diff options
author | Markus Heiser | 2016-06-30 15:18:56 +0200 |
---|---|---|
committer | Mauro Carvalho Chehab | 2016-06-30 21:14:52 +0200 |
commit | 5377d91f3e88d5c8da46b1feba78b00d379fb7b6 (patch) | |
tree | e1b42603f4ccab1e027454cf04ebe7ea11bea30f /Documentation/linux_tv/media/v4l/lirc_dev_intro.rst | |
parent | Merge branch 'docs-next' of git://git.lwn.net/linux into devel/docs-next (diff) | |
download | kernel-qcow2-linux-5377d91f3e88d5c8da46b1feba78b00d379fb7b6.tar.gz kernel-qcow2-linux-5377d91f3e88d5c8da46b1feba78b00d379fb7b6.tar.xz kernel-qcow2-linux-5377d91f3e88d5c8da46b1feba78b00d379fb7b6.zip |
doc-rst: linux_tv DocBook to reST migration (docs-next)
This is the restructuredText (reST) migration of the ``media``
DocBook-XML set from the linux_tv project.
Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de>
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Diffstat (limited to 'Documentation/linux_tv/media/v4l/lirc_dev_intro.rst')
-rw-r--r-- | Documentation/linux_tv/media/v4l/lirc_dev_intro.rst | 37 |
1 files changed, 37 insertions, 0 deletions
diff --git a/Documentation/linux_tv/media/v4l/lirc_dev_intro.rst b/Documentation/linux_tv/media/v4l/lirc_dev_intro.rst new file mode 100644 index 000000000000..10d4d9a96b15 --- /dev/null +++ b/Documentation/linux_tv/media/v4l/lirc_dev_intro.rst @@ -0,0 +1,37 @@ +.. -*- coding: utf-8; mode: rst -*- + +.. _lirc_dev_intro: + +************ +Introduction +************ + +The LIRC device interface is a bi-directional interface for transporting +raw IR data between userspace and kernelspace. Fundamentally, it is just +a chardev (/dev/lircX, for X = 0, 1, 2, ...), with a number of standard +struct file_operations defined on it. With respect to transporting raw +IR data to and fro, the essential fops are read, write and ioctl. + +Example dmesg output upon a driver registering w/LIRC: + + $ dmesg |grep lirc_dev + + lirc_dev: IR Remote Control driver registered, major 248 + + rc rc0: lirc_dev: driver ir-lirc-codec (mceusb) registered at minor + = 0 + +What you should see for a chardev: + + $ ls -l /dev/lirc* + + crw-rw---- 1 root root 248, 0 Jul 2 22:20 /dev/lirc0 + + +.. ------------------------------------------------------------------------------ +.. This file was automatically converted from DocBook-XML with the dbxml +.. library (https://github.com/return42/sphkerneldoc). The origin XML comes +.. from the linux kernel, refer to: +.. +.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook +.. ------------------------------------------------------------------------------ |