Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit a3c332f5 authored by Lais Andrade's avatar Lais Andrade
Browse files

Introduce IVibrator.performVendorEffect 

Introduce HAL API to perform vibration effects defined by the vendor.

The new API accepts a PersistableBundle representing the effect and some
platform-provided parameters, e.g. EffectStrength and scale.

The callback support for completion is required for this API, since
effect duration is undefined.

Fix: 345409060
Test: VtsHalVibratorTargetTest
Flag: EXEMPT HAL interface change
Change-Id: I26379ede4b64e41e1fc85feae6de5105cb636511
parent 6efc6f93

compatibility_matrices/compatibility_matrix.202504.xml

+2 −2
Original line number Diff line number Diff line
@@ -629,7 +629,7 @@ 
    </hal>

    <hal format="aidl">

        <name>android.hardware.vibrator</name>

        <version>1-2</version>

        <version>1-3</version>

        <interface>

            <name>IVibrator</name>

            <instance>default</instance>
@@ -637,7 +637,7 @@ 
    </hal>

    <hal format="aidl">

        <name>android.hardware.vibrator</name>

        <version>1-2</version>

        <version>1-3</version>

        <interface>

            <name>IVibratorManager</name>

            <instance>default</instance>

tests/extension/vibrator/aidl/Android.bp

