diff mbox series

[RFC,v4,2/5] mfd: add driver for Marvell 88PM886 PMIC

Message ID 20240311160110.32185-3-karelb@gimli.ms.mff.cuni.cz (mailing list archive)
State New
Headers show
Series initial support for Marvell 88PM886 PMIC | expand

Commit Message

Karel Balej March 11, 2024, 3:51 p.m. UTC
From: Karel Balej <balejk@matfyz.cz>

Marvell 88PM886 is a PMIC which provides various functions such as
onkey, battery, charger and regulators. It is found for instance in the
samsung,coreprimevelte smartphone with which this was tested. Implement
basic support to allow for the use of regulators and onkey.

Signed-off-by: Karel Balej <balejk@matfyz.cz>
---

Notes:
    RFC v4:
    - Use MFD_CELL_* macros.
    - Address Lee's feedback:
      - Do not define regmap_config.val_bits and .reg_bits.
      - Drop everything regulator related except mfd_cell (regmap
        initialization, IDs enum etc.). Drop pm886_initialize_subregmaps.
      - Do not store regmap pointers as an array as there is now only one
        regmap. Also drop the corresponding enum.
      - Move regmap_config to the header as it is needed in the regulators
        driver.
      - pm886_chip.whoami -> chip_id
      - Reword chip ID mismatch error message and print the ID as
        hexadecimal.
      - Fix includes in include/linux/88pm886.h.
      - Drop the pm886_irq_number enum and define the (for the moment) only
        IRQ explicitly.
    - Have only one MFD cell for all regulators as they are now registered
      all at once in the regulators driver.
    - Reword commit message.
    - Make device table static and remove comma after the sentinel to signal
      that nothing should come after it.
    RFC v3:
    - Drop onkey cell .of_compatible.
    - Rename LDO page offset and regmap to REGULATORS.
    RFC v2:
    - Remove some abstraction.
    - Sort includes alphabetically and add linux/of.h.
    - Depend on OF, remove of_match_ptr and add MODULE_DEVICE_TABLE.
    - Use more temporaries and break long lines.
    - Do not initialize ret in probe.
    - Use the wakeup-source DT property.
    - Rename ret to err.
    - Address Lee's comments:
      - Drop patched in presets for base regmap and related defines.
      - Use full sentences in comments.
      - Remove IRQ comment.
      - Define regmap_config member values.
      - Rename data to sys_off_data.
      - Add _PMIC suffix to Kconfig.
      - Use dev_err_probe.
      - Do not store irq_data.
      - s/WHOAMI/CHIP_ID
      - Drop LINUX part of include guard name.
      - Merge in the regulator series modifications in order to have more
        devices and modify the commit message accordingly. Changes with
        respect to the original regulator series patches:
        - ret -> err
        - Add temporary for dev in pm88x_initialize_subregmaps.
        - Drop of_compatible for the regulators.
        - Do not duplicate LDO regmap for bucks.
    - Rewrite commit message.

 drivers/mfd/88pm886.c       | 149 ++++++++++++++++++++++++++++++++++++
 drivers/mfd/Kconfig         |  12 +++
 drivers/mfd/Makefile        |   1 +
 include/linux/mfd/88pm886.h |  38 +++++++++
 4 files changed, 200 insertions(+)
 create mode 100644 drivers/mfd/88pm886.c
 create mode 100644 include/linux/mfd/88pm886.h

Comments

Lee Jones March 21, 2024, 3:42 p.m. UTC | #1
On Mon, 11 Mar 2024, Karel Balej wrote:

> From: Karel Balej <balejk@matfyz.cz>
> 
> Marvell 88PM886 is a PMIC which provides various functions such as
> onkey, battery, charger and regulators. It is found for instance in the
> samsung,coreprimevelte smartphone with which this was tested. Implement
> basic support to allow for the use of regulators and onkey.
> 
> Signed-off-by: Karel Balej <balejk@matfyz.cz>
> ---
> 
> Notes:
>     RFC v4:
>     - Use MFD_CELL_* macros.
>     - Address Lee's feedback:
>       - Do not define regmap_config.val_bits and .reg_bits.
>       - Drop everything regulator related except mfd_cell (regmap
>         initialization, IDs enum etc.). Drop pm886_initialize_subregmaps.
>       - Do not store regmap pointers as an array as there is now only one
>         regmap. Also drop the corresponding enum.
>       - Move regmap_config to the header as it is needed in the regulators
>         driver.
>       - pm886_chip.whoami -> chip_id
>       - Reword chip ID mismatch error message and print the ID as
>         hexadecimal.
>       - Fix includes in include/linux/88pm886.h.
>       - Drop the pm886_irq_number enum and define the (for the moment) only
>         IRQ explicitly.
>     - Have only one MFD cell for all regulators as they are now registered
>       all at once in the regulators driver.
>     - Reword commit message.
>     - Make device table static and remove comma after the sentinel to signal
>       that nothing should come after it.
>     RFC v3:
>     - Drop onkey cell .of_compatible.
>     - Rename LDO page offset and regmap to REGULATORS.
>     RFC v2:
>     - Remove some abstraction.
>     - Sort includes alphabetically and add linux/of.h.
>     - Depend on OF, remove of_match_ptr and add MODULE_DEVICE_TABLE.
>     - Use more temporaries and break long lines.
>     - Do not initialize ret in probe.
>     - Use the wakeup-source DT property.
>     - Rename ret to err.
>     - Address Lee's comments:
>       - Drop patched in presets for base regmap and related defines.
>       - Use full sentences in comments.
>       - Remove IRQ comment.
>       - Define regmap_config member values.
>       - Rename data to sys_off_data.
>       - Add _PMIC suffix to Kconfig.
>       - Use dev_err_probe.
>       - Do not store irq_data.
>       - s/WHOAMI/CHIP_ID
>       - Drop LINUX part of include guard name.
>       - Merge in the regulator series modifications in order to have more
>         devices and modify the commit message accordingly. Changes with
>         respect to the original regulator series patches:
>         - ret -> err
>         - Add temporary for dev in pm88x_initialize_subregmaps.
>         - Drop of_compatible for the regulators.
>         - Do not duplicate LDO regmap for bucks.
>     - Rewrite commit message.
> 
>  drivers/mfd/88pm886.c       | 149 ++++++++++++++++++++++++++++++++++++
>  drivers/mfd/Kconfig         |  12 +++
>  drivers/mfd/Makefile        |   1 +
>  include/linux/mfd/88pm886.h |  38 +++++++++
>  4 files changed, 200 insertions(+)
>  create mode 100644 drivers/mfd/88pm886.c
>  create mode 100644 include/linux/mfd/88pm886.h

