* [PATCH v4 1/2] input: adc-keys: add DT binding documentation
@ 2016-07-12 19:36 Alexandre Belloni
2016-07-16 22:11 ` Rob Herring
0 siblings, 1 reply; 3+ messages in thread
From: Alexandre Belloni @ 2016-07-12 19:36 UTC (permalink / raw)
To: Dmitry Torokhov
Cc: Jonathan Cameron, linux-input, linux-iio, linux-kernel,
Alexandre Belloni, Rob Herring, devicetree
Add documentation for ADC keys
Signed-off-by: Alexandre Belloni <alexandre.belloni@free-electrons.com>
---
Cc: Rob Herring <robh+dt@kernel.org>
Cc: devicetree@vger.kernel.org
Changes v2..v4:
- Documented autorepeat and poll-interval
.../devicetree/bindings/input/adc-keys.txt | 50 ++++++++++++++++++++++
1 file changed, 50 insertions(+)
create mode 100644 Documentation/devicetree/bindings/input/adc-keys.txt
diff --git a/Documentation/devicetree/bindings/input/adc-keys.txt b/Documentation/devicetree/bindings/input/adc-keys.txt
new file mode 100644
index 000000000000..6f26ad75ed2b
--- /dev/null
+++ b/Documentation/devicetree/bindings/input/adc-keys.txt
@@ -0,0 +1,50 @@
+ADC attached resistor ladder buttons
+------------------------------------
+
+Required properties:
+ - compatible: "adc-keys"
+ - io-channels: Phandle to an ADC channel
+ - io-channel-names = "buttons";
+ - keyup-threshold-mvolt: Voltage at which all the keys are considered up.
+
+Optional properties:
+ - poll-interval: Poll interval time in milliseconds
+ - autorepeat: Boolean, Enable auto repeat feature of Linux input
+ subsystem.
+
+Each button (key) is represented as a sub-node of "adc-keys":
+
+Required subnode-properties:
+ - label: Descriptive name of the key.
+ - linux,code: Keycode to emit.
+ - press-threshold-mvolt: Voltage adc input when this key is pressed.
+
+Example:
+
+#include <dt-bindings/input/input.h>
+
+ adc-keys {
+ compatible = "adc-keys";
+ io-channels = <&lradc 0>;
+ io-channel-names = "buttons";
+ keyup-threshold-mvolt = <2000>;
+
+ button@1500 {
+ label = "Volume Up";
+ linux,code = <KEY_VOLUMEUP>;
+ press-threshold-mvolt = <1500>;
+ };
+
+ button@1000 {
+ label = "Volume Down";
+ linux,code = <KEY_VOLUMEDOWN>;
+ press-threshold-mvolt = <1000>;
+ };
+
+ button@500 {
+ label = "Enter";
+ linux,code = <KEY_ENTER>;
+ press-threshold-mvolt = <500>;
+ };
+ };
+
--
2.8.1
^ permalink raw reply related [flat|nested] 3+ messages in thread
* Re: [PATCH v4 1/2] input: adc-keys: add DT binding documentation
2016-07-12 19:36 [PATCH v4 1/2] input: adc-keys: add DT binding documentation Alexandre Belloni
@ 2016-07-16 22:11 ` Rob Herring
2016-07-16 22:41 ` Alexandre Belloni
0 siblings, 1 reply; 3+ messages in thread
From: Rob Herring @ 2016-07-16 22:11 UTC (permalink / raw)
To: Alexandre Belloni
Cc: Dmitry Torokhov, Jonathan Cameron, linux-input, linux-iio,
linux-kernel, devicetree
On Tue, Jul 12, 2016 at 09:36:25PM +0200, Alexandre Belloni wrote:
> Add documentation for ADC keys
>
> Signed-off-by: Alexandre Belloni <alexandre.belloni@free-electrons.com>
> ---
> Cc: Rob Herring <robh+dt@kernel.org>
> Cc: devicetree@vger.kernel.org
>
> Changes v2..v4:
> - Documented autorepeat and poll-interval
>
>
> .../devicetree/bindings/input/adc-keys.txt | 50 ++++++++++++++++++++++
> 1 file changed, 50 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/input/adc-keys.txt
>
> diff --git a/Documentation/devicetree/bindings/input/adc-keys.txt b/Documentation/devicetree/bindings/input/adc-keys.txt
> new file mode 100644
> index 000000000000..6f26ad75ed2b
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/input/adc-keys.txt
> @@ -0,0 +1,50 @@
> +ADC attached resistor ladder buttons
> +------------------------------------
> +
> +Required properties:
> + - compatible: "adc-keys"
> + - io-channels: Phandle to an ADC channel
> + - io-channel-names = "buttons";
> + - keyup-threshold-mvolt: Voltage at which all the keys are considered up.
'-microvolt' is the standard suffix.
> +
> +Optional properties:
> + - poll-interval: Poll interval time in milliseconds
> + - autorepeat: Boolean, Enable auto repeat feature of Linux input
> + subsystem.
> +
> +Each button (key) is represented as a sub-node of "adc-keys":
> +
> +Required subnode-properties:
> + - label: Descriptive name of the key.
> + - linux,code: Keycode to emit.
> + - press-threshold-mvolt: Voltage adc input when this key is pressed.
> +
> +Example:
> +
> +#include <dt-bindings/input/input.h>
> +
> + adc-keys {
> + compatible = "adc-keys";
> + io-channels = <&lradc 0>;
> + io-channel-names = "buttons";
> + keyup-threshold-mvolt = <2000>;
> +
> + button@1500 {
> + label = "Volume Up";
> + linux,code = <KEY_VOLUMEUP>;
> + press-threshold-mvolt = <1500>;
> + };
> +
> + button@1000 {
> + label = "Volume Down";
> + linux,code = <KEY_VOLUMEDOWN>;
> + press-threshold-mvolt = <1000>;
> + };
> +
> + button@500 {
> + label = "Enter";
> + linux,code = <KEY_ENTER>;
> + press-threshold-mvolt = <500>;
> + };
> + };
> +
> --
> 2.8.1
>
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: [PATCH v4 1/2] input: adc-keys: add DT binding documentation
2016-07-16 22:11 ` Rob Herring
@ 2016-07-16 22:41 ` Alexandre Belloni
0 siblings, 0 replies; 3+ messages in thread
From: Alexandre Belloni @ 2016-07-16 22:41 UTC (permalink / raw)
To: Rob Herring
Cc: Dmitry Torokhov, Jonathan Cameron,
linux-input-u79uwXL29TY76Z2rM5mHXA,
linux-iio-u79uwXL29TY76Z2rM5mHXA,
linux-kernel-u79uwXL29TY76Z2rM5mHXA,
devicetree-u79uwXL29TY76Z2rM5mHXA
On 16/07/2016 at 17:11:39 -0500, Rob Herring wrote :
> On Tue, Jul 12, 2016 at 09:36:25PM +0200, Alexandre Belloni wrote:
> > Add documentation for ADC keys
> >
> > Signed-off-by: Alexandre Belloni <alexandre.belloni-wi1+55ScJUtKEb57/3fJTNBPR1lH4CV8@public.gmane.org>
> > ---
> > Cc: Rob Herring <robh+dt-DgEjT+Ai2ygdnm+yROfE0A@public.gmane.org>
> > Cc: devicetree-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
> >
> > Changes v2..v4:
> > - Documented autorepeat and poll-interval
> >
> >
> > .../devicetree/bindings/input/adc-keys.txt | 50 ++++++++++++++++++++++
> > 1 file changed, 50 insertions(+)
> > create mode 100644 Documentation/devicetree/bindings/input/adc-keys.txt
> >
> > diff --git a/Documentation/devicetree/bindings/input/adc-keys.txt b/Documentation/devicetree/bindings/input/adc-keys.txt
> > new file mode 100644
> > index 000000000000..6f26ad75ed2b
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/input/adc-keys.txt
> > @@ -0,0 +1,50 @@
> > +ADC attached resistor ladder buttons
> > +------------------------------------
> > +
> > +Required properties:
> > + - compatible: "adc-keys"
> > + - io-channels: Phandle to an ADC channel
> > + - io-channel-names = "buttons";
> > + - keyup-threshold-mvolt: Voltage at which all the keys are considered up.
>
> '-microvolt' is the standard suffix.
>
Actually, it is milli volts. I wouls have use uvolt for microvolt.
Should I change that for '-millivolt'?
--
Alexandre Belloni, Free Electrons
Embedded Linux and Kernel engineering
http://free-electrons.com
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2016-07-16 22:41 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2016-07-12 19:36 [PATCH v4 1/2] input: adc-keys: add DT binding documentation Alexandre Belloni
2016-07-16 22:11 ` Rob Herring
2016-07-16 22:41 ` Alexandre Belloni
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).