Merge branch 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/jikos/hid
[cascardo/linux.git] / Documentation / media / uapi / v4l / vidioc-log-status.rst
1 .. -*- coding: utf-8; mode: rst -*-
2
3 .. _VIDIOC_LOG_STATUS:
4
5 ***********************
6 ioctl VIDIOC_LOG_STATUS
7 ***********************
8
9 Name
10 ====
11
12 VIDIOC_LOG_STATUS - Log driver status information
13
14
15 Synopsis
16 ========
17
18 .. c:function:: int ioctl( int fd, VIDIOC_LOG_STATUS)
19     :name: VIDIOC_LOG_STATUS
20
21
22 Arguments
23 =========
24
25 ``fd``
26     File descriptor returned by :ref:`open() <func-open>`.
27
28
29 Description
30 ===========
31
32 As the video/audio devices become more complicated it becomes harder to
33 debug problems. When this ioctl is called the driver will output the
34 current device status to the kernel log. This is particular useful when
35 dealing with problems like no sound, no video and incorrectly tuned
36 channels. Also many modern devices autodetect video and audio standards
37 and this ioctl will report what the device thinks what the standard is.
38 Mismatches may give an indication where the problem is.
39
40 This ioctl is optional and not all drivers support it. It was introduced
41 in Linux 2.6.15.
42
43
44 Return Value
45 ============
46
47 On success 0 is returned, on error -1 and the ``errno`` variable is set
48 appropriately. The generic error codes are described at the
49 :ref:`Generic Error Codes <gen-errors>` chapter.