123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165 |
- /**
- * 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_HS_REC_H__
- #define NFC_HS_REC_H__
- /**@file
- *
- * @defgroup nfc_hs_rec Hs (Handover Select) records
- * @{
- * @ingroup nfc_ble_pair_msg
- *
- * @brief Generation of NFC NDEF Handover Select records for NDEF messages.
- *
- */
- #include <stdint.h>
- #include "nfc_ndef_record.h"
- #include "nfc_ndef_msg.h"
- #ifdef __cplusplus
- extern "C" {
- #endif
- /**
- * @brief Handover Select record payload descriptor.
- */
- typedef struct
- {
- uint8_t major_version; ///< Major version number of the supported Connection Handover specification.
- uint8_t minor_version; ///< Minor version number of the supported Connection Handover specification.
- nfc_ndef_msg_desc_t * p_local_records; ///< Pointer to a message encapsulating local records.
- } nfc_hs_rec_payload_desc_t;
- /**
- * @brief Constructor for an NFC NDEF Handover Select record payload.
- *
- * This function encodes the payload of a Handover Select record as specified in the Connection
- * Handover standard. It implements an API compatible with @ref p_payload_constructor_t.
- */
- ret_code_t nfc_hs_rec_payload_constructor(nfc_hs_rec_payload_desc_t * p_nfc_hs_rec_payload_desc,
- uint8_t * p_buff,
- uint32_t * p_len);
- /**
- * @brief An external reference to the type field of the Handover Select record, defined in the
- * file @c nfc_hs_rec.c. It is used in the @ref NFC_NDEF_HS_RECORD_DESC_DEF macro.
- */
- extern const uint8_t nfc_hs_rec_type_field[];
- /**
- * @brief Size of the type field of the Handover Select record, defined in the
- * file @c nfc_hs_rec.c. It is used in the @ref NFC_NDEF_HS_RECORD_DESC_DEF macro.
- */
- #define NFC_HS_REC_TYPE_LENGTH 2
- /**
- * @brief Macro for creating and initializing an NFC NDEF record descriptor for a Handover Select record.
- *
- * This macro creates and initializes an instance of type @ref nfc_ndef_record_desc_t and
- * an instance of type @ref nfc_hs_rec_payload_desc_t, which together constitute an instance of a Handover Select record.
- *
- * Use the macro @ref NFC_NDEF_HS_RECORD_DESC to access the NDEF Handover Select 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] MAJOR_VERSION Major version number of the supported Connection Handover specification.
- * @param[in] MINOR_VERSION Minor version number of the supported Connection Handover specification.
- * @param[in] MAX_RECORDS Maximum number of local records (ac records plus optional err record).
- */
- #define NFC_NDEF_HS_RECORD_DESC_DEF(NAME, \
- MAJOR_VERSION, \
- MINOR_VERSION, \
- MAX_RECORDS) \
- NFC_NDEF_MSG_DEF(NAME, MAX_RECORDS); \
- nfc_hs_rec_payload_desc_t NAME##_nfc_hs_rec_payload_desc = \
- { \
- .major_version = MAJOR_VERSION, \
- .minor_version = MINOR_VERSION, \
- .p_local_records = &NFC_NDEF_MSG(NAME) \
- }; \
- NFC_NDEF_GENERIC_RECORD_DESC_DEF(NAME, \
- TNF_WELL_KNOWN, \
- 0, \
- 0, \
- nfc_hs_rec_type_field, \
- NFC_HS_REC_TYPE_LENGTH, \
- nfc_hs_rec_payload_constructor, \
- &(NAME##_nfc_hs_rec_payload_desc))
- /**
- * @brief Macro for accessing the NFC NDEF Handover Select record descriptor
- * instance that was created with @ref NFC_NDEF_HS_RECORD_DESC_DEF.
- */
- #define NFC_NDEF_HS_RECORD_DESC(NAME) NFC_NDEF_GENERIC_RECORD_DESC(NAME)
- /**
- * @brief Function for clearing local records in the NFC NDEF Handover Select record.
- *
- * This function clears local records from the Handover Select record.
- *
- * @param[in, out] p_hs_rec Pointer to the Handover Select record descriptor.
- */
- void nfc_hs_rec_local_record_clear(nfc_ndef_record_desc_t * p_hs_rec);
- /**
- * @brief Function for adding a local record to an NFC NDEF Handover Select record.
- *
- * @param[in, out] p_hs_rec Pointer to a Handover Select record.
- * @param[in] p_local_rec Pointer to a local record to add.
- *
- * @retval NRF_SUCCESS If the local record was added successfully.
- * @retval NRF_ERROR_NO_MEM If the Handover Select record already contains the maximum number of local records.
- */
- ret_code_t nfc_hs_rec_local_record_add(nfc_ndef_record_desc_t * p_hs_rec,
- nfc_ndef_record_desc_t * p_local_rec);
- /** @} */
- #ifdef __cplusplus
- }
- #endif
- #endif // NFC_HS_REC_H__
|