media: dvb CA docs: place undocumented data together with ioctls

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>
This commit is contained in:
Mauro Carvalho Chehab 2017-09-01 08:45:28 -04:00
parent e0f891d846
commit 3304727434
3 changed files with 19 additions and 61 deletions

View 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
-----------

View 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
-----------

View 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];
};