Looks mostly okay.

> diff --git a/include/linux/mfd/88pm886.h b/include/linux/mfd/88pm886.h
> new file mode 100644
> index 000000000000..a5e6524bb19d
> --- /dev/null
> +++ b/include/linux/mfd/88pm886.h
> @@ -0,0 +1,38 @@
> +/* SPDX-License-Identifier: GPL-2.0-only */
> +#ifndef __MFD_88PM886_H
> +#define __MFD_88PM886_H
> +
> +#include <linux/i2c.h>
> +#include <linux/regmap.h>
> +
> +#define PM886_A1_CHIP_ID		0xa1
> +
> +#define PM886_REGMAP_CONF_MAX_REG	0xfe
> +
> +#define PM886_REG_ID			0x00
> +
> +#define PM886_REG_STATUS1		0x01
> +#define PM886_ONKEY_STS1		BIT(0)
> +
> +#define PM886_REG_MISC_CONFIG1		0x14
> +#define PM886_SW_PDOWN			BIT(5)
> +
> +#define PM886_REG_MISC_CONFIG2		0x15
> +#define PM886_INT_INV			BIT(0)
> +#define PM886_INT_CLEAR			BIT(1)
> +#define PM886_INT_RC			0x00
> +#define PM886_INT_WC			BIT(1)
> +#define PM886_INT_MASK_MODE		BIT(2)
> +
> +struct pm886_chip {
> +	struct i2c_client *client;
> +	unsigned int chip_id;
> +	struct regmap *regmap;
> +};
> +
> +static const struct regmap_config pm886_i2c_regmap = {
> +	.reg_bits = 8,
> +	.val_bits = 8,
> +	.max_register = PM886_REGMAP_CONF_MAX_REG,
> +};

Why is this in here?

> +#endif /* __MFD_88PM886_H */

