Greg Steiert / pegasus_dev

Development mbed library for MAX32630FTHR

Dependents:   blinky_max32630fthr

rtos/Mail.h@3:1198227e6421, 2016-12-16 (annotated)

Committer:
switches
Date:
Fri Dec 16 16:27:57 2016 +0000
Revision:
3:1198227e6421
Parent:
0:5c4d7b2438d3 
Changed ADC scale for MAX32625 platforms to 1.2V full scale to match MAX32630 platforms

Who changed what in which revision?

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