[v1,1/3] dt-bindings:Add vibrator devicetree documentation
diff mbox series

Message ID 20200615114203.116656-2-fengping.yu@mediatek.com
State New
Headers show
Series
  • [v1,1/3] dt-bindings:Add vibrator devicetree documentation
Related show

Commit Message

Fengping Yu June 15, 2020, 11:42 a.m. UTC
From: "fengping.yu" <fengping.yu@mediatek.com>

Add Mediatek regulator vibrator dt-bindings doc as yaml schema

Signed-off-by: fengping.yu <fengping.yu@mediatek.com>
---
 .../bindings/input/regulator-vibrator.yaml    | 65 +++++++++++++++++++
 1 file changed, 65 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/input/regulator-vibrator.yaml

Comments

Pavel Machek June 16, 2020, 10:58 a.m. UTC | #1
On Mon 2020-06-15 19:42:02, Fengping Yu wrote:
> From: "fengping.yu" <fengping.yu@mediatek.com>
> 
> Add Mediatek regulator vibrator dt-bindings doc as yaml schema
> 
> Signed-off-by: fengping.yu <fengping.yu@mediatek.com>
> ---
>  .../bindings/input/regulator-vibrator.yaml    | 65 +++++++++++++++++++
>  1 file changed, 65 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/input/regulator-vibrator.yaml
> 
> diff --git a/Documentation/devicetree/bindings/input/regulator-vibrator.yaml b/Documentation/devicetree/bindings/input/regulator-vibrator.yaml
> new file mode 100644
> index 000000000000..6511a8a80aff
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/input/regulator-vibrator.yaml
> @@ -0,0 +1,65 @@
> +# SPDX-License-Identifier: GPL-2.0
> +%YAML 1.2
> +---
> +version: 1
> +
> +$id: http://devicetree.org/schemas/input/regulator-vibrator.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Mediatek's regulator vibrator device tree bindings
> +
> +maintainer:
> +  - Fengping Yu <fengping.yu@mediatek.com>
> +
> +description: |
> +  Registers a regulator device as vibrator, where the on/off capability is controlled by a regulator.

Line length?

> +properties:
> +  compatible:
> +      const: "regulator-vibrator"
> +
> +	vibr-supply:
> +		description: Power supply to the vibrator.
> +		refs:Documentation/devicetree/bindings/regulator/regulator.txt for details.
> +
> +  max-volt:
> +    description: The maximum voltage value supplied to the vibrator regulator.
> +    						 The unit of the voltage is micro.
> +

should be -microvolt?

> +  min-volt:
> +    description: The minimum voltage value supplied to the vibrator regulator.
> +    						 The unit of the voltage is micro.
> +
> +  min-limit:
> +    description: The minimum duration time in ms for vibrator, default is 15ms.
> +    						 If user request smaller duration, the default value will be used
> +    						 instead. The default value comes from the smallest unit that can
> +    						 be sensored.

English?

Add -usec or something?

											Pavel

Patch
diff mbox series

diff --git a/Documentation/devicetree/bindings/input/regulator-vibrator.yaml b/Documentation/devicetree/bindings/input/regulator-vibrator.yaml
new file mode 100644
index 000000000000..6511a8a80aff
--- /dev/null
+++ b/Documentation/devicetree/bindings/input/regulator-vibrator.yaml
@@ -0,0 +1,65 @@ 
+# SPDX-License-Identifier: GPL-2.0
+%YAML 1.2
+---
+version: 1
+
+$id: http://devicetree.org/schemas/input/regulator-vibrator.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Mediatek's regulator vibrator device tree bindings
+
+maintainer:
+  - Fengping Yu <fengping.yu@mediatek.com>
+
+description: |
+  Registers a regulator device as vibrator, where the on/off capability is controlled by a regulator.
+
+properties:
+  compatible:
+      const: "regulator-vibrator"
+
+	vibr-supply:
+		description: Power supply to the vibrator.
+		refs:Documentation/devicetree/bindings/regulator/regulator.txt for details.
+
+  max-volt:
+    description: The maximum voltage value supplied to the vibrator regulator.
+    						 The unit of the voltage is micro.
+
+  min-volt:
+    description: The minimum voltage value supplied to the vibrator regulator.
+    						 The unit of the voltage is micro.
+
+  min-limit:
+    description: The minimum duration time in ms for vibrator, default is 15ms.
+    						 If user request smaller duration, the default value will be used
+    						 instead. The default value comes from the smallest unit that can
+    						 be sensored.
+
+  max-limit:
+    description: The maximum duration time in ms for vibrator. If not set, it means
+    						 no max limitation.
+
+required:
+  - compatible
+  - min-volt
+  - max-volt
+
+examples:
+  - |
+
+	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>;
+    min-limit = <25>;
+		max-limit = <15000>;
+		vib-supply = <&mt6359_vibr_ldo_reg>;
+  };