stubs: Add a vmstate_dummy struct for CONFIG_USER_ONLY
[qemu/agraf.git] / hw / usb / dev-smartcard-reader.c
blobcaebc1c3fffa8e27476184bb41b564a960a141cb
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-common.h"
38 #include "qemu/error-report.h"
39 #include "hw/usb.h"
40 #include "hw/usb/desc.h"
41 #include "monitor/monitor.h"
43 #include "hw/ccid.h"
45 #define DPRINTF(s, lvl, fmt, ...) \
46 do { \
47 if (lvl <= s->debug) { \
48 printf("usb-ccid: " fmt , ## __VA_ARGS__); \
49 } \
50 } while (0)
52 #define D_WARN 1
53 #define D_INFO 2
54 #define D_MORE_INFO 3
55 #define D_VERBOSE 4
57 #define CCID_DEV_NAME "usb-ccid"
60 * The two options for variable sized buffers:
61 * make them constant size, for large enough constant,
62 * or handle the migration complexity - VMState doesn't handle this case.
63 * sizes are expected never to be exceeded, unless guest misbehaves.
65 #define BULK_OUT_DATA_SIZE 65536
66 #define PENDING_ANSWERS_NUM 128
68 #define BULK_IN_BUF_SIZE 384
69 #define BULK_IN_PENDING_NUM 8
71 #define InterfaceOutClass \
72 ((USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_INTERFACE)<<8)
74 #define InterfaceInClass \
75 ((USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE)<<8)
77 #define CCID_MAX_PACKET_SIZE 64
79 #define CCID_CONTROL_ABORT 0x1
80 #define CCID_CONTROL_GET_CLOCK_FREQUENCIES 0x2
81 #define CCID_CONTROL_GET_DATA_RATES 0x3
83 #define CCID_PRODUCT_DESCRIPTION "QEMU USB CCID"
84 #define CCID_VENDOR_DESCRIPTION "QEMU"
85 #define CCID_INTERFACE_NAME "CCID Interface"
86 #define CCID_SERIAL_NUMBER_STRING "1"
88 * Using Gemplus Vendor and Product id
89 * Effect on various drivers:
90 * usbccid.sys (winxp, others untested) is a class driver so it doesn't care.
91 * linux has a number of class drivers, but openct filters based on
92 * vendor/product (/etc/openct.conf under fedora), hence Gemplus.
94 #define CCID_VENDOR_ID 0x08e6
95 #define CCID_PRODUCT_ID 0x4433
96 #define CCID_DEVICE_VERSION 0x0000
99 * BULK_OUT messages from PC to Reader
100 * Defined in CCID Rev 1.1 6.1 (page 26)
102 #define CCID_MESSAGE_TYPE_PC_to_RDR_IccPowerOn 0x62
103 #define CCID_MESSAGE_TYPE_PC_to_RDR_IccPowerOff 0x63
104 #define CCID_MESSAGE_TYPE_PC_to_RDR_GetSlotStatus 0x65
105 #define CCID_MESSAGE_TYPE_PC_to_RDR_XfrBlock 0x6f
106 #define CCID_MESSAGE_TYPE_PC_to_RDR_GetParameters 0x6c
107 #define CCID_MESSAGE_TYPE_PC_to_RDR_ResetParameters 0x6d
108 #define CCID_MESSAGE_TYPE_PC_to_RDR_SetParameters 0x61
109 #define CCID_MESSAGE_TYPE_PC_to_RDR_Escape 0x6b
110 #define CCID_MESSAGE_TYPE_PC_to_RDR_IccClock 0x6e
111 #define CCID_MESSAGE_TYPE_PC_to_RDR_T0APDU 0x6a
112 #define CCID_MESSAGE_TYPE_PC_to_RDR_Secure 0x69
113 #define CCID_MESSAGE_TYPE_PC_to_RDR_Mechanical 0x71
114 #define CCID_MESSAGE_TYPE_PC_to_RDR_Abort 0x72
115 #define CCID_MESSAGE_TYPE_PC_to_RDR_SetDataRateAndClockFrequency 0x73
118 * BULK_IN messages from Reader to PC
119 * Defined in CCID Rev 1.1 6.2 (page 48)
121 #define CCID_MESSAGE_TYPE_RDR_to_PC_DataBlock 0x80
122 #define CCID_MESSAGE_TYPE_RDR_to_PC_SlotStatus 0x81
123 #define CCID_MESSAGE_TYPE_RDR_to_PC_Parameters 0x82
124 #define CCID_MESSAGE_TYPE_RDR_to_PC_Escape 0x83
125 #define CCID_MESSAGE_TYPE_RDR_to_PC_DataRateAndClockFrequency 0x84
128 * INTERRUPT_IN messages from Reader to PC
129 * Defined in CCID Rev 1.1 6.3 (page 56)
131 #define CCID_MESSAGE_TYPE_RDR_to_PC_NotifySlotChange 0x50
132 #define CCID_MESSAGE_TYPE_RDR_to_PC_HardwareError 0x51
135 * Endpoints for CCID - addresses are up to us to decide.
136 * To support slot insertion and removal we must have an interrupt in ep
137 * in addition we need a bulk in and bulk out ep
138 * 5.2, page 20
140 #define CCID_INT_IN_EP 1
141 #define CCID_BULK_IN_EP 2
142 #define CCID_BULK_OUT_EP 3
144 /* bmSlotICCState masks */
145 #define SLOT_0_STATE_MASK 1
146 #define SLOT_0_CHANGED_MASK 2
148 /* Status codes that go in bStatus (see 6.2.6) */
149 enum {
150 ICC_STATUS_PRESENT_ACTIVE = 0,
151 ICC_STATUS_PRESENT_INACTIVE,
152 ICC_STATUS_NOT_PRESENT
155 enum {
156 COMMAND_STATUS_NO_ERROR = 0,
157 COMMAND_STATUS_FAILED,
158 COMMAND_STATUS_TIME_EXTENSION_REQUIRED
161 /* Error codes that go in bError (see 6.2.6) */
162 enum {
163 ERROR_CMD_NOT_SUPPORTED = 0,
164 ERROR_CMD_ABORTED = -1,
165 ERROR_ICC_MUTE = -2,
166 ERROR_XFR_PARITY_ERROR = -3,
167 ERROR_XFR_OVERRUN = -4,
168 ERROR_HW_ERROR = -5,
171 /* 6.2.6 RDR_to_PC_SlotStatus definitions */
172 enum {
173 CLOCK_STATUS_RUNNING = 0,
175 * 0 - Clock Running, 1 - Clock stopped in State L, 2 - H,
176 * 3 - unknown state. rest are RFU
180 typedef struct QEMU_PACKED CCID_Header {
181 uint8_t bMessageType;
182 uint32_t dwLength;
183 uint8_t bSlot;
184 uint8_t bSeq;
185 } CCID_Header;
187 typedef struct QEMU_PACKED CCID_BULK_IN {
188 CCID_Header hdr;
189 uint8_t bStatus; /* Only used in BULK_IN */
190 uint8_t bError; /* Only used in BULK_IN */
191 } CCID_BULK_IN;
193 typedef struct QEMU_PACKED CCID_SlotStatus {
194 CCID_BULK_IN b;
195 uint8_t bClockStatus;
196 } CCID_SlotStatus;
198 typedef struct QEMU_PACKED CCID_Parameter {
199 CCID_BULK_IN b;
200 uint8_t bProtocolNum;
201 uint8_t abProtocolDataStructure[0];
202 } CCID_Parameter;
204 typedef struct QEMU_PACKED CCID_DataBlock {
205 CCID_BULK_IN b;
206 uint8_t bChainParameter;
207 uint8_t abData[0];
208 } CCID_DataBlock;
210 /* 6.1.4 PC_to_RDR_XfrBlock */
211 typedef struct QEMU_PACKED CCID_XferBlock {
212 CCID_Header hdr;
213 uint8_t bBWI; /* Block Waiting Timeout */
214 uint16_t wLevelParameter; /* XXX currently unused */
215 uint8_t abData[0];
216 } CCID_XferBlock;
218 typedef struct QEMU_PACKED CCID_IccPowerOn {
219 CCID_Header hdr;
220 uint8_t bPowerSelect;
221 uint16_t abRFU;
222 } CCID_IccPowerOn;
224 typedef struct QEMU_PACKED CCID_IccPowerOff {
225 CCID_Header hdr;
226 uint16_t abRFU;
227 } CCID_IccPowerOff;
229 typedef struct QEMU_PACKED CCID_SetParameters {
230 CCID_Header hdr;
231 uint8_t bProtocolNum;
232 uint16_t abRFU;
233 uint8_t abProtocolDataStructure[0];
234 } CCID_SetParameters;
236 typedef struct CCID_Notify_Slot_Change {
237 uint8_t bMessageType; /* CCID_MESSAGE_TYPE_RDR_to_PC_NotifySlotChange */
238 uint8_t bmSlotICCState;
239 } CCID_Notify_Slot_Change;
241 /* used for DataBlock response to XferBlock */
242 typedef struct Answer {
243 uint8_t slot;
244 uint8_t seq;
245 } Answer;
247 /* pending BULK_IN messages */
248 typedef struct BulkIn {
249 uint8_t data[BULK_IN_BUF_SIZE];
250 uint32_t len;
251 uint32_t pos;
252 } BulkIn;
254 enum {
255 MIGRATION_NONE,
256 MIGRATION_MIGRATED,
259 typedef struct CCIDBus {
260 BusState qbus;
261 } CCIDBus;
263 #define MAX_PROTOCOL_SIZE 7
266 * powered - defaults to true, changed by PowerOn/PowerOff messages
268 typedef struct USBCCIDState {
269 USBDevice dev;
270 USBEndpoint *intr;
271 CCIDBus bus;
272 CCIDCardState *card;
273 BulkIn bulk_in_pending[BULK_IN_PENDING_NUM]; /* circular */
274 uint32_t bulk_in_pending_start;
275 uint32_t bulk_in_pending_end; /* first free */
276 uint32_t bulk_in_pending_num;
277 BulkIn *current_bulk_in;
278 uint8_t bulk_out_data[BULK_OUT_DATA_SIZE];
279 uint32_t bulk_out_pos;
280 uint64_t last_answer_error;
281 Answer pending_answers[PENDING_ANSWERS_NUM];
282 uint32_t pending_answers_start;
283 uint32_t pending_answers_end;
284 uint32_t pending_answers_num;
285 uint8_t bError;
286 uint8_t bmCommandStatus;
287 uint8_t bProtocolNum;
288 uint8_t abProtocolDataStructure[MAX_PROTOCOL_SIZE];
289 uint32_t ulProtocolDataStructureSize;
290 uint32_t state_vmstate;
291 uint32_t migration_target_ip;
292 uint16_t migration_target_port;
293 uint8_t migration_state;
294 uint8_t bmSlotICCState;
295 uint8_t powered;
296 uint8_t notify_slot_change;
297 uint8_t debug;
298 } USBCCIDState;
301 * CCID Spec chapter 4: CCID uses a standard device descriptor per Chapter 9,
302 * "USB Device Framework", section 9.6.1, in the Universal Serial Bus
303 * Specification.
305 * This device implemented based on the spec and with an Athena Smart Card
306 * Reader as reference:
307 * 0dc3:1004 Athena Smartcard Solutions, Inc.
310 static const uint8_t qemu_ccid_descriptor[] = {
311 /* Smart Card Device Class Descriptor */
312 0x36, /* u8 bLength; */
313 0x21, /* u8 bDescriptorType; Functional */
314 0x10, 0x01, /* u16 bcdCCID; CCID Specification Release Number. */
315 0x00, /*
316 * u8 bMaxSlotIndex; The index of the highest available
317 * slot on this device. All slots are consecutive starting
318 * at 00h.
320 0x07, /* u8 bVoltageSupport; 01h - 5.0v, 02h - 3.0, 03 - 1.8 */
322 0x03, 0x00, /* u32 dwProtocols; RRRR PPPP. RRRR = 0000h.*/
323 0x00, 0x00, /* PPPP: 0001h = Protocol T=0, 0002h = Protocol T=1 */
324 /* u32 dwDefaultClock; in kHZ (0x0fa0 is 4 MHz) */
325 0xa0, 0x0f, 0x00, 0x00,
326 /* u32 dwMaximumClock; */
327 0x00, 0x00, 0x01, 0x00,
328 0x00, /* u8 bNumClockSupported; *
329 * 0 means just the default and max. */
330 /* u32 dwDataRate ;bps. 9600 == 00002580h */
331 0x80, 0x25, 0x00, 0x00,
332 /* u32 dwMaxDataRate ; 11520 bps == 0001C200h */
333 0x00, 0xC2, 0x01, 0x00,
334 0x00, /* u8 bNumDataRatesSupported; 00 means all rates between
335 * default and max */
336 /* u32 dwMaxIFSD; *
337 * maximum IFSD supported by CCID for protocol *
338 * T=1 (Maximum seen from various cards) */
339 0xfe, 0x00, 0x00, 0x00,
340 /* u32 dwSyncProtocols; 1 - 2-wire, 2 - 3-wire, 4 - I2C */
341 0x00, 0x00, 0x00, 0x00,
342 /* u32 dwMechanical; 0 - no special characteristics. */
343 0x00, 0x00, 0x00, 0x00,
345 * u32 dwFeatures;
346 * 0 - No special characteristics
347 * + 2 Automatic parameter configuration based on ATR data
348 * + 4 Automatic activation of ICC on inserting
349 * + 8 Automatic ICC voltage selection
350 * + 10 Automatic ICC clock frequency change
351 * + 20 Automatic baud rate change
352 * + 40 Automatic parameters negotiation made by the CCID
353 * + 80 automatic PPS made by the CCID
354 * 100 CCID can set ICC in clock stop mode
355 * 200 NAD value other then 00 accepted (T=1 protocol)
356 * + 400 Automatic IFSD exchange as first exchange (T=1)
357 * One of the following only:
358 * + 10000 TPDU level exchanges with CCID
359 * 20000 Short APDU level exchange with CCID
360 * 40000 Short and Extended APDU level exchange with CCID
362 * + 100000 USB Wake up signaling supported on card
363 * insertion and removal. Must set bit 5 in bmAttributes
364 * in Configuration descriptor if 100000 is set.
366 0xfe, 0x04, 0x11, 0x00,
368 * u32 dwMaxCCIDMessageLength; For extended APDU in
369 * [261 + 10 , 65544 + 10]. Otherwise the minimum is
370 * wMaxPacketSize of the Bulk-OUT endpoint
372 0x12, 0x00, 0x01, 0x00,
373 0xFF, /*
374 * u8 bClassGetResponse; Significant only for CCID that
375 * offers an APDU level for exchanges. Indicates the
376 * default class value used by the CCID when it sends a
377 * Get Response command to perform the transportation of
378 * an APDU by T=0 protocol
379 * FFh indicates that the CCID echos the class of the APDU.
381 0xFF, /*
382 * u8 bClassEnvelope; EAPDU only. Envelope command for
383 * T=0
385 0x00, 0x00, /*
386 * u16 wLcdLayout; XXYY Number of lines (XX) and chars per
387 * line for LCD display used for PIN entry. 0000 - no LCD
389 0x01, /*
390 * u8 bPINSupport; 01h PIN Verification,
391 * 02h PIN Modification
393 0x01, /* u8 bMaxCCIDBusySlots; */
396 enum {
397 STR_MANUFACTURER = 1,
398 STR_PRODUCT,
399 STR_SERIALNUMBER,
400 STR_INTERFACE,
403 static const USBDescStrings desc_strings = {
404 [STR_MANUFACTURER] = "QEMU",
405 [STR_PRODUCT] = "QEMU USB CCID",
406 [STR_SERIALNUMBER] = "1",
407 [STR_INTERFACE] = "CCID Interface",
410 static const USBDescIface desc_iface0 = {
411 .bInterfaceNumber = 0,
412 .bNumEndpoints = 3,
413 .bInterfaceClass = 0x0b,
414 .bInterfaceSubClass = 0x00,
415 .bInterfaceProtocol = 0x00,
416 .iInterface = STR_INTERFACE,
417 .ndesc = 1,
418 .descs = (USBDescOther[]) {
420 /* smartcard descriptor */
421 .data = qemu_ccid_descriptor,
424 .eps = (USBDescEndpoint[]) {
426 .bEndpointAddress = USB_DIR_IN | CCID_INT_IN_EP,
427 .bmAttributes = USB_ENDPOINT_XFER_INT,
428 .bInterval = 255,
429 .wMaxPacketSize = 64,
431 .bEndpointAddress = USB_DIR_IN | CCID_BULK_IN_EP,
432 .bmAttributes = USB_ENDPOINT_XFER_BULK,
433 .wMaxPacketSize = 64,
435 .bEndpointAddress = USB_DIR_OUT | CCID_BULK_OUT_EP,
436 .bmAttributes = USB_ENDPOINT_XFER_BULK,
437 .wMaxPacketSize = 64,
442 static const USBDescDevice desc_device = {
443 .bcdUSB = 0x0110,
444 .bMaxPacketSize0 = 64,
445 .bNumConfigurations = 1,
446 .confs = (USBDescConfig[]) {
448 .bNumInterfaces = 1,
449 .bConfigurationValue = 1,
450 .bmAttributes = 0xe0,
451 .bMaxPower = 50,
452 .nif = 1,
453 .ifs = &desc_iface0,
458 static const USBDesc desc_ccid = {
459 .id = {
460 .idVendor = CCID_VENDOR_ID,
461 .idProduct = CCID_PRODUCT_ID,
462 .bcdDevice = CCID_DEVICE_VERSION,
463 .iManufacturer = STR_MANUFACTURER,
464 .iProduct = STR_PRODUCT,
465 .iSerialNumber = STR_SERIALNUMBER,
467 .full = &desc_device,
468 .str = desc_strings,
471 static const uint8_t *ccid_card_get_atr(CCIDCardState *card, uint32_t *len)
473 CCIDCardClass *cc = CCID_CARD_GET_CLASS(card);
474 if (cc->get_atr) {
475 return cc->get_atr(card, len);
477 return NULL;
480 static void ccid_card_apdu_from_guest(CCIDCardState *card,
481 const uint8_t *apdu,
482 uint32_t len)
484 CCIDCardClass *cc = CCID_CARD_GET_CLASS(card);
485 if (cc->apdu_from_guest) {
486 cc->apdu_from_guest(card, apdu, len);
490 static int ccid_card_exitfn(CCIDCardState *card)
492 CCIDCardClass *cc = CCID_CARD_GET_CLASS(card);
493 if (cc->exitfn) {
494 return cc->exitfn(card);
496 return 0;
499 static int ccid_card_initfn(CCIDCardState *card)
501 CCIDCardClass *cc = CCID_CARD_GET_CLASS(card);
502 if (cc->initfn) {
503 return cc->initfn(card);
505 return 0;
508 static bool ccid_has_pending_answers(USBCCIDState *s)
510 return s->pending_answers_num > 0;
513 static void ccid_clear_pending_answers(USBCCIDState *s)
515 s->pending_answers_num = 0;
516 s->pending_answers_start = 0;
517 s->pending_answers_end = 0;
520 static void ccid_print_pending_answers(USBCCIDState *s)
522 Answer *answer;
523 int i, count;
525 DPRINTF(s, D_VERBOSE, "usb-ccid: pending answers:");
526 if (!ccid_has_pending_answers(s)) {
527 DPRINTF(s, D_VERBOSE, " empty\n");
528 return;
530 for (i = s->pending_answers_start, count = s->pending_answers_num ;
531 count > 0; count--, i++) {
532 answer = &s->pending_answers[i % PENDING_ANSWERS_NUM];
533 if (count == 1) {
534 DPRINTF(s, D_VERBOSE, "%d:%d\n", answer->slot, answer->seq);
535 } else {
536 DPRINTF(s, D_VERBOSE, "%d:%d,", answer->slot, answer->seq);
541 static void ccid_add_pending_answer(USBCCIDState *s, CCID_Header *hdr)
543 Answer *answer;
545 assert(s->pending_answers_num < PENDING_ANSWERS_NUM);
546 s->pending_answers_num++;
547 answer =
548 &s->pending_answers[(s->pending_answers_end++) % PENDING_ANSWERS_NUM];
549 answer->slot = hdr->bSlot;
550 answer->seq = hdr->bSeq;
551 ccid_print_pending_answers(s);
554 static void ccid_remove_pending_answer(USBCCIDState *s,
555 uint8_t *slot, uint8_t *seq)
557 Answer *answer;
559 assert(s->pending_answers_num > 0);
560 s->pending_answers_num--;
561 answer =
562 &s->pending_answers[(s->pending_answers_start++) % PENDING_ANSWERS_NUM];
563 *slot = answer->slot;
564 *seq = answer->seq;
565 ccid_print_pending_answers(s);
568 static void ccid_bulk_in_clear(USBCCIDState *s)
570 s->bulk_in_pending_start = 0;
571 s->bulk_in_pending_end = 0;
572 s->bulk_in_pending_num = 0;
575 static void ccid_bulk_in_release(USBCCIDState *s)
577 assert(s->current_bulk_in != NULL);
578 s->current_bulk_in->pos = 0;
579 s->current_bulk_in = NULL;
582 static void ccid_bulk_in_get(USBCCIDState *s)
584 if (s->current_bulk_in != NULL || s->bulk_in_pending_num == 0) {
585 return;
587 assert(s->bulk_in_pending_num > 0);
588 s->bulk_in_pending_num--;
589 s->current_bulk_in =
590 &s->bulk_in_pending[(s->bulk_in_pending_start++) % BULK_IN_PENDING_NUM];
593 static void *ccid_reserve_recv_buf(USBCCIDState *s, uint16_t len)
595 BulkIn *bulk_in;
597 DPRINTF(s, D_VERBOSE, "%s: QUEUE: reserve %d bytes\n", __func__, len);
599 /* look for an existing element */
600 if (len > BULK_IN_BUF_SIZE) {
601 DPRINTF(s, D_WARN, "usb-ccid.c: %s: len larger then max (%d>%d). "
602 "discarding message.\n",
603 __func__, len, BULK_IN_BUF_SIZE);
604 return NULL;
606 if (s->bulk_in_pending_num >= BULK_IN_PENDING_NUM) {
607 DPRINTF(s, D_WARN, "usb-ccid.c: %s: No free bulk_in buffers. "
608 "discarding message.\n", __func__);
609 return NULL;
611 bulk_in =
612 &s->bulk_in_pending[(s->bulk_in_pending_end++) % BULK_IN_PENDING_NUM];
613 s->bulk_in_pending_num++;
614 bulk_in->len = len;
615 return bulk_in->data;
618 static void ccid_reset(USBCCIDState *s)
620 ccid_bulk_in_clear(s);
621 ccid_clear_pending_answers(s);
624 static void ccid_detach(USBCCIDState *s)
626 ccid_reset(s);
629 static void ccid_handle_reset(USBDevice *dev)
631 USBCCIDState *s = DO_UPCAST(USBCCIDState, dev, dev);
633 DPRINTF(s, 1, "Reset\n");
635 ccid_reset(s);
638 static void ccid_handle_control(USBDevice *dev, USBPacket *p, int request,
639 int value, int index, int length, uint8_t *data)
641 USBCCIDState *s = DO_UPCAST(USBCCIDState, dev, dev);
642 int ret;
644 DPRINTF(s, 1, "got control %x, value %x\n", request, value);
645 ret = usb_desc_handle_control(dev, p, request, value, index, length, data);
646 if (ret >= 0) {
647 return;
650 switch (request) {
651 /* Class specific requests. */
652 case InterfaceOutClass | CCID_CONTROL_ABORT:
653 DPRINTF(s, 1, "ccid_control abort UNIMPLEMENTED\n");
654 p->status = USB_RET_STALL;
655 break;
656 case InterfaceInClass | CCID_CONTROL_GET_CLOCK_FREQUENCIES:
657 DPRINTF(s, 1, "ccid_control get clock frequencies UNIMPLEMENTED\n");
658 p->status = USB_RET_STALL;
659 break;
660 case InterfaceInClass | CCID_CONTROL_GET_DATA_RATES:
661 DPRINTF(s, 1, "ccid_control get data rates UNIMPLEMENTED\n");
662 p->status = USB_RET_STALL;
663 break;
664 default:
665 DPRINTF(s, 1, "got unsupported/bogus control %x, value %x\n",
666 request, value);
667 p->status = USB_RET_STALL;
668 break;
672 static bool ccid_card_inserted(USBCCIDState *s)
674 return s->bmSlotICCState & SLOT_0_STATE_MASK;
677 static uint8_t ccid_card_status(USBCCIDState *s)
679 return ccid_card_inserted(s)
680 ? (s->powered ?
681 ICC_STATUS_PRESENT_ACTIVE
682 : ICC_STATUS_PRESENT_INACTIVE
684 : ICC_STATUS_NOT_PRESENT;
687 static uint8_t ccid_calc_status(USBCCIDState *s)
690 * page 55, 6.2.6, calculation of bStatus from bmICCStatus and
691 * bmCommandStatus
693 uint8_t ret = ccid_card_status(s) | (s->bmCommandStatus << 6);
694 DPRINTF(s, D_VERBOSE, "status = %d\n", ret);
695 return ret;
698 static void ccid_reset_error_status(USBCCIDState *s)
700 s->bError = ERROR_CMD_NOT_SUPPORTED;
701 s->bmCommandStatus = COMMAND_STATUS_NO_ERROR;
704 static void ccid_write_slot_status(USBCCIDState *s, CCID_Header *recv)
706 CCID_SlotStatus *h = ccid_reserve_recv_buf(s, sizeof(CCID_SlotStatus));
707 if (h == NULL) {
708 return;
710 h->b.hdr.bMessageType = CCID_MESSAGE_TYPE_RDR_to_PC_SlotStatus;
711 h->b.hdr.dwLength = 0;
712 h->b.hdr.bSlot = recv->bSlot;
713 h->b.hdr.bSeq = recv->bSeq;
714 h->b.bStatus = ccid_calc_status(s);
715 h->b.bError = s->bError;
716 h->bClockStatus = CLOCK_STATUS_RUNNING;
717 ccid_reset_error_status(s);
720 static void ccid_write_parameters(USBCCIDState *s, CCID_Header *recv)
722 CCID_Parameter *h;
723 uint32_t len = s->ulProtocolDataStructureSize;
725 h = ccid_reserve_recv_buf(s, sizeof(CCID_Parameter) + len);
726 if (h == NULL) {
727 return;
729 h->b.hdr.bMessageType = CCID_MESSAGE_TYPE_RDR_to_PC_Parameters;
730 h->b.hdr.dwLength = 0;
731 h->b.hdr.bSlot = recv->bSlot;
732 h->b.hdr.bSeq = recv->bSeq;
733 h->b.bStatus = ccid_calc_status(s);
734 h->b.bError = s->bError;
735 h->bProtocolNum = s->bProtocolNum;
736 memcpy(h->abProtocolDataStructure, s->abProtocolDataStructure, len);
737 ccid_reset_error_status(s);
740 static void ccid_write_data_block(USBCCIDState *s, uint8_t slot, uint8_t seq,
741 const uint8_t *data, uint32_t len)
743 CCID_DataBlock *p = ccid_reserve_recv_buf(s, sizeof(*p) + len);
745 if (p == NULL) {
746 return;
748 p->b.hdr.bMessageType = CCID_MESSAGE_TYPE_RDR_to_PC_DataBlock;
749 p->b.hdr.dwLength = cpu_to_le32(len);
750 p->b.hdr.bSlot = slot;
751 p->b.hdr.bSeq = seq;
752 p->b.bStatus = ccid_calc_status(s);
753 p->b.bError = s->bError;
754 if (p->b.bError) {
755 DPRINTF(s, D_VERBOSE, "error %d", p->b.bError);
757 memcpy(p->abData, data, len);
758 ccid_reset_error_status(s);
761 static void ccid_write_data_block_answer(USBCCIDState *s,
762 const uint8_t *data, uint32_t len)
764 uint8_t seq;
765 uint8_t slot;
767 if (!ccid_has_pending_answers(s)) {
768 abort();
770 ccid_remove_pending_answer(s, &slot, &seq);
771 ccid_write_data_block(s, slot, seq, data, len);
774 static void ccid_write_data_block_atr(USBCCIDState *s, CCID_Header *recv)
776 const uint8_t *atr = NULL;
777 uint32_t len = 0;
779 if (s->card) {
780 atr = ccid_card_get_atr(s->card, &len);
782 ccid_write_data_block(s, recv->bSlot, recv->bSeq, atr, len);
785 static void ccid_set_parameters(USBCCIDState *s, CCID_Header *recv)
787 CCID_SetParameters *ph = (CCID_SetParameters *) recv;
788 uint32_t len = 0;
789 if ((ph->bProtocolNum & 3) == 0) {
790 len = 5;
792 if ((ph->bProtocolNum & 3) == 1) {
793 len = 7;
795 if (len == 0) {
796 s->bmCommandStatus = COMMAND_STATUS_FAILED;
797 s->bError = 7; /* Protocol invalid or not supported */
798 return;
800 s->bProtocolNum = ph->bProtocolNum;
801 memcpy(s->abProtocolDataStructure, ph->abProtocolDataStructure, len);
802 s->ulProtocolDataStructureSize = len;
803 DPRINTF(s, 1, "%s: using len %d\n", __func__, len);
807 * must be 5 bytes for T=0, 7 bytes for T=1
808 * See page 52
810 static const uint8_t abDefaultProtocolDataStructure[7] = {
811 0x77, 0x00, 0x00, 0x00, 0x00, 0xfe /*IFSC*/, 0x00 /*NAD*/ };
813 static void ccid_reset_parameters(USBCCIDState *s)
815 uint32_t len = sizeof(abDefaultProtocolDataStructure);
817 s->bProtocolNum = 1; /* T=1 */
818 s->ulProtocolDataStructureSize = len;
819 memcpy(s->abProtocolDataStructure, abDefaultProtocolDataStructure, len);
822 static void ccid_report_error_failed(USBCCIDState *s, uint8_t error)
824 s->bmCommandStatus = COMMAND_STATUS_FAILED;
825 s->bError = error;
828 /* NOTE: only a single slot is supported (SLOT_0) */
829 static void ccid_on_slot_change(USBCCIDState *s, bool full)
831 /* RDR_to_PC_NotifySlotChange, 6.3.1 page 56 */
832 uint8_t current = s->bmSlotICCState;
833 if (full) {
834 s->bmSlotICCState |= SLOT_0_STATE_MASK;
835 } else {
836 s->bmSlotICCState &= ~SLOT_0_STATE_MASK;
838 if (current != s->bmSlotICCState) {
839 s->bmSlotICCState |= SLOT_0_CHANGED_MASK;
841 s->notify_slot_change = true;
842 usb_wakeup(s->intr, 0);
845 static void ccid_write_data_block_error(
846 USBCCIDState *s, uint8_t slot, uint8_t seq)
848 ccid_write_data_block(s, slot, seq, NULL, 0);
851 static void ccid_on_apdu_from_guest(USBCCIDState *s, CCID_XferBlock *recv)
853 uint32_t len;
855 if (ccid_card_status(s) != ICC_STATUS_PRESENT_ACTIVE) {
856 DPRINTF(s, 1,
857 "usb-ccid: not sending apdu to client, no card connected\n");
858 ccid_write_data_block_error(s, recv->hdr.bSlot, recv->hdr.bSeq);
859 return;
861 len = le32_to_cpu(recv->hdr.dwLength);
862 DPRINTF(s, 1, "%s: seq %d, len %d\n", __func__,
863 recv->hdr.bSeq, len);
864 ccid_add_pending_answer(s, (CCID_Header *)recv);
865 if (s->card) {
866 ccid_card_apdu_from_guest(s->card, recv->abData, len);
867 } else {
868 DPRINTF(s, D_WARN, "warning: discarded apdu\n");
872 static void ccid_handle_bulk_out(USBCCIDState *s, USBPacket *p)
874 CCID_Header *ccid_header;
876 if (p->iov.size + s->bulk_out_pos > BULK_OUT_DATA_SIZE) {
877 p->status = USB_RET_STALL;
878 return;
880 ccid_header = (CCID_Header *)s->bulk_out_data;
881 usb_packet_copy(p, s->bulk_out_data + s->bulk_out_pos, p->iov.size);
882 s->bulk_out_pos += p->iov.size;
883 if (p->iov.size == CCID_MAX_PACKET_SIZE) {
884 DPRINTF(s, D_VERBOSE,
885 "usb-ccid: bulk_in: expecting more packets (%zd/%d)\n",
886 p->iov.size, ccid_header->dwLength);
887 return;
889 if (s->bulk_out_pos < 10) {
890 DPRINTF(s, 1,
891 "%s: bad USB_TOKEN_OUT length, should be at least 10 bytes\n",
892 __func__);
893 } else {
894 DPRINTF(s, D_MORE_INFO, "%s %x\n", __func__, ccid_header->bMessageType);
895 switch (ccid_header->bMessageType) {
896 case CCID_MESSAGE_TYPE_PC_to_RDR_GetSlotStatus:
897 ccid_write_slot_status(s, ccid_header);
898 break;
899 case CCID_MESSAGE_TYPE_PC_to_RDR_IccPowerOn:
900 DPRINTF(s, 1, "PowerOn: %d\n",
901 ((CCID_IccPowerOn *)(ccid_header))->bPowerSelect);
902 s->powered = true;
903 if (!ccid_card_inserted(s)) {
904 ccid_report_error_failed(s, ERROR_ICC_MUTE);
906 /* atr is written regardless of error. */
907 ccid_write_data_block_atr(s, ccid_header);
908 break;
909 case CCID_MESSAGE_TYPE_PC_to_RDR_IccPowerOff:
910 DPRINTF(s, 1, "PowerOff\n");
911 ccid_reset_error_status(s);
912 s->powered = false;
913 ccid_write_slot_status(s, ccid_header);
914 break;
915 case CCID_MESSAGE_TYPE_PC_to_RDR_XfrBlock:
916 ccid_on_apdu_from_guest(s, (CCID_XferBlock *)s->bulk_out_data);
917 break;
918 case CCID_MESSAGE_TYPE_PC_to_RDR_SetParameters:
919 ccid_reset_error_status(s);
920 ccid_set_parameters(s, ccid_header);
921 ccid_write_parameters(s, ccid_header);
922 break;
923 case CCID_MESSAGE_TYPE_PC_to_RDR_ResetParameters:
924 ccid_reset_error_status(s);
925 ccid_reset_parameters(s);
926 ccid_write_parameters(s, ccid_header);
927 break;
928 case CCID_MESSAGE_TYPE_PC_to_RDR_GetParameters:
929 ccid_reset_error_status(s);
930 ccid_write_parameters(s, ccid_header);
931 break;
932 default:
933 DPRINTF(s, 1,
934 "handle_data: ERROR: unhandled message type %Xh\n",
935 ccid_header->bMessageType);
937 * The caller is expecting the device to respond, tell it we
938 * don't support the operation.
940 ccid_report_error_failed(s, ERROR_CMD_NOT_SUPPORTED);
941 ccid_write_slot_status(s, ccid_header);
942 break;
945 s->bulk_out_pos = 0;
948 static void ccid_bulk_in_copy_to_guest(USBCCIDState *s, USBPacket *p)
950 int len = 0;
952 ccid_bulk_in_get(s);
953 if (s->current_bulk_in != NULL) {
954 len = MIN(s->current_bulk_in->len - s->current_bulk_in->pos,
955 p->iov.size);
956 usb_packet_copy(p, s->current_bulk_in->data +
957 s->current_bulk_in->pos, len);
958 s->current_bulk_in->pos += len;
959 if (s->current_bulk_in->pos == s->current_bulk_in->len) {
960 ccid_bulk_in_release(s);
962 } else {
963 /* return when device has no data - usb 2.0 spec Table 8-4 */
964 p->status = USB_RET_NAK;
966 if (len) {
967 DPRINTF(s, D_MORE_INFO,
968 "%s: %zd/%d req/act to guest (BULK_IN)\n",
969 __func__, p->iov.size, len);
971 if (len < p->iov.size) {
972 DPRINTF(s, 1,
973 "%s: returning short (EREMOTEIO) %d < %zd\n",
974 __func__, len, p->iov.size);
978 static void ccid_handle_data(USBDevice *dev, USBPacket *p)
980 USBCCIDState *s = DO_UPCAST(USBCCIDState, dev, dev);
981 uint8_t buf[2];
983 switch (p->pid) {
984 case USB_TOKEN_OUT:
985 ccid_handle_bulk_out(s, p);
986 break;
988 case USB_TOKEN_IN:
989 switch (p->ep->nr) {
990 case CCID_BULK_IN_EP:
991 ccid_bulk_in_copy_to_guest(s, p);
992 break;
993 case CCID_INT_IN_EP:
994 if (s->notify_slot_change) {
995 /* page 56, RDR_to_PC_NotifySlotChange */
996 buf[0] = CCID_MESSAGE_TYPE_RDR_to_PC_NotifySlotChange;
997 buf[1] = s->bmSlotICCState;
998 usb_packet_copy(p, buf, 2);
999 s->notify_slot_change = false;
1000 s->bmSlotICCState &= ~SLOT_0_CHANGED_MASK;
1001 DPRINTF(s, D_INFO,
1002 "handle_data: int_in: notify_slot_change %X, "
1003 "requested len %zd\n",
1004 s->bmSlotICCState, p->iov.size);
1005 } else {
1006 p->status = USB_RET_NAK;
1008 break;
1009 default:
1010 DPRINTF(s, 1, "Bad endpoint\n");
1011 p->status = USB_RET_STALL;
1012 break;
1014 break;
1015 default:
1016 DPRINTF(s, 1, "Bad token\n");
1017 p->status = USB_RET_STALL;
1018 break;
1022 static void ccid_handle_destroy(USBDevice *dev)
1024 USBCCIDState *s = DO_UPCAST(USBCCIDState, dev, dev);
1026 ccid_bulk_in_clear(s);
1029 static void ccid_flush_pending_answers(USBCCIDState *s)
1031 while (ccid_has_pending_answers(s)) {
1032 ccid_write_data_block_answer(s, NULL, 0);
1036 static Answer *ccid_peek_next_answer(USBCCIDState *s)
1038 return s->pending_answers_num == 0
1039 ? NULL
1040 : &s->pending_answers[s->pending_answers_start % PENDING_ANSWERS_NUM];
1043 static Property ccid_props[] = {
1044 DEFINE_PROP_UINT32("slot", struct CCIDCardState, slot, 0),
1045 DEFINE_PROP_END_OF_LIST(),
1048 #define TYPE_CCID_BUS "ccid-bus"
1049 #define CCID_BUS(obj) OBJECT_CHECK(CCIDBus, (obj), TYPE_CCID_BUS)
1051 static const TypeInfo ccid_bus_info = {
1052 .name = TYPE_CCID_BUS,
1053 .parent = TYPE_BUS,
1054 .instance_size = sizeof(CCIDBus),
1057 void ccid_card_send_apdu_to_guest(CCIDCardState *card,
1058 uint8_t *apdu, uint32_t len)
1060 USBCCIDState *s = DO_UPCAST(USBCCIDState, dev.qdev,
1061 card->qdev.parent_bus->parent);
1062 Answer *answer;
1064 if (!ccid_has_pending_answers(s)) {
1065 DPRINTF(s, 1, "CCID ERROR: got an APDU without pending answers\n");
1066 return;
1068 s->bmCommandStatus = COMMAND_STATUS_NO_ERROR;
1069 answer = ccid_peek_next_answer(s);
1070 if (answer == NULL) {
1071 abort();
1073 DPRINTF(s, 1, "APDU returned to guest %d (answer seq %d, slot %d)\n",
1074 len, answer->seq, answer->slot);
1075 ccid_write_data_block_answer(s, apdu, len);
1078 void ccid_card_card_removed(CCIDCardState *card)
1080 USBCCIDState *s =
1081 DO_UPCAST(USBCCIDState, dev.qdev, card->qdev.parent_bus->parent);
1083 ccid_on_slot_change(s, false);
1084 ccid_flush_pending_answers(s);
1085 ccid_reset(s);
1088 int ccid_card_ccid_attach(CCIDCardState *card)
1090 USBCCIDState *s =
1091 DO_UPCAST(USBCCIDState, dev.qdev, card->qdev.parent_bus->parent);
1093 DPRINTF(s, 1, "CCID Attach\n");
1094 if (s->migration_state == MIGRATION_MIGRATED) {
1095 s->migration_state = MIGRATION_NONE;
1097 return 0;
1100 void ccid_card_ccid_detach(CCIDCardState *card)
1102 USBCCIDState *s =
1103 DO_UPCAST(USBCCIDState, dev.qdev, card->qdev.parent_bus->parent);
1105 DPRINTF(s, 1, "CCID Detach\n");
1106 if (ccid_card_inserted(s)) {
1107 ccid_on_slot_change(s, false);
1109 ccid_detach(s);
1112 void ccid_card_card_error(CCIDCardState *card, uint64_t error)
1114 USBCCIDState *s =
1115 DO_UPCAST(USBCCIDState, dev.qdev, card->qdev.parent_bus->parent);
1117 s->bmCommandStatus = COMMAND_STATUS_FAILED;
1118 s->last_answer_error = error;
1119 DPRINTF(s, 1, "VSC_Error: %" PRIX64 "\n", s->last_answer_error);
1120 /* TODO: these errors should be more verbose and propagated to the guest.*/
1122 * We flush all pending answers on CardRemove message in ccid-card-passthru,
1123 * so check that first to not trigger abort
1125 if (ccid_has_pending_answers(s)) {
1126 ccid_write_data_block_answer(s, NULL, 0);
1130 void ccid_card_card_inserted(CCIDCardState *card)
1132 USBCCIDState *s =
1133 DO_UPCAST(USBCCIDState, dev.qdev, card->qdev.parent_bus->parent);
1135 s->bmCommandStatus = COMMAND_STATUS_NO_ERROR;
1136 ccid_flush_pending_answers(s);
1137 ccid_on_slot_change(s, true);
1140 static int ccid_card_exit(DeviceState *qdev)
1142 int ret = 0;
1143 CCIDCardState *card = CCID_CARD(qdev);
1144 USBCCIDState *s =
1145 DO_UPCAST(USBCCIDState, dev.qdev, card->qdev.parent_bus->parent);
1147 if (ccid_card_inserted(s)) {
1148 ccid_card_card_removed(card);
1150 ret = ccid_card_exitfn(card);
1151 s->card = NULL;
1152 return ret;
1155 static int ccid_card_init(DeviceState *qdev)
1157 CCIDCardState *card = CCID_CARD(qdev);
1158 USBCCIDState *s =
1159 DO_UPCAST(USBCCIDState, dev.qdev, card->qdev.parent_bus->parent);
1160 int ret = 0;
1162 if (card->slot != 0) {
1163 error_report("Warning: usb-ccid supports one slot, can't add %d",
1164 card->slot);
1165 return -1;
1167 if (s->card != NULL) {
1168 error_report("Warning: usb-ccid card already full, not adding");
1169 return -1;
1171 ret = ccid_card_initfn(card);
1172 if (ret == 0) {
1173 s->card = card;
1175 return ret;
1178 static int ccid_initfn(USBDevice *dev)
1180 USBCCIDState *s = DO_UPCAST(USBCCIDState, dev, dev);
1182 usb_desc_create_serial(dev);
1183 usb_desc_init(dev);
1184 qbus_create_inplace(&s->bus.qbus, TYPE_CCID_BUS, &dev->qdev, NULL);
1185 s->intr = usb_ep_get(dev, USB_TOKEN_IN, CCID_INT_IN_EP);
1186 s->bus.qbus.allow_hotplug = 1;
1187 s->card = NULL;
1188 s->migration_state = MIGRATION_NONE;
1189 s->migration_target_ip = 0;
1190 s->migration_target_port = 0;
1191 s->dev.speed = USB_SPEED_FULL;
1192 s->dev.speedmask = USB_SPEED_MASK_FULL;
1193 s->notify_slot_change = false;
1194 s->powered = true;
1195 s->pending_answers_num = 0;
1196 s->last_answer_error = 0;
1197 s->bulk_in_pending_start = 0;
1198 s->bulk_in_pending_end = 0;
1199 s->current_bulk_in = NULL;
1200 ccid_reset_error_status(s);
1201 s->bulk_out_pos = 0;
1202 ccid_reset_parameters(s);
1203 ccid_reset(s);
1204 return 0;
1207 static int ccid_post_load(void *opaque, int version_id)
1209 USBCCIDState *s = opaque;
1212 * This must be done after usb_device_attach, which sets state to ATTACHED,
1213 * while it must be DEFAULT in order to accept packets (like it is after
1214 * reset, but reset will reset our addr and call our reset handler which
1215 * may change state, and we don't want to do that when migrating).
1217 s->dev.state = s->state_vmstate;
1218 return 0;
1221 static void ccid_pre_save(void *opaque)
1223 USBCCIDState *s = opaque;
1225 s->state_vmstate = s->dev.state;
1226 if (s->dev.attached) {
1228 * Migrating an open device, ignore reconnection CHR_EVENT to avoid an
1229 * erroneous detach.
1231 s->migration_state = MIGRATION_MIGRATED;
1235 static VMStateDescription bulk_in_vmstate = {
1236 .name = "CCID BulkIn state",
1237 .version_id = 1,
1238 .minimum_version_id = 1,
1239 .fields = (VMStateField[]) {
1240 VMSTATE_BUFFER(data, BulkIn),
1241 VMSTATE_UINT32(len, BulkIn),
1242 VMSTATE_UINT32(pos, BulkIn),
1243 VMSTATE_END_OF_LIST()
1247 static VMStateDescription answer_vmstate = {
1248 .name = "CCID Answer state",
1249 .version_id = 1,
1250 .minimum_version_id = 1,
1251 .fields = (VMStateField[]) {
1252 VMSTATE_UINT8(slot, Answer),
1253 VMSTATE_UINT8(seq, Answer),
1254 VMSTATE_END_OF_LIST()
1258 static VMStateDescription usb_device_vmstate = {
1259 .name = "usb_device",
1260 .version_id = 1,
1261 .minimum_version_id = 1,
1262 .fields = (VMStateField[]) {
1263 VMSTATE_UINT8(addr, USBDevice),
1264 VMSTATE_BUFFER(setup_buf, USBDevice),
1265 VMSTATE_BUFFER(data_buf, USBDevice),
1266 VMSTATE_END_OF_LIST()
1270 static VMStateDescription ccid_vmstate = {
1271 .name = CCID_DEV_NAME,
1272 .version_id = 1,
1273 .minimum_version_id = 1,
1274 .post_load = ccid_post_load,
1275 .pre_save = ccid_pre_save,
1276 .fields = (VMStateField[]) {
1277 VMSTATE_STRUCT(dev, USBCCIDState, 1, usb_device_vmstate, USBDevice),
1278 VMSTATE_UINT8(debug, USBCCIDState),
1279 VMSTATE_BUFFER(bulk_out_data, USBCCIDState),
1280 VMSTATE_UINT32(bulk_out_pos, USBCCIDState),
1281 VMSTATE_UINT8(bmSlotICCState, USBCCIDState),
1282 VMSTATE_UINT8(powered, USBCCIDState),
1283 VMSTATE_UINT8(notify_slot_change, USBCCIDState),
1284 VMSTATE_UINT64(last_answer_error, USBCCIDState),
1285 VMSTATE_UINT8(bError, USBCCIDState),
1286 VMSTATE_UINT8(bmCommandStatus, USBCCIDState),
1287 VMSTATE_UINT8(bProtocolNum, USBCCIDState),
1288 VMSTATE_BUFFER(abProtocolDataStructure, USBCCIDState),
1289 VMSTATE_UINT32(ulProtocolDataStructureSize, USBCCIDState),
1290 VMSTATE_STRUCT_ARRAY(bulk_in_pending, USBCCIDState,
1291 BULK_IN_PENDING_NUM, 1, bulk_in_vmstate, BulkIn),
1292 VMSTATE_UINT32(bulk_in_pending_start, USBCCIDState),
1293 VMSTATE_UINT32(bulk_in_pending_end, USBCCIDState),
1294 VMSTATE_STRUCT_ARRAY(pending_answers, USBCCIDState,
1295 PENDING_ANSWERS_NUM, 1, answer_vmstate, Answer),
1296 VMSTATE_UINT32(pending_answers_num, USBCCIDState),
1297 VMSTATE_UINT8(migration_state, USBCCIDState),
1298 VMSTATE_UINT32(state_vmstate, USBCCIDState),
1299 VMSTATE_END_OF_LIST()
1303 static Property ccid_properties[] = {
1304 DEFINE_PROP_UINT8("debug", USBCCIDState, debug, 0),
1305 DEFINE_PROP_END_OF_LIST(),
1308 static void ccid_class_initfn(ObjectClass *klass, void *data)
1310 DeviceClass *dc = DEVICE_CLASS(klass);
1311 USBDeviceClass *uc = USB_DEVICE_CLASS(klass);
1313 uc->init = ccid_initfn;
1314 uc->product_desc = "QEMU USB CCID";
1315 uc->usb_desc = &desc_ccid;
1316 uc->handle_reset = ccid_handle_reset;
1317 uc->handle_control = ccid_handle_control;
1318 uc->handle_data = ccid_handle_data;
1319 uc->handle_destroy = ccid_handle_destroy;
1320 dc->desc = "CCID Rev 1.1 smartcard reader";
1321 dc->vmsd = &ccid_vmstate;
1322 dc->props = ccid_properties;
1325 static const TypeInfo ccid_info = {
1326 .name = CCID_DEV_NAME,
1327 .parent = TYPE_USB_DEVICE,
1328 .instance_size = sizeof(USBCCIDState),
1329 .class_init = ccid_class_initfn,
1332 static void ccid_card_class_init(ObjectClass *klass, void *data)
1334 DeviceClass *k = DEVICE_CLASS(klass);
1335 k->bus_type = TYPE_CCID_BUS;
1336 k->init = ccid_card_init;
1337 k->exit = ccid_card_exit;
1338 k->props = ccid_props;
1341 static const TypeInfo ccid_card_type_info = {
1342 .name = TYPE_CCID_CARD,
1343 .parent = TYPE_DEVICE,
1344 .instance_size = sizeof(CCIDCardState),
1345 .abstract = true,
1346 .class_size = sizeof(CCIDCardClass),
1347 .class_init = ccid_card_class_init,
1350 static void ccid_register_types(void)
1352 type_register_static(&ccid_bus_info);
1353 type_register_static(&ccid_card_type_info);
1354 type_register_static(&ccid_info);
1355 usb_legacy_register(CCID_DEV_NAME, "ccid", NULL);
1358 type_init(ccid_register_types)