smartcard2  2.1.0.0
smartcard2.h
Go to the documentation of this file.
1 /****************************************************************************
2 ** Copyright (C) 2020 MikroElektronika d.o.o.
3 ** Contact: https://www.mikroe.com/contact
4 **
5 ** Permission is hereby granted, free of charge, to any person obtaining a copy
6 ** of this software and associated documentation files (the "Software"), to deal
7 ** in the Software without restriction, including without limitation the rights
8 ** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 ** copies of the Software, and to permit persons to whom the Software is
10 ** furnished to do so, subject to the following conditions:
11 ** The above copyright notice and this permission notice shall be
12 ** included in all copies or substantial portions of the Software.
13 **
14 ** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15 ** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
16 ** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
17 ** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
18 ** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
19 ** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
20 ** USE OR OTHER DEALINGS IN THE SOFTWARE.
21 ****************************************************************************/
22 
28 #ifndef SMARTCARD2_H
29 #define SMARTCARD2_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "drv_digital_out.h"
36 #include "drv_digital_in.h"
37 #include "drv_uart.h"
38 
59 #define SMARTCARD2_CMD_ICC_POWER_ON 0x62
60 #define SMARTCARD2_CMD_ICC_POWER_OFF 0x63
61 #define SMARTCARD2_CMD_GET_SLOT_STATUS 0x65
62 #define SMARTCARD2_CMD_XFR_BLOCK 0x6F
63 #define SMARTCARD2_CMD_GET_PARAMETERS 0x6C
64 #define SMARTCARD2_CMD_RESET_PARAMETERS 0x6D
65 #define SMARTCARD2_CMD_SET_PARAMETERS 0x61
66 #define SMARTCARD2_CMD_ESCAPE 0x6B
67 #define SMARTCARD2_CMD_ICC_ESCAPE 0x6E
68 #define SMARTCARD2_CMD_T0_APDU 0x6A
69 #define SMARTCARD2_CMD_SECURE 0x69
70 #define SMARTCARD2_CMD_MECHANICAL 0x71
71 #define SMARTCARD2_CMD_ABORT 0x72
72 #define SMARTCARD2_CMD_SET_DATA_RATE_CLK_FREQ 0x73
73 
78 #define SMARTCARD2_RSP_DATA_BLOCK 0x80
79 #define SMARTCARD2_RSP_SLOT_STATUS 0x81
80 #define SMARTCARD2_RSP_PARAMETERS 0x82
81 #define SMARTCARD2_RSP_ESCAPE 0x83
82 #define SMARTCARD2_RSP_DATA_RATE_CLK_FREQ 0x84
83 
88 #define SMARTCARD2_EVT_NOTIFY_SLOT_CHANGE 0x50
89 #define SMARTCARD2_CARD_ABSENT 0x02
90 #define SMARTCARD2_CARD_PRESENT 0x03
91 #define SMARTCARD2_EVT_HARDWARE_ERROR 0x51
92 #define SMARTCARD2_OVERCURRENT 0x01
93 
98 #define SMARTCARD2_SYNC 0x03
99 #define SMARTCARD2_CTRL_ACK 0x06
100 #define SMARTCARD2_CTRL_NACK 0x15
101 #define SMARTCARD2_SHORT_APDU_MAX_SIZE 261
102 // sync + ack + 10-byte ccid header + short APDU size + checksum
103 #define SMARTCARD2_MAX_BUF_SIZE ( SMARTCARD2_SHORT_APDU_MAX_SIZE + 13 )
104 #define SMARTCARD2_TIMEOUT_MS 5000
105 
110 #define SMARTCARD2_CLK_STATUS_RUNNING 0x00
111 #define SMARTCARD2_CLK_STATUS_STATE_L 0x01
112 #define SMARTCARD2_CLK_STATUS_STATE_H 0x02
113 
118 #define SMARTCARD2_POWER_SEL_AUTO 0x00
119 #define SMARTCARD2_POWER_SEL_5V 0x01
120 #define SMARTCARD2_POWER_SEL_3V 0x02
121 #define SMARTCARD2_POWER_SEL_1_8V 0x03
122 
127 #define SMARTCARD2_ICC_ACTIVE 0
128 #define SMARTCARD2_ICC_PRESENT 1
129 #define SMARTCARD2_ICC_ABSENT 2
130 #define SMARTCARD2_ICC_STATUS_MASK 0x03
131 
137 #define SMARTCARD2_TX_DRV_BUFFER_SIZE SMARTCARD2_MAX_BUF_SIZE
138 #define SMARTCARD2_RX_DRV_BUFFER_SIZE ( SMARTCARD2_MAX_BUF_SIZE * 2 )
139  // smartcard2_cmd
141 
156 #define SMARTCARD2_MAP_MIKROBUS( cfg, mikrobus ) \
157  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
158  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
159  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST );
160  // smartcard2_map // smartcard2
163 
168 typedef struct
169 {
170  uint8_t type;
171  uint32_t payload_size;
172  uint8_t slot_num;
173  uint8_t seq_num;
174  uint8_t spec_bytes[ 3 ];
176  uint8_t payload[ SMARTCARD2_SHORT_APDU_MAX_SIZE ];
179 
184 typedef struct
185 {
186  // Output pins
187  digital_out_t rst;
189  // Modules
190  uart_t uart;
192  // Buffers
193  char uart_rx_buffer[ SMARTCARD2_RX_DRV_BUFFER_SIZE ];
194  char uart_tx_buffer[ SMARTCARD2_TX_DRV_BUFFER_SIZE ];
196  uint8_t seq_num;
199 } smartcard2_t;
200 
205 typedef struct
206 {
207  // Communication gpio pins
208  pin_name_t rx_pin;
209  pin_name_t tx_pin;
211  // Additional gpio pins
212  pin_name_t rst;
214  // Static variable
215  uint32_t baud_rate;
217  uart_data_bits_t data_bit;
218  uart_parity_t parity_bit;
219  uart_stop_bits_t stop_bit;
222 
227 typedef enum
228 {
234 
236 
253 
268 
281 err_t smartcard2_generic_write ( smartcard2_t *ctx, char *data_in, uint16_t len );
282 
295 err_t smartcard2_generic_read ( smartcard2_t *ctx, char *data_out, uint16_t len );
296 
306 
316 
330 
347 
363 err_t smartcard2_icc_power_on ( smartcard2_t *ctx, uint8_t power_sel );
364 
377 
390 
391 #ifdef __cplusplus
392 }
393 #endif
394 #endif // SMARTCARD2_H
395  // smartcard2
397 
398 // ------------------------------------------------------------------------ END
smartcard2_t
Smart Card 2 Click context object.
Definition: smartcard2.h:185
smartcard2_enable_device
void smartcard2_enable_device(smartcard2_t *ctx)
Smart Card 2 enable device function.
SMARTCARD2_ERROR
@ SMARTCARD2_ERROR
Definition: smartcard2.h:230
smartcard2_icc_power_on
err_t smartcard2_icc_power_on(smartcard2_t *ctx, uint8_t power_sel)
Smart Card 2 icc power on function.
smartcard2_ccid_t
Smart Card 2 Click context object.
Definition: smartcard2.h:169
smartcard2_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: smartcard2.h:217
smartcard2_ccid_t::slot_num
uint8_t slot_num
Definition: smartcard2.h:172
smartcard2_icc_power_off
err_t smartcard2_icc_power_off(smartcard2_t *ctx)
Smart Card 2 icc power off function.
smartcard2_t::rst
digital_out_t rst
Definition: smartcard2.h:187
smartcard2_ccid_t::type
uint8_t type
Definition: smartcard2.h:170
smartcard2_generic_write
err_t smartcard2_generic_write(smartcard2_t *ctx, char *data_in, uint16_t len)
Smart Card 2 data writing function.
smartcard2_read_ccid
err_t smartcard2_read_ccid(smartcard2_t *ctx, smartcard2_ccid_t *data_out)
Smart Card 2 read ccid function.
smartcard2_send_ccid
err_t smartcard2_send_ccid(smartcard2_t *ctx, smartcard2_ccid_t *data_in)
Smart Card 2 send ccid function.
SMARTCARD2_CHECKSUM_ERROR
@ SMARTCARD2_CHECKSUM_ERROR
Definition: smartcard2.h:232
smartcard2_ccid_t::seq_num
uint8_t seq_num
Definition: smartcard2.h:173
smartcard2_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: smartcard2.h:219
SMARTCARD2_OK
@ SMARTCARD2_OK
Definition: smartcard2.h:229
smartcard2_cfg_t
Smart Card 2 Click configuration object.
Definition: smartcard2.h:206
smartcard2_disable_device
void smartcard2_disable_device(smartcard2_t *ctx)
Smart Card 2 disable device function.
SMARTCARD2_READ_ERROR
@ SMARTCARD2_READ_ERROR
Definition: smartcard2.h:231
smartcard2_cfg_t::uart_blocking
bool uart_blocking
Definition: smartcard2.h:216
SMARTCARD2_TIMEOUT_ERROR
@ SMARTCARD2_TIMEOUT_ERROR
Definition: smartcard2.h:233
SMARTCARD2_TX_DRV_BUFFER_SIZE
#define SMARTCARD2_TX_DRV_BUFFER_SIZE
Smart Card 2 driver buffer size.
Definition: smartcard2.h:137
smartcard2_return_value_t
smartcard2_return_value_t
Smart Card 2 Click return value data.
Definition: smartcard2.h:228
smartcard2_t::seq_num
uint8_t seq_num
Definition: smartcard2.h:196
smartcard2_cfg_t::tx_pin
pin_name_t tx_pin
Definition: smartcard2.h:209
smartcard2_cfg_setup
void smartcard2_cfg_setup(smartcard2_cfg_t *cfg)
Smart Card 2 configuration object setup function.
smartcard2_get_slot_status
err_t smartcard2_get_slot_status(smartcard2_t *ctx)
Smart Card 2 get slot status function.
smartcard2_generic_read
err_t smartcard2_generic_read(smartcard2_t *ctx, char *data_out, uint16_t len)
Smart Card 2 data reading function.
smartcard2_ccid_t::payload_size
uint32_t payload_size
Definition: smartcard2.h:171
SMARTCARD2_SHORT_APDU_MAX_SIZE
#define SMARTCARD2_SHORT_APDU_MAX_SIZE
Definition: smartcard2.h:101
smartcard2_t::uart
uart_t uart
Definition: smartcard2.h:190
smartcard2_cfg_t::baud_rate
uint32_t baud_rate
Definition: smartcard2.h:215
smartcard2_cfg_t::rst
pin_name_t rst
Definition: smartcard2.h:212
smartcard2_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: smartcard2.h:218
smartcard2_cfg_t::rx_pin
pin_name_t rx_pin
Definition: smartcard2.h:208
smartcard2_init
err_t smartcard2_init(smartcard2_t *ctx, smartcard2_cfg_t *cfg)
Smart Card 2 initialization function.
SMARTCARD2_RX_DRV_BUFFER_SIZE
#define SMARTCARD2_RX_DRV_BUFFER_SIZE
Definition: smartcard2.h:138