doc-rst: standard: read the example captions
[deliverable/linux.git] / Documentation / linux_tv / media / v4l / lirc_dev_intro.rst
1 .. -*- coding: utf-8; mode: rst -*-
2
3 .. _lirc_dev_intro:
4
5 ************
6 Introduction
7 ************
8
9 The LIRC device interface is a bi-directional interface for transporting
10 raw IR data between userspace and kernelspace. Fundamentally, it is just
11 a chardev (/dev/lircX, for X = 0, 1, 2, ...), with a number of standard
12 struct file_operations defined on it. With respect to transporting raw
13 IR data to and fro, the essential fops are read, write and ioctl.
14
15 Example dmesg output upon a driver registering w/LIRC:
16
17 $ dmesg |grep lirc_dev
18
19 lirc_dev: IR Remote Control driver registered, major 248
20
21 rc rc0: lirc_dev: driver ir-lirc-codec (mceusb) registered at minor
22 = 0
23
24 What you should see for a chardev:
25
26 $ ls -l /dev/lirc*
27
28 crw-rw---- 1 root root 248, 0 Jul 2 22:20 /dev/lirc0
29
30
31 .. ------------------------------------------------------------------------------
32 .. This file was automatically converted from DocBook-XML with the dbxml
33 .. library (https://github.com/return42/sphkerneldoc). The origin XML comes
34 .. from the linux kernel, refer to:
35 ..
36 .. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
37 .. ------------------------------------------------------------------------------
This page took 0.038922 seconds and 5 git commands to generate.