[v2,1/8] i2c: i2c-qcom-geni: Provide support for ACPI

Message ID 20190607082901.6491-1-lee.jones@linaro.org
State New
Headers show
Series
  • [v2,1/8] i2c: i2c-qcom-geni: Provide support for ACPI
Related show

Commit Message

Lee Jones June 7, 2019, 8:28 a.m.
Add a match table to allow automatic probing of ACPI device
QCOM0220.  Ignore clock attainment errors.  Set default clock
frequency value.

Signed-off-by: Lee Jones <lee.jones@linaro.org>

---
 drivers/i2c/busses/i2c-qcom-geni.c | 19 +++++++++++++++++--
 1 file changed, 17 insertions(+), 2 deletions(-)

-- 
2.17.1

Comments

Ard Biesheuvel June 7, 2019, 11:08 a.m. | #1
On Fri, 7 Jun 2019 at 10:29, Lee Jones <lee.jones@linaro.org> wrote:
>

> Add a match table to allow automatic probing of ACPI device

> QCOM0220.  Ignore clock attainment errors.  Set default clock

> frequency value.

>

> Signed-off-by: Lee Jones <lee.jones@linaro.org>

> ---

>  drivers/i2c/busses/i2c-qcom-geni.c | 19 +++++++++++++++++--

>  1 file changed, 17 insertions(+), 2 deletions(-)

>

> diff --git a/drivers/i2c/busses/i2c-qcom-geni.c b/drivers/i2c/busses/i2c-qcom-geni.c

> index db075bc0d952..0fa93b448e8d 100644

> --- a/drivers/i2c/busses/i2c-qcom-geni.c

> +++ b/drivers/i2c/busses/i2c-qcom-geni.c

> @@ -1,6 +1,7 @@

>  // SPDX-License-Identifier: GPL-2.0

>  // Copyright (c) 2017-2018, The Linux Foundation. All rights reserved.

>

> +#include <linux/acpi.h>

>  #include <linux/clk.h>

>  #include <linux/dma-mapping.h>

>  #include <linux/err.h>

> @@ -483,6 +484,12 @@ static const struct i2c_algorithm geni_i2c_algo = {

>         .functionality  = geni_i2c_func,

>  };

>

> +static const struct acpi_device_id geni_i2c_acpi_match[] = {

> +       { "QCOM0220"},

> +       { },

> +};

> +MODULE_DEVICE_TABLE(acpi, geni_i2c_acpi_match);

> +


We usually put #ifdef CONFIG_ACPI/#endif around these, otherwise you
end up with acpi:XXXX modaliases even though ACPI is not compiled in.

>  static int geni_i2c_probe(struct platform_device *pdev)

