Freeman Oldman / NUCLEO_STM32F401RE_CC3000_ILI9341

The code from https://github.com/vpcola/Nucleo

mbed-rtos/rtos/Mail.h@0:5464d5e415e5, 2014-10-08 (annotated)

Committer:
sinrab
Date:
Wed Oct 08 11:00:24 2014 +0000
Revision:
0:5464d5e415e5
The code from https://github.com/vpcola/Nucleo

Who changed what in which revision?

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