Denislam Valeev / Mbed OS Nucleo_rtos_basic

1

mbed-os/rtos/Mail.h@0:e056ac8fecf8, 2018-03-13 (annotated)

Committer:
valeyev
Date:
Tue Mar 13 07:17:50 2018 +0000
Revision:
0:e056ac8fecf8
looking for...

Who changed what in which revision?

UserRevisionLine numberNew contents of line
valeyev 0:e056ac8fecf8 1 /* mbed Microcontroller Library
valeyev 0:e056ac8fecf8 2 * Copyright (c) 2006-2017 ARM Limited
valeyev 0:e056ac8fecf8 3 *
valeyev 0:e056ac8fecf8 4 * Permission is hereby granted, free of charge, to any person obtaining a copy
valeyev 0:e056ac8fecf8 5 * of this software and associated documentation files (the "Software"), to deal
valeyev 0:e056ac8fecf8 6 * in the Software without restriction, including without limitation the rights
valeyev 0:e056ac8fecf8 7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
valeyev 0:e056ac8fecf8 8 * copies of the Software, and to permit persons to whom the Software is
valeyev 0:e056ac8fecf8 9 * furnished to do so, subject to the following conditions:
valeyev 0:e056ac8fecf8 10 *
valeyev 0:e056ac8fecf8 11 * The above copyright notice and this permission notice shall be included in
valeyev 0:e056ac8fecf8 12 * all copies or substantial portions of the Software.
valeyev 0:e056ac8fecf8 13 *
valeyev 0:e056ac8fecf8 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
valeyev 0:e056ac8fecf8 15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
valeyev 0:e056ac8fecf8 16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
valeyev 0:e056ac8fecf8 17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
valeyev 0:e056ac8fecf8 18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
valeyev 0:e056ac8fecf8 19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
valeyev 0:e056ac8fecf8 20 * SOFTWARE.
valeyev 0:e056ac8fecf8 21 */
valeyev 0:e056ac8fecf8 22 #ifndef MAIL_H
valeyev 0:e056ac8fecf8 23 #define MAIL_H
valeyev 0:e056ac8fecf8 24
valeyev 0:e056ac8fecf8 25 #include <stdint.h>
valeyev 0:e056ac8fecf8 26 #include <string.h>
valeyev 0:e056ac8fecf8 27
valeyev 0:e056ac8fecf8 28 #include "Queue.h"
valeyev 0:e056ac8fecf8 29 #include "MemoryPool.h"
valeyev 0:e056ac8fecf8 30 #include "cmsis_os2.h"
valeyev 0:e056ac8fecf8 31 #include "mbed_rtos_storage.h"
valeyev 0:e056ac8fecf8 32 #include "mbed_rtos1_types.h"
valeyev 0:e056ac8fecf8 33
valeyev 0:e056ac8fecf8 34 #include "platform/NonCopyable.h"
valeyev 0:e056ac8fecf8 35
valeyev 0:e056ac8fecf8 36 using namespace rtos;
valeyev 0:e056ac8fecf8 37
valeyev 0:e056ac8fecf8 38 namespace rtos {
valeyev 0:e056ac8fecf8 39 /** \addtogroup rtos */
valeyev 0:e056ac8fecf8 40 /** @{*/
valeyev 0:e056ac8fecf8 41 /**
valeyev 0:e056ac8fecf8 42 * \defgroup rtos_Mail Mail class
valeyev 0:e056ac8fecf8 43 * @{
valeyev 0:e056ac8fecf8 44 */
valeyev 0:e056ac8fecf8 45
valeyev 0:e056ac8fecf8 46 /** The Mail class allow to control, send, receive, or wait for mail.
valeyev 0:e056ac8fecf8 47 A mail is a memory block that is send to a thread or interrupt service routine.
valeyev 0:e056ac8fecf8 48 @tparam T data type of a single message element.
valeyev 0:e056ac8fecf8 49 @tparam queue_sz maximum number of messages in queue.
valeyev 0:e056ac8fecf8 50
valeyev 0:e056ac8fecf8 51 @note
valeyev 0:e056ac8fecf8 52 Memory considerations: The mail data store and control structures will be created on current thread's stack,
valeyev 0:e056ac8fecf8 53 both for the mbed OS and underlying RTOS objects (static or dynamic RTOS memory pools are not being used).
valeyev 0:e056ac8fecf8 54 */
valeyev 0:e056ac8fecf8 55 template<typename T, uint32_t queue_sz>
valeyev 0:e056ac8fecf8 56 class Mail : private mbed::NonCopyable<Mail<T, queue_sz> > {
valeyev 0:e056ac8fecf8 57 public:
valeyev 0:e056ac8fecf8 58 /** Create and Initialize Mail queue.
valeyev 0:e056ac8fecf8 59 *
valeyev 0:e056ac8fecf8 60 * @note You cannot call this function from ISR context.
valeyev 0:e056ac8fecf8 61 */
valeyev 0:e056ac8fecf8 62 Mail() { };
valeyev 0:e056ac8fecf8 63
valeyev 0:e056ac8fecf8 64 /** Check if the mail queue is empty
valeyev 0:e056ac8fecf8 65 *
valeyev 0:e056ac8fecf8 66 * @return True if the mail queue is empty, false if not
valeyev 0:e056ac8fecf8 67 *
valeyev 0:e056ac8fecf8 68 * @note You may call this function from ISR context.
valeyev 0:e056ac8fecf8 69 */
valeyev 0:e056ac8fecf8 70 bool empty() const {
valeyev 0:e056ac8fecf8 71 return _queue.empty();
valeyev 0:e056ac8fecf8 72 }
valeyev 0:e056ac8fecf8 73
valeyev 0:e056ac8fecf8 74 /** Check if the mail queue is full
valeyev 0:e056ac8fecf8 75 *
valeyev 0:e056ac8fecf8 76 * @return True if the mail queue is full, false if not
valeyev 0:e056ac8fecf8 77 *
valeyev 0:e056ac8fecf8 78 * @note You may call this function from ISR context.
valeyev 0:e056ac8fecf8 79 */
valeyev 0:e056ac8fecf8 80 bool full() const {
valeyev 0:e056ac8fecf8 81 return _queue.full();
valeyev 0:e056ac8fecf8 82 }
valeyev 0:e056ac8fecf8 83
valeyev 0:e056ac8fecf8 84 /** Allocate a memory block of type T
valeyev 0:e056ac8fecf8 85 @param millisec timeout value or 0 in case of no time-out. (default: 0).
valeyev 0:e056ac8fecf8 86 @return pointer to memory block that can be filled with mail or NULL in case error.
valeyev 0:e056ac8fecf8 87
valeyev 0:e056ac8fecf8 88 @note You may call this function from ISR context if the millisec parameter is set to 0.
valeyev 0:e056ac8fecf8 89 */
valeyev 0:e056ac8fecf8 90 T* alloc(uint32_t millisec=0) {
valeyev 0:e056ac8fecf8 91 return _pool.alloc();
valeyev 0:e056ac8fecf8 92 }
valeyev 0:e056ac8fecf8 93
valeyev 0:e056ac8fecf8 94 /** Allocate a memory block of type T and set memory block to zero.
valeyev 0:e056ac8fecf8 95 @param millisec timeout value or 0 in case of no time-out. (default: 0).
valeyev 0:e056ac8fecf8 96 @return pointer to memory block that can be filled with mail or NULL in case error.
valeyev 0:e056ac8fecf8 97
valeyev 0:e056ac8fecf8 98 @note You may call this function from ISR context if the millisec parameter is set to 0.
valeyev 0:e056ac8fecf8 99 */
valeyev 0:e056ac8fecf8 100 T* calloc(uint32_t millisec=0) {
valeyev 0:e056ac8fecf8 101 return _pool.calloc();
valeyev 0:e056ac8fecf8 102 }
valeyev 0:e056ac8fecf8 103
valeyev 0:e056ac8fecf8 104 /** Put a mail in the queue.
valeyev 0:e056ac8fecf8 105 @param mptr memory block previously allocated with Mail::alloc or Mail::calloc.
valeyev 0:e056ac8fecf8 106 @return status code that indicates the execution status of the function.
valeyev 0:e056ac8fecf8 107
valeyev 0:e056ac8fecf8 108 @note You may call this function from ISR context.
valeyev 0:e056ac8fecf8 109 */
valeyev 0:e056ac8fecf8 110 osStatus put(T *mptr) {
valeyev 0:e056ac8fecf8 111 return _queue.put(mptr);
valeyev 0:e056ac8fecf8 112 }
valeyev 0:e056ac8fecf8 113
valeyev 0:e056ac8fecf8 114 /** Get a mail from a queue.
valeyev 0:e056ac8fecf8 115 @param millisec timeout value or 0 in case of no time-out. (default: osWaitForever).
valeyev 0:e056ac8fecf8 116 @return event that contains mail information or error code.
valeyev 0:e056ac8fecf8 117
valeyev 0:e056ac8fecf8 118 @note You may call this function from ISR context if the millisec parameter is set to 0.
valeyev 0:e056ac8fecf8 119 */
valeyev 0:e056ac8fecf8 120 osEvent get(uint32_t millisec=osWaitForever) {
valeyev 0:e056ac8fecf8 121 osEvent evt = _queue.get(millisec);
valeyev 0:e056ac8fecf8 122 if (evt.status == osEventMessage) {
valeyev 0:e056ac8fecf8 123 evt.status = osEventMail;
valeyev 0:e056ac8fecf8 124 }
valeyev 0:e056ac8fecf8 125 return evt;
valeyev 0:e056ac8fecf8 126 }
valeyev 0:e056ac8fecf8 127
valeyev 0:e056ac8fecf8 128 /** Free a memory block from a mail.
valeyev 0:e056ac8fecf8 129 @param mptr pointer to the memory block that was obtained with Mail::get.
valeyev 0:e056ac8fecf8 130 @return status code that indicates the execution status of the function.
valeyev 0:e056ac8fecf8 131
valeyev 0:e056ac8fecf8 132 @note You may call this function from ISR context.
valeyev 0:e056ac8fecf8 133 */
valeyev 0:e056ac8fecf8 134 osStatus free(T *mptr) {
valeyev 0:e056ac8fecf8 135 return _pool.free(mptr);
valeyev 0:e056ac8fecf8 136 }
valeyev 0:e056ac8fecf8 137
valeyev 0:e056ac8fecf8 138 private:
valeyev 0:e056ac8fecf8 139 Queue<T, queue_sz> _queue;
valeyev 0:e056ac8fecf8 140 MemoryPool<T, queue_sz> _pool;
valeyev 0:e056ac8fecf8 141 };
valeyev 0:e056ac8fecf8 142
valeyev 0:e056ac8fecf8 143 /** @}*/
valeyev 0:e056ac8fecf8 144 /** @}*/
valeyev 0:e056ac8fecf8 145
valeyev 0:e056ac8fecf8 146 }
valeyev 0:e056ac8fecf8 147
valeyev 0:e056ac8fecf8 148 #endif
valeyev 0:e056ac8fecf8 149
valeyev 0:e056ac8fecf8 150
valeyev 0:e056ac8fecf8 151