What would you like me to do with this RFC patch?
Karel Balej March 21, 2024, 4:12 p.m. UTC | #2
Lee Jones, 2024-03-21T15:42:11+00:00:
> On Mon, 11 Mar 2024, Karel Balej wrote:
>
> > From: Karel Balej <balejk@matfyz.cz>
> > 
> > Marvell 88PM886 is a PMIC which provides various functions such as
> > onkey, battery, charger and regulators. It is found for instance in the
> > samsung,coreprimevelte smartphone with which this was tested. Implement
> > basic support to allow for the use of regulators and onkey.
> > 
> > Signed-off-by: Karel Balej <balejk@matfyz.cz>
> > ---
> > 
> > Notes:
> >     RFC v4:
> >     - Use MFD_CELL_* macros.
> >     - Address Lee's feedback:
> >       - Do not define regmap_config.val_bits and .reg_bits.
> >       - Drop everything regulator related except mfd_cell (regmap
> >         initialization, IDs enum etc.). Drop pm886_initialize_subregmaps.
> >       - Do not store regmap pointers as an array as there is now only one
> >         regmap. Also drop the corresponding enum.
> >       - Move regmap_config to the header as it is needed in the regulators
> >         driver.
> >       - pm886_chip.whoami -> chip_id
> >       - Reword chip ID mismatch error message and print the ID as
> >         hexadecimal.
> >       - Fix includes in include/linux/88pm886.h.
> >       - Drop the pm886_irq_number enum and define the (for the moment) only
> >         IRQ explicitly.
> >     - Have only one MFD cell for all regulators as they are now registered
> >       all at once in the regulators driver.
> >     - Reword commit message.
> >     - Make device table static and remove comma after the sentinel to signal
> >       that nothing should come after it.
> >     RFC v3:
> >     - Drop onkey cell .of_compatible.
> >     - Rename LDO page offset and regmap to REGULATORS.
> >     RFC v2:
> >     - Remove some abstraction.
> >     - Sort includes alphabetically and add linux/of.h.
> >     - Depend on OF, remove of_match_ptr and add MODULE_DEVICE_TABLE.
> >     - Use more temporaries and break long lines.
> >     - Do not initialize ret in probe.
> >     - Use the wakeup-source DT property.
> >     - Rename ret to err.
> >     - Address Lee's comments:
> >       - Drop patched in presets for base regmap and related defines.
> >       - Use full sentences in comments.
> >       - Remove IRQ comment.
> >       - Define regmap_config member values.
> >       - Rename data to sys_off_data.
> >       - Add _PMIC suffix to Kconfig.
> >       - Use dev_err_probe.
> >       - Do not store irq_data.
> >       - s/WHOAMI/CHIP_ID
> >       - Drop LINUX part of include guard name.
> >       - Merge in the regulator series modifications in order to have more
> >         devices and modify the commit message accordingly. Changes with
> >         respect to the original regulator series patches:
> >         - ret -> err
> >         - Add temporary for dev in pm88x_initialize_subregmaps.
> >         - Drop of_compatible for the regulators.
> >         - Do not duplicate LDO regmap for bucks.
> >     - Rewrite commit message.
> > 
> >  drivers/mfd/88pm886.c       | 149 ++++++++++++++++++++++++++++++++++++
> >  drivers/mfd/Kconfig         |  12 +++
> >  drivers/mfd/Makefile        |   1 +
> >  include/linux/mfd/88pm886.h |  38 +++++++++
> >  4 files changed, 200 insertions(+)
> >  create mode 100644 drivers/mfd/88pm886.c
> >  create mode 100644 include/linux/mfd/88pm886.h
>
> Looks mostly okay.
>
> > diff --git a/include/linux/mfd/88pm886.h b/include/linux/mfd/88pm886.h
> > new file mode 100644
> > index 000000000000..a5e6524bb19d
> > --- /dev/null
> > +++ b/include/linux/mfd/88pm886.h
> > @@ -0,0 +1,38 @@
> > +/* SPDX-License-Identifier: GPL-2.0-only */
> > +#ifndef __MFD_88PM886_H
> > +#define __MFD_88PM886_H
> > +
> > +#include <linux/i2c.h>
> > +#include <linux/regmap.h>
> > +
> > +#define PM886_A1_CHIP_ID		0xa1
> > +
> > +#define PM886_REGMAP_CONF_MAX_REG	0xfe
> > +
> > +#define PM886_REG_ID			0x00
> > +
> > +#define PM886_REG_STATUS1		0x01
> > +#define PM886_ONKEY_STS1		BIT(0)
> > +
> > +#define PM886_REG_MISC_CONFIG1		0x14
> > +#define PM886_SW_PDOWN			BIT(5)
> > +
> > +#define PM886_REG_MISC_CONFIG2		0x15
> > +#define PM886_INT_INV			BIT(0)
> > +#define PM886_INT_CLEAR			BIT(1)
> > +#define PM886_INT_RC			0x00
> > +#define PM886_INT_WC			BIT(1)
> > +#define PM886_INT_MASK_MODE		BIT(2)
> > +
> > +struct pm886_chip {
> > +	struct i2c_client *client;
> > +	unsigned int chip_id;
> > +	struct regmap *regmap;
> > +};
> > +
> > +static const struct regmap_config pm886_i2c_regmap = {
> > +	.reg_bits = 8,
> > +	.val_bits = 8,
> > +	.max_register = PM886_REGMAP_CONF_MAX_REG,
> > +};
>
> Why is this in here?

Because since I moved the regulators regmap initialization into the
regulators driver, I need to access it from there.

> What would you like me to do with this RFC patch?

I was hoping that you would take this through the MFD tree (after the
regulator subsystem maintainers approve the regulators driver).

I have added the remaining regulators to the driver just today and plan
to send the first non-RFC version of the series after I test it, likely
over the weekend. Hopefully the regulators patch will finally get some
attention then.

Thank you, best regards,
K. B.
Lee Jones March 21, 2024, 4:20 p.m. UTC | #3
On Thu, 21 Mar 2024, Karel Balej wrote:

