summaryrefslogtreecommitdiff
path: root/Documentation/media/uapi/dvb/ca-get-descr-info.rst
blob: b4a31940cec01f1dc63fdf1d4bc5f56190f1d874 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
.. -*- coding: utf-8; mode: rst -*-

.. _CA_GET_DESCR_INFO:

=================
CA_GET_DESCR_INFO
=================

Name
----

CA_GET_DESCR_INFO


Synopsis
--------

.. c:function:: int  ioctl(fd, CA_GET_DESCR_INFO, ca_descr_info_t *desc)
    :name: CA_GET_DESCR_INFO

Arguments
---------

``fd``
  File descriptor returned by a previous call to :c:func:`open() <dvb-ca-open>`.

``desc``
  Pointer to struct :c:type:`ca_descr_info`.

.. c:type:: struct ca_descr_info

.. flat-table:: struct ca_descr_info
    :header-rows:  1
    :stub-columns: 0

    -
      - type
      - name
      - description

    -
      - unsigned int
      - num
      - number of available descramblers (keys)
    -
      - unsigned int
      - type
      - type of supported scrambling system. Valid values are:
	``CA_ECD``, ``CA_NDS`` and ``CA_DSS``.


Description
-----------

.. note:: This ioctl is undocumented. Documentation is welcome.


Return Value
------------

On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.