GitHub/nrf51_2in13_epd
1
0
Fork 0
mirror of https://gitee.com/muyuchl/nrf51_2in13_epd.git synced 2025-12-15 02:08:12 +08:00
Code Issues Packages Projects Releases Wiki Activity

copy project from century 2in6 esl project

Browse Source
This commit is contained in:
muyuchl
2025-04-26 13:14:26 +08:00
commit 2c9b333b97
1507 changed files with 460409 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

94
COMPONENTS/nfc/ndef/parser/message/nfc_ndef_msg_parser.c Normal file
View File

@@ -0,0 +1,94 @@
/**
* Copyright (c) 2016 - 2017, 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_PARSER)
#include "nfc_ndef_msg_parser.h"
#include "nrf_delay.h"
#define NRF_LOG_MODULE_NAME "NFC_NDEF_MSG_PARSER"
#if NFC_NDEF_MSG_PARSER_LOG_ENABLED
#define NRF_LOG_LEVEL NFC_NDEF_MSG_PARSER_LOG_LEVEL
#define NRF_LOG_INFO_COLOR NFC_NDEF_MSG_PARSER_INFO_COLOR
#else // NFC_NDEF_MSG_PARSER_LOG_ENABLED
#define NRF_LOG_LEVEL 0
#endif // NFC_NDEF_MSG_PARSER_LOG_ENABLED
#include "nrf_log.h"
ret_code_t ndef_msg_parser(uint8_t * const p_result_buf,
uint32_t * const p_result_buf_len,
uint8_t * const p_nfc_data,
uint32_t * const p_nfc_data_len)
{
ret_code_t ret_code;
nfc_ndef_parser_memo_desc_t parser_memory_helper;
ret_code = ndef_parser_memo_resolve(p_result_buf,
p_result_buf_len,
&parser_memory_helper);
if (ret_code != NRF_SUCCESS)
{
return ret_code;
}
ret_code = internal_ndef_msg_parser(&parser_memory_helper,
p_nfc_data,
p_nfc_data_len);
return ret_code;
}
void ndef_msg_printout(nfc_ndef_msg_desc_t * const p_msg_desc)
{
uint32_t i;
nrf_delay_ms(100);
NRF_LOG_INFO("NDEF message contains %d record(s)\r\n\r\n", p_msg_desc->record_count);
for (i = 0; i < p_msg_desc->record_count; i++)
{
ndef_record_printout(i, p_msg_desc->pp_record[i]);
}
}
#endif // NRF_MODULE_ENABLED(NFC_NDEF_MSG_PARSER)

124
COMPONENTS/nfc/ndef/parser/message/nfc_ndef_msg_parser.h Normal file
View File

@@ -0,0 +1,124 @@
/**
* Copyright (c) 2016 - 2017, 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_PARSER_H__
#define NFC_NDEF_MSG_PARSER_H__
/**@file
*
* @defgroup nfc_ndef_parser NDEF message parser
* @{
* @ingroup nfc_modules
*
* @brief Parser for NFC NDEF messages and records.
*
* @defgroup nfc_ndef_msg_parser Parser for NDEF messages
* @{
* @ingroup nfc_ndef_parser
*
* @brief Parser for NFC NDEF messages.
*
*/
#include <stdint.h>
#include "nfc_ndef_msg_parser_local.h"
#ifdef __cplusplus
extern "C" {
#endif
/**
* @brief Macro for calculating the memory size required for holding the
* description of a message that consists of a certain number of NDEF records.
*
* @param[in] max_count_of_records Maximum number of records to hold.
*/
#define NFC_NDEF_PARSER_REQIRED_MEMO_SIZE_CALC(max_count_of_records) \
((uint32_t)(max_count_of_records) <= 1) ? \
(sizeof(parsed_ndef_msg_1_t) * (uint32_t)(max_count_of_records)) : \
(sizeof(parsed_ndef_msg_1_t) + ((NFC_PARSER_M_DELTA) *((uint32_t)(max_count_of_records) - 1)))
/**
* @brief Function for parsing NFC NDEF messages.
*
* This function parses NDEF messages using NDEF binary record descriptors.
*
* @param[out] p_result_buf Pointer to the buffer that will be used to hold
* the NDEF message descriptor. After parsing is completed successfully, the first address
* in the buffer is filled by the NDEF message descriptor
* (@ref nfc_ndef_msg_desc_t), which provides a full description of
* the parsed NDEF message.
* @param[in,out] p_result_buf_len As input: size of the buffer specified by @p p_result_buf.
* As output: size of the reserved (used) part of the buffer specified by
* @p p_result_buf.
* @param[in] p_nfc_data Pointer to the data to be parsed.
* @param[in,out] p_nfc_data_len As input: size of the NFC data in the @p p_nfc_data buffer. As output: size of the parsed message.
*
* @retval NRF_SUCCESS If the function completed successfully.
* @retval NRF_ERROR_NO_MEM If the provided buffer is too small to hold a one-record message or
* the buffer is too small to hold the actual result of the parsing.
* @retval NRF_ERROR_INVALID_LENGTH If the expected message length is bigger than the amount of the provided input data.
* @retval NRF_ERROR_INVALID_DATA If the message is not a valid NDEF message.
*/
ret_code_t ndef_msg_parser(uint8_t * const p_result_buf,
uint32_t * const p_result_buf_len,
uint8_t * const p_nfc_data,
uint32_t * const p_nfc_data_len);
/**
* @brief Function for printing the parsed contents of an NDEF message.
*
* @param[in] p_msg_desc Pointer to the descriptor of the message that should be printed.
*/
void ndef_msg_printout(nfc_ndef_msg_desc_t * const p_msg_desc);
/**
* @}
* @}
*/
#ifdef __cplusplus
}
#endif
#endif // NFC_NDEF_MSG_PARSER_H__

