Mustahsin Chowdhury / nRF51822

Nordic stack and drivers for the mbed BLE API

Fork of nRF51822 by Nordic Semiconductor

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

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

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Vincent Coubard 640:c90ae1400bf2 1 /*
Vincent Coubard 640:c90ae1400bf2 2 * Copyright (c) Nordic Semiconductor ASA
Vincent Coubard 640:c90ae1400bf2 3 * All rights reserved.
Vincent Coubard 640:c90ae1400bf2 4 *
Vincent Coubard 640:c90ae1400bf2 5 * Redistribution and use in source and binary forms, with or without modification,
Vincent Coubard 640:c90ae1400bf2 6 * are permitted provided that the following conditions are met:
Vincent Coubard 640:c90ae1400bf2 7 *
Vincent Coubard 640:c90ae1400bf2 8 * 1. Redistributions of source code must retain the above copyright notice, this
Vincent Coubard 640:c90ae1400bf2 9 * list of conditions and the following disclaimer.
Vincent Coubard 640:c90ae1400bf2 10 *
Vincent Coubard 640:c90ae1400bf2 11 * 2. Redistributions in binary form must reproduce the above copyright notice, this
Vincent Coubard 640:c90ae1400bf2 12 * list of conditions and the following disclaimer in the documentation and/or
Vincent Coubard 640:c90ae1400bf2 13 * other materials provided with the distribution.
Vincent Coubard 640:c90ae1400bf2 14 *
Vincent Coubard 640:c90ae1400bf2 15 * 3. Neither the name of Nordic Semiconductor ASA nor the names of other
Vincent Coubard 640:c90ae1400bf2 16 * contributors to this software may be used to endorse or promote products
Vincent Coubard 640:c90ae1400bf2 17 * derived from this software without specific prior written permission.
Vincent Coubard 640:c90ae1400bf2 18 *
Vincent Coubard 640:c90ae1400bf2 19 *
Vincent Coubard 640:c90ae1400bf2 20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
Vincent Coubard 640:c90ae1400bf2 21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
Vincent Coubard 640:c90ae1400bf2 22 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
Vincent Coubard 640:c90ae1400bf2 23 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
Vincent Coubard 640:c90ae1400bf2 24 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
Vincent Coubard 640:c90ae1400bf2 25 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
Vincent Coubard 640:c90ae1400bf2 26 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
Vincent Coubard 640:c90ae1400bf2 27 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
Vincent Coubard 640:c90ae1400bf2 28 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
Vincent Coubard 640:c90ae1400bf2 29 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Vincent Coubard 640:c90ae1400bf2 30 *
Vincent Coubard 640:c90ae1400bf2 31 */
Vincent Coubard 640:c90ae1400bf2 32
Vincent Coubard 640:c90ae1400bf2 33
Vincent Coubard 640:c90ae1400bf2 34 #ifndef PEER_DATA_H__
Vincent Coubard 640:c90ae1400bf2 35 #define PEER_DATA_H__
Vincent Coubard 640:c90ae1400bf2 36
Vincent Coubard 640:c90ae1400bf2 37 #include <stdint.h>
Vincent Coubard 640:c90ae1400bf2 38 #include "peer_manager_types.h"
Vincent Coubard 640:c90ae1400bf2 39 #include "fds.h"
Vincent Coubard 640:c90ae1400bf2 40
Vincent Coubard 640:c90ae1400bf2 41
Vincent Coubard 640:c90ae1400bf2 42 /**
Vincent Coubard 640:c90ae1400bf2 43 * @defgroup peer_data Peer Data
Vincent Coubard 640:c90ae1400bf2 44 * @ingroup peer_manager
Vincent Coubard 640:c90ae1400bf2 45 * @{
Vincent Coubard 640:c90ae1400bf2 46 * @brief An internal module of @ref peer_manager. This module defines the structure of the data
Vincent Coubard 640:c90ae1400bf2 47 * that is managed by the @ref peer_manager. It also provides functions for parsing the data.
Vincent Coubard 640:c90ae1400bf2 48 */
Vincent Coubard 640:c90ae1400bf2 49
Vincent Coubard 640:c90ae1400bf2 50
Vincent Coubard 640:c90ae1400bf2 51 /**@brief Function for enumerating the separate (non-contiguous) parts of the peer data.
Vincent Coubard 640:c90ae1400bf2 52 *
Vincent Coubard 640:c90ae1400bf2 53 * @param[in] p_peer_data The peer data to enumerate.
Vincent Coubard 640:c90ae1400bf2 54 * @param[out] p_chunks The resulting chunks. This must be an array of at least 2 elements.
Vincent Coubard 640:c90ae1400bf2 55 * @param[out] p_n_chunks The number of chunks. If this is 0, something went wrong.
Vincent Coubard 640:c90ae1400bf2 56 */
Vincent Coubard 640:c90ae1400bf2 57 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);
Vincent Coubard 640:c90ae1400bf2 58
Vincent Coubard 640:c90ae1400bf2 59
Vincent Coubard 640:c90ae1400bf2 60 /**@brief Function for converting @ref pm_peer_data_flash_t into @ref pm_peer_data_t.
Vincent Coubard 640:c90ae1400bf2 61 *
Vincent Coubard 640:c90ae1400bf2 62 * @param[in] p_in_data The source data.
Vincent Coubard 640:c90ae1400bf2 63 * @param[out] p_out_data The target data structure.
Vincent Coubard 640:c90ae1400bf2 64 *
Vincent Coubard 640:c90ae1400bf2 65 * @retval NRF_SUCCESS Successful conversion.
Vincent Coubard 640:c90ae1400bf2 66 * @retval NRF_ERROR_NULL A parameter was NULL.
Vincent Coubard 640:c90ae1400bf2 67 * @retval NRF_ERROR_NO_MEM A buffer was not large enough.
Vincent Coubard 640:c90ae1400bf2 68 */
Vincent Coubard 640:c90ae1400bf2 69 ret_code_t peer_data_deserialize(pm_peer_data_flash_t const * p_in_data, pm_peer_data_t * p_out_data);
Vincent Coubard 640:c90ae1400bf2 70
Vincent Coubard 640:c90ae1400bf2 71 /** @} */
Vincent Coubard 640:c90ae1400bf2 72
Vincent Coubard 640:c90ae1400bf2 73 #endif /* PEER_DATA_H__ */