diff mbox

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

Message ID 7bc5c69030b6e491cfb2519eb1b21c1b0adc70c3.1497525667.git.baolin.wang@spreadtrum.com
State Superseded, archived
Headers show

Commit Message

Baolin Wang June 15, 2017, 11:30 a.m. UTC
This patch adds the binding documentation for Spreadtrum I2C
controller device.

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

Comments

Andy Shevchenko June 17, 2017, 5:18 p.m. UTC | #1
On Thu, Jun 15, 2017 at 2:30 PM, Baolin Wang <baolin.wang@spreadtrum.com> wrote:
> This patch adds the I2C controller driver for Spreadtrum platform.


> +       i2c_dev->irq = platform_get_irq(pdev, 0);
> +       if (i2c_dev->irq < 0) {
> +               dev_err(&pdev->dev, "failed to get irq resource\n");

> +               return -ENXIO;

Why shadow actual error?

> +       }


> +       if (!of_property_read_u32(dev->of_node, "clock-frequency", &prop))
> +               i2c_dev->bus_freq = prop;
> +
> +       sprd_i2c_clk_init(i2c_dev);
> +       platform_set_drvdata(pdev, i2c_dev);
> +
> +       pm_runtime_set_autosuspend_delay(i2c_dev->dev, SPRD_I2C_PM_TIMEOUT);
> +       pm_runtime_use_autosuspend(i2c_dev->dev);
> +       pm_runtime_set_active(i2c_dev->dev);
> +       pm_runtime_enable(i2c_dev->dev);
> +
> +       ret = pm_runtime_get_sync(i2c_dev->dev);
> +       if (ret < 0) {
> +               dev_err(&pdev->dev, "i2c%d pm runtime resume failed!\n",
> +                       pdev->id);

> +               return ret;

goto error;

> +       }
> +
> +       ret = devm_request_threaded_irq(dev, i2c_dev->irq,
> +               sprd_i2c_isr, sprd_i2c_isr_thread,
> +               IRQF_NO_SUSPEND | IRQF_ONESHOT,
> +               pdev->name, i2c_dev);
> +       if (ret) {
> +               dev_err(&pdev->dev, "failed to request irq %d\n", i2c_dev->irq);
> +               goto error;
> +       }
> +
> +       ret = i2c_add_numbered_adapter(&i2c_dev->adap);
> +       if (ret) {
> +               dev_err(&pdev->dev, "add adapter failed\n");
> +               goto error;
> +       }
> +
> +       pm_runtime_mark_last_busy(i2c_dev->dev);
> +       pm_runtime_put_autosuspend(i2c_dev->dev);
> +       return 0;
> +
> +error:
> +       pm_runtime_put_noidle(i2c_dev->dev);
> +       pm_runtime_disable(i2c_dev->dev);
> +       return ret;
> +}
> +
> +static int sprd_i2c_remove(struct platform_device *pdev)
> +{
> +       struct sprd_i2c *i2c_dev = platform_get_drvdata(pdev);
> +       int ret;
> +

> +       ret = pm_runtime_get_sync(i2c_dev->dev);
> +       if (ret < 0)
> +               return ret;

Does it make any sense? Doesn't device core power on the device before
calling ->remove() ?

> +
> +       i2c_del_adapter(&i2c_dev->adap);
> +
> +       if (!IS_ERR_OR_NULL(i2c_dev->clk))

_OR_NULL looks suspicious.

> +               clk_unprepare(i2c_dev->clk);
> +
> +       pm_runtime_put_noidle(i2c_dev->dev);
> +       pm_runtime_disable(i2c_dev->dev);
> +
> +       return 0;
> +}
> +

> +#ifdef CONFIG_PM_SLEEP

__maybe_unused instead?

> +static int sprd_i2c_suspend_noirq(struct device *pdev)

> +static int sprd_i2c_resume_noirq(struct device *pdev)

> +#endif  /* CONFIG_PM_SLEEP */

> +#ifdef CONFIG_PM

Ditto.

> +static int sprd_i2c_runtime_suspend(struct device *pdev)

> +}

> +static int sprd_i2c_runtime_resume(struct device *pdev)
> +{

> +       clk_prepare_enable(i2c_dev->clk);

This might fail.


> +}
> +#endif  /* CONFIG_PM */


> +static struct platform_driver sprd_i2c_driver = {
> +       .probe = sprd_i2c_probe,
> +       .remove = sprd_i2c_remove,
> +       .driver = {
> +                  .name = "sprd-i2c",

> +                  .of_match_table = of_match_ptr(sprd_i2c_of_match),

of_match_ptr seems redundant.

> +                  .pm = &sprd_i2c_pm_ops,
> +       },
> +};
> +

> +static int __init sprd_i2c_init(void)
> +{
> +       return platform_driver_register(&sprd_i2c_driver);
> +}

> +arch_initcall_sync(sprd_i2c_init);

Why?
Baolin Wang June 21, 2017, 3:25 a.m. UTC | #2
Hi Andy,

Sorry for late reply due to my business trip.

