Doubea Pierre / Mbed 2 deprecated HW3

Lab Checkoff

Dependencies:   SDFileSystem TextLCD mbed-rtos mbed wave_player FATFileSystem

mbed-rtos/rtos/Mail.h@0:67dbd54e60d4, 2013-11-13 (annotated)

Committer:
doubster
Date:
Wed Nov 13 20:00:28 2013 +0000
Revision:
0:67dbd54e60d4
Lab Checkoff

Who changed what in which revision?

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