Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
Date:   Wed, 10 Aug 2022 12:27:25 +0100
From:   Lee Jones <lee@kernel.org>
To:     Matt Ranostay <mranostay@ti.com>
Cc:     nm@ti.com, linux-rtc@vger.kernel.org, linux-kernel@vger.kernel.org,
        linux-arm-kernel@lists.infradead.org, devicetree@vger.kernel.org,
        Keerthy <j-keerthy@ti.com>
Subject: Re: [PATCH 2/4] MFD: TPS6594x: Add new mfd device for TPS6594x PMIC
Message-ID: <YvOWHccZQ0RMkHiD@google.com>
References: <20220805064352.793918-1-mranostay@ti.com>
 <20220805064352.793918-3-mranostay@ti.com>
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Disposition: inline
Content-Transfer-Encoding: 8bit
In-Reply-To: <20220805064352.793918-3-mranostay@ti.com>
Precedence: bulk

On Thu, 04 Aug 2022, Matt Ranostay wrote:

> From: Keerthy <j-keerthy@ti.com>
> 
> The TPS6594x chip is a PMIC, and contains the following components:
> 
> - Regulators
> - GPIO controller
> - RTC
> 
> However initially only RTC is supported.
> 
> Signed-off-by: Keerthy <j-keerthy@ti.com>
> Signed-off-by: Matt Ranostay <mranostay@ti.com>
> ---
>  drivers/mfd/Kconfig          |  14 +++++
>  drivers/mfd/Makefile         |   1 +
>  drivers/mfd/tps6594x.c       | 106 +++++++++++++++++++++++++++++++++++
>  include/linux/mfd/tps6594x.h |  66 ++++++++++++++++++++++
>  4 files changed, 187 insertions(+)
>  create mode 100644 drivers/mfd/tps6594x.c
>  create mode 100644 include/linux/mfd/tps6594x.h
> 
> diff --git a/drivers/mfd/Kconfig b/drivers/mfd/Kconfig
> index abb58ab1a1a4..cfb5b3d66b76 100644
> --- a/drivers/mfd/Kconfig
> +++ b/drivers/mfd/Kconfig
> @@ -1547,6 +1547,20 @@ config MFD_TI_LP873X
>  	  This driver can also be built as a module. If so, the module
>  	  will be called lp873x.
>  
> +config MFD_TPS6594X
> +	tristate "TI TPS6594X Power Management IC"
> +	depends on I2C
> +	select MFD_CORE
> +	select REGMAP_I2C
> +	help
> +	  If you say yes here then you get support for the TPS6594X series of
> +	  Power Management Integrated Circuits (PMIC).
> +	  These include voltage regulators, RTS, configurable
> +	  General Purpose Outputs (GPO) that are used in portable devices.
> +
> +	  This driver can also be built as a module. If so, the module
> +	  will be called tps7694x.
> +
>  config MFD_TI_LP87565
>  	tristate "TI LP87565 Power Management IC"
>  	depends on I2C && OF
> diff --git a/drivers/mfd/Makefile b/drivers/mfd/Makefile
> index 858cacf659d6..7ff6a8a57d55 100644
> --- a/drivers/mfd/Makefile
> +++ b/drivers/mfd/Makefile
> @@ -105,6 +105,7 @@ obj-$(CONFIG_MFD_TPS65910)	+= tps65910.o
>  obj-$(CONFIG_MFD_TPS65912)	+= tps65912-core.o
>  obj-$(CONFIG_MFD_TPS65912_I2C)	+= tps65912-i2c.o
>  obj-$(CONFIG_MFD_TPS65912_SPI)  += tps65912-spi.o
> +obj-$(CONFIG_MFD_TPS6594X)	+= tps6594x.o
>  obj-$(CONFIG_MENELAUS)		+= menelaus.o
>  
>  obj-$(CONFIG_TWL4030_CORE)	+= twl-core.o twl4030-irq.o twl6030-irq.o
> diff --git a/drivers/mfd/tps6594x.c b/drivers/mfd/tps6594x.c
> new file mode 100644
> index 000000000000..519162cc1fbe
> --- /dev/null
> +++ b/drivers/mfd/tps6594x.c
> @@ -0,0 +1,106 @@
> +// SPDX-License-Identifier: GPL-2.0-or-later
> +/*
> + * tps6594x.c  --  TI TPS6594x chip family multi-function driver

No filenames in comments please.

Also, there are too many spaces around the '--'.

It's not a "multi-function driver" it's a PMIC Core driver.

> + * Copyright (C) 2022 Texas Instruments Incorporated - https://www.ti.com/
> + *
> + * Author: Keerthy <j-keerthy@ti.com>
> + */
> +
> +#include <linux/interrupt.h>
> +#include <linux/mfd/core.h>
> +#include <linux/module.h>
> +#include <linux/of_device.h>
> +#include <linux/i2c.h>
> +#include <linux/regmap.h>

