Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 6936d74f authored by Sakari Ailus's avatar Sakari Ailus Committed by Mauro Carvalho Chehab
Browse files

[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: default avatarSakari Ailus <sakari.ailus@iki.fi>
Acked-by: default avatarHans Verkuil <hans.verkuil@cisco.com>
Acked-by: default avatarLaurent Pinchart <laurent.pinchart@ideasonboard.com>
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@osg.samsung.com>
parent e8bd888a

Documentation/DocBook/media/v4l/dev-subdev.xml

+63 −46
Original line number Diff line number Diff line
@@ -195,53 +195,59 @@ 
	<title>Sample Pipeline Configuration</title>

	<tgroup cols="3">

	  <colspec colname="what"/>

	  <colspec colname="sensor-0" />

	  <colspec colname="frontend-0" />

	  <colspec colname="frontend-1" />

	  <colspec colname="scaler-0" />

	  <colspec colname="scaler-1" />

	  <colspec colname="sensor-0 format" />

	  <colspec colname="frontend-0 format" />

	  <colspec colname="frontend-1 format" />

	  <colspec colname="scaler-0 format" />

	  <colspec colname="scaler-0 compose" />

	  <colspec colname="scaler-1 format" />

	  <thead>

	    <row>

	      <entry></entry>

	      <entry>Sensor/0</entry>

	      <entry>Frontend/0</entry>

	      <entry>Frontend/1</entry>

	      <entry>Scaler/0</entry>

	      <entry>Scaler/1</entry>

	      <entry>Sensor/0 format</entry>

	      <entry>Frontend/0 format</entry>

	      <entry>Frontend/1 format</entry>

	      <entry>Scaler/0 format</entry>

	      <entry>Scaler/0 compose selection rectangle</entry>

	      <entry>Scaler/1 format</entry>

	    </row>

	  </thead>

	  <tbody valign="top">

	    <row>

	      <entry>Initial state</entry>

	      <entry>2048x1536</entry>

	      <entry>-</entry>

	      <entry>-</entry>

	      <entry>-</entry>

	      <entry>-</entry>

	      <entry>2048x1536/SGRBG8_1X8</entry>

	      <entry>(default)</entry>

	      <entry>(default)</entry>

	      <entry>(default)</entry>

	      <entry>(default)</entry>

	      <entry>(default)</entry>

	    </row>

	    <row>

	      <entry>Configure frontend input</entry>

	      <entry>2048x1536</entry>

	      <entry><emphasis>2048x1536</emphasis></entry>

	      <entry><emphasis>2046x1534</emphasis></entry>

	      <entry>-</entry>

	      <entry>-</entry>

	      <entry>Configure frontend sink format</entry>

	      <entry>2048x1536/SGRBG8_1X8</entry>

	      <entry><emphasis>2048x1536/SGRBG8_1X8</emphasis></entry>

	      <entry><emphasis>2046x1534/SGRBG8_1X8</emphasis></entry>

	      <entry>(default)</entry>

	      <entry>(default)</entry>

	      <entry>(default)</entry>

	    </row>

	    <row>

	      <entry>Configure scaler input</entry>

	      <entry>2048x1536</entry>

	      <entry>2048x1536</entry>

	      <entry>2046x1534</entry>

	      <entry><emphasis>2046x1534</emphasis></entry>

	      <entry><emphasis>2046x1534</emphasis></entry>

	      <entry>Configure scaler sink format</entry>

	      <entry>2048x1536/SGRBG8_1X8</entry>

	      <entry>2048x1536/SGRBG8_1X8</entry>

	      <entry>2046x1534/SGRBG8_1X8</entry>

	      <entry><emphasis>2046x1534/SGRBG8_1X8</emphasis></entry>

	      <entry><emphasis>0,0/2046x1534</emphasis></entry>

	      <entry><emphasis>2046x1534/SGRBG8_1X8</emphasis></entry>

	    </row>

	    <row>

	      <entry>Configure scaler output</entry>

	      <entry>2048x1536</entry>

	      <entry>2048x1536</entry>

	      <entry>2046x1534</entry>

	      <entry>2046x1534</entry>

	      <entry><emphasis>1280x960</emphasis></entry>

	      <entry>Configure scaler sink compose selection</entry>

	      <entry>2048x1536/SGRBG8_1X8</entry>

	      <entry>2048x1536/SGRBG8_1X8</entry>

	      <entry>2046x1534/SGRBG8_1X8</entry>

	      <entry>2046x1534/SGRBG8_1X8</entry>

	      <entry><emphasis>0,0/1280x960</emphasis></entry>

	      <entry><emphasis>1280x960/SGRBG8_1X8</emphasis></entry>

	    </row>

	  </tbody>

	</tgroup>
@@ -249,19 +255,30 @@ 


      <para>

      <orderedlist>

	<listitem><para>Initial state. The sensor output is set to its native 3MP

	resolution. Resolutions on the host frontend and scaler input and output

	pads are undefined.</para></listitem>

	<listitem><para>The application configures the frontend input pad resolution to

	2048x1536. The driver propagates the format to the frontend output pad.

	Note that the propagated output format can be different, as in this case,

	than the input format, as the hardware might need to crop pixels (for

	instance when converting a Bayer filter pattern to RGB or YUV).</para></listitem>

	<listitem><para>The application configures the scaler input pad resolution to

	2046x1534 to match the frontend output resolution. The driver propagates

	the format to the scaler output pad.</para></listitem>

	<listitem><para>The application configures the scaler output pad resolution to

	1280x960.</para></listitem>

	<listitem><para>Initial state. The sensor source pad format is

	set to its native 3MP size and V4L2_MBUS_FMT_SGRBG8_1X8

	media bus code. Formats on the host frontend and scaler sink

	and source pads have the default values, as well as the

	compose rectangle on the scaler's sink pad.</para></listitem>



	<listitem><para>The application configures the frontend sink

	pad format's size to 2048x1536 and its media bus code to

	V4L2_MBUS_FMT_SGRBG_1X8. The driver propagates the format to

	the frontend source pad.</para></listitem>



	<listitem><para>The application configures the scaler sink pad

	format's size to 2046x1534 and the media bus code to

	V4L2_MBUS_FMT_SGRBG_1X8 to match the frontend source size and

	media bus code. The media bus code on the sink pad is set to

	V4L2_MBUS_FMT_SGRBG_1X8. The driver propagates the size to the

	compose selection rectangle on the scaler's sink pad, and the

	format to the scaler source pad.</para></listitem>



	<listitem><para>The application configures the size of the compose

	selection rectangle of the scaler's sink pad 1280x960. The driver

	propagates the size to the scaler's source pad

	format.</para></listitem>



      </orderedlist>

      </para>