Commit 580139fa authored by Sakari Ailus's avatar Sakari Ailus Committed by Hans Verkuil
Browse files

media: Documentation: Align numbered list, make it a proper ReST



Align lines for numbered list so that Sphinx produces an uniform output
for all list entries. Also indent paragraphs of such list entries for
consistency.

Also use ReST numbered list syntax for the entries.

Signed-off-by: default avatarSakari Ailus <sakari.ailus@linux.intel.com>
Reviewed-by: default avatarLaurent Pinchart <laurent.pinchart@ideasonboard.com>
Signed-off-by: default avatarHans Verkuil <hverkuil-cisco@xs4all.nl>
parent ef202378
Loading
Loading
Loading
Loading
+24 −25
Original line number Diff line number Diff line
@@ -579,17 +579,16 @@ is started.

There are three steps in configuring the streams:

1) Set up links. Connect the pads between sub-devices using the :ref:`Media
Controller API <media_controller>`
1. Set up links. Connect the pads between sub-devices using the
   :ref:`Media Controller API <media_controller>`

2) Streams. Streams are declared and their routing is configured by
setting the routing table for the sub-device using
:ref:`VIDIOC_SUBDEV_S_ROUTING <VIDIOC_SUBDEV_G_ROUTING>` ioctl. Note that
setting the routing table will reset formats and selections in the
sub-device to default values.
2. Streams. Streams are declared and their routing is configured by setting the
   routing table for the sub-device using :ref:`VIDIOC_SUBDEV_S_ROUTING
   <VIDIOC_SUBDEV_G_ROUTING>` ioctl. Note that setting the routing table will
   reset formats and selections in the sub-device to default values.

3) Configure formats and selections. Formats and selections of each stream
are configured separately as documented for plain sub-devices in
3. Configure formats and selections. Formats and selections of each stream are
   configured separately as documented for plain sub-devices in
   :ref:`format-propagation`. The stream ID is set to the same stream ID
   associated with either sink or source pads of routes configured using the
   :ref:`VIDIOC_SUBDEV_S_ROUTING <VIDIOC_SUBDEV_G_ROUTING>` ioctl.
@@ -618,11 +617,11 @@ modeled as V4L2 devices, exposed to userspace via /dev/videoX nodes.

To configure this pipeline, the userspace must take the following steps:

1) Set up media links between entities: connect the sensors to the bridge,
1. Set up media links between entities: connect the sensors to the bridge,
   bridge to the receiver, and the receiver to the DMA engines. This step does
   not differ from normal non-multiplexed media controller setup.

2) Configure routing
2. Configure routing

.. flat-table:: Bridge routing table
    :header-rows:  1
@@ -656,14 +655,14 @@ not differ from normal non-multiplexed media controller setup.
      - V4L2_SUBDEV_ROUTE_FL_ACTIVE
      - Pixel data stream from Sensor B

3) Configure formats and selections
3. Configure formats and selections

   After configuring routing, the next step is configuring the formats and
   selections for the streams. This is similar to performing this step without
   streams, with just one exception: the ``stream`` field needs to be assigned
   to the value of the stream ID.

A common way to accomplish this is to start from the sensors and propagate the
configurations along the stream towards the receiver,
using :ref:`VIDIOC_SUBDEV_S_FMT <VIDIOC_SUBDEV_G_FMT>` ioctls to configure each
   A common way to accomplish this is to start from the sensors and propagate
   the configurations along the stream towards the receiver, using
   :ref:`VIDIOC_SUBDEV_S_FMT <VIDIOC_SUBDEV_G_FMT>` ioctls to configure each
   stream endpoint in each sub-device.