xref: /linux/Documentation/userspace-api/media/dvb/ca-send-msg.rst (revision 95298d63c67673c654c08952672d016212b26054)
1.. Permission is granted to copy, distribute and/or modify this
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
9
10.. _CA_SEND_MSG:
11
12===========
13CA_SEND_MSG
14===========
15
16Name
17----
18
19CA_SEND_MSG
20
21
22Synopsis
23--------
24
25.. c:function:: int ioctl(fd, CA_SEND_MSG, struct ca_msg *msg)
26    :name: CA_SEND_MSG
27
28
29Arguments
30---------
31
32``fd``
33  File descriptor returned by a previous call to :c:func:`open() <cec-open>`.
34
35``msg``
36  Pointer to struct :c:type:`ca_msg`.
37
38
39Description
40-----------
41
42Sends a message via a CI CA module.
43
44.. note::
45
46   Please notice that, on most drivers, this is done by writing
47   to the /dev/adapter?/ca? device node.
48
49Return Value
50------------
51
52On success 0 is returned.
53
54On error -1 is returned, and the ``errno`` variable is set
55appropriately.
56
57Generic error codes are described at the
58:ref:`Generic Error Codes <gen-errors>` chapter.
59