Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

[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.

Signed-off-by: Sakari Ailus <sakari.ailus@iki.fi>
Acked-by: Hans Verkuil <hans.verkuil@cisco.com>
Acked-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>

authored by

Sakari Ailus and committed by
Mauro Carvalho Chehab
6936d74f e8bd888a

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