Donatien Garnier / rtos_net

RTOS configured for use with Networking libraries

Dependents:   EthernetHTTPClientTest

Mail.h@0:07f30e7c9897, 2012-05-24 (annotated)

Committer:
donatien
Date:
Thu May 24 08:56:51 2012 +0000
Revision:
0:07f30e7c9897
[mbed] converted /VodafoneK3770Lib/rtos

Who changed what in which revision?

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