include/uapi/linux/cec.h

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