Dylan Saada / Mbed 2 deprecated telemetre2

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

USBHost/mbed-rtos/rtos/Mail.h@0:6ce9c65992e5, 2015-04-15 (annotated)

Committer:
dylancachan
Date:
Wed Apr 15 06:23:18 2015 +0000
Revision:
0:6ce9c65992e5
telemetre

Who changed what in which revision?

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