164
COMPONENTS/nfc/ndef/parser/message/nfc_ndef_msg_parser_local.c Normal file
View File

@@ -0,0 +1,164 @@
/**
* Copyright (c) 2016 - 2017, 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_PARSER)
#include "nfc_ndef_msg_parser_local.h"
ret_code_t internal_ndef_msg_parser(nfc_ndef_parser_memo_desc_t * const p_parser_memo_desc,
uint8_t const * p_nfc_data,
uint32_t * const p_nfc_data_len)
{
nfc_ndef_record_location_t record_location;
ret_code_t ret_code;
uint32_t nfc_data_left = *p_nfc_data_len;
uint32_t temp_nfc_data_len = 0;
// want to modify -> use local copy
nfc_ndef_bin_payload_desc_t * p_bin_pay_desc = p_parser_memo_desc->p_bin_pay_desc;
nfc_ndef_record_desc_t * p_rec_desc = p_parser_memo_desc->p_rec_desc;
while (nfc_data_left > 0)
{
temp_nfc_data_len = nfc_data_left;
ret_code = ndef_record_parser(p_bin_pay_desc,
p_rec_desc,
&record_location,
p_nfc_data,
&temp_nfc_data_len);
if (ret_code != NRF_SUCCESS)
{
return ret_code;
}
// verify the records location flags
if (p_parser_memo_desc->p_msg_desc->record_count == 0)
{
if ((record_location != NDEF_FIRST_RECORD) && (record_location != NDEF_LONE_RECORD))
{
return NRF_ERROR_INVALID_DATA;
}
}
else
{
if ((record_location != NDEF_MIDDLE_RECORD) && (record_location != NDEF_LAST_RECORD))
{
return NRF_ERROR_INVALID_DATA;
}
}
ret_code = nfc_ndef_msg_record_add(p_parser_memo_desc->p_msg_desc, p_rec_desc);
if (ret_code != NRF_SUCCESS)
{
return ret_code;
}
nfc_data_left -= temp_nfc_data_len;
if ((record_location == NDEF_LAST_RECORD) || (record_location == NDEF_LONE_RECORD))
{
*p_nfc_data_len = *p_nfc_data_len - nfc_data_left;
return NRF_SUCCESS;
}
else
{
if (p_parser_memo_desc->p_msg_desc->record_count ==
p_parser_memo_desc->p_msg_desc->max_record_count)
{
return NRF_ERROR_NO_MEM;
}
p_nfc_data += temp_nfc_data_len;
p_bin_pay_desc++;
p_rec_desc++;
}
}
return NRF_ERROR_INVALID_DATA;
}
ret_code_t ndef_parser_memo_resolve(uint8_t * const p_result_buf,
uint32_t * const p_result_buf_len,
nfc_ndef_parser_memo_desc_t * const p_parser_memo_desc)
{
uint32_t max_rec_num;
uint32_t memory_last;
uint8_t * p_end;
nfc_ndef_record_desc_t * * pp_record_desc_array;
if (*p_result_buf_len < sizeof(parsed_ndef_msg_1_t))
{
return NRF_ERROR_NO_MEM;
}
memory_last = (*p_result_buf_len) - sizeof(parsed_ndef_msg_1_t);
max_rec_num = (memory_last / (NFC_PARSER_M_DELTA)) + 1;
p_parser_memo_desc->p_msg_desc = (nfc_ndef_msg_desc_t *) p_result_buf;
pp_record_desc_array =
(nfc_ndef_record_desc_t * *) &p_parser_memo_desc->p_msg_desc[1];
p_parser_memo_desc->p_bin_pay_desc =
(nfc_ndef_bin_payload_desc_t *) &pp_record_desc_array[max_rec_num];
p_parser_memo_desc->p_rec_desc =
(nfc_ndef_record_desc_t *) &p_parser_memo_desc->p_bin_pay_desc[max_rec_num];
// initialize message description
p_parser_memo_desc->p_msg_desc->pp_record = pp_record_desc_array;
p_parser_memo_desc->p_msg_desc->max_record_count = max_rec_num;
p_parser_memo_desc->p_msg_desc->record_count = 0;
p_end = (uint8_t *) &p_parser_memo_desc->p_rec_desc[max_rec_num];
*p_result_buf_len = p_end - p_result_buf;
return NRF_SUCCESS;
}
#endif // NRF_MODULE_ENABLED(NFC_NDEF_MSG_PARSER)

168
COMPONENTS/nfc/ndef/parser/message/nfc_ndef_msg_parser_local.h Normal file
View File

@@ -0,0 +1,168 @@
/**
* Copyright (c) 2016 - 2017, 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_PARSER_LOCAL_H__
#define NFC_NDEF_MSG_PARSER_LOCAL_H__
/**@file
*
* @defgroup nfc_ndef_msg_parser_local NDEF message parser (internal)
* @{
* @ingroup nfc_ndef_msg_parser
*
* @brief Internal part of the parser for NFC NDEF messages.
*
*/
#include <stdint.h>
#include "nfc_ndef_msg.h"
#include "nfc_ndef_record_parser.h"
#ifdef __cplusplus
extern "C" {
#endif
/**
* @brief Type for holding descriptors that are used by the NDEF parser.
*/
typedef struct
{
nfc_ndef_msg_desc_t * p_msg_desc; ///< Pointer to the message descriptor.
nfc_ndef_bin_payload_desc_t * p_bin_pay_desc; ///< Pointer to the array of binary payload descriptors.
nfc_ndef_record_desc_t * p_rec_desc; ///< Pointer to the array of record descriptors.
} nfc_ndef_parser_memo_desc_t;
/**
* @brief Memory allocated for a one-record message.
*/
typedef struct
{
nfc_ndef_msg_desc_t msg_desc;
nfc_ndef_record_desc_t * p_record_desc_array[1];
nfc_ndef_bin_payload_desc_t bin_pay_desc[1];
nfc_ndef_record_desc_t rec_desc[1];
} parsed_ndef_msg_1_t;
/**
* @brief Memory allocated for a two-record message.
*/
typedef struct
{
nfc_ndef_msg_desc_t msg_desc;
nfc_ndef_record_desc_t * p_record_desc_array[2];
nfc_ndef_bin_payload_desc_t bin_pay_desc[2];
nfc_ndef_record_desc_t rec_desc[2];
} parsed_ndef_msg_2_t;
/**
* @brief Amount of memory that is required per record in addition to the memory allocated for the message descriptor.
*/
#define NFC_PARSER_M_DELTA (sizeof(parsed_ndef_msg_2_t) - sizeof(parsed_ndef_msg_1_t))
/**
* @brief Function for resolving data instances in the provided buffer according
* to requirements of the function @ref internal_ndef_msg_parser.
*
* This internal function distributes the provided memory between certain data instances that are required
* by @ref internal_ndef_msg_parser.
*
* This function should not be used directly.
*
* @param[in] p_result_buf Pointer to the buffer that will be used to allocate
* data instances.
* @param[in,out] p_result_buf_len As input: size of the buffer specified by @p p_result_buf.
* As output: size of the reserved (used) part of the buffer specified by
* @p p_result_buf.
* @param[out] p_parser_memo_desc Pointer to the structure for holding descriptors of the allocated data
* instances.
*
* @retval NRF_SUCCESS If the function completed successfully.
* @retval NRF_ERROR_NO_MEM If the provided buffer is too small to hold a one-record message.
*/
ret_code_t ndef_parser_memo_resolve(uint8_t * const p_result_buf,
uint32_t * const p_result_buf_len,
nfc_ndef_parser_memo_desc_t * const p_parser_memo_desc);
/**
* @brief Function for parsing NFC NDEF messages.
*
* This internal function parses NDEF messages into certain data instances.
*
* This function should not be used directly.
*
* @param[in,out] p_parser_memo_desc Pointer to the structure that holds descriptors of the allocated data
* instances for the parser. This structure contains the following fields: @n
* .p_msg_desc Pointer to the message descriptor that will
* be filled with parsed data. @n
* .p_bin_pay_desc Pointer to the array of binary payload
* descriptors that will be filled with parsed
* data. @n
* .p_rec_desc Pointer to the array of record descriptors
* that will be filled with parsed data. @n
* The arrays specified by @p .p_bin_pay_desc and @p .p_rec_desc must not
* contain more elements than the message descriptor
* specified by \p .p_msg_desc can hold.
*
* @param[in] p_nfc_data Pointer to the data to be parsed.
* @param[in,out] p_nfc_data_len As input: size of the NFC data in the @p p_nfc_data buffer.
* As output: size of the parsed message.
*
* @retval NRF_SUCCESS If the function completed successfully.
* @retval NRF_ERROR_INVALID_LENGTH If the expected message length is bigger than the amount of provided input data.
* @retval NRF_ERROR_INVALID_DATA If the message is not a valid NDEF message.
* @retval NRF_ERROR_NO_MEM If the provided memory resources are too small to hold the parsing result.
*/
ret_code_t internal_ndef_msg_parser(nfc_ndef_parser_memo_desc_t * const p_parser_memo_desc,
uint8_t const * p_nfc_data,
uint32_t * const p_nfc_data_len);
/**
* @}
*/
#ifdef __cplusplus
}
#endif
#endif // NFC_NDEF_MSG_PARSER_LOCAL_H__

