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