Gitiles
Code Review Sign In
gerrit-public.fairphone.software / kernel / msm-4.19 / ed6de4560ad2f7578be3a9ca1364e268c641f3a7 / . / Documentation / media / uapi / dvb / ca-get-slot-info.rst
blob: 54e5dc78a2dc434116d87cc6ab8e2b540c8ec6bd [file] [log] [blame]
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -0300[diff] [blame]1.. -*- coding: utf-8; mode: rst -*-
2
3.. _CA_GET_SLOT_INFO:
4
Mauro Carvalho Chehab586027c2016-07-05 07:58:48 -0300[diff] [blame]5================
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -0300[diff] [blame]6CA_GET_SLOT_INFO
7================
8
Mauro Carvalho Chehab15e7d612016-07-05 15:14:35 -0300[diff] [blame]9Name
Mauro Carvalho Chehab586027c2016-07-05 07:58:48 -0300[diff] [blame]10----
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -0300[diff] [blame]11
Mauro Carvalho Chehab586027c2016-07-05 07:58:48 -0300[diff] [blame]12CA_GET_SLOT_INFO
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -0300[diff] [blame]13
Mauro Carvalho Chehab15e7d612016-07-05 15:14:35 -0300[diff] [blame]14
15Synopsis
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -0300[diff] [blame]16--------
17
Mauro Carvalho Chehab189d7242016-08-31 15:59:14 -0300[diff] [blame]18.. c:function:: int ioctl(fd, CA_GET_SLOT_INFO, struct ca_slot_info *info)
Mauro Carvalho Chehabcf8076c2016-08-19 16:56:15 -0300[diff] [blame]19 :name: CA_GET_SLOT_INFO
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -0300[diff] [blame]20
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -0300[diff] [blame]21
Mauro Carvalho Chehab15e7d612016-07-05 15:14:35 -0300[diff] [blame]22Arguments
Mauro Carvalho Chehab586027c2016-07-05 07:58:48 -0300[diff] [blame]23---------
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -0300[diff] [blame]24
Mauro Carvalho Chehabcf8076c2016-08-19 16:56:15 -0300[diff] [blame]25``fd``
26 File descriptor returned by a previous call to :c:func:`open() <cec-open>`.
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -0300[diff] [blame]27
Mauro Carvalho Chehabcf8076c2016-08-19 16:56:15 -0300[diff] [blame]28``info``
Mauro Carvalho Chehab63eb58b2016-08-31 14:15:56 -0300[diff] [blame]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`.
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -0300[diff] [blame]112
113
Mauro Carvalho Chehab15e7d612016-07-05 15:14:35 -0300[diff] [blame]114Description
Mauro Carvalho Chehab586027c2016-07-05 07:58:48 -0300[diff] [blame]115-----------
116
Mauro Carvalho Chehabcf8076c2016-08-19 16:56:15 -0300[diff] [blame]117.. note:: This ioctl is undocumented. Documentation is welcome.
Mauro Carvalho Chehab586027c2016-07-05 07:58:48 -0300[diff] [blame]118
119
Mauro Carvalho Chehab15e7d612016-07-05 15:14:35 -0300[diff] [blame]120Return Value
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -0300[diff] [blame]121------------
122
123On success 0 is returned, on error -1 and the ``errno`` variable is set
124appropriately. The generic error codes are described at the
125:ref:`Generic Error Codes <gen-errors>` chapter.