UsbKbd.cpp@ 64468

Last change on this file since 64468 was 64368, checked in by vboxsync, 8 years ago
Devices/Input: Doxygen
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 45.4 KB

Line
1	/* $Id: UsbKbd.cpp 64368 2016-10-22 17:36:37Z vboxsync $ */
2	/** @file
3	* UsbKbd - USB Human Interface Device Emulation, Keyboard.
4	*/
5
6	/*
7	* Copyright (C) 2007-2016 Oracle Corporation
8	*
9	* This file is part of VirtualBox Open Source Edition (OSE), as
10	* available from http://www.virtualbox.org. This file is free software;
11	* you can redistribute it and/or modify it under the terms of the GNU
12	* General Public License (GPL) as published by the Free Software
13	* Foundation, in version 2 as it comes in the "COPYING" file of the
14	* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15	* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16	*/
17
18	/** @page pg_usb_kbd USB Keyboard Device Emulation.
19	*
20	* This module implements a standard USB keyboard which uses the boot
21	* interface. The keyboard sends reports which have room for up to six
22	* normal keys and all standard modifier keys. A report always reflects the
23	* current state of the keyboard and indicates which keys are held down.
24	*
25	* Software normally utilizes the keyboard's interrupt endpoint to request
26	* reports to be sent whenever a state change occurs. However, reports can
27	* also be sent whenever an interrupt transfer is initiated (the keyboard is
28	* not "idle") or requested via the control endpoint (polling).
29	*
30	* Because turnaround on USB is relatively slow, the keyboard often ends up
31	* in a situation where new input arrived but there is no URB available
32	* where a report could be written to. The PDM queue maintained by the
33	* keyboard driver is utilized to provide buffering and hold incoming events
34	* until they can be passed along. The USB keyboard can effectively buffer
35	* up to one event.
36	*
37	* If there is a pending event and a new URB becomes available, a report is
38	* built and the keyboard queue is flushed. This ensures that queued events
39	* are processed as quickly as possible.
40	*
41	*
42	* References:
43	*
44	* Device Class Definition for Human Interface Devices (HID), Version 1.11
45	*
46	*/
47
48
49	/*********************************************************************************************************************************
50	* Header Files *
51	*********************************************************************************************************************************/
52	#define LOG_GROUP LOG_GROUP_USB_KBD
53	#include <VBox/vmm/pdmusb.h>
54	#include <VBox/log.h>
55	#include <VBox/err.h>
56	#include <iprt/assert.h>
57	#include <iprt/critsect.h>
58	#include <iprt/mem.h>
59	#include <iprt/semaphore.h>
60	#include <iprt/string.h>
61	#include <iprt/uuid.h>
62	#include "VBoxDD.h"
63
64
65	/*********************************************************************************************************************************
66	* Defined Constants And Macros *
67	*********************************************************************************************************************************/
68	/** @name USB HID string IDs
69	* @{ */
70	#define USBHID_STR_ID_MANUFACTURER 1
71	#define USBHID_STR_ID_PRODUCT 2
72	/** @} */
73
74	/** @name USB HID specific descriptor types
75	* @{ */
76	#define DT_IF_HID_DESCRIPTOR 0x21
77	#define DT_IF_HID_REPORT 0x22
78	/** @} */
79
80	/** @name USB HID vendor and product IDs
81	* @{ */
82	#define VBOX_USB_VENDOR 0x80EE
83	#define USBHID_PID_KEYBOARD 0x0010
84	/** @} */
85
86	/** @name USB HID class specific requests
87	* @{ */
88	#define HID_REQ_GET_REPORT 0x01
89	#define HID_REQ_GET_IDLE 0x02
90	#define HID_REQ_SET_REPORT 0x09
91	#define HID_REQ_SET_IDLE 0x0A
92	/** @} */
93
94	/** @name USB HID additional constants
95	* @{ */
96	/** The highest USB usage code reported by the VBox emulated keyboard */
97	#define VBOX_USB_MAX_USAGE_CODE 0xE7
98	/** The size of an array needed to store all USB usage codes */
99	#define VBOX_USB_USAGE_ARRAY_SIZE (VBOX_USB_MAX_USAGE_CODE + 1)
100	#define USBHID_USAGE_ROLL_OVER 1
101	/** The usage code of the first modifier key. */
102	#define USBHID_MODIFIER_FIRST 0xE0
103	/** The usage code of the last modifier key. */
104	#define USBHID_MODIFIER_LAST 0xE7
105	/** @} */
106
107
108	/*********************************************************************************************************************************
109	* Structures and Typedefs *
110	*********************************************************************************************************************************/
111
112	/**
113	* The USB HID request state.
114	*/
115	typedef enum USBHIDREQSTATE
116	{
117	/** Invalid status. */
118	USBHIDREQSTATE_INVALID = 0,
119	/** Ready to receive a new read request. */
120	USBHIDREQSTATE_READY,
121	/** Have (more) data for the host. */
122	USBHIDREQSTATE_DATA_TO_HOST,
123	/** Waiting to supply status information to the host. */
124	USBHIDREQSTATE_STATUS,
125	/** The end of the valid states. */
126	USBHIDREQSTATE_END
127	} USBHIDREQSTATE;
128
129
130	/**
131	* Endpoint status data.
132	*/
133	typedef struct USBHIDEP
134	{
135	bool fHalted;
136	} USBHIDEP;
137	/** Pointer to the endpoint status. */
138	typedef USBHIDEP *PUSBHIDEP;
139
140
141	/**
142	* A URB queue.
143	*/
144	typedef struct USBHIDURBQUEUE
145	{
146	/** The head pointer. */
147	PVUSBURB pHead;
148	/** Where to insert the next entry. */
149	PVUSBURB *ppTail;
150	} USBHIDURBQUEUE;
151	/** Pointer to a URB queue. */
152	typedef USBHIDURBQUEUE *PUSBHIDURBQUEUE;
153	/** Pointer to a const URB queue. */
154	typedef USBHIDURBQUEUE const *PCUSBHIDURBQUEUE;
155
156
157	/**
158	* The USB HID report structure for regular keys.
159	*/
160	typedef struct USBHIDK_REPORT
161	{
162	uint8_t ShiftState; /*< Modifier keys bitfield /
163	uint8_t Reserved; /*< Currently unused /
164	uint8_t aKeys[6]; /*< Normal keys /
165	} USBHIDK_REPORT, *PUSBHIDK_REPORT;
166
167	/**
168	* The USB HID instance data.
169	*/
170	typedef struct USBHID
171	{
172	/** Pointer back to the PDM USB Device instance structure. */
173	PPDMUSBINS pUsbIns;
174	/** Critical section protecting the device state. */
175	RTCRITSECT CritSect;
176
177	/** The current configuration.
178	* (0 - default, 1 - the one supported configuration, i.e configured.) */
179	uint8_t bConfigurationValue;
180	/** USB HID Idle value.
181	* (0 - only report state change, !=0 - report in bIdle * 4ms intervals.) */
182	uint8_t bIdle;
183	/** Endpoint 0 is the default control pipe, 1 is the dev->host interrupt one. */
184	USBHIDEP aEps[2];
185	/** The state of the HID (state machine).*/
186	USBHIDREQSTATE enmState;
187
188	/** Pending to-host queue.
189	* The URBs waiting here are waiting for data to become available.
190	*/
191	USBHIDURBQUEUE ToHostQueue;
192
193	/** Done queue
194	* The URBs stashed here are waiting to be reaped. */
195	USBHIDURBQUEUE DoneQueue;
196	/** Signalled when adding an URB to the done queue and fHaveDoneQueueWaiter
197	* is set. */
198	RTSEMEVENT hEvtDoneQueue;
199	/** Someone is waiting on the done queue. */
200	bool fHaveDoneQueueWaiter;
201	/** If device has pending changes. */
202	bool fHasPendingChanges;
203	/** Currently depressed keys */
204	uint8_t abDepressedKeys[VBOX_USB_USAGE_ARRAY_SIZE];
205
206	/**
207	* Keyboard port - LUN#0.
208	*
209	* @implements PDMIBASE
210	* @implements PDMIKEYBOARDPORT
211	*/
212	struct
213	{
214	/** The base interface for the keyboard port. */
215	PDMIBASE IBase;
216	/** The keyboard port base interface. */
217	PDMIKEYBOARDPORT IPort;
218
219	/** The base interface of the attached keyboard driver. */
220	R3PTRTYPE(PPDMIBASE) pDrvBase;
221	/** The keyboard interface of the attached keyboard driver. */
222	R3PTRTYPE(PPDMIKEYBOARDCONNECTOR) pDrv;
223	} Lun0;
224	} USBHID;
225	/** Pointer to the USB HID instance data. */
226	typedef USBHID *PUSBHID;
227
228
229	/*********************************************************************************************************************************
230	* Global Variables *
231	*********************************************************************************************************************************/
232	static const PDMUSBDESCCACHESTRING g_aUsbHidStrings_en_US[] =
233	{
234	{ USBHID_STR_ID_MANUFACTURER, "VirtualBox" },
235	{ USBHID_STR_ID_PRODUCT, "USB Keyboard" },
236	};
237
238	static const PDMUSBDESCCACHELANG g_aUsbHidLanguages[] =
239	{
240	{ 0x0409, RT_ELEMENTS(g_aUsbHidStrings_en_US), g_aUsbHidStrings_en_US }
241	};
242
243	static const VUSBDESCENDPOINTEX g_aUsbHidEndpointDescs[] =
244	{
245	{
246	{
247	/* .bLength = */ sizeof(VUSBDESCENDPOINT),
248	/* .bDescriptorType = */ VUSB_DT_ENDPOINT,
249	/* .bEndpointAddress = / 0x81 / ep=1, in */,
250	/* .bmAttributes = / 3 / interrupt */,
251	/* .wMaxPacketSize = */ 8,
252	/* .bInterval = */ 10,
253	},
254	/* .pvMore = */ NULL,
255	/* .pvClass = */ NULL,
256	/* .cbClass = */ 0
257	},
258	};
259
260	/** HID report descriptor. */
261	static const uint8_t g_UsbHidReportDesc[] =
262	{
263	/* Usage Page / 0x05, 0x01, / Generic Desktop */
264	/* Usage / 0x09, 0x06, / Keyboard */
265	/* Collection / 0xA1, 0x01, / Application */
266	/* Usage Page / 0x05, 0x07, / Keyboard */
267	/* Usage Minimum / 0x19, 0xE0, / Left Ctrl Key */
268	/* Usage Maximum / 0x29, 0xE7, / Right GUI Key */
269	/* Logical Minimum / 0x15, 0x00, / 0 */
270	/* Logical Maximum / 0x25, 0x01, / 1 */
271	/* Report Count / 0x95, 0x08, / 8 */
272	/* Report Size / 0x75, 0x01, / 1 */
273	/* Input / 0x81, 0x02, / Data, Value, Absolute, Bit field */
274	/* Report Count / 0x95, 0x01, / 1 */
275	/* Report Size / 0x75, 0x08, / 8 (padding bits) */
276	/* Input / 0x81, 0x01, / Constant, Array, Absolute, Bit field */
277	/* Report Count / 0x95, 0x05, / 5 */
278	/* Report Size / 0x75, 0x01, / 1 */
279	/* Usage Page / 0x05, 0x08, / LEDs */
280	/* Usage Minimum / 0x19, 0x01, / Num Lock */
281	/* Usage Maximum / 0x29, 0x05, / Kana */
282	/* Output / 0x91, 0x02, / Data, Value, Absolute, Non-volatile,Bit field */
283	/* Report Count / 0x95, 0x01, / 1 */
284	/* Report Size / 0x75, 0x03, / 3 */
285	/* Output / 0x91, 0x01, / Constant, Value, Absolute, Non-volatile, Bit field */
286	/* Report Count / 0x95, 0x06, / 6 */
287	/* Report Size / 0x75, 0x08, / 8 */
288	/* Logical Minimum / 0x15, 0x00, / 0 */
289	/* Logical Maximum / 0x26, 0xFF,0x00,/ 255 */
290	/* Usage Page / 0x05, 0x07, / Keyboard */
291	/* Usage Minimum / 0x19, 0x00, / 0 */
292	/* Usage Maximum / 0x29, 0xFF, / 255 */
293	/* Input / 0x81, 0x00, / Data, Array, Absolute, Bit field */
294	/* End Collection */ 0xC0,
295	};
296
297	/** Additional HID class interface descriptor. */
298	static const uint8_t g_UsbHidIfHidDesc[] =
299	{
300	/* .bLength = */ 0x09,
301	/* .bDescriptorType = / 0x21, / HID */
302	/* .bcdHID = / 0x10, 0x01, / 1.1 */
303	/* .bCountryCode = / 0x0D, / International (ISO) */
304	/* .bNumDescriptors = */ 1,
305	/* .bDescriptorType = / 0x22, / Report */
306	/* .wDescriptorLength = */ sizeof(g_UsbHidReportDesc), 0x00
307	};
308
309	static const VUSBDESCINTERFACEEX g_UsbHidInterfaceDesc =
310	{
311	{
312	/* .bLength = */ sizeof(VUSBDESCINTERFACE),
313	/* .bDescriptorType = */ VUSB_DT_INTERFACE,
314	/* .bInterfaceNumber = */ 0,
315	/* .bAlternateSetting = */ 0,
316	/* .bNumEndpoints = */ 1,
317	/* .bInterfaceClass = / 3 / HID */,
318	/* .bInterfaceSubClass = / 1 / Boot Interface */,
319	/* .bInterfaceProtocol = / 1 / Keyboard */,
320	/* .iInterface = */ 0
321	},
322	/* .pvMore = */ NULL,
323	/* .pvClass = */ &g_UsbHidIfHidDesc,
324	/* .cbClass = */ sizeof(g_UsbHidIfHidDesc),
325	&g_aUsbHidEndpointDescs[0],
326	/* .pIAD = */ NULL,
327	/* .cbIAD = */ 0
328	};
329
330	static const VUSBINTERFACE g_aUsbHidInterfaces[] =
331	{
332	{ &g_UsbHidInterfaceDesc, /* .cSettings = */ 1 },
333	};
334
335	static const VUSBDESCCONFIGEX g_UsbHidConfigDesc =
336	{
337	{
338	/* .bLength = */ sizeof(VUSBDESCCONFIG),
339	/* .bDescriptorType = */ VUSB_DT_CONFIG,
340	/* .wTotalLength = / 0 / recalculated on read */,
341	/* .bNumInterfaces = */ RT_ELEMENTS(g_aUsbHidInterfaces),
342	/* .bConfigurationValue =*/ 1,
343	/* .iConfiguration = */ 0,
344	/* .bmAttributes = */ RT_BIT(7),
345	/* .MaxPower = / 50 / 100mA */
346	},
347	NULL, /* pvMore */
348	&g_aUsbHidInterfaces[0],
349	NULL /* pvOriginal */
350	};
351
352	static const VUSBDESCDEVICE g_UsbHidDeviceDesc =
353	{
354	/* .bLength = */ sizeof(g_UsbHidDeviceDesc),
355	/* .bDescriptorType = */ VUSB_DT_DEVICE,
356	/* .bcdUsb = / 0x110, / 1.1 */
357	/* .bDeviceClass = / 0 / Class specified in the interface desc. */,
358	/* .bDeviceSubClass = / 0 / Subclass specified in the interface desc. */,
359	/* .bDeviceProtocol = / 0 / Protocol specified in the interface desc. */,
360	/* .bMaxPacketSize0 = */ 8,
361	/* .idVendor = */ VBOX_USB_VENDOR,
362	/* .idProduct = */ USBHID_PID_KEYBOARD,
363	/* .bcdDevice = / 0x0100, / 1.0 */
364	/* .iManufacturer = */ USBHID_STR_ID_MANUFACTURER,
365	/* .iProduct = */ USBHID_STR_ID_PRODUCT,
366	/* .iSerialNumber = */ 0,
367	/* .bNumConfigurations = */ 1
368	};
369
370	static const PDMUSBDESCCACHE g_UsbHidDescCache =
371	{
372	/* .pDevice = */ &g_UsbHidDeviceDesc,
373	/* .paConfigs = */ &g_UsbHidConfigDesc,
374	/* .paLanguages = */ g_aUsbHidLanguages,
375	/* .cLanguages = */ RT_ELEMENTS(g_aUsbHidLanguages),
376	/* .fUseCachedDescriptors = */ true,
377	/* .fUseCachedStringsDescriptors = */ true
378	};
379
380
381	/*********************************************************************************************************************************
382	* Internal Functions *
383	*********************************************************************************************************************************/
384
385
386	/**
387	* Initializes an URB queue.
388	*
389	* @param pQueue The URB queue.
390	*/
391	static void usbHidQueueInit(PUSBHIDURBQUEUE pQueue)
392	{
393	pQueue->pHead = NULL;
394	pQueue->ppTail = &pQueue->pHead;
395	}
396
397	/**
398	* Inserts an URB at the end of the queue.
399	*
400	* @param pQueue The URB queue.
401	* @param pUrb The URB to insert.
402	*/
403	DECLINLINE(void) usbHidQueueAddTail(PUSBHIDURBQUEUE pQueue, PVUSBURB pUrb)
404	{
405	pUrb->Dev.pNext = NULL;
406	*pQueue->ppTail = pUrb;
407	pQueue->ppTail = &pUrb->Dev.pNext;
408	}
409
410
411	/**
412	* Unlinks the head of the queue and returns it.
413	*
414	* @returns The head entry.
415	* @param pQueue The URB queue.
416	*/
417	DECLINLINE(PVUSBURB) usbHidQueueRemoveHead(PUSBHIDURBQUEUE pQueue)
418	{
419	PVUSBURB pUrb = pQueue->pHead;
420	if (pUrb)
421	{
422	PVUSBURB pNext = pUrb->Dev.pNext;
423	pQueue->pHead = pNext;
424	if (!pNext)
425	pQueue->ppTail = &pQueue->pHead;
426	else
427	pUrb->Dev.pNext = NULL;
428	}
429	return pUrb;
430	}
431
432
433	/**
434	* Removes an URB from anywhere in the queue.
435	*
436	* @returns true if found, false if not.
437	* @param pQueue The URB queue.
438	* @param pUrb The URB to remove.
439	*/
440	DECLINLINE(bool) usbHidQueueRemove(PUSBHIDURBQUEUE pQueue, PVUSBURB pUrb)
441	{
442	PVUSBURB pCur = pQueue->pHead;
443	if (pCur == pUrb)
444	pQueue->pHead = pUrb->Dev.pNext;
445	else
446	{
447	while (pCur)
448	{
449	if (pCur->Dev.pNext == pUrb)
450	{
451	pCur->Dev.pNext = pUrb->Dev.pNext;
452	break;
453	}
454	pCur = pCur->Dev.pNext;
455	}
456	if (!pCur)
457	return false;
458	}
459	if (!pUrb->Dev.pNext)
460	pQueue->ppTail = &pQueue->pHead;
461	return true;
462	}
463
464
465	#if 0 /* unused */
466	/**
467	* Checks if the queue is empty or not.
468	*
469	* @returns true if it is, false if it isn't.
470	* @param pQueue The URB queue.
471	*/
472	DECLINLINE(bool) usbHidQueueIsEmpty(PCUSBHIDURBQUEUE pQueue)
473	{
474	return pQueue->pHead == NULL;
475	}
476	#endif /* unused */
477
478
479	/**
480	* Links an URB into the done queue.
481	*
482	* @param pThis The HID instance.
483	* @param pUrb The URB.
484	*/
485	static void usbHidLinkDone(PUSBHID pThis, PVUSBURB pUrb)
486	{
487	usbHidQueueAddTail(&pThis->DoneQueue, pUrb);
488
489	if (pThis->fHaveDoneQueueWaiter)
490	{
491	int rc = RTSemEventSignal(pThis->hEvtDoneQueue);
492	AssertRC(rc);
493	}
494	}
495
496
497	/**
498	* Completes the URB with a stalled state, halting the pipe.
499	*/
500	static int usbHidCompleteStall(PUSBHID pThis, PUSBHIDEP pEp, PVUSBURB pUrb, const char *pszWhy)
501	{
502	RT_NOREF1(pszWhy);
503	Log(("usbHidCompleteStall/#%u: pUrb=%p:%s: %s\n", pThis->pUsbIns->iInstance, pUrb, pUrb->pszDesc, pszWhy));
504
505	pUrb->enmStatus = VUSBSTATUS_STALL;
506
507	/** @todo figure out if the stall is global or pipe-specific or both. */
508	if (pEp)
509	pEp->fHalted = true;
510	else
511	{
512	pThis->aEps[0].fHalted = true;
513	pThis->aEps[1].fHalted = true;
514	}
515
516	usbHidLinkDone(pThis, pUrb);
517	return VINF_SUCCESS;
518	}
519
520
521	/**
522	* Completes the URB with a OK state.
523	*/
524	static int usbHidCompleteOk(PUSBHID pThis, PVUSBURB pUrb, size_t cbData)
525	{
526	Log(("usbHidCompleteOk/#%u: pUrb=%p:%s cbData=%#zx\n", pThis->pUsbIns->iInstance, pUrb, pUrb->pszDesc, cbData));
527
528	pUrb->enmStatus = VUSBSTATUS_OK;
529	pUrb->cbData = (uint32_t)cbData;
530
531	usbHidLinkDone(pThis, pUrb);
532	return VINF_SUCCESS;
533	}
534
535
536	/**
537	* Reset worker for usbHidUsbReset, usbHidUsbSetConfiguration and
538	* usbHidHandleDefaultPipe.
539	*
540	* @returns VBox status code.
541	* @param pThis The HID instance.
542	* @param pUrb Set when usbHidHandleDefaultPipe is the
543	* caller.
544	* @param fSetConfig Set when usbHidUsbSetConfiguration is the
545	* caller.
546	*/
547	static int usbHidResetWorker(PUSBHID pThis, PVUSBURB pUrb, bool fSetConfig)
548	{
549	/*
550	* Deactivate the keyboard.
551	*/
552	pThis->Lun0.pDrv->pfnSetActive(pThis->Lun0.pDrv, false);
553
554	/*
555	* Reset the device state.
556	*/
557	pThis->enmState = USBHIDREQSTATE_READY;
558	pThis->bIdle = 0;
559	pThis->fHasPendingChanges = false;
560
561	for (unsigned i = 0; i < RT_ELEMENTS(pThis->aEps); i++)
562	pThis->aEps[i].fHalted = false;
563
564	if (!pUrb && !fSetConfig) /* (only device reset) */
565	pThis->bConfigurationValue = 0; /* default */
566
567	/*
568	* Ditch all pending URBs.
569	*/
570	PVUSBURB pCurUrb;
571	while ((pCurUrb = usbHidQueueRemoveHead(&pThis->ToHostQueue)) != NULL)
572	{
573	pCurUrb->enmStatus = VUSBSTATUS_CRC;
574	usbHidLinkDone(pThis, pCurUrb);
575	}
576
577	if (pUrb)
578	return usbHidCompleteOk(pThis, pUrb, 0);
579	return VINF_SUCCESS;
580	}
581
582	/**
583	* Returns true if the usage code corresponds to a keyboard modifier key
584	* (left or right ctrl, shift, alt or GUI). The usage codes for these keys
585	* are the range 0xe0 to 0xe7.
586	*/
587	static bool usbHidUsageCodeIsModifier(uint8_t u8Usage)
588	{
589	return u8Usage >= USBHID_MODIFIER_FIRST && u8Usage <= USBHID_MODIFIER_LAST;
590	}
591
592	/**
593	* Convert a USB HID usage code to a keyboard modifier flag. The arithmetic
594	* is simple: the modifier keys have usage codes from 0xe0 to 0xe7, and the
595	* lower nibble is the bit number of the flag.
596	*/
597	static uint8_t usbHidModifierToFlag(uint8_t u8Usage)
598	{
599	Assert(usbHidUsageCodeIsModifier(u8Usage));
600	return RT_BIT(u8Usage & 0xf);
601	}
602
603	/**
604	* Create a USB HID keyboard report reflecting the current state of the
605	* keyboard (up/down keys).
606	*/
607	static void usbHidBuildReport(PUSBHIDK_REPORT pReport, uint8_t *pabDepressedKeys)
608	{
609	unsigned iBuf = 0;
610	RT_ZERO(*pReport);
611	for (unsigned iKey = 0; iKey < VBOX_USB_USAGE_ARRAY_SIZE; ++iKey)
612	{
613	Assert(iBuf <= RT_ELEMENTS(pReport->aKeys));
614	if (pabDepressedKeys[iKey])
615	{
616	if (usbHidUsageCodeIsModifier(iKey))
617	pReport->ShiftState \|= usbHidModifierToFlag(iKey);
618	else if (iBuf == RT_ELEMENTS(pReport->aKeys))
619	{
620	/* The USB HID spec says that the entire vector should be
621	* set to ErrorRollOver on overflow. We don't mind if this
622	* path is taken several times for one report. */
623	for (unsigned iBuf2 = 0;
624	iBuf2 < RT_ELEMENTS(pReport->aKeys); ++iBuf2)
625	pReport->aKeys[iBuf2] = USBHID_USAGE_ROLL_OVER;
626	}
627	else
628	{
629	pReport->aKeys[iBuf] = iKey;
630	++iBuf;
631	}
632	}
633	}
634	}
635
636	/**
637	* Handles a SET_REPORT request sent to the default control pipe. Note
638	* that unrecognized requests are ignored without reporting an error.
639	*/
640	static void usbHidSetReport(PUSBHID pThis, PVUSBURB pUrb)
641	{
642	PVUSBSETUP pSetup = (PVUSBSETUP)&pUrb->abData[0];
643	Assert(pSetup->bRequest == HID_REQ_SET_REPORT);
644
645	/* The LED report is the 3rd report, ID 0 (-> wValue 0x200). */
646	if (pSetup->wIndex == 0 && pSetup->wLength == 1 && pSetup->wValue == 0x200)
647	{
648	PDMKEYBLEDS enmLeds = PDMKEYBLEDS_NONE;
649	uint8_t u8LEDs = pUrb->abData[sizeof(*pSetup)];
650	LogFlowFunc(("Setting keybooard LEDs to u8LEDs=%02X\n", u8LEDs));
651
652	/* Translate LED state to PDM format and send upstream. */
653	if (u8LEDs & 0x01)
654	enmLeds = (PDMKEYBLEDS)(enmLeds \| PDMKEYBLEDS_NUMLOCK);
655	if (u8LEDs & 0x02)
656	enmLeds = (PDMKEYBLEDS)(enmLeds \| PDMKEYBLEDS_CAPSLOCK);
657	if (u8LEDs & 0x04)
658	enmLeds = (PDMKEYBLEDS)(enmLeds \| PDMKEYBLEDS_SCROLLLOCK);
659
660	pThis->Lun0.pDrv->pfnLedStatusChange(pThis->Lun0.pDrv, enmLeds);
661	}
662	}
663
664	/**
665	* Sends a state report to the guest if there is a URB available.
666	*/
667	static void usbHidSendReport(PUSBHID pThis)
668	{
669	PVUSBURB pUrb = usbHidQueueRemoveHead(&pThis->ToHostQueue);
670	if (pUrb)
671	{
672	PUSBHIDK_REPORT pReport = (PUSBHIDK_REPORT)&pUrb->abData[0];
673
674	usbHidBuildReport(pReport, pThis->abDepressedKeys);
675	pThis->fHasPendingChanges = false;
676	usbHidCompleteOk(pThis, pUrb, sizeof(*pReport));
677	}
678	else
679	{
680	Log2(("No available URB for USB kbd\n"));
681	pThis->fHasPendingChanges = true;
682	}
683	}
684
685	/**
686	* @interface_method_impl{PDMIBASE,pfnQueryInterface}
687	*/
688	static DECLCALLBACK(void ) usbHidKeyboardQueryInterface(PPDMIBASE pInterface, const char pszIID)
689	{
690	PUSBHID pThis = RT_FROM_MEMBER(pInterface, USBHID, Lun0.IBase);
691	PDMIBASE_RETURN_INTERFACE(pszIID, PDMIBASE, &pThis->Lun0.IBase);
692	PDMIBASE_RETURN_INTERFACE(pszIID, PDMIKEYBOARDPORT, &pThis->Lun0.IPort);
693	return NULL;
694	}
695
696	/* See the PS2K device. */
697	#define KRSP_BAT_FAIL 0xFC /* Also a 'release keys' signal. */
698
699	/**
700	* Keyboard event handler.
701	*
702	* @returns VBox status code.
703	* @param pInterface Pointer to the keyboard port interface (KBDState::Keyboard.IPort).
704	* @param u32UsageCode The key usage ID.
705	*/
706	static DECLCALLBACK(int) usbHidKeyboardPutEvent(PPDMIKEYBOARDPORT pInterface, uint32_t u32UsageCode)
707	{
708	PUSBHID pThis = RT_FROM_MEMBER(pInterface, USBHID, Lun0.IPort);
709	uint8_t u8HidCode;
710	bool fKeyDown;
711	bool fHaveEvent = true;
712	int rc = VINF_SUCCESS;
713
714	RTCritSectEnter(&pThis->CritSect);
715
716	/* Let's see what we got... */
717	fKeyDown = !(u32UsageCode & 0x80000000);
718	u8HidCode = u32UsageCode & 0xFF;
719	AssertReturn(u8HidCode <= VBOX_USB_MAX_USAGE_CODE, VERR_INTERNAL_ERROR);
720
721	LogFlowFunc(("key %s: 0x%x\n", fKeyDown ? "down" : "up", u8HidCode));
722
723	/*
724	* Due to host key repeat, we can get key events for keys which are
725	* already depressed. Drop those right here.
726	*/
727	if (fKeyDown && pThis->abDepressedKeys[u8HidCode])
728	fHaveEvent = false;
729
730	/* If there is already a pending event, we won't accept a new one yet. */
731	if (pThis->fHasPendingChanges && fHaveEvent)
732	{
733	rc = VERR_TRY_AGAIN;
734	}
735	else if (fHaveEvent)
736	{
737	if (RT_UNLIKELY(u32UsageCode == KRSP_BAT_FAIL))
738	{
739	/* Clear all currently depressed and unreported keys. */
740	RT_ZERO(pThis->abDepressedKeys);
741	}
742	else
743	{
744	/* Regular key event - update keyboard state. */
745	if (fKeyDown)
746	pThis->abDepressedKeys[u8HidCode] = 1;
747	else
748	pThis->abDepressedKeys[u8HidCode] = 0;
749	}
750
751	/*
752	* Try sending a report. Note that we already decided to consume the
753	* event regardless of whether a URB is available or not. If it's not,
754	* we will simply not accept any further events.
755	*/
756	usbHidSendReport(pThis);
757	}
758
759	RTCritSectLeave(&pThis->CritSect);
760
761	return rc;
762	}
763
764	/**
765	* @interface_method_impl{PDMUSBREG,pfnUrbReap}
766	*/
767	static DECLCALLBACK(PVUSBURB) usbHidUrbReap(PPDMUSBINS pUsbIns, RTMSINTERVAL cMillies)
768	{
769	PUSBHID pThis = PDMINS_2_DATA(pUsbIns, PUSBHID);
770	//LogFlow(("usbHidUrbReap/#%u: cMillies=%u\n", pUsbIns->iInstance, cMillies));
771
772	RTCritSectEnter(&pThis->CritSect);
773
774	PVUSBURB pUrb = usbHidQueueRemoveHead(&pThis->DoneQueue);
775	if (!pUrb && cMillies)
776	{
777	/* Wait */
778	pThis->fHaveDoneQueueWaiter = true;
779	RTCritSectLeave(&pThis->CritSect);
780
781	RTSemEventWait(pThis->hEvtDoneQueue, cMillies);
782
783	RTCritSectEnter(&pThis->CritSect);
784	pThis->fHaveDoneQueueWaiter = false;
785
786	pUrb = usbHidQueueRemoveHead(&pThis->DoneQueue);
787	}
788
789	RTCritSectLeave(&pThis->CritSect);
790
791	if (pUrb)
792	Log(("usbHidUrbReap/#%u: pUrb=%p:%s\n", pUsbIns->iInstance, pUrb, pUrb->pszDesc));
793	return pUrb;
794	}
795
796
797	/**
798	* @interface_method_impl{PDMUSBREG,pfnWakeup}
799	*/
800	static DECLCALLBACK(int) usbHidWakeup(PPDMUSBINS pUsbIns)
801	{
802	PUSBHID pThis = PDMINS_2_DATA(pUsbIns, PUSBHID);
803
804	return RTSemEventSignal(pThis->hEvtDoneQueue);
805	}
806
807
808	/**
809	* @interface_method_impl{PDMUSBREG,pfnUrbCancel}
810	*/
811	static DECLCALLBACK(int) usbHidUrbCancel(PPDMUSBINS pUsbIns, PVUSBURB pUrb)
812	{
813	PUSBHID pThis = PDMINS_2_DATA(pUsbIns, PUSBHID);
814	LogFlow(("usbHidUrbCancel/#%u: pUrb=%p:%s\n", pUsbIns->iInstance, pUrb, pUrb->pszDesc));
815	RTCritSectEnter(&pThis->CritSect);
816
817	/*
818	* Remove the URB from the to-host queue and move it onto the done queue.
819	*/
820	if (usbHidQueueRemove(&pThis->ToHostQueue, pUrb))
821	usbHidLinkDone(pThis, pUrb);
822
823	RTCritSectLeave(&pThis->CritSect);
824	return VINF_SUCCESS;
825	}
826
827
828	/**
829	* Handles request sent to the inbound (device to host) interrupt pipe. This is
830	* rather different from bulk requests because an interrupt read URB may complete
831	* after arbitrarily long time.
832	*/
833	static int usbHidHandleIntrDevToHost(PUSBHID pThis, PUSBHIDEP pEp, PVUSBURB pUrb)
834	{
835	/*
836	* Stall the request if the pipe is halted.
837	*/
838	if (RT_UNLIKELY(pEp->fHalted))
839	return usbHidCompleteStall(pThis, NULL, pUrb, "Halted pipe");
840
841	/*
842	* Deal with the URB according to the state.
843	*/
844	switch (pThis->enmState)
845	{
846	/*
847	* We've data left to transfer to the host.
848	*/
849	case USBHIDREQSTATE_DATA_TO_HOST:
850	{
851	AssertFailed();
852	Log(("usbHidHandleIntrDevToHost: Entering STATUS\n"));
853	return usbHidCompleteOk(pThis, pUrb, 0);
854	}
855
856	/*
857	* Status transfer.
858	*/
859	case USBHIDREQSTATE_STATUS:
860	{
861	AssertFailed();
862	Log(("usbHidHandleIntrDevToHost: Entering READY\n"));
863	pThis->enmState = USBHIDREQSTATE_READY;
864	return usbHidCompleteOk(pThis, pUrb, 0);
865	}
866
867	case USBHIDREQSTATE_READY:
868	usbHidQueueAddTail(&pThis->ToHostQueue, pUrb);
869	/* If device was not set idle, send the current report right away. */
870	if (pThis->bIdle != 0 \|\| pThis->fHasPendingChanges)
871	{
872	usbHidSendReport(pThis);
873	LogFlow(("usbHidHandleIntrDevToHost: Sent report via %p:%s\n", pUrb, pUrb->pszDesc));
874	Assert(!pThis->fHasPendingChanges); /* Since we just got a URB... */
875	/* There may be more input queued up. Ask for it now. */
876	pThis->Lun0.pDrv->pfnFlushQueue(pThis->Lun0.pDrv);
877	}
878	return VINF_SUCCESS;
879
880	/*
881	* Bad states, stall.
882	*/
883	default:
884	Log(("usbHidHandleIntrDevToHost: enmState=%d cbData=%#x\n", pThis->enmState, pUrb->cbData));
885	return usbHidCompleteStall(pThis, NULL, pUrb, "Really bad state (D2H)!");
886	}
887	}
888
889
890	/**
891	* Handles request sent to the default control pipe.
892	*/
893	static int usbHidHandleDefaultPipe(PUSBHID pThis, PUSBHIDEP pEp, PVUSBURB pUrb)
894	{
895	PVUSBSETUP pSetup = (PVUSBSETUP)&pUrb->abData[0];
896	LogFlow(("usbHidHandleDefaultPipe: cbData=%d\n", pUrb->cbData));
897
898	AssertReturn(pUrb->cbData >= sizeof(*pSetup), VERR_VUSB_FAILED_TO_QUEUE_URB);
899
900	if ((pSetup->bmRequestType & VUSB_REQ_MASK) == VUSB_REQ_STANDARD)
901	{
902	switch (pSetup->bRequest)
903	{
904	case VUSB_REQ_GET_DESCRIPTOR:
905	{
906	switch (pSetup->bmRequestType)
907	{
908	case VUSB_TO_DEVICE \| VUSB_REQ_STANDARD \| VUSB_DIR_TO_HOST:
909	{
910	switch (pSetup->wValue >> 8)
911	{
912	case VUSB_DT_STRING:
913	Log(("usbHid: GET_DESCRIPTOR DT_STRING wValue=%#x wIndex=%#x\n", pSetup->wValue, pSetup->wIndex));
914	break;
915	default:
916	Log(("usbHid: GET_DESCRIPTOR, huh? wValue=%#x wIndex=%#x\n", pSetup->wValue, pSetup->wIndex));
917	break;
918	}
919	break;
920	}
921
922	case VUSB_TO_INTERFACE \| VUSB_REQ_STANDARD \| VUSB_DIR_TO_HOST:
923	{
924	switch (pSetup->wValue >> 8)
925	{
926	case DT_IF_HID_DESCRIPTOR:
927	{
928	uint32_t cbCopy;
929
930	/* Returned data is written after the setup message. */
931	cbCopy = pUrb->cbData - sizeof(*pSetup);
932	cbCopy = RT_MIN(cbCopy, sizeof(g_UsbHidIfHidDesc));
933	Log(("usbHidKbd: GET_DESCRIPTOR DT_IF_HID_DESCRIPTOR wValue=%#x wIndex=%#x cbCopy=%#x\n", pSetup->wValue, pSetup->wIndex, cbCopy));
934	memcpy(&pUrb->abData[sizeof(*pSetup)], &g_UsbHidIfHidDesc, cbCopy);
935	return usbHidCompleteOk(pThis, pUrb, cbCopy + sizeof(*pSetup));
936	}
937
938	case DT_IF_HID_REPORT:
939	{
940	uint32_t cbCopy;
941
942	/* Returned data is written after the setup message. */
943	cbCopy = pUrb->cbData - sizeof(*pSetup);
944	cbCopy = RT_MIN(cbCopy, sizeof(g_UsbHidReportDesc));
945	Log(("usbHid: GET_DESCRIPTOR DT_IF_HID_REPORT wValue=%#x wIndex=%#x cbCopy=%#x\n", pSetup->wValue, pSetup->wIndex, cbCopy));
946	memcpy(&pUrb->abData[sizeof(*pSetup)], &g_UsbHidReportDesc, cbCopy);
947	return usbHidCompleteOk(pThis, pUrb, cbCopy + sizeof(*pSetup));
948	}
949
950	default:
951	Log(("usbHid: GET_DESCRIPTOR, huh? wValue=%#x wIndex=%#x\n", pSetup->wValue, pSetup->wIndex));
952	break;
953	}
954	break;
955	}
956
957	default:
958	Log(("usbHid: Bad GET_DESCRIPTOR req: bmRequestType=%#x\n", pSetup->bmRequestType));
959	return usbHidCompleteStall(pThis, pEp, pUrb, "Bad GET_DESCRIPTOR");
960	}
961	break;
962	}
963
964	case VUSB_REQ_GET_STATUS:
965	{
966	uint16_t wRet = 0;
967
968	if (pSetup->wLength != 2)
969	{
970	Log(("usbHid: Bad GET_STATUS req: wLength=%#x\n", pSetup->wLength));
971	break;
972	}
973	Assert(pSetup->wValue == 0);
974	switch (pSetup->bmRequestType)
975	{
976	case VUSB_TO_DEVICE \| VUSB_REQ_STANDARD \| VUSB_DIR_TO_HOST:
977	{
978	Assert(pSetup->wIndex == 0);
979	Log(("usbHid: GET_STATUS (device)\n"));
980	wRet = 0; /* Not self-powered, no remote wakeup. */
981	memcpy(&pUrb->abData[sizeof(*pSetup)], &wRet, sizeof(wRet));
982	return usbHidCompleteOk(pThis, pUrb, sizeof(wRet) + sizeof(*pSetup));
983	}
984
985	case VUSB_TO_INTERFACE \| VUSB_REQ_STANDARD \| VUSB_DIR_TO_HOST:
986	{
987	if (pSetup->wIndex == 0)
988	{
989	memcpy(&pUrb->abData[sizeof(*pSetup)], &wRet, sizeof(wRet));
990	return usbHidCompleteOk(pThis, pUrb, sizeof(wRet) + sizeof(*pSetup));
991	}
992	else
993	{
994	Log(("usbHid: GET_STATUS (interface) invalid, wIndex=%#x\n", pSetup->wIndex));
995	}
996	break;
997	}
998
999	case VUSB_TO_ENDPOINT \| VUSB_REQ_STANDARD \| VUSB_DIR_TO_HOST:
1000	{
1001	if (pSetup->wIndex < RT_ELEMENTS(pThis->aEps))
1002	{
1003	wRet = pThis->aEps[pSetup->wIndex].fHalted ? 1 : 0;
1004	memcpy(&pUrb->abData[sizeof(*pSetup)], &wRet, sizeof(wRet));
1005	return usbHidCompleteOk(pThis, pUrb, sizeof(wRet) + sizeof(*pSetup));
1006	}
1007	else
1008	{
1009	Log(("usbHid: GET_STATUS (endpoint) invalid, wIndex=%#x\n", pSetup->wIndex));
1010	}
1011	break;
1012	}
1013
1014	default:
1015	Log(("usbHid: Bad GET_STATUS req: bmRequestType=%#x\n", pSetup->bmRequestType));
1016	return usbHidCompleteStall(pThis, pEp, pUrb, "Bad GET_STATUS");
1017	}
1018	break;
1019	}
1020
1021	case VUSB_REQ_CLEAR_FEATURE:
1022	break;
1023	}
1024
1025	/** @todo implement this. */
1026	Log(("usbHid: Implement standard request: bmRequestType=%#x bRequest=%#x wValue=%#x wIndex=%#x wLength=%#x\n",
1027	pSetup->bmRequestType, pSetup->bRequest, pSetup->wValue, pSetup->wIndex, pSetup->wLength));
1028
1029	usbHidCompleteStall(pThis, pEp, pUrb, "TODO: standard request stuff");
1030	}
1031	else if ((pSetup->bmRequestType & VUSB_REQ_MASK) == VUSB_REQ_CLASS)
1032	{
1033	switch (pSetup->bRequest)
1034	{
1035	case HID_REQ_SET_IDLE:
1036	{
1037	switch (pSetup->bmRequestType)
1038	{
1039	case VUSB_TO_INTERFACE \| VUSB_REQ_CLASS \| VUSB_DIR_TO_DEVICE:
1040	{
1041	Log(("usbHid: SET_IDLE wValue=%#x wIndex=%#x\n", pSetup->wValue, pSetup->wIndex));
1042	pThis->bIdle = pSetup->wValue >> 8;
1043	/* Consider 24ms to mean zero for keyboards (see IOUSBHIDDriver) */
1044	if (pThis->bIdle == 6) pThis->bIdle = 0;
1045	return usbHidCompleteOk(pThis, pUrb, 0);
1046	}
1047	break;
1048	}
1049	break;
1050	}
1051	case HID_REQ_GET_IDLE:
1052	{
1053	switch (pSetup->bmRequestType)
1054	{
1055	case VUSB_TO_INTERFACE \| VUSB_REQ_CLASS \| VUSB_DIR_TO_HOST:
1056	{
1057	Log(("usbHid: GET_IDLE wValue=%#x wIndex=%#x, returning %#x\n", pSetup->wValue, pSetup->wIndex, pThis->bIdle));
1058	pUrb->abData[sizeof(*pSetup)] = pThis->bIdle;
1059	return usbHidCompleteOk(pThis, pUrb, 1);
1060	}
1061	break;
1062	}
1063	break;
1064	}
1065	case HID_REQ_SET_REPORT:
1066	{
1067	switch (pSetup->bmRequestType)
1068	{
1069	case VUSB_TO_INTERFACE \| VUSB_REQ_CLASS \| VUSB_DIR_TO_DEVICE:
1070	{
1071	Log(("usbHid: SET_REPORT wValue=%#x wIndex=%#x wLength=%#x\n", pSetup->wValue, pSetup->wIndex, pSetup->wLength));
1072	usbHidSetReport(pThis, pUrb);
1073	return usbHidCompleteOk(pThis, pUrb, 0);
1074	}
1075	break;
1076	}
1077	break;
1078	}
1079	}
1080	Log(("usbHid: Unimplemented class request: bmRequestType=%#x bRequest=%#x wValue=%#x wIndex=%#x wLength=%#x\n",
1081	pSetup->bmRequestType, pSetup->bRequest, pSetup->wValue, pSetup->wIndex, pSetup->wLength));
1082
1083	usbHidCompleteStall(pThis, pEp, pUrb, "TODO: class request stuff");
1084	}
1085	else
1086	{
1087	Log(("usbHid: Unknown control msg: bmRequestType=%#x bRequest=%#x wValue=%#x wIndex=%#x wLength=%#x\n",
1088	pSetup->bmRequestType, pSetup->bRequest, pSetup->wValue, pSetup->wIndex, pSetup->wLength));
1089	return usbHidCompleteStall(pThis, pEp, pUrb, "Unknown control msg");
1090	}
1091
1092	return VINF_SUCCESS;
1093	}
1094
1095
1096	/**
1097	* @interface_method_impl{PDMUSBREG,pfnUrbQueue}
1098	*/
1099	static DECLCALLBACK(int) usbHidQueue(PPDMUSBINS pUsbIns, PVUSBURB pUrb)
1100	{
1101	PUSBHID pThis = PDMINS_2_DATA(pUsbIns, PUSBHID);
1102	LogFlow(("usbHidQueue/#%u: pUrb=%p:%s EndPt=%#x\n", pUsbIns->iInstance, pUrb, pUrb->pszDesc, pUrb->EndPt));
1103	RTCritSectEnter(&pThis->CritSect);
1104
1105	/*
1106	* Parse on a per end-point basis.
1107	*/
1108	int rc;
1109	switch (pUrb->EndPt)
1110	{
1111	case 0:
1112	rc = usbHidHandleDefaultPipe(pThis, &pThis->aEps[0], pUrb);
1113	break;
1114
1115	case 0x81:
1116	AssertFailed();
1117	case 0x01:
1118	rc = usbHidHandleIntrDevToHost(pThis, &pThis->aEps[1], pUrb);
1119	break;
1120
1121	default:
1122	AssertMsgFailed(("EndPt=%d\n", pUrb->EndPt));
1123	rc = VERR_VUSB_FAILED_TO_QUEUE_URB;
1124	break;
1125	}
1126
1127	RTCritSectLeave(&pThis->CritSect);
1128	return rc;
1129	}
1130
1131
1132	/**
1133	* @interface_method_impl{PDMUSBREG,pfnUsbClearHaltedEndpoint}
1134	*/
1135	static DECLCALLBACK(int) usbHidUsbClearHaltedEndpoint(PPDMUSBINS pUsbIns, unsigned uEndpoint)
1136	{
1137	PUSBHID pThis = PDMINS_2_DATA(pUsbIns, PUSBHID);
1138	LogFlow(("usbHidUsbClearHaltedEndpoint/#%u: uEndpoint=%#x\n", pUsbIns->iInstance, uEndpoint));
1139
1140	if ((uEndpoint & ~0x80) < RT_ELEMENTS(pThis->aEps))
1141	{
1142	RTCritSectEnter(&pThis->CritSect);
1143	pThis->aEps[(uEndpoint & ~0x80)].fHalted = false;
1144	RTCritSectLeave(&pThis->CritSect);
1145	}
1146
1147	return VINF_SUCCESS;
1148	}
1149
1150
1151	/**
1152	* @interface_method_impl{PDMUSBREG,pfnUsbSetInterface}
1153	*/
1154	static DECLCALLBACK(int) usbHidUsbSetInterface(PPDMUSBINS pUsbIns, uint8_t bInterfaceNumber, uint8_t bAlternateSetting)
1155	{
1156	RT_NOREF3(pUsbIns, bInterfaceNumber, bAlternateSetting);
1157	LogFlow(("usbHidUsbSetInterface/#%u: bInterfaceNumber=%u bAlternateSetting=%u\n", pUsbIns->iInstance, bInterfaceNumber, bAlternateSetting));
1158	Assert(bAlternateSetting == 0);
1159	return VINF_SUCCESS;
1160	}
1161
1162
1163	/**
1164	* @interface_method_impl{PDMUSBREG,pfnUsbSetConfiguration}
1165	*/
1166	static DECLCALLBACK(int) usbHidUsbSetConfiguration(PPDMUSBINS pUsbIns, uint8_t bConfigurationValue,
1167	const void pvOldCfgDesc, const void pvOldIfState, const void *pvNewCfgDesc)
1168	{
1169	RT_NOREF3(pvOldCfgDesc, pvOldIfState, pvNewCfgDesc);
1170	PUSBHID pThis = PDMINS_2_DATA(pUsbIns, PUSBHID);
1171	LogFlow(("usbHidUsbSetConfiguration/#%u: bConfigurationValue=%u\n", pUsbIns->iInstance, bConfigurationValue));
1172	Assert(bConfigurationValue == 1);
1173	RTCritSectEnter(&pThis->CritSect);
1174
1175	/*
1176	* If the same config is applied more than once, it's a kind of reset.
1177	*/
1178	if (pThis->bConfigurationValue == bConfigurationValue)
1179	usbHidResetWorker(pThis, NULL, true /fSetConfig/); /** @todo figure out the exact difference */
1180	pThis->bConfigurationValue = bConfigurationValue;
1181
1182	/*
1183	* Tell the other end that the keyboard is now enabled and wants
1184	* to receive keystrokes.
1185	*/
1186	pThis->Lun0.pDrv->pfnSetActive(pThis->Lun0.pDrv, true);
1187
1188	RTCritSectLeave(&pThis->CritSect);
1189	return VINF_SUCCESS;
1190	}
1191
1192
1193	/**
1194	* @interface_method_impl{PDMUSBREG,pfnUsbGetDescriptorCache}
1195	*/
1196	static DECLCALLBACK(PCPDMUSBDESCCACHE) usbHidUsbGetDescriptorCache(PPDMUSBINS pUsbIns)
1197	{
1198	PUSBHID pThis = PDMINS_2_DATA(pUsbIns, PUSBHID); RT_NOREF_PV(pThis);
1199	LogFlow(("usbHidUsbGetDescriptorCache/#%u:\n", pUsbIns->iInstance));
1200	return &g_UsbHidDescCache;
1201	}
1202
1203
1204	/**
1205	* @interface_method_impl{PDMUSBREG,pfnUsbReset}
1206	*/
1207	static DECLCALLBACK(int) usbHidUsbReset(PPDMUSBINS pUsbIns, bool fResetOnLinux)
1208	{
1209	RT_NOREF1(fResetOnLinux);
1210	PUSBHID pThis = PDMINS_2_DATA(pUsbIns, PUSBHID);
1211	LogFlow(("usbHidUsbReset/#%u:\n", pUsbIns->iInstance));
1212	RTCritSectEnter(&pThis->CritSect);
1213
1214	int rc = usbHidResetWorker(pThis, NULL, false /fSetConfig/);
1215
1216	RTCritSectLeave(&pThis->CritSect);
1217	return rc;
1218	}
1219
1220
1221	/**
1222	* @interface_method_impl{PDMUSBREG,pfnDestruct}
1223	*/
1224	static DECLCALLBACK(void) usbHidDestruct(PPDMUSBINS pUsbIns)
1225	{
1226	PDMUSB_CHECK_VERSIONS_RETURN_VOID(pUsbIns);
1227	PUSBHID pThis = PDMINS_2_DATA(pUsbIns, PUSBHID);
1228	LogFlow(("usbHidDestruct/#%u:\n", pUsbIns->iInstance));
1229
1230	if (RTCritSectIsInitialized(&pThis->CritSect))
1231	{
1232	/* Let whoever runs in this critical section complete. */
1233	RTCritSectEnter(&pThis->CritSect);
1234	RTCritSectLeave(&pThis->CritSect);
1235	RTCritSectDelete(&pThis->CritSect);
1236	}
1237
1238	if (pThis->hEvtDoneQueue != NIL_RTSEMEVENT)
1239	{
1240	RTSemEventDestroy(pThis->hEvtDoneQueue);
1241	pThis->hEvtDoneQueue = NIL_RTSEMEVENT;
1242	}
1243	}
1244
1245
1246	/**
1247	* @interface_method_impl{PDMUSBREG,pfnConstruct}
1248	*/
1249	static DECLCALLBACK(int) usbHidConstruct(PPDMUSBINS pUsbIns, int iInstance, PCFGMNODE pCfg, PCFGMNODE pCfgGlobal)
1250	{
1251	RT_NOREF1(pCfgGlobal);
1252	PDMUSB_CHECK_VERSIONS_RETURN(pUsbIns);
1253	PUSBHID pThis = PDMINS_2_DATA(pUsbIns, PUSBHID);
1254	Log(("usbHidConstruct/#%u:\n", iInstance));
1255
1256	/*
1257	* Perform the basic structure initialization first so the destructor
1258	* will not misbehave.
1259	*/
1260	pThis->pUsbIns = pUsbIns;
1261	pThis->hEvtDoneQueue = NIL_RTSEMEVENT;
1262	usbHidQueueInit(&pThis->ToHostQueue);
1263	usbHidQueueInit(&pThis->DoneQueue);
1264
1265	int rc = RTCritSectInit(&pThis->CritSect);
1266	AssertRCReturn(rc, rc);
1267
1268	rc = RTSemEventCreate(&pThis->hEvtDoneQueue);
1269	AssertRCReturn(rc, rc);
1270
1271	/*
1272	* Validate and read the configuration.
1273	*/
1274	rc = CFGMR3ValidateConfig(pCfg, "/", "", "", "UsbHid", iInstance);
1275	if (RT_FAILURE(rc))
1276	return rc;
1277
1278	pThis->Lun0.IBase.pfnQueryInterface = usbHidKeyboardQueryInterface;
1279	pThis->Lun0.IPort.pfnPutEventHid = usbHidKeyboardPutEvent;
1280
1281	/*
1282	* Attach the keyboard driver.
1283	*/
1284	rc = PDMUsbHlpDriverAttach(pUsbIns, 0 /iLun/, &pThis->Lun0.IBase, &pThis->Lun0.pDrvBase, "Keyboard Port");
1285	if (RT_FAILURE(rc))
1286	return PDMUsbHlpVMSetError(pUsbIns, rc, RT_SRC_POS, N_("HID failed to attach keyboard driver"));
1287
1288	pThis->Lun0.pDrv = PDMIBASE_QUERY_INTERFACE(pThis->Lun0.pDrvBase, PDMIKEYBOARDCONNECTOR);
1289	if (!pThis->Lun0.pDrv)
1290	return PDMUsbHlpVMSetError(pUsbIns, VERR_PDM_MISSING_INTERFACE, RT_SRC_POS, N_("HID failed to query keyboard interface"));
1291
1292	return VINF_SUCCESS;
1293	}
1294
1295
1296	/**
1297	* The USB Human Interface Device (HID) Keyboard registration record.
1298	*/
1299	const PDMUSBREG g_UsbHidKbd =
1300	{
1301	/* u32Version */
1302	PDM_USBREG_VERSION,
1303	/* szName */
1304	"HidKeyboard",
1305	/* pszDescription */
1306	"USB HID Keyboard.",
1307	/* fFlags */
1308	0,
1309	/* cMaxInstances */
1310	~0U,
1311	/* cbInstance */
1312	sizeof(USBHID),
1313	/* pfnConstruct */
1314	usbHidConstruct,
1315	/* pfnDestruct */
1316	usbHidDestruct,
1317	/* pfnVMInitComplete */
1318	NULL,
1319	/* pfnVMPowerOn */
1320	NULL,
1321	/* pfnVMReset */
1322	NULL,
1323	/* pfnVMSuspend */
1324	NULL,
1325	/* pfnVMResume */
1326	NULL,
1327	/* pfnVMPowerOff */
1328	NULL,
1329	/* pfnHotPlugged */
1330	NULL,
1331	/* pfnHotUnplugged */
1332	NULL,
1333	/* pfnDriverAttach */
1334	NULL,
1335	/* pfnDriverDetach */
1336	NULL,
1337	/* pfnQueryInterface */
1338	NULL,
1339	/* pfnUsbReset */
1340	usbHidUsbReset,
1341	/* pfnUsbGetDescriptorCache */
1342	usbHidUsbGetDescriptorCache,
1343	/* pfnUsbSetConfiguration */
1344	usbHidUsbSetConfiguration,
1345	/* pfnUsbSetInterface */
1346	usbHidUsbSetInterface,
1347	/* pfnUsbClearHaltedEndpoint */
1348	usbHidUsbClearHaltedEndpoint,
1349	/* pfnUrbNew */
1350	NULL/usbHidUrbNew/,
1351	/* pfnUrbQueue */
1352	usbHidQueue,
1353	/* pfnUrbCancel */
1354	usbHidUrbCancel,
1355	/* pfnUrbReap */
1356	usbHidUrbReap,
1357	/* pfnWakeup */
1358	usbHidWakeup,
1359	/* u32TheEnd */
1360	PDM_USBREG_VERSION
1361	};

Note: See TracBrowser for help on using the repository browser.

source: vbox/trunk/src/VBox/Devices/Input/UsbKbd.cpp@ 64468

Download in other formats: