xf_osal_thread.h

浏览该文件的文档.

 
#if XF_OSAL_THREAD_IS_ENABLE || defined(__DOXYGEN__)
 
#ifndef __XF_OSAL_THREAD_H__
#define __XF_OSAL_THREAD_H__
 
/* ==================== [Includes] ========================================== */
 
#include "xf_osal_def.h"
#include "xf_osal_kernel.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ==================== [Defines] =========================================== */
 
#ifndef __NO_RETURN
#   if defined(__CC_ARM)
#       define __NO_RETURN __declspec(noreturn)
#   elif defined(__ARMCC_VERSION) && (__ARMCC_VERSION >= 6010050)
#       define __NO_RETURN __attribute__((__noreturn__))
#   elif defined(__GNUC__)
#       define __NO_RETURN __attribute__((__noreturn__))
#   elif defined(__ICCARM__)
#       define __NO_RETURN __noreturn
#   else
#       define __NO_RETURN
#   endif
#endif
 
#define XF_OSAL_DETACHED       0x00000000U 
#define XF_OSAL_JOINABLE       0x00000001U 
#define XF_OSAL_UNPRIVILEGED   0x00000002U 
#define XF_OSAL_PRIVIEGED      0x00000004U 
#define MAX_BITS_TASK_NOTIFY        31U
 
#define THREAD_FLAGS_INVALID_BITS   (~((1UL << MAX_BITS_TASK_NOTIFY)  - 1U))
 
/* ==================== [Typedefs] ========================================== */
 
typedef enum _xf_osal_priority_t {
    XF_OSAL_PRIORITY_NONE           =  0,         
    XF_OSAL_PRIORITY_IDLE           =  1,         
    XF_OSAL_PRIORITY_LOW            =  8,         
    XF_OSAL_PRIORITY_LOW1           =  8 + 1,     
    XF_OSAL_PRIORITY_LOW2           =  8 + 2,     
    XF_OSAL_PRIORITY_LOW3           =  8 + 3,     
    XF_OSAL_PRIORITY_LOW4           =  8 + 4,     
    XF_OSAL_PRIORITY_LOW5           =  8 + 5,     
    XF_OSAL_PRIORITY_LOW6           =  8 + 6,     
    XF_OSAL_PRIORITY_LOW7           =  8 + 7,     
    XF_OSAL_PRIORITY_BELOW_NORMAL   = 16,         
    XF_OSAL_PRIORITY_BELOW_NORMAL1  = 16 + 1,     
    XF_OSAL_PRIORITY_BELOW_NORMAL2  = 16 + 2,     
    XF_OSAL_PRIORITY_BELOW_NORMAL3  = 16 + 3,     
    XF_OSAL_PRIORITY_BELOW_NORMAL4  = 16 + 4,     
    XF_OSAL_PRIORITY_BELOW_NORMAL5  = 16 + 5,     
    XF_OSAL_PRIORITY_BELOW_NORMAL6  = 16 + 6,     
    XF_OSAL_PRIORITY_BELOW_NORMAL7  = 16 + 7,     
    XF_OSAL_PRIORITY_NORMOL         = 24,         
    XF_OSAL_PRIORITY_NORMOL1        = 24 + 1,     
    XF_OSAL_PRIORITY_NORMOL2        = 24 + 2,     
    XF_OSAL_PRIORITY_NORMOL3        = 24 + 3,     
    XF_OSAL_PRIORITY_NORMOL4        = 24 + 4,     
    XF_OSAL_PRIORITY_NORMOL5        = 24 + 5,     
    XF_OSAL_PRIORITY_NORMOL6        = 24 + 6,     
    XF_OSAL_PRIORITY_NORMOL7        = 24 + 7,     
    XF_OSAL_PRIORITY_ABOVE_NORMAL   = 32,         
    XF_OSAL_PRIORITY_ABOVE_NORMAL1  = 32 + 1,     
    XF_OSAL_PRIORITY_ABOVE_NORMAL2  = 32 + 2,     
    XF_OSAL_PRIORITY_ABOVE_NORMAL3  = 32 + 3,     
    XF_OSAL_PRIORITY_ABOVE_NORMAL4  = 32 + 4,     
    XF_OSAL_PRIORITY_ABOVE_NORMAL5  = 32 + 5,     
    XF_OSAL_PRIORITY_ABOVE_NORMAL6  = 32 + 6,     
    XF_OSAL_PRIORITY_ABOVE_NORMAL7  = 32 + 7,     
    XF_OSAL_PRIORITY_HIGH           = 40,         
    XF_OSAL_PRIORITY_HIGH1          = 40 + 1,     
    XF_OSAL_PRIORITY_HIGH2          = 40 + 2,     
    XF_OSAL_PRIORITY_HIGH3          = 40 + 3,     
    XF_OSAL_PRIORITY_HIGH4          = 40 + 4,     
    XF_OSAL_PRIORITY_HIGH5          = 40 + 5,     
    XF_OSAL_PRIORITY_HIGH6          = 40 + 6,     
    XF_OSAL_PRIORITY_HIGH7          = 40 + 7,     
    XF_OSAL_PRIORITY_REALTIME       = 48,         
    XF_OSAL_PRIORITY_REALTIME1      = 48 + 1,     
    XF_OSAL_PRIORITY_REALTIME2      = 48 + 2,     
    XF_OSAL_PRIORITY_REALTIME3      = 48 + 3,     
    XF_OSAL_PRIORITY_REALTIME4      = 48 + 4,     
    XF_OSAL_PRIORITY_REALTIME5      = 48 + 5,     
    XF_OSAL_PRIORITY_REALTIME6      = 48 + 6,     
    XF_OSAL_PRIORITY_REALTIME7      = 48 + 7,     
    XF_OSAL_PRIORITY_ISR            = 56,         
    XF_OSAL_PRIORITY_ERROR          = -1,         
    XF_OSAL_PRIORITY_RESERVED       = 0x7FFFFFFF  
} xf_osal_priority_t;
 
