1 /* 2 * Copyright (C) 2011 Red Hat, Inc. 3 * 4 * CCID Device emulation 5 * 6 * Written by Alon Levy, with contributions from Robert Relyea. 7 * 8 * Based on usb-serial.c, see its copyright and attributions below. 9 * 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, 16 */ 17 18 /* 19 * References: 20 * 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 24 * 25 * Endianness note: from the spec (1.3) 26 * "Fields that are larger than a byte are stored in little endian" 27 * 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. 35 */ 36 37 #include "qemu/osdep.h" 38 #include "qemu/units.h" 39 #include "qapi/error.h" 40 #include "qemu-common.h" 41 #include "qemu/error-report.h" 42 #include "qemu/module.h" 43 #include "hw/qdev-properties.h" 44 #include "hw/usb.h" 45 #include "migration/vmstate.h" 46 #include "desc.h" 47 48 #include "ccid.h" 49 #include "qom/object.h" 50 51 #define DPRINTF(s, lvl, fmt, ...) \ 52 do { \ 53 if (lvl <= s->debug) { \ 54 printf("usb-ccid: " fmt , ## __VA_ARGS__); \ 55 } \ 56 } while (0) 57 58 #define D_WARN 1 59 #define D_INFO 2 60 #define D_MORE_INFO 3 61 #define D_VERBOSE 4 62 63 #define CCID_DEV_NAME "usb-ccid" 64 typedef struct USBCCIDState USBCCIDState; 65 #define USB_CCID_DEV(obj) OBJECT_CHECK(USBCCIDState, (obj), CCID_DEV_NAME) 66 /* 67 * The two options for variable sized buffers: 68 * make them constant size, for large enough constant, 69 * or handle the migration complexity - VMState doesn't handle this case. 70 * sizes are expected never to be exceeded, unless guest misbehaves. 71 */ 72 #define BULK_OUT_DATA_SIZE (64 * KiB) 73 #define PENDING_ANSWERS_NUM 128 74 75 #define BULK_IN_BUF_SIZE 384 76 #define BULK_IN_PENDING_NUM 8 77 78 #define CCID_MAX_PACKET_SIZE 64 79 80 #define CCID_CONTROL_ABORT 0x1 81 #define CCID_CONTROL_GET_CLOCK_FREQUENCIES 0x2 82 #define CCID_CONTROL_GET_DATA_RATES 0x3 83 84 #define CCID_PRODUCT_DESCRIPTION "QEMU USB CCID" 85 #define CCID_VENDOR_DESCRIPTION "QEMU" 86 #define CCID_INTERFACE_NAME "CCID Interface" 87 #define CCID_SERIAL_NUMBER_STRING "1" 88 /* 89 * Using Gemplus Vendor and Product id 90 * Effect on various drivers: 91 * usbccid.sys (winxp, others untested) is a class driver so it doesn't care. 92 * linux has a number of class drivers, but openct filters based on 93 * vendor/product (/etc/openct.conf under fedora), hence Gemplus. 94 */ 95 #define CCID_VENDOR_ID 0x08e6 96 #define CCID_PRODUCT_ID 0x4433 97 #define CCID_DEVICE_VERSION 0x0000 98 99 /* 100 * BULK_OUT messages from PC to Reader 101 * Defined in CCID Rev 1.1 6.1 (page 26) 102 */ 103 #define CCID_MESSAGE_TYPE_PC_to_RDR_IccPowerOn 0x62 104 #define CCID_MESSAGE_TYPE_PC_to_RDR_IccPowerOff 0x63 105 #define CCID_MESSAGE_TYPE_PC_to_RDR_GetSlotStatus 0x65 106 #define CCID_MESSAGE_TYPE_PC_to_RDR_XfrBlock 0x6f 107 #define CCID_MESSAGE_TYPE_PC_to_RDR_GetParameters 0x6c 108 #define CCID_MESSAGE_TYPE_PC_to_RDR_ResetParameters 0x6d 109 #define CCID_MESSAGE_TYPE_PC_to_RDR_SetParameters 0x61 110 #define CCID_MESSAGE_TYPE_PC_to_RDR_Escape 0x6b 111 #define CCID_MESSAGE_TYPE_PC_to_RDR_IccClock 0x6e 112 #define CCID_MESSAGE_TYPE_PC_to_RDR_T0APDU 0x6a 113 #define CCID_MESSAGE_TYPE_PC_to_RDR_Secure 0x69 114 #define CCID_MESSAGE_TYPE_PC_to_RDR_Mechanical 0x71 115 #define CCID_MESSAGE_TYPE_PC_to_RDR_Abort 0x72 116 #define CCID_MESSAGE_TYPE_PC_to_RDR_SetDataRateAndClockFrequency 0x73 117 118 /* 119 * BULK_IN messages from Reader to PC 120 * Defined in CCID Rev 1.1 6.2 (page 48) 121 */ 122 #define CCID_MESSAGE_TYPE_RDR_to_PC_DataBlock 0x80 123 #define CCID_MESSAGE_TYPE_RDR_to_PC_SlotStatus 0x81 124 #define CCID_MESSAGE_TYPE_RDR_to_PC_Parameters 0x82 125 #define CCID_MESSAGE_TYPE_RDR_to_PC_Escape 0x83 126 #define CCID_MESSAGE_TYPE_RDR_to_PC_DataRateAndClockFrequency 0x84 127 128 /* 129 * INTERRUPT_IN messages from Reader to PC 130 * Defined in CCID Rev 1.1 6.3 (page 56) 131 */ 132 #define CCID_MESSAGE_TYPE_RDR_to_PC_NotifySlotChange 0x50 133 #define CCID_MESSAGE_TYPE_RDR_to_PC_HardwareError 0x51 134 135 /* 136 * Endpoints for CCID - addresses are up to us to decide. 137 * To support slot insertion and removal we must have an interrupt in ep 138 * in addition we need a bulk in and bulk out ep 139 * 5.2, page 20 140 */ 141 #define CCID_INT_IN_EP 1 142 #define CCID_BULK_IN_EP 2 143 #define CCID_BULK_OUT_EP 3 144 145 /* bmSlotICCState masks */ 146 #define SLOT_0_STATE_MASK 1 147 #define SLOT_0_CHANGED_MASK 2 148 149 /* Status codes that go in bStatus (see 6.2.6) */ 150 enum { 151 ICC_STATUS_PRESENT_ACTIVE = 0, 152 ICC_STATUS_PRESENT_INACTIVE, 153 ICC_STATUS_NOT_PRESENT 154 }; 155 156 enum { 157 COMMAND_STATUS_NO_ERROR = 0, 158 COMMAND_STATUS_FAILED, 159 COMMAND_STATUS_TIME_EXTENSION_REQUIRED 160 }; 161 162 /* Error codes that go in bError (see 6.2.6) */ 163 enum { 164 ERROR_CMD_NOT_SUPPORTED = 0, 165 ERROR_CMD_ABORTED = -1, 166 ERROR_ICC_MUTE = -2, 167 ERROR_XFR_PARITY_ERROR = -3, 168 ERROR_XFR_OVERRUN = -4, 169 ERROR_HW_ERROR = -5, 170 }; 171 172 /* 6.2.6 RDR_to_PC_SlotStatus definitions */ 173 enum { 174 CLOCK_STATUS_RUNNING = 0, 175 /* 176 * 0 - Clock Running, 1 - Clock stopped in State L, 2 - H, 177 * 3 - unknown state. rest are RFU 178 */ 179 }; 180 181 typedef struct QEMU_PACKED CCID_Header { 182 uint8_t bMessageType; 183 uint32_t dwLength; 184 uint8_t bSlot; 185 uint8_t bSeq; 186 } CCID_Header; 187 188 typedef struct QEMU_PACKED CCID_BULK_IN { 189 CCID_Header hdr; 190 uint8_t bStatus; /* Only used in BULK_IN */ 191 uint8_t bError; /* Only used in BULK_IN */ 192 } CCID_BULK_IN; 193 194 typedef struct QEMU_PACKED CCID_SlotStatus { 195 CCID_BULK_IN b; 196 uint8_t bClockStatus; 197 } CCID_SlotStatus; 198 199 typedef struct QEMU_PACKED CCID_T0ProtocolDataStructure { 200 uint8_t bmFindexDindex; 201 uint8_t bmTCCKST0; 202 uint8_t bGuardTimeT0; 203 uint8_t bWaitingIntegerT0; 204 uint8_t bClockStop; 205 } CCID_T0ProtocolDataStructure; 206 207 typedef struct QEMU_PACKED CCID_T1ProtocolDataStructure { 208 uint8_t bmFindexDindex; 209 uint8_t bmTCCKST1; 210 uint8_t bGuardTimeT1; 211 uint8_t bWaitingIntegerT1; 212 uint8_t bClockStop; 213 uint8_t bIFSC; 214 uint8_t bNadValue; 215 } CCID_T1ProtocolDataStructure; 216 217 typedef union CCID_ProtocolDataStructure { 218 CCID_T0ProtocolDataStructure t0; 219 CCID_T1ProtocolDataStructure t1; 220 uint8_t data[7]; /* must be = max(sizeof(t0), sizeof(t1)) */ 221 } CCID_ProtocolDataStructure; 222 223 typedef struct QEMU_PACKED CCID_Parameter { 224 CCID_BULK_IN b; 225 uint8_t bProtocolNum; 226 CCID_ProtocolDataStructure abProtocolDataStructure; 227 } CCID_Parameter; 228 229 typedef struct QEMU_PACKED CCID_DataBlock { 230 CCID_BULK_IN b; 231 uint8_t bChainParameter; 232 uint8_t abData[]; 233 } CCID_DataBlock; 234 235 /* 6.1.4 PC_to_RDR_XfrBlock */ 236 typedef struct QEMU_PACKED CCID_XferBlock { 237 CCID_Header hdr; 238 uint8_t bBWI; /* Block Waiting Timeout */ 239 uint16_t wLevelParameter; /* XXX currently unused */ 240 uint8_t abData[]; 241 } CCID_XferBlock; 242 243 typedef struct QEMU_PACKED CCID_IccPowerOn { 244 CCID_Header hdr; 245 uint8_t bPowerSelect; 246 uint16_t abRFU; 247 } CCID_IccPowerOn; 248 249 typedef struct QEMU_PACKED CCID_IccPowerOff { 250 CCID_Header hdr; 251 uint16_t abRFU; 252 } CCID_IccPowerOff; 253 254 typedef struct QEMU_PACKED CCID_SetParameters { 255 CCID_Header hdr; 256 uint8_t bProtocolNum; 257 uint16_t abRFU; 258 CCID_ProtocolDataStructure abProtocolDataStructure; 259 } CCID_SetParameters; 260 261 typedef struct CCID_Notify_Slot_Change { 262 uint8_t bMessageType; /* CCID_MESSAGE_TYPE_RDR_to_PC_NotifySlotChange */ 263 uint8_t bmSlotICCState; 264 } CCID_Notify_Slot_Change; 265 266 /* used for DataBlock response to XferBlock */ 267 typedef struct Answer { 268 uint8_t slot; 269 uint8_t seq; 270 } Answer; 271 272 /* pending BULK_IN messages */ 273 typedef struct BulkIn { 274 uint8_t data[BULK_IN_BUF_SIZE]; 275 uint32_t len; 276 uint32_t pos; 277 } BulkIn; 278 279 struct CCIDBus { 280 BusState qbus; 281 }; 282 typedef struct CCIDBus CCIDBus; 283 284 /* 285 * powered - defaults to true, changed by PowerOn/PowerOff messages 286 */ 287 struct USBCCIDState { 288 USBDevice dev; 289 USBEndpoint *intr; 290 USBEndpoint *bulk; 291 CCIDBus bus; 292 CCIDCardState *card; 293 BulkIn bulk_in_pending[BULK_IN_PENDING_NUM]; /* circular */ 294 uint32_t bulk_in_pending_start; 295 uint32_t bulk_in_pending_end; /* first free */ 296 uint32_t bulk_in_pending_num; 297 BulkIn *current_bulk_in; 298 uint8_t bulk_out_data[BULK_OUT_DATA_SIZE]; 299 uint32_t bulk_out_pos; 300 uint64_t last_answer_error; 301 Answer pending_answers[PENDING_ANSWERS_NUM]; 302 uint32_t pending_answers_start; 303 uint32_t pending_answers_end; 304 uint32_t pending_answers_num; 305 uint8_t bError; 306 uint8_t bmCommandStatus; 307 uint8_t bProtocolNum; 308 CCID_ProtocolDataStructure abProtocolDataStructure; 309 uint32_t ulProtocolDataStructureSize; 310 uint32_t state_vmstate; 311 uint8_t bmSlotICCState; 312 uint8_t powered; 313 uint8_t notify_slot_change; 314 uint8_t debug; 315 }; 316 317 /* 318 * CCID Spec chapter 4: CCID uses a standard device descriptor per Chapter 9, 319 * "USB Device Framework", section 9.6.1, in the Universal Serial Bus 320 * Specification. 321 * 322 * This device implemented based on the spec and with an Athena Smart Card 323 * Reader as reference: 324 * 0dc3:1004 Athena Smartcard Solutions, Inc. 325 */ 326 327 static const uint8_t qemu_ccid_descriptor[] = { 328 /* Smart Card Device Class Descriptor */ 329 0x36, /* u8 bLength; */ 330 0x21, /* u8 bDescriptorType; Functional */ 331 0x10, 0x01, /* u16 bcdCCID; CCID Specification Release Number. */ 332 0x00, /* 333 * u8 bMaxSlotIndex; The index of the highest available 334 * slot on this device. All slots are consecutive starting 335 * at 00h. 336 */ 337 0x07, /* u8 bVoltageSupport; 01h - 5.0v, 02h - 3.0, 03 - 1.8 */ 338 339 0x01, 0x00, /* u32 dwProtocols; RRRR PPPP. RRRR = 0000h.*/ 340 0x00, 0x00, /* PPPP: 0001h = Protocol T=0, 0002h = Protocol T=1 */ 341 /* u32 dwDefaultClock; in kHZ (0x0fa0 is 4 MHz) */ 342 0xa0, 0x0f, 0x00, 0x00, 343 /* u32 dwMaximumClock; */ 344 0x00, 0x00, 0x01, 0x00, 345 0x00, /* u8 bNumClockSupported; * 346 * 0 means just the default and max. */ 347 /* u32 dwDataRate ;bps. 9600 == 00002580h */ 348 0x80, 0x25, 0x00, 0x00, 349 /* u32 dwMaxDataRate ; 11520 bps == 0001C200h */ 350 0x00, 0xC2, 0x01, 0x00, 351 0x00, /* u8 bNumDataRatesSupported; 00 means all rates between 352 * default and max */ 353 /* u32 dwMaxIFSD; * 354 * maximum IFSD supported by CCID for protocol * 355 * T=1 (Maximum seen from various cards) */ 356 0xfe, 0x00, 0x00, 0x00, 357 /* u32 dwSyncProtocols; 1 - 2-wire, 2 - 3-wire, 4 - I2C */ 358 0x00, 0x00, 0x00, 0x00, 359 /* u32 dwMechanical; 0 - no special characteristics. */ 360 0x00, 0x00, 0x00, 0x00, 361 /* 362 * u32 dwFeatures; 363 * 0 - No special characteristics 364 * + 2 Automatic parameter configuration based on ATR data 365 * + 4 Automatic activation of ICC on inserting 366 * + 8 Automatic ICC voltage selection 367 * + 10 Automatic ICC clock frequency change 368 * + 20 Automatic baud rate change 369 * + 40 Automatic parameters negotiation made by the CCID 370 * + 80 automatic PPS made by the CCID 371 * 100 CCID can set ICC in clock stop mode 372 * 200 NAD value other then 00 accepted (T=1 protocol) 373 * + 400 Automatic IFSD exchange as first exchange (T=1) 374 * One of the following only: 375 * + 10000 TPDU level exchanges with CCID 376 * 20000 Short APDU level exchange with CCID 377 * 40000 Short and Extended APDU level exchange with CCID 378 * 379 * 100000 USB Wake up signaling supported on card 380 * insertion and removal. Must set bit 5 in bmAttributes 381 * in Configuration descriptor if 100000 is set. 382 */ 383 0xfe, 0x04, 0x01, 0x00, 384 /* 385 * u32 dwMaxCCIDMessageLength; For extended APDU in 386 * [261 + 10 , 65544 + 10]. Otherwise the minimum is 387 * wMaxPacketSize of the Bulk-OUT endpoint 388 */ 389 0x12, 0x00, 0x01, 0x00, 390 0xFF, /* 391 * u8 bClassGetResponse; Significant only for CCID that 392 * offers an APDU level for exchanges. Indicates the 393 * default class value used by the CCID when it sends a 394 * Get Response command to perform the transportation of 395 * an APDU by T=0 protocol 396 * FFh indicates that the CCID echos the class of the APDU. 397 */ 398 0xFF, /* 399 * u8 bClassEnvelope; EAPDU only. Envelope command for 400 * T=0 401 */ 402 0x00, 0x00, /* 403 * u16 wLcdLayout; XXYY Number of lines (XX) and chars per 404 * line for LCD display used for PIN entry. 0000 - no LCD 405 */ 406 0x01, /* 407 * u8 bPINSupport; 01h PIN Verification, 408 * 02h PIN Modification 409 */ 410 0x01, /* u8 bMaxCCIDBusySlots; */ 411 }; 412 413 enum { 414 STR_MANUFACTURER = 1, 415 STR_PRODUCT, 416 STR_SERIALNUMBER, 417 STR_INTERFACE, 418 }; 419 420 static const USBDescStrings desc_strings = { 421 [STR_MANUFACTURER] = "QEMU", 422 [STR_PRODUCT] = "QEMU USB CCID", 423 [STR_SERIALNUMBER] = "1", 424 [STR_INTERFACE] = "CCID Interface", 425 }; 426 427 static const USBDescIface desc_iface0 = { 428 .bInterfaceNumber = 0, 429 .bNumEndpoints = 3, 430 .bInterfaceClass = USB_CLASS_CSCID, 431 .bInterfaceSubClass = USB_SUBCLASS_UNDEFINED, 432 .bInterfaceProtocol = 0x00, 433 .iInterface = STR_INTERFACE, 434 .ndesc = 1, 435 .descs = (USBDescOther[]) { 436 { 437 /* smartcard descriptor */ 438 .data = qemu_ccid_descriptor, 439 }, 440 }, 441 .eps = (USBDescEndpoint[]) { 442 { 443 .bEndpointAddress = USB_DIR_IN | CCID_INT_IN_EP, 444 .bmAttributes = USB_ENDPOINT_XFER_INT, 445 .bInterval = 255, 446 .wMaxPacketSize = 64, 447 },{ 448 .bEndpointAddress = USB_DIR_IN | CCID_BULK_IN_EP, 449 .bmAttributes = USB_ENDPOINT_XFER_BULK, 450 .wMaxPacketSize = 64, 451 },{ 452 .bEndpointAddress = USB_DIR_OUT | CCID_BULK_OUT_EP, 453 .bmAttributes = USB_ENDPOINT_XFER_BULK, 454 .wMaxPacketSize = 64, 455 }, 456 } 457 }; 458 459 static const USBDescDevice desc_device = { 460 .bcdUSB = 0x0110, 461 .bMaxPacketSize0 = 64, 462 .bNumConfigurations = 1, 463 .confs = (USBDescConfig[]) { 464 { 465 .bNumInterfaces = 1, 466 .bConfigurationValue = 1, 467 .bmAttributes = USB_CFG_ATT_ONE | USB_CFG_ATT_SELFPOWER | 468 USB_CFG_ATT_WAKEUP, 469 .bMaxPower = 50, 470 .nif = 1, 471 .ifs = &desc_iface0, 472 }, 473 }, 474 }; 475 476 static const USBDesc desc_ccid = { 477 .id = { 478 .idVendor = CCID_VENDOR_ID, 479 .idProduct = CCID_PRODUCT_ID, 480 .bcdDevice = CCID_DEVICE_VERSION, 481 .iManufacturer = STR_MANUFACTURER, 482 .iProduct = STR_PRODUCT, 483 .iSerialNumber = STR_SERIALNUMBER, 484 }, 485 .full = &desc_device, 486 .str = desc_strings, 487 }; 488 489 static const uint8_t *ccid_card_get_atr(CCIDCardState *card, uint32_t *len) 490 { 491 CCIDCardClass *cc = CCID_CARD_GET_CLASS(card); 492 493 if (cc->get_atr) { 494 return cc->get_atr(card, len); 495 } 496 return NULL; 497 } 498 499 static void ccid_card_apdu_from_guest(CCIDCardState *card, 500 const uint8_t *apdu, 501 uint32_t len) 502 { 503 CCIDCardClass *cc = CCID_CARD_GET_CLASS(card); 504 505 if (cc->apdu_from_guest) { 506 cc->apdu_from_guest(card, apdu, len); 507 } 508 } 509 510 static bool ccid_has_pending_answers(USBCCIDState *s) 511 { 512 return s->pending_answers_num > 0; 513 } 514 515 static void ccid_clear_pending_answers(USBCCIDState *s) 516 { 517 s->pending_answers_num = 0; 518 s->pending_answers_start = 0; 519 s->pending_answers_end = 0; 520 } 521 522 static void ccid_print_pending_answers(USBCCIDState *s) 523 { 524 Answer *answer; 525 int i, count; 526 527 DPRINTF(s, D_VERBOSE, "usb-ccid: pending answers:"); 528 if (!ccid_has_pending_answers(s)) { 529 DPRINTF(s, D_VERBOSE, " empty\n"); 530 return; 531 } 532 for (i = s->pending_answers_start, count = s->pending_answers_num ; 533 count > 0; count--, i++) { 534 answer = &s->pending_answers[i % PENDING_ANSWERS_NUM]; 535 if (count == 1) { 536 DPRINTF(s, D_VERBOSE, "%d:%d\n", answer->slot, answer->seq); 537 } else { 538 DPRINTF(s, D_VERBOSE, "%d:%d,", answer->slot, answer->seq); 539 } 540 } 541 } 542 543 static void ccid_add_pending_answer(USBCCIDState *s, CCID_Header *hdr) 544 { 545 Answer *answer; 546 547 assert(s->pending_answers_num < PENDING_ANSWERS_NUM); 548 s->pending_answers_num++; 549 answer = 550 &s->pending_answers[(s->pending_answers_end++) % PENDING_ANSWERS_NUM]; 551 answer->slot = hdr->bSlot; 552 answer->seq = hdr->bSeq; 553 ccid_print_pending_answers(s); 554 } 555 556 static void ccid_remove_pending_answer(USBCCIDState *s, 557 uint8_t *slot, uint8_t *seq) 558 { 559 Answer *answer; 560 561 assert(s->pending_answers_num > 0); 562 s->pending_answers_num--; 563 answer = 564 &s->pending_answers[(s->pending_answers_start++) % PENDING_ANSWERS_NUM]; 565 *slot = answer->slot; 566 *seq = answer->seq; 567 ccid_print_pending_answers(s); 568 } 569 570 static void ccid_bulk_in_clear(USBCCIDState *s) 571 { 572 s->bulk_in_pending_start = 0; 573 s->bulk_in_pending_end = 0; 574 s->bulk_in_pending_num = 0; 575 } 576 577 static void ccid_bulk_in_release(USBCCIDState *s) 578 { 579 assert(s->current_bulk_in != NULL); 580 s->current_bulk_in->pos = 0; 581 s->current_bulk_in = NULL; 582 } 583 584 static void ccid_bulk_in_get(USBCCIDState *s) 585 { 586 if (s->current_bulk_in != NULL || s->bulk_in_pending_num == 0) { 587 return; 588 } 589 assert(s->bulk_in_pending_num > 0); 590 s->bulk_in_pending_num--; 591 s->current_bulk_in = 592 &s->bulk_in_pending[(s->bulk_in_pending_start++) % BULK_IN_PENDING_NUM]; 593 } 594 595 static void *ccid_reserve_recv_buf(USBCCIDState *s, uint16_t len) 596 { 597 BulkIn *bulk_in; 598 599 DPRINTF(s, D_VERBOSE, "%s: QUEUE: reserve %d bytes\n", __func__, len); 600 601 /* look for an existing element */ 602 if (len > BULK_IN_BUF_SIZE) { 603 DPRINTF(s, D_WARN, "usb-ccid.c: %s: len larger then max (%d>%d). " 604 "discarding message.\n", 605 __func__, len, BULK_IN_BUF_SIZE); 606 return NULL; 607 } 608 if (s->bulk_in_pending_num >= BULK_IN_PENDING_NUM) { 609 DPRINTF(s, D_WARN, "usb-ccid.c: %s: No free bulk_in buffers. " 610 "discarding message.\n", __func__); 611 return NULL; 612 } 613 bulk_in = 614 &s->bulk_in_pending[(s->bulk_in_pending_end++) % BULK_IN_PENDING_NUM]; 615 s->bulk_in_pending_num++; 616 bulk_in->len = len; 617 return bulk_in->data; 618 } 619 620 static void ccid_reset(USBCCIDState *s) 621 { 622 ccid_bulk_in_clear(s); 623 ccid_clear_pending_answers(s); 624 } 625 626 static void ccid_detach(USBCCIDState *s) 627 { 628 ccid_reset(s); 629 } 630 631 static void ccid_handle_reset(USBDevice *dev) 632 { 633 USBCCIDState *s = USB_CCID_DEV(dev); 634 635 DPRINTF(s, 1, "Reset\n"); 636 637 ccid_reset(s); 638 } 639 640 static const char *ccid_control_to_str(USBCCIDState *s, int request) 641 { 642 switch (request) { 643 /* generic - should be factored out if there are other debugees */ 644 case DeviceOutRequest | USB_REQ_SET_ADDRESS: 645 return "(generic) set address"; 646 case DeviceRequest | USB_REQ_GET_DESCRIPTOR: 647 return "(generic) get descriptor"; 648 case DeviceRequest | USB_REQ_GET_CONFIGURATION: 649 return "(generic) get configuration"; 650 case DeviceOutRequest | USB_REQ_SET_CONFIGURATION: 651 return "(generic) set configuration"; 652 case DeviceRequest | USB_REQ_GET_STATUS: 653 return "(generic) get status"; 654 case DeviceOutRequest | USB_REQ_CLEAR_FEATURE: 655 return "(generic) clear feature"; 656 case DeviceOutRequest | USB_REQ_SET_FEATURE: 657 return "(generic) set_feature"; 658 case InterfaceRequest | USB_REQ_GET_INTERFACE: 659 return "(generic) get interface"; 660 case InterfaceOutRequest | USB_REQ_SET_INTERFACE: 661 return "(generic) set interface"; 662 /* class requests */ 663 case ClassInterfaceOutRequest | CCID_CONTROL_ABORT: 664 return "ABORT"; 665 case ClassInterfaceRequest | CCID_CONTROL_GET_CLOCK_FREQUENCIES: 666 return "GET_CLOCK_FREQUENCIES"; 667 case ClassInterfaceRequest | CCID_CONTROL_GET_DATA_RATES: 668 return "GET_DATA_RATES"; 669 } 670 return "unknown"; 671 } 672 673 static void ccid_handle_control(USBDevice *dev, USBPacket *p, int request, 674 int value, int index, int length, uint8_t *data) 675 { 676 USBCCIDState *s = USB_CCID_DEV(dev); 677 int ret; 678 679 DPRINTF(s, 1, "%s: got control %s (%x), value %x\n", __func__, 680 ccid_control_to_str(s, request), request, value); 681 ret = usb_desc_handle_control(dev, p, request, value, index, length, data); 682 if (ret >= 0) { 683 return; 684 } 685 686 switch (request) { 687 /* Class specific requests. */ 688 case ClassInterfaceOutRequest | CCID_CONTROL_ABORT: 689 DPRINTF(s, 1, "ccid_control abort UNIMPLEMENTED\n"); 690 p->status = USB_RET_STALL; 691 break; 692 case ClassInterfaceRequest | CCID_CONTROL_GET_CLOCK_FREQUENCIES: 693 DPRINTF(s, 1, "ccid_control get clock frequencies UNIMPLEMENTED\n"); 694 p->status = USB_RET_STALL; 695 break; 696 case ClassInterfaceRequest | CCID_CONTROL_GET_DATA_RATES: 697 DPRINTF(s, 1, "ccid_control get data rates UNIMPLEMENTED\n"); 698 p->status = USB_RET_STALL; 699 break; 700 default: 701 DPRINTF(s, 1, "got unsupported/bogus control %x, value %x\n", 702 request, value); 703 p->status = USB_RET_STALL; 704 break; 705 } 706 } 707 708 static bool ccid_card_inserted(USBCCIDState *s) 709 { 710 return s->bmSlotICCState & SLOT_0_STATE_MASK; 711 } 712 713 static uint8_t ccid_card_status(USBCCIDState *s) 714 { 715 return ccid_card_inserted(s) 716 ? (s->powered ? 717 ICC_STATUS_PRESENT_ACTIVE 718 : ICC_STATUS_PRESENT_INACTIVE 719 ) 720 : ICC_STATUS_NOT_PRESENT; 721 } 722 723 static uint8_t ccid_calc_status(USBCCIDState *s) 724 { 725 /* 726 * page 55, 6.2.6, calculation of bStatus from bmICCStatus and 727 * bmCommandStatus 728 */ 729 uint8_t ret = ccid_card_status(s) | (s->bmCommandStatus << 6); 730 DPRINTF(s, D_VERBOSE, "%s: status = %d\n", __func__, ret); 731 return ret; 732 } 733 734 static void ccid_reset_error_status(USBCCIDState *s) 735 { 736 s->bError = ERROR_CMD_NOT_SUPPORTED; 737 s->bmCommandStatus = COMMAND_STATUS_NO_ERROR; 738 } 739 740 static void ccid_write_slot_status(USBCCIDState *s, CCID_Header *recv) 741 { 742 CCID_SlotStatus *h = ccid_reserve_recv_buf(s, sizeof(CCID_SlotStatus)); 743 if (h == NULL) { 744 return; 745 } 746 h->b.hdr.bMessageType = CCID_MESSAGE_TYPE_RDR_to_PC_SlotStatus; 747 h->b.hdr.dwLength = 0; 748 h->b.hdr.bSlot = recv->bSlot; 749 h->b.hdr.bSeq = recv->bSeq; 750 h->b.bStatus = ccid_calc_status(s); 751 h->b.bError = s->bError; 752 h->bClockStatus = CLOCK_STATUS_RUNNING; 753 ccid_reset_error_status(s); 754 usb_wakeup(s->bulk, 0); 755 } 756 757 static void ccid_write_parameters(USBCCIDState *s, CCID_Header *recv) 758 { 759 CCID_Parameter *h; 760 uint32_t len = s->ulProtocolDataStructureSize; 761 762 h = ccid_reserve_recv_buf(s, sizeof(CCID_Parameter) + len); 763 if (h == NULL) { 764 return; 765 } 766 h->b.hdr.bMessageType = CCID_MESSAGE_TYPE_RDR_to_PC_Parameters; 767 h->b.hdr.dwLength = 0; 768 h->b.hdr.bSlot = recv->bSlot; 769 h->b.hdr.bSeq = recv->bSeq; 770 h->b.bStatus = ccid_calc_status(s); 771 h->b.bError = s->bError; 772 h->bProtocolNum = s->bProtocolNum; 773 h->abProtocolDataStructure = s->abProtocolDataStructure; 774 ccid_reset_error_status(s); 775 usb_wakeup(s->bulk, 0); 776 } 777 778 static void ccid_write_data_block(USBCCIDState *s, uint8_t slot, uint8_t seq, 779 const uint8_t *data, uint32_t len) 780 { 781 CCID_DataBlock *p = ccid_reserve_recv_buf(s, sizeof(*p) + len); 782 783 if (p == NULL) { 784 return; 785 } 786 p->b.hdr.bMessageType = CCID_MESSAGE_TYPE_RDR_to_PC_DataBlock; 787 p->b.hdr.dwLength = cpu_to_le32(len); 788 p->b.hdr.bSlot = slot; 789 p->b.hdr.bSeq = seq; 790 p->b.bStatus = ccid_calc_status(s); 791 p->b.bError = s->bError; 792 if (p->b.bError) { 793 DPRINTF(s, D_VERBOSE, "error %d\n", p->b.bError); 794 } 795 if (len) { 796 assert(data); 797 memcpy(p->abData, data, len); 798 } 799 ccid_reset_error_status(s); 800 usb_wakeup(s->bulk, 0); 801 } 802 803 static void ccid_report_error_failed(USBCCIDState *s, uint8_t error) 804 { 805 s->bmCommandStatus = COMMAND_STATUS_FAILED; 806 s->bError = error; 807 } 808 809 static void ccid_write_data_block_answer(USBCCIDState *s, 810 const uint8_t *data, uint32_t len) 811 { 812 uint8_t seq; 813 uint8_t slot; 814 815 if (!ccid_has_pending_answers(s)) { 816 DPRINTF(s, D_WARN, "error: no pending answer to return to guest\n"); 817 ccid_report_error_failed(s, ERROR_ICC_MUTE); 818 return; 819 } 820 ccid_remove_pending_answer(s, &slot, &seq); 821 ccid_write_data_block(s, slot, seq, data, len); 822 } 823 824 static uint8_t atr_get_protocol_num(const uint8_t *atr, uint32_t len) 825 { 826 int i; 827 828 if (len < 2 || !(atr[1] & 0x80)) { 829 /* too short or TD1 not included */ 830 return 0; /* T=0, default */ 831 } 832 i = 1 + !!(atr[1] & 0x10) + !!(atr[1] & 0x20) + !!(atr[1] & 0x40); 833 i += !!(atr[1] & 0x80); 834 return atr[i] & 0x0f; 835 } 836 837 static void ccid_write_data_block_atr(USBCCIDState *s, CCID_Header *recv) 838 { 839 const uint8_t *atr = NULL; 840 uint32_t len = 0; 841 uint8_t atr_protocol_num; 842 CCID_T0ProtocolDataStructure *t0 = &s->abProtocolDataStructure.t0; 843 CCID_T1ProtocolDataStructure *t1 = &s->abProtocolDataStructure.t1; 844 845 if (s->card) { 846 atr = ccid_card_get_atr(s->card, &len); 847 } 848 atr_protocol_num = atr_get_protocol_num(atr, len); 849 DPRINTF(s, D_VERBOSE, "%s: atr contains protocol=%d\n", __func__, 850 atr_protocol_num); 851 /* set parameters from ATR - see spec page 109 */ 852 s->bProtocolNum = (atr_protocol_num <= 1 ? atr_protocol_num 853 : s->bProtocolNum); 854 switch (atr_protocol_num) { 855 case 0: 856 /* TODO: unimplemented ATR T0 parameters */ 857 t0->bmFindexDindex = 0; 858 t0->bmTCCKST0 = 0; 859 t0->bGuardTimeT0 = 0; 860 t0->bWaitingIntegerT0 = 0; 861 t0->bClockStop = 0; 862 break; 863 case 1: 864 /* TODO: unimplemented ATR T1 parameters */ 865 t1->bmFindexDindex = 0; 866 t1->bmTCCKST1 = 0; 867 t1->bGuardTimeT1 = 0; 868 t1->bWaitingIntegerT1 = 0; 869 t1->bClockStop = 0; 870 t1->bIFSC = 0; 871 t1->bNadValue = 0; 872 break; 873 default: 874 DPRINTF(s, D_WARN, "%s: error: unsupported ATR protocol %d\n", 875 __func__, atr_protocol_num); 876 } 877 ccid_write_data_block(s, recv->bSlot, recv->bSeq, atr, len); 878 } 879 880 static void ccid_set_parameters(USBCCIDState *s, CCID_Header *recv) 881 { 882 CCID_SetParameters *ph = (CCID_SetParameters *) recv; 883 uint32_t protocol_num = ph->bProtocolNum & 3; 884 885 if (protocol_num != 0 && protocol_num != 1) { 886 ccid_report_error_failed(s, ERROR_CMD_NOT_SUPPORTED); 887 return; 888 } 889 s->bProtocolNum = protocol_num; 890 s->abProtocolDataStructure = ph->abProtocolDataStructure; 891 } 892 893 /* 894 * must be 5 bytes for T=0, 7 bytes for T=1 895 * See page 52 896 */ 897 static const CCID_ProtocolDataStructure defaultProtocolDataStructure = { 898 .t1 = { 899 .bmFindexDindex = 0x77, 900 .bmTCCKST1 = 0x00, 901 .bGuardTimeT1 = 0x00, 902 .bWaitingIntegerT1 = 0x00, 903 .bClockStop = 0x00, 904 .bIFSC = 0xfe, 905 .bNadValue = 0x00, 906 } 907 }; 908 909 static void ccid_reset_parameters(USBCCIDState *s) 910 { 911 s->bProtocolNum = 0; /* T=0 */ 912 s->abProtocolDataStructure = defaultProtocolDataStructure; 913 } 914 915 /* NOTE: only a single slot is supported (SLOT_0) */ 916 static void ccid_on_slot_change(USBCCIDState *s, bool full) 917 { 918 /* RDR_to_PC_NotifySlotChange, 6.3.1 page 56 */ 919 uint8_t current = s->bmSlotICCState; 920 if (full) { 921 s->bmSlotICCState |= SLOT_0_STATE_MASK; 922 } else { 923 s->bmSlotICCState &= ~SLOT_0_STATE_MASK; 924 } 925 if (current != s->bmSlotICCState) { 926 s->bmSlotICCState |= SLOT_0_CHANGED_MASK; 927 } 928 s->notify_slot_change = true; 929 usb_wakeup(s->intr, 0); 930 } 931 932 static void ccid_write_data_block_error( 933 USBCCIDState *s, uint8_t slot, uint8_t seq) 934 { 935 ccid_write_data_block(s, slot, seq, NULL, 0); 936 } 937 938 static void ccid_on_apdu_from_guest(USBCCIDState *s, CCID_XferBlock *recv) 939 { 940 uint32_t len; 941 942 if (ccid_card_status(s) != ICC_STATUS_PRESENT_ACTIVE) { 943 DPRINTF(s, 1, 944 "usb-ccid: not sending apdu to client, no card connected\n"); 945 ccid_write_data_block_error(s, recv->hdr.bSlot, recv->hdr.bSeq); 946 return; 947 } 948 len = le32_to_cpu(recv->hdr.dwLength); 949 DPRINTF(s, 1, "%s: seq %d, len %d\n", __func__, 950 recv->hdr.bSeq, len); 951 ccid_add_pending_answer(s, (CCID_Header *)recv); 952 if (s->card && len <= BULK_OUT_DATA_SIZE) { 953 ccid_card_apdu_from_guest(s->card, recv->abData, len); 954 } else { 955 DPRINTF(s, D_WARN, "warning: discarded apdu\n"); 956 } 957 } 958 959 static const char *ccid_message_type_to_str(uint8_t type) 960 { 961 switch (type) { 962 case CCID_MESSAGE_TYPE_PC_to_RDR_IccPowerOn: return "IccPowerOn"; 963 case CCID_MESSAGE_TYPE_PC_to_RDR_IccPowerOff: return "IccPowerOff"; 964 case CCID_MESSAGE_TYPE_PC_to_RDR_GetSlotStatus: return "GetSlotStatus"; 965 case CCID_MESSAGE_TYPE_PC_to_RDR_XfrBlock: return "XfrBlock"; 966 case CCID_MESSAGE_TYPE_PC_to_RDR_GetParameters: return "GetParameters"; 967 case CCID_MESSAGE_TYPE_PC_to_RDR_ResetParameters: return "ResetParameters"; 968 case CCID_MESSAGE_TYPE_PC_to_RDR_SetParameters: return "SetParameters"; 969 case CCID_MESSAGE_TYPE_PC_to_RDR_Escape: return "Escape"; 970 case CCID_MESSAGE_TYPE_PC_to_RDR_IccClock: return "IccClock"; 971 case CCID_MESSAGE_TYPE_PC_to_RDR_T0APDU: return "T0APDU"; 972 case CCID_MESSAGE_TYPE_PC_to_RDR_Secure: return "Secure"; 973 case CCID_MESSAGE_TYPE_PC_to_RDR_Mechanical: return "Mechanical"; 974 case CCID_MESSAGE_TYPE_PC_to_RDR_Abort: return "Abort"; 975 case CCID_MESSAGE_TYPE_PC_to_RDR_SetDataRateAndClockFrequency: 976 return "SetDataRateAndClockFrequency"; 977 } 978 return "unknown"; 979 } 980 981 static void ccid_handle_bulk_out(USBCCIDState *s, USBPacket *p) 982 { 983 CCID_Header *ccid_header; 984 985 if (p->iov.size + s->bulk_out_pos > BULK_OUT_DATA_SIZE) { 986 goto err; 987 } 988 usb_packet_copy(p, s->bulk_out_data + s->bulk_out_pos, p->iov.size); 989 s->bulk_out_pos += p->iov.size; 990 if (s->bulk_out_pos < 10) { 991 DPRINTF(s, 1, "%s: header incomplete\n", __func__); 992 goto err; 993 } 994 995 ccid_header = (CCID_Header *)s->bulk_out_data; 996 if ((s->bulk_out_pos - 10 < ccid_header->dwLength) && 997 (p->iov.size == CCID_MAX_PACKET_SIZE)) { 998 DPRINTF(s, D_VERBOSE, 999 "usb-ccid: bulk_in: expecting more packets (%d/%d)\n", 1000 s->bulk_out_pos - 10, ccid_header->dwLength); 1001 return; 1002 } 1003 if (s->bulk_out_pos - 10 != ccid_header->dwLength) { 1004 DPRINTF(s, 1, 1005 "usb-ccid: bulk_in: message size mismatch (got %d, expected %d)\n", 1006 s->bulk_out_pos - 10, ccid_header->dwLength); 1007 goto err; 1008 } 1009 1010 DPRINTF(s, D_MORE_INFO, "%s %x %s\n", __func__, 1011 ccid_header->bMessageType, 1012 ccid_message_type_to_str(ccid_header->bMessageType)); 1013 switch (ccid_header->bMessageType) { 1014 case CCID_MESSAGE_TYPE_PC_to_RDR_GetSlotStatus: 1015 ccid_write_slot_status(s, ccid_header); 1016 break; 1017 case CCID_MESSAGE_TYPE_PC_to_RDR_IccPowerOn: 1018 DPRINTF(s, 1, "%s: PowerOn: %d\n", __func__, 1019 ((CCID_IccPowerOn *)(ccid_header))->bPowerSelect); 1020 s->powered = true; 1021 if (!ccid_card_inserted(s)) { 1022 ccid_report_error_failed(s, ERROR_ICC_MUTE); 1023 } 1024 /* atr is written regardless of error. */ 1025 ccid_write_data_block_atr(s, ccid_header); 1026 break; 1027 case CCID_MESSAGE_TYPE_PC_to_RDR_IccPowerOff: 1028 ccid_reset_error_status(s); 1029 s->powered = false; 1030 ccid_write_slot_status(s, ccid_header); 1031 break; 1032 case CCID_MESSAGE_TYPE_PC_to_RDR_XfrBlock: 1033 ccid_on_apdu_from_guest(s, (CCID_XferBlock *)s->bulk_out_data); 1034 break; 1035 case CCID_MESSAGE_TYPE_PC_to_RDR_SetParameters: 1036 ccid_reset_error_status(s); 1037 ccid_set_parameters(s, ccid_header); 1038 ccid_write_parameters(s, ccid_header); 1039 break; 1040 case CCID_MESSAGE_TYPE_PC_to_RDR_ResetParameters: 1041 ccid_reset_error_status(s); 1042 ccid_reset_parameters(s); 1043 ccid_write_parameters(s, ccid_header); 1044 break; 1045 case CCID_MESSAGE_TYPE_PC_to_RDR_GetParameters: 1046 ccid_reset_error_status(s); 1047 ccid_write_parameters(s, ccid_header); 1048 break; 1049 case CCID_MESSAGE_TYPE_PC_to_RDR_Mechanical: 1050 ccid_report_error_failed(s, 0); 1051 ccid_write_slot_status(s, ccid_header); 1052 break; 1053 default: 1054 DPRINTF(s, 1, 1055 "handle_data: ERROR: unhandled message type %Xh\n", 1056 ccid_header->bMessageType); 1057 /* 1058 * The caller is expecting the device to respond, tell it we 1059 * don't support the operation. 1060 */ 1061 ccid_report_error_failed(s, ERROR_CMD_NOT_SUPPORTED); 1062 ccid_write_slot_status(s, ccid_header); 1063 break; 1064 } 1065 s->bulk_out_pos = 0; 1066 return; 1067 1068 err: 1069 p->status = USB_RET_STALL; 1070 s->bulk_out_pos = 0; 1071 return; 1072 } 1073 1074 static void ccid_bulk_in_copy_to_guest(USBCCIDState *s, USBPacket *p, 1075 unsigned int max_packet_size) 1076 { 1077 int len = 0; 1078 1079 ccid_bulk_in_get(s); 1080 if (s->current_bulk_in != NULL) { 1081 len = MIN(s->current_bulk_in->len - s->current_bulk_in->pos, 1082 p->iov.size); 1083 if (len) { 1084 usb_packet_copy(p, s->current_bulk_in->data + 1085 s->current_bulk_in->pos, len); 1086 } 1087 s->current_bulk_in->pos += len; 1088 if (s->current_bulk_in->pos == s->current_bulk_in->len 1089 && len != max_packet_size) { 1090 ccid_bulk_in_release(s); 1091 } 1092 } else { 1093 /* return when device has no data - usb 2.0 spec Table 8-4 */ 1094 p->status = USB_RET_NAK; 1095 } 1096 if (len) { 1097 DPRINTF(s, D_MORE_INFO, 1098 "%s: %zd/%d req/act to guest (BULK_IN)\n", 1099 __func__, p->iov.size, len); 1100 } 1101 if (len < p->iov.size) { 1102 DPRINTF(s, 1, 1103 "%s: returning short (EREMOTEIO) %d < %zd\n", 1104 __func__, len, p->iov.size); 1105 } 1106 } 1107 1108 static void ccid_handle_data(USBDevice *dev, USBPacket *p) 1109 { 1110 USBCCIDState *s = USB_CCID_DEV(dev); 1111 uint8_t buf[2]; 1112 1113 switch (p->pid) { 1114 case USB_TOKEN_OUT: 1115 ccid_handle_bulk_out(s, p); 1116 break; 1117 1118 case USB_TOKEN_IN: 1119 switch (p->ep->nr) { 1120 case CCID_BULK_IN_EP: 1121 ccid_bulk_in_copy_to_guest(s, p, dev->ep_ctl.max_packet_size); 1122 break; 1123 case CCID_INT_IN_EP: 1124 if (s->notify_slot_change) { 1125 /* page 56, RDR_to_PC_NotifySlotChange */ 1126 buf[0] = CCID_MESSAGE_TYPE_RDR_to_PC_NotifySlotChange; 1127 buf[1] = s->bmSlotICCState; 1128 usb_packet_copy(p, buf, 2); 1129 s->notify_slot_change = false; 1130 s->bmSlotICCState &= ~SLOT_0_CHANGED_MASK; 1131 DPRINTF(s, D_INFO, 1132 "handle_data: int_in: notify_slot_change %X, " 1133 "requested len %zd\n", 1134 s->bmSlotICCState, p->iov.size); 1135 } else { 1136 p->status = USB_RET_NAK; 1137 } 1138 break; 1139 default: 1140 DPRINTF(s, 1, "Bad endpoint\n"); 1141 p->status = USB_RET_STALL; 1142 break; 1143 } 1144 break; 1145 default: 1146 DPRINTF(s, 1, "Bad token\n"); 1147 p->status = USB_RET_STALL; 1148 break; 1149 } 1150 } 1151 1152 static void ccid_unrealize(USBDevice *dev) 1153 { 1154 USBCCIDState *s = USB_CCID_DEV(dev); 1155 1156 ccid_bulk_in_clear(s); 1157 } 1158 1159 static void ccid_flush_pending_answers(USBCCIDState *s) 1160 { 1161 while (ccid_has_pending_answers(s)) { 1162 ccid_write_data_block_answer(s, NULL, 0); 1163 } 1164 } 1165 1166 static Answer *ccid_peek_next_answer(USBCCIDState *s) 1167 { 1168 return s->pending_answers_num == 0 1169 ? NULL 1170 : &s->pending_answers[s->pending_answers_start % PENDING_ANSWERS_NUM]; 1171 } 1172 1173 static Property ccid_props[] = { 1174 DEFINE_PROP_UINT32("slot", struct CCIDCardState, slot, 0), 1175 DEFINE_PROP_END_OF_LIST(), 1176 }; 1177 1178 #define TYPE_CCID_BUS "ccid-bus" 1179 #define CCID_BUS(obj) OBJECT_CHECK(CCIDBus, (obj), TYPE_CCID_BUS) 1180 1181 static const TypeInfo ccid_bus_info = { 1182 .name = TYPE_CCID_BUS, 1183 .parent = TYPE_BUS, 1184 .instance_size = sizeof(CCIDBus), 1185 }; 1186 1187 void ccid_card_send_apdu_to_guest(CCIDCardState *card, 1188 uint8_t *apdu, uint32_t len) 1189 { 1190 DeviceState *qdev = DEVICE(card); 1191 USBDevice *dev = USB_DEVICE(qdev->parent_bus->parent); 1192 USBCCIDState *s = USB_CCID_DEV(dev); 1193 Answer *answer; 1194 1195 if (!ccid_has_pending_answers(s)) { 1196 DPRINTF(s, 1, "CCID ERROR: got an APDU without pending answers\n"); 1197 return; 1198 } 1199 s->bmCommandStatus = COMMAND_STATUS_NO_ERROR; 1200 answer = ccid_peek_next_answer(s); 1201 if (answer == NULL) { 1202 DPRINTF(s, D_WARN, "%s: error: unexpected lack of answer\n", __func__); 1203 ccid_report_error_failed(s, ERROR_HW_ERROR); 1204 return; 1205 } 1206 DPRINTF(s, 1, "APDU returned to guest %d (answer seq %d, slot %d)\n", 1207 len, answer->seq, answer->slot); 1208 ccid_write_data_block_answer(s, apdu, len); 1209 } 1210 1211 void ccid_card_card_removed(CCIDCardState *card) 1212 { 1213 DeviceState *qdev = DEVICE(card); 1214 USBDevice *dev = USB_DEVICE(qdev->parent_bus->parent); 1215 USBCCIDState *s = USB_CCID_DEV(dev); 1216 1217 ccid_on_slot_change(s, false); 1218 ccid_flush_pending_answers(s); 1219 ccid_reset(s); 1220 } 1221 1222 int ccid_card_ccid_attach(CCIDCardState *card) 1223 { 1224 DeviceState *qdev = DEVICE(card); 1225 USBDevice *dev = USB_DEVICE(qdev->parent_bus->parent); 1226 USBCCIDState *s = USB_CCID_DEV(dev); 1227 1228 DPRINTF(s, 1, "CCID Attach\n"); 1229 return 0; 1230 } 1231 1232 void ccid_card_ccid_detach(CCIDCardState *card) 1233 { 1234 DeviceState *qdev = DEVICE(card); 1235 USBDevice *dev = USB_DEVICE(qdev->parent_bus->parent); 1236 USBCCIDState *s = USB_CCID_DEV(dev); 1237 1238 DPRINTF(s, 1, "CCID Detach\n"); 1239 if (ccid_card_inserted(s)) { 1240 ccid_on_slot_change(s, false); 1241 } 1242 ccid_detach(s); 1243 } 1244 1245 void ccid_card_card_error(CCIDCardState *card, uint64_t error) 1246 { 1247 DeviceState *qdev = DEVICE(card); 1248 USBDevice *dev = USB_DEVICE(qdev->parent_bus->parent); 1249 USBCCIDState *s = USB_CCID_DEV(dev); 1250 1251 s->bmCommandStatus = COMMAND_STATUS_FAILED; 1252 s->last_answer_error = error; 1253 DPRINTF(s, 1, "VSC_Error: %" PRIX64 "\n", s->last_answer_error); 1254 /* TODO: these errors should be more verbose and propagated to the guest.*/ 1255 /* 1256 * We flush all pending answers on CardRemove message in ccid-card-passthru, 1257 * so check that first to not trigger abort 1258 */ 1259 if (ccid_has_pending_answers(s)) { 1260 ccid_write_data_block_answer(s, NULL, 0); 1261 } 1262 } 1263 1264 void ccid_card_card_inserted(CCIDCardState *card) 1265 { 1266 DeviceState *qdev = DEVICE(card); 1267 USBDevice *dev = USB_DEVICE(qdev->parent_bus->parent); 1268 USBCCIDState *s = USB_CCID_DEV(dev); 1269 1270 s->bmCommandStatus = COMMAND_STATUS_NO_ERROR; 1271 ccid_flush_pending_answers(s); 1272 ccid_on_slot_change(s, true); 1273 } 1274 1275 static void ccid_card_unrealize(DeviceState *qdev) 1276 { 1277 CCIDCardState *card = CCID_CARD(qdev); 1278 CCIDCardClass *cc = CCID_CARD_GET_CLASS(card); 1279 USBDevice *dev = USB_DEVICE(qdev->parent_bus->parent); 1280 USBCCIDState *s = USB_CCID_DEV(dev); 1281 1282 if (ccid_card_inserted(s)) { 1283 ccid_card_card_removed(card); 1284 } 1285 if (cc->unrealize) { 1286 cc->unrealize(card); 1287 } 1288 s->card = NULL; 1289 } 1290 1291 static void ccid_card_realize(DeviceState *qdev, Error **errp) 1292 { 1293 CCIDCardState *card = CCID_CARD(qdev); 1294 CCIDCardClass *cc = CCID_CARD_GET_CLASS(card); 1295 USBDevice *dev = USB_DEVICE(qdev->parent_bus->parent); 1296 USBCCIDState *s = USB_CCID_DEV(dev); 1297 Error *local_err = NULL; 1298 1299 if (card->slot != 0) { 1300 error_setg(errp, "usb-ccid supports one slot, can't add %d", 1301 card->slot); 1302 return; 1303 } 1304 if (s->card != NULL) { 1305 error_setg(errp, "usb-ccid card already full, not adding"); 1306 return; 1307 } 1308 if (cc->realize) { 1309 cc->realize(card, &local_err); 1310 if (local_err != NULL) { 1311 error_propagate(errp, local_err); 1312 return; 1313 } 1314 } 1315 s->card = card; 1316 } 1317 1318 static void ccid_realize(USBDevice *dev, Error **errp) 1319 { 1320 USBCCIDState *s = USB_CCID_DEV(dev); 1321 1322 usb_desc_create_serial(dev); 1323 usb_desc_init(dev); 1324 qbus_create_inplace(&s->bus, sizeof(s->bus), TYPE_CCID_BUS, DEVICE(dev), 1325 NULL); 1326 qbus_set_hotplug_handler(BUS(&s->bus), OBJECT(dev)); 1327 s->intr = usb_ep_get(dev, USB_TOKEN_IN, CCID_INT_IN_EP); 1328 s->bulk = usb_ep_get(dev, USB_TOKEN_IN, CCID_BULK_IN_EP); 1329 s->card = NULL; 1330 s->dev.speed = USB_SPEED_FULL; 1331 s->dev.speedmask = USB_SPEED_MASK_FULL; 1332 s->notify_slot_change = false; 1333 s->powered = true; 1334 s->pending_answers_num = 0; 1335 s->last_answer_error = 0; 1336 s->bulk_in_pending_start = 0; 1337 s->bulk_in_pending_end = 0; 1338 s->current_bulk_in = NULL; 1339 ccid_reset_error_status(s); 1340 s->bulk_out_pos = 0; 1341 ccid_reset_parameters(s); 1342 ccid_reset(s); 1343 s->debug = parse_debug_env("QEMU_CCID_DEBUG", D_VERBOSE, s->debug); 1344 } 1345 1346 static int ccid_post_load(void *opaque, int version_id) 1347 { 1348 USBCCIDState *s = opaque; 1349 1350 /* 1351 * This must be done after usb_device_attach, which sets state to ATTACHED, 1352 * while it must be DEFAULT in order to accept packets (like it is after 1353 * reset, but reset will reset our addr and call our reset handler which 1354 * may change state, and we don't want to do that when migrating). 1355 */ 1356 s->dev.state = s->state_vmstate; 1357 return 0; 1358 } 1359 1360 static int ccid_pre_save(void *opaque) 1361 { 1362 USBCCIDState *s = opaque; 1363 1364 s->state_vmstate = s->dev.state; 1365 1366 return 0; 1367 } 1368 1369 static VMStateDescription bulk_in_vmstate = { 1370 .name = "CCID BulkIn state", 1371 .version_id = 1, 1372 .minimum_version_id = 1, 1373 .fields = (VMStateField[]) { 1374 VMSTATE_BUFFER(data, BulkIn), 1375 VMSTATE_UINT32(len, BulkIn), 1376 VMSTATE_UINT32(pos, BulkIn), 1377 VMSTATE_END_OF_LIST() 1378 } 1379 }; 1380 1381 static VMStateDescription answer_vmstate = { 1382 .name = "CCID Answer state", 1383 .version_id = 1, 1384 .minimum_version_id = 1, 1385 .fields = (VMStateField[]) { 1386 VMSTATE_UINT8(slot, Answer), 1387 VMSTATE_UINT8(seq, Answer), 1388 VMSTATE_END_OF_LIST() 1389 } 1390 }; 1391 1392 static VMStateDescription usb_device_vmstate = { 1393 .name = "usb_device", 1394 .version_id = 1, 1395 .minimum_version_id = 1, 1396 .fields = (VMStateField[]) { 1397 VMSTATE_UINT8(addr, USBDevice), 1398 VMSTATE_BUFFER(setup_buf, USBDevice), 1399 VMSTATE_BUFFER(data_buf, USBDevice), 1400 VMSTATE_END_OF_LIST() 1401 } 1402 }; 1403 1404 static VMStateDescription ccid_vmstate = { 1405 .name = "usb-ccid", 1406 .version_id = 1, 1407 .minimum_version_id = 1, 1408 .post_load = ccid_post_load, 1409 .pre_save = ccid_pre_save, 1410 .fields = (VMStateField[]) { 1411 VMSTATE_STRUCT(dev, USBCCIDState, 1, usb_device_vmstate, USBDevice), 1412 VMSTATE_UINT8(debug, USBCCIDState), 1413 VMSTATE_BUFFER(bulk_out_data, USBCCIDState), 1414 VMSTATE_UINT32(bulk_out_pos, USBCCIDState), 1415 VMSTATE_UINT8(bmSlotICCState, USBCCIDState), 1416 VMSTATE_UINT8(powered, USBCCIDState), 1417 VMSTATE_UINT8(notify_slot_change, USBCCIDState), 1418 VMSTATE_UINT64(last_answer_error, USBCCIDState), 1419 VMSTATE_UINT8(bError, USBCCIDState), 1420 VMSTATE_UINT8(bmCommandStatus, USBCCIDState), 1421 VMSTATE_UINT8(bProtocolNum, USBCCIDState), 1422 VMSTATE_BUFFER(abProtocolDataStructure.data, USBCCIDState), 1423 VMSTATE_UINT32(ulProtocolDataStructureSize, USBCCIDState), 1424 VMSTATE_STRUCT_ARRAY(bulk_in_pending, USBCCIDState, 1425 BULK_IN_PENDING_NUM, 1, bulk_in_vmstate, BulkIn), 1426 VMSTATE_UINT32(bulk_in_pending_start, USBCCIDState), 1427 VMSTATE_UINT32(bulk_in_pending_end, USBCCIDState), 1428 VMSTATE_STRUCT_ARRAY(pending_answers, USBCCIDState, 1429 PENDING_ANSWERS_NUM, 1, answer_vmstate, Answer), 1430 VMSTATE_UINT32(pending_answers_num, USBCCIDState), 1431 VMSTATE_UNUSED(1), /* was migration_state */ 1432 VMSTATE_UINT32(state_vmstate, USBCCIDState), 1433 VMSTATE_END_OF_LIST() 1434 } 1435 }; 1436 1437 static Property ccid_properties[] = { 1438 DEFINE_PROP_UINT8("debug", USBCCIDState, debug, 0), 1439 DEFINE_PROP_END_OF_LIST(), 1440 }; 1441 1442 static void ccid_class_initfn(ObjectClass *klass, void *data) 1443 { 1444 DeviceClass *dc = DEVICE_CLASS(klass); 1445 USBDeviceClass *uc = USB_DEVICE_CLASS(klass); 1446 HotplugHandlerClass *hc = HOTPLUG_HANDLER_CLASS(klass); 1447 1448 uc->realize = ccid_realize; 1449 uc->product_desc = "QEMU USB CCID"; 1450 uc->usb_desc = &desc_ccid; 1451 uc->handle_reset = ccid_handle_reset; 1452 uc->handle_control = ccid_handle_control; 1453 uc->handle_data = ccid_handle_data; 1454 uc->unrealize = ccid_unrealize; 1455 dc->desc = "CCID Rev 1.1 smartcard reader"; 1456 dc->vmsd = &ccid_vmstate; 1457 device_class_set_props(dc, ccid_properties); 1458 set_bit(DEVICE_CATEGORY_INPUT, dc->categories); 1459 hc->unplug = qdev_simple_device_unplug_cb; 1460 } 1461 1462 static const TypeInfo ccid_info = { 1463 .name = CCID_DEV_NAME, 1464 .parent = TYPE_USB_DEVICE, 1465 .instance_size = sizeof(USBCCIDState), 1466 .class_init = ccid_class_initfn, 1467 .interfaces = (InterfaceInfo[]) { 1468 { TYPE_HOTPLUG_HANDLER }, 1469 { } 1470 } 1471 }; 1472 1473 static void ccid_card_class_init(ObjectClass *klass, void *data) 1474 { 1475 DeviceClass *k = DEVICE_CLASS(klass); 1476 k->bus_type = TYPE_CCID_BUS; 1477 k->realize = ccid_card_realize; 1478 k->unrealize = ccid_card_unrealize; 1479 device_class_set_props(k, ccid_props); 1480 } 1481 1482 static const TypeInfo ccid_card_type_info = { 1483 .name = TYPE_CCID_CARD, 1484 .parent = TYPE_DEVICE, 1485 .instance_size = sizeof(CCIDCardState), 1486 .abstract = true, 1487 .class_size = sizeof(CCIDCardClass), 1488 .class_init = ccid_card_class_init, 1489 }; 1490 1491 static void ccid_register_types(void) 1492 { 1493 type_register_static(&ccid_bus_info); 1494 type_register_static(&ccid_card_type_info); 1495 type_register_static(&ccid_info); 1496 usb_legacy_register(CCID_DEV_NAME, "ccid", NULL); 1497 } 1498 1499 type_init(ccid_register_types) 1500