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