takashi kadono / Mbed OS Nucleo_446

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   ssd1331

mbed-os/rtos/Semaphore.h@0:8fdf9a60065b, 2018-10-10 (annotated)

Committer:
kadonotakashi
Date:
Wed Oct 10 00:33:53 2018 +0000
Revision:
0:8fdf9a60065b
how to make mbed librry

Who changed what in which revision?

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