Kenji Arai / mbed-os_TYBLE16

mbed-os5 only for TYBLE16

Dependents:   TYBLE16_simple_data_logger TYBLE16_MP3_Air

rtos/Mail.h@1:9db0e321a9f4, 2019-12-31 (annotated)

Committer:
kenjiArai
Date:
Tue Dec 31 06:02:27 2019 +0000
Revision:
1:9db0e321a9f4
Parent:
0:5b88d5760320 
updated based on mbed-os5.15.0

Who changed what in which revision?

UserRevisionLine numberNew contents of line
kenjiArai 0:5b88d5760320 1 /* mbed Microcontroller Library
kenjiArai 1:9db0e321a9f4 2 * Copyright (c) 2006-2019 ARM Limited
kenjiArai 0:5b88d5760320 3 *
kenjiArai 0:5b88d5760320 4 * Permission is hereby granted, free of charge, to any person obtaining a copy
kenjiArai 0:5b88d5760320 5 * of this software and associated documentation files (the "Software"), to deal
kenjiArai 0:5b88d5760320 6 * in the Software without restriction, including without limitation the rights
kenjiArai 0:5b88d5760320 7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
kenjiArai 0:5b88d5760320 8 * copies of the Software, and to permit persons to whom the Software is
kenjiArai 0:5b88d5760320 9 * furnished to do so, subject to the following conditions:
kenjiArai 0:5b88d5760320 10 *
kenjiArai 0:5b88d5760320 11 * The above copyright notice and this permission notice shall be included in
kenjiArai 0:5b88d5760320 12 * all copies or substantial portions of the Software.
kenjiArai 0:5b88d5760320 13 *
kenjiArai 0:5b88d5760320 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
kenjiArai 0:5b88d5760320 15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
kenjiArai 0:5b88d5760320 16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
kenjiArai 0:5b88d5760320 17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
kenjiArai 0:5b88d5760320 18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
kenjiArai 0:5b88d5760320 19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
kenjiArai 0:5b88d5760320 20 * SOFTWARE.
kenjiArai 0:5b88d5760320 21 */
kenjiArai 0:5b88d5760320 22 #ifndef MAIL_H
kenjiArai 0:5b88d5760320 23 #define MAIL_H
kenjiArai 0:5b88d5760320 24
kenjiArai 0:5b88d5760320 25 #include <stdint.h>
kenjiArai 0:5b88d5760320 26 #include <string.h>
kenjiArai 0:5b88d5760320 27
kenjiArai 1:9db0e321a9f4 28 #include "rtos/Queue.h"
kenjiArai 1:9db0e321a9f4 29 #include "rtos/MemoryPool.h"
kenjiArai 1:9db0e321a9f4 30 #include "rtos/mbed_rtos_types.h"
kenjiArai 1:9db0e321a9f4 31 #include "rtos/mbed_rtos_storage.h"
kenjiArai 1:9db0e321a9f4 32 #include "rtos/mbed_rtos1_types.h"
kenjiArai 0:5b88d5760320 33
kenjiArai 0:5b88d5760320 34 #include "platform/mbed_toolchain.h"
kenjiArai 0:5b88d5760320 35 #include "platform/NonCopyable.h"
kenjiArai 0:5b88d5760320 36
kenjiArai 0:5b88d5760320 37 #ifndef MBED_NO_GLOBAL_USING_DIRECTIVE
kenjiArai 0:5b88d5760320 38 using namespace rtos;
kenjiArai 0:5b88d5760320 39 #endif
kenjiArai 0:5b88d5760320 40
kenjiArai 1:9db0e321a9f4 41 #if MBED_CONF_RTOS_PRESENT || defined(DOXYGEN_ONLY)
kenjiArai 1:9db0e321a9f4 42
kenjiArai 0:5b88d5760320 43 namespace rtos {
kenjiArai 1:9db0e321a9f4 44 /** \addtogroup rtos-public-api */
kenjiArai 0:5b88d5760320 45 /** @{*/
kenjiArai 1:9db0e321a9f4 46
kenjiArai 0:5b88d5760320 47 /**
kenjiArai 0:5b88d5760320 48 * \defgroup rtos_Mail Mail class
kenjiArai 0:5b88d5760320 49 * @{
kenjiArai 0:5b88d5760320 50 */
kenjiArai 0:5b88d5760320 51
kenjiArai 0:5b88d5760320 52 /** The Mail class allows you to control, send, receive or wait for mail.
kenjiArai 0:5b88d5760320 53 * A mail is a memory block that is sent to a thread or interrupt service routine (ISR).
kenjiArai 0:5b88d5760320 54 * @tparam T Data type of a single mail message element.
kenjiArai 0:5b88d5760320 55 * @tparam queue_sz Maximum number of mail messages in queue.
kenjiArai 0:5b88d5760320 56 *
kenjiArai 0:5b88d5760320 57 * @note
kenjiArai 0:5b88d5760320 58 * Memory considerations: The mail data store and control structures are part of this class - they do not (themselves)
kenjiArai 0:5b88d5760320 59 * allocate memory on the heap, both for the Mbed OS and underlying RTOS objects (static or dynamic RTOS memory
kenjiArai 0:5b88d5760320 60 * pools are not being used).
kenjiArai 0:5b88d5760320 61 */
kenjiArai 0:5b88d5760320 62 template<typename T, uint32_t queue_sz>
kenjiArai 0:5b88d5760320 63 class Mail : private mbed::NonCopyable<Mail<T, queue_sz> > {
kenjiArai 0:5b88d5760320 64 public:
kenjiArai 0:5b88d5760320 65 /** Create and initialize Mail queue.
kenjiArai 0:5b88d5760320 66 *
kenjiArai 0:5b88d5760320 67 * @note You cannot call this function from ISR context.
kenjiArai 0:5b88d5760320 68 */
kenjiArai 0:5b88d5760320 69 Mail() { };
kenjiArai 0:5b88d5760320 70
kenjiArai 0:5b88d5760320 71 /** Check if the mail queue is empty.
kenjiArai 0:5b88d5760320 72 *
kenjiArai 0:5b88d5760320 73 * @return State of queue.
kenjiArai 0:5b88d5760320 74 * @retval true Mail queue is empty.
kenjiArai 0:5b88d5760320 75 * @retval false Mail queue contains mail.
kenjiArai 0:5b88d5760320 76 *
kenjiArai 0:5b88d5760320 77 * @note You may call this function from ISR context.
kenjiArai 0:5b88d5760320 78 */
kenjiArai 0:5b88d5760320 79 bool empty() const
kenjiArai 0:5b88d5760320 80 {
kenjiArai 0:5b88d5760320 81 return _queue.empty();
kenjiArai 0:5b88d5760320 82 }
kenjiArai 0:5b88d5760320 83
kenjiArai 0:5b88d5760320 84 /** Check if the mail queue is full.
kenjiArai 0:5b88d5760320 85 *
kenjiArai 0:5b88d5760320 86 * @return State of queue.
kenjiArai 0:5b88d5760320 87 * @retval true Mail queue is full.
kenjiArai 0:5b88d5760320 88 * @retval false Mail queue is not full.
kenjiArai 0:5b88d5760320 89 *
kenjiArai 0:5b88d5760320 90 * @note You may call this function from ISR context.
kenjiArai 0:5b88d5760320 91 */
kenjiArai 0:5b88d5760320 92 bool full() const
kenjiArai 0:5b88d5760320 93 {
kenjiArai 0:5b88d5760320 94 return _queue.full();
kenjiArai 0:5b88d5760320 95 }
kenjiArai 0:5b88d5760320 96
kenjiArai 0:5b88d5760320 97 /** Allocate a memory block of type T, without blocking.
kenjiArai 0:5b88d5760320 98 *
kenjiArai 0:5b88d5760320 99 * @param millisec Not used (see note).
kenjiArai 0:5b88d5760320 100 *
kenjiArai 1:9db0e321a9f4 101 * @return Pointer to memory block that you can fill with mail or nullptr in case error.
kenjiArai 0:5b88d5760320 102 *
kenjiArai 0:5b88d5760320 103 * @note You may call this function from ISR context.
kenjiArai 0:5b88d5760320 104 * @note If blocking is required, use Mail::alloc_for or Mail::alloc_until
kenjiArai 0:5b88d5760320 105 */
kenjiArai 0:5b88d5760320 106 T *alloc(MBED_UNUSED uint32_t millisec = 0)
kenjiArai 0:5b88d5760320 107 {
kenjiArai 0:5b88d5760320 108 return _pool.alloc();
kenjiArai 0:5b88d5760320 109 }
kenjiArai 0:5b88d5760320 110
kenjiArai 0:5b88d5760320 111 /** Allocate a memory block of type T, optionally blocking.
kenjiArai 0:5b88d5760320 112 *
kenjiArai 0:5b88d5760320 113 * @param millisec Timeout value, or osWaitForever.
kenjiArai 0:5b88d5760320 114 *
kenjiArai 1:9db0e321a9f4 115 * @return Pointer to memory block that you can fill with mail or nullptr in case error.
kenjiArai 0:5b88d5760320 116 *
kenjiArai 0:5b88d5760320 117 * @note You may call this function from ISR context if the millisec parameter is set to 0.
kenjiArai 0:5b88d5760320 118 */
kenjiArai 0:5b88d5760320 119 T *alloc_for(uint32_t millisec)
kenjiArai 0:5b88d5760320 120 {
kenjiArai 0:5b88d5760320 121 return _pool.alloc_for(millisec);
kenjiArai 0:5b88d5760320 122 }
kenjiArai 0:5b88d5760320 123
kenjiArai 0:5b88d5760320 124 /** Allocate a memory block of type T, blocking.
kenjiArai 0:5b88d5760320 125 *
kenjiArai 0:5b88d5760320 126 * @param millisec Absolute timeout time, referenced to Kernel::get_ms_count().
kenjiArai 0:5b88d5760320 127 *
kenjiArai 1:9db0e321a9f4 128 * @return Pointer to memory block that you can fill with mail or nullptr in case error.
kenjiArai 0:5b88d5760320 129 *
kenjiArai 0:5b88d5760320 130 * @note You cannot call this function from ISR context.
kenjiArai 0:5b88d5760320 131 * @note the underlying RTOS may have a limit to the maximum wait time
kenjiArai 0:5b88d5760320 132 * due to internal 32-bit computations, but this is guaranteed to work if the
kenjiArai 0:5b88d5760320 133 * wait is <= 0x7fffffff milliseconds (~24 days). If the limit is exceeded,
kenjiArai 0:5b88d5760320 134 * the wait will time out earlier than specified.
kenjiArai 0:5b88d5760320 135 */
kenjiArai 0:5b88d5760320 136 T *alloc_until(uint64_t millisec)
kenjiArai 0:5b88d5760320 137 {
kenjiArai 0:5b88d5760320 138 return _pool.alloc_until(millisec);
kenjiArai 0:5b88d5760320 139 }
kenjiArai 0:5b88d5760320 140
kenjiArai 0:5b88d5760320 141 /** Allocate a memory block of type T, and set memory block to zero.
kenjiArai 0:5b88d5760320 142 *
kenjiArai 0:5b88d5760320 143 * @param millisec Not used (see note).
kenjiArai 0:5b88d5760320 144 *
kenjiArai 1:9db0e321a9f4 145 * @return Pointer to memory block that you can fill with mail or nullptr in case error.
kenjiArai 0:5b88d5760320 146 *
kenjiArai 0:5b88d5760320 147 * @note You may call this function from ISR context if the millisec parameter is set to 0.
kenjiArai 0:5b88d5760320 148 * @note If blocking is required, use Mail::calloc_for or Mail::calloc_until
kenjiArai 0:5b88d5760320 149 */
kenjiArai 0:5b88d5760320 150 T *calloc(MBED_UNUSED uint32_t millisec = 0)
kenjiArai 0:5b88d5760320 151 {
kenjiArai 0:5b88d5760320 152 return _pool.calloc();
kenjiArai 0:5b88d5760320 153 }
kenjiArai 0:5b88d5760320 154
kenjiArai 0:5b88d5760320 155 /** Allocate a memory block of type T, optionally blocking, and set memory block to zero.
kenjiArai 0:5b88d5760320 156 *
kenjiArai 0:5b88d5760320 157 * @param millisec Timeout value, or osWaitForever.
kenjiArai 0:5b88d5760320 158 *
kenjiArai 1:9db0e321a9f4 159 * @return Pointer to memory block that you can fill with mail or nullptr in case error.
kenjiArai 0:5b88d5760320 160 *
kenjiArai 0:5b88d5760320 161 * @note You may call this function from ISR context if the millisec parameter is set to 0.
kenjiArai 0:5b88d5760320 162 */
kenjiArai 0:5b88d5760320 163 T *calloc_for(uint32_t millisec)
kenjiArai 0:5b88d5760320 164 {
kenjiArai 0:5b88d5760320 165 return _pool.calloc_for(millisec);
kenjiArai 0:5b88d5760320 166 }
kenjiArai 0:5b88d5760320 167
kenjiArai 0:5b88d5760320 168 /** Allocate a memory block of type T, blocking, and set memory block to zero.
kenjiArai 0:5b88d5760320 169 *
kenjiArai 0:5b88d5760320 170 * @param millisec Absolute timeout time, referenced to Kernel::get_ms_count().
kenjiArai 0:5b88d5760320 171 *
kenjiArai 1:9db0e321a9f4 172 * @return Pointer to memory block that you can fill with mail or nullptr in case error.
kenjiArai 0:5b88d5760320 173 *
kenjiArai 0:5b88d5760320 174 * @note You cannot call this function from ISR context.
kenjiArai 0:5b88d5760320 175 * @note the underlying RTOS may have a limit to the maximum wait time
kenjiArai 0:5b88d5760320 176 * due to internal 32-bit computations, but this is guaranteed to work if the
kenjiArai 0:5b88d5760320 177 * wait is <= 0x7fffffff milliseconds (~24 days). If the limit is exceeded,
kenjiArai 0:5b88d5760320 178 * the wait will time out earlier than specified.
kenjiArai 0:5b88d5760320 179 */
kenjiArai 0:5b88d5760320 180 T *calloc_until(uint64_t millisec)
kenjiArai 0:5b88d5760320 181 {
kenjiArai 0:5b88d5760320 182 return _pool.calloc_until(millisec);
kenjiArai 0:5b88d5760320 183 }
kenjiArai 0:5b88d5760320 184
kenjiArai 0:5b88d5760320 185 /** Put a mail in the queue.
kenjiArai 0:5b88d5760320 186 *
kenjiArai 0:5b88d5760320 187 * @param mptr Memory block previously allocated with Mail::alloc or Mail::calloc.
kenjiArai 0:5b88d5760320 188 *
kenjiArai 0:5b88d5760320 189 * @return Status code that indicates the execution status of the function (osOK on success).
kenjiArai 0:5b88d5760320 190 *
kenjiArai 0:5b88d5760320 191 * @note You may call this function from ISR context.
kenjiArai 0:5b88d5760320 192 */
kenjiArai 0:5b88d5760320 193 osStatus put(T *mptr)
kenjiArai 0:5b88d5760320 194 {
kenjiArai 0:5b88d5760320 195 return _queue.put(mptr);
kenjiArai 0:5b88d5760320 196 }
kenjiArai 0:5b88d5760320 197
kenjiArai 0:5b88d5760320 198 /** Get a mail from the queue.
kenjiArai 0:5b88d5760320 199 *
kenjiArai 0:5b88d5760320 200 * @param millisec Timeout value (default: osWaitForever).
kenjiArai 0:5b88d5760320 201 *
kenjiArai 0:5b88d5760320 202 * @return Event that contains mail information or error code.
kenjiArai 0:5b88d5760320 203 * @retval osEventMessage Message received.
kenjiArai 0:5b88d5760320 204 * @retval osOK No mail is available (and no timeout was specified).
kenjiArai 0:5b88d5760320 205 * @retval osEventTimeout No mail has arrived during the given timeout period.
kenjiArai 0:5b88d5760320 206 * @retval osErrorParameter A parameter is invalid or outside of a permitted range.
kenjiArai 0:5b88d5760320 207 *
kenjiArai 0:5b88d5760320 208 * @note You may call this function from ISR context if the millisec parameter is set to 0.
kenjiArai 0:5b88d5760320 209 */
kenjiArai 0:5b88d5760320 210 osEvent get(uint32_t millisec = osWaitForever)
kenjiArai 0:5b88d5760320 211 {
kenjiArai 0:5b88d5760320 212 osEvent evt = _queue.get(millisec);
kenjiArai 0:5b88d5760320 213 if (evt.status == osEventMessage) {
kenjiArai 0:5b88d5760320 214 evt.status = osEventMail;
kenjiArai 0:5b88d5760320 215 }
kenjiArai 0:5b88d5760320 216 return evt;
kenjiArai 0:5b88d5760320 217 }
kenjiArai 0:5b88d5760320 218
kenjiArai 0:5b88d5760320 219 /** Free a memory block from a mail.
kenjiArai 0:5b88d5760320 220 *
kenjiArai 0:5b88d5760320 221 * @param mptr Pointer to the memory block that was obtained with Mail::get.
kenjiArai 0:5b88d5760320 222 *
kenjiArai 0:5b88d5760320 223 * @return Status code that indicates the execution status of the function (osOK on success).
kenjiArai 0:5b88d5760320 224 *
kenjiArai 0:5b88d5760320 225 * @note You may call this function from ISR context.
kenjiArai 0:5b88d5760320 226 */
kenjiArai 0:5b88d5760320 227 osStatus free(T *mptr)
kenjiArai 0:5b88d5760320 228 {
kenjiArai 0:5b88d5760320 229 return _pool.free(mptr);
kenjiArai 0:5b88d5760320 230 }
kenjiArai 0:5b88d5760320 231
kenjiArai 0:5b88d5760320 232 private:
kenjiArai 0:5b88d5760320 233 Queue<T, queue_sz> _queue;
kenjiArai 0:5b88d5760320 234 MemoryPool<T, queue_sz> _pool;
kenjiArai 0:5b88d5760320 235 };
kenjiArai 0:5b88d5760320 236
kenjiArai 0:5b88d5760320 237 /** @}*/
kenjiArai 0:5b88d5760320 238 /** @}*/
kenjiArai 0:5b88d5760320 239
kenjiArai 0:5b88d5760320 240 }
kenjiArai 0:5b88d5760320 241
kenjiArai 0:5b88d5760320 242 #endif
kenjiArai 0:5b88d5760320 243
kenjiArai 1:9db0e321a9f4 244 #endif
kenjiArai 0:5b88d5760320 245