Mistake on this page?
Report an issue in GitHub or email us
mbed_rtx_storage.h
1 /* mbed Microcontroller Library
2  * Copyright (c) 2006-2017 ARM Limited
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining a copy
5  * of this software and associated documentation files (the "Software"), to deal
6  * in the Software without restriction, including without limitation the rights
7  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8  * copies of the Software, and to permit persons to whom the Software is
9  * furnished to do so, subject to the following conditions:
10  *
11  * The above copyright notice and this permission notice shall be included in
12  * all copies or substantial portions of the Software.
13  *
14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20  * SOFTWARE.
21  */
22 #ifndef MBED_RTX_STORAGE_H
23 #define MBED_RTX_STORAGE_H
24 
25 #ifdef __cplusplus
26 extern "C" {
27 #endif
28 
29 #include "rtx_os.h"
30 #include "mbed_rtx_conf.h"
31 
32 /** \ingroup mbed-os-internal */
33 /** \addtogroup rtos-internal-api */
34 /** @{*/
35 
36 /** \defgroup rtos_storage RTOS primitives storage types for RTX
37  Types defined in this file should be utilized, when the direct RTOS C API usage is required, to provide backing memory
38  for internal RTX data. Allocated object should be wrapped in attribute struct and passed to os*New call, for details
39  see CMSIS-RTOS2 documentation.
40 
41  This file breaks abstraction layers and uses RTX internal types, but it limits the contamination to single, RTOS
42  implementation specific, header file, therefore limiting scope of possible changes.
43  @{
44 */
45 
46 /** RTX Mutex storage */
48 
49 /** RTX Semaphore storage */
51 
52 /** RTX Thread storage */
54 
55 /** RTX Memory Pool storage */
57 
58 /** RTX Message Queue storage */
60 
61 /** RTX Event Flags storage */
63 
64 /** RTX Message storage */
66 
67 /** RTX Timer storage */
69 /** @}*/
70 /** @}*/
71 
72 #define MBED_RTOS_STORAGE_MEM_POOL_MEM_SIZE(block_count, block_size) \
73  osRtxMemoryPoolMemSize(block_count, block_size)
74 
75 #ifdef __cplusplus
76 }
77 #endif
78 
79 #endif
Message Queue Control Block.
Definition: rtx_os.h:247
Memory Pool Control Block.
Definition: rtx_os.h:223
Semaphore Control Block.
Definition: rtx_os.h:198
osRtxMessageQueue_t mbed_rtos_storage_msg_queue_t
RTX Message Queue storage.
osRtxEventFlags_t mbed_rtos_storage_event_flags_t
RTX Event Flags storage.
Message Control Block.
Definition: rtx_os.h:237
Thread Control Block.
Definition: rtx_os.h:102
osRtxSemaphore_t mbed_rtos_storage_semaphore_t
RTX Semaphore storage.
Event Flags Control Block.
Definition: rtx_os.h:166
osRtxMemoryPool_t mbed_rtos_storage_mem_pool_t
RTX Memory Pool storage.
osRtxThread_t mbed_rtos_storage_thread_t
RTX Thread storage.
osRtxMessage_t mbed_rtos_storage_message_t
RTX Message storage.
Timer Control Block.
Definition: rtx_os.h:149
Mutex Control Block.
Definition: rtx_os.h:180
osRtxTimer_t mbed_rtos_storage_timer_t
RTX Timer storage.
osRtxMutex_t mbed_rtos_storage_mutex_t
RTX Mutex storage.
Important Information for this Arm website

This site uses cookies to store information on your computer. By continuing to use our site, you consent to our cookies. If you are not happy with the use of these cookies, please review our Cookie Policy to learn how they can be disabled. By disabling cookies, some features of the site will not work.