rfid.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2020 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** Permission is hereby granted, free of charge, to any person obtaining a copy
** of this software and associated documentation files (the "Software"), to deal
** in the Software without restriction, including without limitation the rights
** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
** copies of the Software, and to permit persons to whom the Software is
** furnished to do so, subject to the following conditions:
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
**  USE OR OTHER DEALINGS IN THE SOFTWARE.
****************************************************************************/
 
#ifndef RFID_H
#define RFID_H
 
#ifdef __cplusplus
extern "C"{
#endif
 
#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_spi_master.h"
#include "drv_uart.h"
 
#define RFID_SEND_CMD_CRTL  0x00
#define RFID_RESET_CTRL     0x01
#define RFID_READ_CTRL      0x02
#define RFID_POLL_CTRL      0x03
 
 // rfid_reg
 
#define RFID_IDN            0x01
#define RFID_PROT_SELECT    0x02
#define RFID_SEND_RECV      0x04
#define RFID_IDLE           0x07
#define RFID_RD_WAKEUP_REG  0x08
#define RFID_WR_WAKEUP_REG  0x09
#define RFID_SET_BAUD       0x0A
#define RFID_ECHO           0x55
 
#define RFID_FIELD_OFF      0x00
#define RFID_ISO_15693      0x01
#define RFID_ISO_14443A     0x02    
#define RFID_ISO_14443B     0x03
#define RFID_ISO_18092NFC   0x04
 
#define RFID_UART           0x00
#define RFID_SPI            0x01
 
#define RFID_MAX_DATA_LEN   0xFF
 
#define RFID_DATA_READY     0x08
#define RFID_DATA_NOT_READY 0x00
 
 // rfid_set
 
#define RFID_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
    cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
    cfg.sck  = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
    cfg.cs   = MIKROBUS( mikrobus, MIKROBUS_CS ); \
    cfg.ssi_1 = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.ssi_0 = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
    cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
    cfg.irq_in = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.irq_out = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // rfid_map
 // rfid
 
#define DRV_RX_BUFFER_SIZE 500
typedef struct
{
    // Output pins
 
    digital_out_t  ssi_1;       
    digital_out_t  ssi_0;       
    digital_out_t  irq_in;      
    // Input pins
 
    digital_in_t  irq_out;      
    // Modules
 
    spi_master_t  spi;          
    pin_name_t  chip_select;    
    uart_t uart;                
    char uart_rx_buffer[ DRV_RX_BUFFER_SIZE ]; 
    char uart_tx_buffer[ DRV_RX_BUFFER_SIZE ]; 
    // Variables
    
    uint8_t com_interface; 
    uint8_t rx_data[ DRV_RX_BUFFER_SIZE ]; 
} rfid_t;
 
typedef struct
{
    // Communication gpio pins
 
    pin_name_t  miso;          
    pin_name_t  mosi;          
    pin_name_t  sck;           
    pin_name_t  cs;            
    pin_name_t  rx_pin;        
    pin_name_t  tx_pin;        
    // Additional gpio pins
 
    pin_name_t  ssi_1;         
    pin_name_t  ssi_0;         
    pin_name_t  irq_in;        
    pin_name_t  irq_out;       
    // static variable
 
    uint32_t                           spi_speed;   
    spi_master_mode_t                  spi_mode;    
    spi_master_chip_select_polarity_t  cs_polarity; 
    uint32_t          baud_rate;     
    bool              uart_blocking;
    uart_data_bits_t  data_bit;      
    uart_parity_t     parity_bit;    
    uart_stop_bits_t  stop_bit;      
} rfid_cfg_t;
 
typedef enum
{
   RFID_OK = 0,
   RFID_ERROR = -1
 
} rfid_return_value_t;
 
void rfid_cfg_setup ( rfid_cfg_t *cfg );
 
err_t rfid_init ( rfid_t *ctx, rfid_cfg_t *cfg );
 
err_t rfid_default_cfg ( rfid_t *ctx );
 
err_t rfid_send_command ( rfid_t *ctx, uint8_t cmd, uint8_t *data_in, uint8_t len );
 
err_t rfid_read_data ( rfid_t *ctx, uint8_t *data_out );
 
uint8_t rfid_data_ready ( rfid_t *ctx );
 
err_t rfid_reset ( rfid_t *ctx );
 
err_t rfid_check_echo ( rfid_t *ctx );
 
err_t rfid_calibration ( rfid_t *ctx );
 
err_t rfid_get_device_id ( rfid_t *ctx, uint8_t *device_id );
 
err_t rfid_select_communication_interface ( rfid_t* ctx, uint8_t com_interface );
 
err_t rfid_select_rfid_protocol ( rfid_t *ctx, uint8_t rfid_protocol );
 
err_t rfid_set_index_mod_and_gain ( rfid_t *ctx );
 
err_t rfid_auto_detect_filter ( rfid_t *ctx );
 
err_t rfid_get_tag_uid ( rfid_t *ctx, uint8_t rfid_protocol, uint8_t *tag_uid );
 
#ifdef __cplusplus
}
#endif
#endif // RFID_H
 
 // rfid
 
// ------------------------------------------------------------------------ END