> Lee Jones, 2024-03-21T15:42:11+00:00:
> > On Mon, 11 Mar 2024, Karel Balej wrote:
> >
> > > From: Karel Balej <balejk@matfyz.cz>
> > > 
> > > Marvell 88PM886 is a PMIC which provides various functions such as
> > > onkey, battery, charger and regulators. It is found for instance in the
> > > samsung,coreprimevelte smartphone with which this was tested. Implement
> > > basic support to allow for the use of regulators and onkey.
> > > 
> > > Signed-off-by: Karel Balej <balejk@matfyz.cz>
> > > ---
> > > 
> > > Notes:
> > >     RFC v4:
> > >     - Use MFD_CELL_* macros.
> > >     - Address Lee's feedback:
> > >       - Do not define regmap_config.val_bits and .reg_bits.
> > >       - Drop everything regulator related except mfd_cell (regmap
> > >         initialization, IDs enum etc.). Drop pm886_initialize_subregmaps.
> > >       - Do not store regmap pointers as an array as there is now only one
> > >         regmap. Also drop the corresponding enum.
> > >       - Move regmap_config to the header as it is needed in the regulators
> > >         driver.
> > >       - pm886_chip.whoami -> chip_id
> > >       - Reword chip ID mismatch error message and print the ID as
> > >         hexadecimal.
> > >       - Fix includes in include/linux/88pm886.h.
> > >       - Drop the pm886_irq_number enum and define the (for the moment) only
> > >         IRQ explicitly.
> > >     - Have only one MFD cell for all regulators as they are now registered
> > >       all at once in the regulators driver.
> > >     - Reword commit message.
> > >     - Make device table static and remove comma after the sentinel to signal
> > >       that nothing should come after it.
> > >     RFC v3:
> > >     - Drop onkey cell .of_compatible.
> > >     - Rename LDO page offset and regmap to REGULATORS.
> > >     RFC v2:
> > >     - Remove some abstraction.
> > >     - Sort includes alphabetically and add linux/of.h.
> > >     - Depend on OF, remove of_match_ptr and add MODULE_DEVICE_TABLE.
> > >     - Use more temporaries and break long lines.
> > >     - Do not initialize ret in probe.
> > >     - Use the wakeup-source DT property.
> > >     - Rename ret to err.
> > >     - Address Lee's comments:
> > >       - Drop patched in presets for base regmap and related defines.
> > >       - Use full sentences in comments.
> > >       - Remove IRQ comment.
> > >       - Define regmap_config member values.
> > >       - Rename data to sys_off_data.
> > >       - Add _PMIC suffix to Kconfig.
> > >       - Use dev_err_probe.
> > >       - Do not store irq_data.
> > >       - s/WHOAMI/CHIP_ID
> > >       - Drop LINUX part of include guard name.
> > >       - Merge in the regulator series modifications in order to have more
> > >         devices and modify the commit message accordingly. Changes with
> > >         respect to the original regulator series patches:
> > >         - ret -> err
> > >         - Add temporary for dev in pm88x_initialize_subregmaps.
> > >         - Drop of_compatible for the regulators.
> > >         - Do not duplicate LDO regmap for bucks.
> > >     - Rewrite commit message.
> > > 
> > >  drivers/mfd/88pm886.c       | 149 ++++++++++++++++++++++++++++++++++++
> > >  drivers/mfd/Kconfig         |  12 +++
> > >  drivers/mfd/Makefile        |   1 +
> > >  include/linux/mfd/88pm886.h |  38 +++++++++
> > >  4 files changed, 200 insertions(+)
> > >  create mode 100644 drivers/mfd/88pm886.c
> > >  create mode 100644 include/linux/mfd/88pm886.h
> >
> > Looks mostly okay.
> >
> > > diff --git a/include/linux/mfd/88pm886.h b/include/linux/mfd/88pm886.h
> > > new file mode 100644
> > > index 000000000000..a5e6524bb19d
> > > --- /dev/null
> > > +++ b/include/linux/mfd/88pm886.h
> > > @@ -0,0 +1,38 @@
> > > +/* SPDX-License-Identifier: GPL-2.0-only */
> > > +#ifndef __MFD_88PM886_H
> > > +#define __MFD_88PM886_H
> > > +
> > > +#include <linux/i2c.h>
> > > +#include <linux/regmap.h>
> > > +
> > > +#define PM886_A1_CHIP_ID		0xa1
> > > +
> > > +#define PM886_REGMAP_CONF_MAX_REG	0xfe
> > > +
> > > +#define PM886_REG_ID			0x00
> > > +
> > > +#define PM886_REG_STATUS1		0x01
> > > +#define PM886_ONKEY_STS1		BIT(0)
> > > +
> > > +#define PM886_REG_MISC_CONFIG1		0x14
> > > +#define PM886_SW_PDOWN			BIT(5)
> > > +
> > > +#define PM886_REG_MISC_CONFIG2		0x15
> > > +#define PM886_INT_INV			BIT(0)
> > > +#define PM886_INT_CLEAR			BIT(1)
> > > +#define PM886_INT_RC			0x00
> > > +#define PM886_INT_WC			BIT(1)
> > > +#define PM886_INT_MASK_MODE		BIT(2)
> > > +
> > > +struct pm886_chip {
> > > +	struct i2c_client *client;
> > > +	unsigned int chip_id;
> > > +	struct regmap *regmap;
> > > +};
> > > +
> > > +static const struct regmap_config pm886_i2c_regmap = {
> > > +	.reg_bits = 8,
> > > +	.val_bits = 8,
> > > +	.max_register = PM886_REGMAP_CONF_MAX_REG,
> > > +};
> >
> > Why is this in here?
> 
> Because since I moved the regulators regmap initialization into the
> regulators driver, I need to access it from there.

So move it into the regulators driver?

> > What would you like me to do with this RFC patch?
> 
> I was hoping that you would take this through the MFD tree (after the
> regulator subsystem maintainers approve the regulators driver).
> 
> I have added the remaining regulators to the driver just today and plan
> to send the first non-RFC version of the series after I test it, likely
> over the weekend. Hopefully the regulators patch will finally get some
> attention then.

Don't forget that the merge-window is open.

