diff mbox

[v3,2/5] dt-bindings: input: Add document bindings for mtk-pmic-keys

Message ID 1503642753-12385-3-git-send-email-chen.zhong@mediatek.com (mailing list archive)
State New, archived
Headers show

Commit Message

chen.zhong Aug. 25, 2017, 6:32 a.m. UTC 
This patch adds the device tree binding documentation for the MediaTek
pmic keys found on PMIC MT6397/MT6323.

Signed-off-by: Chen Zhong <chen.zhong@mediatek.com>
---
 .../devicetree/bindings/input/mtk-pmic-keys.txt    |   38 ++++++++++++++++++++
 1 file changed, 38 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/input/mtk-pmic-keys.txt

Comments

Rob Herring Aug. 31, 2017, 7:52 p.m. UTC | #1 
On Fri, Aug 25, 2017 at 02:32:30PM +0800, Chen Zhong wrote:
> This patch adds the device tree binding documentation for the MediaTek
> pmic keys found on PMIC MT6397/MT6323.
> 
> Signed-off-by: Chen Zhong <chen.zhong@mediatek.com>
> ---
>  .../devicetree/bindings/input/mtk-pmic-keys.txt    |   38 ++++++++++++++++++++
>  1 file changed, 38 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/input/mtk-pmic-keys.txt
> 
> diff --git a/Documentation/devicetree/bindings/input/mtk-pmic-keys.txt b/Documentation/devicetree/bindings/input/mtk-pmic-keys.txt
> new file mode 100644
> index 0000000..100ec44
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/input/mtk-pmic-keys.txt
> @@ -0,0 +1,38 @@
> +MediaTek MT6397/MT6323 PMIC Keys Device Driver
> +
> +There are two key functions provided by MT6397/MT6323 PMIC, pwrkey
> +and homekey. The key functions are defined as the subnode of the function
> +node provided by MT6397/MT6323 PMIC that is being defined as one kind
> +of Muti-Function Device (MFD)
> +
> +For MT6397/MT6323 MFD bindings see:
> +Documentation/devicetree/bindings/mfd/mt6397.txt
> +
> +Required properties:
> +- compatible: "mediatek,mt6397-keys" or "mediatek,mt6323-keys"
> +- linux,keycodes: Specifies the numeric keycode values to
> +	be used for reporting keys presses. The array can
> +	contain up to 2 entries.
> +
> +Optional Properties:
> +- wakeup-source: each key can be used as a wakeup source.

wakeup-source is defined as a boolean.

> +- mediatek,long-press-mode: Long press key shutdown setting, 1 for
> +	pwrkey only, 2 for pwrkey/homekey together, others for disabled.
> +- debounce-interval: Long press key shutdown debouncing interval time
> +	in seconds. 0/1/2/3 for 8/11/14/5 seconds. If not specified defaults to 0.
> +
> +Example:
> +
> +	pmic: mt6397 {
> +		compatible = "mediatek,mt6397";
> +
> +		...
> +
> +		mt6397keys: mt6397keys {
> +			compatible = "mediatek,mt6397-keys";
> +			linux,keycodes = <KEY_POWER>, <KEY_VOLUMEDOWN>;
> +			wakeup-source = <1>, <0>;
> +			mediatek,long-press-mode = <1>;
> +			debounce-interval = <0>;
> +		};
> +	};
> -- 
> 1.7.9.5
> 
--
To unsubscribe from this list: send the line "unsubscribe linux-input" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
chen.zhong Sept. 1, 2017, 2 a.m. UTC | #2 
On Thu, 2017-08-31 at 14:52 -0500, Rob Herring wrote:
> On Fri, Aug 25, 2017 at 02:32:30PM +0800, Chen Zhong wrote:
> > This patch adds the device tree binding documentation for the MediaTek
> > pmic keys found on PMIC MT6397/MT6323.
> > 
> > Signed-off-by: Chen Zhong <chen.zhong@mediatek.com>
> > ---
> >  .../devicetree/bindings/input/mtk-pmic-keys.txt    |   38 ++++++++++++++++++++
> >  1 file changed, 38 insertions(+)
> >  create mode 100644 Documentation/devicetree/bindings/input/mtk-pmic-keys.txt
> > 
> > diff --git a/Documentation/devicetree/bindings/input/mtk-pmic-keys.txt b/Documentation/devicetree/bindings/input/mtk-pmic-keys.txt
> > new file mode 100644
> > index 0000000..100ec44
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/input/mtk-pmic-keys.txt
> > @@ -0,0 +1,38 @@
> > +MediaTek MT6397/MT6323 PMIC Keys Device Driver
> > +
> > +There are two key functions provided by MT6397/MT6323 PMIC, pwrkey
> > +and homekey. The key functions are defined as the subnode of the function
> > +node provided by MT6397/MT6323 PMIC that is being defined as one kind
> > +of Muti-Function Device (MFD)
> > +
> > +For MT6397/MT6323 MFD bindings see:
> > +Documentation/devicetree/bindings/mfd/mt6397.txt
> > +
> > +Required properties:
> > +- compatible: "mediatek,mt6397-keys" or "mediatek,mt6323-keys"
> > +- linux,keycodes: Specifies the numeric keycode values to
> > +	be used for reporting keys presses. The array can
> > +	contain up to 2 entries.
> > +
> > +Optional Properties:
> > +- wakeup-source: each key can be used as a wakeup source.
> 
> wakeup-source is defined as a boolean.

