rtdef.h 48 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246
  1. /*
  2. * Copyright (c) 2006-2022, RT-Thread Development Team
  3. *
  4. * SPDX-License-Identifier: Apache-2.0
  5. *
  6. * Change Logs:
  7. * Date Author Notes
  8. * 2007-01-10 Bernard the first version
  9. * 2008-07-12 Bernard remove all rt_int8, rt_uint32_t etc typedef
  10. * 2010-10-26 yi.qiu add module support
  11. * 2010-11-10 Bernard add cleanup callback function in thread exit.
  12. * 2011-05-09 Bernard use builtin va_arg in GCC 4.x
  13. * 2012-11-16 Bernard change RT_NULL from ((void*)0) to 0.
  14. * 2012-12-29 Bernard change the RT_USING_MEMPOOL location and add
  15. * RT_USING_MEMHEAP condition.
  16. * 2012-12-30 Bernard add more control command for graphic.
  17. * 2013-01-09 Bernard change version number.
  18. * 2015-02-01 Bernard change version number to v2.1.0
  19. * 2017-08-31 Bernard change version number to v3.0.0
  20. * 2017-11-30 Bernard change version number to v3.0.1
  21. * 2017-12-27 Bernard change version number to v3.0.2
  22. * 2018-02-24 Bernard change version number to v3.0.3
  23. * 2018-04-25 Bernard change version number to v3.0.4
  24. * 2018-05-31 Bernard change version number to v3.1.0
  25. * 2018-09-04 Bernard change version number to v3.1.1
  26. * 2018-09-14 Bernard apply Apache License v2.0 to RT-Thread Kernel
  27. * 2018-10-13 Bernard change version number to v4.0.0
  28. * 2018-10-02 Bernard add 64bit arch support
  29. * 2018-11-22 Jesven add smp member to struct rt_thread
  30. * add struct rt_cpu
  31. * add smp relevant macros
  32. * 2019-01-27 Bernard change version number to v4.0.1
  33. * 2019-05-17 Bernard change version number to v4.0.2
  34. * 2019-12-20 Bernard change version number to v4.0.3
  35. * 2020-08-10 Meco Man add macro for struct rt_device_ops
  36. * 2020-10-23 Meco Man define maximum value of ipc type
  37. * 2021-03-19 Meco Man add security devices
  38. * 2021-05-10 armink change version number to v4.0.4
  39. * 2021-11-19 Meco Man change version number to v4.1.0
  40. * 2021-12-21 Meco Man re-implement RT_UNUSED
  41. * 2022-01-01 Gabriel improve hooking method
  42. * 2022-01-07 Gabriel move some __on_rt_xxxxx_hook to dedicated c source files
  43. * 2022-01-12 Meco Man remove RT_THREAD_BLOCK
  44. * 2022-04-20 Meco Man change version number to v4.1.1
  45. * 2022-04-21 THEWON add macro RT_VERSION_CHECK
  46. * 2022-06-29 Meco Man add RT_USING_LIBC and standard libc headers
  47. * 2022-08-16 Meco Man change version number to v5.0.0
  48. * 2022-09-12 Meco Man define rt_ssize_t
  49. */
  50. #ifndef __RT_DEF_H__
  51. #define __RT_DEF_H__
  52. #include <rtconfig.h>
  53. #ifdef RT_USING_LIBC
  54. #include <stdint.h>
  55. #include <stddef.h>
  56. #include <stdarg.h>
  57. #include <sys/types.h>
  58. #endif /* RT_USING_LIBC */
  59. #ifdef __cplusplus
  60. extern "C" {
  61. #endif
  62. /**
  63. * @addtogroup BasicDef
  64. */
  65. /**@{*/
  66. /* RT-Thread version information */
  67. #define RT_VERSION_MAJOR 5 /**< Major version number (X.x.x) */
  68. #define RT_VERSION_MINOR 0 /**< Minor version number (x.X.x) */
  69. #define RT_VERSION_PATCH 0 /**< Patch version number (x.x.X) */
  70. /* e.g. #if (RTTHREAD_VERSION >= RT_VERSION_CHECK(4, 1, 0) */
  71. #define RT_VERSION_CHECK(major, minor, revise) ((major * 10000) + (minor * 100) + revise)
  72. /* RT-Thread version */
  73. #define RTTHREAD_VERSION RT_VERSION_CHECK(RT_VERSION_MAJOR, RT_VERSION_MINOR, RT_VERSION_PATCH)
  74. /* RT-Thread basic data type definitions */
  75. typedef int rt_bool_t; /**< boolean type */
  76. typedef signed long rt_base_t; /**< Nbit CPU related date type */
  77. typedef unsigned long rt_ubase_t; /**< Nbit unsigned CPU related data type */
  78. #ifndef RT_USING_ARCH_DATA_TYPE
  79. #ifdef RT_USING_LIBC
  80. typedef int8_t rt_int8_t; /**< 8bit integer type */
  81. typedef int16_t rt_int16_t; /**< 16bit integer type */
  82. typedef int32_t rt_int32_t; /**< 32bit integer type */
  83. typedef uint8_t rt_uint8_t; /**< 8bit unsigned integer type */
  84. typedef uint16_t rt_uint16_t; /**< 16bit unsigned integer type */
  85. typedef uint32_t rt_uint32_t; /**< 32bit unsigned integer type */
  86. typedef int64_t rt_int64_t; /**< 64bit integer type */
  87. typedef uint64_t rt_uint64_t; /**< 64bit unsigned integer type */
  88. typedef size_t rt_size_t; /**< Type for size number */
  89. typedef ssize_t rt_ssize_t; /**< Used for a count of bytes or an error indication */
  90. #else
  91. typedef signed char rt_int8_t; /**< 8bit integer type */
  92. typedef signed short rt_int16_t; /**< 16bit integer type */
  93. typedef signed int rt_int32_t; /**< 32bit integer type */
  94. typedef unsigned char rt_uint8_t; /**< 8bit unsigned integer type */
  95. typedef unsigned short rt_uint16_t; /**< 16bit unsigned integer type */
  96. typedef unsigned int rt_uint32_t; /**< 32bit unsigned integer type */
  97. #ifdef ARCH_CPU_64BIT
  98. typedef signed long rt_int64_t; /**< 64bit integer type */
  99. typedef unsigned long rt_uint64_t; /**< 64bit unsigned integer type */
  100. #else
  101. typedef signed long long rt_int64_t; /**< 64bit integer type */
  102. typedef unsigned long long rt_uint64_t; /**< 64bit unsigned integer type */
  103. #endif /* ARCH_CPU_64BIT */
  104. typedef rt_ubase_t rt_size_t; /**< Type for size number */
  105. typedef rt_base_t rt_ssize_t; /**< Used for a count of bytes or an error indication */
  106. #endif /* RT_USING_LIBC */
  107. #endif /* RT_USING_ARCH_DATA_TYPE */
  108. typedef rt_base_t rt_err_t; /**< Type for error number */
  109. typedef rt_uint32_t rt_time_t; /**< Type for time stamp */
  110. typedef rt_uint32_t rt_tick_t; /**< Type for tick count */
  111. typedef rt_base_t rt_flag_t; /**< Type for flags */
  112. typedef rt_ubase_t rt_dev_t; /**< Type for device */
  113. typedef rt_base_t rt_off_t; /**< Type for offset */
  114. /* boolean type definitions */
  115. #define RT_TRUE 1 /**< boolean true */
  116. #define RT_FALSE 0 /**< boolean fails */
  117. /* null pointer definition */
  118. #define RT_NULL 0
  119. /**@}*/
  120. /* maximum value of base type */
  121. #ifdef RT_USING_LIBC
  122. #define RT_UINT8_MAX UINT8_MAX /**< Maximum number of UINT8 */
  123. #define RT_UINT16_MAX UINT16_MAX /**< Maximum number of UINT16 */
  124. #define RT_UINT32_MAX UINT32_MAX /**< Maximum number of UINT32 */
  125. #else
  126. #define RT_UINT8_MAX 0xff /**< Maximum number of UINT8 */
  127. #define RT_UINT16_MAX 0xffff /**< Maximum number of UINT16 */
  128. #define RT_UINT32_MAX 0xffffffff /**< Maximum number of UINT32 */
  129. #endif /* RT_USING_LIBC */
  130. #define RT_TICK_MAX RT_UINT32_MAX /**< Maximum number of tick */
  131. /* maximum value of ipc type */
  132. #define RT_SEM_VALUE_MAX RT_UINT16_MAX /**< Maximum number of semaphore .value */
  133. #define RT_MUTEX_VALUE_MAX RT_UINT16_MAX /**< Maximum number of mutex .value */
  134. #define RT_MUTEX_HOLD_MAX RT_UINT8_MAX /**< Maximum number of mutex .hold */
  135. #define RT_MB_ENTRY_MAX RT_UINT16_MAX /**< Maximum number of mailbox .entry */
  136. #define RT_MQ_ENTRY_MAX RT_UINT16_MAX /**< Maximum number of message queue .entry */
  137. #define RT_UNUSED(x) ((void)x)
  138. /* Compiler Related Definitions */
  139. #if defined(__ARMCC_VERSION) /* ARM Compiler */
  140. #define RT_SECTION(x) __attribute__((section(x)))
  141. #define RT_USED __attribute__((used))
  142. #define ALIGN(n) __attribute__((aligned(n)))
  143. #define RT_WEAK __attribute__((weak))
  144. #define rt_inline static __inline
  145. /* module compiling */
  146. #ifdef RT_USING_MODULE
  147. #define RTT_API __declspec(dllimport)
  148. #else
  149. #define RTT_API __declspec(dllexport)
  150. #endif /* RT_USING_MODULE */
  151. #elif defined (__IAR_SYSTEMS_ICC__) /* for IAR Compiler */
  152. #define RT_SECTION(x) @ x
  153. #define RT_USED __root
  154. #define PRAGMA(x) _Pragma(#x)
  155. #define ALIGN(n) PRAGMA(data_alignment=n)
  156. #define RT_WEAK __weak
  157. #define rt_inline static inline
  158. #define RTT_API
  159. #elif defined (__GNUC__) /* GNU GCC Compiler */
  160. #ifndef RT_USING_LIBC
  161. /* the version of GNU GCC must be greater than 4.x */
  162. typedef __builtin_va_list __gnuc_va_list;
  163. typedef __gnuc_va_list va_list;
  164. #define va_start(v,l) __builtin_va_start(v,l)
  165. #define va_end(v) __builtin_va_end(v)
  166. #define va_arg(v,l) __builtin_va_arg(v,l)
  167. #endif /* RT_USING_LIBC */
  168. #define RT_SECTION(x) __attribute__((section(x)))
  169. #define RT_USED __attribute__((used))
  170. #define ALIGN(n) __attribute__((aligned(n)))
  171. #define RT_WEAK __attribute__((weak))
  172. #define rt_inline static __inline
  173. #define RTT_API
  174. #elif defined (__ADSPBLACKFIN__) /* for VisualDSP++ Compiler */
  175. #define RT_SECTION(x) __attribute__((section(x)))
  176. #define RT_USED __attribute__((used))
  177. #define ALIGN(n) __attribute__((aligned(n)))
  178. #define RT_WEAK __attribute__((weak))
  179. #define rt_inline static inline
  180. #define RTT_API
  181. #elif defined (_MSC_VER)
  182. #define RT_SECTION(x)
  183. #define RT_USED
  184. #define ALIGN(n) __declspec(align(n))
  185. #define RT_WEAK
  186. #define rt_inline static __inline
  187. #define RTT_API
  188. #elif defined (__TI_COMPILER_VERSION__)
  189. /* The way that TI compiler set section is different from other(at least
  190. * GCC and MDK) compilers. See ARM Optimizing C/C++ Compiler 5.9.3 for more
  191. * details. */
  192. #define RT_SECTION(x) __attribute__((section(x)))
  193. #define RT_USED __attribute__((used))
  194. #define PRAGMA(x) _Pragma(#x)
  195. #define ALIGN(n) __attribute__((aligned(n)))
  196. #define RT_WEAK __attribute__((weak))
  197. #define rt_inline static inline
  198. #define RTT_API
  199. #elif defined (__TASKING__)
  200. #define RT_SECTION(x) __attribute__((section(x)))
  201. #define RT_USED __attribute__((used, protect))
  202. #define PRAGMA(x) _Pragma(#x)
  203. #define ALIGN(n) __attribute__((__align(n)))
  204. #define RT_WEAK __attribute__((weak))
  205. #define rt_inline static inline
  206. #define RTT_API
  207. #else
  208. #error not supported tool chain
  209. #endif /* __ARMCC_VERSION */
  210. /* initialization export */
  211. #ifdef RT_USING_COMPONENTS_INIT
  212. typedef int (*init_fn_t)(void);
  213. #ifdef _MSC_VER
  214. #pragma section("rti_fn$f",read)
  215. #if RT_DEBUG_INIT
  216. struct rt_init_desc
  217. {
  218. const char* level;
  219. const init_fn_t fn;
  220. const char* fn_name;
  221. };
  222. #define INIT_EXPORT(fn, level) \
  223. const char __rti_level_##fn[] = ".rti_fn." level; \
  224. const char __rti_##fn##_name[] = #fn; \
  225. __declspec(allocate("rti_fn$f")) \
  226. RT_USED const struct rt_init_desc __rt_init_msc_##fn = \
  227. {__rti_level_##fn, fn, __rti_##fn##_name};
  228. #else
  229. struct rt_init_desc
  230. {
  231. const char* level;
  232. const init_fn_t fn;
  233. };
  234. #define INIT_EXPORT(fn, level) \
  235. const char __rti_level_##fn[] = ".rti_fn." level; \
  236. __declspec(allocate("rti_fn$f")) \
  237. RT_USED const struct rt_init_desc __rt_init_msc_##fn = \
  238. {__rti_level_##fn, fn };
  239. #endif
  240. #else
  241. #if RT_DEBUG_INIT
  242. struct rt_init_desc
  243. {
  244. const char* fn_name;
  245. const init_fn_t fn;
  246. };
  247. #define INIT_EXPORT(fn, level) \
  248. const char __rti_##fn##_name[] = #fn; \
  249. RT_USED const struct rt_init_desc __rt_init_desc_##fn RT_SECTION(".rti_fn." level) = \
  250. { __rti_##fn##_name, fn};
  251. #else
  252. #define INIT_EXPORT(fn, level) \
  253. RT_USED const init_fn_t __rt_init_##fn RT_SECTION(".rti_fn." level) = fn
  254. #endif
  255. #endif
  256. #else
  257. #define INIT_EXPORT(fn, level)
  258. #endif
  259. /* board init routines will be called in board_init() function */
  260. #define INIT_BOARD_EXPORT(fn) INIT_EXPORT(fn, "1")
  261. /* pre/device/component/env/app init routines will be called in init_thread */
  262. /* components pre-initialization (pure software initialization) */
  263. #define INIT_PREV_EXPORT(fn) INIT_EXPORT(fn, "2")
  264. /* device initialization */
  265. #define INIT_DEVICE_EXPORT(fn) INIT_EXPORT(fn, "3")
  266. /* components initialization (dfs, lwip, ...) */
  267. #define INIT_COMPONENT_EXPORT(fn) INIT_EXPORT(fn, "4")
  268. /* environment initialization (mount disk, ...) */
  269. #define INIT_ENV_EXPORT(fn) INIT_EXPORT(fn, "5")
  270. /* application initialization (rtgui application etc ...) */
  271. #define INIT_APP_EXPORT(fn) INIT_EXPORT(fn, "6")
  272. #if !defined(RT_USING_FINSH)
  273. /* define these to empty, even if not include finsh.h file */
  274. #define FINSH_FUNCTION_EXPORT(name, desc)
  275. #define FINSH_FUNCTION_EXPORT_ALIAS(name, alias, desc)
  276. #define MSH_CMD_EXPORT(command, desc)
  277. #define MSH_CMD_EXPORT_ALIAS(command, alias, desc)
  278. #elif !defined(FINSH_USING_SYMTAB)
  279. #define FINSH_FUNCTION_EXPORT_CMD(name, cmd, desc)
  280. #endif
  281. /* event length */
  282. #define RT_EVENT_LENGTH 32
  283. /* memory management option */
  284. #define RT_MM_PAGE_SIZE 4096
  285. #define RT_MM_PAGE_MASK (RT_MM_PAGE_SIZE - 1)
  286. #define RT_MM_PAGE_BITS 12
  287. /* kernel malloc definitions */
  288. #ifndef RT_KERNEL_MALLOC
  289. #define RT_KERNEL_MALLOC(sz) rt_malloc(sz)
  290. #endif
  291. #ifndef RT_KERNEL_FREE
  292. #define RT_KERNEL_FREE(ptr) rt_free(ptr)
  293. #endif
  294. #ifndef RT_KERNEL_REALLOC
  295. #define RT_KERNEL_REALLOC(ptr, size) rt_realloc(ptr, size)
  296. #endif
  297. /**
  298. * @addtogroup Error
  299. */
  300. /**@{*/
  301. /* RT-Thread error code definitions */
  302. #define RT_EOK 0 /**< There is no error */
  303. #define RT_ERROR 1 /**< A generic error happens */
  304. #define RT_ETIMEOUT 2 /**< Timed out */
  305. #define RT_EFULL 3 /**< The resource is full */
  306. #define RT_EEMPTY 4 /**< The resource is empty */
  307. #define RT_ENOMEM 5 /**< No memory */
  308. #define RT_ENOSYS 6 /**< No system */
  309. #define RT_EBUSY 7 /**< Busy */
  310. #define RT_EIO 8 /**< IO error */
  311. #define RT_EINTR 9 /**< Interrupted system call */
  312. #define RT_EINVAL 10 /**< Invalid argument */
  313. /**@}*/
  314. /**
  315. * @ingroup BasicDef
  316. *
  317. * @def RT_ALIGN(size, align)
  318. * Return the most contiguous size aligned at specified width. RT_ALIGN(13, 4)
  319. * would return 16.
  320. */
  321. #define RT_ALIGN(size, align) (((size) + (align) - 1) & ~((align) - 1))
  322. /**
  323. * @ingroup BasicDef
  324. *
  325. * @def RT_ALIGN_DOWN(size, align)
  326. * Return the down number of aligned at specified width. RT_ALIGN_DOWN(13, 4)
  327. * would return 12.
  328. */
  329. #define RT_ALIGN_DOWN(size, align) ((size) & ~((align) - 1))
  330. /**
  331. * Double List structure
  332. */
  333. struct rt_list_node
  334. {
  335. struct rt_list_node *next; /**< point to next node. */
  336. struct rt_list_node *prev; /**< point to prev node. */
  337. };
  338. typedef struct rt_list_node rt_list_t; /**< Type for lists. */
  339. /**
  340. * Single List structure
  341. */
  342. struct rt_slist_node
  343. {
  344. struct rt_slist_node *next; /**< point to next node. */
  345. };
  346. typedef struct rt_slist_node rt_slist_t; /**< Type for single list. */
  347. /**
  348. * @addtogroup KernelObject
  349. */
  350. /**@{*/
  351. /*
  352. * kernel object macros
  353. */
  354. #define RT_OBJECT_FLAG_MODULE 0x80 /**< is module object. */
  355. /**
  356. * Base structure of Kernel object
  357. */
  358. struct rt_object
  359. {
  360. char name[RT_NAME_MAX]; /**< name of kernel object */
  361. rt_uint8_t type; /**< type of kernel object */
  362. rt_uint8_t flag; /**< flag of kernel object */
  363. #ifdef RT_USING_MODULE
  364. void *module_id; /**< id of application module */
  365. #endif /* RT_USING_MODULE */
  366. rt_list_t list; /**< list node of kernel object */
  367. };
  368. typedef struct rt_object *rt_object_t; /**< Type for kernel objects. */
  369. /**
  370. * The object type can be one of the follows with specific
  371. * macros enabled:
  372. * - Thread
  373. * - Semaphore
  374. * - Mutex
  375. * - Event
  376. * - MailBox
  377. * - MessageQueue
  378. * - MemHeap
  379. * - MemPool
  380. * - Device
  381. * - Timer
  382. * - Module
  383. * - Unknown
  384. * - Static
  385. */
  386. enum rt_object_class_type
  387. {
  388. RT_Object_Class_Null = 0x00, /**< The object is not used. */
  389. RT_Object_Class_Thread = 0x01, /**< The object is a thread. */
  390. RT_Object_Class_Semaphore = 0x02, /**< The object is a semaphore. */
  391. RT_Object_Class_Mutex = 0x03, /**< The object is a mutex. */
  392. RT_Object_Class_Event = 0x04, /**< The object is a event. */
  393. RT_Object_Class_MailBox = 0x05, /**< The object is a mail box. */
  394. RT_Object_Class_MessageQueue = 0x06, /**< The object is a message queue. */
  395. RT_Object_Class_MemHeap = 0x07, /**< The object is a memory heap. */
  396. RT_Object_Class_MemPool = 0x08, /**< The object is a memory pool. */
  397. RT_Object_Class_Device = 0x09, /**< The object is a device. */
  398. RT_Object_Class_Timer = 0x0a, /**< The object is a timer. */
  399. RT_Object_Class_Module = 0x0b, /**< The object is a module. */
  400. RT_Object_Class_Memory = 0x0c, /**< The object is a memory. */
  401. RT_Object_Class_Unknown = 0x0e, /**< The object is unknown. */
  402. RT_Object_Class_Static = 0x80 /**< The object is a static object. */
  403. };
  404. /**
  405. * The information of the kernel object
  406. */
  407. struct rt_object_information
  408. {
  409. enum rt_object_class_type type; /**< object class type */
  410. rt_list_t object_list; /**< object list */
  411. rt_size_t object_size; /**< object size */
  412. };
  413. /**
  414. * The hook function call macro
  415. */
  416. #ifndef RT_USING_HOOK
  417. #define __ON_HOOK_ARGS(__hook, argv)
  418. #define RT_OBJECT_HOOK_CALL(func, argv)
  419. #else
  420. #define RT_OBJECT_HOOK_CALL(func, argv) __on_##func argv
  421. #ifdef RT_HOOK_USING_FUNC_PTR
  422. #define __ON_HOOK_ARGS(__hook, argv) do {if ((__hook) != RT_NULL) __hook argv; } while (0)
  423. #else
  424. #define __ON_HOOK_ARGS(__hook, argv)
  425. #endif /* RT_HOOK_USING_FUNC_PTR */
  426. #endif /* RT_USING_HOOK */
  427. #ifndef __on_rt_interrupt_switch_hook
  428. #define __on_rt_interrupt_switch_hook() __ON_HOOK_ARGS(rt_interrupt_switch_hook, ())
  429. #endif
  430. #ifndef __on_rt_malloc_hook
  431. #define __on_rt_malloc_hook(addr, size) __ON_HOOK_ARGS(rt_malloc_hook, (addr, size))
  432. #endif
  433. #ifndef __on_rt_free_hook
  434. #define __on_rt_free_hook(rmem) __ON_HOOK_ARGS(rt_free_hook, (rmem))
  435. #endif
  436. /**@}*/
  437. /**
  438. * @addtogroup Clock
  439. */
  440. /**@{*/
  441. /**
  442. * clock & timer macros
  443. */
  444. #define RT_TIMER_FLAG_DEACTIVATED 0x0 /**< timer is deactive */
  445. #define RT_TIMER_FLAG_ACTIVATED 0x1 /**< timer is active */
  446. #define RT_TIMER_FLAG_ONE_SHOT 0x0 /**< one shot timer */
  447. #define RT_TIMER_FLAG_PERIODIC 0x2 /**< periodic timer */
  448. #define RT_TIMER_FLAG_HARD_TIMER 0x0 /**< hard timer,the timer's callback function will be called in tick isr. */
  449. #define RT_TIMER_FLAG_SOFT_TIMER 0x4 /**< soft timer,the timer's callback function will be called in timer thread. */
  450. #define RT_TIMER_CTRL_SET_TIME 0x0 /**< set timer control command */
  451. #define RT_TIMER_CTRL_GET_TIME 0x1 /**< get timer control command */
  452. #define RT_TIMER_CTRL_SET_ONESHOT 0x2 /**< change timer to one shot */
  453. #define RT_TIMER_CTRL_SET_PERIODIC 0x3 /**< change timer to periodic */
  454. #define RT_TIMER_CTRL_GET_STATE 0x4 /**< get timer run state active or deactive*/
  455. #define RT_TIMER_CTRL_GET_REMAIN_TIME 0x5 /**< get the remaining hang time */
  456. #ifndef RT_TIMER_SKIP_LIST_LEVEL
  457. #define RT_TIMER_SKIP_LIST_LEVEL 1
  458. #endif
  459. /* 1 or 3 */
  460. #ifndef RT_TIMER_SKIP_LIST_MASK
  461. #define RT_TIMER_SKIP_LIST_MASK 0x3 /**< Timer skips the list mask */
  462. #endif
  463. /**
  464. * timer structure
  465. */
  466. struct rt_timer
  467. {
  468. struct rt_object parent; /**< inherit from rt_object */
  469. rt_list_t row[RT_TIMER_SKIP_LIST_LEVEL];
  470. void (*timeout_func)(void *parameter); /**< timeout function */
  471. void *parameter; /**< timeout function's parameter */
  472. rt_tick_t init_tick; /**< timer timeout tick */
  473. rt_tick_t timeout_tick; /**< timeout tick */
  474. };
  475. typedef struct rt_timer *rt_timer_t;
  476. /**@}*/
  477. /**
  478. * @addtogroup Signal
  479. */
  480. #ifdef RT_USING_SIGNALS
  481. #include <sys/signal.h>
  482. typedef unsigned long rt_sigset_t;
  483. typedef void (*rt_sighandler_t)(int signo);
  484. typedef siginfo_t rt_siginfo_t;
  485. #define RT_SIG_MAX 32
  486. #endif /* RT_USING_SIGNALS */
  487. /**@}*/
  488. /**
  489. * @addtogroup Thread
  490. */
  491. /**@{*/
  492. /*
  493. * Thread
  494. */
  495. /*
  496. * thread state definitions
  497. */
  498. #define RT_THREAD_INIT 0x00 /**< Initialized status */
  499. #define RT_THREAD_READY 0x01 /**< Ready status */
  500. #define RT_THREAD_SUSPEND 0x02 /**< Suspend status */
  501. #define RT_THREAD_RUNNING 0x03 /**< Running status */
  502. #define RT_THREAD_CLOSE 0x04 /**< Closed status */
  503. #define RT_THREAD_STAT_MASK 0x07
  504. #define RT_THREAD_STAT_YIELD 0x08 /**< indicate whether remaining_tick has been reloaded since last schedule */
  505. #define RT_THREAD_STAT_YIELD_MASK RT_THREAD_STAT_YIELD
  506. #define RT_THREAD_STAT_SIGNAL 0x10 /**< task hold signals */
  507. #define RT_THREAD_STAT_SIGNAL_READY (RT_THREAD_STAT_SIGNAL | RT_THREAD_READY)
  508. #define RT_THREAD_STAT_SIGNAL_WAIT 0x20 /**< task is waiting for signals */
  509. #define RT_THREAD_STAT_SIGNAL_PENDING 0x40 /**< signals is held and it has not been procressed */
  510. #define RT_THREAD_STAT_SIGNAL_MASK 0xf0
  511. /**
  512. * thread control command definitions
  513. */
  514. #define RT_THREAD_CTRL_STARTUP 0x00 /**< Startup thread. */
  515. #define RT_THREAD_CTRL_CLOSE 0x01 /**< Close thread. */
  516. #define RT_THREAD_CTRL_CHANGE_PRIORITY 0x02 /**< Change thread priority. */
  517. #define RT_THREAD_CTRL_INFO 0x03 /**< Get thread information. */
  518. #define RT_THREAD_CTRL_BIND_CPU 0x04 /**< Set thread bind cpu. */
  519. #ifdef RT_USING_SMP
  520. #define RT_CPU_DETACHED RT_CPUS_NR /**< The thread not running on cpu. */
  521. #define RT_CPU_MASK ((1 << RT_CPUS_NR) - 1) /**< All CPUs mask bit. */
  522. #ifndef RT_SCHEDULE_IPI
  523. #define RT_SCHEDULE_IPI 0
  524. #endif /* RT_SCHEDULE_IPI */
  525. #ifndef RT_STOP_IPI
  526. #define RT_STOP_IPI 1
  527. #endif /* RT_STOP_IPI */
  528. /**
  529. * CPUs definitions
  530. *
  531. */
  532. struct rt_cpu
  533. {
  534. struct rt_thread *current_thread;
  535. rt_uint16_t irq_nest;
  536. rt_uint8_t irq_switch_flag;
  537. rt_uint8_t current_priority;
  538. rt_list_t priority_table[RT_THREAD_PRIORITY_MAX];
  539. #if RT_THREAD_PRIORITY_MAX > 32
  540. rt_uint32_t priority_group;
  541. rt_uint8_t ready_table[32];
  542. #else
  543. rt_uint32_t priority_group;
  544. #endif /* RT_THREAD_PRIORITY_MAX > 32 */
  545. rt_tick_t tick;
  546. };
  547. #endif /* RT_USING_SMP */
  548. /**
  549. * Thread structure
  550. */
  551. struct rt_thread
  552. {
  553. /* rt object */
  554. char name[RT_NAME_MAX]; /**< the name of thread */
  555. rt_uint8_t type; /**< type of object */
  556. rt_uint8_t flags; /**< thread's flags */
  557. #ifdef RT_USING_MODULE
  558. void *module_id; /**< id of application module */
  559. #endif /* RT_USING_MODULE */
  560. rt_list_t list; /**< the object list */
  561. rt_list_t tlist; /**< the thread list */
  562. /* stack point and entry */
  563. void *sp; /**< stack point */
  564. void *entry; /**< entry */
  565. void *parameter; /**< parameter */
  566. void *stack_addr; /**< stack address */
  567. rt_uint32_t stack_size; /**< stack size */
  568. /* error code */
  569. rt_err_t error; /**< error code */
  570. rt_uint8_t stat; /**< thread status */
  571. #ifdef RT_USING_SMP
  572. rt_uint8_t bind_cpu; /**< thread is bind to cpu */
  573. rt_uint8_t oncpu; /**< process on cpu */
  574. rt_uint16_t scheduler_lock_nest; /**< scheduler lock count */
  575. rt_uint16_t cpus_lock_nest; /**< cpus lock count */
  576. rt_uint16_t critical_lock_nest; /**< critical lock count */
  577. #endif /*RT_USING_SMP*/
  578. /* priority */
  579. rt_uint8_t current_priority; /**< current priority */
  580. rt_uint8_t init_priority; /**< initialized priority */
  581. #if RT_THREAD_PRIORITY_MAX > 32
  582. rt_uint8_t number;
  583. rt_uint8_t high_mask;
  584. #endif /* RT_THREAD_PRIORITY_MAX > 32 */
  585. rt_uint32_t number_mask;
  586. #ifdef RT_USING_MUTEX
  587. /* object for IPC */
  588. rt_list_t taken_object_list;
  589. rt_object_t pending_object;
  590. #endif
  591. #ifdef RT_USING_EVENT
  592. /* thread event */
  593. rt_uint32_t event_set;
  594. rt_uint8_t event_info;
  595. #endif /* RT_USING_EVENT */
  596. #ifdef RT_USING_SIGNALS
  597. rt_sigset_t sig_pending; /**< the pending signals */
  598. rt_sigset_t sig_mask; /**< the mask bits of signal */
  599. #ifndef RT_USING_SMP
  600. void *sig_ret; /**< the return stack pointer from signal */
  601. #endif /* RT_USING_SMP */
  602. rt_sighandler_t *sig_vectors; /**< vectors of signal handler */
  603. void *si_list; /**< the signal infor list */
  604. #endif /* RT_USING_SIGNALS */
  605. rt_ubase_t init_tick; /**< thread's initialized tick */
  606. rt_ubase_t remaining_tick; /**< remaining tick */
  607. #ifdef RT_USING_CPU_USAGE
  608. rt_uint64_t duration_tick; /**< cpu usage tick */
  609. #endif /* RT_USING_CPU_USAGE */
  610. #ifdef RT_USING_PTHREADS
  611. void *pthread_data; /**< the handle of pthread data, adapt 32/64bit */
  612. #endif /* RT_USING_PTHREADS */
  613. struct rt_timer thread_timer; /**< built-in thread timer */
  614. void (*cleanup)(struct rt_thread *tid); /**< cleanup function when thread exit */
  615. /* light weight process if present */
  616. #ifdef RT_USING_LWP
  617. void *lwp;
  618. #endif /* RT_USING_LWP */
  619. rt_ubase_t user_data; /**< private user data beyond this thread */
  620. };
  621. typedef struct rt_thread *rt_thread_t;
  622. /**@}*/
  623. /**
  624. * @addtogroup IPC
  625. */
  626. /**@{*/
  627. /**
  628. * IPC flags and control command definitions
  629. */
  630. #define RT_IPC_FLAG_FIFO 0x00 /**< FIFOed IPC. @ref IPC. */
  631. #define RT_IPC_FLAG_PRIO 0x01 /**< PRIOed IPC. @ref IPC. */
  632. #define RT_IPC_CMD_UNKNOWN 0x00 /**< unknown IPC command */
  633. #define RT_IPC_CMD_RESET 0x01 /**< reset IPC object */
  634. #define RT_WAITING_FOREVER -1 /**< Block forever until get resource. */
  635. #define RT_WAITING_NO 0 /**< Non-block. */
  636. /**
  637. * Base structure of IPC object
  638. */
  639. struct rt_ipc_object
  640. {
  641. struct rt_object parent; /**< inherit from rt_object */
  642. rt_list_t suspend_thread; /**< threads pended on this resource */
  643. };
  644. #ifdef RT_USING_SEMAPHORE
  645. /**
  646. * Semaphore structure
  647. */
  648. struct rt_semaphore
  649. {
  650. struct rt_ipc_object parent; /**< inherit from ipc_object */
  651. rt_uint16_t value; /**< value of semaphore. */
  652. rt_uint16_t reserved; /**< reserved field */
  653. };
  654. typedef struct rt_semaphore *rt_sem_t;
  655. #endif /* RT_USING_SEMAPHORE */
  656. #ifdef RT_USING_MUTEX
  657. /**
  658. * Mutual exclusion (mutex) structure
  659. */
  660. struct rt_mutex
  661. {
  662. struct rt_ipc_object parent; /**< inherit from ipc_object */
  663. rt_uint8_t ceiling_priority; /**< the priority ceiling of mutexe */
  664. rt_uint8_t priority; /**< the maximal priority for pending thread */
  665. rt_uint8_t hold; /**< numbers of thread hold the mutex */
  666. rt_uint8_t reserv;
  667. struct rt_thread *owner; /**< current owner of mutex */
  668. rt_list_t taken_list; /**< the object list taken by thread */
  669. };
  670. typedef struct rt_mutex *rt_mutex_t;
  671. #endif /* RT_USING_MUTEX */
  672. #ifdef RT_USING_EVENT
  673. /**
  674. * flag definitions in event
  675. */
  676. #define RT_EVENT_FLAG_AND 0x01 /**< logic and */
  677. #define RT_EVENT_FLAG_OR 0x02 /**< logic or */
  678. #define RT_EVENT_FLAG_CLEAR 0x04 /**< clear flag */
  679. /*
  680. * event structure
  681. */
  682. struct rt_event
  683. {
  684. struct rt_ipc_object parent; /**< inherit from ipc_object */
  685. rt_uint32_t set; /**< event set */
  686. };
  687. typedef struct rt_event *rt_event_t;
  688. #endif /* RT_USING_EVENT */
  689. #ifdef RT_USING_MAILBOX
  690. /**
  691. * mailbox structure
  692. */
  693. struct rt_mailbox
  694. {
  695. struct rt_ipc_object parent; /**< inherit from ipc_object */
  696. rt_ubase_t *msg_pool; /**< start address of message buffer */
  697. rt_uint16_t size; /**< size of message pool */
  698. rt_uint16_t entry; /**< index of messages in msg_pool */
  699. rt_uint16_t in_offset; /**< input offset of the message buffer */
  700. rt_uint16_t out_offset; /**< output offset of the message buffer */
  701. rt_list_t suspend_sender_thread; /**< sender thread suspended on this mailbox */
  702. };
  703. typedef struct rt_mailbox *rt_mailbox_t;
  704. #endif /* RT_USING_MAILBOX */
  705. #ifdef RT_USING_MESSAGEQUEUE
  706. /**
  707. * message queue structure
  708. */
  709. struct rt_messagequeue
  710. {
  711. struct rt_ipc_object parent; /**< inherit from ipc_object */
  712. void *msg_pool; /**< start address of message queue */
  713. rt_uint16_t msg_size; /**< message size of each message */
  714. rt_uint16_t max_msgs; /**< max number of messages */
  715. rt_uint16_t entry; /**< index of messages in the queue */
  716. void *msg_queue_head; /**< list head */
  717. void *msg_queue_tail; /**< list tail */
  718. void *msg_queue_free; /**< pointer indicated the free node of queue */
  719. rt_list_t suspend_sender_thread; /**< sender thread suspended on this message queue */
  720. };
  721. typedef struct rt_messagequeue *rt_mq_t;
  722. #endif /* RT_USING_MESSAGEQUEUE */
  723. /**@}*/
  724. /**
  725. * @addtogroup MM
  726. */
  727. /**@{*/
  728. #ifdef RT_USING_HEAP
  729. /*
  730. * memory structure
  731. */
  732. struct rt_memory
  733. {
  734. struct rt_object parent; /**< inherit from rt_object */
  735. const char * algorithm; /**< Memory management algorithm name */
  736. rt_ubase_t address; /**< memory start address */
  737. rt_size_t total; /**< memory size */
  738. rt_size_t used; /**< size used */
  739. rt_size_t max; /**< maximum usage */
  740. };
  741. typedef struct rt_memory *rt_mem_t;
  742. #endif /* RT_USING_HEAP */
  743. /*
  744. * memory management
  745. * heap & partition
  746. */
  747. #ifdef RT_USING_SMALL_MEM
  748. typedef rt_mem_t rt_smem_t;
  749. #endif /* RT_USING_SMALL_MEM */
  750. #ifdef RT_USING_SLAB
  751. typedef rt_mem_t rt_slab_t;
  752. #endif /* RT_USING_SLAB */
  753. #ifdef RT_USING_MEMHEAP
  754. /**
  755. * memory item on the heap
  756. */
  757. struct rt_memheap_item
  758. {
  759. rt_uint32_t magic; /**< magic number for memheap */
  760. struct rt_memheap *pool_ptr; /**< point of pool */
  761. struct rt_memheap_item *next; /**< next memheap item */
  762. struct rt_memheap_item *prev; /**< prev memheap item */
  763. struct rt_memheap_item *next_free; /**< next free memheap item */
  764. struct rt_memheap_item *prev_free; /**< prev free memheap item */
  765. #ifdef RT_USING_MEMTRACE
  766. rt_uint8_t owner_thread_name[4]; /**< owner thread name */
  767. #endif /* RT_USING_MEMTRACE */
  768. };
  769. /**
  770. * Base structure of memory heap object
  771. */
  772. struct rt_memheap
  773. {
  774. struct rt_object parent; /**< inherit from rt_object */
  775. void *start_addr; /**< pool start address and size */
  776. rt_size_t pool_size; /**< pool size */
  777. rt_size_t available_size; /**< available size */
  778. rt_size_t max_used_size; /**< maximum allocated size */
  779. struct rt_memheap_item *block_list; /**< used block list */
  780. struct rt_memheap_item *free_list; /**< free block list */
  781. struct rt_memheap_item free_header; /**< free block list header */
  782. struct rt_semaphore lock; /**< semaphore lock */
  783. rt_bool_t locked; /**< External lock mark */
  784. };
  785. #endif /* RT_USING_MEMHEAP */
  786. #ifdef RT_USING_MEMPOOL
  787. /**
  788. * Base structure of Memory pool object
  789. */
  790. struct rt_mempool
  791. {
  792. struct rt_object parent; /**< inherit from rt_object */
  793. void *start_address; /**< memory pool start */
  794. rt_size_t size; /**< size of memory pool */
  795. rt_size_t block_size; /**< size of memory blocks */
  796. rt_uint8_t *block_list; /**< memory blocks list */
  797. rt_size_t block_total_count; /**< numbers of memory block */
  798. rt_size_t block_free_count; /**< numbers of free memory block */
  799. rt_list_t suspend_thread; /**< threads pended on this resource */
  800. };
  801. typedef struct rt_mempool *rt_mp_t;
  802. #endif /* RT_USING_MEMPOOL */
  803. /**@}*/
  804. #ifdef RT_USING_DEVICE
  805. /**
  806. * @addtogroup Device
  807. */
  808. /**@{*/
  809. /**
  810. * device (I/O) class type
  811. */
  812. enum rt_device_class_type
  813. {
  814. RT_Device_Class_Char = 0, /**< character device */
  815. RT_Device_Class_Block, /**< block device */
  816. RT_Device_Class_NetIf, /**< net interface */
  817. RT_Device_Class_MTD, /**< memory device */
  818. RT_Device_Class_CAN, /**< CAN device */
  819. RT_Device_Class_RTC, /**< RTC device */
  820. RT_Device_Class_Sound, /**< Sound device */
  821. RT_Device_Class_Graphic, /**< Graphic device */
  822. RT_Device_Class_I2CBUS, /**< I2C bus device */
  823. RT_Device_Class_USBDevice, /**< USB slave device */
  824. RT_Device_Class_USBHost, /**< USB host bus */
  825. RT_Device_Class_USBOTG, /**< USB OTG bus */
  826. RT_Device_Class_SPIBUS, /**< SPI bus device */
  827. RT_Device_Class_SPIDevice, /**< SPI device */
  828. RT_Device_Class_SDIO, /**< SDIO bus device */
  829. RT_Device_Class_PM, /**< PM pseudo device */
  830. RT_Device_Class_Pipe, /**< Pipe device */
  831. RT_Device_Class_Portal, /**< Portal device */
  832. RT_Device_Class_Timer, /**< Timer device */
  833. RT_Device_Class_Miscellaneous, /**< Miscellaneous device */
  834. RT_Device_Class_Sensor, /**< Sensor device */
  835. RT_Device_Class_Touch, /**< Touch device */
  836. RT_Device_Class_PHY, /**< PHY device */
  837. RT_Device_Class_Security, /**< Security device */
  838. RT_Device_Class_WLAN, /**< WLAN device */
  839. RT_Device_Class_Pin, /**< Pin device */
  840. RT_Device_Class_ADC, /**< ADC device */
  841. RT_Device_Class_DAC, /**< DAC device */
  842. RT_Device_Class_WDT, /**< WDT device */
  843. RT_Device_Class_PWM, /**< PWM device */
  844. RT_Device_Class_Unknown /**< unknown device */
  845. };
  846. /**
  847. * device flags definitions
  848. */
  849. #define RT_DEVICE_FLAG_DEACTIVATE 0x000 /**< device is not not initialized */
  850. #define RT_DEVICE_FLAG_RDONLY 0x001 /**< read only */
  851. #define RT_DEVICE_FLAG_WRONLY 0x002 /**< write only */
  852. #define RT_DEVICE_FLAG_RDWR 0x003 /**< read and write */
  853. #define RT_DEVICE_FLAG_REMOVABLE 0x004 /**< removable device */
  854. #define RT_DEVICE_FLAG_STANDALONE 0x008 /**< standalone device */
  855. #define RT_DEVICE_FLAG_ACTIVATED 0x010 /**< device is activated */
  856. #define RT_DEVICE_FLAG_SUSPENDED 0x020 /**< device is suspended */
  857. #define RT_DEVICE_FLAG_STREAM 0x040 /**< stream mode */
  858. #define RT_DEVICE_FLAG_INT_RX 0x100 /**< INT mode on Rx */
  859. #define RT_DEVICE_FLAG_DMA_RX 0x200 /**< DMA mode on Rx */
  860. #define RT_DEVICE_FLAG_INT_TX 0x400 /**< INT mode on Tx */
  861. #define RT_DEVICE_FLAG_DMA_TX 0x800 /**< DMA mode on Tx */
  862. #define RT_DEVICE_OFLAG_CLOSE 0x000 /**< device is closed */
  863. #define RT_DEVICE_OFLAG_RDONLY 0x001 /**< read only access */
  864. #define RT_DEVICE_OFLAG_WRONLY 0x002 /**< write only access */
  865. #define RT_DEVICE_OFLAG_RDWR 0x003 /**< read and write */
  866. #define RT_DEVICE_OFLAG_OPEN 0x008 /**< device is opened */
  867. #define RT_DEVICE_OFLAG_MASK 0xf0f /**< mask of open flag */
  868. /**
  869. * general device commands
  870. */
  871. #define RT_DEVICE_CTRL_RESUME 0x01 /**< resume device */
  872. #define RT_DEVICE_CTRL_SUSPEND 0x02 /**< suspend device */
  873. #define RT_DEVICE_CTRL_CONFIG 0x03 /**< configure device */
  874. #define RT_DEVICE_CTRL_CLOSE 0x04 /**< close device */
  875. #define RT_DEVICE_CTRL_SET_INT 0x10 /**< set interrupt */
  876. #define RT_DEVICE_CTRL_CLR_INT 0x11 /**< clear interrupt */
  877. #define RT_DEVICE_CTRL_GET_INT 0x12 /**< get interrupt status */
  878. /**
  879. * device control
  880. */
  881. #define RT_DEVICE_CTRL_BASE(Type) (RT_Device_Class_##Type * 0x100)
  882. /**
  883. * special device commands
  884. */
  885. #define RT_DEVICE_CTRL_CHAR_STREAM (RT_DEVICE_CTRL_BASE(Char) + 1) /**< stream mode on char device */
  886. #define RT_DEVICE_CTRL_BLK_GETGEOME (RT_DEVICE_CTRL_BASE(Block) + 1) /**< get geometry information */
  887. #define RT_DEVICE_CTRL_BLK_SYNC (RT_DEVICE_CTRL_BASE(Block) + 2) /**< flush data to block device */
  888. #define RT_DEVICE_CTRL_BLK_ERASE (RT_DEVICE_CTRL_BASE(Block) + 3) /**< erase block on block device */
  889. #define RT_DEVICE_CTRL_BLK_AUTOREFRESH (RT_DEVICE_CTRL_BASE(Block) + 4) /**< block device : enter/exit auto refresh mode */
  890. #define RT_DEVICE_CTRL_NETIF_GETMAC (RT_DEVICE_CTRL_BASE(NetIf) + 1) /**< get mac address */
  891. #define RT_DEVICE_CTRL_MTD_FORMAT (RT_DEVICE_CTRL_BASE(MTD) + 1) /**< format a MTD device */
  892. typedef struct rt_device *rt_device_t;
  893. #ifdef RT_USING_DEVICE_OPS
  894. /**
  895. * operations set for device object
  896. */
  897. struct rt_device_ops
  898. {
  899. /* common device interface */
  900. rt_err_t (*init) (rt_device_t dev);
  901. rt_err_t (*open) (rt_device_t dev, rt_uint16_t oflag);
  902. rt_err_t (*close) (rt_device_t dev);
  903. rt_size_t (*read) (rt_device_t dev, rt_off_t pos, void *buffer, rt_size_t size);
  904. rt_size_t (*write) (rt_device_t dev, rt_off_t pos, const void *buffer, rt_size_t size);
  905. rt_err_t (*control)(rt_device_t dev, int cmd, void *args);
  906. };
  907. #endif /* RT_USING_DEVICE_OPS */
  908. /**
  909. * WaitQueue structure
  910. */
  911. struct rt_wqueue
  912. {
  913. rt_uint32_t flag;
  914. rt_list_t waiting_list;
  915. };
  916. typedef struct rt_wqueue rt_wqueue_t;
  917. /**
  918. * Device structure
  919. */
  920. struct rt_device
  921. {
  922. struct rt_object parent; /**< inherit from rt_object */
  923. enum rt_device_class_type type; /**< device type */
  924. rt_uint16_t flag; /**< device flag */
  925. rt_uint16_t open_flag; /**< device open flag */
  926. rt_uint8_t ref_count; /**< reference count */
  927. rt_uint8_t device_id; /**< 0 - 255 */
  928. /* device call back */
  929. rt_err_t (*rx_indicate)(rt_device_t dev, rt_size_t size);
  930. rt_err_t (*tx_complete)(rt_device_t dev, void *buffer);
  931. #ifdef RT_USING_DEVICE_OPS
  932. const struct rt_device_ops *ops;
  933. #else
  934. /* common device interface */
  935. rt_err_t (*init) (rt_device_t dev);
  936. rt_err_t (*open) (rt_device_t dev, rt_uint16_t oflag);
  937. rt_err_t (*close) (rt_device_t dev);
  938. rt_size_t (*read) (rt_device_t dev, rt_off_t pos, void *buffer, rt_size_t size);
  939. rt_size_t (*write) (rt_device_t dev, rt_off_t pos, const void *buffer, rt_size_t size);
  940. rt_err_t (*control)(rt_device_t dev, int cmd, void *args);
  941. #endif /* RT_USING_DEVICE_OPS */
  942. #ifdef RT_USING_POSIX_DEVIO
  943. const struct dfs_file_ops *fops;
  944. struct rt_wqueue wait_queue;
  945. #endif /* RT_USING_POSIX_DEVIO */
  946. void *user_data; /**< device private data */
  947. };
  948. /**
  949. * block device geometry structure
  950. */
  951. struct rt_device_blk_geometry
  952. {
  953. rt_uint32_t sector_count; /**< count of sectors */
  954. rt_uint32_t bytes_per_sector; /**< number of bytes per sector */
  955. rt_uint32_t block_size; /**< number of bytes to erase one block */
  956. };
  957. /**
  958. * sector arrange struct on block device
  959. */
  960. struct rt_device_blk_sectors
  961. {
  962. rt_uint32_t sector_begin; /**< begin sector */
  963. rt_uint32_t sector_end; /**< end sector */
  964. };
  965. /**
  966. * cursor control command
  967. */
  968. #define RT_DEVICE_CTRL_CURSOR_SET_POSITION 0x10
  969. #define RT_DEVICE_CTRL_CURSOR_SET_TYPE 0x11
  970. /**
  971. * graphic device control command
  972. */
  973. #define RTGRAPHIC_CTRL_RECT_UPDATE (RT_DEVICE_CTRL_BASE(Graphic) + 0)
  974. #define RTGRAPHIC_CTRL_POWERON (RT_DEVICE_CTRL_BASE(Graphic) + 1)
  975. #define RTGRAPHIC_CTRL_POWEROFF (RT_DEVICE_CTRL_BASE(Graphic) + 2)
  976. #define RTGRAPHIC_CTRL_GET_INFO (RT_DEVICE_CTRL_BASE(Graphic) + 3)
  977. #define RTGRAPHIC_CTRL_SET_MODE (RT_DEVICE_CTRL_BASE(Graphic) + 4)
  978. #define RTGRAPHIC_CTRL_GET_EXT (RT_DEVICE_CTRL_BASE(Graphic) + 5)
  979. #define RTGRAPHIC_CTRL_SET_BRIGHTNESS (RT_DEVICE_CTRL_BASE(Graphic) + 6)
  980. #define RTGRAPHIC_CTRL_GET_BRIGHTNESS (RT_DEVICE_CTRL_BASE(Graphic) + 7)
  981. #define RTGRAPHIC_CTRL_GET_MODE (RT_DEVICE_CTRL_BASE(Graphic) + 8)
  982. #define RTGRAPHIC_CTRL_GET_STATUS (RT_DEVICE_CTRL_BASE(Graphic) + 9)
  983. #define RTGRAPHIC_CTRL_PAN_DISPLAY (RT_DEVICE_CTRL_BASE(Graphic) + 10)
  984. #define RTGRAPHIC_CTRL_WAIT_VSYNC (RT_DEVICE_CTRL_BASE(Graphic) + 11)
  985. /* graphic device */
  986. enum
  987. {
  988. RTGRAPHIC_PIXEL_FORMAT_MONO = 0,
  989. RTGRAPHIC_PIXEL_FORMAT_GRAY4,
  990. RTGRAPHIC_PIXEL_FORMAT_GRAY16,
  991. RTGRAPHIC_PIXEL_FORMAT_RGB332,
  992. RTGRAPHIC_PIXEL_FORMAT_RGB444,
  993. RTGRAPHIC_PIXEL_FORMAT_RGB565,
  994. RTGRAPHIC_PIXEL_FORMAT_RGB565P,
  995. RTGRAPHIC_PIXEL_FORMAT_BGR565 = RTGRAPHIC_PIXEL_FORMAT_RGB565P,
  996. RTGRAPHIC_PIXEL_FORMAT_RGB666,
  997. RTGRAPHIC_PIXEL_FORMAT_RGB888,
  998. RTGRAPHIC_PIXEL_FORMAT_BGR888,
  999. RTGRAPHIC_PIXEL_FORMAT_ARGB888,
  1000. RTGRAPHIC_PIXEL_FORMAT_ABGR888,
  1001. RTGRAPHIC_PIXEL_FORMAT_RESERVED,
  1002. };
  1003. /**
  1004. * build a pixel position according to (x, y) coordinates.
  1005. */
  1006. #define RTGRAPHIC_PIXEL_POSITION(x, y) ((x << 16) | y)
  1007. /**
  1008. * graphic device information structure
  1009. */
  1010. struct rt_device_graphic_info
  1011. {
  1012. rt_uint8_t pixel_format; /**< graphic format */
  1013. rt_uint8_t bits_per_pixel; /**< bits per pixel */
  1014. rt_uint16_t pitch; /**< bytes per line */
  1015. rt_uint16_t width; /**< width of graphic device */
  1016. rt_uint16_t height; /**< height of graphic device */
  1017. rt_uint8_t *framebuffer; /**< frame buffer */
  1018. rt_uint32_t smem_len; /**< allocated frame buffer size */
  1019. };
  1020. /**
  1021. * rectangle information structure
  1022. */
  1023. struct rt_device_rect_info
  1024. {
  1025. rt_uint16_t x; /**< x coordinate */
  1026. rt_uint16_t y; /**< y coordinate */
  1027. rt_uint16_t width; /**< width */
  1028. rt_uint16_t height; /**< height */
  1029. };
  1030. /**
  1031. * graphic operations
  1032. */
  1033. struct rt_device_graphic_ops
  1034. {
  1035. void (*set_pixel) (const char *pixel, int x, int y);
  1036. void (*get_pixel) (char *pixel, int x, int y);
  1037. void (*draw_hline)(const char *pixel, int x1, int x2, int y);
  1038. void (*draw_vline)(const char *pixel, int x, int y1, int y2);
  1039. void (*blit_line) (const char *pixel, int x, int y, rt_size_t size);
  1040. };
  1041. #define rt_graphix_ops(device) ((struct rt_device_graphic_ops *)(device->user_data))
  1042. /**@}*/
  1043. #endif /* RT_USING_DEVICE */
  1044. #ifdef __cplusplus
  1045. }
  1046. #endif
  1047. #ifdef __cplusplus
  1048. /* RT-Thread definitions for C++ */
  1049. namespace rtthread {
  1050. enum TICK_WAIT {
  1051. WAIT_NONE = 0,
  1052. WAIT_FOREVER = -1,
  1053. };
  1054. }
  1055. #endif /* __cplusplus */
  1056. #endif /* __RT_DEF_H__ */