Alphabetical.

> +#include <linux/mfd/tps6594x.h>
> +
> +static const struct regmap_config tps6594x_regmap_config = {
> +	.reg_bits = 8,
> +	.val_bits = 8,
> +	.max_register = TPS6594X_REG_MAX,
> +};
> +
> +static const struct mfd_cell tps6594x_cells[] = {
> +	{ .name = "tps6594x-rtc", },
> +};

Where are the rest of the devices?

This is not an MFD with only one device.

> +static struct tps6594x *tps;
> +
> +static void tps6594x_power_off(void)
> +{
> +	regmap_write(tps->regmap, TPS6594X_FSM_NSLEEP_TRIGGERS, 0x3);
> +	regmap_write(tps->regmap, TPS6594X_INT_STARTUP, 0xff);
> +	regmap_write(tps->regmap, TPS6594X_INT_MISC, 0xff);
> +	regmap_write(tps->regmap, TPS6594X_CONFIG_1, 0xc0);
> +	regmap_write(tps->regmap, TPS6594X_FSM_I2C_TRIGGERS, 0x1);

No magic numbers please.  Define all of those values.

> +}
> +
> +static int tps6594x_probe(struct i2c_client *client,
> +			const struct i2c_device_id *ids)
> +{
> +	struct tps6594x *tps6594;

*ddata is preferred.

> +	int ret;
> +	unsigned int otpid;
> +	struct device_node *node = client->dev.of_node;

Re-order these - usually 'structs' go first, then ints.

> +	tps6594 = devm_kzalloc(&client->dev, sizeof(*tps6594), GFP_KERNEL);
> +	if (!tps6594)
> +		return -ENOMEM;
> +
> +	tps6594->dev = &client->dev;
> +
> +	tps6594->regmap = devm_regmap_init_i2c(client, &tps6594x_regmap_config);
> +	if (IS_ERR(tps6594->regmap)) {
> +		ret = PTR_ERR(tps6594->regmap);
> +		dev_err(tps6594->dev,
> +			"Failed to initialize register map: %d\n", ret);
> +		return ret;
> +	}
> +
> +	ret = regmap_read(tps6594->regmap, TPS6594X_REG_DEV_REV, &otpid);
> +	if (ret) {
> +		dev_err(tps6594->dev, "Failed to read OTP ID\n");
> +		return ret;
> +	}
> +
> +	tps6594->rev = otpid;
> +
> +	i2c_set_clientdata(client, tps6594);
> +
> +	ret = mfd_add_devices(tps6594->dev, PLATFORM_DEVID_AUTO, tps6594x_cells,
> +			      ARRAY_SIZE(tps6594x_cells), NULL, 0, NULL);
> +
> +	tps = tps6594;
> +	if (of_property_read_bool(node, "ti,system-power-controller"))
> +		pm_power_off = tps6594x_power_off;

You setting this up even if mfd_add_devices() fails?

Seems wrong.

> +	return ret;
> +}
> +
> +static const struct of_device_id of_tps6594x_match_table[] = {
> +	{ .compatible = "ti,tps6594x", },
> +	{}
> +};
> +MODULE_DEVICE_TABLE(of, of_tps6594x_match_table);
> +
> +static const struct i2c_device_id tps6594x_id_table[] = {
> +	{ "tps6594x", 0 },
> +	{ },
> +};
> +MODULE_DEVICE_TABLE(i2c, tps6594x_id_table);

Remove this and use .probe_new instead please.

