初始版本

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

View File

@@ -0,0 +1,164 @@
/**
* Copyright (c) 2015 - 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)
#include "nfc_ac_rec.h"
#include <string.h>
#include "nrf_error.h"
#include "nrf.h"
#define AC_REC_CPS_BYTE_SIZE 1 ///< Size of the field with CPS data.
#define AC_REC_DATA_REF_LEN_SIZE 1 ///< Size of the Data Reference Length field.
#define AC_REC_AUX_DATA_REF_COUNT_SIZE 1 ///< Size of the Data Reference Length field.
const uint8_t nfc_ac_rec_type_field[2] = {'a', 'c'}; ///< Alternative Carrier Record type.
/**
* @brief Function for calculating the payload length of the NFC NDEF Alternative Carrier record.
*/
static uint32_t nfc_ac_rec_payload_size_get(nfc_ac_rec_payload_desc_t const * p_ac_rec_payload_desc)
{
int32_t i = 0;
// Initialize with size of byte with CPS.
uint32_t payload_size = AC_REC_CPS_BYTE_SIZE;
// Add Carrier Data Reference size.
payload_size += p_ac_rec_payload_desc->carrier_data_ref.length + AC_REC_DATA_REF_LEN_SIZE;
// Add Auxiliary Data Reference Count size.
payload_size += AC_REC_AUX_DATA_REF_COUNT_SIZE;
for (i = 0; i < p_ac_rec_payload_desc->aux_data_ref_count; i++)
{
// Add Auxiliary Data Reference size.
payload_size += p_ac_rec_payload_desc->p_aux_data_ref[i].length + AC_REC_DATA_REF_LEN_SIZE;
}
return payload_size;
}
ret_code_t nfc_ac_rec_payload_constructor(nfc_ac_rec_payload_desc_t * p_nfc_rec_ac_payload_desc,
uint8_t * p_buff,
uint32_t * p_len)
{
int32_t i = 0;
uint32_t payload_size = nfc_ac_rec_payload_size_get(p_nfc_rec_ac_payload_desc);
if (p_buff != NULL)
{
// Not enough space in the buffer, return an error.
if (payload_size > *p_len)
{
return NRF_ERROR_NO_MEM;
}
// Invalid CPS value.
if ( p_nfc_rec_ac_payload_desc->cps & ~NFC_AC_CPS_MASK )
{
return NRF_ERROR_INVALID_PARAM;
}
// Copy CPS.
*p_buff = p_nfc_rec_ac_payload_desc->cps;
p_buff += AC_REC_CPS_BYTE_SIZE;
// Copy Carrier Data Reference.
*p_buff = p_nfc_rec_ac_payload_desc->carrier_data_ref.length;
p_buff += AC_REC_DATA_REF_LEN_SIZE;
memcpy( p_buff,
p_nfc_rec_ac_payload_desc->carrier_data_ref.p_data,
p_nfc_rec_ac_payload_desc->carrier_data_ref.length );
p_buff += p_nfc_rec_ac_payload_desc->carrier_data_ref.length;
// Copy Auxiliary Data Reference.
*p_buff = p_nfc_rec_ac_payload_desc->aux_data_ref_count;
p_buff += AC_REC_AUX_DATA_REF_COUNT_SIZE;
for (i = 0; i < p_nfc_rec_ac_payload_desc->aux_data_ref_count; i++)
{
*p_buff = p_nfc_rec_ac_payload_desc->p_aux_data_ref[i].length;
p_buff += AC_REC_DATA_REF_LEN_SIZE;
memcpy( p_buff,
p_nfc_rec_ac_payload_desc->p_aux_data_ref[i].p_data,
p_nfc_rec_ac_payload_desc->p_aux_data_ref[i].length );
p_buff += p_nfc_rec_ac_payload_desc->p_aux_data_ref[i].length;
}
}
// Assign payload size to the return buffer.
*p_len = payload_size;
return NRF_SUCCESS;
}
void nfc_ac_rec_auxiliary_data_ref_clear(nfc_ndef_record_desc_t * p_ac_rec)
{
nfc_ac_rec_payload_desc_t * p_ac_rec_payload =
(nfc_ac_rec_payload_desc_t*)p_ac_rec->p_payload_descriptor;
p_ac_rec_payload->aux_data_ref_count = 0;
}
ret_code_t nfc_ac_rec_auxiliary_data_ref_add(nfc_ndef_record_desc_t * p_ac_rec,
uint8_t * p_aux_data,
uint8_t aux_length)
{
nfc_ac_rec_payload_desc_t * p_ac_rec_payload =
(nfc_ac_rec_payload_desc_t *)p_ac_rec->p_payload_descriptor;
if (p_ac_rec_payload->aux_data_ref_count >= p_ac_rec_payload->max_aux_data_ref)
{
return NRF_ERROR_NO_MEM;
}
p_ac_rec_payload->p_aux_data_ref[p_ac_rec_payload->aux_data_ref_count].p_data = p_aux_data;
p_ac_rec_payload->p_aux_data_ref[p_ac_rec_payload->aux_data_ref_count].length = aux_length;
p_ac_rec_payload->aux_data_ref_count++;
return NRF_SUCCESS;
}
#endif // NRF_MODULE_ENABLED(NFC_AC_REC)

