Kev Mann / mbed-dev-OS5_10_4

RTC auf true

rtos/Semaphore.h@2:7aab896b1a3b, 2019-03-13 (annotated)

Committer:
kevman
Date:
Wed Mar 13 11:03:24 2019 +0000
Revision:
2:7aab896b1a3b
Parent:
0:38ceb79fef03 
2019-03-13

Who changed what in which revision?

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