platform_hardware_interfaces/automotive/evs/1.1/IEvsUltrasonicsArray.hal
Tanmay Patil 496b86ccbb Adds HAL for ultrasonics to EVS 1.1
- Adds new structs in types.h
- Adds two new .hal IEvsUltrasonicsArray and IEvsUltrasonicsArrayStream
- Adds new APIs calls in IEvsEnumerator
- Adds empty default implementation for all

Bug: 148619310

Test: Build and functionality tested with demo app.

Change-Id: I8b501c7328d4c02cc694b5a2c73a519ca6d87710
2020-02-19 12:36:58 -08:00

81 lines
3.2 KiB
Text

/*
* Copyright 2020 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.automotive.evs@1.1;
import @1.0::EvsResult;
import UltrasonicsArrayDesc;
import UltrasonicsDataFrameDesc;
import IEvsUltrasonicsArrayStream;
/**
* HAL interface for ultrasonics sensor array.
*/
interface IEvsUltrasonicsArray {
/**
* Returns the ultrasonic sensor array information.
*
* @return info The description of this ultrasonic array. This must be the
* same value as reported by IEvsEnumerator::getUltrasonicsArrayList().
*/
getUltrasonicArrayInfo() generates (UltrasonicsArrayDesc info);
/**
* Specifies the depth of the buffer chain the ultrasonic sensors is
* asked to support.
*
* Up to this many data frames may be held concurrently by the client of IEvsUltrasonicsArray.
* If this many frames have been delivered to the receiver without being returned
* by doneWithFrame, the stream must skip frames until a buffer is returned for reuse.
* It is legal for this call to come at any time, even while streams are already running,
* in which case buffers should be added or removed from the chain as appropriate.
* If no call is made to this entry point, the IEvsUltrasonicsArray must support at least one
* data frame by default. More is acceptable.
*
* @param bufferCount Number of buffers the client of
* IEvsUltrasonicsArray may hold concurrently.
* @return result EvsResult::OK is returned if this call is successful.
* Will return EvsResult::INVALID_ARG on invalid bufferCount.
*/
setMaxFramesInFlight(uint32_t bufferCount) generates (EvsResult result);
/**
* Requests to start the stream.
*
* @param stream Implementation of IEvsUltrasonicsArrayStream.
* @return result EvsResult::OK is returned if this call is successful. Returns
* EvsResult::STREAM_ALREADY_RUNNING if stream is already running.
*/
startStream(IEvsUltrasonicsArrayStream stream) generates (EvsResult result);
/**
* Requests to stop the delivery of the ultrasonic array data frames.
*
* Because delivery is asynchronous, frames may continue to arrive for
* some time after this call returns. Each must be returned until the
* closure of the stream is signaled to the IEvsCameraStream.
* This function cannot fail and is ignored if the stream isn't running.
*/
stopStream();
/**
* Notifies the UltrasonicsDataDesc is consumed that was received from
* IEvsUltrasonicsArrayStream.
*
* @param dataFrameDesc Ultrasonics data descriptor.
*/
doneWithDataFrame(UltrasonicsDataFrameDesc dataFrameDesc);
};