summaryrefslogtreecommitdiff
path: root/Documentation/media
diff options
context:
space:
mode:
authorMauro Carvalho Chehab <mchehab@s-opensource.com>2017-09-04 08:03:40 -0400
committerMauro Carvalho Chehab <mchehab@s-opensource.com>2017-09-05 06:23:28 -0400
commit7e6854a9bfea9ed6553acd0204da5101c9a2e6a0 (patch)
treea9a2a48741c54079d939aba0ba4f0b4e61b5667b /Documentation/media
parentbd9049edc66e13e868f819c39844f60443e70817 (diff)
media: ca.h: document ca_msg and the corresponding ioctls
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>
Diffstat (limited to 'Documentation/media')
-rw-r--r--Documentation/media/uapi/dvb/ca-get-msg.rst19
-rw-r--r--Documentation/media/uapi/dvb/ca-send-msg.rst6
2 files changed, 11 insertions, 14 deletions
diff --git a/Documentation/media/uapi/dvb/ca-get-msg.rst b/Documentation/media/uapi/dvb/ca-get-msg.rst
index bdb116552068..ceeda623ce93 100644
--- a/Documentation/media/uapi/dvb/ca-get-msg.rst
+++ b/Documentation/media/uapi/dvb/ca-get-msg.rst
@@ -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
diff --git a/Documentation/media/uapi/dvb/ca-send-msg.rst b/Documentation/media/uapi/dvb/ca-send-msg.rst
index 644b6bda1aea..9e91287b7bbc 100644
--- a/Documentation/media/uapi/dvb/ca-send-msg.rst
+++ b/Documentation/media/uapi/dvb/ca-send-msg.rst
@@ -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
------------