1 /* 2 * Copyright (C) 2014 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17 package com.android.server.hdmi; 18 19 import android.hardware.hdmi.HdmiDeviceInfo; 20 21 /** 22 * Defines constants related to HDMI-CEC protocol internal implementation. 23 * If a constant will be used in the public api, it should be located in 24 * {@link android.hardware.hdmi.HdmiControlManager}. 25 */ 26 final class Constants { 27 28 /** Logical address for TV */ 29 public static final int ADDR_TV = 0; 30 31 /** Logical address for recorder 1 */ 32 public static final int ADDR_RECORDER_1 = 1; 33 34 /** Logical address for recorder 2 */ 35 public static final int ADDR_RECORDER_2 = 2; 36 37 /** Logical address for tuner 1 */ 38 public static final int ADDR_TUNER_1 = 3; 39 40 /** Logical address for playback 1 */ 41 public static final int ADDR_PLAYBACK_1 = 4; 42 43 /** Logical address for audio system */ 44 public static final int ADDR_AUDIO_SYSTEM = 5; 45 46 /** Logical address for tuner 2 */ 47 public static final int ADDR_TUNER_2 = 6; 48 49 /** Logical address for tuner 3 */ 50 public static final int ADDR_TUNER_3 = 7; 51 52 /** Logical address for playback 2 */ 53 public static final int ADDR_PLAYBACK_2 = 8; 54 55 /** Logical address for recorder 3 */ 56 public static final int ADDR_RECORDER_3 = 9; 57 58 /** Logical address for tuner 4 */ 59 public static final int ADDR_TUNER_4 = 10; 60 61 /** Logical address for playback 3 */ 62 public static final int ADDR_PLAYBACK_3 = 11; 63 64 /** Logical address reserved for future usage */ 65 public static final int ADDR_RESERVED_1 = 12; 66 67 /** Logical address reserved for future usage */ 68 public static final int ADDR_RESERVED_2 = 13; 69 70 /** Logical address for TV other than the one assigned with {@link #ADDR_TV} */ 71 public static final int ADDR_SPECIFIC_USE = 14; 72 73 /** Logical address for devices to which address cannot be allocated */ 74 public static final int ADDR_UNREGISTERED = 15; 75 76 /** Logical address used in the destination address field for broadcast messages */ 77 public static final int ADDR_BROADCAST = 15; 78 79 /** Logical address used to indicate it is not initialized or invalid. */ 80 public static final int ADDR_INVALID = -1; 81 82 /** Logical address used to indicate the source comes from internal device. */ 83 public static final int ADDR_INTERNAL = HdmiDeviceInfo.ADDR_INTERNAL; 84 85 static final int MESSAGE_FEATURE_ABORT = 0x00; 86 static final int MESSAGE_IMAGE_VIEW_ON = 0x04; 87 static final int MESSAGE_TUNER_STEP_INCREMENT = 0x05; 88 static final int MESSAGE_TUNER_STEP_DECREMENT = 0x06; 89 static final int MESSAGE_TUNER_DEVICE_STATUS = 0x07; 90 static final int MESSAGE_GIVE_TUNER_DEVICE_STATUS = 0x08; 91 static final int MESSAGE_RECORD_ON = 0x09; 92 static final int MESSAGE_RECORD_STATUS = 0x0A; 93 static final int MESSAGE_RECORD_OFF = 0x0B; 94 static final int MESSAGE_TEXT_VIEW_ON = 0x0D; 95 static final int MESSAGE_RECORD_TV_SCREEN = 0x0F; 96 static final int MESSAGE_GIVE_DECK_STATUS = 0x1A; 97 static final int MESSAGE_DECK_STATUS = 0x1B; 98 static final int MESSAGE_SET_MENU_LANGUAGE = 0x32; 99 static final int MESSAGE_CLEAR_ANALOG_TIMER = 0x33; 100 static final int MESSAGE_SET_ANALOG_TIMER = 0x34; 101 static final int MESSAGE_TIMER_STATUS = 0x35; 102 static final int MESSAGE_STANDBY = 0x36; 103 static final int MESSAGE_PLAY = 0x41; 104 static final int MESSAGE_DECK_CONTROL = 0x42; 105 static final int MESSAGE_TIMER_CLEARED_STATUS = 0x043; 106 static final int MESSAGE_USER_CONTROL_PRESSED = 0x44; 107 static final int MESSAGE_USER_CONTROL_RELEASED = 0x45; 108 static final int MESSAGE_GIVE_OSD_NAME = 0x46; 109 static final int MESSAGE_SET_OSD_NAME = 0x47; 110 static final int MESSAGE_SET_OSD_STRING = 0x64; 111 static final int MESSAGE_SET_TIMER_PROGRAM_TITLE = 0x67; 112 static final int MESSAGE_SYSTEM_AUDIO_MODE_REQUEST = 0x70; 113 static final int MESSAGE_GIVE_AUDIO_STATUS = 0x71; 114 static final int MESSAGE_SET_SYSTEM_AUDIO_MODE = 0x72; 115 static final int MESSAGE_REPORT_AUDIO_STATUS = 0x7A; 116 static final int MESSAGE_GIVE_SYSTEM_AUDIO_MODE_STATUS = 0x7D; 117 static final int MESSAGE_SYSTEM_AUDIO_MODE_STATUS = 0x7E; 118 static final int MESSAGE_ROUTING_CHANGE = 0x80; 119 static final int MESSAGE_ROUTING_INFORMATION = 0x81; 120 static final int MESSAGE_ACTIVE_SOURCE = 0x82; 121 static final int MESSAGE_GIVE_PHYSICAL_ADDRESS = 0x83; 122 static final int MESSAGE_REPORT_PHYSICAL_ADDRESS = 0x84; 123 static final int MESSAGE_REQUEST_ACTIVE_SOURCE = 0x85; 124 static final int MESSAGE_SET_STREAM_PATH = 0x86; 125 static final int MESSAGE_DEVICE_VENDOR_ID = 0x87; 126 static final int MESSAGE_VENDOR_COMMAND = 0x89; 127 static final int MESSAGE_VENDOR_REMOTE_BUTTON_DOWN = 0x8A; 128 static final int MESSAGE_VENDOR_REMOTE_BUTTON_UP = 0x8B; 129 static final int MESSAGE_GIVE_DEVICE_VENDOR_ID = 0x8C; 130 static final int MESSAGE_MENU_REQUEST = 0x8D; 131 static final int MESSAGE_MENU_STATUS = 0x8E; 132 static final int MESSAGE_GIVE_DEVICE_POWER_STATUS = 0x8F; 133 static final int MESSAGE_REPORT_POWER_STATUS = 0x90; 134 static final int MESSAGE_GET_MENU_LANGUAGE = 0x91; 135 static final int MESSAGE_SELECT_ANALOG_SERVICE = 0x92; 136 static final int MESSAGE_SELECT_DIGITAL_SERVICE = 0x93; 137 static final int MESSAGE_SET_DIGITAL_TIMER = 0x97; 138 static final int MESSAGE_CLEAR_DIGITAL_TIMER = 0x99; 139 static final int MESSAGE_SET_AUDIO_RATE = 0x9A; 140 static final int MESSAGE_INACTIVE_SOURCE = 0x9D; 141 static final int MESSAGE_CEC_VERSION = 0x9E; 142 static final int MESSAGE_GET_CEC_VERSION = 0x9F; 143 static final int MESSAGE_VENDOR_COMMAND_WITH_ID = 0xA0; 144 static final int MESSAGE_CLEAR_EXTERNAL_TIMER = 0xA1; 145 static final int MESSAGE_SET_EXTERNAL_TIMER = 0xA2; 146 static final int MESSAGE_REPORT_SHORT_AUDIO_DESCRIPTOR = 0xA3; 147 static final int MESSAGE_REQUEST_SHORT_AUDIO_DESCRIPTOR = 0xA4; 148 static final int MESSAGE_INITIATE_ARC = 0xC0; 149 static final int MESSAGE_REPORT_ARC_INITIATED = 0xC1; 150 static final int MESSAGE_REPORT_ARC_TERMINATED = 0xC2; 151 static final int MESSAGE_REQUEST_ARC_INITIATION = 0xC3; 152 static final int MESSAGE_REQUEST_ARC_TERMINATION = 0xC4; 153 static final int MESSAGE_TERMINATE_ARC = 0xC5; 154 static final int MESSAGE_CDC_MESSAGE = 0xF8; 155 static final int MESSAGE_ABORT = 0xFF; 156 157 static final int UNKNOWN_VENDOR_ID = 0xFFFFFF; 158 159 static final int TRUE = 1; 160 static final int FALSE = 0; 161 162 // Internal abort error code. It's the same as success. 163 static final int ABORT_NO_ERROR = -1; 164 // Constants related to operands of HDMI CEC commands. 165 // Refer to CEC Table 29 in HDMI Spec v1.4b. 166 // [Abort Reason] 167 static final int ABORT_UNRECOGNIZED_OPCODE = 0; 168 static final int ABORT_NOT_IN_CORRECT_MODE = 1; 169 static final int ABORT_CANNOT_PROVIDE_SOURCE = 2; 170 static final int ABORT_INVALID_OPERAND = 3; 171 static final int ABORT_REFUSED = 4; 172 static final int ABORT_UNABLE_TO_DETERMINE = 5; 173 174 // [Audio Status] 175 static final int SYSTEM_AUDIO_STATUS_OFF = 0; 176 static final int SYSTEM_AUDIO_STATUS_ON = 1; 177 178 // [Menu State] 179 static final int MENU_STATE_ACTIVATED = 0; 180 static final int MENU_STATE_DEACTIVATED = 1; 181 182 // Bit mask used to get the routing path of the top level device. 183 // When &'d with the path 1.2.2.0 (0x1220), for instance, gives 1.0.0.0. 184 static final int ROUTING_PATH_TOP_MASK = 0xF000; 185 static final int ROUTING_PATH_TOP_SHIFT = 12; 186 187 static final int INVALID_PORT_ID = HdmiDeviceInfo.PORT_INVALID; 188 static final int INVALID_PHYSICAL_ADDRESS = HdmiDeviceInfo.PATH_INVALID; 189 190 // Send result codes. It should be consistent with hdmi_cec.h's send_message error code. 191 static final int SEND_RESULT_SUCCESS = 0; 192 static final int SEND_RESULT_NAK = 1; 193 static final int SEND_RESULT_BUSY = 2; 194 static final int SEND_RESULT_FAILURE = 3; 195 196 // Strategy for device polling. 197 // Should use "OR(|) operation of POLL_STRATEGY_XXX and POLL_ITERATION_XXX. 198 static final int POLL_STRATEGY_MASK = 0x3; // first and second bit. 199 static final int POLL_STRATEGY_REMOTES_DEVICES = 0x1; 200 static final int POLL_STRATEGY_SYSTEM_AUDIO = 0x2; 201 202 static final int POLL_ITERATION_STRATEGY_MASK = 0x30000; // first and second bit. 203 static final int POLL_ITERATION_IN_ORDER = 0x10000; 204 static final int POLL_ITERATION_REVERSE_ORDER = 0x20000; 205 206 static final int UNKNOWN_VOLUME = -1; 207 208 // IRT(Initiator Repetition Time) in millisecond as recommended in the standard. 209 // Outgoing UCP commands, when in 'Press and Hold' mode, should be this much apart 210 // from the adjacent one so as not to place unnecessarily heavy load on the CEC line. 211 // TODO: This value might need tweaking per product basis. Consider putting it 212 // in config.xml to allow customization. 213 static final int IRT_MS = 300; 214 215 static final String PROPERTY_PREFERRED_ADDRESS_PLAYBACK = "persist.sys.hdmi.addr.playback"; 216 static final String PROPERTY_PREFERRED_ADDRESS_TV = "persist.sys.hdmi.addr.tv"; 217 218 // Property name for the local device configurations. 219 // TODO(OEM): OEM should provide this property, and the value is the comma separated integer 220 // values which denotes the device type in HDMI Spec 1.4. 221 static final String PROPERTY_DEVICE_TYPE = "ro.hdmi.device_type"; 222 223 static final int RECORDING_TYPE_DIGITAL_RF = 1; 224 static final int RECORDING_TYPE_ANALOGUE_RF = 2; 225 static final int RECORDING_TYPE_EXTERNAL_PHYSICAL_ADDRESS = 3; 226 static final int RECORDING_TYPE_OWN_SOURCE = 4; 227 228 // Definitions used for setOption(). These should be in sync with the definition 229 // in hardware/libhardware/include/hardware/{hdmi_cec.h,mhl.h}. 230 231 // TV gets turned on by incoming <Text/Image View On>. enabled by default. 232 // If set to disabled, TV won't turn on automatically. 233 static final int OPTION_CEC_AUTO_WAKEUP = 1; 234 235 // If set to disabled, all CEC commands are discarded. 236 static final int OPTION_CEC_ENABLE = 2; 237 238 // If set to disabled, system service yields control of CEC to sub-microcontroller. 239 // If enabled, it take the control back. 240 static final int OPTION_CEC_SERVICE_CONTROL = 3; 241 242 // Put other devices to standby when TV goes to standby. enabled by default. 243 // If set to disabled, TV doesn't send <Standby> to other devices. 244 static final int OPTION_CEC_AUTO_DEVICE_OFF = 4; 245 246 // If set to disabled, TV does not switch ports when mobile device is connected. 247 static final int OPTION_MHL_INPUT_SWITCHING = 101; 248 249 // If set to enabled, TV disables power charging for mobile device. 250 static final int OPTION_MHL_POWER_CHARGE = 102; 251 252 // If set to disabled, all MHL commands are discarded. 253 static final int OPTION_MHL_ENABLE = 103; 254 255 static final int DISABLED = 0; 256 static final int ENABLED = 1; 257 258 private Constants() { /* cannot be instantiated */ } 259 } 260
