summaryrefslogtreecommitdiffstats
path: root/include/uapi/linux
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 /include/uapi/linux
parentbd9049edc66e13e868f819c39844f60443e70817 (diff)
downloadop-kernel-dev-7e6854a9bfea9ed6553acd0204da5101c9a2e6a0.zip
op-kernel-dev-7e6854a9bfea9ed6553acd0204da5101c9a2e6a0.tar.gz
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 'include/uapi/linux')
-rw-r--r--include/uapi/linux/dvb/ca.h11
1 files changed, 10 insertions, 1 deletions
diff --git a/include/uapi/linux/dvb/ca.h b/include/uapi/linux/dvb/ca.h
index c36fdb8..24fc38e 100644
--- a/include/uapi/linux/dvb/ca.h
+++ b/include/uapi/linux/dvb/ca.h
@@ -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;
OpenPOWER on IntegriCloud