Subject: [PATCH v4 04/11] pwm: add DT bindings documentation for atmel-hlcdc-pwm driver

From: [email-masked] (Varka Bhadram)
Date: Tue, 22 Jul 2014 20:06:11 +0530

On Tuesday 22 July 2014 06:41 PM, Boris BREZILLON wrote:
> The HLCDC IP available in some Atmel SoCs (i.e. sam9x5i.e. at91sam9n12,
> at91sam9x5 family or sama5d3 family) provide a PWM device.
>
> The DT bindings used for this PWM device is following the default 3 cells
> bindings described in Documentation/devicetree/bindings/pwm/pwm.txt.
>
> Signed-off-by: Boris BREZILLON <[email-masked]>
> ---
>   .../devicetree/bindings/pwm/atmel-hlcdc-pwm.txt    | 55 ++++++++++++++++++++++
>   1 file changed, 55 insertions(+)
>   create mode 100644 Documentation/devicetree/bindings/pwm/atmel-hlcdc-pwm.txt
>
> diff --git a/Documentation/devicetree/bindings/pwm/atmel-hlcdc-pwm.txt b/Documentation/devicetree/bindings/pwm/atmel-hlcdc-pwm.txt
> new file mode 100644
> index 0000000..86ad3e2
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/pwm/atmel-hlcdc-pwm.txt
> @@ -0,0 +1,55 @@
> +Device-Tree bindings for Atmel's HLCDC (High LCD Controller) PWM driver
> +
> +The Atmel HLCDC PWM is subdevice of the HLCDC MFD device.
> +See ../mfd/atmel-hlcdc.txt for more details.
> +
> +Required properties:
> + - compatible: value should be one of the following:
> +   "atmel,hlcdc-pwm"
> + - pinctr-names: the pin control state names. Should contain "default".
> + - pinctrl-0: should contain the pinctrl states described by pinctrl
> +   default.
> + - #pwm-cells: should be set to 3. This PWM chip use the default 3 cells
> +   bindings defined in Documentation/devicetree/bindings/pwm/pwm.txt.
> +   The first cell encodes the PWM id (0 is the only acceptable value here,
> +   because the chip only provide one PWM).
> +   The second cell encodes the PWM period in nanoseconds.
> +   The third cell encodes the PWM flags (the only supported flag is
> +   PWM_POLARITY_INVERTED)

It will be readable if:
Required properties:
  - compatible	: value should be one of the following: "atmel,hlcdc-pwm"
  - pinctr-names	: the pin control state names. Should contain "default".
  - pinctrl-0	: should contain the pinctrl states described by pinctrl default.
  - #pwm-cells	: should be set to 3. This PWM chip use the default 3 cells
		  bindings defined in Documentation/devicetree/bindings/pwm/pwm.txt.
		  The first cell encodes the PWM id (0 is the only acceptable value here,
		  because the chip only provide one PWM).
		  The second cell encodes the PWM period in nanoseconds.
		  The third cell encodes the PWM flags (the only supported flag is
		  PWM_POLARITY_INVERTED)
....

-- 
Regards,
Varka Bhadram