HID: use debugfs for report dumping descriptor

It is a little bit inconvenient for people who have some non-standard
HID hardware (usually violating the HID specification) to have to
recompile kernel with CONFIG_HID_DEBUG to be able to see kernel's perspective
of the HID report descriptor and observe the parsed events. Plus the messages
are then mixed up inconveniently with the rest of the dmesg stuff.

This patch implements /sys/kernel/debug/hid/<device>/rdesc file, which
represents the kernel's view of report descriptor (both the raw report
descriptor data and parsed contents).

With all the device-specific debug data being available through debugfs, there
is no need for keeping CONFIG_HID_DEBUG, as the 'debug' parameter to the
hid module will now only output only driver-specific debugging options, which has
absolutely minimal memory footprint, just a few error messages and one global
flag (hid_debug).

We use the current set of output formatting functions. The ones that need to be
used both for one-shot rdesc seq_file and also for continuous flow of data
(individual reports, as being sent by the device) distinguish according to the
passed seq_file parameter, and if it is NULL, it still output to kernel ringbuffer,
otherwise the corresponding seq_file is used for output.

The format of the output is preserved.

Signed-off-by: Jiri Kosina <jkosina@suse.cz>

8 files changed, 195 insertions, 122 deletions

diff --git a/drivers/hid/Kconfig b/drivers/hid/Kconfig
index 7e67dcb3d4f6..05950a783560 100644
--- a/drivers/hid/Kconfig
+++ b/drivers/hid/Kconfig
@@ -31,21 +31,6 @@ config HID
 
           If unsure, say Y.
 
-config HID_DEBUG
-        bool "HID debugging support"
-        default y
-        depends on HID
-        ---help---
-        This option lets the HID layer output diagnostics about its internal
-        state, resolve HID usages, dump HID fields, etc. Individual HID drivers
-        use this debugging facility to output information about individual HID
-        devices, etc.
-
-        This feature is useful for those who are either debugging the HID parser
-        or any HID hardware device.
-
-        If unsure, say Y.
-
 config HIDRAW
         bool "/dev/hidraw raw HID device support"
         depends on HID
diff --git a/drivers/hid/Makefile b/drivers/hid/Makefile
index 1f7cb0fd4505..cf3687d1ed63 100644
--- a/drivers/hid/Makefile
+++ b/drivers/hid/Makefile
@@ -3,9 +3,12 @@
 #
 hid-objs                        := hid-core.o hid-input.o
 
+ifdef CONFIG_DEBUG_FS
+        hid-objs                += hid-debug.o
+endif
+
 obj-$(CONFIG_HID)               += hid.o
 
-hid-$(CONFIG_HID_DEBUG)         += hid-debug.o
 hid-$(CONFIG_HIDRAW)            += hidraw.o
 
 hid-logitech-objs               := hid-lg.o
diff --git a/drivers/hid/hid-core.c b/drivers/hid/hid-core.c
index 8551693d645f..d4317db85b54 100644
--- a/drivers/hid/hid-core.c
+++ b/drivers/hid/hid-core.c
@@ -44,12 +44,10 @@
 #define DRIVER_DESC "HID core driver"
 #define DRIVER_LICENSE "GPL"
 
-#ifdef CONFIG_HID_DEBUG
 int hid_debug = 0;
 module_param_named(debug, hid_debug, int, 0600);
 MODULE_PARM_DESC(debug, "HID debugging (0=off, 1=probing info, 2=continuous data dumping)");
 EXPORT_SYMBOL_GPL(hid_debug);
-#endif
 
 /*
  * Register a new report for a device.
@@ -987,7 +985,6 @@ int hid_set_field(struct hid_field *field, unsigned offset, __s32 value)
 
         if (offset >= field->report_count) {
                 dbg_hid("offset (%d) exceeds report_count (%d)\n", offset, field->report_count);
-                hid_dump_field(field, 8);
                 return -1;
         }
         if (field->logical_minimum < 0) {
@@ -1721,6 +1718,8 @@ int hid_add_device(struct hid_device *hdev)
         if (!ret)
                 hdev->status |= HID_STAT_ADDED;
 
+        hid_debug_register(hdev, dev_name(&hdev->dev));
+
         return ret;
 }
 EXPORT_SYMBOL_GPL(hid_add_device);
@@ -1768,6 +1767,7 @@ static void hid_remove_device(struct hid_device *hdev)
 {
         if (hdev->status & HID_STAT_ADDED) {
                 device_del(&hdev->dev);
+                hid_debug_unregister(hdev);
                 hdev->status &= ~HID_STAT_ADDED;
         }
 }
@@ -1843,6 +1843,10 @@ static int __init hid_init(void)
 {
         int ret;
 
+        if (hid_debug)
+                printk(KERN_WARNING "HID: hid_debug parameter has been deprecated. "
+                                "Debugging data are now provided via debugfs\n");
+
         ret = bus_register(&hid_bus_type);
         if (ret) {
                 printk(KERN_ERR "HID: can't register hid bus\n");
@@ -1853,6 +1857,8 @@ static int __init hid_init(void)
         if (ret)
                 goto err_bus;
 
+        hid_debug_init();
+
         return 0;
 err_bus:
         bus_unregister(&hid_bus_type);
@@ -1862,6 +1868,7 @@ err:
 
 static void __exit hid_exit(void)
 {
+        hid_debug_exit();
         hidraw_exit();
         bus_unregister(&hid_bus_type);
 }
diff --git a/drivers/hid/hid-debug.c b/drivers/hid/hid-debug.c
index 47ac1a7d66e1..067e173aa3e4 100644
--- a/drivers/hid/hid-debug.c
+++ b/drivers/hid/hid-debug.c
@@ -1,9 +1,9 @@
 /*
  *  (c) 1999 Andreas Gal                <gal@cs.uni-magdeburg.de>
  *  (c) 2000-2001 Vojtech Pavlik        <vojtech@ucw.cz>
- *  (c) 2007 Jiri Kosina
+ *  (c) 2007-2009 Jiri Kosina
  *
- *  Some debug stuff for the HID parser.
+ *  HID debugging support
  */
 
 /*
@@ -26,9 +26,13 @@
  * Vojtech Pavlik, Simunkova 1594, Prague 8, 182 00 Czech Republic
  */
 
+#include <linux/debugfs.h>
+#include <linux/seq_file.h>
 #include <linux/hid.h>
 #include <linux/hid-debug.h>
 
+static struct dentry *hid_debug_root;
+
 struct hid_usage_entry {
         unsigned  page;
         unsigned  usage;
@@ -331,72 +335,83 @@ static const struct hid_usage_entry hid_usage_table[] = {
   { 0, 0, NULL }
 };
 
-static void resolv_usage_page(unsigned page) {
+static void resolv_usage_page(unsigned page, struct seq_file *f) {
         const struct hid_usage_entry *p;
 
         for (p = hid_usage_table; p->description; p++)
                 if (p->page == page) {
-                        printk("%s", p->description);
+                        if (!f)
+                                printk("%s", p->description);
+                        else
+                                seq_printf(f, "%s", p->description);
                         return;
                 }