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