record.h

Go to the documentation of this file.

/*
 * Copyright (c) 2018 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
 */
 
#ifndef NFC_NDEF_RECORD_H_
#define NFC_NDEF_RECORD_H_
 
#include <zephyr/types.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define NDEF_RECORD_IL_MASK                0x08
#define NDEF_RECORD_TNF_MASK               0x07
#define NDEF_RECORD_SR_MASK                0x10
#define NDEF_RECORD_PAYLOAD_LEN_LONG_SIZE  4
#define NDEF_RECORD_PAYLOAD_LEN_SHORT_SIZE 1
#define NDEF_RECORD_ID_LEN_SIZE            1
 
typedef int (*payload_constructor_t)(void *payload_descriptor,
                                     uint8_t *buffer,
                                     uint32_t *len);
enum nfc_ndef_record_tnf {
        TNF_EMPTY         = 0x00,
        TNF_WELL_KNOWN    = 0x01,
        TNF_MEDIA_TYPE    = 0x02,
        TNF_ABSOLUTE_URI  = 0x03,
        TNF_EXTERNAL_TYPE = 0x04,
        TNF_UNKNOWN_TYPE  = 0x05,
        TNF_UNCHANGED     = 0x06,
        TNF_RESERVED      = 0x07,
};
 
struct nfc_ndef_record_desc {
        enum nfc_ndef_record_tnf tnf;
        uint8_t id_length;
        uint8_t const *id;
        uint8_t type_length;
        uint8_t const *type;
        payload_constructor_t payload_constructor;
        void *payload_descriptor;
};
 
enum nfc_ndef_record_location {
        NDEF_FIRST_RECORD  = 0x80, 
        NDEF_MIDDLE_RECORD = 0x00, 
        NDEF_LAST_RECORD   = 0x40, 
        NDEF_LONE_RECORD   = 0xC0  
};
 
#define NDEF_RECORD_LOCATION_MASK (NDEF_LONE_RECORD)
 
struct nfc_ndef_bin_payload_desc {
        uint8_t const *payload;  
        uint32_t payload_length; 
};
 
#define NFC_NDEF_GENERIC_RECORD_DESC_DEF(name,                              \
                                         tnf_arg,                           \
                                         id_arg,                            \
                                         id_len,                            \
                                         type_arg,                          \
                                         type_len,                          \
                                         payload_constructor_arg,           \
                                         payload_descriptor_arg)            \
        struct nfc_ndef_record_desc name##_ndef_generic_record_desc =       \
        {                                                                   \
                .tnf = tnf_arg,                                             \
                .id_length = id_len,                                        \
                .id = id_arg,                                               \
                .type_length = type_len,                                    \
                .type = type_arg,                                           \
                .payload_constructor  =                                     \
                        (payload_constructor_t)payload_constructor_arg,     \
                .payload_descriptor = (void *) payload_descriptor_arg       \
        }
 
#define NFC_NDEF_GENERIC_RECORD_DESC(name) (name##_ndef_generic_record_desc)
 
#define NFC_NDEF_RECORD_BIN_DATA_DEF(name,                                  \
                                     tnf_arg,                               \
                                     id_arg,                                \
                                     id_len,                                \
                                     type_arg,                              \
                                     type_len,                              \
                                     payload_arg,                           \
                                     payload_len)                           \
        struct nfc_ndef_bin_payload_desc name##_nfc_ndef_bin_payload_desc = \
        {                                                                   \
                .payload  = payload_arg,                                    \
                .payload_length = payload_len                               \
        };                                                                  \
                                                                            \
        struct nfc_ndef_record_desc name##_nfc_ndef_bin_record_desc =       \
        {                                                                   \
                .tnf = tnf_arg,                                             \
                .id_length = id_len,                                        \
                .id = id_arg,                                               \
                .type_length = type_len,                                    \
                .type = type_arg,                                           \
                .payload_constructor  =                                     \
                    (payload_constructor_t) nfc_ndef_bin_payload_memcopy,   \
                .payload_descriptor =                                       \
                    (void *) &name##_nfc_ndef_bin_payload_desc              \
        }
 
#define NFC_NDEF_RECORD_BIN_DATA(name) (name##_nfc_ndef_bin_record_desc)
 
#define NFC_NDEF_BIN_PAYLOAD_DESC(name) (name##_nfc_ndef_bin_payload_desc)
 
int nfc_ndef_record_encode(struct nfc_ndef_record_desc const *ndef_record_desc,
                           enum nfc_ndef_record_location const record_location,
                           uint8_t *record_buffer,
                           uint32_t *record_len);
 
int nfc_ndef_bin_payload_memcopy(
                        struct nfc_ndef_bin_payload_desc *payload_descriptor,
                        uint8_t *buffer,
                        uint32_t *len);
 
#ifdef __cplusplus
}
#endif
 
#endif /* NFC_NDEF_RECORD_H_ */