Greg Steiert / maxim_dev

Maxim mbed development library

Dependents:   sensomed

rtos/Semaphore.h@0:0e018d759a2a, 2016-11-08 (annotated)

Committer:
switches
Date:
Tue Nov 08 18:27:11 2016 +0000
Revision:
0:0e018d759a2a
Initial commit

Who changed what in which revision?

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