Dorian Cauceglia / mbed-rtos-clxtester

fork

rtos/Semaphore.h@8:88a1a9c26ae3, 2012-11-27 (annotated)

Committer:
emilmont
Date:
Tue Nov 27 16:55:38 2012 +0000
Revision:
8:88a1a9c26ae3
Parent:
6:350b53afb889
Child:
31:015df9e602b6
Add "Thread::get_state" method.; Update license.; Update documentation.

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 {
emilmont 8:88a1a9c26ae3 29
emilmont 8:88a1a9c26ae3 30 /** The Semaphore class is used to manage and protect access to a set of shared resources. */
emilmont 8:88a1a9c26ae3 31 class Semaphore {
emilmont 8:88a1a9c26ae3 32 public:
emilmont 8:88a1a9c26ae3 33 /** Create and Initialize a Semaphore object used for managing resources.
emilmont 8:88a1a9c26ae3 34 @param number of available resources; maximum index value is (count-1).
emilmont 8:88a1a9c26ae3 35 */
emilmont 8:88a1a9c26ae3 36 Semaphore(int32_t count);
emilmont 8:88a1a9c26ae3 37
emilmont 8:88a1a9c26ae3 38 /** Wait until a Semaphore resource becomes available.
emilmont 8:88a1a9c26ae3 39 @param millisec timeout value or 0 in case of no time-out. (default: osWaitForever).
emilmont 8:88a1a9c26ae3 40 @return number of available tokens, or -1 in case of incorrect parameters
emilmont 8:88a1a9c26ae3 41 */
emilmont 8:88a1a9c26ae3 42 int32_t wait(uint32_t millisec=osWaitForever);
emilmont 8:88a1a9c26ae3 43
emilmont 8:88a1a9c26ae3 44 /** Release a Semaphore resource that was obtain with Semaphore::wait.
emilmont 8:88a1a9c26ae3 45 @return status code that indicates the execution status of the function.
emilmont 8:88a1a9c26ae3 46 */
emilmont 8:88a1a9c26ae3 47 osStatus release(void);
emilmont 8:88a1a9c26ae3 48
emilmont 8:88a1a9c26ae3 49 ~Semaphore();
emilmont 8:88a1a9c26ae3 50
emilmont 8:88a1a9c26ae3 51 private:
emilmont 8:88a1a9c26ae3 52 osSemaphoreId _osSemaphoreId;
emilmont 8:88a1a9c26ae3 53 osSemaphoreDef_t _osSemaphoreDef;
emilmont 8:88a1a9c26ae3 54 #ifdef CMSIS_OS_RTX
emilmont 8:88a1a9c26ae3 55 uint32_t _semaphore_data[2];
emilmont 8:88a1a9c26ae3 56 #endif
emilmont 8:88a1a9c26ae3 57 };
emilmont 8:88a1a9c26ae3 58
emilmont 8:88a1a9c26ae3 59 }
emilmont 8:88a1a9c26ae3 60 #endif