> +static struct i2c_driver tps6594x_driver = {
> +	.driver	= {
> +		.name	= "tps6594x",
> +		.of_match_table = of_tps6594x_match_table,
> +	},
> +	.probe		= tps6594x_probe,
> +	.id_table	= tps6594x_id_table,
> +};
> +module_i2c_driver(tps6594x_driver);
> +
> +MODULE_AUTHOR("J Keerthy <j-keerthy@ti.com>");
> +MODULE_DESCRIPTION("TPS6594X chip family Multi-Function Device driver");

Not an MFD.

> +MODULE_LICENSE("GPL");
> diff --git a/include/linux/mfd/tps6594x.h b/include/linux/mfd/tps6594x.h
> new file mode 100644
> index 000000000000..41349f96f013
> --- /dev/null
> +++ b/include/linux/mfd/tps6594x.h
> @@ -0,0 +1,66 @@
> +/* SPDX-License-Identifier: GPL-2.0-or-later */
> +/*
> + * tps6594x.h  --  TI TPS6594x

No filenames.

> + * Copyright (C) 2016 Texas Instruments Incorporated - https://www.ti.com/

2016?

> + */
> +
> +#ifndef __LINUX_MFD_TPS6594X_H
> +#define __LINUX_MFD_TPS6594X_H

Any reason go keep the LINUX part?

> +#include <linux/bits.h>
> +
> +/* TPS6594x chip id list */

"ID"

> +#define TPS6594X			0x00
> +
> +/* All register addresses */
> +#define TPS6594X_REG_DEV_REV			0x01
> +#define TPS6594X_INT_STARTUP			0x65
> +#define TPS6594X_INT_MISC			0x66
> +#define TPS6594X_CONFIG_1			0x7d
> +#define TPS6594X_FSM_I2C_TRIGGERS		0x85
> +#define TPS6594X_FSM_NSLEEP_TRIGGERS		0x86
> +
> +#define TPS6594X_RTC_SECONDS			0xb5
> +#define TPS6594X_RTC_MINUTES			0xb6
> +#define TPS6594X_RTC_HOURS			0xb7
> +#define TPS6594X_RTC_DAYS			0xb8
> +#define TPS6594X_RTC_MONTHS			0xb9
> +#define TPS6594X_RTC_YEARS			0xba
> +#define TPS6594X_RTC_WEEKS			0xbb
> +#define TPS6594X_ALARM_SECONDS			0xbc
> +#define TPS6594X_ALARM_MINUTES			0xbd
> +#define TPS6594X_ALARM_HOURS			0xbe
> +#define TPS6594X_ALARM_DAYS			0xbf
> +#define TPS6594X_ALARM_MONTHS			0xc0
> +#define TPS6594X_ALARM_YEARS			0xc1
> +#define TPS6594X_RTC_CTRL_1			0xc2
> +#define TPS6594X_RTC_CTRL_2			0xc3
> +#define TPS6594X_RTC_STATUS			0xc4
> +#define TPS6594X_RTC_INTERRUPTS			0xc5
> +#define TPS6594X_REG_MAX			0xd0
> +
> +/* Register field definitions */
> +#define TPS6594X_DEV_REV_DEV_ID			0xff
> +
> +#define TPS6594X_RTC_CTRL_REG_GET_TIME		BIT(6)
> +#define TPS6594X_RTC_CTRL_REG_STOP_RTC		BIT(0)
> +#define TPS6594X_RTC_INTERRUPTS_REG_IT_ALARM	BIT(3)
> +
> +#define TPS6594X_RTC_STATUS_RUN			BIT(1)
> +
> +/**
> + * struct tps6594x - state holder for the tps6594x driver
> + * @dev: struct device pointer for MFD device
> + * @rev: revision of the tps6594x
> + * @lock: lock guarding the data structure
> + * @regmap: register map of the tps6594x PMIC
> + *
> + * Device data may be used to access the TPS6594X chip
> + */
> +struct tps6594x {
> +	struct device *dev;
> +	u8 rev;
> +	struct regmap *regmap;
> +};

Please test compile with W=1 enabled and fix the issues.

> +#endif /* __LINUX_MFD_TPS6594X_H */

-- 
Lee Jones [李琼斯]