Alan Ffrench / Mbed 2 deprecated Experiment_2_5

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.

Dependencies:   mbed

mbed-rtos/rtos/Mail.h@0:52468b19aa21, 2020-07-29 (annotated)

Committer:
alanffrench
Date:
Wed Jul 29 18:51:38 2020 +0000
Revision:
0:52468b19aa21
Threads

Who changed what in which revision?

UserRevisionLine numberNew contents of line
alanffrench 0:52468b19aa21 1 /* mbed Microcontroller Library
alanffrench 0:52468b19aa21 2 * Copyright (c) 2006-2012 ARM Limited
alanffrench 0:52468b19aa21 3 *
alanffrench 0:52468b19aa21 4 * Permission is hereby granted, free of charge, to any person obtaining a copy
alanffrench 0:52468b19aa21 5 * of this software and associated documentation files (the "Software"), to deal
alanffrench 0:52468b19aa21 6 * in the Software without restriction, including without limitation the rights
alanffrench 0:52468b19aa21 7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
alanffrench 0:52468b19aa21 8 * copies of the Software, and to permit persons to whom the Software is
alanffrench 0:52468b19aa21 9 * furnished to do so, subject to the following conditions:
alanffrench 0:52468b19aa21 10 *
alanffrench 0:52468b19aa21 11 * The above copyright notice and this permission notice shall be included in
alanffrench 0:52468b19aa21 12 * all copies or substantial portions of the Software.
alanffrench 0:52468b19aa21 13 *
alanffrench 0:52468b19aa21 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
alanffrench 0:52468b19aa21 15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
alanffrench 0:52468b19aa21 16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
alanffrench 0:52468b19aa21 17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
alanffrench 0:52468b19aa21 18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
alanffrench 0:52468b19aa21 19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
alanffrench 0:52468b19aa21 20 * SOFTWARE.
alanffrench 0:52468b19aa21 21 */
alanffrench 0:52468b19aa21 22 #ifndef MAIL_H
alanffrench 0:52468b19aa21 23 #define MAIL_H
alanffrench 0:52468b19aa21 24
alanffrench 0:52468b19aa21 25 #include <stdint.h>
alanffrench 0:52468b19aa21 26 #include <string.h>
alanffrench 0:52468b19aa21 27
alanffrench 0:52468b19aa21 28 #include "cmsis_os.h"
alanffrench 0:52468b19aa21 29
alanffrench 0:52468b19aa21 30 namespace rtos {
alanffrench 0:52468b19aa21 31
alanffrench 0:52468b19aa21 32 /** The Mail class allow to control, send, receive, or wait for mail.
alanffrench 0:52468b19aa21 33 A mail is a memory block that is send to a thread or interrupt service routine.
alanffrench 0:52468b19aa21 34 @tparam T data type of a single message element.
alanffrench 0:52468b19aa21 35 @tparam queue_sz maximum number of messages in queue.
alanffrench 0:52468b19aa21 36 */
alanffrench 0:52468b19aa21 37 template<typename T, uint32_t queue_sz>
alanffrench 0:52468b19aa21 38 class Mail {
alanffrench 0:52468b19aa21 39 public:
alanffrench 0:52468b19aa21 40 /** Create and Initialise Mail queue. */
alanffrench 0:52468b19aa21 41 Mail() {
alanffrench 0:52468b19aa21 42 #ifdef CMSIS_OS_RTX
alanffrench 0:52468b19aa21 43 memset(_mail_q, 0, sizeof(_mail_q));
alanffrench 0:52468b19aa21 44 _mail_p[0] = _mail_q;
alanffrench 0:52468b19aa21 45
alanffrench 0:52468b19aa21 46 memset(_mail_m, 0, sizeof(_mail_m));
alanffrench 0:52468b19aa21 47 _mail_p[1] = _mail_m;
alanffrench 0:52468b19aa21 48
alanffrench 0:52468b19aa21 49 _mail_def.pool = _mail_p;
alanffrench 0:52468b19aa21 50 _mail_def.queue_sz = queue_sz;
alanffrench 0:52468b19aa21 51 _mail_def.item_sz = sizeof(T);
alanffrench 0:52468b19aa21 52 #endif
alanffrench 0:52468b19aa21 53 _mail_id = osMailCreate(&_mail_def, NULL);
alanffrench 0:52468b19aa21 54 }
alanffrench 0:52468b19aa21 55
alanffrench 0:52468b19aa21 56 /** Allocate a memory block of type T
alanffrench 0:52468b19aa21 57 @param millisec timeout value or 0 in case of no time-out. (default: 0).
alanffrench 0:52468b19aa21 58 @return pointer to memory block that can be filled with mail or NULL in case error.
alanffrench 0:52468b19aa21 59 */
alanffrench 0:52468b19aa21 60 T* alloc(uint32_t millisec=0) {
alanffrench 0:52468b19aa21 61 return (T*)osMailAlloc(_mail_id, millisec);
alanffrench 0:52468b19aa21 62 }
alanffrench 0:52468b19aa21 63
alanffrench 0:52468b19aa21 64 /** Allocate a memory block of type T and set memory block to zero.
alanffrench 0:52468b19aa21 65 @param millisec timeout value or 0 in case of no time-out. (default: 0).
alanffrench 0:52468b19aa21 66 @return pointer to memory block that can be filled with mail or NULL in case error.
alanffrench 0:52468b19aa21 67 */
alanffrench 0:52468b19aa21 68 T* calloc(uint32_t millisec=0) {
alanffrench 0:52468b19aa21 69 return (T*)osMailCAlloc(_mail_id, millisec);
alanffrench 0:52468b19aa21 70 }
alanffrench 0:52468b19aa21 71
alanffrench 0:52468b19aa21 72 /** Put a mail in the queue.
alanffrench 0:52468b19aa21 73 @param mptr memory block previously allocated with Mail::alloc or Mail::calloc.
alanffrench 0:52468b19aa21 74 @return status code that indicates the execution status of the function.
alanffrench 0:52468b19aa21 75 */
alanffrench 0:52468b19aa21 76 osStatus put(T *mptr) {
alanffrench 0:52468b19aa21 77 return osMailPut(_mail_id, (void*)mptr);
alanffrench 0:52468b19aa21 78 }
alanffrench 0:52468b19aa21 79
alanffrench 0:52468b19aa21 80 /** Get a mail from a queue.
alanffrench 0:52468b19aa21 81 @param millisec timeout value or 0 in case of no time-out. (default: osWaitForever).
alanffrench 0:52468b19aa21 82 @return event that contains mail information or error code.
alanffrench 0:52468b19aa21 83 */
alanffrench 0:52468b19aa21 84 osEvent get(uint32_t millisec=osWaitForever) {
alanffrench 0:52468b19aa21 85 return osMailGet(_mail_id, millisec);
alanffrench 0:52468b19aa21 86 }
alanffrench 0:52468b19aa21 87
alanffrench 0:52468b19aa21 88 /** Free a memory block from a mail.
alanffrench 0:52468b19aa21 89 @param mptr pointer to the memory block that was obtained with Mail::get.
alanffrench 0:52468b19aa21 90 @return status code that indicates the execution status of the function.
alanffrench 0:52468b19aa21 91 */
alanffrench 0:52468b19aa21 92 osStatus free(T *mptr) {
alanffrench 0:52468b19aa21 93 return osMailFree(_mail_id, (void*)mptr);
alanffrench 0:52468b19aa21 94 }
alanffrench 0:52468b19aa21 95
alanffrench 0:52468b19aa21 96 private:
alanffrench 0:52468b19aa21 97 osMailQId _mail_id;
alanffrench 0:52468b19aa21 98 osMailQDef_t _mail_def;
alanffrench 0:52468b19aa21 99 #ifdef CMSIS_OS_RTX
alanffrench 0:52468b19aa21 100 uint32_t _mail_q[4+(queue_sz)];
alanffrench 0:52468b19aa21 101 uint32_t _mail_m[3+((sizeof(T)+3)/4)*(queue_sz)];
alanffrench 0:52468b19aa21 102 void *_mail_p[2];
alanffrench 0:52468b19aa21 103 #endif
alanffrench 0:52468b19aa21 104 };
alanffrench 0:52468b19aa21 105
alanffrench 0:52468b19aa21 106 }
alanffrench 0:52468b19aa21 107
alanffrench 0:52468b19aa21 108 #endif
alanffrench 0:52468b19aa21 109