vibrator: Add Example Implementation for HAL 1.3 (e8631244) · Commits · e / os / android_hardware_interfaces

vibrator/1.3/example/Android.bp

0 → 100644

+34 −0

Original line number	Original line	Diff line number	Diff line
			//
			// Copyright (C) 2019 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.

			cc_binary {
			name: "android.hardware.vibrator@1.3-service.example",
			vendor: true,
			relative_install_path: "hw",
			init_rc: ["android.hardware.vibrator@1.3-service.example.rc"],
			vintf_fragments: ["android.hardware.vibrator@1.3-service.example.xml"],
			srcs: ["service.cpp", "Vibrator.cpp"],
			cflags: ["-Wall", "-Werror"],
			shared_libs: [
			"libhidlbase",
			"libhidltransport",
			"liblog",
			"libutils",
			"android.hardware.vibrator@1.0",
			"android.hardware.vibrator@1.1",
			"android.hardware.vibrator@1.2",
			"android.hardware.vibrator@1.3",
			],
			}

vibrator/1.3/example/Vibrator.cpp

0 → 100644

+242 −0

Original line number	Original line	Diff line number	Diff line
			/*
			* Copyright (C) 2019 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.
			*/

			#define LOG_TAG "VibratorService"

			#include <log/log.h>

			#include "Vibrator.h"

			namespace android {
			namespace hardware {
			namespace vibrator {
			namespace V1_3 {
			namespace implementation {

			static constexpr uint32_t MS_PER_S = 1000;
			static constexpr uint32_t NS_PER_MS = 1000000;

			Vibrator::Vibrator() {
			sigevent se{};
			se.sigev_notify = SIGEV_THREAD;
			se.sigev_value.sival_ptr = this;
			se.sigev_notify_function = timerCallback;
			se.sigev_notify_attributes = nullptr;

			if (timer_create(CLOCK_REALTIME, &se, &mTimer) < 0) {
			ALOGE("Can not create timer!%s", strerror(errno));
			}
			}

			// Methods from ::android::hardware::vibrator::V1_0::IVibrator follow.

			Return<Status> Vibrator::on(uint32_t timeoutMs) {
			return activate(timeoutMs);
			}

			Return<Status> Vibrator::off() {
			return activate(0);
			}

			Return<bool> Vibrator::supportsAmplitudeControl() {
			return true;
			}

			Return<Status> Vibrator::setAmplitude(uint8_t amplitude) {
			ALOGI("Amplitude: %u -> %u\n", mAmplitude, amplitude);
			mAmplitude = amplitude;
			return Status::OK;
			}

			Return<void> Vibrator::perform(V1_0::Effect effect, EffectStrength strength, perform_cb _hidl_cb) {
			return perform_1_1(static_cast<V1_1::Effect_1_1>(effect), strength, _hidl_cb);
			}

			// Methods from ::android::hardware::vibrator::V1_1::IVibrator follow.

			Return<void> Vibrator::perform_1_1(V1_1::Effect_1_1 effect, EffectStrength strength,
			perform_cb _hidl_cb) {
			return perform_1_2(static_cast<V1_2::Effect>(effect), strength, _hidl_cb);
			}

			// Methods from ::android::hardware::vibrator::V1_2::IVibrator follow.

			Return<void> Vibrator::perform_1_2(Effect effect, EffectStrength strength, perform_cb _hidl_cb) {
			uint8_t amplitude;
			uint32_t ms;
			Status status;

			ALOGI("Perform: Effect %s\n", effectToName(effect));

			amplitude = strengthToAmplitude(strength);
			setAmplitude(amplitude);

			ms = effectToMs(effect);
			status = activate(ms);

			_hidl_cb(status, ms);

			return Void();
			}

			// Methods from ::android::hardware::vibrator::V1_3::IVibrator follow.

			Return<bool> Vibrator::supportsExternalControl() {
			return true;
			}

			Return<Status> Vibrator::setExternalControl(bool enabled) {
			if (mEnabled) {
			ALOGW("Setting external control while the vibrator is enabled is unsupported!");
			return Status::UNSUPPORTED_OPERATION;
			} else {
			ALOGI("ExternalControl: %s -> %s\n", mExternalControl ? "true" : "false",
			enabled ? "true" : "false");
			mExternalControl = enabled;
			return Status::OK;
			}
			}

			// Private methods follow.

			Status Vibrator::enable(bool enabled) {
			if (mExternalControl) {
			ALOGW("Enabling/disabling while the vibrator is externally controlled is unsupported!");
			return Status::UNSUPPORTED_OPERATION;
			} else {
			ALOGI("Enabled: %s -> %s\n", mEnabled ? "true" : "false", enabled ? "true" : "false");
			mEnabled = enabled;
			return Status::OK;
			}
			}

			Status Vibrator::activate(uint32_t ms) {
			std::lock_guard<std::mutex> lock{mMutex};
			Status status = Status::OK;

			if (ms > 0) {
			status = enable(true);
			if (status != Status::OK) {
			return status;
			}
			}

			itimerspec ts{};
			ts.it_value.tv_sec = ms / MS_PER_S;
			ts.it_value.tv_nsec = ms % MS_PER_S * NS_PER_MS;

			if (timer_settime(mTimer, 0, &ts, nullptr) < 0) {
			ALOGE("Can not set timer!");
			status = Status::UNKNOWN_ERROR;
			}

			if ((status != Status::OK) \|\| !ms) {
			Status _status;

			_status = enable(false);

			if (status == Status::OK) {
			status = _status;
			}
			}

			return status;
			}

			void Vibrator::timeout() {
			std::lock_guard<std::mutex> lock{mMutex};
			itimerspec ts{};

			if (timer_gettime(mTimer, &ts) < 0) {
			ALOGE("Can not read timer!");
			}

			if (ts.it_value.tv_sec == 0 && ts.it_value.tv_nsec == 0) {
			enable(false);
			}
			}

			void Vibrator::timerCallback(union sigval sigval) {
			static_cast<Vibrator*>(sigval.sival_ptr)->timeout();
			}

			const char* Vibrator::effectToName(Effect effect) {
			return toString(effect).c_str();
			}

			uint32_t Vibrator::effectToMs(Effect effect) {
			switch (effect) {
			case Effect::CLICK:
			return 10;
			case Effect::DOUBLE_CLICK:
			return 15;
			case Effect::TICK:
			return 5;
			case Effect::THUD:
			return 5;
			case Effect::POP:
			return 5;
			case Effect::HEAVY_CLICK:
			return 10;
			case Effect::RINGTONE_1:
			return 30000;
			case Effect::RINGTONE_2:
			return 30000;
			case Effect::RINGTONE_3:
			return 30000;
			case Effect::RINGTONE_4:
			return 30000;
			case Effect::RINGTONE_5:
			return 30000;
			case Effect::RINGTONE_6:
			return 30000;
			case Effect::RINGTONE_7:
			return 30000;
			case Effect::RINGTONE_8:
			return 30000;
			case Effect::RINGTONE_9:
			return 30000;
			case Effect::RINGTONE_10:
			return 30000;
			case Effect::RINGTONE_11:
			return 30000;
			case Effect::RINGTONE_12:
			return 30000;
			case Effect::RINGTONE_13:
			return 30000;
			case Effect::RINGTONE_14:
			return 30000;
			case Effect::RINGTONE_15:
			return 30000;
			}
			}

			uint8_t Vibrator::strengthToAmplitude(EffectStrength strength) {
			switch (strength) {
			case EffectStrength::LIGHT:
			return 128;
			case EffectStrength::MEDIUM:
			return 192;
			case EffectStrength::STRONG:
			return 255;
			}
			}

			} // namespace implementation
			} // namespace V1_3
			} // namespace vibrator
			} // namespace hardware
			} // namespace android

