1f1ae32a1SGerd Hoffmann /* 2f1ae32a1SGerd Hoffmann * Copyright (C) 2011 Red Hat, Inc. 3f1ae32a1SGerd Hoffmann * 4f1ae32a1SGerd Hoffmann * CCID Device emulation 5f1ae32a1SGerd Hoffmann * 6f1ae32a1SGerd Hoffmann * Written by Alon Levy, with contributions from Robert Relyea. 7f1ae32a1SGerd Hoffmann * 8f1ae32a1SGerd Hoffmann * Based on usb-serial.c, see its copyright and attributions below. 9f1ae32a1SGerd Hoffmann * 10f1ae32a1SGerd Hoffmann * This work is licensed under the terms of the GNU GPL, version 2.1 or later. 11f1ae32a1SGerd Hoffmann * See the COPYING file in the top-level directory. 12f1ae32a1SGerd Hoffmann * ------- (original copyright & attribution for usb-serial.c below) -------- 13f1ae32a1SGerd Hoffmann * Copyright (c) 2006 CodeSourcery. 14f1ae32a1SGerd Hoffmann * Copyright (c) 2008 Samuel Thibault <samuel.thibault@ens-lyon.org> 15f1ae32a1SGerd Hoffmann * Written by Paul Brook, reused for FTDI by Samuel Thibault, 16f1ae32a1SGerd Hoffmann */ 17f1ae32a1SGerd Hoffmann 18f1ae32a1SGerd Hoffmann /* 19f1ae32a1SGerd Hoffmann * References: 20f1ae32a1SGerd Hoffmann * 21f1ae32a1SGerd Hoffmann * CCID Specification Revision 1.1 April 22nd 2005 22f1ae32a1SGerd Hoffmann * "Universal Serial Bus, Device Class: Smart Card" 23f1ae32a1SGerd Hoffmann * Specification for Integrated Circuit(s) Cards Interface Devices 24f1ae32a1SGerd Hoffmann * 25f1ae32a1SGerd Hoffmann * Endianness note: from the spec (1.3) 26f1ae32a1SGerd Hoffmann * "Fields that are larger than a byte are stored in little endian" 27f1ae32a1SGerd Hoffmann * 28f1ae32a1SGerd Hoffmann * KNOWN BUGS 29f1ae32a1SGerd Hoffmann * 1. remove/insert can sometimes result in removed state instead of inserted. 30f1ae32a1SGerd Hoffmann * This is a result of the following: 31f1ae32a1SGerd Hoffmann * symptom: dmesg shows ERMOTEIO (-121), pcscd shows -99. This can happen 32f1ae32a1SGerd Hoffmann * when a short packet is sent, as seen in uhci-usb.c, resulting from a urb 33f1ae32a1SGerd Hoffmann * from the guest requesting SPD and us returning a smaller packet. 34f1ae32a1SGerd Hoffmann * Not sure which messages trigger this. 35f1ae32a1SGerd Hoffmann */ 36f1ae32a1SGerd Hoffmann 37f1ae32a1SGerd Hoffmann #include "qemu-common.h" 381de7afc9SPaolo Bonzini #include "qemu/error-report.h" 39f1ae32a1SGerd Hoffmann #include "hw/usb.h" 40f1ae32a1SGerd Hoffmann #include "hw/usb/desc.h" 4183c9089eSPaolo Bonzini #include "monitor/monitor.h" 42f1ae32a1SGerd Hoffmann 4347b43a1fSPaolo Bonzini #include "ccid.h" 44f1ae32a1SGerd Hoffmann 45f1ae32a1SGerd Hoffmann #define DPRINTF(s, lvl, fmt, ...) \ 46f1ae32a1SGerd Hoffmann do { \ 47f1ae32a1SGerd Hoffmann if (lvl <= s->debug) { \ 48f1ae32a1SGerd Hoffmann printf("usb-ccid: " fmt , ## __VA_ARGS__); \ 49f1ae32a1SGerd Hoffmann } \ 50f1ae32a1SGerd Hoffmann } while (0) 51f1ae32a1SGerd Hoffmann 52f1ae32a1SGerd Hoffmann #define D_WARN 1 53f1ae32a1SGerd Hoffmann #define D_INFO 2 54f1ae32a1SGerd Hoffmann #define D_MORE_INFO 3 55f1ae32a1SGerd Hoffmann #define D_VERBOSE 4 56f1ae32a1SGerd Hoffmann 57f1ae32a1SGerd Hoffmann #define CCID_DEV_NAME "usb-ccid" 58*61b4887bSGonglei #define USB_CCID_DEV(obj) OBJECT_CHECK(USBCCIDState, (obj), CCID_DEV_NAME) 59f1ae32a1SGerd Hoffmann /* 60f1ae32a1SGerd Hoffmann * The two options for variable sized buffers: 61f1ae32a1SGerd Hoffmann * make them constant size, for large enough constant, 62f1ae32a1SGerd Hoffmann * or handle the migration complexity - VMState doesn't handle this case. 63f1ae32a1SGerd Hoffmann * sizes are expected never to be exceeded, unless guest misbehaves. 64f1ae32a1SGerd Hoffmann */ 65f1ae32a1SGerd Hoffmann #define BULK_OUT_DATA_SIZE 65536 66f1ae32a1SGerd Hoffmann #define PENDING_ANSWERS_NUM 128 67f1ae32a1SGerd Hoffmann 68f1ae32a1SGerd Hoffmann #define BULK_IN_BUF_SIZE 384 69f1ae32a1SGerd Hoffmann #define BULK_IN_PENDING_NUM 8 70f1ae32a1SGerd Hoffmann 71f1ae32a1SGerd Hoffmann #define CCID_MAX_PACKET_SIZE 64 72f1ae32a1SGerd Hoffmann 73f1ae32a1SGerd Hoffmann #define CCID_CONTROL_ABORT 0x1 74f1ae32a1SGerd Hoffmann #define CCID_CONTROL_GET_CLOCK_FREQUENCIES 0x2 75f1ae32a1SGerd Hoffmann #define CCID_CONTROL_GET_DATA_RATES 0x3 76f1ae32a1SGerd Hoffmann 77f1ae32a1SGerd Hoffmann #define CCID_PRODUCT_DESCRIPTION "QEMU USB CCID" 7893bfef4cSCrístian Viana #define CCID_VENDOR_DESCRIPTION "QEMU" 79f1ae32a1SGerd Hoffmann #define CCID_INTERFACE_NAME "CCID Interface" 80f1ae32a1SGerd Hoffmann #define CCID_SERIAL_NUMBER_STRING "1" 81f1ae32a1SGerd Hoffmann /* 82f1ae32a1SGerd Hoffmann * Using Gemplus Vendor and Product id 83f1ae32a1SGerd Hoffmann * Effect on various drivers: 84f1ae32a1SGerd Hoffmann * usbccid.sys (winxp, others untested) is a class driver so it doesn't care. 85f1ae32a1SGerd Hoffmann * linux has a number of class drivers, but openct filters based on 86f1ae32a1SGerd Hoffmann * vendor/product (/etc/openct.conf under fedora), hence Gemplus. 87f1ae32a1SGerd Hoffmann */ 88f1ae32a1SGerd Hoffmann #define CCID_VENDOR_ID 0x08e6 89f1ae32a1SGerd Hoffmann #define CCID_PRODUCT_ID 0x4433 90f1ae32a1SGerd Hoffmann #define CCID_DEVICE_VERSION 0x0000 91f1ae32a1SGerd Hoffmann 92f1ae32a1SGerd Hoffmann /* 93f1ae32a1SGerd Hoffmann * BULK_OUT messages from PC to Reader 94f1ae32a1SGerd Hoffmann * Defined in CCID Rev 1.1 6.1 (page 26) 95f1ae32a1SGerd Hoffmann */ 96f1ae32a1SGerd Hoffmann #define CCID_MESSAGE_TYPE_PC_to_RDR_IccPowerOn 0x62 97f1ae32a1SGerd Hoffmann #define CCID_MESSAGE_TYPE_PC_to_RDR_IccPowerOff 0x63 98f1ae32a1SGerd Hoffmann #define CCID_MESSAGE_TYPE_PC_to_RDR_GetSlotStatus 0x65 99f1ae32a1SGerd Hoffmann #define CCID_MESSAGE_TYPE_PC_to_RDR_XfrBlock 0x6f 100f1ae32a1SGerd Hoffmann #define CCID_MESSAGE_TYPE_PC_to_RDR_GetParameters 0x6c 101f1ae32a1SGerd Hoffmann #define CCID_MESSAGE_TYPE_PC_to_RDR_ResetParameters 0x6d 102f1ae32a1SGerd Hoffmann #define CCID_MESSAGE_TYPE_PC_to_RDR_SetParameters 0x61 103f1ae32a1SGerd Hoffmann #define CCID_MESSAGE_TYPE_PC_to_RDR_Escape 0x6b 104f1ae32a1SGerd Hoffmann #define CCID_MESSAGE_TYPE_PC_to_RDR_IccClock 0x6e 105f1ae32a1SGerd Hoffmann #define CCID_MESSAGE_TYPE_PC_to_RDR_T0APDU 0x6a 106f1ae32a1SGerd Hoffmann #define CCID_MESSAGE_TYPE_PC_to_RDR_Secure 0x69 107f1ae32a1SGerd Hoffmann #define CCID_MESSAGE_TYPE_PC_to_RDR_Mechanical 0x71 108f1ae32a1SGerd Hoffmann #define CCID_MESSAGE_TYPE_PC_to_RDR_Abort 0x72 109f1ae32a1SGerd Hoffmann #define CCID_MESSAGE_TYPE_PC_to_RDR_SetDataRateAndClockFrequency 0x73 110f1ae32a1SGerd Hoffmann 111f1ae32a1SGerd Hoffmann /* 112f1ae32a1SGerd Hoffmann * BULK_IN messages from Reader to PC 113f1ae32a1SGerd Hoffmann * Defined in CCID Rev 1.1 6.2 (page 48) 114f1ae32a1SGerd Hoffmann */ 115f1ae32a1SGerd Hoffmann #define CCID_MESSAGE_TYPE_RDR_to_PC_DataBlock 0x80 116f1ae32a1SGerd Hoffmann #define CCID_MESSAGE_TYPE_RDR_to_PC_SlotStatus 0x81 117f1ae32a1SGerd Hoffmann #define CCID_MESSAGE_TYPE_RDR_to_PC_Parameters 0x82 118f1ae32a1SGerd Hoffmann #define CCID_MESSAGE_TYPE_RDR_to_PC_Escape 0x83 119f1ae32a1SGerd Hoffmann #define CCID_MESSAGE_TYPE_RDR_to_PC_DataRateAndClockFrequency 0x84 120f1ae32a1SGerd Hoffmann 121f1ae32a1SGerd Hoffmann /* 122f1ae32a1SGerd Hoffmann * INTERRUPT_IN messages from Reader to PC 123f1ae32a1SGerd Hoffmann * Defined in CCID Rev 1.1 6.3 (page 56) 124f1ae32a1SGerd Hoffmann */ 125f1ae32a1SGerd Hoffmann #define CCID_MESSAGE_TYPE_RDR_to_PC_NotifySlotChange 0x50 126f1ae32a1SGerd Hoffmann #define CCID_MESSAGE_TYPE_RDR_to_PC_HardwareError 0x51 127f1ae32a1SGerd Hoffmann 128f1ae32a1SGerd Hoffmann /* 129f1ae32a1SGerd Hoffmann * Endpoints for CCID - addresses are up to us to decide. 130f1ae32a1SGerd Hoffmann * To support slot insertion and removal we must have an interrupt in ep 131f1ae32a1SGerd Hoffmann * in addition we need a bulk in and bulk out ep 132f1ae32a1SGerd Hoffmann * 5.2, page 20 133f1ae32a1SGerd Hoffmann */ 134f1ae32a1SGerd Hoffmann #define CCID_INT_IN_EP 1 135f1ae32a1SGerd Hoffmann #define CCID_BULK_IN_EP 2 136f1ae32a1SGerd Hoffmann #define CCID_BULK_OUT_EP 3 137f1ae32a1SGerd Hoffmann 138f1ae32a1SGerd Hoffmann /* bmSlotICCState masks */ 139f1ae32a1SGerd Hoffmann #define SLOT_0_STATE_MASK 1 140f1ae32a1SGerd Hoffmann #define SLOT_0_CHANGED_MASK 2 141f1ae32a1SGerd Hoffmann 142f1ae32a1SGerd Hoffmann /* Status codes that go in bStatus (see 6.2.6) */ 143f1ae32a1SGerd Hoffmann enum { 144f1ae32a1SGerd Hoffmann ICC_STATUS_PRESENT_ACTIVE = 0, 145f1ae32a1SGerd Hoffmann ICC_STATUS_PRESENT_INACTIVE, 146f1ae32a1SGerd Hoffmann ICC_STATUS_NOT_PRESENT 147f1ae32a1SGerd Hoffmann }; 148f1ae32a1SGerd Hoffmann 149f1ae32a1SGerd Hoffmann enum { 150f1ae32a1SGerd Hoffmann COMMAND_STATUS_NO_ERROR = 0, 151f1ae32a1SGerd Hoffmann COMMAND_STATUS_FAILED, 152f1ae32a1SGerd Hoffmann COMMAND_STATUS_TIME_EXTENSION_REQUIRED 153f1ae32a1SGerd Hoffmann }; 154f1ae32a1SGerd Hoffmann 155f1ae32a1SGerd Hoffmann /* Error codes that go in bError (see 6.2.6) */ 156f1ae32a1SGerd Hoffmann enum { 157f1ae32a1SGerd Hoffmann ERROR_CMD_NOT_SUPPORTED = 0, 158f1ae32a1SGerd Hoffmann ERROR_CMD_ABORTED = -1, 159f1ae32a1SGerd Hoffmann ERROR_ICC_MUTE = -2, 160f1ae32a1SGerd Hoffmann ERROR_XFR_PARITY_ERROR = -3, 161f1ae32a1SGerd Hoffmann ERROR_XFR_OVERRUN = -4, 162f1ae32a1SGerd Hoffmann ERROR_HW_ERROR = -5, 163f1ae32a1SGerd Hoffmann }; 164f1ae32a1SGerd Hoffmann 165f1ae32a1SGerd Hoffmann /* 6.2.6 RDR_to_PC_SlotStatus definitions */ 166f1ae32a1SGerd Hoffmann enum { 167f1ae32a1SGerd Hoffmann CLOCK_STATUS_RUNNING = 0, 168f1ae32a1SGerd Hoffmann /* 169f1ae32a1SGerd Hoffmann * 0 - Clock Running, 1 - Clock stopped in State L, 2 - H, 170f1ae32a1SGerd Hoffmann * 3 - unknown state. rest are RFU 171f1ae32a1SGerd Hoffmann */ 172f1ae32a1SGerd Hoffmann }; 173f1ae32a1SGerd Hoffmann 174f1ae32a1SGerd Hoffmann typedef struct QEMU_PACKED CCID_Header { 175f1ae32a1SGerd Hoffmann uint8_t bMessageType; 176f1ae32a1SGerd Hoffmann uint32_t dwLength; 177f1ae32a1SGerd Hoffmann uint8_t bSlot; 178f1ae32a1SGerd Hoffmann uint8_t bSeq; 179f1ae32a1SGerd Hoffmann } CCID_Header; 180f1ae32a1SGerd Hoffmann 181f1ae32a1SGerd Hoffmann typedef struct QEMU_PACKED CCID_BULK_IN { 182f1ae32a1SGerd Hoffmann CCID_Header hdr; 183f1ae32a1SGerd Hoffmann uint8_t bStatus; /* Only used in BULK_IN */ 184f1ae32a1SGerd Hoffmann uint8_t bError; /* Only used in BULK_IN */ 185f1ae32a1SGerd Hoffmann } CCID_BULK_IN; 186f1ae32a1SGerd Hoffmann 187f1ae32a1SGerd Hoffmann typedef struct QEMU_PACKED CCID_SlotStatus { 188f1ae32a1SGerd Hoffmann CCID_BULK_IN b; 189f1ae32a1SGerd Hoffmann uint8_t bClockStatus; 190f1ae32a1SGerd Hoffmann } CCID_SlotStatus; 191f1ae32a1SGerd Hoffmann 1924942d6c3SAlon Levy typedef struct QEMU_PACKED CCID_T0ProtocolDataStructure { 1934942d6c3SAlon Levy uint8_t bmFindexDindex; 1944942d6c3SAlon Levy uint8_t bmTCCKST0; 1954942d6c3SAlon Levy uint8_t bGuardTimeT0; 1964942d6c3SAlon Levy uint8_t bWaitingIntegerT0; 1974942d6c3SAlon Levy uint8_t bClockStop; 1984942d6c3SAlon Levy } CCID_T0ProtocolDataStructure; 1994942d6c3SAlon Levy 2004942d6c3SAlon Levy typedef struct QEMU_PACKED CCID_T1ProtocolDataStructure { 2014942d6c3SAlon Levy uint8_t bmFindexDindex; 2024942d6c3SAlon Levy uint8_t bmTCCKST1; 2034942d6c3SAlon Levy uint8_t bGuardTimeT1; 2044942d6c3SAlon Levy uint8_t bWaitingIntegerT1; 2054942d6c3SAlon Levy uint8_t bClockStop; 2064942d6c3SAlon Levy uint8_t bIFSC; 2074942d6c3SAlon Levy uint8_t bNadValue; 2084942d6c3SAlon Levy } CCID_T1ProtocolDataStructure; 2094942d6c3SAlon Levy 2104942d6c3SAlon Levy typedef union CCID_ProtocolDataStructure { 2114942d6c3SAlon Levy CCID_T0ProtocolDataStructure t0; 2124942d6c3SAlon Levy CCID_T1ProtocolDataStructure t1; 2134942d6c3SAlon Levy uint8_t data[7]; /* must be = max(sizeof(t0), sizeof(t1)) */ 2144942d6c3SAlon Levy } CCID_ProtocolDataStructure; 2154942d6c3SAlon Levy 216f1ae32a1SGerd Hoffmann typedef struct QEMU_PACKED CCID_Parameter { 217f1ae32a1SGerd Hoffmann CCID_BULK_IN b; 218f1ae32a1SGerd Hoffmann uint8_t bProtocolNum; 2194942d6c3SAlon Levy CCID_ProtocolDataStructure abProtocolDataStructure; 220f1ae32a1SGerd Hoffmann } CCID_Parameter; 221f1ae32a1SGerd Hoffmann 222f1ae32a1SGerd Hoffmann typedef struct QEMU_PACKED CCID_DataBlock { 223f1ae32a1SGerd Hoffmann CCID_BULK_IN b; 224f1ae32a1SGerd Hoffmann uint8_t bChainParameter; 225f1ae32a1SGerd Hoffmann uint8_t abData[0]; 226f1ae32a1SGerd Hoffmann } CCID_DataBlock; 227f1ae32a1SGerd Hoffmann 228f1ae32a1SGerd Hoffmann /* 6.1.4 PC_to_RDR_XfrBlock */ 229f1ae32a1SGerd Hoffmann typedef struct QEMU_PACKED CCID_XferBlock { 230f1ae32a1SGerd Hoffmann CCID_Header hdr; 231f1ae32a1SGerd Hoffmann uint8_t bBWI; /* Block Waiting Timeout */ 232f1ae32a1SGerd Hoffmann uint16_t wLevelParameter; /* XXX currently unused */ 233f1ae32a1SGerd Hoffmann uint8_t abData[0]; 234f1ae32a1SGerd Hoffmann } CCID_XferBlock; 235f1ae32a1SGerd Hoffmann 236f1ae32a1SGerd Hoffmann typedef struct QEMU_PACKED CCID_IccPowerOn { 237f1ae32a1SGerd Hoffmann CCID_Header hdr; 238f1ae32a1SGerd Hoffmann uint8_t bPowerSelect; 239f1ae32a1SGerd Hoffmann uint16_t abRFU; 240f1ae32a1SGerd Hoffmann } CCID_IccPowerOn; 241f1ae32a1SGerd Hoffmann 242f1ae32a1SGerd Hoffmann typedef struct QEMU_PACKED CCID_IccPowerOff { 243f1ae32a1SGerd Hoffmann CCID_Header hdr; 244f1ae32a1SGerd Hoffmann uint16_t abRFU; 245f1ae32a1SGerd Hoffmann } CCID_IccPowerOff; 246f1ae32a1SGerd Hoffmann 247f1ae32a1SGerd Hoffmann typedef struct QEMU_PACKED CCID_SetParameters { 248f1ae32a1SGerd Hoffmann CCID_Header hdr; 249f1ae32a1SGerd Hoffmann uint8_t bProtocolNum; 250f1ae32a1SGerd Hoffmann uint16_t abRFU; 2514942d6c3SAlon Levy CCID_ProtocolDataStructure abProtocolDataStructure; 252f1ae32a1SGerd Hoffmann } CCID_SetParameters; 253f1ae32a1SGerd Hoffmann 254f1ae32a1SGerd Hoffmann typedef struct CCID_Notify_Slot_Change { 255f1ae32a1SGerd Hoffmann uint8_t bMessageType; /* CCID_MESSAGE_TYPE_RDR_to_PC_NotifySlotChange */ 256f1ae32a1SGerd Hoffmann uint8_t bmSlotICCState; 257f1ae32a1SGerd Hoffmann } CCID_Notify_Slot_Change; 258f1ae32a1SGerd Hoffmann 259f1ae32a1SGerd Hoffmann /* used for DataBlock response to XferBlock */ 260f1ae32a1SGerd Hoffmann typedef struct Answer { 261f1ae32a1SGerd Hoffmann uint8_t slot; 262f1ae32a1SGerd Hoffmann uint8_t seq; 263f1ae32a1SGerd Hoffmann } Answer; 264f1ae32a1SGerd Hoffmann 265f1ae32a1SGerd Hoffmann /* pending BULK_IN messages */ 266f1ae32a1SGerd Hoffmann typedef struct BulkIn { 267f1ae32a1SGerd Hoffmann uint8_t data[BULK_IN_BUF_SIZE]; 268f1ae32a1SGerd Hoffmann uint32_t len; 269f1ae32a1SGerd Hoffmann uint32_t pos; 270f1ae32a1SGerd Hoffmann } BulkIn; 271f1ae32a1SGerd Hoffmann 272f1ae32a1SGerd Hoffmann enum { 273f1ae32a1SGerd Hoffmann MIGRATION_NONE, 274f1ae32a1SGerd Hoffmann MIGRATION_MIGRATED, 275f1ae32a1SGerd Hoffmann }; 276f1ae32a1SGerd Hoffmann 277f1ae32a1SGerd Hoffmann typedef struct CCIDBus { 278f1ae32a1SGerd Hoffmann BusState qbus; 279f1ae32a1SGerd Hoffmann } CCIDBus; 280f1ae32a1SGerd Hoffmann 281f1ae32a1SGerd Hoffmann /* 282f1ae32a1SGerd Hoffmann * powered - defaults to true, changed by PowerOn/PowerOff messages 283f1ae32a1SGerd Hoffmann */ 284f1ae32a1SGerd Hoffmann typedef struct USBCCIDState { 285f1ae32a1SGerd Hoffmann USBDevice dev; 286f1ae32a1SGerd Hoffmann USBEndpoint *intr; 287f1ae32a1SGerd Hoffmann CCIDBus bus; 288f1ae32a1SGerd Hoffmann CCIDCardState *card; 289f1ae32a1SGerd Hoffmann BulkIn bulk_in_pending[BULK_IN_PENDING_NUM]; /* circular */ 290f1ae32a1SGerd Hoffmann uint32_t bulk_in_pending_start; 291f1ae32a1SGerd Hoffmann uint32_t bulk_in_pending_end; /* first free */ 292f1ae32a1SGerd Hoffmann uint32_t bulk_in_pending_num; 293f1ae32a1SGerd Hoffmann BulkIn *current_bulk_in; 294f1ae32a1SGerd Hoffmann uint8_t bulk_out_data[BULK_OUT_DATA_SIZE]; 295f1ae32a1SGerd Hoffmann uint32_t bulk_out_pos; 296f1ae32a1SGerd Hoffmann uint64_t last_answer_error; 297f1ae32a1SGerd Hoffmann Answer pending_answers[PENDING_ANSWERS_NUM]; 298f1ae32a1SGerd Hoffmann uint32_t pending_answers_start; 299f1ae32a1SGerd Hoffmann uint32_t pending_answers_end; 300f1ae32a1SGerd Hoffmann uint32_t pending_answers_num; 301f1ae32a1SGerd Hoffmann uint8_t bError; 302f1ae32a1SGerd Hoffmann uint8_t bmCommandStatus; 303f1ae32a1SGerd Hoffmann uint8_t bProtocolNum; 3044942d6c3SAlon Levy CCID_ProtocolDataStructure abProtocolDataStructure; 305f1ae32a1SGerd Hoffmann uint32_t ulProtocolDataStructureSize; 306f1ae32a1SGerd Hoffmann uint32_t state_vmstate; 307f1ae32a1SGerd Hoffmann uint32_t migration_target_ip; 308f1ae32a1SGerd Hoffmann uint16_t migration_target_port; 309f1ae32a1SGerd Hoffmann uint8_t migration_state; 310f1ae32a1SGerd Hoffmann uint8_t bmSlotICCState; 311f1ae32a1SGerd Hoffmann uint8_t powered; 312f1ae32a1SGerd Hoffmann uint8_t notify_slot_change; 313f1ae32a1SGerd Hoffmann uint8_t debug; 314f1ae32a1SGerd Hoffmann } USBCCIDState; 315f1ae32a1SGerd Hoffmann 316f1ae32a1SGerd Hoffmann /* 317f1ae32a1SGerd Hoffmann * CCID Spec chapter 4: CCID uses a standard device descriptor per Chapter 9, 318f1ae32a1SGerd Hoffmann * "USB Device Framework", section 9.6.1, in the Universal Serial Bus 319f1ae32a1SGerd Hoffmann * Specification. 320f1ae32a1SGerd Hoffmann * 321f1ae32a1SGerd Hoffmann * This device implemented based on the spec and with an Athena Smart Card 322f1ae32a1SGerd Hoffmann * Reader as reference: 323f1ae32a1SGerd Hoffmann * 0dc3:1004 Athena Smartcard Solutions, Inc. 324f1ae32a1SGerd Hoffmann */ 325f1ae32a1SGerd Hoffmann 326f1ae32a1SGerd Hoffmann static const uint8_t qemu_ccid_descriptor[] = { 327f1ae32a1SGerd Hoffmann /* Smart Card Device Class Descriptor */ 328f1ae32a1SGerd Hoffmann 0x36, /* u8 bLength; */ 329f1ae32a1SGerd Hoffmann 0x21, /* u8 bDescriptorType; Functional */ 330f1ae32a1SGerd Hoffmann 0x10, 0x01, /* u16 bcdCCID; CCID Specification Release Number. */ 331f1ae32a1SGerd Hoffmann 0x00, /* 332f1ae32a1SGerd Hoffmann * u8 bMaxSlotIndex; The index of the highest available 333f1ae32a1SGerd Hoffmann * slot on this device. All slots are consecutive starting 334f1ae32a1SGerd Hoffmann * at 00h. 335f1ae32a1SGerd Hoffmann */ 336f1ae32a1SGerd Hoffmann 0x07, /* u8 bVoltageSupport; 01h - 5.0v, 02h - 3.0, 03 - 1.8 */ 337f1ae32a1SGerd Hoffmann 338d7d218efSAlon Levy 0x00, 0x00, /* u32 dwProtocols; RRRR PPPP. RRRR = 0000h.*/ 339d7d218efSAlon Levy 0x01, 0x00, /* PPPP: 0001h = Protocol T=0, 0002h = Protocol T=1 */ 340f1ae32a1SGerd Hoffmann /* u32 dwDefaultClock; in kHZ (0x0fa0 is 4 MHz) */ 341f1ae32a1SGerd Hoffmann 0xa0, 0x0f, 0x00, 0x00, 342f1ae32a1SGerd Hoffmann /* u32 dwMaximumClock; */ 343f1ae32a1SGerd Hoffmann 0x00, 0x00, 0x01, 0x00, 344f1ae32a1SGerd Hoffmann 0x00, /* u8 bNumClockSupported; * 345f1ae32a1SGerd Hoffmann * 0 means just the default and max. */ 346f1ae32a1SGerd Hoffmann /* u32 dwDataRate ;bps. 9600 == 00002580h */ 347f1ae32a1SGerd Hoffmann 0x80, 0x25, 0x00, 0x00, 348f1ae32a1SGerd Hoffmann /* u32 dwMaxDataRate ; 11520 bps == 0001C200h */ 349f1ae32a1SGerd Hoffmann 0x00, 0xC2, 0x01, 0x00, 350f1ae32a1SGerd Hoffmann 0x00, /* u8 bNumDataRatesSupported; 00 means all rates between 351f1ae32a1SGerd Hoffmann * default and max */ 352f1ae32a1SGerd Hoffmann /* u32 dwMaxIFSD; * 353f1ae32a1SGerd Hoffmann * maximum IFSD supported by CCID for protocol * 354f1ae32a1SGerd Hoffmann * T=1 (Maximum seen from various cards) */ 355f1ae32a1SGerd Hoffmann 0xfe, 0x00, 0x00, 0x00, 356f1ae32a1SGerd Hoffmann /* u32 dwSyncProtocols; 1 - 2-wire, 2 - 3-wire, 4 - I2C */ 357f1ae32a1SGerd Hoffmann 0x00, 0x00, 0x00, 0x00, 358f1ae32a1SGerd Hoffmann /* u32 dwMechanical; 0 - no special characteristics. */ 359f1ae32a1SGerd Hoffmann 0x00, 0x00, 0x00, 0x00, 360f1ae32a1SGerd Hoffmann /* 361f1ae32a1SGerd Hoffmann * u32 dwFeatures; 362f1ae32a1SGerd Hoffmann * 0 - No special characteristics 363f1ae32a1SGerd Hoffmann * + 2 Automatic parameter configuration based on ATR data 364f1ae32a1SGerd Hoffmann * + 4 Automatic activation of ICC on inserting 365f1ae32a1SGerd Hoffmann * + 8 Automatic ICC voltage selection 366f1ae32a1SGerd Hoffmann * + 10 Automatic ICC clock frequency change 367f1ae32a1SGerd Hoffmann * + 20 Automatic baud rate change 368f1ae32a1SGerd Hoffmann * + 40 Automatic parameters negotiation made by the CCID 369f1ae32a1SGerd Hoffmann * + 80 automatic PPS made by the CCID 370f1ae32a1SGerd Hoffmann * 100 CCID can set ICC in clock stop mode 371f1ae32a1SGerd Hoffmann * 200 NAD value other then 00 accepted (T=1 protocol) 372f1ae32a1SGerd Hoffmann * + 400 Automatic IFSD exchange as first exchange (T=1) 373f1ae32a1SGerd Hoffmann * One of the following only: 374f1ae32a1SGerd Hoffmann * + 10000 TPDU level exchanges with CCID 375f1ae32a1SGerd Hoffmann * 20000 Short APDU level exchange with CCID 376f1ae32a1SGerd Hoffmann * 40000 Short and Extended APDU level exchange with CCID 377f1ae32a1SGerd Hoffmann * 378c5cd7c87SAlon Levy * 100000 USB Wake up signaling supported on card 379f1ae32a1SGerd Hoffmann * insertion and removal. Must set bit 5 in bmAttributes 380f1ae32a1SGerd Hoffmann * in Configuration descriptor if 100000 is set. 381f1ae32a1SGerd Hoffmann */ 382c5cd7c87SAlon Levy 0xfe, 0x04, 0x01, 0x00, 383f1ae32a1SGerd Hoffmann /* 384f1ae32a1SGerd Hoffmann * u32 dwMaxCCIDMessageLength; For extended APDU in 385f1ae32a1SGerd Hoffmann * [261 + 10 , 65544 + 10]. Otherwise the minimum is 386f1ae32a1SGerd Hoffmann * wMaxPacketSize of the Bulk-OUT endpoint 387f1ae32a1SGerd Hoffmann */ 388f1ae32a1SGerd Hoffmann 0x12, 0x00, 0x01, 0x00, 389f1ae32a1SGerd Hoffmann 0xFF, /* 390f1ae32a1SGerd Hoffmann * u8 bClassGetResponse; Significant only for CCID that 391f1ae32a1SGerd Hoffmann * offers an APDU level for exchanges. Indicates the 392f1ae32a1SGerd Hoffmann * default class value used by the CCID when it sends a 393f1ae32a1SGerd Hoffmann * Get Response command to perform the transportation of 394f1ae32a1SGerd Hoffmann * an APDU by T=0 protocol 395f1ae32a1SGerd Hoffmann * FFh indicates that the CCID echos the class of the APDU. 396f1ae32a1SGerd Hoffmann */ 397f1ae32a1SGerd Hoffmann 0xFF, /* 398f1ae32a1SGerd Hoffmann * u8 bClassEnvelope; EAPDU only. Envelope command for 399f1ae32a1SGerd Hoffmann * T=0 400f1ae32a1SGerd Hoffmann */ 401f1ae32a1SGerd Hoffmann 0x00, 0x00, /* 402f1ae32a1SGerd Hoffmann * u16 wLcdLayout; XXYY Number of lines (XX) and chars per 403f1ae32a1SGerd Hoffmann * line for LCD display used for PIN entry. 0000 - no LCD 404f1ae32a1SGerd Hoffmann */ 405f1ae32a1SGerd Hoffmann 0x01, /* 406f1ae32a1SGerd Hoffmann * u8 bPINSupport; 01h PIN Verification, 407f1ae32a1SGerd Hoffmann * 02h PIN Modification 408f1ae32a1SGerd Hoffmann */ 409f1ae32a1SGerd Hoffmann 0x01, /* u8 bMaxCCIDBusySlots; */ 410f1ae32a1SGerd Hoffmann }; 411f1ae32a1SGerd Hoffmann 412f1ae32a1SGerd Hoffmann enum { 413f1ae32a1SGerd Hoffmann STR_MANUFACTURER = 1, 414f1ae32a1SGerd Hoffmann STR_PRODUCT, 415f1ae32a1SGerd Hoffmann STR_SERIALNUMBER, 416f1ae32a1SGerd Hoffmann STR_INTERFACE, 417f1ae32a1SGerd Hoffmann }; 418f1ae32a1SGerd Hoffmann 419f1ae32a1SGerd Hoffmann static const USBDescStrings desc_strings = { 42093bfef4cSCrístian Viana [STR_MANUFACTURER] = "QEMU", 421f1ae32a1SGerd Hoffmann [STR_PRODUCT] = "QEMU USB CCID", 422f1ae32a1SGerd Hoffmann [STR_SERIALNUMBER] = "1", 423f1ae32a1SGerd Hoffmann [STR_INTERFACE] = "CCID Interface", 424f1ae32a1SGerd Hoffmann }; 425f1ae32a1SGerd Hoffmann 426f1ae32a1SGerd Hoffmann static const USBDescIface desc_iface0 = { 427f1ae32a1SGerd Hoffmann .bInterfaceNumber = 0, 428f1ae32a1SGerd Hoffmann .bNumEndpoints = 3, 429693e4773SAlon Levy .bInterfaceClass = USB_CLASS_CSCID, 430693e4773SAlon Levy .bInterfaceSubClass = USB_SUBCLASS_UNDEFINED, 431f1ae32a1SGerd Hoffmann .bInterfaceProtocol = 0x00, 432f1ae32a1SGerd Hoffmann .iInterface = STR_INTERFACE, 433f1ae32a1SGerd Hoffmann .ndesc = 1, 434f1ae32a1SGerd Hoffmann .descs = (USBDescOther[]) { 435f1ae32a1SGerd Hoffmann { 436f1ae32a1SGerd Hoffmann /* smartcard descriptor */ 437f1ae32a1SGerd Hoffmann .data = qemu_ccid_descriptor, 438f1ae32a1SGerd Hoffmann }, 439f1ae32a1SGerd Hoffmann }, 440f1ae32a1SGerd Hoffmann .eps = (USBDescEndpoint[]) { 441f1ae32a1SGerd Hoffmann { 442f1ae32a1SGerd Hoffmann .bEndpointAddress = USB_DIR_IN | CCID_INT_IN_EP, 443f1ae32a1SGerd Hoffmann .bmAttributes = USB_ENDPOINT_XFER_INT, 444f1ae32a1SGerd Hoffmann .bInterval = 255, 445f1ae32a1SGerd Hoffmann .wMaxPacketSize = 64, 446f1ae32a1SGerd Hoffmann },{ 447f1ae32a1SGerd Hoffmann .bEndpointAddress = USB_DIR_IN | CCID_BULK_IN_EP, 448f1ae32a1SGerd Hoffmann .bmAttributes = USB_ENDPOINT_XFER_BULK, 449f1ae32a1SGerd Hoffmann .wMaxPacketSize = 64, 450f1ae32a1SGerd Hoffmann },{ 451f1ae32a1SGerd Hoffmann .bEndpointAddress = USB_DIR_OUT | CCID_BULK_OUT_EP, 452f1ae32a1SGerd Hoffmann .bmAttributes = USB_ENDPOINT_XFER_BULK, 453f1ae32a1SGerd Hoffmann .wMaxPacketSize = 64, 454f1ae32a1SGerd Hoffmann }, 455f1ae32a1SGerd Hoffmann } 456f1ae32a1SGerd Hoffmann }; 457f1ae32a1SGerd Hoffmann 458f1ae32a1SGerd Hoffmann static const USBDescDevice desc_device = { 459f1ae32a1SGerd Hoffmann .bcdUSB = 0x0110, 460f1ae32a1SGerd Hoffmann .bMaxPacketSize0 = 64, 461f1ae32a1SGerd Hoffmann .bNumConfigurations = 1, 462f1ae32a1SGerd Hoffmann .confs = (USBDescConfig[]) { 463f1ae32a1SGerd Hoffmann { 464f1ae32a1SGerd Hoffmann .bNumInterfaces = 1, 465f1ae32a1SGerd Hoffmann .bConfigurationValue = 1, 466bd93976aSPantelis Koukousoulas .bmAttributes = USB_CFG_ATT_ONE | USB_CFG_ATT_SELFPOWER | 467bd93976aSPantelis Koukousoulas USB_CFG_ATT_WAKEUP, 468f1ae32a1SGerd Hoffmann .bMaxPower = 50, 469f1ae32a1SGerd Hoffmann .nif = 1, 470f1ae32a1SGerd Hoffmann .ifs = &desc_iface0, 471f1ae32a1SGerd Hoffmann }, 472f1ae32a1SGerd Hoffmann }, 473f1ae32a1SGerd Hoffmann }; 474f1ae32a1SGerd Hoffmann 475f1ae32a1SGerd Hoffmann static const USBDesc desc_ccid = { 476f1ae32a1SGerd Hoffmann .id = { 477f1ae32a1SGerd Hoffmann .idVendor = CCID_VENDOR_ID, 478f1ae32a1SGerd Hoffmann .idProduct = CCID_PRODUCT_ID, 479f1ae32a1SGerd Hoffmann .bcdDevice = CCID_DEVICE_VERSION, 480f1ae32a1SGerd Hoffmann .iManufacturer = STR_MANUFACTURER, 481f1ae32a1SGerd Hoffmann .iProduct = STR_PRODUCT, 482f1ae32a1SGerd Hoffmann .iSerialNumber = STR_SERIALNUMBER, 483f1ae32a1SGerd Hoffmann }, 484f1ae32a1SGerd Hoffmann .full = &desc_device, 485f1ae32a1SGerd Hoffmann .str = desc_strings, 486f1ae32a1SGerd Hoffmann }; 487f1ae32a1SGerd Hoffmann 488f1ae32a1SGerd Hoffmann static const uint8_t *ccid_card_get_atr(CCIDCardState *card, uint32_t *len) 489f1ae32a1SGerd Hoffmann { 490f1ae32a1SGerd Hoffmann CCIDCardClass *cc = CCID_CARD_GET_CLASS(card); 4914543d43cSAlon Levy 492f1ae32a1SGerd Hoffmann if (cc->get_atr) { 493f1ae32a1SGerd Hoffmann return cc->get_atr(card, len); 494f1ae32a1SGerd Hoffmann } 495f1ae32a1SGerd Hoffmann return NULL; 496f1ae32a1SGerd Hoffmann } 497f1ae32a1SGerd Hoffmann 498f1ae32a1SGerd Hoffmann static void ccid_card_apdu_from_guest(CCIDCardState *card, 499f1ae32a1SGerd Hoffmann const uint8_t *apdu, 500f1ae32a1SGerd Hoffmann uint32_t len) 501f1ae32a1SGerd Hoffmann { 502f1ae32a1SGerd Hoffmann CCIDCardClass *cc = CCID_CARD_GET_CLASS(card); 5034543d43cSAlon Levy 504f1ae32a1SGerd Hoffmann if (cc->apdu_from_guest) { 505f1ae32a1SGerd Hoffmann cc->apdu_from_guest(card, apdu, len); 506f1ae32a1SGerd Hoffmann } 507f1ae32a1SGerd Hoffmann } 508f1ae32a1SGerd Hoffmann 509f1ae32a1SGerd Hoffmann static int ccid_card_exitfn(CCIDCardState *card) 510f1ae32a1SGerd Hoffmann { 511f1ae32a1SGerd Hoffmann CCIDCardClass *cc = CCID_CARD_GET_CLASS(card); 5124543d43cSAlon Levy 513f1ae32a1SGerd Hoffmann if (cc->exitfn) { 514f1ae32a1SGerd Hoffmann return cc->exitfn(card); 515f1ae32a1SGerd Hoffmann } 516f1ae32a1SGerd Hoffmann return 0; 517f1ae32a1SGerd Hoffmann } 518f1ae32a1SGerd Hoffmann 519f1ae32a1SGerd Hoffmann static int ccid_card_initfn(CCIDCardState *card) 520f1ae32a1SGerd Hoffmann { 521f1ae32a1SGerd Hoffmann CCIDCardClass *cc = CCID_CARD_GET_CLASS(card); 5224543d43cSAlon Levy 523f1ae32a1SGerd Hoffmann if (cc->initfn) { 524f1ae32a1SGerd Hoffmann return cc->initfn(card); 525f1ae32a1SGerd Hoffmann } 526f1ae32a1SGerd Hoffmann return 0; 527f1ae32a1SGerd Hoffmann } 528f1ae32a1SGerd Hoffmann 529f1ae32a1SGerd Hoffmann static bool ccid_has_pending_answers(USBCCIDState *s) 530f1ae32a1SGerd Hoffmann { 531f1ae32a1SGerd Hoffmann return s->pending_answers_num > 0; 532f1ae32a1SGerd Hoffmann } 533f1ae32a1SGerd Hoffmann 534f1ae32a1SGerd Hoffmann static void ccid_clear_pending_answers(USBCCIDState *s) 535f1ae32a1SGerd Hoffmann { 536f1ae32a1SGerd Hoffmann s->pending_answers_num = 0; 537f1ae32a1SGerd Hoffmann s->pending_answers_start = 0; 538f1ae32a1SGerd Hoffmann s->pending_answers_end = 0; 539f1ae32a1SGerd Hoffmann } 540f1ae32a1SGerd Hoffmann 541f1ae32a1SGerd Hoffmann static void ccid_print_pending_answers(USBCCIDState *s) 542f1ae32a1SGerd Hoffmann { 543f1ae32a1SGerd Hoffmann Answer *answer; 544f1ae32a1SGerd Hoffmann int i, count; 545f1ae32a1SGerd Hoffmann 546f1ae32a1SGerd Hoffmann DPRINTF(s, D_VERBOSE, "usb-ccid: pending answers:"); 547f1ae32a1SGerd Hoffmann if (!ccid_has_pending_answers(s)) { 548f1ae32a1SGerd Hoffmann DPRINTF(s, D_VERBOSE, " empty\n"); 549f1ae32a1SGerd Hoffmann return; 550f1ae32a1SGerd Hoffmann } 551f1ae32a1SGerd Hoffmann for (i = s->pending_answers_start, count = s->pending_answers_num ; 552f1ae32a1SGerd Hoffmann count > 0; count--, i++) { 553f1ae32a1SGerd Hoffmann answer = &s->pending_answers[i % PENDING_ANSWERS_NUM]; 554f1ae32a1SGerd Hoffmann if (count == 1) { 555f1ae32a1SGerd Hoffmann DPRINTF(s, D_VERBOSE, "%d:%d\n", answer->slot, answer->seq); 556f1ae32a1SGerd Hoffmann } else { 557f1ae32a1SGerd Hoffmann DPRINTF(s, D_VERBOSE, "%d:%d,", answer->slot, answer->seq); 558f1ae32a1SGerd Hoffmann } 559f1ae32a1SGerd Hoffmann } 560f1ae32a1SGerd Hoffmann } 561f1ae32a1SGerd Hoffmann 562f1ae32a1SGerd Hoffmann static void ccid_add_pending_answer(USBCCIDState *s, CCID_Header *hdr) 563f1ae32a1SGerd Hoffmann { 564f1ae32a1SGerd Hoffmann Answer *answer; 565f1ae32a1SGerd Hoffmann 566f1ae32a1SGerd Hoffmann assert(s->pending_answers_num < PENDING_ANSWERS_NUM); 567f1ae32a1SGerd Hoffmann s->pending_answers_num++; 568f1ae32a1SGerd Hoffmann answer = 569f1ae32a1SGerd Hoffmann &s->pending_answers[(s->pending_answers_end++) % PENDING_ANSWERS_NUM]; 570f1ae32a1SGerd Hoffmann answer->slot = hdr->bSlot; 571f1ae32a1SGerd Hoffmann answer->seq = hdr->bSeq; 572f1ae32a1SGerd Hoffmann ccid_print_pending_answers(s); 573f1ae32a1SGerd Hoffmann } 574f1ae32a1SGerd Hoffmann 575f1ae32a1SGerd Hoffmann static void ccid_remove_pending_answer(USBCCIDState *s, 576f1ae32a1SGerd Hoffmann uint8_t *slot, uint8_t *seq) 577f1ae32a1SGerd Hoffmann { 578f1ae32a1SGerd Hoffmann Answer *answer; 579f1ae32a1SGerd Hoffmann 580f1ae32a1SGerd Hoffmann assert(s->pending_answers_num > 0); 581f1ae32a1SGerd Hoffmann s->pending_answers_num--; 582f1ae32a1SGerd Hoffmann answer = 583f1ae32a1SGerd Hoffmann &s->pending_answers[(s->pending_answers_start++) % PENDING_ANSWERS_NUM]; 584f1ae32a1SGerd Hoffmann *slot = answer->slot; 585f1ae32a1SGerd Hoffmann *seq = answer->seq; 586f1ae32a1SGerd Hoffmann ccid_print_pending_answers(s); 587f1ae32a1SGerd Hoffmann } 588f1ae32a1SGerd Hoffmann 589f1ae32a1SGerd Hoffmann static void ccid_bulk_in_clear(USBCCIDState *s) 590f1ae32a1SGerd Hoffmann { 591f1ae32a1SGerd Hoffmann s->bulk_in_pending_start = 0; 592f1ae32a1SGerd Hoffmann s->bulk_in_pending_end = 0; 593f1ae32a1SGerd Hoffmann s->bulk_in_pending_num = 0; 594f1ae32a1SGerd Hoffmann } 595f1ae32a1SGerd Hoffmann 596f1ae32a1SGerd Hoffmann static void ccid_bulk_in_release(USBCCIDState *s) 597f1ae32a1SGerd Hoffmann { 598f1ae32a1SGerd Hoffmann assert(s->current_bulk_in != NULL); 599f1ae32a1SGerd Hoffmann s->current_bulk_in->pos = 0; 600f1ae32a1SGerd Hoffmann s->current_bulk_in = NULL; 601f1ae32a1SGerd Hoffmann } 602f1ae32a1SGerd Hoffmann 603f1ae32a1SGerd Hoffmann static void ccid_bulk_in_get(USBCCIDState *s) 604f1ae32a1SGerd Hoffmann { 605f1ae32a1SGerd Hoffmann if (s->current_bulk_in != NULL || s->bulk_in_pending_num == 0) { 606f1ae32a1SGerd Hoffmann return; 607f1ae32a1SGerd Hoffmann } 608f1ae32a1SGerd Hoffmann assert(s->bulk_in_pending_num > 0); 609f1ae32a1SGerd Hoffmann s->bulk_in_pending_num--; 610f1ae32a1SGerd Hoffmann s->current_bulk_in = 611f1ae32a1SGerd Hoffmann &s->bulk_in_pending[(s->bulk_in_pending_start++) % BULK_IN_PENDING_NUM]; 612f1ae32a1SGerd Hoffmann } 613f1ae32a1SGerd Hoffmann 614f1ae32a1SGerd Hoffmann static void *ccid_reserve_recv_buf(USBCCIDState *s, uint16_t len) 615f1ae32a1SGerd Hoffmann { 616f1ae32a1SGerd Hoffmann BulkIn *bulk_in; 617f1ae32a1SGerd Hoffmann 618f1ae32a1SGerd Hoffmann DPRINTF(s, D_VERBOSE, "%s: QUEUE: reserve %d bytes\n", __func__, len); 619f1ae32a1SGerd Hoffmann 620f1ae32a1SGerd Hoffmann /* look for an existing element */ 621f1ae32a1SGerd Hoffmann if (len > BULK_IN_BUF_SIZE) { 622f1ae32a1SGerd Hoffmann DPRINTF(s, D_WARN, "usb-ccid.c: %s: len larger then max (%d>%d). " 623f1ae32a1SGerd Hoffmann "discarding message.\n", 624f1ae32a1SGerd Hoffmann __func__, len, BULK_IN_BUF_SIZE); 625f1ae32a1SGerd Hoffmann return NULL; 626f1ae32a1SGerd Hoffmann } 627f1ae32a1SGerd Hoffmann if (s->bulk_in_pending_num >= BULK_IN_PENDING_NUM) { 628f1ae32a1SGerd Hoffmann DPRINTF(s, D_WARN, "usb-ccid.c: %s: No free bulk_in buffers. " 629f1ae32a1SGerd Hoffmann "discarding message.\n", __func__); 630f1ae32a1SGerd Hoffmann return NULL; 631f1ae32a1SGerd Hoffmann } 632f1ae32a1SGerd Hoffmann bulk_in = 633f1ae32a1SGerd Hoffmann &s->bulk_in_pending[(s->bulk_in_pending_end++) % BULK_IN_PENDING_NUM]; 634f1ae32a1SGerd Hoffmann s->bulk_in_pending_num++; 635f1ae32a1SGerd Hoffmann bulk_in->len = len; 636f1ae32a1SGerd Hoffmann return bulk_in->data; 637f1ae32a1SGerd Hoffmann } 638f1ae32a1SGerd Hoffmann 639f1ae32a1SGerd Hoffmann static void ccid_reset(USBCCIDState *s) 640f1ae32a1SGerd Hoffmann { 641f1ae32a1SGerd Hoffmann ccid_bulk_in_clear(s); 642f1ae32a1SGerd Hoffmann ccid_clear_pending_answers(s); 643f1ae32a1SGerd Hoffmann } 644f1ae32a1SGerd Hoffmann 645f1ae32a1SGerd Hoffmann static void ccid_detach(USBCCIDState *s) 646f1ae32a1SGerd Hoffmann { 647f1ae32a1SGerd Hoffmann ccid_reset(s); 648f1ae32a1SGerd Hoffmann } 649f1ae32a1SGerd Hoffmann 650f1ae32a1SGerd Hoffmann static void ccid_handle_reset(USBDevice *dev) 651f1ae32a1SGerd Hoffmann { 652*61b4887bSGonglei USBCCIDState *s = USB_CCID_DEV(dev); 653f1ae32a1SGerd Hoffmann 654f1ae32a1SGerd Hoffmann DPRINTF(s, 1, "Reset\n"); 655f1ae32a1SGerd Hoffmann 656f1ae32a1SGerd Hoffmann ccid_reset(s); 657f1ae32a1SGerd Hoffmann } 658f1ae32a1SGerd Hoffmann 6597e1ac5abSAlon Levy static const char *ccid_control_to_str(USBCCIDState *s, int request) 6607e1ac5abSAlon Levy { 6617e1ac5abSAlon Levy switch (request) { 6627e1ac5abSAlon Levy /* generic - should be factored out if there are other debugees */ 6637e1ac5abSAlon Levy case DeviceOutRequest | USB_REQ_SET_ADDRESS: 6647e1ac5abSAlon Levy return "(generic) set address"; 6657e1ac5abSAlon Levy case DeviceRequest | USB_REQ_GET_DESCRIPTOR: 6667e1ac5abSAlon Levy return "(generic) get descriptor"; 6677e1ac5abSAlon Levy case DeviceRequest | USB_REQ_GET_CONFIGURATION: 6687e1ac5abSAlon Levy return "(generic) get configuration"; 6697e1ac5abSAlon Levy case DeviceOutRequest | USB_REQ_SET_CONFIGURATION: 6707e1ac5abSAlon Levy return "(generic) set configuration"; 6717e1ac5abSAlon Levy case DeviceRequest | USB_REQ_GET_STATUS: 6727e1ac5abSAlon Levy return "(generic) get status"; 6737e1ac5abSAlon Levy case DeviceOutRequest | USB_REQ_CLEAR_FEATURE: 6747e1ac5abSAlon Levy return "(generic) clear feature"; 6757e1ac5abSAlon Levy case DeviceOutRequest | USB_REQ_SET_FEATURE: 6767e1ac5abSAlon Levy return "(generic) set_feature"; 6777e1ac5abSAlon Levy case InterfaceRequest | USB_REQ_GET_INTERFACE: 6787e1ac5abSAlon Levy return "(generic) get interface"; 6797e1ac5abSAlon Levy case InterfaceOutRequest | USB_REQ_SET_INTERFACE: 6807e1ac5abSAlon Levy return "(generic) set interface"; 6817e1ac5abSAlon Levy /* class requests */ 6827e1ac5abSAlon Levy case ClassInterfaceOutRequest | CCID_CONTROL_ABORT: 6837e1ac5abSAlon Levy return "ABORT"; 6847e1ac5abSAlon Levy case ClassInterfaceRequest | CCID_CONTROL_GET_CLOCK_FREQUENCIES: 6857e1ac5abSAlon Levy return "GET_CLOCK_FREQUENCIES"; 6867e1ac5abSAlon Levy case ClassInterfaceRequest | CCID_CONTROL_GET_DATA_RATES: 6877e1ac5abSAlon Levy return "GET_DATA_RATES"; 6887e1ac5abSAlon Levy } 6897e1ac5abSAlon Levy return "unknown"; 6907e1ac5abSAlon Levy } 6917e1ac5abSAlon Levy 6929a77a0f5SHans de Goede static void ccid_handle_control(USBDevice *dev, USBPacket *p, int request, 693f1ae32a1SGerd Hoffmann int value, int index, int length, uint8_t *data) 694f1ae32a1SGerd Hoffmann { 695*61b4887bSGonglei USBCCIDState *s = USB_CCID_DEV(dev); 6969a77a0f5SHans de Goede int ret; 697f1ae32a1SGerd Hoffmann 6987e1ac5abSAlon Levy DPRINTF(s, 1, "%s: got control %s (%x), value %x\n", __func__, 6997e1ac5abSAlon Levy ccid_control_to_str(s, request), request, value); 700f1ae32a1SGerd Hoffmann ret = usb_desc_handle_control(dev, p, request, value, index, length, data); 701f1ae32a1SGerd Hoffmann if (ret >= 0) { 7029a77a0f5SHans de Goede return; 703f1ae32a1SGerd Hoffmann } 704f1ae32a1SGerd Hoffmann 705f1ae32a1SGerd Hoffmann switch (request) { 706f1ae32a1SGerd Hoffmann /* Class specific requests. */ 707693e4773SAlon Levy case ClassInterfaceOutRequest | CCID_CONTROL_ABORT: 708f1ae32a1SGerd Hoffmann DPRINTF(s, 1, "ccid_control abort UNIMPLEMENTED\n"); 7099a77a0f5SHans de Goede p->status = USB_RET_STALL; 710f1ae32a1SGerd Hoffmann break; 711693e4773SAlon Levy case ClassInterfaceRequest | CCID_CONTROL_GET_CLOCK_FREQUENCIES: 712f1ae32a1SGerd Hoffmann DPRINTF(s, 1, "ccid_control get clock frequencies UNIMPLEMENTED\n"); 7139a77a0f5SHans de Goede p->status = USB_RET_STALL; 714f1ae32a1SGerd Hoffmann break; 715693e4773SAlon Levy case ClassInterfaceRequest | CCID_CONTROL_GET_DATA_RATES: 716f1ae32a1SGerd Hoffmann DPRINTF(s, 1, "ccid_control get data rates UNIMPLEMENTED\n"); 7179a77a0f5SHans de Goede p->status = USB_RET_STALL; 718f1ae32a1SGerd Hoffmann break; 719f1ae32a1SGerd Hoffmann default: 720f1ae32a1SGerd Hoffmann DPRINTF(s, 1, "got unsupported/bogus control %x, value %x\n", 721f1ae32a1SGerd Hoffmann request, value); 7229a77a0f5SHans de Goede p->status = USB_RET_STALL; 723f1ae32a1SGerd Hoffmann break; 724f1ae32a1SGerd Hoffmann } 725f1ae32a1SGerd Hoffmann } 726f1ae32a1SGerd Hoffmann 727f1ae32a1SGerd Hoffmann static bool ccid_card_inserted(USBCCIDState *s) 728f1ae32a1SGerd Hoffmann { 729f1ae32a1SGerd Hoffmann return s->bmSlotICCState & SLOT_0_STATE_MASK; 730f1ae32a1SGerd Hoffmann } 731f1ae32a1SGerd Hoffmann 732f1ae32a1SGerd Hoffmann static uint8_t ccid_card_status(USBCCIDState *s) 733f1ae32a1SGerd Hoffmann { 734f1ae32a1SGerd Hoffmann return ccid_card_inserted(s) 735f1ae32a1SGerd Hoffmann ? (s->powered ? 736f1ae32a1SGerd Hoffmann ICC_STATUS_PRESENT_ACTIVE 737f1ae32a1SGerd Hoffmann : ICC_STATUS_PRESENT_INACTIVE 738f1ae32a1SGerd Hoffmann ) 739f1ae32a1SGerd Hoffmann : ICC_STATUS_NOT_PRESENT; 740f1ae32a1SGerd Hoffmann } 741f1ae32a1SGerd Hoffmann 742f1ae32a1SGerd Hoffmann static uint8_t ccid_calc_status(USBCCIDState *s) 743f1ae32a1SGerd Hoffmann { 744f1ae32a1SGerd Hoffmann /* 745f1ae32a1SGerd Hoffmann * page 55, 6.2.6, calculation of bStatus from bmICCStatus and 746f1ae32a1SGerd Hoffmann * bmCommandStatus 747f1ae32a1SGerd Hoffmann */ 748f1ae32a1SGerd Hoffmann uint8_t ret = ccid_card_status(s) | (s->bmCommandStatus << 6); 7497e1ac5abSAlon Levy DPRINTF(s, D_VERBOSE, "%s: status = %d\n", __func__, ret); 750f1ae32a1SGerd Hoffmann return ret; 751f1ae32a1SGerd Hoffmann } 752f1ae32a1SGerd Hoffmann 753f1ae32a1SGerd Hoffmann static void ccid_reset_error_status(USBCCIDState *s) 754f1ae32a1SGerd Hoffmann { 755f1ae32a1SGerd Hoffmann s->bError = ERROR_CMD_NOT_SUPPORTED; 756f1ae32a1SGerd Hoffmann s->bmCommandStatus = COMMAND_STATUS_NO_ERROR; 757f1ae32a1SGerd Hoffmann } 758f1ae32a1SGerd Hoffmann 759f1ae32a1SGerd Hoffmann static void ccid_write_slot_status(USBCCIDState *s, CCID_Header *recv) 760f1ae32a1SGerd Hoffmann { 761f1ae32a1SGerd Hoffmann CCID_SlotStatus *h = ccid_reserve_recv_buf(s, sizeof(CCID_SlotStatus)); 762f1ae32a1SGerd Hoffmann if (h == NULL) { 763f1ae32a1SGerd Hoffmann return; 764f1ae32a1SGerd Hoffmann } 765f1ae32a1SGerd Hoffmann h->b.hdr.bMessageType = CCID_MESSAGE_TYPE_RDR_to_PC_SlotStatus; 766f1ae32a1SGerd Hoffmann h->b.hdr.dwLength = 0; 767f1ae32a1SGerd Hoffmann h->b.hdr.bSlot = recv->bSlot; 768f1ae32a1SGerd Hoffmann h->b.hdr.bSeq = recv->bSeq; 769f1ae32a1SGerd Hoffmann h->b.bStatus = ccid_calc_status(s); 770f1ae32a1SGerd Hoffmann h->b.bError = s->bError; 771f1ae32a1SGerd Hoffmann h->bClockStatus = CLOCK_STATUS_RUNNING; 772f1ae32a1SGerd Hoffmann ccid_reset_error_status(s); 773f1ae32a1SGerd Hoffmann } 774f1ae32a1SGerd Hoffmann 775f1ae32a1SGerd Hoffmann static void ccid_write_parameters(USBCCIDState *s, CCID_Header *recv) 776f1ae32a1SGerd Hoffmann { 777f1ae32a1SGerd Hoffmann CCID_Parameter *h; 778f1ae32a1SGerd Hoffmann uint32_t len = s->ulProtocolDataStructureSize; 779f1ae32a1SGerd Hoffmann 780f1ae32a1SGerd Hoffmann h = ccid_reserve_recv_buf(s, sizeof(CCID_Parameter) + len); 781f1ae32a1SGerd Hoffmann if (h == NULL) { 782f1ae32a1SGerd Hoffmann return; 783f1ae32a1SGerd Hoffmann } 784f1ae32a1SGerd Hoffmann h->b.hdr.bMessageType = CCID_MESSAGE_TYPE_RDR_to_PC_Parameters; 785f1ae32a1SGerd Hoffmann h->b.hdr.dwLength = 0; 786f1ae32a1SGerd Hoffmann h->b.hdr.bSlot = recv->bSlot; 787f1ae32a1SGerd Hoffmann h->b.hdr.bSeq = recv->bSeq; 788f1ae32a1SGerd Hoffmann h->b.bStatus = ccid_calc_status(s); 789f1ae32a1SGerd Hoffmann h->b.bError = s->bError; 790f1ae32a1SGerd Hoffmann h->bProtocolNum = s->bProtocolNum; 7914942d6c3SAlon Levy h->abProtocolDataStructure = s->abProtocolDataStructure; 792f1ae32a1SGerd Hoffmann ccid_reset_error_status(s); 793f1ae32a1SGerd Hoffmann } 794f1ae32a1SGerd Hoffmann 795f1ae32a1SGerd Hoffmann static void ccid_write_data_block(USBCCIDState *s, uint8_t slot, uint8_t seq, 796f1ae32a1SGerd Hoffmann const uint8_t *data, uint32_t len) 797f1ae32a1SGerd Hoffmann { 798f1ae32a1SGerd Hoffmann CCID_DataBlock *p = ccid_reserve_recv_buf(s, sizeof(*p) + len); 799f1ae32a1SGerd Hoffmann 800f1ae32a1SGerd Hoffmann if (p == NULL) { 801f1ae32a1SGerd Hoffmann return; 802f1ae32a1SGerd Hoffmann } 803f1ae32a1SGerd Hoffmann p->b.hdr.bMessageType = CCID_MESSAGE_TYPE_RDR_to_PC_DataBlock; 804f1ae32a1SGerd Hoffmann p->b.hdr.dwLength = cpu_to_le32(len); 805f1ae32a1SGerd Hoffmann p->b.hdr.bSlot = slot; 806f1ae32a1SGerd Hoffmann p->b.hdr.bSeq = seq; 807f1ae32a1SGerd Hoffmann p->b.bStatus = ccid_calc_status(s); 808f1ae32a1SGerd Hoffmann p->b.bError = s->bError; 809f1ae32a1SGerd Hoffmann if (p->b.bError) { 8107e1ac5abSAlon Levy DPRINTF(s, D_VERBOSE, "error %d\n", p->b.bError); 811f1ae32a1SGerd Hoffmann } 812f1ae32a1SGerd Hoffmann memcpy(p->abData, data, len); 813f1ae32a1SGerd Hoffmann ccid_reset_error_status(s); 814f1ae32a1SGerd Hoffmann } 815f1ae32a1SGerd Hoffmann 81647bf53afSAlon Levy static void ccid_report_error_failed(USBCCIDState *s, uint8_t error) 81747bf53afSAlon Levy { 81847bf53afSAlon Levy s->bmCommandStatus = COMMAND_STATUS_FAILED; 81947bf53afSAlon Levy s->bError = error; 82047bf53afSAlon Levy } 82147bf53afSAlon Levy 822f1ae32a1SGerd Hoffmann static void ccid_write_data_block_answer(USBCCIDState *s, 823f1ae32a1SGerd Hoffmann const uint8_t *data, uint32_t len) 824f1ae32a1SGerd Hoffmann { 825f1ae32a1SGerd Hoffmann uint8_t seq; 826f1ae32a1SGerd Hoffmann uint8_t slot; 827f1ae32a1SGerd Hoffmann 828f1ae32a1SGerd Hoffmann if (!ccid_has_pending_answers(s)) { 82947bf53afSAlon Levy DPRINTF(s, D_WARN, "error: no pending answer to return to guest\n"); 83047bf53afSAlon Levy ccid_report_error_failed(s, ERROR_ICC_MUTE); 83147bf53afSAlon Levy return; 832f1ae32a1SGerd Hoffmann } 833f1ae32a1SGerd Hoffmann ccid_remove_pending_answer(s, &slot, &seq); 834f1ae32a1SGerd Hoffmann ccid_write_data_block(s, slot, seq, data, len); 835f1ae32a1SGerd Hoffmann } 836f1ae32a1SGerd Hoffmann 8372f8f916bSAlon Levy static uint8_t atr_get_protocol_num(const uint8_t *atr, uint32_t len) 8382f8f916bSAlon Levy { 8392f8f916bSAlon Levy int i; 8402f8f916bSAlon Levy 8412f8f916bSAlon Levy if (len < 2 || !(atr[1] & 0x80)) { 8422f8f916bSAlon Levy /* too short or TD1 not included */ 8432f8f916bSAlon Levy return 0; /* T=0, default */ 8442f8f916bSAlon Levy } 8452f8f916bSAlon Levy i = 1 + !!(atr[1] & 0x10) + !!(atr[1] & 0x20) + !!(atr[1] & 0x40); 8462f8f916bSAlon Levy i += !!(atr[1] & 0x80); 8472f8f916bSAlon Levy return atr[i] & 0x0f; 8482f8f916bSAlon Levy } 8492f8f916bSAlon Levy 850f1ae32a1SGerd Hoffmann static void ccid_write_data_block_atr(USBCCIDState *s, CCID_Header *recv) 851f1ae32a1SGerd Hoffmann { 852f1ae32a1SGerd Hoffmann const uint8_t *atr = NULL; 853f1ae32a1SGerd Hoffmann uint32_t len = 0; 8542f8f916bSAlon Levy uint8_t atr_protocol_num; 8552f8f916bSAlon Levy CCID_T0ProtocolDataStructure *t0 = &s->abProtocolDataStructure.t0; 8562f8f916bSAlon Levy CCID_T1ProtocolDataStructure *t1 = &s->abProtocolDataStructure.t1; 857f1ae32a1SGerd Hoffmann 858f1ae32a1SGerd Hoffmann if (s->card) { 859f1ae32a1SGerd Hoffmann atr = ccid_card_get_atr(s->card, &len); 860f1ae32a1SGerd Hoffmann } 8612f8f916bSAlon Levy atr_protocol_num = atr_get_protocol_num(atr, len); 8622f8f916bSAlon Levy DPRINTF(s, D_VERBOSE, "%s: atr contains protocol=%d\n", __func__, 8632f8f916bSAlon Levy atr_protocol_num); 8642f8f916bSAlon Levy /* set parameters from ATR - see spec page 109 */ 8652f8f916bSAlon Levy s->bProtocolNum = (atr_protocol_num <= 1 ? atr_protocol_num 8662f8f916bSAlon Levy : s->bProtocolNum); 8672f8f916bSAlon Levy switch (atr_protocol_num) { 8682f8f916bSAlon Levy case 0: 8692f8f916bSAlon Levy /* TODO: unimplemented ATR T0 parameters */ 8702f8f916bSAlon Levy t0->bmFindexDindex = 0; 8712f8f916bSAlon Levy t0->bmTCCKST0 = 0; 8722f8f916bSAlon Levy t0->bGuardTimeT0 = 0; 8732f8f916bSAlon Levy t0->bWaitingIntegerT0 = 0; 8742f8f916bSAlon Levy t0->bClockStop = 0; 8752f8f916bSAlon Levy break; 8762f8f916bSAlon Levy case 1: 8772f8f916bSAlon Levy /* TODO: unimplemented ATR T1 parameters */ 8782f8f916bSAlon Levy t1->bmFindexDindex = 0; 8792f8f916bSAlon Levy t1->bmTCCKST1 = 0; 8802f8f916bSAlon Levy t1->bGuardTimeT1 = 0; 8812f8f916bSAlon Levy t1->bWaitingIntegerT1 = 0; 8822f8f916bSAlon Levy t1->bClockStop = 0; 8832f8f916bSAlon Levy t1->bIFSC = 0; 8842f8f916bSAlon Levy t1->bNadValue = 0; 8852f8f916bSAlon Levy break; 8862f8f916bSAlon Levy default: 8872f8f916bSAlon Levy DPRINTF(s, D_WARN, "%s: error: unsupported ATR protocol %d\n", 8882f8f916bSAlon Levy __func__, atr_protocol_num); 8892f8f916bSAlon Levy } 890f1ae32a1SGerd Hoffmann ccid_write_data_block(s, recv->bSlot, recv->bSeq, atr, len); 891f1ae32a1SGerd Hoffmann } 892f1ae32a1SGerd Hoffmann 893f1ae32a1SGerd Hoffmann static void ccid_set_parameters(USBCCIDState *s, CCID_Header *recv) 894f1ae32a1SGerd Hoffmann { 895f1ae32a1SGerd Hoffmann CCID_SetParameters *ph = (CCID_SetParameters *) recv; 8964942d6c3SAlon Levy uint32_t protocol_num = ph->bProtocolNum & 3; 8974942d6c3SAlon Levy 8984942d6c3SAlon Levy if (protocol_num != 0 && protocol_num != 1) { 8994942d6c3SAlon Levy ccid_report_error_failed(s, ERROR_CMD_NOT_SUPPORTED); 900f1ae32a1SGerd Hoffmann return; 901f1ae32a1SGerd Hoffmann } 9024942d6c3SAlon Levy s->bProtocolNum = protocol_num; 9034942d6c3SAlon Levy s->abProtocolDataStructure = ph->abProtocolDataStructure; 904f1ae32a1SGerd Hoffmann } 905f1ae32a1SGerd Hoffmann 906f1ae32a1SGerd Hoffmann /* 907f1ae32a1SGerd Hoffmann * must be 5 bytes for T=0, 7 bytes for T=1 908f1ae32a1SGerd Hoffmann * See page 52 909f1ae32a1SGerd Hoffmann */ 9104942d6c3SAlon Levy static const CCID_ProtocolDataStructure defaultProtocolDataStructure = { 9114942d6c3SAlon Levy .t1 = { 9124942d6c3SAlon Levy .bmFindexDindex = 0x77, 9134942d6c3SAlon Levy .bmTCCKST1 = 0x00, 9144942d6c3SAlon Levy .bGuardTimeT1 = 0x00, 9154942d6c3SAlon Levy .bWaitingIntegerT1 = 0x00, 9164942d6c3SAlon Levy .bClockStop = 0x00, 9174942d6c3SAlon Levy .bIFSC = 0xfe, 9184942d6c3SAlon Levy .bNadValue = 0x00, 9194942d6c3SAlon Levy } 9204942d6c3SAlon Levy }; 921f1ae32a1SGerd Hoffmann 922f1ae32a1SGerd Hoffmann static void ccid_reset_parameters(USBCCIDState *s) 923f1ae32a1SGerd Hoffmann { 924d7d218efSAlon Levy s->bProtocolNum = 0; /* T=0 */ 9254942d6c3SAlon Levy s->abProtocolDataStructure = defaultProtocolDataStructure; 926f1ae32a1SGerd Hoffmann } 927f1ae32a1SGerd Hoffmann 928f1ae32a1SGerd Hoffmann /* NOTE: only a single slot is supported (SLOT_0) */ 929f1ae32a1SGerd Hoffmann static void ccid_on_slot_change(USBCCIDState *s, bool full) 930f1ae32a1SGerd Hoffmann { 931f1ae32a1SGerd Hoffmann /* RDR_to_PC_NotifySlotChange, 6.3.1 page 56 */ 932f1ae32a1SGerd Hoffmann uint8_t current = s->bmSlotICCState; 933f1ae32a1SGerd Hoffmann if (full) { 934f1ae32a1SGerd Hoffmann s->bmSlotICCState |= SLOT_0_STATE_MASK; 935f1ae32a1SGerd Hoffmann } else { 936f1ae32a1SGerd Hoffmann s->bmSlotICCState &= ~SLOT_0_STATE_MASK; 937f1ae32a1SGerd Hoffmann } 938f1ae32a1SGerd Hoffmann if (current != s->bmSlotICCState) { 939f1ae32a1SGerd Hoffmann s->bmSlotICCState |= SLOT_0_CHANGED_MASK; 940f1ae32a1SGerd Hoffmann } 941f1ae32a1SGerd Hoffmann s->notify_slot_change = true; 9428550a02dSGerd Hoffmann usb_wakeup(s->intr, 0); 943f1ae32a1SGerd Hoffmann } 944f1ae32a1SGerd Hoffmann 945f1ae32a1SGerd Hoffmann static void ccid_write_data_block_error( 946f1ae32a1SGerd Hoffmann USBCCIDState *s, uint8_t slot, uint8_t seq) 947f1ae32a1SGerd Hoffmann { 948f1ae32a1SGerd Hoffmann ccid_write_data_block(s, slot, seq, NULL, 0); 949f1ae32a1SGerd Hoffmann } 950f1ae32a1SGerd Hoffmann 951f1ae32a1SGerd Hoffmann static void ccid_on_apdu_from_guest(USBCCIDState *s, CCID_XferBlock *recv) 952f1ae32a1SGerd Hoffmann { 953f1ae32a1SGerd Hoffmann uint32_t len; 954f1ae32a1SGerd Hoffmann 955f1ae32a1SGerd Hoffmann if (ccid_card_status(s) != ICC_STATUS_PRESENT_ACTIVE) { 956f1ae32a1SGerd Hoffmann DPRINTF(s, 1, 957f1ae32a1SGerd Hoffmann "usb-ccid: not sending apdu to client, no card connected\n"); 958f1ae32a1SGerd Hoffmann ccid_write_data_block_error(s, recv->hdr.bSlot, recv->hdr.bSeq); 959f1ae32a1SGerd Hoffmann return; 960f1ae32a1SGerd Hoffmann } 961f1ae32a1SGerd Hoffmann len = le32_to_cpu(recv->hdr.dwLength); 962f1ae32a1SGerd Hoffmann DPRINTF(s, 1, "%s: seq %d, len %d\n", __func__, 963f1ae32a1SGerd Hoffmann recv->hdr.bSeq, len); 964f1ae32a1SGerd Hoffmann ccid_add_pending_answer(s, (CCID_Header *)recv); 965f1ae32a1SGerd Hoffmann if (s->card) { 966f1ae32a1SGerd Hoffmann ccid_card_apdu_from_guest(s->card, recv->abData, len); 967f1ae32a1SGerd Hoffmann } else { 968f1ae32a1SGerd Hoffmann DPRINTF(s, D_WARN, "warning: discarded apdu\n"); 969f1ae32a1SGerd Hoffmann } 970f1ae32a1SGerd Hoffmann } 971f1ae32a1SGerd Hoffmann 9727e1ac5abSAlon Levy static const char *ccid_message_type_to_str(uint8_t type) 9737e1ac5abSAlon Levy { 9747e1ac5abSAlon Levy switch (type) { 9757e1ac5abSAlon Levy case CCID_MESSAGE_TYPE_PC_to_RDR_IccPowerOn: return "IccPowerOn"; 9767e1ac5abSAlon Levy case CCID_MESSAGE_TYPE_PC_to_RDR_IccPowerOff: return "IccPowerOff"; 9777e1ac5abSAlon Levy case CCID_MESSAGE_TYPE_PC_to_RDR_GetSlotStatus: return "GetSlotStatus"; 9787e1ac5abSAlon Levy case CCID_MESSAGE_TYPE_PC_to_RDR_XfrBlock: return "XfrBlock"; 9797e1ac5abSAlon Levy case CCID_MESSAGE_TYPE_PC_to_RDR_GetParameters: return "GetParameters"; 9807e1ac5abSAlon Levy case CCID_MESSAGE_TYPE_PC_to_RDR_ResetParameters: return "ResetParameters"; 9817e1ac5abSAlon Levy case CCID_MESSAGE_TYPE_PC_to_RDR_SetParameters: return "SetParameters"; 9827e1ac5abSAlon Levy case CCID_MESSAGE_TYPE_PC_to_RDR_Escape: return "Escape"; 9837e1ac5abSAlon Levy case CCID_MESSAGE_TYPE_PC_to_RDR_IccClock: return "IccClock"; 9847e1ac5abSAlon Levy case CCID_MESSAGE_TYPE_PC_to_RDR_T0APDU: return "T0APDU"; 9857e1ac5abSAlon Levy case CCID_MESSAGE_TYPE_PC_to_RDR_Secure: return "Secure"; 9867e1ac5abSAlon Levy case CCID_MESSAGE_TYPE_PC_to_RDR_Mechanical: return "Mechanical"; 9877e1ac5abSAlon Levy case CCID_MESSAGE_TYPE_PC_to_RDR_Abort: return "Abort"; 9887e1ac5abSAlon Levy case CCID_MESSAGE_TYPE_PC_to_RDR_SetDataRateAndClockFrequency: 9897e1ac5abSAlon Levy return "SetDataRateAndClockFrequency"; 9907e1ac5abSAlon Levy } 9917e1ac5abSAlon Levy return "unknown"; 9927e1ac5abSAlon Levy } 9937e1ac5abSAlon Levy 9949a77a0f5SHans de Goede static void ccid_handle_bulk_out(USBCCIDState *s, USBPacket *p) 995f1ae32a1SGerd Hoffmann { 996f1ae32a1SGerd Hoffmann CCID_Header *ccid_header; 997f1ae32a1SGerd Hoffmann 998f1ae32a1SGerd Hoffmann if (p->iov.size + s->bulk_out_pos > BULK_OUT_DATA_SIZE) { 9999a77a0f5SHans de Goede p->status = USB_RET_STALL; 10009a77a0f5SHans de Goede return; 1001f1ae32a1SGerd Hoffmann } 1002f1ae32a1SGerd Hoffmann ccid_header = (CCID_Header *)s->bulk_out_data; 1003f1ae32a1SGerd Hoffmann usb_packet_copy(p, s->bulk_out_data + s->bulk_out_pos, p->iov.size); 1004f1ae32a1SGerd Hoffmann s->bulk_out_pos += p->iov.size; 1005f1ae32a1SGerd Hoffmann if (p->iov.size == CCID_MAX_PACKET_SIZE) { 1006f1ae32a1SGerd Hoffmann DPRINTF(s, D_VERBOSE, 1007f1ae32a1SGerd Hoffmann "usb-ccid: bulk_in: expecting more packets (%zd/%d)\n", 1008f1ae32a1SGerd Hoffmann p->iov.size, ccid_header->dwLength); 10099a77a0f5SHans de Goede return; 1010f1ae32a1SGerd Hoffmann } 1011f1ae32a1SGerd Hoffmann if (s->bulk_out_pos < 10) { 1012f1ae32a1SGerd Hoffmann DPRINTF(s, 1, 1013f1ae32a1SGerd Hoffmann "%s: bad USB_TOKEN_OUT length, should be at least 10 bytes\n", 1014f1ae32a1SGerd Hoffmann __func__); 1015f1ae32a1SGerd Hoffmann } else { 10167e1ac5abSAlon Levy DPRINTF(s, D_MORE_INFO, "%s %x %s\n", __func__, 10177e1ac5abSAlon Levy ccid_header->bMessageType, 10187e1ac5abSAlon Levy ccid_message_type_to_str(ccid_header->bMessageType)); 1019f1ae32a1SGerd Hoffmann switch (ccid_header->bMessageType) { 1020f1ae32a1SGerd Hoffmann case CCID_MESSAGE_TYPE_PC_to_RDR_GetSlotStatus: 1021f1ae32a1SGerd Hoffmann ccid_write_slot_status(s, ccid_header); 1022f1ae32a1SGerd Hoffmann break; 1023f1ae32a1SGerd Hoffmann case CCID_MESSAGE_TYPE_PC_to_RDR_IccPowerOn: 10247e1ac5abSAlon Levy DPRINTF(s, 1, "%s: PowerOn: %d\n", __func__, 1025f1ae32a1SGerd Hoffmann ((CCID_IccPowerOn *)(ccid_header))->bPowerSelect); 1026f1ae32a1SGerd Hoffmann s->powered = true; 1027f1ae32a1SGerd Hoffmann if (!ccid_card_inserted(s)) { 1028f1ae32a1SGerd Hoffmann ccid_report_error_failed(s, ERROR_ICC_MUTE); 1029f1ae32a1SGerd Hoffmann } 1030f1ae32a1SGerd Hoffmann /* atr is written regardless of error. */ 1031f1ae32a1SGerd Hoffmann ccid_write_data_block_atr(s, ccid_header); 1032f1ae32a1SGerd Hoffmann break; 1033f1ae32a1SGerd Hoffmann case CCID_MESSAGE_TYPE_PC_to_RDR_IccPowerOff: 1034f1ae32a1SGerd Hoffmann ccid_reset_error_status(s); 1035f1ae32a1SGerd Hoffmann s->powered = false; 1036f1ae32a1SGerd Hoffmann ccid_write_slot_status(s, ccid_header); 1037f1ae32a1SGerd Hoffmann break; 1038f1ae32a1SGerd Hoffmann case CCID_MESSAGE_TYPE_PC_to_RDR_XfrBlock: 1039f1ae32a1SGerd Hoffmann ccid_on_apdu_from_guest(s, (CCID_XferBlock *)s->bulk_out_data); 1040f1ae32a1SGerd Hoffmann break; 1041f1ae32a1SGerd Hoffmann case CCID_MESSAGE_TYPE_PC_to_RDR_SetParameters: 1042f1ae32a1SGerd Hoffmann ccid_reset_error_status(s); 1043f1ae32a1SGerd Hoffmann ccid_set_parameters(s, ccid_header); 1044f1ae32a1SGerd Hoffmann ccid_write_parameters(s, ccid_header); 1045f1ae32a1SGerd Hoffmann break; 1046f1ae32a1SGerd Hoffmann case CCID_MESSAGE_TYPE_PC_to_RDR_ResetParameters: 1047f1ae32a1SGerd Hoffmann ccid_reset_error_status(s); 1048f1ae32a1SGerd Hoffmann ccid_reset_parameters(s); 1049f1ae32a1SGerd Hoffmann ccid_write_parameters(s, ccid_header); 1050f1ae32a1SGerd Hoffmann break; 1051f1ae32a1SGerd Hoffmann case CCID_MESSAGE_TYPE_PC_to_RDR_GetParameters: 1052f1ae32a1SGerd Hoffmann ccid_reset_error_status(s); 1053f1ae32a1SGerd Hoffmann ccid_write_parameters(s, ccid_header); 1054f1ae32a1SGerd Hoffmann break; 105558aeda15SAlon Levy case CCID_MESSAGE_TYPE_PC_to_RDR_Mechanical: 105658aeda15SAlon Levy ccid_report_error_failed(s, 0); 105758aeda15SAlon Levy ccid_write_slot_status(s, ccid_header); 105858aeda15SAlon Levy break; 1059f1ae32a1SGerd Hoffmann default: 1060f1ae32a1SGerd Hoffmann DPRINTF(s, 1, 1061f1ae32a1SGerd Hoffmann "handle_data: ERROR: unhandled message type %Xh\n", 1062f1ae32a1SGerd Hoffmann ccid_header->bMessageType); 1063f1ae32a1SGerd Hoffmann /* 1064f1ae32a1SGerd Hoffmann * The caller is expecting the device to respond, tell it we 1065f1ae32a1SGerd Hoffmann * don't support the operation. 1066f1ae32a1SGerd Hoffmann */ 1067f1ae32a1SGerd Hoffmann ccid_report_error_failed(s, ERROR_CMD_NOT_SUPPORTED); 1068f1ae32a1SGerd Hoffmann ccid_write_slot_status(s, ccid_header); 1069f1ae32a1SGerd Hoffmann break; 1070f1ae32a1SGerd Hoffmann } 1071f1ae32a1SGerd Hoffmann } 1072f1ae32a1SGerd Hoffmann s->bulk_out_pos = 0; 1073f1ae32a1SGerd Hoffmann } 1074f1ae32a1SGerd Hoffmann 10759a77a0f5SHans de Goede static void ccid_bulk_in_copy_to_guest(USBCCIDState *s, USBPacket *p) 1076f1ae32a1SGerd Hoffmann { 10779a77a0f5SHans de Goede int len = 0; 1078f1ae32a1SGerd Hoffmann 1079f1ae32a1SGerd Hoffmann ccid_bulk_in_get(s); 1080f1ae32a1SGerd Hoffmann if (s->current_bulk_in != NULL) { 10819a77a0f5SHans de Goede len = MIN(s->current_bulk_in->len - s->current_bulk_in->pos, 1082f1ae32a1SGerd Hoffmann p->iov.size); 1083f1ae32a1SGerd Hoffmann usb_packet_copy(p, s->current_bulk_in->data + 10849a77a0f5SHans de Goede s->current_bulk_in->pos, len); 10859a77a0f5SHans de Goede s->current_bulk_in->pos += len; 1086f1ae32a1SGerd Hoffmann if (s->current_bulk_in->pos == s->current_bulk_in->len) { 1087f1ae32a1SGerd Hoffmann ccid_bulk_in_release(s); 1088f1ae32a1SGerd Hoffmann } 1089f1ae32a1SGerd Hoffmann } else { 1090f1ae32a1SGerd Hoffmann /* return when device has no data - usb 2.0 spec Table 8-4 */ 10919a77a0f5SHans de Goede p->status = USB_RET_NAK; 1092f1ae32a1SGerd Hoffmann } 10939a77a0f5SHans de Goede if (len) { 1094f1ae32a1SGerd Hoffmann DPRINTF(s, D_MORE_INFO, 1095f1ae32a1SGerd Hoffmann "%s: %zd/%d req/act to guest (BULK_IN)\n", 10969a77a0f5SHans de Goede __func__, p->iov.size, len); 1097f1ae32a1SGerd Hoffmann } 10989a77a0f5SHans de Goede if (len < p->iov.size) { 1099f1ae32a1SGerd Hoffmann DPRINTF(s, 1, 1100f1ae32a1SGerd Hoffmann "%s: returning short (EREMOTEIO) %d < %zd\n", 11019a77a0f5SHans de Goede __func__, len, p->iov.size); 1102f1ae32a1SGerd Hoffmann } 1103f1ae32a1SGerd Hoffmann } 1104f1ae32a1SGerd Hoffmann 11059a77a0f5SHans de Goede static void ccid_handle_data(USBDevice *dev, USBPacket *p) 1106f1ae32a1SGerd Hoffmann { 1107*61b4887bSGonglei USBCCIDState *s = USB_CCID_DEV(dev); 1108f1ae32a1SGerd Hoffmann uint8_t buf[2]; 1109f1ae32a1SGerd Hoffmann 1110f1ae32a1SGerd Hoffmann switch (p->pid) { 1111f1ae32a1SGerd Hoffmann case USB_TOKEN_OUT: 11129a77a0f5SHans de Goede ccid_handle_bulk_out(s, p); 1113f1ae32a1SGerd Hoffmann break; 1114f1ae32a1SGerd Hoffmann 1115f1ae32a1SGerd Hoffmann case USB_TOKEN_IN: 1116f1ae32a1SGerd Hoffmann switch (p->ep->nr) { 1117f1ae32a1SGerd Hoffmann case CCID_BULK_IN_EP: 11189a77a0f5SHans de Goede ccid_bulk_in_copy_to_guest(s, p); 1119f1ae32a1SGerd Hoffmann break; 1120f1ae32a1SGerd Hoffmann case CCID_INT_IN_EP: 1121f1ae32a1SGerd Hoffmann if (s->notify_slot_change) { 1122f1ae32a1SGerd Hoffmann /* page 56, RDR_to_PC_NotifySlotChange */ 1123f1ae32a1SGerd Hoffmann buf[0] = CCID_MESSAGE_TYPE_RDR_to_PC_NotifySlotChange; 1124f1ae32a1SGerd Hoffmann buf[1] = s->bmSlotICCState; 1125f1ae32a1SGerd Hoffmann usb_packet_copy(p, buf, 2); 1126f1ae32a1SGerd Hoffmann s->notify_slot_change = false; 1127f1ae32a1SGerd Hoffmann s->bmSlotICCState &= ~SLOT_0_CHANGED_MASK; 1128f1ae32a1SGerd Hoffmann DPRINTF(s, D_INFO, 1129f1ae32a1SGerd Hoffmann "handle_data: int_in: notify_slot_change %X, " 1130f1ae32a1SGerd Hoffmann "requested len %zd\n", 1131f1ae32a1SGerd Hoffmann s->bmSlotICCState, p->iov.size); 1132c4020746SHans de Goede } else { 1133c4020746SHans de Goede p->status = USB_RET_NAK; 1134f1ae32a1SGerd Hoffmann } 1135f1ae32a1SGerd Hoffmann break; 1136f1ae32a1SGerd Hoffmann default: 1137f1ae32a1SGerd Hoffmann DPRINTF(s, 1, "Bad endpoint\n"); 11389a77a0f5SHans de Goede p->status = USB_RET_STALL; 1139f1ae32a1SGerd Hoffmann break; 1140f1ae32a1SGerd Hoffmann } 1141f1ae32a1SGerd Hoffmann break; 1142f1ae32a1SGerd Hoffmann default: 1143f1ae32a1SGerd Hoffmann DPRINTF(s, 1, "Bad token\n"); 11449a77a0f5SHans de Goede p->status = USB_RET_STALL; 1145f1ae32a1SGerd Hoffmann break; 1146f1ae32a1SGerd Hoffmann } 1147f1ae32a1SGerd Hoffmann } 1148f1ae32a1SGerd Hoffmann 1149f1ae32a1SGerd Hoffmann static void ccid_handle_destroy(USBDevice *dev) 1150f1ae32a1SGerd Hoffmann { 1151*61b4887bSGonglei USBCCIDState *s = USB_CCID_DEV(dev); 1152f1ae32a1SGerd Hoffmann 1153f1ae32a1SGerd Hoffmann ccid_bulk_in_clear(s); 1154f1ae32a1SGerd Hoffmann } 1155f1ae32a1SGerd Hoffmann 1156f1ae32a1SGerd Hoffmann static void ccid_flush_pending_answers(USBCCIDState *s) 1157f1ae32a1SGerd Hoffmann { 1158f1ae32a1SGerd Hoffmann while (ccid_has_pending_answers(s)) { 1159f1ae32a1SGerd Hoffmann ccid_write_data_block_answer(s, NULL, 0); 1160f1ae32a1SGerd Hoffmann } 1161f1ae32a1SGerd Hoffmann } 1162f1ae32a1SGerd Hoffmann 1163f1ae32a1SGerd Hoffmann static Answer *ccid_peek_next_answer(USBCCIDState *s) 1164f1ae32a1SGerd Hoffmann { 1165f1ae32a1SGerd Hoffmann return s->pending_answers_num == 0 1166f1ae32a1SGerd Hoffmann ? NULL 1167f1ae32a1SGerd Hoffmann : &s->pending_answers[s->pending_answers_start % PENDING_ANSWERS_NUM]; 1168f1ae32a1SGerd Hoffmann } 1169f1ae32a1SGerd Hoffmann 11703cb75a7cSPaolo Bonzini static Property ccid_props[] = { 11713cb75a7cSPaolo Bonzini DEFINE_PROP_UINT32("slot", struct CCIDCardState, slot, 0), 11723cb75a7cSPaolo Bonzini DEFINE_PROP_END_OF_LIST(), 11733cb75a7cSPaolo Bonzini }; 11743cb75a7cSPaolo Bonzini 11750d936928SAnthony Liguori #define TYPE_CCID_BUS "ccid-bus" 11760d936928SAnthony Liguori #define CCID_BUS(obj) OBJECT_CHECK(CCIDBus, (obj), TYPE_CCID_BUS) 11770d936928SAnthony Liguori 11780d936928SAnthony Liguori static const TypeInfo ccid_bus_info = { 11790d936928SAnthony Liguori .name = TYPE_CCID_BUS, 11800d936928SAnthony Liguori .parent = TYPE_BUS, 11810d936928SAnthony Liguori .instance_size = sizeof(CCIDBus), 1182f1ae32a1SGerd Hoffmann }; 1183f1ae32a1SGerd Hoffmann 1184f1ae32a1SGerd Hoffmann void ccid_card_send_apdu_to_guest(CCIDCardState *card, 1185f1ae32a1SGerd Hoffmann uint8_t *apdu, uint32_t len) 1186f1ae32a1SGerd Hoffmann { 1187*61b4887bSGonglei DeviceState *qdev = DEVICE(card); 1188*61b4887bSGonglei USBDevice *dev = USB_DEVICE(qdev); 1189*61b4887bSGonglei USBCCIDState *s = USB_CCID_DEV(dev); 1190f1ae32a1SGerd Hoffmann Answer *answer; 1191f1ae32a1SGerd Hoffmann 1192f1ae32a1SGerd Hoffmann if (!ccid_has_pending_answers(s)) { 1193f1ae32a1SGerd Hoffmann DPRINTF(s, 1, "CCID ERROR: got an APDU without pending answers\n"); 1194f1ae32a1SGerd Hoffmann return; 1195f1ae32a1SGerd Hoffmann } 1196f1ae32a1SGerd Hoffmann s->bmCommandStatus = COMMAND_STATUS_NO_ERROR; 1197f1ae32a1SGerd Hoffmann answer = ccid_peek_next_answer(s); 1198f1ae32a1SGerd Hoffmann if (answer == NULL) { 119947bf53afSAlon Levy DPRINTF(s, D_WARN, "%s: error: unexpected lack of answer\n", __func__); 120047bf53afSAlon Levy ccid_report_error_failed(s, ERROR_HW_ERROR); 120147bf53afSAlon Levy return; 1202f1ae32a1SGerd Hoffmann } 1203f1ae32a1SGerd Hoffmann DPRINTF(s, 1, "APDU returned to guest %d (answer seq %d, slot %d)\n", 1204f1ae32a1SGerd Hoffmann len, answer->seq, answer->slot); 1205f1ae32a1SGerd Hoffmann ccid_write_data_block_answer(s, apdu, len); 1206f1ae32a1SGerd Hoffmann } 1207f1ae32a1SGerd Hoffmann 1208f1ae32a1SGerd Hoffmann void ccid_card_card_removed(CCIDCardState *card) 1209f1ae32a1SGerd Hoffmann { 1210*61b4887bSGonglei DeviceState *qdev = DEVICE(card); 1211*61b4887bSGonglei USBDevice *dev = USB_DEVICE(qdev); 1212*61b4887bSGonglei USBCCIDState *s = USB_CCID_DEV(dev); 1213f1ae32a1SGerd Hoffmann 1214f1ae32a1SGerd Hoffmann ccid_on_slot_change(s, false); 1215f1ae32a1SGerd Hoffmann ccid_flush_pending_answers(s); 1216f1ae32a1SGerd Hoffmann ccid_reset(s); 1217f1ae32a1SGerd Hoffmann } 1218f1ae32a1SGerd Hoffmann 1219f1ae32a1SGerd Hoffmann int ccid_card_ccid_attach(CCIDCardState *card) 1220f1ae32a1SGerd Hoffmann { 1221*61b4887bSGonglei DeviceState *qdev = DEVICE(card); 1222*61b4887bSGonglei USBDevice *dev = USB_DEVICE(qdev); 1223*61b4887bSGonglei USBCCIDState *s = USB_CCID_DEV(dev); 1224f1ae32a1SGerd Hoffmann 1225f1ae32a1SGerd Hoffmann DPRINTF(s, 1, "CCID Attach\n"); 1226f1ae32a1SGerd Hoffmann if (s->migration_state == MIGRATION_MIGRATED) { 1227f1ae32a1SGerd Hoffmann s->migration_state = MIGRATION_NONE; 1228f1ae32a1SGerd Hoffmann } 1229f1ae32a1SGerd Hoffmann return 0; 1230f1ae32a1SGerd Hoffmann } 1231f1ae32a1SGerd Hoffmann 1232f1ae32a1SGerd Hoffmann void ccid_card_ccid_detach(CCIDCardState *card) 1233f1ae32a1SGerd Hoffmann { 1234*61b4887bSGonglei DeviceState *qdev = DEVICE(card); 1235*61b4887bSGonglei USBDevice *dev = USB_DEVICE(qdev); 1236*61b4887bSGonglei USBCCIDState *s = USB_CCID_DEV(dev); 1237f1ae32a1SGerd Hoffmann 1238f1ae32a1SGerd Hoffmann DPRINTF(s, 1, "CCID Detach\n"); 1239f1ae32a1SGerd Hoffmann if (ccid_card_inserted(s)) { 1240f1ae32a1SGerd Hoffmann ccid_on_slot_change(s, false); 1241f1ae32a1SGerd Hoffmann } 1242f1ae32a1SGerd Hoffmann ccid_detach(s); 1243f1ae32a1SGerd Hoffmann } 1244f1ae32a1SGerd Hoffmann 1245f1ae32a1SGerd Hoffmann void ccid_card_card_error(CCIDCardState *card, uint64_t error) 1246f1ae32a1SGerd Hoffmann { 1247*61b4887bSGonglei DeviceState *qdev = DEVICE(card); 1248*61b4887bSGonglei USBDevice *dev = USB_DEVICE(qdev); 1249*61b4887bSGonglei USBCCIDState *s = USB_CCID_DEV(dev); 1250f1ae32a1SGerd Hoffmann 1251f1ae32a1SGerd Hoffmann s->bmCommandStatus = COMMAND_STATUS_FAILED; 1252f1ae32a1SGerd Hoffmann s->last_answer_error = error; 1253f1ae32a1SGerd Hoffmann DPRINTF(s, 1, "VSC_Error: %" PRIX64 "\n", s->last_answer_error); 1254f1ae32a1SGerd Hoffmann /* TODO: these errors should be more verbose and propagated to the guest.*/ 1255f1ae32a1SGerd Hoffmann /* 1256f1ae32a1SGerd Hoffmann * We flush all pending answers on CardRemove message in ccid-card-passthru, 1257f1ae32a1SGerd Hoffmann * so check that first to not trigger abort 1258f1ae32a1SGerd Hoffmann */ 1259f1ae32a1SGerd Hoffmann if (ccid_has_pending_answers(s)) { 1260f1ae32a1SGerd Hoffmann ccid_write_data_block_answer(s, NULL, 0); 1261f1ae32a1SGerd Hoffmann } 1262f1ae32a1SGerd Hoffmann } 1263f1ae32a1SGerd Hoffmann 1264f1ae32a1SGerd Hoffmann void ccid_card_card_inserted(CCIDCardState *card) 1265f1ae32a1SGerd Hoffmann { 1266*61b4887bSGonglei DeviceState *qdev = DEVICE(card); 1267*61b4887bSGonglei USBDevice *dev = USB_DEVICE(qdev); 1268*61b4887bSGonglei USBCCIDState *s = USB_CCID_DEV(dev); 1269f1ae32a1SGerd Hoffmann 1270f1ae32a1SGerd Hoffmann s->bmCommandStatus = COMMAND_STATUS_NO_ERROR; 1271f1ae32a1SGerd Hoffmann ccid_flush_pending_answers(s); 1272f1ae32a1SGerd Hoffmann ccid_on_slot_change(s, true); 1273f1ae32a1SGerd Hoffmann } 1274f1ae32a1SGerd Hoffmann 1275f1ae32a1SGerd Hoffmann static int ccid_card_exit(DeviceState *qdev) 1276f1ae32a1SGerd Hoffmann { 1277f1ae32a1SGerd Hoffmann int ret = 0; 1278f1ae32a1SGerd Hoffmann CCIDCardState *card = CCID_CARD(qdev); 1279*61b4887bSGonglei USBDevice *dev = USB_DEVICE(qdev); 1280*61b4887bSGonglei USBCCIDState *s = USB_CCID_DEV(dev); 1281f1ae32a1SGerd Hoffmann 1282f1ae32a1SGerd Hoffmann if (ccid_card_inserted(s)) { 1283f1ae32a1SGerd Hoffmann ccid_card_card_removed(card); 1284f1ae32a1SGerd Hoffmann } 1285f1ae32a1SGerd Hoffmann ret = ccid_card_exitfn(card); 1286f1ae32a1SGerd Hoffmann s->card = NULL; 1287f1ae32a1SGerd Hoffmann return ret; 1288f1ae32a1SGerd Hoffmann } 1289f1ae32a1SGerd Hoffmann 1290f1ae32a1SGerd Hoffmann static int ccid_card_init(DeviceState *qdev) 1291f1ae32a1SGerd Hoffmann { 1292f1ae32a1SGerd Hoffmann CCIDCardState *card = CCID_CARD(qdev); 1293*61b4887bSGonglei USBDevice *dev = USB_DEVICE(qdev); 1294*61b4887bSGonglei USBCCIDState *s = USB_CCID_DEV(dev); 1295f1ae32a1SGerd Hoffmann int ret = 0; 1296f1ae32a1SGerd Hoffmann 1297f1ae32a1SGerd Hoffmann if (card->slot != 0) { 1298f1ae32a1SGerd Hoffmann error_report("Warning: usb-ccid supports one slot, can't add %d", 1299f1ae32a1SGerd Hoffmann card->slot); 1300f1ae32a1SGerd Hoffmann return -1; 1301f1ae32a1SGerd Hoffmann } 1302f1ae32a1SGerd Hoffmann if (s->card != NULL) { 1303f1ae32a1SGerd Hoffmann error_report("Warning: usb-ccid card already full, not adding"); 1304f1ae32a1SGerd Hoffmann return -1; 1305f1ae32a1SGerd Hoffmann } 1306f1ae32a1SGerd Hoffmann ret = ccid_card_initfn(card); 1307f1ae32a1SGerd Hoffmann if (ret == 0) { 1308f1ae32a1SGerd Hoffmann s->card = card; 1309f1ae32a1SGerd Hoffmann } 1310f1ae32a1SGerd Hoffmann return ret; 1311f1ae32a1SGerd Hoffmann } 1312f1ae32a1SGerd Hoffmann 13130b8b863fSGonglei static void ccid_realize(USBDevice *dev, Error **errp) 1314f1ae32a1SGerd Hoffmann { 1315*61b4887bSGonglei USBCCIDState *s = USB_CCID_DEV(dev); 1316f1ae32a1SGerd Hoffmann 13179d55d1adSGerd Hoffmann usb_desc_create_serial(dev); 1318f1ae32a1SGerd Hoffmann usb_desc_init(dev); 1319fb17dfe0SAndreas Färber qbus_create_inplace(&s->bus, sizeof(s->bus), TYPE_CCID_BUS, DEVICE(dev), 1320fb17dfe0SAndreas Färber NULL); 1321138d587aSIgor Mammedov qbus_set_hotplug_handler(BUS(&s->bus), DEVICE(dev), &error_abort); 1322f1ae32a1SGerd Hoffmann s->intr = usb_ep_get(dev, USB_TOKEN_IN, CCID_INT_IN_EP); 1323f1ae32a1SGerd Hoffmann s->card = NULL; 1324f1ae32a1SGerd Hoffmann s->migration_state = MIGRATION_NONE; 1325f1ae32a1SGerd Hoffmann s->migration_target_ip = 0; 1326f1ae32a1SGerd Hoffmann s->migration_target_port = 0; 1327f1ae32a1SGerd Hoffmann s->dev.speed = USB_SPEED_FULL; 1328f1ae32a1SGerd Hoffmann s->dev.speedmask = USB_SPEED_MASK_FULL; 1329f1ae32a1SGerd Hoffmann s->notify_slot_change = false; 1330f1ae32a1SGerd Hoffmann s->powered = true; 1331f1ae32a1SGerd Hoffmann s->pending_answers_num = 0; 1332f1ae32a1SGerd Hoffmann s->last_answer_error = 0; 1333f1ae32a1SGerd Hoffmann s->bulk_in_pending_start = 0; 1334f1ae32a1SGerd Hoffmann s->bulk_in_pending_end = 0; 1335f1ae32a1SGerd Hoffmann s->current_bulk_in = NULL; 1336f1ae32a1SGerd Hoffmann ccid_reset_error_status(s); 1337f1ae32a1SGerd Hoffmann s->bulk_out_pos = 0; 1338f1ae32a1SGerd Hoffmann ccid_reset_parameters(s); 1339f1ae32a1SGerd Hoffmann ccid_reset(s); 1340b16352acSAlon Levy s->debug = parse_debug_env("QEMU_CCID_DEBUG", D_VERBOSE, s->debug); 1341f1ae32a1SGerd Hoffmann } 1342f1ae32a1SGerd Hoffmann 1343f1ae32a1SGerd Hoffmann static int ccid_post_load(void *opaque, int version_id) 1344f1ae32a1SGerd Hoffmann { 1345f1ae32a1SGerd Hoffmann USBCCIDState *s = opaque; 1346f1ae32a1SGerd Hoffmann 1347f1ae32a1SGerd Hoffmann /* 1348f1ae32a1SGerd Hoffmann * This must be done after usb_device_attach, which sets state to ATTACHED, 1349f1ae32a1SGerd Hoffmann * while it must be DEFAULT in order to accept packets (like it is after 1350f1ae32a1SGerd Hoffmann * reset, but reset will reset our addr and call our reset handler which 1351f1ae32a1SGerd Hoffmann * may change state, and we don't want to do that when migrating). 1352f1ae32a1SGerd Hoffmann */ 1353f1ae32a1SGerd Hoffmann s->dev.state = s->state_vmstate; 1354f1ae32a1SGerd Hoffmann return 0; 1355f1ae32a1SGerd Hoffmann } 1356f1ae32a1SGerd Hoffmann 1357f1ae32a1SGerd Hoffmann static void ccid_pre_save(void *opaque) 1358f1ae32a1SGerd Hoffmann { 1359f1ae32a1SGerd Hoffmann USBCCIDState *s = opaque; 1360f1ae32a1SGerd Hoffmann 1361f1ae32a1SGerd Hoffmann s->state_vmstate = s->dev.state; 1362f1ae32a1SGerd Hoffmann if (s->dev.attached) { 1363f1ae32a1SGerd Hoffmann /* 1364f1ae32a1SGerd Hoffmann * Migrating an open device, ignore reconnection CHR_EVENT to avoid an 1365f1ae32a1SGerd Hoffmann * erroneous detach. 1366f1ae32a1SGerd Hoffmann */ 1367f1ae32a1SGerd Hoffmann s->migration_state = MIGRATION_MIGRATED; 1368f1ae32a1SGerd Hoffmann } 1369f1ae32a1SGerd Hoffmann } 1370f1ae32a1SGerd Hoffmann 1371f1ae32a1SGerd Hoffmann static VMStateDescription bulk_in_vmstate = { 1372f1ae32a1SGerd Hoffmann .name = "CCID BulkIn state", 1373f1ae32a1SGerd Hoffmann .version_id = 1, 1374f1ae32a1SGerd Hoffmann .minimum_version_id = 1, 1375f1ae32a1SGerd Hoffmann .fields = (VMStateField[]) { 1376f1ae32a1SGerd Hoffmann VMSTATE_BUFFER(data, BulkIn), 1377f1ae32a1SGerd Hoffmann VMSTATE_UINT32(len, BulkIn), 1378f1ae32a1SGerd Hoffmann VMSTATE_UINT32(pos, BulkIn), 1379f1ae32a1SGerd Hoffmann VMSTATE_END_OF_LIST() 1380f1ae32a1SGerd Hoffmann } 1381f1ae32a1SGerd Hoffmann }; 1382f1ae32a1SGerd Hoffmann 1383f1ae32a1SGerd Hoffmann static VMStateDescription answer_vmstate = { 1384f1ae32a1SGerd Hoffmann .name = "CCID Answer state", 1385f1ae32a1SGerd Hoffmann .version_id = 1, 1386f1ae32a1SGerd Hoffmann .minimum_version_id = 1, 1387f1ae32a1SGerd Hoffmann .fields = (VMStateField[]) { 1388f1ae32a1SGerd Hoffmann VMSTATE_UINT8(slot, Answer), 1389f1ae32a1SGerd Hoffmann VMSTATE_UINT8(seq, Answer), 1390f1ae32a1SGerd Hoffmann VMSTATE_END_OF_LIST() 1391f1ae32a1SGerd Hoffmann } 1392f1ae32a1SGerd Hoffmann }; 1393f1ae32a1SGerd Hoffmann 1394f1ae32a1SGerd Hoffmann static VMStateDescription usb_device_vmstate = { 1395f1ae32a1SGerd Hoffmann .name = "usb_device", 1396f1ae32a1SGerd Hoffmann .version_id = 1, 1397f1ae32a1SGerd Hoffmann .minimum_version_id = 1, 1398f1ae32a1SGerd Hoffmann .fields = (VMStateField[]) { 1399f1ae32a1SGerd Hoffmann VMSTATE_UINT8(addr, USBDevice), 1400f1ae32a1SGerd Hoffmann VMSTATE_BUFFER(setup_buf, USBDevice), 1401f1ae32a1SGerd Hoffmann VMSTATE_BUFFER(data_buf, USBDevice), 1402f1ae32a1SGerd Hoffmann VMSTATE_END_OF_LIST() 1403f1ae32a1SGerd Hoffmann } 1404f1ae32a1SGerd Hoffmann }; 1405f1ae32a1SGerd Hoffmann 1406f1ae32a1SGerd Hoffmann static VMStateDescription ccid_vmstate = { 14076783ecf1SPeter Maydell .name = "usb-ccid", 1408f1ae32a1SGerd Hoffmann .version_id = 1, 1409f1ae32a1SGerd Hoffmann .minimum_version_id = 1, 1410f1ae32a1SGerd Hoffmann .post_load = ccid_post_load, 1411f1ae32a1SGerd Hoffmann .pre_save = ccid_pre_save, 1412f1ae32a1SGerd Hoffmann .fields = (VMStateField[]) { 1413f1ae32a1SGerd Hoffmann VMSTATE_STRUCT(dev, USBCCIDState, 1, usb_device_vmstate, USBDevice), 1414f1ae32a1SGerd Hoffmann VMSTATE_UINT8(debug, USBCCIDState), 1415f1ae32a1SGerd Hoffmann VMSTATE_BUFFER(bulk_out_data, USBCCIDState), 1416f1ae32a1SGerd Hoffmann VMSTATE_UINT32(bulk_out_pos, USBCCIDState), 1417f1ae32a1SGerd Hoffmann VMSTATE_UINT8(bmSlotICCState, USBCCIDState), 1418f1ae32a1SGerd Hoffmann VMSTATE_UINT8(powered, USBCCIDState), 1419f1ae32a1SGerd Hoffmann VMSTATE_UINT8(notify_slot_change, USBCCIDState), 1420f1ae32a1SGerd Hoffmann VMSTATE_UINT64(last_answer_error, USBCCIDState), 1421f1ae32a1SGerd Hoffmann VMSTATE_UINT8(bError, USBCCIDState), 1422f1ae32a1SGerd Hoffmann VMSTATE_UINT8(bmCommandStatus, USBCCIDState), 1423f1ae32a1SGerd Hoffmann VMSTATE_UINT8(bProtocolNum, USBCCIDState), 14244942d6c3SAlon Levy VMSTATE_BUFFER(abProtocolDataStructure.data, USBCCIDState), 1425f1ae32a1SGerd Hoffmann VMSTATE_UINT32(ulProtocolDataStructureSize, USBCCIDState), 1426f1ae32a1SGerd Hoffmann VMSTATE_STRUCT_ARRAY(bulk_in_pending, USBCCIDState, 1427f1ae32a1SGerd Hoffmann BULK_IN_PENDING_NUM, 1, bulk_in_vmstate, BulkIn), 1428f1ae32a1SGerd Hoffmann VMSTATE_UINT32(bulk_in_pending_start, USBCCIDState), 1429f1ae32a1SGerd Hoffmann VMSTATE_UINT32(bulk_in_pending_end, USBCCIDState), 1430f1ae32a1SGerd Hoffmann VMSTATE_STRUCT_ARRAY(pending_answers, USBCCIDState, 1431f1ae32a1SGerd Hoffmann PENDING_ANSWERS_NUM, 1, answer_vmstate, Answer), 1432f1ae32a1SGerd Hoffmann VMSTATE_UINT32(pending_answers_num, USBCCIDState), 1433f1ae32a1SGerd Hoffmann VMSTATE_UINT8(migration_state, USBCCIDState), 1434f1ae32a1SGerd Hoffmann VMSTATE_UINT32(state_vmstate, USBCCIDState), 1435f1ae32a1SGerd Hoffmann VMSTATE_END_OF_LIST() 1436f1ae32a1SGerd Hoffmann } 1437f1ae32a1SGerd Hoffmann }; 1438f1ae32a1SGerd Hoffmann 1439f1ae32a1SGerd Hoffmann static Property ccid_properties[] = { 1440f1ae32a1SGerd Hoffmann DEFINE_PROP_UINT8("debug", USBCCIDState, debug, 0), 1441f1ae32a1SGerd Hoffmann DEFINE_PROP_END_OF_LIST(), 1442f1ae32a1SGerd Hoffmann }; 1443f1ae32a1SGerd Hoffmann 1444f1ae32a1SGerd Hoffmann static void ccid_class_initfn(ObjectClass *klass, void *data) 1445f1ae32a1SGerd Hoffmann { 1446f1ae32a1SGerd Hoffmann DeviceClass *dc = DEVICE_CLASS(klass); 1447f1ae32a1SGerd Hoffmann USBDeviceClass *uc = USB_DEVICE_CLASS(klass); 1448138d587aSIgor Mammedov HotplugHandlerClass *hc = HOTPLUG_HANDLER_CLASS(klass); 1449f1ae32a1SGerd Hoffmann 14500b8b863fSGonglei uc->realize = ccid_realize; 1451f1ae32a1SGerd Hoffmann uc->product_desc = "QEMU USB CCID"; 1452f1ae32a1SGerd Hoffmann uc->usb_desc = &desc_ccid; 1453f1ae32a1SGerd Hoffmann uc->handle_reset = ccid_handle_reset; 1454f1ae32a1SGerd Hoffmann uc->handle_control = ccid_handle_control; 1455f1ae32a1SGerd Hoffmann uc->handle_data = ccid_handle_data; 1456f1ae32a1SGerd Hoffmann uc->handle_destroy = ccid_handle_destroy; 1457f1ae32a1SGerd Hoffmann dc->desc = "CCID Rev 1.1 smartcard reader"; 1458f1ae32a1SGerd Hoffmann dc->vmsd = &ccid_vmstate; 1459f1ae32a1SGerd Hoffmann dc->props = ccid_properties; 1460125ee0edSMarcel Apfelbaum set_bit(DEVICE_CATEGORY_INPUT, dc->categories); 1461138d587aSIgor Mammedov hc->unplug = qdev_simple_device_unplug_cb; 1462f1ae32a1SGerd Hoffmann } 1463f1ae32a1SGerd Hoffmann 14648c43a6f0SAndreas Färber static const TypeInfo ccid_info = { 1465f1ae32a1SGerd Hoffmann .name = CCID_DEV_NAME, 1466f1ae32a1SGerd Hoffmann .parent = TYPE_USB_DEVICE, 1467f1ae32a1SGerd Hoffmann .instance_size = sizeof(USBCCIDState), 1468f1ae32a1SGerd Hoffmann .class_init = ccid_class_initfn, 1469138d587aSIgor Mammedov .interfaces = (InterfaceInfo[]) { 1470138d587aSIgor Mammedov { TYPE_HOTPLUG_HANDLER }, 1471138d587aSIgor Mammedov { } 1472138d587aSIgor Mammedov } 1473f1ae32a1SGerd Hoffmann }; 1474f1ae32a1SGerd Hoffmann 1475f1ae32a1SGerd Hoffmann static void ccid_card_class_init(ObjectClass *klass, void *data) 1476f1ae32a1SGerd Hoffmann { 1477f1ae32a1SGerd Hoffmann DeviceClass *k = DEVICE_CLASS(klass); 14780d936928SAnthony Liguori k->bus_type = TYPE_CCID_BUS; 1479f1ae32a1SGerd Hoffmann k->init = ccid_card_init; 1480f1ae32a1SGerd Hoffmann k->exit = ccid_card_exit; 1481bce54474SPaolo Bonzini k->props = ccid_props; 1482f1ae32a1SGerd Hoffmann } 1483f1ae32a1SGerd Hoffmann 14848c43a6f0SAndreas Färber static const TypeInfo ccid_card_type_info = { 1485f1ae32a1SGerd Hoffmann .name = TYPE_CCID_CARD, 1486f1ae32a1SGerd Hoffmann .parent = TYPE_DEVICE, 1487f1ae32a1SGerd Hoffmann .instance_size = sizeof(CCIDCardState), 1488f1ae32a1SGerd Hoffmann .abstract = true, 1489f1ae32a1SGerd Hoffmann .class_size = sizeof(CCIDCardClass), 1490f1ae32a1SGerd Hoffmann .class_init = ccid_card_class_init, 1491f1ae32a1SGerd Hoffmann }; 1492f1ae32a1SGerd Hoffmann 1493f1ae32a1SGerd Hoffmann static void ccid_register_types(void) 1494f1ae32a1SGerd Hoffmann { 14950d936928SAnthony Liguori type_register_static(&ccid_bus_info); 1496f1ae32a1SGerd Hoffmann type_register_static(&ccid_card_type_info); 1497f1ae32a1SGerd Hoffmann type_register_static(&ccid_info); 1498f1ae32a1SGerd Hoffmann usb_legacy_register(CCID_DEV_NAME, "ccid", NULL); 1499f1ae32a1SGerd Hoffmann } 1500f1ae32a1SGerd Hoffmann 1501f1ae32a1SGerd Hoffmann type_init(ccid_register_types) 1502