hid-debug.c revision 5a0e3ad6af8660be21ca98a971cd00f331318c05 
1/*
2 *  (c) 1999 Andreas Gal		<gal@cs.uni-magdeburg.de>
3 *  (c) 2000-2001 Vojtech Pavlik	<vojtech@ucw.cz>
4 *  (c) 2007-2009 Jiri Kosina
5 *
6 *  HID debugging support
7 */
8
9/*
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
14 *
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU General Public License for more details.
19 *
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23 *
24 * Should you need to contact me, the author, you can do so either by
25 * e-mail - mail your message to <vojtech@ucw.cz>, or by paper mail:
26 * Vojtech Pavlik, Simunkova 1594, Prague 8, 182 00 Czech Republic
27 */
28
29#include <linux/debugfs.h>
30#include <linux/seq_file.h>
31#include <linux/sched.h>
32#include <linux/slab.h>
33#include <linux/uaccess.h>
34#include <linux/poll.h>
35
36#include <linux/hid.h>
37#include <linux/hid-debug.h>
38
39static struct dentry *hid_debug_root;
40
41struct hid_usage_entry {
42	unsigned  page;
43	unsigned  usage;
44	const char     *description;
45};
46
47static const struct hid_usage_entry hid_usage_table[] = {
48  {  0,      0, "Undefined" },
49  {  1,      0, "GenericDesktop" },
50    {0, 0x01, "Pointer"},
51    {0, 0x02, "Mouse"},
52    {0, 0x04, "Joystick"},
53    {0, 0x05, "GamePad"},
54    {0, 0x06, "Keyboard"},
55    {0, 0x07, "Keypad"},
56    {0, 0x08, "MultiAxis"},
57      {0, 0x30, "X"},
58      {0, 0x31, "Y"},
59      {0, 0x32, "Z"},
60      {0, 0x33, "Rx"},
61      {0, 0x34, "Ry"},
62      {0, 0x35, "Rz"},
63      {0, 0x36, "Slider"},
64      {0, 0x37, "Dial"},
65      {0, 0x38, "Wheel"},
66      {0, 0x39, "HatSwitch"},
67    {0, 0x3a, "CountedBuffer"},
68      {0, 0x3b, "ByteCount"},
69      {0, 0x3c, "MotionWakeup"},
70      {0, 0x3d, "Start"},
71      {0, 0x3e, "Select"},
72      {0, 0x40, "Vx"},
73      {0, 0x41, "Vy"},
74      {0, 0x42, "Vz"},
75      {0, 0x43, "Vbrx"},
76      {0, 0x44, "Vbry"},
77      {0, 0x45, "Vbrz"},
78      {0, 0x46, "Vno"},
79    {0, 0x80, "SystemControl"},
80      {0, 0x81, "SystemPowerDown"},
81      {0, 0x82, "SystemSleep"},
82      {0, 0x83, "SystemWakeUp"},
83      {0, 0x84, "SystemContextMenu"},
84      {0, 0x85, "SystemMainMenu"},
85      {0, 0x86, "SystemAppMenu"},
86      {0, 0x87, "SystemMenuHelp"},
87      {0, 0x88, "SystemMenuExit"},
88      {0, 0x89, "SystemMenuSelect"},
89      {0, 0x8a, "SystemMenuRight"},
90      {0, 0x8b, "SystemMenuLeft"},
91      {0, 0x8c, "SystemMenuUp"},
92      {0, 0x8d, "SystemMenuDown"},
93      {0, 0x90, "D-PadUp"},
94      {0, 0x91, "D-PadDown"},
95      {0, 0x92, "D-PadRight"},
96      {0, 0x93, "D-PadLeft"},
97  {  2, 0, "Simulation" },
98      {0, 0xb0, "Aileron"},
99      {0, 0xb1, "AileronTrim"},
100      {0, 0xb2, "Anti-Torque"},
101      {0, 0xb3, "Autopilot"},
102      {0, 0xb4, "Chaff"},
103      {0, 0xb5, "Collective"},
104      {0, 0xb6, "DiveBrake"},
105      {0, 0xb7, "ElectronicCountermeasures"},
106      {0, 0xb8, "Elevator"},
107      {0, 0xb9, "ElevatorTrim"},
108      {0, 0xba, "Rudder"},
109      {0, 0xbb, "Throttle"},
110      {0, 0xbc, "FlightCommunications"},
111      {0, 0xbd, "FlareRelease"},
112      {0, 0xbe, "LandingGear"},
113      {0, 0xbf, "ToeBrake"},
114  {  7, 0, "Keyboard" },
115  {  8, 0, "LED" },
116      {0, 0x01, "NumLock"},
117      {0, 0x02, "CapsLock"},
118      {0, 0x03, "ScrollLock"},
119      {0, 0x04, "Compose"},
120      {0, 0x05, "Kana"},
121      {0, 0x4b, "GenericIndicator"},
122  {  9, 0, "Button" },
123  { 10, 0, "Ordinal" },
124  { 12, 0, "Consumer" },
125      {0, 0x238, "HorizontalWheel"},
126  { 13, 0, "Digitizers" },
127    {0, 0x01, "Digitizer"},
128    {0, 0x02, "Pen"},
129    {0, 0x03, "LightPen"},
130    {0, 0x04, "TouchScreen"},
131    {0, 0x05, "TouchPad"},
132    {0, 0x20, "Stylus"},
133    {0, 0x21, "Puck"},
134    {0, 0x22, "Finger"},
135    {0, 0x30, "TipPressure"},
136    {0, 0x31, "BarrelPressure"},
137    {0, 0x32, "InRange"},
138    {0, 0x33, "Touch"},
139    {0, 0x34, "UnTouch"},
140    {0, 0x35, "Tap"},
141    {0, 0x39, "TabletFunctionKey"},
142    {0, 0x3a, "ProgramChangeKey"},
143    {0, 0x3c, "Invert"},
144    {0, 0x42, "TipSwitch"},
145    {0, 0x43, "SecondaryTipSwitch"},
146    {0, 0x44, "BarrelSwitch"},
147    {0, 0x45, "Eraser"},
148    {0, 0x46, "TabletPick"},
149    {0, 0x47, "Confidence"},
150    {0, 0x48, "Width"},
151    {0, 0x49, "Height"},
152    {0, 0x51, "ContactID"},
153    {0, 0x52, "InputMode"},
154    {0, 0x53, "DeviceIndex"},
155    {0, 0x54, "ContactCount"},
156    {0, 0x55, "ContactMaximumNumber"},
157  { 15, 0, "PhysicalInterfaceDevice" },
158    {0, 0x00, "Undefined"},
159    {0, 0x01, "Physical_Interface_Device"},
160      {0, 0x20, "Normal"},
161    {0, 0x21, "Set_Effect_Report"},
162      {0, 0x22, "Effect_Block_Index"},
163      {0, 0x23, "Parameter_Block_Offset"},
164      {0, 0x24, "ROM_Flag"},
165      {0, 0x25, "Effect_Type"},
166        {0, 0x26, "ET_Constant_Force"},
167        {0, 0x27, "ET_Ramp"},
168        {0, 0x28, "ET_Custom_Force_Data"},
169        {0, 0x30, "ET_Square"},
170        {0, 0x31, "ET_Sine"},
171        {0, 0x32, "ET_Triangle"},
172        {0, 0x33, "ET_Sawtooth_Up"},
173        {0, 0x34, "ET_Sawtooth_Down"},
174        {0, 0x40, "ET_Spring"},
175        {0, 0x41, "ET_Damper"},
176        {0, 0x42, "ET_Inertia"},
177        {0, 0x43, "ET_Friction"},
178      {0, 0x50, "Duration"},
179      {0, 0x51, "Sample_Period"},
180      {0, 0x52, "Gain"},
181      {0, 0x53, "Trigger_Button"},
182      {0, 0x54, "Trigger_Repeat_Interval"},
183      {0, 0x55, "Axes_Enable"},
184        {0, 0x56, "Direction_Enable"},
185      {0, 0x57, "Direction"},
186      {0, 0x58, "Type_Specific_Block_Offset"},
187        {0, 0x59, "Block_Type"},
188        {0, 0x5A, "Set_Envelope_Report"},
189          {0, 0x5B, "Attack_Level"},
190          {0, 0x5C, "Attack_Time"},
191          {0, 0x5D, "Fade_Level"},
192          {0, 0x5E, "Fade_Time"},
193        {0, 0x5F, "Set_Condition_Report"},
194        {0, 0x60, "CP_Offset"},
195        {0, 0x61, "Positive_Coefficient"},
196        {0, 0x62, "Negative_Coefficient"},
197        {0, 0x63, "Positive_Saturation"},
198        {0, 0x64, "Negative_Saturation"},
199        {0, 0x65, "Dead_Band"},
200      {0, 0x66, "Download_Force_Sample"},
201      {0, 0x67, "Isoch_Custom_Force_Enable"},
202      {0, 0x68, "Custom_Force_Data_Report"},
203        {0, 0x69, "Custom_Force_Data"},
204        {0, 0x6A, "Custom_Force_Vendor_Defined_Data"},
205      {0, 0x6B, "Set_Custom_Force_Report"},
206        {0, 0x6C, "Custom_Force_Data_Offset"},
207        {0, 0x6D, "Sample_Count"},
208      {0, 0x6E, "Set_Periodic_Report"},
209        {0, 0x6F, "Offset"},
210        {0, 0x70, "Magnitude"},
211        {0, 0x71, "Phase"},
212        {0, 0x72, "Period"},
213      {0, 0x73, "Set_Constant_Force_Report"},
214        {0, 0x74, "Set_Ramp_Force_Report"},
215        {0, 0x75, "Ramp_Start"},
216        {0, 0x76, "Ramp_End"},
217      {0, 0x77, "Effect_Operation_Report"},
218        {0, 0x78, "Effect_Operation"},
219          {0, 0x79, "Op_Effect_Start"},
220          {0, 0x7A, "Op_Effect_Start_Solo"},
221          {0, 0x7B, "Op_Effect_Stop"},
222          {0, 0x7C, "Loop_Count"},
223      {0, 0x7D, "Device_Gain_Report"},
224        {0, 0x7E, "Device_Gain"},
225    {0, 0x7F, "PID_Pool_Report"},
226      {0, 0x80, "RAM_Pool_Size"},
227      {0, 0x81, "ROM_Pool_Size"},
228      {0, 0x82, "ROM_Effect_Block_Count"},
229      {0, 0x83, "Simultaneous_Effects_Max"},
230      {0, 0x84, "Pool_Alignment"},
231    {0, 0x85, "PID_Pool_Move_Report"},
232      {0, 0x86, "Move_Source"},
233      {0, 0x87, "Move_Destination"},
234      {0, 0x88, "Move_Length"},
235    {0, 0x89, "PID_Block_Load_Report"},
236      {0, 0x8B, "Block_Load_Status"},
237      {0, 0x8C, "Block_Load_Success"},
238      {0, 0x8D, "Block_Load_Full"},
239      {0, 0x8E, "Block_Load_Error"},
240      {0, 0x8F, "Block_Handle"},
241      {0, 0x90, "PID_Block_Free_Report"},
242      {0, 0x91, "Type_Specific_Block_Handle"},
243    {0, 0x92, "PID_State_Report"},
244      {0, 0x94, "Effect_Playing"},
245      {0, 0x95, "PID_Device_Control_Report"},
246        {0, 0x96, "PID_Device_Control"},
247        {0, 0x97, "DC_Enable_Actuators"},
248        {0, 0x98, "DC_Disable_Actuators"},
249        {0, 0x99, "DC_Stop_All_Effects"},
250        {0, 0x9A, "DC_Device_Reset"},
251        {0, 0x9B, "DC_Device_Pause"},
252        {0, 0x9C, "DC_Device_Continue"},
253      {0, 0x9F, "Device_Paused"},
254      {0, 0xA0, "Actuators_Enabled"},
255      {0, 0xA4, "Safety_Switch"},
256      {0, 0xA5, "Actuator_Override_Switch"},
257      {0, 0xA6, "Actuator_Power"},
258    {0, 0xA7, "Start_Delay"},
259    {0, 0xA8, "Parameter_Block_Size"},
260    {0, 0xA9, "Device_Managed_Pool"},
261    {0, 0xAA, "Shared_Parameter_Blocks"},
262    {0, 0xAB, "Create_New_Effect_Report"},
263    {0, 0xAC, "RAM_Pool_Available"},
264  { 0x84, 0, "Power Device" },
265    { 0x84, 0x02, "PresentStatus" },
266    { 0x84, 0x03, "ChangeStatus" },
267    { 0x84, 0x04, "UPS" },
268    { 0x84, 0x05, "PowerSupply" },
269    { 0x84, 0x10, "BatterySystem" },
270    { 0x84, 0x11, "BatterySystemID" },
271    { 0x84, 0x12, "Battery" },
272    { 0x84, 0x13, "BatteryID" },
273    { 0x84, 0x14, "Charger" },
274    { 0x84, 0x15, "ChargerID" },
275    { 0x84, 0x16, "PowerConverter" },
276    { 0x84, 0x17, "PowerConverterID" },
277    { 0x84, 0x18, "OutletSystem" },
278    { 0x84, 0x19, "OutletSystemID" },
279    { 0x84, 0x1a, "Input" },
280    { 0x84, 0x1b, "InputID" },
281    { 0x84, 0x1c, "Output" },
282    { 0x84, 0x1d, "OutputID" },
283    { 0x84, 0x1e, "Flow" },
284    { 0x84, 0x1f, "FlowID" },
285    { 0x84, 0x20, "Outlet" },
286    { 0x84, 0x21, "OutletID" },
287    { 0x84, 0x22, "Gang" },
288    { 0x84, 0x24, "PowerSummary" },
289    { 0x84, 0x25, "PowerSummaryID" },
290    { 0x84, 0x30, "Voltage" },
291    { 0x84, 0x31, "Current" },
292    { 0x84, 0x32, "Frequency" },
293    { 0x84, 0x33, "ApparentPower" },
294    { 0x84, 0x35, "PercentLoad" },
295    { 0x84, 0x40, "ConfigVoltage" },
296    { 0x84, 0x41, "ConfigCurrent" },
297    { 0x84, 0x43, "ConfigApparentPower" },
298    { 0x84, 0x53, "LowVoltageTransfer" },
299    { 0x84, 0x54, "HighVoltageTransfer" },
300    { 0x84, 0x56, "DelayBeforeStartup" },
301    { 0x84, 0x57, "DelayBeforeShutdown" },
302    { 0x84, 0x58, "Test" },
303    { 0x84, 0x5a, "AudibleAlarmControl" },
304    { 0x84, 0x60, "Present" },
305    { 0x84, 0x61, "Good" },
306    { 0x84, 0x62, "InternalFailure" },
307    { 0x84, 0x65, "Overload" },
308    { 0x84, 0x66, "OverCharged" },
309    { 0x84, 0x67, "OverTemperature" },
310    { 0x84, 0x68, "ShutdownRequested" },
311    { 0x84, 0x69, "ShutdownImminent" },
312    { 0x84, 0x6b, "SwitchOn/Off" },
313    { 0x84, 0x6c, "Switchable" },
314    { 0x84, 0x6d, "Used" },
315    { 0x84, 0x6e, "Boost" },
316    { 0x84, 0x73, "CommunicationLost" },
317    { 0x84, 0xfd, "iManufacturer" },
318    { 0x84, 0xfe, "iProduct" },
319    { 0x84, 0xff, "iSerialNumber" },
320  { 0x85, 0, "Battery System" },
321    { 0x85, 0x01, "SMBBatteryMode" },
322    { 0x85, 0x02, "SMBBatteryStatus" },
323    { 0x85, 0x03, "SMBAlarmWarning" },
324    { 0x85, 0x04, "SMBChargerMode" },
325    { 0x85, 0x05, "SMBChargerStatus" },
326    { 0x85, 0x06, "SMBChargerSpecInfo" },
327    { 0x85, 0x07, "SMBSelectorState" },
328    { 0x85, 0x08, "SMBSelectorPresets" },
329    { 0x85, 0x09, "SMBSelectorInfo" },
330    { 0x85, 0x29, "RemainingCapacityLimit" },
331    { 0x85, 0x2c, "CapacityMode" },
332    { 0x85, 0x42, "BelowRemainingCapacityLimit" },
333    { 0x85, 0x44, "Charging" },
334    { 0x85, 0x45, "Discharging" },
335    { 0x85, 0x4b, "NeedReplacement" },
336    { 0x85, 0x66, "RemainingCapacity" },
337    { 0x85, 0x68, "RunTimeToEmpty" },
338    { 0x85, 0x6a, "AverageTimeToFull" },
339    { 0x85, 0x83, "DesignCapacity" },
340    { 0x85, 0x85, "ManufacturerDate" },
341    { 0x85, 0x89, "iDeviceChemistry" },
342    { 0x85, 0x8b, "Rechargable" },
343    { 0x85, 0x8f, "iOEMInformation" },
344    { 0x85, 0x8d, "CapacityGranularity1" },
345    { 0x85, 0xd0, "ACPresent" },
346  /* pages 0xff00 to 0xffff are vendor-specific */
347  { 0xffff, 0, "Vendor-specific-FF" },
348  { 0, 0, NULL }
349};
350
351/* Either output directly into simple seq_file, or (if f == NULL)
352 * allocate a separate buffer that will then be passed to the 'events'
353 * ringbuffer.
354 *
355 * This is because these functions can be called both for "one-shot"
356 * "rdesc" while resolving, or for blocking "events".
357 *
358 * This holds both for resolv_usage_page() and hid_resolv_usage().
359 */
360static char *resolv_usage_page(unsigned page, struct seq_file *f) {
361	const struct hid_usage_entry *p;
362	char *buf = NULL;
363
364	if (!f) {
365		buf = kzalloc(sizeof(char) * HID_DEBUG_BUFSIZE, GFP_ATOMIC);
366		if (!buf)
367			return ERR_PTR(-ENOMEM);
368	}
369
370	for (p = hid_usage_table; p->description; p++)
371		if (p->page == page) {
372			if (!f) {
373				snprintf(buf, HID_DEBUG_BUFSIZE, "%s",
374						p->description);
375				return buf;
376			}
377			else {
378				seq_printf(f, "%s", p->description);
379				return NULL;
380			}
381		}
382	if (!f)
383		snprintf(buf, HID_DEBUG_BUFSIZE, "%04x", page);
384	else
385		seq_printf(f, "%04x", page);
386	return buf;
387}
388
389char *hid_resolv_usage(unsigned usage, struct seq_file *f) {
390	const struct hid_usage_entry *p;
391	char *buf = NULL;
392	int len = 0;
393
394	buf = resolv_usage_page(usage >> 16, f);
395	if (IS_ERR(buf)) {
396		printk(KERN_ERR "error allocating HID debug buffer\n");
397		return NULL;
398	}
399
400
401	if (!f) {
402		len = strlen(buf);
403		snprintf(buf+len, max(0, HID_DEBUG_BUFSIZE - len), ".");
404		len++;
405	}
406	else {
407		seq_printf(f, ".");
408	}
409	for (p = hid_usage_table; p->description; p++)
410		if (p->page == (usage >> 16)) {
411			for(++p; p->description && p->usage != 0; p++)
412				if (p->usage == (usage & 0xffff)) {
413					if (!f)
414						snprintf(buf + len,
415							max(0,HID_DEBUG_BUFSIZE - len - 1),
416							"%s", p->description);
417					else
418						seq_printf(f,
419							"%s",
420							p->description);
421					return buf;
422				}
423			break;
424		}
425	if (!f)
426		snprintf(buf + len, max(0, HID_DEBUG_BUFSIZE - len - 1),
427				"%04x", usage & 0xffff);
428	else
429		seq_printf(f, "%04x", usage & 0xffff);
430	return buf;
431}
432EXPORT_SYMBOL_GPL(hid_resolv_usage);
433
434static void tab(int n, struct seq_file *f) {
435	seq_printf(f, "%*s", n, "");
436}
437
438void hid_dump_field(struct hid_field *field, int n, struct seq_file *f) {
439	int j;
440
441	if (field->physical) {
442		tab(n, f);
443		seq_printf(f, "Physical(");
444		hid_resolv_usage(field->physical, f); seq_printf(f, ")\n");
445	}
446	if (field->logical) {
447		tab(n, f);
448		seq_printf(f, "Logical(");
449		hid_resolv_usage(field->logical, f); seq_printf(f, ")\n");
450	}
451	tab(n, f); seq_printf(f, "Usage(%d)\n", field->maxusage);
452	for (j = 0; j < field->maxusage; j++) {
453		tab(n+2, f); hid_resolv_usage(field->usage[j].hid, f); seq_printf(f, "\n");
454	}
455	if (field->logical_minimum != field->logical_maximum) {
456		tab(n, f); seq_printf(f, "Logical Minimum(%d)\n", field->logical_minimum);
457		tab(n, f); seq_printf(f, "Logical Maximum(%d)\n", field->logical_maximum);
458	}
459	if (field->physical_minimum != field->physical_maximum) {
460		tab(n, f); seq_printf(f, "Physical Minimum(%d)\n", field->physical_minimum);
461		tab(n, f); seq_printf(f, "Physical Maximum(%d)\n", field->physical_maximum);
462	}
463	if (field->unit_exponent) {
464		tab(n, f); seq_printf(f, "Unit Exponent(%d)\n", field->unit_exponent);
465	}
466	if (field->unit) {
467		static const char *systems[5] = { "None", "SI Linear", "SI Rotation", "English Linear", "English Rotation" };
468		static const char *units[5][8] = {
469			{ "None", "None", "None", "None", "None", "None", "None", "None" },
470			{ "None", "Centimeter", "Gram", "Seconds", "Kelvin",     "Ampere", "Candela", "None" },
471			{ "None", "Radians",    "Gram", "Seconds", "Kelvin",     "Ampere", "Candela", "None" },
472			{ "None", "Inch",       "Slug", "Seconds", "Fahrenheit", "Ampere", "Candela", "None" },
473			{ "None", "Degrees",    "Slug", "Seconds", "Fahrenheit", "Ampere", "Candela", "None" }
474		};
475
476		int i;
477		int sys;
478                __u32 data = field->unit;
479
480		/* First nibble tells us which system we're in. */
481		sys = data & 0xf;
482		data >>= 4;
483
484		if(sys > 4) {
485			tab(n, f); seq_printf(f, "Unit(Invalid)\n");
486		}
487		else {
488			int earlier_unit = 0;
489
490			tab(n, f); seq_printf(f, "Unit(%s : ", systems[sys]);
491
492			for (i=1 ; i<sizeof(__u32)*2 ; i++) {
493				char nibble = data & 0xf;
494				data >>= 4;
495				if (nibble != 0) {
496					if(earlier_unit++ > 0)
497						seq_printf(f, "*");
498					seq_printf(f, "%s", units[sys][i]);
499					if(nibble != 1) {
500						/* This is a _signed_ nibble(!) */
501
502						int val = nibble & 0x7;
503						if(nibble & 0x08)
504							val = -((0x7 & ~val) +1);
505						seq_printf(f, "^%d", val);
506					}
507				}
508			}
509			seq_printf(f, ")\n");
510		}
511	}
512	tab(n, f); seq_printf(f, "Report Size(%u)\n", field->report_size);
513	tab(n, f); seq_printf(f, "Report Count(%u)\n", field->report_count);
514	tab(n, f); seq_printf(f, "Report Offset(%u)\n", field->report_offset);
515
516	tab(n, f); seq_printf(f, "Flags( ");
517	j = field->flags;
518	seq_printf(f, "%s", HID_MAIN_ITEM_CONSTANT & j ? "Constant " : "");
519	seq_printf(f, "%s", HID_MAIN_ITEM_VARIABLE & j ? "Variable " : "Array ");
520	seq_printf(f, "%s", HID_MAIN_ITEM_RELATIVE & j ? "Relative " : "Absolute ");
521	seq_printf(f, "%s", HID_MAIN_ITEM_WRAP & j ? "Wrap " : "");
522	seq_printf(f, "%s", HID_MAIN_ITEM_NONLINEAR & j ? "NonLinear " : "");
523	seq_printf(f, "%s", HID_MAIN_ITEM_NO_PREFERRED & j ? "NoPreferredState " : "");
524	seq_printf(f, "%s", HID_MAIN_ITEM_NULL_STATE & j ? "NullState " : "");
525	seq_printf(f, "%s", HID_MAIN_ITEM_VOLATILE & j ? "Volatile " : "");
526	seq_printf(f, "%s", HID_MAIN_ITEM_BUFFERED_BYTE & j ? "BufferedByte " : "");
527	seq_printf(f, ")\n");
528}
529EXPORT_SYMBOL_GPL(hid_dump_field);
530
531void hid_dump_device(struct hid_device *device, struct seq_file *f)
532{
533	struct hid_report_enum *report_enum;
534	struct hid_report *report;
535	struct list_head *list;
536	unsigned i,k;
537	static const char *table[] = {"INPUT", "OUTPUT", "FEATURE"};
538
539	for (i = 0; i < HID_REPORT_TYPES; i++) {
540		report_enum = device->report_enum + i;
541		list = report_enum->report_list.next;
542		while (list != &report_enum->report_list) {
543			report = (struct hid_report *) list;
544			tab(2, f);
545			seq_printf(f, "%s", table[i]);
546			if (report->id)
547				seq_printf(f, "(%d)", report->id);
548			seq_printf(f, "[%s]", table[report->type]);
549			seq_printf(f, "\n");
550			for (k = 0; k < report->maxfield; k++) {
551				tab(4, f);
552				seq_printf(f, "Field(%d)\n", k);
553				hid_dump_field(report->field[k], 6, f);
554			}
555			list = list->next;
556		}
557	}
558}
559EXPORT_SYMBOL_GPL(hid_dump_device);
560
561/* enqueue string to 'events' ring buffer */
562void hid_debug_event(struct hid_device *hdev, char *buf)
563{
564	int i;
565	struct hid_debug_list *list;
566
567	list_for_each_entry(list, &hdev->debug_list, node) {
568		for (i = 0; i < strlen(buf); i++)
569			list->hid_debug_buf[(list->tail + i) % HID_DEBUG_BUFSIZE] =
570				buf[i];
571		list->tail = (list->tail + i) % HID_DEBUG_BUFSIZE;
572        }
573}
574EXPORT_SYMBOL_GPL(hid_debug_event);
575
576void hid_dump_input(struct hid_device *hdev, struct hid_usage *usage, __s32 value)
577{
578	char *buf;
579	int len;
580
581	buf = hid_resolv_usage(usage->hid, NULL);
582	if (!buf)
583		return;
584	len = strlen(buf);
585	snprintf(buf + len, HID_DEBUG_BUFSIZE - len - 1, " = %d\n", value);
586
587	hid_debug_event(hdev, buf);
588
589	kfree(buf);
590        wake_up_interruptible(&hdev->debug_wait);
591
592}
593EXPORT_SYMBOL_GPL(hid_dump_input);
594
595static const char *events[EV_MAX + 1] = {
596	[EV_SYN] = "Sync",			[EV_KEY] = "Key",
597	[EV_REL] = "Relative",			[EV_ABS] = "Absolute",
598	[EV_MSC] = "Misc",			[EV_LED] = "LED",
599	[EV_SND] = "Sound",			[EV_REP] = "Repeat",
600	[EV_FF] = "ForceFeedback",		[EV_PWR] = "Power",
601	[EV_FF_STATUS] = "ForceFeedbackStatus",
602};
603
604static const char *syncs[3] = {
605	[SYN_REPORT] = "Report",		[SYN_CONFIG] = "Config",
606	[SYN_MT_REPORT] = "MT Report",
607};
608
609static const char *keys[KEY_MAX + 1] = {
610	[KEY_RESERVED] = "Reserved",		[KEY_ESC] = "Esc",
611	[KEY_1] = "1",				[KEY_2] = "2",
612	[KEY_3] = "3",				[KEY_4] = "4",
613	[KEY_5] = "5",				[KEY_6] = "6",
614	[KEY_7] = "7",				[KEY_8] = "8",
615	[KEY_9] = "9",				[KEY_0] = "0",
616	[KEY_MINUS] = "Minus",			[KEY_EQUAL] = "Equal",
617	[KEY_BACKSPACE] = "Backspace",		[KEY_TAB] = "Tab",
618	[KEY_Q] = "Q",				[KEY_W] = "W",
619	[KEY_E] = "E",				[KEY_R] = "R",
620	[KEY_T] = "T",				[KEY_Y] = "Y",
621	[KEY_U] = "U",				[KEY_I] = "I",
622	[KEY_O] = "O",				[KEY_P] = "P",
623	[KEY_LEFTBRACE] = "LeftBrace",		[KEY_RIGHTBRACE] = "RightBrace",
624	[KEY_ENTER] = "Enter",			[KEY_LEFTCTRL] = "LeftControl",
625	[KEY_A] = "A",				[KEY_S] = "S",
626	[KEY_D] = "D",				[KEY_F] = "F",
627	[KEY_G] = "G",				[KEY_H] = "H",
628	[KEY_J] = "J",				[KEY_K] = "K",
629	[KEY_L] = "L",				[KEY_SEMICOLON] = "Semicolon",
630	[KEY_APOSTROPHE] = "Apostrophe",	[KEY_GRAVE] = "Grave",
631	[KEY_LEFTSHIFT] = "LeftShift",		[KEY_BACKSLASH] = "BackSlash",
632	[KEY_Z] = "Z",				[KEY_X] = "X",
633	[KEY_C] = "C",				[KEY_V] = "V",
634	[KEY_B] = "B",				[KEY_N] = "N",
635	[KEY_M] = "M",				[KEY_COMMA] = "Comma",
636	[KEY_DOT] = "Dot",			[KEY_SLASH] = "Slash",
637	[KEY_RIGHTSHIFT] = "RightShift",	[KEY_KPASTERISK] = "KPAsterisk",
638	[KEY_LEFTALT] = "LeftAlt",		[KEY_SPACE] = "Space",
639	[KEY_CAPSLOCK] = "CapsLock",		[KEY_F1] = "F1",
640	[KEY_F2] = "F2",			[KEY_F3] = "F3",
641	[KEY_F4] = "F4",			[KEY_F5] = "F5",
642	[KEY_F6] = "F6",			[KEY_F7] = "F7",
643	[KEY_F8] = "F8",			[KEY_F9] = "F9",
644	[KEY_F10] = "F10",			[KEY_NUMLOCK] = "NumLock",
645	[KEY_SCROLLLOCK] = "ScrollLock",	[KEY_KP7] = "KP7",
646	[KEY_KP8] = "KP8",			[KEY_KP9] = "KP9",
647	[KEY_KPMINUS] = "KPMinus",		[KEY_KP4] = "KP4",
648	[KEY_KP5] = "KP5",			[KEY_KP6] = "KP6",
649	[KEY_KPPLUS] = "KPPlus",		[KEY_KP1] = "KP1",
650	[KEY_KP2] = "KP2",			[KEY_KP3] = "KP3",
651	[KEY_KP0] = "KP0",			[KEY_KPDOT] = "KPDot",
652	[KEY_ZENKAKUHANKAKU] = "Zenkaku/Hankaku", [KEY_102ND] = "102nd",
653	[KEY_F11] = "F11",			[KEY_F12] = "F12",
654	[KEY_RO] = "RO",			[KEY_KATAKANA] = "Katakana",
655	[KEY_HIRAGANA] = "HIRAGANA",		[KEY_HENKAN] = "Henkan",
656	[KEY_KATAKANAHIRAGANA] = "Katakana/Hiragana", [KEY_MUHENKAN] = "Muhenkan",
657	[KEY_KPJPCOMMA] = "KPJpComma",		[KEY_KPENTER] = "KPEnter",
658	[KEY_RIGHTCTRL] = "RightCtrl",		[KEY_KPSLASH] = "KPSlash",
659	[KEY_SYSRQ] = "SysRq",			[KEY_RIGHTALT] = "RightAlt",
660	[KEY_LINEFEED] = "LineFeed",		[KEY_HOME] = "Home",
661	[KEY_UP] = "Up",			[KEY_PAGEUP] = "PageUp",
662	[KEY_LEFT] = "Left",			[KEY_RIGHT] = "Right",
663	[KEY_END] = "End",			[KEY_DOWN] = "Down",
664	[KEY_PAGEDOWN] = "PageDown",		[KEY_INSERT] = "Insert",
665	[KEY_DELETE] = "Delete",		[KEY_MACRO] = "Macro",
666	[KEY_MUTE] = "Mute",			[KEY_VOLUMEDOWN] = "VolumeDown",
667	[KEY_VOLUMEUP] = "VolumeUp",		[KEY_POWER] = "Power",
668	[KEY_KPEQUAL] = "KPEqual",		[KEY_KPPLUSMINUS] = "KPPlusMinus",
669	[KEY_PAUSE] = "Pause",			[KEY_KPCOMMA] = "KPComma",
670	[KEY_HANGUEL] = "Hangeul",		[KEY_HANJA] = "Hanja",
671	[KEY_YEN] = "Yen",			[KEY_LEFTMETA] = "LeftMeta",
672	[KEY_RIGHTMETA] = "RightMeta",		[KEY_COMPOSE] = "Compose",
673	[KEY_STOP] = "Stop",			[KEY_AGAIN] = "Again",
674	[KEY_PROPS] = "Props",			[KEY_UNDO] = "Undo",
675	[KEY_FRONT] = "Front",			[KEY_COPY] = "Copy",
676	[KEY_OPEN] = "Open",			[KEY_PASTE] = "Paste",
677	[KEY_FIND] = "Find",			[KEY_CUT] = "Cut",
678	[KEY_HELP] = "Help",			[KEY_MENU] = "Menu",
679	[KEY_CALC] = "Calc",			[KEY_SETUP] = "Setup",
680	[KEY_SLEEP] = "Sleep",			[KEY_WAKEUP] = "WakeUp",
681	[KEY_FILE] = "File",			[KEY_SENDFILE] = "SendFile",
682	[KEY_DELETEFILE] = "DeleteFile",	[KEY_XFER] = "X-fer",
683	[KEY_PROG1] = "Prog1",			[KEY_PROG2] = "Prog2",
684	[KEY_WWW] = "WWW",			[KEY_MSDOS] = "MSDOS",
685	[KEY_COFFEE] = "Coffee",		[KEY_DIRECTION] = "Direction",
686	[KEY_CYCLEWINDOWS] = "CycleWindows",	[KEY_MAIL] = "Mail",
687	[KEY_BOOKMARKS] = "Bookmarks",		[KEY_COMPUTER] = "Computer",
688	[KEY_BACK] = "Back",			[KEY_FORWARD] = "Forward",
689	[KEY_CLOSECD] = "CloseCD",		[KEY_EJECTCD] = "EjectCD",
690	[KEY_EJECTCLOSECD] = "EjectCloseCD",	[KEY_NEXTSONG] = "NextSong",
691	[KEY_PLAYPAUSE] = "PlayPause",		[KEY_PREVIOUSSONG] = "PreviousSong",
692	[KEY_STOPCD] = "StopCD",		[KEY_RECORD] = "Record",
693	[KEY_REWIND] = "Rewind",		[KEY_PHONE] = "Phone",
694	[KEY_ISO] = "ISOKey",			[KEY_CONFIG] = "Config",
695	[KEY_HOMEPAGE] = "HomePage",		[KEY_REFRESH] = "Refresh",
696	[KEY_EXIT] = "Exit",			[KEY_MOVE] = "Move",
697	[KEY_EDIT] = "Edit",			[KEY_SCROLLUP] = "ScrollUp",
698	[KEY_SCROLLDOWN] = "ScrollDown",	[KEY_KPLEFTPAREN] = "KPLeftParenthesis",
699	[KEY_KPRIGHTPAREN] = "KPRightParenthesis", [KEY_NEW] = "New",
700	[KEY_REDO] = "Redo",			[KEY_F13] = "F13",
701	[KEY_F14] = "F14",			[KEY_F15] = "F15",
702	[KEY_F16] = "F16",			[KEY_F17] = "F17",
703	[KEY_F18] = "F18",			[KEY_F19] = "F19",
704	[KEY_F20] = "F20",			[KEY_F21] = "F21",
705	[KEY_F22] = "F22",			[KEY_F23] = "F23",
706	[KEY_F24] = "F24",			[KEY_PLAYCD] = "PlayCD",
707	[KEY_PAUSECD] = "PauseCD",		[KEY_PROG3] = "Prog3",
708	[KEY_PROG4] = "Prog4",			[KEY_SUSPEND] = "Suspend",
709	[KEY_CLOSE] = "Close",			[KEY_PLAY] = "Play",
710	[KEY_FASTFORWARD] = "FastForward",	[KEY_BASSBOOST] = "BassBoost",
711	[KEY_PRINT] = "Print",			[KEY_HP] = "HP",
712	[KEY_CAMERA] = "Camera",		[KEY_SOUND] = "Sound",
713	[KEY_QUESTION] = "Question",		[KEY_EMAIL] = "Email",
714	[KEY_CHAT] = "Chat",			[KEY_SEARCH] = "Search",
715	[KEY_CONNECT] = "Connect",		[KEY_FINANCE] = "Finance",
716	[KEY_SPORT] = "Sport",			[KEY_SHOP] = "Shop",
717	[KEY_ALTERASE] = "AlternateErase",	[KEY_CANCEL] = "Cancel",
718	[KEY_BRIGHTNESSDOWN] = "BrightnessDown", [KEY_BRIGHTNESSUP] = "BrightnessUp",
719	[KEY_MEDIA] = "Media",			[KEY_UNKNOWN] = "Unknown",
720	[BTN_0] = "Btn0",			[BTN_1] = "Btn1",
721	[BTN_2] = "Btn2",			[BTN_3] = "Btn3",
722	[BTN_4] = "Btn4",			[BTN_5] = "Btn5",
723	[BTN_6] = "Btn6",			[BTN_7] = "Btn7",
724	[BTN_8] = "Btn8",			[BTN_9] = "Btn9",
725	[BTN_LEFT] = "LeftBtn",			[BTN_RIGHT] = "RightBtn",
726	[BTN_MIDDLE] = "MiddleBtn",		[BTN_SIDE] = "SideBtn",
727	[BTN_EXTRA] = "ExtraBtn",		[BTN_FORWARD] = "ForwardBtn",
728	[BTN_BACK] = "BackBtn",			[BTN_TASK] = "TaskBtn",
729	[BTN_TRIGGER] = "Trigger",		[BTN_THUMB] = "ThumbBtn",
730	[BTN_THUMB2] = "ThumbBtn2",		[BTN_TOP] = "TopBtn",
731	[BTN_TOP2] = "TopBtn2",			[BTN_PINKIE] = "PinkieBtn",
732	[BTN_BASE] = "BaseBtn",			[BTN_BASE2] = "BaseBtn2",
733	[BTN_BASE3] = "BaseBtn3",		[BTN_BASE4] = "BaseBtn4",
734	[BTN_BASE5] = "BaseBtn5",		[BTN_BASE6] = "BaseBtn6",
735	[BTN_DEAD] = "BtnDead",			[BTN_A] = "BtnA",
736	[BTN_B] = "BtnB",			[BTN_C] = "BtnC",
737	[BTN_X] = "BtnX",			[BTN_Y] = "BtnY",
738	[BTN_Z] = "BtnZ",			[BTN_TL] = "BtnTL",
739	[BTN_TR] = "BtnTR",			[BTN_TL2] = "BtnTL2",
740	[BTN_TR2] = "BtnTR2",			[BTN_SELECT] = "BtnSelect",
741	[BTN_START] = "BtnStart",		[BTN_MODE] = "BtnMode",
742	[BTN_THUMBL] = "BtnThumbL",		[BTN_THUMBR] = "BtnThumbR",
743	[BTN_TOOL_PEN] = "ToolPen",		[BTN_TOOL_RUBBER] = "ToolRubber",
744	[BTN_TOOL_BRUSH] = "ToolBrush",		[BTN_TOOL_PENCIL] = "ToolPencil",
745	[BTN_TOOL_AIRBRUSH] = "ToolAirbrush",	[BTN_TOOL_FINGER] = "ToolFinger",
746	[BTN_TOOL_MOUSE] = "ToolMouse",		[BTN_TOOL_LENS] = "ToolLens",
747	[BTN_TOUCH] = "Touch",			[BTN_STYLUS] = "Stylus",
748	[BTN_STYLUS2] = "Stylus2",		[BTN_TOOL_DOUBLETAP] = "ToolDoubleTap",
749	[BTN_TOOL_TRIPLETAP] = "ToolTripleTap", [BTN_GEAR_DOWN] = "WheelBtn",
750	[BTN_GEAR_UP] = "Gear up",		[KEY_OK] = "Ok",
751	[KEY_SELECT] = "Select",		[KEY_GOTO] = "Goto",
752	[KEY_CLEAR] = "Clear",			[KEY_POWER2] = "Power2",
753	[KEY_OPTION] = "Option",		[KEY_INFO] = "Info",
754	[KEY_TIME] = "Time",			[KEY_VENDOR] = "Vendor",
755	[KEY_ARCHIVE] = "Archive",		[KEY_PROGRAM] = "Program",
756	[KEY_CHANNEL] = "Channel",		[KEY_FAVORITES] = "Favorites",
757	[KEY_EPG] = "EPG",			[KEY_PVR] = "PVR",
758	[KEY_MHP] = "MHP",			[KEY_LANGUAGE] = "Language",
759	[KEY_TITLE] = "Title",			[KEY_SUBTITLE] = "Subtitle",
760	[KEY_ANGLE] = "Angle",			[KEY_ZOOM] = "Zoom",
761	[KEY_MODE] = "Mode",			[KEY_KEYBOARD] = "Keyboard",
762	[KEY_SCREEN] = "Screen",		[KEY_PC] = "PC",
763	[KEY_TV] = "TV",			[KEY_TV2] = "TV2",
764	[KEY_VCR] = "VCR",			[KEY_VCR2] = "VCR2",
765	[KEY_SAT] = "Sat",			[KEY_SAT2] = "Sat2",
766	[KEY_CD] = "CD",			[KEY_TAPE] = "Tape",
767	[KEY_RADIO] = "Radio",			[KEY_TUNER] = "Tuner",
768	[KEY_PLAYER] = "Player",		[KEY_TEXT] = "Text",
769	[KEY_DVD] = "DVD",			[KEY_AUX] = "Aux",
770	[KEY_MP3] = "MP3",			[KEY_AUDIO] = "Audio",
771	[KEY_VIDEO] = "Video",			[KEY_DIRECTORY] = "Directory",
772	[KEY_LIST] = "List",			[KEY_MEMO] = "Memo",
773	[KEY_CALENDAR] = "Calendar",		[KEY_RED] = "Red",
774	[KEY_GREEN] = "Green",			[KEY_YELLOW] = "Yellow",
775	[KEY_BLUE] = "Blue",			[KEY_CHANNELUP] = "ChannelUp",
776	[KEY_CHANNELDOWN] = "ChannelDown",	[KEY_FIRST] = "First",
777	[KEY_LAST] = "Last",			[KEY_AB] = "AB",
778	[KEY_NEXT] = "Next",			[KEY_RESTART] = "Restart",
779	[KEY_SLOW] = "Slow",			[KEY_SHUFFLE] = "Shuffle",
780	[KEY_BREAK] = "Break",			[KEY_PREVIOUS] = "Previous",
781	[KEY_DIGITS] = "Digits",		[KEY_TEEN] = "TEEN",
782	[KEY_TWEN] = "TWEN",			[KEY_DEL_EOL] = "DeleteEOL",
783	[KEY_DEL_EOS] = "DeleteEOS",		[KEY_INS_LINE] = "InsertLine",
784	[KEY_DEL_LINE] = "DeleteLine",
785	[KEY_SEND] = "Send",			[KEY_REPLY] = "Reply",
786	[KEY_FORWARDMAIL] = "ForwardMail",	[KEY_SAVE] = "Save",
787	[KEY_DOCUMENTS] = "Documents",		[KEY_SPELLCHECK] = "SpellCheck",
788	[KEY_LOGOFF] = "Logoff",
789	[KEY_FN] = "Fn",			[KEY_FN_ESC] = "Fn+ESC",
790	[KEY_FN_1] = "Fn+1",			[KEY_FN_2] = "Fn+2",
791	[KEY_FN_B] = "Fn+B",			[KEY_FN_D] = "Fn+D",
792	[KEY_FN_E] = "Fn+E",			[KEY_FN_F] = "Fn+F",
793	[KEY_FN_S] = "Fn+S",
794	[KEY_FN_F1] = "Fn+F1",			[KEY_FN_F2] = "Fn+F2",
795	[KEY_FN_F3] = "Fn+F3",			[KEY_FN_F4] = "Fn+F4",
796	[KEY_FN_F5] = "Fn+F5",			[KEY_FN_F6] = "Fn+F6",
797	[KEY_FN_F7] = "Fn+F7",			[KEY_FN_F8] = "Fn+F8",
798	[KEY_FN_F9] = "Fn+F9",			[KEY_FN_F10] = "Fn+F10",
799	[KEY_FN_F11] = "Fn+F11",		[KEY_FN_F12] = "Fn+F12",
800	[KEY_KBDILLUMTOGGLE] = "KbdIlluminationToggle",
801	[KEY_KBDILLUMDOWN] = "KbdIlluminationDown",
802	[KEY_KBDILLUMUP] = "KbdIlluminationUp",
803	[KEY_SWITCHVIDEOMODE] = "SwitchVideoMode",
804};
805
806static const char *relatives[REL_MAX + 1] = {
807	[REL_X] = "X",			[REL_Y] = "Y",
808	[REL_Z] = "Z",			[REL_RX] = "Rx",
809	[REL_RY] = "Ry",		[REL_RZ] = "Rz",
810	[REL_HWHEEL] = "HWheel",	[REL_DIAL] = "Dial",
811	[REL_WHEEL] = "Wheel",		[REL_MISC] = "Misc",
812};
813
814static const char *absolutes[ABS_MAX + 1] = {
815	[ABS_X] = "X",			[ABS_Y] = "Y",
816	[ABS_Z] = "Z",			[ABS_RX] = "Rx",
817	[ABS_RY] = "Ry",		[ABS_RZ] = "Rz",
818	[ABS_THROTTLE] = "Throttle",	[ABS_RUDDER] = "Rudder",
819	[ABS_WHEEL] = "Wheel",		[ABS_GAS] = "Gas",
820	[ABS_BRAKE] = "Brake",		[ABS_HAT0X] = "Hat0X",
821	[ABS_HAT0Y] = "Hat0Y",		[ABS_HAT1X] = "Hat1X",
822	[ABS_HAT1Y] = "Hat1Y",		[ABS_HAT2X] = "Hat2X",
823	[ABS_HAT2Y] = "Hat2Y",		[ABS_HAT3X] = "Hat3X",
824	[ABS_HAT3Y] = "Hat 3Y",		[ABS_PRESSURE] = "Pressure",
825	[ABS_DISTANCE] = "Distance",	[ABS_TILT_X] = "XTilt",
826	[ABS_TILT_Y] = "YTilt",		[ABS_TOOL_WIDTH] = "ToolWidth",
827	[ABS_VOLUME] = "Volume",	[ABS_MISC] = "Misc",
828	[ABS_MT_TOUCH_MAJOR] = "MTMajor",
829	[ABS_MT_TOUCH_MINOR] = "MTMinor",
830	[ABS_MT_WIDTH_MAJOR] = "MTMajorW",
831	[ABS_MT_WIDTH_MINOR] = "MTMinorW",
832	[ABS_MT_ORIENTATION] = "MTOrientation",
833	[ABS_MT_POSITION_X] = "MTPositionX",
834	[ABS_MT_POSITION_Y] = "MTPositionY",
835	[ABS_MT_TOOL_TYPE] = "MTToolType",
836	[ABS_MT_BLOB_ID] = "MTBlobID",
837};
838
839static const char *misc[MSC_MAX + 1] = {
840	[MSC_SERIAL] = "Serial",	[MSC_PULSELED] = "Pulseled",
841	[MSC_GESTURE] = "Gesture",	[MSC_RAW] = "RawData"
842};
843
844static const char *leds[LED_MAX + 1] = {
845	[LED_NUML] = "NumLock",		[LED_CAPSL] = "CapsLock",
846	[LED_SCROLLL] = "ScrollLock",	[LED_COMPOSE] = "Compose",
847	[LED_KANA] = "Kana",		[LED_SLEEP] = "Sleep",
848	[LED_SUSPEND] = "Suspend",	[LED_MUTE] = "Mute",
849	[LED_MISC] = "Misc",
850};
851
852static const char *repeats[REP_MAX + 1] = {
853	[REP_DELAY] = "Delay",		[REP_PERIOD] = "Period"
854};
855
856static const char *sounds[SND_MAX + 1] = {
857	[SND_CLICK] = "Click",		[SND_BELL] = "Bell",
858	[SND_TONE] = "Tone"
859};
860
861static const char **names[EV_MAX + 1] = {
862	[EV_SYN] = syncs,			[EV_KEY] = keys,
863	[EV_REL] = relatives,			[EV_ABS] = absolutes,
864	[EV_MSC] = misc,			[EV_LED] = leds,
865	[EV_SND] = sounds,			[EV_REP] = repeats,
866};
867
868static void hid_resolv_event(__u8 type, __u16 code, struct seq_file *f)
869{
870	seq_printf(f, "%s.%s", events[type] ? events[type] : "?",
871		names[type] ? (names[type][code] ? names[type][code] : "?") : "?");
872}
873
874static void hid_dump_input_mapping(struct hid_device *hid, struct seq_file *f)
875{
876	int i, j, k;
877	struct hid_report *report;
878	struct hid_usage *usage;
879
880	for (k = HID_INPUT_REPORT; k <= HID_OUTPUT_REPORT; k++) {
881		list_for_each_entry(report, &hid->report_enum[k].report_list, list) {
882			for (i = 0; i < report->maxfield; i++) {
883				for ( j = 0; j < report->field[i]->maxusage; j++) {
884					usage = report->field[i]->usage + j;
885					hid_resolv_usage(usage->hid, f);
886					seq_printf(f, " ---> ");
887					hid_resolv_event(usage->type, usage->code, f);
888					seq_printf(f, "\n");
889				}
890			}
891		}
892	}
893
894}
895
896
897static int hid_debug_rdesc_show(struct seq_file *f, void *p)
898{
899	struct hid_device *hdev = f->private;
900	int i;
901
902	/* dump HID report descriptor */
903	for (i = 0; i < hdev->rsize; i++)
904		seq_printf(f, "%02x ", hdev->rdesc[i]);
905	seq_printf(f, "\n\n");
906
907	/* dump parsed data and input mappings */
908	hid_dump_device(hdev, f);
909	seq_printf(f, "\n");
910	hid_dump_input_mapping(hdev, f);
911
912	return 0;
913}
914
915static int hid_debug_rdesc_open(struct inode *inode, struct file *file)
916{
917	return single_open(file, hid_debug_rdesc_show, inode->i_private);
918}
919
920static int hid_debug_events_open(struct inode *inode, struct file *file)
921{
922	int err = 0;
923	struct hid_debug_list *list;
924
925	if (!(list = kzalloc(sizeof(struct hid_debug_list), GFP_KERNEL))) {
926		err = -ENOMEM;
927		goto out;
928	}
929
930	if (!(list->hid_debug_buf = kzalloc(sizeof(char) * HID_DEBUG_BUFSIZE, GFP_KERNEL))) {
931		err = -ENOMEM;
932		kfree(list);
933		goto out;
934	}
935	list->hdev = (struct hid_device *) inode->i_private;
936	file->private_data = list;
937	mutex_init(&list->read_mutex);
938
939	list_add_tail(&list->node, &list->hdev->debug_list);
940
941out:
942	return err;
943}
944
945static ssize_t hid_debug_events_read(struct file *file, char __user *buffer,
946		size_t count, loff_t *ppos)
947{
948	struct hid_debug_list *list = file->private_data;
949	int ret = 0, len;
950	DECLARE_WAITQUEUE(wait, current);
951
952	while (ret == 0) {
953		mutex_lock(&list->read_mutex);
954		if (list->head == list->tail) {
955			add_wait_queue(&list->hdev->debug_wait, &wait);
956			set_current_state(TASK_INTERRUPTIBLE);
957
958			while (list->head == list->tail) {
959				if (file->f_flags & O_NONBLOCK) {
960					ret = -EAGAIN;
961					break;
962				}
963				if (signal_pending(current)) {
964					ret = -ERESTARTSYS;
965					break;
966				}
967
968				if (!list->hdev || !list->hdev->debug) {
969					ret = -EIO;
970					break;
971				}
972
973				/* allow O_NONBLOCK from other threads */
974				mutex_unlock(&list->read_mutex);
975				schedule();
976				mutex_lock(&list->read_mutex);
977				set_current_state(TASK_INTERRUPTIBLE);
978			}
979
980			set_current_state(TASK_RUNNING);
981			remove_wait_queue(&list->hdev->debug_wait, &wait);
982		}
983
984		if (ret)
985			goto out;
986
987		/* pass the ringbuffer contents to userspace */
988copy_rest:
989		if (list->tail == list->head)
990			goto out;
991		if (list->tail > list->head) {
992			len = list->tail - list->head;
993
994			if (copy_to_user(buffer + ret, &list->hid_debug_buf[list->head], len)) {
995				ret = -EFAULT;
996				goto out;
997			}
998			ret += len;
999			list->head += len;
1000		} else {
1001			len = HID_DEBUG_BUFSIZE - list->head;
1002
1003			if (copy_to_user(buffer, &list->hid_debug_buf[list->head], len)) {
1004				ret = -EFAULT;
1005				goto out;
1006			}
1007			list->head = 0;
1008			ret += len;
1009			goto copy_rest;
1010		}
1011
1012	}
1013out:
1014	mutex_unlock(&list->read_mutex);
1015	return ret;
1016}
1017
1018static unsigned int hid_debug_events_poll(struct file *file, poll_table *wait)
1019{
1020	struct hid_debug_list *list = file->private_data;
1021
1022	poll_wait(file, &list->hdev->debug_wait, wait);
1023	if (list->head != list->tail)
1024		return POLLIN | POLLRDNORM;
1025	if (!list->hdev->debug)
1026		return POLLERR | POLLHUP;
1027	return 0;
1028}
1029
1030static int hid_debug_events_release(struct inode *inode, struct file *file)
1031{
1032	struct hid_debug_list *list = file->private_data;
1033
1034	list_del(&list->node);
1035	kfree(list->hid_debug_buf);
1036	kfree(list);
1037
1038	return 0;
1039}
1040
1041static const struct file_operations hid_debug_rdesc_fops = {
1042	.open           = hid_debug_rdesc_open,
1043	.read           = seq_read,
1044	.llseek         = seq_lseek,
1045	.release        = single_release,
1046};
1047
1048static const struct file_operations hid_debug_events_fops = {
1049	.owner =        THIS_MODULE,
1050	.open           = hid_debug_events_open,
1051	.read           = hid_debug_events_read,
1052	.poll		= hid_debug_events_poll,
1053	.release        = hid_debug_events_release,
1054};
1055
1056
1057void hid_debug_register(struct hid_device *hdev, const char *name)
1058{
1059	hdev->debug_dir = debugfs_create_dir(name, hid_debug_root);
1060	hdev->debug_rdesc = debugfs_create_file("rdesc", 0400,
1061			hdev->debug_dir, hdev, &hid_debug_rdesc_fops);
1062	hdev->debug_events = debugfs_create_file("events", 0400,
1063			hdev->debug_dir, hdev, &hid_debug_events_fops);
1064	hdev->debug = 1;
1065}
1066
1067void hid_debug_unregister(struct hid_device *hdev)
1068{
1069	hdev->debug = 0;
1070	wake_up_interruptible(&hdev->debug_wait);
1071	debugfs_remove(hdev->debug_rdesc);
1072	debugfs_remove(hdev->debug_events);
1073	debugfs_remove(hdev->debug_dir);
1074}
1075
1076void hid_debug_init(void)
1077{
1078	hid_debug_root = debugfs_create_dir("hid", NULL);
1079}
1080
1081void hid_debug_exit(void)
1082{
1083	debugfs_remove_recursive(hid_debug_root);
1084}
1085
1086