Many maintainers take a well deserved nap during this period.
Karel Balej March 21, 2024, 4:55 p.m. UTC | #4
Lee Jones, 2024-03-21T16:20:45+00:00:
> On Thu, 21 Mar 2024, Karel Balej wrote:
>
> > Lee Jones, 2024-03-21T15:42:11+00:00:
> > > On Mon, 11 Mar 2024, Karel Balej wrote:
> > > > diff --git a/include/linux/mfd/88pm886.h b/include/linux/mfd/88pm886.h
> > > > new file mode 100644
> > > > index 000000000000..a5e6524bb19d
> > > > --- /dev/null
> > > > +++ b/include/linux/mfd/88pm886.h
> > > > @@ -0,0 +1,38 @@
> > > > +/* SPDX-License-Identifier: GPL-2.0-only */
> > > > +#ifndef __MFD_88PM886_H
> > > > +#define __MFD_88PM886_H
> > > > +
> > > > +#include <linux/i2c.h>
> > > > +#include <linux/regmap.h>
> > > > +
> > > > +#define PM886_A1_CHIP_ID		0xa1
> > > > +
> > > > +#define PM886_REGMAP_CONF_MAX_REG	0xfe
> > > > +
> > > > +#define PM886_REG_ID			0x00
> > > > +
> > > > +#define PM886_REG_STATUS1		0x01
> > > > +#define PM886_ONKEY_STS1		BIT(0)
> > > > +
> > > > +#define PM886_REG_MISC_CONFIG1		0x14
> > > > +#define PM886_SW_PDOWN			BIT(5)
> > > > +
> > > > +#define PM886_REG_MISC_CONFIG2		0x15
> > > > +#define PM886_INT_INV			BIT(0)
> > > > +#define PM886_INT_CLEAR			BIT(1)
> > > > +#define PM886_INT_RC			0x00
> > > > +#define PM886_INT_WC			BIT(1)
> > > > +#define PM886_INT_MASK_MODE		BIT(2)
> > > > +
> > > > +struct pm886_chip {
> > > > +	struct i2c_client *client;
> > > > +	unsigned int chip_id;
> > > > +	struct regmap *regmap;
> > > > +};
> > > > +
> > > > +static const struct regmap_config pm886_i2c_regmap = {
> > > > +	.reg_bits = 8,
> > > > +	.val_bits = 8,
> > > > +	.max_register = PM886_REGMAP_CONF_MAX_REG,
> > > > +};
> > >
> > > Why is this in here?
> > 
> > Because since I moved the regulators regmap initialization into the
> > regulators driver, I need to access it from there.
>
> So move it into the regulators driver?

It is used in the MFD driver too for the base regmap.

K. B.
Mark Brown March 21, 2024, 4:58 p.m. UTC | #5
On Thu, Mar 21, 2024 at 05:55:17PM +0100, Karel Balej wrote:
> Lee Jones, 2024-03-21T16:20:45+00:00:
> > On Thu, 21 Mar 2024, Karel Balej wrote:

> > > > > +static const struct regmap_config pm886_i2c_regmap = {
> > > > > +	.reg_bits = 8,
> > > > > +	.val_bits = 8,
> > > > > +	.max_register = PM886_REGMAP_CONF_MAX_REG,
> > > > > +};

> > > > Why is this in here?

> > > Because since I moved the regulators regmap initialization into the
> > > regulators driver, I need to access it from there.

> > So move it into the regulators driver?

> It is used in the MFD driver too for the base regmap.

You shouldn't be creating two regmaps for the same set of registers,
that just opens the potential for confusion.
Karel Balej March 21, 2024, 5:08 p.m. UTC | #6
Mark Brown, 2024-03-21T16:58:44+00:00:
> On Thu, Mar 21, 2024 at 05:55:17PM +0100, Karel Balej wrote:
> > Lee Jones, 2024-03-21T16:20:45+00:00:
> > > On Thu, 21 Mar 2024, Karel Balej wrote:
>
> > > > > > +static const struct regmap_config pm886_i2c_regmap = {
> > > > > > +	.reg_bits = 8,
> > > > > > +	.val_bits = 8,
> > > > > > +	.max_register = PM886_REGMAP_CONF_MAX_REG,
> > > > > > +};
>
> > > > > Why is this in here?
>
> > > > Because since I moved the regulators regmap initialization into the
> > > > regulators driver, I need to access it from there.
>
> > > So move it into the regulators driver?
>
> > It is used in the MFD driver too for the base regmap.
>
> You shouldn't be creating two regmaps for the same set of registers,
> that just opens the potential for confusion.

Just the regmap config is the same. Otherwise, each regmap lives at a
different I2C address.

Regards,
K. B.
Mark Brown March 21, 2024, 5:17 p.m. UTC | #7
On Thu, Mar 21, 2024 at 06:08:16PM +0100, Karel Balej wrote:
> Mark Brown, 2024-03-21T16:58:44+00:00:

> > > > > > > +static const struct regmap_config pm886_i2c_regmap = {
> > > > > > > +	.reg_bits = 8,
> > > > > > > +	.val_bits = 8,
> > > > > > > +	.max_register = PM886_REGMAP_CONF_MAX_REG,
> > > > > > > +};

...

> > You shouldn't be creating two regmaps for the same set of registers,
> > that just opens the potential for confusion.

