mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

TARGET_SDT51822B/TOOLCHAIN_IAR/pm_mutex.h@171:3a7713b1edbc, 2018-11-08 (annotated)

Committer:
AnnaBridge
Date:
Thu Nov 08 11:45:42 2018 +0000
Revision:
171:3a7713b1edbc
Parent:
TARGET_VBLUNO51/TARGET_NORDIC/TARGET_NRF5x/TARGET_SDK_11/ble/peer_manager/pm_mutex.h@169:a7c7b631e539 
mbed library. Release version 164

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AnnaBridge 143:86740a56073b 1 /*
AnnaBridge 143:86740a56073b 2 * Copyright (c) 2015 Nordic Semiconductor ASA
AnnaBridge 143:86740a56073b 3 * All rights reserved.
AnnaBridge 143:86740a56073b 4 *
AnnaBridge 143:86740a56073b 5 * Redistribution and use in source and binary forms, with or without modification,
AnnaBridge 143:86740a56073b 6 * are permitted provided that the following conditions are met:
AnnaBridge 143:86740a56073b 7 *
AnnaBridge 143:86740a56073b 8 * 1. Redistributions of source code must retain the above copyright notice, this list
AnnaBridge 143:86740a56073b 9 * of conditions and the following disclaimer.
AnnaBridge 143:86740a56073b 10 *
AnnaBridge 143:86740a56073b 11 * 2. Redistributions in binary form, except as embedded into a Nordic Semiconductor ASA
AnnaBridge 143:86740a56073b 12 * integrated circuit in a product or a software update for such product, must reproduce
AnnaBridge 143:86740a56073b 13 * the above copyright notice, this list of conditions and the following disclaimer in
AnnaBridge 143:86740a56073b 14 * the documentation and/or other materials provided with the distribution.
AnnaBridge 143:86740a56073b 15 *
AnnaBridge 143:86740a56073b 16 * 3. Neither the name of Nordic Semiconductor ASA nor the names of its contributors may be
AnnaBridge 143:86740a56073b 17 * used to endorse or promote products derived from this software without specific prior
AnnaBridge 143:86740a56073b 18 * written permission.
AnnaBridge 143:86740a56073b 19 *
AnnaBridge 143:86740a56073b 20 * 4. This software, with or without modification, must only be used with a
AnnaBridge 143:86740a56073b 21 * Nordic Semiconductor ASA integrated circuit.
AnnaBridge 143:86740a56073b 22 *
AnnaBridge 143:86740a56073b 23 * 5. Any software provided in binary or object form under this license must not be reverse
AnnaBridge 143:86740a56073b 24 * engineered, decompiled, modified and/or disassembled.
AnnaBridge 143:86740a56073b 25 *
AnnaBridge 143:86740a56073b 26 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
AnnaBridge 143:86740a56073b 27 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
AnnaBridge 143:86740a56073b 28 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
AnnaBridge 143:86740a56073b 29 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
AnnaBridge 143:86740a56073b 30 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
AnnaBridge 143:86740a56073b 31 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
AnnaBridge 143:86740a56073b 32 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
AnnaBridge 143:86740a56073b 33 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
AnnaBridge 143:86740a56073b 34 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
AnnaBridge 143:86740a56073b 35 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
AnnaBridge 143:86740a56073b 36 *
AnnaBridge 143:86740a56073b 37 */
AnnaBridge 143:86740a56073b 38
AnnaBridge 143:86740a56073b 39
AnnaBridge 143:86740a56073b 40
AnnaBridge 143:86740a56073b 41 #ifndef MUTEX_H__
AnnaBridge 143:86740a56073b 42 #define MUTEX_H__
AnnaBridge 143:86740a56073b 43
AnnaBridge 143:86740a56073b 44
AnnaBridge 143:86740a56073b 45 #include <stdint.h>
AnnaBridge 143:86740a56073b 46 #include <stdbool.h>
AnnaBridge 143:86740a56073b 47
AnnaBridge 143:86740a56073b 48 /**
AnnaBridge 143:86740a56073b 49 * @cond NO_DOXYGEN
AnnaBridge 143:86740a56073b 50 * @defgroup pm_mutex Mutex
AnnaBridge 143:86740a56073b 51 * @ingroup peer_manager
AnnaBridge 143:86740a56073b 52 * @{
AnnaBridge 143:86740a56073b 53 * @brief An internal module of @ref peer_manager. This module provides thread-safe mutexes.
AnnaBridge 143:86740a56073b 54 */
AnnaBridge 143:86740a56073b 55
AnnaBridge 143:86740a56073b 56
AnnaBridge 143:86740a56073b 57 /**@brief Defines the storage size of a specified mutex group.
AnnaBridge 143:86740a56073b 58 *
AnnaBridge 143:86740a56073b 59 * @param number_of_mutexes the number of mutexes in the group.
AnnaBridge 143:86740a56073b 60 */
AnnaBridge 143:86740a56073b 61 #define MUTEX_STORAGE_SIZE(number_of_mutexes) ((7 + (number_of_mutexes)) >> 3)
AnnaBridge 143:86740a56073b 62
AnnaBridge 143:86740a56073b 63
AnnaBridge 143:86740a56073b 64 /**@brief Initializes a mutex group.
AnnaBridge 143:86740a56073b 65 *
AnnaBridge 143:86740a56073b 66 * @param[in] p_mutex Pointer to the mutex group. See @ref MUTEX_STORAGE_SIZE().
AnnaBridge 143:86740a56073b 67 * @param[in] mutex_size The size of the mutex group in number of mutexes.
AnnaBridge 143:86740a56073b 68 */
AnnaBridge 143:86740a56073b 69 void pm_mutex_init(uint8_t * p_mutex, uint16_t mutex_size);
AnnaBridge 143:86740a56073b 70
AnnaBridge 143:86740a56073b 71
AnnaBridge 143:86740a56073b 72 /**@brief Locks the mutex specified by the bit id.
AnnaBridge 143:86740a56073b 73 *
AnnaBridge 143:86740a56073b 74 * @param[inout] p_mutex Pointer to the mutex group.
AnnaBridge 143:86740a56073b 75 * @param[in] mutex_bit_id The bit id of the mutex.
AnnaBridge 143:86740a56073b 76 *
AnnaBridge 143:86740a56073b 77 * @retval true if it was possible to lock the mutex.
AnnaBridge 143:86740a56073b 78 * @retval false otherwise.
AnnaBridge 143:86740a56073b 79 */
AnnaBridge 143:86740a56073b 80 bool pm_mutex_lock(uint8_t * p_mutex, uint16_t mutex_bit_id);
AnnaBridge 143:86740a56073b 81
AnnaBridge 143:86740a56073b 82
AnnaBridge 143:86740a56073b 83 /**@brief Locks the first unlocked mutex within the mutex group.
AnnaBridge 143:86740a56073b 84 *
AnnaBridge 143:86740a56073b 85 * @param[in, out] p_mutex Pointer to the mutex group.
AnnaBridge 143:86740a56073b 86 * @param[in] mutex_size The size of the mutex group.
AnnaBridge 143:86740a56073b 87 *
AnnaBridge 143:86740a56073b 88 * @return The first unlocked mutex id in the group.
AnnaBridge 143:86740a56073b 89 * @retval group-size if there was no unlocked mutex available.
AnnaBridge 143:86740a56073b 90 */
AnnaBridge 143:86740a56073b 91 uint16_t pm_mutex_lock_first_available(uint8_t * p_mutex, uint16_t mutex_size);
AnnaBridge 143:86740a56073b 92
AnnaBridge 143:86740a56073b 93
AnnaBridge 143:86740a56073b 94 /**@brief Unlocks the mutex specified by the bit id.
AnnaBridge 143:86740a56073b 95 *
AnnaBridge 143:86740a56073b 96 * @param[in, out] p_mutex Pointer to the mutex group.
AnnaBridge 143:86740a56073b 97 * @param[in] mutex_bit_id The bit id of the mutex.
AnnaBridge 143:86740a56073b 98 */
AnnaBridge 143:86740a56073b 99 void pm_mutex_unlock(uint8_t * p_mutex, uint16_t mutex_bit_id);
AnnaBridge 143:86740a56073b 100
AnnaBridge 143:86740a56073b 101
AnnaBridge 143:86740a56073b 102 /**@brief Gets the locking status of the specified mutex.
AnnaBridge 143:86740a56073b 103 *
AnnaBridge 143:86740a56073b 104 * @param[in, out] p_mutex Pointer to the mutex group.
AnnaBridge 143:86740a56073b 105 * @param[in] mutex_bit_id The bit id of the mutex.
AnnaBridge 143:86740a56073b 106 *
AnnaBridge 143:86740a56073b 107 * @retval true if the mutex was locked.
AnnaBridge 143:86740a56073b 108 * @retval false otherwise.
AnnaBridge 143:86740a56073b 109 */
AnnaBridge 143:86740a56073b 110 bool pm_mutex_lock_status_get(uint8_t * p_mutex, uint16_t mutex_bit_id);
AnnaBridge 143:86740a56073b 111
AnnaBridge 143:86740a56073b 112
AnnaBridge 143:86740a56073b 113 #endif // MUTEX_H__
AnnaBridge 143:86740a56073b 114
AnnaBridge 143:86740a56073b 115 /** @}
AnnaBridge 143:86740a56073b 116 * @endcond
AnnaBridge 143:86740a56073b 117 */