yystopf/openharmony_kernel_liteos_m
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix：Fixed comment description for OS_TSK_GET_INDEX error

Browse Source
This commit is contained in:
zhushengle
2021-04-25 17:40:11 +08:00
committed by Gitee
parent b8cd812303
commit 912bf69866
1 changed files with 14 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
kernel/include/los_task.h
View File

@@ -1542,17 +1542,17 @@ extern UINT32 LOS_CpupUsageMonitor(CPUP_TYPE_E type, CPUP_MODE_E mode, UINT32 ta
/**
* @ingroup los_task
* @brief Check whether a task ID is valid.
* @brief Get the real task ID.
*
* @par Description:
* This API is used to check whether a task ID, excluding the idle task ID, is valid.
* This API is used to get the real task ID.
* @attention None.
*
* @param taskID [IN] Task ID.
*
* @retval 0 or 1. One indicates that the task ID is invalid, whereas zero indicates that the task ID is valid.
* @retval real task ID.
* @par Dependency:
* <ul><li>los_task_pri.h: the header file that contains the API declaration.</li></ul>
* <ul><li>los_task.h: the header file that contains the API declaration.</li></ul>
* @see
*/
#define OS_TSK_GET_INDEX(taskID) (taskID)
@@ -1569,7 +1569,7 @@ extern UINT32 LOS_CpupUsageMonitor(CPUP_TYPE_E type, CPUP_MODE_E mode, UINT32 ta
*
* @retval Pointer to the task control block.
* @par Dependency:
* <ul><li>los_task_pri.h: the header file that contains the API declaration.</li></ul>
* <ul><li>los_task.h: the header file that contains the API declaration.</li></ul>
* @see
*/
#define OS_TCB_FROM_PENDLIST(ptr) LOS_DL_LIST_ENTRY(ptr, LosTaskCB, pendList)
@@ -1586,7 +1586,7 @@ extern UINT32 LOS_CpupUsageMonitor(CPUP_TYPE_E type, CPUP_MODE_E mode, UINT32 ta
*
* @retval Pointer to the task control block.
* @par Dependency:
* <ul><li>los_task_pri.h: the header file that contains the API declaration.</li></ul>
* <ul><li>los_task.h: the header file that contains the API declaration.</li></ul>
* @see
*/
#define OS_TCB_FROM_TID(taskID) (((LosTaskCB *)g_taskCBArray) + (taskID))
@@ -1737,7 +1737,7 @@ extern LOS_DL_LIST g_taskRecyleList;
*
* @retval UINT32 Initialization result.
* @par Dependency:
* <ul><li>los_task_pri.h: the header file that contains the API declaration.</li></ul>
* <ul><li>los_task.h: the header file that contains the API declaration.</li></ul>
* @see
*/
extern UINT32 OsTaskInit(VOID);
@@ -1758,7 +1758,7 @@ extern UINT32 OsTaskInit(VOID);
*
* @retval UINT32 Create result.
* @par Dependency:
* <ul><li>los_task_pri.h: the header file that contains the API declaration.</li></ul>
* <ul><li>los_task.h: the header file that contains the API declaration.</li></ul>
* @see
*/
extern UINT32 OsIdleTaskCreate(VOID);
@@ -1779,7 +1779,7 @@ extern UINT32 OsIdleTaskCreate(VOID);
*
* @retval None.
* @par Dependency:
* <ul><li>los_task_pri.h: the header file that contains the API declaration.</li></ul>
* <ul><li>los_task.h: the header file that contains the API declaration.</li></ul>
* @see
*/
extern VOID OsTaskSwitchCheck(VOID);
@@ -1800,7 +1800,7 @@ extern VOID OsTaskSwitchCheck(VOID);
*
* @retval None.
* @par Dependency:
* <ul><li>los_task_pri.h: the header file that contains the API declaration.</li></ul>
* <ul><li>los_task.h: the header file that contains the API declaration.</li></ul>
* @see
*/
extern VOID OsTaskMonInit(VOID);
@@ -1821,7 +1821,7 @@ extern VOID OsTaskMonInit(VOID);
*
* @retval None.
* @par Dependency:
* <ul><li>los_task_pri.h: the header file that contains the API declaration.</li></ul>
* <ul><li>los_task.h: the header file that contains the API declaration.</li></ul>
* @see
*/
extern VOID OsTaskEntry(UINT32 taskID);
@@ -1842,7 +1842,7 @@ extern VOID OsTaskEntry(UINT32 taskID);
*
* @retval UINT32 Task water line.
* @par Dependency:
* <ul><li>los_task_pri.h: the header file that contains the API declaration.</li></ul>
* <ul><li>los_task.h: the header file that contains the API declaration.</li></ul>
* @see None.
*/
extern UINT32 OsGetTaskWaterLine(UINT32 taskID);
@@ -1863,7 +1863,7 @@ extern UINT32 OsGetTaskWaterLine(UINT32 taskID);
*
* @retval UINT8 * String.
* @par Dependency:
* <ul><li>los_task_pri.h: the header file that contains the API declaration.</li></ul>
* <ul><li>los_task.h: the header file that contains the API declaration.</li></ul>
* @see None.
*/
extern UINT8 *OsConvertTskStatus(UINT16 taskStatus);
@@ -1884,7 +1884,7 @@ extern UINT8 *OsConvertTskStatus(UINT16 taskStatus);
*
* @retval UINT32 All task information.
* @par Dependency:
* <ul><li>los_task_pri.h: the header file that contains the API declaration.</li></ul>
* <ul><li>los_task.h: the header file that contains the API declaration.</li></ul>
* @see None.
*/
extern UINT32 OsGetAllTskInfo(VOID);