Stanislav Silnitskiy / rtos

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Mail.h@0:ea15e955433d, 2012-06-24 (annotated)

Committer:
mailgate_user
Date:
Sun Jun 24 19:47:00 2012 +0000
Revision:
0:ea15e955433d
N threads cut down to 4, stack size cut down to 1024

Who changed what in which revision?

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