platform_hardware_interfaces/contexthub/1.0/IContexthubCallback.hal
Anthony Stange 6001602853 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
2021-01-11 15:53:30 -05:00

78 lines
2.8 KiB
Text

/*
* Copyright (C) 2016 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package android.hardware.contexthub@1.0;
interface IContexthubCallback {
/**
* This callback is passed by the Contexthub service to the HAL
* implementation to allow the HAL to send asynchronous messages back
* to the service and registered clients of the ContextHub service.
*
* @param msg message being sent from the contexthub
*
*/
handleClientMsg(ContextHubMsg msg);
/**
* This callback is passed by the Contexthub service to the HAL
* implementation to allow the HAL to send the response for a
* 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);
/**
* This callback is passed by the Contexthub service to the HAL
* implementation to allow the HAL to send an asynchronous event
* to the ContextHub service.
*
* @param evt event being sent from the contexthub
*
*/
handleHubEvent(AsyncEventType evt);
/**
* This callback is passed by the Contexthub service to the HAL
* implementation to allow the HAL to send a notification to the service
* that a nanp-app has aborted.
* This method must be called when a nanoapp invokes chreAbort(...)).
*
* @param appId app identifier
* @param abortCode code passed by the nanoApp.
*
* Also see chreAbort(...)
*
*/
handleAppAbort(uint64_t appId, uint32_t abortCode);
/**
* This callback is passed by the Contexthub service to the HAL
* implementation to allow the HAL to send information about the
* currently loaded and active nanoapps on the hub.
*
* @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<HubAppInfo> appInfo);
};