aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/DocBook/media/v4l/vidioc-g-fmt.xml
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation/DocBook/media/v4l/vidioc-g-fmt.xml')
-rw-r--r--Documentation/DocBook/media/v4l/vidioc-g-fmt.xml13
1 files changed, 7 insertions, 6 deletions
diff --git a/Documentation/DocBook/media/v4l/vidioc-g-fmt.xml b/Documentation/DocBook/media/v4l/vidioc-g-fmt.xml
index 52acff193a6f..ee8f56e1bac0 100644
--- a/Documentation/DocBook/media/v4l/vidioc-g-fmt.xml
+++ b/Documentation/DocBook/media/v4l/vidioc-g-fmt.xml
@@ -81,7 +81,7 @@ the application calls the <constant>VIDIOC_S_FMT</constant> ioctl
81with a pointer to a <structname>v4l2_format</structname> structure 81with a pointer to a <structname>v4l2_format</structname> structure
82the driver checks 82the driver checks
83and adjusts the parameters against hardware abilities. Drivers 83and adjusts the parameters against hardware abilities. Drivers
84should not return an error code unless the input is ambiguous, this is 84should not return an error code unless the <structfield>type</structfield> field is invalid, this is
85a mechanism to fathom device capabilities and to approach parameters 85a mechanism to fathom device capabilities and to approach parameters
86acceptable for both the application and driver. On success the driver 86acceptable for both the application and driver. On success the driver
87may program the hardware, allocate resources and generally prepare for 87may program the hardware, allocate resources and generally prepare for
@@ -107,6 +107,10 @@ disabling I/O or possibly time consuming hardware preparations.
107Although strongly recommended drivers are not required to implement 107Although strongly recommended drivers are not required to implement
108this ioctl.</para> 108this ioctl.</para>
109 109
110 <para>The format as returned by <constant>VIDIOC_TRY_FMT</constant>
111must be identical to what <constant>VIDIOC_S_FMT</constant> returns for
112the same input or output.</para>
113
110 <table pgwide="1" frame="none" id="v4l2-format"> 114 <table pgwide="1" frame="none" id="v4l2-format">
111 <title>struct <structname>v4l2_format</structname></title> 115 <title>struct <structname>v4l2_format</structname></title>
112 <tgroup cols="4"> 116 <tgroup cols="4">
@@ -170,9 +174,7 @@ capture and output devices.</entry>
170 <entry></entry> 174 <entry></entry>
171 <entry>__u8</entry> 175 <entry>__u8</entry>
172 <entry><structfield>raw_data</structfield>[200]</entry> 176 <entry><structfield>raw_data</structfield>[200]</entry>
173 <entry>Place holder for future extensions and custom 177 <entry>Place holder for future extensions.</entry>
174(driver defined) formats with <structfield>type</structfield>
175<constant>V4L2_BUF_TYPE_PRIVATE</constant> and higher.</entry>
176 </row> 178 </row>
177 </tbody> 179 </tbody>
178 </tgroup> 180 </tgroup>
@@ -187,8 +189,7 @@ capture and output devices.</entry>
187 <term><errorcode>EINVAL</errorcode></term> 189 <term><errorcode>EINVAL</errorcode></term>
188 <listitem> 190 <listitem>
189 <para>The &v4l2-format; <structfield>type</structfield> 191 <para>The &v4l2-format; <structfield>type</structfield>
190field is invalid, the requested buffer type not supported, or the 192field is invalid or the requested buffer type not supported.</para>
191format is not supported with this buffer type.</para>
192 </listitem> 193 </listitem>
193 </varlistentry> 194 </varlistentry>
194 </variablelist> 195 </variablelist>