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_TY51822R3/TOOLCHAIN_IAR/peer_data.h@171:3a7713b1edbc, 2018-11-08 (annotated)
- Committer:
- AnnaBridge
- Date:
- Thu Nov 08 11:45:42 2018 +0000
- Revision:
- 171:3a7713b1edbc
- Parent:
- TARGET_NRF51_DK/TARGET_NORDIC/TARGET_NRF5x/TARGET_SDK_11/ble/peer_manager/peer_data.h@169:a7c7b631e539
mbed library. Release version 164
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
Kojto | 148:fd96258d940d | 1 | /* |
Kojto | 148:fd96258d940d | 2 | * Copyright (c) 2015 Nordic Semiconductor ASA |
Kojto | 148:fd96258d940d | 3 | * All rights reserved. |
Kojto | 148:fd96258d940d | 4 | * |
Kojto | 148:fd96258d940d | 5 | * Redistribution and use in source and binary forms, with or without modification, |
Kojto | 148:fd96258d940d | 6 | * are permitted provided that the following conditions are met: |
Kojto | 148:fd96258d940d | 7 | * |
Kojto | 148:fd96258d940d | 8 | * 1. Redistributions of source code must retain the above copyright notice, this list |
Kojto | 148:fd96258d940d | 9 | * of conditions and the following disclaimer. |
Kojto | 148:fd96258d940d | 10 | * |
Kojto | 148:fd96258d940d | 11 | * 2. Redistributions in binary form, except as embedded into a Nordic Semiconductor ASA |
Kojto | 148:fd96258d940d | 12 | * integrated circuit in a product or a software update for such product, must reproduce |
Kojto | 148:fd96258d940d | 13 | * the above copyright notice, this list of conditions and the following disclaimer in |
Kojto | 148:fd96258d940d | 14 | * the documentation and/or other materials provided with the distribution. |
Kojto | 148:fd96258d940d | 15 | * |
Kojto | 148:fd96258d940d | 16 | * 3. Neither the name of Nordic Semiconductor ASA nor the names of its contributors may be |
Kojto | 148:fd96258d940d | 17 | * used to endorse or promote products derived from this software without specific prior |
Kojto | 148:fd96258d940d | 18 | * written permission. |
Kojto | 148:fd96258d940d | 19 | * |
Kojto | 148:fd96258d940d | 20 | * 4. This software, with or without modification, must only be used with a |
Kojto | 148:fd96258d940d | 21 | * Nordic Semiconductor ASA integrated circuit. |
Kojto | 148:fd96258d940d | 22 | * |
Kojto | 148:fd96258d940d | 23 | * 5. Any software provided in binary or object form under this license must not be reverse |
Kojto | 148:fd96258d940d | 24 | * engineered, decompiled, modified and/or disassembled. |
Kojto | 148:fd96258d940d | 25 | * |
Kojto | 148:fd96258d940d | 26 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND |
Kojto | 148:fd96258d940d | 27 | * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED |
Kojto | 148:fd96258d940d | 28 | * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
Kojto | 148:fd96258d940d | 29 | * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR |
Kojto | 148:fd96258d940d | 30 | * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES |
Kojto | 148:fd96258d940d | 31 | * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; |
Kojto | 148:fd96258d940d | 32 | * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON |
Kojto | 148:fd96258d940d | 33 | * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
Kojto | 148:fd96258d940d | 34 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS |
Kojto | 148:fd96258d940d | 35 | * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
Kojto | 148:fd96258d940d | 36 | * |
Kojto | 148:fd96258d940d | 37 | */ |
Kojto | 148:fd96258d940d | 38 | |
Kojto | 148:fd96258d940d | 39 | |
Kojto | 148:fd96258d940d | 40 | |
Kojto | 148:fd96258d940d | 41 | #ifndef PEER_DATA_H__ |
Kojto | 148:fd96258d940d | 42 | #define PEER_DATA_H__ |
Kojto | 148:fd96258d940d | 43 | |
Kojto | 148:fd96258d940d | 44 | #include <stdint.h> |
Kojto | 148:fd96258d940d | 45 | #include "peer_manager_types.h" |
Kojto | 148:fd96258d940d | 46 | #include "peer_manager_internal.h" |
Kojto | 148:fd96258d940d | 47 | #include "fds.h" |
Kojto | 148:fd96258d940d | 48 | |
Kojto | 148:fd96258d940d | 49 | |
Kojto | 148:fd96258d940d | 50 | /** |
Kojto | 148:fd96258d940d | 51 | * @cond NO_DOXYGEN |
Kojto | 148:fd96258d940d | 52 | * @defgroup peer_data Peer Data |
Kojto | 148:fd96258d940d | 53 | * @ingroup peer_manager |
Kojto | 148:fd96258d940d | 54 | * @{ |
Kojto | 148:fd96258d940d | 55 | * @brief An internal module of @ref peer_manager. This module defines the structure of the data |
Kojto | 148:fd96258d940d | 56 | * that is managed by the @ref peer_manager. It also provides functions for parsing the data. |
Kojto | 148:fd96258d940d | 57 | */ |
Kojto | 148:fd96258d940d | 58 | |
Kojto | 148:fd96258d940d | 59 | |
Kojto | 148:fd96258d940d | 60 | /**@brief Function for enumerating the separate (non-contiguous) parts of the peer data. |
Kojto | 148:fd96258d940d | 61 | * |
Kojto | 148:fd96258d940d | 62 | * @param[in] p_peer_data The peer data to enumerate. |
Kojto | 148:fd96258d940d | 63 | * @param[out] p_chunks The resulting chunks. This must be an array of at least 2 elements. |
Kojto | 148:fd96258d940d | 64 | * @param[out] p_n_chunks The number of chunks. If this is 0, something went wrong. |
Kojto | 148:fd96258d940d | 65 | */ |
Kojto | 148:fd96258d940d | 66 | void peer_data_parts_get(pm_peer_data_const_t const * p_peer_data, fds_record_chunk_t * p_chunks, uint16_t * p_n_chunks); |
Kojto | 148:fd96258d940d | 67 | |
Kojto | 148:fd96258d940d | 68 | |
Kojto | 148:fd96258d940d | 69 | /**@brief Function for converting @ref pm_peer_data_flash_t into @ref pm_peer_data_t. |
Kojto | 148:fd96258d940d | 70 | * |
Kojto | 148:fd96258d940d | 71 | * @param[in] p_in_data The source data. |
Kojto | 148:fd96258d940d | 72 | * @param[out] p_out_data The target data structure. |
Kojto | 148:fd96258d940d | 73 | * |
Kojto | 148:fd96258d940d | 74 | * @retval NRF_SUCCESS Successful conversion. |
Kojto | 148:fd96258d940d | 75 | * @retval NRF_ERROR_NULL A parameter was NULL. |
Kojto | 148:fd96258d940d | 76 | * @retval NRF_ERROR_NO_MEM A buffer was not large enough. |
Kojto | 148:fd96258d940d | 77 | */ |
Kojto | 148:fd96258d940d | 78 | ret_code_t peer_data_deserialize(pm_peer_data_flash_t const * p_in_data, pm_peer_data_t * p_out_data); |
Kojto | 148:fd96258d940d | 79 | |
Kojto | 148:fd96258d940d | 80 | /** @} |
Kojto | 148:fd96258d940d | 81 | * @endcond |
Kojto | 148:fd96258d940d | 82 | */ |
Kojto | 148:fd96258d940d | 83 | |
Kojto | 148:fd96258d940d | 84 | #endif /* PEER_DATA_H__ */ |