Fawwaz Nadzmy / mbed-STM

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.

Fork of mbed-dev by mbed official

targets/hal/TARGET_NORDIC/TARGET_NRF5/sdk/ble/peer_manager/peer_id.h@144:ef7eb2e8f9f7, 2016-09-02 (annotated)

Committer:
<>
Date:
Fri Sep 02 15:07:44 2016 +0100
Revision:
144:ef7eb2e8f9f7
This updates the lib to the mbed lib v125

Who changed what in which revision?

UserRevisionLine numberNew contents of line
<> 144:ef7eb2e8f9f7 1 /*
<> 144:ef7eb2e8f9f7 2 * Copyright (c) 2015 Nordic Semiconductor ASA
<> 144:ef7eb2e8f9f7 3 * All rights reserved.
<> 144:ef7eb2e8f9f7 4 *
<> 144:ef7eb2e8f9f7 5 * Redistribution and use in source and binary forms, with or without modification,
<> 144:ef7eb2e8f9f7 6 * are permitted provided that the following conditions are met:
<> 144:ef7eb2e8f9f7 7 *
<> 144:ef7eb2e8f9f7 8 * 1. Redistributions of source code must retain the above copyright notice, this list
<> 144:ef7eb2e8f9f7 9 * of conditions and the following disclaimer.
<> 144:ef7eb2e8f9f7 10 *
<> 144:ef7eb2e8f9f7 11 * 2. Redistributions in binary form, except as embedded into a Nordic Semiconductor ASA
<> 144:ef7eb2e8f9f7 12 * integrated circuit in a product or a software update for such product, must reproduce
<> 144:ef7eb2e8f9f7 13 * the above copyright notice, this list of conditions and the following disclaimer in
<> 144:ef7eb2e8f9f7 14 * the documentation and/or other materials provided with the distribution.
<> 144:ef7eb2e8f9f7 15 *
<> 144:ef7eb2e8f9f7 16 * 3. Neither the name of Nordic Semiconductor ASA nor the names of its contributors may be
<> 144:ef7eb2e8f9f7 17 * used to endorse or promote products derived from this software without specific prior
<> 144:ef7eb2e8f9f7 18 * written permission.
<> 144:ef7eb2e8f9f7 19 *
<> 144:ef7eb2e8f9f7 20 * 4. This software, with or without modification, must only be used with a
<> 144:ef7eb2e8f9f7 21 * Nordic Semiconductor ASA integrated circuit.
<> 144:ef7eb2e8f9f7 22 *
<> 144:ef7eb2e8f9f7 23 * 5. Any software provided in binary or object form under this license must not be reverse
<> 144:ef7eb2e8f9f7 24 * engineered, decompiled, modified and/or disassembled.
<> 144:ef7eb2e8f9f7 25 *
<> 144:ef7eb2e8f9f7 26 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
<> 144:ef7eb2e8f9f7 27 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
<> 144:ef7eb2e8f9f7 28 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
<> 144:ef7eb2e8f9f7 29 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
<> 144:ef7eb2e8f9f7 30 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
<> 144:ef7eb2e8f9f7 31 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
<> 144:ef7eb2e8f9f7 32 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
<> 144:ef7eb2e8f9f7 33 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
<> 144:ef7eb2e8f9f7 34 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
<> 144:ef7eb2e8f9f7 35 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
<> 144:ef7eb2e8f9f7 36 *
<> 144:ef7eb2e8f9f7 37 */
<> 144:ef7eb2e8f9f7 38
<> 144:ef7eb2e8f9f7 39
<> 144:ef7eb2e8f9f7 40
<> 144:ef7eb2e8f9f7 41 #ifndef PEER_ID_H__
<> 144:ef7eb2e8f9f7 42 #define PEER_ID_H__
<> 144:ef7eb2e8f9f7 43
<> 144:ef7eb2e8f9f7 44
<> 144:ef7eb2e8f9f7 45 #include <stdint.h>
<> 144:ef7eb2e8f9f7 46 #include "sdk_errors.h"
<> 144:ef7eb2e8f9f7 47 #include "nrf_ble_gap.h"
<> 144:ef7eb2e8f9f7 48 #include "peer_manager_types.h"
<> 144:ef7eb2e8f9f7 49
<> 144:ef7eb2e8f9f7 50
<> 144:ef7eb2e8f9f7 51 /**
<> 144:ef7eb2e8f9f7 52 * @cond NO_DOXYGEN
<> 144:ef7eb2e8f9f7 53 * @defgroup peer_id Peer IDs
<> 144:ef7eb2e8f9f7 54 * @ingroup peer_manager
<> 144:ef7eb2e8f9f7 55 * @{
<> 144:ef7eb2e8f9f7 56 * @brief An internal module of @ref peer_manager. This module keeps track of which peer IDs are in
<> 144:ef7eb2e8f9f7 57 * use and which are free.
<> 144:ef7eb2e8f9f7 58 */
<> 144:ef7eb2e8f9f7 59
<> 144:ef7eb2e8f9f7 60
<> 144:ef7eb2e8f9f7 61 /**@brief Function for initializing the module.
<> 144:ef7eb2e8f9f7 62 */
<> 144:ef7eb2e8f9f7 63 void peer_id_init(void);
<> 144:ef7eb2e8f9f7 64
<> 144:ef7eb2e8f9f7 65
<> 144:ef7eb2e8f9f7 66 /**@brief Function for claiming an unused peer ID.
<> 144:ef7eb2e8f9f7 67 *
<> 144:ef7eb2e8f9f7 68 * @param peer_id The peer ID to allocate. If this is @ref PM_PEER_ID_INVALID, the first available
<> 144:ef7eb2e8f9f7 69 * will be allocated.
<> 144:ef7eb2e8f9f7 70 *
<> 144:ef7eb2e8f9f7 71 * @return The allocated peer ID.
<> 144:ef7eb2e8f9f7 72 * @retval PM_PEER_ID_INVALID If no peer ID could be allocated or module is not initialized.
<> 144:ef7eb2e8f9f7 73 */
<> 144:ef7eb2e8f9f7 74 pm_peer_id_t peer_id_allocate(pm_peer_id_t peer_id);
<> 144:ef7eb2e8f9f7 75
<> 144:ef7eb2e8f9f7 76
<> 144:ef7eb2e8f9f7 77 /**@brief Function for marking a peer ID for deletion.
<> 144:ef7eb2e8f9f7 78 *
<> 144:ef7eb2e8f9f7 79 * @param peer_id The peer ID to delete.
<> 144:ef7eb2e8f9f7 80 *
<> 144:ef7eb2e8f9f7 81 * @retval true Deletion was successful.
<> 144:ef7eb2e8f9f7 82 * @retval false Peer ID already marked for deletion, peer_id was PM_PEER_ID_INVALID, or module is
<> 144:ef7eb2e8f9f7 83 * not initialized.
<> 144:ef7eb2e8f9f7 84 */
<> 144:ef7eb2e8f9f7 85 bool peer_id_delete(pm_peer_id_t peer_id);
<> 144:ef7eb2e8f9f7 86
<> 144:ef7eb2e8f9f7 87
<> 144:ef7eb2e8f9f7 88 /**@brief Function for freeing a peer ID and clearing all data associated with it in persistent
<> 144:ef7eb2e8f9f7 89 * storage.
<> 144:ef7eb2e8f9f7 90 *
<> 144:ef7eb2e8f9f7 91 * @param[in] peer_id Peer ID to free.
<> 144:ef7eb2e8f9f7 92 */
<> 144:ef7eb2e8f9f7 93 void peer_id_free(pm_peer_id_t peer_id);
<> 144:ef7eb2e8f9f7 94
<> 144:ef7eb2e8f9f7 95
<> 144:ef7eb2e8f9f7 96 /**@brief Function for finding out whether a peer ID is marked for deletion.
<> 144:ef7eb2e8f9f7 97 *
<> 144:ef7eb2e8f9f7 98 * @param[in] peer_id The peer ID to inquire about.
<> 144:ef7eb2e8f9f7 99 *
<> 144:ef7eb2e8f9f7 100 * @retval true peer_id is in marked for deletion.
<> 144:ef7eb2e8f9f7 101 * @retval false peer_id is not marked for deletion, or the module is not initialized.
<> 144:ef7eb2e8f9f7 102 */
<> 144:ef7eb2e8f9f7 103 bool peer_id_is_deleted(pm_peer_id_t peer_id);
<> 144:ef7eb2e8f9f7 104
<> 144:ef7eb2e8f9f7 105
<> 144:ef7eb2e8f9f7 106 /**@brief Function for finding out whether a peer ID is in use.
<> 144:ef7eb2e8f9f7 107 *
<> 144:ef7eb2e8f9f7 108 * @param[in] peer_id The peer ID to inquire about.
<> 144:ef7eb2e8f9f7 109 *
<> 144:ef7eb2e8f9f7 110 * @retval true peer_id is in use.
<> 144:ef7eb2e8f9f7 111 * @retval false peer_id is free, or the module is not initialized.
<> 144:ef7eb2e8f9f7 112 */
<> 144:ef7eb2e8f9f7 113 bool peer_id_is_allocated(pm_peer_id_t peer_id);
<> 144:ef7eb2e8f9f7 114
<> 144:ef7eb2e8f9f7 115
<> 144:ef7eb2e8f9f7 116 /**@brief Function for getting the next peer ID in the sequence of all used peer IDs. Can be
<> 144:ef7eb2e8f9f7 117 * used to loop through all used peer IDs.
<> 144:ef7eb2e8f9f7 118 *
<> 144:ef7eb2e8f9f7 119 * @note @ref PM_PEER_ID_INVALID is considered to be before the first and after the last ordinary
<> 144:ef7eb2e8f9f7 120 * peer ID.
<> 144:ef7eb2e8f9f7 121 *
<> 144:ef7eb2e8f9f7 122 * @param[in] prev_peer_id The previous peer ID.
<> 144:ef7eb2e8f9f7 123 *
<> 144:ef7eb2e8f9f7 124 * @return The next peer ID.
<> 144:ef7eb2e8f9f7 125 * @return The first used peer ID if prev_peer_id was @ref PM_PEER_ID_INVALID.
<> 144:ef7eb2e8f9f7 126 * @retval PM_PEER_ID_INVALID if prev_peer_id was the last ordinary peer ID or the module is
<> 144:ef7eb2e8f9f7 127 * not initialized.
<> 144:ef7eb2e8f9f7 128 */
<> 144:ef7eb2e8f9f7 129 pm_peer_id_t peer_id_get_next_used(pm_peer_id_t prev_peer_id);
<> 144:ef7eb2e8f9f7 130
<> 144:ef7eb2e8f9f7 131
<> 144:ef7eb2e8f9f7 132 /**@brief Function for getting the next peer ID in the sequence of all peer IDs marked for deletion.
<> 144:ef7eb2e8f9f7 133 * Can be used to loop through all peer IDs marked for deletion.
<> 144:ef7eb2e8f9f7 134 *
<> 144:ef7eb2e8f9f7 135 * @note @ref PM_PEER_ID_INVALID is considered to be before the first and after the last ordinary
<> 144:ef7eb2e8f9f7 136 * peer ID.
<> 144:ef7eb2e8f9f7 137 *
<> 144:ef7eb2e8f9f7 138 * @param[in] prev_peer_id The previous peer ID.
<> 144:ef7eb2e8f9f7 139 *
<> 144:ef7eb2e8f9f7 140 * @return The next peer ID.
<> 144:ef7eb2e8f9f7 141 * @return The first used peer ID if prev_peer_id was @ref PM_PEER_ID_INVALID.
<> 144:ef7eb2e8f9f7 142 * @retval PM_PEER_ID_INVALID if prev_peer_id was the last ordinary peer ID or the module is
<> 144:ef7eb2e8f9f7 143 * not initialized.
<> 144:ef7eb2e8f9f7 144 */
<> 144:ef7eb2e8f9f7 145 pm_peer_id_t peer_id_get_next_deleted(pm_peer_id_t prev_peer_id);
<> 144:ef7eb2e8f9f7 146
<> 144:ef7eb2e8f9f7 147
<> 144:ef7eb2e8f9f7 148 /**@brief Function for querying the number of valid peer IDs available. I.E the number of peers
<> 144:ef7eb2e8f9f7 149 * in persistent storage.
<> 144:ef7eb2e8f9f7 150 *
<> 144:ef7eb2e8f9f7 151 * @return The number of valid peer IDs, or 0 if module is not initialized.
<> 144:ef7eb2e8f9f7 152 */
<> 144:ef7eb2e8f9f7 153 uint32_t peer_id_n_ids(void);
<> 144:ef7eb2e8f9f7 154
<> 144:ef7eb2e8f9f7 155 /** @}
<> 144:ef7eb2e8f9f7 156 * @endcond
<> 144:ef7eb2e8f9f7 157 */
<> 144:ef7eb2e8f9f7 158
<> 144:ef7eb2e8f9f7 159 #endif /* PEER_ID_H__ */