>  {

>         struct geni_i2c_dev *gi2c;

> @@ -502,7 +509,7 @@ static int geni_i2c_probe(struct platform_device *pdev)

>                 return PTR_ERR(gi2c->se.base);

>

>         gi2c->se.clk = devm_clk_get(&pdev->dev, "se");


Can we avoid this call altogether in ACPI mode? Also, please use
'has_acpi_companion()' to test whether we are probing via ACPI.

> -       if (IS_ERR(gi2c->se.clk)) {

> +       if (IS_ERR(gi2c->se.clk) && !ACPI_HANDLE(&pdev->dev)) {



>                 ret = PTR_ERR(gi2c->se.clk);

>                 dev_err(&pdev->dev, "Err getting SE Core clk %d\n", ret);

>                 return ret;

> @@ -510,12 +517,19 @@ static int geni_i2c_probe(struct platform_device *pdev)

>

>         ret = device_property_read_u32(&pdev->dev, "clock-frequency",

>                                                         &gi2c->clk_freq_out);

> -       if (ret) {

> +       if (ret && !ACPI_HANDLE(&pdev->dev)) {

>                 dev_info(&pdev->dev,

>                         "Bus frequency not specified, default to 100kHz.\n");

>                 gi2c->clk_freq_out = KHZ(100);

>         }

>

> +       if (ACPI_HANDLE(&pdev->dev)) {

> +               ACPI_COMPANION_SET(&gi2c->adap.dev, ACPI_COMPANION(&pdev->dev));

> +

> +               /* Using default, same as the !ACPI case above */

> +               gi2c->clk_freq_out = KHZ(100);

> +       }

> +


You are overriding the speed to 100 kHz even if the ACPI device has a
"clock-frequency" property.

>         gi2c->irq = platform_get_irq(pdev, 0);

>         if (gi2c->irq < 0) {

>                 dev_err(&pdev->dev, "IRQ error for i2c-geni\n");

> @@ -660,6 +674,7 @@ static struct platform_driver geni_i2c_driver = {

>                 .name = "geni_i2c",

>                 .pm = &geni_i2c_pm_ops,

>                 .of_match_table = geni_i2c_dt_match,

> +               .acpi_match_table = ACPI_PTR(geni_i2c_acpi_match),

>         },

>  };

>

> --

> 2.17.1

>

>

> _______________________________________________

> linux-arm-kernel mailing list

> linux-arm-kernel@lists.infradead.org

> http://lists.infradead.org/mailman/listinfo/linux-arm-kernel
Ard Biesheuvel June 7, 2019, 11:08 a.m. | #2
On Fri, 7 Jun 2019 at 10:29, Lee Jones <lee.jones@linaro.org> wrote:
>

> The Qualcomm Geni I2C driver currently probes silently which can be

> confusing when debugging potential issues.  Add a low level (INFO)

> print when each I2C controller is successfully initially set-up.

>

> Signed-off-by: Lee Jones <lee.jones@linaro.org>

> ---

>  drivers/i2c/busses/i2c-qcom-geni.c | 2 ++

>  1 file changed, 2 insertions(+)

>

> diff --git a/drivers/i2c/busses/i2c-qcom-geni.c b/drivers/i2c/busses/i2c-qcom-geni.c

> index 0fa93b448e8d..720131c40fe0 100644

> --- a/drivers/i2c/busses/i2c-qcom-geni.c

> +++ b/drivers/i2c/busses/i2c-qcom-geni.c

> @@ -598,6 +598,8 @@ static int geni_i2c_probe(struct platform_device *pdev)

>                 return ret;

>         }

>

> +       dev_dbg(&pdev->dev, "Geni-I2C adaptor successfully added\n");

> +

>         return 0;

>  }

>


Acked-by: Ard Biesheuvel <ard.biesheuvel@linaro.org>
Ard Biesheuvel June 7, 2019, 11:10 a.m. | #3
On Fri, 7 Jun 2019 at 10:29, Lee Jones <lee.jones@linaro.org> wrote:
>

> When booting MSM based platforms with Device Tree or some ACPI

> implementations, it is possible to provide a list of reserved pins

> via the 'gpio-reserved-ranges' and 'gpios' properties respectively.

> However some ACPI tables are not populated with this information,

> thus it has to come from a knowledgable device driver instead.

>

> Here we provide the MSM common driver with additional support to

> parse this informtion and correctly populate the widely used

> 'valid_mask'.

>

> Signed-off-by: Lee Jones <lee.jones@linaro.org>


I'm not sure if this is the correct approach. Presumably, on ACPI
systems, all the pinctl stuff is already set up by the firmware, and
so we shouldn't touch *any* pins unless they have been requested
explicitly. Is there any way we can support this in the current
framework?

> ---

>  drivers/pinctrl/qcom/pinctrl-msm.c | 18 ++++++++++++++++++

>  drivers/pinctrl/qcom/pinctrl-msm.h |  1 +

>  2 files changed, 19 insertions(+)

>

> diff --git a/drivers/pinctrl/qcom/pinctrl-msm.c b/drivers/pinctrl/qcom/pinctrl-msm.c

> index ee8119879c4c..3ac740b36508 100644

> --- a/drivers/pinctrl/qcom/pinctrl-msm.c

> +++ b/drivers/pinctrl/qcom/pinctrl-msm.c

> @@ -607,8 +607,23 @@ static int msm_gpio_init_valid_mask(struct gpio_chip *chip)

>         int ret;

>         unsigned int len, i;

>         unsigned int max_gpios = pctrl->soc->ngpios;

> +       const int *reserved = pctrl->soc->reserved_gpios;

>         u16 *tmp;

>

> +       /* Driver provided reserved list overrides DT and ACPI */

> +       if (reserved) {

> +               bitmap_fill(chip->valid_mask, max_gpios);

> +               for (i = 0; reserved[i] >= 0; i++) {

> +                       if (i >= max_gpios || reserved[i] >= max_gpios) {

> +                               dev_err(pctrl->dev, "invalid list of reserved GPIOs\n");

> +                               return -EINVAL;

> +                       }

> +                       clear_bit(reserved[i], chip->valid_mask);

> +               }

> +

> +               return 0;

> +       }

> +

>         /* The number of GPIOs in the ACPI tables */

>         len = ret = device_property_read_u16_array(pctrl->dev, "gpios", NULL,

>                                                    0);

> @@ -964,6 +979,9 @@ static void msm_gpio_irq_handler(struct irq_desc *desc)

>

>  static bool msm_gpio_needs_valid_mask(struct msm_pinctrl *pctrl)

>  {

> +       if (pctrl->soc->reserved_gpios)

> +               return true;

> +

>         return device_property_read_u16_array(pctrl->dev, "gpios", NULL, 0) > 0;

>  }

>

> diff --git a/drivers/pinctrl/qcom/pinctrl-msm.h b/drivers/pinctrl/qcom/pinctrl-msm.h

> index c12048e54a6f..23b93ae92269 100644

> --- a/drivers/pinctrl/qcom/pinctrl-msm.h

> +++ b/drivers/pinctrl/qcom/pinctrl-msm.h

> @@ -121,6 +121,7 @@ struct msm_pinctrl_soc_data {

>         bool pull_no_keeper;

>         const char *const *tiles;

>         unsigned int ntiles;

> +       const int *reserved_gpios;

>  };

>

>  extern const struct dev_pm_ops msm_pinctrl_dev_pm_ops;

> --

> 2.17.1

>

>

> _______________________________________________

> linux-arm-kernel mailing list

> linux-arm-kernel@lists.infradead.org

> http://lists.infradead.org/mailman/listinfo/linux-arm-kernel
Ard Biesheuvel June 7, 2019, 11:12 a.m. | #4
On Fri, 7 Jun 2019 at 10:30, Lee Jones <lee.jones@linaro.org> wrote:
>

> This patch provides basic support for booting with ACPI instead

> of the currently supported Device Tree.  When doing so there are a

> couple of differences which we need to taken into consideration.

>

> Firstly, the SDM850 ACPI tables omit information pertaining to the

> 4 reserved GPIOs on the platform.  If Linux attempts to touch/

> initialise any of these lines, the firmware will restart the

> platform.

>

> Secondly, when booting with ACPI, it is expected that the firmware

> will set-up things like; Regulators, Clocks, Pin Functions, etc in

> their ideal configuration.  Thus, the possible Pin Functions

> available to this platform are not advertised when providing the

> higher GPIOD/Pinctrl APIs with pin information.

>

> Signed-off-by: Lee Jones <lee.jones@linaro.org>

> ---

>  drivers/pinctrl/qcom/Kconfig          |  2 +-

>  drivers/pinctrl/qcom/pinctrl-sdm845.c | 35 ++++++++++++++++++++++++++-

>  2 files changed, 35 insertions(+), 2 deletions(-)

>

> diff --git a/drivers/pinctrl/qcom/Kconfig b/drivers/pinctrl/qcom/Kconfig

> index 2e66ab72c10b..aafbe932424f 100644

> --- a/drivers/pinctrl/qcom/Kconfig

> +++ b/drivers/pinctrl/qcom/Kconfig

> @@ -168,7 +168,7 @@ config PINCTRL_SDM660

>

>  config PINCTRL_SDM845

>         tristate "Qualcomm Technologies Inc SDM845 pin controller driver"

> -       depends on GPIOLIB && OF

> +       depends on GPIOLIB && (OF || ACPI)

>         select PINCTRL_MSM

>         help

>           This is the pinctrl, pinmux, pinconf and gpiolib driver for the

> diff --git a/drivers/pinctrl/qcom/pinctrl-sdm845.c b/drivers/pinctrl/qcom/pinctrl-sdm845.c

> index c97f20fca5fd..7188bee3cf3e 100644

> --- a/drivers/pinctrl/qcom/pinctrl-sdm845.c

> +++ b/drivers/pinctrl/qcom/pinctrl-sdm845.c

> @@ -3,6 +3,7 @@

>   * Copyright (c) 2016-2018, The Linux Foundation. All rights reserved.

>   */

>

> +#include <linux/acpi.h>

>  #include <linux/module.h>

>  #include <linux/of.h>

>  #include <linux/platform_device.h>

> @@ -1277,6 +1278,10 @@ static const struct msm_pingroup sdm845_groups[] = {

>         UFS_RESET(ufs_reset, 0x99f000),

>  };

>

> +static const int sdm845_acpi_reserved_gpios[] = {

> +       0, 1, 2, 3, 81, 82, 83, 84, -1

> +};

> +

>  static const struct msm_pinctrl_soc_data sdm845_pinctrl = {

>         .pins = sdm845_pins,

>         .npins = ARRAY_SIZE(sdm845_pins),

> @@ -1284,14 +1289,41 @@ static const struct msm_pinctrl_soc_data sdm845_pinctrl = {

>         .nfunctions = ARRAY_SIZE(sdm845_functions),

>         .groups = sdm845_groups,

>         .ngroups = ARRAY_SIZE(sdm845_groups),

> +       .reserved_gpios = sdm845_acpi_reserved_gpios,

> +       .ngpios = 150,

> +};

> +

> +static const struct msm_pinctrl_soc_data sdm845_acpi_pinctrl = {

> +       .pins = sdm845_pins,

> +       .npins = ARRAY_SIZE(sdm845_pins),

> +       .groups = sdm845_groups,

> +       .ngroups = ARRAY_SIZE(sdm845_groups),

> +       .reserved_gpios = sdm845_acpi_reserved_gpios,

>         .ngpios = 150,

>  };

>

>  static int sdm845_pinctrl_probe(struct platform_device *pdev)

>  {

> -       return msm_pinctrl_probe(pdev, &sdm845_pinctrl);

> +       int ret;

> +

> +       if (pdev->dev.of_node) {

> +               ret = msm_pinctrl_probe(pdev, &sdm845_pinctrl);

> +       } else if (ACPI_HANDLE(&pdev->dev)) {


Please use has_acpi_companion() here

> +               ret = msm_pinctrl_probe(pdev, &sdm845_acpi_pinctrl);

> +       } else {

> +               dev_err(&pdev->dev, "DT and ACPI disabled\n");

> +               return -EINVAL;

> +       }

> +

> +       return ret;

>  }

>

> +static const struct acpi_device_id sdm845_pinctrl_acpi_match[] = {

> +       { "QCOM0217"},

> +       { },

> +};

> +MODULE_DEVICE_TABLE(acpi, sdm845_pinctrl_acpi_match);

> +


Put this in a #ifdef CONFIG_ACPI please

>  static const struct of_device_id sdm845_pinctrl_of_match[] = {

>         { .compatible = "qcom,sdm845-pinctrl", },

>         { },

> @@ -1302,6 +1334,7 @@ static struct platform_driver sdm845_pinctrl_driver = {

>                 .name = "sdm845-pinctrl",

>                 .pm = &msm_pinctrl_dev_pm_ops,

>                 .of_match_table = sdm845_pinctrl_of_match,

> +               .acpi_match_table = ACPI_PTR(sdm845_pinctrl_acpi_match),

>         },

>         .probe = sdm845_pinctrl_probe,

>         .remove = msm_pinctrl_remove,

> --

> 2.17.1

>

>

> _______________________________________________

> linux-arm-kernel mailing list

> linux-arm-kernel@lists.infradead.org

> http://lists.infradead.org/mailman/listinfo/linux-arm-kernel
Lee Jones June 10, 2019, 6:44 a.m. | #5
On Fri, 07 Jun 2019, Ard Biesheuvel wrote:

> On Fri, 7 Jun 2019 at 10:29, Lee Jones <lee.jones@linaro.org> wrote:

> >

> > Add a match table to allow automatic probing of ACPI device

> > QCOM0220.  Ignore clock attainment errors.  Set default clock

> > frequency value.

> >

> > Signed-off-by: Lee Jones <lee.jones@linaro.org>

> > ---

> >  drivers/i2c/busses/i2c-qcom-geni.c | 19 +++++++++++++++++--

> >  1 file changed, 17 insertions(+), 2 deletions(-)

> >

> > diff --git a/drivers/i2c/busses/i2c-qcom-geni.c b/drivers/i2c/busses/i2c-qcom-geni.c

> > index db075bc0d952..0fa93b448e8d 100644

> > --- a/drivers/i2c/busses/i2c-qcom-geni.c

> > +++ b/drivers/i2c/busses/i2c-qcom-geni.c

> > @@ -1,6 +1,7 @@

> >  // SPDX-License-Identifier: GPL-2.0

> >  // Copyright (c) 2017-2018, The Linux Foundation. All rights reserved.

> >

> > +#include <linux/acpi.h>

> >  #include <linux/clk.h>

> >  #include <linux/dma-mapping.h>

> >  #include <linux/err.h>

> > @@ -483,6 +484,12 @@ static const struct i2c_algorithm geni_i2c_algo = {

> >         .functionality  = geni_i2c_func,

> >  };

> >

> > +static const struct acpi_device_id geni_i2c_acpi_match[] = {

> > +       { "QCOM0220"},

> > +       { },

> > +};

> > +MODULE_DEVICE_TABLE(acpi, geni_i2c_acpi_match);

> > +

> 

> We usually put #ifdef CONFIG_ACPI/#endif around these, otherwise you

> end up with acpi:XXXX modaliases even though ACPI is not compiled in.


No problem.

> >  static int geni_i2c_probe(struct platform_device *pdev)

> >  {

> >         struct geni_i2c_dev *gi2c;

> > @@ -502,7 +509,7 @@ static int geni_i2c_probe(struct platform_device *pdev)

> >                 return PTR_ERR(gi2c->se.base);

> >

> >         gi2c->se.clk = devm_clk_get(&pdev->dev, "se");

> 

> Can we avoid this call altogether in ACPI mode? Also, please use


I'm trying not to place all non-ACPI specific callers into if ()
statements.  The tabbing becomes ridiculous in some places.  A great
deal of these calls are requesting optional resources too, so it's
better to simply ignore the returning error in the cases where
non-optional resources (such as this one) are requested, since it has
the least impact on the existing code.

> 'has_acpi_companion()' to test whether we are probing via ACPI.


Sure.

> > -       if (IS_ERR(gi2c->se.clk)) {

> > +       if (IS_ERR(gi2c->se.clk) && !ACPI_HANDLE(&pdev->dev)) {

> 

> 

> >                 ret = PTR_ERR(gi2c->se.clk);

> >                 dev_err(&pdev->dev, "Err getting SE Core clk %d\n", ret);

> >                 return ret;

> > @@ -510,12 +517,19 @@ static int geni_i2c_probe(struct platform_device *pdev)

> >

> >         ret = device_property_read_u32(&pdev->dev, "clock-frequency",

> >                                                         &gi2c->clk_freq_out);

> > -       if (ret) {

> > +       if (ret && !ACPI_HANDLE(&pdev->dev)) {

> >                 dev_info(&pdev->dev,

> >                         "Bus frequency not specified, default to 100kHz.\n");

> >                 gi2c->clk_freq_out = KHZ(100);

> >         }

> >

> > +       if (ACPI_HANDLE(&pdev->dev)) {

> > +               ACPI_COMPANION_SET(&gi2c->adap.dev, ACPI_COMPANION(&pdev->dev));

> > +

> > +               /* Using default, same as the !ACPI case above */

> > +               gi2c->clk_freq_out = KHZ(100);

> > +       }

> > +

> 

> You are overriding the speed to 100 kHz even if the ACPI device has a

> "clock-frequency" property.


Will look at this.

Thanks Ard.

-- 
Lee Jones [李琼斯]
Linaro Services Technical Lead
Linaro.org │ Open source software for ARM SoCs
Follow Linaro: Facebook | Twitter | Blog

Patch

diff --git a/drivers/i2c/busses/i2c-qcom-geni.c b/drivers/i2c/busses/i2c-qcom-geni.c
index db075bc0d952..0fa93b448e8d 100644
--- a/drivers/i2c/busses/i2c-qcom-geni.c
+++ b/drivers/i2c/busses/i2c-qcom-geni.c
@@ -1,6 +1,7 @@ 
 // SPDX-License-Identifier: GPL-2.0
 // Copyright (c) 2017-2018, The Linux Foundation. All rights reserved.
 
+#include <linux/acpi.h>
 #include <linux/clk.h>
 #include <linux/dma-mapping.h>
 #include <linux/err.h>
@@ -483,6 +484,12 @@  static const struct i2c_algorithm geni_i2c_algo = {
 	.functionality	= geni_i2c_func,
 };
 
+static const struct acpi_device_id geni_i2c_acpi_match[] = {
+	{ "QCOM0220"},
+	{ },
+};
+MODULE_DEVICE_TABLE(acpi, geni_i2c_acpi_match);
+
 static int geni_i2c_probe(struct platform_device *pdev)
 {
 	struct geni_i2c_dev *gi2c;
@@ -502,7 +509,7 @@  static int geni_i2c_probe(struct platform_device *pdev)
 		return PTR_ERR(gi2c->se.base);
 
 	gi2c->se.clk = devm_clk_get(&pdev->dev, "se");
-	if (IS_ERR(gi2c->se.clk)) {
+	if (IS_ERR(gi2c->se.clk) && !ACPI_HANDLE(&pdev->dev)) {
 		ret = PTR_ERR(gi2c->se.clk);
 		dev_err(&pdev->dev, "Err getting SE Core clk %d\n", ret);
 		return ret;
@@ -510,12 +517,19 @@  static int geni_i2c_probe(struct platform_device *pdev)
 
 	ret = device_property_read_u32(&pdev->dev, "clock-frequency",
 							&gi2c->clk_freq_out);
-	if (ret) {
+	if (ret && !ACPI_HANDLE(&pdev->dev)) {
 		dev_info(&pdev->dev,
 			"Bus frequency not specified, default to 100kHz.\n");
 		gi2c->clk_freq_out = KHZ(100);
 	}
 
+	if (ACPI_HANDLE(&pdev->dev)) {
+		ACPI_COMPANION_SET(&gi2c->adap.dev, ACPI_COMPANION(&pdev->dev));
+
+		/* Using default, same as the !ACPI case above */
+		gi2c->clk_freq_out = KHZ(100);
+	}
+
 	gi2c->irq = platform_get_irq(pdev, 0);
 	if (gi2c->irq < 0) {
 		dev_err(&pdev->dev, "IRQ error for i2c-geni\n");
@@ -660,6 +674,7 @@  static struct platform_driver geni_i2c_driver = {
 		.name = "geni_i2c",
 		.pm = &geni_i2c_pm_ops,
 		.of_match_table = geni_i2c_dt_match,
+		.acpi_match_table = ACPI_PTR(geni_i2c_acpi_match),
 	},
 };