los_task.h

浏览该文件的文档.

/* ----------------------------------------------------------------------------
 * Copyright (c) Huawei Technologies Co., Ltd. 2013-2022. All rights reserved.
 * Description: LiteOS Task Module Implementation HeadFile
 * Author: Huawei LiteOS Team
 * Create: 2013-01-01
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 * 1. Redistributions of source code must retain the above copyright notice, this list of
 * conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright notice, this list
 * of conditions and the following disclaimer in the documentation and/or other materials
 * provided with the distribution.
 * 3. Neither the name of the copyright holder nor the names of its contributors may be used
 * to endorse or promote products derived from this software without specific prior written
 * permission.
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 * --------------------------------------------------------------------------- */
 
#ifndef _LOS_TASK_H
#define _LOS_TASK_H
 
#include "los_base.h"
#include "los_list.h"
#include "los_sys.h"
#include "los_tick.h"
#include "los_event.h"
#include "los_memory.h"
#include "los_err.h"
#include "arch/task.h"
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
#define CPUID_TO_AFFI_MASK(cpuid)               (0x1u << (cpuid))
 
#define LOS_TASK_PRIORITY_HIGHEST    0
 
#define LOS_TASK_PRIORITY_LOWEST     31
 
enum TaskAttrBits {
    LOS_TASK_OS_ALLOC_SECURE = 1 << 0,  
    LOS_TASK_STATUS_JOINABLE = 1 << 7,  
    LOS_TASK_STATUS_DETACHED = 1 << 8,  
};
 
#define LOS_ERRNO_TSK_NO_MEMORY                 LOS_ERRNO_OS_FATAL(LOS_MOD_TSK, 0x00)
 
#define LOS_ERRNO_TSK_PTR_NULL                  LOS_ERRNO_OS_ERROR(LOS_MOD_TSK, 0x01)
 
#define LOS_ERRNO_TSK_STKSZ_NOT_ALIGN           LOS_ERRNO_OS_ERROR(LOS_MOD_TSK, 0x02)
 
#define LOS_ERRNO_TSK_PRIOR_ERROR               LOS_ERRNO_OS_ERROR(LOS_MOD_TSK, 0x03)
 
#define LOS_ERRNO_TSK_ENTRY_NULL                LOS_ERRNO_OS_ERROR(LOS_MOD_TSK, 0x04)
 
#define LOS_ERRNO_TSK_NAME_EMPTY                LOS_ERRNO_OS_ERROR(LOS_MOD_TSK, 0x05)
 
#define LOS_ERRNO_TSK_STKSZ_TOO_SMALL           LOS_ERRNO_OS_ERROR(LOS_MOD_TSK, 0x06)
 
#define LOS_ERRNO_TSK_ID_INVALID                LOS_ERRNO_OS_ERROR(LOS_MOD_TSK, 0x07)
 
#define LOS_ERRNO_TSK_ALREADY_SUSPENDED         LOS_ERRNO_OS_ERROR(LOS_MOD_TSK, 0x08)
 
#define LOS_ERRNO_TSK_NOT_SUSPENDED             LOS_ERRNO_OS_ERROR(LOS_MOD_TSK, 0x09)
 
#define LOS_ERRNO_TSK_NOT_CREATED               LOS_ERRNO_OS_ERROR(LOS_MOD_TSK, 0x0a)
 
#define LOS_ERRNO_TSK_DELETE_LOCKED             LOS_ERRNO_OS_FATAL(LOS_MOD_TSK, 0x0b)
 
#define LOS_ERRNO_TSK_MSG_NONZERO               LOS_ERRNO_OS_ERROR(LOS_MOD_TSK, 0x0c)
 
#define LOS_ERRNO_TSK_DELAY_IN_INT              LOS_ERRNO_OS_FATAL(LOS_MOD_TSK, 0x0d)
 
#define LOS_ERRNO_TSK_DELAY_IN_LOCK             LOS_ERRNO_OS_ERROR(LOS_MOD_TSK, 0x0e)
 
#define LOS_ERRNO_TSK_YIELD_IN_LOCK             LOS_ERRNO_OS_ERROR(LOS_MOD_TSK, 0x0f)
 
#define LOS_ERRNO_TSK_YIELD_NOT_ENOUGH_TASK     LOS_ERRNO_OS_ERROR(LOS_MOD_TSK, 0x10)
 
#define LOS_ERRNO_TSK_TCB_UNAVAILABLE           LOS_ERRNO_OS_ERROR(LOS_MOD_TSK, 0x11)
 
#define LOS_ERRNO_TSK_HOOK_NOT_MATCH            LOS_ERRNO_OS_ERROR(LOS_MOD_TSK, 0x12)
 
#define LOS_ERRNO_TSK_HOOK_IS_FULL              LOS_ERRNO_OS_ERROR(LOS_MOD_TSK, 0x13)
 
#define LOS_ERRNO_TSK_OPERATE_SYSTEM_TASK       LOS_ERRNO_OS_ERROR(LOS_MOD_TSK, 0x14)
 
