media: dvb CA docs: place undocumented data together with ioctls
authorMauro Carvalho Chehab <mchehab@s-opensource.com>
Fri, 1 Sep 2017 12:45:28 +0000 (08:45 -0400)
committerMauro Carvalho Chehab <mchehab@s-opensource.com>
Tue, 5 Sep 2017 10:12:54 +0000 (06:12 -0400)
Right now, the same undocumented structs are on two places:
at ca_data_types.rst and together with their ioctls.

Move them to just one place and use the standard way to
represent them.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Documentation/media/uapi/dvb/ca-get-msg.rst
Documentation/media/uapi/dvb/ca-set-descr.rst
Documentation/media/uapi/dvb/ca_data_types.rst

index 121588da3ef1806176318037b0352c89a2087bb1..1ee9d667c901e8e41319fcf67028047104e5baaa 100644 (file)
@@ -28,37 +28,17 @@ Arguments
 ``msg``
   Pointer to struct :c:type:`ca_msg`.
 
+.. c:type:: ca_msg
 
-.. c:type:: struct ca_msg
-
-.. flat-table:: struct ca_msg
-    :header-rows:  1
-    :stub-columns: 0
-
-    -
-      - type
-      - name
-      - description
-    -
-       - unsigned int
-       - index
-       -
-
-    -
-       - unsigned int
-       - type
-       -
-
-    -
-       - unsigned int
-       - length
-       -
-
-    -
-       - unsigned char
-       - msg[256]
-       -
+.. code-block:: c
 
+    /* a message to/from a CI-CAM */
+    struct ca_msg {
+       unsigned int index;
+       unsigned int type;
+       unsigned int length;
+       unsigned char msg[256];
+    };
 
 Description
 -----------
index 70f7b3cf12addadcfea181a11a2f6380d6125afe..95de34cf74ba6bb4c2ad6c2e3be70592dfc4d6ce 100644 (file)
@@ -28,6 +28,16 @@ Arguments
 ``msg``
   Pointer to struct :c:type:`ca_descr`.
 
+.. c:type:: ca_descr
+
+.. code-block:: c
+
+    struct ca_descr {
+       unsigned int index;
+       unsigned int parity;
+       unsigned char cw[8];
+    };
+
 
 Description
 -----------
index aa57dd176825aa1110fd594d44f58c01ee8df840..ac7cbd76ddd51c6f122e7d5dd4f38f9379de2a34 100644 (file)
@@ -7,35 +7,3 @@ CA Data Types
 *************
 
 .. kernel-doc:: include/uapi/linux/dvb/ca.h
-
-.. c:type:: ca_msg
-
-Undocumented data types
-=======================
-
-.. note::
-
-   Those data types are undocumented. Documentation is welcome.
-
-.. c:type:: ca_msg
-
-.. code-block:: c
-
-    /* a message to/from a CI-CAM */
-    struct ca_msg {
-       unsigned int index;
-       unsigned int type;
-       unsigned int length;
-       unsigned char msg[256];
-    };
-
-
-.. c:type:: ca_descr
-
-.. code-block:: c
-
-    struct ca_descr {
-       unsigned int index;
-       unsigned int parity;
-       unsigned char cw[8];
-    };