driver_ntag21x.h

Go to the documentation of this file.

 
#ifndef DRIVER_NTAG21X_H
#define DRIVER_NTAG21X_H
 
#include <stdio.h>
#include <stdint.h>
#include <string.h>
 
#ifdef __cplusplus
extern "C"{
#endif



typedef enum
{
    NTAG21X_BOOL_FALSE = 0x00,        
    NTAG21X_BOOL_TRUE  = 0x01,        
} ntag21x_bool_t;

typedef enum
{
    NTAG21X_TYPE_INVALID = 0x00,        
    NTAG21X_TYPE_213_5_6 = 0x01,        
} ntag21x_type_t;

typedef enum
{
    NTAG21X_CAPABILITY_CONTAINER_144_BYTE_NTAG213 = 0x00,        
    NTAG21X_CAPABILITY_CONTAINER_496_BYTE_NTAG215 = 0x01,        
    NTAG21X_CAPABILITY_CONTAINER_872_BYTE_NTAG216 = 0x02,        
} ntag21x_capability_container_t;

typedef enum
{
    NTAG21X_MIRROR_NO_ASCII              = 0x00,        
    NTAG21X_MIRROR_UID_ASCII             = 0x01,        
    NTAG21X_MIRROR_NFC_COUNTER_ASCII     = 0x02,        
    NTAG21X_MIRROR_UID_NFC_COUNTER_ASCII = 0x03,        
} ntag21x_mirror_t;

typedef enum
{
    NTAG21X_MIRROR_BYTE_0 = 0x00,        
    NTAG21X_MIRROR_BYTE_1 = 0x01,        
    NTAG21X_MIRROR_BYTE_2 = 0x02,        
    NTAG21X_MIRROR_BYTE_3 = 0x03,        
} ntag21x_mirror_byte_t;

typedef enum
{
    NTAG21X_MODULATION_MODE_NORMAL = 0x00,        
    NTAG21X_MODULATION_MODE_STRONG = 0x01,        
} ntag21x_modulation_mode_t;

typedef enum
{
    NTAG21X_ACCESS_READ_PROTECTION                 = 7,        
    NTAG21X_ACCESS_USER_CONF_PROTECTION            = 6,        
    NTAG21X_ACCESS_NFC_COUNTER                     = 4,        
    NTAG21X_ACCESS_NFC_COUNTER_PASSWORD_PROTECTION = 3,        
} ntag21x_access_t;

typedef struct ntag21x_version_s
{
    uint8_t fixed_header;                 
    uint8_t vendor_id;                    
    uint8_t product_type;                 
    uint8_t product_subtype;              
    uint8_t major_product_version;        
    uint8_t minor_product_version;        
    uint8_t storage_size;                 
    uint8_t protocol_type;                
} ntag21x_version_t;

typedef struct ntag21x_handle_s
{
    uint8_t (*contactless_init)(void);                                             
    uint8_t (*contactless_deinit)(void);                                           
    uint8_t (*contactless_transceiver)(uint8_t *in_buf, uint8_t in_len, 
                                       uint8_t *out_buf, uint8_t *out_len);        
    void (*delay_ms)(uint32_t ms);                                                 
    void (*debug_print)(const char *const fmt, ...);                               
    uint8_t type;                                                                  
    uint8_t inited;                                                                
    uint8_t end_page;                                                              
} ntag21x_handle_t;

typedef struct ntag21x_info_s
{
    char chip_name[32];                
    char manufacturer_name[32];        
    char interface[8];                 
    float supply_voltage_min_v;        
    float supply_voltage_max_v;        
    float max_current_ma;              
    float temperature_min;             
    float temperature_max;             
    uint32_t driver_version;           
} ntag21x_info_t;



#define DRIVER_NTAG21X_LINK_INIT(HANDLE, STRUCTURE)                  memset(HANDLE, 0, sizeof(STRUCTURE))

#define DRIVER_NTAG21X_LINK_CONTACTLESS_INIT(HANDLE, FUC)           (HANDLE)->contactless_init = FUC

#define DRIVER_NTAG21X_LINK_CONTACTLESS_DEINIT(HANDLE, FUC)         (HANDLE)->contactless_deinit = FUC

#define DRIVER_NTAG21X_LINK_CONTACTLESS_TRANSCEIVER(HANDLE, FUC)    (HANDLE)->contactless_transceiver = FUC

#define DRIVER_NTAG21X_LINK_DELAY_MS(HANDLE, FUC)                   (HANDLE)->delay_ms = FUC

#define DRIVER_NTAG21X_LINK_DEBUG_PRINT(HANDLE, FUC)                (HANDLE)->debug_print = FUC



uint8_t ntag21x_info(ntag21x_info_t *info);

uint8_t ntag21x_init(ntag21x_handle_t *handle);

uint8_t ntag21x_deinit(ntag21x_handle_t *handle);

uint8_t ntag21x_request(ntag21x_handle_t *handle, ntag21x_type_t *type);

uint8_t ntag21x_wake_up(ntag21x_handle_t *handle, ntag21x_type_t *type);

uint8_t ntag21x_halt(ntag21x_handle_t *handle);

uint8_t ntag21x_anticollision_cl1(ntag21x_handle_t *handle, uint8_t id[4]);

uint8_t ntag21x_anticollision_cl2(ntag21x_handle_t *handle, uint8_t id[4]);

uint8_t ntag21x_select_cl1(ntag21x_handle_t *handle, uint8_t id[4]);

uint8_t ntag21x_select_cl2(ntag21x_handle_t *handle, uint8_t id[4]);

uint8_t ntag21x_get_version(ntag21x_handle_t *handle, ntag21x_version_t *version);

uint8_t ntag21x_read_four_pages(ntag21x_handle_t *handle, uint8_t start_page, uint8_t data[16]);

uint8_t ntag21x_read_page(ntag21x_handle_t *handle, uint8_t page, uint8_t data[4]);

uint8_t ntag21x_fast_read_page(ntag21x_handle_t *handle, uint8_t start_page, uint8_t stop_page, uint8_t *data, uint16_t *len);

uint8_t ntag21x_compatibility_write_page(ntag21x_handle_t *handle, uint8_t page, uint8_t data[4]);

uint8_t ntag21x_write_page(ntag21x_handle_t *handle, uint8_t page, uint8_t data[4]);

uint8_t ntag21x_read_counter(ntag21x_handle_t *handle, uint32_t *cnt);

uint8_t ntag21x_read_signature(ntag21x_handle_t *handle, uint8_t signature[32]);

uint8_t ntag21x_get_serial_number(ntag21x_handle_t *handle, uint8_t number[7]);

uint8_t ntag21x_get_capability_container(ntag21x_handle_t *handle, ntag21x_capability_container_t *container);

uint8_t ntag21x_set_password(ntag21x_handle_t *handle, uint8_t pwd[4]);

uint8_t ntag21x_set_pack(ntag21x_handle_t *handle, uint8_t pack[2]);

uint8_t ntag21x_authenticate(ntag21x_handle_t *handle, uint8_t pwd[4], uint8_t pack[2]);

uint8_t ntag21x_set_dynamic_lock(ntag21x_handle_t *handle, uint8_t lock[3]);

uint8_t ntag21x_get_dynamic_lock(ntag21x_handle_t *handle, uint8_t lock[3]);

uint8_t ntag21x_set_static_lock(ntag21x_handle_t *handle, uint8_t lock[2]);

uint8_t ntag21x_get_static_lock(ntag21x_handle_t *handle, uint8_t lock[2]);

uint8_t ntag21x_set_mirror(ntag21x_handle_t *handle, ntag21x_mirror_t mirror);

uint8_t ntag21x_get_mirror(ntag21x_handle_t *handle, ntag21x_mirror_t *mirror);

uint8_t ntag21x_set_mirror_byte(ntag21x_handle_t *handle, ntag21x_mirror_byte_t byte);

uint8_t ntag21x_get_mirror_byte(ntag21x_handle_t *handle, ntag21x_mirror_byte_t *byte);

uint8_t ntag21x_set_modulation_mode(ntag21x_handle_t *handle, ntag21x_modulation_mode_t mode);

uint8_t ntag21x_get_modulation_mode(ntag21x_handle_t *handle, ntag21x_modulation_mode_t *mode);

uint8_t ntag21x_set_mirror_page(ntag21x_handle_t *handle, uint8_t page);

uint8_t ntag21x_get_mirror_page(ntag21x_handle_t *handle, uint8_t *page);

uint8_t ntag21x_set_protect_start_page(ntag21x_handle_t *handle, uint8_t page);

uint8_t ntag21x_get_protect_start_page(ntag21x_handle_t *handle, uint8_t *page);

uint8_t ntag21x_set_access(ntag21x_handle_t *handle, ntag21x_access_t access, ntag21x_bool_t enable);

uint8_t ntag21x_get_access(ntag21x_handle_t *handle, ntag21x_access_t access, ntag21x_bool_t *enable);

uint8_t ntag21x_set_authenticate_limitation(ntag21x_handle_t *handle, uint8_t limit);

uint8_t ntag21x_get_authenticate_limitation(ntag21x_handle_t *handle, uint8_t *limit);



uint8_t ntag21x_transceiver(ntag21x_handle_t *handle, uint8_t *in_buf, uint8_t in_len, uint8_t *out_buf, uint8_t *out_len);


 
#ifdef __cplusplus
}
#endif
 
#endif