magicrfid.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 MAGICRFID_H
#define MAGICRFID_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_uart.h"
 
#define MAGICRFID_OPCODE_VERSION                        0x03
#define MAGICRFID_OPCODE_SET_BAUD_RATE                  0x06
#define MAGICRFID_OPCODE_READ_TAG_ID_SINGLE             0x21
#define MAGICRFID_OPCODE_READ_TAG_ID_MULTIPLE           0x22
#define MAGICRFID_OPCODE_WRITE_TAG_ID                   0x23
#define MAGICRFID_OPCODE_WRITE_TAG_DATA                 0x24
#define MAGICRFID_OPCODE_KILL_TAG                       0x26
#define MAGICRFID_OPCODE_READ_TAG_DATA                  0x28
#define MAGICRFID_OPCODE_CLEAR_TAG_ID_BUFFER            0x2A
#define MAGICRFID_OPCODE_MULTI_PROTOCOL_TAG_OP          0x2F
#define MAGICRFID_OPCODE_GET_READ_TX_POWER              0x62
#define MAGICRFID_OPCODE_GET_WRITE_TX_POWER             0x64
#define MAGICRFID_OPCODE_GET_POWER_MODE                 0x68
#define MAGICRFID_OPCODE_GET_READER_OPTIONAL_PARAMS     0x6A
#define MAGICRFID_OPCODE_GET_PROTOCOL_PARAM             0x6B
#define MAGICRFID_OPCODE_SET_ANTENNA_PORT               0x91
#define MAGICRFID_OPCODE_SET_TAG_PROTOCOL               0x93
#define MAGICRFID_OPCODE_SET_READ_TX_POWER              0x92
#define MAGICRFID_OPCODE_SET_WRITE_TX_POWER             0x94
#define MAGICRFID_OPCODE_SET_REGION                     0x97
#define MAGICRFID_OPCODE_SET_READER_OPTIONAL_PARAMS     0x9A
#define MAGICRFID_OPCODE_SET_PROTOCOL_PARAM             0x9B
 
#define MAGICRFID_REGION_INDIA                          0x04
#define MAGICRFID_REGION_JAPAN                          0x05
#define MAGICRFID_REGION_CHINA                          0x06
#define MAGICRFID_REGION_EUROPE                         0x08
#define MAGICRFID_REGION_KOREA                          0x09
#define MAGICRFID_REGION_AUSTRALIA                      0x0B
#define MAGICRFID_REGION_NEWZEALAND                     0x0C
#define MAGICRFID_REGION_NORTHAMERICA                   0x0D
#define MAGICRFID_REGION_OPEN                           0xFF
 
#define MAGICRFID_TAG_PROTOCOL_NONE                     0x00
#define MAGICRFID_TAG_PROTOCOL_ISO180006B               0x03
#define MAGICRFID_TAG_PROTOCOL_GEN2                     0x05
#define MAGICRFID_TAG_PROTOCOL_ISO180006B_UCODE         0x06
#define MAGICRFID_TAG_PROTOCOL_IPX64                    0x07
#define MAGICRFID_TAG_PROTOCOL_IPX256                   0x08
#define MAGICRFID_TAG_PROTOCOL_ATA                      0x1D
 
#define MAGICRFID_NORMAL_DELAY_TIME                     50
#define MAGICRFID_LONG_DELAY_TIME                       100
#define MAGICRFID_TIMEOUT_MS                            3000
 
#define MAGICRFID_HEADER                                0xFF
#define MAGICRFID_COMMAND_MAX_DATA_LEN                  250
#define MAGICRFID_RESPONSE_MAX_DATA_LEN                 248
#define MAGICRFID_EPC_MAX_DATA_LEN                      16
 
#define MAGICRFID_TX_DRV_BUFFER_SIZE                    255
#define MAGICRFID_RX_DRV_BUFFER_SIZE                    255
 
 // magicrfid_cmd
 
