summaryrefslogtreecommitdiffstats
path: root/tv
diff options
context:
space:
mode:
authorAndreas Huber2017-03-28 18:19:16 -0500
committerAndreas Huber2017-03-29 10:53:58 -0500
commit40d3a9bd8c62714ee58f9363c4456f764aa5a95d (patch)
treeda47e5b4448e44385919af0effbd49a5d1b415e8 /tv
parent2f44ec6c868b220be1b566e7ccfbb251beec70ec (diff)
downloadplatform-hardware-interfaces-40d3a9bd8c62714ee58f9363c4456f764aa5a95d.tar.gz
platform-hardware-interfaces-40d3a9bd8c62714ee58f9363c4456f764aa5a95d.tar.xz
platform-hardware-interfaces-40d3a9bd8c62714ee58f9363c4456f764aa5a95d.zip
Convert all comments into "doxygen-ready" comments.
Bug: 36453077 Test: mma Change-Id: I0b1f77dfae5d2258969e33d85ecf45401ffbdfaa
Diffstat (limited to 'tv')
-rw-r--r--tv/cec/1.0/IHdmiCec.hal26
-rw-r--r--tv/cec/1.0/IHdmiCecCallback.hal4
-rw-r--r--tv/cec/1.0/types.hal30
-rw-r--r--tv/input/1.0/ITvInput.hal8
-rw-r--r--tv/input/1.0/ITvInputCallback.hal2
-rw-r--r--tv/input/1.0/types.hal12
6 files changed, 43 insertions, 39 deletions
diff --git a/tv/cec/1.0/IHdmiCec.hal b/tv/cec/1.0/IHdmiCec.hal
index e8db265d..28404171 100644
--- a/tv/cec/1.0/IHdmiCec.hal
+++ b/tv/cec/1.0/IHdmiCec.hal
@@ -18,11 +18,11 @@ package android.hardware.tv.cec@1.0;
18 18
19import IHdmiCecCallback; 19import IHdmiCecCallback;
20 20
21/* 21/**
22 * HDMI-CEC HAL interface definition. 22 * HDMI-CEC HAL interface definition.
23 */ 23 */
24interface IHdmiCec { 24interface IHdmiCec {
25 /* 25 /**
26 * Passes the logical address that must be used in this system. 26 * Passes the logical address that must be used in this system.
27 * 27 *
28 * HAL must use it to configure the hardware so that the CEC commands 28 * HAL must use it to configure the hardware so that the CEC commands
@@ -39,7 +39,7 @@ interface IHdmiCec {
39 @callflow(next={"*"}) 39 @callflow(next={"*"})
40 addLogicalAddress(CecLogicalAddress addr) generates (Result result); 40 addLogicalAddress(CecLogicalAddress addr) generates (Result result);
41 41
42 /* 42 /**
43 * Clears all the logical addresses. 43 * Clears all the logical addresses.
44 * 44 *
45 * It is used when the system doesn't need to process CEC command any more, 45 * It is used when the system doesn't need to process CEC command any more,
@@ -50,7 +50,7 @@ interface IHdmiCec {
50 @exit 50 @exit
51 clearLogicalAddress(); 51 clearLogicalAddress();
52 52
53 /* 53 /**
54 * Gets the CEC physical address. 54 * Gets the CEC physical address.
55 * 55 *
56 * The physical address depends on the topology of the network formed by 56 * The physical address depends on the topology of the network formed by
@@ -66,7 +66,7 @@ interface IHdmiCec {
66 @callflow(next="*") 66 @callflow(next="*")
67 getPhysicalAddress() generates (Result result, uint16_t addr); 67 getPhysicalAddress() generates (Result result, uint16_t addr);
68 68
69 /* 69 /**
70 * Transmits HDMI-CEC message to other HDMI device. 70 * Transmits HDMI-CEC message to other HDMI device.
71 * 71 *
72 * The method must be designed to return in a certain amount of time and not 72 * The method must be designed to return in a certain amount of time and not
@@ -84,7 +84,7 @@ interface IHdmiCec {
84 @callflow(next="*") 84 @callflow(next="*")
85 sendMessage(CecMessage message) generates (SendMessageResult result); 85 sendMessage(CecMessage message) generates (SendMessageResult result);
86 86
87 /* 87 /**
88 * Sets a callback that HDMI-CEC HAL must later use for incoming CEC 88 * Sets a callback that HDMI-CEC HAL must later use for incoming CEC
89 * messages or internal HDMI events. 89 * messages or internal HDMI events.
90 * 90 *
@@ -95,7 +95,7 @@ interface IHdmiCec {
95 @entry 95 @entry
96 setCallback(IHdmiCecCallback callback); 96 setCallback(IHdmiCecCallback callback);
97 97
98 /* 98 /**
99 * Returns the CEC version supported by underlying hardware. 99 * Returns the CEC version supported by underlying hardware.
100 * 100 *
101 * @return version the CEC version supported by underlying hardware. 101 * @return version the CEC version supported by underlying hardware.
@@ -103,7 +103,7 @@ interface IHdmiCec {
103 @callflow(next={"*"}) 103 @callflow(next={"*"})
104 getCecVersion() generates (int32_t version); 104 getCecVersion() generates (int32_t version);
105 105
106 /* 106 /**
107 * Gets the identifier of the vendor. 107 * Gets the identifier of the vendor.
108 * 108 *
109 * @return vendorId Identifier of the vendor that is the 24-bit unique 109 * @return vendorId Identifier of the vendor that is the 24-bit unique
@@ -113,7 +113,7 @@ interface IHdmiCec {
113 @callflow(next={"*"}) 113 @callflow(next={"*"})
114 getVendorId() generates (uint32_t vendorId); 114 getVendorId() generates (uint32_t vendorId);
115 115
116 /* 116 /**
117 * Gets the hdmi port information of underlying hardware. 117 * Gets the hdmi port information of underlying hardware.
118 * 118 *
119 * @return infos The list of HDMI port information 119 * @return infos The list of HDMI port information
@@ -121,7 +121,7 @@ interface IHdmiCec {
121 @callflow(next={"*"}) 121 @callflow(next={"*"})
122 getPortInfo() generates (vec<HdmiPortInfo> infos); 122 getPortInfo() generates (vec<HdmiPortInfo> infos);
123 123
124 /* 124 /**
125 * Sets flags controlling the way HDMI-CEC service works down to HAL 125 * Sets flags controlling the way HDMI-CEC service works down to HAL
126 * implementation. Those flags must be used in case the feature needs update 126 * implementation. Those flags must be used in case the feature needs update
127 * in HAL itself, firmware or microcontroller. 127 * in HAL itself, firmware or microcontroller.
@@ -132,7 +132,7 @@ interface IHdmiCec {
132 @callflow(next="*") 132 @callflow(next="*")
133 setOption(OptionKey key, bool value); 133 setOption(OptionKey key, bool value);
134 134
135 /* 135 /**
136 * Passes the updated language information of Android system. Contains 136 * Passes the updated language information of Android system. Contains
137 * three-letter code as defined in ISO/FDIS 639-2. Must be used for HAL to 137 * three-letter code as defined in ISO/FDIS 639-2. Must be used for HAL to
138 * respond to <Get Menu Language> while in standby mode. 138 * respond to <Get Menu Language> while in standby mode.
@@ -143,7 +143,7 @@ interface IHdmiCec {
143 @callflow(next="*") 143 @callflow(next="*")
144 setLanguage(string language); 144 setLanguage(string language);
145 145
146 /* 146 /**
147 * Configures ARC circuit in the hardware logic to start or stop the 147 * Configures ARC circuit in the hardware logic to start or stop the
148 * feature. 148 * feature.
149 * 149 *
@@ -154,7 +154,7 @@ interface IHdmiCec {
154 @callflow(next="*") 154 @callflow(next="*")
155 enableAudioReturnChannel(int32_t portId, bool enable); 155 enableAudioReturnChannel(int32_t portId, bool enable);
156 156
157 /* 157 /**
158 * Gets the connection status of the specified port. 158 * Gets the connection status of the specified port.
159 * 159 *
160 * @param portId Port id to be inspected for the connection status. 160 * @param portId Port id to be inspected for the connection status.
diff --git a/tv/cec/1.0/IHdmiCecCallback.hal b/tv/cec/1.0/IHdmiCecCallback.hal
index 4a9d28f2..754d19f9 100644
--- a/tv/cec/1.0/IHdmiCecCallback.hal
+++ b/tv/cec/1.0/IHdmiCecCallback.hal
@@ -17,13 +17,13 @@
17package android.hardware.tv.cec@1.0; 17package android.hardware.tv.cec@1.0;
18 18
19interface IHdmiCecCallback { 19interface IHdmiCecCallback {
20 /* 20 /**
21 * The callback function that must be called by HAL implementation to notify 21 * The callback function that must be called by HAL implementation to notify
22 * the system of new CEC message arrival. 22 * the system of new CEC message arrival.
23 */ 23 */
24 oneway onCecMessage(CecMessage message); 24 oneway onCecMessage(CecMessage message);
25 25
26 /* 26 /**
27 * The callback function that must be called by HAL implementation to notify 27 * The callback function that must be called by HAL implementation to notify
28 * the system of new hotplug event. 28 * the system of new hotplug event.
29 */ 29 */
diff --git a/tv/cec/1.0/types.hal b/tv/cec/1.0/types.hal
index ec2e3732..a1853a31 100644
--- a/tv/cec/1.0/types.hal
+++ b/tv/cec/1.0/types.hal
@@ -48,7 +48,7 @@ enum CecLogicalAddress : int32_t {
48 BROADCAST = 15, // as Destination address 48 BROADCAST = 15, // as Destination address
49}; 49};
50 50
51/* 51/**
52 * HDMI CEC message types. The assigned values represent opcode used in CEC 52 * HDMI CEC message types. The assigned values represent opcode used in CEC
53 * frame as specified in CEC Table 8-26 of the CEC Spec 1.4b. 53 * frame as specified in CEC Table 8-26 of the CEC Spec 1.4b.
54 */ 54 */
@@ -123,7 +123,7 @@ enum CecMessageType : int32_t {
123 ABORT = 0xFF, 123 ABORT = 0xFF,
124}; 124};
125 125
126/* 126/**
127 * Operand description [Abort Reason] 127 * Operand description [Abort Reason]
128 */ 128 */
129enum AbortReason : int32_t { 129enum AbortReason : int32_t {
@@ -144,7 +144,7 @@ enum Result : int32_t {
144 FAILURE_BUSY = 5, 144 FAILURE_BUSY = 5,
145}; 145};
146 146
147/* 147/**
148 * error code used for send_message. 148 * error code used for send_message.
149 */ 149 */
150enum SendMessageResult : int32_t { 150enum SendMessageResult : int32_t {
@@ -154,7 +154,7 @@ enum SendMessageResult : int32_t {
154 FAIL = 3, 154 FAIL = 3,
155}; 155};
156 156
157/* 157/**
158 * HDMI port type. 158 * HDMI port type.
159 */ 159 */
160enum HdmiPortType : int32_t { 160enum HdmiPortType : int32_t {
@@ -162,24 +162,27 @@ enum HdmiPortType : int32_t {
162 OUTPUT = 1, 162 OUTPUT = 1,
163}; 163};
164 164
165/* 165/**
166 * Options used for IHdmiCec.setOption() 166 * Options used for IHdmiCec.setOption()
167 */ 167 */
168enum OptionKey : int32_t { 168enum OptionKey : int32_t {
169 /* When set to false, HAL does not wake up the system upon receiving <Image 169 /**
170 * When set to false, HAL does not wake up the system upon receiving <Image
170 * View On> or <Text View On>. Used when user changes the TV settings to 171 * View On> or <Text View On>. Used when user changes the TV settings to
171 * disable the auto TV on functionality. 172 * disable the auto TV on functionality.
172 * True by default. 173 * True by default.
173 */ 174 */
174 WAKEUP = 1, 175 WAKEUP = 1,
175 176
176 /* When set to false, all the CEC commands are discarded. Used when user 177 /**
178 * When set to false, all the CEC commands are discarded. Used when user
177 * changes the TV settings to disable CEC functionality. 179 * changes the TV settings to disable CEC functionality.
178 * True by default. 180 * True by default.
179 */ 181 */
180 ENABLE_CEC = 2, 182 ENABLE_CEC = 2,
181 183
182 /* Setting this flag to false means Android system must stop handling CEC 184 /**
185 * Setting this flag to false means Android system must stop handling CEC
183 * service and yield the control over to the microprocessor that is powered 186 * service and yield the control over to the microprocessor that is powered
184 * on through the standby mode. When set to true, the system must gain the 187 * on through the standby mode. When set to true, the system must gain the
185 * control over, hence telling the microprocessor to stop handling the CEC 188 * control over, hence telling the microprocessor to stop handling the CEC
@@ -190,17 +193,18 @@ enum OptionKey : int32_t {
190 */ 193 */
191 SYSTEM_CEC_CONTROL = 3, 194 SYSTEM_CEC_CONTROL = 3,
192 195
193 /* Option 4 not used */ 196 /** Option 4 not used */
194}; 197};
195 198
196struct CecMessage { 199struct CecMessage {
197 /* logical address of sender */ 200 /** logical address of sender */
198 CecLogicalAddress initiator; 201 CecLogicalAddress initiator;
199 202
200 /* logical address of receiver */ 203 /** logical address of receiver */
201 CecLogicalAddress destination; 204 CecLogicalAddress destination;
202 205
203 /* The maximum size of body is 15 (MaxLength::MESSAGE_BODY) as specified in 206 /**
207 * The maximum size of body is 15 (MaxLength::MESSAGE_BODY) as specified in
204 * the section 6 of the CEC Spec 1.4b. Overflowed data must be ignored. */ 208 * the section 6 of the CEC Spec 1.4b. Overflowed data must be ignored. */
205 vec<uint8_t> body; 209 vec<uint8_t> body;
206}; 210};
@@ -210,7 +214,7 @@ struct HotplugEvent {
210 uint32_t portId; 214 uint32_t portId;
211}; 215};
212 216
213/* 217/**
214 * HDMI port descriptor 218 * HDMI port descriptor
215 */ 219 */
216struct HdmiPortInfo { 220struct HdmiPortInfo {
diff --git a/tv/input/1.0/ITvInput.hal b/tv/input/1.0/ITvInput.hal
index 43de276f..95aff21a 100644
--- a/tv/input/1.0/ITvInput.hal
+++ b/tv/input/1.0/ITvInput.hal
@@ -19,7 +19,7 @@ package android.hardware.tv.input@1.0;
19import ITvInputCallback; 19import ITvInputCallback;
20 20
21interface ITvInput { 21interface ITvInput {
22 /* 22 /**
23 * Sets a callback for events. 23 * Sets a callback for events.
24 * 24 *
25 * Note that initially no device is available in the client side, so the 25 * Note that initially no device is available in the client side, so the
@@ -33,7 +33,7 @@ interface ITvInput {
33 @callflow(next={"getStreamConfigurations"}) 33 @callflow(next={"getStreamConfigurations"})
34 setCallback(ITvInputCallback callback); 34 setCallback(ITvInputCallback callback);
35 35
36 /* 36 /**
37 * Gets stream configurations for a specific device. 37 * Gets stream configurations for a specific device.
38 * 38 *
39 * The configs object is valid only until the next 39 * The configs object is valid only until the next
@@ -48,7 +48,7 @@ interface ITvInput {
48 getStreamConfigurations(int32_t deviceId) 48 getStreamConfigurations(int32_t deviceId)
49 generates (Result result, vec<TvStreamConfig> configurations); 49 generates (Result result, vec<TvStreamConfig> configurations);
50 50
51 /* 51 /**
52 * Opens a specific stream in a device. 52 * Opens a specific stream in a device.
53 * 53 *
54 * @param deviceId Device ID for the steam to open. 54 * @param deviceId Device ID for the steam to open.
@@ -65,7 +65,7 @@ interface ITvInput {
65 openStream(int32_t deviceId, int32_t streamId) 65 openStream(int32_t deviceId, int32_t streamId)
66 generates (Result result, handle sidebandStream); 66 generates (Result result, handle sidebandStream);
67 67
68 /* 68 /**
69 * Closes a specific stream in a device. 69 * Closes a specific stream in a device.
70 * 70 *
71 * @param deviceId Device ID for the steam to open. 71 * @param deviceId Device ID for the steam to open.
diff --git a/tv/input/1.0/ITvInputCallback.hal b/tv/input/1.0/ITvInputCallback.hal
index f2f07a03..6d88c5b5 100644
--- a/tv/input/1.0/ITvInputCallback.hal
+++ b/tv/input/1.0/ITvInputCallback.hal
@@ -17,7 +17,7 @@
17package android.hardware.tv.input@1.0; 17package android.hardware.tv.input@1.0;
18 18
19interface ITvInputCallback { 19interface ITvInputCallback {
20 /* 20 /**
21 * Notifies the client that an event has occured. For possible event types, 21 * Notifies the client that an event has occured. For possible event types,
22 * check TvInputEventType. 22 * check TvInputEventType.
23 * 23 *
diff --git a/tv/input/1.0/types.hal b/tv/input/1.0/types.hal
index 60a3b7b6..55dd6c01 100644
--- a/tv/input/1.0/types.hal
+++ b/tv/input/1.0/types.hal
@@ -26,7 +26,7 @@ enum Result : int32_t {
26 INVALID_STATE, 26 INVALID_STATE,
27}; 27};
28 28
29/* Type of physical TV input. */ 29/** Type of physical TV input. */
30@export(name="", value_prefix="TV_INPUT_TYPE_") 30@export(name="", value_prefix="TV_INPUT_TYPE_")
31enum TvInputType : int32_t { 31enum TvInputType : int32_t {
32 OTHER = 1, // Generic hardware. 32 OTHER = 1, // Generic hardware.
@@ -41,7 +41,7 @@ enum TvInputType : int32_t {
41 DISPLAY_PORT = 10, 41 DISPLAY_PORT = 10,
42}; 42};
43 43
44/* 44/**
45 * Status of cable connection. 45 * Status of cable connection.
46 * This status is for devices having availability to detect the cable in a mechanical way, 46 * This status is for devices having availability to detect the cable in a mechanical way,
47 * regardless of whether the connected external device is electrically on or not. 47 * regardless of whether the connected external device is electrically on or not.
@@ -67,7 +67,7 @@ struct TvInputDeviceInfo {
67 67
68@export(name="", value_prefix="EVENT_") 68@export(name="", value_prefix="EVENT_")
69enum TvInputEventType : int32_t { 69enum TvInputEventType : int32_t {
70 /* 70 /**
71 * Hardware notifies the framework that a device is available. 71 * Hardware notifies the framework that a device is available.
72 * 72 *
73 * Note that DEVICE_AVAILABLE and DEVICE_UNAVAILABLE events do not represent 73 * Note that DEVICE_AVAILABLE and DEVICE_UNAVAILABLE events do not represent
@@ -89,7 +89,7 @@ enum TvInputEventType : int32_t {
89 */ 89 */
90 DEVICE_AVAILABLE = 1, 90 DEVICE_AVAILABLE = 1,
91 91
92 /* 92 /**
93 * Hardware notifies the framework that a device is unavailable. 93 * Hardware notifies the framework that a device is unavailable.
94 * 94 *
95 * HAL implementation must generate this event when a device registered 95 * HAL implementation must generate this event when a device registered
@@ -104,7 +104,7 @@ enum TvInputEventType : int32_t {
104 */ 104 */
105 DEVICE_UNAVAILABLE = 2, 105 DEVICE_UNAVAILABLE = 2,
106 106
107 /* 107 /**
108 * Stream configurations are changed. Client must regard all open streams 108 * Stream configurations are changed. Client must regard all open streams
109 * at the specific device are closed, and must call 109 * at the specific device are closed, and must call
110 * getStreamConfigurations() again, opening some of them if necessary. 110 * getStreamConfigurations() again, opening some of them if necessary.
@@ -126,7 +126,7 @@ enum TvInputEventType : int32_t {
126 126
127struct TvInputEvent { 127struct TvInputEvent {
128 TvInputEventType type; 128 TvInputEventType type;
129 /* 129 /**
130 * DEVICE_AVAILABLE: all fields are relevant. 130 * DEVICE_AVAILABLE: all fields are relevant.
131 * DEVICE_UNAVAILABLE: only deviceId is relevant. 131 * DEVICE_UNAVAILABLE: only deviceId is relevant.
132 * STREAM_CONFIGURATIONS_CHANGED: only deviceId is relevant. 132 * STREAM_CONFIGURATIONS_CHANGED: only deviceId is relevant.