#define LOS_ERRNO_TSK_SUSPEND_LOCKED            LOS_ERRNO_OS_FATAL(LOS_MOD_TSK, 0x15)
 
#define LOS_ERRNO_TSK_FREE_STACK_FAILED         LOS_ERRNO_OS_ERROR(LOS_MOD_TSK, 0x17)
 
#define LOS_ERRNO_TSK_STKAREA_TOO_SMALL         LOS_ERRNO_OS_ERROR(LOS_MOD_TSK, 0x18)
 
#define LOS_ERRNO_TSK_ACTIVE_FAILED             LOS_ERRNO_OS_FATAL(LOS_MOD_TSK, 0x19)
 
#define LOS_ERRNO_TSK_CONFIG_TOO_MANY           LOS_ERRNO_OS_ERROR(LOS_MOD_TSK, 0x1a)
 
#define LOS_ERRNO_TSK_CP_SAVE_AREA_NOT_ALIGN    LOS_ERRNO_OS_ERROR(LOS_MOD_TSK, 0x1b)
 
#define LOS_ERRNO_TSK_MSG_Q_TOO_MANY            LOS_ERRNO_OS_ERROR(LOS_MOD_TSK, 0x1d)
 
#define LOS_ERRNO_TSK_CP_SAVE_AREA_NULL         LOS_ERRNO_OS_ERROR(LOS_MOD_TSK, 0x1e)
 
#define LOS_ERRNO_TSK_SELF_DELETE_ERR           LOS_ERRNO_OS_ERROR(LOS_MOD_TSK, 0x1f)
 
#define LOS_ERRNO_TSK_STKSZ_TOO_LARGE           LOS_ERRNO_OS_ERROR(LOS_MOD_TSK, 0x20)
 
#define LOS_ERRNO_TSK_SUSPEND_SWTMR_NOT_ALLOWED LOS_ERRNO_OS_ERROR(LOS_MOD_TSK, 0x21)
 
#define LOS_ERRNO_TSK_CPU_AFFINITY_MASK_ERR     LOS_ERRNO_OS_FATAL(LOS_MOD_TSK, 0x23)
 
#define LOS_ERRNO_TSK_YIELD_IN_INT              LOS_ERRNO_OS_ERROR(LOS_MOD_TSK, 0x24)
 
#define LOS_ERRNO_TSK_MP_SYNC_RESOURCE          LOS_ERRNO_OS_ERROR(LOS_MOD_TSK, 0x25)
 
#define LOS_ERRNO_TSK_MP_SYNC_FAILED            LOS_ERRNO_OS_ERROR(LOS_MOD_TSK, 0x26)
 
#define LOS_ERRNO_TSK_ALLOC_SECURE_INT          LOS_ERRNO_OS_ERROR(LOS_MOD_TSK, 0x27)
 
#define LOS_ERRNO_TSK_SECURE_ALREADY_ALLOC      LOS_ERRNO_OS_ERROR(LOS_MOD_TSK, 0x28)
 
#define LOS_ERRNO_TSK_ALLOC_SECURE_FAILED       LOS_ERRNO_OS_ERROR(LOS_MOD_TSK, 0x29)
 
#define LOS_ERRNO_TSK_FREE_SECURE_FAILED        LOS_ERRNO_OS_ERROR(LOS_MOD_TSK, 0x2a)
 
#define LOS_ERRNO_TSK_NOT_ALLOW_IN_INT          LOS_ERRNO_OS_ERROR(LOS_MOD_TSK, 0x2b)
 
#define LOS_ERRNO_TSK_SCHED_LOCKED              LOS_ERRNO_OS_ERROR(LOS_MOD_TSK, 0x2c)
 
#define LOS_ERRNO_TSK_ALREADY_JOIN              LOS_ERRNO_OS_ERROR(LOS_MOD_TSK, 0x2d)
 
#define LOS_ERRNO_TSK_IS_DETACHED               LOS_ERRNO_OS_ERROR(LOS_MOD_TSK, 0x2e)
 
#define LOS_ERRNO_TSK_NOT_JOIN_SELF             LOS_ERRNO_OS_ERROR(LOS_MOD_TSK, 0x2f)
 
#define LOS_ERRNO_TSK_IS_ZOMBIE                 LOS_ERRNO_OS_ERROR(LOS_MOD_TSK, 0x30)
 
#define LOS_TASK_MIN_STACK_SIZE (LOS_Align(KERNEL_TSK_MIN_STACK_SIZE, LOSCFG_STACK_POINT_ALIGN_SIZE))
 
#ifdef LOSCFG_BASE_CORE_TSK_MONITOR
typedef VOID (*TSKSWITCHHOOK)(UINT32 oldTaskId, UINT32 newTaskId);
 
extern VOID LOS_TaskSwitchHookReg(TSKSWITCHHOOK hook);
#endif
 
#ifdef LOSCFG_OBSOLETE_API
typedef VOID *(*TSK_ENTRY_FUNC)(UINTPTR param1,
                                UINTPTR param2,
                                UINTPTR param3,
                                UINTPTR param4);
