tequilaOS/platform_hardware_interfaces
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Convert all comments into "doxygen-ready" comments.

Browse source 
Bug: 36453077
Test: make
Change-Id: Ic77394d4d2e1ccedba3a28230d870c5d6108bd40
This commit is contained in:
Andreas Huber 2017-03-28 14:40:58 -07:00
parent 2f44ec6c86
commit 675ae49ab1
18 changed files with 450 additions and 449 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
bluetooth/1.0/IBluetoothHci.hal
View file

@ -18,7 +18,7 @@ package android.hardware.bluetooth@1.0;
import IBluetoothHciCallbacks; import IBluetoothHciCallbacks;
/* /**
* The Host Controller Interface (HCI) is the layer defined by the Bluetooth * The Host Controller Interface (HCI) is the layer defined by the Bluetooth
* specification between the software that runs on the host and the Bluetooth * specification between the software that runs on the host and the Bluetooth
* controller chip. This boundary is the natural choice for a Hardware * controller chip. This boundary is the natural choice for a Hardware

2
bluetooth/1.0/IBluetoothHciCallbacks.hal
View file

@ -16,7 +16,7 @@
package android.hardware.bluetooth@1.0; package android.hardware.bluetooth@1.0;
/* The interface from the Bluetooth Controller to the stack. */ /** The interface from the Bluetooth Controller to the stack. */
interface IBluetoothHciCallbacks { interface IBluetoothHciCallbacks {
/** /**
* Invoked when the Bluetooth controller initialization has been * Invoked when the Bluetooth controller initialization has been

4
ir/1.0/IConsumerIr.hal
View file

@ -17,7 +17,7 @@
package android.hardware.ir@1.0; package android.hardware.ir@1.0;
interface IConsumerIr { interface IConsumerIr {
/* /**
* transmit() sends an IR pattern at a given carrierFreq. * transmit() sends an IR pattern at a given carrierFreq.
* *
* The pattern is alternating series of carrier on and off periods measured in * The pattern is alternating series of carrier on and off periods measured in
@ -30,7 +30,7 @@ interface IConsumerIr {
*/ */
transmit(int32_t carrierFreq, vec<int32_t> pattern) generates (bool success); transmit(int32_t carrierFreq, vec<int32_t> pattern) generates (bool success);
/* /**
* getCarrierFreqs() enumerates which frequencies the IR transmitter supports. * getCarrierFreqs() enumerates which frequencies the IR transmitter supports.
* *
* returns: On success, true and a vector of all supported frequency * returns: On success, true and a vector of all supported frequency

14
nfc/1.0/INfc.hal
View file

@ -19,7 +19,7 @@ package android.hardware.nfc@1.0;
import INfcClientCallback; import INfcClientCallback;
interface INfc { interface INfc {
/* /**
* Opens the NFC controller device and performs initialization. * Opens the NFC controller device and performs initialization.
* This may include patch download and other vendor-specific initialization. * This may include patch download and other vendor-specific initialization.
* *
@ -37,7 +37,7 @@ interface INfc {
@callflow(next={"write", "coreInitialized", "prediscover", "powerCycle", "controlGranted"}) @callflow(next={"write", "coreInitialized", "prediscover", "powerCycle", "controlGranted"})
open(INfcClientCallback clientCallback) generates (NfcStatus status); open(INfcClientCallback clientCallback) generates (NfcStatus status);
/* /**
* Performs an NCI write. * Performs an NCI write.
* *
* This method may queue writes and return immediately. The only * This method may queue writes and return immediately. The only
@ -49,7 +49,7 @@ interface INfc {
"controlGranted"}) "controlGranted"})
write(NfcData data) generates (uint32_t retval); write(NfcData data) generates (uint32_t retval);
/* /**
* coreInitialized() is called after the CORE_INIT_RSP is received from the * coreInitialized() is called after the CORE_INIT_RSP is received from the
* NFCC. At this time, the HAL can do any chip-specific configuration. * NFCC. At this time, the HAL can do any chip-specific configuration.
* *
@ -62,7 +62,7 @@ interface INfc {
@callflow(next={"write", "prediscover", "close"}) @callflow(next={"write", "prediscover", "close"})
coreInitialized(NfcData data) generates (NfcStatus status); coreInitialized(NfcData data) generates (NfcStatus status);
/* /**
* prediscover is called every time before starting RF discovery. * prediscover is called every time before starting RF discovery.
* It is a good place to do vendor-specific configuration that must be * It is a good place to do vendor-specific configuration that must be
* performed every time RF discovery is about to be started. * performed every time RF discovery is about to be started.
@ -76,7 +76,7 @@ interface INfc {
@callflow(next={"write", "close", "coreInitialized", "powerCycle", "controlGranted"}) @callflow(next={"write", "close", "coreInitialized", "powerCycle", "controlGranted"})
prediscover() generates (NfcStatus status); prediscover() generates (NfcStatus status);
/* /**
* Close the NFC controller. Should free all resources. * Close the NFC controller. Should free all resources.
* *
* @return NfcStatus::OK on success and NfcStatus::FAILED on error. * @return NfcStatus::OK on success and NfcStatus::FAILED on error.
@ -84,7 +84,7 @@ interface INfc {
@exit @exit
close() generates (NfcStatus status); close() generates (NfcStatus status);
/* /**
* Grant HAL the exclusive control to send NCI commands. * Grant HAL the exclusive control to send NCI commands.
* Called in response to NfcEvent.REQUEST_CONTROL. * Called in response to NfcEvent.REQUEST_CONTROL.
* Must only be called when there are no NCI commands pending. * Must only be called when there are no NCI commands pending.
@ -95,7 +95,7 @@ interface INfc {
@callflow(next={"write", "close", "prediscover", "coreInitialized", "powerCycle"}) @callflow(next={"write", "close", "prediscover", "coreInitialized", "powerCycle"})
controlGranted() generates (NfcStatus status); controlGranted() generates (NfcStatus status);
/* /**
* Restart controller by power cyle; * Restart controller by power cyle;
* NfcEvent.OPEN_CPLT will notify when operation is complete. * NfcEvent.OPEN_CPLT will notify when operation is complete.
* *

4
nfc/1.0/INfcClientCallback.hal
View file

@ -17,13 +17,13 @@
package android.hardware.nfc@1.0; package android.hardware.nfc@1.0;
interface INfcClientCallback { interface INfcClientCallback {
/* /**
* The callback passed in from the NFC stack that the HAL * The callback passed in from the NFC stack that the HAL
* can use to pass events back to the stack. * can use to pass events back to the stack.
*/ */
sendEvent(NfcEvent event, NfcStatus status); sendEvent(NfcEvent event, NfcStatus status);
/* /**
* The callback passed in from the NFC stack that the HAL * The callback passed in from the NFC stack that the HAL
* can use to pass incomming data to the stack. * can use to pass incomming data to the stack.
*/ */

262
radio/1.0/IRadio.hal
View file

File diff suppressed because it is too large Load diff

92
radio/1.0/IRadioIndication.hal
View file

@ -16,11 +16,11 @@
package android.hardware.radio@1.0; package android.hardware.radio@1.0;
/* /**
* Interface declaring unsolicited radio indications. * Interface declaring unsolicited radio indications.
*/ */
interface IRadioIndication { interface IRadioIndication {
/* /**
* Indicates when radio state changes. * Indicates when radio state changes.
* *
* @param type Type of radio indication * @param type Type of radio indication
@ -28,7 +28,7 @@ interface IRadioIndication {
*/ */
oneway radioStateChanged(RadioIndicationType type, RadioState radioState); oneway radioStateChanged(RadioIndicationType type, RadioState radioState);
/* /**
* Indicates when call state has changed. * Indicates when call state has changed.
* Callee must invoke IRadio.getCurrentCalls() * Callee must invoke IRadio.getCurrentCalls()
* Must be invoked on, for example, * Must be invoked on, for example,
@ -41,7 +41,7 @@ interface IRadioIndication {
*/ */
oneway callStateChanged(RadioIndicationType type); oneway callStateChanged(RadioIndicationType type);
/* /**
* Indicates when voice or data network state changed * Indicates when voice or data network state changed
* Callee must invoke IRadio.getVoiceRegistrationState(), IRadio.getDataRegistrationState(), * Callee must invoke IRadio.getVoiceRegistrationState(), IRadio.getDataRegistrationState(),
* and IRadio.getOperator() * and IRadio.getOperator()
@ -50,7 +50,7 @@ interface IRadioIndication {
*/ */
oneway networkStateChanged(RadioIndicationType type); oneway networkStateChanged(RadioIndicationType type);
/* /**
* Indicates when new SMS is received. * Indicates when new SMS is received.
* Callee must subsequently confirm the receipt of the SMS with a * Callee must subsequently confirm the receipt of the SMS with a
* acknowledgeLastIncomingGsmSms() * acknowledgeLastIncomingGsmSms()
@ -64,7 +64,7 @@ interface IRadioIndication {
*/ */
oneway newSms(RadioIndicationType type, vec<uint8_t> pdu); oneway newSms(RadioIndicationType type, vec<uint8_t> pdu);
/* /**
* Indicates when new SMS Status Report is received. * Indicates when new SMS Status Report is received.
* Callee must subsequently confirm the receipt of the SMS with a * Callee must subsequently confirm the receipt of the SMS with a
* acknowledgeLastIncomingGsmSms() * acknowledgeLastIncomingGsmSms()
@ -78,7 +78,7 @@ interface IRadioIndication {
*/ */
oneway newSmsStatusReport(RadioIndicationType type, vec<uint8_t> pdu); oneway newSmsStatusReport(RadioIndicationType type, vec<uint8_t> pdu);
/* /**
* Indicates when new SMS has been stored on SIM card * Indicates when new SMS has been stored on SIM card
* *
* @param type Type of radio indication * @param type Type of radio indication
@ -86,7 +86,7 @@ interface IRadioIndication {
*/ */
oneway newSmsOnSim(RadioIndicationType type, int32_t recordNumber); oneway newSmsOnSim(RadioIndicationType type, int32_t recordNumber);
/* /**
* Indicates when a new USSD message is received. * Indicates when a new USSD message is received.
* The USSD session is assumed to persist if the type code is REQUEST, otherwise * The USSD session is assumed to persist if the type code is REQUEST, otherwise
* the current session (if any) is assumed to have terminated. * the current session (if any) is assumed to have terminated.
@ -97,7 +97,7 @@ interface IRadioIndication {
*/ */
oneway onUssd(RadioIndicationType type, UssdModeType modeType, string msg); oneway onUssd(RadioIndicationType type, UssdModeType modeType, string msg);
/* /**
* Indicates when radio has received a NITZ time message. * Indicates when radio has received a NITZ time message.
* *
* @param type Type of radio indication * @param type Type of radio indication
@ -106,7 +106,7 @@ interface IRadioIndication {
*/ */
oneway nitzTimeReceived(RadioIndicationType type, string nitzTime, uint64_t receivedTime); oneway nitzTimeReceived(RadioIndicationType type, string nitzTime, uint64_t receivedTime);
/* /**
* Indicates current signal strength of the radio. * Indicates current signal strength of the radio.
* *
* @param type Type of radio indication * @param type Type of radio indication
@ -114,7 +114,7 @@ interface IRadioIndication {
*/ */
oneway currentSignalStrength(RadioIndicationType type, SignalStrength signalStrength); oneway currentSignalStrength(RadioIndicationType type, SignalStrength signalStrength);
/* /**
* Indicates data call contexts have changed. * Indicates data call contexts have changed.
* *
* @param type Type of radio indication * @param type Type of radio indication
@ -127,7 +127,7 @@ interface IRadioIndication {
*/ */
oneway dataCallListChanged(RadioIndicationType type, vec<SetupDataCallResult> dcList); oneway dataCallListChanged(RadioIndicationType type, vec<SetupDataCallResult> dcList);
/* /**
* Reports supplementary service related notification from the network. * Reports supplementary service related notification from the network.
* *
* @param type Type of radio indication * @param type Type of radio indication
@ -135,14 +135,14 @@ interface IRadioIndication {
*/ */
oneway suppSvcNotify(RadioIndicationType type, SuppSvcNotification suppSvc); oneway suppSvcNotify(RadioIndicationType type, SuppSvcNotification suppSvc);
/* /**
* Indicates when STK session is terminated by SIM. * Indicates when STK session is terminated by SIM.
* *
* @param type Type of radio indication * @param type Type of radio indication
*/ */
oneway stkSessionEnd(RadioIndicationType type); oneway stkSessionEnd(RadioIndicationType type);
/* /**
* Indicates when SIM issue a STK proactive command to applications * Indicates when SIM issue a STK proactive command to applications
* *
* @param type Type of radio indication * @param type Type of radio indication
@ -151,7 +151,7 @@ interface IRadioIndication {
*/ */
oneway stkProactiveCommand(RadioIndicationType type, string cmd); oneway stkProactiveCommand(RadioIndicationType type, string cmd);
/* /**
* Indicates when SIM notifies applcations some event happens. * Indicates when SIM notifies applcations some event happens.
* *
* @param type Type of radio indication * @param type Type of radio indication
@ -162,7 +162,7 @@ interface IRadioIndication {
*/ */
oneway stkEventNotify(RadioIndicationType type, string cmd); oneway stkEventNotify(RadioIndicationType type, string cmd);
/* /**
* Indicates when SIM wants application to setup a voice call. * Indicates when SIM wants application to setup a voice call.
* *
* @param type Type of radio indication * @param type Type of radio indication
@ -170,7 +170,7 @@ interface IRadioIndication {
*/ */
oneway stkCallSetup(RadioIndicationType type, int64_t timeout); oneway stkCallSetup(RadioIndicationType type, int64_t timeout);
/* /**
* Indicates that SMS storage on the SIM is full. Sent when the network * Indicates that SMS storage on the SIM is full. Sent when the network
* attempts to deliver a new SMS message. Messages cannot be saved on the * attempts to deliver a new SMS message. Messages cannot be saved on the
* SIM until space is freed. In particular, incoming Class 2 messages must not * SIM until space is freed. In particular, incoming Class 2 messages must not
@ -180,7 +180,7 @@ interface IRadioIndication {
*/ */
oneway simSmsStorageFull(RadioIndicationType type); oneway simSmsStorageFull(RadioIndicationType type);
/* /**
* Indicates that file(s) on the SIM have been updated, or the SIM * Indicates that file(s) on the SIM have been updated, or the SIM
* has been reinitialized. * has been reinitialized.
* Note: If the SIM state changes as a result of the SIM refresh (eg, * Note: If the SIM state changes as a result of the SIM refresh (eg,
@ -192,7 +192,7 @@ interface IRadioIndication {
*/ */
oneway simRefresh(RadioIndicationType type, SimRefreshResult refreshResult); oneway simRefresh(RadioIndicationType type, SimRefreshResult refreshResult);
/* /**
* Ring indication for an incoming call (eg, RING or CRING event). * Ring indication for an incoming call (eg, RING or CRING event).
* There must be at least one callRing() at the beginning * There must be at least one callRing() at the beginning
* of a call and sending multiple is optional. If the system property * of a call and sending multiple is optional. If the system property
@ -210,7 +210,7 @@ interface IRadioIndication {
*/ */
oneway callRing(RadioIndicationType type, bool isGsm, CdmaSignalInfoRecord record); oneway callRing(RadioIndicationType type, bool isGsm, CdmaSignalInfoRecord record);
/* /**
* Indicates that SIM state changes. * Indicates that SIM state changes.
* Callee must invoke getIccCardStatus() * Callee must invoke getIccCardStatus()
* *
@ -218,7 +218,7 @@ interface IRadioIndication {
*/ */
oneway simStatusChanged(RadioIndicationType type); oneway simStatusChanged(RadioIndicationType type);
/* /**
* Indicates when new CDMA SMS is received * Indicates when new CDMA SMS is received
* Callee must subsequently confirm the receipt of the SMS with * Callee must subsequently confirm the receipt of the SMS with
* acknowledgeLastIncomingCdmaSms() * acknowledgeLastIncomingCdmaSms()
@ -230,7 +230,7 @@ interface IRadioIndication {
*/ */
oneway cdmaNewSms(RadioIndicationType type, CdmaSmsMessage msg); oneway cdmaNewSms(RadioIndicationType type, CdmaSmsMessage msg);
/* /**
* Indicates when new Broadcast SMS is received * Indicates when new Broadcast SMS is received
* *
* @param type Type of radio indication * @param type Type of radio indication
@ -243,7 +243,7 @@ interface IRadioIndication {
*/ */
oneway newBroadcastSms(RadioIndicationType type, vec<uint8_t> data); oneway newBroadcastSms(RadioIndicationType type, vec<uint8_t> data);
/* /**
* Indicates that SMS storage on the RUIM is full. Messages * Indicates that SMS storage on the RUIM is full. Messages
* cannot be saved on the RUIM until space is freed. * cannot be saved on the RUIM until space is freed.
* *
@ -251,7 +251,7 @@ interface IRadioIndication {
*/ */
oneway cdmaRuimSmsStorageFull(RadioIndicationType type); oneway cdmaRuimSmsStorageFull(RadioIndicationType type);
/* /**
* Indicates a restricted state change (eg, for Domain Specific Access Control). * Indicates a restricted state change (eg, for Domain Specific Access Control).
* Radio must send this msg after radio off/on cycle no matter it is changed or not. * Radio must send this msg after radio off/on cycle no matter it is changed or not.
* *
@ -260,7 +260,7 @@ interface IRadioIndication {
*/ */
oneway restrictedStateChanged(RadioIndicationType type, PhoneRestrictedState state); oneway restrictedStateChanged(RadioIndicationType type, PhoneRestrictedState state);
/* /**
* Indicates that the radio system selection module has * Indicates that the radio system selection module has
* autonomously entered emergency callback mode. * autonomously entered emergency callback mode.
* *
@ -268,7 +268,7 @@ interface IRadioIndication {
*/ */
oneway enterEmergencyCallbackMode(RadioIndicationType type); oneway enterEmergencyCallbackMode(RadioIndicationType type);
/* /**
* Indicates when CDMA radio receives a call waiting indication. * Indicates when CDMA radio receives a call waiting indication.
* *
* @param type Type of radio indication * @param type Type of radio indication
@ -276,7 +276,7 @@ interface IRadioIndication {
*/ */
oneway cdmaCallWaiting(RadioIndicationType type, CdmaCallWaiting callWaitingRecord); oneway cdmaCallWaiting(RadioIndicationType type, CdmaCallWaiting callWaitingRecord);
/* /**
* Indicates when CDMA radio receives an update of the progress of an OTASP/OTAPA call. * Indicates when CDMA radio receives an update of the progress of an OTASP/OTAPA call.
* *
* @param type Type of radio indication * @param type Type of radio indication
@ -284,7 +284,7 @@ interface IRadioIndication {
*/ */
oneway cdmaOtaProvisionStatus(RadioIndicationType type, CdmaOtaProvisionStatus status); oneway cdmaOtaProvisionStatus(RadioIndicationType type, CdmaOtaProvisionStatus status);
/* /**
* Indicates when CDMA radio receives one or more info recs. * Indicates when CDMA radio receives one or more info recs.
* *
* @param type Type of radio indication * @param type Type of radio indication
@ -292,7 +292,7 @@ interface IRadioIndication {
*/ */
oneway cdmaInfoRec(RadioIndicationType type, CdmaInformationRecords records); oneway cdmaInfoRec(RadioIndicationType type, CdmaInformationRecords records);
/* /**
* Indicates that nework doesn't have in-band information, need to * Indicates that nework doesn't have in-band information, need to
* play out-band tone. * play out-band tone.
* *
@ -301,14 +301,14 @@ interface IRadioIndication {
*/ */
oneway indicateRingbackTone(RadioIndicationType type, bool start); oneway indicateRingbackTone(RadioIndicationType type, bool start);
/* /**
* Indicates that framework/application must reset the uplink mute state. * Indicates that framework/application must reset the uplink mute state.
* *
* @param type Type of radio indication * @param type Type of radio indication
*/ */
oneway resendIncallMute(RadioIndicationType type); oneway resendIncallMute(RadioIndicationType type);
/* /**
* Indicates when CDMA subscription source changed. * Indicates when CDMA subscription source changed.
* *
* @param type Type of radio indication * @param type Type of radio indication
@ -317,7 +317,7 @@ interface IRadioIndication {
oneway cdmaSubscriptionSourceChanged(RadioIndicationType type, oneway cdmaSubscriptionSourceChanged(RadioIndicationType type,
CdmaSubscriptionSource cdmaSource); CdmaSubscriptionSource cdmaSource);
/* /**
* Indicates when PRL (preferred roaming list) changes. * Indicates when PRL (preferred roaming list) changes.
* *
* @param type Type of radio indication * @param type Type of radio indication
@ -325,7 +325,7 @@ interface IRadioIndication {
*/ */
oneway cdmaPrlChanged(RadioIndicationType type, int32_t version); oneway cdmaPrlChanged(RadioIndicationType type, int32_t version);
/* /**
* Indicates when Emergency Callback Mode Ends. * Indicates when Emergency Callback Mode Ends.
* Indicates that the radio system selection module has * Indicates that the radio system selection module has
* proactively exited emergency callback mode. * proactively exited emergency callback mode.
@ -334,14 +334,14 @@ interface IRadioIndication {
*/ */
oneway exitEmergencyCallbackMode(RadioIndicationType type); oneway exitEmergencyCallbackMode(RadioIndicationType type);
/* /**
* Indicates the ril connects and returns the version * Indicates the ril connects and returns the version
* *
* @param type Type of radio indication * @param type Type of radio indication
*/ */
oneway rilConnected(RadioIndicationType type); oneway rilConnected(RadioIndicationType type);
/* /**
* Indicates that voice technology has changed. Responds with new rat. * Indicates that voice technology has changed. Responds with new rat.
* *
* @param type Type of radio indication * @param type Type of radio indication
@ -349,7 +349,7 @@ interface IRadioIndication {
*/ */
oneway voiceRadioTechChanged(RadioIndicationType type, RadioTechnology rat); oneway voiceRadioTechChanged(RadioIndicationType type, RadioTechnology rat);
/* /**
* Same information as returned by getCellInfoList(). * Same information as returned by getCellInfoList().
* *
* @param type Type of radio indication * @param type Type of radio indication
@ -357,7 +357,7 @@ interface IRadioIndication {
*/ */
oneway cellInfoList(RadioIndicationType type, vec<CellInfo> records); oneway cellInfoList(RadioIndicationType type, vec<CellInfo> records);
/* /**
* Indicates when IMS registration state has changed. * Indicates when IMS registration state has changed.
* To get IMS registration state and IMS SMS format, callee needs to invoke * To get IMS registration state and IMS SMS format, callee needs to invoke
* getImsRegistrationState() * getImsRegistrationState()
@ -366,7 +366,7 @@ interface IRadioIndication {
*/ */
oneway imsNetworkStateChanged(RadioIndicationType type); oneway imsNetworkStateChanged(RadioIndicationType type);
/* /**
* Indicated when there is a change in subscription status. * Indicated when there is a change in subscription status.
* This event must be sent in the following scenarios * This event must be sent in the following scenarios
* - subscription readiness at modem, which was selected by telephony layer * - subscription readiness at modem, which was selected by telephony layer
@ -378,7 +378,7 @@ interface IRadioIndication {
*/ */
oneway subscriptionStatusChanged(RadioIndicationType type, bool activate); oneway subscriptionStatusChanged(RadioIndicationType type, bool activate);
/* /**
* Indicates when Single Radio Voice Call Continuity (SRVCC) * Indicates when Single Radio Voice Call Continuity (SRVCC)
* progress state has changed * progress state has changed
* *
@ -387,7 +387,7 @@ interface IRadioIndication {
*/ */
oneway srvccStateNotify(RadioIndicationType type, SrvccState state); oneway srvccStateNotify(RadioIndicationType type, SrvccState state);
/* /**
* Indicates when the hardware configuration associated with the RILd changes. * Indicates when the hardware configuration associated with the RILd changes.
* *
* @param type Type of radio indication * @param type Type of radio indication
@ -395,7 +395,7 @@ interface IRadioIndication {
*/ */
oneway hardwareConfigChanged(RadioIndicationType type, vec<HardwareConfig> configs); oneway hardwareConfigChanged(RadioIndicationType type, vec<HardwareConfig> configs);
/* /**
* Sent when setRadioCapability() completes. * Sent when setRadioCapability() completes.
* Returns the phone radio capability exactly as * Returns the phone radio capability exactly as
* getRadioCapability() and must be the * getRadioCapability() and must be the
@ -406,7 +406,7 @@ interface IRadioIndication {
*/ */
oneway radioCapabilityIndication(RadioIndicationType type, RadioCapability rc); oneway radioCapabilityIndication(RadioIndicationType type, RadioCapability rc);
/* /**
* Indicates when Supplementary service(SS) response is received when DIAL/USSD/SS is changed to * Indicates when Supplementary service(SS) response is received when DIAL/USSD/SS is changed to
* SS by call control. * SS by call control.
* *
@ -414,7 +414,7 @@ interface IRadioIndication {
*/ */
oneway onSupplementaryServiceIndication(RadioIndicationType type, StkCcUnsolSsResult ss); oneway onSupplementaryServiceIndication(RadioIndicationType type, StkCcUnsolSsResult ss);
/* /**
* Indicates when there is an ALPHA from UICC during Call Control. * Indicates when there is an ALPHA from UICC during Call Control.
* *
* @param type Type of radio indication * @param type Type of radio indication
@ -422,7 +422,7 @@ interface IRadioIndication {
*/ */
oneway stkCallControlAlphaNotify(RadioIndicationType type, string alpha); oneway stkCallControlAlphaNotify(RadioIndicationType type, string alpha);
/* /**
* Indicates when there is an incoming Link Capacity Estimate (LCE) info report. * Indicates when there is an incoming Link Capacity Estimate (LCE) info report.
* *
* @param type Type of radio indication * @param type Type of radio indication
@ -430,7 +430,7 @@ interface IRadioIndication {
*/ */
oneway lceData(RadioIndicationType type, LceDataInfo lce); oneway lceData(RadioIndicationType type, LceDataInfo lce);
/* /**
* Indicates when there is new Carrier PCO data received for a data call. Ideally * Indicates when there is new Carrier PCO data received for a data call. Ideally
* only new data must be forwarded, though this is not required. Multiple * only new data must be forwarded, though this is not required. Multiple
* boxes of carrier PCO data for a given call must result in a series of * boxes of carrier PCO data for a given call must result in a series of
@ -441,7 +441,7 @@ interface IRadioIndication {
*/ */
oneway pcoData(RadioIndicationType type, PcoDataInfo pco); oneway pcoData(RadioIndicationType type, PcoDataInfo pco);
/* /**
* Indicates when there is a modem reset. * Indicates when there is a modem reset.
* *
* When modem restarts, one of the following radio state transitions must happen * When modem restarts, one of the following radio state transitions must happen

260
radio/1.0/IRadioResponse.hal
View file

File diff suppressed because it is too large Load diff

27
radio/1.0/types.hal
View file

@ -288,7 +288,7 @@ enum CallState : int32_t {
WAITING, // MT call only WAITING, // MT call only
}; };
/* /**
* User-to-User signaling Info activation types derived from 3GPP 23.087 v8.0 * User-to-User signaling Info activation types derived from 3GPP 23.087 v8.0
*/ */
enum UusType : int32_t { enum UusType : int32_t {
@ -301,7 +301,7 @@ enum UusType : int32_t {
TYPE3_NOT_REQUIRED, TYPE3_NOT_REQUIRED,
}; };
/* /**
* User-to-User Signaling Information data coding schemes. Possible values for * User-to-User Signaling Information data coding schemes. Possible values for
* Octet 3 (Protocol Discriminator field) in the UUIE. The values have been * Octet 3 (Protocol Discriminator field) in the UUIE. The values have been
* specified in section 10.5.4.25 of 3GPP TS 24.008 * specified in section 10.5.4.25 of 3GPP TS 24.008
@ -410,7 +410,8 @@ enum LastCallFailCause : int32_t {
// callback mode // callback mode
CDMA_ACCESS_BLOCKED = 1009, CDMA_ACCESS_BLOCKED = 1009,
/* OEM specific error codes. Used to distinguish error from /**
* OEM specific error codes. Used to distinguish error from
* CALL_FAIL_ERROR_UNSPECIFIED and help assist debugging */ * CALL_FAIL_ERROR_UNSPECIFIED and help assist debugging */
OEM_CAUSE_1 = 0xf001, OEM_CAUSE_1 = 0xf001,
OEM_CAUSE_2 = 0xf002, OEM_CAUSE_2 = 0xf002,
@ -526,7 +527,7 @@ enum DataCallFailCause : int32_t {
ERROR_UNSPECIFIED = 0xffff, ERROR_UNSPECIFIED = 0xffff,
}; };
/* /**
* Please note that registration state UNKNOWN is * Please note that registration state UNKNOWN is
* treated as "out of service" in the Android telephony. * treated as "out of service" in the Android telephony.
* Registration state REG_DENIED must be returned if Location Update * Registration state REG_DENIED must be returned if Location Update
@ -1018,7 +1019,7 @@ enum CdmaOtaProvisionStatus : int32_t {
OTAPA_ABORTED OTAPA_ABORTED
}; };
/* Names of the CDMA info records (C.S0005 section 3.7.5) */ /** Names of the CDMA info records (C.S0005 section 3.7.5) */
enum CdmaInfoRecName : int32_t { enum CdmaInfoRecName : int32_t {
DISPLAY, DISPLAY,
CALLED_PARTY_NUMBER, CALLED_PARTY_NUMBER,
@ -1033,7 +1034,7 @@ enum CdmaInfoRecName : int32_t {
T53_AUDIO_CONTROL T53_AUDIO_CONTROL
}; };
/* Redirecting Number Information Record as defined in C.S0005 section 3.7.5.11 */ /** Redirecting Number Information Record as defined in C.S0005 section 3.7.5.11 */
enum CdmaRedirectingReason : int32_t { enum CdmaRedirectingReason : int32_t {
UNKNOWN = 0, UNKNOWN = 0,
CALL_FORWARDING_BUSY = 1, CALL_FORWARDING_BUSY = 1,
@ -1187,7 +1188,7 @@ struct CardStatus {
vec<AppStatus> applications; // size <= RadioConst:CARD_MAX_APPS vec<AppStatus> applications; // size <= RadioConst:CARD_MAX_APPS
}; };
/* /**
* User-to-User Signaling Information defined in 3GPP 23.087 v8.0 * User-to-User Signaling Information defined in 3GPP 23.087 v8.0
*/ */
struct UusInfo { struct UusInfo {
@ -1893,7 +1894,7 @@ struct SimRefreshResult {
// For SIM_RESET result it is empty string. // For SIM_RESET result it is empty string.
}; };
/* CDMA Signal Information Record as defined in C.S0005 section 3.7.5.5 */ /** CDMA Signal Information Record as defined in C.S0005 section 3.7.5.5 */
struct CdmaSignalInfoRecord { struct CdmaSignalInfoRecord {
bool isPresent; // true if signal information record is present bool isPresent; // true if signal information record is present
int8_t signalType; // as defined 3.7.5.5-1 int8_t signalType; // as defined 3.7.5.5-1
@ -1911,7 +1912,7 @@ struct CdmaCallWaiting {
CdmaCallWaitingNumberPlan numberPlan; CdmaCallWaitingNumberPlan numberPlan;
}; };
/* /**
* Display Info Rec as defined in C.S0005 section 3.7.5.1 * Display Info Rec as defined in C.S0005 section 3.7.5.1
* Extended Display Info Rec as defined in C.S0005 section 3.7.5.16 * Extended Display Info Rec as defined in C.S0005 section 3.7.5.16
* Note: the Extended Display info rec contains multiple records of the * Note: the Extended Display info rec contains multiple records of the
@ -1924,7 +1925,7 @@ struct CdmaDisplayInfoRecord {
string alphaBuf; // Max length = RadioConst:CDMA_ALPHA_INFO_BUFFER_LENGTH string alphaBuf; // Max length = RadioConst:CDMA_ALPHA_INFO_BUFFER_LENGTH
}; };
/* /**
* Called Party Number Info Rec as defined in C.S0005 section 3.7.5.2 * Called Party Number Info Rec as defined in C.S0005 section 3.7.5.2
* Calling Party Number Info Rec as defined in C.S0005 section 3.7.5.3 * Calling Party Number Info Rec as defined in C.S0005 section 3.7.5.3
* Connected Number Info Rec as defined in C.S0005 section 3.7.5.4 * Connected Number Info Rec as defined in C.S0005 section 3.7.5.4
@ -1942,7 +1943,7 @@ struct CdmaRedirectingNumberInfoRecord{
CdmaRedirectingReason redirectingReason; // redirectingReason is set to UNKNOWN if not included CdmaRedirectingReason redirectingReason; // redirectingReason is set to UNKNOWN if not included
}; };
/* Line Control Information Record as defined in C.S0005 section 3.7.5.15 */ /** Line Control Information Record as defined in C.S0005 section 3.7.5.15 */
struct CdmaLineControlInfoRecord { struct CdmaLineControlInfoRecord {
uint8_t lineCtrlPolarityIncluded; uint8_t lineCtrlPolarityIncluded;
uint8_t lineCtrlToggle; uint8_t lineCtrlToggle;
@ -1950,12 +1951,12 @@ struct CdmaLineControlInfoRecord {
uint8_t lineCtrlPowerDenial; uint8_t lineCtrlPowerDenial;
}; };
/* T53 CLIR Information Record */ /** T53 CLIR Information Record */
struct CdmaT53ClirInfoRecord { struct CdmaT53ClirInfoRecord {
uint8_t cause; uint8_t cause;
}; };
/* T53 Audio Control Information Record */ /** T53 Audio Control Information Record */
struct CdmaT53AudioControlInfoRecord { struct CdmaT53AudioControlInfoRecord {
uint8_t upLink; uint8_t upLink;
uint8_t downLink; uint8_t downLink;

6
radio/deprecated/1.0/IOemHookIndication.hal
View file

@ -18,15 +18,15 @@ package android.hardware.radio.deprecated@1.0;
import android.hardware.radio@1.0::types; import android.hardware.radio@1.0::types;
/* /**
* Interface declaring unsolicited oem hook indications. * Interface declaring unsolicited oem hook indications.
*/ */
interface IOemHookIndication { interface IOemHookIndication {
/* /**
* This is for OEM specific use. * This is for OEM specific use.
* *
* @param type Type of radio indication * @param type Type of radio indication
* @param data data passed as raw bytes * @param data data passed as raw bytes
*/ */
oneway oemHookRaw(RadioIndicationType type, vec<uint8_t> data); oneway oemHookRaw(RadioIndicationType type, vec<uint8_t> data);
}; };

8
radio/deprecated/1.0/IOemHookResponse.hal
View file

@ -18,13 +18,13 @@ package android.hardware.radio.deprecated@1.0;
import android.hardware.radio@1.0::types; import android.hardware.radio@1.0::types;
/* /**
* Interface declaring response functions to solicited oem hook requests. * Interface declaring response functions to solicited oem hook requests.
* Response functions defined in this interface are as per following convention: * Response functions defined in this interface are as per following convention:
* <xyz>Response is response to IOemHook.<xyz> * <xyz>Response is response to IOemHook.<xyz>
*/ */
interface IOemHookResponse { interface IOemHookResponse {
/* /**
* @param info Response info struct containing response type, serial no. and error * @param info Response info struct containing response type, serial no. and error
* @param data data returned by oem * @param data data returned by oem
* *
@ -36,7 +36,7 @@ interface IOemHookResponse {
*/ */
oneway sendRequestRawResponse(RadioResponseInfo info, vec<uint8_t> data); oneway sendRequestRawResponse(RadioResponseInfo info, vec<uint8_t> data);
/* /**
* @param info Response info struct containing response type, serial no. and error * @param info Response info struct containing response type, serial no. and error
* @param data data returned by oem * @param data data returned by oem
* *
@ -47,4 +47,4 @@ interface IOemHookResponse {
* RadioError:OEM_ERROR_X * RadioError:OEM_ERROR_X
*/ */
oneway sendRequestStringsResponse(RadioResponseInfo info, vec<string> data); oneway sendRequestStringsResponse(RadioResponseInfo info, vec<string> data);
}; };

152
renderscript/1.0/IContext.hal
View file

@ -32,7 +32,7 @@ import android.hardware.renderscript@1.0::types;
interface IContext { interface IContext {
/* /**
* TODO: Do we need to define "selectors"? It may be a property of the * TODO: Do we need to define "selectors"? It may be a property of the
* "adapted allocation" that's returned. * "adapted allocation" that's returned.
* *
@ -56,7 +56,7 @@ interface IContext {
allocationAdapterCreate(Type type, Allocation baseAlloc) allocationAdapterCreate(Type type, Allocation baseAlloc)
generates (AllocationAdapter subAlloc); generates (AllocationAdapter subAlloc);
/* /**
* TODO: Need to relate "offset" back to the terminology in * TODO: Need to relate "offset" back to the terminology in
* allocationAdapterCreate() -- the latter uses the terms "selector" and * allocationAdapterCreate() -- the latter uses the terms "selector" and
* "selected value". Can we use consistent terminology? Are "offset" and * "selected value". Can we use consistent terminology? Are "offset" and
@ -72,7 +72,7 @@ interface IContext {
@callflow(next={"*"}) @callflow(next={"*"})
allocationAdapterOffset(AllocationAdapter alloc, vec<uint32_t> offsets); allocationAdapterOffset(AllocationAdapter alloc, vec<uint32_t> offsets);
/* /**
* TODO: add more explanation here. * TODO: add more explanation here.
* *
* Returns the Type of the Allocation. * Returns the Type of the Allocation.
@ -83,7 +83,7 @@ interface IContext {
@callflow(next={"*"}) @callflow(next={"*"})
allocationGetType(Allocation allocation) generates (Type type); allocationGetType(Allocation allocation) generates (Type type);
/* /**
* TODO: more clarification needed describing if the pointer can be aliased * TODO: more clarification needed describing if the pointer can be aliased
* or if the data can outlive the allocation. * or if the data can outlive the allocation.
* *
@ -102,7 +102,7 @@ interface IContext {
bitfield<AllocationUsageType> usage, Ptr ptr) bitfield<AllocationUsageType> usage, Ptr ptr)
generates (Allocation allocation); generates (Allocation allocation);
/* /**
* Creates an Allocation from a Bitmap. * Creates an Allocation from a Bitmap.
* *
* @param type Type describing data layout * @param type Type describing data layout
@ -118,7 +118,7 @@ interface IContext {
bitfield<AllocationUsageType> usage) bitfield<AllocationUsageType> usage)
generates (Allocation allocation); generates (Allocation allocation);
/* /**
* Creates a Cubemapped Allocation from a Bitmap. * Creates a Cubemapped Allocation from a Bitmap.
* *
* @param type Type describing data layout * @param type Type describing data layout
@ -135,7 +135,7 @@ interface IContext {
bitfield<AllocationUsageType> usage) bitfield<AllocationUsageType> usage)
generates (Allocation allocation); generates (Allocation allocation);
/* /**
* Returns the handle to a raw buffer that is being managed by the screen * Returns the handle to a raw buffer that is being managed by the screen
* compositor. This operation is only valid for Allocations with * compositor. This operation is only valid for Allocations with
* USAGE_IO_INPUT. * USAGE_IO_INPUT.
@ -147,7 +147,7 @@ interface IContext {
allocationGetNativeWindow(Allocation allocation) allocationGetNativeWindow(Allocation allocation)
generates (NativeWindow nativeWindow); generates (NativeWindow nativeWindow);
/* /**
* TODO: more clarification needed * TODO: more clarification needed
* *
* Sets the NativeWindow of an Allocation. This operation is only valid * Sets the NativeWindow of an Allocation. This operation is only valid
@ -159,7 +159,7 @@ interface IContext {
@callflow(next={"*"}) @callflow(next={"*"})
allocationSetNativeWindow(Allocation allocation, NativeWindow nativewindow); allocationSetNativeWindow(Allocation allocation, NativeWindow nativewindow);
/* /**
* Initialize BufferQueue with specified max number of buffers. * Initialize BufferQueue with specified max number of buffers.
* *
* @param alloc Allocation * @param alloc Allocation
@ -168,7 +168,7 @@ interface IContext {
@callflow(next={"*"}) @callflow(next={"*"})
allocationSetupBufferQueue(Allocation alloc, uint32_t numBuffer); allocationSetupBufferQueue(Allocation alloc, uint32_t numBuffer);
/* /**
* TODO: clearly define baseAlloc vs subAlloc * TODO: clearly define baseAlloc vs subAlloc
* *
* Shares the BufferQueue with another Allocation. Both must be * Shares the BufferQueue with another Allocation. Both must be
@ -181,7 +181,7 @@ interface IContext {
@callflow(next={"*"}) @callflow(next={"*"})
allocationShareBufferQueue(Allocation baseAlloc, Allocation subAlloc); allocationShareBufferQueue(Allocation baseAlloc, Allocation subAlloc);
/* /**
* Copies from the Allocation into a Bitmap. The bitmap must match the * Copies from the Allocation into a Bitmap. The bitmap must match the
* dimensions of the Allocation. * dimensions of the Allocation.
* *
@ -195,7 +195,7 @@ interface IContext {
@callflow(next={"*"}) @callflow(next={"*"})
allocationCopyToBitmap(Allocation allocation, Ptr data, Size sizeBytes); allocationCopyToBitmap(Allocation allocation, Ptr data, Size sizeBytes);
/* /**
* TODO: should we consolidate all [123]DWrite functions or [123]DRead * TODO: should we consolidate all [123]DWrite functions or [123]DRead
* functions into the same API call? Our current plan is to be very similar * functions into the same API call? Our current plan is to be very similar
* to the dispatch table API. How much should we deviate from the original * to the dispatch table API. How much should we deviate from the original
@ -219,7 +219,7 @@ interface IContext {
allocation1DWrite(Allocation allocation, uint32_t offset, uint32_t lod, allocation1DWrite(Allocation allocation, uint32_t offset, uint32_t lod,
uint32_t count, vec<uint8_t> data); uint32_t count, vec<uint8_t> data);
/* /**
* Copies a value into a single sub-Element of this Allocation. * Copies a value into a single sub-Element of this Allocation.
* *
* @param allocation Allocation to be updated * @param allocation Allocation to be updated
@ -237,7 +237,7 @@ interface IContext {
uint32_t z, uint32_t lod, vec<uint8_t> data, uint32_t z, uint32_t lod, vec<uint8_t> data,
Size compIdx); Size compIdx);
/* /**
* Copies from an array into a rectangular region in this Allocation. * Copies from an array into a rectangular region in this Allocation.
* *
* When this HAL entry is executed, all Vec3 elements have been explicitly * When this HAL entry is executed, all Vec3 elements have been explicitly
@ -262,7 +262,7 @@ interface IContext {
uint32_t lod, AllocationCubemapFace face, uint32_t w, uint32_t lod, AllocationCubemapFace face, uint32_t w,
uint32_t h, vec<uint8_t> data, Size stride); uint32_t h, vec<uint8_t> data, Size stride);
/* /**
* Copies from an array into a 3D region in this Allocation. * Copies from an array into a 3D region in this Allocation.
* *
* When this HAL entry is executed, all Vec3 elements have been explicitly * When this HAL entry is executed, all Vec3 elements have been explicitly
@ -288,7 +288,7 @@ interface IContext {
uint32_t zoff, uint32_t lod, uint32_t w, uint32_t h, uint32_t zoff, uint32_t lod, uint32_t w, uint32_t h,
uint32_t d, vec<uint8_t> data, Size stride); uint32_t d, vec<uint8_t> data, Size stride);
/* /**
* Generates a mipmap chain. This is only valid if the Type of the * Generates a mipmap chain. This is only valid if the Type of the
* Allocation includes mipmaps. * Allocation includes mipmaps.
* *
@ -304,7 +304,7 @@ interface IContext {
@callflow(next={"*"}) @callflow(next={"*"})
allocationGenerateMipmaps(Allocation allocation); allocationGenerateMipmaps(Allocation allocation);
/* /**
* Copies all of an Allocation's data into an array. * Copies all of an Allocation's data into an array.
* *
* All Vec3 elements of an Allocation are padded to be Vec4, so the data * All Vec3 elements of an Allocation are padded to be Vec4, so the data
@ -320,7 +320,7 @@ interface IContext {
@callflow(next={"*"}) @callflow(next={"*"})
allocationRead(Allocation allocation, Ptr data, Size sizeBytes); allocationRead(Allocation allocation, Ptr data, Size sizeBytes);
/* /**
* Copies a 1D region of this Allocation into an array. * Copies a 1D region of this Allocation into an array.
* *
* All Vec3 elements of an Allocation are padded to be Vec4, so the data * All Vec3 elements of an Allocation are padded to be Vec4, so the data
@ -342,7 +342,7 @@ interface IContext {
allocation1DRead(Allocation allocation, uint32_t xoff, uint32_t lod, allocation1DRead(Allocation allocation, uint32_t xoff, uint32_t lod,
uint32_t count, Ptr data, Size sizeBytes); uint32_t count, Ptr data, Size sizeBytes);
/* /**
* Returns the value of a single sub-Element of this Allocation. * Returns the value of a single sub-Element of this Allocation.
* *
* HIDL is always running in Passthrough mode for RenderScript, so the * HIDL is always running in Passthrough mode for RenderScript, so the
@ -362,7 +362,7 @@ interface IContext {
uint32_t z, uint32_t lod, Ptr data, Size sizeBytes, uint32_t z, uint32_t lod, Ptr data, Size sizeBytes,
Size compIdx); Size compIdx);
/* /**
* Copies from a rectangular region in this Allocation to an array. * Copies from a rectangular region in this Allocation to an array.
* *
* All Vec3 elements of an Allocation are padded to be Vec4, so the data * All Vec3 elements of an Allocation are padded to be Vec4, so the data
@ -391,7 +391,7 @@ interface IContext {
uint32_t lod, AllocationCubemapFace face, uint32_t w, uint32_t lod, AllocationCubemapFace face, uint32_t w,
uint32_t h, Ptr data, Size sizeBytes, Size stride); uint32_t h, Ptr data, Size sizeBytes, Size stride);
/* /**
* Copies from a rectangular cuboid region in this Allocation to an array. * Copies from a rectangular cuboid region in this Allocation to an array.
* *
* All Vec3 elements of an Allocation are padded to be Vec4, so the data * All Vec3 elements of an Allocation are padded to be Vec4, so the data
@ -421,7 +421,7 @@ interface IContext {
uint32_t zoff, uint32_t lod, uint32_t w, uint32_t h, uint32_t zoff, uint32_t lod, uint32_t w, uint32_t h,
uint32_t d, Ptr data, Size sizeBytes, Size stride); uint32_t d, Ptr data, Size sizeBytes, Size stride);
/* /**
* Propagates changes from one usage of the Allocation to the other usages * Propagates changes from one usage of the Allocation to the other usages
* of the Allocation. * of the Allocation.
* *
@ -431,7 +431,7 @@ interface IContext {
@callflow(next={"*"}) @callflow(next={"*"})
allocationSyncAll(Allocation allocation, AllocationUsageType usageType); allocationSyncAll(Allocation allocation, AllocationUsageType usageType);
/* /**
* TODO: describe the functionality of resize1D better * TODO: describe the functionality of resize1D better
* TODO: original Java Doc description seems to contradict itself ("with * TODO: original Java Doc description seems to contradict itself ("with
* null contents and the region is otherwise undefined") * null contents and the region is otherwise undefined")
@ -455,7 +455,7 @@ interface IContext {
@callflow(next={"*"}) @callflow(next={"*"})
allocationResize1D(Allocation allocation, uint32_t dimX); allocationResize1D(Allocation allocation, uint32_t dimX);
/* /**
* TODO: There are allocationCopy2DRange and 3DRange, but no 1DRange. Should * TODO: There are allocationCopy2DRange and 3DRange, but no 1DRange. Should
* the interface be cleaned up more? * the interface be cleaned up more?
* *
@ -483,7 +483,7 @@ interface IContext {
uint32_t srcXoff, uint32_t srcYoff, uint32_t srcMip, uint32_t srcXoff, uint32_t srcYoff, uint32_t srcMip,
AllocationCubemapFace srcFace); AllocationCubemapFace srcFace);
/* /**
* Copies a rectangular cuboid region into the allocation from another * Copies a rectangular cuboid region into the allocation from another
* Allocation. * Allocation.
* *
@ -508,7 +508,7 @@ interface IContext {
Allocation srcAlloc, uint32_t srcXoff, Allocation srcAlloc, uint32_t srcXoff,
uint32_t srcYoff, uint32_t srcZoff, uint32_t srcMip); uint32_t srcYoff, uint32_t srcZoff, uint32_t srcMip);
/* /**
* TODO: define buffer and output stream * TODO: define buffer and output stream
* *
* Sends a buffer to the output stream. The contents of the Allocation may * Sends a buffer to the output stream. The contents of the Allocation may
@ -520,7 +520,7 @@ interface IContext {
@callflow(next={"*"}) @callflow(next={"*"})
allocationIoSend(Allocation allocation); allocationIoSend(Allocation allocation);
/* /**
* Receives the latest input into the Allocation. This operation is only * Receives the latest input into the Allocation. This operation is only
* valid if USAGE_IO_INPUT is set on the Allocation, otherwise an error * valid if USAGE_IO_INPUT is set on the Allocation, otherwise an error
* must be reported and no operations may be executed. * must be reported and no operations may be executed.
@ -530,7 +530,7 @@ interface IContext {
@callflow(next={"*"}) @callflow(next={"*"})
allocationIoReceive(Allocation allocation); allocationIoReceive(Allocation allocation);
/* /**
* TODO: describe default values for lod, face, and z better. * TODO: describe default values for lod, face, and z better.
* TODO: what cases can invalidate the pointer? Resize? It should be * TODO: what cases can invalidate the pointer? Resize? It should be
* clarified that this method should always return a valid pointer, but the * clarified that this method should always return a valid pointer, but the
@ -560,7 +560,7 @@ interface IContext {
AllocationCubemapFace face, uint32_t z) AllocationCubemapFace face, uint32_t z)
generates (Ptr dataPtr, Size stride); generates (Ptr dataPtr, Size stride);
/* /**
* Retrieves an Element's metadata from native code. * Retrieves an Element's metadata from native code.
* *
* @param element Element to be read * @param element Element to be read
@ -570,7 +570,7 @@ interface IContext {
elementGetNativeMetadata(Element element) elementGetNativeMetadata(Element element)
generates (vec<uint32_t> elemData); generates (vec<uint32_t> elemData);
/* /**
* TODO: define Sub-Element handles better. * TODO: define Sub-Element handles better.
* *
* Retrieves an Element's sub Elements, specifically their identifiers, * Retrieves an Element's sub Elements, specifically their identifiers,
@ -587,7 +587,7 @@ interface IContext {
generates (vec<Element> ids, vec<string> names, generates (vec<Element> ids, vec<string> names,
vec<Size> arraySizes); vec<Size> arraySizes);
/* /**
* TODO: can normalization flag be removed? * TODO: can normalization flag be removed?
* *
* Creates an Element. * Creates an Element.
@ -602,7 +602,7 @@ interface IContext {
elementCreate(DataType dt, DataKind dk, bool norm, uint32_t size) elementCreate(DataType dt, DataKind dk, bool norm, uint32_t size)
generates (Element element); generates (Element element);
/* /**
* Creates a complex Element. * Creates a complex Element.
* *
* @param einsPtr Container of input Elements * @param einsPtr Container of input Elements
@ -615,7 +615,7 @@ interface IContext {
vec<Size> arraySizesPtr) vec<Size> arraySizesPtr)
generates (Element element); generates (Element element);
/* /**
* Retrives a Type's metadata from native code. * Retrives a Type's metadata from native code.
* *
* @param type Type describing data layout * @param type Type describing data layout
@ -624,7 +624,7 @@ interface IContext {
@callflow(next={"*"}) @callflow(next={"*"})
typeGetNativeMetadata(Type type) generates (vec<OpaqueHandle> metadata); typeGetNativeMetadata(Type type) generates (vec<OpaqueHandle> metadata);
/* /**
* Creates a new Type. * Creates a new Type.
* *
* If Type is 1D, Y and Z must be 0. If Type is 2D, Z must be 0. * If Type is 1D, Y and Z must be 0. If Type is 2D, Z must be 0.
@ -644,14 +644,14 @@ interface IContext {
bool mipmaps, bool faces, YuvFormat yuv) bool mipmaps, bool faces, YuvFormat yuv)
generates (Type type); generates (Type type);
/* /**
* Destroys provided RenderScript context, including all objects created in * Destroys provided RenderScript context, including all objects created in
* this context. * this context.
*/ */
@exit @exit
contextDestroy(); contextDestroy();
/* /**
* TODO: provide overview of messaging model and figure out if this should * TODO: provide overview of messaging model and figure out if this should
* be part of HAL or not. * be part of HAL or not.
* TODO: what is the "client" for purposes of this interface? * TODO: what is the "client" for purposes of this interface?
@ -671,7 +671,7 @@ interface IContext {
contextGetMessage(Ptr data, Size size) contextGetMessage(Ptr data, Size size)
generates (MessageToClientType messageType, Size receiveLen); generates (MessageToClientType messageType, Size receiveLen);
/* /**
* TODO: define subID better. * TODO: define subID better.
* *
* Gets the metadata of a message to ensure entire message can be properly * Gets the metadata of a message to ensure entire message can be properly
@ -687,7 +687,7 @@ interface IContext {
generates (MessageToClientType messageType, Size receiveLen, generates (MessageToClientType messageType, Size receiveLen,
uint32_t subID); uint32_t subID);
/* /**
* TODO: Define "previous commands" better * TODO: Define "previous commands" better
* TODO: Is the message identifier the same as subID? * TODO: Is the message identifier the same as subID?
* *
@ -702,7 +702,7 @@ interface IContext {
@callflow(next={"*"}) @callflow(next={"*"})
contextSendMessage(uint32_t id, vec<uint8_t> data); contextSendMessage(uint32_t id, vec<uint8_t> data);
/* /**
* TODO: Can this be done automatically as part of context creation? What * TODO: Can this be done automatically as part of context creation? What
* happens if we perform message operations before doing this? * happens if we perform message operations before doing this?
* *
@ -713,7 +713,7 @@ interface IContext {
@callflow(next={"*"}) @callflow(next={"*"})
contextInitToClient(); contextInitToClient();
/* /**
* TODO: Why doesn't this happen automatically as part of context * TODO: Why doesn't this happen automatically as part of context
* destruction? What happens if the FIFO is not empty? * destruction? What happens if the FIFO is not empty?
* *
@ -722,7 +722,7 @@ interface IContext {
@callflow(next={"*"}) @callflow(next={"*"})
contextDeinitToClient(); contextDeinitToClient();
/* /**
* TODO: do we need to mark asynchronous operations in this interface * TODO: do we need to mark asynchronous operations in this interface
* definition? * definition?
* *
@ -732,14 +732,14 @@ interface IContext {
@callflow(next={"*"}) @callflow(next={"*"})
contextFinish(); contextFinish();
/* /**
* Prints the currently available debugging information about the state of * Prints the currently available debugging information about the state of
* the RS context to the logcat. * the RS context to the logcat.
*/ */
@callflow(next={"*"}) @callflow(next={"*"})
contextLog(); contextLog();
/* /**
* TODO: full path? relative path? Investigate further. * TODO: full path? relative path? Investigate further.
* *
* Sets the cache directory of the context. * Sets the cache directory of the context.
@ -749,7 +749,7 @@ interface IContext {
@callflow(next={"*"}) @callflow(next={"*"})
contextSetCacheDir(string cacheDir); contextSetCacheDir(string cacheDir);
/* /**
* TODO: does this apply to the GPU as well? * TODO: does this apply to the GPU as well?
* *
* Changes the priority of the cpu worker threads for this context. * Changes the priority of the cpu worker threads for this context.
@ -759,7 +759,7 @@ interface IContext {
@callflow(next={"*"}) @callflow(next={"*"})
contextSetPriority(ThreadPriorities priority); contextSetPriority(ThreadPriorities priority);
/* /**
* TODO: does this need to be part of the HAL? What if the object already * TODO: does this need to be part of the HAL? What if the object already
* has a name? * has a name?
* *
@ -771,7 +771,7 @@ interface IContext {
@callflow(next={"*"}) @callflow(next={"*"})
assignName(ObjectBase obj, string name); assignName(ObjectBase obj, string name);
/* /**
* TODO: what if the object has no name? * TODO: what if the object has no name?
* *
* Returns the name of an object. * Returns the name of an object.
@ -782,7 +782,7 @@ interface IContext {
@callflow(next={"*"}) @callflow(next={"*"})
getName(ObjectBase obj) generates (string name); getName(ObjectBase obj) generates (string name);
/* /**
* TODO: starting here we have a set of interfaces for use with * TODO: starting here we have a set of interfaces for use with
* ScriptGroups. At the very least we should indicate for each one that's * ScriptGroups. At the very least we should indicate for each one that's
* what it's for. Should we include ScriptGroup in the interface names? * what it's for. Should we include ScriptGroup in the interface names?
@ -810,7 +810,7 @@ interface IContext {
vec<ScriptFieldID> depFieldIDS) vec<ScriptFieldID> depFieldIDS)
generates (Closure closure); generates (Closure closure);
/* /**
* Creates a Closure which represents a function call to a invocable * Creates a Closure which represents a function call to a invocable
* function, combined with arguments and values for global variables. * function, combined with arguments and values for global variables.
* *
@ -827,7 +827,7 @@ interface IContext {
vec<int32_t> sizes) vec<int32_t> sizes)
generates (Closure closure); generates (Closure closure);
/* /**
* Sets the argument of a Closure at specified index and size to provided * Sets the argument of a Closure at specified index and size to provided
* value. * value.
* *
@ -839,7 +839,7 @@ interface IContext {
@callflow(next={"*"}) @callflow(next={"*"})
closureSetArg(Closure closure, uint32_t index, Ptr value, int32_t size); closureSetArg(Closure closure, uint32_t index, Ptr value, int32_t size);
/* /**
* Sets a global variable in a Closure. * Sets a global variable in a Closure.
* *
* @param closure Closure * @param closure Closure
@ -851,7 +851,7 @@ interface IContext {
closureSetGlobal(Closure closure, ScriptFieldID fieldID, int64_t value, closureSetGlobal(Closure closure, ScriptFieldID fieldID, int64_t value,
int32_t size); int32_t size);
/* /**
* TODO: should slot be unsigned? (applies to other two ID interfaces, too) * TODO: should slot be unsigned? (applies to other two ID interfaces, too)
* *
* Creates a Script Kernel ID. * Creates a Script Kernel ID.
@ -866,7 +866,7 @@ interface IContext {
bitfield<MetadataSignatureBitval> sig) bitfield<MetadataSignatureBitval> sig)
generates (ScriptKernelID scriptKernelID); generates (ScriptKernelID scriptKernelID);
/* /**
* Creates a Script Invoke ID. * Creates a Script Invoke ID.
* *
* @param script Script * @param script Script
@ -877,7 +877,7 @@ interface IContext {
scriptInvokeIDCreate(Script script, int32_t slot) scriptInvokeIDCreate(Script script, int32_t slot)
generates (ScriptInvokeID scriptInvokeID); generates (ScriptInvokeID scriptInvokeID);
/* /**
* TODO: describe the return value better. What is it? * TODO: describe the return value better. What is it?
* *
* Creates a Script Field ID. * Creates a Script Field ID.
@ -890,7 +890,7 @@ interface IContext {
scriptFieldIDCreate(Script script, int32_t slot) scriptFieldIDCreate(Script script, int32_t slot)
generates (ScriptFieldID scriptFieldID); generates (ScriptFieldID scriptFieldID);
/* /**
* TODO: add more description * TODO: add more description
* *
* Creates a Script Group. * Creates a Script Group.
@ -908,7 +908,7 @@ interface IContext {
vec<Type> types) vec<Type> types)
generates (ScriptGroup scriptGroup); generates (ScriptGroup scriptGroup);
/* /**
* Creates a Script Group. * Creates a Script Group.
* *
* @param name Name * @param name Name
@ -920,7 +920,7 @@ interface IContext {
scriptGroup2Create(string name, string cacheDir, vec<Closure> closures) scriptGroup2Create(string name, string cacheDir, vec<Closure> closures)
generates (ScriptGroup2 scriptGroup2); generates (ScriptGroup2 scriptGroup2);
/* /**
* TODO: if SetInput/Output corresponds to the Java API setInput() and * TODO: if SetInput/Output corresponds to the Java API setInput() and
* setOutput(), which are documented as deprecated in API 23, do we need to * setOutput(), which are documented as deprecated in API 23, do we need to
* support them? Or can we fallback to the CPU when they're used? Or can't * support them? Or can we fallback to the CPU when they're used? Or can't
@ -937,7 +937,7 @@ interface IContext {
@callflow(next={"*"}) @callflow(next={"*"})
scriptGroupSetOutput(ScriptGroup sg, ScriptKernelID kid, Allocation alloc); scriptGroupSetOutput(ScriptGroup sg, ScriptKernelID kid, Allocation alloc);
/* /**
* Sets an input of the Script Group. This specifies an Allocation to be * Sets an input of the Script Group. This specifies an Allocation to be
* used for kernels that require an input Allocation provided from outside * used for kernels that require an input Allocation provided from outside
* of the Script Group. * of the Script Group.
@ -949,7 +949,7 @@ interface IContext {
@callflow(next={"*"}) @callflow(next={"*"})
scriptGroupSetInput(ScriptGroup sg, ScriptKernelID kid, Allocation alloc); scriptGroupSetInput(ScriptGroup sg, ScriptKernelID kid, Allocation alloc);
/* /**
* Executes a Script Group. * Executes a Script Group.
* *
* @param sg Script Group to be executed. * @param sg Script Group to be executed.
@ -957,7 +957,7 @@ interface IContext {
@callflow(next={"*"}) @callflow(next={"*"})
scriptGroupExecute( ScriptGroup sg); scriptGroupExecute( ScriptGroup sg);
/* /**
* Frees any native resources associated with this object. The primary use * Frees any native resources associated with this object. The primary use
* is to force immediate cleanup of resources when it is believed the GC * is to force immediate cleanup of resources when it is believed the GC
* may not respond quickly enough. * may not respond quickly enough.
@ -967,7 +967,7 @@ interface IContext {
@callflow(next={"*"}) @callflow(next={"*"})
objDestroy(ObjectBase obj); objDestroy(ObjectBase obj);
/* /**
* Creates a Sampler. * Creates a Sampler.
* *
* @param magFilter Magnification value for the filter * @param magFilter Magnification value for the filter
@ -984,7 +984,7 @@ interface IContext {
float aniso) float aniso)
generates (Sampler sampler); generates (Sampler sampler);
/* /**
* Binds an Allocation to a global pointer in the Script. * Binds an Allocation to a global pointer in the Script.
* *
* @param script Script to be bound to * @param script Script to be bound to
@ -994,7 +994,7 @@ interface IContext {
@callflow(next={"*"}) @callflow(next={"*"})
scriptBindAllocation(Script script, Allocation allocation, uint32_t slot); scriptBindAllocation(Script script, Allocation allocation, uint32_t slot);
/* /**
* TODO: is this necessary? * TODO: is this necessary?
* *
* Sets the timezone of a Script. * Sets the timezone of a Script.
@ -1005,7 +1005,7 @@ interface IContext {
@callflow(next={"*"}) @callflow(next={"*"})
scriptSetTimeZone(Script script, string timeZone); scriptSetTimeZone(Script script, string timeZone);
/* /**
* TODO: can scriptInvoke be combined with scriptInvokeV? * TODO: can scriptInvoke be combined with scriptInvokeV?
* *
* Launches an invokable function. * Launches an invokable function.
@ -1016,7 +1016,7 @@ interface IContext {
@callflow(next={"*"}) @callflow(next={"*"})
scriptInvoke(Script vs, uint32_t slot); scriptInvoke(Script vs, uint32_t slot);
/* /**
* Invokes a Script with values. * Invokes a Script with values.
* *
* @param vs Script to be invoked * @param vs Script to be invoked
@ -1026,7 +1026,7 @@ interface IContext {
@callflow(next={"*"}) @callflow(next={"*"})
scriptInvokeV(Script vs, uint32_t slot, vec<uint8_t> data); scriptInvokeV(Script vs, uint32_t slot, vec<uint8_t> data);
/* /**
* TODO: add documentation for params * TODO: add documentation for params
* TODO: Should we rename "ScriptCall" to "LaunchOptions"? * TODO: Should we rename "ScriptCall" to "LaunchOptions"?
* *
@ -1043,7 +1043,7 @@ interface IContext {
scriptForEach(Script vs, uint32_t slot, vec<Allocation> vains, scriptForEach(Script vs, uint32_t slot, vec<Allocation> vains,
Allocation vaout, vec<uint8_t> params, Ptr sc); Allocation vaout, vec<uint8_t> params, Ptr sc);
/* /**
* Launches a Reduction kernel. * Launches a Reduction kernel.
* *
* @param vs Script * @param vs Script
@ -1056,7 +1056,7 @@ interface IContext {
scriptReduce(Script vs, uint32_t slot, vec<Allocation> vains, scriptReduce(Script vs, uint32_t slot, vec<Allocation> vains,
Allocation vaout, Ptr sc); Allocation vaout, Ptr sc);
/* /**
* Sets a Script's integer variable to a value. * Sets a Script's integer variable to a value.
* *
* @param vs RenderScript Script * @param vs RenderScript Script
@ -1066,7 +1066,7 @@ interface IContext {
@callflow(next={"*"}) @callflow(next={"*"})
scriptSetVarI(Script vs, uint32_t slot, int32_t value); scriptSetVarI(Script vs, uint32_t slot, int32_t value);
/* /**
* Sets a Script's Object variable to a value * Sets a Script's Object variable to a value
* *
* @param vs RenderScript Script * @param vs RenderScript Script
@ -1076,7 +1076,7 @@ interface IContext {
@callflow(next={"*"}) @callflow(next={"*"})
scriptSetVarObj( Script vs, uint32_t slot, ObjectBase obj); scriptSetVarObj( Script vs, uint32_t slot, ObjectBase obj);
/* /**
* Sets a Script's long variable to a value. * Sets a Script's long variable to a value.
* *
* @param vs RenderScript Script * @param vs RenderScript Script
@ -1086,7 +1086,7 @@ interface IContext {
@callflow(next={"*"}) @callflow(next={"*"})
scriptSetVarJ(Script vs, uint32_t slot, int64_t value); scriptSetVarJ(Script vs, uint32_t slot, int64_t value);
/* /**
* Sets a Script's float variable to a value. * Sets a Script's float variable to a value.
* *
* @param vs RenderScript Script * @param vs RenderScript Script
@ -1096,7 +1096,7 @@ interface IContext {
@callflow(next={"*"}) @callflow(next={"*"})
scriptSetVarF(Script vs, uint32_t slot, float value); scriptSetVarF(Script vs, uint32_t slot, float value);
/* /**
* Sets a Script's double variable to a value. * Sets a Script's double variable to a value.
* *
* @param vs RenderScript Script * @param vs RenderScript Script
@ -1106,7 +1106,7 @@ interface IContext {
@callflow(next={"*"}) @callflow(next={"*"})
scriptSetVarD(Script vs, uint32_t slot, double value); scriptSetVarD(Script vs, uint32_t slot, double value);
/* /**
* Sets a Script's struct variable to a value. * Sets a Script's struct variable to a value.
* *
* @param vs RenderScript Script * @param vs RenderScript Script
@ -1116,7 +1116,7 @@ interface IContext {
@callflow(next={"*"}) @callflow(next={"*"})
scriptSetVarV(Script vs, uint32_t slot, vec<uint8_t> data); scriptSetVarV(Script vs, uint32_t slot, vec<uint8_t> data);
/* /**
* TODO: Why do we have typed setters but only untyped getter? * TODO: Why do we have typed setters but only untyped getter?
* *
* Retrieves the value from a global variable in a script. * Retrieves the value from a global variable in a script.
@ -1130,7 +1130,7 @@ interface IContext {
scriptGetVarV(Script vs, uint32_t slot, Size len) scriptGetVarV(Script vs, uint32_t slot, Size len)
generates (vec<uint8_t> data); generates (vec<uint8_t> data);
/* /**
* TODO: Is this a value to be replicated for each member of the array? Or * TODO: Is this a value to be replicated for each member of the array? Or
* is there a representation for each separate member? * is there a representation for each separate member?
* *
@ -1147,7 +1147,7 @@ interface IContext {
scriptSetVarVE(Script vs, uint32_t slot, vec<uint8_t> data, Element ve, scriptSetVarVE(Script vs, uint32_t slot, vec<uint8_t> data, Element ve,
vec<uint32_t> dims); vec<uint32_t> dims);
/* /**
* TODO: is cacheDir redundant with createCache() function? Can we remove * TODO: is cacheDir redundant with createCache() function? Can we remove
* it? * it?
* TODO: define resName more clearly * TODO: define resName more clearly
@ -1163,7 +1163,7 @@ interface IContext {
scriptCCreate(string resName, string cacheDir, vec<uint8_t> text) scriptCCreate(string resName, string cacheDir, vec<uint8_t> text)
generates (Script script); generates (Script script);
/* /**
* Creates a RenderScript Intrinsic script. * Creates a RenderScript Intrinsic script.
* *
* @param id Intrinsic Script identifier * @param id Intrinsic Script identifier

2
renderscript/1.0/IDevice.hal
View file

@ -21,7 +21,7 @@ import IContext;
interface IDevice { interface IDevice {
/* /**
* Creates a RenderScript context. * Creates a RenderScript context.
* *
* @param sdkVersion Target RS API level * @param sdkVersion Target RS API level

2
tests/baz/1.0/IBase.hal
View file

@ -38,7 +38,7 @@ interface IBase {
}; };
struct MoreThanOneArrayField { struct MoreThanOneArrayField {
/* /**
* Generated (Java) code used to redeclare the same variable name * Generated (Java) code used to redeclare the same variable name
* multiple times in the same scope, this test ensures that that's no * multiple times in the same scope, this test ensures that that's no
* longer the case. * longer the case.

2
tests/baz/1.0/types.hal
View file

@ -16,7 +16,7 @@
package android.hardware.tests.baz@1.0; package android.hardware.tests.baz@1.0;
/* /**
* Verify that introducing a typedef in types.hal does not mistakenly emit * Verify that introducing a typedef in types.hal does not mistakenly emit
* a makefile section to create a dedicated ulong.java class as it used to. * a makefile section to create a dedicated ulong.java class as it used to.
*/ */

14
tests/msgq/1.0/IBenchmarkMsgQ.hal
View file

@ -17,7 +17,7 @@
package android.hardware.tests.msgq@1.0; package android.hardware.tests.msgq@1.0;
interface IBenchmarkMsgQ { interface IBenchmarkMsgQ {
/* /**
* This method requests the service to set up Synchronous read/write * This method requests the service to set up Synchronous read/write
* wait-free FMQ with the client as reader. * wait-free FMQ with the client as reader.
* @return ret Will be true if the setup was successful, false otherwise. * @return ret Will be true if the setup was successful, false otherwise.
@ -27,7 +27,7 @@ interface IBenchmarkMsgQ {
configureClientInboxSyncReadWrite() configureClientInboxSyncReadWrite()
generates(bool ret, fmq_sync<uint8_t> mqDescIn); generates(bool ret, fmq_sync<uint8_t> mqDescIn);
/* /**
* This method requests the service to set up Synchronous read/write * This method requests the service to set up Synchronous read/write
* wait-free FMQ with the client as writer. * wait-free FMQ with the client as writer.
* @return ret Will be true if the setup was successful, false otherwise. * @return ret Will be true if the setup was successful, false otherwise.
@ -37,7 +37,7 @@ interface IBenchmarkMsgQ {
configureClientOutboxSyncReadWrite() configureClientOutboxSyncReadWrite()
generates(bool ret, fmq_sync<uint8_t> mqDescOut); generates(bool ret, fmq_sync<uint8_t> mqDescOut);
/* /**
* This method request the service to write into the FMQ. * This method request the service to write into the FMQ.
* @param count Number to messages to write. * @param count Number to messages to write.
* @return ret Will be true if the write operation was successful, * @return ret Will be true if the write operation was successful,
@ -45,14 +45,14 @@ interface IBenchmarkMsgQ {
*/ */
requestWrite(int32_t count) generates (bool ret); requestWrite(int32_t count) generates (bool ret);
/* /**
* This method request the service to read from the FMQ. * This method request the service to read from the FMQ.
* @param count Number to messages to read. * @param count Number to messages to read.
* @ret Will be true if the read operation was successful, false otherwise. * @ret Will be true if the read operation was successful, false otherwise.
*/ */
requestRead(int32_t count) generates (bool ret); requestRead(int32_t count) generates (bool ret);
/* /**
* This method kicks off a benchmarking experiment where * This method kicks off a benchmarking experiment where
* the client writes a message into its outbox FMQ, * the client writes a message into its outbox FMQ,
* the service reads it and writes it into the client's * the service reads it and writes it into the client's
@ -62,14 +62,14 @@ interface IBenchmarkMsgQ {
*/ */
benchmarkPingPong(uint32_t numIter); benchmarkPingPong(uint32_t numIter);
/* /**
* This method kicks off a benchmarking experiment where * This method kicks off a benchmarking experiment where
* the service writes into an FMQ and the client reads the same. * the service writes into an FMQ and the client reads the same.
* @param numIter The number of iterations to run the experiment. * @param numIter The number of iterations to run the experiment.
*/ */
benchmarkServiceWriteClientRead(uint32_t numIter); benchmarkServiceWriteClientRead(uint32_t numIter);
/* /**
* This method sends a vector of time duration(in ns). * This method sends a vector of time duration(in ns).
* @param timeData vector of time instants measured by client. * @param timeData vector of time instants measured by client.
* Each entry is the number of ns between the epoch and a * Each entry is the number of ns between the epoch and a

18
tests/msgq/1.0/ITestMsgQ.hal
View file

@ -22,7 +22,7 @@ interface ITestMsgQ {
FMQ_NOT_FULL = 1 << 1, FMQ_NOT_FULL = 1 << 1,
}; };
/* /**
* This method requests the service to set up a synchronous read/write * This method requests the service to set up a synchronous read/write
* wait-free FMQ with the client as reader. * wait-free FMQ with the client as reader.
* *
@ -33,7 +33,7 @@ interface ITestMsgQ {
configureFmqSyncReadWrite() configureFmqSyncReadWrite()
generates(bool ret, fmq_sync<uint16_t> mqDesc); generates(bool ret, fmq_sync<uint16_t> mqDesc);
/* /**
* This method requests the service to return an MQDescriptor to * This method requests the service to return an MQDescriptor to
* an unsynchronized FMQ set up by the server. If 'configureFmq' is * an unsynchronized FMQ set up by the server. If 'configureFmq' is
* true, then the server sets up a new unsynchronized FMQ. This * true, then the server sets up a new unsynchronized FMQ. This
@ -48,7 +48,7 @@ interface ITestMsgQ {
*/ */
getFmqUnsyncWrite(bool configureFmq) generates(bool ret, fmq_unsync<uint16_t> mqDesc); getFmqUnsyncWrite(bool configureFmq) generates(bool ret, fmq_unsync<uint16_t> mqDesc);
/* /**
* This method request the service to write into the synchronized read/write * This method request the service to write into the synchronized read/write
* flavor of the FMQ. * flavor of the FMQ.
* *
@ -58,7 +58,7 @@ interface ITestMsgQ {
*/ */
requestWriteFmqSync(int32_t count) generates(bool ret); requestWriteFmqSync(int32_t count) generates(bool ret);
/* /**
* This method request the service to read from the synchronized read/write * This method request the service to read from the synchronized read/write
* FMQ. * FMQ.
* *
@ -68,7 +68,7 @@ interface ITestMsgQ {
*/ */
requestReadFmqSync(int32_t count) generates(bool ret); requestReadFmqSync(int32_t count) generates(bool ret);
/* /**
* This method request the service to write into the unsynchronized flavor * This method request the service to write into the unsynchronized flavor
* of FMQ. * of FMQ.
* *
@ -78,7 +78,7 @@ interface ITestMsgQ {
*/ */
requestWriteFmqUnsync(int32_t count) generates(bool ret); requestWriteFmqUnsync(int32_t count) generates(bool ret);
/* /**
* This method request the service to read from the unsynchronized flavor of * This method request the service to read from the unsynchronized flavor of
* FMQ. * FMQ.
* *
@ -88,7 +88,7 @@ interface ITestMsgQ {
*/ */
requestReadFmqUnsync(int32_t count) generates(bool ret); requestReadFmqUnsync(int32_t count) generates(bool ret);
/* /**
* This method requests the service to trigger a blocking read. * This method requests the service to trigger a blocking read.
* *
* @param count Number of messages to read. * @param count Number of messages to read.
@ -96,7 +96,7 @@ interface ITestMsgQ {
*/ */
oneway requestBlockingRead(int32_t count); oneway requestBlockingRead(int32_t count);
/* /**
* This method requests the service to trigger a blocking read using * This method requests the service to trigger a blocking read using
* default Event Flag notification bits defined by the MessageQueue class. * default Event Flag notification bits defined by the MessageQueue class.
* *
@ -105,7 +105,7 @@ interface ITestMsgQ {
*/ */
oneway requestBlockingReadDefaultEventFlagBits(int32_t count); oneway requestBlockingReadDefaultEventFlagBits(int32_t count);
/* /**
* This method requests the service to repeatedly trigger blocking reads. * This method requests the service to repeatedly trigger blocking reads.
* *
* @param count Number of messages to read in a single blocking read. * @param count Number of messages to read in a single blocking read.

28
wifi/1.0/types.hal
View file

@ -589,10 +589,10 @@ enum StaRoamingState : uint8_t {
* Size limits for parameters used in the NAN interface. * Size limits for parameters used in the NAN interface.
*/ */
enum NanParamSizeLimits : uint32_t { enum NanParamSizeLimits : uint32_t {
/* Minimum length of Passphrase argument for data-path configuration */ /** Minimum length of Passphrase argument for data-path configuration */
MIN_PASSPHRASE_LENGTH = 8, MIN_PASSPHRASE_LENGTH = 8,
/* Maximum length of Passphrase argument for data-path configuration */ /** Maximum length of Passphrase argument for data-path configuration */
MAX_PASSPHRASE_LENGTH = 63, MAX_PASSPHRASE_LENGTH = 63,
}; };
@ -607,29 +607,29 @@ typedef uint16_t CommandIdShort;
*/ */
enum NanStatusType : uint32_t { enum NanStatusType : uint32_t {
SUCCESS = 0, SUCCESS = 0,
/* NAN Discovery Engine/Host driver failures */ /** NAN Discovery Engine/Host driver failures */
INTERNAL_FAILURE = 1, INTERNAL_FAILURE = 1,
/* NAN OTA failures */ /** NAN OTA failures */
PROTOCOL_FAILURE = 2, PROTOCOL_FAILURE = 2,
/* The publish/subscribe discovery session id is invalid */ /** The publish/subscribe discovery session id is invalid */
INVALID_SESSION_ID = 3, INVALID_SESSION_ID = 3,
/* Out of resources to fufill request */ /** Out of resources to fufill request */
NO_RESOURCES_AVAILABLE = 4, NO_RESOURCES_AVAILABLE = 4,
/* Invalid arguments passed */ /** Invalid arguments passed */
INVALID_ARGS = 5, INVALID_ARGS = 5,
/* Invalid peer id */ /** Invalid peer id */
INVALID_PEER_ID = 6, INVALID_PEER_ID = 6,
/* Invalid NAN data-path (ndp) id */ /** Invalid NAN data-path (ndp) id */
INVALID_NDP_ID = 7, INVALID_NDP_ID = 7,
/* Attempting to enable NAN when not available, e.g. wifi is disabled */ /** Attempting to enable NAN when not available, e.g. wifi is disabled */
NAN_NOT_ALLOWED = 8, NAN_NOT_ALLOWED = 8,
/* Over the air ACK not received */ /** Over the air ACK not received */
NO_OTA_ACK = 9, NO_OTA_ACK = 9,
/* Attempting to enable NAN when already enabled */ /** Attempting to enable NAN when already enabled */
ALREADY_ENABLED = 10, ALREADY_ENABLED = 10,
/* Can't queue tx followup message foor transmission */ /** Can't queue tx followup message foor transmission */
FOLLOWUP_TX_QUEUE_FULL = 11, FOLLOWUP_TX_QUEUE_FULL = 11,
/* Unsupported concurrency of NAN and another feature - NAN disabled */ /** Unsupported concurrency of NAN and another feature - NAN disabled */
UNSUPPORTED_CONCURRENCY_NAN_DISABLED = 12 UNSUPPORTED_CONCURRENCY_NAN_DISABLED = 12
}; };