Commit 33047274 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab
Browse files

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: default avatarMauro Carvalho Chehab <mchehab@s-opensource.com>
parent e0f891d8

Documentation/media/uapi/dvb/ca-get-msg.rst

+9 −29
Original line number Diff line number Diff line
@@ -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

-----------

Documentation/media/uapi/dvb/ca-set-descr.rst

+10 −0
Original line number Diff line number Diff line
@@ -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

-----------

Documentation/media/uapi/dvb/ca_data_types.rst

+0 −32
Original line number Diff line number Diff line
@@ -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];

    };

CRA Git | Maintained and supported by SUSTech CRA and CCSE