ifx-ndef-record.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) 2024-2026 Infineon Technologies AG
// SPDX-License-Identifier: MIT
 
#ifndef IFX_NDEF_RECORD_H
#define IFX_NDEF_RECORD_H
 
#include <stddef.h>
#include <stdint.h>
#include "infineon/ifx-error.h"
#include "infineon/ifx-utils.h"
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
/* Macro definitions */
/* Definitions of function identifiers */
 
#define IFX_RECORD_SET                 UINT8_C(0x01)
 
#define IFX_RECORD_GET                 UINT8_C(0x02)
 
#define IFX_RECORD_REGISTER            UINT8_C(0x03)
 
#define IFX_RECORD_RETRIEVE            UINT8_C(0x04)
 
#define IFX_RECORD_DEREGISTER          UINT8_C(0x05)
 
#define IFX_RECORD_DATA_FIELD_NA       UINT8_C(0xF1)
 
#define IFX_RECORD_HEADER_MASK_SR_FLAG UINT8_C(0x10)
 
#define IFX_RECORD_HEADER_MASK_ID_FLAG UINT8_C(0x08)
 
#define IFX_RECORD_TNF_MASK            UINT8_C(0x27)
 
#define IFX_RECORD_TNF_TYPE_KNOWN      UINT8_C(0x01)
 
#define IFX_RECORD_TNF_TYPE_MEDIA      UINT8_C(0x02)
 
#define IFX_RECORD_TNF_TYPE_EXT        UINT8_C(0x04)
 
/* enum definitions */
 
typedef enum
{
    IFX_RECORD_TYPE_URI,             
    IFX_RECORD_TYPE_HANDOVER_SELECT, 
    IFX_RECORD_TYPE_ALT_CARRIER,     
    IFX_RECORD_TYPE_BT,              
    IFX_RECORD_TYPE_BLE,             
    IFX_RECORD_TYPE_ERROR,           
    IFX_RECORD_MAX                   
} ifx_ndef_record_type;
 
typedef struct
{
    uint8_t tnf;         
    uint8_t type_length; 
    uint32_t
        payload_length; 
    uint8_t id_length;  
    uint8_t *type;      
    uint8_t *id;        
    uint8_t
        *payload; 
} ifx_ndef_record_t;
 
/* function prototype declarations */
 
typedef ifx_status_t (*ifx_record_encoder_t)(const void *record_details,
                                             uint8_t **payload,
                                             uint32_t *payload_length);
 
typedef ifx_status_t (*ifx_record_decoder_t)(const uint8_t *payload,
                                             uint32_t payload_length,
                                             void *record_details);
 
typedef ifx_status_t (*ifx_record_deinit_t)(void *record_data);
 
/* Structure definitions */
 
typedef struct
{
    uint8_t tnf;     
    ifx_blob_t id;   
    ifx_blob_t type; 
    ifx_record_encoder_t
        encode_record; 
    ifx_record_decoder_t
        decode_record; 
    ifx_record_deinit_t
        deinit_record; 
    void *record_data; 
} ifx_record_handle_t;
 
typedef ifx_status_t (*ifx_record_init_handler_t)(ifx_record_handle_t *handle);
 
typedef struct
{
    uint8_t *type;        
    uint32_t type_length; 
    ifx_record_init_handler_t
        get_handle; 
} ifx_record_init_t;
 
/* public functions */
 
ifx_status_t ifx_ndef_record_set_record_id(ifx_record_handle_t *handle,
                                           const ifx_blob_t *record_id);
 
ifx_status_t ifx_ndef_record_get_record_id(const ifx_record_handle_t *handle,
                                           ifx_blob_t *record_id);
 
ifx_status_t ifx_ndef_record_retrieve_handle(uint8_t tnf, const uint8_t *type,
                                             uint32_t type_length,
                                             ifx_record_handle_t *handle);
 
ifx_status_t ifx_ndef_record_register_handle(ifx_record_init_t *init_handler);
 
ifx_status_t ifx_ndef_record_release_resource(void);
 
ifx_status_t ifx_ndef_record_dispose(ifx_record_handle_t *record_handle);
 
ifx_status_t ifx_ndef_record_dispose_list(ifx_record_handle_t *record_handles,
                                          uint32_t number_of_records);
 
#ifdef __cplusplus
}
 
#endif /* __cplusplus */
#endif /* IFX_NDEF_RECORD_H */