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

   1 .. -*- coding: utf-8; mode: rst -*-
   2
   3 .. _CA_GET_SLOT_INFO:
   4
   5 ================
   6 CA_GET_SLOT_INFO
   7 ================
   8
   9 Name
  10 ----
  11
  12 CA_GET_SLOT_INFO
  13
  14
  15 Synopsis
  16 --------
  17
  18 .. c:function:: int ioctl(fd, CA_GET_SLOT_INFO, struct ca_slot_info *info)
  19     :name: CA_GET_SLOT_INFO
  20
  21
  22 Arguments
  23 ---------
  24
  25 ``fd``
  26   File descriptor returned by a previous call to :c:func:`open() <cec-open>`.
  27
  28 ``info``
  29   Pointer to struct c:type:`ca_slot_info`.
  30
  31 .. _ca_slot_info_type:
  32
  33 .. flat-table:: ca_slot_info types
  34     :header-rows:  1
  35     :stub-columns: 0
  36
  37     -
  38       - type
  39       - name
  40       - description
  41     -
  42        - CA_CI
  43        - 1
  44        - CI high level interface
  45
  46     -
  47        - CA_CI_LINK
  48        - 2
  49        - CI link layer level interface
  50
  51     -
  52        - CA_CI_PHYS
  53        - 4
  54        - CI physical layer level interface
  55
  56     -
  57        - CA_DESCR
  58        - 8
  59        - built-in descrambler
  60
  61     -
  62        - CA_SC
  63        - 128
  64        - simple smart card interface
  65
  66 .. _ca_slot_info_flag:
  67
  68 .. flat-table:: ca_slot_info flags
  69     :header-rows:  1
  70     :stub-columns: 0
  71
  72     -
  73       - type
  74       - name
  75       - description
  76
  77     -
  78        - CA_CI_MODULE_PRESENT
  79        - 1
  80        - module (or card) inserted
  81
  82     -
  83        - CA_CI_MODULE_READY
  84        - 2
  85        -
  86
  87 .. c:type:: ca_slot_info
  88
  89 .. flat-table:: struct ca_slot_info
  90     :header-rows:  1
  91     :stub-columns: 0
  92
  93     -
  94       - type
  95       - name
  96       - description
  97
  98     -
  99        - int
 100        - num
 101        - slot number
 102
 103     -
 104        - int
 105        - type
 106        - CA interface this slot supports, as defined at :ref:`ca_slot_info_type`.
 107
 108     -
 109        - unsigned int
 110        - flags
 111        - flags as defined at :ref:`ca_slot_info_flag`.
 112
 113
 114 Description
 115 -----------
 116
 117 .. note:: This ioctl is undocumented. Documentation is welcome.
 118
 119
 120 Return Value
 121 ------------
 122
 123 On success 0 is returned, on error -1 and the ``errno`` variable is set
 124 appropriately. The generic error codes are described at the
 125 :ref:`Generic Error Codes <gen-errors>` chapter.