> Just the regmap config is the same. Otherwise, each regmap lives at a
> different I2C address.

Do they both genuinely have the same maximum register?
Karel Balej March 21, 2024, 5:32 p.m. UTC | #8
Mark Brown, 2024-03-21T17:17:40+00:00:
> On Thu, Mar 21, 2024 at 06:08:16PM +0100, Karel Balej wrote:
> > Mark Brown, 2024-03-21T16:58:44+00:00:
>
> > > > > > > > +static const struct regmap_config pm886_i2c_regmap = {
> > > > > > > > +	.reg_bits = 8,
> > > > > > > > +	.val_bits = 8,
> > > > > > > > +	.max_register = PM886_REGMAP_CONF_MAX_REG,
> > > > > > > > +};
>
> ...
>
> > > You shouldn't be creating two regmaps for the same set of registers,
> > > that just opens the potential for confusion.
>
> > Just the regmap config is the same. Otherwise, each regmap lives at a
> > different I2C address.
>
> Do they both genuinely have the same maximum register?

They do according to the downstream driver which is my only reference.
In fact, there the driver defines the configs separately for each regmap
but with the same values.
Mark Brown March 21, 2024, 5:48 p.m. UTC | #9
On Thu, Mar 21, 2024 at 06:32:03PM +0100, Karel Balej wrote:
> Mark Brown, 2024-03-21T17:17:40+00:00:

> > Do they both genuinely have the same maximum register?

> They do according to the downstream driver which is my only reference.
> In fact, there the driver defines the configs separately for each regmap
> but with the same values.

This is a downstream driver - are you sure it's got the best code
quality?  I'm not seeing any references to registers with numbers as
high as the maximum register that's there in your driver for example.
Karel Balej March 21, 2024, 6:16 p.m. UTC | #10
Mark Brown, 2024-03-21T17:48:28+00:00:
> On Thu, Mar 21, 2024 at 06:32:03PM +0100, Karel Balej wrote:
> > Mark Brown, 2024-03-21T17:17:40+00:00:
>
> > > Do they both genuinely have the same maximum register?
>
> > They do according to the downstream driver which is my only reference.
> > In fact, there the driver defines the configs separately for each regmap
> > but with the same values.
>
> This is a downstream driver - are you sure it's got the best code
> quality?

No, that is why I have rewritten it and tried to improve on this. But
like I said, it is my only reference. Is there some other way to verify
this value (besides perhaps the datasheet)?

> I'm not seeing any references to registers with numbers as high as the
> maximum register that's there in your driver for example.

Indeed, I have performed the same check with the same findings. But that
doesn't necessarily mean that the maximum should be lower, no?

Do you have some specific modifications of my code in mind regarding
this?

Thank you,
K. B.
Mark Brown March 21, 2024, 7 p.m. UTC | #11
On Thu, Mar 21, 2024 at 07:16:43PM +0100, Karel Balej wrote:
> Mark Brown, 2024-03-21T17:48:28+00:00:

> > > They do according to the downstream driver which is my only reference.
> > > In fact, there the driver defines the configs separately for each regmap
> > > but with the same values.

> > This is a downstream driver - are you sure it's got the best code
> > quality?

> No, that is why I have rewritten it and tried to improve on this. But
> like I said, it is my only reference. Is there some other way to verify
> this value (besides perhaps the datasheet)?

The maximum register is whatever the maximum register we know about for
the device is, the datasheet is generally a good reference there.

> > I'm not seeing any references to registers with numbers as high as the
> > maximum register that's there in your driver for example.

> Indeed, I have performed the same check with the same findings. But that
> doesn't necessarily mean that the maximum should be lower, no?

> Do you have some specific modifications of my code in mind regarding
> this?

I would expect that if you have two separate register maps they would
have separate configurations that describe the corresponding physical
register maps, as far as I can tell this driver is just making up a
maximum register number.
Karel Balej March 21, 2024, 7:14 p.m. UTC | #12
Mark Brown, 2024-03-21T19:00:24+00:00:
> On Thu, Mar 21, 2024 at 07:16:43PM +0100, Karel Balej wrote:
> > Mark Brown, 2024-03-21T17:48:28+00:00:
>
> > > > They do according to the downstream driver which is my only reference.
> > > > In fact, there the driver defines the configs separately for each regmap
> > > > but with the same values.
>
> > > This is a downstream driver - are you sure it's got the best code
> > > quality?
>
> > No, that is why I have rewritten it and tried to improve on this. But
> > like I said, it is my only reference. Is there some other way to verify
> > this value (besides perhaps the datasheet)?
>
> The maximum register is whatever the maximum register we know about for
> the device is, the datasheet is generally a good reference there.
>
> > > I'm not seeing any references to registers with numbers as high as the
> > > maximum register that's there in your driver for example.
>
> > Indeed, I have performed the same check with the same findings. But that
> > doesn't necessarily mean that the maximum should be lower, no?
>
> > Do you have some specific modifications of my code in mind regarding
> > this?
>
> I would expect that if you have two separate register maps they would
> have separate configurations that describe the corresponding physical
> register maps, as far as I can tell this driver is just making up a
> maximum register number.

Alright, so I should just use a separate config for each regmap and set
the max_register value for each to whatever I can find is actually the
highest used value in the downstream code -- correct?

