ch.h

Go to the documentation of this file.

/*
 * Copyright (c) 2020 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
 */
 
#ifndef NFC_NDEF_CH_H_
#define NFC_NDEF_CH_H_
 
#include <stdint.h>
#include <string.h>
#include <zephyr/types.h>
#include <nfc/ndef/record.h>
#include <nfc/ndef/msg.h>
#include <nfc/ndef/payload_type_common.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define NFC_NDEF_CH_REC_TYPE_LENGTH 2
 
struct nfc_ndef_ch_hc_rec {
        enum nfc_ndef_record_tnf ctf;
 
        struct {
                uint8_t type_len;
 
                const uint8_t *type;
 
                uint8_t data_len;
 
                uint8_t *data;
        } carrier;
};
 
enum nfc_ndef_ch_ac_rec_cps {
        NFC_AC_CPS_INACTIVE     = 0x00,
 
        NFC_AC_CPS_ACTIVE       = 0x01,
 
        NFC_AC_CPS_ACTIVATING   = 0x02,
 
        NFC_AC_CPS_UNKNOWN      = 0x03
};
 
#define NFC_NDEF_CH_AC_CPS_MASK (NFC_AC_CPS_UNKNOWN)
 
struct nfc_ndef_ch_ac_rec_ref {
        uint8_t length;
 
        const uint8_t *data;
};
 
struct nfc_ndef_ch_ac_rec {
        enum nfc_ndef_ch_ac_rec_cps cps;
 
        struct nfc_ndef_ch_ac_rec_ref carrier_data_ref;
 
        const uint8_t max_aux_data_ref_cnt;
 
        uint8_t aux_data_ref_cnt;
 
        struct nfc_ndef_ch_ac_rec_ref *aux_data_ref;
};
 
struct nfc_ndef_ch_cr_rec {
        uint16_t random;
};
 
struct nfc_ndef_ch_rec {
        uint8_t major_version;
 
        uint8_t minor_version;
 
        struct nfc_ndef_msg_desc *local_records;
};
 
int nfc_ndef_ch_rec_payload_encode(const struct nfc_ndef_ch_rec *ch_rec,
                                   uint8_t *buf, uint32_t *len);
 
#define NFC_NDEF_CH_RECORD_DESC_DEF(_name,                               \
                                    _rec_type_field,                     \
                                    _major_version,                      \
                                    _minor_version,                      \
                                    _max_records)                        \
        NFC_NDEF_MSG_DEF(_name, _max_records);                           \
        struct nfc_ndef_ch_rec _name##_nfc_ch_rec = {                    \
                .major_version = _major_version,                         \
                .minor_version = _minor_version,                         \
                .local_records = &NFC_NDEF_MSG(_name)                    \
        };                                                               \
        NFC_NDEF_GENERIC_RECORD_DESC_DEF(_name,                          \
                                         TNF_WELL_KNOWN,                 \
                                         0,                              \
                                         0,                              \
                                         _rec_type_field,                \
                                         NFC_NDEF_CH_REC_TYPE_LENGTH,    \
                                         nfc_ndef_ch_rec_payload_encode, \
                                         &(_name##_nfc_ch_rec))
 
#define NFC_NDEF_CH_HS_RECORD_DESC_DEF(_name,                      \
                                       _major_version,             \
                                       _minor_version,             \
                                       _max_records)               \
        NFC_NDEF_CH_RECORD_DESC_DEF(_name,                         \
                                    nfc_ndef_ch_hs_rec_type_field, \
                                    _major_version,                \
                                    _minor_version,                \
                                    _max_records)
 
#define NFC_NDEF_CH_HR_RECORD_DESC_DEF(_name,                      \
                                       _major_version,             \
                                       _minor_version,             \
                                       _max_records)               \
        NFC_NDEF_CH_RECORD_DESC_DEF(_name,                         \
                                    nfc_ndef_ch_hr_rec_type_field, \
                                    _major_version,                \
                                    _minor_version,                \
                                    _max_records)
 
#define NFC_NDEF_CH_HM_RECORD_DESC_DEF(_name,                      \
                                       _major_version,             \
                                       _minor_version,             \
                                       _max_records)               \
        NFC_NDEF_CH_RECORD_DESC_DEF(_name,                         \
                                    nfc_ndef_ch_hm_rec_type_field, \
                                    _major_version,                \
                                    _minor_version,                \
                                    _max_records)
 
#define NFC_NDEF_CH_HI_RECORD_DESC_DEF(_name,                      \
                                       _major_version,             \
                                       _minor_version,             \
                                       _max_records)               \
        NFC_NDEF_CH_RECORD_DESC_DEF(_name,                         \
                                    nfc_ndef_ch_hi_rec_type_field, \
                                    _major_version,                \
                                    _minor_version,                \
                                    _max_records)
 
