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