/[pcsclite]/trunk/Drivers/ccid/src/ccid_serial.c
ViewVC logotype

Contents of /trunk/Drivers/ccid/src/ccid_serial.c

Parent Directory Parent Directory | Revision Log Revision Log


Revision 774 - (show annotations) (download)
Tue Apr 6 13:15:34 2004 UTC (9 years, 1 month ago) by rousseau
File MIME type: text/plain
File size: 13999 byte(s)
add { } to avoid ambiguities now that DEBUG_* are "if (x) y" constructions
1 /*
2 * ccid_serial.c: communicate with a GemPC Twin smart card reader
3 * Copyright (C) 2001-2003 Ludovic Rousseau <ludovic.rousseau@free.fr>
4 *
5 * Thanks to Niki W. Waibel <niki.waibel@gmx.net> for a prototype version
6 *
7 * This program is free software; you can redistribute it and/or modify it
8 * under the terms of the GNU General Public License as published by the
9 * Free Software Foundation; either version 2 of the License, or (at your
10 * option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License along
18 * with this program; if not, write to the Free Software Foundation, Inc.,
19 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20 */
21
22 /*
23 * $Id$
24 */
25
26 #include <stdio.h>
27 #include <stdlib.h>
28 #include <fcntl.h>
29 #include <unistd.h>
30 #include <termios.h>
31 #include <string.h>
32 #include <errno.h>
33 #include <sys/time.h>
34 #include <sys/types.h>
35
36 #include "pcscdefines.h"
37 #include "config.h"
38 #include "debug.h"
39 #include "ccid.h"
40 #include "utils.h"
41
42 /* communication timeout in seconds */
43 #define SERIAL_TIMEOUT 2
44
45 #define SYNC 0x03
46 #define CTRL_ACK 0x06
47 #define CTRL_NAK 0x15
48 #define RDR_to_PC_NotifySlotChange 0x50
49 #define CARD_ABSENT 0x02
50 #define CARD_PRESENT 0x03
51
52 /*
53 * normal command:
54 * 1 : SYNC
55 * 1 : CTRL
56 * 10 +data length : CCID command
57 * 1 : LRC
58 *
59 * SYNC : 0x03
60 * CTRL : ACK (0x06) or NAK (0x15)
61 * CCID command : see USB CCID specs
62 * LRC : xor of all the previous byes
63 *
64 * Error message:
65 * 1 : SYNC (0x03)
66 * 1 : CTRL (NAK: 0x15)
67 * 1 : LRC (0x16)
68 *
69 * Card insertion/withdrawal
70 * 1 : RDR_to_PC_NotifySlotChange (0x50)
71 * 1 : bmSlotIccState
72 * 0x02 if card absent
73 * 0x03 is card present
74 *
75 * Time request
76 * T=1 : normal CCID command
77 * T=0 : 1 byte (value between 0x80 and 0xFF)
78 *
79 */
80
81 /*
82 * You may get read timeout after a card movement.
83 * This is because you will get the echo of the CCID command
84 * but not the result of the command.
85 *
86 * This is not an applicative issue since the card is either removed (and
87 * powered off) or just inserted (and not yet powered on).
88 */
89
90 /* 271 = max size for short APDU
91 * 2 bytes for header
92 * 1 byte checksum
93 * doubled for echo
94 */
95 #define GEMPCTWIN_MAXBUF (271 +2 +1) * 2
96
97 typedef struct
98 {
99 /*
100 * File handle on the serial port
101 */
102 int fd;
103
104 /*
105 * device used ("/dev/ttyS?" under Linux)
106 */
107 char *device;
108
109 /*
110 * serial communication buffer
111 */
112 unsigned char buffer[GEMPCTWIN_MAXBUF];
113
114 /*
115 * next available byte
116 */
117 int buffer_offset;
118
119 /*
120 * number of available bytes
121 */
122 int buffer_offset_last;
123
124 /*
125 * CCID infos common to USB and serial
126 */
127 _ccid_descriptor ccid;
128
129 } _serialDevice;
130
131 /* The _serialDevice structure must be defined before including ccid_serial.h */
132 #include "ccid_serial.h"
133
134 static _serialDevice serialDevice[PCSCLITE_MAX_READERS] = {
135 [ 0 ... (PCSCLITE_MAX_READERS-1) ] = { -1, NULL }
136 };
137
138 /*****************************************************************************
139 *
140 * WriteSerial: Send bytes to the card reader
141 *
142 *****************************************************************************/
143 status_t WriteSerial(int lun, int length, unsigned char *buffer)
144 {
145 int i;
146 unsigned char lrc;
147 unsigned char low_level_buffer[GEMPCTWIN_MAXBUF];
148
149 #ifdef DEBUG_LEVEL_COMM
150 char debug_header[] = "-> 121234 ";
151
152 sprintf(debug_header, "-> %06X ", (int)lun);
153 #endif
154
155 if (length > GEMPCTWIN_MAXBUF-3)
156 {
157 DEBUG_CRITICAL3("command too long: %d for max %d",
158 length, GEMPCTWIN_MAXBUF-3);
159 return STATUS_UNSUCCESSFUL;
160 }
161
162 /* header */
163 low_level_buffer[0] = 0x03; /* SYNC */
164 low_level_buffer[1] = 0x06; /* ACK */
165
166 /* CCID command */
167 memcpy(low_level_buffer+2, buffer, length);
168
169 /* checksum */
170 lrc = 0;
171 for(i=0; i<length+2; i++)
172 lrc ^= low_level_buffer[i];
173 low_level_buffer[length+2] = lrc;
174
175 #ifdef DEBUG_LEVEL_COMM
176 DEBUG_XXD(debug_header, low_level_buffer, length+3);
177 #endif
178
179 if (write(serialDevice[LunToReaderIndex(lun)].fd, low_level_buffer,
180 length+3) != length+3)
181 {
182 DEBUG_CRITICAL2("write error: %s", strerror(errno));
183 return STATUS_UNSUCCESSFUL;
184 }
185
186 return STATUS_SUCCESS;
187 } /* WriteSerial */
188
189
190 /*****************************************************************************
191 *
192 * ReadSerial: Receive bytes from the card reader
193 *
194 *****************************************************************************/
195 status_t ReadSerial(int lun, int *length, unsigned char *buffer)
196 {
197 unsigned char c;
198 int rv;
199 int echo;
200 int to_read;
201 int i;
202
203 /* we get the echo first */
204 echo = TRUE;
205
206 start:
207 DEBUG_COMM("start");
208 if ((rv = get_bytes(lun, &c, 1)) != STATUS_SUCCESS)
209 return rv;
210
211 if (c == RDR_to_PC_NotifySlotChange)
212 goto slot_change;
213
214 if (c == SYNC)
215 goto sync;
216
217 if (c >= 0x80)
218 {
219 DEBUG_COMM2("time request: 0x%02X", c);
220 goto start;
221 }
222
223 DEBUG_CRITICAL2("Got 0x%02X", c);
224 return STATUS_COMM_ERROR;
225
226 slot_change:
227 DEBUG_COMM("slot change");
228 if ((rv = get_bytes(lun, &c, 1)) != STATUS_SUCCESS)
229 return rv;
230
231 if (c == CARD_ABSENT)
232 {
233 DEBUG_COMM("Card removed");
234 }
235 else
236 if (c == CARD_PRESENT)
237 {
238 DEBUG_COMM("Card inserted");
239 }
240 else
241 {
242 DEBUG_COMM2("Unknown card movement: %d", buffer[3]);
243 }
244 goto start;
245
246 sync:
247 DEBUG_COMM("sync");
248 if ((rv = get_bytes(lun, &c, 1)) != STATUS_SUCCESS)
249 return rv;
250
251 if (c == CTRL_ACK)
252 goto ack;
253
254 if (c == CTRL_NAK)
255 goto nak;
256
257 DEBUG_CRITICAL2("Got 0x%02X instead of ACK/NAK", c);
258 return STATUS_COMM_ERROR;
259
260 nak:
261 DEBUG_COMM("nak");
262 if ((rv = get_bytes(lun, &c, 1)) != STATUS_SUCCESS)
263 return rv;
264
265 if (c != (SYNC ^ CTRL_NAK))
266 {
267 DEBUG_CRITICAL2("Wrong LRC: 0x%02X", c);
268 return STATUS_COMM_ERROR;
269 }
270 else
271 goto start;
272
273 ack:
274 DEBUG_COMM("ack");
275 /* normal CCID frame */
276 if ((rv = get_bytes(lun, buffer, 5)) != STATUS_SUCCESS)
277 return rv;
278
279 /* total frame size */
280 to_read = 10+dw2i(buffer, 1);
281
282 DEBUG_COMM2("frame size: %d", to_read);
283 if ((rv = get_bytes(lun, buffer+5, to_read-5)) != STATUS_SUCCESS)
284 return rv;
285
286 #ifdef DEBUG_LEVEL_COMM
287 DEBUG_XXD("frame: ", buffer, to_read);
288 #endif
289
290 /* lrc */
291 DEBUG_COMM("lrc");
292 if ((rv = get_bytes(lun, &c, 1)) != STATUS_SUCCESS)
293 return rv;
294
295 DEBUG_COMM2("lrc: 0x%02X", c);
296 for (i=0; i<to_read; i++)
297 c ^= buffer[i];
298
299 if (c != (SYNC ^ CTRL_ACK))
300 {
301 DEBUG_CRITICAL2("Wrong LRC: 0x%02X", c);
302 //return STATUS_COMM_ERROR;
303 }
304
305 if (echo)
306 {
307 echo = FALSE;
308 goto start;
309 }
310
311 return STATUS_SUCCESS;
312 } /* ReadSerial */
313
314
315 /*****************************************************************************
316 *
317 * get_bytes: get n bytes
318 *
319 *****************************************************************************/
320 int get_bytes(int lun, unsigned char *buffer, int length)
321 {
322 int offset = serialDevice[LunToReaderIndex(lun)].buffer_offset;
323 int offset_last = serialDevice[LunToReaderIndex(lun)].buffer_offset_last;
324
325 DEBUG_COMM3("available: %d, needed: %d", offset_last-offset,
326 length);
327 /* enough data are available */
328 if (offset + length <= offset_last)
329 {
330 DEBUG_COMM("data available");
331 memcpy(buffer, serialDevice[LunToReaderIndex(lun)].buffer + offset, length);
332 serialDevice[LunToReaderIndex(lun)].buffer_offset += length;
333 }
334 else
335 {
336 int present, rv;
337
338 /* copy available data */
339 present = offset_last - offset;
340
341 if (present > 0)
342 {
343 DEBUG_COMM2("some data available: %d", present);
344 memcpy(buffer, serialDevice[LunToReaderIndex(lun)].buffer + offset,
345 present);
346 }
347
348 /* get fresh data */
349 DEBUG_COMM2("get more data: %d", length - present);
350 rv = ReadChunk(lun, serialDevice[LunToReaderIndex(lun)].buffer, sizeof(serialDevice[LunToReaderIndex(lun)].buffer), length - present);
351 if (rv < 0)
352 return STATUS_COMM_ERROR;
353
354 /* fill the buffer */
355 memcpy(buffer + present, serialDevice[LunToReaderIndex(lun)].buffer,
356 length - present);
357 serialDevice[LunToReaderIndex(lun)].buffer_offset = length - present;
358 serialDevice[LunToReaderIndex(lun)].buffer_offset_last = rv;
359 DEBUG_COMM3("offset: %d, last_offset: %d",
360 serialDevice[LunToReaderIndex(lun)].buffer_offset,
361 serialDevice[LunToReaderIndex(lun)].buffer_offset_last);
362 }
363
364 return STATUS_SUCCESS;
365 } /* get_bytes */
366
367
368 /*****************************************************************************
369 *
370 * ReadChunk: read a minimum number of bytes
371 *
372 *****************************************************************************/
373 int ReadChunk(int lun, unsigned char *buffer, int buffer_length, int min_length)
374 {
375 int fd = serialDevice[LunToReaderIndex(lun)].fd;
376 fd_set fdset;
377 struct timeval t;
378 int i, rv = 0;
379 int already_read;
380 #ifdef DEBUG_LEVEL_COMM
381 char debug_header[] = "<- 121234 ";
382
383 sprintf(debug_header, "<- %06X ", (int)lun);
384 #endif
385
386 already_read = 0;
387 while (already_read < min_length)
388 {
389 /* use select() to, eventually, timeout */
390 FD_ZERO(&fdset);
391 FD_SET(fd, &fdset);
392 t.tv_sec = SERIAL_TIMEOUT;
393 t.tv_usec = 0;
394
395 i = select(fd+1, &fdset, NULL, NULL, &t);
396 if (i == -1)
397 {
398 DEBUG_CRITICAL2("select: %s", strerror(errno));
399 return -1;
400 }
401 else
402 if (i == 0)
403 {
404 DEBUG_COMM2("Timeout! (%d sec)", SERIAL_TIMEOUT);
405 return -1;
406 }
407
408 rv = read(fd, buffer + already_read, buffer_length - already_read);
409 if (rv < 0)
410 {
411 DEBUG_COMM2("read error: %s", strerror(errno));
412 return -1;
413 }
414
415 #ifdef DEBUG_LEVEL_COMM
416 DEBUG_XXD(debug_header, buffer + already_read, rv);
417 #endif
418
419 already_read += rv;
420 DEBUG_COMM3("read: %d, to read: %d", already_read,
421 min_length);
422 }
423
424 return already_read;
425 } /* ReadChunk */
426
427
428 /*****************************************************************************
429 *
430 * OpenSerial: open the port
431 *
432 *****************************************************************************/
433 status_t OpenSerial(int lun, int channel)
434 {
435 char dev_name[FILENAME_MAX];
436
437 DEBUG_COMM3("Lun: %X, Channel: %d", lun, channel);
438
439 /*
440 * Conversion of old-style ifd-hanler 1.0 CHANNELID
441 */
442 if (channel == 0x0103F8)
443 channel = 1;
444 else
445 if (channel == 0x0102F8)
446 channel = 2;
447 else
448 if (channel == 0x0103E8)
449 channel = 3;
450 else
451 if (channel == 0x0102E8)
452 channel = 4;
453
454 if (channel < 0)
455 {
456 DEBUG_CRITICAL2("wrong port number: %d", (int) channel);
457 return STATUS_UNSUCCESSFUL;
458 }
459
460 sprintf(dev_name, "/dev/pcsc/%d", (int) channel);
461
462 return OpenSerialByName(lun, dev_name);
463 } /* OpenSerial */
464
465 /*****************************************************************************
466 *
467 * OpenSerialByName: open the port
468 *
469 *****************************************************************************/
470 status_t OpenSerialByName(int lun, char *dev_name)
471 {
472 struct termios current_termios;
473 int i;
474 int reader = LunToReaderIndex(lun);
475
476 DEBUG_COMM3("Lun: %X, Device: %d", lun, dev_name);
477
478 /* check if the same channel is not already used */
479 for (i=0; i<PCSCLITE_MAX_READERS; i++)
480 {
481 if (serialDevice[i].device &&
482 strcmp(serialDevice[i].device, dev_name) == 0)
483 {
484 DEBUG_CRITICAL2("Device %s already in use", dev_name);
485 return STATUS_UNSUCCESSFUL;
486 }
487 }
488
489 serialDevice[reader].fd = open(dev_name, O_RDWR | O_NOCTTY);
490
491 if (serialDevice[reader].fd <= 0)
492 {
493 DEBUG_CRITICAL3("open %s: %s", dev_name, strerror(errno));
494 return STATUS_UNSUCCESSFUL;
495 }
496
497 /* set channel used */
498 serialDevice[reader].device = strdup(dev_name);
499
500 /* empty in and out serial buffers */
501 if (tcflush(serialDevice[reader].fd, TCIOFLUSH))
502 DEBUG_INFO2("tcflush() function error: %s", strerror(errno));
503
504 /* get config attributes */
505 if (tcgetattr(serialDevice[reader].fd, &current_termios) == -1)
506 {
507 DEBUG_INFO2("tcgetattr() function error: %s", strerror(errno));
508 close(serialDevice[reader].fd);
509 serialDevice[reader].fd = -1;
510
511 return STATUS_UNSUCCESSFUL;
512 }
513
514 /* IGNBRK: ignore BREAK condition on input
515 * IGNPAR: ignore framing errors and parity errors. */
516 current_termios.c_iflag = IGNBRK | IGNPAR;
517 current_termios.c_oflag = 0; /* Raw output modes */
518 /* CS8: 8-bits character size
519 * CSTOPB: set two stop bits
520 * CREAD: enable receiver
521 * CLOCAL: ignore modem control lines */
522 current_termios.c_cflag = CS8 | CSTOPB | CREAD | CLOCAL;
523
524 /* Do not echo characters because if you connect to a host it or your modem
525 * will echo characters for you. Don't generate signals. */
526 current_termios.c_lflag = 0;
527
528 /* set serial port speed to 115200 bauds */
529 cfsetspeed(&current_termios, B115200);
530
531 DEBUG_INFO("Set serial port baudrate to 115200 and correct configuration");
532 if (tcsetattr(serialDevice[reader].fd, TCSANOW, &current_termios) == -1)
533 {
534 close(serialDevice[reader].fd);
535 serialDevice[reader].fd = -1;
536 DEBUG_INFO2("tcsetattr error: %s", strerror(errno));
537
538 return STATUS_UNSUCCESSFUL;
539 }
540
541 serialDevice[reader].ccid.bSeq = 0;
542 serialDevice[reader].ccid.readerID = GEMPCTWIN;
543 serialDevice[reader].ccid.dwMaxCCIDMessageLength = 271;
544 serialDevice[reader].ccid.dwMaxIFSD = 254;
545 serialDevice[reader].ccid.dwFeatures = 0x00010230;
546 serialDevice[reader].ccid.dwDefaultClock = 4000;
547 serialDevice[reader].ccid.dwMaxDataRate = 344086;
548
549 serialDevice[reader].buffer_offset = 0;
550 serialDevice[reader].buffer_offset_last = 0;
551
552 return STATUS_SUCCESS;
553 } /* OpenSerialByName */
554
555
556 /*****************************************************************************
557 *
558 * CloseSerial: close the port
559 *
560 *****************************************************************************/
561 status_t CloseSerial(int lun)
562 {
563 int reader = LunToReaderIndex(lun);
564
565 close(serialDevice[reader].fd);
566 serialDevice[reader].fd = -1;
567
568 free(serialDevice[reader].device);
569 serialDevice[reader].device = NULL;
570
571 return STATUS_SUCCESS;
572 } /* CloseSerial */
573
574
575 /*****************************************************************************
576 *
577 * get_ccid_descriptor
578 *
579 ****************************************************************************/
580 _ccid_descriptor *get_ccid_descriptor(int lun)
581 {
582 return &serialDevice[LunToReaderIndex(lun)].ccid;
583 } /* get_ccid_descriptor */
584
585

Properties

Name Value
svn:eol-style native
svn:keywords Author Date Id Revision

  ViewVC Help
Powered by ViewVC 1.1.5