History

[media] v4l: Clean up sub-device format documentation

The sub-device format documentation documented scaling configuration through formats. Instead the compose selection rectangle is elsewhere documented to be used for the purpose. Remove scaling related part of the documentation.

Sakari Ailus committed 12 years ago

Commit 6936d741 parent e8bd8881 file · +63 −46Browse files

Unified · Split

Documentation/DocBook/media/v4l/dev-subdev.xml+63−46
@@ -195,53 +195,59 @@ · 194 unmodified lines
195 <title>Sample Pipeline Configuration</title>195 <title>Sample Pipeline Configuration</title>
196 <tgroup cols="3">196 <tgroup cols="3">
197 <colspec colname="what"/>197 <colspec colname="what"/>
198 <colspec colname="sensor-0" />198 <colspec colname="sensor-0 format" />
199 <colspec colname="frontend-0" />199 <colspec colname="frontend-0 format" />
200 <colspec colname="frontend-1" />200 <colspec colname="frontend-1 format" />
201 <colspec colname="scaler-0" />201 <colspec colname="scaler-0 format" />
202 <colspec colname="scaler-1" />202 <colspec colname="scaler-0 compose" />
203 <colspec colname="scaler-1 format" />
203 <thead>204 <thead>
204 <row>205 <row>
205 <entry></entry>206 <entry></entry>
206 <entry>Sensor/0</entry>207 <entry>Sensor/0 format</entry>
207 <entry>Frontend/0</entry>208 <entry>Frontend/0 format</entry>
208 <entry>Frontend/1</entry>209 <entry>Frontend/1 format</entry>
209 <entry>Scaler/0</entry>210 <entry>Scaler/0 format</entry>
210 <entry>Scaler/1</entry>211 <entry>Scaler/0 compose selection rectangle</entry>
212 <entry>Scaler/1 format</entry>
211 </row>213 </row>
212 </thead>214 </thead>
213 <tbody valign="top">215 <tbody valign="top">
214 <row>216 <row>
215 <entry>Initial state</entry>217 <entry>Initial state</entry>
216 <entry>2048x1536</entry>218 <entry>2048x1536/SGRBG8_1X8</entry>
217 <entry>-</entry>219 <entry>(default)</entry>
218 <entry>-</entry>220 <entry>(default)</entry>
219 <entry>-</entry>221 <entry>(default)</entry>
220 <entry>-</entry>222 <entry>(default)</entry>
223 <entry>(default)</entry>
221 </row>224 </row>
222 <row>225 <row>
223 <entry>Configure frontend input</entry>226 <entry>Configure frontend sink format</entry>
224 <entry>2048x1536</entry>227 <entry>2048x1536/SGRBG8_1X8</entry>
225 <entry><emphasis>2048x1536</emphasis></entry>228 <entry><emphasis>2048x1536/SGRBG8_1X8</emphasis></entry>
226 <entry><emphasis>2046x1534</emphasis></entry>229 <entry><emphasis>2046x1534/SGRBG8_1X8</emphasis></entry>
227 <entry>-</entry>230 <entry>(default)</entry>
228 <entry>-</entry>231 <entry>(default)</entry>
232 <entry>(default)</entry>
229 </row>233 </row>
230 <row>234 <row>
231 <entry>Configure scaler input</entry>235 <entry>Configure scaler sink format</entry>
232 <entry>2048x1536</entry>236 <entry>2048x1536/SGRBG8_1X8</entry>
233 <entry>2048x1536</entry>237 <entry>2048x1536/SGRBG8_1X8</entry>
234 <entry>2046x1534</entry>238 <entry>2046x1534/SGRBG8_1X8</entry>
235 <entry><emphasis>2046x1534</emphasis></entry>239 <entry><emphasis>2046x1534/SGRBG8_1X8</emphasis></entry>
236 <entry><emphasis>2046x1534</emphasis></entry>240 <entry><emphasis>0,0/2046x1534</emphasis></entry>
241 <entry><emphasis>2046x1534/SGRBG8_1X8</emphasis></entry>
237 </row>242 </row>
238 <row>243 <row>
239 <entry>Configure scaler output</entry>244 <entry>Configure scaler sink compose selection</entry>
240 <entry>2048x1536</entry>245 <entry>2048x1536/SGRBG8_1X8</entry>
241 <entry>2048x1536</entry>246 <entry>2048x1536/SGRBG8_1X8</entry>
242 <entry>2046x1534</entry>247 <entry>2046x1534/SGRBG8_1X8</entry>
243 <entry>2046x1534</entry>248 <entry>2046x1534/SGRBG8_1X8</entry>
244 <entry><emphasis>1280x960</emphasis></entry>249 <entry><emphasis>0,0/1280x960</emphasis></entry>
250 <entry><emphasis>1280x960/SGRBG8_1X8</emphasis></entry>
245 </row>251 </row>
246 </tbody>252 </tbody>
247 </tgroup>253 </tgroup>
@@ -249,19 +255,30 @@ · 1 unmodified line
249 255
250 <para>256 <para>
251 <orderedlist>257 <orderedlist>
252 <listitem><para>Initial state. The sensor output is set to its native 3MP258 <listitem><para>Initial state. The sensor source pad format is
253 resolution. Resolutions on the host frontend and scaler input and output259 set to its native 3MP size and V4L2_MBUS_FMT_SGRBG8_1X8
254 pads are undefined.</para></listitem>260 media bus code. Formats on the host frontend and scaler sink
255 <listitem><para>The application configures the frontend input pad resolution to261 and source pads have the default values, as well as the
256 2048x1536. The driver propagates the format to the frontend output pad.262 compose rectangle on the scaler's sink pad.</para></listitem>
257 Note that the propagated output format can be different, as in this case,263
258 than the input format, as the hardware might need to crop pixels (for264 <listitem><para>The application configures the frontend sink
259 instance when converting a Bayer filter pattern to RGB or YUV).</para></listitem>265 pad format's size to 2048x1536 and its media bus code to
260 <listitem><para>The application configures the scaler input pad resolution to266 V4L2_MBUS_FMT_SGRBG_1X8. The driver propagates the format to
261 2046x1534 to match the frontend output resolution. The driver propagates267 the frontend source pad.</para></listitem>
262 the format to the scaler output pad.</para></listitem>268
263 <listitem><para>The application configures the scaler output pad resolution to269 <listitem><para>The application configures the scaler sink pad
264 1280x960.</para></listitem>270 format's size to 2046x1534 and the media bus code to
271 V4L2_MBUS_FMT_SGRBG_1X8 to match the frontend source size and
272 media bus code. The media bus code on the sink pad is set to
273 V4L2_MBUS_FMT_SGRBG_1X8. The driver propagates the size to the
274 compose selection rectangle on the scaler's sink pad, and the
275 format to the scaler source pad.</para></listitem>
276
277 <listitem><para>The application configures the size of the compose
278 selection rectangle of the scaler's sink pad 1280x960. The driver
279 propagates the size to the scaler's source pad
280 format.</para></listitem>
281
265 </orderedlist>282 </orderedlist>
266 </para>283 </para>
267 284