219
COMPONENTS/nfc/ndef/parser/record/nfc_ndef_record_parser.c Normal file
View File

@@ -0,0 +1,219 @@
/**
* Copyright (c) 2016 - 2017, 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_RECORD_PARSER)
#include <stdint.h>
#include <stdbool.h>
#include "nfc_ndef_record_parser.h"
#include "app_util.h"
#include "nordic_common.h"
#include "nrf_delay.h"
#define NRF_LOG_MODULE_NAME "NFC_NDEF_PARSER"
#if NFC_NDEF_RECORD_PARSER_LOG_ENABLED
#define NRF_LOG_LEVEL NFC_NDEF_RECORD_PARSER_LOG_LEVEL
#define NRF_LOG_INFO_COLOR NFC_NDEF_RECORD_PARSER_INFO_COLOR
#else // NFC_NDEF_RECORD_PARSER_LOG_ENABLED
#define NRF_LOG_LEVEL 0
#endif // NFC_NDEF_RECORD_PARSER_LOG_ENABLED
#include "nrf_log.h"
/* Sum of sizes of fields: TNF-flags, Type Length, Payload Length in short NDEF record. */
#define NDEF_RECORD_BASE_LONG_SHORT (2 + NDEF_RECORD_PAYLOAD_LEN_SHORT_SIZE)
ret_code_t ndef_record_parser(nfc_ndef_bin_payload_desc_t * p_bin_pay_desc,
nfc_ndef_record_desc_t * p_rec_desc,
nfc_ndef_record_location_t * p_record_location,
uint8_t const * p_nfc_data,
uint32_t * p_nfc_data_len)
{
uint32_t expected_rec_size = NDEF_RECORD_BASE_LONG_SHORT;
if (expected_rec_size > *p_nfc_data_len)
{
return NRF_ERROR_INVALID_LENGTH;
}
p_rec_desc->tnf = (nfc_ndef_record_tnf_t) ((*p_nfc_data) & NDEF_RECORD_TNF_MASK);
/* An NDEF parser that receives an NDEF record with an unknown or unsupported TNF field value
SHOULD treat it as Unknown. See NFCForum-TS-NDEF_1.0 */
if (p_rec_desc->tnf == TNF_RESERVED)
{
p_rec_desc->tnf = TNF_UNKNOWN_TYPE;
}
*p_record_location = (nfc_ndef_record_location_t) ((*p_nfc_data) & NDEF_RECORD_LOCATION_MASK);
uint8_t flags = *(p_nfc_data++);
p_rec_desc->type_length = *(p_nfc_data++);
uint32_t payload_lenght;
if (flags & NDEF_RECORD_SR_MASK)
{
payload_lenght = *(p_nfc_data++);
}
else
{
expected_rec_size +=
NDEF_RECORD_PAYLOAD_LEN_LONG_SIZE - NDEF_RECORD_PAYLOAD_LEN_SHORT_SIZE;
if (expected_rec_size > *p_nfc_data_len)
{
return NRF_ERROR_INVALID_LENGTH;
}
payload_lenght = uint32_big_decode(p_nfc_data);
p_nfc_data += NDEF_RECORD_PAYLOAD_LEN_LONG_SIZE;
}
if (flags & NDEF_RECORD_IL_MASK)
{
expected_rec_size += NDEF_RECORD_ID_LEN_SIZE;
if (expected_rec_size > *p_nfc_data_len)
{
return NRF_ERROR_INVALID_LENGTH;
}
p_rec_desc->id_length = *(p_nfc_data++);
}
else
{
p_rec_desc->id_length = 0;
p_rec_desc->p_id = NULL;
}
expected_rec_size += p_rec_desc->type_length + p_rec_desc->id_length + payload_lenght;
if (expected_rec_size > *p_nfc_data_len)
{
return NRF_ERROR_INVALID_LENGTH;
}
if (p_rec_desc->type_length > 0)
{
p_rec_desc->p_type = p_nfc_data;
p_nfc_data += p_rec_desc->type_length;
}
else
{
p_rec_desc->p_type = NULL;
}
if (p_rec_desc->id_length > 0)
{
p_rec_desc->p_id = p_nfc_data;
p_nfc_data += p_rec_desc->id_length;
}
if (payload_lenght == 0)
{
p_bin_pay_desc->p_payload = NULL;
}
else
{
p_bin_pay_desc->p_payload = p_nfc_data;
}
p_bin_pay_desc->payload_length = payload_lenght;
p_rec_desc->p_payload_descriptor = p_bin_pay_desc;
p_rec_desc->payload_constructor = (p_payload_constructor_t) nfc_ndef_bin_payload_memcopy;
*p_nfc_data_len = expected_rec_size;
return NRF_SUCCESS;
}
char const * const tnf_strings[] =
{
"Empty\r\n",
"NFC Forum well-known type\r\n",
"Media-type (RFC 2046)\r\n",
"Absolute URI (RFC 3986)\r\n",
"NFC Forum external type (NFC RTD)\r\n",
"Unknown\r\n",
"Unchanged\r\n",
"Reserved\r\n"
};
void ndef_record_printout(uint32_t num, nfc_ndef_record_desc_t * const p_rec_desc)
{
NRF_LOG_INFO("NDEF record %d content:\r\n", num);
NRF_LOG_INFO("TNF: %s",(uint32_t)tnf_strings[p_rec_desc->tnf]);
if (p_rec_desc->p_id != NULL)
{
NRF_LOG_INFO("ID:\r\n");
NRF_LOG_HEXDUMP_INFO((uint8_t *)p_rec_desc->p_id, p_rec_desc->id_length);
}
if (p_rec_desc->p_type != NULL)
{
NRF_LOG_INFO("type:\r\n");
NRF_LOG_HEXDUMP_INFO((uint8_t *)p_rec_desc->p_type, p_rec_desc->type_length);
}
if (p_rec_desc->payload_constructor == (p_payload_constructor_t) nfc_ndef_bin_payload_memcopy)
{
nfc_ndef_bin_payload_desc_t * p_bin_pay_desc = p_rec_desc->p_payload_descriptor;
if (p_bin_pay_desc->p_payload != NULL)
{
NRF_LOG_INFO("Payload data (%d bytes):\r\n", p_bin_pay_desc->payload_length);
NRF_LOG_HEXDUMP_INFO((uint8_t *)p_bin_pay_desc->p_payload, p_bin_pay_desc->payload_length);
}
else
{
NRF_LOG_INFO("No payload\r\n");
}
}
NRF_LOG_INFO("\r\n\r\n");
}
#endif // NRF_MODULE_ENABLED(NFC_NDEF_RECORD_PARSER)

