Software timer

Software timer 的协作图:

结构体
struct	tagSwTmrCtrl

类型定义
typedef VOID(*	SWTMR_PROC_FUNC) (UINTPTR arg)
	Define the type of a callback function that handles software timer timeout. 更多...
typedef struct tagSwTmrCtrl	SWTMR_CTRL_S

枚举
enum	enSwTmrType { LOS_SWTMR_MODE_ONCE , LOS_SWTMR_MODE_PERIOD , LOS_SWTMR_MODE_NO_SELFDELETE , LOS_SWTMR_MODE_OPP }

函数
UINT32	LOS_SwtmrStart (UINT16 swtmrID)
	Start a software timer. 更多...
UINT32	LOS_SwtmrStop (UINT16 swtmrID)
	Stop a software timer. 更多...
UINT32	LOS_SwtmrTimeGet (UINT16 swtmrID, UINT32 *tick)
	Obtain the number of remaining Ticks configured on a software timer. 更多...
UINT32	LOS_SwtmrCreate (UINT32 interval, UINT8 mode, SWTMR_PROC_FUNC handler, UINT16 *swtmrID, UINTPTR arg)
	Create a software timer. 更多...
UINT32	LOS_SwtmrDelete (UINT16 swtmrID)
	Delete a software timer. 更多...

详细描述

类型定义说明

SWTMR_CTRL_S

typedef struct tagSwTmrCtrl SWTMR_CTRL_S

Software timer control structure | 软件定时器控制块
变量前缀 uc:UINT8 us:UINT16 uw:UINT32 代表的意思

SWTMR_PROC_FUNC

typedef VOID(* SWTMR_PROC_FUNC) (UINTPTR arg)

Define the type of a callback function that handles software timer timeout.

Description:

This API is used to define the type of a callback function that handles software timer timeout, so that it can be called when software timer timeout.

注意

• None.

参数

arg	[IN] the parameter of the callback function that handles software timer timeout.

返回值

None.

Dependency:

• los_swtmr.h: the header file that contains the API declaration.

参见

None.

在文件 los_swtmr.h 第 260 行定义.

枚举类型说明

enSwTmrType

enum enSwTmrType

Software timer mode

枚举值
LOS_SWTMR_MODE_ONCE	One-off software timer | 一次性的软件计时器
LOS_SWTMR_MODE_PERIOD	Periodic software timer | 周期性的软件计时器
LOS_SWTMR_MODE_NO_SELFDELETE	One-off software timer, but not self-delete | 一次性软件计时器，但不能自删除
LOS_SWTMR_MODE_OPP	After the one-off timer finishes timing, the periodic software timer is enabled. This mode is not supported temporarily. | 一次性完成后启用周期性软件计时器,鸿蒙目前暂时不支持这种方式

在文件 los_swtmr.h 第 231 行定义.

                 {
    LOS_SWTMR_MODE_ONCE, /**< One-off software timer | 一次性的软件计时器*/
    LOS_SWTMR_MODE_PERIOD, /**< Periodic software timer | 周期性的软件计时器*/
    LOS_SWTMR_MODE_NO_SELFDELETE, /**< One-off software timer, but not self-delete | 一次性软件计时器，但不能自删除*/
    LOS_SWTMR_MODE_OPP  /**< After the one-off timer finishes timing,
                             the periodic software timer is enabled.
                             This mode is not supported temporarily. | 一次性完成后启用周期性软件计时器,鸿蒙目前暂时不支持这种方式*/
};

函数说明

LOS_SwtmrCreate()

UINT32 LOS_SwtmrCreate	(	UINT32	interval,
		UINT8	mode,
		SWTMR_PROC_FUNC	handler,
		UINT16 *	swtmrID,
		UINTPTR	arg
	)

Create a software timer.

Description:

This API is used to create a software timer that has specified timing duration, timeout handling function, and trigger mode, and to return a handle by which the software timer can be referenced.

注意

• Do not use the delay interface in the callback function that handles software timer timeout.
• Threre are LOSCFG_BASE_CORE_SWTMR_LIMIT timers available, change it's value when necessory.

参数

interval	[IN] Timing duration of the software timer to be created (unit: tick).
mode	[IN] Software timer mode. Pass in one of the modes specified by enSwTmrType. There are three types of modes, one-off, periodic, and continuously periodic after one-off, of which the third mode is not supported temporarily.
handler	[IN] Callback function that handles software timer timeout.
swtmrID	[OUT] Software timer ID created by LOS_SwtmrCreate.
arg	[IN] Parameter passed in when the callback function that handles software timer timeout is called.

返回值