View File

@@ -0,0 +1,199 @@
/**
* Copyright (c) 2015 - 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.
*
*/
#ifndef NFC_AC_REC_H__
#define NFC_AC_REC_H__
/**@file
*
* @defgroup nfc_ac_rec ac (Alternative carrier) records
* @{
* @ingroup nfc_ble_pair_msg
*
* @brief Generation of NFC NDEF Alternative Carrier records for NDEF messages.
*
*/
#include <stdint.h>
#include "nfc_ndef_record.h"
#ifdef __cplusplus
extern "C" {
#endif
#define AC_REC_CPS_BYTE_SIZE 1 ///< Size of the field with CPS data.
#define AC_REC_DATA_REF_LEN_SIZE 1 ///< Size of the Data Reference Length field.
#define AC_REC_AUX_DATA_REF_COUNT_SIZE 1 ///< Size of the Data Reference Length field.
/**
* @brief Carrier Power State.
*
* Possible Carrier Power State field values in an Alternative Carrier record.
*/
typedef enum
{
NFC_AC_CPS_INACTIVE = 0x00, ///< Alternative Carrier inactive.
NFC_AC_CPS_ACTIVE = 0x01, ///< Alternative Carrier active.
NFC_AC_CPS_ACTIVATING = 0x02, ///< Alternative Carrier activating.
NFC_AC_CPS_UNKNOWN = 0x03 ///< Alternative Carrier power status unknown.
} nfc_ac_rec_cps_t;
#define NFC_AC_CPS_MASK (NFC_AC_CPS_UNKNOWN) ///< Mask of Carrier Power State bits in a first ac record byte.
/**
* @brief Carrier Data Reference and Auxiliary Data Reference descriptor.
*/
typedef struct
{
uint8_t length; ///< Length of the data field.
uint8_t * p_data; ///< Pointer to the Data Reference characters. Not relevant if length is 0.
} nfc_ac_rec_data_ref_t;
/**
* @brief Alternative Carrier record payload descriptor.
*/
typedef struct
{
nfc_ac_rec_cps_t cps; ///< Carrier Power State value.
nfc_ac_rec_data_ref_t carrier_data_ref; ///< Carrier Data Reference.
uint8_t const max_aux_data_ref; ///< Maximum number of Auxiliary Data Reference fields.
uint8_t aux_data_ref_count; ///< Number of Auxiliary Data Reference fields.
nfc_ac_rec_data_ref_t * p_aux_data_ref; ///< Pointer to the Auxiliary Data Reference fields.
} nfc_ac_rec_payload_desc_t;
/**
* @brief Constructor for an NFC NDEF Alternative Carrier record payload.
*
* This function encodes the payload of an Alternative Carrier record as specified in the Connection
* Handover standard. It implements an API compatible with @ref p_payload_constructor_t.
*/
ret_code_t nfc_ac_rec_payload_constructor(nfc_ac_rec_payload_desc_t * p_nfc_rec_ac_payload_desc,
uint8_t * p_buff,
uint32_t * p_len);
/**
* @brief External reference to the type field of the Alternative Carrier record, defined in the
* file @c nfc_ac_rec.c. It is used in the @ref NFC_NDEF_AC_RECORD_DESC_DEF macro.
*/
extern const uint8_t nfc_ac_rec_type_field[2];
/**
* @brief Size of the type field of the Alternative Carrier record, defined in the
* file @c nfc_ac_rec.c. It is used in the @ref NFC_NDEF_AC_RECORD_DESC_DEF macro.
*/
#define NFC_AC_REC_TYPE_LENGTH 2
/**
*@brief Macro for creating and initializing an NFC NDEF record descriptor for an Alternative Carrier record.
*
* This macro creates and initializes an instance of type @ref nfc_ndef_record_desc_t and
* an instance of type @ref nfc_ac_rec_payload_desc_t, which together constitute an instance of an Alternative Carrier record.
*
* Use the macro @ref NFC_NDEF_AC_RECORD_DESC to access the NDEF Alternative Carrier record descriptor instance.
*
* @note The record descriptor is declared as automatic variable, which implies that
* the NDEF message encoding (see @ref nfc_ble_full_handover_select_msg_encode)
* must be done in the same variable scope.
*
* @param[in] NAME Name of the created record descriptor instance.
* @param[in] CPS Carrier Power State value.
* @param[in] CARR_DATA_REF_LEN Length of the Carrier Data Reference field.
* @param[in] P_CARR_DATA_REF Pointer to the Carrier Data Reference field.
* @param[in] MAX_AUX_DATA_REF Maximum number of Auxiliary Data Reference fields.
*/
#define NFC_NDEF_AC_RECORD_DESC_DEF(NAME, \
CPS, \
CARR_DATA_REF_LEN, \
P_CARR_DATA_REF, \
MAX_AUX_DATA_REF) \
nfc_ac_rec_data_ref_t NAME##_nfc_ac_rec_aux_data_ref_array[MAX_AUX_DATA_REF]; \
nfc_ac_rec_payload_desc_t NAME##_nfc_ac_rec_payload_desc = \
{ \
.cps = CPS, \
.carrier_data_ref = {CARR_DATA_REF_LEN, P_CARR_DATA_REF}, \
.max_aux_data_ref = MAX_AUX_DATA_REF, \
.aux_data_ref_count = 0, \
.p_aux_data_ref = NAME##_nfc_ac_rec_aux_data_ref_array \
}; \
NFC_NDEF_GENERIC_RECORD_DESC_DEF(NAME, \
TNF_WELL_KNOWN, \
0, \
0, \
nfc_ac_rec_type_field, \
NFC_AC_REC_TYPE_LENGTH, \
nfc_ac_rec_payload_constructor, \
&(NAME##_nfc_ac_rec_payload_desc))
/**
* @brief Macro for accessing the NFC NDEF Alternative Carrier record descriptor
* instance that was created with @ref NFC_NDEF_AC_RECORD_DESC_DEF.
*/
#define NFC_NDEF_AC_RECORD_DESC(NAME) NFC_NDEF_GENERIC_RECORD_DESC(NAME)
/**
* @brief Function for clearing an Auxiliary Data Reference in an NFC NDEF Alternative Carrier record.
*
* This function clears the Auxiliary Data References from the Alternative Carrier record.
*
* @param[in, out] p_ac_rec Pointer to the Alternative Carrier record descriptor.
*/
void nfc_ac_rec_auxiliary_data_ref_clear(nfc_ndef_record_desc_t * p_ac_rec);
/**
* @brief Function for adding an Auxiliary Data Reference to an NFC NDEF Alternative Carrier record.
*
* @param[in, out] p_ac_rec Pointer to an ac record.
* @param[in] p_aux_data Pointer to the Auxiliary Data Reference data buffer.
* @param[in] aux_length Length of the Auxiliary Data Reference data.
*
* @retval NRF_SUCCESS If the Auxiliary Data Reference was added successfully.
* @retval NRF_ERROR_NO_MEM If the record already contains the maximum number of Auxiliary Data References.
*/
ret_code_t nfc_ac_rec_auxiliary_data_ref_add(nfc_ndef_record_desc_t * p_ac_rec,
uint8_t * p_aux_data,
uint8_t aux_length);
/** @} */
#ifdef __cplusplus
}
#endif
#endif // NFC_AC_REC_H__