TeamGyro / mbed-rtos

OS2

Dependents:   GYRO_MPU6050 Bluetooth_Powered_Multimeter_Using_STM32F429_and_RTOS fyp

rtos/Mail.h@0:a7c449cd2d5a, 2020-02-03 (annotated)

Committer:
guilhemMBED
Date:
Mon Feb 03 13:41:14 2020 +0000
Revision:
0:a7c449cd2d5a
previous version;

Who changed what in which revision?

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