[v2,1/2] dt-bindings: i2c: Add Spreadtrum I2C controller documentation

Submitted by Baolin Wang on June 21, 2017, 7:23 a.m.

Details

Message ID 7bc5c69030b6e491cfb2519eb1b21c1b0adc70c3.1498029380.git.baolin.wang@spreadtrum.com
State New
Headers show

Commit Message

Baolin Wang June 21, 2017, 7:23 a.m.
This patch adds the binding documentation for Spreadtrum I2C
controller device.

Signed-off-by: Baolin Wang <baolin.wang@spreadtrum.com>
---
Changes since v1:
 - No updates.
---
 Documentation/devicetree/bindings/i2c/i2c-sprd.txt |   31 ++++++++++++++++++++
 1 file changed, 31 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/i2c/i2c-sprd.txt

Comments

Rob Herring June 23, 2017, 10:20 p.m.
On Wed, Jun 21, 2017 at 03:23:03PM +0800, Baolin Wang wrote:
> This patch adds the binding documentation for Spreadtrum I2C
> controller device.
> 
> Signed-off-by: Baolin Wang <baolin.wang@spreadtrum.com>
> ---
> Changes since v1:
>  - No updates.
> ---
>  Documentation/devicetree/bindings/i2c/i2c-sprd.txt |   31 ++++++++++++++++++++
>  1 file changed, 31 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/i2c/i2c-sprd.txt
> 
> diff --git a/Documentation/devicetree/bindings/i2c/i2c-sprd.txt b/Documentation/devicetree/bindings/i2c/i2c-sprd.txt
> new file mode 100644
> index 0000000..f285e5b
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/i2c/i2c-sprd.txt
> @@ -0,0 +1,31 @@
> +I2C for Spreadtrum platforms
> +
> +Required properties:
> +- compatible: Should be "sprd,r8p0-i2c".

Compatible strings should be SoC specific.

> +- reg: Specify the physical base address of the controller and length
> +  of memory mapped region.
> +- interrupts: Should contain I2C interrupt.
> +- clock-names: Should contain following entries:
> +  "i2c" for I2C clock,
> +  "source" for I2C source (parent) clock,
> +  "enable" for I2C module enable clock.
> +- clocks: Should contain a clock specifier for each entry in clock-names.
> +- clock-frequency: Constains desired I2C bus clock frequency in Hz.
> +- #address-cells: Should be 1 to describe address cells for I2C device address.
> +- #size-cells: Should be 0 means no size cell for I2C device address.
> +
> +Optional properties:
> +- Child nodes conforming to I2C bus binding
> +
> +Examples:
> +i2c0: i2c@70500000 {
> +	compatible = "sprd,r8p0-i2c";
> +	reg = <0 0x70500000 0 0x1000>;
> +	interrupts = <GIC_SPI 11 IRQ_TYPE_LEVEL_HIGH>;
> +	clock-names = "i2c", "source", "enable";
> +	clocks = <&clk_i2c3>, <&ext_26m>, <&clk_ap_apb_gates 11>;
> +	clock-frequency = <400000>;
> +	#address-cells = <1>;
> +	#size-cells = <0>;
> +};
> +
> -- 
> 1.7.9.5
>
Baolin Wang June 26, 2017, 2:40 a.m.
Hi Rob,

On 五,  6月 23, 2017 at 05:20:16下午 -0500, Rob Herring wrote:
> On Wed, Jun 21, 2017 at 03:23:03PM +0800, Baolin Wang wrote:
> > This patch adds the binding documentation for Spreadtrum I2C
> > controller device.
> > 
> > Signed-off-by: Baolin Wang <baolin.wang@spreadtrum.com>
> > ---
> > Changes since v1:
> >  - No updates.
> > ---
> >  Documentation/devicetree/bindings/i2c/i2c-sprd.txt |   31 ++++++++++++++++++++
> >  1 file changed, 31 insertions(+)
> >  create mode 100644 Documentation/devicetree/bindings/i2c/i2c-sprd.txt
> > 
> > diff --git a/Documentation/devicetree/bindings/i2c/i2c-sprd.txt b/Documentation/devicetree/bindings/i2c/i2c-sprd.txt
> > new file mode 100644
> > index 0000000..f285e5b
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/i2c/i2c-sprd.txt
> > @@ -0,0 +1,31 @@
> > +I2C for Spreadtrum platforms
> > +
> > +Required properties:
> > +- compatible: Should be "sprd,r8p0-i2c".
> 
> Compatible strings should be SoC specific.

Will fix this in next version. Thanks.

> 
> > +- reg: Specify the physical base address of the controller and length
> > +  of memory mapped region.
> > +- interrupts: Should contain I2C interrupt.
> > +- clock-names: Should contain following entries:
> > +  "i2c" for I2C clock,
> > +  "source" for I2C source (parent) clock,
> > +  "enable" for I2C module enable clock.
> > +- clocks: Should contain a clock specifier for each entry in clock-names.
> > +- clock-frequency: Constains desired I2C bus clock frequency in Hz.
> > +- #address-cells: Should be 1 to describe address cells for I2C device address.
> > +- #size-cells: Should be 0 means no size cell for I2C device address.
> > +
> > +Optional properties:
> > +- Child nodes conforming to I2C bus binding
> > +
> > +Examples:
> > +i2c0: i2c@70500000 {
> > +	compatible = "sprd,r8p0-i2c";
> > +	reg = <0 0x70500000 0 0x1000>;
> > +	interrupts = <GIC_SPI 11 IRQ_TYPE_LEVEL_HIGH>;
> > +	clock-names = "i2c", "source", "enable";
> > +	clocks = <&clk_i2c3>, <&ext_26m>, <&clk_ap_apb_gates 11>;
> > +	clock-frequency = <400000>;
> > +	#address-cells = <1>;
> > +	#size-cells = <0>;
> > +};
> > +
> > -- 
> > 1.7.9.5
> >

Patch hide | download patch | download mbox

diff --git a/Documentation/devicetree/bindings/i2c/i2c-sprd.txt b/Documentation/devicetree/bindings/i2c/i2c-sprd.txt
new file mode 100644
index 0000000..f285e5b
--- /dev/null
+++ b/Documentation/devicetree/bindings/i2c/i2c-sprd.txt
@@ -0,0 +1,31 @@ 
+I2C for Spreadtrum platforms
+
+Required properties:
+- compatible: Should be "sprd,r8p0-i2c".
+- reg: Specify the physical base address of the controller and length
+  of memory mapped region.
+- interrupts: Should contain I2C interrupt.
+- clock-names: Should contain following entries:
+  "i2c" for I2C clock,
+  "source" for I2C source (parent) clock,
+  "enable" for I2C module enable clock.
+- clocks: Should contain a clock specifier for each entry in clock-names.
+- clock-frequency: Constains desired I2C bus clock frequency in Hz.
+- #address-cells: Should be 1 to describe address cells for I2C device address.
+- #size-cells: Should be 0 means no size cell for I2C device address.
+
+Optional properties:
+- Child nodes conforming to I2C bus binding
+
+Examples:
+i2c0: i2c@70500000 {
+	compatible = "sprd,r8p0-i2c";
+	reg = <0 0x70500000 0 0x1000>;
+	interrupts = <GIC_SPI 11 IRQ_TYPE_LEVEL_HIGH>;
+	clock-names = "i2c", "source", "enable";
+	clocks = <&clk_i2c3>, <&ext_26m>, <&clk_ap_apb_gates 11>;
+	clock-frequency = <400000>;
+	#address-cells = <1>;
+	#size-cells = <0>;
+};
+