Marco Zecchini
/
Example_RTOS
Rtos API example
Embed:
(wiki syntax)
Show/hide line numbers
Semaphore.h
00001 /* mbed Microcontroller Library 00002 * Copyright (c) 2006-2012 ARM Limited 00003 * 00004 * Permission is hereby granted, free of charge, to any person obtaining a copy 00005 * of this software and associated documentation files (the "Software"), to deal 00006 * in the Software without restriction, including without limitation the rights 00007 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 00008 * copies of the Software, and to permit persons to whom the Software is 00009 * furnished to do so, subject to the following conditions: 00010 * 00011 * The above copyright notice and this permission notice shall be included in 00012 * all copies or substantial portions of the Software. 00013 * 00014 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 00015 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 00016 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 00017 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 00018 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 00019 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 00020 * SOFTWARE. 00021 */ 00022 #ifndef SEMAPHORE_H 00023 #define SEMAPHORE_H 00024 00025 #include <stdint.h> 00026 #include "cmsis_os2.h" 00027 #include "mbed_rtos1_types.h" 00028 #include "mbed_rtos_storage.h" 00029 #include "platform/NonCopyable.h" 00030 00031 namespace rtos { 00032 /** \addtogroup rtos */ 00033 /** @{*/ 00034 /** 00035 * \defgroup rtos_Semaphore Semaphore class 00036 * @{ 00037 */ 00038 00039 /** The Semaphore class is used to manage and protect access to a set of shared resources. 00040 * 00041 * @note 00042 * Memory considerations: The semaphore control structures will be created on current thread's stack, both for the mbed OS 00043 * and underlying RTOS objects (static or dynamic RTOS memory pools are not being used). 00044 */ 00045 class Semaphore : private mbed::NonCopyable<Semaphore> { 00046 public: 00047 /** Create and Initialize a Semaphore object used for managing resources. 00048 @param count number of available resources; maximum index value is (count-1). (default: 0). 00049 */ 00050 Semaphore(int32_t count=0); 00051 00052 /** Create and Initialize a Semaphore object used for managing resources. 00053 @param count number of available resources 00054 @param max_count maximum number of available resources 00055 */ 00056 Semaphore(int32_t count, uint16_t max_count); 00057 00058 /** Wait until a Semaphore resource becomes available. 00059 @param millisec timeout value or 0 in case of no time-out. (default: osWaitForever). 00060 @return number of available tokens, before taking one; or -1 in case of incorrect parameters 00061 */ 00062 int32_t wait(uint32_t millisec=osWaitForever); 00063 00064 /** Release a Semaphore resource that was obtain with Semaphore::wait. 00065 @return status code that indicates the execution status of the function: 00066 @a osOK the token has been correctly released. 00067 @a osErrorResource the maximum token count has been reached. 00068 @a osErrorParameter internal error. 00069 */ 00070 osStatus release(void); 00071 00072 ~Semaphore(); 00073 00074 private: 00075 void constructor(int32_t count, uint16_t max_count); 00076 00077 osSemaphoreId_t _id; 00078 mbed_rtos_storage_semaphore_t _obj_mem; 00079 }; 00080 /** @}*/ 00081 /** @}*/ 00082 } 00083 #endif 00084 00085
Generated on Sun Jul 17 2022 08:25:29 by 1.7.2