mbox series

[v7,0/9] iio: adc: introduce Qualcomm SPMI Round Robin ADC

Message ID 20220216134920.239989-1-caleb.connolly@linaro.org
Headers show
Series iio: adc: introduce Qualcomm SPMI Round Robin ADC | expand

Message

Caleb Connolly Feb. 16, 2022, 1:49 p.m. UTC
The RRADC is responsible for reading data about the current and
voltage from the USB or DC in jacks, it can also read the battery
ID (resistence) and some temperatures. It is found on the PMI8998 and
PM660 Qualcomm PMICs.

The RRADC has to calibrate some ADC values based on which chip fab
the PMIC was produced in, to facilitate this the patches
("mfd: qcom-spmi-pmic: expose the PMIC revid information to clients")
and ("mfd: qcom-spmi-pmic: read fab id on supported PMICs")
expose the PMIC revision information and fab_id as a struct and register
them as driver data in the Qualcomm SPMI PMIC driver so that it can be
read by the RRADC.

The first 3 patches add support for looking up an SPMI device from a
struct device_node, as well as introducing support for looking up the
base USID of a Qcom PMIC, see patch comments for more details. These
Address Bjorns comments on v2.

Changes since v6:
 * Fix printf format warning in rradc

Changes since v5:
 * Add missing EXPORT_SYMBOL_GPL() to
   ("spmi: add a helper to look up an SPMI device from a device node")

Changes since v4:
 * Addressed Jonathan's comments on v4
 * Reworked the qcom-spmi-pmic patches to properly walk the devicetree
   to find the base USID. I've tested this on SDM845 which has two PMICs
   (pm8998 and pmi8998) and I'm able to look up the PMIC revid from all
   4 USIDs.

Changes since v3:
 * Split PMIC patch in two, rework to support function drivers on a
   sibling USID
 * Completely rework RRADC driver to make use of the modern IIO
   framework. This required re-arranging a lot of the equations and
   results in some lost precision, where relevant I've left comments to
   explain this. I don't think any of it is significant enough to
   justify doing post-processing in driver.
	Thanks a lot Jonathan and John Stultz for helping me out with
	this 

Changes since v2:
 * Add missing include (thanks kernel test robot :D)
 * Rework some confusing function return values, specifically
   rradc_read_status_in_cont_mode and rradc_prepare_batt_id_conversion
   both of which didn't correctly handle "ret". This also bought up an
   issue as the previous implementation didn't actually wait for the
   channel to be ready. It doesn't seem like that's strictly necessary
   (same data is reported if I wait for the status to be good or not)
   but I've included it anyway for good measure.

Changes since v1:
 * Rework the RRADC driver based on Jonathan's feedback
 * Pick up Rob's reviewed by for the dt-binding patch.

 --

Caleb Connolly (9):
  spmi: add a helper to look up an SPMI device from a device node
  mfd: qcom-spmi-pmic: expose the PMIC revid information to clients
  mfd: qcom-spmi-pmic: read fab id on supported PMICs
  dt-bindings: iio: adc: document qcom-spmi-rradc
  iio: adc: qcom-spmi-rradc: introduce round robin adc
  arm64: dts: qcom: pmi8998: add rradc node
  arm64: dts: qcom: sdm845-oneplus: enable rradc
  arm64: dts: qcom: sdm845-db845c: enable rradc
  arm64: dts: qcom: sdm845-xiaomi-beryllium: enable rradc

 .../bindings/iio/adc/qcom,spmi-rradc.yaml     |   54 +
 arch/arm64/boot/dts/qcom/pmi8998.dtsi         |    8 +
 arch/arm64/boot/dts/qcom/sdm845-db845c.dts    |    4 +
 .../boot/dts/qcom/sdm845-oneplus-common.dtsi  |    4 +
 .../boot/dts/qcom/sdm845-xiaomi-beryllium.dts |    4 +
 drivers/iio/adc/Kconfig                       |   12 +
 drivers/iio/adc/Makefile                      |    1 +
 drivers/iio/adc/qcom-spmi-rradc.c             | 1016 +++++++++++++++++
 drivers/mfd/qcom-spmi-pmic.c                  |  183 ++-
 drivers/spmi/spmi.c                           |   17 +
 include/linux/spmi.h                          |    2 +
 include/soc/qcom/qcom-spmi-pmic.h             |   61 +
 12 files changed, 1309 insertions(+), 57 deletions(-)
 create mode 100644 Documentation/devicetree/bindings/iio/adc/qcom,spmi-rradc.yaml
 create mode 100644 drivers/iio/adc/qcom-spmi-rradc.c
 create mode 100644 include/soc/qcom/qcom-spmi-pmic.h

Comments

Jonathan Cameron Feb. 19, 2022, 6:19 p.m. UTC | #1
On Wed, 16 Feb 2022 13:49:12 +0000
Caleb Connolly <caleb.connolly@linaro.org> wrote:

> The helper function spmi_device_from_of() takes a device node and
> returns the SPMI device associated with it.
> This is like of_find_device_by_node but for SPMI devices.
> 
> Signed-off-by: Caleb Connolly <caleb.connolly@linaro.org>
> ---
>  drivers/spmi/spmi.c  | 17 +++++++++++++++++
>  include/linux/spmi.h |  2 ++
>  2 files changed, 19 insertions(+)
> 
> diff --git a/drivers/spmi/spmi.c b/drivers/spmi/spmi.c
> index b37ead9e2fad..de550b777451 100644
> --- a/drivers/spmi/spmi.c
> +++ b/drivers/spmi/spmi.c
> @@ -386,6 +386,23 @@ static struct bus_type spmi_bus_type = {
>  	.uevent		= spmi_drv_uevent,
>  };
>  
> +/**
> + * spmi_device_from_of() - get the associated SPMI device from a device node
> + *

https://www.kernel.org/doc/html/latest/doc-guide/kernel-doc.html
"Each function argument should be described in order, immediately following the
 short function description. Do not leave a blank line between the function
 description and the arguments, nor between the arguments."

> + * @np:		device node
> + *
> + * Returns the struct spmi_device associated with a device node or NULL.
> + */
> +inline struct spmi_device *spmi_device_from_of(struct device_node *np)
> +{
> +	struct device *dev = bus_find_device_by_of_node(&spmi_bus_type, np);
> +
> +	if (dev)
> +		return to_spmi_device(dev);
> +	return NULL;
> +}
> +EXPORT_SYMBOL_GPL(spmi_device_from_of);
> +
>  /**
>   * spmi_controller_alloc() - Allocate a new SPMI device
>   * @ctrl:	associated controller
> diff --git a/include/linux/spmi.h b/include/linux/spmi.h
> index 729bcbf9f5ad..6ee476bc1cd6 100644
> --- a/include/linux/spmi.h
> +++ b/include/linux/spmi.h
> @@ -7,6 +7,7 @@
>  #include <linux/types.h>
>  #include <linux/device.h>
>  #include <linux/mod_devicetable.h>
> +#include <linux/of.h>

If all you need is struct device_node * then normally preferred to
use a forwards definition rather than including the header.

struct device_node;

>  
>  /* Maximum slave identifier */
>  #define SPMI_MAX_SLAVE_ID		16
> @@ -164,6 +165,7 @@ static inline void spmi_driver_unregister(struct spmi_driver *sdrv)
>  	module_driver(__spmi_driver, spmi_driver_register, \
>  			spmi_driver_unregister)
>  
> +inline struct spmi_device *spmi_device_from_of(struct device_node *np);
>  int spmi_register_read(struct spmi_device *sdev, u8 addr, u8 *buf);
>  int spmi_ext_register_read(struct spmi_device *sdev, u8 addr, u8 *buf,
>  			   size_t len);
Jonathan Cameron Feb. 19, 2022, 6:27 p.m. UTC | #2
On Wed, 16 Feb 2022 13:49:13 +0000
Caleb Connolly <caleb.connolly@linaro.org> wrote:

