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

183
components/nfc/ndef/generic/message/nfc_ndef_msg.c Normal file
View File

@@ -0,0 +1,183 @@
/**
* 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_NDEF_MSG)
#include "app_util.h"
#include "nfc_ndef_msg.h"
#include "nordic_common.h"
#include "nrf.h"
/**
* @brief Resolve the value of record location flags of the NFC NDEF record within an NFC NDEF message.
*/
__STATIC_INLINE nfc_ndef_record_location_t record_location_get(uint32_t index,
uint32_t record_count)
{
nfc_ndef_record_location_t record_location;
if (index == 0)
{
if (record_count == 1)
{
record_location = NDEF_LONE_RECORD;
}
else
{
record_location = NDEF_FIRST_RECORD;
}
}
else if (record_count == index + 1)
{
record_location = NDEF_LAST_RECORD;
}
else
{
record_location = NDEF_MIDDLE_RECORD;
}
return record_location;
}
ret_code_t nfc_ndef_msg_encode(nfc_ndef_msg_desc_t const * p_ndef_msg_desc,
uint8_t * p_msg_buffer,
uint32_t * const p_msg_len)
{
nfc_ndef_record_location_t record_location;
uint32_t temp_len;
uint32_t i;
uint32_t err_code;
uint32_t sum_of_len = 0;
if ((p_ndef_msg_desc == NULL) || p_msg_len == NULL)
{
return NRF_ERROR_NULL;
}
nfc_ndef_record_desc_t * * pp_record_rec_desc = p_ndef_msg_desc->pp_record;
if (p_ndef_msg_desc->pp_record == NULL)
{
return NRF_ERROR_NULL;
}
#if NFC_NDEF_MSG_TAG_TYPE == TYPE_4_TAG
uint8_t * p_root_msg_buffer = p_msg_buffer;
if (p_msg_buffer != NULL)
{
if (*p_msg_len < NLEN_FIELD_SIZE)
{
return NRF_ERROR_NO_MEM;
}
p_msg_buffer += NLEN_FIELD_SIZE;
}
sum_of_len += NLEN_FIELD_SIZE;
#endif
for (i = 0; i < p_ndef_msg_desc->record_count; i++)
{
record_location = record_location_get(i, p_ndef_msg_desc->record_count);
temp_len = *p_msg_len - sum_of_len;
err_code = nfc_ndef_record_encode(*pp_record_rec_desc,
record_location,
p_msg_buffer,
&temp_len);
if (err_code != NRF_SUCCESS)
{
return err_code;
}
sum_of_len += temp_len;
if (p_msg_buffer != NULL)
{
p_msg_buffer += temp_len;
}
/* next record */
pp_record_rec_desc++;
}
#if NFC_NDEF_MSG_TAG_TYPE == TYPE_4_TAG
if (p_msg_buffer != NULL)
{
if (sum_of_len - NLEN_FIELD_SIZE > UINT16_MAX)
{
return NRF_ERROR_NOT_SUPPORTED;
}
UNUSED_RETURN_VALUE(uint16_big_encode(sum_of_len - NLEN_FIELD_SIZE, p_root_msg_buffer));
}
#endif
*p_msg_len = sum_of_len;
return NRF_SUCCESS;
}
void nfc_ndef_msg_clear(nfc_ndef_msg_desc_t * p_msg)
{
p_msg->record_count = 0;
}
ret_code_t nfc_ndef_msg_record_add(nfc_ndef_msg_desc_t * const p_msg,
nfc_ndef_record_desc_t * const p_record)
{
if (p_msg->record_count >= p_msg->max_record_count)
{
return NRF_ERROR_NO_MEM;
}
p_msg->pp_record[p_msg->record_count] = p_record;
p_msg->record_count++;
return NRF_SUCCESS;
}
#endif // NRF_MODULE_ENABLED(NFC_NDEF_MSG)

197
components/nfc/ndef/generic/message/nfc_ndef_msg.h Normal file
View File

