xiaozhengsheng/HL-PDJ-1
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

初始版本

Browse Source
This commit is contained in:
xiaozhengsheng
2025-08-19 09:49:41 +08:00
parent 10f1ddf1c1
commit 6df0f7d96e
2974 changed files with 1712873 additions and 54 deletions
Download Patch File Download Diff File Expand all files Collapse all files

205
components/nfc/ndef/conn_hand_parser/ac_rec_parser/nfc_ac_rec_parser.c Normal file
View File

@@ -0,0 +1,205 @@
/**
* Copyright (c) 2016 - 2020, Nordic Semiconductor ASA
*
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification,
* are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form, except as embedded into a Nordic
* Semiconductor ASA integrated circuit in a product or a software update for
* such product, must reproduce the above copyright notice, this list of
* conditions and the following disclaimer in the documentation and/or other
* materials provided with the distribution.
*
* 3. Neither the name of Nordic Semiconductor ASA nor the names of its
* contributors may be used to endorse or promote products derived from this
* software without specific prior written permission.
*
* 4. This software, with or without modification, must only be used with a
* Nordic Semiconductor ASA integrated circuit.
*
* 5. Any software provided in binary form under this license must not be reverse
* engineered, decompiled, modified and/or disassembled.
*
* THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
* OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
* GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
*/
#include "sdk_common.h"
#if NRF_MODULE_ENABLED(NFC_AC_REC_PARSER)
#include "nfc_ac_rec_parser.h"
#include "sdk_macros.h"
/**
* @brief Function for parsing Data Reference field inside Alternative Carrier record payload.
*
* This function parses Data Reference field inside Alternative Carrier record payload and extracts
* its descriptor.
*
* @param[in,out] pp_buff Pointer to pointer to the remaining payload data.
* @param[in,out] p_len Pointer to the length of remaining payload data.
* @param[in,out] p_ref_field Pointer to the structure that will be used to hold
* parsed data.
*
* @retval NRF_SUCCESS If the function completed successfully.
* @retval NRF_ERROR_NULL If provided buffer for Data Reference in \p p_ref_field is
* null.
* @retval NRF_ERROR_NO_MEM If the buffer provided for Data Reference in \p p_ref_field
* does not have enough space to store it.
* @retval NRF_ERROR_INVALID_LENGTH If Data Reference length exceeds record payload.
*/
static ret_code_t ac_rec_reference_field_parse(uint8_t ** const pp_buff,
uint32_t * const p_len,
nfc_ac_rec_data_ref_t * const p_ref_field)
{
if (p_ref_field->length < **pp_buff)
{
return NRF_ERROR_NO_MEM;
}
p_ref_field->length = **pp_buff;
*pp_buff += AC_REC_DATA_REF_LEN_SIZE;
(*p_len) -= AC_REC_DATA_REF_LEN_SIZE;
if (*p_len < p_ref_field->length)
{
return NRF_ERROR_INVALID_LENGTH;
}
VERIFY_PARAM_NOT_NULL(p_ref_field->p_data);
memcpy( p_ref_field->p_data,
*pp_buff,
p_ref_field->length );
*pp_buff += p_ref_field->length;
(*p_len) -= p_ref_field->length;
return NRF_SUCCESS;
}
/**
* @brief Function for parsing Alternative Carrier record payload.
*
* This function parses Alternative Carrier record payload and extracts its payload descriptor.
*
* @param[in] p_buff Pointer to the record payload.
* @param[in] p_len Pointer to the record payload length.
* @param[in,out] p_ac_rec_payload_data Pointer to the structure that will be used to hold
* parsed data.
*
* @retval NRF_SUCCESS If the function completed successfully.
* @retval NRF_ERROR_NULL If any provided arguments or any needed buffers stored in
* \p p_ac_rec_payload_data are nulls.
* @retval NRF_ERROR_NO_MEM If any from provided buffers does not have enough space
* to store its data.
* @retval NRF_ERROR_INVALID_LENGTH If any length field exceeds record payload.
* @retval NRF_ERROR_INVALID_PARAM If Carrier Power State field has incorrect value.
*/
static ret_code_t nfc_ac_payload_parse(uint8_t * p_buff,
uint32_t * const p_len,
nfc_ac_rec_payload_desc_t * const p_ac_rec_payload_data)
{
if ( (p_buff == NULL) || (p_len == NULL) || (p_ac_rec_payload_data == NULL) )
{
return NRF_ERROR_NULL;
}
if (*p_len < AC_REC_CPS_BYTE_SIZE + AC_REC_DATA_REF_LEN_SIZE + AC_REC_AUX_DATA_REF_COUNT_SIZE)
{
return NRF_ERROR_INVALID_LENGTH;
}
// Copy CPS to ac record payload descriptor.
if (*p_buff & ~NFC_AC_CPS_MASK)
{
return NRF_ERROR_INVALID_PARAM;
}
p_ac_rec_payload_data->cps = (nfc_ac_rec_cps_t) *p_buff;
p_buff += AC_REC_CPS_BYTE_SIZE;
(*p_len) -= AC_REC_CPS_BYTE_SIZE;
// Copy Carrier Data Reference to ac record payload descriptor.
ret_code_t err_code = ac_rec_reference_field_parse(&p_buff,
p_len,
&p_ac_rec_payload_data->carrier_data_ref);
VERIFY_SUCCESS(err_code);
// Copy Auxiliary Data Reference to ac record payload descriptor.
if ( p_ac_rec_payload_data->aux_data_ref_count < *p_buff)
{
return NRF_ERROR_NO_MEM;
}
p_ac_rec_payload_data->aux_data_ref_count = *p_buff;
p_buff += AC_REC_AUX_DATA_REF_COUNT_SIZE;
(*p_len) -= AC_REC_AUX_DATA_REF_COUNT_SIZE;
if (p_ac_rec_payload_data->aux_data_ref_count != 0)
{
VERIFY_PARAM_NOT_NULL(p_ac_rec_payload_data->p_aux_data_ref);
}
for (uint8_t i = 0; i < p_ac_rec_payload_data->aux_data_ref_count; i++)
{
err_code = ac_rec_reference_field_parse(&p_buff,
p_len,
&(p_ac_rec_payload_data->p_aux_data_ref[i]));
VERIFY_SUCCESS(err_code);
}
// Check if all payload data were parsed.
if (*p_len != 0)
{
return NRF_ERROR_INVALID_LENGTH;
}
return NRF_SUCCESS;
}
ret_code_t nfc_ac_rec_parse(nfc_ndef_record_desc_t const * const p_rec_desc,
nfc_ac_rec_payload_desc_t * const p_ac_rec_payload_data)
{
ret_code_t err_code;
if (p_rec_desc->tnf != TNF_WELL_KNOWN)
{
return NRF_ERROR_INVALID_DATA;
}
if (p_rec_desc->type_length != sizeof(nfc_ac_rec_type_field))
{
return NRF_ERROR_INVALID_DATA;
}
if (memcmp(p_rec_desc->p_type, nfc_ac_rec_type_field, sizeof(nfc_ac_rec_type_field)) != 0)
{
return NRF_ERROR_INVALID_DATA;
}
if (p_rec_desc->payload_constructor != (p_payload_constructor_t) nfc_ndef_bin_payload_memcopy)
{
return NRF_ERROR_NOT_SUPPORTED;
}
uint8_t const * p_payload =
((nfc_ndef_bin_payload_desc_t *)(p_rec_desc->p_payload_descriptor))->p_payload;
uint32_t payload_length =
((nfc_ndef_bin_payload_desc_t *)(p_rec_desc->p_payload_descriptor))->payload_length;
err_code = nfc_ac_payload_parse((uint8_t *) p_payload,
&payload_length,
p_ac_rec_payload_data);
return err_code;
}
#endif // NRF_MODULE_ENABLED(NFC_AC_REC_PARSER)

