Pierre-Alexandre Geraert
Mail.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 MAIL_H |
| PA | 0:7ae810ca8a42 | 3 | #define MAIL_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 | |
| PA | 0:7ae810ca8a42 | 10 | namespace rtos { |
| PA | 0:7ae810ca8a42 | 11 | |
| PA | 0:7ae810ca8a42 | 12 | /*! The Mail class allow to control, send, receive, or wait for mail. |
| PA | 0:7ae810ca8a42 | 13 | A mail is a memory block that is send to a thread or interrupt service routine. |
| PA | 0:7ae810ca8a42 | 14 | \tparam T data type of a single message element. |
| PA | 0:7ae810ca8a42 | 15 | \tparam queue_sz maximum number of messages in queue. |
| PA | 0:7ae810ca8a42 | 16 | */ |
| PA | 0:7ae810ca8a42 | 17 | template<typename T, uint32_t queue_sz> |
| PA | 0:7ae810ca8a42 | 18 | class Mail { |
| PA | 0:7ae810ca8a42 | 19 | public: |
| PA | 0:7ae810ca8a42 | 20 | /*! Create and Initialise Mail queue. */ |
| PA | 0:7ae810ca8a42 | 21 | Mail() { |
| PA | 0:7ae810ca8a42 | 22 | #ifdef CMSIS_OS_RTX |
| PA | 0:7ae810ca8a42 | 23 | memset(_mail_q, 0, sizeof(_mail_q)); |
| PA | 0:7ae810ca8a42 | 24 | _mail_p[0] = _mail_q; |
| PA | 0:7ae810ca8a42 | 25 | |
| PA | 0:7ae810ca8a42 | 26 | memset(_mail_m, 0, sizeof(_mail_m)); |
| PA | 0:7ae810ca8a42 | 27 | _mail_p[1] = _mail_m; |
| PA | 0:7ae810ca8a42 | 28 | |
| PA | 0:7ae810ca8a42 | 29 | _mail_def.pool = _mail_p; |
| PA | 0:7ae810ca8a42 | 30 | _mail_def.queue_sz = queue_sz; |
| PA | 0:7ae810ca8a42 | 31 | _mail_def.item_sz = sizeof(T); |
| PA | 0:7ae810ca8a42 | 32 | #endif |
| PA | 0:7ae810ca8a42 | 33 | _mail_id = osMailCreate(&_mail_def, NULL); |
| PA | 0:7ae810ca8a42 | 34 | } |
| PA | 0:7ae810ca8a42 | 35 | |
| PA | 0:7ae810ca8a42 | 36 | /*! Allocate a memory block of type T |
| PA | 0:7ae810ca8a42 | 37 | \param millisec timeout value or 0 in case of no time-out. (default: 0). |
| PA | 0:7ae810ca8a42 | 38 | \return pointer to memory block that can be filled with mail or NULL in case error. |
| PA | 0:7ae810ca8a42 | 39 | */ |
| PA | 0:7ae810ca8a42 | 40 | T* alloc(uint32_t millisec=0) { |
| PA | 0:7ae810ca8a42 | 41 | return (T*)osMailAlloc(_mail_id, millisec); |
| PA | 0:7ae810ca8a42 | 42 | } |
| PA | 0:7ae810ca8a42 | 43 | |
| PA | 0:7ae810ca8a42 | 44 | /*! Allocate a memory block of type T and set memory block to zero. |
| PA | 0:7ae810ca8a42 | 45 | \param millisec timeout value or 0 in case of no time-out. (default: 0). |
| PA | 0:7ae810ca8a42 | 46 | \return pointer to memory block that can be filled with mail or NULL in case error. |
| PA | 0:7ae810ca8a42 | 47 | */ |
| PA | 0:7ae810ca8a42 | 48 | T* calloc(uint32_t millisec=0) { |
| PA | 0:7ae810ca8a42 | 49 | return (T*)osMailCAlloc(_mail_id, millisec); |
| PA | 0:7ae810ca8a42 | 50 | } |
| PA | 0:7ae810ca8a42 | 51 | |
| PA | 0:7ae810ca8a42 | 52 | /*! Put a mail in the queue. |
| PA | 0:7ae810ca8a42 | 53 | \param mptr memory block previously allocated with Mail::alloc or Mail::calloc. |
| PA | 0:7ae810ca8a42 | 54 | \return status code that indicates the execution status of the function. |
| PA | 0:7ae810ca8a42 | 55 | */ |
| PA | 0:7ae810ca8a42 | 56 | osStatus put(T *mptr) { |
| PA | 0:7ae810ca8a42 | 57 | return osMailPut(_mail_id, (void*)mptr); |
| PA | 0:7ae810ca8a42 | 58 | } |
| PA | 0:7ae810ca8a42 | 59 | |
| PA | 0:7ae810ca8a42 | 60 | /*! Get a mail from a queue. |
| PA | 0:7ae810ca8a42 | 61 | \param millisec timeout value or 0 in case of no time-out. (default: osWaitForever). |
| PA | 0:7ae810ca8a42 | 62 | \return event that contains mail information or error code. |
| PA | 0:7ae810ca8a42 | 63 | */ |
| PA | 0:7ae810ca8a42 | 64 | osEvent get(uint32_t millisec=osWaitForever) { |
| PA | 0:7ae810ca8a42 | 65 | return osMailGet(_mail_id, millisec); |
| PA | 0:7ae810ca8a42 | 66 | } |
| PA | 0:7ae810ca8a42 | 67 | |
| PA | 0:7ae810ca8a42 | 68 | /*! Free a memory block from a mail. |
| PA | 0:7ae810ca8a42 | 69 | \param mptr pointer to the memory block that was obtained with Mail::get. |
| PA | 0:7ae810ca8a42 | 70 | \return status code that indicates the execution status of the function. |
| PA | 0:7ae810ca8a42 | 71 | */ |
| PA | 0:7ae810ca8a42 | 72 | osStatus free(T *mptr) { |
| PA | 0:7ae810ca8a42 | 73 | return osMailFree(_mail_id, (void*)mptr); |
| PA | 0:7ae810ca8a42 | 74 | } |
| PA | 0:7ae810ca8a42 | 75 | |
| PA | 0:7ae810ca8a42 | 76 | private: |
| PA | 0:7ae810ca8a42 | 77 | osMailQId _mail_id; |
| PA | 0:7ae810ca8a42 | 78 | osMailQDef_t _mail_def; |
| PA | 0:7ae810ca8a42 | 79 | #ifdef CMSIS_OS_RTX |
| PA | 0:7ae810ca8a42 | 80 | uint32_t _mail_q[4+(queue_sz)]; |
| PA | 0:7ae810ca8a42 | 81 | uint32_t _mail_m[3+((sizeof(T)+3)/4)*(queue_sz)]; |
| PA | 0:7ae810ca8a42 | 82 | void *_mail_p[2]; |
| PA | 0:7ae810ca8a42 | 83 | #endif |
| PA | 0:7ae810ca8a42 | 84 | }; |
| PA | 0:7ae810ca8a42 | 85 | |
| PA | 0:7ae810ca8a42 | 86 | } |
| PA | 0:7ae810ca8a42 | 87 | |
| PA | 0:7ae810ca8a42 | 88 | #endif |
| PA | 0:7ae810ca8a42 | 89 |