Nordic Semiconductor / nRF51822

Nordic stack and drivers for the mbed BLE API

Dependents:   BLE_ANCS_SDAPI BLE_temperature BLE_HeartRate writable_gatt ... more

TARGET_MCU_NRF51822/sdk/source/ble/peer_manager/pm_mutex.h@638:c90ae1400bf2, 2016-09-14 (annotated)

Committer:
Vincent Coubard
Date:
Wed Sep 14 14:39:43 2016 +0100
Revision:
638:c90ae1400bf2
Sync with bdab10dc0f90748b6989c8b577771bb403ca6bd8 from ARMmbed/mbed-os.

Who changed what in which revision?

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