88
components/nfc/ndef/conn_hand_parser/ac_rec_parser/nfc_ac_rec_parser.h Normal file
View File

@@ -0,0 +1,88 @@
/**
* Copyright (c) 2016 - 2020, Nordic Semiconductor ASA
*
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification,
* are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form, except as embedded into a Nordic
* Semiconductor ASA integrated circuit in a product or a software update for
* such product, must reproduce the above copyright notice, this list of
* conditions and the following disclaimer in the documentation and/or other
* materials provided with the distribution.
*
* 3. Neither the name of Nordic Semiconductor ASA nor the names of its
* contributors may be used to endorse or promote products derived from this
* software without specific prior written permission.
*
* 4. This software, with or without modification, must only be used with a
* Nordic Semiconductor ASA integrated circuit.
*
* 5. Any software provided in binary form under this license must not be reverse
* engineered, decompiled, modified and/or disassembled.
*
* THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
* OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
* GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
*/
/** @file
*
* @defgroup nfc_ac_rec_parser Alternative Carrier records parser
* @{
* @ingroup nfc_ble_pair_msg
* @brief Functions for parsing and decoding Alternative Carrier records.
*/
#ifndef __NFC_AC_REC_PARSER_H__
#define __NFC_AC_REC_PARSER_H__
#include "nfc_ndef_record.h"
#include "nfc_ac_rec.h"
#ifdef __cplusplus
extern "C" {
#endif
/**
* @brief Function for parsing general record description as Alternative Carrier record.
*
* This function checks if record description matches the Alternative Carrier record and extracts
* its payload structure. It is required for the record description to use binary payload
* descriptor.
*
* @param[in] p_rec_desc Pointer to the record descriptor.
* @param[in,out] p_ac_rec_payload_data Pointer to the structure that will be used to hold
* parsed data.
*
* @retval NRF_SUCCESS If the function completed successfully.
* @retval NRF_ERROR_INVALID_DATA If the NDEF record type or TNF is incorrect.
* @retval NRF_ERROR_NOT_SUPPORTED If the payload descriptor is not binary.
* @retval NRF_ERROR_NULL If any provided arguments or any needed buffers stored in
* \p p_ac_rec_payload_data are nulls.
* @retval NRF_ERROR_NO_MEM If any from provided buffers does not have enough space
* to store its data.
* @retval NRF_ERROR_INVALID_LENGTH If any length field exceeds record payload.
* @retval NRF_ERROR_INVALID_PARAM If Carrier Power State field has incorrect value.
*/
ret_code_t nfc_ac_rec_parse(nfc_ndef_record_desc_t const * const p_rec_desc,
nfc_ac_rec_payload_desc_t * const p_ac_rec_payload_data);
#ifdef __cplusplus
}
#endif
#endif // __NFC_AC_REC_PARSER_H__
/** @} */

524
components/nfc/ndef/conn_hand_parser/ble_oob_advdata_parser/nfc_ble_oob_advdata_parser.c Normal file
View File