@@ -0,0 +1,197 @@
/**
* 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_NDEF_MSG_H__
#define NFC_NDEF_MSG_H__
#include "nfc_ndef_record.h"
#ifdef __cplusplus
extern "C" {
#endif
/**@file
*
* @defgroup nfc_ndef_msg Custom NDEF messages
* @{
* @ingroup nfc_modules
*
* @brief Generation of NFC NDEF messages for the NFC tag.
*
*/
#define TYPE_4_TAG 4U ///< Type 4 Tag identifier.
#define NLEN_FIELD_SIZE 2U ///< Size of NLEN field, used to encode NDEF message for Type 4 Tag.
/**
* @brief NDEF message descriptor.
*/
typedef struct {
nfc_ndef_record_desc_t ** pp_record; ///< Pointer to an array of pointers to NDEF record descriptors.
uint32_t max_record_count; ///< Number of elements in the allocated pp_record array, which defines the maximum number of records within the NDEF message.
uint32_t record_count; ///< Number of records in the NDEF message.
} nfc_ndef_msg_desc_t;
/**
* @brief Function for encoding an NDEF message.
*
* This function encodes an NDEF message according to the provided message descriptor.
*
* @note The way of encoding an NDEF message may vary depending on tag's platform, which
* can be chosen with @ref NFC_NDEF_MSG_TAG_TYPE in @c sdk_config.h.
*
* @param[in] p_ndef_msg_desc Pointer to the message descriptor.
* @param[out] p_msg_buffer Pointer to the message destination. If NULL, function will
* calculate the expected size of the message.
* @param[in,out] p_msg_len Size of the available memory for the message as input. Size of
* the generated message as output.
*
* @return Return value from @ref nfc_ndef_record_encode.
*/
ret_code_t nfc_ndef_msg_encode(nfc_ndef_msg_desc_t const * p_ndef_msg_desc,
uint8_t * p_msg_buffer,
uint32_t * const p_msg_len);
/**
* @brief Function for clearing an NDEF message.
*
* This function clears an NDEF message descriptor, thus empties the NDEF message.
*
* @param[in,out] p_msg Pointer to the message descriptor.
*/
void nfc_ndef_msg_clear( nfc_ndef_msg_desc_t * p_msg);
/**
* @brief Function for adding a record to an NDEF message.
*
* @param[in] p_record Pointer to the record descriptor.
* @param[in,out] p_msg Pointer to the message descriptor.
*
* @retval NRF_SUCCESS If the record was added successfully.
* @retval NRF_ERROR_NO_MEM If the message already contains the maximum number of records and the operation is not allowed.
*/
ret_code_t nfc_ndef_msg_record_add(nfc_ndef_msg_desc_t * const p_msg,
nfc_ndef_record_desc_t * const p_record);
/**@brief Macro for creating and initializing an NFC NDEF message descriptor.
*
* This macro creates and initializes an instance of type @ref nfc_ndef_msg_desc_t
* and an array of pointers to record descriptors (@ref nfc_ndef_record_desc_t) used
* by the message.
*
* Use the macro @ref NFC_NDEF_MSG to access the NDEF message descriptor instance.
*
* @note The message descriptor is declared as automatic variable, which implies that
* the NDEF message encoding must be done in the same variable scope.
*
* @param[in] NAME Name of the related instance.
* @param[in] MAX_RECORD_CNT Maximal count of records in the message.
*/
#define NFC_NDEF_MSG_DEF(NAME, MAX_RECORD_CNT) \
nfc_ndef_record_desc_t * NAME##_nfc_ndef_p_record_desc_array[MAX_RECORD_CNT]; \
nfc_ndef_msg_desc_t NAME##_nfc_ndef_msg_desc = \
{ \
.pp_record = NAME##_nfc_ndef_p_record_desc_array, \
.max_record_count = MAX_RECORD_CNT, \
.record_count = 0 \
}
/** @brief Macro for accessing the NFC NDEF message descriptor instance
* that you created with @ref NFC_NDEF_MSG_DEF.
*/
#define NFC_NDEF_MSG(NAME) (NAME##_nfc_ndef_msg_desc)
/**
* @brief Macro for creating and initializing an NFC NDEF record descriptor with an encapsulated NDEF message.
* This macro creates and initializes a static instance of type
* @ref nfc_ndef_record_desc_t that contains an encapsulated NDEF message as
* payload. @ref nfc_ndef_msg_encode is used as payload constructor to encode
* the message. The encoded message is then used as payload for the record.
*
* Use the macro @ref NFC_NDEF_NESTED_NDEF_MSG_RECORD to access the NDEF record descriptor instance.
*
* @note The message descriptor is declared as automatic variable, which implies that
* the NDEF message encoding must be done in the same variable scope.
*
* @param[in] NAME Name of the created record descriptor instance.
* @param[in] TNF Type Name Format (TNF) value for the record.
* @param[in] P_ID Pointer to the ID string.
* @param[in] ID_LEN Length of the ID string.
* @param[in] P_TYPE Pointer to the type string.
* @param[in] TYPE_LEN Length of the type string.
* @param[in] P_NESTED_MESSAGE Pointer to the message descriptor to encapsulate
* as the record's payload.
*/
#define NFC_NDEF_NESTED_NDEF_MSG_RECORD_DEF( NAME, \
TNF, \
P_ID, \
ID_LEN, \
P_TYPE, \
TYPE_LEN, \
P_NESTED_MESSAGE ) \
nfc_ndef_record_desc_t NAME##_ndef_record_nested_desc = \
{ \
.tnf = TNF, \
\
.id_length = ID_LEN, \
.p_id = P_ID, \
\
.type_length = TYPE_LEN, \
.p_type = P_TYPE, \
\
.payload_constructor = (p_payload_constructor_t)(nfc_ndef_msg_encode), \
.p_payload_descriptor = (void*) (P_NESTED_MESSAGE) \
}
/** @brief Macro for accessing the NFC NDEF record descriptor instance
* that you created with @ref NFC_NDEF_NESTED_NDEF_MSG_RECORD_DEF.
*/
#define NFC_NDEF_NESTED_NDEF_MSG_RECORD(NAME) (NAME##_ndef_record_nested_desc)
/**
* @}
*/
#ifdef __cplusplus
}
#endif
#endif