#LOS_ERRNO_SWTMR_INTERVAL_NOT_SUITED	The software timer timeout interval is 0.
#LOS_ERRNO_SWTMR_MODE_INVALID	Invalid software timer mode.
#LOS_ERRNO_SWTMR_PTR_NULL	The callback function that handles software timer timeout is NULL.
#LOS_ERRNO_SWTMR_RET_PTR_NULL	The passed-in software timer ID is NULL.
#LOS_ERRNO_SWTMR_MAXSIZE	The number of software timers exceeds the configured permitted maximum number.
#LOS_OK	The software timer is successfully created.

Dependency:

• los_swtmr.h: the header file that contains the API declaration.

参见

LOS_SwtmrDelete

Create a software timer.

在文件 los_swtmr.c 第 712 行定义.

{
    SWTMR_CTRL_S *swtmr = NULL;
    UINT32 intSave;
    SortLinkList *sortList = NULL;
 
    if (interval == 0) {
        return LOS_ERRNO_SWTMR_INTERVAL_NOT_SUITED;
    }
 
    if ((mode != LOS_SWTMR_MODE_ONCE) && (mode != LOS_SWTMR_MODE_PERIOD) &&
        (mode != LOS_SWTMR_MODE_NO_SELFDELETE)) {
        return LOS_ERRNO_SWTMR_MODE_INVALID;
    }
 
    if (handler == NULL) {
        return LOS_ERRNO_SWTMR_PTR_NULL;
    }
 
    if (swtmrID == NULL) {
        return LOS_ERRNO_SWTMR_RET_PTR_NULL;
    }
 
    SWTMR_LOCK(intSave);
    if (LOS_ListEmpty(&g_swtmrFreeList)) {//空闲链表不能为空
        SWTMR_UNLOCK(intSave);
        return LOS_ERRNO_SWTMR_MAXSIZE;
    }
 
    sortList = LOS_DL_LIST_ENTRY(g_swtmrFreeList.pstNext, SortLinkList, sortLinkNode);
    swtmr = LOS_DL_LIST_ENTRY(sortList, SWTMR_CTRL_S, stSortList);
    LOS_ListDelete(LOS_DL_LIST_FIRST(&g_swtmrFreeList));//
    SWTMR_UNLOCK(intSave);
 
    swtmr->uwOwnerPid = OsCurrProcessGet()->processID;//定时器进程归属设定
    swtmr->pfnHandler = handler;//时间到了的回调函数
    swtmr->ucMode = mode;   //定时器模式
    swtmr->uwOverrun = 0;
    swtmr->uwInterval = interval;   //周期性超时间隔
    swtmr->uwExpiry = interval;     //一次性超时间隔
    swtmr->uwArg = arg;             //回调函数的参数
    swtmr->ucState = OS_SWTMR_STATUS_CREATED;   //已创建状态
    SET_SORTLIST_VALUE(&swtmr->stSortList, OS_SORT_LINK_INVALID_TIME);
    *swtmrID = swtmr->usTimerID;
    OsHookCall(LOS_HOOK_TYPE_SWTMR_CREATE, swtmr);
    return LOS_OK;
}

函数调用图:

这是这个函数的调用关系图:

LOS_SwtmrDelete()

UINT32 LOS_SwtmrDelete

(

UINT16

swtmrID

)

Delete a software timer.

Description:

This API is used to delete a software timer.

注意

• The specific timer should be created and then stopped firstly.

参数

swtmrID

[IN] Software timer ID created by LOS_SwtmrCreate. The value of ID should be in [0, LOSCFG_BASE_CORE_SWTMR_LIMIT - 1].

返回值

#LOS_ERRNO_SWTMR_ID_INVALID	Invalid software timer ID.
#LOS_ERRNO_SWTMR_NOT_CREATED	The software timer is not created.
#LOS_ERRNO_SWTMR_STATUS_INVALID	Invalid software timer state.
#LOS_OK	The software timer is successfully deleted.

Dependency:

• los_swtmr.h: the header file that contains the API declaration.

参见

LOS_SwtmrCreate

Delete a software timer.

在文件 los_swtmr.c 第 889 行定义.