@@ -0,0 +1,524 @@
/**
* Copyright (c) 2016 - 2020, Nordic Semiconductor ASA
*
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification,
* are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form, except as embedded into a Nordic
* Semiconductor ASA integrated circuit in a product or a software update for
* such product, must reproduce the above copyright notice, this list of
* conditions and the following disclaimer in the documentation and/or other
* materials provided with the distribution.
*
* 3. Neither the name of Nordic Semiconductor ASA nor the names of its
* contributors may be used to endorse or promote products derived from this
* software without specific prior written permission.
*
* 4. This software, with or without modification, must only be used with a
* Nordic Semiconductor ASA integrated circuit.
*
* 5. Any software provided in binary form under this license must not be reverse
* engineered, decompiled, modified and/or disassembled.
*
* THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
* OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
* GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
*/
#include "sdk_common.h"
#if NRF_MODULE_ENABLED(NFC_BLE_OOB_ADVDATA_PARSER)
#include "nfc_ble_oob_advdata_parser.h"
#include "app_util.h"
#include "nfc_ble_pair_common.h"
#define NRF_LOG_MODULE_NAME ble_oob_ad_parser
#include "nrf_log.h"
NRF_LOG_MODULE_REGISTER();
/* Workaround for using NRF_LOG_RAW_INFO() macro only when logging level is "DEBUG" */
#if (NRF_LOG_LEVEL > 3)
#define NRF_BLE_OOB_AD_PARSER_LOG_DEBUG(...) NRF_LOG_RAW_INFO(__VA_ARGS__)
#else // (NRF_LOG_LEVEL > 3)
#define NRF_BLE_OOB_AD_PARSER_LOG_DEBUG(...)
#endif // (NRF_LOG_LEVEL > 3)
#define EARLY_TERMINATOR 0 /* Value of AD Structure Length field indicating an early
termination of Advertising or Scan Response Data. */
#define FIELD_LEN_INC_VAL 1 /* Incorrect Value of AD Structure Length field. */
/** @brief Values used with @ref ad_type_counter_t. */
typedef enum
{
AD_TYPE_NOT_PRESENT = 0, /* Value indicating that AD type is not present. */
AD_TYPE_OCCUR_THRES = 1 /* Maximal occurrence number of any AD type within the buffer */
} ad_type_counter_values_t;
/**@brief Internal module structure indicating how many BLE AD fields of the same type are in the buffer. */
typedef struct
{
uint8_t name_type; /* Number of Short and Full Device Name AD Structures. */
uint8_t addr_type; /* Number of LE Bluetooth Device Address AD Structures. */
uint8_t appear_type; /* Number of Appearance AD Structures. */
uint8_t flags_type; /* Number of Flags AD Structures. */
uint8_t le_role_type; /* Number of LE Role AD Structures. */
uint8_t tk_type; /* Number of Security Manager TK AD Structures. */
uint8_t sec_mgr_oob_flags_type; /* Number of Security Manager OOB Flags AD Structures. */
uint8_t lesc_confirm_type; /* Number of LESC OOB Confirmation Value AD Structures. */
uint8_t lesc_random_type; /* Number of LESC OOB Random Value AD Structures. */
} ad_type_counter_t;
/**@brief Decodes and stores AD Data from Flags AD Structure. */
__STATIC_INLINE ret_code_t flags_decode(uint8_t const * p_flags_data,
uint8_t len,
nfc_ble_oob_pairing_data_t * p_nfc_ble_pairing_data)
{
if (len != AD_TYPE_FLAGS_DATA_SIZE)
{
return NRF_ERROR_INVALID_LENGTH;
}
p_nfc_ble_pairing_data->flags = *p_flags_data;
return NRF_SUCCESS;
}
void nfc_oob_data_printout(nfc_ble_oob_pairing_data_t const * const p_pairing_data)
{
NRF_LOG_RAW_INFO("\r\n");
NRF_LOG_INFO("BLE Advertising data contents");
NRF_LOG_INFO("Device name: \"%s\"", NRF_LOG_PUSH((char *)p_pairing_data->device_name.p_name));
NRF_LOG_INFO("Device Address: ");
for (int i=0; i < BLE_GAP_ADDR_LEN; ++i)
{
NRF_LOG_RAW_INFO("%02X ", p_pairing_data->p_device_addr->addr[i]);
}
NRF_LOG_RAW_INFO("\r\n");
if (p_pairing_data->p_tk_value != NULL)
{
NRF_LOG_INFO("Device Temporary Key present.");
for (int i=0; i < BLE_GAP_SEC_KEY_LEN; ++i)
{
NRF_BLE_OOB_AD_PARSER_LOG_DEBUG("%02X ", p_pairing_data->p_tk_value->tk[i]);
}
NRF_BLE_OOB_AD_PARSER_LOG_DEBUG("\r\n");
}
else
{
NRF_LOG_INFO("Device Temporary Key not present.");
}
if (p_pairing_data->p_lesc_confirm_value != NULL && p_pairing_data->p_lesc_random_value)
{
NRF_LOG_INFO("LESC Confirmation Value present.");
for (int i=0; i < BLE_GAP_SEC_KEY_LEN; ++i)
{
NRF_BLE_OOB_AD_PARSER_LOG_DEBUG("%02X ", p_pairing_data->p_lesc_confirm_value[i]);
}
NRF_BLE_OOB_AD_PARSER_LOG_DEBUG("\r\n");
NRF_LOG_INFO("LESC Random Value present.");
for (int i=0; i < BLE_GAP_SEC_KEY_LEN; ++i)
{
NRF_BLE_OOB_AD_PARSER_LOG_DEBUG("%02X ", p_pairing_data->p_lesc_random_value[i]);
}
NRF_BLE_OOB_AD_PARSER_LOG_DEBUG("\r\n");
}
else
{
NRF_LOG_INFO("LESC data not present.");
}
NRF_LOG_RAW_INFO("\r\n");
}
/**@brief Decodes and stores AD Data that is common for Short and Full Device Name AD Structures. */
static ret_code_t name_decode(uint8_t const * p_name_data,
uint8_t len,
nfc_ble_oob_pairing_data_t * p_nfc_ble_pairing_data)
{
uint8_t * p_name = p_nfc_ble_pairing_data->device_name.p_name;
uint8_t * p_name_len = &p_nfc_ble_pairing_data->device_name.len;
VERIFY_PARAM_NOT_NULL(p_name);
if (*p_name_len < len)
{
return NRF_ERROR_NO_MEM;
}
memcpy(p_name, p_name_data, len);
*p_name_len = len;
return NRF_SUCCESS;
}
/**@brief Decodes and stores AD Data from Short Device Name AD Structure. */
__STATIC_INLINE ret_code_t short_name_decode(uint8_t const * p_short_name_data,
uint8_t len,
nfc_ble_oob_pairing_data_t * p_nfc_ble_pairing_data)
{
p_nfc_ble_pairing_data->device_name.name_type = BLE_ADVDATA_SHORT_NAME;
return name_decode(p_short_name_data, len, p_nfc_ble_pairing_data);
}
/**@brief Decodes and stores AD Data from Full Device Name AD Structure. */
__STATIC_INLINE ret_code_t full_name_decode(uint8_t const * p_full_name_data,
uint8_t len,
nfc_ble_oob_pairing_data_t * p_nfc_ble_pairing_data)
{
p_nfc_ble_pairing_data->device_name.name_type = BLE_ADVDATA_FULL_NAME;
return name_decode(p_full_name_data, len, p_nfc_ble_pairing_data);
}
/**@brief Decodes and stores AD Data from Security Manager TK AD Structure. */
static ret_code_t tk_value_decode(uint8_t const * p_tk_value_data,
uint8_t len,
nfc_ble_oob_pairing_data_t * p_nfc_ble_pairing_data)
{
if (len != AD_TYPE_TK_VALUE_DATA_SIZE)
{
return NRF_ERROR_INVALID_LENGTH;
}
ble_advdata_tk_value_t * p_tk_value = p_nfc_ble_pairing_data->p_tk_value;
VERIFY_PARAM_NOT_NULL(p_tk_value);
memcpy(p_tk_value->tk, p_tk_value_data, AD_TYPE_TK_VALUE_DATA_SIZE);
return NRF_SUCCESS;
}
/**@brief Decodes and stores AD Data from Security Manager TK AD Structure. */
static ret_code_t lesc_confirm_value_decode(uint8_t const * p_lesc_confirm_value_data,
uint8_t len,
nfc_ble_oob_pairing_data_t * p_nfc_ble_pairing_data)
{
if (len != AD_TYPE_CONFIRM_VALUE_DATA_SIZE)
{
return NRF_ERROR_INVALID_LENGTH;
}
uint8_t * p_lesc_confirm_data = p_nfc_ble_pairing_data->p_lesc_confirm_value;
VERIFY_PARAM_NOT_NULL(p_lesc_confirm_data);
memcpy(p_lesc_confirm_data, p_lesc_confirm_value_data, AD_TYPE_CONFIRM_VALUE_DATA_SIZE);
return NRF_SUCCESS;
}
/**@brief Decodes and stores AD Data from Security Manager TK AD Structure. */
static ret_code_t lesc_random_value_decode(uint8_t const * p_lesc_random_value_data,
uint8_t len,
nfc_ble_oob_pairing_data_t * p_nfc_ble_pairing_data)
{
if (len != AD_TYPE_RANDOM_VALUE_DATA_SIZE)
{
return NRF_ERROR_INVALID_LENGTH;
}
uint8_t * p_lesc_random_data = p_nfc_ble_pairing_data->p_lesc_random_value;
VERIFY_PARAM_NOT_NULL(p_lesc_random_data);
memcpy(p_lesc_random_data, p_lesc_random_value_data, AD_TYPE_RANDOM_VALUE_DATA_SIZE);
return NRF_SUCCESS;
}
/**@brief Decodes and stores AD Data from Security Manager OOB Flags AD Structure. */
static ret_code_t sec_mgr_oob_flags_decode(uint8_t const * p_sec_mgr_oob_flags_data,
uint8_t len,
nfc_ble_oob_pairing_data_t * p_nfc_ble_pairing_data)
{
if (len != AD_TYPE_OOB_FLAGS_DATA_SIZE)
{
return NRF_ERROR_INVALID_LENGTH;
}
VERIFY_PARAM_NOT_NULL(p_nfc_ble_pairing_data->p_sec_mgr_oob_flags);
*(p_nfc_ble_pairing_data->p_sec_mgr_oob_flags) = *(p_sec_mgr_oob_flags_data);
return NRF_SUCCESS;
}
/**@brief Decodes and stores AD Data from Appearance AD Structure. */
static ret_code_t appearance_decode(uint8_t const * p_appearance_data,
uint8_t len,
nfc_ble_oob_pairing_data_t * p_nfc_ble_pairing_data)
{
if (len != AD_TYPE_APPEARANCE_DATA_SIZE)
{
return NRF_ERROR_INVALID_LENGTH;
}
p_nfc_ble_pairing_data->appearance = uint16_decode(p_appearance_data);
return NRF_SUCCESS;
}
/**@brief Decodes and stores AD Data from LE Bluetooth Device Address AD Structure. */
static ret_code_t ble_device_addr_decode(uint8_t const * p_dev_addr_data,
uint8_t len,
nfc_ble_oob_pairing_data_t * p_nfc_ble_pairing_data)
{
if (len != AD_TYPE_BLE_DEVICE_ADDR_DATA_SIZE)
{
return NRF_ERROR_INVALID_LENGTH;
}
ble_gap_addr_t * p_device_addr = p_nfc_ble_pairing_data->p_device_addr;
VERIFY_PARAM_NOT_NULL(p_device_addr);
memcpy(p_device_addr->addr, p_dev_addr_data, BLE_GAP_ADDR_LEN);
p_device_addr->addr_type = *(p_dev_addr_data + BLE_GAP_ADDR_LEN);
return NRF_SUCCESS;
}
/**@brief Decodes and stores AD Data from LE Role AD Structure. */
static ret_code_t le_role_decode(uint8_t const * p_le_role_data,
uint8_t len,
nfc_ble_oob_pairing_data_t * p_nfc_ble_pairing_data)
{
if (len != AD_TYPE_LE_ROLE_DATA_SIZE)
{
return NRF_ERROR_INVALID_LENGTH;
}
uint8_t le_role = *p_le_role_data;
switch (le_role)
{
case NFC_BLE_ADVDATA_ROLE_ENCODED_ONLY_PERIPH:
p_nfc_ble_pairing_data->le_role = BLE_ADVDATA_ROLE_ONLY_PERIPH;
break;
case NFC_BLE_ADVDATA_ROLE_ENCODED_ONLY_CENTRAL:
p_nfc_ble_pairing_data->le_role = BLE_ADVDATA_ROLE_ONLY_CENTRAL;
break;
case NFC_BLE_ADVDATA_ROLE_ENCODED_BOTH_PERIPH_PREFERRED:
p_nfc_ble_pairing_data->le_role = BLE_ADVDATA_ROLE_BOTH_PERIPH_PREFERRED;
break;
case NFC_BLE_ADVDATA_ROLE_ENCODED_BOTH_CENTRAL_PREFERRED:
p_nfc_ble_pairing_data->le_role = BLE_ADVDATA_ROLE_BOTH_CENTRAL_PREFERRED;
break;
default:
return NRF_ERROR_INVALID_PARAM;
}
return NRF_SUCCESS;
}
/**@brief Validates if Length field of AD structure is correct. */
__STATIC_INLINE ret_code_t field_length_validate(uint8_t field_length, uint8_t index, uint8_t len)
{
if ( (field_length == FIELD_LEN_INC_VAL) || (index + field_length >= len) )
{
return NRF_ERROR_INVALID_LENGTH;
}
else
{
return NRF_SUCCESS;
}
}
/**@brief Validates which AD types were not present in parsed data and checks if any
* AD Type occured more than once.
*/
__STATIC_INLINE ret_code_t field_type_validate(nfc_ble_oob_pairing_data_t * p_nfc_ble_pairing_data,
ad_type_counter_t * ad_type_counter)
{
/* Reset AD type fields which were not present in parsed buffer. */
if (ad_type_counter->name_type == AD_TYPE_NOT_PRESENT)
{
p_nfc_ble_pairing_data->device_name.p_name = NULL;
p_nfc_ble_pairing_data->device_name.len = 0;
p_nfc_ble_pairing_data->device_name.name_type = BLE_ADVDATA_NO_NAME;
}
if ( (ad_type_counter->addr_type == AD_TYPE_NOT_PRESENT) &&
(p_nfc_ble_pairing_data->p_device_addr != NULL) )
{
p_nfc_ble_pairing_data->p_device_addr = NULL;
}
if ( (ad_type_counter->tk_type == AD_TYPE_NOT_PRESENT) &&
(p_nfc_ble_pairing_data->p_tk_value != NULL) )
{
p_nfc_ble_pairing_data->p_tk_value = NULL;
}
if ( (ad_type_counter->lesc_confirm_type == AD_TYPE_NOT_PRESENT) &&
(p_nfc_ble_pairing_data->p_lesc_confirm_value != NULL) )
{
p_nfc_ble_pairing_data->p_lesc_confirm_value = NULL;
}
if ( (ad_type_counter->lesc_random_type == AD_TYPE_NOT_PRESENT) &&
(p_nfc_ble_pairing_data->p_lesc_random_value != NULL) )
{
p_nfc_ble_pairing_data->p_lesc_random_value = NULL;
}
if ( (ad_type_counter->sec_mgr_oob_flags_type == AD_TYPE_NOT_PRESENT) &&
(p_nfc_ble_pairing_data->p_sec_mgr_oob_flags != NULL) )
{
p_nfc_ble_pairing_data->p_sec_mgr_oob_flags = NULL;
}
if (ad_type_counter->appear_type == AD_TYPE_NOT_PRESENT)
{
p_nfc_ble_pairing_data->appearance = BLE_ADVDATA_APPEARANCE_NOT_PRESENT;
}
if (ad_type_counter->flags_type == AD_TYPE_NOT_PRESENT)
{
p_nfc_ble_pairing_data->flags = 0;
}
if (ad_type_counter->le_role_type == AD_TYPE_NOT_PRESENT)
{
p_nfc_ble_pairing_data->le_role = BLE_ADVDATA_ROLE_NOT_PRESENT;
}
/* Check if any AD Type was doubled. */
if ( (ad_type_counter->name_type > AD_TYPE_OCCUR_THRES) ||
(ad_type_counter->addr_type > AD_TYPE_OCCUR_THRES) ||
(ad_type_counter->tk_type > AD_TYPE_OCCUR_THRES) ||
(ad_type_counter->sec_mgr_oob_flags_type > AD_TYPE_OCCUR_THRES) ||
(ad_type_counter->appear_type > AD_TYPE_OCCUR_THRES) ||
(ad_type_counter->flags_type > AD_TYPE_OCCUR_THRES) ||
(ad_type_counter->le_role_type > AD_TYPE_OCCUR_THRES) ||
(ad_type_counter->lesc_confirm_type > AD_TYPE_OCCUR_THRES) ||
(ad_type_counter->lesc_random_type > AD_TYPE_OCCUR_THRES) )
{
return NRF_ERROR_NOT_SUPPORTED;
}
return NRF_SUCCESS;
}
ret_code_t nfc_ble_oob_advdata_parse(uint8_t const * p_advdata,
uint8_t len,
nfc_ble_oob_pairing_data_t * p_nfc_ble_pairing_data)
{
ret_code_t err_code = NRF_SUCCESS;
uint8_t index = 0;
ad_type_counter_t ad_type_counter;
memset(&ad_type_counter, AD_TYPE_NOT_PRESENT, sizeof(ad_type_counter_t));
if ( (p_nfc_ble_pairing_data == NULL) || (p_advdata == NULL) )
{
return NRF_ERROR_NULL;
}
while (index < len)
{
uint8_t field_length = p_advdata[index];
if (field_length == EARLY_TERMINATOR)
{
return NRF_SUCCESS;
}
err_code = field_length_validate(field_length, index, len);
VERIFY_SUCCESS(err_code);
uint8_t field_type = p_advdata[index + AD_LENGTH_FIELD_SIZE];
uint8_t const * p_field_data = &p_advdata[index + AD_DATA_OFFSET];
uint8_t field_data_len = field_length - AD_TYPE_FIELD_SIZE;
switch (field_type)
{
case BLE_GAP_AD_TYPE_FLAGS:
++ad_type_counter.flags_type;
err_code = flags_decode(p_field_data,
field_data_len,
p_nfc_ble_pairing_data);
break;
case BLE_GAP_AD_TYPE_SHORT_LOCAL_NAME:
++ad_type_counter.name_type;
err_code = short_name_decode(p_field_data,
field_data_len,
p_nfc_ble_pairing_data);
break;
case BLE_GAP_AD_TYPE_COMPLETE_LOCAL_NAME:
++ad_type_counter.name_type;
err_code = full_name_decode(p_field_data,
field_data_len,
p_nfc_ble_pairing_data);
break;
case BLE_GAP_AD_TYPE_SECURITY_MANAGER_TK_VALUE:
++ad_type_counter.tk_type;
err_code = tk_value_decode(p_field_data,
field_data_len,
p_nfc_ble_pairing_data);
break;
case BLE_GAP_AD_TYPE_LESC_CONFIRMATION_VALUE:
++ad_type_counter.lesc_confirm_type;
err_code = lesc_confirm_value_decode(p_field_data,
field_data_len,
p_nfc_ble_pairing_data);
break;
case BLE_GAP_AD_TYPE_LESC_RANDOM_VALUE:
++ad_type_counter.lesc_random_type;
err_code = lesc_random_value_decode(p_field_data,
field_data_len,
p_nfc_ble_pairing_data);
break;
case BLE_GAP_AD_TYPE_SECURITY_MANAGER_OOB_FLAGS:
++ad_type_counter.sec_mgr_oob_flags_type;
err_code = sec_mgr_oob_flags_decode(p_field_data,
field_data_len,
p_nfc_ble_pairing_data);
break;
case BLE_GAP_AD_TYPE_APPEARANCE:
++ad_type_counter.appear_type;
err_code = appearance_decode(p_field_data,
field_data_len,
p_nfc_ble_pairing_data);
break;
case BLE_GAP_AD_TYPE_LE_BLUETOOTH_DEVICE_ADDRESS:
++ad_type_counter.addr_type;
err_code = ble_device_addr_decode(p_field_data,
field_data_len,
p_nfc_ble_pairing_data);
break;
case BLE_GAP_AD_TYPE_LE_ROLE:
++ad_type_counter.le_role_type;
err_code = le_role_decode(p_field_data,
field_data_len,
p_nfc_ble_pairing_data);
break;
default:
/* AD Structure Type field unknown for parser. */
return NRF_ERROR_NOT_SUPPORTED;
}
VERIFY_SUCCESS(err_code);
index += field_length + AD_LENGTH_FIELD_SIZE;
}
err_code = field_type_validate(p_nfc_ble_pairing_data, &ad_type_counter);
return err_code;
}
#endif // NRF_MODULE_ENABLED(NFC_BLE_OOB_ADVDATA_PARSER)

