SkyTEM BMAG / Mbed 2 deprecated BMAGThrRev

Bmag incl gps rettelse

Dependencies:   mbed WDT MODSERIAL BME280

USBHost/mbed-rtos/rtos/Mail.h@64:06b9b8ffd5a6, 2019-07-09 (annotated)

Committer:
gert_lauritsen
Date:
Tue Jul 09 09:54:41 2019 +0000
Branch:
MbedBMAGThrRev
Revision:
64:06b9b8ffd5a6
Parent:
61:52a6d0ffd8e5 
dataline version to 4 and fw til 1.0.0.7

Who changed what in which revision?

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