driver_fm11rfxx.h

Go to the documentation of this file.

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



typedef enum
{
    FM11RFXX_TYPE_INVALID  = 0x00,        
    FM11RFXX_TYPE_FM11RF08 = 0x01,        
    FM11RFXX_TYPE_FM11RF32 = 0x02,        
} fm11rfxx_type_t;

typedef enum
{
    FM11RFXX_LOAD_MODULATION_NORMAL = 0x00,        
    FM11RFXX_LOAD_MODULATION_STRONG = 0x01,        
} fm11rfxx_load_modulation_t;

typedef enum
{
    FM11RFXX_PERSONALIZED_UID_0 = 0x00,        
    FM11RFXX_PERSONALIZED_UID_1 = 0x40,        
    FM11RFXX_PERSONALIZED_UID_2 = 0x20,        
    FM11RFXX_PERSONALIZED_UID_3 = 0x60,        
} fm11rfxx_personalized_uid_t;

typedef enum
{
    FM11RFXX_AUTHENTICATION_KEY_A = 0x00,        
    FM11RFXX_AUTHENTICATION_KEY_B = 0x01,        
} fm11rfxx_authentication_key_t;

typedef struct fm11rfxx_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;                                                                
} fm11rfxx_handle_t;

typedef struct fm11rfxx_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;           
} fm11rfxx_info_t;



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

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

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

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

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

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



uint8_t fm11rfxx_info(fm11rfxx_info_t *info);

uint8_t fm11rfxx_init(fm11rfxx_handle_t *handle);

uint8_t fm11rfxx_deinit(fm11rfxx_handle_t *handle);

uint8_t fm11rfxx_request(fm11rfxx_handle_t *handle, fm11rfxx_type_t *type);

uint8_t fm11rfxx_wake_up(fm11rfxx_handle_t *handle, fm11rfxx_type_t *type);

uint8_t fm11rfxx_halt(fm11rfxx_handle_t *handle);

uint8_t fm11rfxx_set_modulation(fm11rfxx_handle_t *handle, fm11rfxx_load_modulation_t mod);

uint8_t fm11rfxx_set_personalized_uid(fm11rfxx_handle_t *handle, fm11rfxx_personalized_uid_t type);

uint8_t fm11rfxx_anticollision_cl1(fm11rfxx_handle_t *handle, uint8_t id[4]);

uint8_t fm11rfxx_anticollision_cl2(fm11rfxx_handle_t *handle, uint8_t id[4]);

uint8_t fm11rfxx_select_cl1(fm11rfxx_handle_t *handle, uint8_t id[4]);

uint8_t fm11rfxx_select_cl2(fm11rfxx_handle_t *handle, uint8_t id[4]);

uint8_t fm11rfxx_authentication(fm11rfxx_handle_t *handle, uint8_t id[4], uint8_t block,
                                fm11rfxx_authentication_key_t key_type, uint8_t key[6]);

uint8_t fm11rfxx_read(fm11rfxx_handle_t *handle, uint8_t block, uint8_t data[16]);

uint8_t fm11rfxx_write(fm11rfxx_handle_t *handle, uint8_t block, uint8_t data[16]);

uint8_t fm11rfxx_value_init(fm11rfxx_handle_t *handle, uint8_t block, int32_t value, uint8_t addr);

uint8_t fm11rfxx_value_write(fm11rfxx_handle_t *handle, uint8_t block, int32_t value, uint8_t addr);

uint8_t fm11rfxx_value_read(fm11rfxx_handle_t *handle, uint8_t block, int32_t *value, uint8_t *addr);

uint8_t fm11rfxx_increment(fm11rfxx_handle_t *handle, uint8_t block, uint32_t value);

uint8_t fm11rfxx_decrement(fm11rfxx_handle_t *handle, uint8_t block, uint32_t value);

uint8_t fm11rfxx_transfer(fm11rfxx_handle_t *handle, uint8_t block);

uint8_t fm11rfxx_restore(fm11rfxx_handle_t *handle, uint8_t block);

uint8_t fm11rfxx_block_to_sector(fm11rfxx_handle_t *handle, uint8_t block, uint8_t *sector);

uint8_t fm11rfxx_sector_block_count(fm11rfxx_handle_t *handle, uint8_t sector, uint8_t *count);

uint8_t fm11rfxx_sector_first_block(fm11rfxx_handle_t *handle, uint8_t sector, uint8_t *block);

uint8_t fm11rfxx_sector_last_block(fm11rfxx_handle_t *handle, uint8_t sector, uint8_t *block);

uint8_t fm11rfxx_set_sector_permission(fm11rfxx_handle_t *handle,
                                       uint8_t sector, uint8_t key_a[6], 
                                       uint8_t block_0_0_4, uint8_t block_1_5_9,
                                       uint8_t block_2_10_14, uint8_t block_3_15,
                                       uint8_t user_data, uint8_t key_b[6]);

uint8_t fm11rfxx_get_sector_permission(fm11rfxx_handle_t *handle,
                                       uint8_t sector, uint8_t *block_0_0_4, uint8_t *block_1_5_9,
                                       uint8_t *block_2_10_14, uint8_t *block_3_15,
                                       uint8_t *user_data, uint8_t key_b[6]);



uint8_t fm11rfxx_transceiver(fm11rfxx_handle_t *handle, uint8_t *in_buf, uint8_t in_len, uint8_t *out_buf, uint8_t *out_len);


 
#ifdef __cplusplus
}
#endif
 
#endif