Nicolas Borla / Mbed OS BBR_1Ebene

BBR 1 Ebene

mbed-os/rtos/Semaphore.h@0:fbdae7e6d805, 2018-05-14 (annotated)

Committer:
borlanic
Date:
Mon May 14 11:29:06 2018 +0000
Revision:
0:fbdae7e6d805
BBR

Who changed what in which revision?

UserRevisionLine numberNew contents of line
borlanic 0:fbdae7e6d805 1 /* mbed Microcontroller Library
borlanic 0:fbdae7e6d805 2 * Copyright (c) 2006-2012 ARM Limited
borlanic 0:fbdae7e6d805 3 *
borlanic 0:fbdae7e6d805 4 * Permission is hereby granted, free of charge, to any person obtaining a copy
borlanic 0:fbdae7e6d805 5 * of this software and associated documentation files (the "Software"), to deal
borlanic 0:fbdae7e6d805 6 * in the Software without restriction, including without limitation the rights
borlanic 0:fbdae7e6d805 7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
borlanic 0:fbdae7e6d805 8 * copies of the Software, and to permit persons to whom the Software is
borlanic 0:fbdae7e6d805 9 * furnished to do so, subject to the following conditions:
borlanic 0:fbdae7e6d805 10 *
borlanic 0:fbdae7e6d805 11 * The above copyright notice and this permission notice shall be included in
borlanic 0:fbdae7e6d805 12 * all copies or substantial portions of the Software.
borlanic 0:fbdae7e6d805 13 *
borlanic 0:fbdae7e6d805 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
borlanic 0:fbdae7e6d805 15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
borlanic 0:fbdae7e6d805 16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
borlanic 0:fbdae7e6d805 17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
borlanic 0:fbdae7e6d805 18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
borlanic 0:fbdae7e6d805 19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
borlanic 0:fbdae7e6d805 20 * SOFTWARE.
borlanic 0:fbdae7e6d805 21 */
borlanic 0:fbdae7e6d805 22 #ifndef SEMAPHORE_H
borlanic 0:fbdae7e6d805 23 #define SEMAPHORE_H
borlanic 0:fbdae7e6d805 24
borlanic 0:fbdae7e6d805 25 #include <stdint.h>
borlanic 0:fbdae7e6d805 26 #include "cmsis_os2.h"
borlanic 0:fbdae7e6d805 27 #include "mbed_rtos1_types.h"
borlanic 0:fbdae7e6d805 28 #include "mbed_rtos_storage.h"
borlanic 0:fbdae7e6d805 29 #include "platform/NonCopyable.h"
borlanic 0:fbdae7e6d805 30
borlanic 0:fbdae7e6d805 31 namespace rtos {
borlanic 0:fbdae7e6d805 32 /** \addtogroup rtos */
borlanic 0:fbdae7e6d805 33 /** @{*/
borlanic 0:fbdae7e6d805 34 /**
borlanic 0:fbdae7e6d805 35 * \defgroup rtos_Semaphore Semaphore class
borlanic 0:fbdae7e6d805 36 * @{
borlanic 0:fbdae7e6d805 37 */
borlanic 0:fbdae7e6d805 38
borlanic 0:fbdae7e6d805 39 /** The Semaphore class is used to manage and protect access to a set of shared resources.
borlanic 0:fbdae7e6d805 40 *
borlanic 0:fbdae7e6d805 41 * @note
borlanic 0:fbdae7e6d805 42 * Memory considerations: The semaphore control structures will be created on current thread's stack, both for the mbed OS
borlanic 0:fbdae7e6d805 43 * and underlying RTOS objects (static or dynamic RTOS memory pools are not being used).
borlanic 0:fbdae7e6d805 44 */
borlanic 0:fbdae7e6d805 45 class Semaphore : private mbed::NonCopyable<Semaphore> {
borlanic 0:fbdae7e6d805 46 public:
borlanic 0:fbdae7e6d805 47 /** Create and Initialize a Semaphore object used for managing resources.
borlanic 0:fbdae7e6d805 48 @param count number of available resources; maximum index value is (count-1). (default: 0).
borlanic 0:fbdae7e6d805 49
borlanic 0:fbdae7e6d805 50 @note You cannot call this function from ISR context.
borlanic 0:fbdae7e6d805 51 */
borlanic 0:fbdae7e6d805 52 Semaphore(int32_t count=0);
borlanic 0:fbdae7e6d805 53
borlanic 0:fbdae7e6d805 54 /** Create and Initialize a Semaphore object used for managing resources.
borlanic 0:fbdae7e6d805 55 @param count number of available resources
borlanic 0:fbdae7e6d805 56 @param max_count maximum number of available resources
borlanic 0:fbdae7e6d805 57
borlanic 0:fbdae7e6d805 58 @note You cannot call this function from ISR context.
borlanic 0:fbdae7e6d805 59 */
borlanic 0:fbdae7e6d805 60 Semaphore(int32_t count, uint16_t max_count);
borlanic 0:fbdae7e6d805 61
borlanic 0:fbdae7e6d805 62 /** Wait until a Semaphore resource becomes available.
borlanic 0:fbdae7e6d805 63 @param millisec timeout value or 0 in case of no time-out. (default: osWaitForever).
borlanic 0:fbdae7e6d805 64 @return number of available tokens, before taking one; or -1 in case of incorrect parameters
borlanic 0:fbdae7e6d805 65
borlanic 0:fbdae7e6d805 66 @note You may call this function from ISR context if the millisec parameter is set to 0.
borlanic 0:fbdae7e6d805 67 */
borlanic 0:fbdae7e6d805 68 int32_t wait(uint32_t millisec=osWaitForever);
borlanic 0:fbdae7e6d805 69
borlanic 0:fbdae7e6d805 70 /** Wait until a Semaphore resource becomes available.
borlanic 0:fbdae7e6d805 71 @param millisec absolute timeout time, referenced to Kernel::get_ms_count()
borlanic 0:fbdae7e6d805 72 @return number of available tokens, before taking one; or -1 in case of incorrect parameters
borlanic 0:fbdae7e6d805 73 @note the underlying RTOS may have a limit to the maximum wait time
borlanic 0:fbdae7e6d805 74 due to internal 32-bit computations, but this is guaranteed to work if the
borlanic 0:fbdae7e6d805 75 wait is <= 0x7fffffff milliseconds (~24 days). If the limit is exceeded,
borlanic 0:fbdae7e6d805 76 the acquire attempt will time out earlier than specified.
borlanic 0:fbdae7e6d805 77
borlanic 0:fbdae7e6d805 78 @note You cannot call this function from ISR context.
borlanic 0:fbdae7e6d805 79 */
borlanic 0:fbdae7e6d805 80 int32_t wait_until(uint64_t millisec);
borlanic 0:fbdae7e6d805 81
borlanic 0:fbdae7e6d805 82 /** Release a Semaphore resource that was obtain with Semaphore::wait.
borlanic 0:fbdae7e6d805 83 @return status code that indicates the execution status of the function:
borlanic 0:fbdae7e6d805 84 @a osOK the token has been correctly released.
borlanic 0:fbdae7e6d805 85 @a osErrorResource the maximum token count has been reached.
borlanic 0:fbdae7e6d805 86 @a osErrorParameter internal error.
borlanic 0:fbdae7e6d805 87
borlanic 0:fbdae7e6d805 88 @note You may call this function from ISR context.
borlanic 0:fbdae7e6d805 89 */
borlanic 0:fbdae7e6d805 90 osStatus release(void);
borlanic 0:fbdae7e6d805 91
borlanic 0:fbdae7e6d805 92 /** Semaphore destructor
borlanic 0:fbdae7e6d805 93 *
borlanic 0:fbdae7e6d805 94 * @note You cannot call this function from ISR context.
borlanic 0:fbdae7e6d805 95 */
borlanic 0:fbdae7e6d805 96 ~Semaphore();
borlanic 0:fbdae7e6d805 97
borlanic 0:fbdae7e6d805 98 private:
borlanic 0:fbdae7e6d805 99 void constructor(int32_t count, uint16_t max_count);
borlanic 0:fbdae7e6d805 100
borlanic 0:fbdae7e6d805 101 osSemaphoreId_t _id;
borlanic 0:fbdae7e6d805 102 mbed_rtos_storage_semaphore_t _obj_mem;
borlanic 0:fbdae7e6d805 103 };
borlanic 0:fbdae7e6d805 104 /** @}*/
borlanic 0:fbdae7e6d805 105 /** @}*/
borlanic 0:fbdae7e6d805 106 }
borlanic 0:fbdae7e6d805 107 #endif
borlanic 0:fbdae7e6d805 108
borlanic 0:fbdae7e6d805 109