iv/linux
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

media: ca.h: document ca_msg and the corresponding ioctls

Browse Source 
Usually, CA messages are sent/received via reading/writing at
the CA device node. However, two drivers (dst_ca and firedtv-ci)
also implement it via ioctls.

Apparently, on both cases, the net result is the same.

Anyway, let's document it.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
This commit is contained in:
Mauro Carvalho Chehab 2017-09-04 08:03:40 -04:00
parent bd9049edc6
commit 7e6854a9bf
3 changed files with 21 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
Documentation/media/uapi/dvb/ca-get-msg.rst
View File

@ -28,22 +28,15 @@ Arguments
``msg``
Pointer to struct :c:type:`ca_msg`.
.. 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];
};
Description
-----------
.. note:: This ioctl is undocumented. Documentation is welcome.
Receives a message via a CI CA module.
.. note::
Please notice that, on most drivers, this is done by reading from
the /dev/adapter?/ca? device node.
Return Value

6
Documentation/media/uapi/dvb/ca-send-msg.rst
View File

@ -32,8 +32,12 @@ Arguments
Description
-----------
.. note:: This ioctl is undocumented. Documentation is welcome.
Sends a message via a CI CA module.
.. note::
Please notice that, on most drivers, this is done by writing
to the /dev/adapter?/ca? device node.
Return Value
------------

11
include/uapi/linux/dvb/ca.h
View File

@ -101,7 +101,16 @@ struct ca_caps {
unsigned int descr_type;
};
/* a message to/from a CI-CAM */
/**
* struct ca_msg - a message to/from a CI-CAM
*
* @index: unused
* @type: unused
* @length: length of the message
* @msg: message
*
* This struct carries a message to be send/received from a CI CA module.
*/
struct ca_msg {
unsigned int index;
unsigned int type;