Pierre Provent / USBHost

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.

Dependents:   TEST_USB_Nucleo_F429ZI Essais_USB_Nucleo_F429ZI SID_V3_Nucleo_F429ZI SID_V4_Nucleo_F429ZI_copy

mbed-rtos/rtos/Mail.h@0:77ca32e8e04e, 2020-09-25 (annotated)

Committer:
pierreprovent
Date:
Fri Sep 25 10:17:49 2020 +0000
Revision:
0:77ca32e8e04e
Programme acquisition en enregistrement sur clef USB carte Nucleo F429ZI cours ELE118 Cnam

Who changed what in which revision?

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