vibrator/1.3/example/Vibrator.h

0 → 100644

+78 −0

Original line number	Original line	Diff line number	Diff line
			/*
			* Copyright (C) 2019 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.
			*/
			#ifndef ANDROID_HARDWARE_VIBRATOR_V1_3_VIBRATOR_H
			#define ANDROID_HARDWARE_VIBRATOR_V1_3_VIBRATOR_H

			#include <android/hardware/vibrator/1.3/IVibrator.h>
			#include <hidl/Status.h>

			namespace android {
			namespace hardware {
			namespace vibrator {
			namespace V1_3 {
			namespace implementation {

			using android::hardware::vibrator::V1_0::EffectStrength;
			using android::hardware::vibrator::V1_0::Status;
			using android::hardware::vibrator::V1_2::Effect;

			class Vibrator : public IVibrator {
			public:
			Vibrator();

			// Methods from ::android::hardware::vibrator::V1_0::IVibrator follow.
			Return<Status> on(uint32_t timeoutMs) override;
			Return<Status> off() override;
			Return<bool> supportsAmplitudeControl() override;
			Return<Status> setAmplitude(uint8_t amplitude) override;
			Return<void> perform(V1_0::Effect effect, EffectStrength strength,
			perform_cb _hidl_cb) override;

			// Methods from ::android::hardware::vibrator::V1_1::IVibrator follow.
			Return<void> perform_1_1(V1_1::Effect_1_1 effect, EffectStrength strength,
			perform_cb _hidl_cb) override;

			// Methods from ::android::hardware::vibrator::V1_2::IVibrator follow.
			Return<void> perform_1_2(Effect effect, EffectStrength strength, perform_cb _hidl_cb) override;

			// Methods from ::android::hardware::vibrator::V1_3::IVibrator follow.
			Return<bool> supportsExternalControl() override;
			Return<Status> setExternalControl(bool enabled) override;

			private:
			Status enable(bool enabled);
			Status activate(uint32_t ms);
			void timeout();

			static void timerCallback(union sigval sigval);
			static const char* effectToName(Effect effect);
			static uint32_t effectToMs(Effect effect);
			static uint8_t strengthToAmplitude(EffectStrength strength);

			private:
			bool mEnabled{false};
			uint8_t mAmplitude{UINT8_MAX};
			bool mExternalControl{false};
			std::mutex mMutex;
			timer_t mTimer{nullptr};
			};
			} // namespace implementation
			} // namespace V1_3
			} // namespace vibrator
			} // namespace hardware
			} // namespace android

			#endif // ANDROID_HARDWARE_VIBRATOR_V1_3_VIBRATOR_H

vibrator/1.3/example/android.hardware.vibrator@1.3-service.example.rc

0 → 100644

+4 −0

Original line number	Original line	Diff line number	Diff line
			service vendor.vibrator-1-3 /vendor/bin/hw/android.hardware.vibrator@1.3-service.example
			class hal
			user system
			group system

vibrator/1.3/example/android.hardware.vibrator@1.3-service.example.xml

0 → 100644

+11 −0

Original line number	Original line	Diff line number	Diff line
			<manifest version="1.0" type="device">
			<hal format="hidl">
			<name>android.hardware.vibrator</name>
			<transport>hwbinder</transport>
			<version>1.3</version>
			<interface>
			<name>IVibrator</name>
			<instance>default</instance>
			</interface>
			</hal>
			</manifest>