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