> Some PMIC functions such as the RRADC need to be aware of the PMIC
> chip revision information to implement errata or otherwise adjust
> behaviour, export the PMIC information to enable this.
> 
> This is specifically required to enable the RRADC to adjust
> coefficients based on which chip fab the PMIC was produced in,
> this can vary per unique device and therefore has to be read at
> runtime.
> 
> Signed-off-by: Caleb Connolly <caleb.connolly@linaro.org>
Hi Caleb,

A few minor comments inline.

Thanks,

Jonathan

> ---
>  drivers/mfd/qcom-spmi-pmic.c      | 176 ++++++++++++++++++++----------
>  include/soc/qcom/qcom-spmi-pmic.h |  60 ++++++++++
>  2 files changed, 179 insertions(+), 57 deletions(-)
>  create mode 100644 include/soc/qcom/qcom-spmi-pmic.h
> 
> diff --git a/drivers/mfd/qcom-spmi-pmic.c b/drivers/mfd/qcom-spmi-pmic.c
> index 1cacc00aa6c9..5e656485cd55 100644
> --- a/drivers/mfd/qcom-spmi-pmic.c
> +++ b/drivers/mfd/qcom-spmi-pmic.c
> @@ -3,51 +3,26 @@
>   * Copyright (c) 2014, The Linux Foundation. All rights reserved.
>   */
>  
> +#include <linux/device.h>
> +#include <linux/errno.h>
> +#include <linux/gfp.h>
>  #include <linux/kernel.h>
>  #include <linux/module.h>
> +#include <linux/math.h>
> +#include <linux/slab.h>
>  #include <linux/spmi.h>
> +#include <linux/types.h>
>  #include <linux/regmap.h>
>  #include <linux/of_platform.h>
> +#include <soc/qcom/qcom-spmi-pmic.h>

All these new headers are a result of changes in this patch?
Some clearly are, but device.h / errno.h?

If you want to add missing ones that should always have been here
it belongs in a different patch.

>  
>  #define PMIC_REV2		0x101
>  #define PMIC_REV3		0x102
>  #define PMIC_REV4		0x103
>  #define PMIC_TYPE		0x104
>  #define PMIC_SUBTYPE		0x105
> -

Unrelated change.  Please check through patches for this sort of noise.
Whilst it doesn't matter in this particular case, it is good practice to
ensure it isn't there to distract a reviewer from what matters.

