Lee Kai Xuan / mbed-os

mbed-os

Fork of mbed-os by erkin yucel

rtos/Semaphore.h@0:f269e3021894, 2016-10-23 (annotated)

Committer:
elessair
Date:
Sun Oct 23 15:10:02 2016 +0000
Revision:
0:f269e3021894
Initial commit

Who changed what in which revision?

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