diff options
author | Hans Verkuil <hans.verkuil@cisco.com> | 2013-04-06 06:16:58 -0300 |
---|---|---|
committer | Mauro Carvalho Chehab <mchehab@redhat.com> | 2013-04-14 19:47:33 -0300 |
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 e44161ffdd0..f43542ae298 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. </para> </listitem> <listitem> - <para>Added new debugging ioctl &VIDIOC-DBG-G-CHIP-NAME;. + <para>Added new debugging ioctl &VIDIOC-DBG-G-CHIP-INFO;. </para> </listitem> </orderedlist> diff --git a/Documentation/DocBook/media/v4l/v4l2.xml b/Documentation/DocBook/media/v4l/v4l2.xml index c1f33408421..bfc93cdcf69 100644 --- a/Documentation/DocBook/media/v4l/v4l2.xml +++ b/Documentation/DocBook/media/v4l/v4l2.xml @@ -147,7 +147,7 @@ applications. --> <revremark>Remove obsolete and unused DV_PRESET ioctls: VIDIOC_G_DV_PRESET, VIDIOC_S_DV_PRESET, VIDIOC_QUERY_DV_PRESET and VIDIOC_ENUM_DV_PRESET. Remove the related v4l2_input/output capability - flags V4L2_IN_CAP_PRESETS and V4L2_OUT_CAP_PRESETS. Added VIDIOC_DBG_G_CHIP_NAME. + flags V4L2_IN_CAP_PRESETS and V4L2_OUT_CAP_PRESETS. Added VIDIOC_DBG_G_CHIP_INFO. </revremark> </revision> @@ -548,7 +548,7 @@ and discussions on the V4L mailing list.</revremark> &sub-create-bufs; &sub-cropcap; &sub-dbg-g-chip-ident; - &sub-dbg-g-chip-name; + &sub-dbg-g-chip-info; &sub-dbg-g-register; &sub-decoder-cmd; &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 fa3bd42ab16..e1cece6c5de 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 @@ -<refentry id="vidioc-dbg-g-chip-name"> +<refentry id="vidioc-dbg-g-chip-info"> <refmeta> - <refentrytitle>ioctl VIDIOC_DBG_G_CHIP_NAME</refentrytitle> + <refentrytitle>ioctl VIDIOC_DBG_G_CHIP_INFO</refentrytitle> &manvol; </refmeta> <refnamediv> - <refname>VIDIOC_DBG_G_CHIP_NAME</refname> + <refname>VIDIOC_DBG_G_CHIP_INFO</refname> <refpurpose>Identify the chips on a TV card</refpurpose> </refnamediv> @@ -15,7 +15,7 @@ <funcdef>int <function>ioctl</function></funcdef> <paramdef>int <parameter>fd</parameter></paramdef> <paramdef>int <parameter>request</parameter></paramdef> - <paramdef>struct v4l2_dbg_chip_name + <paramdef>struct v4l2_dbg_chip_info *<parameter>argp</parameter></paramdef> </funcprototype> </funcsynopsis> @@ -34,7 +34,7 @@ <varlistentry> <term><parameter>request</parameter></term> <listitem> - <para>VIDIOC_DBG_G_CHIP_NAME</para> + <para>VIDIOC_DBG_G_CHIP_INFO</para> </listitem> </varlistentry> <varlistentry> @@ -69,8 +69,8 @@ so it can be fixed.</para> <para>To query the driver applications must initialize the <structfield>match.type</structfield> and <structfield>match.addr</structfield> or <structfield>match.name</structfield> -fields of a &v4l2-dbg-chip-name; -and call <constant>VIDIOC_DBG_G_CHIP_NAME</constant> with a pointer to +fields of a &v4l2-dbg-chip-info; +and call <constant>VIDIOC_DBG_G_CHIP_INFO</constant> with a pointer to this structure. On success the driver stores information about the selected chip in the <structfield>name</structfield> and <structfield>flags</structfield> fields. On failure the structure @@ -81,7 +81,7 @@ remains unchanged.</para> <structfield>match.addr</structfield> selects the nth bridge 'chip' on the TV card. You can enumerate all chips by starting at zero and incrementing <structfield>match.addr</structfield> by one until -<constant>VIDIOC_DBG_G_CHIP_NAME</constant> fails with an &EINVAL;. +<constant>VIDIOC_DBG_G_CHIP_INFO</constant> fails with an &EINVAL;. The number zero always selects the bridge chip itself, ⪚ the chip connected to the PCI or USB bus. Non-zero numbers identify specific parts of the bridge chip such as an AC97 register block.</para> @@ -138,8 +138,8 @@ to the <structfield>type</structfield> field.</entry> </tgroup> </table> - <table pgwide="1" frame="none" id="v4l2-dbg-chip-name"> - <title>struct <structname>v4l2_dbg_chip_name</structname></title> + <table pgwide="1" frame="none" id="v4l2-dbg-chip-info"> + <title>struct <structname>v4l2_dbg_chip_info</structname></title> <tgroup cols="3"> &cs-str; <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 db7844f2439..d13bac9e244 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> <structfield>match.addr</structfield> selects the nth non-sub-device chip on the TV card. The number zero always selects the host chip, ⪚ the chip connected to the PCI or USB bus. You can find out which chips are -present with the &VIDIOC-DBG-G-CHIP-NAME; ioctl.</para> +present with the &VIDIOC-DBG-G-CHIP-INFO; ioctl.</para> <para>When <structfield>match.type</structfield> is <constant>V4L2_CHIP_MATCH_I2C_DRIVER</constant>, @@ -109,7 +109,7 @@ For instance supported by the saa7127 driver, regardless of its &i2c; bus address. When multiple chips supported by the same driver are present, the effect of these ioctls is undefined. Again with the -&VIDIOC-DBG-G-CHIP-NAME; ioctl you can find out which &i2c; chips are +&VIDIOC-DBG-G-CHIP-INFO; ioctl you can find out which &i2c; chips are present.</para> <para>When <structfield>match.type</structfield> is @@ -131,14 +131,14 @@ on the TV card.</para> <para>Due to a flaw in the Linux &i2c; bus driver these ioctls may return successfully without actually reading or writing a register. To -catch the most likely failure we recommend a &VIDIOC-DBG-G-CHIP-NAME; +catch the most likely failure we recommend a &VIDIOC-DBG-G-CHIP-INFO; call confirming the presence of the selected &i2c; chip.</para> </note> <para>These ioctls are optional, not all drivers may support them. However when a driver supports these ioctls it must also support -&VIDIOC-DBG-G-CHIP-NAME;. Conversely it may support -<constant>VIDIOC_DBG_G_CHIP_NAME</constant> but not these ioctls.</para> +&VIDIOC-DBG-G-CHIP-INFO;. Conversely it may support +<constant>VIDIOC_DBG_G_CHIP_INFO</constant> but not these ioctls.</para> <para><constant>VIDIOC_DBG_G_REGISTER</constant> and <constant>VIDIOC_DBG_S_REGISTER</constant> were introduced in Linux |