rtthread.h 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712
  1. /*
  2. * Copyright (c) 2006-2021, RT-Thread Development Team
  3. *
  4. * SPDX-License-Identifier: Apache-2.0
  5. *
  6. * Change Logs:
  7. * Date Author Notes
  8. * 2006-03-18 Bernard the first version
  9. * 2006-04-26 Bernard add semaphore APIs
  10. * 2006-08-10 Bernard add version information
  11. * 2007-01-28 Bernard rename RT_OBJECT_Class_Static to RT_Object_Class_Static
  12. * 2007-03-03 Bernard clean up the definitions to rtdef.h
  13. * 2010-04-11 yi.qiu add module feature
  14. * 2013-06-24 Bernard add rt_kprintf re-define when not use RT_USING_CONSOLE.
  15. * 2016-08-09 ArdaFu add new thread and interrupt hook.
  16. * 2018-11-22 Jesven add all cpu's lock and ipi handler
  17. * 2021-02-28 Meco Man add RT_KSERVICE_USING_STDLIB
  18. * 2021-11-14 Meco Man add rtlegacy.h for compatibility
  19. * 2022-06-04 Meco Man remove strnlen
  20. */
  21. #ifndef __RT_THREAD_H__
  22. #define __RT_THREAD_H__
  23. #include <rtconfig.h>
  24. #include <rtdebug.h>
  25. #include <rtdef.h>
  26. #include <rtservice.h>
  27. #include <rtm.h>
  28. #ifdef RT_USING_LEGACY
  29. #include <rtlegacy.h>
  30. #endif
  31. #ifdef __cplusplus
  32. extern "C" {
  33. #endif
  34. /**
  35. * @addtogroup KernelObject
  36. * @{
  37. */
  38. /*
  39. * kernel object interface
  40. */
  41. struct rt_object_information *
  42. rt_object_get_information(enum rt_object_class_type type);
  43. int rt_object_get_length(enum rt_object_class_type type);
  44. int rt_object_get_pointers(enum rt_object_class_type type, rt_object_t *pointers, int maxlen);
  45. void rt_object_init(struct rt_object *object,
  46. enum rt_object_class_type type,
  47. const char *name);
  48. void rt_object_detach(rt_object_t object);
  49. #ifdef RT_USING_HEAP
  50. rt_object_t rt_object_allocate(enum rt_object_class_type type,
  51. const char *name);
  52. void rt_object_delete(rt_object_t object);
  53. #endif
  54. rt_bool_t rt_object_is_systemobject(rt_object_t object);
  55. rt_uint8_t rt_object_get_type(rt_object_t object);
  56. rt_object_t rt_object_find(const char *name, rt_uint8_t type);
  57. #ifdef RT_USING_HEAP
  58. /* custom object */
  59. rt_object_t rt_custom_object_create(const char *name, void *data, rt_err_t (*data_destroy)(void *));
  60. rt_err_t rt_custom_object_destroy(rt_object_t obj);
  61. #endif
  62. #ifdef RT_USING_HOOK
  63. void rt_object_attach_sethook(void (*hook)(struct rt_object *object));
  64. void rt_object_detach_sethook(void (*hook)(struct rt_object *object));
  65. void rt_object_trytake_sethook(void (*hook)(struct rt_object *object));
  66. void rt_object_take_sethook(void (*hook)(struct rt_object *object));
  67. void rt_object_put_sethook(void (*hook)(struct rt_object *object));
  68. #endif
  69. /**@}*/
  70. /**
  71. * @addtogroup Clock
  72. * @{
  73. */
  74. /*
  75. * clock & timer interface
  76. */
  77. rt_tick_t rt_tick_get(void);
  78. void rt_tick_set(rt_tick_t tick);
  79. void rt_tick_increase(void);
  80. rt_tick_t rt_tick_from_millisecond(rt_int32_t ms);
  81. rt_tick_t rt_tick_get_millisecond(void);
  82. #ifdef RT_USING_HOOK
  83. void rt_tick_sethook(void (*hook)(void));
  84. #endif
  85. void rt_system_timer_init(void);
  86. void rt_system_timer_thread_init(void);
  87. void rt_timer_init(rt_timer_t timer,
  88. const char *name,
  89. void (*timeout)(void *parameter),
  90. void *parameter,
  91. rt_tick_t time,
  92. rt_uint8_t flag);
  93. rt_err_t rt_timer_detach(rt_timer_t timer);
  94. #ifdef RT_USING_HEAP
  95. rt_timer_t rt_timer_create(const char *name,
  96. void (*timeout)(void *parameter),
  97. void *parameter,
  98. rt_tick_t time,
  99. rt_uint8_t flag);
  100. rt_err_t rt_timer_delete(rt_timer_t timer);
  101. #endif
  102. rt_err_t rt_timer_start(rt_timer_t timer);
  103. rt_err_t rt_timer_stop(rt_timer_t timer);
  104. rt_err_t rt_timer_control(rt_timer_t timer, int cmd, void *arg);
  105. rt_tick_t rt_timer_next_timeout_tick(void);
  106. void rt_timer_check(void);
  107. #ifdef RT_USING_HOOK
  108. void rt_timer_enter_sethook(void (*hook)(struct rt_timer *timer));
  109. void rt_timer_exit_sethook(void (*hook)(struct rt_timer *timer));
  110. #endif
  111. /**@}*/
  112. /**
  113. * @addtogroup Thread
  114. * @{
  115. */
  116. /*
  117. * thread interface
  118. */
  119. rt_err_t rt_thread_init(struct rt_thread *thread,
  120. const char *name,
  121. void (*entry)(void *parameter),
  122. void *parameter,
  123. void *stack_start,
  124. rt_uint32_t stack_size,
  125. rt_uint8_t priority,
  126. rt_uint32_t tick);
  127. rt_err_t rt_thread_detach(rt_thread_t thread);
  128. #ifdef RT_USING_HEAP
  129. rt_thread_t rt_thread_create(const char *name,
  130. void (*entry)(void *parameter),
  131. void *parameter,
  132. rt_uint32_t stack_size,
  133. rt_uint8_t priority,
  134. rt_uint32_t tick);
  135. rt_err_t rt_thread_delete(rt_thread_t thread);
  136. #endif
  137. rt_thread_t rt_thread_self(void);
  138. rt_thread_t rt_thread_find(char *name);
  139. rt_err_t rt_thread_startup(rt_thread_t thread);
  140. rt_err_t rt_thread_yield(void);
  141. rt_err_t rt_thread_delay(rt_tick_t tick);
  142. rt_err_t rt_thread_delay_until(rt_tick_t *tick, rt_tick_t inc_tick);
  143. rt_err_t rt_thread_mdelay(rt_int32_t ms);
  144. rt_err_t rt_thread_control(rt_thread_t thread, int cmd, void *arg);
  145. rt_err_t rt_thread_suspend(rt_thread_t thread);
  146. rt_err_t rt_thread_suspend_with_flag(rt_thread_t thread, int suspend_flag);
  147. rt_err_t rt_thread_resume(rt_thread_t thread);
  148. #ifdef RT_USING_SMART
  149. rt_err_t rt_thread_wakeup(rt_thread_t thread);
  150. void rt_thread_wakeup_set(struct rt_thread *thread, rt_wakeup_func_t func, void* user_data);
  151. #endif
  152. void rt_thread_timeout(void *parameter);
  153. #ifdef RT_USING_SIGNALS
  154. void rt_thread_alloc_sig(rt_thread_t tid);
  155. void rt_thread_free_sig(rt_thread_t tid);
  156. int rt_thread_kill(rt_thread_t tid, int sig);
  157. #endif
  158. #ifdef RT_USING_HOOK
  159. void rt_thread_suspend_sethook(void (*hook)(rt_thread_t thread));
  160. void rt_thread_resume_sethook (void (*hook)(rt_thread_t thread));
  161. void rt_thread_inited_sethook (void (*hook)(rt_thread_t thread));
  162. #endif
  163. /*
  164. * idle thread interface
  165. */
  166. void rt_thread_idle_init(void);
  167. #if defined(RT_USING_HOOK) || defined(RT_USING_IDLE_HOOK)
  168. rt_err_t rt_thread_idle_sethook(void (*hook)(void));
  169. rt_err_t rt_thread_idle_delhook(void (*hook)(void));
  170. #endif
  171. rt_thread_t rt_thread_idle_gethandler(void);
  172. /*
  173. * schedule service
  174. */
  175. void rt_system_scheduler_init(void);
  176. void rt_system_scheduler_start(void);
  177. void rt_schedule(void);
  178. void rt_schedule_insert_thread(struct rt_thread *thread);
  179. void rt_schedule_remove_thread(struct rt_thread *thread);
  180. void rt_enter_critical(void);
  181. void rt_exit_critical(void);
  182. rt_uint16_t rt_critical_level(void);
  183. #ifdef RT_USING_HOOK
  184. void rt_scheduler_sethook(void (*hook)(rt_thread_t from, rt_thread_t to));
  185. void rt_scheduler_switch_sethook(void (*hook)(struct rt_thread *tid));
  186. #endif
  187. #ifdef RT_USING_SMP
  188. void rt_secondary_cpu_entry(void);
  189. void rt_scheduler_ipi_handler(int vector, void *param);
  190. #endif
  191. /**@}*/
  192. /**
  193. * @addtogroup Signals
  194. * @{
  195. */
  196. #ifdef RT_USING_SIGNALS
  197. void rt_signal_mask(int signo);
  198. void rt_signal_unmask(int signo);
  199. rt_sighandler_t rt_signal_install(int signo, rt_sighandler_t handler);
  200. int rt_signal_wait(const rt_sigset_t *set, rt_siginfo_t *si, rt_int32_t timeout);
  201. int rt_system_signal_init(void);
  202. #endif
  203. /**@}*/
  204. /**
  205. * @addtogroup MM
  206. * @{
  207. */
  208. /*
  209. * memory management interface
  210. */
  211. #ifdef RT_USING_MEMPOOL
  212. /*
  213. * memory pool interface
  214. */
  215. rt_err_t rt_mp_init(struct rt_mempool *mp,
  216. const char *name,
  217. void *start,
  218. rt_size_t size,
  219. rt_size_t block_size);
  220. rt_err_t rt_mp_detach(struct rt_mempool *mp);
  221. #ifdef RT_USING_HEAP
  222. rt_mp_t rt_mp_create(const char *name,
  223. rt_size_t block_count,
  224. rt_size_t block_size);
  225. rt_err_t rt_mp_delete(rt_mp_t mp);
  226. #endif
  227. void *rt_mp_alloc(rt_mp_t mp, rt_int32_t time);
  228. void rt_mp_free(void *block);
  229. #ifdef RT_USING_HOOK
  230. void rt_mp_alloc_sethook(void (*hook)(struct rt_mempool *mp, void *block));
  231. void rt_mp_free_sethook(void (*hook)(struct rt_mempool *mp, void *block));
  232. #endif
  233. #endif
  234. #ifdef RT_USING_HEAP
  235. /*
  236. * heap memory interface
  237. */
  238. void rt_system_heap_init(void *begin_addr, void *end_addr);
  239. void *rt_malloc(rt_size_t size);
  240. void rt_free(void *ptr);
  241. void *rt_realloc(void *ptr, rt_size_t newsize);
  242. void *rt_calloc(rt_size_t count, rt_size_t size);
  243. void *rt_malloc_align(rt_size_t size, rt_size_t align);
  244. void rt_free_align(void *ptr);
  245. void rt_memory_info(rt_size_t *total,
  246. rt_size_t *used,
  247. rt_size_t *max_used);
  248. #if defined(RT_USING_SLAB) && defined(RT_USING_SLAB_AS_HEAP)
  249. void *rt_page_alloc(rt_size_t npages);
  250. void rt_page_free(void *addr, rt_size_t npages);
  251. #endif
  252. #ifdef RT_USING_HOOK
  253. void rt_malloc_sethook(void (*hook)(void *ptr, rt_size_t size));
  254. void rt_free_sethook(void (*hook)(void *ptr));
  255. #endif
  256. #endif
  257. #ifdef RT_USING_SMALL_MEM
  258. /**
  259. * small memory object interface
  260. */
  261. rt_smem_t rt_smem_init(const char *name,
  262. void *begin_addr,
  263. rt_size_t size);
  264. rt_err_t rt_smem_detach(rt_smem_t m);
  265. void *rt_smem_alloc(rt_smem_t m, rt_size_t size);
  266. void *rt_smem_realloc(rt_smem_t m, void *rmem, rt_size_t newsize);
  267. void rt_smem_free(void *rmem);
  268. #endif
  269. #ifdef RT_USING_MEMHEAP
  270. /**
  271. * memory heap object interface
  272. */
  273. rt_err_t rt_memheap_init(struct rt_memheap *memheap,
  274. const char *name,
  275. void *start_addr,
  276. rt_size_t size);
  277. rt_err_t rt_memheap_detach(struct rt_memheap *heap);
  278. void *rt_memheap_alloc(struct rt_memheap *heap, rt_size_t size);
  279. void *rt_memheap_realloc(struct rt_memheap *heap, void *ptr, rt_size_t newsize);
  280. void rt_memheap_free(void *ptr);
  281. void rt_memheap_info(struct rt_memheap *heap,
  282. rt_size_t *total,
  283. rt_size_t *used,
  284. rt_size_t *max_used);
  285. #endif
  286. #ifdef RT_USING_SLAB
  287. /**
  288. * slab object interface
  289. */
  290. rt_slab_t rt_slab_init(const char *name, void *begin_addr, rt_size_t size);
  291. rt_err_t rt_slab_detach(rt_slab_t m);
  292. void *rt_slab_page_alloc(rt_slab_t m, rt_size_t npages);
  293. void rt_slab_page_free(rt_slab_t m, void *addr, rt_size_t npages);
  294. void *rt_slab_alloc(rt_slab_t m, rt_size_t size);
  295. void *rt_slab_realloc(rt_slab_t m, void *ptr, rt_size_t size);
  296. void rt_slab_free(rt_slab_t m, void *ptr);
  297. #endif
  298. /**@}*/
  299. /**
  300. * @addtogroup IPC
  301. * @{
  302. */
  303. #ifdef RT_USING_SEMAPHORE
  304. /*
  305. * semaphore interface
  306. */
  307. rt_err_t rt_sem_init(rt_sem_t sem,
  308. const char *name,
  309. rt_uint32_t value,
  310. rt_uint8_t flag);
  311. rt_err_t rt_sem_detach(rt_sem_t sem);
  312. #ifdef RT_USING_HEAP
  313. rt_sem_t rt_sem_create(const char *name, rt_uint32_t value, rt_uint8_t flag);
  314. rt_err_t rt_sem_delete(rt_sem_t sem);
  315. #endif
  316. rt_err_t rt_sem_take(rt_sem_t sem, rt_int32_t timeout);
  317. rt_err_t rt_sem_take_interruptible(rt_sem_t sem, rt_int32_t timeout);
  318. rt_err_t rt_sem_take_killable(rt_sem_t sem, rt_int32_t timeout);
  319. rt_err_t rt_sem_trytake(rt_sem_t sem);
  320. rt_err_t rt_sem_release(rt_sem_t sem);
  321. rt_err_t rt_sem_control(rt_sem_t sem, int cmd, void *arg);
  322. #endif
  323. #ifdef RT_USING_MUTEX
  324. /*
  325. * mutex interface
  326. */
  327. rt_err_t rt_mutex_init(rt_mutex_t mutex, const char *name, rt_uint8_t flag);
  328. rt_err_t rt_mutex_detach(rt_mutex_t mutex);
  329. #ifdef RT_USING_HEAP
  330. rt_mutex_t rt_mutex_create(const char *name, rt_uint8_t flag);
  331. rt_err_t rt_mutex_delete(rt_mutex_t mutex);
  332. #endif
  333. void rt_mutex_drop_thread(rt_mutex_t mutex, rt_thread_t thread);
  334. rt_uint8_t rt_mutex_setprioceiling(rt_mutex_t mutex, rt_uint8_t priority);
  335. rt_uint8_t rt_mutex_getprioceiling(rt_mutex_t mutex);
  336. rt_err_t rt_mutex_take(rt_mutex_t mutex, rt_int32_t timeout);
  337. rt_err_t rt_mutex_trytake(rt_mutex_t mutex);
  338. rt_err_t rt_mutex_take_interruptible(rt_mutex_t mutex, rt_int32_t time);
  339. rt_err_t rt_mutex_take_killable(rt_mutex_t mutex, rt_int32_t time);
  340. rt_err_t rt_mutex_release(rt_mutex_t mutex);
  341. rt_err_t rt_mutex_control(rt_mutex_t mutex, int cmd, void *arg);
  342. #endif
  343. #ifdef RT_USING_EVENT
  344. /*
  345. * event interface
  346. */
  347. rt_err_t rt_event_init(rt_event_t event, const char *name, rt_uint8_t flag);
  348. rt_err_t rt_event_detach(rt_event_t event);
  349. #ifdef RT_USING_HEAP
  350. rt_event_t rt_event_create(const char *name, rt_uint8_t flag);
  351. rt_err_t rt_event_delete(rt_event_t event);
  352. #endif
  353. rt_err_t rt_event_send(rt_event_t event, rt_uint32_t set);
  354. rt_err_t rt_event_recv(rt_event_t event,
  355. rt_uint32_t set,
  356. rt_uint8_t opt,
  357. rt_int32_t timeout,
  358. rt_uint32_t *recved);
  359. rt_err_t rt_event_recv_interruptible(rt_event_t event,
  360. rt_uint32_t set,
  361. rt_uint8_t opt,
  362. rt_int32_t timeout,
  363. rt_uint32_t *recved);
  364. rt_err_t rt_event_recv_killable(rt_event_t event,
  365. rt_uint32_t set,
  366. rt_uint8_t opt,
  367. rt_int32_t timeout,
  368. rt_uint32_t *recved);
  369. rt_err_t rt_event_control(rt_event_t event, int cmd, void *arg);
  370. #endif
  371. #ifdef RT_USING_MAILBOX
  372. /*
  373. * mailbox interface
  374. */
  375. rt_err_t rt_mb_init(rt_mailbox_t mb,
  376. const char *name,
  377. void *msgpool,
  378. rt_size_t size,
  379. rt_uint8_t flag);
  380. rt_err_t rt_mb_detach(rt_mailbox_t mb);
  381. #ifdef RT_USING_HEAP
  382. rt_mailbox_t rt_mb_create(const char *name, rt_size_t size, rt_uint8_t flag);
  383. rt_err_t rt_mb_delete(rt_mailbox_t mb);
  384. #endif
  385. rt_err_t rt_mb_send(rt_mailbox_t mb, rt_ubase_t value);
  386. rt_err_t rt_mb_send_wait(rt_mailbox_t mb,
  387. rt_ubase_t value,
  388. rt_int32_t timeout);
  389. rt_err_t rt_mb_send_wait_interruptible(rt_mailbox_t mb,
  390. rt_ubase_t value,
  391. rt_int32_t timeout);
  392. rt_err_t rt_mb_send_wait_killable(rt_mailbox_t mb,
  393. rt_ubase_t value,
  394. rt_int32_t timeout);
  395. rt_err_t rt_mb_urgent(rt_mailbox_t mb, rt_ubase_t value);
  396. rt_err_t rt_mb_recv(rt_mailbox_t mb, rt_ubase_t *value, rt_int32_t timeout);
  397. rt_err_t rt_mb_recv_interruptibale(rt_mailbox_t mb, rt_ubase_t *value, rt_int32_t timeout);
  398. rt_err_t rt_mb_recv_killable(rt_mailbox_t mb, rt_ubase_t *value, rt_int32_t timeout);
  399. rt_err_t rt_mb_control(rt_mailbox_t mb, int cmd, void *arg);
  400. #endif
  401. #ifdef RT_USING_MESSAGEQUEUE
  402. /*
  403. * message queue interface
  404. */
  405. rt_err_t rt_mq_init(rt_mq_t mq,
  406. const char *name,
  407. void *msgpool,
  408. rt_size_t msg_size,
  409. rt_size_t pool_size,
  410. rt_uint8_t flag);
  411. rt_err_t rt_mq_detach(rt_mq_t mq);
  412. #ifdef RT_USING_HEAP
  413. rt_mq_t rt_mq_create(const char *name,
  414. rt_size_t msg_size,
  415. rt_size_t max_msgs,
  416. rt_uint8_t flag);
  417. rt_err_t rt_mq_delete(rt_mq_t mq);
  418. #endif
  419. rt_err_t rt_mq_send(rt_mq_t mq, const void *buffer, rt_size_t size);
  420. rt_err_t rt_mq_send_interrupt(rt_mq_t mq, const void *buffer, rt_size_t size);
  421. rt_err_t rt_mq_send_killable(rt_mq_t mq, const void *buffer, rt_size_t size);
  422. rt_err_t rt_mq_send_wait(rt_mq_t mq,
  423. const void *buffer,
  424. rt_size_t size,
  425. rt_int32_t timeout);
  426. rt_err_t rt_mq_send_wait_interruptible(rt_mq_t mq,
  427. const void *buffer,
  428. rt_size_t size,
  429. rt_int32_t timeout);
  430. rt_err_t rt_mq_send_wait_killable(rt_mq_t mq,
  431. const void *buffer,
  432. rt_size_t size,
  433. rt_int32_t timeout);
  434. rt_err_t rt_mq_urgent(rt_mq_t mq, const void *buffer, rt_size_t size);
  435. rt_err_t rt_mq_recv(rt_mq_t mq,
  436. void *buffer,
  437. rt_size_t size,
  438. rt_int32_t timeout);
  439. rt_err_t rt_mq_recv_interruptible(rt_mq_t mq,
  440. void *buffer,
  441. rt_size_t size,
  442. rt_int32_t timeout);
  443. rt_err_t rt_mq_recv_killable(rt_mq_t mq,
  444. void *buffer,
  445. rt_size_t size,
  446. rt_int32_t timeout);
  447. rt_err_t rt_mq_control(rt_mq_t mq, int cmd, void *arg);
  448. #endif
  449. /* defunct */
  450. void rt_thread_defunct_enqueue(rt_thread_t thread);
  451. rt_thread_t rt_thread_defunct_dequeue(void);
  452. /*
  453. * spinlock
  454. */
  455. #ifdef RT_USING_SMP
  456. struct rt_spinlock;
  457. void rt_spin_lock_init(struct rt_spinlock *lock);
  458. void rt_spin_lock(struct rt_spinlock *lock);
  459. void rt_spin_unlock(struct rt_spinlock *lock);
  460. rt_base_t rt_spin_lock_irqsave(struct rt_spinlock *lock);
  461. void rt_spin_unlock_irqrestore(struct rt_spinlock *lock, rt_base_t level);
  462. #else
  463. #define rt_spin_lock_init(lock) /* nothing */
  464. #define rt_spin_lock(lock) rt_enter_critical()
  465. #define rt_spin_unlock(lock) rt_exit_critical()
  466. #define rt_spin_lock_irqsave(lock) rt_hw_interrupt_disable()
  467. #define rt_spin_unlock_irqrestore(lock, level) rt_hw_interrupt_enable(level)
  468. #endif
  469. /**@}*/
  470. #ifdef RT_USING_DEVICE
  471. /**
  472. * @addtogroup Device
  473. * @{
  474. */
  475. /*
  476. * device (I/O) system interface
  477. */
  478. rt_device_t rt_device_find(const char *name);
  479. rt_err_t rt_device_register(rt_device_t dev,
  480. const char *name,
  481. rt_uint16_t flags);
  482. rt_err_t rt_device_unregister(rt_device_t dev);
  483. #ifdef RT_USING_HEAP
  484. rt_device_t rt_device_create(int type, int attach_size);
  485. void rt_device_destroy(rt_device_t device);
  486. #endif
  487. rt_err_t
  488. rt_device_set_rx_indicate(rt_device_t dev,
  489. rt_err_t (*rx_ind)(rt_device_t dev, rt_size_t size));
  490. rt_err_t
  491. rt_device_set_tx_complete(rt_device_t dev,
  492. rt_err_t (*tx_done)(rt_device_t dev, void *buffer));
  493. rt_err_t rt_device_init (rt_device_t dev);
  494. rt_err_t rt_device_open (rt_device_t dev, rt_uint16_t oflag);
  495. rt_err_t rt_device_close(rt_device_t dev);
  496. rt_ssize_t rt_device_read(rt_device_t dev,
  497. rt_off_t pos,
  498. void *buffer,
  499. rt_size_t size);
  500. rt_ssize_t rt_device_write(rt_device_t dev,
  501. rt_off_t pos,
  502. const void *buffer,
  503. rt_size_t size);
  504. rt_err_t rt_device_control(rt_device_t dev, int cmd, void *arg);
  505. #ifdef RT_USING_DM
  506. rt_err_t rt_device_bind_driver(rt_device_t device, rt_driver_t driver, void *node);
  507. rt_device_t rt_device_create_since_driver(rt_driver_t drv,int device_id);
  508. rt_err_t rt_device_probe_and_init(rt_device_t device);
  509. rt_err_t rt_driver_match_with_id(const rt_driver_t drv,int device_id);
  510. rt_err_t rt_driver_match_with_dtb(const rt_driver_t drv,void *from_node,int max_dev_num);
  511. #endif
  512. /**@}*/
  513. #endif
  514. /*
  515. * interrupt service
  516. */
  517. /*
  518. * rt_interrupt_enter and rt_interrupt_leave only can be called by BSP
  519. */
  520. void rt_interrupt_enter(void);
  521. void rt_interrupt_leave(void);
  522. #ifdef RT_USING_SMP
  523. /*
  524. * smp cpus lock service
  525. */
  526. rt_base_t rt_cpus_lock(void);
  527. void rt_cpus_unlock(rt_base_t level);
  528. struct rt_cpu *rt_cpu_self(void);
  529. struct rt_cpu *rt_cpu_index(int index);
  530. #endif
  531. /*
  532. * the number of nested interrupts.
  533. */
  534. rt_uint8_t rt_interrupt_get_nest(void);
  535. #ifdef RT_USING_HOOK
  536. void rt_interrupt_enter_sethook(void (*hook)(void));
  537. void rt_interrupt_leave_sethook(void (*hook)(void));
  538. #endif
  539. #ifdef RT_USING_COMPONENTS_INIT
  540. void rt_components_init(void);
  541. void rt_components_board_init(void);
  542. #endif
  543. /**
  544. * @addtogroup KernelService
  545. * @{
  546. */
  547. /*
  548. * general kernel service
  549. */
  550. #ifndef RT_USING_CONSOLE
  551. #define rt_kprintf(...)
  552. #define rt_kputs(str)
  553. #else
  554. int rt_kprintf(const char *fmt, ...);
  555. void rt_kputs(const char *str);
  556. #endif
  557. int rt_vsprintf(char *dest, const char *format, va_list arg_ptr);
  558. int rt_vsnprintf(char *buf, rt_size_t size, const char *fmt, va_list args);
  559. int rt_sprintf(char *buf, const char *format, ...);
  560. int rt_snprintf(char *buf, rt_size_t size, const char *format, ...);
  561. #if defined(RT_USING_DEVICE) && defined(RT_USING_CONSOLE)
  562. rt_device_t rt_console_set_device(const char *name);
  563. rt_device_t rt_console_get_device(void);
  564. #endif
  565. rt_err_t rt_get_errno(void);
  566. void rt_set_errno(rt_err_t no);
  567. int *_rt_errno(void);
  568. const char *rt_strerror(rt_err_t error);
  569. #if !defined(RT_USING_NEWLIBC) && !defined(_WIN32)
  570. #ifndef errno
  571. #define errno *_rt_errno()
  572. #endif
  573. #endif
  574. int __rt_ffs(int value);
  575. #ifndef RT_KSERVICE_USING_STDLIB_MEMORY
  576. void *rt_memset(void *src, int c, rt_ubase_t n);
  577. void *rt_memcpy(void *dest, const void *src, rt_ubase_t n);
  578. void *rt_memmove(void *dest, const void *src, rt_size_t n);
  579. rt_int32_t rt_memcmp(const void *cs, const void *ct, rt_size_t count);
  580. #endif /* RT_KSERVICE_USING_STDLIB_MEMORY */
  581. char *rt_strdup(const char *s);
  582. rt_size_t rt_strnlen(const char *s, rt_ubase_t maxlen);
  583. #ifndef RT_KSERVICE_USING_STDLIB
  584. char *rt_strstr(const char *str1, const char *str2);
  585. rt_int32_t rt_strcasecmp(const char *a, const char *b);
  586. char *rt_strcpy(char *dst, const char *src);
  587. char *rt_strncpy(char *dest, const char *src, rt_size_t n);
  588. rt_int32_t rt_strncmp(const char *cs, const char *ct, rt_size_t count);
  589. rt_int32_t rt_strcmp(const char *cs, const char *ct);
  590. rt_size_t rt_strlen(const char *src);
  591. #else
  592. #include <string.h>
  593. #ifdef RT_KSERVICE_USING_STDLIB_MEMORY
  594. #define rt_memset(s, c, count) memset(s, c, count)
  595. #define rt_memcpy(dst, src, count) memcpy(dst, src, count)
  596. #define rt_memmove(dest, src, n) memmove(dest, src, n)
  597. #define rt_memcmp(cs, ct, count) memcmp(cs, ct, count)
  598. #endif /* RT_KSERVICE_USING_STDLIB_MEMORY */
  599. #define rt_strstr(str1, str2) strstr(str1, str2)
  600. #define rt_strcasecmp(a, b) strcasecmp(a, b)
  601. #define rt_strcpy(dest, src) strcpy(dest, src)
  602. #define rt_strncpy(dest, src, n) strncpy(dest, src, n)
  603. #define rt_strncmp(cs, ct, count) strncmp(cs, ct, count)
  604. #define rt_strcmp(cs, ct) strcmp(cs, ct)
  605. #define rt_strlen(src) strlen(src)
  606. #endif /*RT_KSERVICE_USING_STDLIB*/
  607. void rt_show_version(void);
  608. #ifdef RT_DEBUG
  609. extern void (*rt_assert_hook)(const char *ex, const char *func, rt_size_t line);
  610. void rt_assert_set_hook(void (*hook)(const char *ex, const char *func, rt_size_t line));
  611. void rt_assert_handler(const char *ex, const char *func, rt_size_t line);
  612. #endif /* RT_DEBUG */
  613. #ifdef RT_USING_FINSH
  614. #include <finsh.h>
  615. #endif
  616. /**@}*/
  617. #ifdef __cplusplus
  618. }
  619. #endif
  620. #endif