[media] media: rc: document rc class sysfs API
authorJames Hogan <james.hogan@imgtec.com>
Fri, 17 Jan 2014 13:58:46 +0000 (10:58 -0300)
committerMauro Carvalho Chehab <m.chehab@samsung.com>
Tue, 4 Feb 2014 15:10:31 +0000 (13:10 -0200)
Briefly document /sys/class/rc/ API for remote controller devices in
Documentation/ABI/teting.

Signed-off-by: James Hogan <james.hogan@imgtec.com>
Cc: Rob Landley <rob@landley.net>
Signed-off-by: Mauro Carvalho Chehab <m.chehab@samsung.com>
Documentation/ABI/testing/sysfs-class-rc [new file with mode: 0644]

diff --git a/Documentation/ABI/testing/sysfs-class-rc b/Documentation/ABI/testing/sysfs-class-rc
new file mode 100644 (file)
index 0000000..52bc057
--- /dev/null
@@ -0,0 +1,34 @@
+What:          /sys/class/rc/
+Date:          Apr 2010
+KernelVersion: 2.6.35
+Contact:       Mauro Carvalho Chehab <m.chehab@samsung.com>
+Description:
+               The rc/ class sub-directory belongs to the Remote Controller
+               core and provides a sysfs interface for configuring infrared
+               remote controller receivers.
+
+What:          /sys/class/rc/rcN/
+Date:          Apr 2010
+KernelVersion: 2.6.35
+Contact:       Mauro Carvalho Chehab <m.chehab@samsung.com>
+Description:
+               A /sys/class/rc/rcN directory is created for each remote
+               control receiver device where N is the number of the receiver.
+
+What:          /sys/class/rc/rcN/protocols
+Date:          Jun 2010
+KernelVersion: 2.6.36
+Contact:       Mauro Carvalho Chehab <m.chehab@samsung.com>
+Description:
+               Reading this file returns a list of available protocols,
+               something like:
+                   "rc5 [rc6] nec jvc [sony]"
+               Enabled protocols are shown in [] brackets.
+               Writing "+proto" will add a protocol to the list of enabled
+               protocols.
+               Writing "-proto" will remove a protocol from the list of enabled
+               protocols.
+               Writing "proto" will enable only "proto".
+               Writing "none" will disable all protocols.
+               Write fails with EINVAL if an invalid protocol combination or
+               unknown protocol name is used.