smartcard2.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 SMARTCARD2_H
#define SMARTCARD2_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 SMARTCARD2_CMD_ICC_POWER_ON             0x62
#define SMARTCARD2_CMD_ICC_POWER_OFF            0x63
#define SMARTCARD2_CMD_GET_SLOT_STATUS          0x65
#define SMARTCARD2_CMD_XFR_BLOCK                0x6F
#define SMARTCARD2_CMD_GET_PARAMETERS           0x6C
#define SMARTCARD2_CMD_RESET_PARAMETERS         0x6D
#define SMARTCARD2_CMD_SET_PARAMETERS           0x61
#define SMARTCARD2_CMD_ESCAPE                   0x6B
#define SMARTCARD2_CMD_ICC_ESCAPE               0x6E
#define SMARTCARD2_CMD_T0_APDU                  0x6A
#define SMARTCARD2_CMD_SECURE                   0x69
#define SMARTCARD2_CMD_MECHANICAL               0x71
#define SMARTCARD2_CMD_ABORT                    0x72
#define SMARTCARD2_CMD_SET_DATA_RATE_CLK_FREQ   0x73
 
#define SMARTCARD2_RSP_DATA_BLOCK               0x80
#define SMARTCARD2_RSP_SLOT_STATUS              0x81
#define SMARTCARD2_RSP_PARAMETERS               0x82
#define SMARTCARD2_RSP_ESCAPE                   0x83
#define SMARTCARD2_RSP_DATA_RATE_CLK_FREQ       0x84
 
#define SMARTCARD2_EVT_NOTIFY_SLOT_CHANGE       0x50
#define SMARTCARD2_CARD_ABSENT                  0x02
#define SMARTCARD2_CARD_PRESENT                 0x03
#define SMARTCARD2_EVT_HARDWARE_ERROR           0x51
#define SMARTCARD2_OVERCURRENT                  0x01
 
#define SMARTCARD2_SYNC                         0x03
#define SMARTCARD2_CTRL_ACK                     0x06
#define SMARTCARD2_CTRL_NACK                    0x15
#define SMARTCARD2_SHORT_APDU_MAX_SIZE          261
// sync + ack + 10-byte ccid header + short APDU size + checksum
#define SMARTCARD2_MAX_BUF_SIZE                 ( SMARTCARD2_SHORT_APDU_MAX_SIZE + 13 )
#define SMARTCARD2_TIMEOUT_MS                   5000
 
#define SMARTCARD2_CLK_STATUS_RUNNING           0x00
#define SMARTCARD2_CLK_STATUS_STATE_L           0x01
#define SMARTCARD2_CLK_STATUS_STATE_H           0x02
 
#define SMARTCARD2_POWER_SEL_AUTO               0x00
#define SMARTCARD2_POWER_SEL_5V                 0x01
#define SMARTCARD2_POWER_SEL_3V                 0x02
#define SMARTCARD2_POWER_SEL_1_8V               0x03
 
#define SMARTCARD2_ICC_ACTIVE                   0
#define SMARTCARD2_ICC_PRESENT                  1
#define SMARTCARD2_ICC_ABSENT                   2
#define SMARTCARD2_ICC_STATUS_MASK              0x03
 
#define SMARTCARD2_TX_DRV_BUFFER_SIZE           SMARTCARD2_MAX_BUF_SIZE
#define SMARTCARD2_RX_DRV_BUFFER_SIZE           ( SMARTCARD2_MAX_BUF_SIZE * 2 )
 
 // smartcard2_cmd
 
#define SMARTCARD2_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.tx_pin  = MIKROBUS( mikrobus, MIKROBUS_TX ); \
    cfg.rx_pin  = MIKROBUS( mikrobus, MIKROBUS_RX ); \
    cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST );
 
 // smartcard2_map
 // smartcard2
 
typedef struct
{
    uint8_t type;               
    uint32_t payload_size;      
    uint8_t slot_num;           
    uint8_t seq_num;            
    uint8_t spec_bytes[ 3 ];    
    uint8_t payload[ SMARTCARD2_SHORT_APDU_MAX_SIZE ];  
} smartcard2_ccid_t;
 
typedef struct
{
    // Output pins
    digital_out_t rst;                  
    // Modules
    uart_t uart;                        
    // Buffers
    char uart_rx_buffer[ SMARTCARD2_RX_DRV_BUFFER_SIZE ];   
    char uart_tx_buffer[ SMARTCARD2_TX_DRV_BUFFER_SIZE ];   
    uint8_t seq_num;                    
} smartcard2_t;
 
typedef struct
{
    // Communication gpio pins
    pin_name_t rx_pin;                  
    pin_name_t tx_pin;                  
    // Additional gpio pins
    pin_name_t rst;                     
    // 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;          
} smartcard2_cfg_t;
 
typedef enum
{
    SMARTCARD2_OK = 0,
    SMARTCARD2_ERROR = -1,
    SMARTCARD2_READ_ERROR = -2,
    SMARTCARD2_CHECKSUM_ERROR = -3,
    SMARTCARD2_TIMEOUT_ERROR = -4,
 
} smartcard2_return_value_t;
 
void smartcard2_cfg_setup ( smartcard2_cfg_t *cfg );
 
err_t smartcard2_init ( smartcard2_t *ctx, smartcard2_cfg_t *cfg );
 
err_t smartcard2_generic_write ( smartcard2_t *ctx, char *data_in, uint16_t len );
 
err_t smartcard2_generic_read ( smartcard2_t *ctx, char *data_out, uint16_t len );
 
void smartcard2_enable_device ( smartcard2_t *ctx );
 
void smartcard2_disable_device ( smartcard2_t *ctx );
 
err_t smartcard2_send_ccid ( smartcard2_t *ctx, smartcard2_ccid_t *data_in );
 
err_t smartcard2_read_ccid ( smartcard2_t *ctx, smartcard2_ccid_t *data_out );
 
err_t smartcard2_icc_power_on ( smartcard2_t *ctx, uint8_t power_sel );
 
err_t smartcard2_icc_power_off ( smartcard2_t *ctx );
 
err_t smartcard2_get_slot_status ( smartcard2_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // SMARTCARD2_H
 
 // smartcard2
 
// ------------------------------------------------------------------------ END