137
components/nfc/ndef/conn_hand_parser/ble_oob_advdata_parser/nfc_ble_oob_advdata_parser.h Normal file
View File

@@ -0,0 +1,137 @@
/**
* Copyright (c) 2016 - 2020, Nordic Semiconductor ASA
*
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification,
* are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form, except as embedded into a Nordic
* Semiconductor ASA integrated circuit in a product or a software update for
* such product, must reproduce the above copyright notice, this list of
* conditions and the following disclaimer in the documentation and/or other
* materials provided with the distribution.
*
* 3. Neither the name of Nordic Semiconductor ASA nor the names of its
* contributors may be used to endorse or promote products derived from this
* software without specific prior written permission.
*
* 4. This software, with or without modification, must only be used with a
* Nordic Semiconductor ASA integrated circuit.
*
* 5. Any software provided in binary form under this license must not be reverse
* engineered, decompiled, modified and/or disassembled.
*
* THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
* OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
* GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
*/
/** @file
*
* @defgroup nfc_ble_oob_advdata_parser Advertising and Scan Response Data Parser for NFC OOB pairing
* @{
* @ingroup nfc_ble_pair_msg
* @brief Functions for parsing and decoding data in the Advertising and Scan Response
* Data format for NFC OOB pairing.
*/
#ifndef NFC_BLE_OOB_ADVDATA_PARSER_H_
#define NFC_BLE_OOB_ADVDATA_PARSER_H_
#include "sdk_errors.h"
#include "ble_advdata.h"
#ifdef __cplusplus
extern "C" {
#endif
#define BLE_ADVDATA_APPEARANCE_NOT_PRESENT 0 /**< Appearance AD structure not present. */
/**@brief Bluetooth Low Energy GAP device name. */
typedef struct
{
ble_advdata_name_type_t name_type; /**< See @ref ble_advdata_name_type_t. */
uint8_t len; /**< Length of device name. */
uint8_t * p_name; /**< Pointer to the buffer with device name. */
} ble_gap_dev_name_t;
/**@brief BLE Advertising data that is relevant for OOB pairing. */
typedef struct
{
ble_gap_dev_name_t device_name; /**< See @ref ble_gap_dev_name_t. */
ble_gap_addr_t * p_device_addr; /**< See @ref ble_gap_addr_t. */
ble_advdata_tk_value_t * p_tk_value; /**< See @ref ble_advdata_tk_value_t. */
uint8_t * p_lesc_confirm_value; /**< LESC OOB confirmation data. */
uint8_t * p_lesc_random_value; /**< LESC OOB random data. */
ble_advdata_le_role_t le_role; /**< See @ref ble_advdata_le_role_t. */
uint16_t appearance; /**< Advertising data Appearance field. */
uint8_t flags; /**< Advertising data Flags field. */
uint8_t * p_sec_mgr_oob_flags; /**< Security Manager Out Of Band Flags data field. */
} nfc_ble_oob_pairing_data_t;
/**@brief Function for parsing BLE data encoded in AD Type format.
*
* @details This function parses BLE data encoded in Advertising Data Type format which
* can be generated with @ref ble_advdata_encode function. The result of the parsing is
* stored within @ref nfc_ble_oob_pairing_data_t structure.
*
* @note Currently, module can be used to parse BLE AD Type data, which contains
* AD Structures with following GAP AD Types: Flags, Shortened and Complete Device
* Name, Security Manager TK Value and OOB Flags, Appearance, LE Bluetooth Device
* Address and LE Role.
*
* @warning Before passing \p p_nfc_ble_pairing_data structure to this function,
* it is necessary to provide buffers for AD Structures Data, which are expected to be
* found within parsed buffer. This applies to following GAP AD Types with corresponding
* structures: Shortened and Complete Device Name - @ref ble_gap_dev_name_t,
* LE Bluetooth Device Address - @ref ble_gap_addr_t, Security Manager TK Value -
* @ref ble_advdata_tk_value_t and Security Manager OOB Flags - uint8_t.
*
* @param[in] p_advdata Pointer to the data to be parsed.
* @param[in] len Size of the data to be parsed.
* @param[out] p_nfc_ble_pairing_data Pointer to the structure that will be used
* to hold parsed data.
*
* @retval NRF_SUCCESS If the function completed successfully.
* @retval NRF_ERROR_NO_MEM If the provided buffer for device name is
* too small to hold parsed data.
* @retval NRF_ERROR_INVALID_LENGTH If any AD Structure Length field contains
* different value than expected.
* @retval NRF_ERROR_INVALID_PARAM If any AD Structure Data field contains
* invalid parameters.
* @retval NRF_ERROR_NULL If any function pointer parameter is NULL or
* any expected buffer in \p p_nfc_ble_pairing_data
* was not provided.
* @retval NRF_ERROR_NOT_SUPPORTED If any AD Structure Type field contains
* type which is not supported or any AD
* Structure Type occurs more than once.
*/
ret_code_t nfc_ble_oob_advdata_parse(uint8_t const * p_advdata,
uint8_t len,
nfc_ble_oob_pairing_data_t * p_nfc_ble_pairing_data);
/**@brief Function for displaying values of basic BLE OOB Advertising data types.
*
* @param[in] p_pairing_data Structure containing parsed data.
*/
void nfc_oob_data_printout(nfc_ble_oob_pairing_data_t const * const p_pairing_data);
#ifdef __cplusplus
}
#endif
#endif //NFC_BLE_OOB_ADVDATA_PARSER_H__
/** @} */