+3 −0
Original line number Diff line number Diff line
@@ -43,6 +43,9 @@ aidl_interface { 
        cpp: {

            enabled: false,

        },

        rust: {

            enabled: false,

        },

    },

    frozen: true,

    versions_with_info: [

tests/extension/vibrator/aidl/default/Android.bp

+1 −5
Original line number Diff line number Diff line
@@ -10,11 +10,6 @@ package { 
cc_binary {

    name: "android.hardware.tests.extension.vibrator-service.example",

    relative_install_path: "hw",

    // normally you implement a service directly, but we are using an implementation

    // from a library to attach our extension to.

    static_libs: [

        "libvibratorexampleimpl",

    ],



    // need to add this in the manifest and to init as well to use, see

    // android.hardware.vibrator-service.example. This binary is being tested
@@ -23,6 +18,7 @@ cc_binary { 
    vendor: true,

    srcs: [

        "service.cpp",

        "Vibrator.cpp",

        "CustomVibrator.cpp",

    ],

    shared_libs: [

tests/extension/vibrator/aidl/default/Vibrator.cpp

0 → 100644
+131 −0
Original line number Diff line number Diff line 
/*

 * Copyright (C) 2024 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.

 */



#include "Vibrator.h"



#include <android-base/logging.h>



namespace aidl::android::hardware::vibrator {



ndk::ScopedAStatus Vibrator::getCapabilities(int32_t* _aidl_return) {

    // basic example with only amplitude control capability

    *_aidl_return = IVibrator::CAP_AMPLITUDE_CONTROL;

    return ndk::ScopedAStatus::ok();

}



ndk::ScopedAStatus Vibrator::off() {

    LOG(INFO) << "Vibrator off";

    return ndk::ScopedAStatus::ok();

}



ndk::ScopedAStatus Vibrator::on(int32_t timeoutMs, const std::shared_ptr<IVibratorCallback>&) {

    LOG(INFO) << "Vibrator on for timeoutMs: " << timeoutMs;

    return ndk::ScopedAStatus::ok();

}



ndk::ScopedAStatus Vibrator::setAmplitude(float amplitude) {

    LOG(INFO) << "Vibrator set amplitude: " << amplitude;

    if (amplitude <= 0.0f || amplitude > 1.0f) {

        return ndk::ScopedAStatus(AStatus_fromExceptionCode(EX_ILLEGAL_ARGUMENT));

    }

    return ndk::ScopedAStatus::ok();

}



ndk::ScopedAStatus Vibrator::perform(Effect, EffectStrength,

                                     const std::shared_ptr<IVibratorCallback>&, int32_t*) {

    return ndk::ScopedAStatus(AStatus_fromExceptionCode(EX_UNSUPPORTED_OPERATION));

}



ndk::ScopedAStatus Vibrator::getSupportedEffects(std::vector<Effect>* _aidl_return) {

    *_aidl_return = {};

    return ndk::ScopedAStatus::ok();

}



ndk::ScopedAStatus Vibrator::setExternalControl(bool) {

    return ndk::ScopedAStatus(AStatus_fromExceptionCode(EX_UNSUPPORTED_OPERATION));

}



ndk::ScopedAStatus Vibrator::getCompositionDelayMax(int32_t*) {

    return ndk::ScopedAStatus(AStatus_fromExceptionCode(EX_UNSUPPORTED_OPERATION));

}



ndk::ScopedAStatus Vibrator::getCompositionSizeMax(int32_t*) {

    return ndk::ScopedAStatus(AStatus_fromExceptionCode(EX_UNSUPPORTED_OPERATION));

}



ndk::ScopedAStatus Vibrator::getSupportedPrimitives(std::vector<CompositePrimitive>*) {

    return ndk::ScopedAStatus(AStatus_fromExceptionCode(EX_UNSUPPORTED_OPERATION));

}



ndk::ScopedAStatus Vibrator::getPrimitiveDuration(CompositePrimitive, int32_t*) {

    return ndk::ScopedAStatus(AStatus_fromExceptionCode(EX_UNSUPPORTED_OPERATION));

}



ndk::ScopedAStatus Vibrator::compose(const std::vector<CompositeEffect>&,

                                     const std::shared_ptr<IVibratorCallback>&) {

    return ndk::ScopedAStatus(AStatus_fromExceptionCode(EX_UNSUPPORTED_OPERATION));

}



ndk::ScopedAStatus Vibrator::getSupportedAlwaysOnEffects(std::vector<Effect>*) {

    return ndk::ScopedAStatus(AStatus_fromExceptionCode(EX_UNSUPPORTED_OPERATION));

}



ndk::ScopedAStatus Vibrator::alwaysOnEnable(int32_t, Effect, EffectStrength) {

    return ndk::ScopedAStatus(AStatus_fromExceptionCode(EX_UNSUPPORTED_OPERATION));

}



ndk::ScopedAStatus Vibrator::alwaysOnDisable(int32_t) {

    return ndk::ScopedAStatus(AStatus_fromExceptionCode(EX_UNSUPPORTED_OPERATION));

}



ndk::ScopedAStatus Vibrator::getResonantFrequency(float*) {

    return ndk::ScopedAStatus(AStatus_fromExceptionCode(EX_UNSUPPORTED_OPERATION));

}



ndk::ScopedAStatus Vibrator::getQFactor(float*) {

    return ndk::ScopedAStatus(AStatus_fromExceptionCode(EX_UNSUPPORTED_OPERATION));

}



ndk::ScopedAStatus Vibrator::getFrequencyResolution(float*) {

    return ndk::ScopedAStatus(AStatus_fromExceptionCode(EX_UNSUPPORTED_OPERATION));

}



ndk::ScopedAStatus Vibrator::getFrequencyMinimum(float*) {

    return ndk::ScopedAStatus(AStatus_fromExceptionCode(EX_UNSUPPORTED_OPERATION));

}



ndk::ScopedAStatus Vibrator::getBandwidthAmplitudeMap(std::vector<float>*) {

    return ndk::ScopedAStatus(AStatus_fromExceptionCode(EX_UNSUPPORTED_OPERATION));

}



ndk::ScopedAStatus Vibrator::getPwlePrimitiveDurationMax(int32_t*) {

    return ndk::ScopedAStatus(AStatus_fromExceptionCode(EX_UNSUPPORTED_OPERATION));

}



ndk::ScopedAStatus Vibrator::getPwleCompositionSizeMax(int32_t*) {

    return ndk::ScopedAStatus(AStatus_fromExceptionCode(EX_UNSUPPORTED_OPERATION));

}



ndk::ScopedAStatus Vibrator::getSupportedBraking(std::vector<Braking>*) {

    return ndk::ScopedAStatus(AStatus_fromExceptionCode(EX_UNSUPPORTED_OPERATION));

}



ndk::ScopedAStatus Vibrator::composePwle(const std::vector<PrimitivePwle>&,

                                         const std::shared_ptr<IVibratorCallback>&) {

    return ndk::ScopedAStatus(AStatus_fromExceptionCode(EX_UNSUPPORTED_OPERATION));

}



}  // namespace aidl::android::hardware::vibrator

tests/extension/vibrator/aidl/default/Vibrator.h

0 → 100644
+56 −0
Original line number Diff line number Diff line 
/*

 * Copyright (C) 2024 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.

 */



#pragma once



#include <aidl/android/hardware/vibrator/BnVibrator.h>



namespace aidl::android::hardware::vibrator {



class Vibrator : public BnVibrator {

    ndk::ScopedAStatus getCapabilities(int32_t* _aidl_return) override;

    ndk::ScopedAStatus off() override;

    ndk::ScopedAStatus on(int32_t timeoutMs,

                          const std::shared_ptr<IVibratorCallback>& callback) override;

    ndk::ScopedAStatus perform(Effect effect, EffectStrength strength,

                               const std::shared_ptr<IVibratorCallback>& callback,

                               int32_t* _aidl_return) override;

    ndk::ScopedAStatus getSupportedEffects(std::vector<Effect>* _aidl_return) override;

    ndk::ScopedAStatus setAmplitude(float amplitude) override;

    ndk::ScopedAStatus setExternalControl(bool enabled) override;

    ndk::ScopedAStatus getCompositionDelayMax(int32_t* maxDelayMs);

    ndk::ScopedAStatus getCompositionSizeMax(int32_t* maxSize);

    ndk::ScopedAStatus getSupportedPrimitives(std::vector<CompositePrimitive>* supported) override;

    ndk::ScopedAStatus getPrimitiveDuration(CompositePrimitive primitive,

                                            int32_t* durationMs) override;

    ndk::ScopedAStatus compose(const std::vector<CompositeEffect>& composite,

                               const std::shared_ptr<IVibratorCallback>& callback) override;

    ndk::ScopedAStatus getSupportedAlwaysOnEffects(std::vector<Effect>* _aidl_return) override;

    ndk::ScopedAStatus alwaysOnEnable(int32_t id, Effect effect, EffectStrength strength) override;

    ndk::ScopedAStatus alwaysOnDisable(int32_t id) override;

    ndk::ScopedAStatus getResonantFrequency(float* resonantFreqHz) override;

    ndk::ScopedAStatus getQFactor(float* qFactor) override;

    ndk::ScopedAStatus getFrequencyResolution(float* freqResolutionHz) override;

    ndk::ScopedAStatus getFrequencyMinimum(float* freqMinimumHz) override;

    ndk::ScopedAStatus getBandwidthAmplitudeMap(std::vector<float>* _aidl_return) override;

    ndk::ScopedAStatus getPwlePrimitiveDurationMax(int32_t* durationMs) override;

    ndk::ScopedAStatus getPwleCompositionSizeMax(int32_t* maxSize) override;

    ndk::ScopedAStatus getSupportedBraking(std::vector<Braking>* supported) override;

    ndk::ScopedAStatus composePwle(const std::vector<PrimitivePwle>& composite,

                                   const std::shared_ptr<IVibratorCallback>& callback) override;

};



}  // namespace aidl::android::hardware::vibrator