diff options
Diffstat (limited to 'Documentation/media/uapi/dvb/ca-get-slot-info.rst')
-rw-r--r-- | Documentation/media/uapi/dvb/ca-get-slot-info.rst | 102 |
1 files changed, 17 insertions, 85 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..1a1d6f0c71b9 100644 --- a/Documentation/media/uapi/dvb/ca-get-slot-info.rst +++ b/Documentation/media/uapi/dvb/ca-get-slot-info.rst @@ -26,100 +26,32 @@ Arguments File descriptor returned by a previous call to :c:func:`open() <cec-open>`. ``info`` - Pointer to struct c:type:`ca_slot_info`. + Pointer to struct :c:type:`ca_slot_info`. -.. _ca_slot_info_type: +Description +----------- -.. flat-table:: ca_slot_info types - :header-rows: 1 - :stub-columns: 0 +Returns information about a CA slot identified by +:c:type:`ca_slot_info`.slot_num. - - - - 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 +Return Value +------------ - - - - CA_CI_MODULE_PRESENT - - 1 - - module (or card) inserted +On success 0 is returned, and :c:type:`ca_slot_info` is filled. - - - - CA_CI_MODULE_READY - - 2 - - +On error -1 is returned, and the ``errno`` variable is set +appropriately. -.. c:type:: ca_slot_info +.. tabularcolumns:: |p{2.5cm}|p{15.0cm}| -.. flat-table:: struct ca_slot_info - :header-rows: 1 +.. flat-table:: + :header-rows: 0 :stub-columns: 0 + :widths: 1 16 - - - - 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 ------------ - -.. note:: This ioctl is undocumented. Documentation is welcome. - - -Return Value ------------- + - - ``ENODEV`` + - the slot is not available. -On success 0 is returned, on error -1 and the ``errno`` variable is set -appropriately. The generic error codes are described at the +The generic error codes are described at the :ref:`Generic Error Codes <gen-errors>` chapter. |