On Wed, 16 Feb 2022 13:49:13 +0000
Caleb Connolly <caleb.connolly@xxxxxxxxxx> 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@xxxxxxxxxx>
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);
> }
