rtdef.h 32 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895
  1. /*
  2. * File : rtdef.h
  3. * This file is part of RT-Thread RTOS
  4. * COPYRIGHT (C) 2006 - 2012, RT-Thread Development Team
  5. *
  6. * The license and distribution terms for this file may be
  7. * found in the file LICENSE in this distribution or at
  8. * http://www.rt-thread.org/license/LICENSE
  9. *
  10. * Change Logs:
  11. * Date Author Notes
  12. * 2007-01-10 Bernard the first version
  13. * 2008-07-12 Bernard remove all rt_int8, rt_uint32_t etc typedef
  14. * 2010-10-26 yi.qiu add module support
  15. * 2010-11-10 Bernard add cleanup callback function in thread exit.
  16. * 2011-05-09 Bernard use builtin va_arg in GCC 4.x
  17. * 2012-11-16 Bernard change RT_NULL from ((void*)0) to 0.
  18. * 2012-12-29 Bernard change the RT_USING_MEMPOOL location and add
  19. * RT_USING_MEMHEAP condition.
  20. * 2012-12-30 Bernard add more control command for graphic.
  21. */
  22. #ifndef __RT_DEF_H__
  23. #define __RT_DEF_H__
  24. #include <rtconfig.h>
  25. #ifdef __cplusplus
  26. extern "C" {
  27. #endif
  28. /**
  29. * @addtogroup BasicDef
  30. */
  31. /*@{*/
  32. /* RT-Thread version information */
  33. #define RT_VERSION 1L /**< major version number */
  34. #define RT_SUBVERSION 1L /**< minor version number */
  35. #define RT_REVISION 0L /**< revise version number */
  36. /* RT-Thread version */
  37. #define RTTHREAD_VERSION ((RT_VERSION * 10000) + \
  38. (RT_SUBVERSION * 100) + RT_REVISION)
  39. /* RT-Thread basic data type definitions */
  40. typedef signed char rt_int8_t; /**< 8bit integer type */
  41. typedef signed short rt_int16_t; /**< 16bit integer type */
  42. typedef signed long rt_int32_t; /**< 32bit integer type */
  43. typedef unsigned char rt_uint8_t; /**< 8bit unsigned integer type */
  44. typedef unsigned short rt_uint16_t; /**< 16bit unsigned integer type */
  45. typedef unsigned long rt_uint32_t; /**< 32bit unsigned integer type */
  46. typedef int rt_bool_t; /**< boolean type */
  47. /* 32bit CPU */
  48. typedef long rt_base_t; /**< Nbit CPU related date type */
  49. typedef unsigned long rt_ubase_t; /**< Nbit unsigned CPU related data type */
  50. typedef rt_base_t rt_err_t; /**< Type for error number */
  51. typedef rt_uint32_t rt_time_t; /**< Type for time stamp */
  52. typedef rt_uint32_t rt_tick_t; /**< Type for tick count */
  53. typedef rt_base_t rt_flag_t; /**< Type for flags */
  54. typedef rt_ubase_t rt_size_t; /**< Type for size number */
  55. typedef rt_ubase_t rt_dev_t; /**< Type for device */
  56. typedef rt_base_t rt_off_t; /**< Type for offset */
  57. /* boolean type definitions */
  58. #define RT_TRUE 1 /**< boolean true */
  59. #define RT_FALSE 0 /**< boolean fails */
  60. /*@}*/
  61. /* maximum value of base type */
  62. #define RT_UINT8_MAX 0xff /**< Maxium number of UINT8 */
  63. #define RT_UINT16_MAX 0xffff /**< Maxium number of UINT16 */
  64. #define RT_UINT32_MAX 0xffffffff /**< Maxium number of UINT32 */
  65. #define RT_TICK_MAX RT_UINT32_MAX /**< Maxium number of tick */
  66. /* Compiler Related Definitions */
  67. #ifdef __CC_ARM /* ARM Compiler */
  68. #include <stdarg.h>
  69. #define SECTION(x) __attribute__((section(x)))
  70. #define UNUSED __attribute__((unused))
  71. #define ALIGN(n) __attribute__((aligned(n)))
  72. #define rt_inline static __inline
  73. /* module compiling */
  74. #ifdef RT_USING_MODULE
  75. #define RTT_API __declspec(dllimport)
  76. #else
  77. #define RTT_API __declspec(dllexport)
  78. #endif
  79. #elif defined (__IAR_SYSTEMS_ICC__) /* for IAR Compiler */
  80. #include <stdarg.h>
  81. #define SECTION(x) @ x
  82. #define UNUSED
  83. #define PRAGMA(x) _Pragma(#x)
  84. #define ALIGN(n) PRAGMA(data_alignment=n)
  85. #define rt_inline static inline
  86. #define RTT_API
  87. #elif defined (__GNUC__) /* GNU GCC Compiler */
  88. #ifdef RT_USING_NEWLIB
  89. #include <stdarg.h>
  90. #else
  91. #if __GNUC__ < 4
  92. typedef void *__sys_va_list;
  93. typedef __sys_va_list va_list;
  94. #define __va_rounded_size(type) \
  95. (((sizeof(type) + sizeof(int) - 1) / sizeof(int)) * sizeof(int))
  96. #define va_start(ap, lastarg) \
  97. (ap = ((char *) &(lastarg) + __va_rounded_size(lastarg)))
  98. #define va_end(ap) ((void)0)
  99. /* little endian */
  100. #define va_arg(ap, type) \
  101. (ap = (__sys_va_list) ((char *)(ap) + __va_rounded_size(type)), \
  102. *((type *) (void *) ((char *)(ap) - __va_rounded_size(type))))
  103. #else
  104. typedef __builtin_va_list __gnuc_va_list;
  105. typedef __gnuc_va_list va_list;
  106. #define va_start(v,l) __builtin_va_start(v,l)
  107. #define va_end(v) __builtin_va_end(v)
  108. #define va_arg(v,l) __builtin_va_arg(v,l)
  109. #endif
  110. #endif
  111. #define SECTION(x) __attribute__((section(x)))
  112. #define UNUSED __attribute__((unused))
  113. #define ALIGN(n) __attribute__((aligned(n)))
  114. #define rt_inline static __inline
  115. #define RTT_API
  116. #elif defined (__ADSPBLACKFIN__) /* for VisualDSP++ Compiler */
  117. #include <stdarg.h>
  118. #define SECTION(x) __attribute__((section(x)))
  119. #define UNUSED __attribute__((unused))
  120. #define ALIGN(n) __attribute__((aligned(n)))
  121. #define rt_inline static inline
  122. #define RTT_API
  123. #elif defined (_MSC_VER)
  124. #include <stdarg.h>
  125. #define SECTION(x)
  126. #define UNUSED
  127. #define ALIGN(n) __declspec(align(n))
  128. #define rt_inline static __inline
  129. #define RTT_API
  130. #endif
  131. /* event length */
  132. #define RT_EVENT_LENGTH 32
  133. /* memory management option */
  134. #define RT_MM_PAGE_SIZE 4096
  135. #define RT_MM_PAGE_MASK (RT_MM_PAGE_SIZE - 1)
  136. #define RT_MM_PAGE_BITS 12
  137. /**
  138. * @addtogroup Error
  139. */
  140. /*@{*/
  141. /* RT-Thread error code definitions */
  142. #define RT_EOK 0 /**< There is no error */
  143. #define RT_ERROR 1 /**< A generic error happens */
  144. #define RT_ETIMEOUT 2 /**< Timed out */
  145. #define RT_EFULL 3 /**< The resource is full */
  146. #define RT_EEMPTY 4 /**< The resource is empty */
  147. #define RT_ENOMEM 5 /**< No memory */
  148. #define RT_ENOSYS 6 /**< No system */
  149. #define RT_EBUSY 7 /**< Busy */
  150. #define RT_EIO 8 /**< IO error */
  151. /*@}*/
  152. /**
  153. * @ingroup BasicDef
  154. *
  155. * @def RT_ALIGN(size, align)
  156. * Return the most contiguous size aligned at specified width. RT_ALIGN(13, 4)
  157. * would return 16.
  158. */
  159. #define RT_ALIGN(size, align) (((size) + (align) - 1) & ~((align) - 1))
  160. /**
  161. * @ingroup BasicDef
  162. *
  163. * @def RT_ALIGN_DOWN(size, align)
  164. * Return the down number of aligned at specified width. RT_ALIGN_DOWN(13, 4)
  165. * would return 12.
  166. */
  167. #define RT_ALIGN_DOWN(size, align) ((size) & ~((align) - 1))
  168. /**
  169. * @ingroup BasicDef
  170. *
  171. * @def RT_NULL
  172. * Similar as the \c NULL in C library.
  173. */
  174. #define RT_NULL (0)
  175. struct rt_list_node
  176. {
  177. struct rt_list_node *next; /**< point to next node. */
  178. struct rt_list_node *prev; /**< point to prev node. */
  179. };
  180. typedef struct rt_list_node rt_list_t; /**< Type for lists. */
  181. /**
  182. * @addtogroup KernelObject
  183. */
  184. /*@{*/
  185. /*
  186. * kernel object macros
  187. */
  188. #define RT_OBJECT_FLAG_MODULE 0x80 /**< is module object. */
  189. /**
  190. * Base structure of Kernel object
  191. */
  192. struct rt_object
  193. {
  194. char name[RT_NAME_MAX]; /**< name of kernel object */
  195. rt_uint8_t type; /**< type of kernel object */
  196. rt_uint8_t flag; /**< flag of kernel object */
  197. #ifdef RT_USING_MODULE
  198. void *module_id; /**< id of application module */
  199. #endif
  200. rt_list_t list; /**< list node of kernel object */
  201. };
  202. typedef struct rt_object *rt_object_t; /**< Type for kernel objects. */
  203. /**
  204. * The object type can be one of the follows with specific
  205. * macros enabled:
  206. * - Thread
  207. * - Semaphore
  208. * - Mutex
  209. * - Event
  210. * - MailBox
  211. * - MessageQueue
  212. * - MemHeap
  213. * - MemPool
  214. * - Device
  215. * - Timer
  216. * - Module
  217. * - Unknown
  218. * - Static
  219. */
  220. enum rt_object_class_type
  221. {
  222. RT_Object_Class_Thread = 0, /**< The object is a thread. */
  223. #ifdef RT_USING_SEMAPHORE
  224. RT_Object_Class_Semaphore, /**< The object is a semaphore. */
  225. #endif
  226. #ifdef RT_USING_MUTEX
  227. RT_Object_Class_Mutex, /**< The object is a mutex. */
  228. #endif
  229. #ifdef RT_USING_EVENT
  230. RT_Object_Class_Event, /**< The object is a event. */
  231. #endif
  232. #ifdef RT_USING_MAILBOX
  233. RT_Object_Class_MailBox, /**< The object is a mail box. */
  234. #endif
  235. #ifdef RT_USING_MESSAGEQUEUE
  236. RT_Object_Class_MessageQueue, /**< The object is a message queue. */
  237. #endif
  238. #ifdef RT_USING_MEMHEAP
  239. RT_Object_Class_MemHeap, /**< The object is a memory heap */
  240. #endif
  241. #ifdef RT_USING_MEMPOOL
  242. RT_Object_Class_MemPool, /**< The object is a memory pool. */
  243. #endif
  244. #ifdef RT_USING_DEVICE
  245. RT_Object_Class_Device, /**< The object is a device */
  246. #endif
  247. RT_Object_Class_Timer, /**< The object is a timer. */
  248. #ifdef RT_USING_MODULE
  249. RT_Object_Class_Module, /**< The object is a module. */
  250. #endif
  251. RT_Object_Class_Unknown, /**< The object is unknown. */
  252. RT_Object_Class_Static = 0x80 /**< The object is a static object. */
  253. };
  254. /**
  255. * The information of the kernel object
  256. */
  257. struct rt_object_information
  258. {
  259. enum rt_object_class_type type; /**< object class type */
  260. rt_list_t object_list; /**< object list */
  261. rt_size_t object_size; /**< object size */
  262. };
  263. /**
  264. * The hook function call macro
  265. */
  266. #ifdef RT_USING_HOOK
  267. #define RT_OBJECT_HOOK_CALL(func, argv) \
  268. do { if ((func) != RT_NULL) func argv; } while (0)
  269. #else
  270. #define RT_OBJECT_HOOK_CALL(func, argv)
  271. #endif
  272. /*@}*/
  273. /**
  274. * @addtogroup Clock
  275. */
  276. /*@{*/
  277. /**
  278. * clock & timer macros
  279. */
  280. #define RT_TIMER_FLAG_DEACTIVATED 0x0 /**< timer is deactive */
  281. #define RT_TIMER_FLAG_ACTIVATED 0x1 /**< timer is active */
  282. #define RT_TIMER_FLAG_ONE_SHOT 0x0 /**< one shot timer */
  283. #define RT_TIMER_FLAG_PERIODIC 0x2 /**< periodic timer */
  284. #define RT_TIMER_FLAG_HARD_TIMER 0x0 /**< hard timer,the timer's callback function will be called in tick isr. */
  285. #define RT_TIMER_FLAG_SOFT_TIMER 0x4 /**< soft timer,the timer's callback function will be called in timer thread. */
  286. #define RT_TIMER_CTRL_SET_TIME 0x0 /**< set timer control command */
  287. #define RT_TIMER_CTRL_GET_TIME 0x1 /**< get timer control command */
  288. #define RT_TIMER_CTRL_SET_ONESHOT 0x2 /**< change timer to one shot */
  289. #define RT_TIMER_CTRL_SET_PERIODIC 0x3 /**< change timer to periodic */
  290. /**
  291. * timer structure
  292. */
  293. struct rt_timer
  294. {
  295. struct rt_object parent; /**< inherit from rt_object */
  296. rt_list_t list; /**< the node of timer list */
  297. void (*timeout_func)(void *parameter); /**< timeout function */
  298. void *parameter; /**< timeout function's parameter */
  299. rt_tick_t init_tick; /**< timer timeout tick */
  300. rt_tick_t timeout_tick; /**< timeout tick */
  301. };
  302. typedef struct rt_timer *rt_timer_t;
  303. /*@}*/
  304. /**
  305. * @addtogroup Thread
  306. */
  307. /*@{*/
  308. /*
  309. * Thread
  310. */
  311. /*
  312. * thread state definitions
  313. */
  314. #define RT_THREAD_INIT 0x00 /**< Initialized status */
  315. #define RT_THREAD_READY 0x01 /**< Ready status */
  316. #define RT_THREAD_SUSPEND 0x02 /**< Suspend status */
  317. #define RT_THREAD_RUNNING 0x03 /**< Running status */
  318. #define RT_THREAD_BLOCK RT_THREAD_SUSPEND /**< Blocked status */
  319. #define RT_THREAD_CLOSE 0x04 /**< Closed status */
  320. /**
  321. * thread control command definitions
  322. */
  323. #define RT_THREAD_CTRL_STARTUP 0x00 /**< Startup thread. */
  324. #define RT_THREAD_CTRL_CLOSE 0x01 /**< Close thread. */
  325. #define RT_THREAD_CTRL_CHANGE_PRIORITY 0x02 /**< Change thread priority. */
  326. #define RT_THREAD_CTRL_INFO 0x03 /**< Get thread information. */
  327. /**
  328. * Thread structure
  329. */
  330. struct rt_thread
  331. {
  332. /* rt object */
  333. char name[RT_NAME_MAX]; /**< the name of thread */
  334. rt_uint8_t type; /**< type of object */
  335. rt_uint8_t flags; /**< thread's flags */
  336. #ifdef RT_USING_MODULE
  337. void *module_id; /**< id of application module */
  338. #endif
  339. rt_list_t list; /**< the object list */
  340. rt_list_t tlist; /**< the thread list */
  341. /* stack point and entry */
  342. void *sp; /**< stack point */
  343. void *entry; /**< entry */
  344. void *parameter; /**< parameter */
  345. void *stack_addr; /**< stack address */
  346. rt_uint16_t stack_size; /**< stack size */
  347. /* error code */
  348. rt_err_t error; /**< error code */
  349. rt_uint8_t stat; /**< thread stat */
  350. /* priority */
  351. rt_uint8_t current_priority; /**< current priority */
  352. rt_uint8_t init_priority; /**< initialized priority */
  353. #if RT_THREAD_PRIORITY_MAX > 32
  354. rt_uint8_t number;
  355. rt_uint8_t high_mask;
  356. #endif
  357. rt_uint32_t number_mask;
  358. #if defined(RT_USING_EVENT)
  359. /* thread event */
  360. rt_uint32_t event_set;
  361. rt_uint8_t event_info;
  362. #endif
  363. rt_ubase_t init_tick; /**< thread's initialized tick */
  364. rt_ubase_t remaining_tick; /**< remaining tick */
  365. struct rt_timer thread_timer; /**< built-in thread timer */
  366. void (*cleanup)(struct rt_thread *tid); /**< cleanup function when thread exit */
  367. rt_uint32_t user_data; /**< private user data beyond this thread */
  368. };
  369. typedef struct rt_thread *rt_thread_t;
  370. /*@}*/
  371. /**
  372. * @addtogroup IPC
  373. */
  374. /*@{*/
  375. /**
  376. * IPC flags and control command definitions
  377. */
  378. #define RT_IPC_FLAG_FIFO 0x00 /**< FIFOed IPC. @ref IPC. */
  379. #define RT_IPC_FLAG_PRIO 0x01 /**< PRIOed IPC. @ref IPC. */
  380. #define RT_IPC_CMD_UNKNOWN 0x00 /**< unknown IPC command */
  381. #define RT_IPC_CMD_RESET 0x01 /**< reset IPC object */
  382. #define RT_WAITING_FOREVER -1 /**< Block forever until get resource. */
  383. #define RT_WAITING_NO 0 /**< Non-block. */
  384. /**
  385. * Base structure of IPC object
  386. */
  387. struct rt_ipc_object
  388. {
  389. struct rt_object parent; /**< inherit from rt_object */
  390. rt_list_t suspend_thread; /**< threads pended on this resource */
  391. };
  392. #ifdef RT_USING_SEMAPHORE
  393. /**
  394. * Semaphore structure
  395. */
  396. struct rt_semaphore
  397. {
  398. struct rt_ipc_object parent; /**< inherit from ipc_object */
  399. rt_uint16_t value; /**< value of semaphore. */
  400. };
  401. typedef struct rt_semaphore *rt_sem_t;
  402. #endif
  403. #ifdef RT_USING_MUTEX
  404. /**
  405. * Mutual exclusion (mutex) structure
  406. */
  407. struct rt_mutex
  408. {
  409. struct rt_ipc_object parent; /**< inherit from ipc_object */
  410. rt_uint16_t value; /**< value of mutex */
  411. rt_uint8_t original_priority; /**< priority of last thread hold the mutex */
  412. rt_uint8_t hold; /**< numbers of thread hold the mutex */
  413. struct rt_thread *owner; /**< current owner of mutex */
  414. };
  415. typedef struct rt_mutex *rt_mutex_t;
  416. #endif
  417. #ifdef RT_USING_EVENT
  418. /**
  419. * flag defintions in event
  420. */
  421. #define RT_EVENT_FLAG_AND 0x01 /**< logic and */
  422. #define RT_EVENT_FLAG_OR 0x02 /**< logic or */
  423. #define RT_EVENT_FLAG_CLEAR 0x04 /**< clear flag */
  424. /*
  425. * event structure
  426. */
  427. struct rt_event
  428. {
  429. struct rt_ipc_object parent; /**< inherit from ipc_object */
  430. rt_uint32_t set; /**< event set */
  431. };
  432. typedef struct rt_event *rt_event_t;
  433. #endif
  434. #ifdef RT_USING_MAILBOX
  435. /**
  436. * mailbox structure
  437. */
  438. struct rt_mailbox
  439. {
  440. struct rt_ipc_object parent; /**< inherit from ipc_object */
  441. rt_uint32_t *msg_pool; /**< start address of message buffer */
  442. rt_uint16_t size; /**< size of message pool */
  443. rt_uint16_t entry; /**< index of messages in msg_pool */
  444. rt_uint16_t in_offset; /**< input offset of the message buffer */
  445. rt_uint16_t out_offset; /**< output offset of the message buffer */
  446. rt_list_t suspend_sender_thread; /**< sender thread suspended on this mailbox */
  447. };
  448. typedef struct rt_mailbox *rt_mailbox_t;
  449. #endif
  450. #ifdef RT_USING_MESSAGEQUEUE
  451. /**
  452. * message queue structure
  453. */
  454. struct rt_messagequeue
  455. {
  456. struct rt_ipc_object parent; /**< inherit from ipc_object */
  457. void *msg_pool; /**< start address of message queue */
  458. rt_uint16_t msg_size; /**< message size of each message */
  459. rt_uint16_t max_msgs; /**< max number of messages */
  460. rt_uint16_t entry; /**< index of messages in the queue */
  461. void *msg_queue_head; /**< list head */
  462. void *msg_queue_tail; /**< list tail */
  463. void *msg_queue_free; /**< pointer indicated the free node of queue */
  464. };
  465. typedef struct rt_messagequeue *rt_mq_t;
  466. #endif
  467. /*@}*/
  468. /**
  469. * @addtogroup MM
  470. */
  471. /*@{*/
  472. /*
  473. * memory management
  474. * heap & partition
  475. */
  476. #ifdef RT_USING_MEMHEAP
  477. /**
  478. * memory item on the heap
  479. */
  480. struct rt_memheap_item
  481. {
  482. rt_uint32_t magic; /**< magic number for memheap */
  483. struct rt_memheap_item *next; /**< next memheap item */
  484. struct rt_memheap_item *prev; /**< prev memheap item */
  485. struct rt_memheap *pool_ptr; /**< point of pool */
  486. struct rt_memheap_item *next_free; /**< next free memheap item */
  487. struct rt_memheap_item *prev_free; /**< prev free memheap item */
  488. };
  489. /**
  490. * Base structure of memory heap object
  491. */
  492. struct rt_memheap
  493. {
  494. struct rt_object parent; /**< inherit from rt_object */
  495. void *start_addr; /**< pool start address and size */
  496. rt_uint32_t pool_size; /**< pool size */
  497. rt_uint32_t available_size; /**< available size */
  498. rt_uint32_t max_used_size; /**< maximum allocated size */
  499. struct rt_memheap_item *block_list; /**< used block list */
  500. struct rt_memheap_item *free_list; /**< free block list */
  501. struct rt_memheap_item free_header; /**< free block list header */
  502. struct rt_semaphore lock; /**< semaphore lock */
  503. };
  504. #endif
  505. #ifdef RT_USING_MEMPOOL
  506. /**
  507. * Base structure of Memory pool object
  508. */
  509. struct rt_mempool
  510. {
  511. struct rt_object parent; /**< inherit from rt_object */
  512. void *start_address; /**< memory pool start */
  513. rt_size_t size; /**< size of memory pool */
  514. rt_size_t block_size; /**< size of memory blocks */
  515. rt_uint8_t *block_list; /**< memory blocks list */
  516. rt_size_t block_total_count; /**< numbers of memory block */
  517. rt_size_t block_free_count; /**< numbers of free memory block */
  518. rt_list_t suspend_thread; /**< threads pended on this resource */
  519. rt_size_t suspend_thread_count; /**< numbers of thread pended on this resource */
  520. };
  521. typedef struct rt_mempool *rt_mp_t;
  522. #endif
  523. /*@}*/
  524. #ifdef RT_USING_DEVICE
  525. /**
  526. * @addtogroup Device
  527. */
  528. /*@{*/
  529. /**
  530. * device (I/O) class type
  531. */
  532. enum rt_device_class_type
  533. {
  534. RT_Device_Class_Char = 0, /**< character device */
  535. RT_Device_Class_Block, /**< block device */
  536. RT_Device_Class_NetIf, /**< net interface */
  537. RT_Device_Class_MTD, /**< memory device */
  538. RT_Device_Class_CAN, /**< CAN device */
  539. RT_Device_Class_RTC, /**< RTC device */
  540. RT_Device_Class_Sound, /**< Sound device */
  541. RT_Device_Class_Graphic, /**< Graphic device */
  542. RT_Device_Class_I2CBUS, /**< I2C bus device */
  543. RT_Device_Class_USBDevice, /**< USB slave device */
  544. RT_Device_Class_USBHost, /**< USB host bus */
  545. RT_Device_Class_SPIBUS, /**< SPI bus device */
  546. RT_Device_Class_SPIDevice, /**< SPI device */
  547. RT_Device_Class_SDIO, /**< SDIO bus device */
  548. RT_Device_Class_PM, /**< PM pseudo device */
  549. RT_Device_Class_Unknown /**< unknown device */
  550. };
  551. /**
  552. * device flags defitions
  553. */
  554. #define RT_DEVICE_FLAG_DEACTIVATE 0x000 /**< device is not not initialized */
  555. #define RT_DEVICE_FLAG_RDONLY 0x001 /**< read only */
  556. #define RT_DEVICE_FLAG_WRONLY 0x002 /**< write only */
  557. #define RT_DEVICE_FLAG_RDWR 0x003 /**< read and write */
  558. #define RT_DEVICE_FLAG_REMOVABLE 0x004 /**< removable device */
  559. #define RT_DEVICE_FLAG_STANDALONE 0x008 /**< standalone device */
  560. #define RT_DEVICE_FLAG_ACTIVATED 0x010 /**< device is activated */
  561. #define RT_DEVICE_FLAG_SUSPENDED 0x020 /**< device is suspended */
  562. #define RT_DEVICE_FLAG_STREAM 0x040 /**< stream mode */
  563. #define RT_DEVICE_FLAG_INT_RX 0x100 /**< INT mode on Rx */
  564. #define RT_DEVICE_FLAG_DMA_RX 0x200 /**< DMA mode on Rx */
  565. #define RT_DEVICE_FLAG_INT_TX 0x400 /**< INT mode on Tx */
  566. #define RT_DEVICE_FLAG_DMA_TX 0x800 /**< DMA mode on Tx */
  567. #define RT_DEVICE_OFLAG_CLOSE 0x000 /**< device is closed */
  568. #define RT_DEVICE_OFLAG_RDONLY 0x001 /**< read only access */
  569. #define RT_DEVICE_OFLAG_WRONLY 0x002 /**< write only access */
  570. #define RT_DEVICE_OFLAG_RDWR 0x003 /**< read and write */
  571. #define RT_DEVICE_OFLAG_OPEN 0x008 /**< device is opened */
  572. /**
  573. * general device commands
  574. */
  575. #define RT_DEVICE_CTRL_RESUME 0x01 /**< resume device */
  576. #define RT_DEVICE_CTRL_SUSPEND 0x02 /**< suspend device */
  577. /**
  578. * special device commands
  579. */
  580. #define RT_DEVICE_CTRL_CHAR_STREAM 0x10 /**< stream mode on char device */
  581. #define RT_DEVICE_CTRL_BLK_GETGEOME 0x10 /**< get geometry information */
  582. #define RT_DEVICE_CTRL_BLK_SYNC 0x11 /**< flush data to block device */
  583. #define RT_DEVICE_CTRL_BLK_ERASE 0x12 /**< erase block on block device */
  584. #define RT_DEVICE_CTRL_NETIF_GETMAC 0x10 /**< get mac address */
  585. #define RT_DEVICE_CTRL_MTD_FORMAT 0x10 /**< format a MTD device */
  586. #define RT_DEVICE_CTRL_RTC_GET_TIME 0x10 /**< get time */
  587. #define RT_DEVICE_CTRL_RTC_SET_TIME 0x11 /**< set time */
  588. #define RT_DEVICE_CTRL_RTC_GET_ALARM 0x12 /**< get alarm */
  589. #define RT_DEVICE_CTRL_RTC_SET_ALARM 0x13 /**< set alarm */
  590. typedef struct rt_device *rt_device_t;
  591. /**
  592. * Device structure
  593. */
  594. struct rt_device
  595. {
  596. struct rt_object parent; /**< inherit from rt_object */
  597. enum rt_device_class_type type; /**< device type */
  598. rt_uint16_t flag; /**< device flag */
  599. rt_uint16_t open_flag; /**< device open flag */
  600. rt_uint8_t device_id; /**< 0 - 255 */
  601. /* device call back */
  602. rt_err_t (*rx_indicate)(rt_device_t dev, rt_size_t size);
  603. rt_err_t (*tx_complete)(rt_device_t dev, void *buffer);
  604. /* common device interface */
  605. rt_err_t (*init) (rt_device_t dev);
  606. rt_err_t (*open) (rt_device_t dev, rt_uint16_t oflag);
  607. rt_err_t (*close) (rt_device_t dev);
  608. rt_size_t (*read) (rt_device_t dev, rt_off_t pos, void *buffer, rt_size_t size);
  609. rt_size_t (*write) (rt_device_t dev, rt_off_t pos, const void *buffer, rt_size_t size);
  610. rt_err_t (*control)(rt_device_t dev, rt_uint8_t cmd, void *args);
  611. #ifdef RT_USING_DEVICE_SUSPEND
  612. rt_err_t (*suspend) (rt_device_t dev);
  613. rt_err_t (*resumed) (rt_device_t dev);
  614. #endif
  615. void *user_data; /**< device private data */
  616. };
  617. /**
  618. * block device geometry structure
  619. */
  620. struct rt_device_blk_geometry
  621. {
  622. rt_uint32_t sector_count; /**< count of sectors */
  623. rt_uint32_t bytes_per_sector; /**< number of bytes per sector */
  624. rt_uint32_t block_size; /**< size to erase one block */
  625. };
  626. /**
  627. * sector arrange struct on block device
  628. */
  629. struct rt_device_blk_sectors
  630. {
  631. rt_uint32_t sector_begin; /**< begin sector */
  632. rt_uint32_t sector_end; /**< end sector */
  633. };
  634. /**
  635. * cursor control command
  636. */
  637. #define RT_DEVICE_CTRL_CURSOR_SET_POSITION 0x10
  638. #define RT_DEVICE_CTRL_CURSOR_SET_TYPE 0x11
  639. /**
  640. * graphic device control command
  641. */
  642. #define RTGRAPHIC_CTRL_RECT_UPDATE 0
  643. #define RTGRAPHIC_CTRL_POWERON 1
  644. #define RTGRAPHIC_CTRL_POWEROFF 2
  645. #define RTGRAPHIC_CTRL_GET_INFO 3
  646. #define RTGRAPHIC_CTRL_SET_MODE 4
  647. #define RTGRAPHIC_CTRL_GET_EXT 5
  648. /* graphic deice */
  649. enum
  650. {
  651. RTGRAPHIC_PIXEL_FORMAT_MONO = 0,
  652. RTGRAPHIC_PIXEL_FORMAT_GRAY4,
  653. RTGRAPHIC_PIXEL_FORMAT_GRAY16,
  654. RTGRAPHIC_PIXEL_FORMAT_RGB332,
  655. RTGRAPHIC_PIXEL_FORMAT_RGB444,
  656. RTGRAPHIC_PIXEL_FORMAT_RGB565,
  657. RTGRAPHIC_PIXEL_FORMAT_RGB565P,
  658. RTGRAPHIC_PIXEL_FORMAT_RGB666,
  659. RTGRAPHIC_PIXEL_FORMAT_RGB888,
  660. RTGRAPHIC_PIXEL_FORMAT_ARGB888
  661. };
  662. /**
  663. * build a pixel position according to (x, y) coordinates.
  664. */
  665. #define RTGRAPHIC_PIXEL_POSITION(x, y) ((x << 16) | y)
  666. /**
  667. * graphic device information structure
  668. */
  669. struct rt_device_graphic_info
  670. {
  671. rt_uint8_t pixel_format; /**< graphic format */
  672. rt_uint8_t bits_per_pixel; /**< bits per pixel */
  673. rt_uint16_t reserved; /**< reserved field */
  674. rt_uint16_t width; /**< width of graphic device */
  675. rt_uint16_t height; /**< height of graphic device */
  676. rt_uint8_t *framebuffer; /**< frame buffer */
  677. };
  678. /**
  679. * rectangle information structure
  680. */
  681. struct rt_device_rect_info
  682. {
  683. rt_uint16_t x; /**< x coordinate */
  684. rt_uint16_t y; /**< y coordinate */
  685. rt_uint16_t width; /**< width */
  686. rt_uint16_t height; /**< height */
  687. };
  688. /**
  689. * graphic operations
  690. */
  691. struct rt_device_graphic_ops
  692. {
  693. void (*set_pixel) (const char *pixel, int x, int y);
  694. void (*get_pixel) (char *pixel, int x, int y);
  695. void (*draw_hline)(const char *pixel, int x1, int x2, int y);
  696. void (*draw_vline)(const char *pixel, int x, int y1, int y2);
  697. void (*blit_line) (const char *pixel, int x, int y, rt_size_t size);
  698. };
  699. #define rt_graphix_ops(device) ((struct rt_device_graphic_ops *)(device->user_data))
  700. /*@}*/
  701. #endif
  702. #ifdef RT_USING_MODULE
  703. /**
  704. * @addtogroup Module
  705. */
  706. /*@{*/
  707. /*
  708. * module system
  709. */
  710. #define RT_MODULE_FLAG_WITHENTRY 0x00 /**< with entry point */
  711. #define RT_MODULE_FLAG_WITHOUTENTRY 0x01 /**< without entry point */
  712. /**
  713. * Application Module structure
  714. */
  715. struct rt_module
  716. {
  717. struct rt_object parent; /**< inherit from object */
  718. rt_uint8_t *module_space; /**< module memory space */
  719. void *module_entry; /**< entry address of module's thread */
  720. rt_thread_t module_thread; /**< stack size of module's thread */
  721. rt_uint32_t stack_size; /**< priority of module's thread */
  722. rt_uint32_t thread_priority;
  723. #ifdef RT_USING_SLAB
  724. /* module memory allocator */
  725. void *mem_list; /**< module's free memory list */
  726. void *page_array; /**< module's using pages */
  727. rt_uint32_t page_cnt; /**< module's using pages count */
  728. #endif
  729. rt_uint32_t nsym; /**< number of symbol in the module */
  730. struct rt_module_symtab *symtab; /**< module symbol table */
  731. rt_uint32_t nref; /**< reference count */
  732. /* object in this module, module object is the last basic object type */
  733. struct rt_object_information module_object[RT_Object_Class_Unknown];
  734. };
  735. typedef struct rt_module *rt_module_t;
  736. /*@}*/
  737. #endif
  738. #ifdef __cplusplus
  739. }
  740. #endif
  741. #endif