rtdef.h 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696
  1. /*
  2. * File : rtdef.h
  3. * This file is part of RT-Thread RTOS
  4. * COPYRIGHT (C) 2006, 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://openlab.rt-thread.com/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. */
  17. #ifndef __RT_DEF_H__
  18. #define __RT_DEF_H__
  19. #include <rtconfig.h>
  20. #ifdef __cplusplus
  21. extern "C" {
  22. #endif
  23. /**
  24. * @addtogroup BasicDef
  25. */
  26. /*@{*/
  27. /**
  28. * RT-Thread version information
  29. */
  30. #define RT_VERSION 4L /**< major version number */
  31. #define RT_SUBVERSION 0L /**< minor version number */
  32. /**
  33. * RT-Thread basic data type definitions
  34. */
  35. typedef signed char rt_int8_t; /**< 8bit integer type */
  36. typedef signed short rt_int16_t; /**< 16bit integer type */
  37. typedef signed long rt_int32_t; /**< 32bit integer type */
  38. typedef unsigned char rt_uint8_t; /**< 8bit unsigned integer type */
  39. typedef unsigned short rt_uint16_t; /**< 16bit unsigned integer type */
  40. typedef unsigned long rt_uint32_t; /**< 32bit unsigned integer type */
  41. typedef int rt_bool_t; /**< boolean type */
  42. /* 32bit CPU */
  43. typedef long rt_base_t; /**< Nbit CPU related date type */
  44. typedef unsigned long rt_ubase_t; /**< Nbit unsigned CPU related data type */
  45. typedef rt_base_t rt_err_t; /**< Type for error number */
  46. typedef rt_uint32_t rt_time_t; /**< Type for time stamp */
  47. typedef rt_uint32_t rt_tick_t; /**< Type for tick count */
  48. typedef rt_base_t rt_flag_t; /**< Type for flags */
  49. typedef rt_ubase_t rt_size_t; /**< Type for size number */
  50. typedef rt_ubase_t rt_dev_t; /**< Type for device */
  51. typedef rt_uint32_t rt_off_t; /**< Type for offset */
  52. /**
  53. * boolean type definitions
  54. */
  55. #define RT_TRUE 1 /**< boolean true */
  56. #define RT_FALSE 0 /**< boolean fails */
  57. /*@}*/
  58. /* maximun value of base type */
  59. #define RT_UINT8_MAX 0xff /* Maxium number of UINT8. */
  60. #define RT_UINT16_MAX 0xffff /* Maxium number of UINT16. */
  61. #define RT_UINT32_MAX 0xffffffff /* Maxium number of UINT32. */
  62. #define RT_TICK_MAX RT_UINT32_MAX /* Maxium number of tick */
  63. /* Compiler Related Definitions */
  64. #ifdef __CC_ARM /* ARM Compiler */
  65. #include <stdarg.h>
  66. #define SECTION(x) __attribute__((section(x)))
  67. #define UNUSED __attribute__((unused))
  68. #define ALIGN(n) __attribute__((aligned(n)))
  69. #define rt_inline static __inline
  70. /* module compiling */
  71. #ifdef RT_USING_MODULE
  72. #define RTT_API __declspec(dllimport)
  73. #else
  74. #define RTT_API __declspec(dllexport)
  75. #endif
  76. #elif defined (__IAR_SYSTEMS_ICC__) /* for IAR Compiler */
  77. #include <stdarg.h>
  78. #define SECTION(x) @ x
  79. #define UNUSED
  80. #define PRAGMA(x) _Pragma(#x)
  81. #define ALIGN(n) PRAGMA(data_alignment=n)
  82. #define rt_inline inline
  83. #define RTT_API
  84. #elif defined (__GNUC__) /* GNU GCC Compiler */
  85. #ifdef RT_USING_NEWLIB
  86. #include <stdarg.h>
  87. #else
  88. typedef void *__sys_va_list;
  89. typedef __sys_va_list va_list;
  90. #define __va_rounded_size(type) \
  91. (((sizeof (type) + sizeof (int) - 1) / sizeof (int)) * sizeof (int))
  92. #define va_start(ap, lastarg) \
  93. (ap = ((char *) &(lastarg) + __va_rounded_size(lastarg)))
  94. #define va_end(ap) ((void)0)
  95. /* little endian */
  96. #define va_arg(ap, type) \
  97. (ap = (__sys_va_list) ((char *) (ap) + __va_rounded_size (type)), \
  98. *((type *) (void *) ((char *) (ap) - __va_rounded_size (type))))
  99. #endif
  100. #define SECTION(x) __attribute__((section(x)))
  101. #define UNUSED __attribute__((unused))
  102. #define ALIGN(n) __attribute__((aligned(n)))
  103. #define rt_inline static __inline
  104. #define RTT_API
  105. #endif
  106. /* event length */
  107. #define RT_EVENT_LENGTH 32
  108. /* memory management option */
  109. #define RT_MM_PAGE_SIZE 4096
  110. #define RT_MM_PAGE_MASK (RT_MM_PAGE_SIZE - 1)
  111. #define RT_MM_PAGE_BITS 12
  112. /**
  113. * @addtogroup Error
  114. */
  115. /*@{*/
  116. /** RT-Thread error code definitions */
  117. #define RT_EOK 0 /**< There is no error */
  118. #define RT_ERROR 1 /**< A generic error happens */
  119. #define RT_ETIMEOUT 2 /**< Timed out */
  120. #define RT_EFULL 3 /**< The resource is full */
  121. #define RT_EEMPTY 4 /**< The resource is empty */
  122. #define RT_ENOMEM 5 /**< No memory */
  123. #define RT_ENOSYS 6 /**< No system */
  124. #define RT_EBUSY 7 /**< Busy */
  125. /*@}*/
  126. #ifdef RT_DEBUG
  127. #define RT_ASSERT(EX) if (!(EX)) {volatile char dummy=0; rt_kprintf("(%s) assert failed at %s:%d \n", \
  128. #EX, __FUNCTION__, __LINE__); while (dummy==0);}
  129. #else
  130. #define RT_ASSERT(EX)
  131. #endif
  132. /**
  133. * @ingroup BasicDef
  134. *
  135. * @def RT_ALIGN(size, align)
  136. * Return the most contiguous size aligned at specified width. RT_ALIGN(13, 4)
  137. * would return 16.
  138. */
  139. #define RT_ALIGN(size, align) (((size) + (align) - 1) & ~((align)-1))
  140. /**
  141. * @ingroup BasicDef
  142. *
  143. * @def RT_ALIGN_DOWN(size, align)
  144. * Return the down number of aligned at specified width. RT_ALIGN_DOWN(13, 4)
  145. * would return 12.
  146. */
  147. #define RT_ALIGN_DOWN(size, align) ((size) & ~((align) -1))
  148. /**
  149. * @ingroup BasicDef
  150. *
  151. * @def RT_NULL
  152. * Similar as the \c NULL in C library.
  153. */
  154. #define RT_NULL ((void *)0)
  155. struct rt_list_node
  156. {
  157. struct rt_list_node *next; /* point to next node. */
  158. struct rt_list_node *prev; /* point to prev node. */
  159. };
  160. typedef struct rt_list_node rt_list_t; /* Type for lists. */
  161. /**
  162. * @addtogroup KernelObject
  163. */
  164. /*@{*/
  165. /*
  166. * kernel object macros
  167. */
  168. #define RT_OBJECT_FLAG_MODULE 0x80 /* is module object. */
  169. /**
  170. * Base structure of Kernel object
  171. */
  172. struct rt_object
  173. {
  174. char name[RT_NAME_MAX]; /**< name of kernel object */
  175. rt_uint8_t type; /**< type of kernel object */
  176. rt_uint8_t flag; /**< flag of kernel object */
  177. #ifdef RT_USING_MODULE
  178. void* module_id; /**< id of application module */
  179. #endif
  180. rt_list_t list; /**< list node of kernel object */
  181. };
  182. typedef struct rt_object* rt_object_t; /* Type for kernel objects. */
  183. /**
  184. * The object type can be one of the follows with specific
  185. * macros enabled:
  186. * - Thread
  187. * - Semaphore
  188. * - Mutex
  189. * - Event
  190. * - MailBox
  191. * - MessageQueue
  192. * - MemPool
  193. * - Device
  194. * - Timer
  195. * - Unknown
  196. * - Static
  197. */
  198. enum rt_object_class_type
  199. {
  200. RT_Object_Class_Thread = 0, /**< The object is a thread. */
  201. #ifdef RT_USING_SEMAPHORE
  202. RT_Object_Class_Semaphore, /**< The object is a semaphore. */
  203. #endif
  204. #ifdef RT_USING_MUTEX
  205. RT_Object_Class_Mutex, /**< The object is a mutex. */
  206. #endif
  207. #ifdef RT_USING_EVENT
  208. RT_Object_Class_Event, /**< The object is a event. */
  209. #endif
  210. #ifdef RT_USING_MAILBOX
  211. RT_Object_Class_MailBox, /**< The object is a mail box. */
  212. #endif
  213. #ifdef RT_USING_MESSAGEQUEUE
  214. RT_Object_Class_MessageQueue, /**< The object is a message queue. */
  215. #endif
  216. #ifdef RT_USING_MEMPOOL
  217. RT_Object_Class_MemPool, /**< The object is a memory pool. */
  218. #endif
  219. #ifdef RT_USING_DEVICE
  220. RT_Object_Class_Device, /**< The object is a device */
  221. #endif
  222. RT_Object_Class_Timer, /**< The object is a timer. */
  223. #ifdef RT_USING_MODULE
  224. RT_Object_Class_Module, /**< The object is a module. */
  225. #endif
  226. RT_Object_Class_Unknown, /**< The object is unknown. */
  227. RT_Object_Class_Static = 0x80 /**< The object is a static object. */
  228. };
  229. /**
  230. * The information of the kernel object
  231. */
  232. struct rt_object_information
  233. {
  234. enum rt_object_class_type type; /**< object class type */
  235. rt_list_t object_list; /**< object list */
  236. rt_size_t object_size; /**< object size */
  237. };
  238. /*@}*/
  239. /**
  240. * @addtogroup Clock
  241. */
  242. /*@{*/
  243. /**
  244. * clock & timer macros
  245. */
  246. #define RT_TIMER_FLAG_DEACTIVATED 0x0 /**< timer is deactive */
  247. #define RT_TIMER_FLAG_ACTIVATED 0x1 /**< timer is active */
  248. #define RT_TIMER_FLAG_ONE_SHOT 0x0 /**< one shot timer */
  249. #define RT_TIMER_FLAG_PERIODIC 0x2 /**< periodic timer */
  250. #define RT_TIMER_FLAG_HARD_TIMER 0x0 /**< hard timer,the timer's callback function will be called in tick isr. */
  251. #define RT_TIMER_FLAG_SOFT_TIMER 0x4 /**< soft timer,the timer's callback function will be called in timer thread. */
  252. #define RT_TIMER_CTRL_SET_TIME 0x0 /**< set timer control command */
  253. #define RT_TIMER_CTRL_GET_TIME 0x1 /**< get timer control command */
  254. #define RT_TIMER_CTRL_SET_ONESHOT 0x2 /**< change timer to one shot */
  255. #define RT_TIMER_CTRL_SET_PERIODIC 0x3 /**< change timer to periodic */
  256. /**
  257. * timer structure
  258. */
  259. struct rt_timer
  260. {
  261. struct rt_object parent; /**< inherit from rt_object */
  262. rt_list_t list; /**< the node of timer list */
  263. void (*timeout_func)(void* parameter); /**< timeout function */
  264. void *parameter; /**< timeout function's parameter */
  265. rt_tick_t init_tick; /**< timer timeout tick */
  266. rt_tick_t timeout_tick; /**< timeout tick */
  267. };
  268. typedef struct rt_timer* rt_timer_t;
  269. /*@}*/
  270. /**
  271. * @addtogroup Thread
  272. */
  273. /*@{*/
  274. /*
  275. * Thread
  276. */
  277. /*
  278. * thread state definitions
  279. */
  280. #define RT_THREAD_INIT 0x00 /**< Initialized status */
  281. #define RT_THREAD_READY 0x01 /**< Ready status */
  282. #define RT_THREAD_SUSPEND 0x02 /**< Suspend status */
  283. #define RT_THREAD_RUNNING 0x03 /**< Running status */
  284. #define RT_THREAD_BLOCK RT_THREAD_SUSPEND /**< Blocked status */
  285. #define RT_THREAD_CLOSE 0x04 /**< Closed status */
  286. /**
  287. * thread control command definitions
  288. */
  289. #define RT_THREAD_CTRL_STARTUP 0x00 /**< Starup thread. */
  290. #define RT_THREAD_CTRL_CLOSE 0x01 /**< Close thread. */
  291. #define RT_THREAD_CTRL_CHANGE_PRIORITY 0x02 /**< Change thread priority. */
  292. #define RT_THREAD_CTRL_INFO 0x03 /**< Get thread information. */
  293. typedef struct rt_thread* rt_thread_t;
  294. /**
  295. * Thread structure
  296. *
  297. */
  298. struct rt_thread
  299. {
  300. /* rt object */
  301. char name[RT_NAME_MAX]; /**< the name of thread */
  302. rt_uint8_t type; /**< type of object */
  303. rt_uint8_t flags; /**< thread's flags */
  304. #ifdef RT_USING_MODULE
  305. void* module_id; /**< id of application module */
  306. #endif
  307. rt_list_t list; /**< the object list */
  308. rt_list_t tlist; /**< the thread list */
  309. /* stack point and entry */
  310. void* sp; /**< stack point */
  311. void* entry; /**< entry */
  312. void* parameter; /**< parameter */
  313. void* stack_addr; /**< stack address */
  314. rt_uint16_t stack_size; /**< stack size */
  315. /* error code */
  316. rt_err_t error; /**< error code */
  317. rt_uint8_t stat; /**< thread stat */
  318. /* priority */
  319. rt_uint8_t current_priority; /**< current priority */
  320. rt_uint8_t init_priority; /**< initialized priority */
  321. #if RT_THREAD_PRIORITY_MAX > 32
  322. rt_uint8_t number;
  323. rt_uint8_t high_mask;
  324. #endif
  325. rt_uint32_t number_mask;
  326. #if defined(RT_USING_EVENT)
  327. /* thread event */
  328. rt_uint32_t event_set;
  329. rt_uint8_t event_info;
  330. #endif
  331. rt_ubase_t init_tick; /**< thread's initialized tick */
  332. rt_ubase_t remaining_tick; /**< remaining tick */
  333. struct rt_timer thread_timer; /**< thread timer */
  334. void (*cleanup)(struct rt_thread* tid); /**< cleanup function when thread exit */
  335. rt_uint32_t user_data; /**< user data */
  336. };
  337. /*@}*/
  338. /**
  339. * @addtogroup IPC
  340. */
  341. /*@{*/
  342. /**
  343. * IPC flags and control command defitions
  344. */
  345. #define RT_IPC_FLAG_FIFO 0x00 /**< FIFOed IPC. @ref IPC. */
  346. #define RT_IPC_FLAG_PRIO 0x01 /**< PRIOed IPC. @ref IPC. */
  347. #define RT_IPC_CMD_UNKNOWN 0x00 /**< unknown IPC command */
  348. #define RT_IPC_CMD_RESET 0x01 /**< reset IPC object */
  349. #define RT_WAITING_FOREVER -1 /**< Block forever until get resource. */
  350. #define RT_WAITING_NO 0 /**< Non-block. */
  351. /**
  352. * Base structure of IPC object
  353. */
  354. struct rt_ipc_object
  355. {
  356. struct rt_object parent; /**< inherit from rt_object */
  357. rt_list_t suspend_thread; /**< threads pended on this resource */
  358. };
  359. #ifdef RT_USING_SEMAPHORE
  360. /**
  361. * Semaphore structure
  362. */
  363. struct rt_semaphore
  364. {
  365. struct rt_ipc_object parent; /**< inherit from ipc_object */
  366. rt_uint16_t value; /**< value of semaphore. */
  367. };
  368. typedef struct rt_semaphore* rt_sem_t;
  369. #endif
  370. #ifdef RT_USING_MUTEX
  371. /**
  372. * Mutual exclusion (mutex) structure
  373. */
  374. struct rt_mutex
  375. {
  376. struct rt_ipc_object parent; /**< inherit from ipc_object */
  377. rt_uint16_t value; /**< value of mutex */
  378. rt_uint8_t original_priority; /**< priority of last thread hold the mutex */
  379. rt_uint8_t hold; /**< numbers of thread hold the mutex */
  380. struct rt_thread *owner; /**< current owner of mutex */
  381. };
  382. typedef struct rt_mutex* rt_mutex_t;
  383. #endif
  384. #ifdef RT_USING_EVENT
  385. /**
  386. * flag defintions in event
  387. */
  388. #define RT_EVENT_FLAG_AND 0x01 /**< logic and */
  389. #define RT_EVENT_FLAG_OR 0x02 /**< logic or */
  390. #define RT_EVENT_FLAG_CLEAR 0x04 /**< clear flag */
  391. /*
  392. * event structure
  393. */
  394. struct rt_event
  395. {
  396. struct rt_ipc_object parent; /**< inherit from ipc_object */
  397. rt_uint32_t set; /**< event set */
  398. };
  399. typedef struct rt_event* rt_event_t;
  400. #endif
  401. #ifdef RT_USING_MAILBOX
  402. /**
  403. * mailbox structure
  404. *
  405. */
  406. struct rt_mailbox
  407. {
  408. struct rt_ipc_object parent; /**< inherit from ipc_object */
  409. rt_uint32_t* msg_pool; /**< start address of message buffer. */
  410. rt_uint16_t size; /**< size of message pool. */
  411. rt_uint16_t entry; /**< index of messages in msg_pool. */
  412. rt_uint16_t in_offset, out_offset; /**< in/output offset of the message buffer. */
  413. };
  414. typedef struct rt_mailbox* rt_mailbox_t;
  415. #endif
  416. #ifdef RT_USING_MESSAGEQUEUE
  417. /**
  418. * message queue structure
  419. */
  420. struct rt_messagequeue
  421. {
  422. struct rt_ipc_object parent; /**< inherit from ipc_object */
  423. void* msg_pool; /**< start address of message queue. */
  424. rt_uint16_t msg_size; /**< message size of each message. */
  425. rt_uint16_t max_msgs; /**< max number of messages. */
  426. rt_uint16_t entry; /**< index of messages in the queue. */
  427. void* msg_queue_head; /**< list head. */
  428. void* msg_queue_tail; /**< list tail. */
  429. void* msg_queue_free; /**< pointer indicated the free node of queue. */
  430. };
  431. typedef struct rt_messagequeue* rt_mq_t;
  432. #endif
  433. /*@}*/
  434. /**
  435. * @addtogroup MM
  436. */
  437. /*@{*/
  438. /*
  439. * memory management
  440. * heap & partition
  441. */
  442. #ifdef RT_USING_MEMPOOL
  443. /**
  444. * Base structure of Memory pool object
  445. */
  446. struct rt_mempool
  447. {
  448. struct rt_object parent; /**< inherit from rt_object */
  449. void *start_address; /**< memory pool start */
  450. rt_size_t size; /**< size of memory pool */
  451. rt_size_t block_size; /**< size of memory blocks */
  452. rt_uint8_t *block_list; /**< memory blocks list */
  453. rt_size_t block_total_count; /**< numbers of memory block */
  454. rt_size_t block_free_count; /**< numbers of free memory block */
  455. rt_list_t suspend_thread; /**< threads pended on this resource */
  456. rt_size_t suspend_thread_count; /**< numbers of thread pended on this resource */
  457. };
  458. typedef struct rt_mempool* rt_mp_t;
  459. #endif
  460. /*@}*/
  461. #ifdef RT_USING_DEVICE
  462. /**
  463. * @addtogroup Device
  464. */
  465. /*@{*/
  466. /**
  467. * device (I/O) class type
  468. */
  469. enum rt_device_class_type
  470. {
  471. RT_Device_Class_Char = 0, /**< character device */
  472. RT_Device_Class_Block, /**< block device */
  473. RT_Device_Class_NetIf, /**< net interface */
  474. RT_Device_Class_MTD, /**< memory device */
  475. RT_Device_Class_CAN, /**< CAN device */
  476. RT_Device_Class_RTC, /**< RTC device */
  477. RT_Device_Class_Sound, /**< Sound device */
  478. RT_Device_Class_Unknown /**< unknown device */
  479. };
  480. /**
  481. * device flags defitions
  482. */
  483. #define RT_DEVICE_FLAG_DEACTIVATE 0x000 /**< device is not not initialized */
  484. #define RT_DEVICE_FLAG_RDONLY 0x001 /**< read only */
  485. #define RT_DEVICE_FLAG_WRONLY 0x002 /**< write only */
  486. #define RT_DEVICE_FLAG_RDWR 0x003 /**< read and write */
  487. #define RT_DEVICE_FLAG_REMOVABLE 0x004 /**< removable device */
  488. #define RT_DEVICE_FLAG_STANDALONE 0x008 /**< standalone device */
  489. #define RT_DEVICE_FLAG_ACTIVATED 0x010 /**< device is activated */
  490. #define RT_DEVICE_FLAG_SUSPENDED 0x020 /**< device is suspended */
  491. #define RT_DEVICE_FLAG_STREAM 0x040 /**< stream mode */
  492. #define RT_DEVICE_FLAG_INT_RX 0x100 /**< INT mode on Rx */
  493. #define RT_DEVICE_FLAG_DMA_RX 0x200 /**< DMA mode on Rx */
  494. #define RT_DEVICE_FLAG_INT_TX 0x400 /**< INT mode on Tx */
  495. #define RT_DEVICE_FLAG_DMA_TX 0x800 /**< DMA mode on Tx */
  496. #define RT_DEVICE_OFLAG_CLOSE 0x000 /**< device is closed */
  497. #define RT_DEVICE_OFLAG_RDONLY 0x001 /**< read only access */
  498. #define RT_DEVICE_OFLAG_WRONLY 0x002 /**< write only access */
  499. #define RT_DEVICE_OFLAG_RDWR 0x003 /**< read and write */
  500. #define RT_DEVICE_OFLAG_OPEN 0x008 /**< device is opened */
  501. /**
  502. * general device commands
  503. */
  504. #define RT_DEVICE_CTRL_RESUME 0x01 /**< resume device */
  505. #define RT_DEVICE_CTRL_SUSPEND 0x02 /**< suspend device */
  506. /**
  507. * special device commands
  508. */
  509. #define RT_DEVICE_CTRL_CHAR_STREAM 0x10 /**< stream mode on char device */
  510. #define RT_DEVICE_CTRL_BLK_GETGEOME 0x10 /**< get geometry information */
  511. #define RT_DEVICE_CTRL_NETIF_GETMAC 0x10 /**< get mac address */
  512. #define RT_DEVICE_CTRL_MTD_FORMAT 0x10 /**< format a MTD device */
  513. #define RT_DEVICE_CTRL_RTC_GET_TIME 0x10 /**< get time */
  514. #define RT_DEVICE_CTRL_RTC_SET_TIME 0x11 /**< set time */
  515. typedef struct rt_device* rt_device_t;
  516. /**
  517. * Device structure
  518. */
  519. struct rt_device
  520. {
  521. struct rt_object parent; /**< inherit from rt_object */
  522. enum rt_device_class_type type; /**< device type */
  523. rt_uint16_t flag, open_flag; /**< device flag and device open flag */
  524. /* device call back */
  525. rt_err_t (*rx_indicate)(rt_device_t dev, rt_size_t size);
  526. rt_err_t (*tx_complete)(rt_device_t dev, void* buffer);
  527. /* common device interface */
  528. rt_err_t (*init) (rt_device_t dev);
  529. rt_err_t (*open) (rt_device_t dev, rt_uint16_t oflag);
  530. rt_err_t (*close) (rt_device_t dev);
  531. rt_size_t (*read) (rt_device_t dev, rt_off_t pos, void* buffer, rt_size_t size);
  532. rt_size_t (*write) (rt_device_t dev, rt_off_t pos, const void* buffer, rt_size_t size);
  533. rt_err_t (*control)(rt_device_t dev, rt_uint8_t cmd, void *args);
  534. #ifdef RT_USING_DEVICE_SUSPEND
  535. rt_err_t (*suspend) (rt_device_t dev);
  536. rt_err_t (*resumed) (rt_device_t dev);
  537. #endif
  538. void* user_data; /**< device private data */
  539. };
  540. /**
  541. * block device geometry structure
  542. */
  543. struct rt_device_blk_geometry
  544. {
  545. rt_uint32_t sector_count; /**< count of sectors */
  546. rt_uint32_t bytes_per_sector; /**< number of bytes per sector */
  547. rt_uint32_t block_size; /**< size to erase one block */
  548. };
  549. /*@}*/
  550. /**
  551. * @addtogroup Module
  552. */
  553. /*@{*/
  554. #ifdef RT_USING_MODULE
  555. /*
  556. * module system
  557. */
  558. #define RT_MODULE_FLAG_WITHENTRY 0x00 /* with entry point */
  559. #define RT_MODULE_FLAG_WITHOUTENTRY 0x01 /* without entry point */
  560. /**
  561. * Application Module structure
  562. */
  563. struct rt_module
  564. {
  565. struct rt_object parent; /**< inherit from object */
  566. rt_uint8_t* module_space; /**< module memory space */
  567. void* module_entry; /**< entry address of module's thread */
  568. rt_thread_t module_thread; /**< stack size of module's thread */
  569. rt_uint32_t stack_size; /**< priority of module's thread */
  570. rt_uint32_t thread_priority;
  571. /* module memory allocator */
  572. void* mem_list; /**< module's free memory list */
  573. rt_list_t page_list; /**< module's using page list */
  574. rt_mp_t mpool; /**< module's memory pool */
  575. rt_uint32_t nsym; /**< number of symbol in the module */
  576. struct rt_module_symtab *symtab; /**< module symbol table */
  577. rt_uint32_t nref; /**< reference count */
  578. /**< object in this module, module object is the last basic object type */
  579. struct rt_object_information module_object[RT_Object_Class_Unknown];
  580. };
  581. typedef struct rt_module* rt_module_t;
  582. #endif
  583. /*@}*/
  584. #endif
  585. #ifdef __cplusplus
  586. }
  587. #endif
  588. #endif