rtthread.h 22 KB

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