Merge tag 'for-4.21/dm-changes' of git://git.kernel.org/pub/scm/linux/kernel/git...
[sfrench/cifs-2.6.git] / Documentation / media / uapi / dvb / ca-get-cap.rst
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/media/uapi/fdl-appendix.rst.
7 ..
8 .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections
9
10 .. _CA_GET_CAP:
11
12 ==========
13 CA_GET_CAP
14 ==========
15
16 Name
17 ----
18
19 CA_GET_CAP
20
21
22 Synopsis
23 --------
24
25 .. c:function:: int ioctl(fd, CA_GET_CAP, struct ca_caps *caps)
26     :name: CA_GET_CAP
27
28
29 Arguments
30 ---------
31
32 ``fd``
33   File descriptor returned by a previous call to :c:func:`open() <dvb-ca-open>`.
34
35 ``caps``
36   Pointer to struct :c:type:`ca_caps`.
37
38 Description
39 -----------
40
41 Queries the Kernel for information about the available CA and descrambler
42 slots, and their types.
43
44 Return Value
45 ------------
46
47 On success 0 is returned and :c:type:`ca_caps` is filled.
48
49 On error, -1 is returned and the ``errno`` variable is set
50 appropriately.
51
52 The generic error codes are described at the
53 :ref:`Generic Error Codes <gen-errors>` chapter.