Re: [RESEND v7 1/5] mfd: hi655x: Add document for mfd hi665x PMIC

[Lee Jones]

On Mon, 01 Feb 2016, Chen Feng wrote:

> DT bindings for hisilicon hi655x MFD PMIC chip.
> 
> Signed-off-by: Chen Feng <puck.chen@xxxxxxxxxxxxx>
> Signed-off-by: Fei Wang <w.f@xxxxxxxxxx>
> Signed-off-by: Xinwei Kong <kong.kongxinwei@xxxxxxxxxxxxx>
> Reviewed-by: Haojian Zhuang <haojian.zhuang@xxxxxxxxxx>
> ---
>  .../devicetree/bindings/mfd/hisilicon,hi655x.txt   | 27 ++++++++++++++++++++++
>  1 file changed, 27 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/mfd/hisilicon,hi655x.txt
> 
> diff --git a/Documentation/devicetree/bindings/mfd/hisilicon,hi655x.txt b/Documentation/devicetree/bindings/mfd/hisilicon,hi655x.txt
> new file mode 100644
> index 0000000..5edc310
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/mfd/hisilicon,hi655x.txt
> @@ -0,0 +1,27 @@
> +Hisilicon hi655x Power Management Integrated Circuit (PMIC)
> +
> +The hardware layout for access PMIC Hi655x from AP SoC Hi6220.
> +Between PMIC Hi655x and Hi6220, the physical signal channel is SSI.
> +We can use memory-mapped I/O to communicate.
> +
> ++----------------+             +-------------+
> +|                |             |             |
> +|    Hi6220      |   SSI bus   |   Hi655x    |
> +|                |-------------|             |
> +|                |(REGMAP_MMIO)|             |
> ++----------------+             +-------------+
> +
> +Required properties:
> +- compatible: Should be "hisilicon,hi655x-pmic"
> +- reg: Base address of PMIC on hi6220 soc

s/hi6220 soc/Hi6220 SoC/

> +- interrupt-controller: Hi655x has internal IRQs (has own IRQ domain).
> +- pmic-gpios: The gpio used by PMIC irq.

s/gpio/GPIO/
s/irq/IRQ/

These are always easier to read in this format:

- compatible:			Should be "hisilicon,hi655x-pmic"
- reg:				Base address of PMIC on hi6220 soc
- interrupt-controller: 	Hi655x has internal IRQs (has own IRQ domain).
- pmic-gpios:			The gpio used by PMIC irq.

> +Example:
> +	pmic: pmic@f8000000 {
> +		compatible = "hisilicon,hi655x-pmic";
> +		reg = <0x0 0xf8000000 0x0 0x1000>;
> +		interrupt-controller;
> +		#interrupt-cells = <2>;
> +		pmic-gpios = <&gpio1 2 GPIO_ACTIVE_HIGH>;
> +	}

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