mfrc522.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2021 Freie Universität Berlin
 * SPDX-License-Identifier: LGPL-2.1-only
 */
 
#pragma once

 
#ifdef __cplusplus
extern "C"
{
#endif
 
#include "stdbool.h"
 
#include "periph/spi.h"
 
#include "mfrc522_regs.h"

#define MFRC522_UID_MAX_SIZE  10

#define MFRC522_MF_ACK  0xA

#define MFRC522_MF_KEY_SIZE  6

typedef struct {
    spi_t spi_dev;      
    spi_clk_t spi_clk;  
    gpio_t sck_pin;     
    gpio_t miso_pin;    
    gpio_t mosi_pin;    
    gpio_t cs_pin;      
    gpio_t rst_pin;     
} mfrc522_params_t;

typedef struct {
    mfrc522_params_t params;  
} mfrc522_t;

typedef struct {
    uint8_t size;                               
    uint8_t uid_byte[MFRC522_UID_MAX_SIZE];     
    uint8_t sak;                                
} mfrc522_uid_t;

typedef struct {
    uint8_t key_byte[MFRC522_MF_KEY_SIZE];  
} mfrc522_mifare_key_t;

typedef enum {
    MFRC522_PICC_TYPE_ISO_14443_4,      
    MFRC522_PICC_TYPE_ISO_18092,        
    MFRC522_PICC_TYPE_MIFARE_MINI,      
    MFRC522_PICC_TYPE_MIFARE_1K,        
    MFRC522_PICC_TYPE_MIFARE_4K,        
    MFRC522_PICC_TYPE_MIFARE_UL,        
    MFRC522_PICC_TYPE_MIFARE_PLUS,      
    MFRC522_PICC_TYPE_MIFARE_DESFIRE,   
    MFRC522_PICC_TYPE_TNP3XXX,          
    MFRC522_PICC_TYPE_NOT_COMPLETE,     
    MFRC522_PICC_TYPE_UNKNOWN           
} mfrc522_picc_type_t;

void mfrc522_pcd_set_register_bitmask(mfrc522_t *dev, mfrc522_pcd_register_t reg, uint8_t mask);

void mfrc522_pcd_clear_register_bitmask(mfrc522_t *dev, mfrc522_pcd_register_t reg, uint8_t mask);

int mfrc522_pcd_calculate_crc(mfrc522_t *dev, const uint8_t *data, uint8_t length, uint8_t *result);

int mfrc522_pcd_init(mfrc522_t *dev, const mfrc522_params_t *params);

void mfrc522_pcd_reset(mfrc522_t *dev);

void mfrc522_pcd_antenna_on(mfrc522_t *dev);

void mfrc522_pcd_antenna_off(mfrc522_t *dev);

mfrc522_pcd_rx_gain_t mfrc522_pcd_get_antenna_gain(mfrc522_t *dev);

void mfrc522_pcd_set_antenna_gain(mfrc522_t *dev, mfrc522_pcd_rx_gain_t rx_gain);

void mfrc522_pcd_soft_power_down(mfrc522_t *dev);

void mfrc522_pcd_soft_power_up(mfrc522_t *dev);

int mfrc522_pcd_transceive_data(mfrc522_t *dev,
                                const uint8_t *send_data, uint8_t send_len,
                                uint8_t *back_data, uint8_t *back_len,
                                uint8_t *valid_bits, uint8_t rx_align, bool check_crc);

int mfrc522_pcd_communicate_with_picc(mfrc522_t *dev, mfrc522_pcd_command_t command,
                                      uint8_t wait_irq,
                                      const uint8_t *send_data, uint8_t send_len,
                                      uint8_t *back_data, uint8_t *back_len,
                                      uint8_t *valid_bits, uint8_t rx_align, bool check_crc);

int mfrc522_picc_request_a(mfrc522_t *dev, uint8_t *buffer_atqa, uint8_t *buffer_size);

int mfrc522_picc_wakeup_a(mfrc522_t *dev, uint8_t *buffer_atqa, uint8_t *buffer_size);

int mfrc522_picc_reqa_or_wupa(mfrc522_t *dev, mfrc522_picc_command_t command,
                              uint8_t *buffer_atqa, uint8_t *buffer_size);

int mfrc522_picc_select(mfrc522_t *dev, mfrc522_uid_t *uid, uint8_t valid_bits);

int mfrc522_picc_halt_a(mfrc522_t *dev);

int mfrc522_pcd_authenticate(mfrc522_t *dev, mfrc522_picc_command_t command,
                             uint8_t block_addr, const mfrc522_mifare_key_t *key,
                             const mfrc522_uid_t *uid);

void mfrc522_pcd_stop_crypto1(mfrc522_t *dev);

int mfrc522_mifare_read(mfrc522_t *dev, uint8_t block_addr, uint8_t *buffer, uint8_t *buffer_size);

int mfrc522_mifare_write(mfrc522_t *dev, uint8_t block_addr,
                         const uint8_t *buffer, uint8_t buffer_size);

int mfrc522_mifare_ultralight_write(mfrc522_t *dev, uint8_t page, const uint8_t *buffer);

int mfrc522_mifare_decrement(mfrc522_t *dev, uint8_t block_addr, int32_t delta);

int mfrc522_mifare_increment(mfrc522_t *dev, uint8_t block_addr, int32_t delta);

int mfrc522_mifare_restore(mfrc522_t *dev, uint8_t block_addr);

int mfrc522_mifare_transfer(mfrc522_t *dev, uint8_t block_addr);

int mfrc522_mifare_get_value(mfrc522_t *dev, uint8_t block_addr, int32_t *value);

int mfrc522_mifare_set_value(mfrc522_t *dev, uint8_t block_addr, int32_t value);

int mfrc522_pcd_ntag216_auth(mfrc522_t *dev, const uint8_t *password, uint8_t p_ack[]);

int mfrc522_pcd_mifare_transceive(mfrc522_t *dev,
                                  const uint8_t *send_data, uint8_t send_len,
                                  bool accept_timeout);

mfrc522_picc_type_t mfrc522_picc_get_type(uint8_t sak);

const char *mfrc522_picc_get_type_string(mfrc522_picc_type_t picc_type);

void mfrc522_mifare_set_access_bits(uint8_t *access_bit_buffer,
                                    uint8_t g0, uint8_t g1, uint8_t g2, uint8_t g3);

int mfrc522_mifare_open_uid_backdoor(mfrc522_t *dev);

int mfrc522_mifare_set_uid(mfrc522_t *dev, mfrc522_uid_t *uid,
                           const uint8_t *new_uid, uint8_t new_uid_size);

int mfrc522_mifare_unbrick_uid_sector(mfrc522_t *dev);

bool mfrc522_picc_is_new_card_present(mfrc522_t *dev);

int mfrc522_picc_read_card_serial(mfrc522_t *dev, mfrc522_uid_t *uid);

void mfrc522_pcd_dump_version_to_serial(mfrc522_t *dev);

void mfrc522_picc_dump_to_serial(mfrc522_t *dev, mfrc522_uid_t *uid);

void mfrc522_picc_dump_details_to_serial(mfrc522_uid_t *uid);

void mfrc522_picc_dump_mifare_classic_to_serial(mfrc522_t *dev, mfrc522_uid_t *uid,
                                                mfrc522_picc_type_t picc_type,
                                                mfrc522_mifare_key_t *key);

void mfrc522_picc_dump_mifare_classic_sector_to_serial(mfrc522_t *dev, mfrc522_uid_t *uid,
                                                       mfrc522_mifare_key_t *key, uint8_t sector);

void mfrc522_picc_dump_mifare_ultralight_to_serial(mfrc522_t *dev);

bool mfrc522_pcd_perform_self_test(mfrc522_t *dev);
 
#ifdef __cplusplus
}
#endif