Thank you,
K. B.
Mark Brown March 21, 2024, 7:32 p.m. UTC | #13
On Thu, Mar 21, 2024 at 08:14:44PM +0100, Karel Balej wrote:
> Mark Brown, 2024-03-21T19:00:24+00:00:

> > I would expect that if you have two separate register maps they would
> > have separate configurations that describe the corresponding physical
> > register maps, as far as I can tell this driver is just making up a
> > maximum register number.

> Alright, so I should just use a separate config for each regmap and set
> the max_register value for each to whatever I can find is actually the
> highest used value in the downstream code -- correct?

That sounds plausible if you don't have any other information about the
register maps.
diff mbox series

Patch

diff --git a/drivers/mfd/88pm886.c b/drivers/mfd/88pm886.c
new file mode 100644
index 000000000000..88f21f813ec1
--- /dev/null
+++ b/drivers/mfd/88pm886.c
@@ -0,0 +1,149 @@ 
+// SPDX-License-Identifier: GPL-2.0-only
+#include <linux/i2c.h>
+#include <linux/mfd/core.h>
+#include <linux/module.h>
+#include <linux/notifier.h>
+#include <linux/of.h>
+#include <linux/reboot.h>
+#include <linux/regmap.h>
+
+#include <linux/mfd/88pm886.h>
+
+#define PM886_REG_INT_STATUS1			0x05
+
+#define PM886_REG_INT_ENA_1			0x0a
+#define PM886_INT_ENA1_ONKEY			BIT(0)
+
+#define PM886_IRQ_ONKEY				0
+
+static struct regmap_irq pm886_regmap_irqs[] = {
+	REGMAP_IRQ_REG(PM886_IRQ_ONKEY, 0, PM886_INT_ENA1_ONKEY),
+};
+
+static struct regmap_irq_chip pm886_regmap_irq_chip = {
+	.name = "88pm886",
+	.irqs = pm886_regmap_irqs,
+	.num_irqs = ARRAY_SIZE(pm886_regmap_irqs),
+	.num_regs = 4,
+	.status_base = PM886_REG_INT_STATUS1,
+	.ack_base = PM886_REG_INT_STATUS1,
+	.unmask_base = PM886_REG_INT_ENA_1,
+};
+
+static struct resource pm886_onkey_resources[] = {
+	DEFINE_RES_IRQ_NAMED(PM886_IRQ_ONKEY, "88pm886-onkey"),
+};
+
+static struct mfd_cell pm886_devs[] = {
+	MFD_CELL_RES("88pm886-onkey", pm886_onkey_resources),
+	MFD_CELL_NAME("88pm886-regulator"),
+};
+
+static int pm886_power_off_handler(struct sys_off_data *sys_off_data)
+{
+	struct pm886_chip *chip = sys_off_data->cb_data;
+	struct regmap *regmap = chip->regmap;
+	struct device *dev = &chip->client->dev;
+	int err;
+
+	err = regmap_update_bits(regmap, PM886_REG_MISC_CONFIG1, PM886_SW_PDOWN,
+				PM886_SW_PDOWN);
+	if (err) {
+		dev_err(dev, "Failed to power off the device: %d\n", err);
+		return NOTIFY_BAD;
+	}
+	return NOTIFY_DONE;
+}
+
+static int pm886_setup_irq(struct pm886_chip *chip,
+		struct regmap_irq_chip_data **irq_data)
+{
+	struct regmap *regmap = chip->regmap;
+	struct device *dev = &chip->client->dev;
+	int err;
+
+	/* Set interrupt clearing mode to clear on write. */
+	err = regmap_update_bits(regmap, PM886_REG_MISC_CONFIG2,
+			PM886_INT_INV | PM886_INT_CLEAR | PM886_INT_MASK_MODE,
+			PM886_INT_WC);
+	if (err) {
+		dev_err(dev, "Failed to set interrupt clearing mode: %d\n", err);
+		return err;
+	}
+
+	err = devm_regmap_add_irq_chip(dev, regmap, chip->client->irq,
+					IRQF_ONESHOT, -1, &pm886_regmap_irq_chip,
+					irq_data);
+	if (err) {
+		dev_err(dev, "Failed to request IRQ: %d\n", err);
+		return err;
+	}
+
+	return 0;
+}
+
+static int pm886_probe(struct i2c_client *client)
+{
+	struct regmap_irq_chip_data *irq_data;
+	struct device *dev = &client->dev;
+	struct pm886_chip *chip;
+	struct regmap *regmap;
+	unsigned int chip_id;
+	int err;
+
+	chip = devm_kzalloc(dev, sizeof(*chip), GFP_KERNEL);
+	if (!chip)
+		return -ENOMEM;
+
+	chip->client = client;
+	chip->chip_id = (uintptr_t)device_get_match_data(dev);
+	i2c_set_clientdata(client, chip);
+
+	regmap = devm_regmap_init_i2c(client, &pm886_i2c_regmap);
+	if (IS_ERR(regmap))
+		return dev_err_probe(dev, PTR_ERR(regmap), "Failed to initialize regmap\n");
+	chip->regmap = regmap;
+
+	err = regmap_read(regmap, PM886_REG_ID, &chip_id);
+	if (err)
+		return dev_err_probe(dev, err, "Failed to read chip ID\n");
+
+	if (chip->chip_id != chip_id)
+		return dev_err_probe(dev, -EINVAL, "Unsupported chip: 0x%x\n", chip_id);
+
+	err = pm886_setup_irq(chip, &irq_data);
+	if (err)
+		return err;
+
+	err = devm_mfd_add_devices(dev, 0, pm886_devs, ARRAY_SIZE(pm886_devs),
+				NULL, 0, regmap_irq_get_domain(irq_data));
+	if (err)
+		return dev_err_probe(dev, err, "Failed to add devices\n");
+
+	err = devm_register_power_off_handler(dev, pm886_power_off_handler, chip);
+	if (err)
+		return dev_err_probe(dev, err, "Failed to register power off handler\n");
+
+	device_init_wakeup(dev, device_property_read_bool(dev, "wakeup-source"));
+
+	return 0;
+}
+
+static const struct of_device_id pm886_of_match[] = {
+	{ .compatible = "marvell,88pm886-a1", .data = (void *)PM886_A1_CHIP_ID },
+	{ }
+};
+MODULE_DEVICE_TABLE(of, pm886_of_match);
+
+static struct i2c_driver pm886_i2c_driver = {
+	.driver = {
+		.name = "88pm886",
+		.of_match_table = pm886_of_match,
+	},
+	.probe = pm886_probe,
+};
+module_i2c_driver(pm886_i2c_driver);
+
+MODULE_DESCRIPTION("Marvell 88PM886 PMIC driver");
+MODULE_AUTHOR("Karel Balej <balejk@matfyz.cz>");
+MODULE_LICENSE("GPL");
diff --git a/drivers/mfd/Kconfig b/drivers/mfd/Kconfig
index e7a6e45b9fac..9ef921c59f30 100644
--- a/drivers/mfd/Kconfig
+++ b/drivers/mfd/Kconfig
@@ -794,6 +794,18 @@  config MFD_88PM860X
 	  select individual components like voltage regulators, RTC and
 	  battery-charger under the corresponding menus.
 