Hi Rob,

We have two keys, maybe one key can be used as a wakeup source, another
not.Since wakeup-source is defined as a boolean, we cannot distinguish
the behavior of the two keys. May i know the better way to do this?

Thank you.
> 
> > +- mediatek,long-press-mode: Long press key shutdown setting, 1 for
> > +	pwrkey only, 2 for pwrkey/homekey together, others for disabled.
> > +- debounce-interval: Long press key shutdown debouncing interval time
> > +	in seconds. 0/1/2/3 for 8/11/14/5 seconds. If not specified defaults to 0.
> > +
> > +Example:
> > +
> > +	pmic: mt6397 {
> > +		compatible = "mediatek,mt6397";
> > +
> > +		...
> > +
> > +		mt6397keys: mt6397keys {
> > +			compatible = "mediatek,mt6397-keys";
> > +			linux,keycodes = <KEY_POWER>, <KEY_VOLUMEDOWN>;
> > +			wakeup-source = <1>, <0>;
> > +			mediatek,long-press-mode = <1>;
> > +			debounce-interval = <0>;
> > +		};
> > +	};
> > -- 
> > 1.7.9.5
> > 


--
To unsubscribe from this list: send the line "unsubscribe linux-input" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
chen.zhong Sept. 2, 2017, 2:16 a.m. UTC | #3 
On Thu, 2017-08-31 at 14:52 -0500, Rob Herring wrote:
> On Fri, Aug 25, 2017 at 02:32:30PM +0800, Chen Zhong wrote:
> > This patch adds the device tree binding documentation for the MediaTek
> > pmic keys found on PMIC MT6397/MT6323.
> > 
> > Signed-off-by: Chen Zhong <chen.zhong@mediatek.com>
> > ---
> >  .../devicetree/bindings/input/mtk-pmic-keys.txt    |   38 ++++++++++++++++++++
> >  1 file changed, 38 insertions(+)
> >  create mode 100644 Documentation/devicetree/bindings/input/mtk-pmic-keys.txt
> > 
> > diff --git a/Documentation/devicetree/bindings/input/mtk-pmic-keys.txt b/Documentation/devicetree/bindings/input/mtk-pmic-keys.txt
> > new file mode 100644
> > index 0000000..100ec44
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/input/mtk-pmic-keys.txt
> > @@ -0,0 +1,38 @@
> > +MediaTek MT6397/MT6323 PMIC Keys Device Driver
> > +
> > +There are two key functions provided by MT6397/MT6323 PMIC, pwrkey
> > +and homekey. The key functions are defined as the subnode of the function
> > +node provided by MT6397/MT6323 PMIC that is being defined as one kind
> > +of Muti-Function Device (MFD)
> > +
> > +For MT6397/MT6323 MFD bindings see:
> > +Documentation/devicetree/bindings/mfd/mt6397.txt
> > +
> > +Required properties:
> > +- compatible: "mediatek,mt6397-keys" or "mediatek,mt6323-keys"
> > +- linux,keycodes: Specifies the numeric keycode values to
> > +	be used for reporting keys presses. The array can
> > +	contain up to 2 entries.
> > +
> > +Optional Properties:
> > +- wakeup-source: each key can be used as a wakeup source.
> 
> wakeup-source is defined as a boolean.

Hi Rob,

Could I modify it as this?

mediatek,wakeup-keys = <1>, <0>;
wakeup-source;