typedef struct _xf_osal_thread_attr_t {
    const char         *name;       
    uint32_t            attr_bits;  
    void               *cb_mem;     
    uint32_t            cb_size;    
    void               *stack_mem;  
    uint32_t            stack_size; 
    xf_osal_priority_t  priority;   
    uint32_t            reserved;   
} xf_osal_thread_attr_t;
 
typedef void *xf_osal_thread_t;
 
typedef void (*xf_osal_thread_func_t)(void *argument);
 
/* ==================== [Global Prototypes] ================================= */
 
xf_osal_thread_t xf_osal_thread_create(
    xf_osal_thread_func_t func, void *argument, const xf_osal_thread_attr_t *attr);
 
const char *xf_osal_thread_get_name(xf_osal_thread_t thread);
 
xf_osal_thread_t xf_osal_thread_get_current(void);
 
xf_osal_state_t xf_osal_thread_get_state(xf_osal_thread_t thread);
 
uint32_t xf_osal_thread_get_stack_space(xf_osal_thread_t thread);
 
xf_err_t xf_osal_thread_set_priority(
    xf_osal_thread_t thread, xf_osal_priority_t priority);
 
xf_osal_priority_t xf_osal_thread_get_priority(xf_osal_thread_t thread);
 
xf_err_t xf_osal_thread_yield(void);
 
xf_err_t xf_osal_thread_suspend(xf_osal_thread_t thread);
 
xf_err_t xf_osal_thread_resume(xf_osal_thread_t thread);
 
xf_err_t xf_osal_thread_delete(xf_osal_thread_t thread);
 
uint32_t xf_osal_thread_get_count(void);
 
uint32_t xf_osal_thread_enumerate(
    xf_osal_thread_t *thread_array, uint32_t array_items);
 
xf_err_t xf_osal_thread_notify_set(xf_osal_thread_t thread, uint32_t notify);
 
xf_err_t xf_osal_thread_notify_clear(uint32_t notify);
 
uint32_t xf_osal_thread_notify_get(void);
 
xf_err_t xf_osal_thread_notify_wait(
    uint32_t notify, uint32_t options, uint32_t timeout);
 
xf_err_t xf_osal_delay(uint32_t ticks);
 
xf_err_t xf_osal_delay_until(uint32_t ticks);
 
xf_err_t xf_osal_delay_ms(uint32_t ms);
 
/* ==================== [Macros] ============================================ */
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif // __XF_OSAL_THREAD_H__
 
#endif // XF_OSAL_THREAD_IS_ENABLE