From 7033e87d8ce05ea2a8c8dccaefac24a149978cb5 Mon Sep 17 00:00:00 2001 From: "Harpreet \\\"Eli\\\" Sangha" Date: Tue, 4 Feb 2020 12:10:45 +0900 Subject: [PATCH] vibrator: Document the source of always-on source IDs. Bug: 148617686 Test: N/A: Documentation change. Change-Id: I471d394e0c0258fbdaaea27a50ed21c4c10123a7 Signed-off-by: Harpreet \"Eli\" Sangha --- .../aidl/android/hardware/vibrator/IVibrator.aidl | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/vibrator/aidl/android/hardware/vibrator/IVibrator.aidl b/vibrator/aidl/android/hardware/vibrator/IVibrator.aidl index 06a8bf5c17..6489c1d600 100644 --- a/vibrator/aidl/android/hardware/vibrator/IVibrator.aidl +++ b/vibrator/aidl/android/hardware/vibrator/IVibrator.aidl @@ -202,6 +202,12 @@ interface IVibrator { * once enabled and assigned an effect to play. This may not be supported * and this support is reflected in getCapabilities (CAP_ALWAYS_ON_CONTROL). * + * The always-on source ID is conveyed directly to clients through + * device/board configuration files ensuring that no ID is assigned to + * multiple clients. No client should use this API unless explicitly + * assigned an always-on source ID. Clients must develop their own way to + * get IDs from vendor in a stable way. + * * @param id The device-specific always-on source ID to enable. * @param effect The type of haptic event to trigger. * @param strength The intensity of haptic event to trigger. @@ -212,6 +218,12 @@ interface IVibrator { * Disable an always-on haptic source. This may not be supported and this * support is reflected in getCapabilities (CAP_ALWAYS_ON_CONTROL). * + * The always-on source ID is conveyed directly to clients through + * device/board configuration files ensuring that no ID is assigned to + * multiple clients. No client should use this API unless explicitly + * assigned an always-on source ID. Clients must develop their own way to + * get IDs from vendor in a stable way. + * * @param id The device-specific always-on source ID to disable. */ void alwaysOnDisable(in int id);