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,
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"
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"
40 #include "hw/usb/desc.h"
41 #include "monitor/monitor.h"
45 #define DPRINTF(s, lvl, fmt, ...) \
47 if (lvl <= s->debug) { \
48 printf("usb-ccid: " fmt , ## __VA_ARGS__); \
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
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) */
150 ICC_STATUS_PRESENT_ACTIVE
= 0,
151 ICC_STATUS_PRESENT_INACTIVE
,
152 ICC_STATUS_NOT_PRESENT
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) */
163 ERROR_CMD_NOT_SUPPORTED
= 0,
164 ERROR_CMD_ABORTED
= -1,
166 ERROR_XFR_PARITY_ERROR
= -3,
167 ERROR_XFR_OVERRUN
= -4,
171 /* 6.2.6 RDR_to_PC_SlotStatus definitions */
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
;
187 typedef struct QEMU_PACKED CCID_BULK_IN
{
189 uint8_t bStatus
; /* Only used in BULK_IN */
190 uint8_t bError
; /* Only used in BULK_IN */
193 typedef struct QEMU_PACKED CCID_SlotStatus
{
195 uint8_t bClockStatus
;
198 typedef struct QEMU_PACKED CCID_Parameter
{
200 uint8_t bProtocolNum
;
201 uint8_t abProtocolDataStructure
[0];
204 typedef struct QEMU_PACKED CCID_DataBlock
{
206 uint8_t bChainParameter
;
210 /* 6.1.4 PC_to_RDR_XfrBlock */
211 typedef struct QEMU_PACKED CCID_XferBlock
{
213 uint8_t bBWI
; /* Block Waiting Timeout */
214 uint16_t wLevelParameter
; /* XXX currently unused */
218 typedef struct QEMU_PACKED CCID_IccPowerOn
{
220 uint8_t bPowerSelect
;
224 typedef struct QEMU_PACKED CCID_IccPowerOff
{
229 typedef struct QEMU_PACKED CCID_SetParameters
{
231 uint8_t bProtocolNum
;
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
{
247 /* pending BULK_IN messages */
248 typedef struct BulkIn
{
249 uint8_t data
[BULK_IN_BUF_SIZE
];
259 typedef struct CCIDBus
{
263 #define MAX_PROTOCOL_SIZE 7
266 * powered - defaults to true, changed by PowerOn/PowerOff messages
268 typedef struct USBCCIDState
{
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
;
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
;
296 uint8_t notify_slot_change
;
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
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. */
316 * u8 bMaxSlotIndex; The index of the highest available
317 * slot on this device. All slots are consecutive starting
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
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,
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,
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.
382 * u8 bClassEnvelope; EAPDU only. Envelope command for
386 * u16 wLcdLayout; XXYY Number of lines (XX) and chars per
387 * line for LCD display used for PIN entry. 0000 - no LCD
390 * u8 bPINSupport; 01h PIN Verification,
391 * 02h PIN Modification
393 0x01, /* u8 bMaxCCIDBusySlots; */
397 STR_MANUFACTURER
= 1,
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,
413 .bInterfaceClass
= 0x0b,
414 .bInterfaceSubClass
= 0x00,
415 .bInterfaceProtocol
= 0x00,
416 .iInterface
= STR_INTERFACE
,
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
,
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
= {
444 .bMaxPacketSize0
= 64,
445 .bNumConfigurations
= 1,
446 .confs
= (USBDescConfig
[]) {
449 .bConfigurationValue
= 1,
450 .bmAttributes
= 0xe0,
458 static const USBDesc desc_ccid
= {
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
,
471 static const uint8_t *ccid_card_get_atr(CCIDCardState
*card
, uint32_t *len
)
473 CCIDCardClass
*cc
= CCID_CARD_GET_CLASS(card
);
475 return cc
->get_atr(card
, len
);
480 static void ccid_card_apdu_from_guest(CCIDCardState
*card
,
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
);
494 return cc
->exitfn(card
);
499 static int ccid_card_initfn(CCIDCardState
*card
)
501 CCIDCardClass
*cc
= CCID_CARD_GET_CLASS(card
);
503 return cc
->initfn(card
);
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
)
525 DPRINTF(s
, D_VERBOSE
, "usb-ccid: pending answers:");
526 if (!ccid_has_pending_answers(s
)) {
527 DPRINTF(s
, D_VERBOSE
, " empty\n");
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
];
534 DPRINTF(s
, D_VERBOSE
, "%d:%d\n", answer
->slot
, answer
->seq
);
536 DPRINTF(s
, D_VERBOSE
, "%d:%d,", answer
->slot
, answer
->seq
);
541 static void ccid_add_pending_answer(USBCCIDState
*s
, CCID_Header
*hdr
)
545 assert(s
->pending_answers_num
< PENDING_ANSWERS_NUM
);
546 s
->pending_answers_num
++;
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
)
559 assert(s
->pending_answers_num
> 0);
560 s
->pending_answers_num
--;
562 &s
->pending_answers
[(s
->pending_answers_start
++) % PENDING_ANSWERS_NUM
];
563 *slot
= answer
->slot
;
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) {
587 assert(s
->bulk_in_pending_num
> 0);
588 s
->bulk_in_pending_num
--;
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
)
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
);
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__
);
612 &s
->bulk_in_pending
[(s
->bulk_in_pending_end
++) % BULK_IN_PENDING_NUM
];
613 s
->bulk_in_pending_num
++;
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
)
629 static void ccid_handle_reset(USBDevice
*dev
)
631 USBCCIDState
*s
= DO_UPCAST(USBCCIDState
, dev
, dev
);
633 DPRINTF(s
, 1, "Reset\n");
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
);
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
);
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
;
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
;
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
;
665 DPRINTF(s
, 1, "got unsupported/bogus control %x, value %x\n",
667 p
->status
= USB_RET_STALL
;
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
)
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
693 uint8_t ret
= ccid_card_status(s
) | (s
->bmCommandStatus
<< 6);
694 DPRINTF(s
, D_VERBOSE
, "status = %d\n", 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
));
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
)
723 uint32_t len
= s
->ulProtocolDataStructureSize
;
725 h
= ccid_reserve_recv_buf(s
, sizeof(CCID_Parameter
) + len
);
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
);
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
;
752 p
->b
.bStatus
= ccid_calc_status(s
);
753 p
->b
.bError
= s
->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
)
767 if (!ccid_has_pending_answers(s
)) {
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
;
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
;
789 if ((ph
->bProtocolNum
& 3) == 0) {
792 if ((ph
->bProtocolNum
& 3) == 1) {
796 s
->bmCommandStatus
= COMMAND_STATUS_FAILED
;
797 s
->bError
= 7; /* Protocol invalid or not supported */
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
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
;
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
;
834 s
->bmSlotICCState
|= SLOT_0_STATE_MASK
;
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
)
855 if (ccid_card_status(s
) != ICC_STATUS_PRESENT_ACTIVE
) {
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
);
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
);
866 ccid_card_apdu_from_guest(s
->card
, recv
->abData
, len
);
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
;
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
);
889 if (s
->bulk_out_pos
< 10) {
891 "%s: bad USB_TOKEN_OUT length, should be at least 10 bytes\n",
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
);
899 case CCID_MESSAGE_TYPE_PC_to_RDR_IccPowerOn
:
900 DPRINTF(s
, 1, "PowerOn: %d\n",
901 ((CCID_IccPowerOn
*)(ccid_header
))->bPowerSelect
);
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
);
909 case CCID_MESSAGE_TYPE_PC_to_RDR_IccPowerOff
:
910 DPRINTF(s
, 1, "PowerOff\n");
911 ccid_reset_error_status(s
);
913 ccid_write_slot_status(s
, ccid_header
);
915 case CCID_MESSAGE_TYPE_PC_to_RDR_XfrBlock
:
916 ccid_on_apdu_from_guest(s
, (CCID_XferBlock
*)s
->bulk_out_data
);
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
);
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
);
928 case CCID_MESSAGE_TYPE_PC_to_RDR_GetParameters
:
929 ccid_reset_error_status(s
);
930 ccid_write_parameters(s
, ccid_header
);
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
);
948 static void ccid_bulk_in_copy_to_guest(USBCCIDState
*s
, USBPacket
*p
)
953 if (s
->current_bulk_in
!= NULL
) {
954 len
= MIN(s
->current_bulk_in
->len
- s
->current_bulk_in
->pos
,
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
);
963 /* return when device has no data - usb 2.0 spec Table 8-4 */
964 p
->status
= USB_RET_NAK
;
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
) {
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
);
985 ccid_handle_bulk_out(s
, p
);
990 case CCID_BULK_IN_EP
:
991 ccid_bulk_in_copy_to_guest(s
, p
);
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
;
1002 "handle_data: int_in: notify_slot_change %X, "
1003 "requested len %zd\n",
1004 s
->bmSlotICCState
, p
->iov
.size
);
1006 p
->status
= USB_RET_NAK
;
1010 DPRINTF(s
, 1, "Bad endpoint\n");
1011 p
->status
= USB_RET_STALL
;
1016 DPRINTF(s
, 1, "Bad token\n");
1017 p
->status
= USB_RET_STALL
;
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
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
,
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
);
1064 if (!ccid_has_pending_answers(s
)) {
1065 DPRINTF(s
, 1, "CCID ERROR: got an APDU without pending answers\n");
1068 s
->bmCommandStatus
= COMMAND_STATUS_NO_ERROR
;
1069 answer
= ccid_peek_next_answer(s
);
1070 if (answer
== NULL
) {
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
)
1081 DO_UPCAST(USBCCIDState
, dev
.qdev
, card
->qdev
.parent_bus
->parent
);
1083 ccid_on_slot_change(s
, false);
1084 ccid_flush_pending_answers(s
);
1088 int ccid_card_ccid_attach(CCIDCardState
*card
)
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
;
1100 void ccid_card_ccid_detach(CCIDCardState
*card
)
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);
1112 void ccid_card_card_error(CCIDCardState
*card
, uint64_t error
)
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
)
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
)
1143 CCIDCardState
*card
= CCID_CARD(qdev
);
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
);
1155 static int ccid_card_init(DeviceState
*qdev
)
1157 CCIDCardState
*card
= CCID_CARD(qdev
);
1159 DO_UPCAST(USBCCIDState
, dev
.qdev
, card
->qdev
.parent_bus
->parent
);
1162 if (card
->slot
!= 0) {
1163 error_report("Warning: usb-ccid supports one slot, can't add %d",
1167 if (s
->card
!= NULL
) {
1168 error_report("Warning: usb-ccid card already full, not adding");
1171 ret
= ccid_card_initfn(card
);
1178 static int ccid_initfn(USBDevice
*dev
)
1180 USBCCIDState
*s
= DO_UPCAST(USBCCIDState
, dev
, dev
);
1182 usb_desc_create_serial(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;
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;
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
);
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
;
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
1231 s
->migration_state
= MIGRATION_MIGRATED
;
1235 static VMStateDescription bulk_in_vmstate
= {
1236 .name
= "CCID BulkIn state",
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",
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",
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
,
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
),
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
)