{
    SWTMR_CTRL_S *swtmr = NULL;
    UINT32 intSave;
    UINT32 ret = LOS_OK;
    UINT16 swtmrCBID;
 
    if (swtmrID >= OS_SWTMR_MAX_TIMERID) {
        return LOS_ERRNO_SWTMR_ID_INVALID;
    }
 
    swtmrCBID = swtmrID % LOSCFG_BASE_CORE_SWTMR_LIMIT;//取模
    swtmr = g_swtmrCBArray + swtmrCBID;//获取定时器控制结构体
    SWTMR_LOCK(intSave);
 
    if (swtmr->usTimerID != swtmrID) {//ID必须一样
        SWTMR_UNLOCK(intSave);
        return LOS_ERRNO_SWTMR_ID_INVALID;
    }
 
    switch (swtmr->ucState) {
        case OS_SWTMR_STATUS_UNUSED:
            ret = LOS_ERRNO_SWTMR_NOT_CREATED;
            break;
        case OS_SWTMR_STATUS_TICKING://正在计数就先停止再删除,这里没有break;
            SwtmrStop(swtmr);
            /* fall-through */
        case OS_SWTMR_STATUS_CREATED://再删除定时器
            SwtmrDelete(swtmr);
            break;
        default:
            ret = LOS_ERRNO_SWTMR_STATUS_INVALID;
            break;
    }
 
    SWTMR_UNLOCK(intSave);
    OsHookCall(LOS_HOOK_TYPE_SWTMR_DELETE, swtmr);
    return ret;
}

函数调用图:

这是这个函数的调用关系图:

LOS_SwtmrStart()

UINT32 LOS_SwtmrStart

(

UINT16

swtmrID

)

Start a software timer.

Description:

This API is used to start a software timer that has a specified ID.

注意

• The specific timer must be created first

参数

swtmrID

[IN] Software timer ID created by LOS_SwtmrCreate. The value of ID should be in [0, LOSCFG_BASE_CORE_SWTMR_LIMIT - 1].

返回值

#LOS_ERRNO_SWTMR_ID_INVALID	Invalid software timer ID.
#LOS_ERRNO_SWTMR_NOT_CREATED	The software timer is not created.
#LOS_ERRNO_SWTMR_STATUS_INVALID	Invalid software timer state.
#LOS_OK	The software timer is successfully started.

Dependency:

• los_swtmr.h: the header file that contains the API declaration.

参见

LOS_SwtmrStop | LOS_SwtmrCreate

Start a software timer.

在文件 los_swtmr.c 第 764 行定义.

{
    SWTMR_CTRL_S *swtmr = NULL;
    UINT32 intSave;
    UINT32 ret = LOS_OK;
    UINT16 swtmrCBID;
 
    if (swtmrID >= OS_SWTMR_MAX_TIMERID) {
        return LOS_ERRNO_SWTMR_ID_INVALID;
    }
 
    swtmrCBID = swtmrID % LOSCFG_BASE_CORE_SWTMR_LIMIT;//取模
    swtmr = g_swtmrCBArray + swtmrCBID;//获取定时器控制结构体
 
    SWTMR_LOCK(intSave);
    if (swtmr->usTimerID != swtmrID) {//ID必须一样
        SWTMR_UNLOCK(intSave);
        return LOS_ERRNO_SWTMR_ID_INVALID;
    }
 
    switch (swtmr->ucState) {//判断定时器状态
        case OS_SWTMR_STATUS_UNUSED:
            ret = LOS_ERRNO_SWTMR_NOT_CREATED;
            break;
        /* 如果定时器的状态为启动中,应先停止定时器再重新启动
         * If the status of swtmr is timing, it should stop the swtmr first,
         * then start the swtmr again.
         */
        case OS_SWTMR_STATUS_TICKING://正在计数的定时器
            SwtmrStop(swtmr);//先停止定时器,注意这里没有break;,在OsSwtmrStop中状态将会回到了OS_SWTMR_STATUS_CREATED 接下来就是执行启动了
            /* fall-through */
        case OS_SWTMR_STATUS_CREATED://已经创建好了
            SwtmrStart(swtmr);
            break;
        default:
            ret = LOS_ERRNO_SWTMR_STATUS_INVALID;
            break;
    }
 
    SWTMR_UNLOCK(intSave);
    OsHookCall(LOS_HOOK_TYPE_SWTMR_START, swtmr);
    return ret;
}

函数调用图:

这是这个函数的调用关系图:

LOS_SwtmrStop()

UINT32 LOS_SwtmrStop

(

UINT16

swtmrID

)

Stop a software timer.

Description:

This API is used to stop a software timer that has a specified ID.

注意

• The specific timer should be created and started firstly.

参数

swtmrID

[IN] Software timer ID created by LOS_SwtmrCreate. The value of ID should be in [0, LOSCFG_BASE_CORE_SWTMR_LIMIT - 1].

返回值

#LOS_ERRNO_SWTMR_ID_INVALID	Invalid software timer ID.
#LOS_ERRNO_SWTMR_NOT_CREATED	The software timer is not created.
#LOS_ERRNO_SWTMR_NOT_STARTED	The software timer is not started.
#LOS_ERRNO_SWTMR_STATUS_INVALID	Invalid software timer state.
#LOS_OK	The software timer is successfully stopped.

Dependency:

• los_swtmr.h: the header file that contains the API declaration.

参见

