aboutsummaryrefslogtreecommitdiff
path: root/Documentation/media
diff options
context:
space:
mode:
authorMauro Carvalho Chehab2017-09-01 07:48:02 -0400
committerMauro Carvalho Chehab2017-09-05 06:10:33 -0400
commitfed7c4fe8bd0b131cc3f19ba2744061935cdcdb7 (patch)
tree1704c8f172d1090bac98bbc34551c468faa74a1c /Documentation/media
parent833ff5e7feda1a042b83e82208cef3d212ca0ef1 (diff)
media: ca.h: document most CA data types
For most of the stuff there, documenting is easy, as the header file contains information. Yet, I was unable to document two data structs: ca_msg and ca_descr As those two structs are used by a few drivers, keep them. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Diffstat (limited to 'Documentation/media')
-rw-r--r--Documentation/media/uapi/dvb/ca_data_types.rst75
1 files changed, 10 insertions, 65 deletions
diff --git a/Documentation/media/uapi/dvb/ca_data_types.rst b/Documentation/media/uapi/dvb/ca_data_types.rst
index 555b5137936b..aa57dd176825 100644
--- a/Documentation/media/uapi/dvb/ca_data_types.rst
+++ b/Documentation/media/uapi/dvb/ca_data_types.rst
@@ -6,91 +6,36 @@
CA Data Types
*************
+.. kernel-doc:: include/uapi/linux/dvb/ca.h
-.. c:type:: ca_slot_info
-
-ca_slot_info_t
-==============
-
-
-.. code-block:: c
-
- typedef struct ca_slot_info {
- int num; /* slot number */
-
- int type; /* CA interface this slot supports */
- #define CA_CI 1 /* CI high level interface */
- #define CA_CI_LINK 2 /* CI link layer level interface */
- #define CA_CI_PHYS 4 /* CI physical layer level interface */
- #define CA_DESCR 8 /* built-in descrambler */
- #define CA_SC 128 /* simple smart card interface */
-
- unsigned int flags;
- #define CA_CI_MODULE_PRESENT 1 /* module (or card) inserted */
- #define CA_CI_MODULE_READY 2
- } ca_slot_info_t;
-
-
-.. c:type:: ca_descr_info
-
-ca_descr_info_t
-===============
-
-
-.. code-block:: c
-
- typedef struct ca_descr_info {
- unsigned int num; /* number of available descramblers (keys) */
- unsigned int type; /* type of supported scrambling system */
- #define CA_ECD 1
- #define CA_NDS 2
- #define CA_DSS 4
- } ca_descr_info_t;
-
-
-.. c:type:: ca_caps
-
-ca_caps_t
-=========
-
+.. c:type:: ca_msg
-.. code-block:: c
+Undocumented data types
+=======================
- typedef struct ca_caps {
- unsigned int slot_num; /* total number of CA card and module slots */
- unsigned int slot_type; /* OR of all supported types */
- unsigned int descr_num; /* total number of descrambler slots (keys) */
- unsigned int descr_type;/* OR of all supported types */
- } ca_cap_t;
+.. note::
+ Those data types are undocumented. Documentation is welcome.
.. c:type:: ca_msg
-ca_msg_t
-========
-
-
.. code-block:: c
/* a message to/from a CI-CAM */
- typedef struct ca_msg {
+ struct ca_msg {
unsigned int index;
unsigned int type;
unsigned int length;
unsigned char msg[256];
- } ca_msg_t;
+ };
.. c:type:: ca_descr
-ca_descr_t
-==========
-
-
.. code-block:: c
- typedef struct ca_descr {
+ struct ca_descr {
unsigned int index;
unsigned int parity;
unsigned char cw[8];
- } ca_descr_t;
+ };