1 .. -*- coding: utf-8; mode: rst -*-
3 .. _CEC_ADAP_LOG_ADDRS:
4 .. _CEC_ADAP_G_LOG_ADDRS:
5 .. _CEC_ADAP_S_LOG_ADDRS:
7 ****************************************************
8 ioctls CEC_ADAP_G_LOG_ADDRS and CEC_ADAP_S_LOG_ADDRS
9 ****************************************************
14 CEC_ADAP_G_LOG_ADDRS, CEC_ADAP_S_LOG_ADDRS - Get or set the logical addresses
20 .. c:function:: int ioctl( int fd, CEC_ADAP_G_LOG_ADDRS, struct cec_log_addrs *argp )
21 :name: CEC_ADAP_G_LOG_ADDRS
23 .. c:function:: int ioctl( int fd, CEC_ADAP_S_LOG_ADDRS, struct cec_log_addrs *argp )
24 :name: CEC_ADAP_S_LOG_ADDRS
30 File descriptor returned by :c:func:`open() <cec-open>`.
33 Pointer to struct :c:type:`cec_log_addrs`.
38 To query the current CEC logical addresses, applications call
39 :ref:`ioctl CEC_ADAP_G_LOG_ADDRS <CEC_ADAP_G_LOG_ADDRS>` with a pointer to a
40 struct :c:type:`cec_log_addrs` where the driver stores the logical addresses.
42 To set new logical addresses, applications fill in
43 struct :c:type:`cec_log_addrs` and call :ref:`ioctl CEC_ADAP_S_LOG_ADDRS <CEC_ADAP_S_LOG_ADDRS>`
44 with a pointer to this struct. The :ref:`ioctl CEC_ADAP_S_LOG_ADDRS <CEC_ADAP_S_LOG_ADDRS>`
45 is only available if ``CEC_CAP_LOG_ADDRS`` is set (the ``ENOTTY`` error code is
46 returned otherwise). The :ref:`ioctl CEC_ADAP_S_LOG_ADDRS <CEC_ADAP_S_LOG_ADDRS>`
47 can only be called by a file descriptor in initiator mode (see :ref:`CEC_S_MODE`), if not
48 the ``EBUSY`` error code will be returned.
50 To clear existing logical addresses set ``num_log_addrs`` to 0. All other fields
51 will be ignored in that case. The adapter will go to the unconfigured state.
53 If the physical address is valid (see :ref:`ioctl CEC_ADAP_S_PHYS_ADDR <CEC_ADAP_S_PHYS_ADDR>`),
54 then this ioctl will block until all requested logical
55 addresses have been claimed. If the file descriptor is in non-blocking mode then it will
56 not wait for the logical addresses to be claimed, instead it just returns 0.
58 A :ref:`CEC_EVENT_STATE_CHANGE <CEC-EVENT-STATE-CHANGE>` event is sent when the
59 logical addresses are claimed or cleared.
61 Attempting to call :ref:`ioctl CEC_ADAP_S_LOG_ADDRS <CEC_ADAP_S_LOG_ADDRS>` when
62 logical address types are already defined will return with error ``EBUSY``.
64 .. c:type:: cec_log_addrs
66 .. tabularcolumns:: |p{1.0cm}|p{7.5cm}|p{8.0cm}|
68 .. cssclass:: longtable
70 .. flat-table:: struct cec_log_addrs
76 - ``log_addr[CEC_MAX_LOG_ADDRS]``
77 - The actual logical addresses that were claimed. This is set by the
78 driver. If no logical address could be claimed, then it is set to
79 ``CEC_LOG_ADDR_INVALID``. If this adapter is Unregistered, then
80 ``log_addr[0]`` is set to 0xf and all others to
81 ``CEC_LOG_ADDR_INVALID``.
84 - The bitmask of all logical addresses this adapter has claimed. If
85 this adapter is Unregistered then ``log_addr_mask`` sets bit 15
86 and clears all other bits. If this adapter is not configured at
87 all, then ``log_addr_mask`` is set to 0. Set by the driver.
90 - The CEC version that this adapter shall use. See
91 :ref:`cec-versions`. Used to implement the
92 ``CEC_MSG_CEC_VERSION`` and ``CEC_MSG_REPORT_FEATURES`` messages.
93 Note that :ref:`CEC_OP_CEC_VERSION_1_3A <CEC-OP-CEC-VERSION-1-3A>` is not allowed by the CEC
97 - Number of logical addresses to set up. Must be ≤
98 ``available_log_addrs`` as returned by
99 :ref:`CEC_ADAP_G_CAPS`. All arrays in
100 this structure are only filled up to index
101 ``available_log_addrs``-1. The remaining array elements will be
102 ignored. Note that the CEC 2.0 standard allows for a maximum of 2
103 logical addresses, although some hardware has support for more.
104 ``CEC_MAX_LOG_ADDRS`` is 4. The driver will return the actual
105 number of logical addresses it could claim, which may be less than
106 what was requested. If this field is set to 0, then the CEC
107 adapter shall clear all claimed logical addresses and all other
108 fields will be ignored.
111 - The vendor ID is a 24-bit number that identifies the specific
112 vendor or entity. Based on this ID vendor specific commands may be
113 defined. If you do not want a vendor ID then set it to
114 ``CEC_VENDOR_ID_NONE``.
117 - Flags. See :ref:`cec-log-addrs-flags` for a list of available flags.
120 - The On-Screen Display name as is returned by the
121 ``CEC_MSG_SET_OSD_NAME`` message.
123 - ``primary_device_type[CEC_MAX_LOG_ADDRS]``
124 - Primary device type for each logical address. See
125 :ref:`cec-prim-dev-types` for possible types.
127 - ``log_addr_type[CEC_MAX_LOG_ADDRS]``
128 - Logical address types. See :ref:`cec-log-addr-types` for
129 possible types. The driver will update this with the actual
130 logical address type that it claimed (e.g. it may have to fallback
131 to :ref:`CEC_LOG_ADDR_TYPE_UNREGISTERED <CEC-LOG-ADDR-TYPE-UNREGISTERED>`).
133 - ``all_device_types[CEC_MAX_LOG_ADDRS]``
134 - CEC 2.0 specific: the bit mask of all device types. See
135 :ref:`cec-all-dev-types-flags`. It is used in the CEC 2.0
136 ``CEC_MSG_REPORT_FEATURES`` message. For CEC 1.4 you can either leave
137 this field to 0, or fill it in according to the CEC 2.0 guidelines to
138 give the CEC framework more information about the device type, even
139 though the framework won't use it directly in the CEC message.
141 - ``features[CEC_MAX_LOG_ADDRS][12]``
142 - Features for each logical address. It is used in the CEC 2.0
143 ``CEC_MSG_REPORT_FEATURES`` message. The 12 bytes include both the
144 RC Profile and the Device Features. For CEC 1.4 you can either leave
145 this field to all 0, or fill it in according to the CEC 2.0 guidelines to
146 give the CEC framework more information about the device type, even
147 though the framework won't use it directly in the CEC message.
149 .. _cec-log-addrs-flags:
151 .. flat-table:: Flags for struct cec_log_addrs
156 * .. _`CEC-LOG-ADDRS-FL-ALLOW-UNREG-FALLBACK`:
158 - ``CEC_LOG_ADDRS_FL_ALLOW_UNREG_FALLBACK``
160 - By default if no logical address of the requested type can be claimed, then
161 it will go back to the unconfigured state. If this flag is set, then it will
162 fallback to the Unregistered logical address. Note that if the Unregistered
163 logical address was explicitly requested, then this flag has no effect.
164 * .. _`CEC-LOG-ADDRS-FL-ALLOW-RC-PASSTHRU`:
166 - ``CEC_LOG_ADDRS_FL_ALLOW_RC_PASSTHRU``
168 - By default the ``CEC_MSG_USER_CONTROL_PRESSED`` and ``CEC_MSG_USER_CONTROL_RELEASED``
169 messages are only passed on to the follower(s), if any. If this flag is set,
170 then these messages are also passed on to the remote control input subsystem
171 and will appear as keystrokes. This features needs to be enabled explicitly.
172 If CEC is used to enter e.g. passwords, then you may not want to enable this
173 to avoid trivial snooping of the keystrokes.
174 * .. _`CEC-LOG-ADDRS-FL-CDC-ONLY`:
176 - `CEC_LOG_ADDRS_FL_CDC_ONLY`
178 - If this flag is set, then the device is CDC-Only. CDC-Only CEC devices
179 are CEC devices that can only handle CDC messages.
181 All other messages are ignored.
184 .. tabularcolumns:: |p{6.6cm}|p{2.2cm}|p{8.7cm}|
188 .. flat-table:: CEC Versions
193 * .. _`CEC-OP-CEC-VERSION-1-3A`:
195 - ``CEC_OP_CEC_VERSION_1_3A``
197 - CEC version according to the HDMI 1.3a standard.
198 * .. _`CEC-OP-CEC-VERSION-1-4B`:
200 - ``CEC_OP_CEC_VERSION_1_4B``
202 - CEC version according to the HDMI 1.4b standard.
203 * .. _`CEC-OP-CEC-VERSION-2-0`:
205 - ``CEC_OP_CEC_VERSION_2_0``
207 - CEC version according to the HDMI 2.0 standard.
210 .. tabularcolumns:: |p{6.6cm}|p{2.2cm}|p{8.7cm}|
212 .. _cec-prim-dev-types:
214 .. flat-table:: CEC Primary Device Types
219 * .. _`CEC-OP-PRIM-DEVTYPE-TV`:
221 - ``CEC_OP_PRIM_DEVTYPE_TV``
224 * .. _`CEC-OP-PRIM-DEVTYPE-RECORD`:
226 - ``CEC_OP_PRIM_DEVTYPE_RECORD``
228 - Use for a recording device.
229 * .. _`CEC-OP-PRIM-DEVTYPE-TUNER`:
231 - ``CEC_OP_PRIM_DEVTYPE_TUNER``
233 - Use for a device with a tuner.
234 * .. _`CEC-OP-PRIM-DEVTYPE-PLAYBACK`:
236 - ``CEC_OP_PRIM_DEVTYPE_PLAYBACK``
238 - Use for a playback device.
239 * .. _`CEC-OP-PRIM-DEVTYPE-AUDIOSYSTEM`:
241 - ``CEC_OP_PRIM_DEVTYPE_AUDIOSYSTEM``
243 - Use for an audio system (e.g. an audio/video receiver).
244 * .. _`CEC-OP-PRIM-DEVTYPE-SWITCH`:
246 - ``CEC_OP_PRIM_DEVTYPE_SWITCH``
248 - Use for a CEC switch.
249 * .. _`CEC-OP-PRIM-DEVTYPE-VIDEOPROC`:
251 - ``CEC_OP_PRIM_DEVTYPE_VIDEOPROC``
253 - Use for a video processor device.
256 .. tabularcolumns:: |p{6.6cm}|p{2.2cm}|p{8.7cm}|
258 .. _cec-log-addr-types:
260 .. flat-table:: CEC Logical Address Types
265 * .. _`CEC-LOG-ADDR-TYPE-TV`:
267 - ``CEC_LOG_ADDR_TYPE_TV``
270 * .. _`CEC-LOG-ADDR-TYPE-RECORD`:
272 - ``CEC_LOG_ADDR_TYPE_RECORD``
274 - Use for a recording device.
275 * .. _`CEC-LOG-ADDR-TYPE-TUNER`:
277 - ``CEC_LOG_ADDR_TYPE_TUNER``
279 - Use for a tuner device.
280 * .. _`CEC-LOG-ADDR-TYPE-PLAYBACK`:
282 - ``CEC_LOG_ADDR_TYPE_PLAYBACK``
284 - Use for a playback device.
285 * .. _`CEC-LOG-ADDR-TYPE-AUDIOSYSTEM`:
287 - ``CEC_LOG_ADDR_TYPE_AUDIOSYSTEM``
289 - Use for an audio system device.
290 * .. _`CEC-LOG-ADDR-TYPE-SPECIFIC`:
292 - ``CEC_LOG_ADDR_TYPE_SPECIFIC``
294 - Use for a second TV or for a video processor device.
295 * .. _`CEC-LOG-ADDR-TYPE-UNREGISTERED`:
297 - ``CEC_LOG_ADDR_TYPE_UNREGISTERED``
299 - Use this if you just want to remain unregistered. Used for pure
300 CEC switches or CDC-only devices (CDC: Capability Discovery and
305 .. tabularcolumns:: |p{6.6cm}|p{2.2cm}|p{8.7cm}|
307 .. _cec-all-dev-types-flags:
309 .. flat-table:: CEC All Device Types Flags
314 * .. _`CEC-OP-ALL-DEVTYPE-TV`:
316 - ``CEC_OP_ALL_DEVTYPE_TV``
318 - This supports the TV type.
319 * .. _`CEC-OP-ALL-DEVTYPE-RECORD`:
321 - ``CEC_OP_ALL_DEVTYPE_RECORD``
323 - This supports the Recording type.
324 * .. _`CEC-OP-ALL-DEVTYPE-TUNER`:
326 - ``CEC_OP_ALL_DEVTYPE_TUNER``
328 - This supports the Tuner type.
329 * .. _`CEC-OP-ALL-DEVTYPE-PLAYBACK`:
331 - ``CEC_OP_ALL_DEVTYPE_PLAYBACK``
333 - This supports the Playback type.
334 * .. _`CEC-OP-ALL-DEVTYPE-AUDIOSYSTEM`:
336 - ``CEC_OP_ALL_DEVTYPE_AUDIOSYSTEM``
338 - This supports the Audio System type.
339 * .. _`CEC-OP-ALL-DEVTYPE-SWITCH`:
341 - ``CEC_OP_ALL_DEVTYPE_SWITCH``
343 - This supports the CEC Switch or Video Processing type.
350 On success 0 is returned, on error -1 and the ``errno`` variable is set
351 appropriately. The generic error codes are described at the
352 :ref:`Generic Error Codes <gen-errors>` chapter.