drivers/hid/hid-debug.c

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