From 600160285345c0c207d6924d8a1c7d6ed1b5345e Mon Sep 17 00:00:00 2001 From: Anthony Stange Date: Mon, 11 Jan 2021 15:53:30 -0500 Subject: [PATCH] Update Contexthub HAL 1.0 doc format The HAL 1.0 docs are using the incorrect format for HALs. Update them to match what is now used in 1.1/1.2. Fixes: 177248013 Test: presubmits Change-Id: If5bdac0cec9e271ba6b79ecc10f4b3a93aff040c --- contexthub/1.0/IContexthub.hal | 20 ++++++++++---------- contexthub/1.0/IContexthubCallback.hal | 25 ++++++++++++------------- current.txt | 2 ++ 3 files changed, 24 insertions(+), 23 deletions(-) diff --git a/contexthub/1.0/IContexthub.hal b/contexthub/1.0/IContexthub.hal index 8dccd67276..950e081326 100644 --- a/contexthub/1.0/IContexthub.hal +++ b/contexthub/1.0/IContexthub.hal @@ -41,7 +41,7 @@ interface IContexthub { * registration. * * @param hubId identifier for the hub - * callback an implementation of the IContextHubCallbacks + * @param callback an implementation of the IContextHubCallbacks * * @return result OK on success * BAD_VALUE if parameters are not sane @@ -53,7 +53,7 @@ interface IContexthub { * Send a message to a hub * * @param hubId identifier for hub to send message to - * msg message to be sent + * @param msg message to be sent * * @return result OK if successful, error code otherwise * BAD_VALUE if parameters are not sane @@ -77,9 +77,9 @@ interface IContexthub { * device. * * @param hubId identifer of the contextHub - * appBinary contains the binary representation of the nanoApp, plus + * @param appBinary contains the binary representation of the nanoApp, plus * metadata - * transactionId transactionId for this call + * @param transactionId transactionId for this call * * @return result OK if transation started * BAD_VALUE if parameters are not sane @@ -101,8 +101,8 @@ interface IContexthub { * Unloading a nanoapp must not take more than 5 seconds. * * @param hubId identifer of the contextHub - * appId appIdentifier returned by the HAL - * msg message to be sent + * @param appId appIdentifier returned by the HAL + * @param msg message to be sent * * @return result OK if transation started * BAD_VALUE if parameters are not sane @@ -122,8 +122,8 @@ interface IContexthub { * Enabling a nanoapp must not take more than 5 seconds. * * @param hubId identifer of the contextHub - * appId appIdentifier returned by the HAL - * msg message to be sent + * @param appId appIdentifier returned by the HAL + * @param msg message to be sent * * @return result OK if transation started * BAD_VALUE if parameters are not sane @@ -143,8 +143,8 @@ interface IContexthub { * Disabling a nanoapp must not take more than 5 seconds. * * @param hubId identifer of the contextHub - * appId appIdentifier returned by the HAL - * msg message to be sent + * @param appId appIdentifier returned by the HAL + * @param msg message to be sent * * @return result OK if transation started * BAD_VALUE if parameters are not sane diff --git a/contexthub/1.0/IContexthubCallback.hal b/contexthub/1.0/IContexthubCallback.hal index 264f84ca17..70750f808b 100644 --- a/contexthub/1.0/IContexthubCallback.hal +++ b/contexthub/1.0/IContexthubCallback.hal @@ -22,7 +22,7 @@ interface IContexthubCallback { * implementation to allow the HAL to send asynchronous messages back * to the service and registered clients of the ContextHub service. * - * @params msg : message + * @param msg message being sent from the contexthub * */ handleClientMsg(ContextHubMsg msg); @@ -32,9 +32,9 @@ interface IContexthubCallback { * implementation to allow the HAL to send the response for a * transaction. * - * @params txnId : transaction id whose result is being sent - * passed in by the service at start of transacation. - * result: result of transaction. + * @param txnId transaction id whose result is being sent + * passed in by the service at start of transacation. + * @param result result of transaction. * */ handleTxnResult(uint32_t txnId, TransactionResult result); @@ -44,7 +44,7 @@ interface IContexthubCallback { * implementation to allow the HAL to send an asynchronous event * to the ContextHub service. * - * @params msg : message + * @param evt event being sent from the contexthub * */ handleHubEvent(AsyncEventType evt); @@ -55,8 +55,8 @@ interface IContexthubCallback { * that a nanp-app has aborted. * This method must be called when a nanoapp invokes chreAbort(...)). * - * @params appId : app identifier - * : abortCode code passed by the nanoApp. + * @param appId app identifier + * @param abortCode code passed by the nanoApp. * * Also see chreAbort(...) * @@ -68,12 +68,11 @@ interface IContexthubCallback { * implementation to allow the HAL to send information about the * currently loaded and active nanoapps on the hub. * - * @params appInfo : vector of HubAppinfo structure for each nanoApp - * on the hub that can be enabled, disabled and - * unloaded by the service. Any nanoApps that cannot - * be controlled by the service must not be reported. - * All nanoApps that can be controlled by the service - * must be reported. + * @param appInfo vector of HubAppinfo structure for each nanoApp on the + * hub that can be enabled, disabled and unloaded by the + * service. Any nanoApps that cannot be controlled by the + * service must not be reported. All nanoApps that can be + * controlled by the service must be reported. */ handleAppsInfo(vec appInfo); }; diff --git a/current.txt b/current.txt index 0b88a7a835..bf6829a353 100644 --- a/current.txt +++ b/current.txt @@ -767,6 +767,8 @@ a64467bae843569f0d465c5be7f0c7a5b987985b55a3ef4794dd5afc68538650 android.hardwar 98592d193a717066facf91428426e5abe211e3bd718bc372e29fb944ddbe6e7c android.hardware.wifi.supplicant@1.3::types # ABI preserving changes to HALs during Android S +e042522daa4b5f7fd4a0a19bcdadb93c79a1b04c09ef2c9813a3a8941032f3f5 android.hardware.contexthub@1.0::IContexthub +c2f64133b83ede65c9939ef97ab5bd867b73faf3dba0e7e69f77c3c43d9e487e android.hardware.contexthub@1.0::IContexthubCallback 1ca372cd67d197df099e87616a613ba6ede6552638a603e18f86c8834302c3d1 android.hardware.gnss@1.0::IGnssMeasurementCallback 6a271e493907e8ba20912e42771bd0d99ae45431a851d5675ef9496d02510a34 android.hardware.gnss@1.1::IGnssMeasurementCallback 2c331a9605f3a08d9c1e0a36169ca57758bc43c11a78ef3f3730509885e52c15 android.hardware.graphics.composer@2.4::IComposerClient