WE310F5  39.00.000
m2mb_os.h
Go to the documentation of this file.
1 /*===============================================================================================*/
2 /* >>> Copyright (C) Telit Communications S.p.A. Italy All Rights Reserved. <<< */
29 #ifndef M2MB_OS_H
30 #define M2MB_OS_H
31 
32 /* Include ======================================================================================*/
33 #ifdef __cplusplus
34 extern "C" {
35 #endif
36 
37 #include "m2mb_os_types.h"
38 #include "m2mb_os_ev.h"
39 #include "m2mb_os_mtx.h"
40 #include "m2mb_os_q.h"
41 #include "m2mb_os_sem.h"
42 
53 /*-----------------------------------------------------------------------------------------------*/
54 
59 /*-----------------------------------------------------------------------------------------------*/
60 
61 
62 #ifdef DEBUG_ENABLE
63 #define vspfunc app_vspfunc
64 #define uart_print app_uart_printextern
65 char tmp[100];
66 #else
67 #define vspfunc( ...) (0)
68 #define uart_print( ...)
69 #endif
70 
71 
72 /* Global declarations ==========================================================================*/
73 #define M2MB_OS_TASK_INVALID 0
74 #define M2MB_OS_TASK_INVALID_ATTR 0
75 
76 #define M2MB_OS_TASK_AUTOSTART 1
77 #define M2MB_OS_TASK_NOT_START 0
78 
79 #define M2MB_OS_ISR_ON 1
80 #define M2MB_OS_ISR_OFF 0
81 
82 /* in bytes */
83 #define M2MB_OS_MIN_STACK_SIZE 1024
84 
85 //QBO #define M2MB_OS_MS2TICKS(ms) ( ms ? ( ( (UINT32)ms * OS_TICKS_x_SEC ) /1000 ) + 1 : 0 )
86 
87 /* category for errno */
88 #define M2MB_FS_CAT ( (UINT32)0 )
89 #define M2MB_SMS_CAT ( (UINT32)1 )
90 #define M2MB_GNSS_CAT ( (UINT32)2 )
91 #define M2MB_OS_CAT ( (UINT32)3 )
92 
93 /*-----------------------------------------------------------------------------------------------*/
94 
95 /* Global typedefs ==============================================================================*/
96 typedef HANDLE M2MB_OS_TASK_HANDLE;
97 typedef HANDLE M2MB_OS_TASK_ATTR_HANDLE;
98 
99 /* specified type for entry function of task */
100 typedef void( *ENTRY_FN )( void * );
101 
102 typedef enum
103 {
104  M2MB_OS_TASK_SEL_CMD_CREATE_ATTR,
105  M2MB_OS_TASK_SEL_CMD_DEL_ATTR,
106  M2MB_OS_TASK_SEL_CMD_NAME,
107  M2MB_OS_TASK_SEL_CMD_USRNAME,
108  M2MB_OS_TASK_SEL_CMD_STACK_START,
109  M2MB_OS_TASK_SEL_CMD_STACK_SIZE,
110  M2MB_OS_TASK_SEL_CMD_PRIORITY,
111  M2MB_OS_TASK_SEL_CMD_PREEMPTIONTH,
112  M2MB_OS_TASK_SEL_CMD_TSLICE,
113  M2MB_OS_TASK_SEL_CMD_AUTOSTART,
115  M2MB_OS_TASK_SEL_CMD_STATE,
116  M2MB_OS_TASK_SEL_CMD_RUN_CNT,
118  /* ---- */
119  M2MB_OS_TASK_SEL_CMD_END,
120  ENUM_TO_INT( M2MB_OS_TASK_SEL_CMD_E )
121 } M2MB_OS_TASK_SEL_CMD_E;
122 
123 typedef enum
124 {
125  M2MB_OS_TASK_STATE_READY,
126  M2MB_OS_TASK_STATE_COMPLETED,
127  M2MB_OS_TASK_STATE_TERMINATED,
128  M2MB_OS_TASK_STATE_SUSP,
129  M2MB_OS_TASK_STATE_SLEEP,
130  M2MB_OS_TASK_STATE_QUEUE_SUSP,
131  M2MB_OS_TASK_STATE_SEMAPHORE_SUSP,
132  M2MB_OS_TASK_STATE_SIG_SUSP,
133  M2MB_OS_TASK_STATE_BLOCK_MEM_SUSP,
134  M2MB_OS_TASK_STATE_BYTE_MEM_SUSP,
135  M2MB_OS_TASK_STATE_MUTEX_SUSP = 0x0D,
136 
137  /* ---- */
138  M2MB_OS_TASK_STATE_END,
139  ENUM_TO_INT( M2MB_OS_TASK_STATE_E )
140 } M2MB_OS_TASK_STATE_E;
141 
142 typedef enum
143 {
144  M2MB_OS_MEMINFO_FRAGMENTS, //the total number of memory fragments
145  M2MB_OS_MEMINFO_BYTES_AVAILABLE, //the total number of available bytes
146  M2MB_OS_MEMINFO_SIZE, //the total number of memory size
147 
148  /* ---- */
149  M2MB_OS_MEMINFO_END,
150  ENUM_TO_INT( M2MB_OS_MEMINFO_E )
151 } M2MB_OS_MEMINFO_E;
152 
153 
154 #define M2MB_OS_ENTER_CRITICAL() do { __asm("cpsid i"); } while(0)
155 #define M2MB_OS_EXIT_CRITICAL() do { __asm("cpsie i"); } while(0)
156 
157 /* Global functions =============================================================================*/
158 
159 UINT32 M2MB_OS_MS2TICKS( UINT32 ms );
160 
161 
162 /*-----------------------------------------------------------------------------------------------*/
202 /*-----------------------------------------------------------------------------------------------*/
203 void *m2mb_os_malloc( UINT32 size );
204 
205 /*-----------------------------------------------------------------------------------------------*/
255 /*-----------------------------------------------------------------------------------------------*/
256 void *m2mb_os_calloc( UINT32 count, UINT32 size );
257  void *m2mb_os_realloc( void *ptr, UINT32 size );
258 /*-----------------------------------------------------------------------------------------------*/
294 /*-----------------------------------------------------------------------------------------------*/
295 M2MB_OS_RESULT_E m2mb_os_free( void *pMem );
296 
297 /*-----------------------------------------------------------------------------------------------*/
321 /*-----------------------------------------------------------------------------------------------*/
322 M2MB_OS_RESULT_E m2mb_os_init( void );
323 
324 /*-----------------------------------------------------------------------------------------------*/
420 /*-----------------------------------------------------------------------------------------------*/
421 M2MB_OS_RESULT_E m2mb_os_taskCreate(
422  M2MB_OS_TASK_HANDLE *pTaskHandle,
423  M2MB_OS_TASK_ATTR_HANDLE *pTaskAttr,
424  ENTRY_FN entryFn,
425  void *pArg
426 );
427 
428 /*-----------------------------------------------------------------------------------------------*/
555 /*-----------------------------------------------------------------------------------------------*/
556 M2MB_OS_RESULT_E m2mb_os_taskGetItem(
557  M2MB_OS_TASK_HANDLE taskHandle,
558  M2MB_OS_TASK_SEL_CMD_E selCmd,
559  MEM_W *pOut,
560  void *pIn
561 );
562 
563 
564 /*-----------------------------------------------------------------------------------------------*/
608 /*-----------------------------------------------------------------------------------------------*/
609 M2MB_OS_RESULT_E m2mb_os_taskSetItem(
610  M2MB_OS_TASK_HANDLE taskHandle,
611  M2MB_OS_TASK_SEL_CMD_E selCmd,
612  void *pIn
613 );
614 
615 /*-----------------------------------------------------------------------------------------------*/
687 /*-----------------------------------------------------------------------------------------------*/
688 M2MB_OS_RESULT_E m2mb_os_taskSetAttrItem(
689  M2MB_OS_TASK_ATTR_HANDLE *pTaskAttrHandle,
690  UINT8 nCmds,
691  ...
692 );
693 
694 /*-----------------------------------------------------------------------------------------------*/
723 /*-----------------------------------------------------------------------------------------------*/
724 M2MB_OS_TASK_HANDLE m2mb_os_taskGetId( void );
725 
726 /*-----------------------------------------------------------------------------------------------*/
765 /*-----------------------------------------------------------------------------------------------*/
766 M2MB_OS_RESULT_E m2mb_os_taskSuspend( M2MB_OS_TASK_HANDLE taskHandle );
767 
768 /*-----------------------------------------------------------------------------------------------*/
803 /*-----------------------------------------------------------------------------------------------*/
804 M2MB_OS_RESULT_E m2mb_os_taskResume( M2MB_OS_TASK_HANDLE taskHandle );
805 
806 /*-----------------------------------------------------------------------------------------------*/
843 /*-----------------------------------------------------------------------------------------------*/
844 M2MB_OS_RESULT_E m2mb_os_taskTerminate( M2MB_OS_TASK_HANDLE taskHandle );
845 
846 /*-----------------------------------------------------------------------------------------------*/
883 /*-----------------------------------------------------------------------------------------------*/
884 M2MB_OS_RESULT_E m2mb_os_taskRestart( M2MB_OS_TASK_HANDLE taskHandle );
885 
886 /*-----------------------------------------------------------------------------------------------*/
928 /*-----------------------------------------------------------------------------------------------*/
929 M2MB_OS_RESULT_E m2mb_os_taskDelete( M2MB_OS_TASK_HANDLE taskHandle );
930 
931 /*-----------------------------------------------------------------------------------------------*/
978 /*-----------------------------------------------------------------------------------------------*/
979 M2MB_OS_RESULT_E m2mb_os_taskCooperate( void );
980 
981 /*-----------------------------------------------------------------------------------------------*/
1068 /*-----------------------------------------------------------------------------------------------*/
1069 M2MB_OS_RESULT_E m2mb_os_taskWaitAbort( M2MB_OS_TASK_HANDLE taskHandle );
1070 
1071 /*-----------------------------------------------------------------------------------------------*/
1099 /*-----------------------------------------------------------------------------------------------*/
1100 UINT32 m2mb_os_getSysTicks( void );
1101 
1102 /*-----------------------------------------------------------------------------------------------*/
1132 /*-----------------------------------------------------------------------------------------------*/
1133 M2MB_OS_RESULT_E m2mb_os_setSysTicks( UINT32 newTick );
1134 
1135 /*-----------------------------------------------------------------------------------------------*/
1157 /*-----------------------------------------------------------------------------------------------*/
1158 FLOAT32 m2mb_os_getSysTickDuration_ms( void );
1159 
1160 /*-----------------------------------------------------------------------------------------------*/
1201 /*-----------------------------------------------------------------------------------------------*/
1202 UINT8 m2mb_os_isrCtrl( UINT8 newIsrState );
1203 
1204 /*-----------------------------------------------------------------------------------------------*/
1205 /*-----------------------------------------------------------------------------------------------*/
1243 /*-----------------------------------------------------------------------------------------------*/
1244 M2MB_OS_RESULT_E m2mb_os_get_errno( UINT32 *pCategory, INT32 *pErrno );
1245 
1246 
1247 /*-----------------------------------------------------------------------------------------------*/
1264 /*-----------------------------------------------------------------------------------------------*/
1265 int m2mb_thread_fp_enable(void);
1269 /*-----------------------------------------------------------------------------------------------*/
1270 
1271 #ifdef __cplusplus
1272 }
1273 #endif
1274 #endif /* M2MB_OS_H */
m2mb_os_taskTerminate
M2MB_OS_RESULT_E m2mb_os_taskTerminate(M2MB_OS_TASK_HANDLE taskHandle)
Terminates application task.
FLOAT32
float FLOAT32
Definition: m2mb_types.h:77
ENUM_TO_INT
#define ENUM_TO_INT(Prefix)
Definition: m2mb_types.h:207
M2MB_OS_TASK_ATTR_HANDLE
HANDLE M2MB_OS_TASK_ATTR_HANDLE
Definition: m2mb_os.h:97
M2MB_OS_MEMINFO_E
M2MB_OS_MEMINFO_E
Definition: m2mb_os.h:142
m2mb_os_taskSetAttrItem
M2MB_OS_RESULT_E m2mb_os_taskSetAttrItem(M2MB_OS_TASK_ATTR_HANDLE *pTaskAttrHandle, UINT8 nCmds,...)
Set specific attribute for task creation.
UINT8
unsigned char UINT8
Definition: m2mb_types.h:86
m2mb_os_calloc
void * m2mb_os_calloc(UINT32 count, UINT32 size)
Allocates bytes of memory and init space with 0.
m2mb_os_setSysTicks
M2MB_OS_RESULT_E m2mb_os_setSysTicks(UINT32 newTick)
Set start system time in ticks.
m2mb_os_taskSetItem
M2MB_OS_RESULT_E m2mb_os_taskSetItem(M2MB_OS_TASK_HANDLE taskHandle, M2MB_OS_TASK_SEL_CMD_E selCmd, void *pIn)
Set specific task properties.
m2mb_os_taskCooperate
M2MB_OS_RESULT_E m2mb_os_taskCooperate(void)
Make task to cooperate by releasing scheduler control.
M2MB_OS_TASK_HANDLE
HANDLE M2MB_OS_TASK_HANDLE
Definition: m2mb_os.h:96
m2mb_thread_fp_enable
int m2mb_thread_fp_enable(void)
Sets the thread floating point unit flag.
m2mb_os_realloc
void * m2mb_os_realloc(void *ptr, UINT32 size)
m2mb_os_free
M2MB_OS_RESULT_E m2mb_os_free(void *pMem)
Free allocated memory.
m2mb_os_getSysTicks
UINT32 m2mb_os_getSysTicks(void)
Get system time in ticks.
m2mb_os_init
M2MB_OS_RESULT_E m2mb_os_init(void)
Initialization of OS.
m2mb_os_types.h
Types used across OS (semaphore, mutex...)
m2mb_os_taskWaitAbort
M2MB_OS_RESULT_E m2mb_os_taskWaitAbort(M2MB_OS_TASK_HANDLE taskHandle)
Abort suspension of a specified task.
M2MB_OS_RESULT_E
enum M2MB_OS_RESULT M2MB_OS_RESULT_E
M2MB_OS_MS2TICKS
UINT32 M2MB_OS_MS2TICKS(UINT32 ms)
m2mb_os_taskResume
M2MB_OS_RESULT_E m2mb_os_taskResume(M2MB_OS_TASK_HANDLE taskHandle)
Resume suspended application task.
m2mb_os_taskDelete
M2MB_OS_RESULT_E m2mb_os_taskDelete(M2MB_OS_TASK_HANDLE taskHandle)
Task delete.
m2mb_os_getSysTickDuration_ms
FLOAT32 m2mb_os_getSysTickDuration_ms(void)
Get the duration of system tick in ms.
m2mb_os_q.h
OS queue prototypes.
m2mb_os_malloc
void * m2mb_os_malloc(UINT32 size)
Allocates bytes of memory.
m2mb_os_get_errno
M2MB_OS_RESULT_E m2mb_os_get_errno(UINT32 *pCategory, INT32 *pErrno)
Allow to get Errno saved in a relative task environment.
M2MB_OS_TASK_SEL_CMD_E
M2MB_OS_TASK_SEL_CMD_E
Definition: m2mb_os.h:102
UINT32
unsigned long int UINT32
Definition: m2mb_types.h:88
M2MB_OS_TASK_STATE_E
M2MB_OS_TASK_STATE_E
Definition: m2mb_os.h:123
m2mb_os_sem.h
OS Semaphore prototypes.
MEM_W
UINT32 MEM_W
Definition: m2mb_types.h:94
INT32
signed int INT32
Definition: m2mb_types.h:82
m2mb_os_taskSuspend
M2MB_OS_RESULT_E m2mb_os_taskSuspend(M2MB_OS_TASK_HANDLE taskHandle)
Suspend application task.
HANDLE
void * HANDLE
Definition: m2mb_types.h:98
m2mb_os_taskGetId
M2MB_OS_TASK_HANDLE m2mb_os_taskGetId(void)
Retrieves handle to the currently executing task.
m2mb_os_taskCreate
M2MB_OS_RESULT_E m2mb_os_taskCreate(M2MB_OS_TASK_HANDLE *pTaskHandle, M2MB_OS_TASK_ATTR_HANDLE *pTaskAttr, ENTRY_FN entryFn, void *pArg)
Create application task.
m2mb_os_mtx.h
OS mutex prototypes.
m2mb_os_taskRestart
M2MB_OS_RESULT_E m2mb_os_taskRestart(M2MB_OS_TASK_HANDLE taskHandle)
Task restart.
m2mb_os_isrCtrl
UINT8 m2mb_os_isrCtrl(UINT8 newIsrState)
Enable and disable interrupts (ISRs)
ENTRY_FN
void(* ENTRY_FN)(void *)
Definition: m2mb_os.h:100
m2mb_os_ev.h
OS event prototypes.
m2mb_os_taskGetItem
M2MB_OS_RESULT_E m2mb_os_taskGetItem(M2MB_OS_TASK_HANDLE taskHandle, M2MB_OS_TASK_SEL_CMD_E selCmd, MEM_W *pOut, void *pIn)
Get specific task properties.