#else
typedef VOID *(*TSK_ENTRY_FUNC)(VOID *param);
#endif
typedef struct tagTskInitParam {
    TSK_ENTRY_FUNC  pfnTaskEntry;  
    UINT16          usTaskPrio;    
#ifdef LOSCFG_OBSOLETE_API
    UINTPTR         auwArgs[4];    
#else
    VOID            *pArgs;        
#endif
    UINT32          uwStackSize;   
    CHAR            *pcName;       
#ifdef LOSCFG_KERNEL_SMP
    UINT16          usCpuAffiMask; 
#endif
    UINT32          uwResved;      
} TSK_INIT_PARAM_S;
 
#define LOS_TASK_NAMELEN                        32
 
typedef struct tagTskInfo {
    CHAR                acName[LOS_TASK_NAMELEN];   
    UINT32              uwTaskID;                   
    UINT16              usTaskStatus;               
    UINT16              usTaskPrio;                 
    VOID                *pTaskSem;                  
    VOID                *pTaskMux;                  
    EVENT_CB_S          uwEvent;                    
    UINT32              uwEventMask;                
    UINT32              uwStackSize;                
    UINTPTR             uwTopOfStack;               
    UINTPTR             uwBottomOfStack;            
    UINTPTR             uwSP;                       
    UINT32              uwCurrUsed;                 
    UINT32              uwPeakUsed;                 
    BOOL                bOvf;                       
} TSK_INFO_S;
 
#ifdef LOSCFG_TASK_STACK_STATIC_ALLOCATION
extern UINT32 LOS_TaskCreateOnlyStatic(UINT32 *taskId, TSK_INIT_PARAM_S *initParam, VOID *topStack);
 
extern UINT32 LOS_TaskCreateStatic(UINT32 *taskId, TSK_INIT_PARAM_S *initParam, VOID *topStack);
#endif
 
#ifdef LOSCFG_TASK_STACK_DYNAMIC_ALLOCATION
extern UINT32 LOS_TaskCreateOnly(UINT32 *taskId, TSK_INIT_PARAM_S *initParam);
 
extern UINT32 LOS_TaskCreate(UINT32 *taskId, TSK_INIT_PARAM_S *initParam);
#endif
 
extern UINT32 LOS_TaskResume(UINT32 taskId);
 
extern UINT32 LOS_TaskSuspend(UINT32 taskId);
 
extern UINT32 LOS_TaskDelete(UINT32 taskId);
 
extern UINT32 LOS_TaskDelay(UINT32 tick);
 
extern BOOL LOS_TaskIsScheduled(VOID);
 
extern VOID LOS_TaskLock(VOID);
 
extern VOID LOS_TaskUnlock(VOID);
 
extern VOID LOS_TaskUnlockNoSched(VOID);
 
extern UINT32 LOS_TaskPriSet(UINT32 taskId, UINT16 taskPrio);
 
extern UINT32 LOS_CurTaskPriSet(UINT16 taskPrio);
 
extern UINT32 LOS_TaskYield(VOID);
 
extern UINT16 LOS_TaskPriGet(UINT32 taskId);
 
extern UINT32 LOS_CurTaskIDGet(VOID);
 
extern UINT32 LOS_TaskInfoGet(UINT32 taskId, TSK_INFO_S *taskInfo);
 
extern UINT32 LOS_TaskCpuAffiSet(UINT32 taskId, UINT16 usCpuAffiMask);
 
extern UINT16 LOS_TaskCpuAffiGet(UINT32 taskId);
 
extern VOID LOS_TaskResRecycle(VOID);
 
#ifdef LOSCFG_OBSOLETE_API
    #define LOS_TASK_PARAM_INIT_ARG_0(initParam, arg) \
            (initParam.auwArgs[0] = (UINTPTR)(arg))
    #define LOS_TASK_PARAM_INIT_ARG(initParam, arg) LOS_TASK_PARAM_INIT_ARG_0(initParam, arg)
#else
    #define LOS_TASK_PARAM_INIT_ARG(initParam, arg) \
            (initParam.pArgs = (VOID *)(arg))
#endif
 
typedef VOID (*LOWPOWERIDLEHOOK)(VOID);
 
extern VOID LOS_LowpowerHookReg(LOWPOWERIDLEHOOK hook);
 
typedef VOID (*IDLEHANDLERHOOK)(VOID);
 
extern VOID LOS_IdleHandlerHookReg(IDLEHANDLERHOOK hook);
 
#ifdef LOSCFG_TRUSTZONE
extern UINT32 LOS_TaskAllocSecureContext(UINT32 taskId, UINT32 size);
 
#endif
 
extern UINT32 LOS_TaskDetach(UINT32 taskId);
 
extern UINT32 LOS_TaskJoin(UINT32 taskId, UINTPTR *retval);
 
#ifdef __cplusplus
}
#endif /* __cplusplus */
 
#endif /* _LOS_TASK_H */