Thanks.
> 
> > +- mediatek,long-press-mode: Long press key shutdown setting, 1 for
> > +	pwrkey only, 2 for pwrkey/homekey together, others for disabled.
> > +- debounce-interval: Long press key shutdown debouncing interval time
> > +	in seconds. 0/1/2/3 for 8/11/14/5 seconds. If not specified defaults to 0.
> > +
> > +Example:
> > +
> > +	pmic: mt6397 {
> > +		compatible = "mediatek,mt6397";
> > +
> > +		...
> > +
> > +		mt6397keys: mt6397keys {
> > +			compatible = "mediatek,mt6397-keys";
> > +			linux,keycodes = <KEY_POWER>, <KEY_VOLUMEDOWN>;
> > +			wakeup-source = <1>, <0>;
> > +			mediatek,long-press-mode = <1>;
> > +			debounce-interval = <0>;
> > +		};
> > +	};
> > -- 
> > 1.7.9.5
> > 


--
To unsubscribe from this list: send the line "unsubscribe linux-input" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Rob Herring Sept. 5, 2017, 4:05 p.m. UTC | #4 
On Fri, Sep 1, 2017 at 9:16 PM, Chen Zhong <chen.zhong@mediatek.com> wrote:
> On Thu, 2017-08-31 at 14:52 -0500, Rob Herring wrote:
>> On Fri, Aug 25, 2017 at 02:32:30PM +0800, Chen Zhong wrote:
>> > This patch adds the device tree binding documentation for the MediaTek
>> > pmic keys found on PMIC MT6397/MT6323.
>> >
>> > Signed-off-by: Chen Zhong <chen.zhong@mediatek.com>
>> > ---
>> >  .../devicetree/bindings/input/mtk-pmic-keys.txt    |   38 ++++++++++++++++++++
>> >  1 file changed, 38 insertions(+)
>> >  create mode 100644 Documentation/devicetree/bindings/input/mtk-pmic-keys.txt
>> >
>> > diff --git a/Documentation/devicetree/bindings/input/mtk-pmic-keys.txt b/Documentation/devicetree/bindings/input/mtk-pmic-keys.txt
>> > new file mode 100644
>> > index 0000000..100ec44
>> > --- /dev/null
>> > +++ b/Documentation/devicetree/bindings/input/mtk-pmic-keys.txt
>> > @@ -0,0 +1,38 @@
>> > +MediaTek MT6397/MT6323 PMIC Keys Device Driver
>> > +
>> > +There are two key functions provided by MT6397/MT6323 PMIC, pwrkey
>> > +and homekey. The key functions are defined as the subnode of the function
>> > +node provided by MT6397/MT6323 PMIC that is being defined as one kind
>> > +of Muti-Function Device (MFD)
>> > +
>> > +For MT6397/MT6323 MFD bindings see:
>> > +Documentation/devicetree/bindings/mfd/mt6397.txt
>> > +
>> > +Required properties:
>> > +- compatible: "mediatek,mt6397-keys" or "mediatek,mt6323-keys"
>> > +- linux,keycodes: Specifies the numeric keycode values to
>> > +   be used for reporting keys presses. The array can
>> > +   contain up to 2 entries.
>> > +
>> > +Optional Properties:
>> > +- wakeup-source: each key can be used as a wakeup source.
>>
>> wakeup-source is defined as a boolean.
>
> Hi Rob,
>
> Could I modify it as this?
>
> mediatek,wakeup-keys = <1>, <0>;
> wakeup-source;

What do the values and index signify? The power key is index 0 and the
value 1 means enable wakeup? Or each value is the raw key (i.e.
indexes in linux,keycode) that wakeup is enabled for?

I don't think this should be in DT really. It's really up to the user
(i.e. userspace) to decide what keys cause wakeup (or maybe that's
only suspend). If you default to the power key causes wakeup, do you
really need to support different options?

If we do put this in DT, then it should be a common binding to specify
keys that cause wake-up.

