Merge tag 'gcc-plugins-v4.9-rc4' of git://git.kernel.org/pub/scm/linux/kernel/git...
[cascardo/linux.git] / Documentation / media / uapi / dvb / ca-get-cap.rst
1 .. -*- coding: utf-8; mode: rst -*-
2
3 .. _CA_GET_CAP:
4
5 ==========
6 CA_GET_CAP
7 ==========
8
9 Name
10 ----
11
12 CA_GET_CAP
13
14
15 Synopsis
16 --------
17
18 .. c:function:: int ioctl(fd, CA_GET_CAP, struct ca_caps *caps)
19     :name: CA_GET_CAP
20
21
22 Arguments
23 ---------
24
25 ``fd``
26   File descriptor returned by a previous call to :c:func:`open() <dvb-ca-open>`.
27
28 ``caps``
29   Pointer to struct :c:type:`ca_caps`.
30
31 .. c:type:: struct ca_caps
32
33 .. flat-table:: struct ca_caps
34     :header-rows:  1
35     :stub-columns: 0
36
37     -
38       - type
39       - name
40       - description
41     -
42       - unsigned int
43       - slot_num
44       - total number of CA card and module slots
45     -
46       - unsigned int
47       - slot_type
48       - bitmask with all supported slot types
49     -
50       - unsigned int
51       - descr_num
52       - total number of descrambler slots (keys)
53     -
54       - unsigned int
55       - descr_type
56       - bit mask with all supported descr types
57
58
59 Description
60 -----------
61
62 .. note:: This ioctl is undocumented. Documentation is welcome.
63
64
65 Return Value
66 ------------
67
68 On success 0 is returned, on error -1 and the ``errno`` variable is set
69 appropriately. The generic error codes are described at the
70 :ref:`Generic Error Codes <gen-errors>` chapter.