diff options
Diffstat (limited to '')
-rw-r--r-- | Documentation/media/uapi/dvb/ca-get-msg.rst | 52 |
1 files changed, 52 insertions, 0 deletions
diff --git a/Documentation/media/uapi/dvb/ca-get-msg.rst b/Documentation/media/uapi/dvb/ca-get-msg.rst new file mode 100644 index 000000000..ceeda623c --- /dev/null +++ b/Documentation/media/uapi/dvb/ca-get-msg.rst @@ -0,0 +1,52 @@ +.. -*- coding: utf-8; mode: rst -*- + +.. _CA_GET_MSG: + +========== +CA_GET_MSG +========== + +Name +---- + +CA_GET_MSG + + +Synopsis +-------- + +.. c:function:: int ioctl(fd, CA_GET_MSG, struct ca_msg *msg) + :name: CA_GET_MSG + + +Arguments +--------- + +``fd`` + File descriptor returned by a previous call to :c:func:`open() <dvb-ca-open>`. + +``msg`` + Pointer to struct :c:type:`ca_msg`. + +Description +----------- + +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 +------------ + + +On success 0 is returned. + +On error -1 is returned, and the ``errno`` variable is set +appropriately. + +Generic error codes are described at the +:ref:`Generic Error Codes <gen-errors>` chapter. |