WE310F5  39.00.000
m2mb_rtc_mem.h
Go to the documentation of this file.
1 /*===============================================================================================*/
2 /* >>> Copyright (C) Telit Communications S.p.A. Italy All Rights Reserved. <<< */
25 #ifndef M2MB_RTC_MEM_H
26 #define M2MB_RTC_MEM_H
27 
28 #ifdef __cplusplus
29 extern "C" {
30 #endif
31 
41 /*-----------------------------------------------------------------------------------------------*/
42 
47 /*-----------------------------------------------------------------------------------------------*/
48 
49 
50 /* GLOBAL DECLARATIONS ----------------------------------------------------------- */
51 
52 /* Global declarations ==========================================================================*/
53 
54 #define M2MB_RTC_INVALID_BUFFER ((M2MB_STATUS_T)(__M2MB_ERROR(M2MB_MOD_BASE, 1)))
55 #define M2MB_RTC_INVALID_POOL_ID ((M2MB_STATUS_T)(__M2MB_ERROR(M2MB_MOD_BASE, 2)))
56 #define M2MB_RTC_INVALID_CLIENT_ID ((M2MB_STATUS_T)(__M2MB_ERROR(M2MB_MOD_BASE, 3)))
57 #define M2MB_RTC_DRIVER_NOT_INITIALIZED ((M2MB_STATUS_T)(__M2MB_ERROR(M2MB_MOD_BASE, 4)))
58 #define M2MB_RTC_POOL_NOT_INITIALIZED ((M2MB_STATUS_T)(__M2MB_ERROR(M2MB_MOD_BASE, 5)))
59 #define M2MB_RTC_CLIENT_NOT_FOUND ((M2MB_STATUS_T)(__M2MB_ERROR(M2MB_MOD_BASE, 6)))
60 #define M2MB_RTC_INVALID_CALL_SEQUENCE ((M2MB_STATUS_T)(__M2MB_ERROR(M2MB_MOD_BASE, 7)))
61 #define M2MB_RTC_OUT_OF_MEMORY ((M2MB_STATUS_T)(__M2MB_ERROR(M2MB_MOD_BASE, 8)))
62 #define M2MB_RTC_ERROR ((M2MB_STATUS_T)(__M2MB_ERROR(M2MB_MOD_BASE, 9)))
63 #define M2MB_RTC_FATAL_ERROR ((M2MB_STATUS_T)(__M2MB_ERROR(M2MB_MOD_BASE, 10)))
64 
65 
66 /* Global typedefs --------------------------------------------------------------- */
67 
68 /* Global functions =============================================================================*/
69 
70 /*-----------------------------------------------------------------------------------------------*/
108 /*-----------------------------------------------------------------------------------------------*/
109 
110 
111 INT32 m2mb_rtc_mem_alloc(UINT16 client_id, UINT16 buffer_size,
112  void **buffer_ptr);
113 
114 /*-----------------------------------------------------------------------------------------------*/
150 /*-----------------------------------------------------------------------------------------------*/
151 
152 
153 INT32 m2mb_rtc_mem_write(UINT16 client_id);
154 
155 /*-----------------------------------------------------------------------------------------------*/
188 /*-----------------------------------------------------------------------------------------------*/
189 
190 
191 INT32 m2mb_rtc_mem_read(UINT16 client_id, UINT16* buffer_size,
192  void **buffer_ptr);
193 
194 
195 /*-----------------------------------------------------------------------------------------------*/
224 /*-----------------------------------------------------------------------------------------------*/
225 
226 
227 INT32 m2mb_rtc_mem_free(UINT16 client_id);
228 
229 
233 /*-----------------------------------------------------------------------------------------------*/
234 
235 #ifdef __cplusplus
236 }
237 #endif
238 #endif /* M2MB_RTC_H */
m2mb_rtc_mem_read
INT32 m2mb_rtc_mem_read(UINT16 client_id, UINT16 *buffer_size, void **buffer_ptr)
Read data from RTC memory.
m2mb_rtc_mem_free
INT32 m2mb_rtc_mem_free(UINT16 client_id)
Free the previously alloctaed buffer in RTC memory.
m2mb_rtc_mem_alloc
INT32 m2mb_rtc_mem_alloc(UINT16 client_id, UINT16 buffer_size, void **buffer_ptr)
Allocate Buffer in RTC memory.
UINT16
unsigned short UINT16
Definition: m2mb_types.h:87
m2mb_rtc_mem_write
INT32 m2mb_rtc_mem_write(UINT16 client_id)
Save data in RTC memory.
INT32
signed int INT32
Definition: m2mb_types.h:82