[PATCH v1 1/3] dt-bindings: add regulator vibrator documentation
From: Xing Zhang
Date: Wed Apr 29 2020 - 04:22:18 EST
From: Xing Zhang <xing.zhang@xxxxxxxxxxxx>
Add the DT binding documentation for regulator vibrator
Change-Id: I6a2350b1bac46cf90d6122c6de6cfecddb696928
Signed-off-by: Xing Zhang <xing.zhang@xxxxxxxxxxxx>
---
.../bindings/leds/regulator-vibrator.txt | 39 +++++++++++++++++++
1 file changed, 39 insertions(+)
create mode 100644 Documentation/devicetree/bindings/leds/regulator-vibrator.txt
diff --git a/Documentation/devicetree/bindings/leds/regulator-vibrator.txt b/Documentation/devicetree/bindings/leds/regulator-vibrator.txt
new file mode 100644
index 000000000000..8f45d3ed13bd
--- /dev/null
+++ b/Documentation/devicetree/bindings/leds/regulator-vibrator.txt
@@ -0,0 +1,39 @@
+* Regulator vibrator device tree bindings
+
+Required Properties:
+ - compatible : Should be "regulator-vibrator"
+ - vibr-supply : Power supply to the vibrator.
+ [*] refer Documentation/devicetree/bindings/regulator/regulator.txt
+
+ - max-volt : The maximum voltage value supplied to the vibrator regulator.
+ [The unit of the voltage is a micro]
+
+ - min-volt : The minimum voltage value supplied to the vibrator regulator.
+ [The unit of the voltage is a micro]
+
+Optional properties:
+ - min-limit : Set the minimum time in ms for vibrator , default is 15ms,
+ if user request duration is smaller, this value will be used instead.
+ the default value comes from the smallest unit that can be sensed.
+
+ - max-limit : Set the maximum time in ms for vibrator.
+ if not set, it means no max limitation.
+
+Example:
+
+ mt6359_vibr_ldo_reg: ldo_vibr {
+ regulator-name = "vibr";
+ regulator-min-microvolt = <1200000>;
+ regulator-max-microvolt = <3300000>;
+ regulator-enable-ramp-delay = <240>;
+ };
+
+ regulator_vibrator {
+ compatible = "regulator-vibrator";
+ min-volt = <2300000>;
+ max-volt = <3200000>;
+ max-limit = <15000>;
+ min-limit = <15>;
+ vib-supply = <&mt6359_vibr_ldo_reg>;
+ };
+
--
2.18.0