media/cec/cec-ioc-adap-g-caps.rst

1 .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
10 Name  chapter
13 CEC_ADAP_G_CAPS - Query device capabilities
38 .. tabularcolumns:: |p{1.2cm}|p{2.5cm}|p{13.6cm}|
42 .. flat-table:: struct cec_caps
43     :header-rows:  0
44     :stub-columns: 0
47     * - char
48       - ``driver[32]``
49       - The name of the cec adapter driver.
50     * - char
51       - ``name[32]``
52       - The name of this CEC adapter. The combination ``driver`` and
53 	``name`` must be unique.
54     * - __u32
55       - ``available_log_addrs``
56       - The maximum number of logical addresses that can be configured.
57     * - __u32
58       - ``capabilities``
59       - The capabilities of the CEC adapter, see
60 	:ref:`cec-capabilities`.
61     * - __u32
62       - ``version``
63       - CEC Framework API version, formatted with the ``KERNEL_VERSION()``
66 .. tabularcolumns:: |p{4.4cm}|p{2.5cm}|p{10.4cm}|
68 .. _cec-capabilities:
70 .. flat-table:: CEC Capabilities Flags
71     :header-rows:  0
72     :stub-columns: 0
75     * .. _`CEC-CAP-PHYS-ADDR`:
77       - ``CEC_CAP_PHYS_ADDR``
78       - 0x00000001
79       - Userspace has to configure the physical address by calling
84     * .. _`CEC-CAP-LOG-ADDRS`:
86       - ``CEC_CAP_LOG_ADDRS``
87       - 0x00000002
88       - Userspace has to configure the logical addresses by calling
92     * .. _`CEC-CAP-TRANSMIT`:
94       - ``CEC_CAP_TRANSMIT``
95       - 0x00000004
96       - Userspace can transmit CEC messages by calling
102     * .. _`CEC-CAP-PASSTHROUGH`:
104       - ``CEC_CAP_PASSTHROUGH``
105       - 0x00000008
106       - Userspace can use the passthrough mode by calling
108     * .. _`CEC-CAP-RC`:
110       - ``CEC_CAP_RC``
111       - 0x00000010
112       - This adapter supports the remote control protocol.
113     * .. _`CEC-CAP-MONITOR-ALL`:
115       - ``CEC_CAP_MONITOR_ALL``
116       - 0x00000020
117       - The CEC hardware can monitor all messages, not just directed and
119     * .. _`CEC-CAP-NEEDS-HPD`:
121       - ``CEC_CAP_NEEDS_HPD``
122       - 0x00000040
123       - The CEC hardware is only active if the HDMI Hotplug Detect pin is
127     * .. _`CEC-CAP-MONITOR-PIN`:
129       - ``CEC_CAP_MONITOR_PIN``
130       - 0x00000080
131       - The CEC hardware can monitor CEC pin changes from low to high voltage
134     * .. _`CEC-CAP-CONNECTOR-INFO`:
136       - ``CEC_CAP_CONNECTOR_INFO``
137       - 0x00000100
138       - If this capability is set, then :ref:`CEC_ADAP_G_CONNECTOR_INFO` can
140     * .. _`CEC-CAP-REPLY-VENDOR-ID`:
142       - ``CEC_CAP_REPLY_VENDOR_ID``
143       - 0x00000200
144       - If this capability is set, then
145         :ref:`CEC_MSG_FL_REPLY_VENDOR_ID <cec-msg-flags>` can be used.
150 On success 0 is returned, on error -1 and the ``errno`` variable is set
152 :ref:`Generic Error Codes <gen-errors>` chapter.