Dorian Cauceglia / mbed-rtos

f

Dependents:   Active-WolfMan_V2-5-All-Frank-Board-Functions_copy

rtos/Semaphore.h@124:e645e86173a2, 2019-03-08 (annotated)

Committer:
emperord
Date:
Fri Mar 08 13:46:18 2019 +0000
Revision:
124:e645e86173a2
Parent:
123:58563e6cba1e 
fo

Who changed what in which revision?

UserRevisionLine numberNew contents of line
emilmont 8:88a1a9c26ae3 1 /* mbed Microcontroller Library
emilmont 8:88a1a9c26ae3 2 * Copyright (c) 2006-2012 ARM Limited
emilmont 8:88a1a9c26ae3 3 *
emilmont 8:88a1a9c26ae3 4 * Permission is hereby granted, free of charge, to any person obtaining a copy
emilmont 8:88a1a9c26ae3 5 * of this software and associated documentation files (the "Software"), to deal
emilmont 8:88a1a9c26ae3 6 * in the Software without restriction, including without limitation the rights
emilmont 8:88a1a9c26ae3 7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
emilmont 8:88a1a9c26ae3 8 * copies of the Software, and to permit persons to whom the Software is
emilmont 8:88a1a9c26ae3 9 * furnished to do so, subject to the following conditions:
emilmont 8:88a1a9c26ae3 10 *
emilmont 8:88a1a9c26ae3 11 * The above copyright notice and this permission notice shall be included in
emilmont 8:88a1a9c26ae3 12 * all copies or substantial portions of the Software.
emilmont 8:88a1a9c26ae3 13 *
emilmont 8:88a1a9c26ae3 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
emilmont 8:88a1a9c26ae3 15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
emilmont 8:88a1a9c26ae3 16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
emilmont 8:88a1a9c26ae3 17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
emilmont 8:88a1a9c26ae3 18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
emilmont 8:88a1a9c26ae3 19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
emilmont 8:88a1a9c26ae3 20 * SOFTWARE.
emilmont 8:88a1a9c26ae3 21 */
emilmont 8:88a1a9c26ae3 22 #ifndef SEMAPHORE_H
emilmont 8:88a1a9c26ae3 23 #define SEMAPHORE_H
emilmont 8:88a1a9c26ae3 24
emilmont 8:88a1a9c26ae3 25 #include <stdint.h>
emilmont 8:88a1a9c26ae3 26 #include "cmsis_os.h"
emilmont 8:88a1a9c26ae3 27
emilmont 8:88a1a9c26ae3 28 namespace rtos {
c1728p9 123:58563e6cba1e 29 /** \addtogroup rtos */
c1728p9 123:58563e6cba1e 30 /** @{*/
emilmont 8:88a1a9c26ae3 31
emilmont 8:88a1a9c26ae3 32 /** The Semaphore class is used to manage and protect access to a set of shared resources. */
emilmont 8:88a1a9c26ae3 33 class Semaphore {
emilmont 8:88a1a9c26ae3 34 public:
mbed_official 31:015df9e602b6 35 /** Create and Initialize a Semaphore object used for managing resources.
Kojto 119:19af2d39a542 36 @param number of available resources; maximum index value is (count-1). (default: 0).
emilmont 8:88a1a9c26ae3 37 */
Kojto 119:19af2d39a542 38 Semaphore(int32_t count=0);
mbed_official 31:015df9e602b6 39
mbed_official 31:015df9e602b6 40 /** Wait until a Semaphore resource becomes available.
emilmont 8:88a1a9c26ae3 41 @param millisec timeout value or 0 in case of no time-out. (default: osWaitForever).
emilmont 8:88a1a9c26ae3 42 @return number of available tokens, or -1 in case of incorrect parameters
emilmont 8:88a1a9c26ae3 43 */
emilmont 8:88a1a9c26ae3 44 int32_t wait(uint32_t millisec=osWaitForever);
mbed_official 31:015df9e602b6 45
emilmont 8:88a1a9c26ae3 46 /** Release a Semaphore resource that was obtain with Semaphore::wait.
mbed_official 31:015df9e602b6 47 @return status code that indicates the execution status of the function.
emilmont 8:88a1a9c26ae3 48 */
emilmont 8:88a1a9c26ae3 49 osStatus release(void);
mbed_official 31:015df9e602b6 50
emilmont 8:88a1a9c26ae3 51 ~Semaphore();
emilmont 8:88a1a9c26ae3 52
emilmont 8:88a1a9c26ae3 53 private:
emilmont 8:88a1a9c26ae3 54 osSemaphoreId _osSemaphoreId;
emilmont 8:88a1a9c26ae3 55 osSemaphoreDef_t _osSemaphoreDef;
emilmont 8:88a1a9c26ae3 56 #ifdef CMSIS_OS_RTX
emilmont 8:88a1a9c26ae3 57 uint32_t _semaphore_data[2];
emilmont 8:88a1a9c26ae3 58 #endif
emilmont 8:88a1a9c26ae3 59 };
emilmont 8:88a1a9c26ae3 60
emilmont 8:88a1a9c26ae3 61 }
emilmont 8:88a1a9c26ae3 62 #endif
c1728p9 123:58563e6cba1e 63
c1728p9 123:58563e6cba1e 64 /** @}*/