LOS_SwtmrStart | LOS_SwtmrCreate

Stop a software timer.

在文件 los_swtmr.c 第 808 行定义.

{
    SWTMR_CTRL_S *swtmr = NULL;
    UINT32 intSave;
    UINT32 ret = LOS_OK;
    UINT16 swtmrCBID;
 
    if (swtmrID >= OS_SWTMR_MAX_TIMERID) {
        return LOS_ERRNO_SWTMR_ID_INVALID;
    }
 
    swtmrCBID = swtmrID % LOSCFG_BASE_CORE_SWTMR_LIMIT;//取模
    swtmr = g_swtmrCBArray + swtmrCBID;//获取定时器控制结构体
    SWTMR_LOCK(intSave);
 
    if (swtmr->usTimerID != swtmrID) {//ID必须一样
        SWTMR_UNLOCK(intSave);
        return LOS_ERRNO_SWTMR_ID_INVALID;
    }
 
    switch (swtmr->ucState) {//判断定时器状态
        case OS_SWTMR_STATUS_UNUSED:
            ret = LOS_ERRNO_SWTMR_NOT_CREATED;//返回没有创建
            break;
        case OS_SWTMR_STATUS_CREATED:
            ret = LOS_ERRNO_SWTMR_NOT_STARTED;//返回没有开始
            break;
        case OS_SWTMR_STATUS_TICKING://正在计数
            SwtmrStop(swtmr);//执行正在停止定时器操作
            break;
        default:
            ret = LOS_ERRNO_SWTMR_STATUS_INVALID;
            break;
    }
 
    SWTMR_UNLOCK(intSave);
    OsHookCall(LOS_HOOK_TYPE_SWTMR_STOP, swtmr);
    return ret;
}

函数调用图:

这是这个函数的调用关系图:

LOS_SwtmrTimeGet()

UINT32 LOS_SwtmrTimeGet	(	UINT16	swtmrID,
		UINT32 *	tick
	)

Obtain the number of remaining Ticks configured on a software timer.

Description:

This API is used to obtain the number of remaining Ticks configured on the software timer of which the ID is specified by usSwTmrID.

注意

• The specific timer should be created and started successfully, error happends otherwise.

参数

swtmrID	[IN] Software timer ID created by LOS_SwtmrCreate. The value of ID should be in [0, LOSCFG_BASE_CORE_SWTMR_LIMIT - 1].
tick	[OUT] Number of remaining Ticks configured on the software timer.

返回值

#LOS_ERRNO_SWTMR_ID_INVALID	Invalid software timer ID.
#LOS_ERRNO_SWTMR_NOT_CREATED	The software timer is not created.
#LOS_ERRNO_SWTMR_NOT_STARTED	The software timer is not started.
#LOS_ERRNO_SWTMR_STATUS_INVALID	Invalid software timer state.
#LOS_OK	The number of remaining Ticks is successfully obtained.

Dependency:

• los_swtmr.h: the header file that contains the API declaration.

参见

LOS_SwtmrCreate

Obtain the number of remaining Ticks configured on a software timer.

在文件 los_swtmr.c 第 848 行定义.

{
    SWTMR_CTRL_S *swtmr = NULL;
    UINT32 intSave;
    UINT32 ret = LOS_OK;
    UINT16 swtmrCBID;
 
    if (swtmrID >= OS_SWTMR_MAX_TIMERID) {
        return LOS_ERRNO_SWTMR_ID_INVALID;
    }
 
    if (tick == NULL) {
        return LOS_ERRNO_SWTMR_TICK_PTR_NULL;
    }
 
    swtmrCBID = swtmrID % LOSCFG_BASE_CORE_SWTMR_LIMIT;//取模
    swtmr = g_swtmrCBArray + swtmrCBID;//获取定时器控制结构体
    SWTMR_LOCK(intSave);
 
    if (swtmr->usTimerID != swtmrID) {//ID必须一样
        SWTMR_UNLOCK(intSave);
        return LOS_ERRNO_SWTMR_ID_INVALID;
    }
    switch (swtmr->ucState) {
        case OS_SWTMR_STATUS_UNUSED:
            ret = LOS_ERRNO_SWTMR_NOT_CREATED;
            break;
        case OS_SWTMR_STATUS_CREATED:
            ret = LOS_ERRNO_SWTMR_NOT_STARTED;
            break;
        case OS_SWTMR_STATUS_TICKING://正在计数的定时器
            *tick = OsSwtmrTimeGet(swtmr);//获取
            break;
        default:
            ret = LOS_ERRNO_SWTMR_STATUS_INVALID;
            break;
    }
    SWTMR_UNLOCK(intSave);
    return ret;
}

函数调用图:

这是这个函数的调用关系图: