Merge pull request #534 from JamiKettunen/hfd-service

porting: configuring: DeviceInfo: add HfdService section
ubports · Dec 18, 2022 · 48ef1df · 48ef1df
2 parents e76b853 + aabe3af
commit 48ef1df
Show file tree

Hide file tree

Showing 2 changed files with 32 additions and 0 deletions.
diff --git a/porting/configure_test_fix/device_info/HfdService.rst b/porting/configure_test_fix/device_info/HfdService.rst
@@ -0,0 +1,31 @@
+.. _DeviceInfo_HfdService:
+
+hfd-service
+===========
+
+Overview of all hfd-service keys::
+
+    <devicename>:
+      VibrateDurationExtraMs: <any integer value>
+
+Device quirks
+-------------
+
+======================  =============================================  ==================
+Key                     Description                                    Value(s)
+======================  =============================================  ==================
+VibrateDurationExtraMs  Milliseconds to extend all vibration calls by  Any integer number
+======================  =============================================  ==================
+
+Examples
+--------
+
+Device ``sample`` using:
+
+- Extend vibrations by 50 milliseconds to feel the on-screen keyboard haptics on devices with simpler on/off vibration motors
+
+Config file::
+
+    $ cat /etc/deviceinfo/devices/sample.yaml
+    sample:
+      VibrateDurationExtraMs: 50
diff --git a/porting/configure_test_fix/device_info/index.rst b/porting/configure_test_fix/device_info/index.rst
@@ -60,3 +60,4 @@ Other keys are documented in the component specific subpages.
 
    Mir
    Repowerd
+   HfdService