xref: /linux/include/uapi/linux/cec.h (revision 52338415)
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  */
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  */
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  */
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  */
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  */
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 static inline void cec_msg_set_reply_to(struct cec_msg *msg,
137 					struct cec_msg *orig)
138 {
139 	/* The destination becomes the initiator and vice versa */
140 	msg->msg[0] = (cec_msg_destination(orig) << 4) |
141 		      cec_msg_initiator(orig);
142 	msg->reply = msg->timeout = 0;
143 }
144 
145 /* cec_msg flags field */
146 #define CEC_MSG_FL_REPLY_TO_FOLLOWERS	(1 << 0)
147 #define CEC_MSG_FL_RAW			(1 << 1)
148 
149 /* cec_msg tx/rx_status field */
150 #define CEC_TX_STATUS_OK		(1 << 0)
151 #define CEC_TX_STATUS_ARB_LOST		(1 << 1)
152 #define CEC_TX_STATUS_NACK		(1 << 2)
153 #define CEC_TX_STATUS_LOW_DRIVE		(1 << 3)
154 #define CEC_TX_STATUS_ERROR		(1 << 4)
155 #define CEC_TX_STATUS_MAX_RETRIES	(1 << 5)
156 #define CEC_TX_STATUS_ABORTED		(1 << 6)
157 #define CEC_TX_STATUS_TIMEOUT		(1 << 7)
158 
159 #define CEC_RX_STATUS_OK		(1 << 0)
160 #define CEC_RX_STATUS_TIMEOUT		(1 << 1)
161 #define CEC_RX_STATUS_FEATURE_ABORT	(1 << 2)
162 #define CEC_RX_STATUS_ABORTED		(1 << 3)
163 
164 static inline int cec_msg_status_is_ok(const struct cec_msg *msg)
165 {
166 	if (msg->tx_status && !(msg->tx_status & CEC_TX_STATUS_OK))
167 		return 0;
168 	if (msg->rx_status && !(msg->rx_status & CEC_RX_STATUS_OK))
169 		return 0;
170 	if (!msg->tx_status && !msg->rx_status)
171 		return 0;
172 	return !(msg->rx_status & CEC_RX_STATUS_FEATURE_ABORT);
173 }
174 
175 #define CEC_LOG_ADDR_INVALID		0xff
176 #define CEC_PHYS_ADDR_INVALID		0xffff
177 
178 /*
179  * The maximum number of logical addresses one device can be assigned to.
180  * The CEC 2.0 spec allows for only 2 logical addresses at the moment. The
181  * Analog Devices CEC hardware supports 3. So let's go wild and go for 4.
182  */
183 #define CEC_MAX_LOG_ADDRS 4
184 
185 /* The logical addresses defined by CEC 2.0 */
186 #define CEC_LOG_ADDR_TV			0
187 #define CEC_LOG_ADDR_RECORD_1		1
188 #define CEC_LOG_ADDR_RECORD_2		2
189 #define CEC_LOG_ADDR_TUNER_1		3
190 #define CEC_LOG_ADDR_PLAYBACK_1		4
191 #define CEC_LOG_ADDR_AUDIOSYSTEM	5
192 #define CEC_LOG_ADDR_TUNER_2		6
193 #define CEC_LOG_ADDR_TUNER_3		7
194 #define CEC_LOG_ADDR_PLAYBACK_2		8
195 #define CEC_LOG_ADDR_RECORD_3		9
196 #define CEC_LOG_ADDR_TUNER_4		10
197 #define CEC_LOG_ADDR_PLAYBACK_3		11
198 #define CEC_LOG_ADDR_BACKUP_1		12
199 #define CEC_LOG_ADDR_BACKUP_2		13
200 #define CEC_LOG_ADDR_SPECIFIC		14
201 #define CEC_LOG_ADDR_UNREGISTERED	15 /* as initiator address */
202 #define CEC_LOG_ADDR_BROADCAST		15 /* as destination address */
203 
204 /* The logical address types that the CEC device wants to claim */
205 #define CEC_LOG_ADDR_TYPE_TV		0
206 #define CEC_LOG_ADDR_TYPE_RECORD	1
207 #define CEC_LOG_ADDR_TYPE_TUNER		2
208 #define CEC_LOG_ADDR_TYPE_PLAYBACK	3
209 #define CEC_LOG_ADDR_TYPE_AUDIOSYSTEM	4
210 #define CEC_LOG_ADDR_TYPE_SPECIFIC	5
211 #define CEC_LOG_ADDR_TYPE_UNREGISTERED	6
212 /*
213  * Switches should use UNREGISTERED.
214  * Processors should use SPECIFIC.
215  */
216 
217 #define CEC_LOG_ADDR_MASK_TV		(1 << CEC_LOG_ADDR_TV)
218 #define CEC_LOG_ADDR_MASK_RECORD	((1 << CEC_LOG_ADDR_RECORD_1) | \
219 					 (1 << CEC_LOG_ADDR_RECORD_2) | \
220 					 (1 << CEC_LOG_ADDR_RECORD_3))
221 #define CEC_LOG_ADDR_MASK_TUNER		((1 << CEC_LOG_ADDR_TUNER_1) | \
222 					 (1 << CEC_LOG_ADDR_TUNER_2) | \
223 					 (1 << CEC_LOG_ADDR_TUNER_3) | \
224 					 (1 << CEC_LOG_ADDR_TUNER_4))
225 #define CEC_LOG_ADDR_MASK_PLAYBACK	((1 << CEC_LOG_ADDR_PLAYBACK_1) | \
226 					 (1 << CEC_LOG_ADDR_PLAYBACK_2) | \
227 					 (1 << CEC_LOG_ADDR_PLAYBACK_3))
228 #define CEC_LOG_ADDR_MASK_AUDIOSYSTEM	(1 << CEC_LOG_ADDR_AUDIOSYSTEM)
229 #define CEC_LOG_ADDR_MASK_BACKUP	((1 << CEC_LOG_ADDR_BACKUP_1) | \
230 					 (1 << CEC_LOG_ADDR_BACKUP_2))
231 #define CEC_LOG_ADDR_MASK_SPECIFIC	(1 << CEC_LOG_ADDR_SPECIFIC)
232 #define CEC_LOG_ADDR_MASK_UNREGISTERED	(1 << CEC_LOG_ADDR_UNREGISTERED)
233 
234 static inline int cec_has_tv(__u16 log_addr_mask)
235 {
236 	return log_addr_mask & CEC_LOG_ADDR_MASK_TV;
237 }
238 
239 static inline int cec_has_record(__u16 log_addr_mask)
240 {
241 	return log_addr_mask & CEC_LOG_ADDR_MASK_RECORD;
242 }
243 
244 static inline int cec_has_tuner(__u16 log_addr_mask)
245 {
246 	return log_addr_mask & CEC_LOG_ADDR_MASK_TUNER;
247 }
248 
249 static inline int cec_has_playback(__u16 log_addr_mask)
250 {
251 	return log_addr_mask & CEC_LOG_ADDR_MASK_PLAYBACK;
252 }
253 
254 static inline int cec_has_audiosystem(__u16 log_addr_mask)
255 {
256 	return log_addr_mask & CEC_LOG_ADDR_MASK_AUDIOSYSTEM;
257 }
258 
259 static inline int cec_has_backup(__u16 log_addr_mask)
260 {
261 	return log_addr_mask & CEC_LOG_ADDR_MASK_BACKUP;
262 }
263 
264 static inline int cec_has_specific(__u16 log_addr_mask)
265 {
266 	return log_addr_mask & CEC_LOG_ADDR_MASK_SPECIFIC;
267 }
268 
269 static inline int cec_is_unregistered(__u16 log_addr_mask)
270 {
271 	return log_addr_mask & CEC_LOG_ADDR_MASK_UNREGISTERED;
272 }
273 
274 static inline int cec_is_unconfigured(__u16 log_addr_mask)
275 {
276 	return log_addr_mask == 0;
277 }
278 
279 /*
280  * Use this if there is no vendor ID (CEC_G_VENDOR_ID) or if the vendor ID
281  * should be disabled (CEC_S_VENDOR_ID)
282  */
283 #define CEC_VENDOR_ID_NONE		0xffffffff
284 
285 /* The message handling modes */
286 /* Modes for initiator */
287 #define CEC_MODE_NO_INITIATOR		(0x0 << 0)
288 #define CEC_MODE_INITIATOR		(0x1 << 0)
289 #define CEC_MODE_EXCL_INITIATOR		(0x2 << 0)
290 #define CEC_MODE_INITIATOR_MSK		0x0f
291 
292 /* Modes for follower */
293 #define CEC_MODE_NO_FOLLOWER		(0x0 << 4)
294 #define CEC_MODE_FOLLOWER		(0x1 << 4)
295 #define CEC_MODE_EXCL_FOLLOWER		(0x2 << 4)
296 #define CEC_MODE_EXCL_FOLLOWER_PASSTHRU	(0x3 << 4)
297 #define CEC_MODE_MONITOR_PIN		(0xd << 4)
298 #define CEC_MODE_MONITOR		(0xe << 4)
299 #define CEC_MODE_MONITOR_ALL		(0xf << 4)
300 #define CEC_MODE_FOLLOWER_MSK		0xf0
301 
302 /* Userspace has to configure the physical address */
303 #define CEC_CAP_PHYS_ADDR	(1 << 0)
304 /* Userspace has to configure the logical addresses */
305 #define CEC_CAP_LOG_ADDRS	(1 << 1)
306 /* Userspace can transmit messages (and thus become follower as well) */
307 #define CEC_CAP_TRANSMIT	(1 << 2)
308 /*
309  * Passthrough all messages instead of processing them.
310  */
311 #define CEC_CAP_PASSTHROUGH	(1 << 3)
312 /* Supports remote control */
313 #define CEC_CAP_RC		(1 << 4)
314 /* Hardware can monitor all messages, not just directed and broadcast. */
315 #define CEC_CAP_MONITOR_ALL	(1 << 5)
316 /* Hardware can use CEC only if the HDMI HPD pin is high. */
317 #define CEC_CAP_NEEDS_HPD	(1 << 6)
318 /* Hardware can monitor CEC pin transitions */
319 #define CEC_CAP_MONITOR_PIN	(1 << 7)
320 
321 /**
322  * struct cec_caps - CEC capabilities structure.
323  * @driver: name of the CEC device driver.
324  * @name: name of the CEC device. @driver + @name must be unique.
325  * @available_log_addrs: number of available logical addresses.
326  * @capabilities: capabilities of the CEC adapter.
327  * @version: version of the CEC adapter framework.
328  */
329 struct cec_caps {
330 	char driver[32];
331 	char name[32];
332 	__u32 available_log_addrs;
333 	__u32 capabilities;
334 	__u32 version;
335 };
336 
337 /**
338  * struct cec_log_addrs - CEC logical addresses structure.
339  * @log_addr: the claimed logical addresses. Set by the driver.
340  * @log_addr_mask: current logical address mask. Set by the driver.
341  * @cec_version: the CEC version that the adapter should implement. Set by the
342  *	caller.
343  * @num_log_addrs: how many logical addresses should be claimed. Set by the
344  *	caller.
345  * @vendor_id: the vendor ID of the device. Set by the caller.
346  * @flags: flags.
347  * @osd_name: the OSD name of the device. Set by the caller.
348  * @primary_device_type: the primary device type for each logical address.
349  *	Set by the caller.
350  * @log_addr_type: the logical address types. Set by the caller.
351  * @all_device_types: CEC 2.0: all device types represented by the logical
352  *	address. Set by the caller.
353  * @features:	CEC 2.0: The logical address features. Set by the caller.
354  */
355 struct cec_log_addrs {
356 	__u8 log_addr[CEC_MAX_LOG_ADDRS];
357 	__u16 log_addr_mask;
358 	__u8 cec_version;
359 	__u8 num_log_addrs;
360 	__u32 vendor_id;
361 	__u32 flags;
362 	char osd_name[15];
363 	__u8 primary_device_type[CEC_MAX_LOG_ADDRS];
364 	__u8 log_addr_type[CEC_MAX_LOG_ADDRS];
365 
366 	/* CEC 2.0 */
367 	__u8 all_device_types[CEC_MAX_LOG_ADDRS];
368 	__u8 features[CEC_MAX_LOG_ADDRS][12];
369 };
370 
371 /* Allow a fallback to unregistered */
372 #define CEC_LOG_ADDRS_FL_ALLOW_UNREG_FALLBACK	(1 << 0)
373 /* Passthrough RC messages to the input subsystem */
374 #define CEC_LOG_ADDRS_FL_ALLOW_RC_PASSTHRU	(1 << 1)
375 /* CDC-Only device: supports only CDC messages */
376 #define CEC_LOG_ADDRS_FL_CDC_ONLY		(1 << 2)
377 
378 /* Events */
379 
380 /* Event that occurs when the adapter state changes */
381 #define CEC_EVENT_STATE_CHANGE		1
382 /*
383  * This event is sent when messages are lost because the application
384  * didn't empty the message queue in time
385  */
386 #define CEC_EVENT_LOST_MSGS		2
387 #define CEC_EVENT_PIN_CEC_LOW		3
388 #define CEC_EVENT_PIN_CEC_HIGH		4
389 #define CEC_EVENT_PIN_HPD_LOW		5
390 #define CEC_EVENT_PIN_HPD_HIGH		6
391 #define CEC_EVENT_PIN_5V_LOW		7
392 #define CEC_EVENT_PIN_5V_HIGH		8
393 
394 #define CEC_EVENT_FL_INITIAL_STATE	(1 << 0)
395 #define CEC_EVENT_FL_DROPPED_EVENTS	(1 << 1)
396 
397 /**
398  * struct cec_event_state_change - used when the CEC adapter changes state.
399  * @phys_addr: the current physical address
400  * @log_addr_mask: the current logical address mask
401  */
402 struct cec_event_state_change {
403 	__u16 phys_addr;
404 	__u16 log_addr_mask;
405 };
406 
407 /**
408  * struct cec_event_lost_msgs - tells you how many messages were lost.
409  * @lost_msgs: how many messages were lost.
410  */
411 struct cec_event_lost_msgs {
412 	__u32 lost_msgs;
413 };
414 
415 /**
416  * struct cec_event - CEC event structure
417  * @ts: the timestamp of when the event was sent.
418  * @event: the event.
419  * array.
420  * @state_change: the event payload for CEC_EVENT_STATE_CHANGE.
421  * @lost_msgs: the event payload for CEC_EVENT_LOST_MSGS.
422  * @raw: array to pad the union.
423  */
424 struct cec_event {
425 	__u64 ts;
426 	__u32 event;
427 	__u32 flags;
428 	union {
429 		struct cec_event_state_change state_change;
430 		struct cec_event_lost_msgs lost_msgs;
431 		__u32 raw[16];
432 	};
433 };
434 
435 /* ioctls */
436 
437 /* Adapter capabilities */
438 #define CEC_ADAP_G_CAPS		_IOWR('a',  0, struct cec_caps)
439 
440 /*
441  * phys_addr is either 0 (if this is the CEC root device)
442  * or a valid physical address obtained from the sink's EDID
443  * as read by this CEC device (if this is a source device)
444  * or a physical address obtained and modified from a sink
445  * EDID and used for a sink CEC device.
446  * If nothing is connected, then phys_addr is 0xffff.
447  * See HDMI 1.4b, section 8.7 (Physical Address).
448  *
449  * The CEC_ADAP_S_PHYS_ADDR ioctl may not be available if that is handled
450  * internally.
451  */
452 #define CEC_ADAP_G_PHYS_ADDR	_IOR('a',  1, __u16)
453 #define CEC_ADAP_S_PHYS_ADDR	_IOW('a',  2, __u16)
454 
455 /*
456  * Configure the CEC adapter. It sets the device type and which
457  * logical types it will try to claim. It will return which
458  * logical addresses it could actually claim.
459  * An error is returned if the adapter is disabled or if there
460  * is no physical address assigned.
461  */
462 
463 #define CEC_ADAP_G_LOG_ADDRS	_IOR('a',  3, struct cec_log_addrs)
464 #define CEC_ADAP_S_LOG_ADDRS	_IOWR('a',  4, struct cec_log_addrs)
465 
466 /* Transmit/receive a CEC command */
467 #define CEC_TRANSMIT		_IOWR('a',  5, struct cec_msg)
468 #define CEC_RECEIVE		_IOWR('a',  6, struct cec_msg)
469 
470 /* Dequeue CEC events */
471 #define CEC_DQEVENT		_IOWR('a',  7, struct cec_event)
472 
473 /*
474  * Get and set the message handling mode for this filehandle.
475  */
476 #define CEC_G_MODE		_IOR('a',  8, __u32)
477 #define CEC_S_MODE		_IOW('a',  9, __u32)
478 
479 /*
480  * The remainder of this header defines all CEC messages and operands.
481  * The format matters since it the cec-ctl utility parses it to generate
482  * code for implementing all these messages.
483  *
484  * Comments ending with 'Feature' group messages for each feature.
485  * If messages are part of multiple features, then the "Has also"
486  * comment is used to list the previously defined messages that are
487  * supported by the feature.
488  *
489  * Before operands are defined a comment is added that gives the
490  * name of the operand and in brackets the variable name of the
491  * corresponding argument in the cec-funcs.h function.
492  */
493 
494 /* Messages */
495 
496 /* One Touch Play Feature */
497 #define CEC_MSG_ACTIVE_SOURCE				0x82
498 #define CEC_MSG_IMAGE_VIEW_ON				0x04
499 #define CEC_MSG_TEXT_VIEW_ON				0x0d
500 
501 
502 /* Routing Control Feature */
503 
504 /*
505  * Has also:
506  *	CEC_MSG_ACTIVE_SOURCE
507  */
508 
509 #define CEC_MSG_INACTIVE_SOURCE				0x9d
510 #define CEC_MSG_REQUEST_ACTIVE_SOURCE			0x85
511 #define CEC_MSG_ROUTING_CHANGE				0x80
512 #define CEC_MSG_ROUTING_INFORMATION			0x81
513 #define CEC_MSG_SET_STREAM_PATH				0x86
514 
515 
516 /* Standby Feature */
517 #define CEC_MSG_STANDBY					0x36
518 
519 
520 /* One Touch Record Feature */
521 #define CEC_MSG_RECORD_OFF				0x0b
522 #define CEC_MSG_RECORD_ON				0x09
523 /* Record Source Type Operand (rec_src_type) */
524 #define CEC_OP_RECORD_SRC_OWN				1
525 #define CEC_OP_RECORD_SRC_DIGITAL			2
526 #define CEC_OP_RECORD_SRC_ANALOG			3
527 #define CEC_OP_RECORD_SRC_EXT_PLUG			4
528 #define CEC_OP_RECORD_SRC_EXT_PHYS_ADDR			5
529 /* Service Identification Method Operand (service_id_method) */
530 #define CEC_OP_SERVICE_ID_METHOD_BY_DIG_ID		0
531 #define CEC_OP_SERVICE_ID_METHOD_BY_CHANNEL		1
532 /* Digital Service Broadcast System Operand (dig_bcast_system) */
533 #define CEC_OP_DIG_SERVICE_BCAST_SYSTEM_ARIB_GEN	0x00
534 #define CEC_OP_DIG_SERVICE_BCAST_SYSTEM_ATSC_GEN	0x01
535 #define CEC_OP_DIG_SERVICE_BCAST_SYSTEM_DVB_GEN		0x02
536 #define CEC_OP_DIG_SERVICE_BCAST_SYSTEM_ARIB_BS		0x08
537 #define CEC_OP_DIG_SERVICE_BCAST_SYSTEM_ARIB_CS		0x09
538 #define CEC_OP_DIG_SERVICE_BCAST_SYSTEM_ARIB_T		0x0a
539 #define CEC_OP_DIG_SERVICE_BCAST_SYSTEM_ATSC_CABLE	0x10
540 #define CEC_OP_DIG_SERVICE_BCAST_SYSTEM_ATSC_SAT	0x11
541 #define CEC_OP_DIG_SERVICE_BCAST_SYSTEM_ATSC_T		0x12
542 #define CEC_OP_DIG_SERVICE_BCAST_SYSTEM_DVB_C		0x18
543 #define CEC_OP_DIG_SERVICE_BCAST_SYSTEM_DVB_S		0x19
544 #define CEC_OP_DIG_SERVICE_BCAST_SYSTEM_DVB_S2		0x1a
545 #define CEC_OP_DIG_SERVICE_BCAST_SYSTEM_DVB_T		0x1b
546 /* Analogue Broadcast Type Operand (ana_bcast_type) */
547 #define CEC_OP_ANA_BCAST_TYPE_CABLE			0
548 #define CEC_OP_ANA_BCAST_TYPE_SATELLITE			1
549 #define CEC_OP_ANA_BCAST_TYPE_TERRESTRIAL		2
550 /* Broadcast System Operand (bcast_system) */
551 #define CEC_OP_BCAST_SYSTEM_PAL_BG			0x00
552 #define CEC_OP_BCAST_SYSTEM_SECAM_LQ			0x01 /* SECAM L' */
553 #define CEC_OP_BCAST_SYSTEM_PAL_M			0x02
554 #define CEC_OP_BCAST_SYSTEM_NTSC_M			0x03
555 #define CEC_OP_BCAST_SYSTEM_PAL_I			0x04
556 #define CEC_OP_BCAST_SYSTEM_SECAM_DK			0x05
557 #define CEC_OP_BCAST_SYSTEM_SECAM_BG			0x06
558 #define CEC_OP_BCAST_SYSTEM_SECAM_L			0x07
559 #define CEC_OP_BCAST_SYSTEM_PAL_DK			0x08
560 #define CEC_OP_BCAST_SYSTEM_OTHER			0x1f
561 /* Channel Number Format Operand (channel_number_fmt) */
562 #define CEC_OP_CHANNEL_NUMBER_FMT_1_PART		0x01
563 #define CEC_OP_CHANNEL_NUMBER_FMT_2_PART		0x02
564 
565 #define CEC_MSG_RECORD_STATUS				0x0a
566 /* Record Status Operand (rec_status) */
567 #define CEC_OP_RECORD_STATUS_CUR_SRC			0x01
568 #define CEC_OP_RECORD_STATUS_DIG_SERVICE		0x02
569 #define CEC_OP_RECORD_STATUS_ANA_SERVICE		0x03
570 #define CEC_OP_RECORD_STATUS_EXT_INPUT			0x04
571 #define CEC_OP_RECORD_STATUS_NO_DIG_SERVICE		0x05
572 #define CEC_OP_RECORD_STATUS_NO_ANA_SERVICE		0x06
573 #define CEC_OP_RECORD_STATUS_NO_SERVICE			0x07
574 #define CEC_OP_RECORD_STATUS_INVALID_EXT_PLUG		0x09
575 #define CEC_OP_RECORD_STATUS_INVALID_EXT_PHYS_ADDR	0x0a
576 #define CEC_OP_RECORD_STATUS_UNSUP_CA			0x0b
577 #define CEC_OP_RECORD_STATUS_NO_CA_ENTITLEMENTS		0x0c
578 #define CEC_OP_RECORD_STATUS_CANT_COPY_SRC		0x0d
579 #define CEC_OP_RECORD_STATUS_NO_MORE_COPIES		0x0e
580 #define CEC_OP_RECORD_STATUS_NO_MEDIA			0x10
581 #define CEC_OP_RECORD_STATUS_PLAYING			0x11
582 #define CEC_OP_RECORD_STATUS_ALREADY_RECORDING		0x12
583 #define CEC_OP_RECORD_STATUS_MEDIA_PROT			0x13
584 #define CEC_OP_RECORD_STATUS_NO_SIGNAL			0x14
585 #define CEC_OP_RECORD_STATUS_MEDIA_PROBLEM		0x15
586 #define CEC_OP_RECORD_STATUS_NO_SPACE			0x16
587 #define CEC_OP_RECORD_STATUS_PARENTAL_LOCK		0x17
588 #define CEC_OP_RECORD_STATUS_TERMINATED_OK		0x1a
589 #define CEC_OP_RECORD_STATUS_ALREADY_TERM		0x1b
590 #define CEC_OP_RECORD_STATUS_OTHER			0x1f
591 
592 #define CEC_MSG_RECORD_TV_SCREEN			0x0f
593 
594 
595 /* Timer Programming Feature */
596 #define CEC_MSG_CLEAR_ANALOGUE_TIMER			0x33
597 /* Recording Sequence Operand (recording_seq) */
598 #define CEC_OP_REC_SEQ_SUNDAY				0x01
599 #define CEC_OP_REC_SEQ_MONDAY				0x02
600 #define CEC_OP_REC_SEQ_TUESDAY				0x04
601 #define CEC_OP_REC_SEQ_WEDNESDAY			0x08
602 #define CEC_OP_REC_SEQ_THURSDAY				0x10
603 #define CEC_OP_REC_SEQ_FRIDAY				0x20
604 #define CEC_OP_REC_SEQ_SATERDAY				0x40
605 #define CEC_OP_REC_SEQ_ONCE_ONLY			0x00
606 
607 #define CEC_MSG_CLEAR_DIGITAL_TIMER			0x99
608 
609 #define CEC_MSG_CLEAR_EXT_TIMER				0xa1
610 /* External Source Specifier Operand (ext_src_spec) */
611 #define CEC_OP_EXT_SRC_PLUG				0x04
612 #define CEC_OP_EXT_SRC_PHYS_ADDR			0x05
613 
614 #define CEC_MSG_SET_ANALOGUE_TIMER			0x34
615 #define CEC_MSG_SET_DIGITAL_TIMER			0x97
616 #define CEC_MSG_SET_EXT_TIMER				0xa2
617 
618 #define CEC_MSG_SET_TIMER_PROGRAM_TITLE			0x67
619 #define CEC_MSG_TIMER_CLEARED_STATUS			0x43
620 /* Timer Cleared Status Data Operand (timer_cleared_status) */
621 #define CEC_OP_TIMER_CLR_STAT_RECORDING			0x00
622 #define CEC_OP_TIMER_CLR_STAT_NO_MATCHING		0x01
623 #define CEC_OP_TIMER_CLR_STAT_NO_INFO			0x02
624 #define CEC_OP_TIMER_CLR_STAT_CLEARED			0x80
625 
626 #define CEC_MSG_TIMER_STATUS				0x35
627 /* Timer Overlap Warning Operand (timer_overlap_warning) */
628 #define CEC_OP_TIMER_OVERLAP_WARNING_NO_OVERLAP		0
629 #define CEC_OP_TIMER_OVERLAP_WARNING_OVERLAP		1
630 /* Media Info Operand (media_info) */
631 #define CEC_OP_MEDIA_INFO_UNPROT_MEDIA			0
632 #define CEC_OP_MEDIA_INFO_PROT_MEDIA			1
633 #define CEC_OP_MEDIA_INFO_NO_MEDIA			2
634 /* Programmed Indicator Operand (prog_indicator) */
635 #define CEC_OP_PROG_IND_NOT_PROGRAMMED			0
636 #define CEC_OP_PROG_IND_PROGRAMMED			1
637 /* Programmed Info Operand (prog_info) */
638 #define CEC_OP_PROG_INFO_ENOUGH_SPACE			0x08
639 #define CEC_OP_PROG_INFO_NOT_ENOUGH_SPACE		0x09
640 #define CEC_OP_PROG_INFO_MIGHT_NOT_BE_ENOUGH_SPACE	0x0b
641 #define CEC_OP_PROG_INFO_NONE_AVAILABLE			0x0a
642 /* Not Programmed Error Info Operand (prog_error) */
643 #define CEC_OP_PROG_ERROR_NO_FREE_TIMER			0x01
644 #define CEC_OP_PROG_ERROR_DATE_OUT_OF_RANGE		0x02
645 #define CEC_OP_PROG_ERROR_REC_SEQ_ERROR			0x03
646 #define CEC_OP_PROG_ERROR_INV_EXT_PLUG			0x04
647 #define CEC_OP_PROG_ERROR_INV_EXT_PHYS_ADDR		0x05
648 #define CEC_OP_PROG_ERROR_CA_UNSUPP			0x06
649 #define CEC_OP_PROG_ERROR_INSUF_CA_ENTITLEMENTS		0x07
650 #define CEC_OP_PROG_ERROR_RESOLUTION_UNSUPP		0x08
651 #define CEC_OP_PROG_ERROR_PARENTAL_LOCK			0x09
652 #define CEC_OP_PROG_ERROR_CLOCK_FAILURE			0x0a
653 #define CEC_OP_PROG_ERROR_DUPLICATE			0x0e
654 
655 
656 /* System Information Feature */
657 #define CEC_MSG_CEC_VERSION				0x9e
658 /* CEC Version Operand (cec_version) */
659 #define CEC_OP_CEC_VERSION_1_3A				4
660 #define CEC_OP_CEC_VERSION_1_4				5
661 #define CEC_OP_CEC_VERSION_2_0				6
662 
663 #define CEC_MSG_GET_CEC_VERSION				0x9f
664 #define CEC_MSG_GIVE_PHYSICAL_ADDR			0x83
665 #define CEC_MSG_GET_MENU_LANGUAGE			0x91
666 #define CEC_MSG_REPORT_PHYSICAL_ADDR			0x84
667 /* Primary Device Type Operand (prim_devtype) */
668 #define CEC_OP_PRIM_DEVTYPE_TV				0
669 #define CEC_OP_PRIM_DEVTYPE_RECORD			1
670 #define CEC_OP_PRIM_DEVTYPE_TUNER			3
671 #define CEC_OP_PRIM_DEVTYPE_PLAYBACK			4
672 #define CEC_OP_PRIM_DEVTYPE_AUDIOSYSTEM			5
673 #define CEC_OP_PRIM_DEVTYPE_SWITCH			6
674 #define CEC_OP_PRIM_DEVTYPE_PROCESSOR			7
675 
676 #define CEC_MSG_SET_MENU_LANGUAGE			0x32
677 #define CEC_MSG_REPORT_FEATURES				0xa6	/* HDMI 2.0 */
678 /* All Device Types Operand (all_device_types) */
679 #define CEC_OP_ALL_DEVTYPE_TV				0x80
680 #define CEC_OP_ALL_DEVTYPE_RECORD			0x40
681 #define CEC_OP_ALL_DEVTYPE_TUNER			0x20
682 #define CEC_OP_ALL_DEVTYPE_PLAYBACK			0x10
683 #define CEC_OP_ALL_DEVTYPE_AUDIOSYSTEM			0x08
684 #define CEC_OP_ALL_DEVTYPE_SWITCH			0x04
685 /*
686  * And if you wondering what happened to PROCESSOR devices: those should
687  * be mapped to a SWITCH.
688  */
689 
690 /* Valid for RC Profile and Device Feature operands */
691 #define CEC_OP_FEAT_EXT					0x80	/* Extension bit */
692 /* RC Profile Operand (rc_profile) */
693 #define CEC_OP_FEAT_RC_TV_PROFILE_NONE			0x00
694 #define CEC_OP_FEAT_RC_TV_PROFILE_1			0x02
695 #define CEC_OP_FEAT_RC_TV_PROFILE_2			0x06
696 #define CEC_OP_FEAT_RC_TV_PROFILE_3			0x0a
697 #define CEC_OP_FEAT_RC_TV_PROFILE_4			0x0e
698 #define CEC_OP_FEAT_RC_SRC_HAS_DEV_ROOT_MENU		0x50
699 #define CEC_OP_FEAT_RC_SRC_HAS_DEV_SETUP_MENU		0x48
700 #define CEC_OP_FEAT_RC_SRC_HAS_CONTENTS_MENU		0x44
701 #define CEC_OP_FEAT_RC_SRC_HAS_MEDIA_TOP_MENU		0x42
702 #define CEC_OP_FEAT_RC_SRC_HAS_MEDIA_CONTEXT_MENU	0x41
703 /* Device Feature Operand (dev_features) */
704 #define CEC_OP_FEAT_DEV_HAS_RECORD_TV_SCREEN		0x40
705 #define CEC_OP_FEAT_DEV_HAS_SET_OSD_STRING		0x20
706 #define CEC_OP_FEAT_DEV_HAS_DECK_CONTROL		0x10
707 #define CEC_OP_FEAT_DEV_HAS_SET_AUDIO_RATE		0x08
708 #define CEC_OP_FEAT_DEV_SINK_HAS_ARC_TX			0x04
709 #define CEC_OP_FEAT_DEV_SOURCE_HAS_ARC_RX		0x02
710 
711 #define CEC_MSG_GIVE_FEATURES				0xa5	/* HDMI 2.0 */
712 
713 
714 /* Deck Control Feature */
715 #define CEC_MSG_DECK_CONTROL				0x42
716 /* Deck Control Mode Operand (deck_control_mode) */
717 #define CEC_OP_DECK_CTL_MODE_SKIP_FWD			1
718 #define CEC_OP_DECK_CTL_MODE_SKIP_REV			2
719 #define CEC_OP_DECK_CTL_MODE_STOP			3
720 #define CEC_OP_DECK_CTL_MODE_EJECT			4
721 
722 #define CEC_MSG_DECK_STATUS				0x1b
723 /* Deck Info Operand (deck_info) */
724 #define CEC_OP_DECK_INFO_PLAY				0x11
725 #define CEC_OP_DECK_INFO_RECORD				0x12
726 #define CEC_OP_DECK_INFO_PLAY_REV			0x13
727 #define CEC_OP_DECK_INFO_STILL				0x14
728 #define CEC_OP_DECK_INFO_SLOW				0x15
729 #define CEC_OP_DECK_INFO_SLOW_REV			0x16
730 #define CEC_OP_DECK_INFO_FAST_FWD			0x17
731 #define CEC_OP_DECK_INFO_FAST_REV			0x18
732 #define CEC_OP_DECK_INFO_NO_MEDIA			0x19
733 #define CEC_OP_DECK_INFO_STOP				0x1a
734 #define CEC_OP_DECK_INFO_SKIP_FWD			0x1b
735 #define CEC_OP_DECK_INFO_SKIP_REV			0x1c
736 #define CEC_OP_DECK_INFO_INDEX_SEARCH_FWD		0x1d
737 #define CEC_OP_DECK_INFO_INDEX_SEARCH_REV		0x1e
738 #define CEC_OP_DECK_INFO_OTHER				0x1f
739 
740 #define CEC_MSG_GIVE_DECK_STATUS			0x1a
741 /* Status Request Operand (status_req) */
742 #define CEC_OP_STATUS_REQ_ON				1
743 #define CEC_OP_STATUS_REQ_OFF				2
744 #define CEC_OP_STATUS_REQ_ONCE				3
745 
746 #define CEC_MSG_PLAY					0x41
747 /* Play Mode Operand (play_mode) */
748 #define CEC_OP_PLAY_MODE_PLAY_FWD			0x24
749 #define CEC_OP_PLAY_MODE_PLAY_REV			0x20
750 #define CEC_OP_PLAY_MODE_PLAY_STILL			0x25
751 #define CEC_OP_PLAY_MODE_PLAY_FAST_FWD_MIN		0x05
752 #define CEC_OP_PLAY_MODE_PLAY_FAST_FWD_MED		0x06
753 #define CEC_OP_PLAY_MODE_PLAY_FAST_FWD_MAX		0x07
754 #define CEC_OP_PLAY_MODE_PLAY_FAST_REV_MIN		0x09
755 #define CEC_OP_PLAY_MODE_PLAY_FAST_REV_MED		0x0a
756 #define CEC_OP_PLAY_MODE_PLAY_FAST_REV_MAX		0x0b
757 #define CEC_OP_PLAY_MODE_PLAY_SLOW_FWD_MIN		0x15
758 #define CEC_OP_PLAY_MODE_PLAY_SLOW_FWD_MED		0x16
759 #define CEC_OP_PLAY_MODE_PLAY_SLOW_FWD_MAX		0x17
760 #define CEC_OP_PLAY_MODE_PLAY_SLOW_REV_MIN		0x19
761 #define CEC_OP_PLAY_MODE_PLAY_SLOW_REV_MED		0x1a
762 #define CEC_OP_PLAY_MODE_PLAY_SLOW_REV_MAX		0x1b
763 
764 
765 /* Tuner Control Feature */
766 #define CEC_MSG_GIVE_TUNER_DEVICE_STATUS		0x08
767 #define CEC_MSG_SELECT_ANALOGUE_SERVICE			0x92
768 #define CEC_MSG_SELECT_DIGITAL_SERVICE			0x93
769 #define CEC_MSG_TUNER_DEVICE_STATUS			0x07
770 /* Recording Flag Operand (rec_flag) */
771 #define CEC_OP_REC_FLAG_USED				0
772 #define CEC_OP_REC_FLAG_NOT_USED			1
773 /* Tuner Display Info Operand (tuner_display_info) */
774 #define CEC_OP_TUNER_DISPLAY_INFO_DIGITAL		0
775 #define CEC_OP_TUNER_DISPLAY_INFO_NONE			1
776 #define CEC_OP_TUNER_DISPLAY_INFO_ANALOGUE		2
777 
778 #define CEC_MSG_TUNER_STEP_DECREMENT			0x06
779 #define CEC_MSG_TUNER_STEP_INCREMENT			0x05
780 
781 
782 /* Vendor Specific Commands Feature */
783 
784 /*
785  * Has also:
786  *	CEC_MSG_CEC_VERSION
787  *	CEC_MSG_GET_CEC_VERSION
788  */
789 #define CEC_MSG_DEVICE_VENDOR_ID			0x87
790 #define CEC_MSG_GIVE_DEVICE_VENDOR_ID			0x8c
791 #define CEC_MSG_VENDOR_COMMAND				0x89
792 #define CEC_MSG_VENDOR_COMMAND_WITH_ID			0xa0
793 #define CEC_MSG_VENDOR_REMOTE_BUTTON_DOWN		0x8a
794 #define CEC_MSG_VENDOR_REMOTE_BUTTON_UP			0x8b
795 
796 
797 /* OSD Display Feature */
798 #define CEC_MSG_SET_OSD_STRING				0x64
799 /* Display Control Operand (disp_ctl) */
800 #define CEC_OP_DISP_CTL_DEFAULT				0x00
801 #define CEC_OP_DISP_CTL_UNTIL_CLEARED			0x40
802 #define CEC_OP_DISP_CTL_CLEAR				0x80
803 
804 
805 /* Device OSD Transfer Feature */
806 #define CEC_MSG_GIVE_OSD_NAME				0x46
807 #define CEC_MSG_SET_OSD_NAME				0x47
808 
809 
810 /* Device Menu Control Feature */
811 #define CEC_MSG_MENU_REQUEST				0x8d
812 /* Menu Request Type Operand (menu_req) */
813 #define CEC_OP_MENU_REQUEST_ACTIVATE			0x00
814 #define CEC_OP_MENU_REQUEST_DEACTIVATE			0x01
815 #define CEC_OP_MENU_REQUEST_QUERY			0x02
816 
817 #define CEC_MSG_MENU_STATUS				0x8e
818 /* Menu State Operand (menu_state) */
819 #define CEC_OP_MENU_STATE_ACTIVATED			0x00
820 #define CEC_OP_MENU_STATE_DEACTIVATED			0x01
821 
822 #define CEC_MSG_USER_CONTROL_PRESSED			0x44
823 /* UI Broadcast Type Operand (ui_bcast_type) */
824 #define CEC_OP_UI_BCAST_TYPE_TOGGLE_ALL			0x00
825 #define CEC_OP_UI_BCAST_TYPE_TOGGLE_DIG_ANA		0x01
826 #define CEC_OP_UI_BCAST_TYPE_ANALOGUE			0x10
827 #define CEC_OP_UI_BCAST_TYPE_ANALOGUE_T			0x20
828 #define CEC_OP_UI_BCAST_TYPE_ANALOGUE_CABLE		0x30
829 #define CEC_OP_UI_BCAST_TYPE_ANALOGUE_SAT		0x40
830 #define CEC_OP_UI_BCAST_TYPE_DIGITAL			0x50
831 #define CEC_OP_UI_BCAST_TYPE_DIGITAL_T			0x60
832 #define CEC_OP_UI_BCAST_TYPE_DIGITAL_CABLE		0x70
833 #define CEC_OP_UI_BCAST_TYPE_DIGITAL_SAT		0x80
834 #define CEC_OP_UI_BCAST_TYPE_DIGITAL_COM_SAT		0x90
835 #define CEC_OP_UI_BCAST_TYPE_DIGITAL_COM_SAT2		0x91
836 #define CEC_OP_UI_BCAST_TYPE_IP				0xa0
837 /* UI Sound Presentation Control Operand (ui_snd_pres_ctl) */
838 #define CEC_OP_UI_SND_PRES_CTL_DUAL_MONO		0x10
839 #define CEC_OP_UI_SND_PRES_CTL_KARAOKE			0x20
840 #define CEC_OP_UI_SND_PRES_CTL_DOWNMIX			0x80
841 #define CEC_OP_UI_SND_PRES_CTL_REVERB			0x90
842 #define CEC_OP_UI_SND_PRES_CTL_EQUALIZER		0xa0
843 #define CEC_OP_UI_SND_PRES_CTL_BASS_UP			0xb1
844 #define CEC_OP_UI_SND_PRES_CTL_BASS_NEUTRAL		0xb2
845 #define CEC_OP_UI_SND_PRES_CTL_BASS_DOWN		0xb3
846 #define CEC_OP_UI_SND_PRES_CTL_TREBLE_UP		0xc1
847 #define CEC_OP_UI_SND_PRES_CTL_TREBLE_NEUTRAL		0xc2
848 #define CEC_OP_UI_SND_PRES_CTL_TREBLE_DOWN		0xc3
849 
850 #define CEC_MSG_USER_CONTROL_RELEASED			0x45
851 
852 
853 /* Remote Control Passthrough Feature */
854 
855 /*
856  * Has also:
857  *	CEC_MSG_USER_CONTROL_PRESSED
858  *	CEC_MSG_USER_CONTROL_RELEASED
859  */
860 
861 
862 /* Power Status Feature */
863 #define CEC_MSG_GIVE_DEVICE_POWER_STATUS		0x8f
864 #define CEC_MSG_REPORT_POWER_STATUS			0x90
865 /* Power Status Operand (pwr_state) */
866 #define CEC_OP_POWER_STATUS_ON				0
867 #define CEC_OP_POWER_STATUS_STANDBY			1
868 #define CEC_OP_POWER_STATUS_TO_ON			2
869 #define CEC_OP_POWER_STATUS_TO_STANDBY			3
870 
871 
872 /* General Protocol Messages */
873 #define CEC_MSG_FEATURE_ABORT				0x00
874 /* Abort Reason Operand (reason) */
875 #define CEC_OP_ABORT_UNRECOGNIZED_OP			0
876 #define CEC_OP_ABORT_INCORRECT_MODE			1
877 #define CEC_OP_ABORT_NO_SOURCE				2
878 #define CEC_OP_ABORT_INVALID_OP				3
879 #define CEC_OP_ABORT_REFUSED				4
880 #define CEC_OP_ABORT_UNDETERMINED			5
881 
882 #define CEC_MSG_ABORT					0xff
883 
884 
885 /* System Audio Control Feature */
886 
887 /*
888  * Has also:
889  *	CEC_MSG_USER_CONTROL_PRESSED
890  *	CEC_MSG_USER_CONTROL_RELEASED
891  */
892 #define CEC_MSG_GIVE_AUDIO_STATUS			0x71
893 #define CEC_MSG_GIVE_SYSTEM_AUDIO_MODE_STATUS		0x7d
894 #define CEC_MSG_REPORT_AUDIO_STATUS			0x7a
895 /* Audio Mute Status Operand (aud_mute_status) */
896 #define CEC_OP_AUD_MUTE_STATUS_OFF			0
897 #define CEC_OP_AUD_MUTE_STATUS_ON			1
898 
899 #define CEC_MSG_REPORT_SHORT_AUDIO_DESCRIPTOR		0xa3
900 #define CEC_MSG_REQUEST_SHORT_AUDIO_DESCRIPTOR		0xa4
901 #define CEC_MSG_SET_SYSTEM_AUDIO_MODE			0x72
902 /* System Audio Status Operand (sys_aud_status) */
903 #define CEC_OP_SYS_AUD_STATUS_OFF			0
904 #define CEC_OP_SYS_AUD_STATUS_ON			1
905 
906 #define CEC_MSG_SYSTEM_AUDIO_MODE_REQUEST		0x70
907 #define CEC_MSG_SYSTEM_AUDIO_MODE_STATUS		0x7e
908 /* Audio Format ID Operand (audio_format_id) */
909 #define CEC_OP_AUD_FMT_ID_CEA861			0
910 #define CEC_OP_AUD_FMT_ID_CEA861_CXT			1
911 
912 
913 /* Audio Rate Control Feature */
914 #define CEC_MSG_SET_AUDIO_RATE				0x9a
915 /* Audio Rate Operand (audio_rate) */
916 #define CEC_OP_AUD_RATE_OFF				0
917 #define CEC_OP_AUD_RATE_WIDE_STD			1
918 #define CEC_OP_AUD_RATE_WIDE_FAST			2
919 #define CEC_OP_AUD_RATE_WIDE_SLOW			3
920 #define CEC_OP_AUD_RATE_NARROW_STD			4
921 #define CEC_OP_AUD_RATE_NARROW_FAST			5
922 #define CEC_OP_AUD_RATE_NARROW_SLOW			6
923 
924 
925 /* Audio Return Channel Control Feature */
926 #define CEC_MSG_INITIATE_ARC				0xc0
927 #define CEC_MSG_REPORT_ARC_INITIATED			0xc1
928 #define CEC_MSG_REPORT_ARC_TERMINATED			0xc2
929 #define CEC_MSG_REQUEST_ARC_INITIATION			0xc3
930 #define CEC_MSG_REQUEST_ARC_TERMINATION			0xc4
931 #define CEC_MSG_TERMINATE_ARC				0xc5
932 
933 
934 /* Dynamic Audio Lipsync Feature */
935 /* Only for CEC 2.0 and up */
936 #define CEC_MSG_REQUEST_CURRENT_LATENCY			0xa7
937 #define CEC_MSG_REPORT_CURRENT_LATENCY			0xa8
938 /* Low Latency Mode Operand (low_latency_mode) */
939 #define CEC_OP_LOW_LATENCY_MODE_OFF			0
940 #define CEC_OP_LOW_LATENCY_MODE_ON			1
941 /* Audio Output Compensated Operand (audio_out_compensated) */
942 #define CEC_OP_AUD_OUT_COMPENSATED_NA			0
943 #define CEC_OP_AUD_OUT_COMPENSATED_DELAY		1
944 #define CEC_OP_AUD_OUT_COMPENSATED_NO_DELAY		2
945 #define CEC_OP_AUD_OUT_COMPENSATED_PARTIAL_DELAY	3
946 
947 
948 /* Capability Discovery and Control Feature */
949 #define CEC_MSG_CDC_MESSAGE				0xf8
950 /* Ethernet-over-HDMI: nobody ever does this... */
951 #define CEC_MSG_CDC_HEC_INQUIRE_STATE			0x00
952 #define CEC_MSG_CDC_HEC_REPORT_STATE			0x01
953 /* HEC Functionality State Operand (hec_func_state) */
954 #define CEC_OP_HEC_FUNC_STATE_NOT_SUPPORTED		0
955 #define CEC_OP_HEC_FUNC_STATE_INACTIVE			1
956 #define CEC_OP_HEC_FUNC_STATE_ACTIVE			2
957 #define CEC_OP_HEC_FUNC_STATE_ACTIVATION_FIELD		3
958 /* Host Functionality State Operand (host_func_state) */
959 #define CEC_OP_HOST_FUNC_STATE_NOT_SUPPORTED		0
960 #define CEC_OP_HOST_FUNC_STATE_INACTIVE			1
961 #define CEC_OP_HOST_FUNC_STATE_ACTIVE			2
962 /* ENC Functionality State Operand (enc_func_state) */
963 #define CEC_OP_ENC_FUNC_STATE_EXT_CON_NOT_SUPPORTED	0
964 #define CEC_OP_ENC_FUNC_STATE_EXT_CON_INACTIVE		1
965 #define CEC_OP_ENC_FUNC_STATE_EXT_CON_ACTIVE		2
966 /* CDC Error Code Operand (cdc_errcode) */
967 #define CEC_OP_CDC_ERROR_CODE_NONE			0
968 #define CEC_OP_CDC_ERROR_CODE_CAP_UNSUPPORTED		1
969 #define CEC_OP_CDC_ERROR_CODE_WRONG_STATE		2
970 #define CEC_OP_CDC_ERROR_CODE_OTHER			3
971 /* HEC Support Operand (hec_support) */
972 #define CEC_OP_HEC_SUPPORT_NO				0
973 #define CEC_OP_HEC_SUPPORT_YES				1
974 /* HEC Activation Operand (hec_activation) */
975 #define CEC_OP_HEC_ACTIVATION_ON			0
976 #define CEC_OP_HEC_ACTIVATION_OFF			1
977 
978 #define CEC_MSG_CDC_HEC_SET_STATE_ADJACENT		0x02
979 #define CEC_MSG_CDC_HEC_SET_STATE			0x03
980 /* HEC Set State Operand (hec_set_state) */
981 #define CEC_OP_HEC_SET_STATE_DEACTIVATE			0
982 #define CEC_OP_HEC_SET_STATE_ACTIVATE			1
983 
984 #define CEC_MSG_CDC_HEC_REQUEST_DEACTIVATION		0x04
985 #define CEC_MSG_CDC_HEC_NOTIFY_ALIVE			0x05
986 #define CEC_MSG_CDC_HEC_DISCOVER			0x06
987 /* Hotplug Detect messages */
988 #define CEC_MSG_CDC_HPD_SET_STATE			0x10
989 /* HPD State Operand (hpd_state) */
990 #define CEC_OP_HPD_STATE_CP_EDID_DISABLE		0
991 #define CEC_OP_HPD_STATE_CP_EDID_ENABLE			1
992 #define CEC_OP_HPD_STATE_CP_EDID_DISABLE_ENABLE		2
993 #define CEC_OP_HPD_STATE_EDID_DISABLE			3
994 #define CEC_OP_HPD_STATE_EDID_ENABLE			4
995 #define CEC_OP_HPD_STATE_EDID_DISABLE_ENABLE		5
996 #define CEC_MSG_CDC_HPD_REPORT_STATE			0x11
997 /* HPD Error Code Operand (hpd_error) */
998 #define CEC_OP_HPD_ERROR_NONE				0
999 #define CEC_OP_HPD_ERROR_INITIATOR_NOT_CAPABLE		1
1000 #define CEC_OP_HPD_ERROR_INITIATOR_WRONG_STATE		2
1001 #define CEC_OP_HPD_ERROR_OTHER				3
1002 #define CEC_OP_HPD_ERROR_NONE_NO_VIDEO			4
1003 
1004 /* End of Messages */
1005 
1006 /* Helper functions to identify the 'special' CEC devices */
1007 
1008 static inline int cec_is_2nd_tv(const struct cec_log_addrs *las)
1009 {
1010 	/*
1011 	 * It is a second TV if the logical address is 14 or 15 and the
1012 	 * primary device type is a TV.
1013 	 */
1014 	return las->num_log_addrs &&
1015 	       las->log_addr[0] >= CEC_LOG_ADDR_SPECIFIC &&
1016 	       las->primary_device_type[0] == CEC_OP_PRIM_DEVTYPE_TV;
1017 }
1018 
1019 static inline int cec_is_processor(const struct cec_log_addrs *las)
1020 {
1021 	/*
1022 	 * It is a processor if the logical address is 12-15 and the
1023 	 * primary device type is a Processor.
1024 	 */
1025 	return las->num_log_addrs &&
1026 	       las->log_addr[0] >= CEC_LOG_ADDR_BACKUP_1 &&
1027 	       las->primary_device_type[0] == CEC_OP_PRIM_DEVTYPE_PROCESSOR;
1028 }
1029 
1030 static inline int cec_is_switch(const struct cec_log_addrs *las)
1031 {
1032 	/*
1033 	 * It is a switch if the logical address is 15 and the
1034 	 * primary device type is a Switch and the CDC-Only flag is not set.
1035 	 */
1036 	return las->num_log_addrs == 1 &&
1037 	       las->log_addr[0] == CEC_LOG_ADDR_UNREGISTERED &&
1038 	       las->primary_device_type[0] == CEC_OP_PRIM_DEVTYPE_SWITCH &&
1039 	       !(las->flags & CEC_LOG_ADDRS_FL_CDC_ONLY);
1040 }
1041 
1042 static inline int cec_is_cdc_only(const struct cec_log_addrs *las)
1043 {
1044 	/*
1045 	 * It is a CDC-only device if the logical address is 15 and the
1046 	 * primary device type is a Switch and the CDC-Only flag is set.
1047 	 */
1048 	return las->num_log_addrs == 1 &&
1049 	       las->log_addr[0] == CEC_LOG_ADDR_UNREGISTERED &&
1050 	       las->primary_device_type[0] == CEC_OP_PRIM_DEVTYPE_SWITCH &&
1051 	       (las->flags & CEC_LOG_ADDRS_FL_CDC_ONLY);
1052 }
1053 
1054 #endif
1055