media/cec/cec-ioc-adap-g-log-addrs.rst

1 .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
15 CEC_ADAP_G_LOG_ADDRS, CEC_ADAP_S_LOG_ADDRS - Get or set the logical addresses
44 To set new logical addresses, applications fill in
47 is only available if ``CEC_CAP_LOG_ADDRS`` is set (the ``ENOTTY`` error code is
52 To clear existing logical addresses set ``num_log_addrs`` to 0. All other fields
59 addresses have been claimed. If the file descriptor is in non-blocking mode then it will
62 A :ref:`CEC_EVENT_STATE_CHANGE <CEC-EVENT-STATE-CHANGE>` event is sent when the
74 .. flat-table:: struct cec_log_addrs
75     :header-rows:  0
76     :stub-columns: 0
79     * - __u8
80       - ``log_addr[CEC_MAX_LOG_ADDRS]``
81       - The actual logical addresses that were claimed. This is set by the
82 	driver. If no logical address could be claimed, then it is set to
84 	``log_addr[0]`` is set to 0xf and all others to
86     * - __u16
87       - ``log_addr_mask``
88       - The bitmask of all logical addresses this adapter has claimed. If
91 	all, then ``log_addr_mask`` is set to 0. Set by the driver.
92     * - __u8
93       - ``cec_version``
94       - The CEC version that this adapter shall use. See
95 	:ref:`cec-versions`. Used to implement the
97 	Note that :ref:`CEC_OP_CEC_VERSION_1_3A <CEC-OP-CEC-VERSION-1-3A>` is not allowed by the CEC
99     * - __u8
100       - ``num_log_addrs``
101       - Number of logical addresses to set up. Must be ≤
105 	``available_log_addrs``-1. The remaining array elements will be
110 	what was requested. If this field is set to 0, then the CEC
113     * - __u32
114       - ``vendor_id``
115       - The vendor ID is a 24-bit number that identifies the specific
117 	defined. If you do not want a vendor ID then set it to
119     * - __u32
120       - ``flags``
121       - Flags. See :ref:`cec-log-addrs-flags` for a list of available flags.
122     * - char
123       - ``osd_name[15]``
124       - The On-Screen Display name as is returned by the
126     * - __u8
127       - ``primary_device_type[CEC_MAX_LOG_ADDRS]``
128       - Primary device type for each logical address. See
129 	:ref:`cec-prim-dev-types` for possible types.
130     * - __u8
131       - ``log_addr_type[CEC_MAX_LOG_ADDRS]``
132       - Logical address types. See :ref:`cec-log-addr-types` for
135 	to :ref:`CEC_LOG_ADDR_TYPE_UNREGISTERED <CEC-LOG-ADDR-TYPE-UNREGISTERED>`).
136     * - __u8
137       - ``all_device_types[CEC_MAX_LOG_ADDRS]``
138       - CEC 2.0 specific: the bit mask of all device types. See
139 	:ref:`cec-all-dev-types-flags`. It is used in the CEC 2.0
144     * - __u8
145       - ``features[CEC_MAX_LOG_ADDRS][12]``
146       - Features for each logical address. It is used in the CEC 2.0
155 .. _cec-log-addrs-flags:
157 .. flat-table:: Flags for struct cec_log_addrs
158     :header-rows:  0
159     :stub-columns: 0
162     * .. _`CEC-LOG-ADDRS-FL-ALLOW-UNREG-FALLBACK`:
164       - ``CEC_LOG_ADDRS_FL_ALLOW_UNREG_FALLBACK``
165       - 1
166       - By default if no logical address of the requested type can be claimed, then
167 	it will go back to the unconfigured state. If this flag is set, then it will
170     * .. _`CEC-LOG-ADDRS-FL-ALLOW-RC-PASSTHRU`:
172       - ``CEC_LOG_ADDRS_FL_ALLOW_RC_PASSTHRU``
173       - 2
174       - By default the ``CEC_MSG_USER_CONTROL_PRESSED`` and ``CEC_MSG_USER_CONTROL_RELEASED``
175         messages are only passed on to the follower(s), if any. If this flag is set,
180     * .. _`CEC-LOG-ADDRS-FL-CDC-ONLY`:
182       - ``CEC_LOG_ADDRS_FL_CDC_ONLY``
183       - 4
184       - If this flag is set, then the device is CDC-Only. CDC-Only CEC devices
191 .. _cec-versions:
193 .. flat-table:: CEC Versions
194     :header-rows:  0
195     :stub-columns: 0
198     * .. _`CEC-OP-CEC-VERSION-1-3A`:
200       - ``CEC_OP_CEC_VERSION_1_3A``
201       - 4
202       - CEC version according to the HDMI 1.3a standard.
203     * .. _`CEC-OP-CEC-VERSION-1-4B`:
205       - ``CEC_OP_CEC_VERSION_1_4B``
206       - 5
207       - CEC version according to the HDMI 1.4b standard.
208     * .. _`CEC-OP-CEC-VERSION-2-0`:
210       - ``CEC_OP_CEC_VERSION_2_0``
211       - 6
212       - CEC version according to the HDMI 2.0 standard.
216 .. _cec-prim-dev-types:
218 .. flat-table:: CEC Primary Device Types
219     :header-rows:  0
220     :stub-columns: 0
223     * .. _`CEC-OP-PRIM-DEVTYPE-TV`:
225       - ``CEC_OP_PRIM_DEVTYPE_TV``
226       - 0
227       - Use for a TV.
228     * .. _`CEC-OP-PRIM-DEVTYPE-RECORD`:
230       - ``CEC_OP_PRIM_DEVTYPE_RECORD``
231       - 1
232       - Use for a recording device.
233     * .. _`CEC-OP-PRIM-DEVTYPE-TUNER`:
235       - ``CEC_OP_PRIM_DEVTYPE_TUNER``
236       - 3
237       - Use for a device with a tuner.
238     * .. _`CEC-OP-PRIM-DEVTYPE-PLAYBACK`:
240       - ``CEC_OP_PRIM_DEVTYPE_PLAYBACK``
241       - 4
242       - Use for a playback device.
243     * .. _`CEC-OP-PRIM-DEVTYPE-AUDIOSYSTEM`:
245       - ``CEC_OP_PRIM_DEVTYPE_AUDIOSYSTEM``
246       - 5
247       - Use for an audio system (e.g. an audio/video receiver).
248     * .. _`CEC-OP-PRIM-DEVTYPE-SWITCH`:
250       - ``CEC_OP_PRIM_DEVTYPE_SWITCH``
251       - 6
252       - Use for a CEC switch.
253     * .. _`CEC-OP-PRIM-DEVTYPE-VIDEOPROC`:
255       - ``CEC_OP_PRIM_DEVTYPE_VIDEOPROC``
256       - 7
257       - Use for a video processor device.
261 .. _cec-log-addr-types:
263 .. flat-table:: CEC Logical Address Types
264     :header-rows:  0
265     :stub-columns: 0
268     * .. _`CEC-LOG-ADDR-TYPE-TV`:
270       - ``CEC_LOG_ADDR_TYPE_TV``
271       - 0
272       - Use for a TV.
273     * .. _`CEC-LOG-ADDR-TYPE-RECORD`:
275       - ``CEC_LOG_ADDR_TYPE_RECORD``
276       - 1
277       - Use for a recording device.
278     * .. _`CEC-LOG-ADDR-TYPE-TUNER`:
280       - ``CEC_LOG_ADDR_TYPE_TUNER``
281       - 2
282       - Use for a tuner device.
283     * .. _`CEC-LOG-ADDR-TYPE-PLAYBACK`:
285       - ``CEC_LOG_ADDR_TYPE_PLAYBACK``
286       - 3
287       - Use for a playback device.
288     * .. _`CEC-LOG-ADDR-TYPE-AUDIOSYSTEM`:
290       - ``CEC_LOG_ADDR_TYPE_AUDIOSYSTEM``
291       - 4
292       - Use for an audio system device.
293     * .. _`CEC-LOG-ADDR-TYPE-SPECIFIC`:
295       - ``CEC_LOG_ADDR_TYPE_SPECIFIC``
296       - 5
297       - Use for a second TV or for a video processor device.
298     * .. _`CEC-LOG-ADDR-TYPE-UNREGISTERED`:
300       - ``CEC_LOG_ADDR_TYPE_UNREGISTERED``
301       - 6
302       - Use this if you just want to remain unregistered. Used for pure
303 	CEC switches or CDC-only devices (CDC: Capability Discovery and
309 .. _cec-all-dev-types-flags:
311 .. flat-table:: CEC All Device Types Flags
312     :header-rows:  0
313     :stub-columns: 0
316     * .. _`CEC-OP-ALL-DEVTYPE-TV`:
318       - ``CEC_OP_ALL_DEVTYPE_TV``
319       - 0x80
320       - This supports the TV type.
321     * .. _`CEC-OP-ALL-DEVTYPE-RECORD`:
323       - ``CEC_OP_ALL_DEVTYPE_RECORD``
324       - 0x40
325       - This supports the Recording type.
326     * .. _`CEC-OP-ALL-DEVTYPE-TUNER`:
328       - ``CEC_OP_ALL_DEVTYPE_TUNER``
329       - 0x20
330       - This supports the Tuner type.
331     * .. _`CEC-OP-ALL-DEVTYPE-PLAYBACK`:
333       - ``CEC_OP_ALL_DEVTYPE_PLAYBACK``
334       - 0x10
335       - This supports the Playback type.
336     * .. _`CEC-OP-ALL-DEVTYPE-AUDIOSYSTEM`:
338       - ``CEC_OP_ALL_DEVTYPE_AUDIOSYSTEM``
339       - 0x08
340       - This supports the Audio System type.
341     * .. _`CEC-OP-ALL-DEVTYPE-SWITCH`:
343       - ``CEC_OP_ALL_DEVTYPE_SWITCH``
344       - 0x04
345       - This supports the CEC Switch or Video Processing type.
351 On success 0 is returned, on error -1 and the ``errno`` variable is set
353 :ref:`Generic Error Codes <gen-errors>` chapter.
359     The ``CEC_CAP_LOG_ADDRS`` capability wasn't set, so this ioctl is not supported.
363     ``num_log_addrs`` is non-zero, or another filehandle is in exclusive follower or