#define NFC_NDEF_CH_RECORD_DESC(_name) NFC_NDEF_GENERIC_RECORD_DESC(_name)
 
void nfc_ndef_ch_rec_local_record_clear(struct nfc_ndef_record_desc *ch_rec);
 
int nfc_ndef_ch_rec_local_record_add(struct nfc_ndef_record_desc *ch_rec,
                                     const struct nfc_ndef_record_desc *local_rec);
 
int nfc_ndef_ch_hc_rec_payload_encode(const struct nfc_ndef_ch_hc_rec *hc_rec,
                                      uint8_t *buf, uint32_t *len);
 
#define NFC_NDEF_CH_HC_RECORD_DESC_DEF(_name,                               \
                                       _payload_id,                         \
                                       _payload_id_length,                  \
                                       _payload_desc)                       \
                                                                            \
        NFC_NDEF_GENERIC_RECORD_DESC_DEF(_name,                             \
                                         TNF_WELL_KNOWN,                    \
                                         _payload_id,                       \
                                         _payload_id_length,                \
                                         nfc_ndef_ch_hc_rec_type_field,     \
                                         NFC_NDEF_CH_REC_TYPE_LENGTH,       \
                                         nfc_ndef_ch_hc_rec_payload_encode, \
                                         (_payload_desc))
 
#define NFC_NDEF_CH_HC_RECORD_DESC(_name) NFC_NDEF_GENERIC_RECORD_DESC(_name)
 
int nfc_ndef_ch_ac_rec_payload_encode(const struct nfc_ndef_ch_ac_rec *nfc_rec_ac,
                                      uint8_t *buf, uint32_t *len);
 
#define NFC_NDEF_CH_AC_RECORD_DESC_DEF(_name,                               \
                                       _cps,                                \
                                       _carr_data_ref_len,                  \
                                       _carr_data_ref,                      \
                                       _max_aux_data_ref_cnt)               \
        struct nfc_ndef_ch_ac_rec_ref                                       \
                _name##nfc_ndef_ch_ac_rec_ref[_max_aux_data_ref_cnt];       \
        struct nfc_ndef_ch_ac_rec                                           \
                _name##_nfc_ac_rec = {                                      \
                .cps = _cps,                                                \
                .carrier_data_ref = { _carr_data_ref_len, _carr_data_ref }, \
                .max_aux_data_ref_cnt = _max_aux_data_ref_cnt,              \
                .aux_data_ref_cnt = 0,                                      \
                .aux_data_ref = _name##nfc_ndef_ch_ac_rec_ref               \
        };                                                                  \
        NFC_NDEF_GENERIC_RECORD_DESC_DEF(_name,                             \
                                         TNF_WELL_KNOWN,                    \
                                         0,                                 \
                                         0,                                 \
                                         nfc_ndef_ch_ac_rec_type_field,     \
                                         NFC_NDEF_CH_REC_TYPE_LENGTH,       \
                                         nfc_ndef_ch_ac_rec_payload_encode, \
                                         &(_name##_nfc_ac_rec))
 
#define NFC_NDEF_CH_AC_RECORD_DESC(_name) NFC_NDEF_GENERIC_RECORD_DESC(_name)
 
void nfc_ndef_ch_ac_rec_auxiliary_data_ref_clear(struct nfc_ndef_record_desc *ac_rec);
 
int nfc_ndef_ch_ac_rec_auxiliary_data_ref_add(struct nfc_ndef_record_desc *ac_rec,
                                              const uint8_t *aux_data,
                                              uint8_t aux_length);
 
int nfc_ndef_ch_cr_rec_payload_encode(const struct nfc_ndef_ch_cr_rec *nfc_rec_cr,
                                      uint8_t *buf, uint32_t *len);
 
#define NFC_NDEF_CH_CR_RECORD_DESC_DEF(_name,                               \
                                       _random_number)                      \
        struct nfc_ndef_ch_cr_rec                                           \
                _name##_nfc_cr_rec = {                                      \
                .random = _random_number,                                   \
        };                                                                  \
        NFC_NDEF_GENERIC_RECORD_DESC_DEF(_name,                             \
                                         TNF_WELL_KNOWN,                    \
                                         0,                                 \
                                         0,                                 \
                                         nfc_ndef_ch_cr_rec_type_field,     \
                                         NFC_NDEF_CH_REC_TYPE_LENGTH,       \
                                         nfc_ndef_ch_cr_rec_payload_encode, \
                                         &(_name##_nfc_cr_rec))
 
#define NFC_NDEF_CR_RECORD_DESC(_name) NFC_NDEF_GENERIC_RECORD_DESC(_name)
 
#ifdef __cplusplus
}
#endif
 
#endif /* NFC_NDEF_CH_H_ */