Pierre-Alexandre Geraert
Queue.h@0:7ae810ca8a42, 2012-06-21 (annotated)
- Committer:
- PA
- Date:
- Thu Jun 21 14:04:44 2012 +0000
- Revision:
- 0:7ae810ca8a42
Who changed what in which revision?
| User | Revision | Line number | New contents of line |
|---|---|---|---|
| PA | 0:7ae810ca8a42 | 1 | /* Copyright (c) 2012 mbed.org */ |
| PA | 0:7ae810ca8a42 | 2 | #ifndef QUEUE_H |
| PA | 0:7ae810ca8a42 | 3 | #define QUEUE_H |
| PA | 0:7ae810ca8a42 | 4 | |
| PA | 0:7ae810ca8a42 | 5 | #include <stdint.h> |
| PA | 0:7ae810ca8a42 | 6 | #include <string.h> |
| PA | 0:7ae810ca8a42 | 7 | |
| PA | 0:7ae810ca8a42 | 8 | #include "cmsis_os.h" |
| PA | 0:7ae810ca8a42 | 9 | #include "error.h" |
| PA | 0:7ae810ca8a42 | 10 | |
| PA | 0:7ae810ca8a42 | 11 | namespace rtos { |
| PA | 0:7ae810ca8a42 | 12 | |
| PA | 0:7ae810ca8a42 | 13 | /*! The Queue class allow to control, send, receive, or wait for messages. |
| PA | 0:7ae810ca8a42 | 14 | A message can be a integer or pointer value to a certain type T that is send |
| PA | 0:7ae810ca8a42 | 15 | to a thread or interrupt service routine. |
| PA | 0:7ae810ca8a42 | 16 | \tparam T data type of a single message element. |
| PA | 0:7ae810ca8a42 | 17 | \tparam queue_sz maximum number of messages in queue. |
| PA | 0:7ae810ca8a42 | 18 | */ |
| PA | 0:7ae810ca8a42 | 19 | template<typename T, uint32_t queue_sz> |
| PA | 0:7ae810ca8a42 | 20 | class Queue { |
| PA | 0:7ae810ca8a42 | 21 | public: |
| PA | 0:7ae810ca8a42 | 22 | /*! Create and initialise a message Queue. */ |
| PA | 0:7ae810ca8a42 | 23 | Queue() { |
| PA | 0:7ae810ca8a42 | 24 | #ifdef CMSIS_OS_RTX |
| PA | 0:7ae810ca8a42 | 25 | memset(_queue_q, 0, sizeof(_queue_q)); |
| PA | 0:7ae810ca8a42 | 26 | _queue_def.pool = _queue_q; |
| PA | 0:7ae810ca8a42 | 27 | _queue_def.queue_sz = queue_sz; |
| PA | 0:7ae810ca8a42 | 28 | #endif |
| PA | 0:7ae810ca8a42 | 29 | _queue_id = osMessageCreate(&_queue_def, NULL); |
| PA | 0:7ae810ca8a42 | 30 | if (_queue_id == NULL) { |
| PA | 0:7ae810ca8a42 | 31 | error("Error initialising the queue object\n"); |
| PA | 0:7ae810ca8a42 | 32 | } |
| PA | 0:7ae810ca8a42 | 33 | } |
| PA | 0:7ae810ca8a42 | 34 | |
| PA | 0:7ae810ca8a42 | 35 | /*! Put a message in a Queue. |
| PA | 0:7ae810ca8a42 | 36 | \param data message pointer. |
| PA | 0:7ae810ca8a42 | 37 | \param millisec timeout value or 0 in case of no time-out. (default: 0) |
| PA | 0:7ae810ca8a42 | 38 | \return status code that indicates the execution status of the function. |
| PA | 0:7ae810ca8a42 | 39 | */ |
| PA | 0:7ae810ca8a42 | 40 | osStatus put(T* data, uint32_t millisec=0) { |
| PA | 0:7ae810ca8a42 | 41 | return osMessagePut(_queue_id, (uint32_t)data, millisec); |
| PA | 0:7ae810ca8a42 | 42 | } |
| PA | 0:7ae810ca8a42 | 43 | |
| PA | 0:7ae810ca8a42 | 44 | /*! Get a message or Wait for a message from a Queue. |
| PA | 0:7ae810ca8a42 | 45 | \param millisec timeout value or 0 in case of no time-out. (default: osWaitForever). |
| PA | 0:7ae810ca8a42 | 46 | \return event information that includes the message and the status code. |
| PA | 0:7ae810ca8a42 | 47 | */ |
| PA | 0:7ae810ca8a42 | 48 | osEvent get(uint32_t millisec=osWaitForever) { |
| PA | 0:7ae810ca8a42 | 49 | return osMessageGet(_queue_id, millisec); |
| PA | 0:7ae810ca8a42 | 50 | } |
| PA | 0:7ae810ca8a42 | 51 | |
| PA | 0:7ae810ca8a42 | 52 | private: |
| PA | 0:7ae810ca8a42 | 53 | osMessageQId _queue_id; |
| PA | 0:7ae810ca8a42 | 54 | osMessageQDef_t _queue_def; |
| PA | 0:7ae810ca8a42 | 55 | #ifdef CMSIS_OS_RTX |
| PA | 0:7ae810ca8a42 | 56 | uint32_t _queue_q[4+(queue_sz)]; |
| PA | 0:7ae810ca8a42 | 57 | #endif |
| PA | 0:7ae810ca8a42 | 58 | }; |
| PA | 0:7ae810ca8a42 | 59 | |
| PA | 0:7ae810ca8a42 | 60 | } |
| PA | 0:7ae810ca8a42 | 61 | #endif |