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
37e532b2e0SPeter Maydell #include "qemu/osdep.h"
38246e195bSPhilippe Mathieu-Daudé #include "qemu/units.h"
39da34e65cSMarkus Armbruster #include "qapi/error.h"
40415b7327SMarc-André Lureau #include "qemu/cutils.h"
411de7afc9SPaolo Bonzini #include "qemu/error-report.h"
420b8fa32fSMarkus Armbruster #include "qemu/module.h"
43a27bd6c7SMarkus Armbruster #include "hw/qdev-properties.h"
44f1ae32a1SGerd Hoffmann #include "hw/usb.h"
45d6454270SMarkus Armbruster #include "migration/vmstate.h"
46463581a8SMichael S. Tsirkin #include "desc.h"
47f1ae32a1SGerd Hoffmann
4847b43a1fSPaolo Bonzini #include "ccid.h"
49db1015e9SEduardo Habkost #include "qom/object.h"
50f1ae32a1SGerd Hoffmann
51f1ae32a1SGerd Hoffmann #define DPRINTF(s, lvl, fmt, ...) \
52f1ae32a1SGerd Hoffmann do { \
53f1ae32a1SGerd Hoffmann if (lvl <= s->debug) { \
54f1ae32a1SGerd Hoffmann printf("usb-ccid: " fmt , ## __VA_ARGS__); \
55f1ae32a1SGerd Hoffmann } \
56f1ae32a1SGerd Hoffmann } while (0)
57f1ae32a1SGerd Hoffmann
58f1ae32a1SGerd Hoffmann #define D_WARN 1
59f1ae32a1SGerd Hoffmann #define D_INFO 2
60f1ae32a1SGerd Hoffmann #define D_MORE_INFO 3
61f1ae32a1SGerd Hoffmann #define D_VERBOSE 4
62f1ae32a1SGerd Hoffmann
637f46ed2bSEduardo Habkost #define TYPE_USB_CCID_DEV "usb-ccid"
648063396bSEduardo Habkost OBJECT_DECLARE_SIMPLE_TYPE(USBCCIDState, USB_CCID_DEV)
65f1ae32a1SGerd Hoffmann /*
66f1ae32a1SGerd Hoffmann * The two options for variable sized buffers:
67f1ae32a1SGerd Hoffmann * make them constant size, for large enough constant,
68f1ae32a1SGerd Hoffmann * or handle the migration complexity - VMState doesn't handle this case.
69f1ae32a1SGerd Hoffmann * sizes are expected never to be exceeded, unless guest misbehaves.
70f1ae32a1SGerd Hoffmann */
71246e195bSPhilippe Mathieu-Daudé #define BULK_OUT_DATA_SIZE (64 * KiB)
72f1ae32a1SGerd Hoffmann #define PENDING_ANSWERS_NUM 128
73f1ae32a1SGerd Hoffmann
74f1ae32a1SGerd Hoffmann #define BULK_IN_BUF_SIZE 384
75f1ae32a1SGerd Hoffmann #define BULK_IN_PENDING_NUM 8
76f1ae32a1SGerd Hoffmann
77f1ae32a1SGerd Hoffmann #define CCID_MAX_PACKET_SIZE 64
78f1ae32a1SGerd Hoffmann
79f1ae32a1SGerd Hoffmann #define CCID_CONTROL_ABORT 0x1
80f1ae32a1SGerd Hoffmann #define CCID_CONTROL_GET_CLOCK_FREQUENCIES 0x2
81f1ae32a1SGerd Hoffmann #define CCID_CONTROL_GET_DATA_RATES 0x3
82f1ae32a1SGerd Hoffmann
83f1ae32a1SGerd Hoffmann #define CCID_PRODUCT_DESCRIPTION "QEMU USB CCID"
8493bfef4cSCrístian Viana #define CCID_VENDOR_DESCRIPTION "QEMU"
85f1ae32a1SGerd Hoffmann #define CCID_INTERFACE_NAME "CCID Interface"
86f1ae32a1SGerd Hoffmann #define CCID_SERIAL_NUMBER_STRING "1"
87f1ae32a1SGerd Hoffmann /*
88f1ae32a1SGerd Hoffmann * Using Gemplus Vendor and Product id
89f1ae32a1SGerd Hoffmann * Effect on various drivers:
90f1ae32a1SGerd Hoffmann * usbccid.sys (winxp, others untested) is a class driver so it doesn't care.
91f1ae32a1SGerd Hoffmann * linux has a number of class drivers, but openct filters based on
92f1ae32a1SGerd Hoffmann * vendor/product (/etc/openct.conf under fedora), hence Gemplus.
93f1ae32a1SGerd Hoffmann */
94f1ae32a1SGerd Hoffmann #define CCID_VENDOR_ID 0x08e6
95f1ae32a1SGerd Hoffmann #define CCID_PRODUCT_ID 0x4433
96f1ae32a1SGerd Hoffmann #define CCID_DEVICE_VERSION 0x0000
97f1ae32a1SGerd Hoffmann
98f1ae32a1SGerd Hoffmann /*
99f1ae32a1SGerd Hoffmann * BULK_OUT messages from PC to Reader
100f1ae32a1SGerd Hoffmann * Defined in CCID Rev 1.1 6.1 (page 26)
101f1ae32a1SGerd Hoffmann */
102f1ae32a1SGerd Hoffmann #define CCID_MESSAGE_TYPE_PC_to_RDR_IccPowerOn 0x62
103f1ae32a1SGerd Hoffmann #define CCID_MESSAGE_TYPE_PC_to_RDR_IccPowerOff 0x63
104f1ae32a1SGerd Hoffmann #define CCID_MESSAGE_TYPE_PC_to_RDR_GetSlotStatus 0x65
105f1ae32a1SGerd Hoffmann #define CCID_MESSAGE_TYPE_PC_to_RDR_XfrBlock 0x6f
106f1ae32a1SGerd Hoffmann #define CCID_MESSAGE_TYPE_PC_to_RDR_GetParameters 0x6c
107f1ae32a1SGerd Hoffmann #define CCID_MESSAGE_TYPE_PC_to_RDR_ResetParameters 0x6d
108f1ae32a1SGerd Hoffmann #define CCID_MESSAGE_TYPE_PC_to_RDR_SetParameters 0x61
109f1ae32a1SGerd Hoffmann #define CCID_MESSAGE_TYPE_PC_to_RDR_Escape 0x6b
110f1ae32a1SGerd Hoffmann #define CCID_MESSAGE_TYPE_PC_to_RDR_IccClock 0x6e
111f1ae32a1SGerd Hoffmann #define CCID_MESSAGE_TYPE_PC_to_RDR_T0APDU 0x6a
112f1ae32a1SGerd Hoffmann #define CCID_MESSAGE_TYPE_PC_to_RDR_Secure 0x69
113f1ae32a1SGerd Hoffmann #define CCID_MESSAGE_TYPE_PC_to_RDR_Mechanical 0x71
114f1ae32a1SGerd Hoffmann #define CCID_MESSAGE_TYPE_PC_to_RDR_Abort 0x72
115f1ae32a1SGerd Hoffmann #define CCID_MESSAGE_TYPE_PC_to_RDR_SetDataRateAndClockFrequency 0x73
116f1ae32a1SGerd Hoffmann
117f1ae32a1SGerd Hoffmann /*
118f1ae32a1SGerd Hoffmann * BULK_IN messages from Reader to PC
119f1ae32a1SGerd Hoffmann * Defined in CCID Rev 1.1 6.2 (page 48)
120f1ae32a1SGerd Hoffmann */
121f1ae32a1SGerd Hoffmann #define CCID_MESSAGE_TYPE_RDR_to_PC_DataBlock 0x80
122f1ae32a1SGerd Hoffmann #define CCID_MESSAGE_TYPE_RDR_to_PC_SlotStatus 0x81
123f1ae32a1SGerd Hoffmann #define CCID_MESSAGE_TYPE_RDR_to_PC_Parameters 0x82
124f1ae32a1SGerd Hoffmann #define CCID_MESSAGE_TYPE_RDR_to_PC_Escape 0x83
125f1ae32a1SGerd Hoffmann #define CCID_MESSAGE_TYPE_RDR_to_PC_DataRateAndClockFrequency 0x84
126f1ae32a1SGerd Hoffmann
127f1ae32a1SGerd Hoffmann /*
128f1ae32a1SGerd Hoffmann * INTERRUPT_IN messages from Reader to PC
129f1ae32a1SGerd Hoffmann * Defined in CCID Rev 1.1 6.3 (page 56)
130f1ae32a1SGerd Hoffmann */
131f1ae32a1SGerd Hoffmann #define CCID_MESSAGE_TYPE_RDR_to_PC_NotifySlotChange 0x50
132f1ae32a1SGerd Hoffmann #define CCID_MESSAGE_TYPE_RDR_to_PC_HardwareError 0x51
133f1ae32a1SGerd Hoffmann
134f1ae32a1SGerd Hoffmann /*
135f1ae32a1SGerd Hoffmann * Endpoints for CCID - addresses are up to us to decide.
136f1ae32a1SGerd Hoffmann * To support slot insertion and removal we must have an interrupt in ep
137f1ae32a1SGerd Hoffmann * in addition we need a bulk in and bulk out ep
138f1ae32a1SGerd Hoffmann * 5.2, page 20
139f1ae32a1SGerd Hoffmann */
140f1ae32a1SGerd Hoffmann #define CCID_INT_IN_EP 1
141f1ae32a1SGerd Hoffmann #define CCID_BULK_IN_EP 2
142f1ae32a1SGerd Hoffmann #define CCID_BULK_OUT_EP 3
143f1ae32a1SGerd Hoffmann
144f1ae32a1SGerd Hoffmann /* bmSlotICCState masks */
145f1ae32a1SGerd Hoffmann #define SLOT_0_STATE_MASK 1
146f1ae32a1SGerd Hoffmann #define SLOT_0_CHANGED_MASK 2
147f1ae32a1SGerd Hoffmann
148f1ae32a1SGerd Hoffmann /* Status codes that go in bStatus (see 6.2.6) */
149f1ae32a1SGerd Hoffmann enum {
150f1ae32a1SGerd Hoffmann ICC_STATUS_PRESENT_ACTIVE = 0,
151f1ae32a1SGerd Hoffmann ICC_STATUS_PRESENT_INACTIVE,
152f1ae32a1SGerd Hoffmann ICC_STATUS_NOT_PRESENT
153f1ae32a1SGerd Hoffmann };
154f1ae32a1SGerd Hoffmann
155f1ae32a1SGerd Hoffmann enum {
156f1ae32a1SGerd Hoffmann COMMAND_STATUS_NO_ERROR = 0,
157f1ae32a1SGerd Hoffmann COMMAND_STATUS_FAILED,
158f1ae32a1SGerd Hoffmann COMMAND_STATUS_TIME_EXTENSION_REQUIRED
159f1ae32a1SGerd Hoffmann };
160f1ae32a1SGerd Hoffmann
161f1ae32a1SGerd Hoffmann /* Error codes that go in bError (see 6.2.6) */
162f1ae32a1SGerd Hoffmann enum {
163f1ae32a1SGerd Hoffmann ERROR_CMD_NOT_SUPPORTED = 0,
164f1ae32a1SGerd Hoffmann ERROR_CMD_ABORTED = -1,
165f1ae32a1SGerd Hoffmann ERROR_ICC_MUTE = -2,
166f1ae32a1SGerd Hoffmann ERROR_XFR_PARITY_ERROR = -3,
167f1ae32a1SGerd Hoffmann ERROR_XFR_OVERRUN = -4,
168f1ae32a1SGerd Hoffmann ERROR_HW_ERROR = -5,
169f1ae32a1SGerd Hoffmann };
170f1ae32a1SGerd Hoffmann
171f1ae32a1SGerd Hoffmann /* 6.2.6 RDR_to_PC_SlotStatus definitions */
172f1ae32a1SGerd Hoffmann enum {
173f1ae32a1SGerd Hoffmann CLOCK_STATUS_RUNNING = 0,
174f1ae32a1SGerd Hoffmann /*
175f1ae32a1SGerd Hoffmann * 0 - Clock Running, 1 - Clock stopped in State L, 2 - H,
176f1ae32a1SGerd Hoffmann * 3 - unknown state. rest are RFU
177f1ae32a1SGerd Hoffmann */
178f1ae32a1SGerd Hoffmann };
179f1ae32a1SGerd Hoffmann
180f1ae32a1SGerd Hoffmann typedef struct QEMU_PACKED CCID_Header {
181f1ae32a1SGerd Hoffmann uint8_t bMessageType;
182f1ae32a1SGerd Hoffmann uint32_t dwLength;
183f1ae32a1SGerd Hoffmann uint8_t bSlot;
184f1ae32a1SGerd Hoffmann uint8_t bSeq;
185f1ae32a1SGerd Hoffmann } CCID_Header;
186f1ae32a1SGerd Hoffmann
187f1ae32a1SGerd Hoffmann typedef struct QEMU_PACKED CCID_BULK_IN {
188f1ae32a1SGerd Hoffmann CCID_Header hdr;
189f1ae32a1SGerd Hoffmann uint8_t bStatus; /* Only used in BULK_IN */
190f1ae32a1SGerd Hoffmann uint8_t bError; /* Only used in BULK_IN */
191f1ae32a1SGerd Hoffmann } CCID_BULK_IN;
192f1ae32a1SGerd Hoffmann
193f1ae32a1SGerd Hoffmann typedef struct QEMU_PACKED CCID_SlotStatus {
194f1ae32a1SGerd Hoffmann CCID_BULK_IN b;
195f1ae32a1SGerd Hoffmann uint8_t bClockStatus;
196f1ae32a1SGerd Hoffmann } CCID_SlotStatus;
197f1ae32a1SGerd Hoffmann
1984942d6c3SAlon Levy typedef struct QEMU_PACKED CCID_T0ProtocolDataStructure {
1994942d6c3SAlon Levy uint8_t bmFindexDindex;
2004942d6c3SAlon Levy uint8_t bmTCCKST0;
2014942d6c3SAlon Levy uint8_t bGuardTimeT0;
2024942d6c3SAlon Levy uint8_t bWaitingIntegerT0;
2034942d6c3SAlon Levy uint8_t bClockStop;
2044942d6c3SAlon Levy } CCID_T0ProtocolDataStructure;
2054942d6c3SAlon Levy
2064942d6c3SAlon Levy typedef struct QEMU_PACKED CCID_T1ProtocolDataStructure {
2074942d6c3SAlon Levy uint8_t bmFindexDindex;
2084942d6c3SAlon Levy uint8_t bmTCCKST1;
2094942d6c3SAlon Levy uint8_t bGuardTimeT1;
2104942d6c3SAlon Levy uint8_t bWaitingIntegerT1;
2114942d6c3SAlon Levy uint8_t bClockStop;
2124942d6c3SAlon Levy uint8_t bIFSC;
2134942d6c3SAlon Levy uint8_t bNadValue;
2144942d6c3SAlon Levy } CCID_T1ProtocolDataStructure;
2154942d6c3SAlon Levy
2164942d6c3SAlon Levy typedef union CCID_ProtocolDataStructure {
2174942d6c3SAlon Levy CCID_T0ProtocolDataStructure t0;
2184942d6c3SAlon Levy CCID_T1ProtocolDataStructure t1;
2194942d6c3SAlon Levy uint8_t data[7]; /* must be = max(sizeof(t0), sizeof(t1)) */
2204942d6c3SAlon Levy } CCID_ProtocolDataStructure;
2214942d6c3SAlon Levy
222f1ae32a1SGerd Hoffmann typedef struct QEMU_PACKED CCID_Parameter {
223f1ae32a1SGerd Hoffmann CCID_BULK_IN b;
224f1ae32a1SGerd Hoffmann uint8_t bProtocolNum;
2254942d6c3SAlon Levy CCID_ProtocolDataStructure abProtocolDataStructure;
226f1ae32a1SGerd Hoffmann } CCID_Parameter;
227f1ae32a1SGerd Hoffmann
228f1ae32a1SGerd Hoffmann typedef struct QEMU_PACKED CCID_DataBlock {
229f1ae32a1SGerd Hoffmann CCID_BULK_IN b;
230f1ae32a1SGerd Hoffmann uint8_t bChainParameter;
231f7795e40SPhilippe Mathieu-Daudé uint8_t abData[];
232f1ae32a1SGerd Hoffmann } CCID_DataBlock;
233f1ae32a1SGerd Hoffmann
234f1ae32a1SGerd Hoffmann /* 6.1.4 PC_to_RDR_XfrBlock */
235f1ae32a1SGerd Hoffmann typedef struct QEMU_PACKED CCID_XferBlock {
236f1ae32a1SGerd Hoffmann CCID_Header hdr;
237f1ae32a1SGerd Hoffmann uint8_t bBWI; /* Block Waiting Timeout */
238f1ae32a1SGerd Hoffmann uint16_t wLevelParameter; /* XXX currently unused */
239f7795e40SPhilippe Mathieu-Daudé uint8_t abData[];
240f1ae32a1SGerd Hoffmann } CCID_XferBlock;
241f1ae32a1SGerd Hoffmann
242f1ae32a1SGerd Hoffmann typedef struct QEMU_PACKED CCID_IccPowerOn {
243f1ae32a1SGerd Hoffmann CCID_Header hdr;
244f1ae32a1SGerd Hoffmann uint8_t bPowerSelect;
245f1ae32a1SGerd Hoffmann uint16_t abRFU;
246f1ae32a1SGerd Hoffmann } CCID_IccPowerOn;
247f1ae32a1SGerd Hoffmann
248f1ae32a1SGerd Hoffmann typedef struct QEMU_PACKED CCID_IccPowerOff {
249f1ae32a1SGerd Hoffmann CCID_Header hdr;
250f1ae32a1SGerd Hoffmann uint16_t abRFU;
251f1ae32a1SGerd Hoffmann } CCID_IccPowerOff;
252f1ae32a1SGerd Hoffmann
253f1ae32a1SGerd Hoffmann typedef struct QEMU_PACKED CCID_SetParameters {
254f1ae32a1SGerd Hoffmann CCID_Header hdr;
255f1ae32a1SGerd Hoffmann uint8_t bProtocolNum;
256f1ae32a1SGerd Hoffmann uint16_t abRFU;
2574942d6c3SAlon Levy CCID_ProtocolDataStructure abProtocolDataStructure;
258f1ae32a1SGerd Hoffmann } CCID_SetParameters;
259f1ae32a1SGerd Hoffmann
260f1ae32a1SGerd Hoffmann typedef struct CCID_Notify_Slot_Change {
261f1ae32a1SGerd Hoffmann uint8_t bMessageType; /* CCID_MESSAGE_TYPE_RDR_to_PC_NotifySlotChange */
262f1ae32a1SGerd Hoffmann uint8_t bmSlotICCState;
263f1ae32a1SGerd Hoffmann } CCID_Notify_Slot_Change;
264f1ae32a1SGerd Hoffmann
265f1ae32a1SGerd Hoffmann /* used for DataBlock response to XferBlock */
266f1ae32a1SGerd Hoffmann typedef struct Answer {
267f1ae32a1SGerd Hoffmann uint8_t slot;
268f1ae32a1SGerd Hoffmann uint8_t seq;
269f1ae32a1SGerd Hoffmann } Answer;
270f1ae32a1SGerd Hoffmann
271f1ae32a1SGerd Hoffmann /* pending BULK_IN messages */
272f1ae32a1SGerd Hoffmann typedef struct BulkIn {
273f1ae32a1SGerd Hoffmann uint8_t data[BULK_IN_BUF_SIZE];
274f1ae32a1SGerd Hoffmann uint32_t len;
275f1ae32a1SGerd Hoffmann uint32_t pos;
276f1ae32a1SGerd Hoffmann } BulkIn;
277f1ae32a1SGerd Hoffmann
278db1015e9SEduardo Habkost struct CCIDBus {
279f1ae32a1SGerd Hoffmann BusState qbus;
280db1015e9SEduardo Habkost };
281*1fc3efc6SPhilippe Mathieu-Daudé
282*1fc3efc6SPhilippe Mathieu-Daudé #define TYPE_CCID_BUS "ccid-bus"
283*1fc3efc6SPhilippe Mathieu-Daudé OBJECT_DECLARE_SIMPLE_TYPE(CCIDBus, CCID_BUS)
284f1ae32a1SGerd Hoffmann
285f1ae32a1SGerd Hoffmann /*
286f1ae32a1SGerd Hoffmann * powered - defaults to true, changed by PowerOn/PowerOff messages
287f1ae32a1SGerd Hoffmann */
288db1015e9SEduardo Habkost struct USBCCIDState {
289f1ae32a1SGerd Hoffmann USBDevice dev;
290f1ae32a1SGerd Hoffmann USBEndpoint *intr;
29186d7e214SGerd Hoffmann USBEndpoint *bulk;
292f1ae32a1SGerd Hoffmann CCIDBus bus;
293f1ae32a1SGerd Hoffmann CCIDCardState *card;
294f1ae32a1SGerd Hoffmann BulkIn bulk_in_pending[BULK_IN_PENDING_NUM]; /* circular */
295f1ae32a1SGerd Hoffmann uint32_t bulk_in_pending_start;
296f1ae32a1SGerd Hoffmann uint32_t bulk_in_pending_end; /* first free */
297f1ae32a1SGerd Hoffmann uint32_t bulk_in_pending_num;
298f1ae32a1SGerd Hoffmann BulkIn *current_bulk_in;
299f1ae32a1SGerd Hoffmann uint8_t bulk_out_data[BULK_OUT_DATA_SIZE];
300f1ae32a1SGerd Hoffmann uint32_t bulk_out_pos;
301f1ae32a1SGerd Hoffmann uint64_t last_answer_error;
302f1ae32a1SGerd Hoffmann Answer pending_answers[PENDING_ANSWERS_NUM];
303f1ae32a1SGerd Hoffmann uint32_t pending_answers_start;
304f1ae32a1SGerd Hoffmann uint32_t pending_answers_end;
305f1ae32a1SGerd Hoffmann uint32_t pending_answers_num;
306f1ae32a1SGerd Hoffmann uint8_t bError;
307f1ae32a1SGerd Hoffmann uint8_t bmCommandStatus;
308f1ae32a1SGerd Hoffmann uint8_t bProtocolNum;
3094942d6c3SAlon Levy CCID_ProtocolDataStructure abProtocolDataStructure;
310f1ae32a1SGerd Hoffmann uint32_t ulProtocolDataStructureSize;
311f1ae32a1SGerd Hoffmann uint32_t state_vmstate;
312f1ae32a1SGerd Hoffmann uint8_t bmSlotICCState;
313f1ae32a1SGerd Hoffmann uint8_t powered;
314f1ae32a1SGerd Hoffmann uint8_t notify_slot_change;
315f1ae32a1SGerd Hoffmann uint8_t debug;
316db1015e9SEduardo Habkost };
317f1ae32a1SGerd Hoffmann
318f1ae32a1SGerd Hoffmann /*
319f1ae32a1SGerd Hoffmann * CCID Spec chapter 4: CCID uses a standard device descriptor per Chapter 9,
320f1ae32a1SGerd Hoffmann * "USB Device Framework", section 9.6.1, in the Universal Serial Bus
321f1ae32a1SGerd Hoffmann * Specification.
322f1ae32a1SGerd Hoffmann *
323f1ae32a1SGerd Hoffmann * This device implemented based on the spec and with an Athena Smart Card
324f1ae32a1SGerd Hoffmann * Reader as reference:
325f1ae32a1SGerd Hoffmann * 0dc3:1004 Athena Smartcard Solutions, Inc.
326f1ae32a1SGerd Hoffmann */
327f1ae32a1SGerd Hoffmann
328f1ae32a1SGerd Hoffmann static const uint8_t qemu_ccid_descriptor[] = {
329f1ae32a1SGerd Hoffmann /* Smart Card Device Class Descriptor */
330f1ae32a1SGerd Hoffmann 0x36, /* u8 bLength; */
331f1ae32a1SGerd Hoffmann 0x21, /* u8 bDescriptorType; Functional */
332f1ae32a1SGerd Hoffmann 0x10, 0x01, /* u16 bcdCCID; CCID Specification Release Number. */
333f1ae32a1SGerd Hoffmann 0x00, /*
334f1ae32a1SGerd Hoffmann * u8 bMaxSlotIndex; The index of the highest available
335f1ae32a1SGerd Hoffmann * slot on this device. All slots are consecutive starting
336f1ae32a1SGerd Hoffmann * at 00h.
337f1ae32a1SGerd Hoffmann */
338f1ae32a1SGerd Hoffmann 0x07, /* u8 bVoltageSupport; 01h - 5.0v, 02h - 3.0, 03 - 1.8 */
339f1ae32a1SGerd Hoffmann
3400ee86bb6SJason Andryuk 0x01, 0x00, /* u32 dwProtocols; RRRR PPPP. RRRR = 0000h.*/
3410ee86bb6SJason Andryuk 0x00, 0x00, /* PPPP: 0001h = Protocol T=0, 0002h = Protocol T=1 */
342f1ae32a1SGerd Hoffmann /* u32 dwDefaultClock; in kHZ (0x0fa0 is 4 MHz) */
343f1ae32a1SGerd Hoffmann 0xa0, 0x0f, 0x00, 0x00,
344f1ae32a1SGerd Hoffmann /* u32 dwMaximumClock; */
345f1ae32a1SGerd Hoffmann 0x00, 0x00, 0x01, 0x00,
346f1ae32a1SGerd Hoffmann 0x00, /* u8 bNumClockSupported; *
347f1ae32a1SGerd Hoffmann * 0 means just the default and max. */
348f1ae32a1SGerd Hoffmann /* u32 dwDataRate ;bps. 9600 == 00002580h */
349f1ae32a1SGerd Hoffmann 0x80, 0x25, 0x00, 0x00,
350f1ae32a1SGerd Hoffmann /* u32 dwMaxDataRate ; 11520 bps == 0001C200h */
351f1ae32a1SGerd Hoffmann 0x00, 0xC2, 0x01, 0x00,
352f1ae32a1SGerd Hoffmann 0x00, /* u8 bNumDataRatesSupported; 00 means all rates between
353f1ae32a1SGerd Hoffmann * default and max */
354f1ae32a1SGerd Hoffmann /* u32 dwMaxIFSD; *
355f1ae32a1SGerd Hoffmann * maximum IFSD supported by CCID for protocol *
356f1ae32a1SGerd Hoffmann * T=1 (Maximum seen from various cards) */
357f1ae32a1SGerd Hoffmann 0xfe, 0x00, 0x00, 0x00,
358f1ae32a1SGerd Hoffmann /* u32 dwSyncProtocols; 1 - 2-wire, 2 - 3-wire, 4 - I2C */
359f1ae32a1SGerd Hoffmann 0x00, 0x00, 0x00, 0x00,
360f1ae32a1SGerd Hoffmann /* u32 dwMechanical; 0 - no special characteristics. */
361f1ae32a1SGerd Hoffmann 0x00, 0x00, 0x00, 0x00,
362f1ae32a1SGerd Hoffmann /*
363f1ae32a1SGerd Hoffmann * u32 dwFeatures;
364f1ae32a1SGerd Hoffmann * 0 - No special characteristics
365f1ae32a1SGerd Hoffmann * + 2 Automatic parameter configuration based on ATR data
366f1ae32a1SGerd Hoffmann * + 4 Automatic activation of ICC on inserting
367f1ae32a1SGerd Hoffmann * + 8 Automatic ICC voltage selection
368f1ae32a1SGerd Hoffmann * + 10 Automatic ICC clock frequency change
369f1ae32a1SGerd Hoffmann * + 20 Automatic baud rate change
370f1ae32a1SGerd Hoffmann * + 40 Automatic parameters negotiation made by the CCID
371f1ae32a1SGerd Hoffmann * + 80 automatic PPS made by the CCID
372f1ae32a1SGerd Hoffmann * 100 CCID can set ICC in clock stop mode
373f1ae32a1SGerd Hoffmann * 200 NAD value other then 00 accepted (T=1 protocol)
374f1ae32a1SGerd Hoffmann * + 400 Automatic IFSD exchange as first exchange (T=1)
375f1ae32a1SGerd Hoffmann * One of the following only:
376f1ae32a1SGerd Hoffmann * + 10000 TPDU level exchanges with CCID
377f1ae32a1SGerd Hoffmann * 20000 Short APDU level exchange with CCID
378f1ae32a1SGerd Hoffmann * 40000 Short and Extended APDU level exchange with CCID
379f1ae32a1SGerd Hoffmann *
380c5cd7c87SAlon Levy * 100000 USB Wake up signaling supported on card
381f1ae32a1SGerd Hoffmann * insertion and removal. Must set bit 5 in bmAttributes
382f1ae32a1SGerd Hoffmann * in Configuration descriptor if 100000 is set.
383f1ae32a1SGerd Hoffmann */
384c5cd7c87SAlon Levy 0xfe, 0x04, 0x01, 0x00,
385f1ae32a1SGerd Hoffmann /*
386f1ae32a1SGerd Hoffmann * u32 dwMaxCCIDMessageLength; For extended APDU in
387f1ae32a1SGerd Hoffmann * [261 + 10 , 65544 + 10]. Otherwise the minimum is
388f1ae32a1SGerd Hoffmann * wMaxPacketSize of the Bulk-OUT endpoint
389f1ae32a1SGerd Hoffmann */
390f1ae32a1SGerd Hoffmann 0x12, 0x00, 0x01, 0x00,
391f1ae32a1SGerd Hoffmann 0xFF, /*
392f1ae32a1SGerd Hoffmann * u8 bClassGetResponse; Significant only for CCID that
393f1ae32a1SGerd Hoffmann * offers an APDU level for exchanges. Indicates the
394f1ae32a1SGerd Hoffmann * default class value used by the CCID when it sends a
395f1ae32a1SGerd Hoffmann * Get Response command to perform the transportation of
396f1ae32a1SGerd Hoffmann * an APDU by T=0 protocol
397f1ae32a1SGerd Hoffmann * FFh indicates that the CCID echos the class of the APDU.
398f1ae32a1SGerd Hoffmann */
399f1ae32a1SGerd Hoffmann 0xFF, /*
400f1ae32a1SGerd Hoffmann * u8 bClassEnvelope; EAPDU only. Envelope command for
401f1ae32a1SGerd Hoffmann * T=0
402f1ae32a1SGerd Hoffmann */
403f1ae32a1SGerd Hoffmann 0x00, 0x00, /*
404f1ae32a1SGerd Hoffmann * u16 wLcdLayout; XXYY Number of lines (XX) and chars per
405f1ae32a1SGerd Hoffmann * line for LCD display used for PIN entry. 0000 - no LCD
406f1ae32a1SGerd Hoffmann */
407f1ae32a1SGerd Hoffmann 0x01, /*
408f1ae32a1SGerd Hoffmann * u8 bPINSupport; 01h PIN Verification,
409f1ae32a1SGerd Hoffmann * 02h PIN Modification
410f1ae32a1SGerd Hoffmann */
411f1ae32a1SGerd Hoffmann 0x01, /* u8 bMaxCCIDBusySlots; */
412f1ae32a1SGerd Hoffmann };
413f1ae32a1SGerd Hoffmann
414f1ae32a1SGerd Hoffmann enum {
415f1ae32a1SGerd Hoffmann STR_MANUFACTURER = 1,
416f1ae32a1SGerd Hoffmann STR_PRODUCT,
417f1ae32a1SGerd Hoffmann STR_SERIALNUMBER,
418f1ae32a1SGerd Hoffmann STR_INTERFACE,
419f1ae32a1SGerd Hoffmann };
420f1ae32a1SGerd Hoffmann
421f1ae32a1SGerd Hoffmann static const USBDescStrings desc_strings = {
42293bfef4cSCrístian Viana [STR_MANUFACTURER] = "QEMU",
423f1ae32a1SGerd Hoffmann [STR_PRODUCT] = "QEMU USB CCID",
424f1ae32a1SGerd Hoffmann [STR_SERIALNUMBER] = "1",
425f1ae32a1SGerd Hoffmann [STR_INTERFACE] = "CCID Interface",
426f1ae32a1SGerd Hoffmann };
427f1ae32a1SGerd Hoffmann
428f1ae32a1SGerd Hoffmann static const USBDescIface desc_iface0 = {
429f1ae32a1SGerd Hoffmann .bInterfaceNumber = 0,
430f1ae32a1SGerd Hoffmann .bNumEndpoints = 3,
431693e4773SAlon Levy .bInterfaceClass = USB_CLASS_CSCID,
432693e4773SAlon Levy .bInterfaceSubClass = USB_SUBCLASS_UNDEFINED,
433f1ae32a1SGerd Hoffmann .bInterfaceProtocol = 0x00,
434f1ae32a1SGerd Hoffmann .iInterface = STR_INTERFACE,
435f1ae32a1SGerd Hoffmann .ndesc = 1,
436f1ae32a1SGerd Hoffmann .descs = (USBDescOther[]) {
437f1ae32a1SGerd Hoffmann {
438f1ae32a1SGerd Hoffmann /* smartcard descriptor */
439f1ae32a1SGerd Hoffmann .data = qemu_ccid_descriptor,
440f1ae32a1SGerd Hoffmann },
441f1ae32a1SGerd Hoffmann },
442f1ae32a1SGerd Hoffmann .eps = (USBDescEndpoint[]) {
443f1ae32a1SGerd Hoffmann {
444f1ae32a1SGerd Hoffmann .bEndpointAddress = USB_DIR_IN | CCID_INT_IN_EP,
445f1ae32a1SGerd Hoffmann .bmAttributes = USB_ENDPOINT_XFER_INT,
446f1ae32a1SGerd Hoffmann .bInterval = 255,
447f1ae32a1SGerd Hoffmann .wMaxPacketSize = 64,
448f1ae32a1SGerd Hoffmann },{
449f1ae32a1SGerd Hoffmann .bEndpointAddress = USB_DIR_IN | CCID_BULK_IN_EP,
450f1ae32a1SGerd Hoffmann .bmAttributes = USB_ENDPOINT_XFER_BULK,
451f1ae32a1SGerd Hoffmann .wMaxPacketSize = 64,
452f1ae32a1SGerd Hoffmann },{
453f1ae32a1SGerd Hoffmann .bEndpointAddress = USB_DIR_OUT | CCID_BULK_OUT_EP,
454f1ae32a1SGerd Hoffmann .bmAttributes = USB_ENDPOINT_XFER_BULK,
455f1ae32a1SGerd Hoffmann .wMaxPacketSize = 64,
456f1ae32a1SGerd Hoffmann },
457f1ae32a1SGerd Hoffmann }
458f1ae32a1SGerd Hoffmann };
459f1ae32a1SGerd Hoffmann
460f1ae32a1SGerd Hoffmann static const USBDescDevice desc_device = {
461f1ae32a1SGerd Hoffmann .bcdUSB = 0x0110,
462f1ae32a1SGerd Hoffmann .bMaxPacketSize0 = 64,
463f1ae32a1SGerd Hoffmann .bNumConfigurations = 1,
464f1ae32a1SGerd Hoffmann .confs = (USBDescConfig[]) {
465f1ae32a1SGerd Hoffmann {
466f1ae32a1SGerd Hoffmann .bNumInterfaces = 1,
467f1ae32a1SGerd Hoffmann .bConfigurationValue = 1,
468bd93976aSPantelis Koukousoulas .bmAttributes = USB_CFG_ATT_ONE | USB_CFG_ATT_SELFPOWER |
469bd93976aSPantelis Koukousoulas USB_CFG_ATT_WAKEUP,
470f1ae32a1SGerd Hoffmann .bMaxPower = 50,
471f1ae32a1SGerd Hoffmann .nif = 1,
472f1ae32a1SGerd Hoffmann .ifs = &desc_iface0,
473f1ae32a1SGerd Hoffmann },
474f1ae32a1SGerd Hoffmann },
475f1ae32a1SGerd Hoffmann };
476f1ae32a1SGerd Hoffmann
477f1ae32a1SGerd Hoffmann static const USBDesc desc_ccid = {
478f1ae32a1SGerd Hoffmann .id = {
479f1ae32a1SGerd Hoffmann .idVendor = CCID_VENDOR_ID,
480f1ae32a1SGerd Hoffmann .idProduct = CCID_PRODUCT_ID,
481f1ae32a1SGerd Hoffmann .bcdDevice = CCID_DEVICE_VERSION,
482f1ae32a1SGerd Hoffmann .iManufacturer = STR_MANUFACTURER,
483f1ae32a1SGerd Hoffmann .iProduct = STR_PRODUCT,
484f1ae32a1SGerd Hoffmann .iSerialNumber = STR_SERIALNUMBER,
485f1ae32a1SGerd Hoffmann },
486f1ae32a1SGerd Hoffmann .full = &desc_device,
487f1ae32a1SGerd Hoffmann .str = desc_strings,
488f1ae32a1SGerd Hoffmann };
489f1ae32a1SGerd Hoffmann
ccid_card_get_atr(CCIDCardState * card,uint32_t * len)490f1ae32a1SGerd Hoffmann static const uint8_t *ccid_card_get_atr(CCIDCardState *card, uint32_t *len)
491f1ae32a1SGerd Hoffmann {
492f1ae32a1SGerd Hoffmann CCIDCardClass *cc = CCID_CARD_GET_CLASS(card);
4934543d43cSAlon Levy
494f1ae32a1SGerd Hoffmann if (cc->get_atr) {
495f1ae32a1SGerd Hoffmann return cc->get_atr(card, len);
496f1ae32a1SGerd Hoffmann }
497f1ae32a1SGerd Hoffmann return NULL;
498f1ae32a1SGerd Hoffmann }
499f1ae32a1SGerd Hoffmann
ccid_card_apdu_from_guest(CCIDCardState * card,const uint8_t * apdu,uint32_t len)500f1ae32a1SGerd Hoffmann static void ccid_card_apdu_from_guest(CCIDCardState *card,
501f1ae32a1SGerd Hoffmann const uint8_t *apdu,
502f1ae32a1SGerd Hoffmann uint32_t len)
503f1ae32a1SGerd Hoffmann {
504f1ae32a1SGerd Hoffmann CCIDCardClass *cc = CCID_CARD_GET_CLASS(card);
5054543d43cSAlon Levy
506f1ae32a1SGerd Hoffmann if (cc->apdu_from_guest) {
507f1ae32a1SGerd Hoffmann cc->apdu_from_guest(card, apdu, len);
508f1ae32a1SGerd Hoffmann }
509f1ae32a1SGerd Hoffmann }
510f1ae32a1SGerd Hoffmann
ccid_has_pending_answers(USBCCIDState * s)511f1ae32a1SGerd Hoffmann static bool ccid_has_pending_answers(USBCCIDState *s)
512f1ae32a1SGerd Hoffmann {
513f1ae32a1SGerd Hoffmann return s->pending_answers_num > 0;
514f1ae32a1SGerd Hoffmann }
515f1ae32a1SGerd Hoffmann
ccid_clear_pending_answers(USBCCIDState * s)516f1ae32a1SGerd Hoffmann static void ccid_clear_pending_answers(USBCCIDState *s)
517f1ae32a1SGerd Hoffmann {
518f1ae32a1SGerd Hoffmann s->pending_answers_num = 0;
519f1ae32a1SGerd Hoffmann s->pending_answers_start = 0;
520f1ae32a1SGerd Hoffmann s->pending_answers_end = 0;
521f1ae32a1SGerd Hoffmann }
522f1ae32a1SGerd Hoffmann
ccid_print_pending_answers(USBCCIDState * s)523f1ae32a1SGerd Hoffmann static void ccid_print_pending_answers(USBCCIDState *s)
524f1ae32a1SGerd Hoffmann {
525f1ae32a1SGerd Hoffmann Answer *answer;
526f1ae32a1SGerd Hoffmann int i, count;
527f1ae32a1SGerd Hoffmann
528f1ae32a1SGerd Hoffmann DPRINTF(s, D_VERBOSE, "usb-ccid: pending answers:");
529f1ae32a1SGerd Hoffmann if (!ccid_has_pending_answers(s)) {
530f1ae32a1SGerd Hoffmann DPRINTF(s, D_VERBOSE, " empty\n");
531f1ae32a1SGerd Hoffmann return;
532f1ae32a1SGerd Hoffmann }
533f1ae32a1SGerd Hoffmann for (i = s->pending_answers_start, count = s->pending_answers_num ;
534f1ae32a1SGerd Hoffmann count > 0; count--, i++) {
535f1ae32a1SGerd Hoffmann answer = &s->pending_answers[i % PENDING_ANSWERS_NUM];
536f1ae32a1SGerd Hoffmann if (count == 1) {
537f1ae32a1SGerd Hoffmann DPRINTF(s, D_VERBOSE, "%d:%d\n", answer->slot, answer->seq);
538f1ae32a1SGerd Hoffmann } else {
539f1ae32a1SGerd Hoffmann DPRINTF(s, D_VERBOSE, "%d:%d,", answer->slot, answer->seq);
540f1ae32a1SGerd Hoffmann }
541f1ae32a1SGerd Hoffmann }
542f1ae32a1SGerd Hoffmann }
543f1ae32a1SGerd Hoffmann
ccid_add_pending_answer(USBCCIDState * s,CCID_Header * hdr)544f1ae32a1SGerd Hoffmann static void ccid_add_pending_answer(USBCCIDState *s, CCID_Header *hdr)
545f1ae32a1SGerd Hoffmann {
546f1ae32a1SGerd Hoffmann Answer *answer;
547f1ae32a1SGerd Hoffmann
548f1ae32a1SGerd Hoffmann assert(s->pending_answers_num < PENDING_ANSWERS_NUM);
549f1ae32a1SGerd Hoffmann s->pending_answers_num++;
550f1ae32a1SGerd Hoffmann answer =
551f1ae32a1SGerd Hoffmann &s->pending_answers[(s->pending_answers_end++) % PENDING_ANSWERS_NUM];
552f1ae32a1SGerd Hoffmann answer->slot = hdr->bSlot;
553f1ae32a1SGerd Hoffmann answer->seq = hdr->bSeq;
554f1ae32a1SGerd Hoffmann ccid_print_pending_answers(s);
555f1ae32a1SGerd Hoffmann }
556f1ae32a1SGerd Hoffmann
ccid_remove_pending_answer(USBCCIDState * s,uint8_t * slot,uint8_t * seq)557f1ae32a1SGerd Hoffmann static void ccid_remove_pending_answer(USBCCIDState *s,
558f1ae32a1SGerd Hoffmann uint8_t *slot, uint8_t *seq)
559f1ae32a1SGerd Hoffmann {
560f1ae32a1SGerd Hoffmann Answer *answer;
561f1ae32a1SGerd Hoffmann
562f1ae32a1SGerd Hoffmann assert(s->pending_answers_num > 0);
563f1ae32a1SGerd Hoffmann s->pending_answers_num--;
564f1ae32a1SGerd Hoffmann answer =
565f1ae32a1SGerd Hoffmann &s->pending_answers[(s->pending_answers_start++) % PENDING_ANSWERS_NUM];
566f1ae32a1SGerd Hoffmann *slot = answer->slot;
567f1ae32a1SGerd Hoffmann *seq = answer->seq;
568f1ae32a1SGerd Hoffmann ccid_print_pending_answers(s);
569f1ae32a1SGerd Hoffmann }
570f1ae32a1SGerd Hoffmann
ccid_bulk_in_clear(USBCCIDState * s)571f1ae32a1SGerd Hoffmann static void ccid_bulk_in_clear(USBCCIDState *s)
572f1ae32a1SGerd Hoffmann {
573f1ae32a1SGerd Hoffmann s->bulk_in_pending_start = 0;
574f1ae32a1SGerd Hoffmann s->bulk_in_pending_end = 0;
575f1ae32a1SGerd Hoffmann s->bulk_in_pending_num = 0;
576f1ae32a1SGerd Hoffmann }
577f1ae32a1SGerd Hoffmann
ccid_bulk_in_release(USBCCIDState * s)578f1ae32a1SGerd Hoffmann static void ccid_bulk_in_release(USBCCIDState *s)
579f1ae32a1SGerd Hoffmann {
580f1ae32a1SGerd Hoffmann assert(s->current_bulk_in != NULL);
581f1ae32a1SGerd Hoffmann s->current_bulk_in->pos = 0;
582f1ae32a1SGerd Hoffmann s->current_bulk_in = NULL;
583f1ae32a1SGerd Hoffmann }
584f1ae32a1SGerd Hoffmann
ccid_bulk_in_get(USBCCIDState * s)585f1ae32a1SGerd Hoffmann static void ccid_bulk_in_get(USBCCIDState *s)
586f1ae32a1SGerd Hoffmann {
587f1ae32a1SGerd Hoffmann if (s->current_bulk_in != NULL || s->bulk_in_pending_num == 0) {
588f1ae32a1SGerd Hoffmann return;
589f1ae32a1SGerd Hoffmann }
590f1ae32a1SGerd Hoffmann assert(s->bulk_in_pending_num > 0);
591f1ae32a1SGerd Hoffmann s->bulk_in_pending_num--;
592f1ae32a1SGerd Hoffmann s->current_bulk_in =
593f1ae32a1SGerd Hoffmann &s->bulk_in_pending[(s->bulk_in_pending_start++) % BULK_IN_PENDING_NUM];
594f1ae32a1SGerd Hoffmann }
595f1ae32a1SGerd Hoffmann
ccid_reserve_recv_buf(USBCCIDState * s,uint16_t len)596f1ae32a1SGerd Hoffmann static void *ccid_reserve_recv_buf(USBCCIDState *s, uint16_t len)
597f1ae32a1SGerd Hoffmann {
598f1ae32a1SGerd Hoffmann BulkIn *bulk_in;
599f1ae32a1SGerd Hoffmann
600f1ae32a1SGerd Hoffmann DPRINTF(s, D_VERBOSE, "%s: QUEUE: reserve %d bytes\n", __func__, len);
601f1ae32a1SGerd Hoffmann
602f1ae32a1SGerd Hoffmann /* look for an existing element */
603f1ae32a1SGerd Hoffmann if (len > BULK_IN_BUF_SIZE) {
604f1ae32a1SGerd Hoffmann DPRINTF(s, D_WARN, "usb-ccid.c: %s: len larger then max (%d>%d). "
605f1ae32a1SGerd Hoffmann "discarding message.\n",
606f1ae32a1SGerd Hoffmann __func__, len, BULK_IN_BUF_SIZE);
607f1ae32a1SGerd Hoffmann return NULL;
608f1ae32a1SGerd Hoffmann }
609f1ae32a1SGerd Hoffmann if (s->bulk_in_pending_num >= BULK_IN_PENDING_NUM) {
610f1ae32a1SGerd Hoffmann DPRINTF(s, D_WARN, "usb-ccid.c: %s: No free bulk_in buffers. "
611f1ae32a1SGerd Hoffmann "discarding message.\n", __func__);
612f1ae32a1SGerd Hoffmann return NULL;
613f1ae32a1SGerd Hoffmann }
614f1ae32a1SGerd Hoffmann bulk_in =
615f1ae32a1SGerd Hoffmann &s->bulk_in_pending[(s->bulk_in_pending_end++) % BULK_IN_PENDING_NUM];
616f1ae32a1SGerd Hoffmann s->bulk_in_pending_num++;
617f1ae32a1SGerd Hoffmann bulk_in->len = len;
618f1ae32a1SGerd Hoffmann return bulk_in->data;
619f1ae32a1SGerd Hoffmann }
620f1ae32a1SGerd Hoffmann
ccid_reset(USBCCIDState * s)621f1ae32a1SGerd Hoffmann static void ccid_reset(USBCCIDState *s)
622f1ae32a1SGerd Hoffmann {
623f1ae32a1SGerd Hoffmann ccid_bulk_in_clear(s);
624f1ae32a1SGerd Hoffmann ccid_clear_pending_answers(s);
625f1ae32a1SGerd Hoffmann }
626f1ae32a1SGerd Hoffmann
ccid_detach(USBCCIDState * s)627f1ae32a1SGerd Hoffmann static void ccid_detach(USBCCIDState *s)
628f1ae32a1SGerd Hoffmann {
629f1ae32a1SGerd Hoffmann ccid_reset(s);
630f1ae32a1SGerd Hoffmann }
631f1ae32a1SGerd Hoffmann
ccid_handle_reset(USBDevice * dev)632f1ae32a1SGerd Hoffmann static void ccid_handle_reset(USBDevice *dev)
633f1ae32a1SGerd Hoffmann {
63461b4887bSGonglei USBCCIDState *s = USB_CCID_DEV(dev);
635f1ae32a1SGerd Hoffmann
636f1ae32a1SGerd Hoffmann DPRINTF(s, 1, "Reset\n");
637f1ae32a1SGerd Hoffmann
638f1ae32a1SGerd Hoffmann ccid_reset(s);
639f1ae32a1SGerd Hoffmann }
640f1ae32a1SGerd Hoffmann
ccid_control_to_str(USBCCIDState * s,int request)6417e1ac5abSAlon Levy static const char *ccid_control_to_str(USBCCIDState *s, int request)
6427e1ac5abSAlon Levy {
6437e1ac5abSAlon Levy switch (request) {
6447e1ac5abSAlon Levy /* generic - should be factored out if there are other debugees */
6457e1ac5abSAlon Levy case DeviceOutRequest | USB_REQ_SET_ADDRESS:
6467e1ac5abSAlon Levy return "(generic) set address";
6477e1ac5abSAlon Levy case DeviceRequest | USB_REQ_GET_DESCRIPTOR:
6487e1ac5abSAlon Levy return "(generic) get descriptor";
6497e1ac5abSAlon Levy case DeviceRequest | USB_REQ_GET_CONFIGURATION:
6507e1ac5abSAlon Levy return "(generic) get configuration";
6517e1ac5abSAlon Levy case DeviceOutRequest | USB_REQ_SET_CONFIGURATION:
6527e1ac5abSAlon Levy return "(generic) set configuration";
6537e1ac5abSAlon Levy case DeviceRequest | USB_REQ_GET_STATUS:
6547e1ac5abSAlon Levy return "(generic) get status";
6557e1ac5abSAlon Levy case DeviceOutRequest | USB_REQ_CLEAR_FEATURE:
6567e1ac5abSAlon Levy return "(generic) clear feature";
6577e1ac5abSAlon Levy case DeviceOutRequest | USB_REQ_SET_FEATURE:
6587e1ac5abSAlon Levy return "(generic) set_feature";
6597e1ac5abSAlon Levy case InterfaceRequest | USB_REQ_GET_INTERFACE:
6607e1ac5abSAlon Levy return "(generic) get interface";
6617e1ac5abSAlon Levy case InterfaceOutRequest | USB_REQ_SET_INTERFACE:
6627e1ac5abSAlon Levy return "(generic) set interface";
6637e1ac5abSAlon Levy /* class requests */
6647e1ac5abSAlon Levy case ClassInterfaceOutRequest | CCID_CONTROL_ABORT:
6657e1ac5abSAlon Levy return "ABORT";
6667e1ac5abSAlon Levy case ClassInterfaceRequest | CCID_CONTROL_GET_CLOCK_FREQUENCIES:
6677e1ac5abSAlon Levy return "GET_CLOCK_FREQUENCIES";
6687e1ac5abSAlon Levy case ClassInterfaceRequest | CCID_CONTROL_GET_DATA_RATES:
6697e1ac5abSAlon Levy return "GET_DATA_RATES";
6707e1ac5abSAlon Levy }
6717e1ac5abSAlon Levy return "unknown";
6727e1ac5abSAlon Levy }
6737e1ac5abSAlon Levy
ccid_handle_control(USBDevice * dev,USBPacket * p,int request,int value,int index,int length,uint8_t * data)6749a77a0f5SHans de Goede static void ccid_handle_control(USBDevice *dev, USBPacket *p, int request,
675f1ae32a1SGerd Hoffmann int value, int index, int length, uint8_t *data)
676f1ae32a1SGerd Hoffmann {
67761b4887bSGonglei USBCCIDState *s = USB_CCID_DEV(dev);
6789a77a0f5SHans de Goede int ret;
679f1ae32a1SGerd Hoffmann
6807e1ac5abSAlon Levy DPRINTF(s, 1, "%s: got control %s (%x), value %x\n", __func__,
6817e1ac5abSAlon Levy ccid_control_to_str(s, request), request, value);
682f1ae32a1SGerd Hoffmann ret = usb_desc_handle_control(dev, p, request, value, index, length, data);
683f1ae32a1SGerd Hoffmann if (ret >= 0) {
6849a77a0f5SHans de Goede return;
685f1ae32a1SGerd Hoffmann }
686f1ae32a1SGerd Hoffmann
687f1ae32a1SGerd Hoffmann switch (request) {
688f1ae32a1SGerd Hoffmann /* Class specific requests. */
689693e4773SAlon Levy case ClassInterfaceOutRequest | CCID_CONTROL_ABORT:
690f1ae32a1SGerd Hoffmann DPRINTF(s, 1, "ccid_control abort UNIMPLEMENTED\n");
6919a77a0f5SHans de Goede p->status = USB_RET_STALL;
692f1ae32a1SGerd Hoffmann break;
693693e4773SAlon Levy case ClassInterfaceRequest | CCID_CONTROL_GET_CLOCK_FREQUENCIES:
694f1ae32a1SGerd Hoffmann DPRINTF(s, 1, "ccid_control get clock frequencies UNIMPLEMENTED\n");
6959a77a0f5SHans de Goede p->status = USB_RET_STALL;
696f1ae32a1SGerd Hoffmann break;
697693e4773SAlon Levy case ClassInterfaceRequest | CCID_CONTROL_GET_DATA_RATES:
698f1ae32a1SGerd Hoffmann DPRINTF(s, 1, "ccid_control get data rates UNIMPLEMENTED\n");
6999a77a0f5SHans de Goede p->status = USB_RET_STALL;
700f1ae32a1SGerd Hoffmann break;
701f1ae32a1SGerd Hoffmann default:
702f1ae32a1SGerd Hoffmann DPRINTF(s, 1, "got unsupported/bogus control %x, value %x\n",
703f1ae32a1SGerd Hoffmann request, value);
7049a77a0f5SHans de Goede p->status = USB_RET_STALL;
705f1ae32a1SGerd Hoffmann break;
706f1ae32a1SGerd Hoffmann }
707f1ae32a1SGerd Hoffmann }
708f1ae32a1SGerd Hoffmann
ccid_card_inserted(USBCCIDState * s)709f1ae32a1SGerd Hoffmann static bool ccid_card_inserted(USBCCIDState *s)
710f1ae32a1SGerd Hoffmann {
711f1ae32a1SGerd Hoffmann return s->bmSlotICCState & SLOT_0_STATE_MASK;
712f1ae32a1SGerd Hoffmann }
713f1ae32a1SGerd Hoffmann
ccid_card_status(USBCCIDState * s)714f1ae32a1SGerd Hoffmann static uint8_t ccid_card_status(USBCCIDState *s)
715f1ae32a1SGerd Hoffmann {
716f1ae32a1SGerd Hoffmann return ccid_card_inserted(s)
717f1ae32a1SGerd Hoffmann ? (s->powered ?
718f1ae32a1SGerd Hoffmann ICC_STATUS_PRESENT_ACTIVE
719f1ae32a1SGerd Hoffmann : ICC_STATUS_PRESENT_INACTIVE
720f1ae32a1SGerd Hoffmann )
721f1ae32a1SGerd Hoffmann : ICC_STATUS_NOT_PRESENT;
722f1ae32a1SGerd Hoffmann }
723f1ae32a1SGerd Hoffmann
ccid_calc_status(USBCCIDState * s)724f1ae32a1SGerd Hoffmann static uint8_t ccid_calc_status(USBCCIDState *s)
725f1ae32a1SGerd Hoffmann {
726f1ae32a1SGerd Hoffmann /*
727f1ae32a1SGerd Hoffmann * page 55, 6.2.6, calculation of bStatus from bmICCStatus and
728f1ae32a1SGerd Hoffmann * bmCommandStatus
729f1ae32a1SGerd Hoffmann */
730f1ae32a1SGerd Hoffmann uint8_t ret = ccid_card_status(s) | (s->bmCommandStatus << 6);
7317e1ac5abSAlon Levy DPRINTF(s, D_VERBOSE, "%s: status = %d\n", __func__, ret);
732f1ae32a1SGerd Hoffmann return ret;
733f1ae32a1SGerd Hoffmann }
734f1ae32a1SGerd Hoffmann
ccid_reset_error_status(USBCCIDState * s)735f1ae32a1SGerd Hoffmann static void ccid_reset_error_status(USBCCIDState *s)
736f1ae32a1SGerd Hoffmann {
737f1ae32a1SGerd Hoffmann s->bError = ERROR_CMD_NOT_SUPPORTED;
738f1ae32a1SGerd Hoffmann s->bmCommandStatus = COMMAND_STATUS_NO_ERROR;
739f1ae32a1SGerd Hoffmann }
740f1ae32a1SGerd Hoffmann
ccid_write_slot_status(USBCCIDState * s,CCID_Header * recv)741f1ae32a1SGerd Hoffmann static void ccid_write_slot_status(USBCCIDState *s, CCID_Header *recv)
742f1ae32a1SGerd Hoffmann {
743f1ae32a1SGerd Hoffmann CCID_SlotStatus *h = ccid_reserve_recv_buf(s, sizeof(CCID_SlotStatus));
744f1ae32a1SGerd Hoffmann if (h == NULL) {
745f1ae32a1SGerd Hoffmann return;
746f1ae32a1SGerd Hoffmann }
747f1ae32a1SGerd Hoffmann h->b.hdr.bMessageType = CCID_MESSAGE_TYPE_RDR_to_PC_SlotStatus;
748f1ae32a1SGerd Hoffmann h->b.hdr.dwLength = 0;
749f1ae32a1SGerd Hoffmann h->b.hdr.bSlot = recv->bSlot;
750f1ae32a1SGerd Hoffmann h->b.hdr.bSeq = recv->bSeq;
751f1ae32a1SGerd Hoffmann h->b.bStatus = ccid_calc_status(s);
752f1ae32a1SGerd Hoffmann h->b.bError = s->bError;
753f1ae32a1SGerd Hoffmann h->bClockStatus = CLOCK_STATUS_RUNNING;
754f1ae32a1SGerd Hoffmann ccid_reset_error_status(s);
75586d7e214SGerd Hoffmann usb_wakeup(s->bulk, 0);
756f1ae32a1SGerd Hoffmann }
757f1ae32a1SGerd Hoffmann
ccid_write_parameters(USBCCIDState * s,CCID_Header * recv)758f1ae32a1SGerd Hoffmann static void ccid_write_parameters(USBCCIDState *s, CCID_Header *recv)
759f1ae32a1SGerd Hoffmann {
760f1ae32a1SGerd Hoffmann CCID_Parameter *h;
761f1ae32a1SGerd Hoffmann uint32_t len = s->ulProtocolDataStructureSize;
762f1ae32a1SGerd Hoffmann
763f1ae32a1SGerd Hoffmann h = ccid_reserve_recv_buf(s, sizeof(CCID_Parameter) + len);
764f1ae32a1SGerd Hoffmann if (h == NULL) {
765f1ae32a1SGerd Hoffmann return;
766f1ae32a1SGerd Hoffmann }
767f1ae32a1SGerd Hoffmann h->b.hdr.bMessageType = CCID_MESSAGE_TYPE_RDR_to_PC_Parameters;
768f1ae32a1SGerd Hoffmann h->b.hdr.dwLength = 0;
769f1ae32a1SGerd Hoffmann h->b.hdr.bSlot = recv->bSlot;
770f1ae32a1SGerd Hoffmann h->b.hdr.bSeq = recv->bSeq;
771f1ae32a1SGerd Hoffmann h->b.bStatus = ccid_calc_status(s);
772f1ae32a1SGerd Hoffmann h->b.bError = s->bError;
773f1ae32a1SGerd Hoffmann h->bProtocolNum = s->bProtocolNum;
7744942d6c3SAlon Levy h->abProtocolDataStructure = s->abProtocolDataStructure;
775f1ae32a1SGerd Hoffmann ccid_reset_error_status(s);
77686d7e214SGerd Hoffmann usb_wakeup(s->bulk, 0);
777f1ae32a1SGerd Hoffmann }
778f1ae32a1SGerd Hoffmann
ccid_write_data_block(USBCCIDState * s,uint8_t slot,uint8_t seq,const uint8_t * data,uint32_t len)779f1ae32a1SGerd Hoffmann static void ccid_write_data_block(USBCCIDState *s, uint8_t slot, uint8_t seq,
780f1ae32a1SGerd Hoffmann const uint8_t *data, uint32_t len)
781f1ae32a1SGerd Hoffmann {
782f1ae32a1SGerd Hoffmann CCID_DataBlock *p = ccid_reserve_recv_buf(s, sizeof(*p) + len);
783f1ae32a1SGerd Hoffmann
784f1ae32a1SGerd Hoffmann if (p == NULL) {
785f1ae32a1SGerd Hoffmann return;
786f1ae32a1SGerd Hoffmann }
787f1ae32a1SGerd Hoffmann p->b.hdr.bMessageType = CCID_MESSAGE_TYPE_RDR_to_PC_DataBlock;
788f1ae32a1SGerd Hoffmann p->b.hdr.dwLength = cpu_to_le32(len);
789f1ae32a1SGerd Hoffmann p->b.hdr.bSlot = slot;
790f1ae32a1SGerd Hoffmann p->b.hdr.bSeq = seq;
791f1ae32a1SGerd Hoffmann p->b.bStatus = ccid_calc_status(s);
792f1ae32a1SGerd Hoffmann p->b.bError = s->bError;
793f1ae32a1SGerd Hoffmann if (p->b.bError) {
7947e1ac5abSAlon Levy DPRINTF(s, D_VERBOSE, "error %d\n", p->b.bError);
795f1ae32a1SGerd Hoffmann }
7966b1de148SPhilippe Mathieu-Daudé if (len) {
797719a3077SMarkus Armbruster assert(data);
798f1ae32a1SGerd Hoffmann memcpy(p->abData, data, len);
7996b1de148SPhilippe Mathieu-Daudé }
800f1ae32a1SGerd Hoffmann ccid_reset_error_status(s);
80186d7e214SGerd Hoffmann usb_wakeup(s->bulk, 0);
802f1ae32a1SGerd Hoffmann }
803f1ae32a1SGerd Hoffmann
ccid_report_error_failed(USBCCIDState * s,uint8_t error)80447bf53afSAlon Levy static void ccid_report_error_failed(USBCCIDState *s, uint8_t error)
80547bf53afSAlon Levy {
80647bf53afSAlon Levy s->bmCommandStatus = COMMAND_STATUS_FAILED;
80747bf53afSAlon Levy s->bError = error;
80847bf53afSAlon Levy }
80947bf53afSAlon Levy
ccid_write_data_block_answer(USBCCIDState * s,const uint8_t * data,uint32_t len)810f1ae32a1SGerd Hoffmann static void ccid_write_data_block_answer(USBCCIDState *s,
811f1ae32a1SGerd Hoffmann const uint8_t *data, uint32_t len)
812f1ae32a1SGerd Hoffmann {
813f1ae32a1SGerd Hoffmann uint8_t seq;
814f1ae32a1SGerd Hoffmann uint8_t slot;
815f1ae32a1SGerd Hoffmann
816f1ae32a1SGerd Hoffmann if (!ccid_has_pending_answers(s)) {
81747bf53afSAlon Levy DPRINTF(s, D_WARN, "error: no pending answer to return to guest\n");
81847bf53afSAlon Levy ccid_report_error_failed(s, ERROR_ICC_MUTE);
81947bf53afSAlon Levy return;
820f1ae32a1SGerd Hoffmann }
821f1ae32a1SGerd Hoffmann ccid_remove_pending_answer(s, &slot, &seq);
822f1ae32a1SGerd Hoffmann ccid_write_data_block(s, slot, seq, data, len);
823f1ae32a1SGerd Hoffmann }
824f1ae32a1SGerd Hoffmann
atr_get_protocol_num(const uint8_t * atr,uint32_t len)8252f8f916bSAlon Levy static uint8_t atr_get_protocol_num(const uint8_t *atr, uint32_t len)
8262f8f916bSAlon Levy {
8272f8f916bSAlon Levy int i;
8282f8f916bSAlon Levy
8292f8f916bSAlon Levy if (len < 2 || !(atr[1] & 0x80)) {
8302f8f916bSAlon Levy /* too short or TD1 not included */
8312f8f916bSAlon Levy return 0; /* T=0, default */
8322f8f916bSAlon Levy }
8332f8f916bSAlon Levy i = 1 + !!(atr[1] & 0x10) + !!(atr[1] & 0x20) + !!(atr[1] & 0x40);
8342f8f916bSAlon Levy i += !!(atr[1] & 0x80);
8352f8f916bSAlon Levy return atr[i] & 0x0f;
8362f8f916bSAlon Levy }
8372f8f916bSAlon Levy
ccid_write_data_block_atr(USBCCIDState * s,CCID_Header * recv)838f1ae32a1SGerd Hoffmann static void ccid_write_data_block_atr(USBCCIDState *s, CCID_Header *recv)
839f1ae32a1SGerd Hoffmann {
840f1ae32a1SGerd Hoffmann const uint8_t *atr = NULL;
841f1ae32a1SGerd Hoffmann uint32_t len = 0;
8422f8f916bSAlon Levy uint8_t atr_protocol_num;
8432f8f916bSAlon Levy CCID_T0ProtocolDataStructure *t0 = &s->abProtocolDataStructure.t0;
8442f8f916bSAlon Levy CCID_T1ProtocolDataStructure *t1 = &s->abProtocolDataStructure.t1;
845f1ae32a1SGerd Hoffmann
846f1ae32a1SGerd Hoffmann if (s->card) {
847f1ae32a1SGerd Hoffmann atr = ccid_card_get_atr(s->card, &len);
848f1ae32a1SGerd Hoffmann }
8492f8f916bSAlon Levy atr_protocol_num = atr_get_protocol_num(atr, len);
8502f8f916bSAlon Levy DPRINTF(s, D_VERBOSE, "%s: atr contains protocol=%d\n", __func__,
8512f8f916bSAlon Levy atr_protocol_num);
8522f8f916bSAlon Levy /* set parameters from ATR - see spec page 109 */
8532f8f916bSAlon Levy s->bProtocolNum = (atr_protocol_num <= 1 ? atr_protocol_num
8542f8f916bSAlon Levy : s->bProtocolNum);
8552f8f916bSAlon Levy switch (atr_protocol_num) {
8562f8f916bSAlon Levy case 0:
8572f8f916bSAlon Levy /* TODO: unimplemented ATR T0 parameters */
8582f8f916bSAlon Levy t0->bmFindexDindex = 0;
8592f8f916bSAlon Levy t0->bmTCCKST0 = 0;
8602f8f916bSAlon Levy t0->bGuardTimeT0 = 0;
8612f8f916bSAlon Levy t0->bWaitingIntegerT0 = 0;
8622f8f916bSAlon Levy t0->bClockStop = 0;
8632f8f916bSAlon Levy break;
8642f8f916bSAlon Levy case 1:
8652f8f916bSAlon Levy /* TODO: unimplemented ATR T1 parameters */
8662f8f916bSAlon Levy t1->bmFindexDindex = 0;
8672f8f916bSAlon Levy t1->bmTCCKST1 = 0;
8682f8f916bSAlon Levy t1->bGuardTimeT1 = 0;
8692f8f916bSAlon Levy t1->bWaitingIntegerT1 = 0;
8702f8f916bSAlon Levy t1->bClockStop = 0;
8712f8f916bSAlon Levy t1->bIFSC = 0;
8722f8f916bSAlon Levy t1->bNadValue = 0;
8732f8f916bSAlon Levy break;
8742f8f916bSAlon Levy default:
8752f8f916bSAlon Levy DPRINTF(s, D_WARN, "%s: error: unsupported ATR protocol %d\n",
8762f8f916bSAlon Levy __func__, atr_protocol_num);
8772f8f916bSAlon Levy }
878f1ae32a1SGerd Hoffmann ccid_write_data_block(s, recv->bSlot, recv->bSeq, atr, len);
879f1ae32a1SGerd Hoffmann }
880f1ae32a1SGerd Hoffmann
ccid_set_parameters(USBCCIDState * s,CCID_Header * recv)881f1ae32a1SGerd Hoffmann static void ccid_set_parameters(USBCCIDState *s, CCID_Header *recv)
882f1ae32a1SGerd Hoffmann {
883f1ae32a1SGerd Hoffmann CCID_SetParameters *ph = (CCID_SetParameters *) recv;
8844942d6c3SAlon Levy uint32_t protocol_num = ph->bProtocolNum & 3;
8854942d6c3SAlon Levy
8864942d6c3SAlon Levy if (protocol_num != 0 && protocol_num != 1) {
8874942d6c3SAlon Levy ccid_report_error_failed(s, ERROR_CMD_NOT_SUPPORTED);
888f1ae32a1SGerd Hoffmann return;
889f1ae32a1SGerd Hoffmann }
8904942d6c3SAlon Levy s->bProtocolNum = protocol_num;
8914942d6c3SAlon Levy s->abProtocolDataStructure = ph->abProtocolDataStructure;
892f1ae32a1SGerd Hoffmann }
893f1ae32a1SGerd Hoffmann
894f1ae32a1SGerd Hoffmann /*
895f1ae32a1SGerd Hoffmann * must be 5 bytes for T=0, 7 bytes for T=1
896f1ae32a1SGerd Hoffmann * See page 52
897f1ae32a1SGerd Hoffmann */
8984942d6c3SAlon Levy static const CCID_ProtocolDataStructure defaultProtocolDataStructure = {
8994942d6c3SAlon Levy .t1 = {
9004942d6c3SAlon Levy .bmFindexDindex = 0x77,
9014942d6c3SAlon Levy .bmTCCKST1 = 0x00,
9024942d6c3SAlon Levy .bGuardTimeT1 = 0x00,
9034942d6c3SAlon Levy .bWaitingIntegerT1 = 0x00,
9044942d6c3SAlon Levy .bClockStop = 0x00,
9054942d6c3SAlon Levy .bIFSC = 0xfe,
9064942d6c3SAlon Levy .bNadValue = 0x00,
9074942d6c3SAlon Levy }
9084942d6c3SAlon Levy };
909f1ae32a1SGerd Hoffmann
ccid_reset_parameters(USBCCIDState * s)910f1ae32a1SGerd Hoffmann static void ccid_reset_parameters(USBCCIDState *s)
911f1ae32a1SGerd Hoffmann {
912d7d218efSAlon Levy s->bProtocolNum = 0; /* T=0 */
9134942d6c3SAlon Levy s->abProtocolDataStructure = defaultProtocolDataStructure;
914f1ae32a1SGerd Hoffmann }
915f1ae32a1SGerd Hoffmann
916f1ae32a1SGerd Hoffmann /* NOTE: only a single slot is supported (SLOT_0) */
ccid_on_slot_change(USBCCIDState * s,bool full)917f1ae32a1SGerd Hoffmann static void ccid_on_slot_change(USBCCIDState *s, bool full)
918f1ae32a1SGerd Hoffmann {
919f1ae32a1SGerd Hoffmann /* RDR_to_PC_NotifySlotChange, 6.3.1 page 56 */
920f1ae32a1SGerd Hoffmann uint8_t current = s->bmSlotICCState;
921f1ae32a1SGerd Hoffmann if (full) {
922f1ae32a1SGerd Hoffmann s->bmSlotICCState |= SLOT_0_STATE_MASK;
923f1ae32a1SGerd Hoffmann } else {
924f1ae32a1SGerd Hoffmann s->bmSlotICCState &= ~SLOT_0_STATE_MASK;
925f1ae32a1SGerd Hoffmann }
926f1ae32a1SGerd Hoffmann if (current != s->bmSlotICCState) {
927f1ae32a1SGerd Hoffmann s->bmSlotICCState |= SLOT_0_CHANGED_MASK;
928f1ae32a1SGerd Hoffmann }
929f1ae32a1SGerd Hoffmann s->notify_slot_change = true;
9308550a02dSGerd Hoffmann usb_wakeup(s->intr, 0);
931f1ae32a1SGerd Hoffmann }
932f1ae32a1SGerd Hoffmann
ccid_write_data_block_error(USBCCIDState * s,uint8_t slot,uint8_t seq)933f1ae32a1SGerd Hoffmann static void ccid_write_data_block_error(
934f1ae32a1SGerd Hoffmann USBCCIDState *s, uint8_t slot, uint8_t seq)
935f1ae32a1SGerd Hoffmann {
936f1ae32a1SGerd Hoffmann ccid_write_data_block(s, slot, seq, NULL, 0);
937f1ae32a1SGerd Hoffmann }
938f1ae32a1SGerd Hoffmann
ccid_on_apdu_from_guest(USBCCIDState * s,CCID_XferBlock * recv)939f1ae32a1SGerd Hoffmann static void ccid_on_apdu_from_guest(USBCCIDState *s, CCID_XferBlock *recv)
940f1ae32a1SGerd Hoffmann {
941f1ae32a1SGerd Hoffmann uint32_t len;
942f1ae32a1SGerd Hoffmann
943f1ae32a1SGerd Hoffmann if (ccid_card_status(s) != ICC_STATUS_PRESENT_ACTIVE) {
944f1ae32a1SGerd Hoffmann DPRINTF(s, 1,
945f1ae32a1SGerd Hoffmann "usb-ccid: not sending apdu to client, no card connected\n");
946f1ae32a1SGerd Hoffmann ccid_write_data_block_error(s, recv->hdr.bSlot, recv->hdr.bSeq);
947f1ae32a1SGerd Hoffmann return;
948f1ae32a1SGerd Hoffmann }
949f1ae32a1SGerd Hoffmann len = le32_to_cpu(recv->hdr.dwLength);
950268c0242SAlex Chen DPRINTF(s, 1, "%s: seq %d, len %u\n", __func__,
951f1ae32a1SGerd Hoffmann recv->hdr.bSeq, len);
952f1ae32a1SGerd Hoffmann ccid_add_pending_answer(s, (CCID_Header *)recv);
953c7dfbf32SPrasad J Pandit if (s->card && len <= BULK_OUT_DATA_SIZE) {
954f1ae32a1SGerd Hoffmann ccid_card_apdu_from_guest(s->card, recv->abData, len);
955f1ae32a1SGerd Hoffmann } else {
956f1ae32a1SGerd Hoffmann DPRINTF(s, D_WARN, "warning: discarded apdu\n");
957f1ae32a1SGerd Hoffmann }
958f1ae32a1SGerd Hoffmann }
959f1ae32a1SGerd Hoffmann
ccid_message_type_to_str(uint8_t type)9607e1ac5abSAlon Levy static const char *ccid_message_type_to_str(uint8_t type)
9617e1ac5abSAlon Levy {
9627e1ac5abSAlon Levy switch (type) {
9637e1ac5abSAlon Levy case CCID_MESSAGE_TYPE_PC_to_RDR_IccPowerOn: return "IccPowerOn";
9647e1ac5abSAlon Levy case CCID_MESSAGE_TYPE_PC_to_RDR_IccPowerOff: return "IccPowerOff";
9657e1ac5abSAlon Levy case CCID_MESSAGE_TYPE_PC_to_RDR_GetSlotStatus: return "GetSlotStatus";
9667e1ac5abSAlon Levy case CCID_MESSAGE_TYPE_PC_to_RDR_XfrBlock: return "XfrBlock";
9677e1ac5abSAlon Levy case CCID_MESSAGE_TYPE_PC_to_RDR_GetParameters: return "GetParameters";
9687e1ac5abSAlon Levy case CCID_MESSAGE_TYPE_PC_to_RDR_ResetParameters: return "ResetParameters";
9697e1ac5abSAlon Levy case CCID_MESSAGE_TYPE_PC_to_RDR_SetParameters: return "SetParameters";
9707e1ac5abSAlon Levy case CCID_MESSAGE_TYPE_PC_to_RDR_Escape: return "Escape";
9717e1ac5abSAlon Levy case CCID_MESSAGE_TYPE_PC_to_RDR_IccClock: return "IccClock";
9727e1ac5abSAlon Levy case CCID_MESSAGE_TYPE_PC_to_RDR_T0APDU: return "T0APDU";
9737e1ac5abSAlon Levy case CCID_MESSAGE_TYPE_PC_to_RDR_Secure: return "Secure";
9747e1ac5abSAlon Levy case CCID_MESSAGE_TYPE_PC_to_RDR_Mechanical: return "Mechanical";
9757e1ac5abSAlon Levy case CCID_MESSAGE_TYPE_PC_to_RDR_Abort: return "Abort";
9767e1ac5abSAlon Levy case CCID_MESSAGE_TYPE_PC_to_RDR_SetDataRateAndClockFrequency:
9777e1ac5abSAlon Levy return "SetDataRateAndClockFrequency";
9787e1ac5abSAlon Levy }
9797e1ac5abSAlon Levy return "unknown";
9807e1ac5abSAlon Levy }
9817e1ac5abSAlon Levy
ccid_handle_bulk_out(USBCCIDState * s,USBPacket * p)9829a77a0f5SHans de Goede static void ccid_handle_bulk_out(USBCCIDState *s, USBPacket *p)
983f1ae32a1SGerd Hoffmann {
984f1ae32a1SGerd Hoffmann CCID_Header *ccid_header;
985f1ae32a1SGerd Hoffmann
986f1ae32a1SGerd Hoffmann if (p->iov.size + s->bulk_out_pos > BULK_OUT_DATA_SIZE) {
9870aeebc73SGerd Hoffmann goto err;
988f1ae32a1SGerd Hoffmann }
989f1ae32a1SGerd Hoffmann usb_packet_copy(p, s->bulk_out_data + s->bulk_out_pos, p->iov.size);
990f1ae32a1SGerd Hoffmann s->bulk_out_pos += p->iov.size;
9917569c546SGerd Hoffmann if (s->bulk_out_pos < 10) {
9927569c546SGerd Hoffmann DPRINTF(s, 1, "%s: header incomplete\n", __func__);
9937569c546SGerd Hoffmann goto err;
9947569c546SGerd Hoffmann }
9957569c546SGerd Hoffmann
9967569c546SGerd Hoffmann ccid_header = (CCID_Header *)s->bulk_out_data;
99731fb4444SGerd Hoffmann if ((s->bulk_out_pos - 10 < ccid_header->dwLength) &&
99831fb4444SGerd Hoffmann (p->iov.size == CCID_MAX_PACKET_SIZE)) {
999f1ae32a1SGerd Hoffmann DPRINTF(s, D_VERBOSE,
1000268c0242SAlex Chen "usb-ccid: bulk_in: expecting more packets (%u/%u)\n",
100131fb4444SGerd Hoffmann s->bulk_out_pos - 10, ccid_header->dwLength);
10029a77a0f5SHans de Goede return;
1003f1ae32a1SGerd Hoffmann }
100431fb4444SGerd Hoffmann if (s->bulk_out_pos - 10 != ccid_header->dwLength) {
100531fb4444SGerd Hoffmann DPRINTF(s, 1,
1006268c0242SAlex Chen "usb-ccid: bulk_in: message size mismatch (got %u, expected %u)\n",
100731fb4444SGerd Hoffmann s->bulk_out_pos - 10, ccid_header->dwLength);
100831fb4444SGerd Hoffmann goto err;
100931fb4444SGerd Hoffmann }
10100aeebc73SGerd Hoffmann
10117e1ac5abSAlon Levy DPRINTF(s, D_MORE_INFO, "%s %x %s\n", __func__,
10127e1ac5abSAlon Levy ccid_header->bMessageType,
10137e1ac5abSAlon Levy ccid_message_type_to_str(ccid_header->bMessageType));
1014f1ae32a1SGerd Hoffmann switch (ccid_header->bMessageType) {
1015f1ae32a1SGerd Hoffmann case CCID_MESSAGE_TYPE_PC_to_RDR_GetSlotStatus:
1016f1ae32a1SGerd Hoffmann ccid_write_slot_status(s, ccid_header);
1017f1ae32a1SGerd Hoffmann break;
1018f1ae32a1SGerd Hoffmann case CCID_MESSAGE_TYPE_PC_to_RDR_IccPowerOn:
10197e1ac5abSAlon Levy DPRINTF(s, 1, "%s: PowerOn: %d\n", __func__,
1020f1ae32a1SGerd Hoffmann ((CCID_IccPowerOn *)(ccid_header))->bPowerSelect);
1021f1ae32a1SGerd Hoffmann s->powered = true;
1022f1ae32a1SGerd Hoffmann if (!ccid_card_inserted(s)) {
1023f1ae32a1SGerd Hoffmann ccid_report_error_failed(s, ERROR_ICC_MUTE);
1024f1ae32a1SGerd Hoffmann }
1025f1ae32a1SGerd Hoffmann /* atr is written regardless of error. */
1026f1ae32a1SGerd Hoffmann ccid_write_data_block_atr(s, ccid_header);
1027f1ae32a1SGerd Hoffmann break;
1028f1ae32a1SGerd Hoffmann case CCID_MESSAGE_TYPE_PC_to_RDR_IccPowerOff:
1029f1ae32a1SGerd Hoffmann ccid_reset_error_status(s);
1030f1ae32a1SGerd Hoffmann s->powered = false;
1031f1ae32a1SGerd Hoffmann ccid_write_slot_status(s, ccid_header);
1032f1ae32a1SGerd Hoffmann break;
1033f1ae32a1SGerd Hoffmann case CCID_MESSAGE_TYPE_PC_to_RDR_XfrBlock:
1034f1ae32a1SGerd Hoffmann ccid_on_apdu_from_guest(s, (CCID_XferBlock *)s->bulk_out_data);
1035f1ae32a1SGerd Hoffmann break;
1036f1ae32a1SGerd Hoffmann case CCID_MESSAGE_TYPE_PC_to_RDR_SetParameters:
1037f1ae32a1SGerd Hoffmann ccid_reset_error_status(s);
1038f1ae32a1SGerd Hoffmann ccid_set_parameters(s, ccid_header);
1039f1ae32a1SGerd Hoffmann ccid_write_parameters(s, ccid_header);
1040f1ae32a1SGerd Hoffmann break;
1041f1ae32a1SGerd Hoffmann case CCID_MESSAGE_TYPE_PC_to_RDR_ResetParameters:
1042f1ae32a1SGerd Hoffmann ccid_reset_error_status(s);
1043f1ae32a1SGerd Hoffmann ccid_reset_parameters(s);
1044f1ae32a1SGerd Hoffmann ccid_write_parameters(s, ccid_header);
1045f1ae32a1SGerd Hoffmann break;
1046f1ae32a1SGerd Hoffmann case CCID_MESSAGE_TYPE_PC_to_RDR_GetParameters:
1047f1ae32a1SGerd Hoffmann ccid_reset_error_status(s);
1048f1ae32a1SGerd Hoffmann ccid_write_parameters(s, ccid_header);
1049f1ae32a1SGerd Hoffmann break;
105058aeda15SAlon Levy case CCID_MESSAGE_TYPE_PC_to_RDR_Mechanical:
105158aeda15SAlon Levy ccid_report_error_failed(s, 0);
105258aeda15SAlon Levy ccid_write_slot_status(s, ccid_header);
105358aeda15SAlon Levy break;
1054f1ae32a1SGerd Hoffmann default:
1055f1ae32a1SGerd Hoffmann DPRINTF(s, 1,
1056f1ae32a1SGerd Hoffmann "handle_data: ERROR: unhandled message type %Xh\n",
1057f1ae32a1SGerd Hoffmann ccid_header->bMessageType);
1058f1ae32a1SGerd Hoffmann /*
1059f1ae32a1SGerd Hoffmann * The caller is expecting the device to respond, tell it we
1060f1ae32a1SGerd Hoffmann * don't support the operation.
1061f1ae32a1SGerd Hoffmann */
1062f1ae32a1SGerd Hoffmann ccid_report_error_failed(s, ERROR_CMD_NOT_SUPPORTED);
1063f1ae32a1SGerd Hoffmann ccid_write_slot_status(s, ccid_header);
1064f1ae32a1SGerd Hoffmann break;
1065f1ae32a1SGerd Hoffmann }
1066f1ae32a1SGerd Hoffmann s->bulk_out_pos = 0;
10670aeebc73SGerd Hoffmann return;
10680aeebc73SGerd Hoffmann
10690aeebc73SGerd Hoffmann err:
10700aeebc73SGerd Hoffmann p->status = USB_RET_STALL;
10710aeebc73SGerd Hoffmann s->bulk_out_pos = 0;
10720aeebc73SGerd Hoffmann return;
1073f1ae32a1SGerd Hoffmann }
1074f1ae32a1SGerd Hoffmann
ccid_bulk_in_copy_to_guest(USBCCIDState * s,USBPacket * p,unsigned int max_packet_size)10758030dca3SJakub Jelen static void ccid_bulk_in_copy_to_guest(USBCCIDState *s, USBPacket *p,
10768030dca3SJakub Jelen unsigned int max_packet_size)
1077f1ae32a1SGerd Hoffmann {
10789a77a0f5SHans de Goede int len = 0;
1079f1ae32a1SGerd Hoffmann
1080f1ae32a1SGerd Hoffmann ccid_bulk_in_get(s);
1081f1ae32a1SGerd Hoffmann if (s->current_bulk_in != NULL) {
10829a77a0f5SHans de Goede len = MIN(s->current_bulk_in->len - s->current_bulk_in->pos,
1083f1ae32a1SGerd Hoffmann p->iov.size);
10848030dca3SJakub Jelen if (len) {
1085f1ae32a1SGerd Hoffmann usb_packet_copy(p, s->current_bulk_in->data +
10869a77a0f5SHans de Goede s->current_bulk_in->pos, len);
10878030dca3SJakub Jelen }
10889a77a0f5SHans de Goede s->current_bulk_in->pos += len;
10898030dca3SJakub Jelen if (s->current_bulk_in->pos == s->current_bulk_in->len
10908030dca3SJakub Jelen && len != max_packet_size) {
1091f1ae32a1SGerd Hoffmann ccid_bulk_in_release(s);
1092f1ae32a1SGerd Hoffmann }
1093f1ae32a1SGerd Hoffmann } else {
1094f1ae32a1SGerd Hoffmann /* return when device has no data - usb 2.0 spec Table 8-4 */
10959a77a0f5SHans de Goede p->status = USB_RET_NAK;
1096f1ae32a1SGerd Hoffmann }
10979a77a0f5SHans de Goede if (len) {
1098f1ae32a1SGerd Hoffmann DPRINTF(s, D_MORE_INFO,
1099f1ae32a1SGerd Hoffmann "%s: %zd/%d req/act to guest (BULK_IN)\n",
11009a77a0f5SHans de Goede __func__, p->iov.size, len);
1101f1ae32a1SGerd Hoffmann }
11029a77a0f5SHans de Goede if (len < p->iov.size) {
1103f1ae32a1SGerd Hoffmann DPRINTF(s, 1,
1104f1ae32a1SGerd Hoffmann "%s: returning short (EREMOTEIO) %d < %zd\n",
11059a77a0f5SHans de Goede __func__, len, p->iov.size);
1106f1ae32a1SGerd Hoffmann }
1107f1ae32a1SGerd Hoffmann }
1108f1ae32a1SGerd Hoffmann
ccid_handle_data(USBDevice * dev,USBPacket * p)11099a77a0f5SHans de Goede static void ccid_handle_data(USBDevice *dev, USBPacket *p)
1110f1ae32a1SGerd Hoffmann {
111161b4887bSGonglei USBCCIDState *s = USB_CCID_DEV(dev);
1112f1ae32a1SGerd Hoffmann uint8_t buf[2];
1113f1ae32a1SGerd Hoffmann
1114f1ae32a1SGerd Hoffmann switch (p->pid) {
1115f1ae32a1SGerd Hoffmann case USB_TOKEN_OUT:
11169a77a0f5SHans de Goede ccid_handle_bulk_out(s, p);
1117f1ae32a1SGerd Hoffmann break;
1118f1ae32a1SGerd Hoffmann
1119f1ae32a1SGerd Hoffmann case USB_TOKEN_IN:
1120f1ae32a1SGerd Hoffmann switch (p->ep->nr) {
1121f1ae32a1SGerd Hoffmann case CCID_BULK_IN_EP:
11228030dca3SJakub Jelen ccid_bulk_in_copy_to_guest(s, p, dev->ep_ctl.max_packet_size);
1123f1ae32a1SGerd Hoffmann break;
1124f1ae32a1SGerd Hoffmann case CCID_INT_IN_EP:
1125f1ae32a1SGerd Hoffmann if (s->notify_slot_change) {
1126f1ae32a1SGerd Hoffmann /* page 56, RDR_to_PC_NotifySlotChange */
1127f1ae32a1SGerd Hoffmann buf[0] = CCID_MESSAGE_TYPE_RDR_to_PC_NotifySlotChange;
1128f1ae32a1SGerd Hoffmann buf[1] = s->bmSlotICCState;
1129f1ae32a1SGerd Hoffmann usb_packet_copy(p, buf, 2);
1130f1ae32a1SGerd Hoffmann s->notify_slot_change = false;
1131f1ae32a1SGerd Hoffmann s->bmSlotICCState &= ~SLOT_0_CHANGED_MASK;
1132f1ae32a1SGerd Hoffmann DPRINTF(s, D_INFO,
1133f1ae32a1SGerd Hoffmann "handle_data: int_in: notify_slot_change %X, "
1134f1ae32a1SGerd Hoffmann "requested len %zd\n",
1135f1ae32a1SGerd Hoffmann s->bmSlotICCState, p->iov.size);
1136c4020746SHans de Goede } else {
1137c4020746SHans de Goede p->status = USB_RET_NAK;
1138f1ae32a1SGerd Hoffmann }
1139f1ae32a1SGerd Hoffmann break;
1140f1ae32a1SGerd Hoffmann default:
1141f1ae32a1SGerd Hoffmann DPRINTF(s, 1, "Bad endpoint\n");
11429a77a0f5SHans de Goede p->status = USB_RET_STALL;
1143f1ae32a1SGerd Hoffmann break;
1144f1ae32a1SGerd Hoffmann }
1145f1ae32a1SGerd Hoffmann break;
1146f1ae32a1SGerd Hoffmann default:
1147f1ae32a1SGerd Hoffmann DPRINTF(s, 1, "Bad token\n");
11489a77a0f5SHans de Goede p->status = USB_RET_STALL;
1149f1ae32a1SGerd Hoffmann break;
1150f1ae32a1SGerd Hoffmann }
1151f1ae32a1SGerd Hoffmann }
1152f1ae32a1SGerd Hoffmann
ccid_unrealize(USBDevice * dev)1153b69c3c21SMarkus Armbruster static void ccid_unrealize(USBDevice *dev)
1154f1ae32a1SGerd Hoffmann {
115561b4887bSGonglei USBCCIDState *s = USB_CCID_DEV(dev);
1156f1ae32a1SGerd Hoffmann
1157f1ae32a1SGerd Hoffmann ccid_bulk_in_clear(s);
1158f1ae32a1SGerd Hoffmann }
1159f1ae32a1SGerd Hoffmann
ccid_flush_pending_answers(USBCCIDState * s)1160f1ae32a1SGerd Hoffmann static void ccid_flush_pending_answers(USBCCIDState *s)
1161f1ae32a1SGerd Hoffmann {
1162f1ae32a1SGerd Hoffmann while (ccid_has_pending_answers(s)) {
1163f1ae32a1SGerd Hoffmann ccid_write_data_block_answer(s, NULL, 0);
1164f1ae32a1SGerd Hoffmann }
1165f1ae32a1SGerd Hoffmann }
1166f1ae32a1SGerd Hoffmann
ccid_peek_next_answer(USBCCIDState * s)1167f1ae32a1SGerd Hoffmann static Answer *ccid_peek_next_answer(USBCCIDState *s)
1168f1ae32a1SGerd Hoffmann {
1169f1ae32a1SGerd Hoffmann return s->pending_answers_num == 0
1170f1ae32a1SGerd Hoffmann ? NULL
1171f1ae32a1SGerd Hoffmann : &s->pending_answers[s->pending_answers_start % PENDING_ANSWERS_NUM];
1172f1ae32a1SGerd Hoffmann }
1173f1ae32a1SGerd Hoffmann
11743cb75a7cSPaolo Bonzini static Property ccid_props[] = {
11753cb75a7cSPaolo Bonzini DEFINE_PROP_UINT32("slot", struct CCIDCardState, slot, 0),
11763cb75a7cSPaolo Bonzini DEFINE_PROP_END_OF_LIST(),
11773cb75a7cSPaolo Bonzini };
11783cb75a7cSPaolo Bonzini
11790d936928SAnthony Liguori static const TypeInfo ccid_bus_info = {
11800d936928SAnthony Liguori .name = TYPE_CCID_BUS,
11810d936928SAnthony Liguori .parent = TYPE_BUS,
11820d936928SAnthony Liguori .instance_size = sizeof(CCIDBus),
1183f1ae32a1SGerd Hoffmann };
1184f1ae32a1SGerd Hoffmann
ccid_card_send_apdu_to_guest(CCIDCardState * card,uint8_t * apdu,uint32_t len)1185f1ae32a1SGerd Hoffmann void ccid_card_send_apdu_to_guest(CCIDCardState *card,
1186f1ae32a1SGerd Hoffmann uint8_t *apdu, uint32_t len)
1187f1ae32a1SGerd Hoffmann {
118861b4887bSGonglei DeviceState *qdev = DEVICE(card);
1189cfda2cefSGerd Hoffmann USBDevice *dev = USB_DEVICE(qdev->parent_bus->parent);
119061b4887bSGonglei USBCCIDState *s = USB_CCID_DEV(dev);
1191f1ae32a1SGerd Hoffmann Answer *answer;
1192f1ae32a1SGerd Hoffmann
1193f1ae32a1SGerd Hoffmann if (!ccid_has_pending_answers(s)) {
1194f1ae32a1SGerd Hoffmann DPRINTF(s, 1, "CCID ERROR: got an APDU without pending answers\n");
1195f1ae32a1SGerd Hoffmann return;
1196f1ae32a1SGerd Hoffmann }
1197f1ae32a1SGerd Hoffmann s->bmCommandStatus = COMMAND_STATUS_NO_ERROR;
1198f1ae32a1SGerd Hoffmann answer = ccid_peek_next_answer(s);
1199f1ae32a1SGerd Hoffmann if (answer == NULL) {
120047bf53afSAlon Levy DPRINTF(s, D_WARN, "%s: error: unexpected lack of answer\n", __func__);
120147bf53afSAlon Levy ccid_report_error_failed(s, ERROR_HW_ERROR);
120247bf53afSAlon Levy return;
1203f1ae32a1SGerd Hoffmann }
1204268c0242SAlex Chen DPRINTF(s, 1, "APDU returned to guest %u (answer seq %d, slot %d)\n",
1205f1ae32a1SGerd Hoffmann len, answer->seq, answer->slot);
1206f1ae32a1SGerd Hoffmann ccid_write_data_block_answer(s, apdu, len);
1207f1ae32a1SGerd Hoffmann }
1208f1ae32a1SGerd Hoffmann
ccid_card_card_removed(CCIDCardState * card)1209f1ae32a1SGerd Hoffmann void ccid_card_card_removed(CCIDCardState *card)
1210f1ae32a1SGerd Hoffmann {
121161b4887bSGonglei DeviceState *qdev = DEVICE(card);
1212cfda2cefSGerd Hoffmann USBDevice *dev = USB_DEVICE(qdev->parent_bus->parent);
121361b4887bSGonglei USBCCIDState *s = USB_CCID_DEV(dev);
1214f1ae32a1SGerd Hoffmann
1215f1ae32a1SGerd Hoffmann ccid_on_slot_change(s, false);
1216f1ae32a1SGerd Hoffmann ccid_flush_pending_answers(s);
1217f1ae32a1SGerd Hoffmann ccid_reset(s);
1218f1ae32a1SGerd Hoffmann }
1219f1ae32a1SGerd Hoffmann
ccid_card_ccid_attach(CCIDCardState * card)1220f1ae32a1SGerd Hoffmann int ccid_card_ccid_attach(CCIDCardState *card)
1221f1ae32a1SGerd Hoffmann {
122261b4887bSGonglei DeviceState *qdev = DEVICE(card);
1223cfda2cefSGerd Hoffmann USBDevice *dev = USB_DEVICE(qdev->parent_bus->parent);
122461b4887bSGonglei USBCCIDState *s = USB_CCID_DEV(dev);
1225f1ae32a1SGerd Hoffmann
1226f1ae32a1SGerd Hoffmann DPRINTF(s, 1, "CCID Attach\n");
1227f1ae32a1SGerd Hoffmann return 0;
1228f1ae32a1SGerd Hoffmann }
1229f1ae32a1SGerd Hoffmann
ccid_card_ccid_detach(CCIDCardState * card)1230f1ae32a1SGerd Hoffmann void ccid_card_ccid_detach(CCIDCardState *card)
1231f1ae32a1SGerd Hoffmann {
123261b4887bSGonglei DeviceState *qdev = DEVICE(card);
1233cfda2cefSGerd Hoffmann USBDevice *dev = USB_DEVICE(qdev->parent_bus->parent);
123461b4887bSGonglei USBCCIDState *s = USB_CCID_DEV(dev);
1235f1ae32a1SGerd Hoffmann
1236f1ae32a1SGerd Hoffmann DPRINTF(s, 1, "CCID Detach\n");
1237f1ae32a1SGerd Hoffmann if (ccid_card_inserted(s)) {
1238f1ae32a1SGerd Hoffmann ccid_on_slot_change(s, false);
1239f1ae32a1SGerd Hoffmann }
1240f1ae32a1SGerd Hoffmann ccid_detach(s);
1241f1ae32a1SGerd Hoffmann }
1242f1ae32a1SGerd Hoffmann
ccid_card_card_error(CCIDCardState * card,uint64_t error)1243f1ae32a1SGerd Hoffmann void ccid_card_card_error(CCIDCardState *card, uint64_t error)
1244f1ae32a1SGerd Hoffmann {
124561b4887bSGonglei DeviceState *qdev = DEVICE(card);
1246cfda2cefSGerd Hoffmann USBDevice *dev = USB_DEVICE(qdev->parent_bus->parent);
124761b4887bSGonglei USBCCIDState *s = USB_CCID_DEV(dev);
1248f1ae32a1SGerd Hoffmann
1249f1ae32a1SGerd Hoffmann s->bmCommandStatus = COMMAND_STATUS_FAILED;
1250f1ae32a1SGerd Hoffmann s->last_answer_error = error;
1251f1ae32a1SGerd Hoffmann DPRINTF(s, 1, "VSC_Error: %" PRIX64 "\n", s->last_answer_error);
1252f1ae32a1SGerd Hoffmann /* TODO: these errors should be more verbose and propagated to the guest.*/
1253f1ae32a1SGerd Hoffmann /*
1254f1ae32a1SGerd Hoffmann * We flush all pending answers on CardRemove message in ccid-card-passthru,
1255f1ae32a1SGerd Hoffmann * so check that first to not trigger abort
1256f1ae32a1SGerd Hoffmann */
1257f1ae32a1SGerd Hoffmann if (ccid_has_pending_answers(s)) {
1258f1ae32a1SGerd Hoffmann ccid_write_data_block_answer(s, NULL, 0);
1259f1ae32a1SGerd Hoffmann }
1260f1ae32a1SGerd Hoffmann }
1261f1ae32a1SGerd Hoffmann
ccid_card_card_inserted(CCIDCardState * card)1262f1ae32a1SGerd Hoffmann void ccid_card_card_inserted(CCIDCardState *card)
1263f1ae32a1SGerd Hoffmann {
126461b4887bSGonglei DeviceState *qdev = DEVICE(card);
1265cfda2cefSGerd Hoffmann USBDevice *dev = USB_DEVICE(qdev->parent_bus->parent);
126661b4887bSGonglei USBCCIDState *s = USB_CCID_DEV(dev);
1267f1ae32a1SGerd Hoffmann
1268f1ae32a1SGerd Hoffmann s->bmCommandStatus = COMMAND_STATUS_NO_ERROR;
1269f1ae32a1SGerd Hoffmann ccid_flush_pending_answers(s);
1270f1ae32a1SGerd Hoffmann ccid_on_slot_change(s, true);
1271f1ae32a1SGerd Hoffmann }
1272f1ae32a1SGerd Hoffmann
ccid_card_unrealize(DeviceState * qdev)1273b69c3c21SMarkus Armbruster static void ccid_card_unrealize(DeviceState *qdev)
1274f1ae32a1SGerd Hoffmann {
1275f1ae32a1SGerd Hoffmann CCIDCardState *card = CCID_CARD(qdev);
127680ae8654SPhilippe Mathieu-Daudé CCIDCardClass *cc = CCID_CARD_GET_CLASS(card);
1277cfda2cefSGerd Hoffmann USBDevice *dev = USB_DEVICE(qdev->parent_bus->parent);
127861b4887bSGonglei USBCCIDState *s = USB_CCID_DEV(dev);
1279f1ae32a1SGerd Hoffmann
1280f1ae32a1SGerd Hoffmann if (ccid_card_inserted(s)) {
1281f1ae32a1SGerd Hoffmann ccid_card_card_removed(card);
1282f1ae32a1SGerd Hoffmann }
128380ae8654SPhilippe Mathieu-Daudé if (cc->unrealize) {
1284b69c3c21SMarkus Armbruster cc->unrealize(card);
128580ae8654SPhilippe Mathieu-Daudé }
1286f1ae32a1SGerd Hoffmann s->card = NULL;
1287f1ae32a1SGerd Hoffmann }
1288f1ae32a1SGerd Hoffmann
ccid_card_realize(DeviceState * qdev,Error ** errp)1289cc847bfdSMao Zhongyi static void ccid_card_realize(DeviceState *qdev, Error **errp)
1290f1ae32a1SGerd Hoffmann {
1291f1ae32a1SGerd Hoffmann CCIDCardState *card = CCID_CARD(qdev);
1292c7516699SPhilippe Mathieu-Daudé CCIDCardClass *cc = CCID_CARD_GET_CLASS(card);
1293cfda2cefSGerd Hoffmann USBDevice *dev = USB_DEVICE(qdev->parent_bus->parent);
129461b4887bSGonglei USBCCIDState *s = USB_CCID_DEV(dev);
1295cc847bfdSMao Zhongyi Error *local_err = NULL;
1296f1ae32a1SGerd Hoffmann
1297f1ae32a1SGerd Hoffmann if (card->slot != 0) {
1298cc847bfdSMao Zhongyi error_setg(errp, "usb-ccid supports one slot, can't add %d",
1299f1ae32a1SGerd Hoffmann card->slot);
1300cc847bfdSMao Zhongyi return;
1301f1ae32a1SGerd Hoffmann }
1302f1ae32a1SGerd Hoffmann if (s->card != NULL) {
1303cc847bfdSMao Zhongyi error_setg(errp, "usb-ccid card already full, not adding");
1304cc847bfdSMao Zhongyi return;
1305f1ae32a1SGerd Hoffmann }
1306c7516699SPhilippe Mathieu-Daudé if (cc->realize) {
1307c7516699SPhilippe Mathieu-Daudé cc->realize(card, &local_err);
1308cc847bfdSMao Zhongyi if (local_err != NULL) {
1309cc847bfdSMao Zhongyi error_propagate(errp, local_err);
1310cc847bfdSMao Zhongyi return;
1311cc847bfdSMao Zhongyi }
1312c7516699SPhilippe Mathieu-Daudé }
1313f1ae32a1SGerd Hoffmann s->card = card;
1314f1ae32a1SGerd Hoffmann }
1315f1ae32a1SGerd Hoffmann
ccid_realize(USBDevice * dev,Error ** errp)13160b8b863fSGonglei static void ccid_realize(USBDevice *dev, Error **errp)
1317f1ae32a1SGerd Hoffmann {
131861b4887bSGonglei USBCCIDState *s = USB_CCID_DEV(dev);
1319f1ae32a1SGerd Hoffmann
13209d55d1adSGerd Hoffmann usb_desc_create_serial(dev);
1321f1ae32a1SGerd Hoffmann usb_desc_init(dev);
1322d637e1dcSPeter Maydell qbus_init(&s->bus, sizeof(s->bus), TYPE_CCID_BUS, DEVICE(dev), NULL);
13239bc6bfdfSMarkus Armbruster qbus_set_hotplug_handler(BUS(&s->bus), OBJECT(dev));
1324f1ae32a1SGerd Hoffmann s->intr = usb_ep_get(dev, USB_TOKEN_IN, CCID_INT_IN_EP);
132586d7e214SGerd Hoffmann s->bulk = usb_ep_get(dev, USB_TOKEN_IN, CCID_BULK_IN_EP);
1326f1ae32a1SGerd Hoffmann s->card = NULL;
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
ccid_post_load(void * opaque,int version_id)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
ccid_pre_save(void * opaque)135744b1ff31SDr. David Alan Gilbert static int ccid_pre_save(void *opaque)
1358f1ae32a1SGerd Hoffmann {
1359f1ae32a1SGerd Hoffmann USBCCIDState *s = opaque;
1360f1ae32a1SGerd Hoffmann
1361f1ae32a1SGerd Hoffmann s->state_vmstate = s->dev.state;
136244b1ff31SDr. David Alan Gilbert
136344b1ff31SDr. David Alan Gilbert return 0;
1364f1ae32a1SGerd Hoffmann }
1365f1ae32a1SGerd Hoffmann
1366db2dc7d8SPhilippe Mathieu-Daudé static const VMStateDescription bulk_in_vmstate = {
1367f1ae32a1SGerd Hoffmann .name = "CCID BulkIn state",
1368f1ae32a1SGerd Hoffmann .version_id = 1,
1369f1ae32a1SGerd Hoffmann .minimum_version_id = 1,
1370f1ae32a1SGerd Hoffmann .fields = (VMStateField[]) {
1371f1ae32a1SGerd Hoffmann VMSTATE_BUFFER(data, BulkIn),
1372f1ae32a1SGerd Hoffmann VMSTATE_UINT32(len, BulkIn),
1373f1ae32a1SGerd Hoffmann VMSTATE_UINT32(pos, BulkIn),
1374f1ae32a1SGerd Hoffmann VMSTATE_END_OF_LIST()
1375f1ae32a1SGerd Hoffmann }
1376f1ae32a1SGerd Hoffmann };
1377f1ae32a1SGerd Hoffmann
1378db2dc7d8SPhilippe Mathieu-Daudé static const VMStateDescription answer_vmstate = {
1379f1ae32a1SGerd Hoffmann .name = "CCID Answer state",
1380f1ae32a1SGerd Hoffmann .version_id = 1,
1381f1ae32a1SGerd Hoffmann .minimum_version_id = 1,
1382f1ae32a1SGerd Hoffmann .fields = (VMStateField[]) {
1383f1ae32a1SGerd Hoffmann VMSTATE_UINT8(slot, Answer),
1384f1ae32a1SGerd Hoffmann VMSTATE_UINT8(seq, Answer),
1385f1ae32a1SGerd Hoffmann VMSTATE_END_OF_LIST()
1386f1ae32a1SGerd Hoffmann }
1387f1ae32a1SGerd Hoffmann };
1388f1ae32a1SGerd Hoffmann
1389db2dc7d8SPhilippe Mathieu-Daudé static const VMStateDescription usb_device_vmstate = {
1390f1ae32a1SGerd Hoffmann .name = "usb_device",
1391f1ae32a1SGerd Hoffmann .version_id = 1,
1392f1ae32a1SGerd Hoffmann .minimum_version_id = 1,
1393f1ae32a1SGerd Hoffmann .fields = (VMStateField[]) {
1394f1ae32a1SGerd Hoffmann VMSTATE_UINT8(addr, USBDevice),
1395f1ae32a1SGerd Hoffmann VMSTATE_BUFFER(setup_buf, USBDevice),
1396f1ae32a1SGerd Hoffmann VMSTATE_BUFFER(data_buf, USBDevice),
1397f1ae32a1SGerd Hoffmann VMSTATE_END_OF_LIST()
1398f1ae32a1SGerd Hoffmann }
1399f1ae32a1SGerd Hoffmann };
1400f1ae32a1SGerd Hoffmann
1401db2dc7d8SPhilippe Mathieu-Daudé static const VMStateDescription ccid_vmstate = {
14026783ecf1SPeter Maydell .name = "usb-ccid",
1403f1ae32a1SGerd Hoffmann .version_id = 1,
1404f1ae32a1SGerd Hoffmann .minimum_version_id = 1,
1405f1ae32a1SGerd Hoffmann .post_load = ccid_post_load,
1406f1ae32a1SGerd Hoffmann .pre_save = ccid_pre_save,
1407f1ae32a1SGerd Hoffmann .fields = (VMStateField[]) {
1408f1ae32a1SGerd Hoffmann VMSTATE_STRUCT(dev, USBCCIDState, 1, usb_device_vmstate, USBDevice),
1409f1ae32a1SGerd Hoffmann VMSTATE_UINT8(debug, USBCCIDState),
1410f1ae32a1SGerd Hoffmann VMSTATE_BUFFER(bulk_out_data, USBCCIDState),
1411f1ae32a1SGerd Hoffmann VMSTATE_UINT32(bulk_out_pos, USBCCIDState),
1412f1ae32a1SGerd Hoffmann VMSTATE_UINT8(bmSlotICCState, USBCCIDState),
1413f1ae32a1SGerd Hoffmann VMSTATE_UINT8(powered, USBCCIDState),
1414f1ae32a1SGerd Hoffmann VMSTATE_UINT8(notify_slot_change, USBCCIDState),
1415f1ae32a1SGerd Hoffmann VMSTATE_UINT64(last_answer_error, USBCCIDState),
1416f1ae32a1SGerd Hoffmann VMSTATE_UINT8(bError, USBCCIDState),
1417f1ae32a1SGerd Hoffmann VMSTATE_UINT8(bmCommandStatus, USBCCIDState),
1418f1ae32a1SGerd Hoffmann VMSTATE_UINT8(bProtocolNum, USBCCIDState),
14194942d6c3SAlon Levy VMSTATE_BUFFER(abProtocolDataStructure.data, USBCCIDState),
1420f1ae32a1SGerd Hoffmann VMSTATE_UINT32(ulProtocolDataStructureSize, USBCCIDState),
1421f1ae32a1SGerd Hoffmann VMSTATE_STRUCT_ARRAY(bulk_in_pending, USBCCIDState,
1422f1ae32a1SGerd Hoffmann BULK_IN_PENDING_NUM, 1, bulk_in_vmstate, BulkIn),
1423f1ae32a1SGerd Hoffmann VMSTATE_UINT32(bulk_in_pending_start, USBCCIDState),
1424f1ae32a1SGerd Hoffmann VMSTATE_UINT32(bulk_in_pending_end, USBCCIDState),
1425f1ae32a1SGerd Hoffmann VMSTATE_STRUCT_ARRAY(pending_answers, USBCCIDState,
1426f1ae32a1SGerd Hoffmann PENDING_ANSWERS_NUM, 1, answer_vmstate, Answer),
1427f1ae32a1SGerd Hoffmann VMSTATE_UINT32(pending_answers_num, USBCCIDState),
142831bd59dbSMarc-André Lureau VMSTATE_UNUSED(1), /* was migration_state */
1429f1ae32a1SGerd Hoffmann VMSTATE_UINT32(state_vmstate, USBCCIDState),
1430f1ae32a1SGerd Hoffmann VMSTATE_END_OF_LIST()
1431f1ae32a1SGerd Hoffmann }
1432f1ae32a1SGerd Hoffmann };
1433f1ae32a1SGerd Hoffmann
1434f1ae32a1SGerd Hoffmann static Property ccid_properties[] = {
1435f1ae32a1SGerd Hoffmann DEFINE_PROP_UINT8("debug", USBCCIDState, debug, 0),
1436f1ae32a1SGerd Hoffmann DEFINE_PROP_END_OF_LIST(),
1437f1ae32a1SGerd Hoffmann };
1438f1ae32a1SGerd Hoffmann
ccid_class_initfn(ObjectClass * klass,void * data)1439f1ae32a1SGerd Hoffmann static void ccid_class_initfn(ObjectClass *klass, void *data)
1440f1ae32a1SGerd Hoffmann {
1441f1ae32a1SGerd Hoffmann DeviceClass *dc = DEVICE_CLASS(klass);
1442f1ae32a1SGerd Hoffmann USBDeviceClass *uc = USB_DEVICE_CLASS(klass);
1443138d587aSIgor Mammedov HotplugHandlerClass *hc = HOTPLUG_HANDLER_CLASS(klass);
1444f1ae32a1SGerd Hoffmann
14450b8b863fSGonglei uc->realize = ccid_realize;
1446f1ae32a1SGerd Hoffmann uc->product_desc = "QEMU USB CCID";
1447f1ae32a1SGerd Hoffmann uc->usb_desc = &desc_ccid;
1448f1ae32a1SGerd Hoffmann uc->handle_reset = ccid_handle_reset;
1449f1ae32a1SGerd Hoffmann uc->handle_control = ccid_handle_control;
1450f1ae32a1SGerd Hoffmann uc->handle_data = ccid_handle_data;
1451c4fe9700SMarc-André Lureau uc->unrealize = ccid_unrealize;
1452f1ae32a1SGerd Hoffmann dc->desc = "CCID Rev 1.1 smartcard reader";
1453f1ae32a1SGerd Hoffmann dc->vmsd = &ccid_vmstate;
14544f67d30bSMarc-André Lureau device_class_set_props(dc, ccid_properties);
1455125ee0edSMarcel Apfelbaum set_bit(DEVICE_CATEGORY_INPUT, dc->categories);
1456138d587aSIgor Mammedov hc->unplug = qdev_simple_device_unplug_cb;
1457f1ae32a1SGerd Hoffmann }
1458f1ae32a1SGerd Hoffmann
14598c43a6f0SAndreas Färber static const TypeInfo ccid_info = {
14607f46ed2bSEduardo Habkost .name = TYPE_USB_CCID_DEV,
1461f1ae32a1SGerd Hoffmann .parent = TYPE_USB_DEVICE,
1462f1ae32a1SGerd Hoffmann .instance_size = sizeof(USBCCIDState),
1463f1ae32a1SGerd Hoffmann .class_init = ccid_class_initfn,
1464138d587aSIgor Mammedov .interfaces = (InterfaceInfo[]) {
1465138d587aSIgor Mammedov { TYPE_HOTPLUG_HANDLER },
1466138d587aSIgor Mammedov { }
1467138d587aSIgor Mammedov }
1468f1ae32a1SGerd Hoffmann };
1469f1ae32a1SGerd Hoffmann
ccid_card_class_init(ObjectClass * klass,void * data)1470f1ae32a1SGerd Hoffmann static void ccid_card_class_init(ObjectClass *klass, void *data)
1471f1ae32a1SGerd Hoffmann {
1472f1ae32a1SGerd Hoffmann DeviceClass *k = DEVICE_CLASS(klass);
14730d936928SAnthony Liguori k->bus_type = TYPE_CCID_BUS;
1474cc847bfdSMao Zhongyi k->realize = ccid_card_realize;
147580ae8654SPhilippe Mathieu-Daudé k->unrealize = ccid_card_unrealize;
14764f67d30bSMarc-André Lureau device_class_set_props(k, ccid_props);
1477f1ae32a1SGerd Hoffmann }
1478f1ae32a1SGerd Hoffmann
14798c43a6f0SAndreas Färber static const TypeInfo ccid_card_type_info = {
1480f1ae32a1SGerd Hoffmann .name = TYPE_CCID_CARD,
1481f1ae32a1SGerd Hoffmann .parent = TYPE_DEVICE,
1482f1ae32a1SGerd Hoffmann .instance_size = sizeof(CCIDCardState),
1483f1ae32a1SGerd Hoffmann .abstract = true,
1484f1ae32a1SGerd Hoffmann .class_size = sizeof(CCIDCardClass),
1485f1ae32a1SGerd Hoffmann .class_init = ccid_card_class_init,
1486f1ae32a1SGerd Hoffmann };
1487f1ae32a1SGerd Hoffmann
ccid_register_types(void)1488f1ae32a1SGerd Hoffmann static void ccid_register_types(void)
1489f1ae32a1SGerd Hoffmann {
14900d936928SAnthony Liguori type_register_static(&ccid_bus_info);
1491f1ae32a1SGerd Hoffmann type_register_static(&ccid_card_type_info);
1492f1ae32a1SGerd Hoffmann type_register_static(&ccid_info);
1493f1ae32a1SGerd Hoffmann }
1494f1ae32a1SGerd Hoffmann
1495f1ae32a1SGerd Hoffmann type_init(ccid_register_types)
1496