media: docs: sliced-vbi: fix V4L2_SLICED_WSS_625 docs
authorMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Thu, 10 Dec 2020 07:13:48 +0000 (08:13 +0100)
committerMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Thu, 11 Mar 2021 10:59:39 +0000 (11:59 +0100)
While fixing issues with PDF generation, I noticed that
bit 8 was missing for WSS 625 format.

While here, convert the literal block into a tables,
as it becomes more visible.

I opted to move the payload into a separate table, as
Sphinx has troubles with complex nested tables.

This way, it should work fine on both html and LaTeX/PDF
formats.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Documentation/userspace-api/media/v4l/dev-sliced-vbi.rst
Documentation/userspace-api/media/v4l/vidioc-g-sliced-vbi-cap.rst

index f0df144c9f635a3b12e469bd6c8ab914a6bd9bd4..213b736c9b67e65f64b1fe84d6ad0c861efe06a1 100644 (file)
@@ -253,13 +253,7 @@ Sliced VBI services
 
        :ref:`en300294`
       - PAL/SECAM line 23
-      -
-
-       ::
-
-           Byte         0                 1
-                 msb         lsb  msb           lsb
-            Bit  7 6 5 4 3 2 1 0  x x 13 12 11 10 9
+      -  See :ref:`v4l2-sliced-wss-625-payload` below.
     * - ``V4L2_SLICED_VBI_525``
       - 0x1000
       - :cspan:`2` Set of services applicable to 525 line systems.
@@ -282,6 +276,21 @@ format while i/o is in progress (between a
 :ref:`VIDIOC_STREAMOFF <VIDIOC_STREAMON>` call, and after the first
 :c:func:`read()` or :c:func:`write()` call).
 
+.. _v4l2-sliced-wss-625-payload:
+
+V4L2_SLICED_WSS_625 payload
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The payload for ``V4L2_SLICED_WSS_625`` is:
+
+           +-----+------------------+-----------------------+
+          |Byte |        0         |           1           |
+           +-----+--------+---------+-----------+-----------+
+          |     | msb    | lsb     | msb       | lsb       |
+           |     +-+-+-+--+--+-+-+--+--+-+--+---+---+--+-+--+
+          | Bit |7|6|5|4 | 3|2|1|0 | x|x|13|12 | 11|10|9|8 |
+           +-----+-+-+-+--+--+-+-+--+--+-+--+---+---+--+-+--+
+
 Reading and writing sliced VBI data
 ===================================
 
index 752f7f5fae730510bc12dcb6f1f930f26d47a3e1..b3f4dc71bb5dd8e583394256989059a77f4ffcc6 100644 (file)
@@ -162,13 +162,7 @@ the sliced VBI API is unsupported or ``type`` is invalid.
 
        :ref:`itu1119`
       - PAL/SECAM line 23
-      -
-
-       ::
-
-           Byte        0                 1
-                msb         lsb  msb           lsb
-           Bit  7 6 5 4 3 2 1 0  x x 13 12 11 10 9
+      - See :ref:`v4l2-sliced-vbi-cap-wss-625-payload` below.
     * - ``V4L2_SLICED_VBI_525``
       - 0x1000
       - :cspan:`2` Set of services applicable to 525 line systems.
@@ -180,6 +174,22 @@ the sliced VBI API is unsupported or ``type`` is invalid.
 
     \normalsize
 
+.. _v4l2-sliced-vbi-cap-wss-625-payload:
+
+V4L2_SLICED_VBI_CAP WSS_625 payload
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The payload for ``V4L2_SLICED_WSS_625`` is:
+
+           +-----+------------------+-----------------------+
+           |Byte |        0         |           1           |
+           +-----+--------+---------+-----------+-----------+
+           |     | msb    | lsb     | msb       | lsb       |
+           |     +-+-+-+--+--+-+-+--+--+-+--+---+---+--+-+--+
+           | Bit |7|6|5|4 | 3|2|1|0 | x|x|13|12 | 11|10|9|8 |
+           +-----+-+-+-+--+--+-+-+--+--+-+--+---+---+--+-+--+
+
+
 Return Value
 ============