blob: 0e0664f594a09168edc9fda8f40d68f2c662d127 [file] [log] [blame]
/*
* Copyright (C) 2014 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.android.server.hdmi;
/**
* Defines constants related to HDMI-CEC protocol internal implementation.
* If a constant will be used in the public api, it should be located in
* {@link android.hardware.hdmi.HdmiCec}.
*/
final class Constants {
/** Logical address for TV */
public static final int ADDR_TV = 0;
/** Logical address for recorder 1 */
public static final int ADDR_RECORDER_1 = 1;
/** Logical address for recorder 2 */
public static final int ADDR_RECORDER_2 = 2;
/** Logical address for tuner 1 */
public static final int ADDR_TUNER_1 = 3;
/** Logical address for playback 1 */
public static final int ADDR_PLAYBACK_1 = 4;
/** Logical address for audio system */
public static final int ADDR_AUDIO_SYSTEM = 5;
/** Logical address for tuner 2 */
public static final int ADDR_TUNER_2 = 6;
/** Logical address for tuner 3 */
public static final int ADDR_TUNER_3 = 7;
/** Logical address for playback 2 */
public static final int ADDR_PLAYBACK_2 = 8;
/** Logical address for recorder 3 */
public static final int ADDR_RECORDER_3 = 9;
/** Logical address for tuner 4 */
public static final int ADDR_TUNER_4 = 10;
/** Logical address for playback 3 */
public static final int ADDR_PLAYBACK_3 = 11;
/** Logical address reserved for future usage */
public static final int ADDR_RESERVED_1 = 12;
/** Logical address reserved for future usage */
public static final int ADDR_RESERVED_2 = 13;
/** Logical address for TV other than the one assigned with {@link #ADDR_TV} */
public static final int ADDR_SPECIFIC_USE = 14;
/** Logical address for devices to which address cannot be allocated */
public static final int ADDR_UNREGISTERED = 15;
/** Logical address used in the destination address field for broadcast messages */
public static final int ADDR_BROADCAST = 15;
/** Logical address used to indicate it is not initialized or invalid. */
public static final int ADDR_INVALID = -1;
/** Logical address used to indicate the source comes from internal device. */
public static final int ADDR_INTERNAL = 0xFFFF;
static final int MESSAGE_FEATURE_ABORT = 0x00;
static final int MESSAGE_IMAGE_VIEW_ON = 0x04;
static final int MESSAGE_TUNER_STEP_INCREMENT = 0x05;
static final int MESSAGE_TUNER_STEP_DECREMENT = 0x06;
static final int MESSAGE_TUNER_DEVICE_STATUS = 0x07;
static final int MESSAGE_GIVE_TUNER_DEVICE_STATUS = 0x08;
static final int MESSAGE_RECORD_ON = 0x09;
static final int MESSAGE_RECORD_STATUS = 0x0A;
static final int MESSAGE_RECORD_OFF = 0x0B;
static final int MESSAGE_TEXT_VIEW_ON = 0x0D;
static final int MESSAGE_RECORD_TV_SCREEN = 0x0F;
static final int MESSAGE_GIVE_DECK_STATUS = 0x1A;
static final int MESSAGE_DECK_STATUS = 0x1B;
static final int MESSAGE_SET_MENU_LANGUAGE = 0x32;
static final int MESSAGE_CLEAR_ANALOG_TIMER = 0x33;
static final int MESSAGE_SET_ANALOG_TIMER = 0x34;
static final int MESSAGE_TIMER_STATUS = 0x35;
static final int MESSAGE_STANDBY = 0x36;
static final int MESSAGE_PLAY = 0x41;
static final int MESSAGE_DECK_CONTROL = 0x42;
static final int MESSAGE_TIMER_CLEARED_STATUS = 0x043;
static final int MESSAGE_USER_CONTROL_PRESSED = 0x44;
static final int MESSAGE_USER_CONTROL_RELEASED = 0x45;
static final int MESSAGE_GIVE_OSD_NAME = 0x46;
static final int MESSAGE_SET_OSD_NAME = 0x47;
static final int MESSAGE_SET_OSD_STRING = 0x64;
static final int MESSAGE_SET_TIMER_PROGRAM_TITLE = 0x67;
static final int MESSAGE_SYSTEM_AUDIO_MODE_REQUEST = 0x70;
static final int MESSAGE_GIVE_AUDIO_STATUS = 0x71;
static final int MESSAGE_SET_SYSTEM_AUDIO_MODE = 0x72;
static final int MESSAGE_REPORT_AUDIO_STATUS = 0x7A;
static final int MESSAGE_GIVE_SYSTEM_AUDIO_MODE_STATUS = 0x7D;
static final int MESSAGE_SYSTEM_AUDIO_MODE_STATUS = 0x7E;
static final int MESSAGE_ROUTING_CHANGE = 0x80;
static final int MESSAGE_ROUTING_INFORMATION = 0x81;
static final int MESSAGE_ACTIVE_SOURCE = 0x82;
static final int MESSAGE_GIVE_PHYSICAL_ADDRESS = 0x83;
static final int MESSAGE_REPORT_PHYSICAL_ADDRESS = 0x84;
static final int MESSAGE_REQUEST_ACTIVE_SOURCE = 0x85;
static final int MESSAGE_SET_STREAM_PATH = 0x86;
static final int MESSAGE_DEVICE_VENDOR_ID = 0x87;
static final int MESSAGE_VENDOR_COMMAND = 0x89;
static final int MESSAGE_VENDOR_REMOTE_BUTTON_DOWN = 0x8A;
static final int MESSAGE_VENDOR_REMOTE_BUTTON_UP = 0x8B;
static final int MESSAGE_GIVE_DEVICE_VENDOR_ID = 0x8C;
static final int MESSAGE_MENU_REQUEST = 0x8D;
static final int MESSAGE_MENU_STATUS = 0x8E;
static final int MESSAGE_GIVE_DEVICE_POWER_STATUS = 0x8F;
static final int MESSAGE_REPORT_POWER_STATUS = 0x90;
static final int MESSAGE_GET_MENU_LANGUAGE = 0x91;
static final int MESSAGE_SELECT_ANALOG_SERVICE = 0x92;
static final int MESSAGE_SELECT_DIGITAL_SERVICE = 0x93;
static final int MESSAGE_SET_DIGITAL_TIMER = 0x97;
static final int MESSAGE_CLEAR_DIGITAL_TIMER = 0x99;
static final int MESSAGE_SET_AUDIO_RATE = 0x9A;
static final int MESSAGE_INACTIVE_SOURCE = 0x9D;
static final int MESSAGE_CEC_VERSION = 0x9E;
static final int MESSAGE_GET_CEC_VERSION = 0x9F;
static final int MESSAGE_VENDOR_COMMAND_WITH_ID = 0xA0;
static final int MESSAGE_CLEAR_EXTERNAL_TIMER = 0xA1;
static final int MESSAGE_SET_EXTERNAL_TIMER = 0xA2;
static final int MESSAGE_REPORT_SHORT_AUDIO_DESCRIPTOR = 0xA3;
static final int MESSAGE_REQUEST_SHORT_AUDIO_DESCRIPTOR = 0xA4;
static final int MESSAGE_INITIATE_ARC = 0xC0;
static final int MESSAGE_REPORT_ARC_INITIATED = 0xC1;
static final int MESSAGE_REPORT_ARC_TERMINATED = 0xC2;
static final int MESSAGE_REQUEST_ARC_INITIATION = 0xC3;
static final int MESSAGE_REQUEST_ARC_TERMINATION = 0xC4;
static final int MESSAGE_TERMINATE_ARC = 0xC5;
static final int MESSAGE_CDC_MESSAGE = 0xF8;
static final int MESSAGE_ABORT = 0xFF;
static final int UNKNOWN_VENDOR_ID = 0xFFFFFF;
// Constants related to operands of HDMI CEC commands.
// Refer to CEC Table 29 in HDMI Spec v1.4b.
// [Abort Reason]
static final int ABORT_UNRECOGNIZED_MODE = 0;
static final int ABORT_NOT_IN_CORRECT_MODE = 1;
static final int ABORT_CANNOT_PROVIDE_SOURCE = 2;
static final int ABORT_INVALID_OPERAND = 3;
static final int ABORT_REFUSED = 4;
static final int ABORT_UNABLE_TO_DETERMINE = 5;
// [Audio Status]
static final int SYSTEM_AUDIO_STATUS_OFF = 0;
static final int SYSTEM_AUDIO_STATUS_ON = 1;
// Bit mask used to get the routing path of the top level device.
// When &'d with the path 1.2.2.0 (0x1220), for instance, gives 1.0.0.0.
static final int ROUTING_PATH_TOP_MASK = 0xF000;
static final int ROUTING_PATH_TOP_SHIFT = 12;
static final int INVALID_PORT_ID = -1;
static final int INVALID_PHYSICAL_ADDRESS = 0xFFFF;
// Send result codes.
static final int SEND_RESULT_SUCCESS = 0;
static final int SEND_RESULT_NAK = -1;
static final int SEND_RESULT_FAILURE = -2;
// Strategy for device polling.
// Should use "OR(|) operation of POLL_STRATEGY_XXX and POLL_ITERATION_XXX.
static final int POLL_STRATEGY_MASK = 0x3; // first and second bit.
static final int POLL_STRATEGY_REMOTES_DEVICES = 0x1;
static final int POLL_STRATEGY_SYSTEM_AUDIO = 0x2;
static final int POLL_ITERATION_STRATEGY_MASK = 0x30000; // first and second bit.
static final int POLL_ITERATION_IN_ORDER = 0x10000;
static final int POLL_ITERATION_REVERSE_ORDER = 0x20000;
static final int UNKNOWN_VOLUME = -1;
// IRT(Initiator Repetition Time) in millisecond as recommended in the standard.
// Outgoing UCP commands, when in 'Press and Hold' mode, should be this much apart
// from the adjacent one so as not to place unnecessarily heavy load on the CEC line.
// TODO: This value might need tweaking per product basis. Consider putting it
// in config.xml to allow customization.
static final int IRT_MS = 300;
private Constants() { /* cannot be instantiated */ }
}