1 /* SPDX-License-Identifier: ((GPL-2.0 WITH Linux-syscall-note) OR BSD-3-Clause) */
2 /*
3 * cec - HDMI Consumer Electronics Control public header
4 *
5 * Copyright 2016 Cisco Systems, Inc. and/or its affiliates. All rights reserved.
6 */
7
8 #ifndef _CEC_UAPI_H
9 #define _CEC_UAPI_H
10
11 #include <linux/types.h>
12 #include <linux/string.h>
13
14 #define CEC_MAX_MSG_SIZE 16
15
16 /**
17 * struct cec_msg - CEC message structure.
18 * @tx_ts: Timestamp in nanoseconds using CLOCK_MONOTONIC. Set by the
19 * driver when the message transmission has finished.
20 * @rx_ts: Timestamp in nanoseconds using CLOCK_MONOTONIC. Set by the
21 * driver when the message was received.
22 * @len: Length in bytes of the message.
23 * @timeout: The timeout (in ms) that is used to timeout CEC_RECEIVE.
24 * Set to 0 if you want to wait forever. This timeout can also be
25 * used with CEC_TRANSMIT as the timeout for waiting for a reply.
26 * If 0, then it will use a 1 second timeout instead of waiting
27 * forever as is done with CEC_RECEIVE.
28 * @sequence: The framework assigns a sequence number to messages that are
29 * sent. This can be used to track replies to previously sent
30 * messages.
31 * @flags: Set to 0.
32 * @msg: The message payload.
33 * @reply: This field is ignored with CEC_RECEIVE and is only used by
34 * CEC_TRANSMIT. If non-zero, then wait for a reply with this
35 * opcode. Set to CEC_MSG_FEATURE_ABORT if you want to wait for
36 * a possible ABORT reply. If there was an error when sending the
37 * msg or FeatureAbort was returned, then reply is set to 0.
38 * If reply is non-zero upon return, then len/msg are set to
39 * the received message.
40 * If reply is zero upon return and status has the
41 * CEC_TX_STATUS_FEATURE_ABORT bit set, then len/msg are set to
42 * the received feature abort message.
43 * If reply is zero upon return and status has the
44 * CEC_TX_STATUS_MAX_RETRIES bit set, then no reply was seen at
45 * all. If reply is non-zero for CEC_TRANSMIT and the message is a
46 * broadcast, then -EINVAL is returned.
47 * if reply is non-zero, then timeout is set to 1000 (the required
48 * maximum response time).
49 * @rx_status: The message receive status bits. Set by the driver.
50 * @tx_status: The message transmit status bits. Set by the driver.
51 * @tx_arb_lost_cnt: The number of 'Arbitration Lost' events. Set by the driver.
52 * @tx_nack_cnt: The number of 'Not Acknowledged' events. Set by the driver.
53 * @tx_low_drive_cnt: The number of 'Low Drive Detected' events. Set by the
54 * driver.
55 * @tx_error_cnt: The number of 'Error' events. Set by the driver.
56 */
57 struct cec_msg {
58 __u64 tx_ts;
59 __u64 rx_ts;
60 __u32 len;
61 __u32 timeout;
62 __u32 sequence;
63 __u32 flags;
64 __u8 msg[CEC_MAX_MSG_SIZE];
65 __u8 reply;
66 __u8 rx_status;
67 __u8 tx_status;
68 __u8 tx_arb_lost_cnt;
69 __u8 tx_nack_cnt;
70 __u8 tx_low_drive_cnt;
71 __u8 tx_error_cnt;
72 };
73
74 /**
75 * cec_msg_initiator - return the initiator's logical address.
76 * @msg: the message structure
77 */
cec_msg_initiator(const struct cec_msg * msg)78 static inline __u8 cec_msg_initiator(const struct cec_msg *msg)
79 {
80 return msg->msg[0] >> 4;
81 }
82
83 /**
84 * cec_msg_destination - return the destination's logical address.
85 * @msg: the message structure
86 */
cec_msg_destination(const struct cec_msg * msg)87 static inline __u8 cec_msg_destination(const struct cec_msg *msg)
88 {
89 return msg->msg[0] & 0xf;
90 }
91
92 /**
93 * cec_msg_opcode - return the opcode of the message, -1 for poll
94 * @msg: the message structure
95 */
cec_msg_opcode(const struct cec_msg * msg)96 static inline int cec_msg_opcode(const struct cec_msg *msg)
97 {
98 return msg->len > 1 ? msg->msg[1] : -1;
99 }
100
101 /**
102 * cec_msg_is_broadcast - return true if this is a broadcast message.
103 * @msg: the message structure
104 */
cec_msg_is_broadcast(const struct cec_msg * msg)105 static inline int cec_msg_is_broadcast(const struct cec_msg *msg)
106 {
107 return (msg->msg[0] & 0xf) == 0xf;
108 }
109
110 /**
111 * cec_msg_init - initialize the message structure.
112 * @msg: the message structure
113 * @initiator: the logical address of the initiator
114 * @destination:the logical address of the destination (0xf for broadcast)
115 *
116 * The whole structure is zeroed, the len field is set to 1 (i.e. a poll
117 * message) and the initiator and destination are filled in.
118 */
cec_msg_init(struct cec_msg * msg,__u8 initiator,__u8 destination)119 static inline void cec_msg_init(struct cec_msg *msg,
120 __u8 initiator, __u8 destination)
121 {
122 memset(msg, 0, sizeof(*msg));
123 msg->msg[0] = (initiator << 4) | destination;
124 msg->len = 1;
125 }
126
127 /**
128 * cec_msg_set_reply_to - fill in destination/initiator in a reply message.
129 * @msg: the message structure for the reply
130 * @orig: the original message structure
131 *
132 * Set the msg destination to the orig initiator and the msg initiator to the
133 * orig destination. Note that msg and orig may be the same pointer, in which
134 * case the change is done in place.
135 *
136 * It also zeroes the reply, timeout and flags fields.
137 */
cec_msg_set_reply_to(struct cec_msg * msg,struct cec_msg * orig)138 static inline void cec_msg_set_reply_to(struct cec_msg *msg,
139 struct cec_msg *orig)
140 {
141 /* The destination becomes the initiator and vice versa */
142 msg->msg[0] = (cec_msg_destination(orig) << 4) |
143 cec_msg_initiator(orig);
144 msg->reply = 0;
145 msg->timeout = 0;
146 msg->flags = 0;
147 }
148
149 /**
150 * cec_msg_recv_is_tx_result - return true if this message contains the
151 * result of an earlier non-blocking transmit
152 * @msg: the message structure from CEC_RECEIVE
153 */
cec_msg_recv_is_tx_result(const struct cec_msg * msg)154 static inline int cec_msg_recv_is_tx_result(const struct cec_msg *msg)
155 {
156 return msg->sequence && msg->tx_status && !msg->rx_status;
157 }
158
159 /**
160 * cec_msg_recv_is_rx_result - return true if this message contains the
161 * reply of an earlier non-blocking transmit
162 * @msg: the message structure from CEC_RECEIVE
163 */
cec_msg_recv_is_rx_result(const struct cec_msg * msg)164 static inline int cec_msg_recv_is_rx_result(const struct cec_msg *msg)
165 {
166 return msg->sequence && !msg->tx_status && msg->rx_status;
167 }
168
169 /* cec_msg flags field */
170 #define CEC_MSG_FL_REPLY_TO_FOLLOWERS (1 << 0)
171 #define CEC_MSG_FL_RAW (1 << 1)
172
173 /* cec_msg tx/rx_status field */
174 #define CEC_TX_STATUS_OK (1 << 0)
175 #define CEC_TX_STATUS_ARB_LOST (1 << 1)
176 #define CEC_TX_STATUS_NACK (1 << 2)
177 #define CEC_TX_STATUS_LOW_DRIVE (1 << 3)
178 #define CEC_TX_STATUS_ERROR (1 << 4)
179 #define CEC_TX_STATUS_MAX_RETRIES (1 << 5)
180 #define CEC_TX_STATUS_ABORTED (1 << 6)
181 #define CEC_TX_STATUS_TIMEOUT (1 << 7)
182
183 #define CEC_RX_STATUS_OK (1 << 0)
184 #define CEC_RX_STATUS_TIMEOUT (1 << 1)
185 #define CEC_RX_STATUS_FEATURE_ABORT (1 << 2)
186 #define CEC_RX_STATUS_ABORTED (1 << 3)
187
cec_msg_status_is_ok(const struct cec_msg * msg)188 static inline int cec_msg_status_is_ok(const struct cec_msg *msg)
189 {
190 if (msg->tx_status && !(msg->tx_status & CEC_TX_STATUS_OK))
191 return 0;
192 if (msg->rx_status && !(msg->rx_status & CEC_RX_STATUS_OK))
193 return 0;
194 if (!msg->tx_status && !msg->rx_status)
195 return 0;
196 return !(msg->rx_status & CEC_RX_STATUS_FEATURE_ABORT);
197 }
198
199 #define CEC_LOG_ADDR_INVALID 0xff
200 #define CEC_PHYS_ADDR_INVALID 0xffff
201
202 /*
203 * The maximum number of logical addresses one device can be assigned to.
204 * The CEC 2.0 spec allows for only 2 logical addresses at the moment. The
205 * Analog Devices CEC hardware supports 3. So let's go wild and go for 4.
206 */
207 #define CEC_MAX_LOG_ADDRS 4
208
209 /* The logical addresses defined by CEC 2.0 */
210 #define CEC_LOG_ADDR_TV 0
211 #define CEC_LOG_ADDR_RECORD_1 1
212 #define CEC_LOG_ADDR_RECORD_2 2
213 #define CEC_LOG_ADDR_TUNER_1 3
214 #define CEC_LOG_ADDR_PLAYBACK_1 4
215 #define CEC_LOG_ADDR_AUDIOSYSTEM 5
216 #define CEC_LOG_ADDR_TUNER_2 6
217 #define CEC_LOG_ADDR_TUNER_3 7
218 #define CEC_LOG_ADDR_PLAYBACK_2 8
219 #define CEC_LOG_ADDR_RECORD_3 9
220 #define CEC_LOG_ADDR_TUNER_4 10
221 #define CEC_LOG_ADDR_PLAYBACK_3 11
222 #define CEC_LOG_ADDR_BACKUP_1 12
223 #define CEC_LOG_ADDR_BACKUP_2 13
224 #define CEC_LOG_ADDR_SPECIFIC 14
225 #define CEC_LOG_ADDR_UNREGISTERED 15 /* as initiator address */
226 #define CEC_LOG_ADDR_BROADCAST 15 /* as destination address */
227
228 /* The logical address types that the CEC device wants to claim */
229 #define CEC_LOG_ADDR_TYPE_TV 0
230 #define CEC_LOG_ADDR_TYPE_RECORD 1
231 #define CEC_LOG_ADDR_TYPE_TUNER 2
232 #define CEC_LOG_ADDR_TYPE_PLAYBACK 3
233 #define CEC_LOG_ADDR_TYPE_AUDIOSYSTEM 4
234 #define CEC_LOG_ADDR_TYPE_SPECIFIC 5
235 #define CEC_LOG_ADDR_TYPE_UNREGISTERED 6
236 /*
237 * Switches should use UNREGISTERED.
238 * Processors should use SPECIFIC.
239 */
240
241 #define CEC_LOG_ADDR_MASK_TV (1 << CEC_LOG_ADDR_TV)
242 #define CEC_LOG_ADDR_MASK_RECORD ((1 << CEC_LOG_ADDR_RECORD_1) | \
243 (1 << CEC_LOG_ADDR_RECORD_2) | \
244 (1 << CEC_LOG_ADDR_RECORD_3))
245 #define CEC_LOG_ADDR_MASK_TUNER ((1 << CEC_LOG_ADDR_TUNER_1) | \
246 (1 << CEC_LOG_ADDR_TUNER_2) | \
247 (1 << CEC_LOG_ADDR_TUNER_3) | \
248 (1 << CEC_LOG_ADDR_TUNER_4))
249 #define CEC_LOG_ADDR_MASK_PLAYBACK ((1 << CEC_LOG_ADDR_PLAYBACK_1) | \
250 (1 << CEC_LOG_ADDR_PLAYBACK_2) | \
251 (1 << CEC_LOG_ADDR_PLAYBACK_3))
252 #define CEC_LOG_ADDR_MASK_AUDIOSYSTEM (1 << CEC_LOG_ADDR_AUDIOSYSTEM)
253 #define CEC_LOG_ADDR_MASK_BACKUP ((1 << CEC_LOG_ADDR_BACKUP_1) | \
254 (1 << CEC_LOG_ADDR_BACKUP_2))
255 #define CEC_LOG_ADDR_MASK_SPECIFIC (1 << CEC_LOG_ADDR_SPECIFIC)
256 #define CEC_LOG_ADDR_MASK_UNREGISTERED (1 << CEC_LOG_ADDR_UNREGISTERED)
257
cec_has_tv(__u16 log_addr_mask)258 static inline int cec_has_tv(__u16 log_addr_mask)
259 {
260 return log_addr_mask & CEC_LOG_ADDR_MASK_TV;
261 }
262
cec_has_record(__u16 log_addr_mask)263 static inline int cec_has_record(__u16 log_addr_mask)
264 {
265 return log_addr_mask & CEC_LOG_ADDR_MASK_RECORD;
266 }
267
cec_has_tuner(__u16 log_addr_mask)268 static inline int cec_has_tuner(__u16 log_addr_mask)
269 {
270 return log_addr_mask & CEC_LOG_ADDR_MASK_TUNER;
271 }
272
cec_has_playback(__u16 log_addr_mask)273 static inline int cec_has_playback(__u16 log_addr_mask)
274 {
275 return log_addr_mask & CEC_LOG_ADDR_MASK_PLAYBACK;
276 }
277
cec_has_audiosystem(__u16 log_addr_mask)278 static inline int cec_has_audiosystem(__u16 log_addr_mask)
279 {
280 return log_addr_mask & CEC_LOG_ADDR_MASK_AUDIOSYSTEM;
281 }
282
cec_has_backup(__u16 log_addr_mask)283 static inline int cec_has_backup(__u16 log_addr_mask)
284 {
285 return log_addr_mask & CEC_LOG_ADDR_MASK_BACKUP;
286 }
287
cec_has_specific(__u16 log_addr_mask)288 static inline int cec_has_specific(__u16 log_addr_mask)
289 {
290 return log_addr_mask & CEC_LOG_ADDR_MASK_SPECIFIC;
291 }
292
cec_is_unregistered(__u16 log_addr_mask)293 static inline int cec_is_unregistered(__u16 log_addr_mask)
294 {
295 return log_addr_mask & CEC_LOG_ADDR_MASK_UNREGISTERED;
296 }
297
cec_is_unconfigured(__u16 log_addr_mask)298 static inline int cec_is_unconfigured(__u16 log_addr_mask)
299 {
300 return log_addr_mask == 0;
301 }
302
303 /*
304 * Use this if there is no vendor ID (CEC_G_VENDOR_ID) or if the vendor ID
305 * should be disabled (CEC_S_VENDOR_ID)
306 */
307 #define CEC_VENDOR_ID_NONE 0xffffffff
308
309 /* The message handling modes */
310 /* Modes for initiator */
311 #define CEC_MODE_NO_INITIATOR (0x0 << 0)
312 #define CEC_MODE_INITIATOR (0x1 << 0)
313 #define CEC_MODE_EXCL_INITIATOR (0x2 << 0)
314 #define CEC_MODE_INITIATOR_MSK 0x0f
315
316 /* Modes for follower */
317 #define CEC_MODE_NO_FOLLOWER (0x0 << 4)
318 #define CEC_MODE_FOLLOWER (0x1 << 4)
319 #define CEC_MODE_EXCL_FOLLOWER (0x2 << 4)
320 #define CEC_MODE_EXCL_FOLLOWER_PASSTHRU (0x3 << 4)
321 #define CEC_MODE_MONITOR_PIN (0xd << 4)
322 #define CEC_MODE_MONITOR (0xe << 4)
323 #define CEC_MODE_MONITOR_ALL (0xf << 4)
324 #define CEC_MODE_FOLLOWER_MSK 0xf0
325
326 /* Userspace has to configure the physical address */
327 #define CEC_CAP_PHYS_ADDR (1 << 0)
328 /* Userspace has to configure the logical addresses */
329 #define CEC_CAP_LOG_ADDRS (1 << 1)
330 /* Userspace can transmit messages (and thus become follower as well) */
331 #define CEC_CAP_TRANSMIT (1 << 2)
332 /*
333 * Passthrough all messages instead of processing them.
334 */
335 #define CEC_CAP_PASSTHROUGH (1 << 3)
336 /* Supports remote control */
337 #define CEC_CAP_RC (1 << 4)
338 /* Hardware can monitor all messages, not just directed and broadcast. */
339 #define CEC_CAP_MONITOR_ALL (1 << 5)
340 /* Hardware can use CEC only if the HDMI HPD pin is high. */
341 #define CEC_CAP_NEEDS_HPD (1 << 6)
342 /* Hardware can monitor CEC pin transitions */
343 #define CEC_CAP_MONITOR_PIN (1 << 7)
344 /* CEC_ADAP_G_CONNECTOR_INFO is available */
345 #define CEC_CAP_CONNECTOR_INFO (1 << 8)
346
347 /**
348 * struct cec_caps - CEC capabilities structure.
349 * @driver: name of the CEC device driver.
350 * @name: name of the CEC device. @driver + @name must be unique.
351 * @available_log_addrs: number of available logical addresses.
352 * @capabilities: capabilities of the CEC adapter.
353 * @version: version of the CEC adapter framework.
354 */
355 struct cec_caps {
356 char driver[32];
357 char name[32];
358 __u32 available_log_addrs;
359 __u32 capabilities;
360 __u32 version;
361 };
362
363 /**
364 * struct cec_log_addrs - CEC logical addresses structure.
365 * @log_addr: the claimed logical addresses. Set by the driver.
366 * @log_addr_mask: current logical address mask. Set by the driver.
367 * @cec_version: the CEC version that the adapter should implement. Set by the
368 * caller.
369 * @num_log_addrs: how many logical addresses should be claimed. Set by the
370 * caller.
371 * @vendor_id: the vendor ID of the device. Set by the caller.
372 * @flags: flags.
373 * @osd_name: the OSD name of the device. Set by the caller.
374 * @primary_device_type: the primary device type for each logical address.
375 * Set by the caller.
376 * @log_addr_type: the logical address types. Set by the caller.
377 * @all_device_types: CEC 2.0: all device types represented by the logical
378 * address. Set by the caller.
379 * @features: CEC 2.0: The logical address features. Set by the caller.
380 */
381 struct cec_log_addrs {
382 __u8 log_addr[CEC_MAX_LOG_ADDRS];
383 __u16 log_addr_mask;
384 __u8 cec_version;
385 __u8 num_log_addrs;
386 __u32 vendor_id;
387 __u32 flags;
388 char osd_name[15];
389 __u8 primary_device_type[CEC_MAX_LOG_ADDRS];
390 __u8 log_addr_type[CEC_MAX_LOG_ADDRS];
391
392 /* CEC 2.0 */
393 __u8 all_device_types[CEC_MAX_LOG_ADDRS];
394 __u8 features[CEC_MAX_LOG_ADDRS][12];
395 };
396
397 /* Allow a fallback to unregistered */
398 #define CEC_LOG_ADDRS_FL_ALLOW_UNREG_FALLBACK (1 << 0)
399 /* Passthrough RC messages to the input subsystem */
400 #define CEC_LOG_ADDRS_FL_ALLOW_RC_PASSTHRU (1 << 1)
401 /* CDC-Only device: supports only CDC messages */
402 #define CEC_LOG_ADDRS_FL_CDC_ONLY (1 << 2)
403
404 /**
405 * struct cec_drm_connector_info - tells which drm connector is
406 * associated with the CEC adapter.
407 * @card_no: drm card number
408 * @connector_id: drm connector ID
409 */
410 struct cec_drm_connector_info {
411 __u32 card_no;
412 __u32 connector_id;
413 };
414
415 #define CEC_CONNECTOR_TYPE_NO_CONNECTOR 0
416 #define CEC_CONNECTOR_TYPE_DRM 1
417
418 /**
419 * struct cec_connector_info - tells if and which connector is
420 * associated with the CEC adapter.
421 * @type: connector type (if any)
422 * @drm: drm connector info
423 * @raw: array to pad the union
424 */
425 struct cec_connector_info {
426 __u32 type;
427 union {
428 struct cec_drm_connector_info drm;
429 __u32 raw[16];
430 };
431 };
432
433 /* Events */
434
435 /* Event that occurs when the adapter state changes */
436 #define CEC_EVENT_STATE_CHANGE 1
437 /*
438 * This event is sent when messages are lost because the application
439 * didn't empty the message queue in time
440 */
441 #define CEC_EVENT_LOST_MSGS 2
442 #define CEC_EVENT_PIN_CEC_LOW 3
443 #define CEC_EVENT_PIN_CEC_HIGH 4
444 #define CEC_EVENT_PIN_HPD_LOW 5
445 #define CEC_EVENT_PIN_HPD_HIGH 6
446 #define CEC_EVENT_PIN_5V_LOW 7
447 #define CEC_EVENT_PIN_5V_HIGH 8
448
449 #define CEC_EVENT_FL_INITIAL_STATE (1 << 0)
450 #define CEC_EVENT_FL_DROPPED_EVENTS (1 << 1)
451
452 /**
453 * struct cec_event_state_change - used when the CEC adapter changes state.
454 * @phys_addr: the current physical address
455 * @log_addr_mask: the current logical address mask
456 * @have_conn_info: if non-zero, then HDMI connector information is available.
457 * This field is only valid if CEC_CAP_CONNECTOR_INFO is set. If that
458 * capability is set and @have_conn_info is zero, then that indicates
459 * that the HDMI connector device is not instantiated, either because
460 * the HDMI driver is still configuring the device or because the HDMI
461 * device was unbound.
462 */
463 struct cec_event_state_change {
464 __u16 phys_addr;
465 __u16 log_addr_mask;
466 __u16 have_conn_info;
467 };
468
469 /**
470 * struct cec_event_lost_msgs - tells you how many messages were lost.
471 * @lost_msgs: how many messages were lost.
472 */
473 struct cec_event_lost_msgs {
474 __u32 lost_msgs;
475 };
476
477 /**
478 * struct cec_event - CEC event structure
479 * @ts: the timestamp of when the event was sent.
480 * @event: the event.
481 * @flags: event flags.
482 * @state_change: the event payload for CEC_EVENT_STATE_CHANGE.
483 * @lost_msgs: the event payload for CEC_EVENT_LOST_MSGS.
484 * @raw: array to pad the union.
485 */
486 struct cec_event {
487 __u64 ts;
488 __u32 event;
489 __u32 flags;
490 union {
491 struct cec_event_state_change state_change;
492 struct cec_event_lost_msgs lost_msgs;
493 __u32 raw[16];
494 };
495 };
496
497 /* ioctls */
498
499 /* Adapter capabilities */
500 #define CEC_ADAP_G_CAPS _IOWR('a', 0, struct cec_caps)
501
502 /*
503 * phys_addr is either 0 (if this is the CEC root device)
504 * or a valid physical address obtained from the sink's EDID
505 * as read by this CEC device (if this is a source device)
506 * or a physical address obtained and modified from a sink
507 * EDID and used for a sink CEC device.
508 * If nothing is connected, then phys_addr is 0xffff.
509 * See HDMI 1.4b, section 8.7 (Physical Address).
510 *
511 * The CEC_ADAP_S_PHYS_ADDR ioctl may not be available if that is handled
512 * internally.
513 */
514 #define CEC_ADAP_G_PHYS_ADDR _IOR('a', 1, __u16)
515 #define CEC_ADAP_S_PHYS_ADDR _IOW('a', 2, __u16)
516
517 /*
518 * Configure the CEC adapter. It sets the device type and which
519 * logical types it will try to claim. It will return which
520 * logical addresses it could actually claim.
521 * An error is returned if the adapter is disabled or if there
522 * is no physical address assigned.
523 */
524
525 #define CEC_ADAP_G_LOG_ADDRS _IOR('a', 3, struct cec_log_addrs)
526 #define CEC_ADAP_S_LOG_ADDRS _IOWR('a', 4, struct cec_log_addrs)
527
528 /* Transmit/receive a CEC command */
529 #define CEC_TRANSMIT _IOWR('a', 5, struct cec_msg)
530 #define CEC_RECEIVE _IOWR('a', 6, struct cec_msg)
531
532 /* Dequeue CEC events */
533 #define CEC_DQEVENT _IOWR('a', 7, struct cec_event)
534
535 /*
536 * Get and set the message handling mode for this filehandle.
537 */
538 #define CEC_G_MODE _IOR('a', 8, __u32)
539 #define CEC_S_MODE _IOW('a', 9, __u32)
540
541 /* Get the connector info */
542 #define CEC_ADAP_G_CONNECTOR_INFO _IOR('a', 10, struct cec_connector_info)
543
544 /*
545 * The remainder of this header defines all CEC messages and operands.
546 * The format matters since it the cec-ctl utility parses it to generate
547 * code for implementing all these messages.
548 *
549 * Comments ending with 'Feature' group messages for each feature.
550 * If messages are part of multiple features, then the "Has also"
551 * comment is used to list the previously defined messages that are
552 * supported by the feature.
553 *
554 * Before operands are defined a comment is added that gives the
555 * name of the operand and in brackets the variable name of the
556 * corresponding argument in the cec-funcs.h function.
557 */
558
559 /* Messages */
560
561 /* One Touch Play Feature */
562 #define CEC_MSG_ACTIVE_SOURCE 0x82
563 #define CEC_MSG_IMAGE_VIEW_ON 0x04
564 #define CEC_MSG_TEXT_VIEW_ON 0x0d
565
566
567 /* Routing Control Feature */
568
569 /*
570 * Has also:
571 * CEC_MSG_ACTIVE_SOURCE
572 */
573
574 #define CEC_MSG_INACTIVE_SOURCE 0x9d
575 #define CEC_MSG_REQUEST_ACTIVE_SOURCE 0x85
576 #define CEC_MSG_ROUTING_CHANGE 0x80
577 #define CEC_MSG_ROUTING_INFORMATION 0x81
578 #define CEC_MSG_SET_STREAM_PATH 0x86
579
580
581 /* Standby Feature */
582 #define CEC_MSG_STANDBY 0x36
583
584
585 /* One Touch Record Feature */
586 #define CEC_MSG_RECORD_OFF 0x0b
587 #define CEC_MSG_RECORD_ON 0x09
588 /* Record Source Type Operand (rec_src_type) */
589 #define CEC_OP_RECORD_SRC_OWN 1
590 #define CEC_OP_RECORD_SRC_DIGITAL 2
591 #define CEC_OP_RECORD_SRC_ANALOG 3
592 #define CEC_OP_RECORD_SRC_EXT_PLUG 4
593 #define CEC_OP_RECORD_SRC_EXT_PHYS_ADDR 5
594 /* Service Identification Method Operand (service_id_method) */
595 #define CEC_OP_SERVICE_ID_METHOD_BY_DIG_ID 0
596 #define CEC_OP_SERVICE_ID_METHOD_BY_CHANNEL 1
597 /* Digital Service Broadcast System Operand (dig_bcast_system) */
598 #define CEC_OP_DIG_SERVICE_BCAST_SYSTEM_ARIB_GEN 0x00
599 #define CEC_OP_DIG_SERVICE_BCAST_SYSTEM_ATSC_GEN 0x01
600 #define CEC_OP_DIG_SERVICE_BCAST_SYSTEM_DVB_GEN 0x02
601 #define CEC_OP_DIG_SERVICE_BCAST_SYSTEM_ARIB_BS 0x08
602 #define CEC_OP_DIG_SERVICE_BCAST_SYSTEM_ARIB_CS 0x09
603 #define CEC_OP_DIG_SERVICE_BCAST_SYSTEM_ARIB_T 0x0a
604 #define CEC_OP_DIG_SERVICE_BCAST_SYSTEM_ATSC_CABLE 0x10
605 #define CEC_OP_DIG_SERVICE_BCAST_SYSTEM_ATSC_SAT 0x11
606 #define CEC_OP_DIG_SERVICE_BCAST_SYSTEM_ATSC_T 0x12
607 #define CEC_OP_DIG_SERVICE_BCAST_SYSTEM_DVB_C 0x18
608 #define CEC_OP_DIG_SERVICE_BCAST_SYSTEM_DVB_S 0x19
609 #define CEC_OP_DIG_SERVICE_BCAST_SYSTEM_DVB_S2 0x1a
610 #define CEC_OP_DIG_SERVICE_BCAST_SYSTEM_DVB_T 0x1b
611 /* Analogue Broadcast Type Operand (ana_bcast_type) */
612 #define CEC_OP_ANA_BCAST_TYPE_CABLE 0
613 #define CEC_OP_ANA_BCAST_TYPE_SATELLITE 1
614 #define CEC_OP_ANA_BCAST_TYPE_TERRESTRIAL 2
615 /* Broadcast System Operand (bcast_system) */
616 #define CEC_OP_BCAST_SYSTEM_PAL_BG 0x00
617 #define CEC_OP_BCAST_SYSTEM_SECAM_LQ 0x01 /* SECAM L' */
618 #define CEC_OP_BCAST_SYSTEM_PAL_M 0x02
619 #define CEC_OP_BCAST_SYSTEM_NTSC_M 0x03
620 #define CEC_OP_BCAST_SYSTEM_PAL_I 0x04
621 #define CEC_OP_BCAST_SYSTEM_SECAM_DK 0x05
622 #define CEC_OP_BCAST_SYSTEM_SECAM_BG 0x06
623 #define CEC_OP_BCAST_SYSTEM_SECAM_L 0x07
624 #define CEC_OP_BCAST_SYSTEM_PAL_DK 0x08
625 #define CEC_OP_BCAST_SYSTEM_OTHER 0x1f
626 /* Channel Number Format Operand (channel_number_fmt) */
627 #define CEC_OP_CHANNEL_NUMBER_FMT_1_PART 0x01
628 #define CEC_OP_CHANNEL_NUMBER_FMT_2_PART 0x02
629
630 #define CEC_MSG_RECORD_STATUS 0x0a
631 /* Record Status Operand (rec_status) */
632 #define CEC_OP_RECORD_STATUS_CUR_SRC 0x01
633 #define CEC_OP_RECORD_STATUS_DIG_SERVICE 0x02
634 #define CEC_OP_RECORD_STATUS_ANA_SERVICE 0x03
635 #define CEC_OP_RECORD_STATUS_EXT_INPUT 0x04
636 #define CEC_OP_RECORD_STATUS_NO_DIG_SERVICE 0x05
637 #define CEC_OP_RECORD_STATUS_NO_ANA_SERVICE 0x06
638 #define CEC_OP_RECORD_STATUS_NO_SERVICE 0x07
639 #define CEC_OP_RECORD_STATUS_INVALID_EXT_PLUG 0x09
640 #define CEC_OP_RECORD_STATUS_INVALID_EXT_PHYS_ADDR 0x0a
641 #define CEC_OP_RECORD_STATUS_UNSUP_CA 0x0b
642 #define CEC_OP_RECORD_STATUS_NO_CA_ENTITLEMENTS 0x0c
643 #define CEC_OP_RECORD_STATUS_CANT_COPY_SRC 0x0d
644 #define CEC_OP_RECORD_STATUS_NO_MORE_COPIES 0x0e
645 #define CEC_OP_RECORD_STATUS_NO_MEDIA 0x10
646 #define CEC_OP_RECORD_STATUS_PLAYING 0x11
647 #define CEC_OP_RECORD_STATUS_ALREADY_RECORDING 0x12
648 #define CEC_OP_RECORD_STATUS_MEDIA_PROT 0x13
649 #define CEC_OP_RECORD_STATUS_NO_SIGNAL 0x14
650 #define CEC_OP_RECORD_STATUS_MEDIA_PROBLEM 0x15
651 #define CEC_OP_RECORD_STATUS_NO_SPACE 0x16
652 #define CEC_OP_RECORD_STATUS_PARENTAL_LOCK 0x17
653 #define CEC_OP_RECORD_STATUS_TERMINATED_OK 0x1a
654 #define CEC_OP_RECORD_STATUS_ALREADY_TERM 0x1b
655 #define CEC_OP_RECORD_STATUS_OTHER 0x1f
656
657 #define CEC_MSG_RECORD_TV_SCREEN 0x0f
658
659
660 /* Timer Programming Feature */
661 #define CEC_MSG_CLEAR_ANALOGUE_TIMER 0x33
662 /* Recording Sequence Operand (recording_seq) */
663 #define CEC_OP_REC_SEQ_SUNDAY 0x01
664 #define CEC_OP_REC_SEQ_MONDAY 0x02
665 #define CEC_OP_REC_SEQ_TUESDAY 0x04
666 #define CEC_OP_REC_SEQ_WEDNESDAY 0x08
667 #define CEC_OP_REC_SEQ_THURSDAY 0x10
668 #define CEC_OP_REC_SEQ_FRIDAY 0x20
669 #define CEC_OP_REC_SEQ_SATURDAY 0x40
670 #define CEC_OP_REC_SEQ_ONCE_ONLY 0x00
671
672 #define CEC_MSG_CLEAR_DIGITAL_TIMER 0x99
673
674 #define CEC_MSG_CLEAR_EXT_TIMER 0xa1
675 /* External Source Specifier Operand (ext_src_spec) */
676 #define CEC_OP_EXT_SRC_PLUG 0x04
677 #define CEC_OP_EXT_SRC_PHYS_ADDR 0x05
678
679 #define CEC_MSG_SET_ANALOGUE_TIMER 0x34
680 #define CEC_MSG_SET_DIGITAL_TIMER 0x97
681 #define CEC_MSG_SET_EXT_TIMER 0xa2
682
683 #define CEC_MSG_SET_TIMER_PROGRAM_TITLE 0x67
684 #define CEC_MSG_TIMER_CLEARED_STATUS 0x43
685 /* Timer Cleared Status Data Operand (timer_cleared_status) */
686 #define CEC_OP_TIMER_CLR_STAT_RECORDING 0x00
687 #define CEC_OP_TIMER_CLR_STAT_NO_MATCHING 0x01
688 #define CEC_OP_TIMER_CLR_STAT_NO_INFO 0x02
689 #define CEC_OP_TIMER_CLR_STAT_CLEARED 0x80
690
691 #define CEC_MSG_TIMER_STATUS 0x35
692 /* Timer Overlap Warning Operand (timer_overlap_warning) */
693 #define CEC_OP_TIMER_OVERLAP_WARNING_NO_OVERLAP 0
694 #define CEC_OP_TIMER_OVERLAP_WARNING_OVERLAP 1
695 /* Media Info Operand (media_info) */
696 #define CEC_OP_MEDIA_INFO_UNPROT_MEDIA 0
697 #define CEC_OP_MEDIA_INFO_PROT_MEDIA 1
698 #define CEC_OP_MEDIA_INFO_NO_MEDIA 2
699 /* Programmed Indicator Operand (prog_indicator) */
700 #define CEC_OP_PROG_IND_NOT_PROGRAMMED 0
701 #define CEC_OP_PROG_IND_PROGRAMMED 1
702 /* Programmed Info Operand (prog_info) */
703 #define CEC_OP_PROG_INFO_ENOUGH_SPACE 0x08
704 #define CEC_OP_PROG_INFO_NOT_ENOUGH_SPACE 0x09
705 #define CEC_OP_PROG_INFO_MIGHT_NOT_BE_ENOUGH_SPACE 0x0b
706 #define CEC_OP_PROG_INFO_NONE_AVAILABLE 0x0a
707 /* Not Programmed Error Info Operand (prog_error) */
708 #define CEC_OP_PROG_ERROR_NO_FREE_TIMER 0x01
709 #define CEC_OP_PROG_ERROR_DATE_OUT_OF_RANGE 0x02
710 #define CEC_OP_PROG_ERROR_REC_SEQ_ERROR 0x03
711 #define CEC_OP_PROG_ERROR_INV_EXT_PLUG 0x04
712 #define CEC_OP_PROG_ERROR_INV_EXT_PHYS_ADDR 0x05
713 #define CEC_OP_PROG_ERROR_CA_UNSUPP 0x06
714 #define CEC_OP_PROG_ERROR_INSUF_CA_ENTITLEMENTS 0x07
715 #define CEC_OP_PROG_ERROR_RESOLUTION_UNSUPP 0x08
716 #define CEC_OP_PROG_ERROR_PARENTAL_LOCK 0x09
717 #define CEC_OP_PROG_ERROR_CLOCK_FAILURE 0x0a
718 #define CEC_OP_PROG_ERROR_DUPLICATE 0x0e
719
720
721 /* System Information Feature */
722 #define CEC_MSG_CEC_VERSION 0x9e
723 /* CEC Version Operand (cec_version) */
724 #define CEC_OP_CEC_VERSION_1_3A 4
725 #define CEC_OP_CEC_VERSION_1_4 5
726 #define CEC_OP_CEC_VERSION_2_0 6
727
728 #define CEC_MSG_GET_CEC_VERSION 0x9f
729 #define CEC_MSG_GIVE_PHYSICAL_ADDR 0x83
730 #define CEC_MSG_GET_MENU_LANGUAGE 0x91
731 #define CEC_MSG_REPORT_PHYSICAL_ADDR 0x84
732 /* Primary Device Type Operand (prim_devtype) */
733 #define CEC_OP_PRIM_DEVTYPE_TV 0
734 #define CEC_OP_PRIM_DEVTYPE_RECORD 1
735 #define CEC_OP_PRIM_DEVTYPE_TUNER 3
736 #define CEC_OP_PRIM_DEVTYPE_PLAYBACK 4
737 #define CEC_OP_PRIM_DEVTYPE_AUDIOSYSTEM 5
738 #define CEC_OP_PRIM_DEVTYPE_SWITCH 6
739 #define CEC_OP_PRIM_DEVTYPE_PROCESSOR 7
740
741 #define CEC_MSG_SET_MENU_LANGUAGE 0x32
742 #define CEC_MSG_REPORT_FEATURES 0xa6 /* HDMI 2.0 */
743 /* All Device Types Operand (all_device_types) */
744 #define CEC_OP_ALL_DEVTYPE_TV 0x80
745 #define CEC_OP_ALL_DEVTYPE_RECORD 0x40
746 #define CEC_OP_ALL_DEVTYPE_TUNER 0x20
747 #define CEC_OP_ALL_DEVTYPE_PLAYBACK 0x10
748 #define CEC_OP_ALL_DEVTYPE_AUDIOSYSTEM 0x08
749 #define CEC_OP_ALL_DEVTYPE_SWITCH 0x04
750 /*
751 * And if you wondering what happened to PROCESSOR devices: those should
752 * be mapped to a SWITCH.
753 */
754
755 /* Valid for RC Profile and Device Feature operands */
756 #define CEC_OP_FEAT_EXT 0x80 /* Extension bit */
757 /* RC Profile Operand (rc_profile) */
758 #define CEC_OP_FEAT_RC_TV_PROFILE_NONE 0x00
759 #define CEC_OP_FEAT_RC_TV_PROFILE_1 0x02
760 #define CEC_OP_FEAT_RC_TV_PROFILE_2 0x06
761 #define CEC_OP_FEAT_RC_TV_PROFILE_3 0x0a
762 #define CEC_OP_FEAT_RC_TV_PROFILE_4 0x0e
763 #define CEC_OP_FEAT_RC_SRC_HAS_DEV_ROOT_MENU 0x50
764 #define CEC_OP_FEAT_RC_SRC_HAS_DEV_SETUP_MENU 0x48
765 #define CEC_OP_FEAT_RC_SRC_HAS_CONTENTS_MENU 0x44
766 #define CEC_OP_FEAT_RC_SRC_HAS_MEDIA_TOP_MENU 0x42
767 #define CEC_OP_FEAT_RC_SRC_HAS_MEDIA_CONTEXT_MENU 0x41
768 /* Device Feature Operand (dev_features) */
769 #define CEC_OP_FEAT_DEV_HAS_RECORD_TV_SCREEN 0x40
770 #define CEC_OP_FEAT_DEV_HAS_SET_OSD_STRING 0x20
771 #define CEC_OP_FEAT_DEV_HAS_DECK_CONTROL 0x10
772 #define CEC_OP_FEAT_DEV_HAS_SET_AUDIO_RATE 0x08
773 #define CEC_OP_FEAT_DEV_SINK_HAS_ARC_TX 0x04
774 #define CEC_OP_FEAT_DEV_SOURCE_HAS_ARC_RX 0x02
775 #define CEC_OP_FEAT_DEV_HAS_SET_AUDIO_VOLUME_LEVEL 0x01
776
777 #define CEC_MSG_GIVE_FEATURES 0xa5 /* HDMI 2.0 */
778
779
780 /* Deck Control Feature */
781 #define CEC_MSG_DECK_CONTROL 0x42
782 /* Deck Control Mode Operand (deck_control_mode) */
783 #define CEC_OP_DECK_CTL_MODE_SKIP_FWD 1
784 #define CEC_OP_DECK_CTL_MODE_SKIP_REV 2
785 #define CEC_OP_DECK_CTL_MODE_STOP 3
786 #define CEC_OP_DECK_CTL_MODE_EJECT 4
787
788 #define CEC_MSG_DECK_STATUS 0x1b
789 /* Deck Info Operand (deck_info) */
790 #define CEC_OP_DECK_INFO_PLAY 0x11
791 #define CEC_OP_DECK_INFO_RECORD 0x12
792 #define CEC_OP_DECK_INFO_PLAY_REV 0x13
793 #define CEC_OP_DECK_INFO_STILL 0x14
794 #define CEC_OP_DECK_INFO_SLOW 0x15
795 #define CEC_OP_DECK_INFO_SLOW_REV 0x16
796 #define CEC_OP_DECK_INFO_FAST_FWD 0x17
797 #define CEC_OP_DECK_INFO_FAST_REV 0x18
798 #define CEC_OP_DECK_INFO_NO_MEDIA 0x19
799 #define CEC_OP_DECK_INFO_STOP 0x1a
800 #define CEC_OP_DECK_INFO_SKIP_FWD 0x1b
801 #define CEC_OP_DECK_INFO_SKIP_REV 0x1c
802 #define CEC_OP_DECK_INFO_INDEX_SEARCH_FWD 0x1d
803 #define CEC_OP_DECK_INFO_INDEX_SEARCH_REV 0x1e
804 #define CEC_OP_DECK_INFO_OTHER 0x1f
805
806 #define CEC_MSG_GIVE_DECK_STATUS 0x1a
807 /* Status Request Operand (status_req) */
808 #define CEC_OP_STATUS_REQ_ON 1
809 #define CEC_OP_STATUS_REQ_OFF 2
810 #define CEC_OP_STATUS_REQ_ONCE 3
811
812 #define CEC_MSG_PLAY 0x41
813 /* Play Mode Operand (play_mode) */
814 #define CEC_OP_PLAY_MODE_PLAY_FWD 0x24
815 #define CEC_OP_PLAY_MODE_PLAY_REV 0x20
816 #define CEC_OP_PLAY_MODE_PLAY_STILL 0x25
817 #define CEC_OP_PLAY_MODE_PLAY_FAST_FWD_MIN 0x05
818 #define CEC_OP_PLAY_MODE_PLAY_FAST_FWD_MED 0x06
819 #define CEC_OP_PLAY_MODE_PLAY_FAST_FWD_MAX 0x07
820 #define CEC_OP_PLAY_MODE_PLAY_FAST_REV_MIN 0x09
821 #define CEC_OP_PLAY_MODE_PLAY_FAST_REV_MED 0x0a
822 #define CEC_OP_PLAY_MODE_PLAY_FAST_REV_MAX 0x0b
823 #define CEC_OP_PLAY_MODE_PLAY_SLOW_FWD_MIN 0x15
824 #define CEC_OP_PLAY_MODE_PLAY_SLOW_FWD_MED 0x16
825 #define CEC_OP_PLAY_MODE_PLAY_SLOW_FWD_MAX 0x17
826 #define CEC_OP_PLAY_MODE_PLAY_SLOW_REV_MIN 0x19
827 #define CEC_OP_PLAY_MODE_PLAY_SLOW_REV_MED 0x1a
828 #define CEC_OP_PLAY_MODE_PLAY_SLOW_REV_MAX 0x1b
829
830
831 /* Tuner Control Feature */
832 #define CEC_MSG_GIVE_TUNER_DEVICE_STATUS 0x08
833 #define CEC_MSG_SELECT_ANALOGUE_SERVICE 0x92
834 #define CEC_MSG_SELECT_DIGITAL_SERVICE 0x93
835 #define CEC_MSG_TUNER_DEVICE_STATUS 0x07
836 /* Recording Flag Operand (rec_flag) */
837 #define CEC_OP_REC_FLAG_NOT_USED 0
838 #define CEC_OP_REC_FLAG_USED 1
839 /* Tuner Display Info Operand (tuner_display_info) */
840 #define CEC_OP_TUNER_DISPLAY_INFO_DIGITAL 0
841 #define CEC_OP_TUNER_DISPLAY_INFO_NONE 1
842 #define CEC_OP_TUNER_DISPLAY_INFO_ANALOGUE 2
843
844 #define CEC_MSG_TUNER_STEP_DECREMENT 0x06
845 #define CEC_MSG_TUNER_STEP_INCREMENT 0x05
846
847
848 /* Vendor Specific Commands Feature */
849
850 /*
851 * Has also:
852 * CEC_MSG_CEC_VERSION
853 * CEC_MSG_GET_CEC_VERSION
854 */
855 #define CEC_MSG_DEVICE_VENDOR_ID 0x87
856 #define CEC_MSG_GIVE_DEVICE_VENDOR_ID 0x8c
857 #define CEC_MSG_VENDOR_COMMAND 0x89
858 #define CEC_MSG_VENDOR_COMMAND_WITH_ID 0xa0
859 #define CEC_MSG_VENDOR_REMOTE_BUTTON_DOWN 0x8a
860 #define CEC_MSG_VENDOR_REMOTE_BUTTON_UP 0x8b
861
862
863 /* OSD Display Feature */
864 #define CEC_MSG_SET_OSD_STRING 0x64
865 /* Display Control Operand (disp_ctl) */
866 #define CEC_OP_DISP_CTL_DEFAULT 0x00
867 #define CEC_OP_DISP_CTL_UNTIL_CLEARED 0x40
868 #define CEC_OP_DISP_CTL_CLEAR 0x80
869
870
871 /* Device OSD Transfer Feature */
872 #define CEC_MSG_GIVE_OSD_NAME 0x46
873 #define CEC_MSG_SET_OSD_NAME 0x47
874
875
876 /* Device Menu Control Feature */
877 #define CEC_MSG_MENU_REQUEST 0x8d
878 /* Menu Request Type Operand (menu_req) */
879 #define CEC_OP_MENU_REQUEST_ACTIVATE 0x00
880 #define CEC_OP_MENU_REQUEST_DEACTIVATE 0x01
881 #define CEC_OP_MENU_REQUEST_QUERY 0x02
882
883 #define CEC_MSG_MENU_STATUS 0x8e
884 /* Menu State Operand (menu_state) */
885 #define CEC_OP_MENU_STATE_ACTIVATED 0x00
886 #define CEC_OP_MENU_STATE_DEACTIVATED 0x01
887
888 #define CEC_MSG_USER_CONTROL_PRESSED 0x44
889 /* UI Command Operand (ui_cmd) */
890 #define CEC_OP_UI_CMD_SELECT 0x00
891 #define CEC_OP_UI_CMD_UP 0x01
892 #define CEC_OP_UI_CMD_DOWN 0x02
893 #define CEC_OP_UI_CMD_LEFT 0x03
894 #define CEC_OP_UI_CMD_RIGHT 0x04
895 #define CEC_OP_UI_CMD_RIGHT_UP 0x05
896 #define CEC_OP_UI_CMD_RIGHT_DOWN 0x06
897 #define CEC_OP_UI_CMD_LEFT_UP 0x07
898 #define CEC_OP_UI_CMD_LEFT_DOWN 0x08
899 #define CEC_OP_UI_CMD_DEVICE_ROOT_MENU 0x09
900 #define CEC_OP_UI_CMD_DEVICE_SETUP_MENU 0x0a
901 #define CEC_OP_UI_CMD_CONTENTS_MENU 0x0b
902 #define CEC_OP_UI_CMD_FAVORITE_MENU 0x0c
903 #define CEC_OP_UI_CMD_BACK 0x0d
904 #define CEC_OP_UI_CMD_MEDIA_TOP_MENU 0x10
905 #define CEC_OP_UI_CMD_MEDIA_CONTEXT_SENSITIVE_MENU 0x11
906 #define CEC_OP_UI_CMD_NUMBER_ENTRY_MODE 0x1d
907 #define CEC_OP_UI_CMD_NUMBER_11 0x1e
908 #define CEC_OP_UI_CMD_NUMBER_12 0x1f
909 #define CEC_OP_UI_CMD_NUMBER_0_OR_NUMBER_10 0x20
910 #define CEC_OP_UI_CMD_NUMBER_1 0x21
911 #define CEC_OP_UI_CMD_NUMBER_2 0x22
912 #define CEC_OP_UI_CMD_NUMBER_3 0x23
913 #define CEC_OP_UI_CMD_NUMBER_4 0x24
914 #define CEC_OP_UI_CMD_NUMBER_5 0x25
915 #define CEC_OP_UI_CMD_NUMBER_6 0x26
916 #define CEC_OP_UI_CMD_NUMBER_7 0x27
917 #define CEC_OP_UI_CMD_NUMBER_8 0x28
918 #define CEC_OP_UI_CMD_NUMBER_9 0x29
919 #define CEC_OP_UI_CMD_DOT 0x2a
920 #define CEC_OP_UI_CMD_ENTER 0x2b
921 #define CEC_OP_UI_CMD_CLEAR 0x2c
922 #define CEC_OP_UI_CMD_NEXT_FAVORITE 0x2f
923 #define CEC_OP_UI_CMD_CHANNEL_UP 0x30
924 #define CEC_OP_UI_CMD_CHANNEL_DOWN 0x31
925 #define CEC_OP_UI_CMD_PREVIOUS_CHANNEL 0x32
926 #define CEC_OP_UI_CMD_SOUND_SELECT 0x33
927 #define CEC_OP_UI_CMD_INPUT_SELECT 0x34
928 #define CEC_OP_UI_CMD_DISPLAY_INFORMATION 0x35
929 #define CEC_OP_UI_CMD_HELP 0x36
930 #define CEC_OP_UI_CMD_PAGE_UP 0x37
931 #define CEC_OP_UI_CMD_PAGE_DOWN 0x38
932 #define CEC_OP_UI_CMD_POWER 0x40
933 #define CEC_OP_UI_CMD_VOLUME_UP 0x41
934 #define CEC_OP_UI_CMD_VOLUME_DOWN 0x42
935 #define CEC_OP_UI_CMD_MUTE 0x43
936 #define CEC_OP_UI_CMD_PLAY 0x44
937 #define CEC_OP_UI_CMD_STOP 0x45
938 #define CEC_OP_UI_CMD_PAUSE 0x46
939 #define CEC_OP_UI_CMD_RECORD 0x47
940 #define CEC_OP_UI_CMD_REWIND 0x48
941 #define CEC_OP_UI_CMD_FAST_FORWARD 0x49
942 #define CEC_OP_UI_CMD_EJECT 0x4a
943 #define CEC_OP_UI_CMD_SKIP_FORWARD 0x4b
944 #define CEC_OP_UI_CMD_SKIP_BACKWARD 0x4c
945 #define CEC_OP_UI_CMD_STOP_RECORD 0x4d
946 #define CEC_OP_UI_CMD_PAUSE_RECORD 0x4e
947 #define CEC_OP_UI_CMD_ANGLE 0x50
948 #define CEC_OP_UI_CMD_SUB_PICTURE 0x51
949 #define CEC_OP_UI_CMD_VIDEO_ON_DEMAND 0x52
950 #define CEC_OP_UI_CMD_ELECTRONIC_PROGRAM_GUIDE 0x53
951 #define CEC_OP_UI_CMD_TIMER_PROGRAMMING 0x54
952 #define CEC_OP_UI_CMD_INITIAL_CONFIGURATION 0x55
953 #define CEC_OP_UI_CMD_SELECT_BROADCAST_TYPE 0x56
954 #define CEC_OP_UI_CMD_SELECT_SOUND_PRESENTATION 0x57
955 #define CEC_OP_UI_CMD_AUDIO_DESCRIPTION 0x58
956 #define CEC_OP_UI_CMD_INTERNET 0x59
957 #define CEC_OP_UI_CMD_3D_MODE 0x5a
958 #define CEC_OP_UI_CMD_PLAY_FUNCTION 0x60
959 #define CEC_OP_UI_CMD_PAUSE_PLAY_FUNCTION 0x61
960 #define CEC_OP_UI_CMD_RECORD_FUNCTION 0x62
961 #define CEC_OP_UI_CMD_PAUSE_RECORD_FUNCTION 0x63
962 #define CEC_OP_UI_CMD_STOP_FUNCTION 0x64
963 #define CEC_OP_UI_CMD_MUTE_FUNCTION 0x65
964 #define CEC_OP_UI_CMD_RESTORE_VOLUME_FUNCTION 0x66
965 #define CEC_OP_UI_CMD_TUNE_FUNCTION 0x67
966 #define CEC_OP_UI_CMD_SELECT_MEDIA_FUNCTION 0x68
967 #define CEC_OP_UI_CMD_SELECT_AV_INPUT_FUNCTION 0x69
968 #define CEC_OP_UI_CMD_SELECT_AUDIO_INPUT_FUNCTION 0x6a
969 #define CEC_OP_UI_CMD_POWER_TOGGLE_FUNCTION 0x6b
970 #define CEC_OP_UI_CMD_POWER_OFF_FUNCTION 0x6c
971 #define CEC_OP_UI_CMD_POWER_ON_FUNCTION 0x6d
972 #define CEC_OP_UI_CMD_F1_BLUE 0x71
973 #define CEC_OP_UI_CMD_F2_RED 0x72
974 #define CEC_OP_UI_CMD_F3_GREEN 0x73
975 #define CEC_OP_UI_CMD_F4_YELLOW 0x74
976 #define CEC_OP_UI_CMD_F5 0x75
977 #define CEC_OP_UI_CMD_DATA 0x76
978 /* UI Broadcast Type Operand (ui_bcast_type) */
979 #define CEC_OP_UI_BCAST_TYPE_TOGGLE_ALL 0x00
980 #define CEC_OP_UI_BCAST_TYPE_TOGGLE_DIG_ANA 0x01
981 #define CEC_OP_UI_BCAST_TYPE_ANALOGUE 0x10
982 #define CEC_OP_UI_BCAST_TYPE_ANALOGUE_T 0x20
983 #define CEC_OP_UI_BCAST_TYPE_ANALOGUE_CABLE 0x30
984 #define CEC_OP_UI_BCAST_TYPE_ANALOGUE_SAT 0x40
985 #define CEC_OP_UI_BCAST_TYPE_DIGITAL 0x50
986 #define CEC_OP_UI_BCAST_TYPE_DIGITAL_T 0x60
987 #define CEC_OP_UI_BCAST_TYPE_DIGITAL_CABLE 0x70
988 #define CEC_OP_UI_BCAST_TYPE_DIGITAL_SAT 0x80
989 #define CEC_OP_UI_BCAST_TYPE_DIGITAL_COM_SAT 0x90
990 #define CEC_OP_UI_BCAST_TYPE_DIGITAL_COM_SAT2 0x91
991 #define CEC_OP_UI_BCAST_TYPE_IP 0xa0
992 /* UI Sound Presentation Control Operand (ui_snd_pres_ctl) */
993 #define CEC_OP_UI_SND_PRES_CTL_DUAL_MONO 0x10
994 #define CEC_OP_UI_SND_PRES_CTL_KARAOKE 0x20
995 #define CEC_OP_UI_SND_PRES_CTL_DOWNMIX 0x80
996 #define CEC_OP_UI_SND_PRES_CTL_REVERB 0x90
997 #define CEC_OP_UI_SND_PRES_CTL_EQUALIZER 0xa0
998 #define CEC_OP_UI_SND_PRES_CTL_BASS_UP 0xb1
999 #define CEC_OP_UI_SND_PRES_CTL_BASS_NEUTRAL 0xb2
1000 #define CEC_OP_UI_SND_PRES_CTL_BASS_DOWN 0xb3
1001 #define CEC_OP_UI_SND_PRES_CTL_TREBLE_UP 0xc1
1002 #define CEC_OP_UI_SND_PRES_CTL_TREBLE_NEUTRAL 0xc2
1003 #define CEC_OP_UI_SND_PRES_CTL_TREBLE_DOWN 0xc3
1004
1005 #define CEC_MSG_USER_CONTROL_RELEASED 0x45
1006
1007
1008 /* Remote Control Passthrough Feature */
1009
1010 /*
1011 * Has also:
1012 * CEC_MSG_USER_CONTROL_PRESSED
1013 * CEC_MSG_USER_CONTROL_RELEASED
1014 */
1015
1016
1017 /* Power Status Feature */
1018 #define CEC_MSG_GIVE_DEVICE_POWER_STATUS 0x8f
1019 #define CEC_MSG_REPORT_POWER_STATUS 0x90
1020 /* Power Status Operand (pwr_state) */
1021 #define CEC_OP_POWER_STATUS_ON 0
1022 #define CEC_OP_POWER_STATUS_STANDBY 1
1023 #define CEC_OP_POWER_STATUS_TO_ON 2
1024 #define CEC_OP_POWER_STATUS_TO_STANDBY 3
1025
1026
1027 /* General Protocol Messages */
1028 #define CEC_MSG_FEATURE_ABORT 0x00
1029 /* Abort Reason Operand (reason) */
1030 #define CEC_OP_ABORT_UNRECOGNIZED_OP 0
1031 #define CEC_OP_ABORT_INCORRECT_MODE 1
1032 #define CEC_OP_ABORT_NO_SOURCE 2
1033 #define CEC_OP_ABORT_INVALID_OP 3
1034 #define CEC_OP_ABORT_REFUSED 4
1035 #define CEC_OP_ABORT_UNDETERMINED 5
1036
1037 #define CEC_MSG_ABORT 0xff
1038
1039
1040 /* System Audio Control Feature */
1041
1042 /*
1043 * Has also:
1044 * CEC_MSG_USER_CONTROL_PRESSED
1045 * CEC_MSG_USER_CONTROL_RELEASED
1046 */
1047 #define CEC_MSG_GIVE_AUDIO_STATUS 0x71
1048 #define CEC_MSG_GIVE_SYSTEM_AUDIO_MODE_STATUS 0x7d
1049 #define CEC_MSG_REPORT_AUDIO_STATUS 0x7a
1050 /* Audio Mute Status Operand (aud_mute_status) */
1051 #define CEC_OP_AUD_MUTE_STATUS_OFF 0
1052 #define CEC_OP_AUD_MUTE_STATUS_ON 1
1053
1054 #define CEC_MSG_REPORT_SHORT_AUDIO_DESCRIPTOR 0xa3
1055 #define CEC_MSG_REQUEST_SHORT_AUDIO_DESCRIPTOR 0xa4
1056 #define CEC_MSG_SET_SYSTEM_AUDIO_MODE 0x72
1057 /* System Audio Status Operand (sys_aud_status) */
1058 #define CEC_OP_SYS_AUD_STATUS_OFF 0
1059 #define CEC_OP_SYS_AUD_STATUS_ON 1
1060
1061 #define CEC_MSG_SYSTEM_AUDIO_MODE_REQUEST 0x70
1062 #define CEC_MSG_SYSTEM_AUDIO_MODE_STATUS 0x7e
1063 /* Audio Format ID Operand (audio_format_id) */
1064 #define CEC_OP_AUD_FMT_ID_CEA861 0
1065 #define CEC_OP_AUD_FMT_ID_CEA861_CXT 1
1066
1067 #define CEC_MSG_SET_AUDIO_VOLUME_LEVEL 0x73
1068
1069 /* Audio Rate Control Feature */
1070 #define CEC_MSG_SET_AUDIO_RATE 0x9a
1071 /* Audio Rate Operand (audio_rate) */
1072 #define CEC_OP_AUD_RATE_OFF 0
1073 #define CEC_OP_AUD_RATE_WIDE_STD 1
1074 #define CEC_OP_AUD_RATE_WIDE_FAST 2
1075 #define CEC_OP_AUD_RATE_WIDE_SLOW 3
1076 #define CEC_OP_AUD_RATE_NARROW_STD 4
1077 #define CEC_OP_AUD_RATE_NARROW_FAST 5
1078 #define CEC_OP_AUD_RATE_NARROW_SLOW 6
1079
1080
1081 /* Audio Return Channel Control Feature */
1082 #define CEC_MSG_INITIATE_ARC 0xc0
1083 #define CEC_MSG_REPORT_ARC_INITIATED 0xc1
1084 #define CEC_MSG_REPORT_ARC_TERMINATED 0xc2
1085 #define CEC_MSG_REQUEST_ARC_INITIATION 0xc3
1086 #define CEC_MSG_REQUEST_ARC_TERMINATION 0xc4
1087 #define CEC_MSG_TERMINATE_ARC 0xc5
1088
1089
1090 /* Dynamic Audio Lipsync Feature */
1091 /* Only for CEC 2.0 and up */
1092 #define CEC_MSG_REQUEST_CURRENT_LATENCY 0xa7
1093 #define CEC_MSG_REPORT_CURRENT_LATENCY 0xa8
1094 /* Low Latency Mode Operand (low_latency_mode) */
1095 #define CEC_OP_LOW_LATENCY_MODE_OFF 0
1096 #define CEC_OP_LOW_LATENCY_MODE_ON 1
1097 /* Audio Output Compensated Operand (audio_out_compensated) */
1098 #define CEC_OP_AUD_OUT_COMPENSATED_NA 0
1099 #define CEC_OP_AUD_OUT_COMPENSATED_DELAY 1
1100 #define CEC_OP_AUD_OUT_COMPENSATED_NO_DELAY 2
1101 #define CEC_OP_AUD_OUT_COMPENSATED_PARTIAL_DELAY 3
1102
1103
1104 /* Capability Discovery and Control Feature */
1105 #define CEC_MSG_CDC_MESSAGE 0xf8
1106 /* Ethernet-over-HDMI: nobody ever does this... */
1107 #define CEC_MSG_CDC_HEC_INQUIRE_STATE 0x00
1108 #define CEC_MSG_CDC_HEC_REPORT_STATE 0x01
1109 /* HEC Functionality State Operand (hec_func_state) */
1110 #define CEC_OP_HEC_FUNC_STATE_NOT_SUPPORTED 0
1111 #define CEC_OP_HEC_FUNC_STATE_INACTIVE 1
1112 #define CEC_OP_HEC_FUNC_STATE_ACTIVE 2
1113 #define CEC_OP_HEC_FUNC_STATE_ACTIVATION_FIELD 3
1114 /* Host Functionality State Operand (host_func_state) */
1115 #define CEC_OP_HOST_FUNC_STATE_NOT_SUPPORTED 0
1116 #define CEC_OP_HOST_FUNC_STATE_INACTIVE 1
1117 #define CEC_OP_HOST_FUNC_STATE_ACTIVE 2
1118 /* ENC Functionality State Operand (enc_func_state) */
1119 #define CEC_OP_ENC_FUNC_STATE_EXT_CON_NOT_SUPPORTED 0
1120 #define CEC_OP_ENC_FUNC_STATE_EXT_CON_INACTIVE 1
1121 #define CEC_OP_ENC_FUNC_STATE_EXT_CON_ACTIVE 2
1122 /* CDC Error Code Operand (cdc_errcode) */
1123 #define CEC_OP_CDC_ERROR_CODE_NONE 0
1124 #define CEC_OP_CDC_ERROR_CODE_CAP_UNSUPPORTED 1
1125 #define CEC_OP_CDC_ERROR_CODE_WRONG_STATE 2
1126 #define CEC_OP_CDC_ERROR_CODE_OTHER 3
1127 /* HEC Support Operand (hec_support) */
1128 #define CEC_OP_HEC_SUPPORT_NO 0
1129 #define CEC_OP_HEC_SUPPORT_YES 1
1130 /* HEC Activation Operand (hec_activation) */
1131 #define CEC_OP_HEC_ACTIVATION_ON 0
1132 #define CEC_OP_HEC_ACTIVATION_OFF 1
1133
1134 #define CEC_MSG_CDC_HEC_SET_STATE_ADJACENT 0x02
1135 #define CEC_MSG_CDC_HEC_SET_STATE 0x03
1136 /* HEC Set State Operand (hec_set_state) */
1137 #define CEC_OP_HEC_SET_STATE_DEACTIVATE 0
1138 #define CEC_OP_HEC_SET_STATE_ACTIVATE 1
1139
1140 #define CEC_MSG_CDC_HEC_REQUEST_DEACTIVATION 0x04
1141 #define CEC_MSG_CDC_HEC_NOTIFY_ALIVE 0x05
1142 #define CEC_MSG_CDC_HEC_DISCOVER 0x06
1143 /* Hotplug Detect messages */
1144 #define CEC_MSG_CDC_HPD_SET_STATE 0x10
1145 /* HPD State Operand (hpd_state) */
1146 #define CEC_OP_HPD_STATE_CP_EDID_DISABLE 0
1147 #define CEC_OP_HPD_STATE_CP_EDID_ENABLE 1
1148 #define CEC_OP_HPD_STATE_CP_EDID_DISABLE_ENABLE 2
1149 #define CEC_OP_HPD_STATE_EDID_DISABLE 3
1150 #define CEC_OP_HPD_STATE_EDID_ENABLE 4
1151 #define CEC_OP_HPD_STATE_EDID_DISABLE_ENABLE 5
1152 #define CEC_MSG_CDC_HPD_REPORT_STATE 0x11
1153 /* HPD Error Code Operand (hpd_error) */
1154 #define CEC_OP_HPD_ERROR_NONE 0
1155 #define CEC_OP_HPD_ERROR_INITIATOR_NOT_CAPABLE 1
1156 #define CEC_OP_HPD_ERROR_INITIATOR_WRONG_STATE 2
1157 #define CEC_OP_HPD_ERROR_OTHER 3
1158 #define CEC_OP_HPD_ERROR_NONE_NO_VIDEO 4
1159
1160 /* End of Messages */
1161
1162 /* Helper functions to identify the 'special' CEC devices */
1163
cec_is_2nd_tv(const struct cec_log_addrs * las)1164 static inline int cec_is_2nd_tv(const struct cec_log_addrs *las)
1165 {
1166 /*
1167 * It is a second TV if the logical address is 14 or 15 and the
1168 * primary device type is a TV.
1169 */
1170 return las->num_log_addrs &&
1171 las->log_addr[0] >= CEC_LOG_ADDR_SPECIFIC &&
1172 las->primary_device_type[0] == CEC_OP_PRIM_DEVTYPE_TV;
1173 }
1174
cec_is_processor(const struct cec_log_addrs * las)1175 static inline int cec_is_processor(const struct cec_log_addrs *las)
1176 {
1177 /*
1178 * It is a processor if the logical address is 12-15 and the
1179 * primary device type is a Processor.
1180 */
1181 return las->num_log_addrs &&
1182 las->log_addr[0] >= CEC_LOG_ADDR_BACKUP_1 &&
1183 las->primary_device_type[0] == CEC_OP_PRIM_DEVTYPE_PROCESSOR;
1184 }
1185
cec_is_switch(const struct cec_log_addrs * las)1186 static inline int cec_is_switch(const struct cec_log_addrs *las)
1187 {
1188 /*
1189 * It is a switch if the logical address is 15 and the
1190 * primary device type is a Switch and the CDC-Only flag is not set.
1191 */
1192 return las->num_log_addrs == 1 &&
1193 las->log_addr[0] == CEC_LOG_ADDR_UNREGISTERED &&
1194 las->primary_device_type[0] == CEC_OP_PRIM_DEVTYPE_SWITCH &&
1195 !(las->flags & CEC_LOG_ADDRS_FL_CDC_ONLY);
1196 }
1197
cec_is_cdc_only(const struct cec_log_addrs * las)1198 static inline int cec_is_cdc_only(const struct cec_log_addrs *las)
1199 {
1200 /*
1201 * It is a CDC-only device if the logical address is 15 and the
1202 * primary device type is a Switch and the CDC-Only flag is set.
1203 */
1204 return las->num_log_addrs == 1 &&
1205 las->log_addr[0] == CEC_LOG_ADDR_UNREGISTERED &&
1206 las->primary_device_type[0] == CEC_OP_PRIM_DEVTYPE_SWITCH &&
1207 (las->flags & CEC_LOG_ADDRS_FL_CDC_ONLY);
1208 }
1209
1210 #endif
1211