191
components/nfc/ndef/generic/record/nfc_ndef_record.c Normal file
View File

@@ -0,0 +1,191 @@
/**
* 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_config.h"
#include "nordic_common.h"
#if NRF_MODULE_ENABLED(NFC_NDEF_RECORD)
#include <string.h>
#include "nfc_ndef_record.h"
#include "app_util.h"
#include "nrf.h"
/* Sum of sizes of fields: TNF-flags, Type Length, Payload Length in long NDEF record. */
#define NDEF_RECORD_BASE_LONG_SIZE (2 + NDEF_RECORD_PAYLOAD_LEN_LONG_SIZE)
__STATIC_INLINE uint32_t record_header_size_calc(nfc_ndef_record_desc_t const * p_ndef_record_desc)
{
uint32_t len = NDEF_RECORD_BASE_LONG_SIZE;
len += p_ndef_record_desc->id_length + p_ndef_record_desc->type_length;
if (p_ndef_record_desc->id_length > 0)
{
len++;
}
return len;
}
ret_code_t nfc_ndef_record_encode(nfc_ndef_record_desc_t const * p_ndef_record_desc,
nfc_ndef_record_location_t record_location,
uint8_t * p_record_buffer,
uint32_t * p_record_len)
{
uint8_t * p_flags; // use as pointer to TNF + flags field
uint8_t * p_payload_len = NULL; // use as pointer to payload length field
uint32_t record_payload_len;
if (p_ndef_record_desc == NULL)
{
return NRF_ERROR_NULL;
}
// count record length without payload
uint32_t record_header_len = record_header_size_calc(p_ndef_record_desc);
uint32_t err_code = NRF_SUCCESS;
if (p_record_buffer != NULL)
{
/* verify location range */
if ((record_location & (~NDEF_RECORD_LOCATION_MASK)) != 0x00)
{
return NRF_ERROR_INVALID_PARAM;
}
/* verify if there is enough available memory */
if (record_header_len > *p_record_len)
{
return NRF_ERROR_NO_MEM;
}
p_flags = p_record_buffer;
p_record_buffer++;
// set location bits and clear other bits in 1st byte.
*p_flags = record_location;
*p_flags |= p_ndef_record_desc->tnf;
/* TYPE LENGTH */
*(p_record_buffer++) = p_ndef_record_desc->type_length;
// use always long record and remember payload len field memory offset.
p_payload_len = p_record_buffer;
p_record_buffer += NDEF_RECORD_PAYLOAD_LEN_LONG_SIZE;
/* ID LENGTH - option */
if (p_ndef_record_desc->id_length > 0)
{
*(p_record_buffer++) = p_ndef_record_desc->id_length;
/* IL flag */
*p_flags |= NDEF_RECORD_IL_MASK;
}
/* TYPE */
memcpy(p_record_buffer, p_ndef_record_desc->p_type, p_ndef_record_desc->type_length);
p_record_buffer += p_ndef_record_desc->type_length;
/* ID */
if (p_ndef_record_desc->id_length > 0)
{
memcpy(p_record_buffer, p_ndef_record_desc->p_id, p_ndef_record_desc->id_length);
p_record_buffer += p_ndef_record_desc->id_length;
}
// count how much memory is left in record buffer for payload field.
record_payload_len = (*p_record_len - record_header_len);
}
/* PAYLOAD */
if (p_ndef_record_desc->payload_constructor != NULL)
{
err_code =
p_ndef_record_desc->payload_constructor(p_ndef_record_desc->p_payload_descriptor,
p_record_buffer,
&record_payload_len);
if (err_code != NRF_SUCCESS)
{
return err_code;
}
}
else
{
return NRF_ERROR_NULL;
}
if (p_record_buffer != NULL)
{
/* PAYLOAD LENGTH */
(void) uint32_big_encode(record_payload_len, p_payload_len);
}
*p_record_len = record_header_len + record_payload_len;
return NRF_SUCCESS;
}
ret_code_t nfc_ndef_bin_payload_memcopy(nfc_ndef_bin_payload_desc_t * p_payload_descriptor,
uint8_t * p_buffer,
uint32_t * p_len)
{
if (p_buffer != NULL)
{
if ( *p_len < p_payload_descriptor->payload_length)
{
return NRF_ERROR_NO_MEM;
}
memcpy(p_buffer,
p_payload_descriptor->p_payload,
p_payload_descriptor->payload_length);
}
*p_len = p_payload_descriptor->payload_length;
return NRF_SUCCESS;
}
#endif // NRF_MODULE_ENABLED(NFC_NDEF_RECORD)

