GNU Linux-libre 6.1.90-gnu
[releases.git] / Documentation / userspace-api / media / dvb / ca-reset.rst
1 .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
2 .. c:namespace:: DTV.ca
3
4 .. _CA_RESET:
5
6 ========
7 CA_RESET
8 ========
9
10 Name
11 ----
12
13 CA_RESET
14
15 Synopsis
16 --------
17
18 .. c:macro:: CA_RESET
19
20 ``int ioctl(fd, CA_RESET)``
21
22 Arguments
23 ---------
24
25 ``fd``
26   File descriptor returned by a previous call to :c:func:`open()`.
27
28 Description
29 -----------
30
31 Puts the Conditional Access hardware on its initial state. It should
32 be called before start using the CA hardware.
33
34 Return Value
35 ------------
36
37 On success 0 is returned.
38
39 On error -1 is returned, and the ``errno`` variable is set
40 appropriately.
41
42 Generic error codes are described at the
43 :ref:`Generic Error Codes <gen-errors>` chapter.