xref: /linux/Documentation/userspace-api/media/dvb/ca-reset.rst (revision e5a52fd2b8cdb700b3c07b030e050a49ef3156b9)
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_RESET:
11
12========
13CA_RESET
14========
15
16Name
17----
18
19CA_RESET
20
21
22Synopsis
23--------
24
25.. c:function:: int ioctl(fd, CA_RESET)
26    :name: CA_RESET
27
28
29Arguments
30---------
31
32``fd``
33  File descriptor returned by a previous call to :c:func:`open() <cec-open>`.
34
35Description
36-----------
37
38Puts the Conditional Access hardware on its initial state. It should
39be called before start using the CA hardware.
40
41
42Return Value
43------------
44
45On success 0 is returned.
46
47On error -1 is returned, and the ``errno`` variable is set
48appropriately.
49
50Generic error codes are described at the
51:ref:`Generic Error Codes <gen-errors>` chapter.
52