xref: /linux-6.15/include/uapi/linux/cec.h (revision bbb03029)
1 /*
2  * cec - HDMI Consumer Electronics Control public header
3  *
4  * Copyright 2016 Cisco Systems, Inc. and/or its affiliates. All rights reserved.
5  *
6  * This program is free software; you may redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; version 2 of the License.
9  *
10  * Alternatively you can redistribute this file under the terms of the
11  * BSD license as stated below:
12  *
13  * Redistribution and use in source and binary forms, with or without
14  * modification, are permitted provided that the following conditions
15  * are met:
16  * 1. Redistributions of source code must retain the above copyright
17  *    notice, this list of conditions and the following disclaimer.
18  * 2. Redistributions in binary form must reproduce the above copyright
19  *    notice, this list of conditions and the following disclaimer in
20  *    the documentation and/or other materials provided with the
21  *    distribution.
22  * 3. The names of its contributors may not be used to endorse or promote
23  *    products derived from this software without specific prior written
24  *    permission.
25  *
26  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
27  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
28  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
29  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
30  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
31  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
32  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
33  * SOFTWARE.
34  */
35 
36 #ifndef _CEC_UAPI_H
37 #define _CEC_UAPI_H
38 
39 #include <linux/types.h>
40 #include <linux/string.h>
41 
42 #define CEC_MAX_MSG_SIZE	16
43 
44 /**
45  * struct cec_msg - CEC message structure.
46  * @tx_ts:	Timestamp in nanoseconds using CLOCK_MONOTONIC. Set by the
47  *		driver when the message transmission has finished.
48  * @rx_ts:	Timestamp in nanoseconds using CLOCK_MONOTONIC. Set by the
49  *		driver when the message was received.
50  * @len:	Length in bytes of the message.
51  * @timeout:	The timeout (in ms) that is used to timeout CEC_RECEIVE.
52  *		Set to 0 if you want to wait forever. This timeout can also be
53  *		used with CEC_TRANSMIT as the timeout for waiting for a reply.
54  *		If 0, then it will use a 1 second timeout instead of waiting
55  *		forever as is done with CEC_RECEIVE.
56  * @sequence:	The framework assigns a sequence number to messages that are
57  *		sent. This can be used to track replies to previously sent
58  *		messages.
59  * @flags:	Set to 0.
60  * @msg:	The message payload.
61  * @reply:	This field is ignored with CEC_RECEIVE and is only used by
62  *		CEC_TRANSMIT. If non-zero, then wait for a reply with this
63  *		opcode. Set to CEC_MSG_FEATURE_ABORT if you want to wait for
64  *		a possible ABORT reply. If there was an error when sending the
65  *		msg or FeatureAbort was returned, then reply is set to 0.
66  *		If reply is non-zero upon return, then len/msg are set to
67  *		the received message.
68  *		If reply is zero upon return and status has the
69  *		CEC_TX_STATUS_FEATURE_ABORT bit set, then len/msg are set to
70  *		the received feature abort message.
71  *		If reply is zero upon return and status has the
72  *		CEC_TX_STATUS_MAX_RETRIES bit set, then no reply was seen at
73  *		all. If reply is non-zero for CEC_TRANSMIT and the message is a
74  *		broadcast, then -EINVAL is returned.
75  *		if reply is non-zero, then timeout is set to 1000 (the required
76  *		maximum response time).
77  * @rx_status:	The message receive status bits. Set by the driver.
78  * @tx_status:	The message transmit status bits. Set by the driver.
79  * @tx_arb_lost_cnt: The number of 'Arbitration Lost' events. Set by the driver.
80  * @tx_nack_cnt: The number of 'Not Acknowledged' events. Set by the driver.
81  * @tx_low_drive_cnt: The number of 'Low Drive Detected' events. Set by the
82  *		driver.
83  * @tx_error_cnt: The number of 'Error' events. Set by the driver.
84  */
85 struct cec_msg {
86 	__u64 tx_ts;
87 	__u64 rx_ts;
88 	__u32 len;
89 	__u32 timeout;
90 	__u32 sequence;
91 	__u32 flags;
92 	__u8 msg[CEC_MAX_MSG_SIZE];
93 	__u8 reply;
94 	__u8 rx_status;
95 	__u8 tx_status;
96 	__u8 tx_arb_lost_cnt;
97 	__u8 tx_nack_cnt;
98 	__u8 tx_low_drive_cnt;
99 	__u8 tx_error_cnt;
100 };
101 
102 /**
103  * cec_msg_initiator - return the initiator's logical address.
104  * @msg:	the message structure
105  */
106 static inline __u8 cec_msg_initiator(const struct cec_msg *msg)
107 {
108 	return msg->msg[0] >> 4;
109 }
110 
111 /**
112  * cec_msg_destination - return the destination's logical address.
113  * @msg:	the message structure
114  */
115 static inline __u8 cec_msg_destination(const struct cec_msg *msg)
116 {
117 	return msg->msg[0] & 0xf;
118 }
119 
120 /**
121  * cec_msg_opcode - return the opcode of the message, -1 for poll
122  * @msg:	the message structure
123  */
124 static inline int cec_msg_opcode(const struct cec_msg *msg)
125 {
126 	return msg->len > 1 ? msg->msg[1] : -1;
127 }
128 
129 /**
130  * cec_msg_is_broadcast - return true if this is a broadcast message.
131  * @msg:	the message structure
132  */
133 static inline int cec_msg_is_broadcast(const struct cec_msg *msg)
134 {
135 	return (msg->msg[0] & 0xf) == 0xf;
136 }
137 
138 /**
139  * cec_msg_init - initialize the message structure.
140  * @msg:	the message structure
141  * @initiator:	the logical address of the initiator
142  * @destination:the logical address of the destination (0xf for broadcast)
143  *
144  * The whole structure is zeroed, the len field is set to 1 (i.e. a poll
145  * message) and the initiator and destination are filled in.
146  */
147 static inline void cec_msg_init(struct cec_msg *msg,
148 				__u8 initiator, __u8 destination)
149 {
150 	memset(msg, 0, sizeof(*msg));
151 	msg->msg[0] = (initiator << 4) | destination;
152 	msg->len = 1;
153 }
154 
155 /**
156  * cec_msg_set_reply_to - fill in destination/initiator in a reply message.
157  * @msg:	the message structure for the reply
158  * @orig:	the original message structure
159  *
160  * Set the msg destination to the orig initiator and the msg initiator to the
161  * orig destination. Note that msg and orig may be the same pointer, in which
162  * case the change is done in place.
163  */
164 static inline void cec_msg_set_reply_to(struct cec_msg *msg,
165 					struct cec_msg *orig)
166 {
167 	/* The destination becomes the initiator and vice versa */
168 	msg->msg[0] = (cec_msg_destination(orig) << 4) |
169 		      cec_msg_initiator(orig);
170 	msg->reply = msg->timeout = 0;
171 }
172 
173 /* cec_msg flags field */
174 #define CEC_MSG_FL_REPLY_TO_FOLLOWERS	(1 << 0)
175 
176 /* cec_msg tx/rx_status field */
177 #define CEC_TX_STATUS_OK		(1 << 0)
178 #define CEC_TX_STATUS_ARB_LOST		(1 << 1)
179 #define CEC_TX_STATUS_NACK		(1 << 2)
180 #define CEC_TX_STATUS_LOW_DRIVE		(1 << 3)
181 #define CEC_TX_STATUS_ERROR		(1 << 4)
182 #define CEC_TX_STATUS_MAX_RETRIES	(1 << 5)
183 
184 #define CEC_RX_STATUS_OK		(1 << 0)
185 #define CEC_RX_STATUS_TIMEOUT		(1 << 1)
186 #define CEC_RX_STATUS_FEATURE_ABORT	(1 << 2)
187 
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 
258 static inline int cec_has_tv(__u16 log_addr_mask)
259 {
260 	return log_addr_mask & CEC_LOG_ADDR_MASK_TV;
261 }
262 
263 static inline int cec_has_record(__u16 log_addr_mask)
264 {
265 	return log_addr_mask & CEC_LOG_ADDR_MASK_RECORD;
266 }
267 
268 static inline int cec_has_tuner(__u16 log_addr_mask)
269 {
270 	return log_addr_mask & CEC_LOG_ADDR_MASK_TUNER;
271 }
272 
273 static inline int cec_has_playback(__u16 log_addr_mask)
274 {
275 	return log_addr_mask & CEC_LOG_ADDR_MASK_PLAYBACK;
276 }
277 
278 static inline int cec_has_audiosystem(__u16 log_addr_mask)
279 {
280 	return log_addr_mask & CEC_LOG_ADDR_MASK_AUDIOSYSTEM;
281 }
282 
283 static inline int cec_has_backup(__u16 log_addr_mask)
284 {
285 	return log_addr_mask & CEC_LOG_ADDR_MASK_BACKUP;
286 }
287 
288 static inline int cec_has_specific(__u16 log_addr_mask)
289 {
290 	return log_addr_mask & CEC_LOG_ADDR_MASK_SPECIFIC;
291 }
292 
293 static inline int cec_is_unregistered(__u16 log_addr_mask)
294 {
295 	return log_addr_mask & CEC_LOG_ADDR_MASK_UNREGISTERED;
296 }
297 
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		(0xe << 4)
322 #define CEC_MODE_MONITOR_ALL		(0xf << 4)
323 #define CEC_MODE_FOLLOWER_MSK		0xf0
324 
325 /* Userspace has to configure the physical address */
326 #define CEC_CAP_PHYS_ADDR	(1 << 0)
327 /* Userspace has to configure the logical addresses */
328 #define CEC_CAP_LOG_ADDRS	(1 << 1)
329 /* Userspace can transmit messages (and thus become follower as well) */
330 #define CEC_CAP_TRANSMIT	(1 << 2)
331 /*
332  * Passthrough all messages instead of processing them.
333  */
334 #define CEC_CAP_PASSTHROUGH	(1 << 3)
335 /* Supports remote control */
336 #define CEC_CAP_RC		(1 << 4)
337 /* Hardware can monitor all messages, not just directed and broadcast. */
338 #define CEC_CAP_MONITOR_ALL	(1 << 5)
339 /* Hardware can use CEC only if the HDMI HPD pin is high. */
340 #define CEC_CAP_NEEDS_HPD	(1 << 6)
341 
342 /**
343  * struct cec_caps - CEC capabilities structure.
344  * @driver: name of the CEC device driver.
345  * @name: name of the CEC device. @driver + @name must be unique.
346  * @available_log_addrs: number of available logical addresses.
347  * @capabilities: capabilities of the CEC adapter.
348  * @version: version of the CEC adapter framework.
349  */
350 struct cec_caps {
351 	char driver[32];
352 	char name[32];
353 	__u32 available_log_addrs;
354 	__u32 capabilities;
355 	__u32 version;
356 };
357 
358 /**
359  * struct cec_log_addrs - CEC logical addresses structure.
360  * @log_addr: the claimed logical addresses. Set by the driver.
361  * @log_addr_mask: current logical address mask. Set by the driver.
362  * @cec_version: the CEC version that the adapter should implement. Set by the
363  *	caller.
364  * @num_log_addrs: how many logical addresses should be claimed. Set by the
365  *	caller.
366  * @vendor_id: the vendor ID of the device. Set by the caller.
367  * @flags: flags.
368  * @osd_name: the OSD name of the device. Set by the caller.
369  * @primary_device_type: the primary device type for each logical address.
370  *	Set by the caller.
371  * @log_addr_type: the logical address types. Set by the caller.
372  * @all_device_types: CEC 2.0: all device types represented by the logical
373  *	address. Set by the caller.
374  * @features:	CEC 2.0: The logical address features. Set by the caller.
375  */
376 struct cec_log_addrs {
377 	__u8 log_addr[CEC_MAX_LOG_ADDRS];
378 	__u16 log_addr_mask;
379 	__u8 cec_version;
380 	__u8 num_log_addrs;
381 	__u32 vendor_id;
382 	__u32 flags;
383 	char osd_name[15];
384 	__u8 primary_device_type[CEC_MAX_LOG_ADDRS];
385 	__u8 log_addr_type[CEC_MAX_LOG_ADDRS];
386 
387 	/* CEC 2.0 */
388 	__u8 all_device_types[CEC_MAX_LOG_ADDRS];
389 	__u8 features[CEC_MAX_LOG_ADDRS][12];
390 };
391 
392 /* Allow a fallback to unregistered */
393 #define CEC_LOG_ADDRS_FL_ALLOW_UNREG_FALLBACK	(1 << 0)
394 /* Passthrough RC messages to the input subsystem */
395 #define CEC_LOG_ADDRS_FL_ALLOW_RC_PASSTHRU	(1 << 1)
396 /* CDC-Only device: supports only CDC messages */
397 #define CEC_LOG_ADDRS_FL_CDC_ONLY		(1 << 2)
398 
399 /* Events */
400 
401 /* Event that occurs when the adapter state changes */
402 #define CEC_EVENT_STATE_CHANGE		1
403 /*
404  * This event is sent when messages are lost because the application
405  * didn't empty the message queue in time
406  */
407 #define CEC_EVENT_LOST_MSGS		2
408 
409 #define CEC_EVENT_FL_INITIAL_STATE	(1 << 0)
410 
411 /**
412  * struct cec_event_state_change - used when the CEC adapter changes state.
413  * @phys_addr: the current physical address
414  * @log_addr_mask: the current logical address mask
415  */
416 struct cec_event_state_change {
417 	__u16 phys_addr;
418 	__u16 log_addr_mask;
419 };
420 
421 /**
422  * struct cec_event_lost_msgs - tells you how many messages were lost due.
423  * @lost_msgs: how many messages were lost.
424  */
425 struct cec_event_lost_msgs {
426 	__u32 lost_msgs;
427 };
428 
429 /**
430  * struct cec_event - CEC event structure
431  * @ts: the timestamp of when the event was sent.
432  * @event: the event.
433  * array.
434  * @state_change: the event payload for CEC_EVENT_STATE_CHANGE.
435  * @lost_msgs: the event payload for CEC_EVENT_LOST_MSGS.
436  * @raw: array to pad the union.
437  */
438 struct cec_event {
439 	__u64 ts;
440 	__u32 event;
441 	__u32 flags;
442 	union {
443 		struct cec_event_state_change state_change;
444 		struct cec_event_lost_msgs lost_msgs;
445 		__u32 raw[16];
446 	};
447 };
448 
449 /* ioctls */
450 
451 /* Adapter capabilities */
452 #define CEC_ADAP_G_CAPS		_IOWR('a',  0, struct cec_caps)
453 
454 /*
455  * phys_addr is either 0 (if this is the CEC root device)
456  * or a valid physical address obtained from the sink's EDID
457  * as read by this CEC device (if this is a source device)
458  * or a physical address obtained and modified from a sink
459  * EDID and used for a sink CEC device.
460  * If nothing is connected, then phys_addr is 0xffff.
461  * See HDMI 1.4b, section 8.7 (Physical Address).
462  *
463  * The CEC_ADAP_S_PHYS_ADDR ioctl may not be available if that is handled
464  * internally.
465  */
466 #define CEC_ADAP_G_PHYS_ADDR	_IOR('a',  1, __u16)
467 #define CEC_ADAP_S_PHYS_ADDR	_IOW('a',  2, __u16)
468 
469 /*
470  * Configure the CEC adapter. It sets the device type and which
471  * logical types it will try to claim. It will return which
472  * logical addresses it could actually claim.
473  * An error is returned if the adapter is disabled or if there
474  * is no physical address assigned.
475  */
476 
477 #define CEC_ADAP_G_LOG_ADDRS	_IOR('a',  3, struct cec_log_addrs)
478 #define CEC_ADAP_S_LOG_ADDRS	_IOWR('a',  4, struct cec_log_addrs)
479 
480 /* Transmit/receive a CEC command */
481 #define CEC_TRANSMIT		_IOWR('a',  5, struct cec_msg)
482 #define CEC_RECEIVE		_IOWR('a',  6, struct cec_msg)
483 
484 /* Dequeue CEC events */
485 #define CEC_DQEVENT		_IOWR('a',  7, struct cec_event)
486 
487 /*
488  * Get and set the message handling mode for this filehandle.
489  */
490 #define CEC_G_MODE		_IOR('a',  8, __u32)
491 #define CEC_S_MODE		_IOW('a',  9, __u32)
492 
493 /*
494  * The remainder of this header defines all CEC messages and operands.
495  * The format matters since it the cec-ctl utility parses it to generate
496  * code for implementing all these messages.
497  *
498  * Comments ending with 'Feature' group messages for each feature.
499  * If messages are part of multiple features, then the "Has also"
500  * comment is used to list the previously defined messages that are
501  * supported by the feature.
502  *
503  * Before operands are defined a comment is added that gives the
504  * name of the operand and in brackets the variable name of the
505  * corresponding argument in the cec-funcs.h function.
506  */
507 
508 /* Messages */
509 
510 /* One Touch Play Feature */
511 #define CEC_MSG_ACTIVE_SOURCE				0x82
512 #define CEC_MSG_IMAGE_VIEW_ON				0x04
513 #define CEC_MSG_TEXT_VIEW_ON				0x0d
514 
515 
516 /* Routing Control Feature */
517 
518 /*
519  * Has also:
520  *	CEC_MSG_ACTIVE_SOURCE
521  */
522 
523 #define CEC_MSG_INACTIVE_SOURCE				0x9d
524 #define CEC_MSG_REQUEST_ACTIVE_SOURCE			0x85
525 #define CEC_MSG_ROUTING_CHANGE				0x80
526 #define CEC_MSG_ROUTING_INFORMATION			0x81
527 #define CEC_MSG_SET_STREAM_PATH				0x86
528 
529 
530 /* Standby Feature */
531 #define CEC_MSG_STANDBY					0x36
532 
533 
534 /* One Touch Record Feature */
535 #define CEC_MSG_RECORD_OFF				0x0b
536 #define CEC_MSG_RECORD_ON				0x09
537 /* Record Source Type Operand (rec_src_type) */
538 #define CEC_OP_RECORD_SRC_OWN				1
539 #define CEC_OP_RECORD_SRC_DIGITAL			2
540 #define CEC_OP_RECORD_SRC_ANALOG			3
541 #define CEC_OP_RECORD_SRC_EXT_PLUG			4
542 #define CEC_OP_RECORD_SRC_EXT_PHYS_ADDR			5
543 /* Service Identification Method Operand (service_id_method) */
544 #define CEC_OP_SERVICE_ID_METHOD_BY_DIG_ID		0
545 #define CEC_OP_SERVICE_ID_METHOD_BY_CHANNEL		1
546 /* Digital Service Broadcast System Operand (dig_bcast_system) */
547 #define CEC_OP_DIG_SERVICE_BCAST_SYSTEM_ARIB_GEN	0x00
548 #define CEC_OP_DIG_SERVICE_BCAST_SYSTEM_ATSC_GEN	0x01
549 #define CEC_OP_DIG_SERVICE_BCAST_SYSTEM_DVB_GEN		0x02
550 #define CEC_OP_DIG_SERVICE_BCAST_SYSTEM_ARIB_BS		0x08
551 #define CEC_OP_DIG_SERVICE_BCAST_SYSTEM_ARIB_CS		0x09
552 #define CEC_OP_DIG_SERVICE_BCAST_SYSTEM_ARIB_T		0x0a
553 #define CEC_OP_DIG_SERVICE_BCAST_SYSTEM_ATSC_CABLE	0x10
554 #define CEC_OP_DIG_SERVICE_BCAST_SYSTEM_ATSC_SAT	0x11
555 #define CEC_OP_DIG_SERVICE_BCAST_SYSTEM_ATSC_T		0x12
556 #define CEC_OP_DIG_SERVICE_BCAST_SYSTEM_DVB_C		0x18
557 #define CEC_OP_DIG_SERVICE_BCAST_SYSTEM_DVB_S		0x19
558 #define CEC_OP_DIG_SERVICE_BCAST_SYSTEM_DVB_S2		0x1a
559 #define CEC_OP_DIG_SERVICE_BCAST_SYSTEM_DVB_T		0x1b
560 /* Analogue Broadcast Type Operand (ana_bcast_type) */
561 #define CEC_OP_ANA_BCAST_TYPE_CABLE			0
562 #define CEC_OP_ANA_BCAST_TYPE_SATELLITE			1
563 #define CEC_OP_ANA_BCAST_TYPE_TERRESTRIAL		2
564 /* Broadcast System Operand (bcast_system) */
565 #define CEC_OP_BCAST_SYSTEM_PAL_BG			0x00
566 #define CEC_OP_BCAST_SYSTEM_SECAM_LQ			0x01 /* SECAM L' */
567 #define CEC_OP_BCAST_SYSTEM_PAL_M			0x02
568 #define CEC_OP_BCAST_SYSTEM_NTSC_M			0x03
569 #define CEC_OP_BCAST_SYSTEM_PAL_I			0x04
570 #define CEC_OP_BCAST_SYSTEM_SECAM_DK			0x05
571 #define CEC_OP_BCAST_SYSTEM_SECAM_BG			0x06
572 #define CEC_OP_BCAST_SYSTEM_SECAM_L			0x07
573 #define CEC_OP_BCAST_SYSTEM_PAL_DK			0x08
574 #define CEC_OP_BCAST_SYSTEM_OTHER			0x1f
575 /* Channel Number Format Operand (channel_number_fmt) */
576 #define CEC_OP_CHANNEL_NUMBER_FMT_1_PART		0x01
577 #define CEC_OP_CHANNEL_NUMBER_FMT_2_PART		0x02
578 
579 #define CEC_MSG_RECORD_STATUS				0x0a
580 /* Record Status Operand (rec_status) */
581 #define CEC_OP_RECORD_STATUS_CUR_SRC			0x01
582 #define CEC_OP_RECORD_STATUS_DIG_SERVICE		0x02
583 #define CEC_OP_RECORD_STATUS_ANA_SERVICE		0x03
584 #define CEC_OP_RECORD_STATUS_EXT_INPUT			0x04
585 #define CEC_OP_RECORD_STATUS_NO_DIG_SERVICE		0x05
586 #define CEC_OP_RECORD_STATUS_NO_ANA_SERVICE		0x06
587 #define CEC_OP_RECORD_STATUS_NO_SERVICE			0x07
588 #define CEC_OP_RECORD_STATUS_INVALID_EXT_PLUG		0x09
589 #define CEC_OP_RECORD_STATUS_INVALID_EXT_PHYS_ADDR	0x0a
590 #define CEC_OP_RECORD_STATUS_UNSUP_CA			0x0b
591 #define CEC_OP_RECORD_STATUS_NO_CA_ENTITLEMENTS		0x0c
592 #define CEC_OP_RECORD_STATUS_CANT_COPY_SRC		0x0d
593 #define CEC_OP_RECORD_STATUS_NO_MORE_COPIES		0x0e
594 #define CEC_OP_RECORD_STATUS_NO_MEDIA			0x10
595 #define CEC_OP_RECORD_STATUS_PLAYING			0x11
596 #define CEC_OP_RECORD_STATUS_ALREADY_RECORDING		0x12
597 #define CEC_OP_RECORD_STATUS_MEDIA_PROT			0x13
598 #define CEC_OP_RECORD_STATUS_NO_SIGNAL			0x14
599 #define CEC_OP_RECORD_STATUS_MEDIA_PROBLEM		0x15
600 #define CEC_OP_RECORD_STATUS_NO_SPACE			0x16
601 #define CEC_OP_RECORD_STATUS_PARENTAL_LOCK		0x17
602 #define CEC_OP_RECORD_STATUS_TERMINATED_OK		0x1a
603 #define CEC_OP_RECORD_STATUS_ALREADY_TERM		0x1b
604 #define CEC_OP_RECORD_STATUS_OTHER			0x1f
605 
606 #define CEC_MSG_RECORD_TV_SCREEN			0x0f
607 
608 
609 /* Timer Programming Feature */
610 #define CEC_MSG_CLEAR_ANALOGUE_TIMER			0x33
611 /* Recording Sequence Operand (recording_seq) */
612 #define CEC_OP_REC_SEQ_SUNDAY				0x01
613 #define CEC_OP_REC_SEQ_MONDAY				0x02
614 #define CEC_OP_REC_SEQ_TUESDAY				0x04
615 #define CEC_OP_REC_SEQ_WEDNESDAY			0x08
616 #define CEC_OP_REC_SEQ_THURSDAY				0x10
617 #define CEC_OP_REC_SEQ_FRIDAY				0x20
618 #define CEC_OP_REC_SEQ_SATERDAY				0x40
619 #define CEC_OP_REC_SEQ_ONCE_ONLY			0x00
620 
621 #define CEC_MSG_CLEAR_DIGITAL_TIMER			0x99
622 
623 #define CEC_MSG_CLEAR_EXT_TIMER				0xa1
624 /* External Source Specifier Operand (ext_src_spec) */
625 #define CEC_OP_EXT_SRC_PLUG				0x04
626 #define CEC_OP_EXT_SRC_PHYS_ADDR			0x05
627 
628 #define CEC_MSG_SET_ANALOGUE_TIMER			0x34
629 #define CEC_MSG_SET_DIGITAL_TIMER			0x97
630 #define CEC_MSG_SET_EXT_TIMER				0xa2
631 
632 #define CEC_MSG_SET_TIMER_PROGRAM_TITLE			0x67
633 #define CEC_MSG_TIMER_CLEARED_STATUS			0x43
634 /* Timer Cleared Status Data Operand (timer_cleared_status) */
635 #define CEC_OP_TIMER_CLR_STAT_RECORDING			0x00
636 #define CEC_OP_TIMER_CLR_STAT_NO_MATCHING		0x01
637 #define CEC_OP_TIMER_CLR_STAT_NO_INFO			0x02
638 #define CEC_OP_TIMER_CLR_STAT_CLEARED			0x80
639 
640 #define CEC_MSG_TIMER_STATUS				0x35
641 /* Timer Overlap Warning Operand (timer_overlap_warning) */
642 #define CEC_OP_TIMER_OVERLAP_WARNING_NO_OVERLAP		0
643 #define CEC_OP_TIMER_OVERLAP_WARNING_OVERLAP		1
644 /* Media Info Operand (media_info) */
645 #define CEC_OP_MEDIA_INFO_UNPROT_MEDIA			0
646 #define CEC_OP_MEDIA_INFO_PROT_MEDIA			1
647 #define CEC_OP_MEDIA_INFO_NO_MEDIA			2
648 /* Programmed Indicator Operand (prog_indicator) */
649 #define CEC_OP_PROG_IND_NOT_PROGRAMMED			0
650 #define CEC_OP_PROG_IND_PROGRAMMED			1
651 /* Programmed Info Operand (prog_info) */
652 #define CEC_OP_PROG_INFO_ENOUGH_SPACE			0x08
653 #define CEC_OP_PROG_INFO_NOT_ENOUGH_SPACE		0x09
654 #define CEC_OP_PROG_INFO_MIGHT_NOT_BE_ENOUGH_SPACE	0x0b
655 #define CEC_OP_PROG_INFO_NONE_AVAILABLE			0x0a
656 /* Not Programmed Error Info Operand (prog_error) */
657 #define CEC_OP_PROG_ERROR_NO_FREE_TIMER			0x01
658 #define CEC_OP_PROG_ERROR_DATE_OUT_OF_RANGE		0x02
659 #define CEC_OP_PROG_ERROR_REC_SEQ_ERROR			0x03
660 #define CEC_OP_PROG_ERROR_INV_EXT_PLUG			0x04
661 #define CEC_OP_PROG_ERROR_INV_EXT_PHYS_ADDR		0x05
662 #define CEC_OP_PROG_ERROR_CA_UNSUPP			0x06
663 #define CEC_OP_PROG_ERROR_INSUF_CA_ENTITLEMENTS		0x07
664 #define CEC_OP_PROG_ERROR_RESOLUTION_UNSUPP		0x08
665 #define CEC_OP_PROG_ERROR_PARENTAL_LOCK			0x09
666 #define CEC_OP_PROG_ERROR_CLOCK_FAILURE			0x0a
667 #define CEC_OP_PROG_ERROR_DUPLICATE			0x0e
668 
669 
670 /* System Information Feature */
671 #define CEC_MSG_CEC_VERSION				0x9e
672 /* CEC Version Operand (cec_version) */
673 #define CEC_OP_CEC_VERSION_1_3A				4
674 #define CEC_OP_CEC_VERSION_1_4				5
675 #define CEC_OP_CEC_VERSION_2_0				6
676 
677 #define CEC_MSG_GET_CEC_VERSION				0x9f
678 #define CEC_MSG_GIVE_PHYSICAL_ADDR			0x83
679 #define CEC_MSG_GET_MENU_LANGUAGE			0x91
680 #define CEC_MSG_REPORT_PHYSICAL_ADDR			0x84
681 /* Primary Device Type Operand (prim_devtype) */
682 #define CEC_OP_PRIM_DEVTYPE_TV				0
683 #define CEC_OP_PRIM_DEVTYPE_RECORD			1
684 #define CEC_OP_PRIM_DEVTYPE_TUNER			3
685 #define CEC_OP_PRIM_DEVTYPE_PLAYBACK			4
686 #define CEC_OP_PRIM_DEVTYPE_AUDIOSYSTEM			5
687 #define CEC_OP_PRIM_DEVTYPE_SWITCH			6
688 #define CEC_OP_PRIM_DEVTYPE_PROCESSOR			7
689 
690 #define CEC_MSG_SET_MENU_LANGUAGE			0x32
691 #define CEC_MSG_REPORT_FEATURES				0xa6	/* HDMI 2.0 */
692 /* All Device Types Operand (all_device_types) */
693 #define CEC_OP_ALL_DEVTYPE_TV				0x80
694 #define CEC_OP_ALL_DEVTYPE_RECORD			0x40
695 #define CEC_OP_ALL_DEVTYPE_TUNER			0x20
696 #define CEC_OP_ALL_DEVTYPE_PLAYBACK			0x10
697 #define CEC_OP_ALL_DEVTYPE_AUDIOSYSTEM			0x08
698 #define CEC_OP_ALL_DEVTYPE_SWITCH			0x04
699 /*
700  * And if you wondering what happened to PROCESSOR devices: those should
701  * be mapped to a SWITCH.
702  */
703 
704 /* Valid for RC Profile and Device Feature operands */
705 #define CEC_OP_FEAT_EXT					0x80	/* Extension bit */
706 /* RC Profile Operand (rc_profile) */
707 #define CEC_OP_FEAT_RC_TV_PROFILE_NONE			0x00
708 #define CEC_OP_FEAT_RC_TV_PROFILE_1			0x02
709 #define CEC_OP_FEAT_RC_TV_PROFILE_2			0x06
710 #define CEC_OP_FEAT_RC_TV_PROFILE_3			0x0a
711 #define CEC_OP_FEAT_RC_TV_PROFILE_4			0x0e
712 #define CEC_OP_FEAT_RC_SRC_HAS_DEV_ROOT_MENU		0x50
713 #define CEC_OP_FEAT_RC_SRC_HAS_DEV_SETUP_MENU		0x48
714 #define CEC_OP_FEAT_RC_SRC_HAS_CONTENTS_MENU		0x44
715 #define CEC_OP_FEAT_RC_SRC_HAS_MEDIA_TOP_MENU		0x42
716 #define CEC_OP_FEAT_RC_SRC_HAS_MEDIA_CONTEXT_MENU	0x41
717 /* Device Feature Operand (dev_features) */
718 #define CEC_OP_FEAT_DEV_HAS_RECORD_TV_SCREEN		0x40
719 #define CEC_OP_FEAT_DEV_HAS_SET_OSD_STRING		0x20
720 #define CEC_OP_FEAT_DEV_HAS_DECK_CONTROL		0x10
721 #define CEC_OP_FEAT_DEV_HAS_SET_AUDIO_RATE		0x08
722 #define CEC_OP_FEAT_DEV_SINK_HAS_ARC_TX			0x04
723 #define CEC_OP_FEAT_DEV_SOURCE_HAS_ARC_RX		0x02
724 
725 #define CEC_MSG_GIVE_FEATURES				0xa5	/* HDMI 2.0 */
726 
727 
728 /* Deck Control Feature */
729 #define CEC_MSG_DECK_CONTROL				0x42
730 /* Deck Control Mode Operand (deck_control_mode) */
731 #define CEC_OP_DECK_CTL_MODE_SKIP_FWD			1
732 #define CEC_OP_DECK_CTL_MODE_SKIP_REV			2
733 #define CEC_OP_DECK_CTL_MODE_STOP			3
734 #define CEC_OP_DECK_CTL_MODE_EJECT			4
735 
736 #define CEC_MSG_DECK_STATUS				0x1b
737 /* Deck Info Operand (deck_info) */
738 #define CEC_OP_DECK_INFO_PLAY				0x11
739 #define CEC_OP_DECK_INFO_RECORD				0x12
740 #define CEC_OP_DECK_INFO_PLAY_REV			0x13
741 #define CEC_OP_DECK_INFO_STILL				0x14
742 #define CEC_OP_DECK_INFO_SLOW				0x15
743 #define CEC_OP_DECK_INFO_SLOW_REV			0x16
744 #define CEC_OP_DECK_INFO_FAST_FWD			0x17
745 #define CEC_OP_DECK_INFO_FAST_REV			0x18
746 #define CEC_OP_DECK_INFO_NO_MEDIA			0x19
747 #define CEC_OP_DECK_INFO_STOP				0x1a
748 #define CEC_OP_DECK_INFO_SKIP_FWD			0x1b
749 #define CEC_OP_DECK_INFO_SKIP_REV			0x1c
750 #define CEC_OP_DECK_INFO_INDEX_SEARCH_FWD		0x1d
751 #define CEC_OP_DECK_INFO_INDEX_SEARCH_REV		0x1e
752 #define CEC_OP_DECK_INFO_OTHER				0x1f
753 
754 #define CEC_MSG_GIVE_DECK_STATUS			0x1a
755 /* Status Request Operand (status_req) */
756 #define CEC_OP_STATUS_REQ_ON				1
757 #define CEC_OP_STATUS_REQ_OFF				2
758 #define CEC_OP_STATUS_REQ_ONCE				3
759 
760 #define CEC_MSG_PLAY					0x41
761 /* Play Mode Operand (play_mode) */
762 #define CEC_OP_PLAY_MODE_PLAY_FWD			0x24
763 #define CEC_OP_PLAY_MODE_PLAY_REV			0x20
764 #define CEC_OP_PLAY_MODE_PLAY_STILL			0x25
765 #define CEC_OP_PLAY_MODE_PLAY_FAST_FWD_MIN		0x05
766 #define CEC_OP_PLAY_MODE_PLAY_FAST_FWD_MED		0x06
767 #define CEC_OP_PLAY_MODE_PLAY_FAST_FWD_MAX		0x07
768 #define CEC_OP_PLAY_MODE_PLAY_FAST_REV_MIN		0x09
769 #define CEC_OP_PLAY_MODE_PLAY_FAST_REV_MED		0x0a
770 #define CEC_OP_PLAY_MODE_PLAY_FAST_REV_MAX		0x0b
771 #define CEC_OP_PLAY_MODE_PLAY_SLOW_FWD_MIN		0x15
772 #define CEC_OP_PLAY_MODE_PLAY_SLOW_FWD_MED		0x16
773 #define CEC_OP_PLAY_MODE_PLAY_SLOW_FWD_MAX		0x17
774 #define CEC_OP_PLAY_MODE_PLAY_SLOW_REV_MIN		0x19
775 #define CEC_OP_PLAY_MODE_PLAY_SLOW_REV_MED		0x1a
776 #define CEC_OP_PLAY_MODE_PLAY_SLOW_REV_MAX		0x1b
777 
778 
779 /* Tuner Control Feature */
780 #define CEC_MSG_GIVE_TUNER_DEVICE_STATUS		0x08
781 #define CEC_MSG_SELECT_ANALOGUE_SERVICE			0x92
782 #define CEC_MSG_SELECT_DIGITAL_SERVICE			0x93
783 #define CEC_MSG_TUNER_DEVICE_STATUS			0x07
784 /* Recording Flag Operand (rec_flag) */
785 #define CEC_OP_REC_FLAG_USED				0
786 #define CEC_OP_REC_FLAG_NOT_USED			1
787 /* Tuner Display Info Operand (tuner_display_info) */
788 #define CEC_OP_TUNER_DISPLAY_INFO_DIGITAL		0
789 #define CEC_OP_TUNER_DISPLAY_INFO_NONE			1
790 #define CEC_OP_TUNER_DISPLAY_INFO_ANALOGUE		2
791 
792 #define CEC_MSG_TUNER_STEP_DECREMENT			0x06
793 #define CEC_MSG_TUNER_STEP_INCREMENT			0x05
794 
795 
796 /* Vendor Specific Commands Feature */
797 
798 /*
799  * Has also:
800  *	CEC_MSG_CEC_VERSION
801  *	CEC_MSG_GET_CEC_VERSION
802  */
803 #define CEC_MSG_DEVICE_VENDOR_ID			0x87
804 #define CEC_MSG_GIVE_DEVICE_VENDOR_ID			0x8c
805 #define CEC_MSG_VENDOR_COMMAND				0x89
806 #define CEC_MSG_VENDOR_COMMAND_WITH_ID			0xa0
807 #define CEC_MSG_VENDOR_REMOTE_BUTTON_DOWN		0x8a
808 #define CEC_MSG_VENDOR_REMOTE_BUTTON_UP			0x8b
809 
810 
811 /* OSD Display Feature */
812 #define CEC_MSG_SET_OSD_STRING				0x64
813 /* Display Control Operand (disp_ctl) */
814 #define CEC_OP_DISP_CTL_DEFAULT				0x00
815 #define CEC_OP_DISP_CTL_UNTIL_CLEARED			0x40
816 #define CEC_OP_DISP_CTL_CLEAR				0x80
817 
818 
819 /* Device OSD Transfer Feature */
820 #define CEC_MSG_GIVE_OSD_NAME				0x46
821 #define CEC_MSG_SET_OSD_NAME				0x47
822 
823 
824 /* Device Menu Control Feature */
825 #define CEC_MSG_MENU_REQUEST				0x8d
826 /* Menu Request Type Operand (menu_req) */
827 #define CEC_OP_MENU_REQUEST_ACTIVATE			0x00
828 #define CEC_OP_MENU_REQUEST_DEACTIVATE			0x01
829 #define CEC_OP_MENU_REQUEST_QUERY			0x02
830 
831 #define CEC_MSG_MENU_STATUS				0x8e
832 /* Menu State Operand (menu_state) */
833 #define CEC_OP_MENU_STATE_ACTIVATED			0x00
834 #define CEC_OP_MENU_STATE_DEACTIVATED			0x01
835 
836 #define CEC_MSG_USER_CONTROL_PRESSED			0x44
837 /* UI Broadcast Type Operand (ui_bcast_type) */
838 #define CEC_OP_UI_BCAST_TYPE_TOGGLE_ALL			0x00
839 #define CEC_OP_UI_BCAST_TYPE_TOGGLE_DIG_ANA		0x01
840 #define CEC_OP_UI_BCAST_TYPE_ANALOGUE			0x10
841 #define CEC_OP_UI_BCAST_TYPE_ANALOGUE_T			0x20
842 #define CEC_OP_UI_BCAST_TYPE_ANALOGUE_CABLE		0x30
843 #define CEC_OP_UI_BCAST_TYPE_ANALOGUE_SAT		0x40
844 #define CEC_OP_UI_BCAST_TYPE_DIGITAL			0x50
845 #define CEC_OP_UI_BCAST_TYPE_DIGITAL_T			0x60
846 #define CEC_OP_UI_BCAST_TYPE_DIGITAL_CABLE		0x70
847 #define CEC_OP_UI_BCAST_TYPE_DIGITAL_SAT		0x80
848 #define CEC_OP_UI_BCAST_TYPE_DIGITAL_COM_SAT		0x90
849 #define CEC_OP_UI_BCAST_TYPE_DIGITAL_COM_SAT2		0x91
850 #define CEC_OP_UI_BCAST_TYPE_IP				0xa0
851 /* UI Sound Presentation Control Operand (ui_snd_pres_ctl) */
852 #define CEC_OP_UI_SND_PRES_CTL_DUAL_MONO		0x10
853 #define CEC_OP_UI_SND_PRES_CTL_KARAOKE			0x20
854 #define CEC_OP_UI_SND_PRES_CTL_DOWNMIX			0x80
855 #define CEC_OP_UI_SND_PRES_CTL_REVERB			0x90
856 #define CEC_OP_UI_SND_PRES_CTL_EQUALIZER		0xa0
857 #define CEC_OP_UI_SND_PRES_CTL_BASS_UP			0xb1
858 #define CEC_OP_UI_SND_PRES_CTL_BASS_NEUTRAL		0xb2
859 #define CEC_OP_UI_SND_PRES_CTL_BASS_DOWN		0xb3
860 #define CEC_OP_UI_SND_PRES_CTL_TREBLE_UP		0xc1
861 #define CEC_OP_UI_SND_PRES_CTL_TREBLE_NEUTRAL		0xc2
862 #define CEC_OP_UI_SND_PRES_CTL_TREBLE_DOWN		0xc3
863 
864 #define CEC_MSG_USER_CONTROL_RELEASED			0x45
865 
866 
867 /* Remote Control Passthrough Feature */
868 
869 /*
870  * Has also:
871  *	CEC_MSG_USER_CONTROL_PRESSED
872  *	CEC_MSG_USER_CONTROL_RELEASED
873  */
874 
875 
876 /* Power Status Feature */
877 #define CEC_MSG_GIVE_DEVICE_POWER_STATUS		0x8f
878 #define CEC_MSG_REPORT_POWER_STATUS			0x90
879 /* Power Status Operand (pwr_state) */
880 #define CEC_OP_POWER_STATUS_ON				0
881 #define CEC_OP_POWER_STATUS_STANDBY			1
882 #define CEC_OP_POWER_STATUS_TO_ON			2
883 #define CEC_OP_POWER_STATUS_TO_STANDBY			3
884 
885 
886 /* General Protocol Messages */
887 #define CEC_MSG_FEATURE_ABORT				0x00
888 /* Abort Reason Operand (reason) */
889 #define CEC_OP_ABORT_UNRECOGNIZED_OP			0
890 #define CEC_OP_ABORT_INCORRECT_MODE			1
891 #define CEC_OP_ABORT_NO_SOURCE				2
892 #define CEC_OP_ABORT_INVALID_OP				3
893 #define CEC_OP_ABORT_REFUSED				4
894 #define CEC_OP_ABORT_UNDETERMINED			5
895 
896 #define CEC_MSG_ABORT					0xff
897 
898 
899 /* System Audio Control Feature */
900 
901 /*
902  * Has also:
903  *	CEC_MSG_USER_CONTROL_PRESSED
904  *	CEC_MSG_USER_CONTROL_RELEASED
905  */
906 #define CEC_MSG_GIVE_AUDIO_STATUS			0x71
907 #define CEC_MSG_GIVE_SYSTEM_AUDIO_MODE_STATUS		0x7d
908 #define CEC_MSG_REPORT_AUDIO_STATUS			0x7a
909 /* Audio Mute Status Operand (aud_mute_status) */
910 #define CEC_OP_AUD_MUTE_STATUS_OFF			0
911 #define CEC_OP_AUD_MUTE_STATUS_ON			1
912 
913 #define CEC_MSG_REPORT_SHORT_AUDIO_DESCRIPTOR		0xa3
914 #define CEC_MSG_REQUEST_SHORT_AUDIO_DESCRIPTOR		0xa4
915 #define CEC_MSG_SET_SYSTEM_AUDIO_MODE			0x72
916 /* System Audio Status Operand (sys_aud_status) */
917 #define CEC_OP_SYS_AUD_STATUS_OFF			0
918 #define CEC_OP_SYS_AUD_STATUS_ON			1
919 
920 #define CEC_MSG_SYSTEM_AUDIO_MODE_REQUEST		0x70
921 #define CEC_MSG_SYSTEM_AUDIO_MODE_STATUS		0x7e
922 /* Audio Format ID Operand (audio_format_id) */
923 #define CEC_OP_AUD_FMT_ID_CEA861			0
924 #define CEC_OP_AUD_FMT_ID_CEA861_CXT			1
925 
926 
927 /* Audio Rate Control Feature */
928 #define CEC_MSG_SET_AUDIO_RATE				0x9a
929 /* Audio Rate Operand (audio_rate) */
930 #define CEC_OP_AUD_RATE_OFF				0
931 #define CEC_OP_AUD_RATE_WIDE_STD			1
932 #define CEC_OP_AUD_RATE_WIDE_FAST			2
933 #define CEC_OP_AUD_RATE_WIDE_SLOW			3
934 #define CEC_OP_AUD_RATE_NARROW_STD			4
935 #define CEC_OP_AUD_RATE_NARROW_FAST			5
936 #define CEC_OP_AUD_RATE_NARROW_SLOW			6
937 
938 
939 /* Audio Return Channel Control Feature */
940 #define CEC_MSG_INITIATE_ARC				0xc0
941 #define CEC_MSG_REPORT_ARC_INITIATED			0xc1
942 #define CEC_MSG_REPORT_ARC_TERMINATED			0xc2
943 #define CEC_MSG_REQUEST_ARC_INITIATION			0xc3
944 #define CEC_MSG_REQUEST_ARC_TERMINATION			0xc4
945 #define CEC_MSG_TERMINATE_ARC				0xc5
946 
947 
948 /* Dynamic Audio Lipsync Feature */
949 /* Only for CEC 2.0 and up */
950 #define CEC_MSG_REQUEST_CURRENT_LATENCY			0xa7
951 #define CEC_MSG_REPORT_CURRENT_LATENCY			0xa8
952 /* Low Latency Mode Operand (low_latency_mode) */
953 #define CEC_OP_LOW_LATENCY_MODE_OFF			0
954 #define CEC_OP_LOW_LATENCY_MODE_ON			1
955 /* Audio Output Compensated Operand (audio_out_compensated) */
956 #define CEC_OP_AUD_OUT_COMPENSATED_NA			0
957 #define CEC_OP_AUD_OUT_COMPENSATED_DELAY		1
958 #define CEC_OP_AUD_OUT_COMPENSATED_NO_DELAY		2
959 #define CEC_OP_AUD_OUT_COMPENSATED_PARTIAL_DELAY	3
960 
961 
962 /* Capability Discovery and Control Feature */
963 #define CEC_MSG_CDC_MESSAGE				0xf8
964 /* Ethernet-over-HDMI: nobody ever does this... */
965 #define CEC_MSG_CDC_HEC_INQUIRE_STATE			0x00
966 #define CEC_MSG_CDC_HEC_REPORT_STATE			0x01
967 /* HEC Functionality State Operand (hec_func_state) */
968 #define CEC_OP_HEC_FUNC_STATE_NOT_SUPPORTED		0
969 #define CEC_OP_HEC_FUNC_STATE_INACTIVE			1
970 #define CEC_OP_HEC_FUNC_STATE_ACTIVE			2
971 #define CEC_OP_HEC_FUNC_STATE_ACTIVATION_FIELD		3
972 /* Host Functionality State Operand (host_func_state) */
973 #define CEC_OP_HOST_FUNC_STATE_NOT_SUPPORTED		0
974 #define CEC_OP_HOST_FUNC_STATE_INACTIVE			1
975 #define CEC_OP_HOST_FUNC_STATE_ACTIVE			2
976 /* ENC Functionality State Operand (enc_func_state) */
977 #define CEC_OP_ENC_FUNC_STATE_EXT_CON_NOT_SUPPORTED	0
978 #define CEC_OP_ENC_FUNC_STATE_EXT_CON_INACTIVE		1
979 #define CEC_OP_ENC_FUNC_STATE_EXT_CON_ACTIVE		2
980 /* CDC Error Code Operand (cdc_errcode) */
981 #define CEC_OP_CDC_ERROR_CODE_NONE			0
982 #define CEC_OP_CDC_ERROR_CODE_CAP_UNSUPPORTED		1
983 #define CEC_OP_CDC_ERROR_CODE_WRONG_STATE		2
984 #define CEC_OP_CDC_ERROR_CODE_OTHER			3
985 /* HEC Support Operand (hec_support) */
986 #define CEC_OP_HEC_SUPPORT_NO				0
987 #define CEC_OP_HEC_SUPPORT_YES				1
988 /* HEC Activation Operand (hec_activation) */
989 #define CEC_OP_HEC_ACTIVATION_ON			0
990 #define CEC_OP_HEC_ACTIVATION_OFF			1
991 
992 #define CEC_MSG_CDC_HEC_SET_STATE_ADJACENT		0x02
993 #define CEC_MSG_CDC_HEC_SET_STATE			0x03
994 /* HEC Set State Operand (hec_set_state) */
995 #define CEC_OP_HEC_SET_STATE_DEACTIVATE			0
996 #define CEC_OP_HEC_SET_STATE_ACTIVATE			1
997 
998 #define CEC_MSG_CDC_HEC_REQUEST_DEACTIVATION		0x04
999 #define CEC_MSG_CDC_HEC_NOTIFY_ALIVE			0x05
1000 #define CEC_MSG_CDC_HEC_DISCOVER			0x06
1001 /* Hotplug Detect messages */
1002 #define CEC_MSG_CDC_HPD_SET_STATE			0x10
1003 /* HPD State Operand (hpd_state) */
1004 #define CEC_OP_HPD_STATE_CP_EDID_DISABLE		0
1005 #define CEC_OP_HPD_STATE_CP_EDID_ENABLE			1
1006 #define CEC_OP_HPD_STATE_CP_EDID_DISABLE_ENABLE		2
1007 #define CEC_OP_HPD_STATE_EDID_DISABLE			3
1008 #define CEC_OP_HPD_STATE_EDID_ENABLE			4
1009 #define CEC_OP_HPD_STATE_EDID_DISABLE_ENABLE		5
1010 #define CEC_MSG_CDC_HPD_REPORT_STATE			0x11
1011 /* HPD Error Code Operand (hpd_error) */
1012 #define CEC_OP_HPD_ERROR_NONE				0
1013 #define CEC_OP_HPD_ERROR_INITIATOR_NOT_CAPABLE		1
1014 #define CEC_OP_HPD_ERROR_INITIATOR_WRONG_STATE		2
1015 #define CEC_OP_HPD_ERROR_OTHER				3
1016 #define CEC_OP_HPD_ERROR_NONE_NO_VIDEO			4
1017 
1018 /* End of Messages */
1019 
1020 /* Helper functions to identify the 'special' CEC devices */
1021 
1022 static inline int cec_is_2nd_tv(const struct cec_log_addrs *las)
1023 {
1024 	/*
1025 	 * It is a second TV if the logical address is 14 or 15 and the
1026 	 * primary device type is a TV.
1027 	 */
1028 	return las->num_log_addrs &&
1029 	       las->log_addr[0] >= CEC_LOG_ADDR_SPECIFIC &&
1030 	       las->primary_device_type[0] == CEC_OP_PRIM_DEVTYPE_TV;
1031 }
1032 
1033 static inline int cec_is_processor(const struct cec_log_addrs *las)
1034 {
1035 	/*
1036 	 * It is a processor if the logical address is 12-15 and the
1037 	 * primary device type is a Processor.
1038 	 */
1039 	return las->num_log_addrs &&
1040 	       las->log_addr[0] >= CEC_LOG_ADDR_BACKUP_1 &&
1041 	       las->primary_device_type[0] == CEC_OP_PRIM_DEVTYPE_PROCESSOR;
1042 }
1043 
1044 static inline int cec_is_switch(const struct cec_log_addrs *las)
1045 {
1046 	/*
1047 	 * It is a switch if the logical address is 15 and the
1048 	 * primary device type is a Switch and the CDC-Only flag is not set.
1049 	 */
1050 	return las->num_log_addrs == 1 &&
1051 	       las->log_addr[0] == CEC_LOG_ADDR_UNREGISTERED &&
1052 	       las->primary_device_type[0] == CEC_OP_PRIM_DEVTYPE_SWITCH &&
1053 	       !(las->flags & CEC_LOG_ADDRS_FL_CDC_ONLY);
1054 }
1055 
1056 static inline int cec_is_cdc_only(const struct cec_log_addrs *las)
1057 {
1058 	/*
1059 	 * It is a CDC-only device if the logical address is 15 and the
1060 	 * primary device type is a Switch and the CDC-Only flag is set.
1061 	 */
1062 	return las->num_log_addrs == 1 &&
1063 	       las->log_addr[0] == CEC_LOG_ADDR_UNREGISTERED &&
1064 	       las->primary_device_type[0] == CEC_OP_PRIM_DEVTYPE_SWITCH &&
1065 	       (las->flags & CEC_LOG_ADDRS_FL_CDC_ONLY);
1066 }
1067 
1068 #endif
1069