usb: ccid: check ccid apdu length
[qemu/ar7.git] / hw / usb / dev-smartcard-reader.c
blob1325ea1659a064869a8cd3485e5968c75fac593e
1 /*
2 * Copyright (C) 2011 Red Hat, Inc.
4 * CCID Device emulation
6 * Written by Alon Levy, with contributions from Robert Relyea.
8 * Based on usb-serial.c, see its copyright and attributions below.
10 * This work is licensed under the terms of the GNU GPL, version 2.1 or later.
11 * See the COPYING file in the top-level directory.
12 * ------- (original copyright & attribution for usb-serial.c below) --------
13 * Copyright (c) 2006 CodeSourcery.
14 * Copyright (c) 2008 Samuel Thibault <samuel.thibault@ens-lyon.org>
15 * Written by Paul Brook, reused for FTDI by Samuel Thibault,
19 * References:
21 * CCID Specification Revision 1.1 April 22nd 2005
22 * "Universal Serial Bus, Device Class: Smart Card"
23 * Specification for Integrated Circuit(s) Cards Interface Devices
25 * Endianness note: from the spec (1.3)
26 * "Fields that are larger than a byte are stored in little endian"
28 * KNOWN BUGS
29 * 1. remove/insert can sometimes result in removed state instead of inserted.
30 * This is a result of the following:
31 * symptom: dmesg shows ERMOTEIO (-121), pcscd shows -99. This can happen
32 * when a short packet is sent, as seen in uhci-usb.c, resulting from a urb
33 * from the guest requesting SPD and us returning a smaller packet.
34 * Not sure which messages trigger this.
37 #include "qemu/osdep.h"
38 #include "qapi/error.h"
39 #include "qemu-common.h"
40 #include "qemu/error-report.h"
41 #include "hw/usb.h"
42 #include "hw/usb/desc.h"
44 #include "ccid.h"
46 #define DPRINTF(s, lvl, fmt, ...) \
47 do { \
48 if (lvl <= s->debug) { \
49 printf("usb-ccid: " fmt , ## __VA_ARGS__); \
50 } \
51 } while (0)
53 #define D_WARN 1
54 #define D_INFO 2
55 #define D_MORE_INFO 3
56 #define D_VERBOSE 4
58 #define CCID_DEV_NAME "usb-ccid"
59 #define USB_CCID_DEV(obj) OBJECT_CHECK(USBCCIDState, (obj), CCID_DEV_NAME)
61 * The two options for variable sized buffers:
62 * make them constant size, for large enough constant,
63 * or handle the migration complexity - VMState doesn't handle this case.
64 * sizes are expected never to be exceeded, unless guest misbehaves.
66 #define BULK_OUT_DATA_SIZE 65536
67 #define PENDING_ANSWERS_NUM 128
69 #define BULK_IN_BUF_SIZE 384
70 #define BULK_IN_PENDING_NUM 8
72 #define CCID_MAX_PACKET_SIZE 64
74 #define CCID_CONTROL_ABORT 0x1
75 #define CCID_CONTROL_GET_CLOCK_FREQUENCIES 0x2
76 #define CCID_CONTROL_GET_DATA_RATES 0x3
78 #define CCID_PRODUCT_DESCRIPTION "QEMU USB CCID"
79 #define CCID_VENDOR_DESCRIPTION "QEMU"
80 #define CCID_INTERFACE_NAME "CCID Interface"
81 #define CCID_SERIAL_NUMBER_STRING "1"
83 * Using Gemplus Vendor and Product id
84 * Effect on various drivers:
85 * usbccid.sys (winxp, others untested) is a class driver so it doesn't care.
86 * linux has a number of class drivers, but openct filters based on
87 * vendor/product (/etc/openct.conf under fedora), hence Gemplus.
89 #define CCID_VENDOR_ID 0x08e6
90 #define CCID_PRODUCT_ID 0x4433
91 #define CCID_DEVICE_VERSION 0x0000
94 * BULK_OUT messages from PC to Reader
95 * Defined in CCID Rev 1.1 6.1 (page 26)
97 #define CCID_MESSAGE_TYPE_PC_to_RDR_IccPowerOn 0x62
98 #define CCID_MESSAGE_TYPE_PC_to_RDR_IccPowerOff 0x63
99 #define CCID_MESSAGE_TYPE_PC_to_RDR_GetSlotStatus 0x65
100 #define CCID_MESSAGE_TYPE_PC_to_RDR_XfrBlock 0x6f
101 #define CCID_MESSAGE_TYPE_PC_to_RDR_GetParameters 0x6c
102 #define CCID_MESSAGE_TYPE_PC_to_RDR_ResetParameters 0x6d
103 #define CCID_MESSAGE_TYPE_PC_to_RDR_SetParameters 0x61
104 #define CCID_MESSAGE_TYPE_PC_to_RDR_Escape 0x6b
105 #define CCID_MESSAGE_TYPE_PC_to_RDR_IccClock 0x6e
106 #define CCID_MESSAGE_TYPE_PC_to_RDR_T0APDU 0x6a
107 #define CCID_MESSAGE_TYPE_PC_to_RDR_Secure 0x69
108 #define CCID_MESSAGE_TYPE_PC_to_RDR_Mechanical 0x71
109 #define CCID_MESSAGE_TYPE_PC_to_RDR_Abort 0x72
110 #define CCID_MESSAGE_TYPE_PC_to_RDR_SetDataRateAndClockFrequency 0x73
113 * BULK_IN messages from Reader to PC
114 * Defined in CCID Rev 1.1 6.2 (page 48)
116 #define CCID_MESSAGE_TYPE_RDR_to_PC_DataBlock 0x80
117 #define CCID_MESSAGE_TYPE_RDR_to_PC_SlotStatus 0x81
118 #define CCID_MESSAGE_TYPE_RDR_to_PC_Parameters 0x82
119 #define CCID_MESSAGE_TYPE_RDR_to_PC_Escape 0x83
120 #define CCID_MESSAGE_TYPE_RDR_to_PC_DataRateAndClockFrequency 0x84
123 * INTERRUPT_IN messages from Reader to PC
124 * Defined in CCID Rev 1.1 6.3 (page 56)
126 #define CCID_MESSAGE_TYPE_RDR_to_PC_NotifySlotChange 0x50
127 #define CCID_MESSAGE_TYPE_RDR_to_PC_HardwareError 0x51
130 * Endpoints for CCID - addresses are up to us to decide.
131 * To support slot insertion and removal we must have an interrupt in ep
132 * in addition we need a bulk in and bulk out ep
133 * 5.2, page 20
135 #define CCID_INT_IN_EP 1
136 #define CCID_BULK_IN_EP 2
137 #define CCID_BULK_OUT_EP 3
139 /* bmSlotICCState masks */
140 #define SLOT_0_STATE_MASK 1
141 #define SLOT_0_CHANGED_MASK 2
143 /* Status codes that go in bStatus (see 6.2.6) */
144 enum {
145 ICC_STATUS_PRESENT_ACTIVE = 0,
146 ICC_STATUS_PRESENT_INACTIVE,
147 ICC_STATUS_NOT_PRESENT
150 enum {
151 COMMAND_STATUS_NO_ERROR = 0,
152 COMMAND_STATUS_FAILED,
153 COMMAND_STATUS_TIME_EXTENSION_REQUIRED
156 /* Error codes that go in bError (see 6.2.6) */
157 enum {
158 ERROR_CMD_NOT_SUPPORTED = 0,
159 ERROR_CMD_ABORTED = -1,
160 ERROR_ICC_MUTE = -2,
161 ERROR_XFR_PARITY_ERROR = -3,
162 ERROR_XFR_OVERRUN = -4,
163 ERROR_HW_ERROR = -5,
166 /* 6.2.6 RDR_to_PC_SlotStatus definitions */
167 enum {
168 CLOCK_STATUS_RUNNING = 0,
170 * 0 - Clock Running, 1 - Clock stopped in State L, 2 - H,
171 * 3 - unknown state. rest are RFU
175 typedef struct QEMU_PACKED CCID_Header {
176 uint8_t bMessageType;
177 uint32_t dwLength;
178 uint8_t bSlot;
179 uint8_t bSeq;
180 } CCID_Header;
182 typedef struct QEMU_PACKED CCID_BULK_IN {
183 CCID_Header hdr;
184 uint8_t bStatus; /* Only used in BULK_IN */
185 uint8_t bError; /* Only used in BULK_IN */
186 } CCID_BULK_IN;
188 typedef struct QEMU_PACKED CCID_SlotStatus {
189 CCID_BULK_IN b;
190 uint8_t bClockStatus;
191 } CCID_SlotStatus;
193 typedef struct QEMU_PACKED CCID_T0ProtocolDataStructure {
194 uint8_t bmFindexDindex;
195 uint8_t bmTCCKST0;
196 uint8_t bGuardTimeT0;
197 uint8_t bWaitingIntegerT0;
198 uint8_t bClockStop;
199 } CCID_T0ProtocolDataStructure;
201 typedef struct QEMU_PACKED CCID_T1ProtocolDataStructure {
202 uint8_t bmFindexDindex;
203 uint8_t bmTCCKST1;
204 uint8_t bGuardTimeT1;
205 uint8_t bWaitingIntegerT1;
206 uint8_t bClockStop;
207 uint8_t bIFSC;
208 uint8_t bNadValue;
209 } CCID_T1ProtocolDataStructure;
211 typedef union CCID_ProtocolDataStructure {
212 CCID_T0ProtocolDataStructure t0;
213 CCID_T1ProtocolDataStructure t1;
214 uint8_t data[7]; /* must be = max(sizeof(t0), sizeof(t1)) */
215 } CCID_ProtocolDataStructure;
217 typedef struct QEMU_PACKED CCID_Parameter {
218 CCID_BULK_IN b;
219 uint8_t bProtocolNum;
220 CCID_ProtocolDataStructure abProtocolDataStructure;
221 } CCID_Parameter;
223 typedef struct QEMU_PACKED CCID_DataBlock {
224 CCID_BULK_IN b;
225 uint8_t bChainParameter;
226 uint8_t abData[0];
227 } CCID_DataBlock;
229 /* 6.1.4 PC_to_RDR_XfrBlock */
230 typedef struct QEMU_PACKED CCID_XferBlock {
231 CCID_Header hdr;
232 uint8_t bBWI; /* Block Waiting Timeout */
233 uint16_t wLevelParameter; /* XXX currently unused */
234 uint8_t abData[0];
235 } CCID_XferBlock;
237 typedef struct QEMU_PACKED CCID_IccPowerOn {
238 CCID_Header hdr;
239 uint8_t bPowerSelect;
240 uint16_t abRFU;
241 } CCID_IccPowerOn;
243 typedef struct QEMU_PACKED CCID_IccPowerOff {
244 CCID_Header hdr;
245 uint16_t abRFU;
246 } CCID_IccPowerOff;
248 typedef struct QEMU_PACKED CCID_SetParameters {
249 CCID_Header hdr;
250 uint8_t bProtocolNum;
251 uint16_t abRFU;
252 CCID_ProtocolDataStructure abProtocolDataStructure;
253 } CCID_SetParameters;
255 typedef struct CCID_Notify_Slot_Change {
256 uint8_t bMessageType; /* CCID_MESSAGE_TYPE_RDR_to_PC_NotifySlotChange */
257 uint8_t bmSlotICCState;
258 } CCID_Notify_Slot_Change;
260 /* used for DataBlock response to XferBlock */
261 typedef struct Answer {
262 uint8_t slot;
263 uint8_t seq;
264 } Answer;
266 /* pending BULK_IN messages */
267 typedef struct BulkIn {
268 uint8_t data[BULK_IN_BUF_SIZE];
269 uint32_t len;
270 uint32_t pos;
271 } BulkIn;
273 enum {
274 MIGRATION_NONE,
275 MIGRATION_MIGRATED,
278 typedef struct CCIDBus {
279 BusState qbus;
280 } CCIDBus;
283 * powered - defaults to true, changed by PowerOn/PowerOff messages
285 typedef struct USBCCIDState {
286 USBDevice dev;
287 USBEndpoint *intr;
288 USBEndpoint *bulk;
289 CCIDBus bus;
290 CCIDCardState *card;
291 BulkIn bulk_in_pending[BULK_IN_PENDING_NUM]; /* circular */
292 uint32_t bulk_in_pending_start;
293 uint32_t bulk_in_pending_end; /* first free */
294 uint32_t bulk_in_pending_num;
295 BulkIn *current_bulk_in;
296 uint8_t bulk_out_data[BULK_OUT_DATA_SIZE];
297 uint32_t bulk_out_pos;
298 uint64_t last_answer_error;
299 Answer pending_answers[PENDING_ANSWERS_NUM];
300 uint32_t pending_answers_start;
301 uint32_t pending_answers_end;
302 uint32_t pending_answers_num;
303 uint8_t bError;
304 uint8_t bmCommandStatus;
305 uint8_t bProtocolNum;
306 CCID_ProtocolDataStructure abProtocolDataStructure;
307 uint32_t ulProtocolDataStructureSize;
308 uint32_t state_vmstate;
309 uint32_t migration_target_ip;
310 uint16_t migration_target_port;
311 uint8_t migration_state;
312 uint8_t bmSlotICCState;
313 uint8_t powered;
314 uint8_t notify_slot_change;
315 uint8_t debug;
316 } USBCCIDState;
319 * CCID Spec chapter 4: CCID uses a standard device descriptor per Chapter 9,
320 * "USB Device Framework", section 9.6.1, in the Universal Serial Bus
321 * Specification.
323 * This device implemented based on the spec and with an Athena Smart Card
324 * Reader as reference:
325 * 0dc3:1004 Athena Smartcard Solutions, Inc.
328 static const uint8_t qemu_ccid_descriptor[] = {
329 /* Smart Card Device Class Descriptor */
330 0x36, /* u8 bLength; */
331 0x21, /* u8 bDescriptorType; Functional */
332 0x10, 0x01, /* u16 bcdCCID; CCID Specification Release Number. */
333 0x00, /*
334 * u8 bMaxSlotIndex; The index of the highest available
335 * slot on this device. All slots are consecutive starting
336 * at 00h.
338 0x07, /* u8 bVoltageSupport; 01h - 5.0v, 02h - 3.0, 03 - 1.8 */
340 0x00, 0x00, /* u32 dwProtocols; RRRR PPPP. RRRR = 0000h.*/
341 0x01, 0x00, /* PPPP: 0001h = Protocol T=0, 0002h = Protocol T=1 */
342 /* u32 dwDefaultClock; in kHZ (0x0fa0 is 4 MHz) */
343 0xa0, 0x0f, 0x00, 0x00,
344 /* u32 dwMaximumClock; */
345 0x00, 0x00, 0x01, 0x00,
346 0x00, /* u8 bNumClockSupported; *
347 * 0 means just the default and max. */
348 /* u32 dwDataRate ;bps. 9600 == 00002580h */
349 0x80, 0x25, 0x00, 0x00,
350 /* u32 dwMaxDataRate ; 11520 bps == 0001C200h */
351 0x00, 0xC2, 0x01, 0x00,
352 0x00, /* u8 bNumDataRatesSupported; 00 means all rates between
353 * default and max */
354 /* u32 dwMaxIFSD; *
355 * maximum IFSD supported by CCID for protocol *
356 * T=1 (Maximum seen from various cards) */
357 0xfe, 0x00, 0x00, 0x00,
358 /* u32 dwSyncProtocols; 1 - 2-wire, 2 - 3-wire, 4 - I2C */
359 0x00, 0x00, 0x00, 0x00,
360 /* u32 dwMechanical; 0 - no special characteristics. */
361 0x00, 0x00, 0x00, 0x00,
363 * u32 dwFeatures;
364 * 0 - No special characteristics
365 * + 2 Automatic parameter configuration based on ATR data
366 * + 4 Automatic activation of ICC on inserting
367 * + 8 Automatic ICC voltage selection
368 * + 10 Automatic ICC clock frequency change
369 * + 20 Automatic baud rate change
370 * + 40 Automatic parameters negotiation made by the CCID
371 * + 80 automatic PPS made by the CCID
372 * 100 CCID can set ICC in clock stop mode
373 * 200 NAD value other then 00 accepted (T=1 protocol)
374 * + 400 Automatic IFSD exchange as first exchange (T=1)
375 * One of the following only:
376 * + 10000 TPDU level exchanges with CCID
377 * 20000 Short APDU level exchange with CCID
378 * 40000 Short and Extended APDU level exchange with CCID
380 * 100000 USB Wake up signaling supported on card
381 * insertion and removal. Must set bit 5 in bmAttributes
382 * in Configuration descriptor if 100000 is set.
384 0xfe, 0x04, 0x01, 0x00,
386 * u32 dwMaxCCIDMessageLength; For extended APDU in
387 * [261 + 10 , 65544 + 10]. Otherwise the minimum is
388 * wMaxPacketSize of the Bulk-OUT endpoint
390 0x12, 0x00, 0x01, 0x00,
391 0xFF, /*
392 * u8 bClassGetResponse; Significant only for CCID that
393 * offers an APDU level for exchanges. Indicates the
394 * default class value used by the CCID when it sends a
395 * Get Response command to perform the transportation of
396 * an APDU by T=0 protocol
397 * FFh indicates that the CCID echos the class of the APDU.
399 0xFF, /*
400 * u8 bClassEnvelope; EAPDU only. Envelope command for
401 * T=0
403 0x00, 0x00, /*
404 * u16 wLcdLayout; XXYY Number of lines (XX) and chars per
405 * line for LCD display used for PIN entry. 0000 - no LCD
407 0x01, /*
408 * u8 bPINSupport; 01h PIN Verification,
409 * 02h PIN Modification
411 0x01, /* u8 bMaxCCIDBusySlots; */
414 enum {
415 STR_MANUFACTURER = 1,
416 STR_PRODUCT,
417 STR_SERIALNUMBER,
418 STR_INTERFACE,
421 static const USBDescStrings desc_strings = {
422 [STR_MANUFACTURER] = "QEMU",
423 [STR_PRODUCT] = "QEMU USB CCID",
424 [STR_SERIALNUMBER] = "1",
425 [STR_INTERFACE] = "CCID Interface",
428 static const USBDescIface desc_iface0 = {
429 .bInterfaceNumber = 0,
430 .bNumEndpoints = 3,
431 .bInterfaceClass = USB_CLASS_CSCID,
432 .bInterfaceSubClass = USB_SUBCLASS_UNDEFINED,
433 .bInterfaceProtocol = 0x00,
434 .iInterface = STR_INTERFACE,
435 .ndesc = 1,
436 .descs = (USBDescOther[]) {
438 /* smartcard descriptor */
439 .data = qemu_ccid_descriptor,
442 .eps = (USBDescEndpoint[]) {
444 .bEndpointAddress = USB_DIR_IN | CCID_INT_IN_EP,
445 .bmAttributes = USB_ENDPOINT_XFER_INT,
446 .bInterval = 255,
447 .wMaxPacketSize = 64,
449 .bEndpointAddress = USB_DIR_IN | CCID_BULK_IN_EP,
450 .bmAttributes = USB_ENDPOINT_XFER_BULK,
451 .wMaxPacketSize = 64,
453 .bEndpointAddress = USB_DIR_OUT | CCID_BULK_OUT_EP,
454 .bmAttributes = USB_ENDPOINT_XFER_BULK,
455 .wMaxPacketSize = 64,
460 static const USBDescDevice desc_device = {
461 .bcdUSB = 0x0110,
462 .bMaxPacketSize0 = 64,
463 .bNumConfigurations = 1,
464 .confs = (USBDescConfig[]) {
466 .bNumInterfaces = 1,
467 .bConfigurationValue = 1,
468 .bmAttributes = USB_CFG_ATT_ONE | USB_CFG_ATT_SELFPOWER |
469 USB_CFG_ATT_WAKEUP,
470 .bMaxPower = 50,
471 .nif = 1,
472 .ifs = &desc_iface0,
477 static const USBDesc desc_ccid = {
478 .id = {
479 .idVendor = CCID_VENDOR_ID,
480 .idProduct = CCID_PRODUCT_ID,
481 .bcdDevice = CCID_DEVICE_VERSION,
482 .iManufacturer = STR_MANUFACTURER,
483 .iProduct = STR_PRODUCT,
484 .iSerialNumber = STR_SERIALNUMBER,
486 .full = &desc_device,
487 .str = desc_strings,
490 static const uint8_t *ccid_card_get_atr(CCIDCardState *card, uint32_t *len)
492 CCIDCardClass *cc = CCID_CARD_GET_CLASS(card);
494 if (cc->get_atr) {
495 return cc->get_atr(card, len);
497 return NULL;
500 static void ccid_card_apdu_from_guest(CCIDCardState *card,
501 const uint8_t *apdu,
502 uint32_t len)
504 CCIDCardClass *cc = CCID_CARD_GET_CLASS(card);
506 if (cc->apdu_from_guest) {
507 cc->apdu_from_guest(card, apdu, len);
511 static void ccid_card_exitfn(CCIDCardState *card)
513 CCIDCardClass *cc = CCID_CARD_GET_CLASS(card);
515 if (cc->exitfn) {
516 cc->exitfn(card);
521 static int ccid_card_initfn(CCIDCardState *card)
523 CCIDCardClass *cc = CCID_CARD_GET_CLASS(card);
525 if (cc->initfn) {
526 return cc->initfn(card);
528 return 0;
531 static bool ccid_has_pending_answers(USBCCIDState *s)
533 return s->pending_answers_num > 0;
536 static void ccid_clear_pending_answers(USBCCIDState *s)
538 s->pending_answers_num = 0;
539 s->pending_answers_start = 0;
540 s->pending_answers_end = 0;
543 static void ccid_print_pending_answers(USBCCIDState *s)
545 Answer *answer;
546 int i, count;
548 DPRINTF(s, D_VERBOSE, "usb-ccid: pending answers:");
549 if (!ccid_has_pending_answers(s)) {
550 DPRINTF(s, D_VERBOSE, " empty\n");
551 return;
553 for (i = s->pending_answers_start, count = s->pending_answers_num ;
554 count > 0; count--, i++) {
555 answer = &s->pending_answers[i % PENDING_ANSWERS_NUM];
556 if (count == 1) {
557 DPRINTF(s, D_VERBOSE, "%d:%d\n", answer->slot, answer->seq);
558 } else {
559 DPRINTF(s, D_VERBOSE, "%d:%d,", answer->slot, answer->seq);
564 static void ccid_add_pending_answer(USBCCIDState *s, CCID_Header *hdr)
566 Answer *answer;
568 assert(s->pending_answers_num < PENDING_ANSWERS_NUM);
569 s->pending_answers_num++;
570 answer =
571 &s->pending_answers[(s->pending_answers_end++) % PENDING_ANSWERS_NUM];
572 answer->slot = hdr->bSlot;
573 answer->seq = hdr->bSeq;
574 ccid_print_pending_answers(s);
577 static void ccid_remove_pending_answer(USBCCIDState *s,
578 uint8_t *slot, uint8_t *seq)
580 Answer *answer;
582 assert(s->pending_answers_num > 0);
583 s->pending_answers_num--;
584 answer =
585 &s->pending_answers[(s->pending_answers_start++) % PENDING_ANSWERS_NUM];
586 *slot = answer->slot;
587 *seq = answer->seq;
588 ccid_print_pending_answers(s);
591 static void ccid_bulk_in_clear(USBCCIDState *s)
593 s->bulk_in_pending_start = 0;
594 s->bulk_in_pending_end = 0;
595 s->bulk_in_pending_num = 0;
598 static void ccid_bulk_in_release(USBCCIDState *s)
600 assert(s->current_bulk_in != NULL);
601 s->current_bulk_in->pos = 0;
602 s->current_bulk_in = NULL;
605 static void ccid_bulk_in_get(USBCCIDState *s)
607 if (s->current_bulk_in != NULL || s->bulk_in_pending_num == 0) {
608 return;
610 assert(s->bulk_in_pending_num > 0);
611 s->bulk_in_pending_num--;
612 s->current_bulk_in =
613 &s->bulk_in_pending[(s->bulk_in_pending_start++) % BULK_IN_PENDING_NUM];
616 static void *ccid_reserve_recv_buf(USBCCIDState *s, uint16_t len)
618 BulkIn *bulk_in;
620 DPRINTF(s, D_VERBOSE, "%s: QUEUE: reserve %d bytes\n", __func__, len);
622 /* look for an existing element */
623 if (len > BULK_IN_BUF_SIZE) {
624 DPRINTF(s, D_WARN, "usb-ccid.c: %s: len larger then max (%d>%d). "
625 "discarding message.\n",
626 __func__, len, BULK_IN_BUF_SIZE);
627 return NULL;
629 if (s->bulk_in_pending_num >= BULK_IN_PENDING_NUM) {
630 DPRINTF(s, D_WARN, "usb-ccid.c: %s: No free bulk_in buffers. "
631 "discarding message.\n", __func__);
632 return NULL;
634 bulk_in =
635 &s->bulk_in_pending[(s->bulk_in_pending_end++) % BULK_IN_PENDING_NUM];
636 s->bulk_in_pending_num++;
637 bulk_in->len = len;
638 return bulk_in->data;
641 static void ccid_reset(USBCCIDState *s)
643 ccid_bulk_in_clear(s);
644 ccid_clear_pending_answers(s);
647 static void ccid_detach(USBCCIDState *s)
649 ccid_reset(s);
652 static void ccid_handle_reset(USBDevice *dev)
654 USBCCIDState *s = USB_CCID_DEV(dev);
656 DPRINTF(s, 1, "Reset\n");
658 ccid_reset(s);
661 static const char *ccid_control_to_str(USBCCIDState *s, int request)
663 switch (request) {
664 /* generic - should be factored out if there are other debugees */
665 case DeviceOutRequest | USB_REQ_SET_ADDRESS:
666 return "(generic) set address";
667 case DeviceRequest | USB_REQ_GET_DESCRIPTOR:
668 return "(generic) get descriptor";
669 case DeviceRequest | USB_REQ_GET_CONFIGURATION:
670 return "(generic) get configuration";
671 case DeviceOutRequest | USB_REQ_SET_CONFIGURATION:
672 return "(generic) set configuration";
673 case DeviceRequest | USB_REQ_GET_STATUS:
674 return "(generic) get status";
675 case DeviceOutRequest | USB_REQ_CLEAR_FEATURE:
676 return "(generic) clear feature";
677 case DeviceOutRequest | USB_REQ_SET_FEATURE:
678 return "(generic) set_feature";
679 case InterfaceRequest | USB_REQ_GET_INTERFACE:
680 return "(generic) get interface";
681 case InterfaceOutRequest | USB_REQ_SET_INTERFACE:
682 return "(generic) set interface";
683 /* class requests */
684 case ClassInterfaceOutRequest | CCID_CONTROL_ABORT:
685 return "ABORT";
686 case ClassInterfaceRequest | CCID_CONTROL_GET_CLOCK_FREQUENCIES:
687 return "GET_CLOCK_FREQUENCIES";
688 case ClassInterfaceRequest | CCID_CONTROL_GET_DATA_RATES:
689 return "GET_DATA_RATES";
691 return "unknown";
694 static void ccid_handle_control(USBDevice *dev, USBPacket *p, int request,
695 int value, int index, int length, uint8_t *data)
697 USBCCIDState *s = USB_CCID_DEV(dev);
698 int ret;
700 DPRINTF(s, 1, "%s: got control %s (%x), value %x\n", __func__,
701 ccid_control_to_str(s, request), request, value);
702 ret = usb_desc_handle_control(dev, p, request, value, index, length, data);
703 if (ret >= 0) {
704 return;
707 switch (request) {
708 /* Class specific requests. */
709 case ClassInterfaceOutRequest | CCID_CONTROL_ABORT:
710 DPRINTF(s, 1, "ccid_control abort UNIMPLEMENTED\n");
711 p->status = USB_RET_STALL;
712 break;
713 case ClassInterfaceRequest | CCID_CONTROL_GET_CLOCK_FREQUENCIES:
714 DPRINTF(s, 1, "ccid_control get clock frequencies UNIMPLEMENTED\n");
715 p->status = USB_RET_STALL;
716 break;
717 case ClassInterfaceRequest | CCID_CONTROL_GET_DATA_RATES:
718 DPRINTF(s, 1, "ccid_control get data rates UNIMPLEMENTED\n");
719 p->status = USB_RET_STALL;
720 break;
721 default:
722 DPRINTF(s, 1, "got unsupported/bogus control %x, value %x\n",
723 request, value);
724 p->status = USB_RET_STALL;
725 break;
729 static bool ccid_card_inserted(USBCCIDState *s)
731 return s->bmSlotICCState & SLOT_0_STATE_MASK;
734 static uint8_t ccid_card_status(USBCCIDState *s)
736 return ccid_card_inserted(s)
737 ? (s->powered ?
738 ICC_STATUS_PRESENT_ACTIVE
739 : ICC_STATUS_PRESENT_INACTIVE
741 : ICC_STATUS_NOT_PRESENT;
744 static uint8_t ccid_calc_status(USBCCIDState *s)
747 * page 55, 6.2.6, calculation of bStatus from bmICCStatus and
748 * bmCommandStatus
750 uint8_t ret = ccid_card_status(s) | (s->bmCommandStatus << 6);
751 DPRINTF(s, D_VERBOSE, "%s: status = %d\n", __func__, ret);
752 return ret;
755 static void ccid_reset_error_status(USBCCIDState *s)
757 s->bError = ERROR_CMD_NOT_SUPPORTED;
758 s->bmCommandStatus = COMMAND_STATUS_NO_ERROR;
761 static void ccid_write_slot_status(USBCCIDState *s, CCID_Header *recv)
763 CCID_SlotStatus *h = ccid_reserve_recv_buf(s, sizeof(CCID_SlotStatus));
764 if (h == NULL) {
765 return;
767 h->b.hdr.bMessageType = CCID_MESSAGE_TYPE_RDR_to_PC_SlotStatus;
768 h->b.hdr.dwLength = 0;
769 h->b.hdr.bSlot = recv->bSlot;
770 h->b.hdr.bSeq = recv->bSeq;
771 h->b.bStatus = ccid_calc_status(s);
772 h->b.bError = s->bError;
773 h->bClockStatus = CLOCK_STATUS_RUNNING;
774 ccid_reset_error_status(s);
775 usb_wakeup(s->bulk, 0);
778 static void ccid_write_parameters(USBCCIDState *s, CCID_Header *recv)
780 CCID_Parameter *h;
781 uint32_t len = s->ulProtocolDataStructureSize;
783 h = ccid_reserve_recv_buf(s, sizeof(CCID_Parameter) + len);
784 if (h == NULL) {
785 return;
787 h->b.hdr.bMessageType = CCID_MESSAGE_TYPE_RDR_to_PC_Parameters;
788 h->b.hdr.dwLength = 0;
789 h->b.hdr.bSlot = recv->bSlot;
790 h->b.hdr.bSeq = recv->bSeq;
791 h->b.bStatus = ccid_calc_status(s);
792 h->b.bError = s->bError;
793 h->bProtocolNum = s->bProtocolNum;
794 h->abProtocolDataStructure = s->abProtocolDataStructure;
795 ccid_reset_error_status(s);
796 usb_wakeup(s->bulk, 0);
799 static void ccid_write_data_block(USBCCIDState *s, uint8_t slot, uint8_t seq,
800 const uint8_t *data, uint32_t len)
802 CCID_DataBlock *p = ccid_reserve_recv_buf(s, sizeof(*p) + len);
804 if (p == NULL) {
805 return;
807 p->b.hdr.bMessageType = CCID_MESSAGE_TYPE_RDR_to_PC_DataBlock;
808 p->b.hdr.dwLength = cpu_to_le32(len);
809 p->b.hdr.bSlot = slot;
810 p->b.hdr.bSeq = seq;
811 p->b.bStatus = ccid_calc_status(s);
812 p->b.bError = s->bError;
813 if (p->b.bError) {
814 DPRINTF(s, D_VERBOSE, "error %d\n", p->b.bError);
816 memcpy(p->abData, data, len);
817 ccid_reset_error_status(s);
818 usb_wakeup(s->bulk, 0);
821 static void ccid_report_error_failed(USBCCIDState *s, uint8_t error)
823 s->bmCommandStatus = COMMAND_STATUS_FAILED;
824 s->bError = error;
827 static void ccid_write_data_block_answer(USBCCIDState *s,
828 const uint8_t *data, uint32_t len)
830 uint8_t seq;
831 uint8_t slot;
833 if (!ccid_has_pending_answers(s)) {
834 DPRINTF(s, D_WARN, "error: no pending answer to return to guest\n");
835 ccid_report_error_failed(s, ERROR_ICC_MUTE);
836 return;
838 ccid_remove_pending_answer(s, &slot, &seq);
839 ccid_write_data_block(s, slot, seq, data, len);
842 static uint8_t atr_get_protocol_num(const uint8_t *atr, uint32_t len)
844 int i;
846 if (len < 2 || !(atr[1] & 0x80)) {
847 /* too short or TD1 not included */
848 return 0; /* T=0, default */
850 i = 1 + !!(atr[1] & 0x10) + !!(atr[1] & 0x20) + !!(atr[1] & 0x40);
851 i += !!(atr[1] & 0x80);
852 return atr[i] & 0x0f;
855 static void ccid_write_data_block_atr(USBCCIDState *s, CCID_Header *recv)
857 const uint8_t *atr = NULL;
858 uint32_t len = 0;
859 uint8_t atr_protocol_num;
860 CCID_T0ProtocolDataStructure *t0 = &s->abProtocolDataStructure.t0;
861 CCID_T1ProtocolDataStructure *t1 = &s->abProtocolDataStructure.t1;
863 if (s->card) {
864 atr = ccid_card_get_atr(s->card, &len);
866 atr_protocol_num = atr_get_protocol_num(atr, len);
867 DPRINTF(s, D_VERBOSE, "%s: atr contains protocol=%d\n", __func__,
868 atr_protocol_num);
869 /* set parameters from ATR - see spec page 109 */
870 s->bProtocolNum = (atr_protocol_num <= 1 ? atr_protocol_num
871 : s->bProtocolNum);
872 switch (atr_protocol_num) {
873 case 0:
874 /* TODO: unimplemented ATR T0 parameters */
875 t0->bmFindexDindex = 0;
876 t0->bmTCCKST0 = 0;
877 t0->bGuardTimeT0 = 0;
878 t0->bWaitingIntegerT0 = 0;
879 t0->bClockStop = 0;
880 break;
881 case 1:
882 /* TODO: unimplemented ATR T1 parameters */
883 t1->bmFindexDindex = 0;
884 t1->bmTCCKST1 = 0;
885 t1->bGuardTimeT1 = 0;
886 t1->bWaitingIntegerT1 = 0;
887 t1->bClockStop = 0;
888 t1->bIFSC = 0;
889 t1->bNadValue = 0;
890 break;
891 default:
892 DPRINTF(s, D_WARN, "%s: error: unsupported ATR protocol %d\n",
893 __func__, atr_protocol_num);
895 ccid_write_data_block(s, recv->bSlot, recv->bSeq, atr, len);
898 static void ccid_set_parameters(USBCCIDState *s, CCID_Header *recv)
900 CCID_SetParameters *ph = (CCID_SetParameters *) recv;
901 uint32_t protocol_num = ph->bProtocolNum & 3;
903 if (protocol_num != 0 && protocol_num != 1) {
904 ccid_report_error_failed(s, ERROR_CMD_NOT_SUPPORTED);
905 return;
907 s->bProtocolNum = protocol_num;
908 s->abProtocolDataStructure = ph->abProtocolDataStructure;
912 * must be 5 bytes for T=0, 7 bytes for T=1
913 * See page 52
915 static const CCID_ProtocolDataStructure defaultProtocolDataStructure = {
916 .t1 = {
917 .bmFindexDindex = 0x77,
918 .bmTCCKST1 = 0x00,
919 .bGuardTimeT1 = 0x00,
920 .bWaitingIntegerT1 = 0x00,
921 .bClockStop = 0x00,
922 .bIFSC = 0xfe,
923 .bNadValue = 0x00,
927 static void ccid_reset_parameters(USBCCIDState *s)
929 s->bProtocolNum = 0; /* T=0 */
930 s->abProtocolDataStructure = defaultProtocolDataStructure;
933 /* NOTE: only a single slot is supported (SLOT_0) */
934 static void ccid_on_slot_change(USBCCIDState *s, bool full)
936 /* RDR_to_PC_NotifySlotChange, 6.3.1 page 56 */
937 uint8_t current = s->bmSlotICCState;
938 if (full) {
939 s->bmSlotICCState |= SLOT_0_STATE_MASK;
940 } else {
941 s->bmSlotICCState &= ~SLOT_0_STATE_MASK;
943 if (current != s->bmSlotICCState) {
944 s->bmSlotICCState |= SLOT_0_CHANGED_MASK;
946 s->notify_slot_change = true;
947 usb_wakeup(s->intr, 0);
950 static void ccid_write_data_block_error(
951 USBCCIDState *s, uint8_t slot, uint8_t seq)
953 ccid_write_data_block(s, slot, seq, NULL, 0);
956 static void ccid_on_apdu_from_guest(USBCCIDState *s, CCID_XferBlock *recv)
958 uint32_t len;
960 if (ccid_card_status(s) != ICC_STATUS_PRESENT_ACTIVE) {
961 DPRINTF(s, 1,
962 "usb-ccid: not sending apdu to client, no card connected\n");
963 ccid_write_data_block_error(s, recv->hdr.bSlot, recv->hdr.bSeq);
964 return;
966 len = le32_to_cpu(recv->hdr.dwLength);
967 DPRINTF(s, 1, "%s: seq %d, len %d\n", __func__,
968 recv->hdr.bSeq, len);
969 ccid_add_pending_answer(s, (CCID_Header *)recv);
970 if (s->card && len <= BULK_OUT_DATA_SIZE) {
971 ccid_card_apdu_from_guest(s->card, recv->abData, len);
972 } else {
973 DPRINTF(s, D_WARN, "warning: discarded apdu\n");
977 static const char *ccid_message_type_to_str(uint8_t type)
979 switch (type) {
980 case CCID_MESSAGE_TYPE_PC_to_RDR_IccPowerOn: return "IccPowerOn";
981 case CCID_MESSAGE_TYPE_PC_to_RDR_IccPowerOff: return "IccPowerOff";
982 case CCID_MESSAGE_TYPE_PC_to_RDR_GetSlotStatus: return "GetSlotStatus";
983 case CCID_MESSAGE_TYPE_PC_to_RDR_XfrBlock: return "XfrBlock";
984 case CCID_MESSAGE_TYPE_PC_to_RDR_GetParameters: return "GetParameters";
985 case CCID_MESSAGE_TYPE_PC_to_RDR_ResetParameters: return "ResetParameters";
986 case CCID_MESSAGE_TYPE_PC_to_RDR_SetParameters: return "SetParameters";
987 case CCID_MESSAGE_TYPE_PC_to_RDR_Escape: return "Escape";
988 case CCID_MESSAGE_TYPE_PC_to_RDR_IccClock: return "IccClock";
989 case CCID_MESSAGE_TYPE_PC_to_RDR_T0APDU: return "T0APDU";
990 case CCID_MESSAGE_TYPE_PC_to_RDR_Secure: return "Secure";
991 case CCID_MESSAGE_TYPE_PC_to_RDR_Mechanical: return "Mechanical";
992 case CCID_MESSAGE_TYPE_PC_to_RDR_Abort: return "Abort";
993 case CCID_MESSAGE_TYPE_PC_to_RDR_SetDataRateAndClockFrequency:
994 return "SetDataRateAndClockFrequency";
996 return "unknown";
999 static void ccid_handle_bulk_out(USBCCIDState *s, USBPacket *p)
1001 CCID_Header *ccid_header;
1003 if (p->iov.size + s->bulk_out_pos > BULK_OUT_DATA_SIZE) {
1004 p->status = USB_RET_STALL;
1005 return;
1007 ccid_header = (CCID_Header *)s->bulk_out_data;
1008 usb_packet_copy(p, s->bulk_out_data + s->bulk_out_pos, p->iov.size);
1009 s->bulk_out_pos += p->iov.size;
1010 if (p->iov.size == CCID_MAX_PACKET_SIZE) {
1011 DPRINTF(s, D_VERBOSE,
1012 "usb-ccid: bulk_in: expecting more packets (%zd/%d)\n",
1013 p->iov.size, ccid_header->dwLength);
1014 return;
1016 if (s->bulk_out_pos < 10) {
1017 DPRINTF(s, 1,
1018 "%s: bad USB_TOKEN_OUT length, should be at least 10 bytes\n",
1019 __func__);
1020 } else {
1021 DPRINTF(s, D_MORE_INFO, "%s %x %s\n", __func__,
1022 ccid_header->bMessageType,
1023 ccid_message_type_to_str(ccid_header->bMessageType));
1024 switch (ccid_header->bMessageType) {
1025 case CCID_MESSAGE_TYPE_PC_to_RDR_GetSlotStatus:
1026 ccid_write_slot_status(s, ccid_header);
1027 break;
1028 case CCID_MESSAGE_TYPE_PC_to_RDR_IccPowerOn:
1029 DPRINTF(s, 1, "%s: PowerOn: %d\n", __func__,
1030 ((CCID_IccPowerOn *)(ccid_header))->bPowerSelect);
1031 s->powered = true;
1032 if (!ccid_card_inserted(s)) {
1033 ccid_report_error_failed(s, ERROR_ICC_MUTE);
1035 /* atr is written regardless of error. */
1036 ccid_write_data_block_atr(s, ccid_header);
1037 break;
1038 case CCID_MESSAGE_TYPE_PC_to_RDR_IccPowerOff:
1039 ccid_reset_error_status(s);
1040 s->powered = false;
1041 ccid_write_slot_status(s, ccid_header);
1042 break;
1043 case CCID_MESSAGE_TYPE_PC_to_RDR_XfrBlock:
1044 ccid_on_apdu_from_guest(s, (CCID_XferBlock *)s->bulk_out_data);
1045 break;
1046 case CCID_MESSAGE_TYPE_PC_to_RDR_SetParameters:
1047 ccid_reset_error_status(s);
1048 ccid_set_parameters(s, ccid_header);
1049 ccid_write_parameters(s, ccid_header);
1050 break;
1051 case CCID_MESSAGE_TYPE_PC_to_RDR_ResetParameters:
1052 ccid_reset_error_status(s);
1053 ccid_reset_parameters(s);
1054 ccid_write_parameters(s, ccid_header);
1055 break;
1056 case CCID_MESSAGE_TYPE_PC_to_RDR_GetParameters:
1057 ccid_reset_error_status(s);
1058 ccid_write_parameters(s, ccid_header);
1059 break;
1060 case CCID_MESSAGE_TYPE_PC_to_RDR_Mechanical:
1061 ccid_report_error_failed(s, 0);
1062 ccid_write_slot_status(s, ccid_header);
1063 break;
1064 default:
1065 DPRINTF(s, 1,
1066 "handle_data: ERROR: unhandled message type %Xh\n",
1067 ccid_header->bMessageType);
1069 * The caller is expecting the device to respond, tell it we
1070 * don't support the operation.
1072 ccid_report_error_failed(s, ERROR_CMD_NOT_SUPPORTED);
1073 ccid_write_slot_status(s, ccid_header);
1074 break;
1077 s->bulk_out_pos = 0;
1080 static void ccid_bulk_in_copy_to_guest(USBCCIDState *s, USBPacket *p)
1082 int len = 0;
1084 ccid_bulk_in_get(s);
1085 if (s->current_bulk_in != NULL) {
1086 len = MIN(s->current_bulk_in->len - s->current_bulk_in->pos,
1087 p->iov.size);
1088 usb_packet_copy(p, s->current_bulk_in->data +
1089 s->current_bulk_in->pos, len);
1090 s->current_bulk_in->pos += len;
1091 if (s->current_bulk_in->pos == s->current_bulk_in->len) {
1092 ccid_bulk_in_release(s);
1094 } else {
1095 /* return when device has no data - usb 2.0 spec Table 8-4 */
1096 p->status = USB_RET_NAK;
1098 if (len) {
1099 DPRINTF(s, D_MORE_INFO,
1100 "%s: %zd/%d req/act to guest (BULK_IN)\n",
1101 __func__, p->iov.size, len);
1103 if (len < p->iov.size) {
1104 DPRINTF(s, 1,
1105 "%s: returning short (EREMOTEIO) %d < %zd\n",
1106 __func__, len, p->iov.size);
1110 static void ccid_handle_data(USBDevice *dev, USBPacket *p)
1112 USBCCIDState *s = USB_CCID_DEV(dev);
1113 uint8_t buf[2];
1115 switch (p->pid) {
1116 case USB_TOKEN_OUT:
1117 ccid_handle_bulk_out(s, p);
1118 break;
1120 case USB_TOKEN_IN:
1121 switch (p->ep->nr) {
1122 case CCID_BULK_IN_EP:
1123 ccid_bulk_in_copy_to_guest(s, p);
1124 break;
1125 case CCID_INT_IN_EP:
1126 if (s->notify_slot_change) {
1127 /* page 56, RDR_to_PC_NotifySlotChange */
1128 buf[0] = CCID_MESSAGE_TYPE_RDR_to_PC_NotifySlotChange;
1129 buf[1] = s->bmSlotICCState;
1130 usb_packet_copy(p, buf, 2);
1131 s->notify_slot_change = false;
1132 s->bmSlotICCState &= ~SLOT_0_CHANGED_MASK;
1133 DPRINTF(s, D_INFO,
1134 "handle_data: int_in: notify_slot_change %X, "
1135 "requested len %zd\n",
1136 s->bmSlotICCState, p->iov.size);
1137 } else {
1138 p->status = USB_RET_NAK;
1140 break;
1141 default:
1142 DPRINTF(s, 1, "Bad endpoint\n");
1143 p->status = USB_RET_STALL;
1144 break;
1146 break;
1147 default:
1148 DPRINTF(s, 1, "Bad token\n");
1149 p->status = USB_RET_STALL;
1150 break;
1154 static void ccid_handle_destroy(USBDevice *dev)
1156 USBCCIDState *s = USB_CCID_DEV(dev);
1158 ccid_bulk_in_clear(s);
1161 static void ccid_flush_pending_answers(USBCCIDState *s)
1163 while (ccid_has_pending_answers(s)) {
1164 ccid_write_data_block_answer(s, NULL, 0);
1168 static Answer *ccid_peek_next_answer(USBCCIDState *s)
1170 return s->pending_answers_num == 0
1171 ? NULL
1172 : &s->pending_answers[s->pending_answers_start % PENDING_ANSWERS_NUM];
1175 static Property ccid_props[] = {
1176 DEFINE_PROP_UINT32("slot", struct CCIDCardState, slot, 0),
1177 DEFINE_PROP_END_OF_LIST(),
1180 #define TYPE_CCID_BUS "ccid-bus"
1181 #define CCID_BUS(obj) OBJECT_CHECK(CCIDBus, (obj), TYPE_CCID_BUS)
1183 static const TypeInfo ccid_bus_info = {
1184 .name = TYPE_CCID_BUS,
1185 .parent = TYPE_BUS,
1186 .instance_size = sizeof(CCIDBus),
1189 void ccid_card_send_apdu_to_guest(CCIDCardState *card,
1190 uint8_t *apdu, uint32_t len)
1192 DeviceState *qdev = DEVICE(card);
1193 USBDevice *dev = USB_DEVICE(qdev->parent_bus->parent);
1194 USBCCIDState *s = USB_CCID_DEV(dev);
1195 Answer *answer;
1197 if (!ccid_has_pending_answers(s)) {
1198 DPRINTF(s, 1, "CCID ERROR: got an APDU without pending answers\n");
1199 return;
1201 s->bmCommandStatus = COMMAND_STATUS_NO_ERROR;
1202 answer = ccid_peek_next_answer(s);
1203 if (answer == NULL) {
1204 DPRINTF(s, D_WARN, "%s: error: unexpected lack of answer\n", __func__);
1205 ccid_report_error_failed(s, ERROR_HW_ERROR);
1206 return;
1208 DPRINTF(s, 1, "APDU returned to guest %d (answer seq %d, slot %d)\n",
1209 len, answer->seq, answer->slot);
1210 ccid_write_data_block_answer(s, apdu, len);
1213 void ccid_card_card_removed(CCIDCardState *card)
1215 DeviceState *qdev = DEVICE(card);
1216 USBDevice *dev = USB_DEVICE(qdev->parent_bus->parent);
1217 USBCCIDState *s = USB_CCID_DEV(dev);
1219 ccid_on_slot_change(s, false);
1220 ccid_flush_pending_answers(s);
1221 ccid_reset(s);
1224 int ccid_card_ccid_attach(CCIDCardState *card)
1226 DeviceState *qdev = DEVICE(card);
1227 USBDevice *dev = USB_DEVICE(qdev->parent_bus->parent);
1228 USBCCIDState *s = USB_CCID_DEV(dev);
1230 DPRINTF(s, 1, "CCID Attach\n");
1231 if (s->migration_state == MIGRATION_MIGRATED) {
1232 s->migration_state = MIGRATION_NONE;
1234 return 0;
1237 void ccid_card_ccid_detach(CCIDCardState *card)
1239 DeviceState *qdev = DEVICE(card);
1240 USBDevice *dev = USB_DEVICE(qdev->parent_bus->parent);
1241 USBCCIDState *s = USB_CCID_DEV(dev);
1243 DPRINTF(s, 1, "CCID Detach\n");
1244 if (ccid_card_inserted(s)) {
1245 ccid_on_slot_change(s, false);
1247 ccid_detach(s);
1250 void ccid_card_card_error(CCIDCardState *card, uint64_t error)
1252 DeviceState *qdev = DEVICE(card);
1253 USBDevice *dev = USB_DEVICE(qdev->parent_bus->parent);
1254 USBCCIDState *s = USB_CCID_DEV(dev);
1256 s->bmCommandStatus = COMMAND_STATUS_FAILED;
1257 s->last_answer_error = error;
1258 DPRINTF(s, 1, "VSC_Error: %" PRIX64 "\n", s->last_answer_error);
1259 /* TODO: these errors should be more verbose and propagated to the guest.*/
1261 * We flush all pending answers on CardRemove message in ccid-card-passthru,
1262 * so check that first to not trigger abort
1264 if (ccid_has_pending_answers(s)) {
1265 ccid_write_data_block_answer(s, NULL, 0);
1269 void ccid_card_card_inserted(CCIDCardState *card)
1271 DeviceState *qdev = DEVICE(card);
1272 USBDevice *dev = USB_DEVICE(qdev->parent_bus->parent);
1273 USBCCIDState *s = USB_CCID_DEV(dev);
1275 s->bmCommandStatus = COMMAND_STATUS_NO_ERROR;
1276 ccid_flush_pending_answers(s);
1277 ccid_on_slot_change(s, true);
1280 static int ccid_card_exit(DeviceState *qdev)
1282 CCIDCardState *card = CCID_CARD(qdev);
1283 USBDevice *dev = USB_DEVICE(qdev->parent_bus->parent);
1284 USBCCIDState *s = USB_CCID_DEV(dev);
1286 if (ccid_card_inserted(s)) {
1287 ccid_card_card_removed(card);
1289 ccid_card_exitfn(card);
1290 s->card = NULL;
1291 return 0;
1294 static int ccid_card_init(DeviceState *qdev)
1296 CCIDCardState *card = CCID_CARD(qdev);
1297 USBDevice *dev = USB_DEVICE(qdev->parent_bus->parent);
1298 USBCCIDState *s = USB_CCID_DEV(dev);
1299 int ret = 0;
1301 if (card->slot != 0) {
1302 error_report("Warning: usb-ccid supports one slot, can't add %d",
1303 card->slot);
1304 return -1;
1306 if (s->card != NULL) {
1307 error_report("Warning: usb-ccid card already full, not adding");
1308 return -1;
1310 ret = ccid_card_initfn(card);
1311 if (ret == 0) {
1312 s->card = card;
1314 return ret;
1317 static void ccid_realize(USBDevice *dev, Error **errp)
1319 USBCCIDState *s = USB_CCID_DEV(dev);
1321 usb_desc_create_serial(dev);
1322 usb_desc_init(dev);
1323 qbus_create_inplace(&s->bus, sizeof(s->bus), TYPE_CCID_BUS, DEVICE(dev),
1324 NULL);
1325 qbus_set_hotplug_handler(BUS(&s->bus), DEVICE(dev), &error_abort);
1326 s->intr = usb_ep_get(dev, USB_TOKEN_IN, CCID_INT_IN_EP);
1327 s->bulk = usb_ep_get(dev, USB_TOKEN_IN, CCID_BULK_IN_EP);
1328 s->card = NULL;
1329 s->migration_state = MIGRATION_NONE;
1330 s->migration_target_ip = 0;
1331 s->migration_target_port = 0;
1332 s->dev.speed = USB_SPEED_FULL;
1333 s->dev.speedmask = USB_SPEED_MASK_FULL;
1334 s->notify_slot_change = false;
1335 s->powered = true;
1336 s->pending_answers_num = 0;
1337 s->last_answer_error = 0;
1338 s->bulk_in_pending_start = 0;
1339 s->bulk_in_pending_end = 0;
1340 s->current_bulk_in = NULL;
1341 ccid_reset_error_status(s);
1342 s->bulk_out_pos = 0;
1343 ccid_reset_parameters(s);
1344 ccid_reset(s);
1345 s->debug = parse_debug_env("QEMU_CCID_DEBUG", D_VERBOSE, s->debug);
1348 static int ccid_post_load(void *opaque, int version_id)
1350 USBCCIDState *s = opaque;
1353 * This must be done after usb_device_attach, which sets state to ATTACHED,
1354 * while it must be DEFAULT in order to accept packets (like it is after
1355 * reset, but reset will reset our addr and call our reset handler which
1356 * may change state, and we don't want to do that when migrating).
1358 s->dev.state = s->state_vmstate;
1359 return 0;
1362 static void ccid_pre_save(void *opaque)
1364 USBCCIDState *s = opaque;
1366 s->state_vmstate = s->dev.state;
1367 if (s->dev.attached) {
1369 * Migrating an open device, ignore reconnection CHR_EVENT to avoid an
1370 * erroneous detach.
1372 s->migration_state = MIGRATION_MIGRATED;
1376 static VMStateDescription bulk_in_vmstate = {
1377 .name = "CCID BulkIn state",
1378 .version_id = 1,
1379 .minimum_version_id = 1,
1380 .fields = (VMStateField[]) {
1381 VMSTATE_BUFFER(data, BulkIn),
1382 VMSTATE_UINT32(len, BulkIn),
1383 VMSTATE_UINT32(pos, BulkIn),
1384 VMSTATE_END_OF_LIST()
1388 static VMStateDescription answer_vmstate = {
1389 .name = "CCID Answer state",
1390 .version_id = 1,
1391 .minimum_version_id = 1,
1392 .fields = (VMStateField[]) {
1393 VMSTATE_UINT8(slot, Answer),
1394 VMSTATE_UINT8(seq, Answer),
1395 VMSTATE_END_OF_LIST()
1399 static VMStateDescription usb_device_vmstate = {
1400 .name = "usb_device",
1401 .version_id = 1,
1402 .minimum_version_id = 1,
1403 .fields = (VMStateField[]) {
1404 VMSTATE_UINT8(addr, USBDevice),
1405 VMSTATE_BUFFER(setup_buf, USBDevice),
1406 VMSTATE_BUFFER(data_buf, USBDevice),
1407 VMSTATE_END_OF_LIST()
1411 static VMStateDescription ccid_vmstate = {
1412 .name = "usb-ccid",
1413 .version_id = 1,
1414 .minimum_version_id = 1,
1415 .post_load = ccid_post_load,
1416 .pre_save = ccid_pre_save,
1417 .fields = (VMStateField[]) {
1418 VMSTATE_STRUCT(dev, USBCCIDState, 1, usb_device_vmstate, USBDevice),
1419 VMSTATE_UINT8(debug, USBCCIDState),
1420 VMSTATE_BUFFER(bulk_out_data, USBCCIDState),
1421 VMSTATE_UINT32(bulk_out_pos, USBCCIDState),
1422 VMSTATE_UINT8(bmSlotICCState, USBCCIDState),
1423 VMSTATE_UINT8(powered, USBCCIDState),
1424 VMSTATE_UINT8(notify_slot_change, USBCCIDState),
1425 VMSTATE_UINT64(last_answer_error, USBCCIDState),
1426 VMSTATE_UINT8(bError, USBCCIDState),
1427 VMSTATE_UINT8(bmCommandStatus, USBCCIDState),
1428 VMSTATE_UINT8(bProtocolNum, USBCCIDState),
1429 VMSTATE_BUFFER(abProtocolDataStructure.data, USBCCIDState),
1430 VMSTATE_UINT32(ulProtocolDataStructureSize, USBCCIDState),
1431 VMSTATE_STRUCT_ARRAY(bulk_in_pending, USBCCIDState,
1432 BULK_IN_PENDING_NUM, 1, bulk_in_vmstate, BulkIn),
1433 VMSTATE_UINT32(bulk_in_pending_start, USBCCIDState),
1434 VMSTATE_UINT32(bulk_in_pending_end, USBCCIDState),
1435 VMSTATE_STRUCT_ARRAY(pending_answers, USBCCIDState,
1436 PENDING_ANSWERS_NUM, 1, answer_vmstate, Answer),
1437 VMSTATE_UINT32(pending_answers_num, USBCCIDState),
1438 VMSTATE_UINT8(migration_state, USBCCIDState),
1439 VMSTATE_UINT32(state_vmstate, USBCCIDState),
1440 VMSTATE_END_OF_LIST()
1444 static Property ccid_properties[] = {
1445 DEFINE_PROP_UINT8("debug", USBCCIDState, debug, 0),
1446 DEFINE_PROP_END_OF_LIST(),
1449 static void ccid_class_initfn(ObjectClass *klass, void *data)
1451 DeviceClass *dc = DEVICE_CLASS(klass);
1452 USBDeviceClass *uc = USB_DEVICE_CLASS(klass);
1453 HotplugHandlerClass *hc = HOTPLUG_HANDLER_CLASS(klass);
1455 uc->realize = ccid_realize;
1456 uc->product_desc = "QEMU USB CCID";
1457 uc->usb_desc = &desc_ccid;
1458 uc->handle_reset = ccid_handle_reset;
1459 uc->handle_control = ccid_handle_control;
1460 uc->handle_data = ccid_handle_data;
1461 uc->handle_destroy = ccid_handle_destroy;
1462 dc->desc = "CCID Rev 1.1 smartcard reader";
1463 dc->vmsd = &ccid_vmstate;
1464 dc->props = ccid_properties;
1465 set_bit(DEVICE_CATEGORY_INPUT, dc->categories);
1466 hc->unplug = qdev_simple_device_unplug_cb;
1469 static const TypeInfo ccid_info = {
1470 .name = CCID_DEV_NAME,
1471 .parent = TYPE_USB_DEVICE,
1472 .instance_size = sizeof(USBCCIDState),
1473 .class_init = ccid_class_initfn,
1474 .interfaces = (InterfaceInfo[]) {
1475 { TYPE_HOTPLUG_HANDLER },
1480 static void ccid_card_class_init(ObjectClass *klass, void *data)
1482 DeviceClass *k = DEVICE_CLASS(klass);
1483 k->bus_type = TYPE_CCID_BUS;
1484 k->init = ccid_card_init;
1485 k->exit = ccid_card_exit;
1486 k->props = ccid_props;
1489 static const TypeInfo ccid_card_type_info = {
1490 .name = TYPE_CCID_CARD,
1491 .parent = TYPE_DEVICE,
1492 .instance_size = sizeof(CCIDCardState),
1493 .abstract = true,
1494 .class_size = sizeof(CCIDCardClass),
1495 .class_init = ccid_card_class_init,
1498 static void ccid_register_types(void)
1500 type_register_static(&ccid_bus_info);
1501 type_register_static(&ccid_card_type_info);
1502 type_register_static(&ccid_info);
1503 usb_legacy_register(CCID_DEV_NAME, "ccid", NULL);
1506 type_init(ccid_register_types)