Re: [PATCH 3/5] mfd: adp5585: Add Analog Devices ADP5585 core support
From: Laurent Pinchart
Date: Thu May 23 2024 - 16:19:45 EST
Hi Bough,
On Thu, May 23, 2024 at 08:29:32AM +0000, Bough Chen wrote:
> On Sent: 2024年5月21日 4:00, Laurent Pinchart wrote:
> >
> > From: Haibo Chen <haibo.chen@xxxxxxx>
> >
> > The ADP5585 is a 10/11 input/output port expander with a built in keypad
> > matrix decoder, programmable logic, reset generator, and PWM generator.
> > This driver supports the chip by modelling it as an MFD device, with two child
> > devices for the GPIO and PWM functions.
> >
> > The driver is derived from an initial implementation from NXP, available in
> > commit 8059835bee19 ("MLK-25917-1 mfd: adp5585: add ADI adp5585 core
> > support") in their BSP kernel tree. It has been extensively rewritten.
>
> Hi Laurent
>
> Thanks for sending this to upstream.
> Just one minor comment in the end of this patch.
>
> > Signed-off-by: Haibo Chen <haibo.chen@xxxxxxx>
> > Signed-off-by: Laurent Pinchart <laurent.pinchart@xxxxxxxxxxxxxxxx>
> > ---
> > Changes compared to the NXP original version:
> >
> > - Add MAINTAINERS entry
> > - Fix compatible strings for child devices
> > - Fix header guards
> > - Use lowercase hex constants
> > - White space fixes
> > - Use module_i2c_driver()
> > - Switch to regmap
> > - Drop I2C device ID table
> > - Drop ADP5585_REG_MASK
> > - Support R5 GPIO pin
> > - Drop dev field from adp5585_dev structure
> > - Check device ID at probe time
> > - Fix register field names
> > - Update copyright
> > - Update license to GPL-2.0-only
> > - Implement suspend/resume
> > ---
> > MAINTAINERS | 2 +
> > drivers/mfd/Kconfig | 11 ++
> > drivers/mfd/Makefile | 1 +
> > drivers/mfd/adp5585.c | 207
> > ++++++++++++++++++++++++++++++++++++
> > include/linux/mfd/adp5585.h | 120 +++++++++++++++++++++
> > 5 files changed, 341 insertions(+)
> > create mode 100644 drivers/mfd/adp5585.c create mode 100644
> > include/linux/mfd/adp5585.h
> >
> > diff --git a/MAINTAINERS b/MAINTAINERS
> > index afecdb82e783..7150f091b69b 100644
> > --- a/MAINTAINERS
> > +++ b/MAINTAINERS
> > @@ -503,6 +503,8 @@ L: linux-gpio@xxxxxxxxxxxxxxx
> > L: linux-pwm@xxxxxxxxxxxxxxx
> > S: Maintained
> > F: Documentation/devicetree/bindings/*/adi,adp5585*.yaml
> > +F: drivers/mfd/adp5585.c
> > +F: include/linux/mfd/adp5585.h
> >
> > ADP5588 QWERTY KEYPAD AND IO EXPANDER DRIVER (ADP5588/ADP5587)
> > M: Michael Hennerich <michael.hennerich@xxxxxxxxxx>
> > diff --git a/drivers/mfd/Kconfig b/drivers/mfd/Kconfig index
> > 4b023ee229cf..3423eac0877a 100644
> > --- a/drivers/mfd/Kconfig
> > +++ b/drivers/mfd/Kconfig
> > @@ -20,6 +20,17 @@ config MFD_CS5535
> > This is the core driver for CS5535/CS5536 MFD functions. This is
> > necessary for using the board's GPIO and MFGPT functionality.
> >
> > +config MFD_ADP5585
> > + tristate "Analog Devices ADP5585 MFD driver"
> > + select MFD_CORE
> > + select REGMAP_I2C
> > + depends on I2C && OF
> > + help
> > + Say yes here to add support for the Analog Devices ADP5585 GPIO
> > + expander, PWM and keypad controller. This includes the I2C driver and
> > + the core APIs _only_, you have to select individual components like
> > + the GPIO and PWM functions under the corresponding menus.
> > +
> > config MFD_ALTERA_A10SR
> > bool "Altera Arria10 DevKit System Resource chip"
> > depends on ARCH_INTEL_SOCFPGA && SPI_MASTER=y && OF diff --git
> > a/drivers/mfd/Makefile b/drivers/mfd/Makefile index
> > c66f07edcd0e..37f36a019a68 100644
> > --- a/drivers/mfd/Makefile
> > +++ b/drivers/mfd/Makefile
> > @@ -188,6 +188,7 @@ obj-$(CONFIG_MFD_DB8500_PRCMU) +=
> > db8500-prcmu.o
> > obj-$(CONFIG_AB8500_CORE) += ab8500-core.o ab8500-sysctrl.o
> > obj-$(CONFIG_MFD_TIMBERDALE) += timberdale.o
> > obj-$(CONFIG_PMIC_ADP5520) += adp5520.o
> > +obj-$(CONFIG_MFD_ADP5585) += adp5585.o
> > obj-$(CONFIG_MFD_KEMPLD) += kempld-core.o
> > obj-$(CONFIG_MFD_INTEL_QUARK_I2C_GPIO) += intel_quark_i2c_gpio.o
> > obj-$(CONFIG_LPC_SCH) += lpc_sch.o
> > diff --git a/drivers/mfd/adp5585.c b/drivers/mfd/adp5585.c new file mode
> > 100644 index 000000000000..75957f9b67c2
> > --- /dev/null
> > +++ b/drivers/mfd/adp5585.c
> > @@ -0,0 +1,207 @@
> > +// SPDX-License-Identifier: GPL-2.0-only
> > +/*
> > + * Analog Devices ADP5585 I/O expander, PWM controller and keypad
> > +controller
> > + *
> > + * Copyright 2022 NXP
> > + * Copyright 2024 Ideas on Board Oy
> > + */
> > +
> > +#include <linux/module.h>
> > +#include <linux/moduleparam.h>
> > +#include <linux/init.h>
> > +#include <linux/slab.h>
> > +#include <linux/i2c.h>
> > +#include <linux/of.h>
> > +#include <linux/of_device.h>
> > +#include <linux/mfd/core.h>
> > +#include <linux/mfd/adp5585.h>
> > +#include <linux/regmap.h>
> > +
> > +static const struct mfd_cell adp5585_devs[] = {
> > + {
> > + .name = "adp5585-gpio",
> > + .of_compatible = "adi,adp5585-gpio",
> > + },
> > + {
> > + .name = "adp5585-pwm",
> > + .of_compatible = "adi,adp5585-pwm",
> > + },
> > +};
> > +
> > +static const struct regmap_range adp5585_volatile_ranges[] = {
> > + regmap_reg_range(ADP5585_ID, ADP5585_GPI_STATUS_B), };
> > +
> > +static const struct regmap_access_table adp5585_volatile_regs = {
> > + .yes_ranges = adp5585_volatile_ranges,
> > + .n_yes_ranges = ARRAY_SIZE(adp5585_volatile_ranges),
> > +};
> > +
> > +static const u8 adp5585_regmap_defaults_00[ADP5585_MAX_REG + 1] = {
> > + /* 0x00 */ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
> > + /* 0x08 */ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
> > + /* 0x10 */ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
> > + /* 0x18 */ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
> > + /* 0x20 */ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
> > + /* 0x28 */ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
> > + /* 0x30 */ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
> > + /* 0x38 */ 0x00, 0x00, 0x00, 0x00, 0x00, };
> > +
> > +static const u8 adp5585_regmap_defaults_02[ADP5585_MAX_REG + 1] = {
> > + /* 0x00 */ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
> > + /* 0x08 */ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
> > + /* 0x10 */ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xc3,
> > + /* 0x18 */ 0x03, 0x00, 0x03, 0x00, 0x00, 0x00, 0x00, 0x00,
> > + /* 0x20 */ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
> > + /* 0x28 */ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
> > + /* 0x30 */ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
> > + /* 0x38 */ 0x00, 0x00, 0x00, 0x00, 0x00, };
> > +
> > +static const u8 adp5585_regmap_defaults_04[ADP5585_MAX_REG + 1] = {
> > + /* 0x00 */ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
> > + /* 0x08 */ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
> > + /* 0x10 */ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x55,
> > + /* 0x18 */ 0x05, 0x55, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00,
> > + /* 0x20 */ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
> > + /* 0x28 */ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
> > + /* 0x30 */ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
> > + /* 0x38 */ 0x00, 0x00, 0x00, 0x00, 0x00, };
> > +
> > +enum adp5585_regmap_type {
> > + ADP5585_REGMAP_00,
> > + ADP5585_REGMAP_02,
> > + ADP5585_REGMAP_04,
> > +};
> > +
> > +static const struct regmap_config adp5585_regmap_configs[] = {
> > + [ADP5585_REGMAP_00] = {
> > + .reg_bits = 8,
> > + .val_bits = 8,
> > + .max_register = ADP5585_MAX_REG,
> > + .volatile_table = &adp5585_volatile_regs,
> > + .cache_type = REGCACHE_MAPLE,
> > + .reg_defaults_raw = adp5585_regmap_defaults_00,
> > + .num_reg_defaults_raw = sizeof(adp5585_regmap_defaults_00),
> > + },
> > + [ADP5585_REGMAP_02] = {
> > + .reg_bits = 8,
> > + .val_bits = 8,
> > + .max_register = ADP5585_MAX_REG,
> > + .volatile_table = &adp5585_volatile_regs,
> > + .cache_type = REGCACHE_MAPLE,
> > + .reg_defaults_raw = adp5585_regmap_defaults_02,
> > + .num_reg_defaults_raw = sizeof(adp5585_regmap_defaults_02),
> > + },
> > + [ADP5585_REGMAP_04] = {
> > + .reg_bits = 8,
> > + .val_bits = 8,
> > + .max_register = ADP5585_MAX_REG,
> > + .volatile_table = &adp5585_volatile_regs,
> > + .cache_type = REGCACHE_MAPLE,
> > + .reg_defaults_raw = adp5585_regmap_defaults_04,
> > + .num_reg_defaults_raw = sizeof(adp5585_regmap_defaults_04),
> > + },
> > +};
> > +
> > +
> > +static int adp5585_i2c_probe(struct i2c_client *i2c) {
> > + const struct regmap_config *regmap_config;
> > + struct adp5585_dev *adp5585;
> > + unsigned int id;
> > + int ret;
> > +
> > + adp5585 = devm_kzalloc(&i2c->dev, sizeof(struct adp5585_dev),
> > + GFP_KERNEL);
> > + if (adp5585 == NULL)
> > + return -ENOMEM;
> > +
> > + i2c_set_clientdata(i2c, adp5585);
> > +
> > + regmap_config = of_device_get_match_data(&i2c->dev);
> > + adp5585->regmap = devm_regmap_init_i2c(i2c, regmap_config);
> > + if (IS_ERR(adp5585->regmap))
> > + return dev_err_probe(&i2c->dev, PTR_ERR(adp5585->regmap),
> > + "Failed to initialize register map\n");
> > +
> > + /* Verify the device ID. */
> > + ret = regmap_read(adp5585->regmap, ADP5585_ID, &id);
> > + if (ret)
> > + return dev_err_probe(&i2c->dev, ret,
> > + "Failed to read device ID\n");
> > +
> > + if (ADP5585_MAN_ID(id) != ADP5585_MAN_ID_VALUE)
> > + return dev_err_probe(&i2c->dev, -ENODEV,
> > + "Invalid device ID 0x%02x\n", id);
> > +
> > + dev_dbg(&i2c->dev, "device ID 0x%02x\n", id);
> > +
> > + /* Add MFD devices. */
> > + ret = devm_mfd_add_devices(&i2c->dev, PLATFORM_DEVID_AUTO,
> > + adp5585_devs, ARRAY_SIZE(adp5585_devs),
> > + NULL, 0, NULL);
> > + if (ret)
> > + return dev_err_probe(&i2c->dev, ret,
> > + "Failed to add MFD devices\n");
> > +
> > + return 0;
> > +}
> > +
> > +static int adp5585_suspend(struct device *dev) {
> > + struct adp5585_dev *adp5585 = dev_get_drvdata(dev);
> > +
> > + regcache_cache_only(adp5585->regmap, true);
> > +
> > + return 0;
> > +}
> > +
> > +static int adp5585_resume(struct device *dev) {
> > + struct adp5585_dev *adp5585 = dev_get_drvdata(dev);
> > +
> > + regcache_cache_only(adp5585->regmap, false);
> > + regcache_mark_dirty(adp5585->regmap);
> > +
> > + return regcache_sync(adp5585->regmap); }
> > +
> > +static DEFINE_SIMPLE_DEV_PM_OPS(adp5585_pm, adp5585_suspend,
> > +adp5585_resume);
> > +
> > +static const struct of_device_id adp5585_of_match[] = {
> > + {
> > + .compatible = "adi,adp5585-00",
> > + .data = &adp5585_regmap_configs[ADP5585_REGMAP_00],
> > + }, {
> > + .compatible = "adi,adp5585-01",
> > + .data = &adp5585_regmap_configs[ADP5585_REGMAP_00],
> > + }, {
> > + .compatible = "adi,adp5585-02",
> > + .data = &adp5585_regmap_configs[ADP5585_REGMAP_02],
> > + }, {
> > + .compatible = "adi,adp5585-03",
> > + .data = &adp5585_regmap_configs[ADP5585_REGMAP_00],
> > + }, {
> > + .compatible = "adi,adp5585-04",
> > + .data = &adp5585_regmap_configs[ADP5585_REGMAP_04],
> > + },
> > + { /* sentinel */ }
> > +};
> > +MODULE_DEVICE_TABLE(of, adp5585_of_match);
> > +
> > +static struct i2c_driver adp5585_i2c_driver = {
> > + .driver = {
> > + .name = "adp5585",
> > + .of_match_table = of_match_ptr(adp5585_of_match),
> > + .pm = pm_sleep_ptr(&adp5585_pm),
> > + },
> > + .probe = adp5585_i2c_probe,
> > +};
> > +module_i2c_driver(adp5585_i2c_driver);
> > +
> > +MODULE_DESCRIPTION("ADP5585 core driver"); MODULE_AUTHOR("Haibo
> > Chen
> > +<haibo.chen@xxxxxxx>"); MODULE_LICENSE("GPL");
> > diff --git a/include/linux/mfd/adp5585.h b/include/linux/mfd/adp5585.h new file
> > mode 100644 index 000000000000..3f178f30fac6
> > --- /dev/null
> > +++ b/include/linux/mfd/adp5585.h
> > @@ -0,0 +1,120 @@
> > +/* SPDX-License-Identifier: GPL-2.0-only */
> > +/*
> > + * Analog Devices ADP5585 I/O expander, PWM controller and keypad
> > +controller
> > + *
> > + * Copyright 2022 NXP
> > + * Copyright 2024 Ideas on Board Oy
> > + */
> > +
> > +#ifndef __LINUX_MFD_ADP5585_H_
> > +#define __LINUX_MFD_ADP5585_H_
> > +
> > +#include <linux/bits.h>
> > +
> > +#define ADP5585_ID 0x00
> > +#define ADP5585_MAN_ID(v) (((v) & 0xf0) >> 4)
> > +#define ADP5585_MAN_ID_VALUE 0x02
> > +#define ADP5585_INT_STATUS 0x01
> > +#define ADP5585_STATUS 0x02
> > +#define ADP5585_FIFO_1 0x03
> > +#define ADP5585_FIFO_2 0x04
> > +#define ADP5585_FIFO_3 0x05
> > +#define ADP5585_FIFO_4 0x06
> > +#define ADP5585_FIFO_5 0x07
> > +#define ADP5585_FIFO_6 0x08
> > +#define ADP5585_FIFO_7 0x09
> > +#define ADP5585_FIFO_8 0x0a
> > +#define ADP5585_FIFO_9 0x0b
> > +#define ADP5585_FIFO_10 0x0c
> > +#define ADP5585_FIFO_11 0x0d
> > +#define ADP5585_FIFO_12 0x0e
> > +#define ADP5585_FIFO_13 0x0f
> > +#define ADP5585_FIFO_14 0x10
> > +#define ADP5585_FIFO_15 0x11
> > +#define ADP5585_FIFO_16 0x12
> > +#define ADP5585_GPI_INT_STAT_A 0x13
> > +#define ADP5585_GPI_INT_STAT_B 0x14
> > +#define ADP5585_GPI_STATUS_A 0x15
> > +#define ADP5585_GPI_STATUS_B 0x16
> > +#define ADP5585_RPULL_CONFIG_A 0x17
> > +#define ADP5585_RPULL_CONFIG_B 0x18
> > +#define ADP5585_RPULL_CONFIG_C 0x19
> > +#define ADP5585_RPULL_CONFIG_D 0x1a
> > +#define ADP5585_Rx_PULL_CFG(n, v) ((v) << ((n) * 2))
> > +#define ADP5585_Rx_PULL_CFG_PU_300K (0)
> > +#define ADP5585_Rx_PULL_CFG_PD_300K (1)
> > +#define ADP5585_Rx_PULL_CFG_PU_100K (2)
> > +#define ADP5585_Rx_PULL_CFG_DISABLE (3)
> > +#define ADP5585_Rx_PULL_CFG_MASK (3)
> > +#define ADP5585_GPI_INT_LEVEL_A 0x1b
> > +#define ADP5585_GPI_INT_LEVEL_B 0x1c
> > +#define ADP5585_GPI_EVENT_EN_A 0x1d
> > +#define ADP5585_GPI_EVENT_EN_B 0x1e
> > +#define ADP5585_GPI_INTERRUPT_EN_A 0x1f
> > +#define ADP5585_GPI_INTERRUPT_EN_B 0x20
> > +#define ADP5585_DEBOUNCE_DIS_A 0x21
> > +#define ADP5585_DEBOUNCE_DIS_B 0x22
> > +#define ADP5585_GPO_DATA_OUT_A 0x23
> > +#define ADP5585_GPO_DATA_OUT_B 0x24
> > +#define ADP5585_GPO_OUT_MODE_A 0x25
> > +#define ADP5585_GPO_OUT_MODE_B 0x26
> > +#define ADP5585_GPIO_DIRECTION_A 0x27
> > +#define ADP5585_GPIO_DIRECTION_B 0x28
> > +#define ADP5585_RESET1_EVENT_A 0x29
> > +#define ADP5585_RESET1_EVENT_B 0x2a
> > +#define ADP5585_RESET1_EVENT_C 0x2b
> > +#define ADP5585_RESET2_EVENT_A 0x2c
> > +#define ADP5585_RESET2_EVENT_B 0x2d
> > +#define ADP5585_RESET_CFG 0x2e
> > +#define ADP5585_PWM_OFFT_LOW 0x2f
> > +#define ADP5585_PWM_OFFT_HIGH 0x30
> > +#define ADP5585_PWM_ONT_LOW 0x31
> > +#define ADP5585_PWM_ONT_HIGH 0x32
> > +#define ADP5585_PWM_CFG 0x33
> > +#define ADP5585_PWM_IN_AND BIT(2)
> > +#define ADP5585_PWM_MODE BIT(1)
> > +#define ADP5585_PWM_EN BIT(0)
> > +#define ADP5585_LOGIC_CFG 0x34
> > +#define ADP5585_LOGIC_FF_CFG 0x35
> > +#define ADP5585_LOGIC_INT_EVENT_EN 0x36
> > +#define ADP5585_POLL_PTIME_CFG 0x37
> > +#define ADP5585_PIN_CONFIG_A 0x38
> > +#define ADP5585_PIN_CONFIG_B 0x39
> > +#define ADP5585_PIN_CONFIG_C 0x3a
> > +#define ADP5585_PULL_SELECT BIT(7)
> > +#define ADP5585_C4_EXTEND_CFG_GPIO11 (0U << 6)
> > +#define ADP5585_C4_EXTEND_CFG_RESET2 (1U << 6)
> > +#define ADP5585_C4_EXTEND_CFG_MASK (1U << 6)
> > +#define ADP5585_R4_EXTEND_CFG_GPIO5 (0U << 5)
> > +#define ADP5585_R4_EXTEND_CFG_RESET1 (1U << 5)
> > +#define ADP5585_R4_EXTEND_CFG_MASK (1U << 5)
> > +#define ADP5585_R3_EXTEND_CFG_GPIO4 (0U << 2)
> > +#define ADP5585_R3_EXTEND_CFG_LC (1U << 2)
> > +#define ADP5585_R3_EXTEND_CFG_PWM_OUT (2U << 2)
> > +#define ADP5585_R3_EXTEND_CFG_MASK (3U << 2)
> > +#define ADP5585_R0_EXTEND_CFG_GPIO1 (0U << 0)
> > +#define ADP5585_R0_EXTEND_CFG_LY (1U << 0)
> > +#define ADP5585_R0_EXTEND_CFG_MASK (1U << 0)
> > +#define ADP5585_GENERAL_CFG 0x3b
> > +#define ADP5585_OSC_EN BIT(7)
> > +#define ADP5585_OSC_FREQ_50KHZ (0U << 5)
> > +#define ADP5585_OSC_FREQ_100KHZ (1U << 5)
> > +#define ADP5585_OSC_FREQ_200KHZ (2U << 5)
> > +#define ADP5585_OSC_FREQ_500KHZ (3U << 5)
> > +#define ADP5585_OSC_FREQ_MASK (3U << 5)
> > +#define ADP5585_INT_CFG BIT(1)
> > +#define ADP5585_RST_CFG BIT(0)
> > +#define ADP5585_INT_EN 0x3c
> > +
> > +#define ADP5585_MAX_REG ADP5585_INT_EN
> > +
> > +#define ADP5585_BANK(n) ((n) >= 6 ? 1 : 0)
> > +#define ADP5585_BIT(n) ((n) >= 6 ? BIT((n) - 6) : BIT(n))
>
> Since you use 6 here for the BANK, maybe better to add comment here.
> For adi,adp5585-00(default), need to add "gpio-reserved-ranges = <5 1>;"
> to reserve gpio5 (GPIO 6/Row 5 in datasheet).
That's right. The DT bindings document that. I decided to follow the
numbering scheme from the datasheet, and mark GPIO 6/R5 as reserved for
chips that don't support it. The alternative would shift all the upper
GPIOs by one, and I think that would be more confusing for the users.
> People will meet issue when they try to use GPIO7~GPIO11 without
> config the reserved range, then will check the BANK here, add comment
> here will help.
I'll add a comment in the next version.
> > +
> > +struct regmap;
> > +
> > +struct adp5585_dev {
> > + struct regmap *regmap;
> > +};
> > +
> > +#endif
--
Regards,
Laurent Pinchart