104
components/nfc/ndef/conn_hand_parser/le_oob_rec_parser/nfc_le_oob_rec_parser.c Normal file
View File

@@ -0,0 +1,104 @@
/**
* Copyright (c) 2016 - 2020, Nordic Semiconductor ASA
*
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification,
* are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form, except as embedded into a Nordic
* Semiconductor ASA integrated circuit in a product or a software update for
* such product, must reproduce the above copyright notice, this list of
* conditions and the following disclaimer in the documentation and/or other
* materials provided with the distribution.
*
* 3. Neither the name of Nordic Semiconductor ASA nor the names of its
* contributors may be used to endorse or promote products derived from this
* software without specific prior written permission.
*
* 4. This software, with or without modification, must only be used with a
* Nordic Semiconductor ASA integrated circuit.
*
* 5. Any software provided in binary form under this license must not be reverse
* engineered, decompiled, modified and/or disassembled.
*
* THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
* OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
* GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
*/
#include "sdk_common.h"
#if NRF_MODULE_ENABLED(NFC_LE_OOB_REC_PARSER)
#include "nfc_le_oob_rec_parser.h"
#include "sdk_errors.h"
/**
* @brief Function for parsing LE OOB record payload.
*
* This function parses LE OOB record payload and extracts BLE OOB Advertising data structure.
*
* @param[in] p_buff Pointer to the record payload.
* @param[in] p_len Pointer to the record payload length.
* @param[in,out] p_nfc_ble_oob_pairing_data Pointer to the structure that will be used to hold
* parsed data.
*
* @retval NRF_SUCCESS If the function completed successfully.
* @retval Other An error code that might have been returned by
* @ref nfc_ble_oob_advdata_parse function.
*/
static ret_code_t nfc_le_oob_payload_parse(uint8_t * p_buff,
uint32_t * const p_len,
nfc_ble_oob_pairing_data_t * const p_nfc_ble_oob_pairing_data)
{
ret_code_t err_code = nfc_ble_oob_advdata_parse(p_buff,
*p_len,
p_nfc_ble_oob_pairing_data);
return err_code;
}
ret_code_t nfc_le_oob_rec_parse(nfc_ndef_record_desc_t const * const p_rec_desc,
nfc_ble_oob_pairing_data_t * const p_nfc_ble_oob_pairing_data)
{
ret_code_t err_code;
if (p_rec_desc->tnf != TNF_MEDIA_TYPE)
{
return NRF_ERROR_INVALID_DATA;
}
if (p_rec_desc->type_length != sizeof(le_oob_rec_type_field))
{
return NRF_ERROR_INVALID_DATA;
}
if (memcmp(p_rec_desc->p_type, le_oob_rec_type_field, sizeof(le_oob_rec_type_field)) != 0)
{
return NRF_ERROR_INVALID_DATA;
}
if (p_rec_desc->payload_constructor != (p_payload_constructor_t) nfc_ndef_bin_payload_memcopy)
{
return NRF_ERROR_NOT_SUPPORTED;
}
uint8_t const * p_payload = ((nfc_ndef_bin_payload_desc_t*)(p_rec_desc->p_payload_descriptor))->p_payload;
uint32_t payload_lenght = ((nfc_ndef_bin_payload_desc_t*)(p_rec_desc->p_payload_descriptor))->payload_length;
err_code = nfc_le_oob_payload_parse((uint8_t *) p_payload,
&payload_lenght,
p_nfc_ble_oob_pairing_data);
return err_code;
}
#endif // NRF_MODULE_ENABLED(NFC_LE_OOB_REC_PARSER)