101
COMPONENTS/nfc/ndef/parser/record/nfc_ndef_record_parser.h Normal file
View File

@@ -0,0 +1,101 @@
/**
* Copyright (c) 2016 - 2017, 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_PARSER_H__
#define NFC_NDEF_RECORD_PARSER_H__
#include <stdint.h>
#include "sdk_errors.h"
#include "nfc_ndef_record.h"
#ifdef __cplusplus
extern "C" {
#endif
/**@file
*
* @defgroup nfc_ndef_record_parser Parser for NDEF records
* @{
* @ingroup nfc_ndef_parser
*
* @brief Parser for NFC NDEF records.
*
*/
/**
* @brief Function for parsing NDEF records.
*
* This parsing implementation uses the binary payload descriptor (@ref nfc_ndef_bin_payload_desc_t) to describe the payload for the record.
*
* @param[out] p_bin_pay_desc Pointer to the binary payload descriptor that will be filled and referenced by the record descriptor.
* @param[out] p_rec_desc Pointer to the record descriptor that will be filled with parsed data.
* @param[out] p_record_location Pointer to the record location.
* @param[in] p_nfc_data Pointer to the raw data to be parsed.
* @param[in,out] p_nfc_data_len As input: size of the NFC data in the @p p_nfc_data buffer. As output: size of the parsed record.
*
* @retval NRF_SUCCESS If the function completed successfully.
* @retval NRF_ERROR_INVALID_LENGTH If the expected record length is bigger than the provided input data amount.
*/
ret_code_t ndef_record_parser(nfc_ndef_bin_payload_desc_t * p_bin_pay_desc,
nfc_ndef_record_desc_t * p_rec_desc,
nfc_ndef_record_location_t * p_record_location,
uint8_t const * p_nfc_data,
uint32_t * p_nfc_data_len);
/**
* @brief Function for printing the parsed contents of the NDEF record.
*
* @param[in] num Sequence number of the record within the NDEF message.
* @param[in] p_rec_desc Pointer to the descriptor of the record that should be printed.
*
*/
void ndef_record_printout(uint32_t num, nfc_ndef_record_desc_t * const p_rec_desc);
/**
* @}
*/
#ifdef __cplusplus
}
#endif
#endif // NFC_NDEF_RECORD_PARSER_H__