[2/2] hwmon: add MP5920 driver

Add support for MPS Hot-Swap controller mp5920. This driver exposes
telemetry and limits value readings and writtings.

Signed-off-by: Alex Vdovydchenko <xzeol@yahoo.com>
---
 Documentation/hwmon/index.rst  |  1 +
 Documentation/hwmon/mp5920.rst | 91 +++++++++++++++++++++++++++++++++
 drivers/hwmon/pmbus/Kconfig    |  9 ++++
 drivers/hwmon/pmbus/Makefile   |  1 +
 drivers/hwmon/pmbus/mp5920.c   | 93 ++++++++++++++++++++++++++++++++++
 5 files changed, 195 insertions(+)
 create mode 100644 Documentation/hwmon/mp5920.rst
 create mode 100644 drivers/hwmon/pmbus/mp5920.c

On 6/26/24 07:24, Alex Vdovydchenko wrote:
> Add support for MPS Hot-Swap controller mp5920. This driver exposes
> telemetry and limits value readings and writtings.

limit

writings

> 

Is there a patch 1/2 and/or a summary patch ?

> Signed-off-by: Alex Vdovydchenko <xzeol@yahoo.com>
> ---
>   Documentation/hwmon/index.rst  |  1 +
>   Documentation/hwmon/mp5920.rst | 91 +++++++++++++++++++++++++++++++++
>   drivers/hwmon/pmbus/Kconfig    |  9 ++++
>   drivers/hwmon/pmbus/Makefile   |  1 +
>   drivers/hwmon/pmbus/mp5920.c   | 93 ++++++++++++++++++++++++++++++++++
>   5 files changed, 195 insertions(+)
>   create mode 100644 Documentation/hwmon/mp5920.rst
>   create mode 100644 drivers/hwmon/pmbus/mp5920.c
> 
> diff --git a/Documentation/hwmon/index.rst b/Documentation/hwmon/index.rst
> index e92a3d5c7..9eba7e402 100644
> --- a/Documentation/hwmon/index.rst
> +++ b/Documentation/hwmon/index.rst
> @@ -168,6 +168,7 @@ Hardware Monitoring Kernel Drivers
>      mp2975
>      mp2993
>      mp5023
> +   mp5920
>      mp5990
>      mp9941
>      mpq8785
> diff --git a/Documentation/hwmon/mp5920.rst b/Documentation/hwmon/mp5920.rst
> new file mode 100644
> --- /dev/null
> +++ b/Documentation/hwmon/mp5920.rst
> @@ -0,0 +1,91 @@
> +.. SPDX-License-Identifier: GPL-2.0
> +
> +Kernel driver mp5920
> +====================
> +
> +Supported chips:
> +
> +  * MPS MP5920
> +
> +    Prefix: 'mp5920'
> +
> +  * Datasheet
> +
> +    Publicly available at the MPS website : https://www.monolithicpower.com/en/mp5920.html
> +
> +Authors:
> +
> +	Tony Ao <tony_ao@wiwynn.com>
> +	Alex Vdovydchenko <xzeol@yahoo.com>
> +
> +Description
> +-----------
> +
> +This driver implements support for Monolithic Power Systems, Inc. (MPS)
> +MP5920 Hot-Swap Controller.
> +
> +Device compliant with:
> +
> +- PMBus rev 1.3 interface.
> +
> +Device supports direct and linear format for reading input voltage,
> +output voltage, output current, input power and temperature.
> +
> +The driver exports the following attributes via the 'sysfs' files
> +for input voltage:
> +
> +**in1_input**
> +
> +**in1_label**
> +
> +**in1_rated_max**
> +
> +**in1_rated_min**
> +
> +**in1_crit**
> +
> +**in1_alarm**
> +
> +The driver provides the following attributes for output voltage:
> +
> +**in2_input**
> +
> +**in2_label**
> +
> +**in2_rated_max**
> +
> +**in2_rated_min**
> +
> +**in2_alarm**
> +
> +The driver provides the following attributes for output current:
> +
> +**curr1_input**
> +
> +**curr1_label**
> +
> +**curr1_crit**
> +
> +**curr1_alarm**
> +
> +**curr1_rated_max**
> +
> +The driver provides the following attributes for input power:
> +
> +**power1_input**
> +
> +**power1_label**
> +
> +**power1_max**
> +
> +**power1_rated_max**
> +
> +The driver provides the following attributes for temperature:
> +
> +**temp1_input**
> +
> +**temp1_max**
> +
> +**temp1_crit**
> +
> +**temp1_alarm**
> diff --git a/drivers/hwmon/pmbus/Kconfig b/drivers/hwmon/pmbus/Kconfig
> --- a/drivers/hwmon/pmbus/Kconfig
> +++ b/drivers/hwmon/pmbus/Kconfig
> @@ -371,6 +371,15 @@ config SENSORS_MP5023
>   	  This driver can also be built as a module. If so, the module will
>   	  be called mp5023.
>   
> +config SENSORS_MP5920
> +	tristate "MPS MP5920"
> +	help
> +	  If you say yes here you get hardware monitoring support for Monolithic
> +	  MP5920.
> +
> +	  This driver can also be built as a module. If so, the module will
> +	  be called mp5920.
> +
>   config SENSORS_MP5990
>   	tristate "MPS MP5990"
>   	help
> diff --git a/drivers/hwmon/pmbus/Makefile b/drivers/hwmon/pmbus/Makefile
> --- a/drivers/hwmon/pmbus/Makefile
> +++ b/drivers/hwmon/pmbus/Makefile
> @@ -39,6 +39,7 @@ obj-$(CONFIG_SENSORS_MP2888)	+= mp2888.o
>   obj-$(CONFIG_SENSORS_MP2975)	+= mp2975.o
>   obj-$(CONFIG_SENSORS_MP2993)	+= mp2993.o
>   obj-$(CONFIG_SENSORS_MP5023)	+= mp5023.o
> +obj-$(CONFIG_SENSORS_MP5920)	+= mp5920.o
>   obj-$(CONFIG_SENSORS_MP5990)	+= mp5990.o
>   obj-$(CONFIG_SENSORS_MP9941)	+= mp9941.o
>   obj-$(CONFIG_SENSORS_MPQ7932)	+= mpq7932.o
> diff --git a/drivers/hwmon/pmbus/mp5920.c b/drivers/hwmon/pmbus/mp5920.c
> new file mode 100644
> --- /dev/null
> +++ b/drivers/hwmon/pmbus/mp5920.c
> @@ -0,0 +1,95 @@
> +// SPDX-License-Identifier: GPL-2.0-or-later
> +/*
> + * Hardware monitoring driver for MP5920 and compatible chips.
> + *
> + * Copyright (c) 2019 Facebook Inc.
> + *
> + * This program is free software; you can redistribute it and/or modify
> + * it under the terms of the GNU General Public License as published by
> + * the Free Software Foundation; either version 2 of the License, or
> + * (at your option) any later version.
> + *
> + * This program is distributed in the hope that it will be useful,
> + * but WITHOUT ANY WARRANTY; without even the implied warranty of
> + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
> + * GNU General Public License for more details.

This blob is unnecessary; it is covered by the SPDX license reference above.

> + */
> +#include <linux/err.h>
> +#include <linux/i2c.h>
> +#include <linux/init.h>
> +#include <linux/jiffies.h>

