PES4 / Mbed OS Queue_02

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.

mbed-os/rtos/Semaphore.h@1:b36bbc1c6d27, 2020-04-11 (annotated)

Committer:
demayer
Date:
Sat Apr 11 08:15:48 2020 +0000
Revision:
1:b36bbc1c6d27
Parent:
0:6bf0743ece18 
IMU-library in .h und .cpp file aufgeteilt

Who changed what in which revision?

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