1 .. SPDX-License-Identifier: GFDL-1.1-no-invari !! 1 .. Permission is granted to copy, distribute and/or modify this
2 .. c:namespace:: DTV.ca !! 2 .. document under the terms of the GNU Free Documentation License,
>> 3 .. Version 1.1 or any later version published by the Free Software
>> 4 .. Foundation, with no Invariant Sections, no Front-Cover Texts
>> 5 .. and no Back-Cover Texts. A copy of the license is included at
>> 6 .. Documentation/userspace-api/media/fdl-appendix.rst.
>> 7 ..
>> 8 .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections
3 9
4 .. _CA_GET_MSG: 10 .. _CA_GET_MSG:
5 11
6 ========== 12 ==========
7 CA_GET_MSG 13 CA_GET_MSG
8 ========== 14 ==========
9 15
10 Name 16 Name
11 ---- 17 ----
12 18
13 CA_GET_MSG 19 CA_GET_MSG
14 20
>> 21
15 Synopsis 22 Synopsis
16 -------- 23 --------
17 24
18 .. c:macro:: CA_GET_MSG !! 25 .. c:function:: int ioctl(fd, CA_GET_MSG, struct ca_msg *msg)
>> 26 :name: CA_GET_MSG
19 27
20 ``int ioctl(fd, CA_GET_MSG, struct ca_msg *msg <<
21 28
22 Arguments 29 Arguments
23 --------- 30 ---------
24 31
25 ``fd`` 32 ``fd``
26 File descriptor returned by a previous call !! 33 File descriptor returned by a previous call to :c:func:`open() <dvb-ca-open>`.
27 34
28 ``msg`` 35 ``msg``
29 Pointer to struct :c:type:`ca_msg`. 36 Pointer to struct :c:type:`ca_msg`.
30 37
31 Description 38 Description
32 ----------- 39 -----------
33 40
34 Receives a message via a CI CA module. 41 Receives a message via a CI CA module.
35 42
36 .. note:: 43 .. note::
37 44
38 Please notice that, on most drivers, this i 45 Please notice that, on most drivers, this is done by reading from
39 the /dev/adapter?/ca? device node. 46 the /dev/adapter?/ca? device node.
40 47
>> 48
41 Return Value 49 Return Value
42 ------------ 50 ------------
>> 51
43 52
44 On success 0 is returned. 53 On success 0 is returned.
45 54
46 On error -1 is returned, and the ``errno`` var 55 On error -1 is returned, and the ``errno`` variable is set
47 appropriately. 56 appropriately.
48 57
49 Generic error codes are described at the 58 Generic error codes are described at the
50 :ref:`Generic Error Codes <gen-errors>` chapte 59 :ref:`Generic Error Codes <gen-errors>` chapter.
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.