diff options
| author | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2017-09-01 14:45:28 +0200 |
|---|---|---|
| committer | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2017-09-05 12:12:54 +0200 |
| commit | 33047274346a830e9620764f11e37f5f6acc380d (patch) | |
| tree | 5f7ac6f6fdb69abe32a484e9d1c46806b0d8027a /Documentation/media | |
| parent | media: ca-get-descr-info.rst: document this ioctl (diff) | |
| download | linux-33047274346a830e9620764f11e37f5f6acc380d.tar.xz linux-33047274346a830e9620764f11e37f5f6acc380d.zip | |
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>
Diffstat (limited to 'Documentation/media')
| -rw-r--r-- | Documentation/media/uapi/dvb/ca-get-msg.rst | 38 | ||||
| -rw-r--r-- | Documentation/media/uapi/dvb/ca-set-descr.rst | 10 | ||||
| -rw-r--r-- | Documentation/media/uapi/dvb/ca_data_types.rst | 32 |
3 files changed, 19 insertions, 61 deletions
diff --git a/Documentation/media/uapi/dvb/ca-get-msg.rst b/Documentation/media/uapi/dvb/ca-get-msg.rst index 121588da3ef1..1ee9d667c901 100644 --- a/Documentation/media/uapi/dvb/ca-get-msg.rst +++ b/Documentation/media/uapi/dvb/ca-get-msg.rst @@ -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 ----------- diff --git a/Documentation/media/uapi/dvb/ca-set-descr.rst b/Documentation/media/uapi/dvb/ca-set-descr.rst index 70f7b3cf12ad..95de34cf74ba 100644 --- a/Documentation/media/uapi/dvb/ca-set-descr.rst +++ b/Documentation/media/uapi/dvb/ca-set-descr.rst @@ -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 ----------- diff --git a/Documentation/media/uapi/dvb/ca_data_types.rst b/Documentation/media/uapi/dvb/ca_data_types.rst index aa57dd176825..ac7cbd76ddd5 100644 --- a/Documentation/media/uapi/dvb/ca_data_types.rst +++ b/Documentation/media/uapi/dvb/ca_data_types.rst @@ -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]; - }; |