On ε…­,  6月 17, 2017 at 08:18:49δΈ‹εˆ +0300, Andy Shevchenko wrote:
> On Thu, Jun 15, 2017 at 2:30 PM, Baolin Wang <baolin.wang@spreadtrum.com> wrote:
> > This patch adds the I2C controller driver for Spreadtrum platform.
> 
> 
> > +       i2c_dev->irq = platform_get_irq(pdev, 0);
> > +       if (i2c_dev->irq < 0) {
> > +               dev_err(&pdev->dev, "failed to get irq resource\n");
> 
> > +               return -ENXIO;
> 
> Why shadow actual error?

Sorry for missing this and will fix in next version.

> 
> > +       }
> 
> 
> > +       if (!of_property_read_u32(dev->of_node, "clock-frequency", &prop))
> > +               i2c_dev->bus_freq = prop;
> > +
> > +       sprd_i2c_clk_init(i2c_dev);
> > +       platform_set_drvdata(pdev, i2c_dev);
> > +
> > +       pm_runtime_set_autosuspend_delay(i2c_dev->dev, SPRD_I2C_PM_TIMEOUT);
> > +       pm_runtime_use_autosuspend(i2c_dev->dev);
> > +       pm_runtime_set_active(i2c_dev->dev);
> > +       pm_runtime_enable(i2c_dev->dev);
> > +
> > +       ret = pm_runtime_get_sync(i2c_dev->dev);
> > +       if (ret < 0) {
> > +               dev_err(&pdev->dev, "i2c%d pm runtime resume failed!\n",
> > +                       pdev->id);
> 
> > +               return ret;
> 
> goto error;

Yes, will fix it.

> 
> > +       }
> > +
> > +       ret = devm_request_threaded_irq(dev, i2c_dev->irq,
> > +               sprd_i2c_isr, sprd_i2c_isr_thread,
> > +               IRQF_NO_SUSPEND | IRQF_ONESHOT,
> > +               pdev->name, i2c_dev);
> > +       if (ret) {
> > +               dev_err(&pdev->dev, "failed to request irq %d\n", i2c_dev->irq);
> > +               goto error;
> > +       }
> > +
> > +       ret = i2c_add_numbered_adapter(&i2c_dev->adap);
> > +       if (ret) {
> > +               dev_err(&pdev->dev, "add adapter failed\n");
> > +               goto error;
> > +       }
> > +
> > +       pm_runtime_mark_last_busy(i2c_dev->dev);
> > +       pm_runtime_put_autosuspend(i2c_dev->dev);
> > +       return 0;
> > +
> > +error:
> > +       pm_runtime_put_noidle(i2c_dev->dev);
> > +       pm_runtime_disable(i2c_dev->dev);
> > +       return ret;
> > +}
> > +
> > +static int sprd_i2c_remove(struct platform_device *pdev)
> > +{
> > +       struct sprd_i2c *i2c_dev = platform_get_drvdata(pdev);
> > +       int ret;
> > +
> 
> > +       ret = pm_runtime_get_sync(i2c_dev->dev);
> > +       if (ret < 0)
> > +               return ret;
> 
> Does it make any sense? Doesn't device core power on the device before
> calling ->remove() ?

Yes, you are right. We need power on device in probe() function.

> 
> > +
> > +       i2c_del_adapter(&i2c_dev->adap);
> > +
> > +       if (!IS_ERR_OR_NULL(i2c_dev->clk))
> 
> _OR_NULL looks suspicious.

Since our ->clk can be NULL as one optional connfig in case we test I2C
driver on FPGA platform which does not support clock operation.

> 
> > +               clk_unprepare(i2c_dev->clk);
> > +
> > +       pm_runtime_put_noidle(i2c_dev->dev);
> > +       pm_runtime_disable(i2c_dev->dev);
> > +
> > +       return 0;
> > +}
> > +
> 
> > +#ifdef CONFIG_PM_SLEEP
> 
> __maybe_unused instead?

OK.

> 
> > +static int sprd_i2c_suspend_noirq(struct device *pdev)
> 
> > +static int sprd_i2c_resume_noirq(struct device *pdev)
> 
> > +#endif  /* CONFIG_PM_SLEEP */
> 
> > +#ifdef CONFIG_PM
> 
> Ditto.

OK.

> 
> > +static int sprd_i2c_runtime_suspend(struct device *pdev)
> 
> > +}
> 
> > +static int sprd_i2c_runtime_resume(struct device *pdev)
> > +{
> 
> > +       clk_prepare_enable(i2c_dev->clk);
> 
> This might fail.

Yes, will check return value.

> 
> 
> > +}
> > +#endif  /* CONFIG_PM */
> 
> 
> > +static struct platform_driver sprd_i2c_driver = {
> > +       .probe = sprd_i2c_probe,
> > +       .remove = sprd_i2c_remove,
> > +       .driver = {
> > +                  .name = "sprd-i2c",
> 
> > +                  .of_match_table = of_match_ptr(sprd_i2c_of_match),
> 
> of_match_ptr seems redundant.

OK.

> 
> > +                  .pm = &sprd_i2c_pm_ops,
> > +       },
> > +};
> > +
> 
> > +static int __init sprd_i2c_init(void)
> > +{
> > +       return platform_driver_register(&sprd_i2c_driver);
> > +}
> 
> > +arch_initcall_sync(sprd_i2c_init);
> 
> Why?

IN our Spreadtrum platform, our regulator driver will depend on I2C driver
and the regulator driver uses subsys_initcall() level to initialize. Moreover
some other drivers like GPU, they will depend on regulator to set voltage and
they also need initialization much earlier. Thanks for your comments.

> 
> -- 
> With Best Regards,
> Andy Shevchenko
--
To unsubscribe from this list: send the line "unsubscribe devicetree" 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/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>;
+};
+