| Message ID | 20240530112307.3089696-2-naveenkrishna.chatradhi@amd.com (mailing list archive) |
|---|---|
| State | Handled Elsewhere |
| Headers | show |
| Series | mfd: add amd side-band functionality | expand |
On 5/30/24 04:23, Naveen Krishna Chatradhi wrote: > From: Akshay Gupta <akshay.gupta@amd.com> > > This is done to support other functionality provided by the SBRMI, which > does not fit in the hwmon subsystem. > > - Move the core SBRMI core functionality and I2C device probing to MFD > - Modify this module to be probed as a platform device by the MFD cell. > > Signed-off-by: Akshay Gupta <Akshay.Gupta@amd.com> > Reviewed-by: Naveen Krishna Chatradhi <naveenkrishna.chatradhi@amd.com> For the hwmon part: Acked-by: Guenter Roeck <linux@roeck-us.net> > --- > drivers/hwmon/Kconfig | 1 + > drivers/hwmon/sbrmi.c | 245 +++---------------------------------- > drivers/mfd/Kconfig | 10 +- > drivers/mfd/Makefile | 2 + > drivers/mfd/sbrmi-core.c | 137 +++++++++++++++++++++ > drivers/mfd/sbrmi-i2c.c | 106 ++++++++++++++++ > include/linux/mfd/amd-sb.h | 45 +++++++ > 7 files changed, 316 insertions(+), 230 deletions(-) > create mode 100644 drivers/mfd/sbrmi-core.c > create mode 100644 drivers/mfd/sbrmi-i2c.c > create mode 100644 include/linux/mfd/amd-sb.h > > diff --git a/drivers/hwmon/Kconfig b/drivers/hwmon/Kconfig > index e14ae18a973b..56b73e665424 100644 > --- a/drivers/hwmon/Kconfig > +++ b/drivers/hwmon/Kconfig > @@ -1839,6 +1839,7 @@ config SENSORS_SBTSI > config SENSORS_SBRMI > tristate "Emulated SB-RMI sensor" > depends on I2C > + depends on MFD_SBRMI_I2C > help > If you say yes here you get support for emulated RMI > sensors on AMD SoCs with APML interface connected to a BMC device. > diff --git a/drivers/hwmon/sbrmi.c b/drivers/hwmon/sbrmi.c > index d48d8e5460ff..aaeb5050eb0c 100644 > --- a/drivers/hwmon/sbrmi.c > +++ b/drivers/hwmon/sbrmi.c > @@ -3,190 +3,18 @@ > * sbrmi.c - hwmon driver for a SB-RMI mailbox > * compliant AMD SoC device. > * > - * Copyright (C) 2020-2021 Advanced Micro Devices, Inc. > + * Copyright (C) 2020-2024 Advanced Micro Devices, Inc. > */ > > -#include <linux/delay.h> > #include <linux/err.h> > #include <linux/hwmon.h> > -#include <linux/i2c.h> > -#include <linux/init.h> > +#include <linux/mfd/amd-sb.h> > #include <linux/module.h> > -#include <linux/mutex.h> > -#include <linux/of.h> > +#include <linux/mod_devicetable.h> > +#include <linux/platform_device.h> > > /* Do not allow setting negative power limit */ > #define SBRMI_PWR_MIN 0 > -/* Mask for Status Register bit[1] */ > -#define SW_ALERT_MASK 0x2 > - > -/* Software Interrupt for triggering */ > -#define START_CMD 0x80 > -#define TRIGGER_MAILBOX 0x01 > - > -/* > - * SB-RMI supports soft mailbox service request to MP1 (power management > - * firmware) through SBRMI inbound/outbound message registers. > - * SB-RMI message IDs > - */ > -enum sbrmi_msg_id { > - SBRMI_READ_PKG_PWR_CONSUMPTION = 0x1, > - SBRMI_WRITE_PKG_PWR_LIMIT, > - SBRMI_READ_PKG_PWR_LIMIT, > - SBRMI_READ_PKG_MAX_PWR_LIMIT, > -}; > - > -/* SB-RMI registers */ > -enum sbrmi_reg { > - SBRMI_CTRL = 0x01, > - SBRMI_STATUS, > - SBRMI_OUTBNDMSG0 = 0x30, > - SBRMI_OUTBNDMSG1, > - SBRMI_OUTBNDMSG2, > - SBRMI_OUTBNDMSG3, > - SBRMI_OUTBNDMSG4, > - SBRMI_OUTBNDMSG5, > - SBRMI_OUTBNDMSG6, > - SBRMI_OUTBNDMSG7, > - SBRMI_INBNDMSG0, > - SBRMI_INBNDMSG1, > - SBRMI_INBNDMSG2, > - SBRMI_INBNDMSG3, > - SBRMI_INBNDMSG4, > - SBRMI_INBNDMSG5, > - SBRMI_INBNDMSG6, > - SBRMI_INBNDMSG7, > - SBRMI_SW_INTERRUPT, > -}; > - > -/* Each client has this additional data */ > -struct sbrmi_data { > - struct i2c_client *client; > - struct mutex lock; > - u32 pwr_limit_max; > -}; > - > -struct sbrmi_mailbox_msg { > - u8 cmd; > - bool read; > - u32 data_in; > - u32 data_out; > -}; > - > -static int sbrmi_enable_alert(struct i2c_client *client) > -{ > - int ctrl; > - > - /* > - * Enable the SB-RMI Software alert status > - * by writing 0 to bit 4 of Control register(0x1) > - */ > - ctrl = i2c_smbus_read_byte_data(client, SBRMI_CTRL); > - if (ctrl < 0) > - return ctrl; > - > - if (ctrl & 0x10) { > - ctrl &= ~0x10; > - return i2c_smbus_write_byte_data(client, > - SBRMI_CTRL, ctrl); > - } > - > - return 0; > -} > - > -static int rmi_mailbox_xfer(struct sbrmi_data *data, > - struct sbrmi_mailbox_msg *msg) > -{ > - int i, ret, retry = 10; > - int sw_status; > - u8 byte; > - > - mutex_lock(&data->lock); > - > - /* Indicate firmware a command is to be serviced */ > - ret = i2c_smbus_write_byte_data(data->client, > - SBRMI_INBNDMSG7, START_CMD); > - if (ret < 0) > - goto exit_unlock; > - > - /* Write the command to SBRMI::InBndMsg_inst0 */ > - ret = i2c_smbus_write_byte_data(data->client, > - SBRMI_INBNDMSG0, msg->cmd); > - if (ret < 0) > - goto exit_unlock; > - > - /* > - * For both read and write the initiator (BMC) writes > - * Command Data In[31:0] to SBRMI::InBndMsg_inst[4:1] > - * SBRMI_x3C(MSB):SBRMI_x39(LSB) > - */ > - for (i = 0; i < 4; i++) { > - byte = (msg->data_in >> i * 8) & 0xff; > - ret = i2c_smbus_write_byte_data(data->client, > - SBRMI_INBNDMSG1 + i, byte); > - if (ret < 0) > - goto exit_unlock; > - } > - > - /* > - * Write 0x01 to SBRMI::SoftwareInterrupt to notify firmware to > - * perform the requested read or write command > - */ > - ret = i2c_smbus_write_byte_data(data->client, > - SBRMI_SW_INTERRUPT, TRIGGER_MAILBOX); > - if (ret < 0) > - goto exit_unlock; > - > - /* > - * Firmware will write SBRMI::Status[SwAlertSts]=1 to generate > - * an ALERT (if enabled) to initiator (BMC) to indicate completion > - * of the requested command > - */ > - do { > - sw_status = i2c_smbus_read_byte_data(data->client, > - SBRMI_STATUS); > - if (sw_status < 0) { > - ret = sw_status; > - goto exit_unlock; > - } > - if (sw_status & SW_ALERT_MASK) > - break; > - usleep_range(50, 100); > - } while (retry--); > - > - if (retry < 0) { > - dev_err(&data->client->dev, > - "Firmware fail to indicate command completion\n"); > - ret = -EIO; > - goto exit_unlock; > - } > - > - /* > - * For a read operation, the initiator (BMC) reads the firmware > - * response Command Data Out[31:0] from SBRMI::OutBndMsg_inst[4:1] > - * {SBRMI_x34(MSB):SBRMI_x31(LSB)}. > - */ > - if (msg->read) { > - for (i = 0; i < 4; i++) { > - ret = i2c_smbus_read_byte_data(data->client, > - SBRMI_OUTBNDMSG1 + i); > - if (ret < 0) > - goto exit_unlock; > - msg->data_out |= ret << i * 8; > - } > - } > - > - /* > - * BMC must write 1'b1 to SBRMI::Status[SwAlertSts] to clear the > - * ALERT to initiator > - */ > - ret = i2c_smbus_write_byte_data(data->client, SBRMI_STATUS, > - sw_status | SW_ALERT_MASK); > - > -exit_unlock: > - mutex_unlock(&data->lock); > - return ret; > -} > > static int sbrmi_read(struct device *dev, enum hwmon_sensor_types type, > u32 attr, int channel, long *val) > @@ -282,76 +110,35 @@ static const struct hwmon_chip_info sbrmi_chip_info = { > .info = sbrmi_info, > }; > > -static int sbrmi_get_max_pwr_limit(struct sbrmi_data *data) > +static int sbrmi_probe(struct platform_device *pdev) > { > - struct sbrmi_mailbox_msg msg = { 0 }; > - int ret; > - > - msg.cmd = SBRMI_READ_PKG_MAX_PWR_LIMIT; > - msg.read = true; > - ret = rmi_mailbox_xfer(data, &msg); > - if (ret < 0) > - return ret; > - data->pwr_limit_max = msg.data_out; > - > - return ret; > -} > - > -static int sbrmi_probe(struct i2c_client *client) > -{ > - struct device *dev = &client->dev; > + struct device *dev = &pdev->dev; > struct device *hwmon_dev; > - struct sbrmi_data *data; > - int ret; > - > - data = devm_kzalloc(dev, sizeof(struct sbrmi_data), GFP_KERNEL); > - if (!data) > - return -ENOMEM; > - > - data->client = client; > - mutex_init(&data->lock); > - > - /* Enable alert for SB-RMI sequence */ > - ret = sbrmi_enable_alert(client); > - if (ret < 0) > - return ret; > + struct sbrmi_data *data = dev_get_drvdata(pdev->dev.parent); > > - /* Cache maximum power limit */ > - ret = sbrmi_get_max_pwr_limit(data); > - if (ret < 0) > - return ret; > - > - hwmon_dev = devm_hwmon_device_register_with_info(dev, client->name, data, > + hwmon_dev = devm_hwmon_device_register_with_info(dev, "sbrmi", data, > &sbrmi_chip_info, NULL); > - > return PTR_ERR_OR_ZERO(hwmon_dev); > } > > -static const struct i2c_device_id sbrmi_id[] = { > - {"sbrmi"}, > - {} > -}; > -MODULE_DEVICE_TABLE(i2c, sbrmi_id); > - > -static const struct of_device_id __maybe_unused sbrmi_of_match[] = { > +static const struct platform_device_id sbrmi_id[] = { > { > - .compatible = "amd,sbrmi", > + .name = "sbrmi-hwmon", > }, > { }, > }; > -MODULE_DEVICE_TABLE(of, sbrmi_of_match); > +MODULE_DEVICE_TABLE(platform, sbrmi_id); > > -static struct i2c_driver sbrmi_driver = { > +static struct platform_driver amd_sbrmi_hwmon_driver = { > + .probe = sbrmi_probe, > .driver = { > - .name = "sbrmi", > - .of_match_table = of_match_ptr(sbrmi_of_match), > + .name = "amd-sbrmi", > }, > - .probe = sbrmi_probe, > .id_table = sbrmi_id, > }; > - > -module_i2c_driver(sbrmi_driver); > +module_platform_driver(amd_sbrmi_hwmon_driver); > > MODULE_AUTHOR("Akshay Gupta <akshay.gupta@amd.com>"); > +MODULE_AUTHOR("Naveen Krishna Chatradhi <naveenkrishna.chatradhi@amd.com>"); > MODULE_DESCRIPTION("Hwmon driver for AMD SB-RMI emulated sensor"); > MODULE_LICENSE("GPL"); > diff --git a/drivers/mfd/Kconfig b/drivers/mfd/Kconfig > index 266b4f54af60..0411cb29b6df 100644 > --- a/drivers/mfd/Kconfig > +++ b/drivers/mfd/Kconfig > @@ -1442,6 +1442,15 @@ config MFD_STMPE > Touchscreen: stmpe-ts > ADC: stmpe-adc > > +config MFD_SBRMI_I2C > + tristate "APML SBRMI support" > + depends on I2C > + select MFD_CORE > + help > + APML RMI core support for AMD out of band management > + This driver can also be built as a module. If so, the module will > + be called sbrmi. > + > menu "STMicroelectronics STMPE Interface Drivers" > depends on MFD_STMPE > > @@ -2333,6 +2342,5 @@ config MFD_RSMU_SPI > This driver provides common support for accessing the device. > Additional drivers must be enabled in order to use the functionality > of the device. > - > endmenu > endif > diff --git a/drivers/mfd/Makefile b/drivers/mfd/Makefile > index c66f07edcd0e..6bc807c2e5ed 100644 > --- a/drivers/mfd/Makefile > +++ b/drivers/mfd/Makefile > @@ -284,3 +284,5 @@ rsmu-i2c-objs := rsmu_core.o rsmu_i2c.o > rsmu-spi-objs := rsmu_core.o rsmu_spi.o > obj-$(CONFIG_MFD_RSMU_I2C) += rsmu-i2c.o > obj-$(CONFIG_MFD_RSMU_SPI) += rsmu-spi.o > +apml_sbrmi-objs := sbrmi-i2c.o sbrmi-core.o > +obj-$(CONFIG_MFD_SBRMI_I2C) += apml_sbrmi.o > diff --git a/drivers/mfd/sbrmi-core.c b/drivers/mfd/sbrmi-core.c > new file mode 100644 > index 000000000000..d872b5107b36 > --- /dev/null > +++ b/drivers/mfd/sbrmi-core.c > @@ -0,0 +1,137 @@ > +// SPDX-License-Identifier: GPL-2.0-or-later > +/* > + * sbrmi-common.c - file defining SB-RMI protocols > + * compliant AMD SoC device. > + * > + * Copyright (C) 2021-2024 Advanced Micro Devices, Inc. > + */ > +#include <linux/delay.h> > +#include <linux/err.h> > +#include <linux/i2c.h> > +#include <linux/mfd/amd-sb.h> > +#include <linux/mutex.h> > + > +/* Mask for Status Register bit[1] */ > +#define SW_ALERT_MASK 0x2 > + > +/* Software Interrupt for triggering */ > +#define START_CMD 0x80 > +#define TRIGGER_MAILBOX 0x01 > + > +/* SB-RMI registers */ > +enum sbrmi_reg { > + SBRMI_CTRL = 0x01, > + SBRMI_STATUS, > + SBRMI_OUTBNDMSG0 = 0x30, > + SBRMI_OUTBNDMSG1, > + SBRMI_OUTBNDMSG2, > + SBRMI_OUTBNDMSG3, > + SBRMI_OUTBNDMSG4, > + SBRMI_OUTBNDMSG5, > + SBRMI_OUTBNDMSG6, > + SBRMI_OUTBNDMSG7, > + SBRMI_INBNDMSG0, > + SBRMI_INBNDMSG1, > + SBRMI_INBNDMSG2, > + SBRMI_INBNDMSG3, > + SBRMI_INBNDMSG4, > + SBRMI_INBNDMSG5, > + SBRMI_INBNDMSG6, > + SBRMI_INBNDMSG7, > + SBRMI_SW_INTERRUPT, > +}; > + > +int rmi_mailbox_xfer(struct sbrmi_data *data, > + struct sbrmi_mailbox_msg *msg) > +{ > + int i, ret, retry = 10; > + int sw_status; > + u8 byte; > + > + mutex_lock(&data->lock); > + > + /* Indicate firmware a command is to be serviced */ > + ret = i2c_smbus_write_byte_data(data->client, > + SBRMI_INBNDMSG7, START_CMD); > + if (ret < 0) > + goto exit_unlock; > + > + /* Write the command to SBRMI::InBndMsg_inst0 */ > + ret = i2c_smbus_write_byte_data(data->client, > + SBRMI_INBNDMSG0, msg->cmd); > + if (ret < 0) > + goto exit_unlock; > + > + /* > + * For both read and write the initiator (BMC) writes > + * Command Data In[31:0] to SBRMI::InBndMsg_inst[4:1] > + * SBRMI_x3C(MSB):SBRMI_x39(LSB) > + */ > + for (i = 0; i < 4; i++) { > + byte = (msg->data_in >> i * 8) & 0xff; > + ret = i2c_smbus_write_byte_data(data->client, > + SBRMI_INBNDMSG1 + i, byte); > + if (ret < 0) > + goto exit_unlock; > + } > + > + /* > + * Write 0x01 to SBRMI::SoftwareInterrupt to notify firmware to > + * perform the requested read or write command > + */ > + ret = i2c_smbus_write_byte_data(data->client, > + SBRMI_SW_INTERRUPT, TRIGGER_MAILBOX); > + if (ret < 0) > + goto exit_unlock; > + > + /* > + * Firmware will write SBRMI::Status[SwAlertSts]=1 to generate > + * an ALERT (if enabled) to initiator (BMC) to indicate completion > + * of the requested command > + */ > + do { > + sw_status = i2c_smbus_read_byte_data(data->client, > + SBRMI_STATUS); > + if (sw_status < 0) { > + ret = sw_status; > + goto exit_unlock; > + } > + if (sw_status & SW_ALERT_MASK) > + break; > + usleep_range(50, 100); > + } while (retry--); > + > + if (retry < 0) { > + dev_err(&data->client->dev, > + "Firmware fail to indicate command completion\n"); > + ret = -EIO; > + goto exit_unlock; > + } > + > + /* > + * For a read operation, the initiator (BMC) reads the firmware > + * response Command Data Out[31:0] from SBRMI::OutBndMsg_inst[4:1] > + * {SBRMI_x34(MSB):SBRMI_x31(LSB)}. > + */ > + if (msg->read) { > + for (i = 0; i < 4; i++) { > + ret = i2c_smbus_read_byte_data(data->client, > + SBRMI_OUTBNDMSG1 + i); > + if (ret < 0) > + goto exit_unlock; > + msg->data_out |= ret << i * 8; > + } > + } > + > + /* > + * BMC must write 1'b1 to SBRMI::Status[SwAlertSts] to clear the > + * ALERT to initiator > + */ > + ret = i2c_smbus_write_byte_data(data->client, SBRMI_STATUS, > + sw_status | SW_ALERT_MASK); > + > +exit_unlock: > + mutex_unlock(&data->lock); > + return ret; > +} > +EXPORT_SYMBOL(rmi_mailbox_xfer); > diff --git a/drivers/mfd/sbrmi-i2c.c b/drivers/mfd/sbrmi-i2c.c > new file mode 100644 > index 000000000000..96215e986740 > --- /dev/null > +++ b/drivers/mfd/sbrmi-i2c.c > @@ -0,0 +1,106 @@ > +// SPDX-License-Identifier: GPL-2.0-or-later > +/* > + * sbrmi.c - hwmon driver for a SB-RMI mailbox > + * compliant AMD SoC device. > + * > + * Copyright (C) 2020-2024 Advanced Micro Devices, Inc. > + */ > + > +#include <linux/delay.h> > +#include <linux/err.h> > +#include <linux/i2c.h> > +#include <linux/init.h> > +#include <linux/mfd/amd-sb.h> > +#include <linux/module.h> > +#include <linux/mutex.h> > +#include <linux/of.h> > + > +#define SBRMI_CTRL 0x1 > + > +static int sbrmi_enable_alert(struct i2c_client *client) > +{ > + int ctrl; > + > + /* > + * Enable the SB-RMI Software alert status > + * by writing 0 to bit 4 of Control register(0x1) > + */ > + ctrl = i2c_smbus_read_byte_data(client, SBRMI_CTRL); > + if (ctrl < 0) > + return ctrl; > + > + if (ctrl & 0x10) { > + ctrl &= ~0x10; > + return i2c_smbus_write_byte_data(client, > + SBRMI_CTRL, ctrl); > + } > + > + return 0; > +} > + > +static int sbrmi_get_max_pwr_limit(struct sbrmi_data *data) > +{ > + struct sbrmi_mailbox_msg msg = { 0 }; > + int ret; > + > + msg.cmd = SBRMI_READ_PKG_MAX_PWR_LIMIT; > + msg.read = true; > + ret = rmi_mailbox_xfer(data, &msg); > + if (ret < 0) > + return ret; > + data->pwr_limit_max = msg.data_out; > + > + return ret; > +} > + > +static int sbrmi_i2c_probe(struct i2c_client *client) > +{ > + struct device *dev = &client->dev; > + struct sbrmi_data *data; > + int ret; > + > + data = devm_kzalloc(dev, sizeof(struct sbrmi_data), GFP_KERNEL); > + if (!data) > + return -ENOMEM; > + > + data->client = client; > + mutex_init(&data->lock); > + > + /* Enable alert for SB-RMI sequence */ > + ret = sbrmi_enable_alert(client); > + if (ret < 0) > + return ret; > + > + /* Cache maximum power limit */ > + return sbrmi_get_max_pwr_limit(data); > +} > + > +static const struct i2c_device_id sbrmi_id[] = { > + {"sbrmi-mfd"}, > + {} > +}; > +MODULE_DEVICE_TABLE(i2c, sbrmi_id); > + > +static const struct of_device_id __maybe_unused sbrmi_of_match[] = { > + { > + .compatible = "amd,sbrmi", > + }, > + { }, > +}; > +MODULE_DEVICE_TABLE(of, sbrmi_of_match); > + > +static struct i2c_driver sbrmi_driver = { > + .driver = { > + .name = "sbrmi-mfd", > + .of_match_table = of_match_ptr(sbrmi_of_match), > + }, > + .probe = sbrmi_i2c_probe, > + .id_table = sbrmi_id, > +}; > + > +module_i2c_driver(sbrmi_driver); > + > +MODULE_AUTHOR("Akshay Gupta <akshay.gupta@amd.com>"); > +MODULE_AUTHOR("Naveen Krishna Chatradhi <naveenkrishna.chatradhi@amd.com>"); > +MODULE_DESCRIPTION("Hwmon driver for AMD SB-RMI emulated sensor"); > +MODULE_LICENSE("GPL"); > diff --git a/include/linux/mfd/amd-sb.h b/include/linux/mfd/amd-sb.h > new file mode 100644 > index 000000000000..7805f31fb6ea > --- /dev/null > +++ b/include/linux/mfd/amd-sb.h > @@ -0,0 +1,45 @@ > +/* SPDX-License-Identifier: GPL-2.0-or-later */ > +/* > + * Copyright (C) 2021-2024 Advanced Micro Devices, Inc. > + */ > + > +#ifndef _AMD_SB_H_ > +#define _AMD_SB_H_ > + > +#include <linux/mutex.h> > +#include <linux/i2c.h> > +/* > + * SB-RMI supports soft mailbox service request to MP1 (power management > + * firmware) through SBRMI inbound/outbound message registers. > + * SB-RMI message IDs > + */ > +enum sbrmi_msg_id { > + SBRMI_READ_PKG_PWR_CONSUMPTION = 0x1, > + SBRMI_WRITE_PKG_PWR_LIMIT, > + SBRMI_READ_PKG_PWR_LIMIT, > + SBRMI_READ_PKG_MAX_PWR_LIMIT, > +}; > + > +/* Each client has this additional data */ > +struct sbrmi_data { > + struct i2c_client *client; > + struct mutex lock; > + u32 pwr_limit_max; > +}; > + > +struct sbrmi_mailbox_msg { > + u8 cmd; > + bool read; > + u32 data_in; > + u32 data_out; > +}; > + > +#if IS_ENABLED(CONFIG_MFD_SBRMI_I2C) > +int rmi_mailbox_xfer(struct sbrmi_data *data, struct sbrmi_mailbox_msg *msg); > +#else > +int rmi_mailbox_xfer(struct sbrmi_data *data, struct sbrmi_mailbox_msg *msg) > +{ > + return -EOPNOTSUPP; > +} > +#endif > +#endif /*_AMD_SB_H_*/
diff --git a/drivers/hwmon/Kconfig b/drivers/hwmon/Kconfig index e14ae18a973b..56b73e665424 100644 --- a/drivers/hwmon/Kconfig +++ b/drivers/hwmon/Kconfig @@ -1839,6 +1839,7 @@ config SENSORS_SBTSI config SENSORS_SBRMI tristate "Emulated SB-RMI sensor" depends on I2C + depends on MFD_SBRMI_I2C help If you say yes here you get support for emulated RMI sensors on AMD SoCs with APML interface connected to a BMC device. diff --git a/drivers/hwmon/sbrmi.c b/drivers/hwmon/sbrmi.c index d48d8e5460ff..aaeb5050eb0c 100644 --- a/drivers/hwmon/sbrmi.c +++ b/drivers/hwmon/sbrmi.c @@ -3,190 +3,18 @@ * sbrmi.c - hwmon driver for a SB-RMI mailbox * compliant AMD SoC device. * - * Copyright (C) 2020-2021 Advanced Micro Devices, Inc. + * Copyright (C) 2020-2024 Advanced Micro Devices, Inc. */ -#include <linux/delay.h> #include <linux/err.h> #include <linux/hwmon.h> -#include <linux/i2c.h> -#include <linux/init.h> +#include <linux/mfd/amd-sb.h> #include <linux/module.h> -#include <linux/mutex.h> -#include <linux/of.h> +#include <linux/mod_devicetable.h> +#include <linux/platform_device.h> /* Do not allow setting negative power limit */ #define SBRMI_PWR_MIN 0 -/* Mask for Status Register bit[1] */ -#define SW_ALERT_MASK 0x2 - -/* Software Interrupt for triggering */ -#define START_CMD 0x80 -#define TRIGGER_MAILBOX 0x01 - -/* - * SB-RMI supports soft mailbox service request to MP1 (power management - * firmware) through SBRMI inbound/outbound message registers. - * SB-RMI message IDs - */ -enum sbrmi_msg_id { - SBRMI_READ_PKG_PWR_CONSUMPTION = 0x1, - SBRMI_WRITE_PKG_PWR_LIMIT, - SBRMI_READ_PKG_PWR_LIMIT, - SBRMI_READ_PKG_MAX_PWR_LIMIT, -}; - -/* SB-RMI registers */ -enum sbrmi_reg { - SBRMI_CTRL = 0x01, - SBRMI_STATUS, - SBRMI_OUTBNDMSG0 = 0x30, - SBRMI_OUTBNDMSG1, - SBRMI_OUTBNDMSG2, - SBRMI_OUTBNDMSG3, - SBRMI_OUTBNDMSG4, - SBRMI_OUTBNDMSG5, - SBRMI_OUTBNDMSG6, - SBRMI_OUTBNDMSG7, - SBRMI_INBNDMSG0, - SBRMI_INBNDMSG1, - SBRMI_INBNDMSG2, - SBRMI_INBNDMSG3, - SBRMI_INBNDMSG4, - SBRMI_INBNDMSG5, - SBRMI_INBNDMSG6, - SBRMI_INBNDMSG7, - SBRMI_SW_INTERRUPT, -}; - -/* Each client has this additional data */ -struct sbrmi_data { - struct i2c_client *client; - struct mutex lock; - u32 pwr_limit_max; -}; - -struct sbrmi_mailbox_msg { - u8 cmd; - bool read; - u32 data_in; - u32 data_out; -}; - -static int sbrmi_enable_alert(struct i2c_client *client) -{ - int ctrl; - - /* - * Enable the SB-RMI Software alert status - * by writing 0 to bit 4 of Control register(0x1) - */ - ctrl = i2c_smbus_read_byte_data(client, SBRMI_CTRL); - if (ctrl < 0) - return ctrl; - - if (ctrl & 0x10) { - ctrl &= ~0x10; - return i2c_smbus_write_byte_data(client, - SBRMI_CTRL, ctrl); - } - - return 0; -} - -static int rmi_mailbox_xfer(struct sbrmi_data *data, - struct sbrmi_mailbox_msg *msg) -{ - int i, ret, retry = 10; - int sw_status; - u8 byte; - - mutex_lock(&data->lock); - - /* Indicate firmware a command is to be serviced */ - ret = i2c_smbus_write_byte_data(data->client, - SBRMI_INBNDMSG7, START_CMD); - if (ret < 0) - goto exit_unlock; - - /* Write the command to SBRMI::InBndMsg_inst0 */ - ret = i2c_smbus_write_byte_data(data->client, - SBRMI_INBNDMSG0, msg->cmd); - if (ret < 0) - goto exit_unlock; - - /* - * For both read and write the initiator (BMC) writes - * Command Data In[31:0] to SBRMI::InBndMsg_inst[4:1] - * SBRMI_x3C(MSB):SBRMI_x39(LSB) - */ - for (i = 0; i < 4; i++) { - byte = (msg->data_in >> i * 8) & 0xff; - ret = i2c_smbus_write_byte_data(data->client, - SBRMI_INBNDMSG1 + i, byte); - if (ret < 0) - goto exit_unlock; - } - - /* - * Write 0x01 to SBRMI::SoftwareInterrupt to notify firmware to - * perform the requested read or write command - */ - ret = i2c_smbus_write_byte_data(data->client, - SBRMI_SW_INTERRUPT, TRIGGER_MAILBOX); - if (ret < 0) - goto exit_unlock; - - /* - * Firmware will write SBRMI::Status[SwAlertSts]=1 to generate - * an ALERT (if enabled) to initiator (BMC) to indicate completion - * of the requested command - */ - do { - sw_status = i2c_smbus_read_byte_data(data->client, - SBRMI_STATUS); - if (sw_status < 0) { - ret = sw_status; - goto exit_unlock; - } - if (sw_status & SW_ALERT_MASK) - break; - usleep_range(50, 100); - } while (retry--); - - if (retry < 0) { - dev_err(&data->client->dev, - "Firmware fail to indicate command completion\n"); - ret = -EIO; - goto exit_unlock; - } - - /* - * For a read operation, the initiator (BMC) reads the firmware - * response Command Data Out[31:0] from SBRMI::OutBndMsg_inst[4:1] - * {SBRMI_x34(MSB):SBRMI_x31(LSB)}. - */ - if (msg->read) { - for (i = 0; i < 4; i++) { - ret = i2c_smbus_read_byte_data(data->client, - SBRMI_OUTBNDMSG1 + i); - if (ret < 0) - goto exit_unlock; - msg->data_out |= ret << i * 8; - } - } - - /* - * BMC must write 1'b1 to SBRMI::Status[SwAlertSts] to clear the - * ALERT to initiator - */ - ret = i2c_smbus_write_byte_data(data->client, SBRMI_STATUS, - sw_status | SW_ALERT_MASK); - -exit_unlock: - mutex_unlock(&data->lock); - return ret; -} static int sbrmi_read(struct device *dev, enum hwmon_sensor_types type, u32 attr, int channel, long *val) @@ -282,76 +110,35 @@ static const struct hwmon_chip_info sbrmi_chip_info = { .info = sbrmi_info, }; -static int sbrmi_get_max_pwr_limit(struct sbrmi_data *data) +static int sbrmi_probe(struct platform_device *pdev) { - struct sbrmi_mailbox_msg msg = { 0 }; - int ret; - - msg.cmd = SBRMI_READ_PKG_MAX_PWR_LIMIT; - msg.read = true; - ret = rmi_mailbox_xfer(data, &msg); - if (ret < 0) - return ret; - data->pwr_limit_max = msg.data_out; - - return ret; -} - -static int sbrmi_probe(struct i2c_client *client) -{ - struct device *dev = &client->dev; + struct device *dev = &pdev->dev; struct device *hwmon_dev; - struct sbrmi_data *data; - int ret; - - data = devm_kzalloc(dev, sizeof(struct sbrmi_data), GFP_KERNEL); - if (!data) - return -ENOMEM; - - data->client = client; - mutex_init(&data->lock); - - /* Enable alert for SB-RMI sequence */ - ret = sbrmi_enable_alert(client); - if (ret < 0) - return ret; + struct sbrmi_data *data = dev_get_drvdata(pdev->dev.parent); - /* Cache maximum power limit */ - ret = sbrmi_get_max_pwr_limit(data); - if (ret < 0) - return ret; - - hwmon_dev = devm_hwmon_device_register_with_info(dev, client->name, data, + hwmon_dev = devm_hwmon_device_register_with_info(dev, "sbrmi", data, &sbrmi_chip_info, NULL); - return PTR_ERR_OR_ZERO(hwmon_dev); } -static const struct i2c_device_id sbrmi_id[] = { - {"sbrmi"}, - {} -}; -MODULE_DEVICE_TABLE(i2c, sbrmi_id); - -static const struct of_device_id __maybe_unused sbrmi_of_match[] = { +static const struct platform_device_id sbrmi_id[] = { { - .compatible = "amd,sbrmi", + .name = "sbrmi-hwmon", }, { }, }; -MODULE_DEVICE_TABLE(of, sbrmi_of_match); +MODULE_DEVICE_TABLE(platform, sbrmi_id); -static struct i2c_driver sbrmi_driver = { +static struct platform_driver amd_sbrmi_hwmon_driver = { + .probe = sbrmi_probe, .driver = { - .name = "sbrmi", - .of_match_table = of_match_ptr(sbrmi_of_match), + .name = "amd-sbrmi", }, - .probe = sbrmi_probe, .id_table = sbrmi_id, }; - -module_i2c_driver(sbrmi_driver); +module_platform_driver(amd_sbrmi_hwmon_driver); MODULE_AUTHOR("Akshay Gupta <akshay.gupta@amd.com>"); +MODULE_AUTHOR("Naveen Krishna Chatradhi <naveenkrishna.chatradhi@amd.com>"); MODULE_DESCRIPTION("Hwmon driver for AMD SB-RMI emulated sensor"); MODULE_LICENSE("GPL"); diff --git a/drivers/mfd/Kconfig b/drivers/mfd/Kconfig index 266b4f54af60..0411cb29b6df 100644 --- a/drivers/mfd/Kconfig +++ b/drivers/mfd/Kconfig @@ -1442,6 +1442,15 @@ config MFD_STMPE Touchscreen: stmpe-ts ADC: stmpe-adc +config MFD_SBRMI_I2C + tristate "APML SBRMI support" + depends on I2C + select MFD_CORE + help + APML RMI core support for AMD out of band management + This driver can also be built as a module. If so, the module will + be called sbrmi. + menu "STMicroelectronics STMPE Interface Drivers" depends on MFD_STMPE @@ -2333,6 +2342,5 @@ config MFD_RSMU_SPI This driver provides common support for accessing the device. Additional drivers must be enabled in order to use the functionality of the device. - endmenu endif diff --git a/drivers/mfd/Makefile b/drivers/mfd/Makefile index c66f07edcd0e..6bc807c2e5ed 100644 --- a/drivers/mfd/Makefile +++ b/drivers/mfd/Makefile @@ -284,3 +284,5 @@ rsmu-i2c-objs := rsmu_core.o rsmu_i2c.o rsmu-spi-objs := rsmu_core.o rsmu_spi.o obj-$(CONFIG_MFD_RSMU_I2C) += rsmu-i2c.o obj-$(CONFIG_MFD_RSMU_SPI) += rsmu-spi.o +apml_sbrmi-objs := sbrmi-i2c.o sbrmi-core.o +obj-$(CONFIG_MFD_SBRMI_I2C) += apml_sbrmi.o diff --git a/drivers/mfd/sbrmi-core.c b/drivers/mfd/sbrmi-core.c new file mode 100644 index 000000000000..d872b5107b36 --- /dev/null +++ b/drivers/mfd/sbrmi-core.c @@ -0,0 +1,137 @@ +// SPDX-License-Identifier: GPL-2.0-or-later +/* + * sbrmi-common.c - file defining SB-RMI protocols + * compliant AMD SoC device. + * + * Copyright (C) 2021-2024 Advanced Micro Devices, Inc. + */ +#include <linux/delay.h> +#include <linux/err.h> +#include <linux/i2c.h> +#include <linux/mfd/amd-sb.h> +#include <linux/mutex.h> + +/* Mask for Status Register bit[1] */ +#define SW_ALERT_MASK 0x2 + +/* Software Interrupt for triggering */ +#define START_CMD 0x80 +#define TRIGGER_MAILBOX 0x01 + +/* SB-RMI registers */ +enum sbrmi_reg { + SBRMI_CTRL = 0x01, + SBRMI_STATUS, + SBRMI_OUTBNDMSG0 = 0x30, + SBRMI_OUTBNDMSG1, + SBRMI_OUTBNDMSG2, + SBRMI_OUTBNDMSG3, + SBRMI_OUTBNDMSG4, + SBRMI_OUTBNDMSG5, + SBRMI_OUTBNDMSG6, + SBRMI_OUTBNDMSG7, + SBRMI_INBNDMSG0, + SBRMI_INBNDMSG1, + SBRMI_INBNDMSG2, + SBRMI_INBNDMSG3, + SBRMI_INBNDMSG4, + SBRMI_INBNDMSG5, + SBRMI_INBNDMSG6, + SBRMI_INBNDMSG7, + SBRMI_SW_INTERRUPT, +}; + +int rmi_mailbox_xfer(struct sbrmi_data *data, + struct sbrmi_mailbox_msg *msg) +{ + int i, ret, retry = 10; + int sw_status; + u8 byte; + + mutex_lock(&data->lock); + + /* Indicate firmware a command is to be serviced */ + ret = i2c_smbus_write_byte_data(data->client, + SBRMI_INBNDMSG7, START_CMD); + if (ret < 0) + goto exit_unlock; + + /* Write the command to SBRMI::InBndMsg_inst0 */ + ret = i2c_smbus_write_byte_data(data->client, + SBRMI_INBNDMSG0, msg->cmd); + if (ret < 0) + goto exit_unlock; + + /* + * For both read and write the initiator (BMC) writes + * Command Data In[31:0] to SBRMI::InBndMsg_inst[4:1] + * SBRMI_x3C(MSB):SBRMI_x39(LSB) + */ + for (i = 0; i < 4; i++) { + byte = (msg->data_in >> i * 8) & 0xff; + ret = i2c_smbus_write_byte_data(data->client, + SBRMI_INBNDMSG1 + i, byte); + if (ret < 0) + goto exit_unlock; + } + + /* + * Write 0x01 to SBRMI::SoftwareInterrupt to notify firmware to + * perform the requested read or write command + */ + ret = i2c_smbus_write_byte_data(data->client, + SBRMI_SW_INTERRUPT, TRIGGER_MAILBOX); + if (ret < 0) + goto exit_unlock; + + /* + * Firmware will write SBRMI::Status[SwAlertSts]=1 to generate + * an ALERT (if enabled) to initiator (BMC) to indicate completion + * of the requested command + */ + do { + sw_status = i2c_smbus_read_byte_data(data->client, + SBRMI_STATUS); + if (sw_status < 0) { + ret = sw_status; + goto exit_unlock; + } + if (sw_status & SW_ALERT_MASK) + break; + usleep_range(50, 100); + } while (retry--); + + if (retry < 0) { + dev_err(&data->client->dev, + "Firmware fail to indicate command completion\n"); + ret = -EIO; + goto exit_unlock; + } + + /* + * For a read operation, the initiator (BMC) reads the firmware + * response Command Data Out[31:0] from SBRMI::OutBndMsg_inst[4:1] + * {SBRMI_x34(MSB):SBRMI_x31(LSB)}. + */ + if (msg->read) { + for (i = 0; i < 4; i++) { + ret = i2c_smbus_read_byte_data(data->client, + SBRMI_OUTBNDMSG1 + i); + if (ret < 0) + goto exit_unlock; + msg->data_out |= ret << i * 8; + } + } + + /* + * BMC must write 1'b1 to SBRMI::Status[SwAlertSts] to clear the + * ALERT to initiator + */ + ret = i2c_smbus_write_byte_data(data->client, SBRMI_STATUS, + sw_status | SW_ALERT_MASK); + +exit_unlock: + mutex_unlock(&data->lock); + return ret; +} +EXPORT_SYMBOL(rmi_mailbox_xfer); diff --git a/drivers/mfd/sbrmi-i2c.c b/drivers/mfd/sbrmi-i2c.c new file mode 100644 index 000000000000..96215e986740 --- /dev/null +++ b/drivers/mfd/sbrmi-i2c.c @@ -0,0 +1,106 @@ +// SPDX-License-Identifier: GPL-2.0-or-later +/* + * sbrmi.c - hwmon driver for a SB-RMI mailbox + * compliant AMD SoC device. + * + * Copyright (C) 2020-2024 Advanced Micro Devices, Inc. + */ + +#include <linux/delay.h> +#include <linux/err.h> +#include <linux/i2c.h> +#include <linux/init.h> +#include <linux/mfd/amd-sb.h> +#include <linux/module.h> +#include <linux/mutex.h> +#include <linux/of.h> + +#define SBRMI_CTRL 0x1 + +static int sbrmi_enable_alert(struct i2c_client *client) +{ + int ctrl; + + /* + * Enable the SB-RMI Software alert status + * by writing 0 to bit 4 of Control register(0x1) + */ + ctrl = i2c_smbus_read_byte_data(client, SBRMI_CTRL); + if (ctrl < 0) + return ctrl; + + if (ctrl & 0x10) { + ctrl &= ~0x10; + return i2c_smbus_write_byte_data(client, + SBRMI_CTRL, ctrl); + } + + return 0; +} + +static int sbrmi_get_max_pwr_limit(struct sbrmi_data *data) +{ + struct sbrmi_mailbox_msg msg = { 0 }; + int ret; + + msg.cmd = SBRMI_READ_PKG_MAX_PWR_LIMIT; + msg.read = true; + ret = rmi_mailbox_xfer(data, &msg); + if (ret < 0) + return ret; + data->pwr_limit_max = msg.data_out; + + return ret; +} + +static int sbrmi_i2c_probe(struct i2c_client *client) +{ + struct device *dev = &client->dev; + struct sbrmi_data *data; + int ret; + + data = devm_kzalloc(dev, sizeof(struct sbrmi_data), GFP_KERNEL); + if (!data) + return -ENOMEM; + + data->client = client; + mutex_init(&data->lock); + + /* Enable alert for SB-RMI sequence */ + ret = sbrmi_enable_alert(client); + if (ret < 0) + return ret; + + /* Cache maximum power limit */ + return sbrmi_get_max_pwr_limit(data); +} + +static const struct i2c_device_id sbrmi_id[] = { + {"sbrmi-mfd"}, + {} +}; +MODULE_DEVICE_TABLE(i2c, sbrmi_id); + +static const struct of_device_id __maybe_unused sbrmi_of_match[] = { + { + .compatible = "amd,sbrmi", + }, + { }, +}; +MODULE_DEVICE_TABLE(of, sbrmi_of_match); + +static struct i2c_driver sbrmi_driver = { + .driver = { + .name = "sbrmi-mfd", + .of_match_table = of_match_ptr(sbrmi_of_match), + }, + .probe = sbrmi_i2c_probe, + .id_table = sbrmi_id, +}; + +module_i2c_driver(sbrmi_driver); + +MODULE_AUTHOR("Akshay Gupta <akshay.gupta@amd.com>"); +MODULE_AUTHOR("Naveen Krishna Chatradhi <naveenkrishna.chatradhi@amd.com>"); +MODULE_DESCRIPTION("Hwmon driver for AMD SB-RMI emulated sensor"); +MODULE_LICENSE("GPL"); diff --git a/include/linux/mfd/amd-sb.h b/include/linux/mfd/amd-sb.h new file mode 100644 index 000000000000..7805f31fb6ea --- /dev/null +++ b/include/linux/mfd/amd-sb.h @@ -0,0 +1,45 @@ +/* SPDX-License-Identifier: GPL-2.0-or-later */ +/* + * Copyright (C) 2021-2024 Advanced Micro Devices, Inc. + */ + +#ifndef _AMD_SB_H_ +#define _AMD_SB_H_ + +#include <linux/mutex.h> +#include <linux/i2c.h> +/* + * SB-RMI supports soft mailbox service request to MP1 (power management + * firmware) through SBRMI inbound/outbound message registers. + * SB-RMI message IDs + */ +enum sbrmi_msg_id { + SBRMI_READ_PKG_PWR_CONSUMPTION = 0x1, + SBRMI_WRITE_PKG_PWR_LIMIT, + SBRMI_READ_PKG_PWR_LIMIT, + SBRMI_READ_PKG_MAX_PWR_LIMIT, +}; + +/* Each client has this additional data */ +struct sbrmi_data { + struct i2c_client *client; + struct mutex lock; + u32 pwr_limit_max; +}; + +struct sbrmi_mailbox_msg { + u8 cmd; + bool read; + u32 data_in; + u32 data_out; +}; + +#if IS_ENABLED(CONFIG_MFD_SBRMI_I2C) +int rmi_mailbox_xfer(struct sbrmi_data *data, struct sbrmi_mailbox_msg *msg); +#else +int rmi_mailbox_xfer(struct sbrmi_data *data, struct sbrmi_mailbox_msg *msg) +{ + return -EOPNOTSUPP; +} +#endif +#endif /*_AMD_SB_H_*/