Re: [PATCH V1 2/2] devicetree: Add bindings for DA9063 OnKey

[Lee Jones <lee.jones@linaro.org>]

On Wed, 08 Apr 2015, Steve Twiss wrote:

> From: Steve Twiss <stwiss.opensource@diasemi.com>

What format is this?  Why aren't you using `git send-email`?

> Add device tree bindings for the DA9063 OnKey driver
> 
> This patch is dependent on PATCH V1 1/2 

How can there be dependencies between a binding document and a driver
patch?

> Signed-off-by: Steve Twiss <stwiss.opensource@diasemi.com>
> 
> ---
> This patch applies against linux-next and v4.0-rc6 
> 
> 
>  Documentation/devicetree/bindings/mfd/da9063.txt | 22 ++++++++++++++++++++--
>  1 file changed, 20 insertions(+), 2 deletions(-)
> 
> diff --git a/Documentation/devicetree/bindings/mfd/da9063.txt b/Documentation/devicetree/bindings/mfd/da9063.txt
> index 42c6fa6..3449b75 100644
> --- a/Documentation/devicetree/bindings/mfd/da9063.txt
> +++ b/Documentation/devicetree/bindings/mfd/da9063.txt
> @@ -2,9 +2,10 @@
>  
>  DA9093 consists of a large and varied group of sub-devices (I2C Only):
>  
> -Device                   Supply Names    Description
> -------                   ------------    -----------
> +Device			 Supply Names	 Description
> +------			 ------------	 -----------
>  da9063-regulator        :               : LDOs & BUCKs
> +da9063-onkey            :               : On Key
>  da9063-rtc              :               : Real-Time Clock
>  da9063-watchdog         :               : Watchdog
>  
> @@ -51,6 +52,18 @@ Sub-nodes:
>    the DA9063. There are currently no entries in this binding, however
>    compatible = "dlg,da9063-rtc" should be added if a node is created.
>  
> +- onkey : This node defines the OnKey settings for controlling the key
> +  functionality of the device. The node should contain the compatible keyword

s/keyword/property/

> +  with the value "dlg,da9063-onkey".
> +
> +  The platform data needs to match the OTP content of high address register

It's wrong to mention platform data here.  Just tell us what the
property is for.

> +  DA9063_REG_CONFIG_I and the device tree entry "dlg,disable-key-power" can

I feel like you're burying the dlg,disable-key-power documentation in
side a long winded paragraph.  It's better to start the line with it,
like:

Optional Properties:

dlg,disable-key-power:  Disable power-down using a long key-press.  If
			absent <blah> ... 

> +  be used to control this. If the onkey node contains "dlg,disable-key-power"
> +  then the power down using a long key-press is disabled. If this entry is
> +  missing then by default the key-press triggered power down is enabled.
> +  By toggling this key-power keyword the OnKey driver will support KEY_POWER
> +  and KEY_SLEEP key presses.
> +
>  - watchdog : This node defines settings for the Watchdog timer associated
>    with the DA9063. There are currently no entries in this binding, however
>    compatible = "dlg,da9063-watchdog" should be added if a node is created.
> @@ -73,6 +86,11 @@ Example:
>  			compatible = "dlg,da9063-watchdog";
>  		};
>  
> +		onkey {
> +			compatible = "dlg,da9063-onkey";
> +			dlg,disable-key-power;
> +		};
> +
>  		regulators {
>  			DA9063_BCORE1: bcore1 {
>  				regulator-name = "BCORE1";

-- 
Lee Jones
Linaro STMicroelectronics Landing Team Lead
Linaro.org │ Open source software for ARM SoCs
Follow Linaro: Facebook | Twitter | Blog