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