85
components/nfc/ndef/conn_hand_parser/le_oob_rec_parser/nfc_le_oob_rec_parser.h Normal file
View File

@@ -0,0 +1,85 @@
/**
* Copyright (c) 2016 - 2020, Nordic Semiconductor ASA
*
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification,
* are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form, except as embedded into a Nordic
* Semiconductor ASA integrated circuit in a product or a software update for
* such product, must reproduce the above copyright notice, this list of
* conditions and the following disclaimer in the documentation and/or other
* materials provided with the distribution.
*
* 3. Neither the name of Nordic Semiconductor ASA nor the names of its
* contributors may be used to endorse or promote products derived from this
* software without specific prior written permission.
*
* 4. This software, with or without modification, must only be used with a
* Nordic Semiconductor ASA integrated circuit.
*
* 5. Any software provided in binary form under this license must not be reverse
* engineered, decompiled, modified and/or disassembled.
*
* THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
* OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
* GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
*/
/** @file
*
* @defgroup nfc_le_oob_rec_parser LE OOB records parser
* @{
* @ingroup nfc_ble_pair_msg
* @brief Functions for parsing and decoding LE OOB records.
*/
#ifndef __NFC_LE_OOB_REC_PARSER_H__
#define __NFC_LE_OOB_REC_PARSER_H__
#include "nfc_ndef_record.h"
#include "nfc_ble_oob_advdata_parser.h"
#include "nfc_ble_pair_common.h"
#ifdef __cplusplus
extern "C" {
#endif
/**
* @brief Function for parsing general record description as LE OOB record.
*
* This function checks if record description matches the LE OOB record pattern and extracts BLE
* OOB Advertising data structure. It is required for the record description to use binary payload
* descriptor.
*
* @param[in] p_rec_desc Pointer to the record descriptor.
* @param[in,out] p_nfc_ble_oob_pairing_data Pointer to the structure that will be used to hold
* parsed data.
*
* @retval NRF_SUCCESS If the function completed successfully.
* @retval NRF_ERROR_INVALID_DATA If the NDEF record type or TNF is incorrect.
* @retval NRF_ERROR_NOT_SUPPORTED If the payload descriptor is not binary.
* @retval Other An error code that might have been returned by
* @ref nfc_ble_oob_advdata_parse function.
*/
ret_code_t nfc_le_oob_rec_parse(nfc_ndef_record_desc_t const * const p_rec_desc,
nfc_ble_oob_pairing_data_t * const p_nfc_ble_oob_pairing_data);
#ifdef __cplusplus
}
#endif
#endif // __NFC_LE_OOB_REC_PARSER_H__
/** @} */