+config MFD_88PM886_PMIC
+	bool "Marvell 88PM886 PMIC"
+	depends on I2C=y
+	depends on OF
+	select REGMAP_I2C
+	select REGMAP_IRQ
+	select MFD_CORE
+	help
+	  This enables support for Marvell 88PM886 Power Management IC.
+	  This includes the I2C driver and the core APIs _only_, you have to
+	  select individual components like onkey under the corresponding menus.
+
 config MFD_MAX14577
 	tristate "Maxim Semiconductor MAX14577/77836 MUIC + Charger Support"
 	depends on I2C
diff --git a/drivers/mfd/Makefile b/drivers/mfd/Makefile
index c66f07edcd0e..d016b7fed354 100644
--- a/drivers/mfd/Makefile
+++ b/drivers/mfd/Makefile
@@ -7,6 +7,7 @@ 
 obj-$(CONFIG_MFD_88PM860X)	+= 88pm860x.o
 obj-$(CONFIG_MFD_88PM800)	+= 88pm800.o 88pm80x.o
 obj-$(CONFIG_MFD_88PM805)	+= 88pm805.o 88pm80x.o
+obj-$(CONFIG_MFD_88PM886_PMIC)	+= 88pm886.o
 obj-$(CONFIG_MFD_ACT8945A)	+= act8945a.o
 obj-$(CONFIG_MFD_SM501)		+= sm501.o
 obj-$(CONFIG_ARCH_BCM2835)	+= bcm2835-pm.o
diff --git a/include/linux/mfd/88pm886.h b/include/linux/mfd/88pm886.h
new file mode 100644
index 000000000000..a5e6524bb19d
--- /dev/null
+++ b/include/linux/mfd/88pm886.h
@@ -0,0 +1,38 @@ 
+/* SPDX-License-Identifier: GPL-2.0-only */
+#ifndef __MFD_88PM886_H
+#define __MFD_88PM886_H
+
+#include <linux/i2c.h>
+#include <linux/regmap.h>
+
+#define PM886_A1_CHIP_ID		0xa1
+
+#define PM886_REGMAP_CONF_MAX_REG	0xfe
+
+#define PM886_REG_ID			0x00
+
+#define PM886_REG_STATUS1		0x01
+#define PM886_ONKEY_STS1		BIT(0)
+
+#define PM886_REG_MISC_CONFIG1		0x14
+#define PM886_SW_PDOWN			BIT(5)
+
+#define PM886_REG_MISC_CONFIG2		0x15
+#define PM886_INT_INV			BIT(0)
+#define PM886_INT_CLEAR			BIT(1)
+#define PM886_INT_RC			0x00
+#define PM886_INT_WC			BIT(1)
+#define PM886_INT_MASK_MODE		BIT(2)
+
+struct pm886_chip {
+	struct i2c_client *client;
+	unsigned int chip_id;
+	struct regmap *regmap;
+};
+
+static const struct regmap_config pm886_i2c_regmap = {
+	.reg_bits = 8,
+	.val_bits = 8,
+	.max_register = PM886_REGMAP_CONF_MAX_REG,
+};
+#endif /* __MFD_88PM886_H */