#define MAGICRFID_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
    cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
    cfg.en = MIKROBUS( mikrobus, MIKROBUS_CS )
 
 // magicrfid_map
 // magicrfid
 
typedef struct
{
    // Output pins
    digital_out_t en;       
    // Modules
    uart_t uart;            
    // Buffers
    uint8_t uart_rx_buffer[ MAGICRFID_RX_DRV_BUFFER_SIZE ];     
    uint8_t uart_tx_buffer[ MAGICRFID_TX_DRV_BUFFER_SIZE ];     
} magicrfid_t;
 
typedef struct
{
    // Communication gpio pins
    pin_name_t rx_pin;      
    pin_name_t tx_pin;      
    // Additional gpio pins
    pin_name_t en;          
    // Static variable
    uint32_t          baud_rate;        
    bool              uart_blocking;    
    uart_data_bits_t  data_bit;         
    uart_parity_t     parity_bit;       
    uart_stop_bits_t  stop_bit;         
} magicrfid_cfg_t;
 
typedef struct
{
    uint8_t data_len;
    uint8_t opcode;
    uint8_t data_buf[ MAGICRFID_COMMAND_MAX_DATA_LEN ];
 
} magicrfid_command_t;
 
typedef struct
{
    uint8_t data_len;
    uint8_t opcode;
    uint16_t status;
    uint8_t data_buf[ MAGICRFID_RESPONSE_MAX_DATA_LEN ];
 
} magicrfid_response_t;
 
typedef struct
{
    uint8_t data_len;
    uint16_t epc_pc;
    uint8_t data_buf[ MAGICRFID_EPC_MAX_DATA_LEN ];
    uint16_t epc_crc;
 
} magicrfid_epc_t;
 
typedef enum
{
    MAGICRFID_OK = 0,
    MAGICRFID_ERROR = -1
 
} magicrfid_return_value_t;
 
void magicrfid_cfg_setup ( magicrfid_cfg_t *cfg );
 
err_t magicrfid_init ( magicrfid_t *ctx, magicrfid_cfg_t *cfg );
 
void magicrfid_default_cfg ( magicrfid_t *ctx );
 
err_t magicrfid_generic_write ( magicrfid_t *ctx, uint8_t *data_buf, uint16_t len );
 
err_t magicrfid_generic_read ( magicrfid_t *ctx, uint8_t *data_buf, uint16_t max_len );
 
void magicrfid_device_reset ( magicrfid_t *ctx );
 
void magicrfid_send_command ( magicrfid_t *ctx, magicrfid_command_t cmd );
 
err_t magicrfid_get_response ( magicrfid_t *ctx, magicrfid_response_t *rsp );
 
int8_t magicrfid_parse_tag_rssi ( magicrfid_response_t rsp );
 
uint32_t magicrfid_parse_tag_freq ( magicrfid_response_t rsp );
 
void magicrfid_parse_tag_epc ( magicrfid_response_t rsp, magicrfid_epc_t *epc );
 
void magicrfid_set_tag_protocol ( magicrfid_t *ctx, uint8_t protocol );
 
void magicrfid_set_region ( magicrfid_t *ctx, uint8_t region );
 
void magicrfid_set_antenna_port ( magicrfid_t *ctx );
 
void magicrfid_set_baud_rate ( magicrfid_t *ctx, uint32_t baud_rate );
 
void magicrfid_set_read_power ( magicrfid_t *ctx, uint16_t power_setting );
 
void magicrfid_set_write_power ( magicrfid_t *ctx, uint16_t power_setting );
 
void magicrfid_set_reader_config ( magicrfid_t *ctx, uint8_t option1, uint8_t option2 );
 
void magicrfid_start_reading ( magicrfid_t *ctx );
 
void magicrfid_clear_buffers ( magicrfid_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // MAGICRFID_H
 
 // magicrfid
 
// ------------------------------------------------------------------------ END