media: ca-get-slot-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>
This commit is contained in:
parent
3c71bfd433
commit
5d153fb888
|
@ -26,100 +26,24 @@ Arguments
|
||||||
File descriptor returned by a previous call to :c:func:`open() <cec-open>`.
|
File descriptor returned by a previous call to :c:func:`open() <cec-open>`.
|
||||||
|
|
||||||
``info``
|
``info``
|
||||||
Pointer to struct c:type:`ca_slot_info`.
|
Pointer to struct :c:type:`ca_slot_info`.
|
||||||
|
|
||||||
.. _ca_slot_info_type:
|
|
||||||
|
|
||||||
.. flat-table:: ca_slot_info types
|
|
||||||
:header-rows: 1
|
|
||||||
:stub-columns: 0
|
|
||||||
|
|
||||||
-
|
|
||||||
- type
|
|
||||||
- name
|
|
||||||
- description
|
|
||||||
-
|
|
||||||
- CA_CI
|
|
||||||
- 1
|
|
||||||
- CI high level interface
|
|
||||||
|
|
||||||
-
|
|
||||||
- CA_CI_LINK
|
|
||||||
- 2
|
|
||||||
- CI link layer level interface
|
|
||||||
|
|
||||||
-
|
|
||||||
- CA_CI_PHYS
|
|
||||||
- 4
|
|
||||||
- CI physical layer level interface
|
|
||||||
|
|
||||||
-
|
|
||||||
- CA_DESCR
|
|
||||||
- 8
|
|
||||||
- built-in descrambler
|
|
||||||
|
|
||||||
-
|
|
||||||
- CA_SC
|
|
||||||
- 128
|
|
||||||
- simple smart card interface
|
|
||||||
|
|
||||||
.. _ca_slot_info_flag:
|
|
||||||
|
|
||||||
.. flat-table:: ca_slot_info flags
|
|
||||||
:header-rows: 1
|
|
||||||
:stub-columns: 0
|
|
||||||
|
|
||||||
-
|
|
||||||
- type
|
|
||||||
- name
|
|
||||||
- description
|
|
||||||
|
|
||||||
-
|
|
||||||
- CA_CI_MODULE_PRESENT
|
|
||||||
- 1
|
|
||||||
- module (or card) inserted
|
|
||||||
|
|
||||||
-
|
|
||||||
- CA_CI_MODULE_READY
|
|
||||||
- 2
|
|
||||||
-
|
|
||||||
|
|
||||||
.. c:type:: ca_slot_info
|
|
||||||
|
|
||||||
.. flat-table:: struct ca_slot_info
|
|
||||||
:header-rows: 1
|
|
||||||
:stub-columns: 0
|
|
||||||
|
|
||||||
-
|
|
||||||
- type
|
|
||||||
- name
|
|
||||||
- description
|
|
||||||
|
|
||||||
-
|
|
||||||
- int
|
|
||||||
- num
|
|
||||||
- slot number
|
|
||||||
|
|
||||||
-
|
|
||||||
- int
|
|
||||||
- type
|
|
||||||
- CA interface this slot supports, as defined at :ref:`ca_slot_info_type`.
|
|
||||||
|
|
||||||
-
|
|
||||||
- unsigned int
|
|
||||||
- flags
|
|
||||||
- flags as defined at :ref:`ca_slot_info_flag`.
|
|
||||||
|
|
||||||
|
|
||||||
Description
|
Description
|
||||||
-----------
|
-----------
|
||||||
|
|
||||||
.. note:: This ioctl is undocumented. Documentation is welcome.
|
Returns information about a CA slot identified by
|
||||||
|
:c:type:`ca_slot_info`.slot_num.
|
||||||
|
|
||||||
|
|
||||||
Return Value
|
Return Value
|
||||||
------------
|
------------
|
||||||
|
|
||||||
On success 0 is returned, on error -1 and the ``errno`` variable is set
|
On success 0 is returned, and :c:type:`ca_slot_info` is filled.
|
||||||
appropriately. The generic error codes are described at the
|
|
||||||
|
On error -1 is returned, and the ``errno`` variable is set
|
||||||
|
appropriately.
|
||||||
|
|
||||||
|
If the slot is not available, ``errno`` will contain ``-EINVAL``.
|
||||||
|
|
||||||
|
The generic error codes are described at the
|
||||||
:ref:`Generic Error Codes <gen-errors>` chapter.
|
:ref:`Generic Error Codes <gen-errors>` chapter.
|
||||||
|
|
Loading…
Reference in New Issue