Not needed or used.

> +#include <linux/kernel.h>
> +#include <linux/module.h>
> +#include "pmbus.h"
> +
> +static struct pmbus_driver_info mp5920_info = {
> +	pages = 1,
> +	format[PSC_VOLTAGE_IN] = direct,
> +	format[PSC_VOLTAGE_OUT] = direct,
> +	format[PSC_CURRENT_OUT] = direct,
> +	format[PSC_POWER] = direct,
> +	format[PSC_TEMPERATURE] = direct,
> +	m[PSC_VOLTAGE_IN] = 2266,
> +	b[PSC_VOLTAGE_IN] = 0,
> +	R[PSC_VOLTAGE_IN] = -1,
> +	m[PSC_VOLTAGE_OUT] = 2266,
> +	b[PSC_VOLTAGE_OUT] = 0,
> +	R[PSC_VOLTAGE_OUT] = -1,
> +	m[PSC_CURRENT_OUT] = 546,
> +	b[PSC_CURRENT_OUT] = 0,
> +	R[PSC_CURRENT_OUT] = -2,
> +	m[PSC_POWER] = 5840,
> +	b[PSC_POWER] = 0,
> +	R[PSC_POWER] = -3,
> +	m[PSC_TEMPERATURE] = 1067,
> +	b[PSC_TEMPERATURE] = 20500,
> +	R[PSC_TEMPERATURE] = -2,
> +	func[0] = PMBUS_HAVE_VIN  | PMBUS_HAVE_VOUT |
> +		PMBUS_HAVE_IOUT | PMBUS_HAVE_POUT |
> +		PMBUS_HAVE_TEMP,
> +};
> +
> +static int mp5920_probe(struct i2c_client *client)
> +{
> +	struct device *dev =  &client->dev;
> +	int chip_id;
> +
> +	if (!i2c_check_functionality(client->adapter,
> +				     I2C_FUNC_SMBUS_READ_WORD_DATA))
> +		return -ENODEV;
> +
> +	chip_id = i2c_smbus_read_word_data(client, PMBUS_MFR_ID);
> +	if (chip_id < 0) {
> +		dev_err(dev, "Failed to read MFR ID");
> +		return chip_id;
> +	}

What is the point of reading the chip ID without doing anything with it ?

> +
> +	return pmbus_do_probe(client, &mp5920_info);
> +}
> +
> +static const struct of_device_id mp5920_of_match[] = {
> +	{ .compatible = "mps,mp5920" },
> +	{}
> +};
> +
> +static const struct i2c_device_id mp5920_id[] = {
> +	{"mp5920", 0},
> +	{ }
> +};
> +MODULE_DEVICE_TABLE(i2c, mp5920_id);
> +
> +static struct i2c_driver mp5920_driver = {
> +	.driver = {
> +		.name = "mp5920",
> +		.of_match_table = mp5920_of_match,
> +	},
> +	.probe = mp5920_probe,
> +	.id_table = mp5920_id,
> +};
> +module_i2c_driver(mp5920_driver);
> +
> +MODULE_AUTHOR("Tony Ao <tony_ao@wiwynn.com>");
> +MODULE_AUTHOR("Alex Vdovydchenko <xzeol@yahoo.com>");
> +MODULE_DESCRIPTION("PMBus driver for MP5920 HSC");
> +MODULE_LICENSE("GPL");
> +MODULE_IMPORT_NS(PMBUS);

