dev-smartcard-reader.c 42 KB

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