Documentation/media/uapi/dvb/ca-get-descr-info.rst

   1 .. -*- coding: utf-8; mode: rst -*-
   2
   3 .. _CA_GET_DESCR_INFO:
   4
   5 =================
   6 CA_GET_DESCR_INFO
   7 =================
   8
   9 Name
  10 ----
  11
  12 CA_GET_DESCR_INFO
  13
  14
  15 Synopsis
  16 --------
  17
  18 .. c:function:: int  ioctl(fd, CA_GET_DESCR_INFO, struct ca_descr_info *desc)
  19     :name: CA_GET_DESCR_INFO
  20
  21 Arguments
  22 ---------
  23
  24 ``fd``
  25   File descriptor returned by a previous call to :c:func:`open() <dvb-ca-open>`.
  26
  27 ``desc``
  28   Pointer to struct :c:type:`ca_descr_info`.
  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 Description
  53 -----------
  54
  55 .. note:: This ioctl is undocumented. Documentation is welcome.
  56
  57
  58 Return Value
  59 ------------
  60
  61 On success 0 is returned, on error -1 and the ``errno`` variable is set
  62 appropriately. The generic error codes are described at the
  63 :ref:`Generic Error Codes <gen-errors>` chapter.