summaryrefslogtreecommitdiffstats
path: root/Documentation/userspace-api/media/dvb/ca-get-slot-info.rst
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation/userspace-api/media/dvb/ca-get-slot-info.rst')
-rw-r--r--Documentation/userspace-api/media/dvb/ca-get-slot-info.rst56
1 files changed, 56 insertions, 0 deletions
diff --git a/Documentation/userspace-api/media/dvb/ca-get-slot-info.rst b/Documentation/userspace-api/media/dvb/ca-get-slot-info.rst
new file mode 100644
index 000000000..582444af7
--- /dev/null
+++ b/Documentation/userspace-api/media/dvb/ca-get-slot-info.rst
@@ -0,0 +1,56 @@
+.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
+.. c:namespace:: DTV.ca
+
+.. _CA_GET_SLOT_INFO:
+
+================
+CA_GET_SLOT_INFO
+================
+
+Name
+----
+
+CA_GET_SLOT_INFO
+
+Synopsis
+--------
+
+.. c:macro:: CA_GET_SLOT_INFO
+
+``int ioctl(fd, CA_GET_SLOT_INFO, struct ca_slot_info *info)``
+
+Arguments
+---------
+
+``fd``
+ File descriptor returned by a previous call to :c:func:`open()`.
+
+``info``
+ Pointer to struct :c:type:`ca_slot_info`.
+
+Description
+-----------
+
+Returns information about a CA slot identified by
+:c:type:`ca_slot_info`.slot_num.
+
+Return Value
+------------
+
+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.
+
+.. tabularcolumns:: |p{2.5cm}|p{15.0cm}|
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+ :widths: 1 16
+
+ - - ``ENODEV``
+ - the slot is not available.
+
+The generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.