diff options
author | Hans Verkuil <hans.verkuil@cisco.com> | 2013-04-06 05:16:58 -0400 |
---|---|---|
committer | Mauro Carvalho Chehab <mchehab@redhat.com> | 2013-04-14 18:47:33 -0400 |
commit | 96b03d2a3078d5e95a8b106634faa7cea88ebe5e (patch) | |
tree | 22f781d017cf9f27fa61a8577d896993a1e82f08 /Documentation/DocBook | |
parent | 0f0fe4b9f6f32b90c82345b97da2977b84e14414 (diff) |
[media] v4l2: rename VIDIOC_DBG_G_CHIP_NAME to _CHIP_INFO
This ioctl will be extended to return more information than just the name.
Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
Diffstat (limited to 'Documentation/DocBook')
-rw-r--r-- | Documentation/DocBook/media/v4l/compat.xml | 2 | ||||
-rw-r--r-- | Documentation/DocBook/media/v4l/v4l2.xml | 4 | ||||
-rw-r--r-- | Documentation/DocBook/media/v4l/vidioc-dbg-g-chip-info.xml (renamed from Documentation/DocBook/media/v4l/vidioc-dbg-g-chip-name.xml) | 20 | ||||
-rw-r--r-- | Documentation/DocBook/media/v4l/vidioc-dbg-g-register.xml | 10 |
4 files changed, 18 insertions, 18 deletions
diff --git a/Documentation/DocBook/media/v4l/compat.xml b/Documentation/DocBook/media/v4l/compat.xml index e44161ffdd07..f43542ae2981 100644 --- a/Documentation/DocBook/media/v4l/compat.xml +++ b/Documentation/DocBook/media/v4l/compat.xml | |||
@@ -2507,7 +2507,7 @@ that used it. It was originally scheduled for removal in 2.6.35. | |||
2507 | </para> | 2507 | </para> |
2508 | </listitem> | 2508 | </listitem> |
2509 | <listitem> | 2509 | <listitem> |
2510 | <para>Added new debugging ioctl &VIDIOC-DBG-G-CHIP-NAME;. | 2510 | <para>Added new debugging ioctl &VIDIOC-DBG-G-CHIP-INFO;. |
2511 | </para> | 2511 | </para> |
2512 | </listitem> | 2512 | </listitem> |
2513 | </orderedlist> | 2513 | </orderedlist> |
diff --git a/Documentation/DocBook/media/v4l/v4l2.xml b/Documentation/DocBook/media/v4l/v4l2.xml index c1f334084213..bfc93cdcf696 100644 --- a/Documentation/DocBook/media/v4l/v4l2.xml +++ b/Documentation/DocBook/media/v4l/v4l2.xml | |||
@@ -147,7 +147,7 @@ applications. --> | |||
147 | <revremark>Remove obsolete and unused DV_PRESET ioctls: | 147 | <revremark>Remove obsolete and unused DV_PRESET ioctls: |
148 | VIDIOC_G_DV_PRESET, VIDIOC_S_DV_PRESET, VIDIOC_QUERY_DV_PRESET and | 148 | VIDIOC_G_DV_PRESET, VIDIOC_S_DV_PRESET, VIDIOC_QUERY_DV_PRESET and |
149 | VIDIOC_ENUM_DV_PRESET. Remove the related v4l2_input/output capability | 149 | VIDIOC_ENUM_DV_PRESET. Remove the related v4l2_input/output capability |
150 | flags V4L2_IN_CAP_PRESETS and V4L2_OUT_CAP_PRESETS. Added VIDIOC_DBG_G_CHIP_NAME. | 150 | flags V4L2_IN_CAP_PRESETS and V4L2_OUT_CAP_PRESETS. Added VIDIOC_DBG_G_CHIP_INFO. |
151 | </revremark> | 151 | </revremark> |
152 | </revision> | 152 | </revision> |
153 | 153 | ||
@@ -548,7 +548,7 @@ and discussions on the V4L mailing list.</revremark> | |||
548 | &sub-create-bufs; | 548 | &sub-create-bufs; |
549 | &sub-cropcap; | 549 | &sub-cropcap; |
550 | &sub-dbg-g-chip-ident; | 550 | &sub-dbg-g-chip-ident; |
551 | &sub-dbg-g-chip-name; | 551 | &sub-dbg-g-chip-info; |
552 | &sub-dbg-g-register; | 552 | &sub-dbg-g-register; |
553 | &sub-decoder-cmd; | 553 | &sub-decoder-cmd; |
554 | &sub-dqevent; | 554 | &sub-dqevent; |
diff --git a/Documentation/DocBook/media/v4l/vidioc-dbg-g-chip-name.xml b/Documentation/DocBook/media/v4l/vidioc-dbg-g-chip-info.xml index fa3bd42ab167..e1cece6c5de1 100644 --- a/Documentation/DocBook/media/v4l/vidioc-dbg-g-chip-name.xml +++ b/Documentation/DocBook/media/v4l/vidioc-dbg-g-chip-info.xml | |||
@@ -1,11 +1,11 @@ | |||
1 | <refentry id="vidioc-dbg-g-chip-name"> | 1 | <refentry id="vidioc-dbg-g-chip-info"> |
2 | <refmeta> | 2 | <refmeta> |
3 | <refentrytitle>ioctl VIDIOC_DBG_G_CHIP_NAME</refentrytitle> | 3 | <refentrytitle>ioctl VIDIOC_DBG_G_CHIP_INFO</refentrytitle> |
4 | &manvol; | 4 | &manvol; |
5 | </refmeta> | 5 | </refmeta> |
6 | 6 | ||
7 | <refnamediv> | 7 | <refnamediv> |
8 | <refname>VIDIOC_DBG_G_CHIP_NAME</refname> | 8 | <refname>VIDIOC_DBG_G_CHIP_INFO</refname> |
9 | <refpurpose>Identify the chips on a TV card</refpurpose> | 9 | <refpurpose>Identify the chips on a TV card</refpurpose> |
10 | </refnamediv> | 10 | </refnamediv> |
11 | 11 | ||
@@ -15,7 +15,7 @@ | |||
15 | <funcdef>int <function>ioctl</function></funcdef> | 15 | <funcdef>int <function>ioctl</function></funcdef> |
16 | <paramdef>int <parameter>fd</parameter></paramdef> | 16 | <paramdef>int <parameter>fd</parameter></paramdef> |
17 | <paramdef>int <parameter>request</parameter></paramdef> | 17 | <paramdef>int <parameter>request</parameter></paramdef> |
18 | <paramdef>struct v4l2_dbg_chip_name | 18 | <paramdef>struct v4l2_dbg_chip_info |
19 | *<parameter>argp</parameter></paramdef> | 19 | *<parameter>argp</parameter></paramdef> |
20 | </funcprototype> | 20 | </funcprototype> |
21 | </funcsynopsis> | 21 | </funcsynopsis> |
@@ -34,7 +34,7 @@ | |||
34 | <varlistentry> | 34 | <varlistentry> |
35 | <term><parameter>request</parameter></term> | 35 | <term><parameter>request</parameter></term> |
36 | <listitem> | 36 | <listitem> |
37 | <para>VIDIOC_DBG_G_CHIP_NAME</para> | 37 | <para>VIDIOC_DBG_G_CHIP_INFO</para> |
38 | </listitem> | 38 | </listitem> |
39 | </varlistentry> | 39 | </varlistentry> |
40 | <varlistentry> | 40 | <varlistentry> |
@@ -69,8 +69,8 @@ so it can be fixed.</para> | |||
69 | <para>To query the driver applications must initialize the | 69 | <para>To query the driver applications must initialize the |
70 | <structfield>match.type</structfield> and | 70 | <structfield>match.type</structfield> and |
71 | <structfield>match.addr</structfield> or <structfield>match.name</structfield> | 71 | <structfield>match.addr</structfield> or <structfield>match.name</structfield> |
72 | fields of a &v4l2-dbg-chip-name; | 72 | fields of a &v4l2-dbg-chip-info; |
73 | and call <constant>VIDIOC_DBG_G_CHIP_NAME</constant> with a pointer to | 73 | and call <constant>VIDIOC_DBG_G_CHIP_INFO</constant> with a pointer to |
74 | this structure. On success the driver stores information about the | 74 | this structure. On success the driver stores information about the |
75 | selected chip in the <structfield>name</structfield> and | 75 | selected chip in the <structfield>name</structfield> and |
76 | <structfield>flags</structfield> fields. On failure the structure | 76 | <structfield>flags</structfield> fields. On failure the structure |
@@ -81,7 +81,7 @@ remains unchanged.</para> | |||
81 | <structfield>match.addr</structfield> selects the nth bridge 'chip' | 81 | <structfield>match.addr</structfield> selects the nth bridge 'chip' |
82 | on the TV card. You can enumerate all chips by starting at zero and | 82 | on the TV card. You can enumerate all chips by starting at zero and |
83 | incrementing <structfield>match.addr</structfield> by one until | 83 | incrementing <structfield>match.addr</structfield> by one until |
84 | <constant>VIDIOC_DBG_G_CHIP_NAME</constant> fails with an &EINVAL;. | 84 | <constant>VIDIOC_DBG_G_CHIP_INFO</constant> fails with an &EINVAL;. |
85 | The number zero always selects the bridge chip itself, ⪚ the chip | 85 | The number zero always selects the bridge chip itself, ⪚ the chip |
86 | connected to the PCI or USB bus. Non-zero numbers identify specific | 86 | connected to the PCI or USB bus. Non-zero numbers identify specific |
87 | parts of the bridge chip such as an AC97 register block.</para> | 87 | parts of the bridge chip such as an AC97 register block.</para> |
@@ -138,8 +138,8 @@ to the <structfield>type</structfield> field.</entry> | |||
138 | </tgroup> | 138 | </tgroup> |
139 | </table> | 139 | </table> |
140 | 140 | ||
141 | <table pgwide="1" frame="none" id="v4l2-dbg-chip-name"> | 141 | <table pgwide="1" frame="none" id="v4l2-dbg-chip-info"> |
142 | <title>struct <structname>v4l2_dbg_chip_name</structname></title> | 142 | <title>struct <structname>v4l2_dbg_chip_info</structname></title> |
143 | <tgroup cols="3"> | 143 | <tgroup cols="3"> |
144 | &cs-str; | 144 | &cs-str; |
145 | <tbody valign="top"> | 145 | <tbody valign="top"> |
diff --git a/Documentation/DocBook/media/v4l/vidioc-dbg-g-register.xml b/Documentation/DocBook/media/v4l/vidioc-dbg-g-register.xml index db7844f2439f..d13bac9e2445 100644 --- a/Documentation/DocBook/media/v4l/vidioc-dbg-g-register.xml +++ b/Documentation/DocBook/media/v4l/vidioc-dbg-g-register.xml | |||
@@ -99,7 +99,7 @@ unchanged.</para> | |||
99 | <structfield>match.addr</structfield> selects the nth non-sub-device chip | 99 | <structfield>match.addr</structfield> selects the nth non-sub-device chip |
100 | on the TV card. The number zero always selects the host chip, ⪚ the | 100 | on the TV card. The number zero always selects the host chip, ⪚ the |
101 | chip connected to the PCI or USB bus. You can find out which chips are | 101 | chip connected to the PCI or USB bus. You can find out which chips are |
102 | present with the &VIDIOC-DBG-G-CHIP-NAME; ioctl.</para> | 102 | present with the &VIDIOC-DBG-G-CHIP-INFO; ioctl.</para> |
103 | 103 | ||
104 | <para>When <structfield>match.type</structfield> is | 104 | <para>When <structfield>match.type</structfield> is |
105 | <constant>V4L2_CHIP_MATCH_I2C_DRIVER</constant>, | 105 | <constant>V4L2_CHIP_MATCH_I2C_DRIVER</constant>, |
@@ -109,7 +109,7 @@ For instance | |||
109 | supported by the saa7127 driver, regardless of its &i2c; bus address. | 109 | supported by the saa7127 driver, regardless of its &i2c; bus address. |
110 | When multiple chips supported by the same driver are present, the | 110 | When multiple chips supported by the same driver are present, the |
111 | effect of these ioctls is undefined. Again with the | 111 | effect of these ioctls is undefined. Again with the |
112 | &VIDIOC-DBG-G-CHIP-NAME; ioctl you can find out which &i2c; chips are | 112 | &VIDIOC-DBG-G-CHIP-INFO; ioctl you can find out which &i2c; chips are |
113 | present.</para> | 113 | present.</para> |
114 | 114 | ||
115 | <para>When <structfield>match.type</structfield> is | 115 | <para>When <structfield>match.type</structfield> is |
@@ -131,14 +131,14 @@ on the TV card.</para> | |||
131 | 131 | ||
132 | <para>Due to a flaw in the Linux &i2c; bus driver these ioctls may | 132 | <para>Due to a flaw in the Linux &i2c; bus driver these ioctls may |
133 | return successfully without actually reading or writing a register. To | 133 | return successfully without actually reading or writing a register. To |
134 | catch the most likely failure we recommend a &VIDIOC-DBG-G-CHIP-NAME; | 134 | catch the most likely failure we recommend a &VIDIOC-DBG-G-CHIP-INFO; |
135 | call confirming the presence of the selected &i2c; chip.</para> | 135 | call confirming the presence of the selected &i2c; chip.</para> |
136 | </note> | 136 | </note> |
137 | 137 | ||
138 | <para>These ioctls are optional, not all drivers may support them. | 138 | <para>These ioctls are optional, not all drivers may support them. |
139 | However when a driver supports these ioctls it must also support | 139 | However when a driver supports these ioctls it must also support |
140 | &VIDIOC-DBG-G-CHIP-NAME;. Conversely it may support | 140 | &VIDIOC-DBG-G-CHIP-INFO;. Conversely it may support |
141 | <constant>VIDIOC_DBG_G_CHIP_NAME</constant> but not these ioctls.</para> | 141 | <constant>VIDIOC_DBG_G_CHIP_INFO</constant> but not these ioctls.</para> |
142 | 142 | ||
143 | <para><constant>VIDIOC_DBG_G_REGISTER</constant> and | 143 | <para><constant>VIDIOC_DBG_G_REGISTER</constant> and |
144 | <constant>VIDIOC_DBG_S_REGISTER</constant> were introduced in Linux | 144 | <constant>VIDIOC_DBG_S_REGISTER</constant> were introduced in Linux |