summaryrefslogtreecommitdiff
path: root/Documentation/media/uapi/dvb/ca-get-slot-info.rst
diff options
context:
space:
mode:
authorMauro Carvalho Chehab <mchehab@s-opensource.com>2017-09-01 08:32:56 -0400
committerMauro Carvalho Chehab <mchehab@s-opensource.com>2017-09-05 06:12:16 -0400
commit5d153fb888bd9bae0802d0a8db8e1321caf4296e (patch)
tree4a4075dddacab2f53c35b84d6bd9aba31ef8d9b5 /Documentation/media/uapi/dvb/ca-get-slot-info.rst
parent3c71bfd433b4d936dce21b5a7ed3274220669680 (diff)
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>
Diffstat (limited to 'Documentation/media/uapi/dvb/ca-get-slot-info.rst')
-rw-r--r--Documentation/media/uapi/dvb/ca-get-slot-info.rst98
1 files changed, 11 insertions, 87 deletions
diff --git a/Documentation/media/uapi/dvb/ca-get-slot-info.rst b/Documentation/media/uapi/dvb/ca-get-slot-info.rst
index 54e5dc78a2dc..d7e41e038ca7 100644
--- a/Documentation/media/uapi/dvb/ca-get-slot-info.rst
+++ b/Documentation/media/uapi/dvb/ca-get-slot-info.rst
@@ -26,100 +26,24 @@ Arguments
File descriptor returned by a previous call to :c:func:`open() <cec-open>`.
``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`.
-
+ Pointer to struct :c:type:`ca_slot_info`.
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
------------
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
+On success 0 is returned, and :c:type:`ca_slot_info` is filled.
+
+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.