rtx_msgqueue.c 23 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828
  1. /*
  2. * Copyright (c) 2013-2016 ARM Limited. All rights reserved.
  3. *
  4. * SPDX-License-Identifier: Apache-2.0
  5. *
  6. * Licensed under the Apache License, Version 2.0 (the License); you may
  7. * not use this file except in compliance with the License.
  8. * You may obtain a copy of the License at
  9. *
  10. * http://www.apache.org/licenses/LICENSE-2.0
  11. *
  12. * Unless required by applicable law or agreed to in writing, software
  13. * distributed under the License is distributed on an AS IS BASIS, WITHOUT
  14. * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15. * See the License for the specific language governing permissions and
  16. * limitations under the License.
  17. *
  18. * -----------------------------------------------------------------------------
  19. *
  20. * Project: CMSIS-RTOS RTX
  21. * Title: Message Queue functions
  22. *
  23. * -----------------------------------------------------------------------------
  24. */
  25. #include "rtx_lib.h"
  26. // ==== Helper functions ====
  27. /// Put a Message into Queue sorted by Priority (Highest at Head).
  28. /// \param[in] mq message queue object.
  29. /// \param[in] msg message object.
  30. static void os_MessageQueuePut (os_message_queue_t *mq, os_message_t *msg) {
  31. #ifdef __NO_EXCLUSIVE_ACCESS
  32. uint32_t primask = __get_PRIMASK();
  33. #endif
  34. os_message_t *prev, *next;
  35. if (mq->msg_last != NULL) {
  36. prev = mq->msg_last;
  37. next = NULL;
  38. while ((prev != NULL) && (prev->priority < msg->priority)) {
  39. next = prev;
  40. prev = prev->prev;
  41. }
  42. msg->prev = prev;
  43. msg->next = next;
  44. if (prev != NULL) {
  45. prev->next = msg;
  46. } else {
  47. mq->msg_first = msg;
  48. }
  49. if (next != NULL) {
  50. next->prev = msg;
  51. } else {
  52. mq->msg_last = msg;
  53. }
  54. } else {
  55. msg->prev = NULL;
  56. msg->next = NULL;
  57. mq->msg_first= msg;
  58. mq->msg_last = msg;
  59. }
  60. #ifdef __NO_EXCLUSIVE_ACCESS
  61. __disable_irq();
  62. mq->msg_count++;
  63. if (primask == 0U) {
  64. __enable_irq();
  65. }
  66. #else
  67. os_exc_inc32(&mq->msg_count);
  68. #endif
  69. }
  70. /// Get a Message from Queue with Highest Priority.
  71. /// \param[in] mq message queue object.
  72. /// \return message object or NULL.
  73. static os_message_t *os_MessageQueueGet (os_message_queue_t *mq) {
  74. #ifdef __NO_EXCLUSIVE_ACCESS
  75. uint32_t primask = __get_PRIMASK();
  76. #endif
  77. os_message_t *msg;
  78. uint32_t count;
  79. uint8_t flags;
  80. #ifdef __NO_EXCLUSIVE_ACCESS
  81. __disable_irq();
  82. count = mq->msg_count;
  83. if (count != 0U) {
  84. mq->msg_count--;
  85. }
  86. if (primask == 0U) {
  87. __enable_irq();
  88. }
  89. #else
  90. count = os_exc_dec32_nz(&mq->msg_count);
  91. #endif
  92. if (count == 0U) {
  93. return NULL;
  94. }
  95. msg = mq->msg_first;
  96. while (msg != NULL) {
  97. #ifdef __NO_EXCLUSIVE_ACCESS
  98. __disable_irq();
  99. flags = msg->flags;
  100. msg->flags = 1U;
  101. if (primask == 0U) {
  102. __enable_irq();
  103. }
  104. #else
  105. flags = os_exc_wr8(&msg->flags, 1U);
  106. #endif
  107. if (flags == 0U) {
  108. break;
  109. }
  110. msg = msg->next;
  111. }
  112. return msg;
  113. }
  114. /// Remove a Message from Queue
  115. /// \param[in] mq message queue object.
  116. /// \param[in] msg message object.
  117. static void os_MessageQueueRemove (os_message_queue_t *mq, os_message_t *msg) {
  118. if (msg->prev != NULL) {
  119. msg->prev->next = msg->next;
  120. } else {
  121. mq->msg_first = msg->next;
  122. }
  123. if (msg->next != NULL) {
  124. msg->next->prev = msg->prev;
  125. } else {
  126. mq->msg_last = msg->prev;
  127. }
  128. }
  129. // ==== Library functions ====
  130. /// Message Queue post ISR processing.
  131. /// \param[in] msg message object.
  132. void os_MessageQueuePostProcess (os_message_t *msg) {
  133. os_message_queue_t *mq;
  134. os_thread_t *thread;
  135. uint32_t *reg;
  136. void **ptr;
  137. if (msg->state == os_ObjectInactive) {
  138. return;
  139. }
  140. if (msg->flags != 0U) {
  141. // Remove Message
  142. ptr = (void *)((uint8_t *)msg + sizeof(os_message_t));
  143. mq = *ptr;
  144. if (mq->state == os_ObjectInactive) {
  145. return;
  146. }
  147. os_MessageQueueRemove(mq, msg);
  148. // Free memory
  149. msg->state = os_ObjectInactive;
  150. os_MemoryPoolFree(&mq->mp_info, msg);
  151. // Check if Thread is waiting to send a Message
  152. if ((mq->thread_list != NULL) && (mq->thread_list->state == os_ThreadWaitingMessagePut)) {
  153. // Try to allocate memory
  154. msg = os_MemoryPoolAlloc(&mq->mp_info);
  155. if (msg != NULL) {
  156. // Wakeup waiting Thread with highest Priority
  157. thread = os_ThreadListGet((os_object_t*)mq);
  158. os_ThreadWaitExit(thread, (uint32_t)osOK, false);
  159. // Copy Message (R1 = const void *msg_ptr, R2 = msg_prio)
  160. reg = os_ThreadRegPtr(thread);
  161. memcpy((uint8_t *)msg + sizeof(os_message_t), (void *)reg[1], mq->msg_size);
  162. // Store Message into Queue
  163. msg->id = os_IdMessage;
  164. msg->state = os_ObjectActive;
  165. msg->flags = 0U;
  166. msg->priority = (uint8_t)reg[2];
  167. os_MessageQueuePut(mq, msg);
  168. }
  169. }
  170. } else {
  171. // New Message
  172. ptr = (void *)((uint8_t *)msg + sizeof(os_message_t) - sizeof(os_message_queue_t *));
  173. mq = *ptr;
  174. if (mq->state == os_ObjectInactive) {
  175. return;
  176. }
  177. // Check if Thread is waiting to receive a Message
  178. if ((mq->thread_list != NULL) && (mq->thread_list->state == os_ThreadWaitingMessageGet)) {
  179. // Wakeup waiting Thread with highest Priority
  180. thread = os_ThreadListGet((os_object_t*)mq);
  181. os_ThreadWaitExit(thread, (uint32_t)osOK, false);
  182. // Copy Message (R1 = void *msg_ptr, R2 = *msg_prio)
  183. reg = os_ThreadRegPtr(thread);
  184. memcpy((void *)reg[1], (uint8_t *)msg + sizeof(os_message_t), mq->msg_size);
  185. if (reg[2] != 0U) {
  186. *((uint8_t *)reg[2]) = msg->priority;
  187. }
  188. // Free memory
  189. msg->state = os_ObjectInactive;
  190. os_MemoryPoolFree(&mq->mp_info, msg);
  191. } else {
  192. os_MessageQueuePut(mq, msg);
  193. }
  194. }
  195. }
  196. // ==== Service Calls ====
  197. SVC0_3(MessageQueueNew, osMessageQueueId_t, uint32_t, uint32_t, const osMessageQueueAttr_t *)
  198. SVC0_4(MessageQueuePut, osStatus_t, osMessageQueueId_t, const void *, uint8_t, uint32_t)
  199. SVC0_4(MessageQueueGet, osStatus_t, osMessageQueueId_t, void *, uint8_t *, uint32_t)
  200. SVC0_1(MessageQueueGetCapacity, uint32_t, osMessageQueueId_t)
  201. SVC0_1(MessageQueueGetMsgSize, uint32_t, osMessageQueueId_t)
  202. SVC0_1(MessageQueueGetCount, uint32_t, osMessageQueueId_t)
  203. SVC0_1(MessageQueueGetSpace, uint32_t, osMessageQueueId_t)
  204. SVC0_1(MessageQueueReset, osStatus_t, osMessageQueueId_t)
  205. SVC0_1(MessageQueueDelete, osStatus_t, osMessageQueueId_t)
  206. /// Create and Initialize a Message Queue object.
  207. /// \note API identical to osMessageQueueNew
  208. osMessageQueueId_t os_svcMessageQueueNew (uint32_t msg_count, uint32_t msg_size, const osMessageQueueAttr_t *attr) {
  209. os_message_queue_t *mq;
  210. void *mq_mem;
  211. uint32_t mq_size;
  212. uint32_t block_size;
  213. uint32_t size;
  214. uint8_t flags;
  215. const char *name;
  216. // Check parameters
  217. if ((msg_count == 0U) ||
  218. (msg_size == 0U)) {
  219. return (osMessageQueueId_t)NULL;
  220. }
  221. msg_size = (msg_size + 3U) & ~3UL;
  222. block_size = msg_size + sizeof(os_message_t);
  223. if ((__CLZ(msg_count) + __CLZ(block_size)) < 32) {
  224. return (osMessageQueueId_t)NULL;
  225. }
  226. size = msg_count * block_size;
  227. // Process attributes
  228. if (attr != NULL) {
  229. name = attr->name;
  230. mq = attr->cb_mem;
  231. mq_mem = attr->mq_mem;
  232. mq_size = attr->mq_size;
  233. if (mq != NULL) {
  234. if (((uint32_t)mq & 3U) || (attr->cb_size < sizeof(os_message_queue_t))) {
  235. return (osMessageQueueId_t)NULL;
  236. }
  237. } else {
  238. if (attr->cb_size != 0U) {
  239. return (osMessageQueueId_t)NULL;
  240. }
  241. }
  242. if (mq_mem != NULL) {
  243. if (((uint32_t)mq_mem & 3U) || (mq_size < size)) {
  244. return (osMessageQueueId_t)NULL;
  245. }
  246. } else {
  247. if (mq_size != 0U) {
  248. return (osMessageQueueId_t)NULL;
  249. }
  250. }
  251. } else {
  252. name = NULL;
  253. mq = NULL;
  254. mq_mem = NULL;
  255. }
  256. // Allocate object memory if not provided
  257. if (mq == NULL) {
  258. if (os_Info.mpi.message_queue != NULL) {
  259. mq = os_MemoryPoolAlloc(os_Info.mpi.message_queue);
  260. } else {
  261. mq = os_MemoryAlloc(os_Info.mem.cb, sizeof(os_message_queue_t));
  262. }
  263. if (mq == NULL) {
  264. return (osMessageQueueId_t)NULL;
  265. }
  266. flags = os_FlagSystemObject;
  267. } else {
  268. flags = 0U;
  269. }
  270. // Allocate data memory if not provided
  271. if (mq_mem == NULL) {
  272. mq_mem = os_MemoryAlloc(os_Info.mem.data, size);
  273. if (mq_mem == NULL) {
  274. if (flags & os_FlagSystemObject) {
  275. if (os_Info.mpi.message_queue != NULL) {
  276. os_MemoryPoolFree(os_Info.mpi.message_queue, mq);
  277. } else {
  278. os_MemoryFree(os_Info.mem.cb, mq);
  279. }
  280. }
  281. return (osMessageQueueId_t)NULL;
  282. }
  283. memset(mq_mem, 0, size);
  284. flags |= os_FlagSystemMemory;
  285. }
  286. // Initialize control block
  287. mq->id = os_IdMessageQueue;
  288. mq->state = os_ObjectActive;
  289. mq->flags = flags;
  290. mq->name = name;
  291. mq->thread_list = NULL;
  292. mq->msg_size = msg_size;
  293. mq->msg_count = 0U;
  294. mq->msg_first = NULL;
  295. mq->msg_last = NULL;
  296. os_MemoryPoolInit(&mq->mp_info, msg_count, block_size, mq_mem);
  297. // Register post ISR processing function
  298. os_Info.post_process.message_queue = os_MessageQueuePostProcess;
  299. return (osMessageQueueId_t)mq;
  300. }
  301. /// Put a Message into a Queue or timeout if Queue is full.
  302. /// \note API identical to osMessageQueuePut
  303. osStatus_t os_svcMessageQueuePut (osMessageQueueId_t mq_id, const void *msg_ptr, uint8_t msg_prio, uint32_t millisec) {
  304. os_message_queue_t *mq = (os_message_queue_t *)mq_id;
  305. os_message_t *msg;
  306. os_thread_t *thread;
  307. uint32_t *reg;
  308. // Check parameters
  309. if ((mq == NULL) ||
  310. (mq->id != os_IdMessageQueue)) {
  311. return osErrorParameter;
  312. }
  313. if (msg_ptr == NULL) {
  314. return osErrorParameter;
  315. }
  316. // Check object state
  317. if (mq->state == os_ObjectInactive) {
  318. return osErrorResource;
  319. }
  320. // Check if Thread is waiting to receive a Message
  321. if ((mq->thread_list != NULL) && (mq->thread_list->state == os_ThreadWaitingMessageGet)) {
  322. // Wakeup waiting Thread with highest Priority
  323. thread = os_ThreadListGet((os_object_t*)mq);
  324. os_ThreadWaitExit(thread, (uint32_t)osOK, true);
  325. // Copy Message (R1 = void *msg_ptr, R2 = *msg_prio)
  326. reg = os_ThreadRegPtr(thread);
  327. memcpy((void *)reg[1], msg_ptr, mq->msg_size);
  328. if (reg[2] != 0U) {
  329. *((uint8_t *)reg[2]) = msg_prio;
  330. }
  331. return osOK;
  332. }
  333. // Try to allocate memory
  334. msg = os_MemoryPoolAlloc(&mq->mp_info);
  335. if (msg != NULL) {
  336. // Copy Message
  337. memcpy((uint8_t *)msg + sizeof(os_message_t), msg_ptr, mq->msg_size);
  338. // Put Message into Queue
  339. msg->id = os_IdMessage;
  340. msg->state = os_ObjectActive;
  341. msg->flags = 0U;
  342. msg->priority = msg_prio;
  343. os_MessageQueuePut(mq, msg);
  344. } else {
  345. // No memory available
  346. if (millisec != 0U) {
  347. // Suspend current Thread
  348. os_ThreadListPut((os_object_t*)mq, os_ThreadGetRunning());
  349. os_ThreadWaitEnter(os_ThreadWaitingMessagePut, millisec);
  350. return osErrorTimeout;
  351. } else {
  352. return osErrorResource;
  353. }
  354. }
  355. return osOK;
  356. }
  357. /// Get a Message from a Queue or timeout if Queue is empty.
  358. /// \note API identical to osMessageQueueGet
  359. osStatus_t os_svcMessageQueueGet (osMessageQueueId_t mq_id, void *msg_ptr, uint8_t *msg_prio, uint32_t millisec) {
  360. os_message_queue_t *mq = (os_message_queue_t *)mq_id;
  361. os_message_t *msg;
  362. os_thread_t *thread;
  363. uint32_t *reg;
  364. // Check parameters
  365. if ((mq == NULL) ||
  366. (mq->id != os_IdMessageQueue)) {
  367. return osErrorParameter;
  368. }
  369. if (msg_ptr == NULL) {
  370. return osErrorParameter;
  371. }
  372. // Check object state
  373. if (mq->state == os_ObjectInactive) {
  374. return osErrorResource;
  375. }
  376. // Get Message from Queue
  377. msg = os_MessageQueueGet(mq);
  378. if (msg != NULL) {
  379. os_MessageQueueRemove(mq, msg);
  380. // Copy Message
  381. memcpy(msg_ptr, (uint8_t *)msg + sizeof(os_message_t), mq->msg_size);
  382. if (msg_prio != NULL) {
  383. *msg_prio = msg->priority;
  384. }
  385. // Free memory
  386. msg->state = os_ObjectInactive;
  387. os_MemoryPoolFree(&mq->mp_info, msg);
  388. } else {
  389. // No Message available
  390. if (millisec != 0U) {
  391. // Suspend current Thread
  392. os_ThreadListPut((os_object_t*)mq, os_ThreadGetRunning());
  393. os_ThreadWaitEnter(os_ThreadWaitingMessageGet, millisec);
  394. return osErrorTimeout;
  395. } else {
  396. return osErrorResource;
  397. }
  398. }
  399. // Check if Thread is waiting to send a Message
  400. if ((mq->thread_list != NULL) && (mq->thread_list->state == os_ThreadWaitingMessagePut)) {
  401. // Try to allocate memory
  402. msg = os_MemoryPoolAlloc(&mq->mp_info);
  403. if (msg != NULL) {
  404. // Wakeup waiting Thread with highest Priority
  405. thread = os_ThreadListGet((os_object_t*)mq);
  406. os_ThreadWaitExit(thread, (uint32_t)osOK, true);
  407. // Copy Message (R1 = const void *msg_ptr, R2 = msg_prio)
  408. reg = os_ThreadRegPtr(thread);
  409. memcpy((uint8_t *)msg + sizeof(os_message_t), (void *)reg[1], mq->msg_size);
  410. // Store Message into Queue
  411. msg->id = os_IdMessage;
  412. msg->state = os_ObjectActive;
  413. msg->flags = 0U;
  414. msg->priority = (uint8_t)reg[2];
  415. os_MessageQueuePut(mq, msg);
  416. }
  417. }
  418. return osOK;
  419. }
  420. /// Get maximum number of messages in a Message Queue.
  421. /// \note API identical to osMessageGetCapacity
  422. uint32_t os_svcMessageQueueGetCapacity (osMessageQueueId_t mq_id) {
  423. os_message_queue_t *mq = (os_message_queue_t *)mq_id;
  424. // Check parameters
  425. if ((mq == NULL) ||
  426. (mq->id != os_IdMessageQueue)) {
  427. return 0U;
  428. }
  429. // Check object state
  430. if (mq->state == os_ObjectInactive) {
  431. return 0U;
  432. }
  433. return mq->mp_info.max_blocks;
  434. }
  435. /// Get maximum message size in a Memory Pool.
  436. /// \note API identical to osMessageGetMsgSize
  437. uint32_t os_svcMessageQueueGetMsgSize (osMessageQueueId_t mq_id) {
  438. os_message_queue_t *mq = (os_message_queue_t *)mq_id;
  439. // Check parameters
  440. if ((mq == NULL) ||
  441. (mq->id != os_IdMessageQueue)) {
  442. return 0U;
  443. }
  444. // Check object state
  445. if (mq->state == os_ObjectInactive) {
  446. return 0U;
  447. }
  448. return mq->msg_size;
  449. }
  450. /// Get number of queued messages in a Message Queue.
  451. /// \note API identical to osMessageGetCount
  452. uint32_t os_svcMessageQueueGetCount (osMessageQueueId_t mq_id) {
  453. os_message_queue_t *mq = (os_message_queue_t *)mq_id;
  454. // Check parameters
  455. if ((mq == NULL) ||
  456. (mq->id != os_IdMessageQueue)) {
  457. return 0U;
  458. }
  459. // Check object state
  460. if (mq->state == os_ObjectInactive) {
  461. return 0U;
  462. }
  463. return mq->msg_count;
  464. }
  465. /// Get number of available slots for messages in a Message Queue.
  466. /// \note API identical to osMessageGetSpace
  467. uint32_t os_svcMessageQueueGetSpace (osMessageQueueId_t mq_id) {
  468. os_message_queue_t *mq = (os_message_queue_t *)mq_id;
  469. // Check parameters
  470. if ((mq == NULL) ||
  471. (mq->id != os_IdMessageQueue)) {
  472. return 0U;
  473. }
  474. // Check object state
  475. if (mq->state == os_ObjectInactive) {
  476. return 0U;
  477. }
  478. return (mq->mp_info.max_blocks - mq->msg_count);
  479. }
  480. /// Reset a Message Queue to initial empty state.
  481. /// \note API identical to osMessageQueueReset
  482. osStatus_t os_svcMessageQueueReset (osMessageQueueId_t mq_id) {
  483. os_message_queue_t *mq = (os_message_queue_t *)mq_id;
  484. os_message_t *msg;
  485. os_thread_t *thread;
  486. uint32_t *reg;
  487. // Check parameters
  488. if ((mq == NULL) ||
  489. (mq->id != os_IdMessageQueue)) {
  490. return osErrorParameter;
  491. }
  492. // Check object state
  493. if (mq->state == os_ObjectInactive) {
  494. return osErrorResource;
  495. }
  496. // Remove Messages from Queue
  497. for (;;) {
  498. // Get Message from Queue
  499. msg = os_MessageQueueGet(mq);
  500. if (msg == NULL) {
  501. break;
  502. }
  503. os_MessageQueueRemove(mq, msg);
  504. // Free memory
  505. msg->state = os_ObjectInactive;
  506. os_MemoryPoolFree(&mq->mp_info, msg);
  507. }
  508. // Check if Threads are waiting to send Messages
  509. if ((mq->thread_list != NULL) && (mq->thread_list->state == os_ThreadWaitingMessagePut)) {
  510. do {
  511. // Try to allocate memory
  512. msg = os_MemoryPoolAlloc(&mq->mp_info);
  513. if (msg != NULL) {
  514. // Wakeup waiting Thread with highest Priority
  515. thread = os_ThreadListGet((os_object_t*)mq);
  516. os_ThreadWaitExit(thread, (uint32_t)osOK, false);
  517. // Copy Message (R1 = const void *msg_ptr, R2 = msg_prio)
  518. reg = os_ThreadRegPtr(thread);
  519. memcpy((uint8_t *)msg + sizeof(os_message_t), (void *)reg[1], mq->msg_size);
  520. // Store Message into Queue
  521. msg->id = os_IdMessage;
  522. msg->state = os_ObjectActive;
  523. msg->flags = 0U;
  524. msg->priority = (uint8_t)reg[2];
  525. os_MessageQueuePut(mq, msg);
  526. }
  527. } while ((msg != NULL) && (mq->thread_list != NULL));
  528. os_ThreadDispatch(NULL);
  529. }
  530. return osOK;
  531. }
  532. /// Delete a Message Queue object.
  533. /// \note API identical to osMessageQueueDelete
  534. osStatus_t os_svcMessageQueueDelete (osMessageQueueId_t mq_id) {
  535. os_message_queue_t *mq = (os_message_queue_t *)mq_id;
  536. os_thread_t *thread;
  537. // Check parameters
  538. if ((mq == NULL) ||
  539. (mq->id != os_IdMessageQueue)) {
  540. return osErrorParameter;
  541. }
  542. // Check object state
  543. if (mq->state == os_ObjectInactive) {
  544. return osErrorResource;
  545. }
  546. // Mark object as inactive
  547. mq->state = os_ObjectInactive;
  548. // Unblock waiting threads
  549. if (mq->thread_list != NULL) {
  550. do {
  551. thread = os_ThreadListGet((os_object_t*)mq);
  552. os_ThreadWaitExit(thread, (uint32_t)osErrorResource, false);
  553. } while (mq->thread_list != NULL);
  554. os_ThreadDispatch(NULL);
  555. }
  556. // Free data memory
  557. if (mq->flags & os_FlagSystemMemory) {
  558. os_MemoryFree(os_Info.mem.data, mq->mp_info.block_base);
  559. }
  560. // Free object memory
  561. if (mq->flags & os_FlagSystemObject) {
  562. if (os_Info.mpi.message_queue != NULL) {
  563. os_MemoryPoolFree(os_Info.mpi.message_queue, mq);
  564. } else {
  565. os_MemoryFree(os_Info.mem.cb, mq);
  566. }
  567. }
  568. return osOK;
  569. }
  570. // ==== ISR Calls ====
  571. /// Put a Message into a Queue or timeout if Queue is full.
  572. /// \note API identical to osMessageQueuePut
  573. __STATIC_INLINE
  574. osStatus_t os_isrMessageQueuePut (osMessageQueueId_t mq_id, const void *msg_ptr, uint8_t msg_prio, uint32_t millisec) {
  575. os_message_queue_t *mq = (os_message_queue_t *)mq_id;
  576. os_message_t *msg;
  577. void **ptr;
  578. // Check parameters
  579. if ((mq == NULL) ||
  580. (mq->id != os_IdMessageQueue)) {
  581. return osErrorParameter;
  582. }
  583. if (msg_ptr == NULL) {
  584. return osErrorParameter;
  585. }
  586. if (millisec != 0U) {
  587. return osErrorParameter;
  588. }
  589. // Check object state
  590. if (mq->state == os_ObjectInactive) {
  591. return osErrorResource;
  592. }
  593. // Try to allocate memory
  594. msg = os_MemoryPoolAlloc(&mq->mp_info);
  595. if (msg != NULL) {
  596. // Copy Message
  597. memcpy((uint8_t *)msg + sizeof(os_message_t), msg_ptr, mq->msg_size);
  598. msg->id = os_IdMessage;
  599. msg->state = os_ObjectActive;
  600. msg->flags = 0U;
  601. msg->priority = msg_prio;
  602. // Register post ISR processing
  603. ptr = (void *)((uint8_t *)msg + sizeof(os_message_t) - sizeof(os_message_queue_t *));
  604. *ptr = mq;
  605. os_PostProcess((os_object_t *)msg);
  606. } else {
  607. // No memory available
  608. return osErrorResource;
  609. }
  610. return osOK;
  611. }
  612. /// Get a Message from a Queue or timeout if Queue is empty.
  613. /// \note API identical to osMessageQueueGet
  614. __STATIC_INLINE
  615. osStatus_t os_isrMessageQueueGet (osMessageQueueId_t mq_id, void *msg_ptr, uint8_t *msg_prio, uint32_t millisec) {
  616. os_message_queue_t *mq = (os_message_queue_t *)mq_id;
  617. os_message_t *msg;
  618. void **ptr;
  619. // Check parameters
  620. if ((mq == NULL) ||
  621. (mq->id != os_IdMessageQueue)) {
  622. return osErrorParameter;
  623. }
  624. if (msg_ptr == NULL) {
  625. return osErrorParameter;
  626. }
  627. if (millisec != 0U) {
  628. return osErrorParameter;
  629. }
  630. // Check object state
  631. if (mq->state == os_ObjectInactive) {
  632. return osErrorResource;
  633. }
  634. // Get Message from Queue
  635. msg = os_MessageQueueGet(mq);
  636. if (msg != NULL) {
  637. // Copy Message
  638. memcpy(msg_ptr, (uint8_t *)msg + sizeof(os_message_t), mq->msg_size);
  639. if (msg_prio != NULL) {
  640. *msg_prio = msg->priority;
  641. }
  642. // Register post ISR processing
  643. ptr = (void *)((uint8_t *)msg + sizeof(os_message_t));
  644. *ptr = mq;
  645. os_PostProcess((os_object_t *)msg);
  646. } else {
  647. // No Message available
  648. return osErrorResource;
  649. }
  650. return osOK;
  651. }
  652. // ==== Public API ====
  653. /// Create and Initialize a Message Queue object.
  654. osMessageQueueId_t osMessageQueueNew (uint32_t msg_count, uint32_t msg_size, const osMessageQueueAttr_t *attr) {
  655. if (__get_IPSR() != 0U) {
  656. return (osMessageQueueId_t)NULL; // Not allowed in ISR
  657. }
  658. if ((os_KernelGetState() == os_KernelReady) && ((__get_CONTROL() & 1U) == 0U)) {
  659. // Kernel Ready (not running) and in Privileged mode
  660. return os_svcMessageQueueNew(msg_count, msg_size, attr);
  661. } else {
  662. return __svcMessageQueueNew(msg_count, msg_size, attr);
  663. }
  664. }
  665. /// Put a Message into a Queue or timeout if Queue is full.
  666. osStatus_t osMessageQueuePut (osMessageQueueId_t mq_id, const void *msg_ptr, uint8_t msg_prio, uint32_t millisec) {
  667. if (__get_IPSR() != 0U) { // in ISR
  668. return os_isrMessageQueuePut(mq_id, msg_ptr, msg_prio, millisec);
  669. } else { // in Thread
  670. return __svcMessageQueuePut(mq_id, msg_ptr, msg_prio, millisec);
  671. }
  672. }
  673. /// Get a Message from a Queue or timeout if Queue is empty.
  674. osStatus_t osMessageQueueGet (osMessageQueueId_t mq_id, void *msg_ptr, uint8_t *msg_prio, uint32_t millisec) {
  675. if (__get_IPSR() != 0U) { // in ISR
  676. return os_isrMessageQueueGet(mq_id, msg_ptr, msg_prio, millisec);
  677. } else { // in Thread
  678. return __svcMessageQueueGet(mq_id, msg_ptr, msg_prio, millisec);
  679. }
  680. }
  681. /// Get maximum number of messages in a Message Queue.
  682. uint32_t osMessageQueueGetCapacity (osMessageQueueId_t mq_id) {
  683. if (__get_IPSR() != 0U) { // in ISR
  684. return os_svcMessageQueueGetCapacity(mq_id);
  685. } else { // in Thread
  686. return __svcMessageQueueGetCapacity(mq_id);
  687. }
  688. }
  689. /// Get maximum message size in a Memory Pool.
  690. uint32_t osMessageQueueGetMsgSize (osMessageQueueId_t mq_id) {
  691. if (__get_IPSR() != 0U) { // in ISR
  692. return os_svcMessageQueueGetMsgSize(mq_id);
  693. } else { // in Thread
  694. return __svcMessageQueueGetMsgSize(mq_id);
  695. }
  696. }
  697. /// Get number of queued messages in a Message Queue.
  698. uint32_t osMessageQueueGetCount (osMessageQueueId_t mq_id) {
  699. if (__get_IPSR() != 0U) { // in ISR
  700. return os_svcMessageQueueGetCount(mq_id);
  701. } else { // in Thread
  702. return __svcMessageQueueGetCount(mq_id);
  703. }
  704. }
  705. /// Get number of available slots for messages in a Message Queue.
  706. uint32_t osMessageQueueGetSpace (osMessageQueueId_t mq_id) {
  707. if (__get_IPSR() != 0U) { // in ISR
  708. return os_svcMessageQueueGetSpace(mq_id);
  709. } else { // in Thread
  710. return __svcMessageQueueGetSpace(mq_id);
  711. }
  712. }
  713. /// Reset a Message Queue to initial empty state.
  714. osStatus_t osMessageQueueReset (osMessageQueueId_t mq_id) {
  715. if (__get_IPSR() != 0U) {
  716. return osErrorISR; // Not allowed in ISR
  717. }
  718. return __svcMessageQueueReset(mq_id);
  719. }
  720. /// Delete a Message Queue object.
  721. osStatus_t osMessageQueueDelete (osMessageQueueId_t mq_id) {
  722. if (__get_IPSR() != 0U) {
  723. return osErrorISR; // Not allowed in ISR
  724. }
  725. return __svcMessageQueueDelete(mq_id);
  726. }