nfc6.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 NFC6_H
#define NFC6_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 "spi_specifics.h"
 
#define NFC6_CONTROL_SEND_COMMAND           0x00
#define NFC6_CONTROL_READ_DATA              0x02
#define NFC6_CONTROL_POLL_READY             0x03
#define NFC6_CONTROL_RESET_DEVICE           0x01
#define NFC6_CONTROL_POLL_READY_FLAG        0x08
 
#define NFC6_CMD_IDN                        0x01
#define NFC6_CMD_PROTOCOL_SELECT            0x02
#define NFC6_CMD_POLL_FIELD                 0x03
#define NFC6_CMD_SEND_RECV                  0x04
#define NFC6_CMD_LISTEN                     0x05
#define NFC6_CMD_SEND                       0x06
#define NFC6_CMD_IDLE                       0x07
#define NFC6_CMD_RD_REG                     0x08
#define NFC6_CMD_WR_REG                     0x09
#define NFC6_CMD_SUB_FREQ_RES               0x0B
#define NFC6_CMD_AC_FILTER                  0x0D
#define NFC6_CMD_ECHO                       0x55
 
 // nfc6_reg
 
#define NFC6_RSP_FIXED_BYTES                0x80
#define NFC6_RSP_FIXED_BYTES_MASK           0x8F
#define NFC6_RSP_LONG_FRAME_MASK            0x60
#define NFC6_RSP_OK                         0x00
#define NFC6_RSP_ECHO                       0x55
#define NFC6_RSP_MAX_DATA_LEN               528u
#define NFC6_RSP_READY_TIMEOUT_MS           5000ul
 
#define NFC6_IDLE_CMD_LENGTH                14
#define NFC6_IDLE_CMD_WU_SOURCE             0x03
#define NFC6_IDLE_CMD_ENTER_CTRL_L          0xA1
#define NFC6_IDLE_CMD_ENTER_CTRL_H          0x00
#define NFC6_IDLE_CMD_WU_CTRL_L             0xF8
#define NFC6_IDLE_CMD_WU_CTRL_H             0x01
#define NFC6_IDLE_CMD_LEAVE_CTRL_L          0x18
#define NFC6_IDLE_CMD_LEAVE_CTRL_H          0x00
#define NFC6_IDLE_CMD_WU_PERIOD             0x20
#define NFC6_IDLE_CMD_OSC_START             0x60
#define NFC6_IDLE_CMD_DAC_START             0x60
#define NFC6_IDLE_CMD_DAC_DATA_L            0x00
#define NFC6_IDLE_CMD_DAC_DATA_H            0x00
#define NFC6_IDLE_CMD_DAC_DATA_H_MIN        0x00
#define NFC6_IDLE_CMD_DAC_DATA_H_MAX        0xFC
#define NFC6_IDLE_CMD_SWINGS_CNT            0x3F
#define NFC6_IDLE_CMD_MAX_SLEEP             0x01
#define NFC6_IDLE_RSP_TIMEOUT               0x01
#define NFC6_IDLE_RSP_TAG_DETECT            0x02
#define NFC6_IDLE_RSP_LENGTH                1
#define NFC6_IDLE_CALIB_START               0x80
 
#define NFC6_PROTOCOL_FIELD_OFF             0
#define NFC6_PROTOCOL_ISO_15693             1
#define NFC6_PROTOCOL_ISO_14443A            2
#define NFC6_PROTOCOL_ISO_14443B            3
#define NFC6_PROTOCOL_FELICA                4
 
#define NFC6_TAG_UID_RSP_MAX_DATA_LEN       10
#define NFC6_TAG_UID_MAX_LEN                7
#define NFC6_MIFARE_REQA                    0x26
#define NFC6_MIFARE_REQA_LEN                0x07
#define NFC6_MIFARE_WUPA                    0x52
#define NFC6_MIFARE_CL1                     0x93
#define NFC6_MIFARE_CL2                     0x95
#define NFC6_MIFARE_ANTICOLLISION           0x20
#define NFC6_MIFARE_ANTICOLLISION_LEN       0x08
#define NFC6_MIFARE_SELECT                  0x70
#define NFC6_MIFARE_CASCADE_TAG             0x88
#define NFC6_MIFARE_READ                    0x30
#define NFC6_MIFARE_WRITE                   0xA0
 
#define NFC6_SET_DATA_SAMPLE_EDGE           SET_SPI_DATA_SAMPLE_EDGE
#define NFC6_SET_DATA_SAMPLE_MIDDLE         SET_SPI_DATA_SAMPLE_MIDDLE
 
 // nfc6_set
 
#define NFC6_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.irq_in = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.irq_out = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // nfc6_map
 // nfc6
 
typedef struct
{
    // Output pins
    digital_out_t irq_in;       
    // Input pins
    digital_in_t irq_out;       
    // Modules
    spi_master_t spi;           
    pin_name_t chip_select;     
    uint8_t cal_dac_data_h;     
} nfc6_t;
 
typedef struct
{
    // Communication gpio pins
    pin_name_t miso;            
    pin_name_t mosi;            
    pin_name_t sck;             
    pin_name_t cs;              
    // Additional gpio pins
    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;  
} nfc6_cfg_t;
 
typedef enum
{
    NFC6_OK = 0,
    NFC6_ERROR = -1
 
} nfc6_return_value_t;
 
void nfc6_cfg_setup ( nfc6_cfg_t *cfg );
 
err_t nfc6_init ( nfc6_t *ctx, nfc6_cfg_t *cfg );
 
err_t nfc6_default_cfg ( nfc6_t *ctx );
 
err_t nfc6_send_command ( nfc6_t *ctx, uint8_t cmd, uint8_t *data_in, uint8_t len );
 
err_t nfc6_read_data ( nfc6_t *ctx, uint8_t *data_out, uint16_t buffer_size, uint16_t *rx_len );
 
err_t nfc6_poll_ready ( nfc6_t *ctx );
 
err_t nfc6_poll_ready_irq ( nfc6_t *ctx );
 
err_t nfc6_reset_device ( nfc6_t *ctx );
 
err_t nfc6_check_command_echo ( nfc6_t *ctx );
 
void nfc6_pulse_irq_in ( nfc6_t *ctx );
 
void nfc6_set_irq_in_pin ( nfc6_t *ctx, uint8_t state );
 
uint8_t nfc6_get_irq_out_pin ( nfc6_t *ctx );
 
err_t nfc6_calibrate_device ( nfc6_t *ctx );
 
err_t nfc6_select_protocol ( nfc6_t *ctx, uint8_t protocol );
 
err_t nfc6_read_mifare_tag_uid ( nfc6_t *ctx, uint8_t *tag_uid, uint8_t *tag_uid_len );
 
#ifdef __cplusplus
}
#endif
#endif // NFC6_H
 
 // nfc6
 
// ------------------------------------------------------------------------ END