Rob
--
To unsubscribe from this list: send the line "unsubscribe linux-input" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
chen.zhong Sept. 7, 2017, 3:05 a.m. UTC | #5 
On Tue, 2017-09-05 at 11:05 -0500, Rob Herring wrote:
> On Fri, Sep 1, 2017 at 9:16 PM, Chen Zhong <chen.zhong@mediatek.com> wrote:
> > On Thu, 2017-08-31 at 14:52 -0500, Rob Herring wrote:
> >> On Fri, Aug 25, 2017 at 02:32:30PM +0800, Chen Zhong wrote:
> >> > This patch adds the device tree binding documentation for the MediaTek
> >> > pmic keys found on PMIC MT6397/MT6323.
> >> >
> >> > Signed-off-by: Chen Zhong <chen.zhong@mediatek.com>
> >> > ---
> >> >  .../devicetree/bindings/input/mtk-pmic-keys.txt    |   38 ++++++++++++++++++++
> >> >  1 file changed, 38 insertions(+)
> >> >  create mode 100644 Documentation/devicetree/bindings/input/mtk-pmic-keys.txt
> >> >
> >> > diff --git a/Documentation/devicetree/bindings/input/mtk-pmic-keys.txt b/Documentation/devicetree/bindings/input/mtk-pmic-keys.txt
> >> > new file mode 100644
> >> > index 0000000..100ec44
> >> > --- /dev/null
> >> > +++ b/Documentation/devicetree/bindings/input/mtk-pmic-keys.txt
> >> > @@ -0,0 +1,38 @@
> >> > +MediaTek MT6397/MT6323 PMIC Keys Device Driver
> >> > +
> >> > +There are two key functions provided by MT6397/MT6323 PMIC, pwrkey
> >> > +and homekey. The key functions are defined as the subnode of the function
> >> > +node provided by MT6397/MT6323 PMIC that is being defined as one kind
> >> > +of Muti-Function Device (MFD)
> >> > +
> >> > +For MT6397/MT6323 MFD bindings see:
> >> > +Documentation/devicetree/bindings/mfd/mt6397.txt
> >> > +
> >> > +Required properties:
> >> > +- compatible: "mediatek,mt6397-keys" or "mediatek,mt6323-keys"
> >> > +- linux,keycodes: Specifies the numeric keycode values to
> >> > +   be used for reporting keys presses. The array can
> >> > +   contain up to 2 entries.
> >> > +
> >> > +Optional Properties:
> >> > +- wakeup-source: each key can be used as a wakeup source.
> >>
> >> wakeup-source is defined as a boolean.
> >
> > Hi Rob,
> >
> > Could I modify it as this?
> >
> > mediatek,wakeup-keys = <1>, <0>;
> > wakeup-source;
> 
> What do the values and index signify? The power key is index 0 and the
> value 1 means enable wakeup? Or each value is the raw key (i.e.
> indexes in linux,keycode) that wakeup is enabled for?
> 
> I don't think this should be in DT really. It's really up to the user
> (i.e. userspace) to decide what keys cause wakeup (or maybe that's
> only suspend). If you default to the power key causes wakeup, do you
> really need to support different options?
> 
> If we do put this in DT, then it should be a common binding to specify
> keys that cause wake-up.
> 
> Rob

Hi Rob,

Yes, we want to describe that power key is index 0 and is a wakeup
source, homekey is index 1 and not a wakeup source.

Since power key and homekey are two real HW keys, customer can decide
which key to be the wakeup source or both due to their hw design, so we
put this in DT and can be different for different boards.

Thank you.

Chen


--
To unsubscribe from this list: send the line "unsubscribe linux-input" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
diff mbox

Patch

diff --git a/Documentation/devicetree/bindings/input/mtk-pmic-keys.txt b/Documentation/devicetree/bindings/input/mtk-pmic-keys.txt
new file mode 100644
index 0000000..100ec44
--- /dev/null
+++ b/Documentation/devicetree/bindings/input/mtk-pmic-keys.txt
@@ -0,0 +1,38 @@ 
+MediaTek MT6397/MT6323 PMIC Keys Device Driver
+
+There are two key functions provided by MT6397/MT6323 PMIC, pwrkey
+and homekey. The key functions are defined as the subnode of the function
+node provided by MT6397/MT6323 PMIC that is being defined as one kind
+of Muti-Function Device (MFD)
+
+For MT6397/MT6323 MFD bindings see:
+Documentation/devicetree/bindings/mfd/mt6397.txt
+
+Required properties:
+- compatible: "mediatek,mt6397-keys" or "mediatek,mt6323-keys"
+- linux,keycodes: Specifies the numeric keycode values to
+	be used for reporting keys presses. The array can
+	contain up to 2 entries.
+
+Optional Properties:
+- wakeup-source: each key can be used as a wakeup source.
+- mediatek,long-press-mode: Long press key shutdown setting, 1 for
+	pwrkey only, 2 for pwrkey/homekey together, others for disabled.
+- debounce-interval: Long press key shutdown debouncing interval time
+	in seconds. 0/1/2/3 for 8/11/14/5 seconds. If not specified defaults to 0.
+
+Example:
+
+	pmic: mt6397 {
+		compatible = "mediatek,mt6397";
+
+		...
+
+		mt6397keys: mt6397keys {
+			compatible = "mediatek,mt6397-keys";
+			linux,keycodes = <KEY_POWER>, <KEY_VOLUMEDOWN>;
+			wakeup-source = <1>, <0>;
+			mediatek,long-press-mode = <1>;
+			debounce-interval = <0>;
+		};
+	};