>  #define PMIC_TYPE_VALUE		0x51
>  
> -#define COMMON_SUBTYPE		0x00
> -#define PM8941_SUBTYPE		0x01
> -#define PM8841_SUBTYPE		0x02
> -#define PM8019_SUBTYPE		0x03
> -#define PM8226_SUBTYPE		0x04
> -#define PM8110_SUBTYPE		0x05
> -#define PMA8084_SUBTYPE		0x06
> -#define PMI8962_SUBTYPE		0x07
> -#define PMD9635_SUBTYPE		0x08
> -#define PM8994_SUBTYPE		0x09
> -#define PMI8994_SUBTYPE		0x0a
> -#define PM8916_SUBTYPE		0x0b
> -#define PM8004_SUBTYPE		0x0c
> -#define PM8909_SUBTYPE		0x0d
> -#define PM8028_SUBTYPE		0x0e
> -#define PM8901_SUBTYPE		0x0f
> -#define PM8950_SUBTYPE		0x10
> -#define PMI8950_SUBTYPE		0x11
> -#define PM8998_SUBTYPE		0x14
> -#define PMI8998_SUBTYPE		0x15
> -#define PM8005_SUBTYPE		0x18
> -#define PM660L_SUBTYPE		0x1A
> -#define PM660_SUBTYPE		0x1B
> -#define PM8150_SUBTYPE		0x1E
> -#define PM8150L_SUBTYPE		0x1f
> -#define PM8150B_SUBTYPE		0x20
> -#define PMK8002_SUBTYPE		0x21
> -#define PM8009_SUBTYPE		0x24
> -#define PM8150C_SUBTYPE		0x26
> -#define SMB2351_SUBTYPE		0x29
> -
>  static const struct of_device_id pmic_spmi_id_table[] = {
>  	{ .compatible = "qcom,pm660",     .data = (void *)PM660_SUBTYPE },
>  	{ .compatible = "qcom,pm660l",    .data = (void *)PM660L_SUBTYPE },
> @@ -81,42 +56,118 @@ static const struct of_device_id pmic_spmi_id_table[] = {
>  	{ }
>  };
>  
> -static void pmic_spmi_show_revid(struct regmap *map, struct device *dev)
> +/**

Run kernel-doc script over this and fix all the errors + warnings.
I'm fairly sure you will get some.

> + * @brief Get a pointer to the base PMIC device
> + *
> + * @param dev the pmic function device
> + * @return const struct qcom_spmi_pmic*
> + *
> + * A PMIC can be represented by multiple SPMI devices, but
> + * only the base PMIC device will contain a reference to
> + * the revision information.
> + *
> + * This function takes a pointer to a function device and
> + * returns a pointer to the base PMIC device.
> + */
> +const struct qcom_spmi_pmic *qcom_pmic_get(struct device *dev)
> +{
> +	struct spmi_device *sdev;
> +	struct device_node *spmi_bus;
> +	struct device_node *other_usid;
> +	int function_parent_usid, ret;
> +	u32 reg[2];
> +
> +	if (!of_match_device(pmic_spmi_id_table, dev->parent))
> +		return ERR_PTR(-EINVAL);
> +
> +	sdev = to_spmi_device(dev->parent);
> +	if (!sdev)
> +		return ERR_PTR(-EINVAL);
> +
> +	/*
> +	 * Quick return if the function device is already in the right
> +	 * USID
> +	 */
> +	if (sdev->usid % 2 == 0)
> +		return spmi_device_get_drvdata(sdev);
> +
> +	function_parent_usid = sdev->usid;
> +
> +	/*
> +	 * Walk through the list of PMICs until we find the sibling USID.
> +	 * The goal is the find to previous sibling. Assuming there is no
> +	 * PMIC with more than 2 USIDs. We know that function_parent_usid
> +	 * is one greater than the base USID.
> +	 */
> +	spmi_bus = of_get_parent(sdev->dev.parent->of_node);
> +	do {
> +		other_usid = of_get_next_child(spmi_bus, other_usid);
> +		ret = of_property_read_u32_array(other_usid, "reg", reg, 2);
> +		if (ret)
> +			return ERR_PTR(ret);
> +		sdev = spmi_device_from_of(other_usid);
> +		if (sdev == NULL) {
> +			/*
> +			 * If the base USID for this PMIC hasn't probed yet
> +			 * but the secondary USID has, then we need to defer
> +			 * the function driver so that it will attempt to
> +			 * probe again when the base USID is ready.
> +			 */
> +			if (reg[0] == function_parent_usid - 1)
> +				return ERR_PTR(-EPROBE_DEFER);
> +
> +			continue;
> +		}
> +
> +		if (reg[0] == function_parent_usid - 1)
> +			return spmi_device_get_drvdata(sdev);
> +	} while (other_usid->sibling);
> +
> +	return ERR_PTR(-ENODATA);
> +}
> +EXPORT_SYMBOL(qcom_pmic_get);
> +
> +static inline void pmic_print_info(struct device *dev, struct qcom_spmi_pmic *pmic)
> +{
> +	dev_info(dev, "%x: %s v%d.%d\n",
> +		pmic->subtype, pmic->name, pmic->major, pmic->minor);
> +}
> +
> +static int pmic_spmi_load_revid(struct regmap *map, struct device *dev,
> +				 struct qcom_spmi_pmic *pmic)
>  {
> -	unsigned int rev2, minor, major, type, subtype;
> -	const char *name = "unknown";
>  	int ret, i;
>  
> -	ret = regmap_read(map, PMIC_TYPE, &type);
> +	ret = regmap_read(map, PMIC_TYPE, &pmic->type);
>  	if (ret < 0)
> -		return;
> +		return ret;
>  
> -	if (type != PMIC_TYPE_VALUE)
> -		return;
> +	if (pmic->type != PMIC_TYPE_VALUE)
> +		return ret;
>  
> -	ret = regmap_read(map, PMIC_SUBTYPE, &subtype);
> +	ret = regmap_read(map, PMIC_SUBTYPE, &pmic->subtype);
>  	if (ret < 0)
> -		return;
> +		return ret;
>  
>  	for (i = 0; i < ARRAY_SIZE(pmic_spmi_id_table); i++) {
> -		if (subtype == (unsigned long)pmic_spmi_id_table[i].data)
> +		if (pmic->subtype == (unsigned long)pmic_spmi_id_table[i].data)
>  			break;
>  	}
>  
>  	if (i != ARRAY_SIZE(pmic_spmi_id_table))
> -		name = pmic_spmi_id_table[i].compatible;
> +		pmic->name = devm_kstrdup_const(dev, pmic_spmi_id_table[i].compatible, GFP_KERNEL);
>  
> -	ret = regmap_read(map, PMIC_REV2, &rev2);
> +	ret = regmap_read(map, PMIC_REV2, &pmic->rev2);
>  	if (ret < 0)
> -		return;
> +		return ret;
>  
> -	ret = regmap_read(map, PMIC_REV3, &minor);
> +	ret = regmap_read(map, PMIC_REV3, &pmic->minor);
>  	if (ret < 0)
> -		return;
> +		return ret;
>  
> -	ret = regmap_read(map, PMIC_REV4, &major);
> +	ret = regmap_read(map, PMIC_REV4, &pmic->major);
>  	if (ret < 0)
> -		return;
> +		return ret;
>  
>  	/*
>  	 * In early versions of PM8941 and PM8226, the major revision number
> @@ -124,14 +175,14 @@ static void pmic_spmi_show_revid(struct regmap *map, struct device *dev)
>  	 * Increment the major revision number here if the chip is an early
>  	 * version of PM8941 or PM8226.
>  	 */
> -	if ((subtype == PM8941_SUBTYPE || subtype == PM8226_SUBTYPE) &&
> -	    major < 0x02)
> -		major++;
> +	if ((pmic->subtype == PM8941_SUBTYPE || pmic->subtype == PM8226_SUBTYPE) &&
> +	    pmic->major < 0x02)
> +		pmic->major++;
>  
> -	if (subtype == PM8110_SUBTYPE)
> -		minor = rev2;
> +	if (pmic->subtype == PM8110_SUBTYPE)
> +		pmic->minor = pmic->rev2;
>  
> -	dev_dbg(dev, "%x: %s v%d.%d\n", subtype, name, major, minor);

Why remove the dev_dbg?

> +	return 0;
>  }
>  
>  static const struct regmap_config spmi_regmap_config = {
> @@ -144,14 +195,25 @@ static const struct regmap_config spmi_regmap_config = {
>  static int pmic_spmi_probe(struct spmi_device *sdev)
>  {
>  	struct regmap *regmap;
> +	struct qcom_spmi_pmic *pmic;
> +	int ret;
>  
>  	regmap = devm_regmap_init_spmi_ext(sdev, &spmi_regmap_config);
>  	if (IS_ERR(regmap))
>  		return PTR_ERR(regmap);
>  
> +	pmic = devm_kzalloc(&sdev->dev, sizeof(*pmic), GFP_KERNEL);
> +	if (!pmic)
> +		return -ENOMEM;
> +
>  	/* Only the first slave id for a PMIC contains this information */
> -	if (sdev->usid % 2 == 0)
> -		pmic_spmi_show_revid(regmap, &sdev->dev);
> +	if (sdev->usid % 2 == 0) {
> +		ret = pmic_spmi_load_revid(regmap, &sdev->dev, pmic);
> +		if (ret < 0)
> +			return ret;
> +		spmi_device_set_drvdata(sdev, pmic);
> +		pmic_print_info(&sdev->dev, pmic);
> +	}
>  
>  	return devm_of_platform_populate(&sdev->dev);
>  }
Jonathan Cameron Feb. 19, 2022, 6:44 p.m. UTC | #3
On Wed, 16 Feb 2022 13:49:16 +0000
Caleb Connolly <caleb.connolly@linaro.org> wrote:

> The Round Robin ADC is responsible for reading data about the rate of
> charge from the USB or DC input ports, it can also read the battery
> ID (resistence), skin temperature and the die temperature of the pmic.
> It is found on the PMI8998 and PM660 Qualcomm PMICs.
> 
> Signed-off-by: Caleb Connolly <caleb.connolly@linaro.org>

Hi Caleb,

A few really trivial things noticed on a fresh read through. Given you
are spinning again might as well tidy them up.

Thanks,

Jonathan

...

> diff --git a/drivers/iio/adc/qcom-spmi-rradc.c b/drivers/iio/adc/qcom-spmi-rradc.c
> new file mode 100644
> index 000000000000..8d5675f625dc
> --- /dev/null
> +++ b/drivers/iio/adc/qcom-spmi-rradc.c
> @@ -0,0 +1,1016 @@
> +// SPDX-License-Identifier: GPL-2.0-only
> +/*
> + * Copyright (c) 2022 Linaro Limited.
> + *  Author: Caleb Connolly <caleb.connolly@linaro.org>
> + *
> + * This driver is for the Round Robin ADC found in the pmi8998 and pm660 PMICs.
> + */
> +
> +#include <linux/bitfield.h>
> +#include <linux/delay.h>
> +#include <linux/kernel.h>
> +#include <linux/math64.h>
> +#include <linux/module.h>
> +#include <linux/mod_devicetable.h>
> +#include <linux/platform_device.h>
> +#include <linux/regmap.h>
> +#include <linux/spmi.h>
> +#include <linux/types.h>
> +#include <linux/units.h>
> +
> +#include <asm/unaligned.h>
> +
> +#include <linux/iio/iio.h>
> +#include <linux/iio/types.h>
> +
> +#include <soc/qcom/qcom-spmi-pmic.h>
> +
> +#define DRIVER_NAME "qcom-spmi-rradc"
> +

> +
> +#define RR_ADC_STS_CHANNEL_READING_MASK GENMASK(1, 0) // 0x03

Drop the // 0x03 as I'd hope that's obvious! :) 

...

> +
> +struct rradc_chip {
> +	struct device *dev;
> +	const struct qcom_spmi_pmic *pmic;
> +	/* Lock held while doing channel conversion
	/*
	 * Lock ...

> +	 * involving multiple register read/writes
> +	 */
> +	struct mutex conversion_lock;
> +	struct regmap *regmap;
> +	u32 base;
> +	int batt_id_delay;
> +	u16 batt_id_data;
> +};
> +
> +static const int batt_id_delays[] = { 0, 1, 4, 12, 20, 40, 60, 80 };
> +static const struct rradc_channel rradc_chans[RR_ADC_CHAN_MAX];
> +static const struct iio_chan_spec rradc_iio_chans[RR_ADC_CHAN_MAX];
> +
> +static int rradc_read(struct rradc_chip *chip, u16 addr, u8 *data, int len)
> +{
> +	int ret, retry_cnt = 0;
> +	u8 data_check[RR_ADC_CHAN_MAX_CONTINUOUS_BUFFER_LEN];
> +
> +	if (len > RR_ADC_CHAN_MAX_CONTINUOUS_BUFFER_LEN) {
> +		dev_err(chip->dev,
> +			"Can't read more than %d bytes, but asked to read %d bytes.\n",
> +			RR_ADC_CHAN_MAX_CONTINUOUS_BUFFER_LEN, len);
> +		return -EINVAL;
> +	}
> +
> +	while (retry_cnt < RR_ADC_COHERENT_CHECK_RETRY) {
> +		ret = regmap_bulk_read(chip->regmap, chip->base + addr, data,
> +				       len);
> +		if (ret < 0) {
> +			dev_err(chip->dev, "rr_adc reg 0x%x failed :%d\n", addr,
> +				ret);
> +			return ret;
> +		}
> +
> +		ret = regmap_bulk_read(chip->regmap, chip->base + addr,
> +				       data_check, len);
> +		if (ret < 0) {
> +			dev_err(chip->dev, "rr_adc reg 0x%x failed :%d\n", addr,
> +				ret);
> +			return ret;
> +		}
> +
> +		if (memcmp(data, data_check, len) != 0) {
> +			retry_cnt++;
> +			dev_dbg(chip->dev,
> +				"coherent read error, retry_cnt:%d\n",
> +				retry_cnt);
> +			continue;
> +		}
> +
> +		break;
> +	}
> +
> +	if (retry_cnt == RR_ADC_COHERENT_CHECK_RETRY)
> +		dev_err(chip->dev, "Retry exceeded for coherrency check\n");
> +
> +	return ret;
> +}
> +
> +static int rradc_get_fab_coeff(struct rradc_chip *chip, int64_t *offset,
> +			       int64_t *slope)
> +{
> +	if (chip->pmic->subtype == PM660_SUBTYPE) {
> +		switch (chip->pmic->fab_id) {
> +		case PM660_FAB_ID_GF:
> +			*offset = RR_ADC_CHG_TEMP_660_GF_OFFSET_UV;
> +			*slope = RR_ADC_CHG_TEMP_660_GF_SLOPE_UV_PER_C;
> +			break;
			return 0;

> +		case PM660_FAB_ID_TSMC:
> +			*offset = RR_ADC_CHG_TEMP_660_SMIC_OFFSET_UV;
> +			*slope = RR_ADC_CHG_TEMP_660_SMIC_SLOPE_UV_PER_C;
> +			break;
			return 0;
> +		default:
> +			*offset = RR_ADC_CHG_TEMP_660_MGNA_OFFSET_UV;
> +			*slope = RR_ADC_CHG_TEMP_660_MGNA_SLOPE_UV_PER_C;
			return 0;
> +		}
> +	} else if (chip->pmic->subtype == PMI8998_SUBTYPE) {
> +		switch (chip->pmic->fab_id) {
> +		case PMI8998_FAB_ID_GF:
> +			*offset = RR_ADC_CHG_TEMP_GF_OFFSET_UV;
> +			*slope = RR_ADC_CHG_TEMP_GF_SLOPE_UV_PER_C;
> +			break;
			return 0;
> +		case PMI8998_FAB_ID_SMIC:
> +			*offset = RR_ADC_CHG_TEMP_SMIC_OFFSET_UV;
> +			*slope = RR_ADC_CHG_TEMP_SMIC_SLOPE_UV_PER_C;
> +			break;
			return 0;
> +		default:
> +			return -EINVAL;
> +		}
> +	} else {
> +		return -EINVAL;
> +	}
> +
> +	return 0;
Can only get here via a few paths adn in all of those returning early
makes just as much sense.

> +}
> +

...

> +static int rradc_read_status_in_cont_mode(struct rradc_chip *chip,
> +					  enum rradc_channel_id chan_address)
> +{
> +	const struct rradc_channel *chan = &rradc_chans[chan_address];
> +	const struct iio_chan_spec *iio_chan = &rradc_iio_chans[chan_address];
> +	int ret, i;
> +
> +	if (chan->trigger_mask == 0) {
> +		dev_err(chip->dev, "Channel doesn't have a trigger mask\n");
> +		return -EINVAL;
> +	}
> +
> +	ret = regmap_update_bits(chip->regmap, chip->base + chan->trigger_addr,
> +				 chan->trigger_mask, chan->trigger_mask);
> +	if (ret < 0) {
> +		dev_err(chip->dev,
> +			"Failed to apply trigger for channel '%s' ret=%d\n",
> +			iio_chan->extend_name, ret);
> +		return ret;
> +	}
> +
> +	ret = rradc_enable_continuous_mode(chip);
> +	if (ret < 0) {
> +		dev_err(chip->dev, "Failed to switch to continuous mode\n");
> +		goto disable_trigger;
> +	}
> +
> +	/*
> +	 * The wait/sleep values were found through trial and error,
> +	 * this is mostly for the battery ID channel which takes some
> +	 * time to settle.
> +	 */
> +	for (i = 0; i < 5; i++) {
> +		if (rradc_is_ready(chip, chan_address))
> +			break;
> +		usleep_range(50000, 50000 + 500);
> +	}
> +
> +	if (i == 5) {
> +		dev_err(chip->dev, "Channel '%s' is not ready\n",
> +			iio_chan->extend_name);
> +		ret = -EINVAL;

Perhaps indicate a timeout rather than invalid?

> +	}
> +
> +	rradc_disable_continuous_mode(chip);
> +
> +disable_trigger:
> +	regmap_update_bits(chip->regmap, chip->base + chan->trigger_addr,
> +			   chan->trigger_mask, 0);
> +
> +	return ret;
> +}
> +
> +static int rradc_prepare_batt_id_conversion(struct rradc_chip *chip,
> +					    enum rradc_channel_id chan_address,
> +					    u16 *data)
> +{
> +	int ret;
> +
> +	ret = regmap_update_bits(chip->regmap, chip->base + RR_ADC_BATT_ID_CTRL,
> +				 RR_ADC_BATT_ID_CTRL_CHANNEL_CONV,
> +				 RR_ADC_BATT_ID_CTRL_CHANNEL_CONV);
> +	if (ret < 0) {
> +		dev_err(chip->dev, "Enabling BATT ID channel failed:%d\n", ret);
> +		return ret;
> +	}
> +
> +	ret = regmap_update_bits(chip->regmap,
> +				 chip->base + RR_ADC_BATT_ID_TRIGGER,
> +				 RR_ADC_TRIGGER_CTL, RR_ADC_TRIGGER_CTL);
> +	if (ret < 0) {
> +		dev_err(chip->dev, "BATT_ID trigger set failed:%d\n", ret);
> +		goto out_disable_batt_id;
> +	}
> +
> +	ret = rradc_read_status_in_cont_mode(chip, chan_address);
> +
> +	/*
> +	 * Reset registers back to default values

Might as well do this as a single line comment.

> +	 */
> +	regmap_update_bits(chip->regmap, chip->base + RR_ADC_BATT_ID_TRIGGER,
> +			   RR_ADC_TRIGGER_CTL, 0);
> +
> +out_disable_batt_id:
> +	regmap_update_bits(chip->regmap, chip->base + RR_ADC_BATT_ID_CTRL,
> +			   RR_ADC_BATT_ID_CTRL_CHANNEL_CONV, 0);
> +
> +	return ret;
> +}
> +


...

> +static int rradc_read_scale(struct rradc_chip *chip, int chan_address, int *val,
> +			    int *val2)
> +{
> +	int64_t fab_offset, fab_slope;
> +	int ret;
> +
> +	ret = rradc_get_fab_coeff(chip, &fab_offset, &fab_slope);
> +	if (ret < 0) {
> +		dev_err(chip->dev, "Unable to get fab id coefficients\n");
> +		return -EINVAL;
> +	}
> +
> +	switch (chan_address) {
> +	case RR_ADC_SKIN_TEMP:
> +		*val = MILLI;
> +		*val2 = RR_ADC_BATT_THERM_LSB_K;
> +		return IIO_VAL_FRACTIONAL;
> +	case RR_ADC_USBIN_I:
> +		*val = RR_ADC_CURR_USBIN_INPUT_FACTOR_MIL *
> +		       RR_ADC_FS_VOLTAGE_MV;
> +		*val2 = RR_ADC_CHAN_MSB;
> +		return IIO_VAL_FRACTIONAL;
> +	case RR_ADC_DCIN_I:
> +		*val = RR_ADC_CURR_INPUT_FACTOR * RR_ADC_FS_VOLTAGE_MV;
> +		*val2 = RR_ADC_CHAN_MSB;
> +		return IIO_VAL_FRACTIONAL;
> +	case RR_ADC_USBIN_V:
> +	case RR_ADC_DCIN_V:
> +		*val = RR_ADC_VOLT_INPUT_FACTOR * RR_ADC_FS_VOLTAGE_MV * MILLI;
> +		*val2 = RR_ADC_CHAN_MSB;
> +		return IIO_VAL_FRACTIONAL;
> +	case RR_ADC_GPIO:
> +		*val = RR_ADC_GPIO_FS_RANGE;
> +		*val2 = RR_ADC_CHAN_MSB;
> +		return IIO_VAL_FRACTIONAL;
> +	case RR_ADC_CHG_TEMP:
> +		/*
> +		 * We divide val2 by MILLI instead of multiplying val
> +		 * to avoid an integer overflow.
> +		 */
> +		*val = -RR_ADC_TEMP_FS_VOLTAGE_NUM;
> +		*val2 = div64_s64(RR_ADC_TEMP_FS_VOLTAGE_DEN * RR_ADC_CHAN_MSB *
> +					  fab_slope,
> +				  MILLI);
> +
> +		return IIO_VAL_FRACTIONAL;
> +	case RR_ADC_DIE_TEMP:
> +		*val = RR_ADC_TEMP_FS_VOLTAGE_NUM;
> +		*val2 = RR_ADC_TEMP_FS_VOLTAGE_DEN * RR_ADC_CHAN_MSB *
> +			RR_ADC_DIE_TEMP_SLOPE;
> +
> +		return IIO_VAL_FRACTIONAL;
> +	default:
> +		break;

		return -EINVAL; and drop the one below.

> +	}
> +
> +	return -EINVAL;
> +}
> +


...

> +static int rradc_probe(struct platform_device *pdev)
> +{
> +	struct device *dev = &pdev->dev;
> +	struct iio_dev *indio_dev;
> +	struct rradc_chip *chip;
> +	int ret, i, batt_id_delay;
> +
> +	indio_dev = devm_iio_device_alloc(dev, sizeof(*chip));
> +	if (!indio_dev)
> +		return -ENOMEM;
> +
> +	chip = iio_priv(indio_dev);
> +	chip->regmap = dev_get_regmap(pdev->dev.parent, NULL);
> +	if (!chip->regmap) {
> +		dev_err(dev, "Couldn't get parent's regmap\n");
> +		return -EINVAL;
> +	}
> +
> +	chip->dev = dev;
> +	mutex_init(&chip->conversion_lock);
> +
> +	ret = device_property_read_u32(dev, "reg", &chip->base);
> +	if (ret < 0) {
> +		dev_err(chip->dev, "Couldn't find reg address, ret = %d\n",
> +			ret);
> +		return ret;
> +	}
> +
> +	batt_id_delay = -1;
> +	ret = device_property_read_u32(dev, "qcom,batt-id-delay-ms",
> +				       &batt_id_delay);
> +	if (!ret) {
> +		for (i = 0; i < RRADC_BATT_ID_DELAY_MAX; i++) {
> +			if (batt_id_delay == batt_id_delays[i])
> +				break;
> +		}
> +		if (i == RRADC_BATT_ID_DELAY_MAX)
> +			batt_id_delay = -1;
> +	}
> +
> +	if (batt_id_delay >= 0) {
> +		batt_id_delay = FIELD_PREP(BATT_ID_SETTLE_MASK, batt_id_delay);
> +		ret = regmap_update_bits(chip->regmap,
> +					 chip->base + RR_ADC_BATT_ID_CFG,
> +					 batt_id_delay, batt_id_delay);
> +		if (ret < 0) {
> +			dev_err(chip->dev,
> +				"BATT_ID settling time config failed:%d\n",
> +				ret);
> +		}
> +	}
> +
> +	/* Get the PMIC revision ID, we need to handle some varying coefficients */
> +	chip->pmic = qcom_pmic_get(chip->dev);
> +	if (IS_ERR_VALUE(chip->pmic)) {

Isn't IS_ERR() more appropriate?

> +		dev_err(chip->dev, "Unable to get reference to PMIC device\n");
> +		return PTR_ERR(chip->pmic);
> +	}
Caleb Connolly Feb. 21, 2022, 5:19 p.m. UTC | #4
On 19/02/2022 18:27, Jonathan Cameron wrote:
> On Wed, 16 Feb 2022 13:49:13 +0000
> Caleb Connolly <caleb.connolly@linaro.org> wrote:
> 
>> Some PMIC functions such as the RRADC need to be aware of the PMIC
>> chip revision information to implement errata or otherwise adjust
>> behaviour, export the PMIC information to enable this.
>>
>> This is specifically required to enable the RRADC to adjust
>> coefficients based on which chip fab the PMIC was produced in,
>> this can vary per unique device and therefore has to be read at
>> runtime.
>>
>> Signed-off-by: Caleb Connolly <caleb.connolly@linaro.org>
Hi Jonathan,
> Hi Caleb,
> 
> A few minor comments inline.
> 
> Thanks,
> 
> Jonathan
> 
>> ---
>>   drivers/mfd/qcom-spmi-pmic.c      | 176 ++++++++++++++++++++----------
>>   include/soc/qcom/qcom-spmi-pmic.h |  60 ++++++++++
>>   2 files changed, 179 insertions(+), 57 deletions(-)
>>   create mode 100644 include/soc/qcom/qcom-spmi-pmic.h
>>
>> diff --git a/drivers/mfd/qcom-spmi-pmic.c b/drivers/mfd/qcom-spmi-pmic.c
>> index 1cacc00aa6c9..5e656485cd55 100644
>> --- a/drivers/mfd/qcom-spmi-pmic.c
>> +++ b/drivers/mfd/qcom-spmi-pmic.c
>> @@ -3,51 +3,26 @@
>>    * Copyright (c) 2014, The Linux Foundation. All rights reserved.
>>    */
>>   
>> +#include <linux/device.h>
>> +#include <linux/errno.h>
>> +#include <linux/gfp.h>
>>   #include <linux/kernel.h>
>>   #include <linux/module.h>
>> +#include <linux/math.h>
>> +#include <linux/slab.h>
>>   #include <linux/spmi.h>
>> +#include <linux/types.h>
>>   #include <linux/regmap.h>
>>   #include <linux/of_platform.h>
>> +#include <soc/qcom/qcom-spmi-pmic.h>
> 
> All these new headers are a result of changes in this patch?
> Some clearly are, but device.h / errno.h?
device.h is required for devm_kzalloc() and errno.h for EPROBE_DEFER.

However slab.h and math.h aren't needed, they were from development,
I'll drop them in the next revision.
> 
> If you want to add missing ones that should always have been here
> it belongs in a different patch.
> 
>>   
>>   #define PMIC_REV2		0x101
>>   #define PMIC_REV3		0x102
>>   #define PMIC_REV4		0x103
>>   #define PMIC_TYPE		0x104
>>   #define PMIC_SUBTYPE		0x105
>> -
> 
> Unrelated change.  Please check through patches for this sort of noise.
> Whilst it doesn't matter in this particular case, it is good practice to
> ensure it isn't there to distract a reviewer from what matters.
ack
> 
>>   #define PMIC_TYPE_VALUE		0x51
>>   
>> -#define COMMON_SUBTYPE		0x00
>> -#define PM8941_SUBTYPE		0x01
>> -#define PM8841_SUBTYPE		0x02
>> -#define PM8019_SUBTYPE		0x03
>> -#define PM8226_SUBTYPE		0x04
>> -#define PM8110_SUBTYPE		0x05
>> -#define PMA8084_SUBTYPE		0x06
>> -#define PMI8962_SUBTYPE		0x07
>> -#define PMD9635_SUBTYPE		0x08
>> -#define PM8994_SUBTYPE		0x09
>> -#define PMI8994_SUBTYPE		0x0a
>> -#define PM8916_SUBTYPE		0x0b
>> -#define PM8004_SUBTYPE		0x0c
>> -#define PM8909_SUBTYPE		0x0d
>> -#define PM8028_SUBTYPE		0x0e
>> -#define PM8901_SUBTYPE		0x0f
>> -#define PM8950_SUBTYPE		0x10
>> -#define PMI8950_SUBTYPE		0x11
>> -#define PM8998_SUBTYPE		0x14
>> -#define PMI8998_SUBTYPE		0x15
>> -#define PM8005_SUBTYPE		0x18
>> -#define PM660L_SUBTYPE		0x1A
>> -#define PM660_SUBTYPE		0x1B
>> -#define PM8150_SUBTYPE		0x1E
>> -#define PM8150L_SUBTYPE		0x1f
>> -#define PM8150B_SUBTYPE		0x20
>> -#define PMK8002_SUBTYPE		0x21
>> -#define PM8009_SUBTYPE		0x24
>> -#define PM8150C_SUBTYPE		0x26
>> -#define SMB2351_SUBTYPE		0x29
>> -
>>   static const struct of_device_id pmic_spmi_id_table[] = {
>>   	{ .compatible = "qcom,pm660",     .data = (void *)PM660_SUBTYPE },
>>   	{ .compatible = "qcom,pm660l",    .data = (void *)PM660L_SUBTYPE },
>> @@ -81,42 +56,118 @@ static const struct of_device_id pmic_spmi_id_table[] = {
>>   	{ }
>>   };
>>   
>> -static void pmic_spmi_show_revid(struct regmap *map, struct device *dev)
>> +/**
> 
> Run kernel-doc script over this and fix all the errors + warnings.
> I'm fairly sure you will get some.
ack, yeah this is not good kernel-doc, I'll get it sorted for the next revision, thanks.
> 
>> + * @brief Get a pointer to the base PMIC device
>> + *
>> + * @param dev the pmic function device
>> + * @return const struct qcom_spmi_pmic*
>> + *
>> + * A PMIC can be represented by multiple SPMI devices, but
>> + * only the base PMIC device will contain a reference to
>> + * the revision information.
>> + *
>> + * This function takes a pointer to a function device and
>> + * returns a pointer to the base PMIC device.
>> + */
>> +const struct qcom_spmi_pmic *qcom_pmic_get(struct device *dev)
>> +{
>> +	struct spmi_device *sdev;
>> +	struct device_node *spmi_bus;
>> +	struct device_node *other_usid;
>> +	int function_parent_usid, ret;
>> +	u32 reg[2];
>> +
>> +	if (!of_match_device(pmic_spmi_id_table, dev->parent))
>> +		return ERR_PTR(-EINVAL);
>> +
>> +	sdev = to_spmi_device(dev->parent);
>> +	if (!sdev)
>> +		return ERR_PTR(-EINVAL);
>> +
>> +	/*
>> +	 * Quick return if the function device is already in the right
>> +	 * USID
>> +	 */
>> +	if (sdev->usid % 2 == 0)
>> +		return spmi_device_get_drvdata(sdev);
>> +
>> +	function_parent_usid = sdev->usid;
>> +
>> +	/*
>> +	 * Walk through the list of PMICs until we find the sibling USID.
>> +	 * The goal is the find to previous sibling. Assuming there is no
>> +	 * PMIC with more than 2 USIDs. We know that function_parent_usid
>> +	 * is one greater than the base USID.
>> +	 */
>> +	spmi_bus = of_get_parent(sdev->dev.parent->of_node);
>> +	do {
>> +		other_usid = of_get_next_child(spmi_bus, other_usid);
>> +		ret = of_property_read_u32_array(other_usid, "reg", reg, 2);
>> +		if (ret)
>> +			return ERR_PTR(ret);
>> +		sdev = spmi_device_from_of(other_usid);
>> +		if (sdev == NULL) {
>> +			/*
>> +			 * If the base USID for this PMIC hasn't probed yet
>> +			 * but the secondary USID has, then we need to defer
>> +			 * the function driver so that it will attempt to
>> +			 * probe again when the base USID is ready.
>> +			 */
>> +			if (reg[0] == function_parent_usid - 1)
>> +				return ERR_PTR(-EPROBE_DEFER);
>> +
>> +			continue;
>> +		}
>> +
>> +		if (reg[0] == function_parent_usid - 1)
>> +			return spmi_device_get_drvdata(sdev);
>> +	} while (other_usid->sibling);
>> +
>> +	return ERR_PTR(-ENODATA);
>> +}
>> +EXPORT_SYMBOL(qcom_pmic_get);
>> +
>> +static inline void pmic_print_info(struct device *dev, struct qcom_spmi_pmic *pmic)
>> +{
>> +	dev_info(dev, "%x: %s v%d.%d\n",
>> +		pmic->subtype, pmic->name, pmic->major, pmic->minor);
>> +}
>> +
>> +static int pmic_spmi_load_revid(struct regmap *map, struct device *dev,
>> +				 struct qcom_spmi_pmic *pmic)
>>   {
>> -	unsigned int rev2, minor, major, type, subtype;
>> -	const char *name = "unknown";
>>   	int ret, i;
>>   
>> -	ret = regmap_read(map, PMIC_TYPE, &type);
>> +	ret = regmap_read(map, PMIC_TYPE, &pmic->type);
>>   	if (ret < 0)
>> -		return;
>> +		return ret;
>>   
>> -	if (type != PMIC_TYPE_VALUE)
>> -		return;
>> +	if (pmic->type != PMIC_TYPE_VALUE)
>> +		return ret;
>>   
>> -	ret = regmap_read(map, PMIC_SUBTYPE, &subtype);
>> +	ret = regmap_read(map, PMIC_SUBTYPE, &pmic->subtype);
>>   	if (ret < 0)
>> -		return;
>> +		return ret;
>>   
>>   	for (i = 0; i < ARRAY_SIZE(pmic_spmi_id_table); i++) {
>> -		if (subtype == (unsigned long)pmic_spmi_id_table[i].data)
>> +		if (pmic->subtype == (unsigned long)pmic_spmi_id_table[i].data)
>>   			break;
>>   	}
>>   
>>   	if (i != ARRAY_SIZE(pmic_spmi_id_table))
>> -		name = pmic_spmi_id_table[i].compatible;
>> +		pmic->name = devm_kstrdup_const(dev, pmic_spmi_id_table[i].compatible, GFP_KERNEL);
>>   
>> -	ret = regmap_read(map, PMIC_REV2, &rev2);
>> +	ret = regmap_read(map, PMIC_REV2, &pmic->rev2);
>>   	if (ret < 0)
>> -		return;
>> +		return ret;
>>   
>> -	ret = regmap_read(map, PMIC_REV3, &minor);
>> +	ret = regmap_read(map, PMIC_REV3, &pmic->minor);
>>   	if (ret < 0)
>> -		return;
>> +		return ret;
>>   
>> -	ret = regmap_read(map, PMIC_REV4, &major);
>> +	ret = regmap_read(map, PMIC_REV4, &pmic->major);
>>   	if (ret < 0)
>> -		return;
>> +		return ret;
>>   
>>   	/*
>>   	 * In early versions of PM8941 and PM8226, the major revision number
>> @@ -124,14 +175,14 @@ static void pmic_spmi_show_revid(struct regmap *map, struct device *dev)
>>   	 * Increment the major revision number here if the chip is an early
>>   	 * version of PM8941 or PM8226.
>>   	 */
>> -	if ((subtype == PM8941_SUBTYPE || subtype == PM8226_SUBTYPE) &&
>> -	    major < 0x02)
>> -		major++;
>> +	if ((pmic->subtype == PM8941_SUBTYPE || pmic->subtype == PM8226_SUBTYPE) &&
>> +	    pmic->major < 0x02)
>> +		pmic->major++;
>>   
>> -	if (subtype == PM8110_SUBTYPE)
>> -		minor = rev2;
>> +	if (pmic->subtype == PM8110_SUBTYPE)
>> +		pmic->minor = pmic->rev2;
>>   
>> -	dev_dbg(dev, "%x: %s v%d.%d\n", subtype, name, major, minor);
> 
> Why remove the dev_dbg?
I moved the print to be after the call to this function instead of in it - this function previously
just fetched and printed the PMIC revision information when debug printing was enabled, I'm changing
it to instead just fetch the information and populate the new struct qcom_spmi_pmic, I renamed the
function to match the new behaviour too. So it seemed sensible to remove the print behaviour and
instead move it outside the function (see the call to pmic_print_info() below).

I also inadvertently upgraded it to a dev_info() instead which I don't think
upstream are too keen on. I'll drop it back to dev_dbg in the next revision.
> 
>> +	return 0;
>>   }
>>   
>>   static const struct regmap_config spmi_regmap_config = {
>> @@ -144,14 +195,25 @@ static const struct regmap_config spmi_regmap_config = {
>>   static int pmic_spmi_probe(struct spmi_device *sdev)
>>   {
>>   	struct regmap *regmap;
>> +	struct qcom_spmi_pmic *pmic;
>> +	int ret;
>>   
>>   	regmap = devm_regmap_init_spmi_ext(sdev, &spmi_regmap_config);
>>   	if (IS_ERR(regmap))
>>   		return PTR_ERR(regmap);
>>   
>> +	pmic = devm_kzalloc(&sdev->dev, sizeof(*pmic), GFP_KERNEL);
>> +	if (!pmic)
>> +		return -ENOMEM;
>> +
>>   	/* Only the first slave id for a PMIC contains this information */
>> -	if (sdev->usid % 2 == 0)
>> -		pmic_spmi_show_revid(regmap, &sdev->dev);
>> +	if (sdev->usid % 2 == 0) {
>> +		ret = pmic_spmi_load_revid(regmap, &sdev->dev, pmic);
>> +		if (ret < 0)
>> +			return ret;
>> +		spmi_device_set_drvdata(sdev, pmic);
>> +		pmic_print_info(&sdev->dev, pmic);
>> +	}
>>   
>>   	return devm_of_platform_populate(&sdev->dev);
>>   }
>
Jonathan Cameron Feb. 26, 2022, 4:47 p.m. UTC | #5
On Mon, 21 Feb 2022 17:19:51 +0000
Caleb Connolly <caleb.connolly@linaro.org> wrote:

> On 19/02/2022 18:27, Jonathan Cameron wrote:
> > On Wed, 16 Feb 2022 13:49:13 +0000
> > Caleb Connolly <caleb.connolly@linaro.org> wrote:
> >   
> >> Some PMIC functions such as the RRADC need to be aware of the PMIC
> >> chip revision information to implement errata or otherwise adjust
> >> behaviour, export the PMIC information to enable this.
> >>
> >> This is specifically required to enable the RRADC to adjust
> >> coefficients based on which chip fab the PMIC was produced in,
> >> this can vary per unique device and therefore has to be read at
> >> runtime.
> >>
> >> Signed-off-by: Caleb Connolly <caleb.connolly@linaro.org>  
> Hi Jonathan,
> > Hi Caleb,
> > 
> > A few minor comments inline.
> > 
> > Thanks,
> > 
> > Jonathan
> >   
> >> ---
> >>   drivers/mfd/qcom-spmi-pmic.c      | 176 ++++++++++++++++++++----------
> >>   include/soc/qcom/qcom-spmi-pmic.h |  60 ++++++++++
> >>   2 files changed, 179 insertions(+), 57 deletions(-)
> >>   create mode 100644 include/soc/qcom/qcom-spmi-pmic.h
> >>
> >> diff --git a/drivers/mfd/qcom-spmi-pmic.c b/drivers/mfd/qcom-spmi-pmic.c
> >> index 1cacc00aa6c9..5e656485cd55 100644
> >> --- a/drivers/mfd/qcom-spmi-pmic.c
> >> +++ b/drivers/mfd/qcom-spmi-pmic.c
> >> @@ -3,51 +3,26 @@
> >>    * Copyright (c) 2014, The Linux Foundation. All rights reserved.
> >>    */
> >>   
> >> +#include <linux/device.h>
> >> +#include <linux/errno.h>
> >> +#include <linux/gfp.h>
> >>   #include <linux/kernel.h>
> >>   #include <linux/module.h>
> >> +#include <linux/math.h>
> >> +#include <linux/slab.h>
> >>   #include <linux/spmi.h>
> >> +#include <linux/types.h>
> >>   #include <linux/regmap.h>
> >>   #include <linux/of_platform.h>
> >> +#include <soc/qcom/qcom-spmi-pmic.h>  
> > 
> > All these new headers are a result of changes in this patch?
> > Some clearly are, but device.h / errno.h?  
> device.h is required for devm_kzalloc() and errno.h for EPROBE_DEFER.

oops. Clearly I was having an unobservant day!
> 
> However slab.h and math.h aren't needed, they were from development,
> I'll drop them in the next revision.

Great :) 

> > 
> > If you want to add missing ones that should always have been here
> > it belongs in a different patch.
> >   
> >>   
> >>   #define PMIC_REV2		0x101
> >>   #define PMIC_REV3		0x102
> >>   #define PMIC_REV4		0x103
> >>   #define PMIC_TYPE		0x104
> >>   #define PMIC_SUBTYPE		0x105
> >> -  
> > 
> > Unrelated change.  Please check through patches for this sort of noise.
> > Whilst it doesn't matter in this particular case, it is good practice to
> > ensure it isn't there to distract a reviewer from what matters.  
> ack
> >   
> >>   #define PMIC_TYPE_VALUE		0x51
> >>   
> >> -#define COMMON_SUBTYPE		0x00
> >> -#define PM8941_SUBTYPE		0x01
> >> -#define PM8841_SUBTYPE		0x02
> >> -#define PM8019_SUBTYPE		0x03
> >> -#define PM8226_SUBTYPE		0x04
> >> -#define PM8110_SUBTYPE		0x05
> >> -#define PMA8084_SUBTYPE		0x06
> >> -#define PMI8962_SUBTYPE		0x07
> >> -#define PMD9635_SUBTYPE		0x08
> >> -#define PM8994_SUBTYPE		0x09
> >> -#define PMI8994_SUBTYPE		0x0a
> >> -#define PM8916_SUBTYPE		0x0b
> >> -#define PM8004_SUBTYPE		0x0c
> >> -#define PM8909_SUBTYPE		0x0d
> >> -#define PM8028_SUBTYPE		0x0e
> >> -#define PM8901_SUBTYPE		0x0f
> >> -#define PM8950_SUBTYPE		0x10
> >> -#define PMI8950_SUBTYPE		0x11
> >> -#define PM8998_SUBTYPE		0x14
> >> -#define PMI8998_SUBTYPE		0x15
> >> -#define PM8005_SUBTYPE		0x18
> >> -#define PM660L_SUBTYPE		0x1A
> >> -#define PM660_SUBTYPE		0x1B
> >> -#define PM8150_SUBTYPE		0x1E
> >> -#define PM8150L_SUBTYPE		0x1f
> >> -#define PM8150B_SUBTYPE		0x20
> >> -#define PMK8002_SUBTYPE		0x21
> >> -#define PM8009_SUBTYPE		0x24
> >> -#define PM8150C_SUBTYPE		0x26
> >> -#define SMB2351_SUBTYPE		0x29
> >> -
> >>   static const struct of_device_id pmic_spmi_id_table[] = {
> >>   	{ .compatible = "qcom,pm660",     .data = (void *)PM660_SUBTYPE },
> >>   	{ .compatible = "qcom,pm660l",    .data = (void *)PM660L_SUBTYPE },
> >> @@ -81,42 +56,118 @@ static const struct of_device_id pmic_spmi_id_table[] = {
> >>   	{ }
> >>   };
> >>   
> >> -static void pmic_spmi_show_revid(struct regmap *map, struct device *dev)
> >> +/**  
> > 
> > Run kernel-doc script over this and fix all the errors + warnings.
> > I'm fairly sure you will get some.  
> ack, yeah this is not good kernel-doc, I'll get it sorted for the next revision, thanks.
> >   
> >> + * @brief Get a pointer to the base PMIC device
> >> + *
> >> + * @param dev the pmic function device
> >> + * @return const struct qcom_spmi_pmic*
> >> + *
> >> + * A PMIC can be represented by multiple SPMI devices, but
> >> + * only the base PMIC device will contain a reference to
> >> + * the revision information.
> >> + *
> >> + * This function takes a pointer to a function device and
> >> + * returns a pointer to the base PMIC device.
> >> + */
> >> +const struct qcom_spmi_pmic *qcom_pmic_get(struct device *dev)
> >> +{
> >> +	struct spmi_device *sdev;
> >> +	struct device_node *spmi_bus;
> >> +	struct device_node *other_usid;
> >> +	int function_parent_usid, ret;
> >> +	u32 reg[2];
> >> +
> >> +	if (!of_match_device(pmic_spmi_id_table, dev->parent))
> >> +		return ERR_PTR(-EINVAL);
> >> +
> >> +	sdev = to_spmi_device(dev->parent);
> >> +	if (!sdev)
> >> +		return ERR_PTR(-EINVAL);
> >> +
> >> +	/*
> >> +	 * Quick return if the function device is already in the right
> >> +	 * USID
> >> +	 */
> >> +	if (sdev->usid % 2 == 0)
> >> +		return spmi_device_get_drvdata(sdev);
> >> +
> >> +	function_parent_usid = sdev->usid;
> >> +
> >> +	/*
> >> +	 * Walk through the list of PMICs until we find the sibling USID.
> >> +	 * The goal is the find to previous sibling. Assuming there is no
> >> +	 * PMIC with more than 2 USIDs. We know that function_parent_usid
> >> +	 * is one greater than the base USID.
> >> +	 */
> >> +	spmi_bus = of_get_parent(sdev->dev.parent->of_node);
> >> +	do {
> >> +		other_usid = of_get_next_child(spmi_bus, other_usid);
> >> +		ret = of_property_read_u32_array(other_usid, "reg", reg, 2);
> >> +		if (ret)
> >> +			return ERR_PTR(ret);
> >> +		sdev = spmi_device_from_of(other_usid);
> >> +		if (sdev == NULL) {
> >> +			/*
> >> +			 * If the base USID for this PMIC hasn't probed yet
> >> +			 * but the secondary USID has, then we need to defer
> >> +			 * the function driver so that it will attempt to
> >> +			 * probe again when the base USID is ready.
> >> +			 */
> >> +			if (reg[0] == function_parent_usid - 1)
> >> +				return ERR_PTR(-EPROBE_DEFER);
> >> +
> >> +			continue;
> >> +		}
> >> +
> >> +		if (reg[0] == function_parent_usid - 1)
> >> +			return spmi_device_get_drvdata(sdev);
> >> +	} while (other_usid->sibling);
> >> +
> >> +	return ERR_PTR(-ENODATA);
> >> +}
> >> +EXPORT_SYMBOL(qcom_pmic_get);
> >> +
> >> +static inline void pmic_print_info(struct device *dev, struct qcom_spmi_pmic *pmic)
> >> +{
> >> +	dev_info(dev, "%x: %s v%d.%d\n",
> >> +		pmic->subtype, pmic->name, pmic->major, pmic->minor);
> >> +}
> >> +
> >> +static int pmic_spmi_load_revid(struct regmap *map, struct device *dev,
> >> +				 struct qcom_spmi_pmic *pmic)
> >>   {
> >> -	unsigned int rev2, minor, major, type, subtype;
> >> -	const char *name = "unknown";
> >>   	int ret, i;
> >>   
> >> -	ret = regmap_read(map, PMIC_TYPE, &type);
> >> +	ret = regmap_read(map, PMIC_TYPE, &pmic->type);
> >>   	if (ret < 0)
> >> -		return;
> >> +		return ret;
> >>   
> >> -	if (type != PMIC_TYPE_VALUE)
> >> -		return;
> >> +	if (pmic->type != PMIC_TYPE_VALUE)
> >> +		return ret;
> >>   
> >> -	ret = regmap_read(map, PMIC_SUBTYPE, &subtype);
> >> +	ret = regmap_read(map, PMIC_SUBTYPE, &pmic->subtype);
> >>   	if (ret < 0)
> >> -		return;
> >> +		return ret;
> >>   
> >>   	for (i = 0; i < ARRAY_SIZE(pmic_spmi_id_table); i++) {
> >> -		if (subtype == (unsigned long)pmic_spmi_id_table[i].data)
> >> +		if (pmic->subtype == (unsigned long)pmic_spmi_id_table[i].data)
> >>   			break;
> >>   	}
> >>   
> >>   	if (i != ARRAY_SIZE(pmic_spmi_id_table))
> >> -		name = pmic_spmi_id_table[i].compatible;
> >> +		pmic->name = devm_kstrdup_const(dev, pmic_spmi_id_table[i].compatible, GFP_KERNEL);
> >>   
> >> -	ret = regmap_read(map, PMIC_REV2, &rev2);
> >> +	ret = regmap_read(map, PMIC_REV2, &pmic->rev2);
> >>   	if (ret < 0)
> >> -		return;
> >> +		return ret;
> >>   
> >> -	ret = regmap_read(map, PMIC_REV3, &minor);
> >> +	ret = regmap_read(map, PMIC_REV3, &pmic->minor);
> >>   	if (ret < 0)
> >> -		return;
> >> +		return ret;
> >>   
> >> -	ret = regmap_read(map, PMIC_REV4, &major);
> >> +	ret = regmap_read(map, PMIC_REV4, &pmic->major);
> >>   	if (ret < 0)
> >> -		return;
> >> +		return ret;
> >>   
> >>   	/*
> >>   	 * In early versions of PM8941 and PM8226, the major revision number
> >> @@ -124,14 +175,14 @@ static void pmic_spmi_show_revid(struct regmap *map, struct device *dev)
> >>   	 * Increment the major revision number here if the chip is an early
> >>   	 * version of PM8941 or PM8226.
> >>   	 */
> >> -	if ((subtype == PM8941_SUBTYPE || subtype == PM8226_SUBTYPE) &&
> >> -	    major < 0x02)
> >> -		major++;
> >> +	if ((pmic->subtype == PM8941_SUBTYPE || pmic->subtype == PM8226_SUBTYPE) &&
> >> +	    pmic->major < 0x02)
> >> +		pmic->major++;
> >>   
> >> -	if (subtype == PM8110_SUBTYPE)
> >> -		minor = rev2;
> >> +	if (pmic->subtype == PM8110_SUBTYPE)
> >> +		pmic->minor = pmic->rev2;
> >>   
> >> -	dev_dbg(dev, "%x: %s v%d.%d\n", subtype, name, major, minor);  
> > 
> > Why remove the dev_dbg?  
> I moved the print to be after the call to this function instead of in it - this function previously
> just fetched and printed the PMIC revision information when debug printing was enabled, I'm changing
> it to instead just fetch the information and populate the new struct qcom_spmi_pmic, I renamed the
> function to match the new behaviour too. So it seemed sensible to remove the print behaviour and
> instead move it outside the function (see the call to pmic_print_info() below).
Ah. Unobservant again :)

Thanks, for pointing me in the right direction.

Jonathan

> 
> I also inadvertently upgraded it to a dev_info() instead which I don't think
> upstream are too keen on. I'll drop it back to dev_dbg in the next revision.
> >   
> >> +	return 0;
> >>   }
> >>   
> >>   static const struct regmap_config spmi_regmap_config = {
> >> @@ -144,14 +195,25 @@ static const struct regmap_config spmi_regmap_config = {
> >>   static int pmic_spmi_probe(struct spmi_device *sdev)
> >>   {
> >>   	struct regmap *regmap;
> >> +	struct qcom_spmi_pmic *pmic;
> >> +	int ret;
> >>   
> >>   	regmap = devm_regmap_init_spmi_ext(sdev, &spmi_regmap_config);
> >>   	if (IS_ERR(regmap))
> >>   		return PTR_ERR(regmap);
> >>   
> >> +	pmic = devm_kzalloc(&sdev->dev, sizeof(*pmic), GFP_KERNEL);
> >> +	if (!pmic)
> >> +		return -ENOMEM;
> >> +
> >>   	/* Only the first slave id for a PMIC contains this information */
> >> -	if (sdev->usid % 2 == 0)
> >> -		pmic_spmi_show_revid(regmap, &sdev->dev);
> >> +	if (sdev->usid % 2 == 0) {
> >> +		ret = pmic_spmi_load_revid(regmap, &sdev->dev, pmic);
> >> +		if (ret < 0)
> >> +			return ret;
> >> +		spmi_device_set_drvdata(sdev, pmic);
> >> +		pmic_print_info(&sdev->dev, pmic);
> >> +	}
> >>   
> >>   	return devm_of_platform_populate(&sdev->dev);
> >>   }  
> >   
>