include/linux/cec.h

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