311
components/nfc/ndef/generic/record/nfc_ndef_record.h Normal file
View File

@@ -0,0 +1,311 @@
/**
* 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_NDEF_RECORD_H__
#define NFC_NDEF_RECORD_H__
#include <stdint.h>
#include <string.h>
#include "compiler_abstraction.h"
#include "sdk_errors.h"
#include "nrf.h"
#ifdef __cplusplus
extern "C" {
#endif
/**@file
*
* @defgroup nfc_ndef_record Custom NDEF records
* @{
* @ingroup nfc_ndef_msg
*
* @brief Generation of NFC NDEF records for NFC messages.
*
*/
#define NDEF_RECORD_IL_MASK 0x08 ///< Mask of the ID field presence bit in the flags byte of an NDEF record.
#define NDEF_RECORD_TNF_MASK 0x07 ///< Mask of the TNF value field in the first byte of an NDEF record.
#define NDEF_RECORD_SR_MASK 0x10 ///< Mask of the SR flag. If set, this flag indicates that the PAYLOAD_LENGTH field has a size of 1 byte. Otherwise, PAYLOAD_LENGTH has 4 bytes.
#define NDEF_RECORD_PAYLOAD_LEN_LONG_SIZE 4 ///< Size of the Payload Length field in a long NDEF record.
#define NDEF_RECORD_PAYLOAD_LEN_SHORT_SIZE 1 ///< Size of the Payload Length field in a short NDEF record.
#define NDEF_RECORD_ID_LEN_SIZE 1 ///< Size of the ID Length field in an NDEF record.
/**
* @brief Payload constructor type.
* A payload constructor is a function for constructing the payload of an NDEF
* record.
*
* @param[in] p_payload_descriptor Pointer to the input data for the constructor.
* @param[out] p_buffer Pointer to the payload destination. If NULL, function will
* calculate the expected size of the record payload.
*
* @param[in,out] p_len Size of the available memory to write as input. Size of the generated
* record payload as output. The implementation must check if the payload
* will fit in the provided buffer. This must be checked by the caller function.
*
* @retval NRF_SUCCESS If the function completed successfully.
* @retval NRF_ERROR_xxx If an error occurred.
*/
typedef ret_code_t (* p_payload_constructor_t)(void * p_payload_descriptor,
uint8_t * p_buffer,
uint32_t * p_len);
/**
* @brief Type Name Format (TNF) Field Values.
*
* Values to specify the TNF of a record.
*/
typedef enum
{
TNF_EMPTY = 0x00, ///< The value indicates that there is no type or payload associated with this record.
TNF_WELL_KNOWN = 0x01, ///< NFC Forum well-known type [NFC RTD].
TNF_MEDIA_TYPE = 0x02, ///< Media-type as defined in RFC 2046 [RFC 2046].
TNF_ABSOLUTE_URI = 0x03, ///< Absolute URI as defined in RFC 3986 [RFC 3986].
TNF_EXTERNAL_TYPE = 0x04, ///< NFC Forum external type [NFC RTD].
TNF_UNKNOWN_TYPE = 0x05, ///< The value indicates that there is no type associated with this record.
TNF_UNCHANGED = 0x06, ///< The value is used for the record chunks used in chunked payload.
TNF_RESERVED = 0x07, ///< The value is reserved for future use.
} nfc_ndef_record_tnf_t;
/**
* @brief NDEF record descriptor.
*/
typedef struct
{
nfc_ndef_record_tnf_t tnf; ///< Value of the Type Name Format (TNF) field.
uint8_t id_length; ///< Length of the ID field. If 0, a record format without ID field is assumed.
uint8_t const * p_id; ///< Pointer to the ID field data. Not relevant if id_length is 0.
uint8_t type_length; ///< Length of the type field.
uint8_t const * p_type; ///< Pointer to the type field data. Not relevant if type_length is 0.
p_payload_constructor_t payload_constructor; ///< Pointer to the payload constructor function.
void * p_payload_descriptor; ///< Pointer to the data for the payload constructor function.
} nfc_ndef_record_desc_t;
/**
* @brief Record position within the NDEF message.
*
* Values to specify the location of a record within the NDEF message.
*/
typedef enum
{
NDEF_FIRST_RECORD = 0x80, ///< First record.
NDEF_MIDDLE_RECORD = 0x00, ///< Middle record.
NDEF_LAST_RECORD = 0x40, ///< Last record.
NDEF_LONE_RECORD = 0xC0 ///< Only one record in the message.
} nfc_ndef_record_location_t;
#define NDEF_RECORD_LOCATION_MASK (NDEF_LONE_RECORD) ///< Mask of the Record Location bits in the NDEF record's flags byte.
/**
* @brief Binary data descriptor containing the payload for the record.
*/
typedef struct
{
uint8_t const * p_payload; ///< Pointer to the buffer with the data.
uint32_t payload_length; ///< Length of data in bytes.
} nfc_ndef_bin_payload_desc_t;
/**
* @brief Macro for creating and initializing an NFC NDEF record descriptor for a generic record.
*
* This macro creates and initializes an instance of type @ref nfc_ndef_record_desc_t.
*
* Use the macro @ref NFC_NDEF_GENERIC_RECORD_DESC to access the NDEF record descriptor instance.
*
* @note The record descriptor is declared as automatic variable, which implies that
* the NDEF record encoding must be done in the same variable scope.
*
* @param[in] NAME Name of the created descriptor instance.
* @param[in] TNF Type Name Format (TNF) value for the record.
* @param[in] P_ID Pointer to the ID string.
* @param[in] ID_LEN Length of the ID string.
* @param[in] P_TYPE Pointer to the type string.
* @param[in] TYPE_LEN Length of the type string.
* @param[in] P_PAYLOAD_CONSTRUCTOR Pointer to the payload constructor function.
* The constructor must be of type @ref p_payload_constructor_t.
* @param[in] P_PAYLOAD_DESCRIPTOR Pointer to the data for the payload constructor.
*/
#define NFC_NDEF_GENERIC_RECORD_DESC_DEF(NAME, \
TNF, \
P_ID, \
ID_LEN, \
P_TYPE, \
TYPE_LEN, \
P_PAYLOAD_CONSTRUCTOR, \
P_PAYLOAD_DESCRIPTOR) \
nfc_ndef_record_desc_t NAME##_ndef_generic_record_desc = \
{ \
.tnf = TNF, \
\
.id_length = ID_LEN, \
.p_id = P_ID, \
\
.type_length = TYPE_LEN, \
.p_type = P_TYPE, \
\
.payload_constructor = (p_payload_constructor_t)P_PAYLOAD_CONSTRUCTOR, \
.p_payload_descriptor = (void *) P_PAYLOAD_DESCRIPTOR \
}
/** @brief Macro for accessing the NFC NDEF record descriptor instance
* that you created with @ref NFC_NDEF_GENERIC_RECORD_DESC_DEF.
*/
#define NFC_NDEF_GENERIC_RECORD_DESC(NAME) (NAME##_ndef_generic_record_desc)
/**
* @brief Macro for creating and initializing an NFC NDEF record descriptor for a record with
* binary payload.
*
* This macro creates and initializes a static instance of type @ref nfc_ndef_record_desc_t and a binary data descriptor containing the payload data.
*
* Use the macro @ref NFC_NDEF_RECORD_BIN_DATA to access the NDEF record descriptor instance.
*
* @note The record descriptor is declared as automatic variable, which implies that
* the NDEF record encoding must be done in the same variable scope.
*
* @param[in] NAME Name of the created descriptor instance.
* @param[in] TNF Type Name Format (TNF) value for the record.
* @param[in] P_ID Pointer to the ID string.
* @param[in] ID_LEN Length of the ID string.
* @param[in] P_TYPE Pointer to the type string.
* @param[in] TYPE_LEN Length of the type string.
* @param[in] P_PAYLOAD Pointer to the payload data that will be copied to the payload field.
* @param[in] PAYLOAD_LEN Length of the payload.
*/
#define NFC_NDEF_RECORD_BIN_DATA_DEF(NAME, \
TNF, \
P_ID, ID_LEN, \
P_TYPE, \
TYPE_LEN, \
P_PAYLOAD, \
PAYLOAD_LEN) \
nfc_ndef_bin_payload_desc_t NAME##_nfc_ndef_bin_payload_desc = \
{ \
.p_payload = P_PAYLOAD, \
.payload_length = PAYLOAD_LEN \
}; \
\
nfc_ndef_record_desc_t NAME##_nfc_ndef_bin_record_desc = \
{ \
.tnf = TNF, \
\
.id_length = ID_LEN, \
.p_id = P_ID, \
\
.type_length = TYPE_LEN, \
.p_type = P_TYPE, \
\
.payload_constructor = (p_payload_constructor_t) nfc_ndef_bin_payload_memcopy, \
.p_payload_descriptor = (void *) &NAME##_nfc_ndef_bin_payload_desc \
}
/** @brief Macro for accessing the NFC NDEF record descriptor instance
* that you created with @ref NFC_NDEF_RECORD_BIN_DATA_DEF.
*/
#define NFC_NDEF_RECORD_BIN_DATA(NAME) (NAME##_nfc_ndef_bin_record_desc)
/** @brief Macro for accessing the binary data descriptor that contains
* the payload of the record that you created with @ref NFC_NDEF_RECORD_BIN_DATA_DEF.
*/
#define NFC_NDEF_BIN_PAYLOAD_DESC(NAME) (NAME##_nfc_ndef_bin_payload_desc)
/**
* @brief Function for encoding an NDEF record.
*
* This function encodes an NDEF record according to the provided record descriptor.
*
* @param[in] p_ndef_record_desc Pointer to the record descriptor.
* @param[in] record_location Location of the record within the NDEF message.
* @param[out] p_record_buffer Pointer to the record destination. If NULL, function will
* calculate the expected size of the record.
* @param[in,out] p_record_len Size of the available memory for the record as input. Size of the generated
* record as output.
*
* @retval NRF_SUCCESS If the record was encoded successfully.
* @retval NRF_ERROR_NO_MEM If the predicted record size is bigger than the provided buffer space.
* @retval NRF_ERROR_INVALID_PARAM If the location of the record is erroneous.
* @retval Other Other codes might be returned depending on the NDEF record payload constructor implementation.
*/
ret_code_t nfc_ndef_record_encode(nfc_ndef_record_desc_t const * p_ndef_record_desc,
nfc_ndef_record_location_t record_location,
uint8_t * p_record_buffer,
uint32_t * p_record_len);
/**
* @brief Function for constructing the payload for an NFC NDEF record from binary data.
*
* This function copies data from a binary buffer to the payload field of the NFC NDEF record.
*
* @param[in] p_payload_descriptor Pointer to the descriptor of the binary data location and size.
*
* @param[out] p_buffer Pointer to the payload destination. If NULL, function will
* calculate the expected size of the record payload.
* @param[in,out] p_len Size of the available memory for the payload as input. Size of the copied payload
* as output.
*
* @retval NRF_SUCCESS If the function completed successfully.
* @retval NRF_ERROR_NO_MEM If the payload size is bigger than the provided buffer space.
*/
ret_code_t nfc_ndef_bin_payload_memcopy(nfc_ndef_bin_payload_desc_t * p_payload_descriptor,
uint8_t * p_buffer,
uint32_t * p_len);
/**
* @}
*/
#ifdef __cplusplus
}
#endif
#endif // NFC_NDEF_RECORD_H__