tjh.dev
Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
media: ca-get-descr-info.rst: document this ioctl
Instead of a generic boilerplate, fill it with relevant
information about this ioctl.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
+4
-25
+4
-25
Documentation/media/uapi/dvb/ca-get-descr-info.rst
+4
-25
Documentation/media/uapi/dvb/ca-get-descr-info.rst
···
27
27
``desc``
28
28
Pointer to struct :c:type:`ca_descr_info`.
29
29
30
-
.. c:type:: struct ca_descr_info
31
-
32
-
.. flat-table:: struct ca_descr_info
33
-
:header-rows: 1
34
-
:stub-columns: 0
35
-
36
-
-
37
-
- type
38
-
- name
39
-
- description
40
-
41
-
-
42
-
- unsigned int
43
-
- num
44
-
- number of available descramblers (keys)
45
-
-
46
-
- unsigned int
47
-
- type
48
-
- type of supported scrambling system. Valid values are:
49
-
``CA_ECD``, ``CA_NDS`` and ``CA_DSS``.
50
-
51
-
52
30
Description
53
31
-----------
54
32
55
-
.. note:: This ioctl is undocumented. Documentation is welcome.
56
-
33
+
Returns information about all descrambler slots.
57
34
58
35
Return Value
59
36
------------
60
37
61
-
On success 0 is returned, on error -1 and the ``errno`` variable is set
38
+
On success 0 is returned, and :c:type:`ca_descr_info` is filled.
39
+
40
+
On error -1 is returned, and the ``errno`` variable is set
62
41
appropriately. The generic error codes are described at the
63
42
:ref:`Generic Error Codes <gen-errors>` chapter.