On 2024-06-26 17:24:34+0000, Alex Vdovydchenko wrote:
> Add support for MPS Hot-Swap controller mp5920. This driver exposes
> telemetry and limits value readings and writtings.
> 
> Signed-off-by: Alex Vdovydchenko <xzeol@yahoo.com>
> ---
>  Documentation/hwmon/index.rst  |  1 +
>  Documentation/hwmon/mp5920.rst | 91 +++++++++++++++++++++++++++++++++
>  drivers/hwmon/pmbus/Kconfig    |  9 ++++
>  drivers/hwmon/pmbus/Makefile   |  1 +
>  drivers/hwmon/pmbus/mp5920.c   | 93 ++++++++++++++++++++++++++++++++++
>  5 files changed, 195 insertions(+)
>  create mode 100644 Documentation/hwmon/mp5920.rst
>  create mode 100644 drivers/hwmon/pmbus/mp5920.c
> 
> diff --git a/Documentation/hwmon/index.rst b/Documentation/hwmon/index.rst
> index e92a3d5c7..9eba7e402 100644
> --- a/Documentation/hwmon/index.rst
> +++ b/Documentation/hwmon/index.rst
> @@ -168,6 +168,7 @@ Hardware Monitoring Kernel Drivers
>     mp2975
>     mp2993
>     mp5023
> +   mp5920
>     mp5990
>     mp9941
>     mpq8785
> diff --git a/Documentation/hwmon/mp5920.rst b/Documentation/hwmon/mp5920.rst
> new file mode 100644
> --- /dev/null
> +++ b/Documentation/hwmon/mp5920.rst
> @@ -0,0 +1,91 @@
> +.. SPDX-License-Identifier: GPL-2.0
> +
> +Kernel driver mp5920
> +====================
> +
> +Supported chips:
> +
> +  * MPS MP5920
> +
> +    Prefix: 'mp5920'
> +
> +  * Datasheet
> +
> +    Publicly available at the MPS website : https://www.monolithicpower.com/en/mp5920.html
> +
> +Authors:
> +
> +	Tony Ao <tony_ao@wiwynn.com>
> +	Alex Vdovydchenko <xzeol@yahoo.com>
> +
> +Description
> +-----------
> +
> +This driver implements support for Monolithic Power Systems, Inc. (MPS)
> +MP5920 Hot-Swap Controller.
> +
> +Device compliant with:
> +
> +- PMBus rev 1.3 interface.
> +
> +Device supports direct and linear format for reading input voltage,
> +output voltage, output current, input power and temperature.
> +
> +The driver exports the following attributes via the 'sysfs' files
> +for input voltage:
> +
> +**in1_input**
> +
> +**in1_label**
> +
> +**in1_rated_max**
> +
> +**in1_rated_min**
> +
> +**in1_crit**
> +
> +**in1_alarm**
> +
> +The driver provides the following attributes for output voltage:
> +
> +**in2_input**
> +
> +**in2_label**
> +
> +**in2_rated_max**
> +
> +**in2_rated_min**
> +
> +**in2_alarm**
> +
> +The driver provides the following attributes for output current:
> +
> +**curr1_input**
> +
> +**curr1_label**
> +
> +**curr1_crit**
> +
> +**curr1_alarm**
> +
> +**curr1_rated_max**
> +
> +The driver provides the following attributes for input power:
> +
> +**power1_input**
> +
> +**power1_label**
> +
> +**power1_max**
> +
> +**power1_rated_max**
> +
> +The driver provides the following attributes for temperature:
> +
> +**temp1_input**
> +
> +**temp1_max**
> +
> +**temp1_crit**
> +
> +**temp1_alarm**
> diff --git a/drivers/hwmon/pmbus/Kconfig b/drivers/hwmon/pmbus/Kconfig
> --- a/drivers/hwmon/pmbus/Kconfig
> +++ b/drivers/hwmon/pmbus/Kconfig
> @@ -371,6 +371,15 @@ config SENSORS_MP5023
>  	  This driver can also be built as a module. If so, the module will
>  	  be called mp5023.
>  
> +config SENSORS_MP5920
> +	tristate "MPS MP5920"
> +	help
> +	  If you say yes here you get hardware monitoring support for Monolithic
> +	  MP5920.
> +
> +	  This driver can also be built as a module. If so, the module will
> +	  be called mp5920.
> +
>  config SENSORS_MP5990
>  	tristate "MPS MP5990"
>  	help
> diff --git a/drivers/hwmon/pmbus/Makefile b/drivers/hwmon/pmbus/Makefile
> --- a/drivers/hwmon/pmbus/Makefile
> +++ b/drivers/hwmon/pmbus/Makefile
> @@ -39,6 +39,7 @@ obj-$(CONFIG_SENSORS_MP2888)	+= mp2888.o
>  obj-$(CONFIG_SENSORS_MP2975)	+= mp2975.o
>  obj-$(CONFIG_SENSORS_MP2993)	+= mp2993.o
>  obj-$(CONFIG_SENSORS_MP5023)	+= mp5023.o
> +obj-$(CONFIG_SENSORS_MP5920)	+= mp5920.o
>  obj-$(CONFIG_SENSORS_MP5990)	+= mp5990.o
>  obj-$(CONFIG_SENSORS_MP9941)	+= mp9941.o
>  obj-$(CONFIG_SENSORS_MPQ7932)	+= mpq7932.o
> diff --git a/drivers/hwmon/pmbus/mp5920.c b/drivers/hwmon/pmbus/mp5920.c
> new file mode 100644
> --- /dev/null
> +++ b/drivers/hwmon/pmbus/mp5920.c
> @@ -0,0 +1,95 @@
> +// SPDX-License-Identifier: GPL-2.0-or-later
> +/*
> + * Hardware monitoring driver for MP5920 and compatible chips.
> + *
> + * Copyright (c) 2019 Facebook Inc.
> + *
> + * This program is free software; you can redistribute it and/or modify
> + * it under the terms of the GNU General Public License as published by
> + * the Free Software Foundation; either version 2 of the License, or
> + * (at your option) any later version.
> + *
> + * This program is distributed in the hope that it will be useful,
> + * but WITHOUT ANY WARRANTY; without even the implied warranty of
> + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
> + * GNU General Public License for more details.
> + */
> +#include <linux/err.h>
> +#include <linux/i2c.h>
> +#include <linux/init.h>
> +#include <linux/jiffies.h>
> +#include <linux/kernel.h>
> +#include <linux/module.h>
> +#include "pmbus.h"
> +
> +static struct pmbus_driver_info mp5920_info = {
> +	pages = 1,
> +	format[PSC_VOLTAGE_IN] = direct,
> +	format[PSC_VOLTAGE_OUT] = direct,
> +	format[PSC_CURRENT_OUT] = direct,
> +	format[PSC_POWER] = direct,
> +	format[PSC_TEMPERATURE] = direct,
> +	m[PSC_VOLTAGE_IN] = 2266,
> +	b[PSC_VOLTAGE_IN] = 0,
> +	R[PSC_VOLTAGE_IN] = -1,
> +	m[PSC_VOLTAGE_OUT] = 2266,
> +	b[PSC_VOLTAGE_OUT] = 0,
> +	R[PSC_VOLTAGE_OUT] = -1,
> +	m[PSC_CURRENT_OUT] = 546,
> +	b[PSC_CURRENT_OUT] = 0,
> +	R[PSC_CURRENT_OUT] = -2,
> +	m[PSC_POWER] = 5840,
> +	b[PSC_POWER] = 0,
> +	R[PSC_POWER] = -3,
> +	m[PSC_TEMPERATURE] = 1067,
> +	b[PSC_TEMPERATURE] = 20500,
> +	R[PSC_TEMPERATURE] = -2,
> +	func[0] = PMBUS_HAVE_VIN  | PMBUS_HAVE_VOUT |
> +		PMBUS_HAVE_IOUT | PMBUS_HAVE_POUT |
> +		PMBUS_HAVE_TEMP,
> +};
> +
> +static int mp5920_probe(struct i2c_client *client)
> +{
> +	struct device *dev =  &client->dev;
> +	int chip_id;
> +
> +	if (!i2c_check_functionality(client->adapter,
> +				     I2C_FUNC_SMBUS_READ_WORD_DATA))
> +		return -ENODEV;

Already checked by pmbus_do_probe().

> +
> +	chip_id = i2c_smbus_read_word_data(client, PMBUS_MFR_ID);
> +	if (chip_id < 0) {
> +		dev_err(dev, "Failed to read MFR ID");
> +		return chip_id;
> +	}
> +
> +	return pmbus_do_probe(client, &mp5920_info);
> +}
> +
> +static const struct of_device_id mp5920_of_match[] = {
> +	{ .compatible = "mps,mp5920" },
> +	{}
> +};

MODULE_DEVICE_TABLE(of, mp5920_of_match);

> +
> +static const struct i2c_device_id mp5920_id[] = {
> +	{"mp5920", 0},
> +	{ }

Inconsistent style between sentinels of both device tables.

> +};
> +MODULE_DEVICE_TABLE(i2c, mp5920_id);
> +
> +static struct i2c_driver mp5920_driver = {
> +	.driver = {
> +		.name = "mp5920",
> +		.of_match_table = mp5920_of_match,
> +	},
> +	.probe = mp5920_probe,
> +	.id_table = mp5920_id,
> +};
> +module_i2c_driver(mp5920_driver);
> +
> +MODULE_AUTHOR("Tony Ao <tony_ao@wiwynn.com>");
> +MODULE_AUTHOR("Alex Vdovydchenko <xzeol@yahoo.com>");
> +MODULE_DESCRIPTION("PMBus driver for MP5920 HSC");
> +MODULE_LICENSE("GPL");
> +MODULE_IMPORT_NS(PMBUS);
> -- 
> 2.43.0
>