hw/usb-ccid.c

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