Skip to contentSkip to conversation

i2c: New driver for Nuvoton SMBus adapters

PATCH In review Adam Honse 3 participants 3 messages Sep 7, 2022 – Sep 14, 2022 I2C subsystem host drivers

lore
Share & tools
lore

Adam Honse

author
#0 lore raw

PATCH v2 1/1 i2c: New driver for Nuvoton SMBus adapters

This patch introduces a new driver for the SMBus adapter that is built in to most Nuvoton Super-IO chips. This SMBus adapter is used for RGB lighting control on some ASUS motherboards with Intel chipsets.

The interface's register description is available in the supported devices' datasheets. Operation of this interface has been verified with OpenRGB on an ASUS PRIME Z270-A motherboard.

---
 drivers/i2c/busses/Kconfig       |   9 +
 drivers/i2c/busses/Makefile      |   1 +
 drivers/i2c/busses/i2c-nct6793.c | 550 +++++++++++++++++++++++++++++++
 3 files changed, 560 insertions(+)
 create mode 100644 drivers/i2c/busses/i2c-nct6793.c
drivers/i2c/busses/Kconfig +9 -0
index a1bae59208e3..ef679c5141e5 100644
@@ -227,6 +227,15 @@ config I2C_CHT_WC
 	  combined with a FUSB302 Type-C port-controller as such it is advised
 	  to also select CONFIG_TYPEC_FUSB302=m.
 
+config I2C_NCT6793
+	tristate "Nuvoton NCT6793D and compatible SMBus controller"
+	help
+		If you say yes to this option, support will be included for the
+		Nuvoton NCT6793D and compatible SMBus controllers.
+
+		This driver can also be built as a module.  If so, the module
+		will be called i2c-nct6793.
+
 config I2C_NFORCE2
 	tristate "Nvidia nForce2, nForce3 and nForce4"
 	depends on PCI
drivers/i2c/busses/Makefile +1 -0
index 479f60e4ee3d..ab3506e40ecf 100644
@@ -20,6 +20,7 @@ obj-$(CONFIG_I2C_CHT_WC)	+= i2c-cht-wc.o
 obj-$(CONFIG_I2C_I801)		+= i2c-i801.o
 obj-$(CONFIG_I2C_ISCH)		+= i2c-isch.o
 obj-$(CONFIG_I2C_ISMT)		+= i2c-ismt.o
+obj-$(CONFIG_I2C_NCT6793)	+= i2c-nct6793.o
 obj-$(CONFIG_I2C_NFORCE2)	+= i2c-nforce2.o
 obj-$(CONFIG_I2C_NFORCE2_S4985)	+= i2c-nforce2-s4985.o
 obj-$(CONFIG_I2C_NVIDIA_GPU)	+= i2c-nvidia-gpu.o
drivers/i2c/busses/i2c-nct6793.c new file +550 -0

550 lines not on this page · raw message

Signature · 1 line
2.35.1
#1 lore raw

Hi Adam,

Quoted 7 lines · Adam Honse

This patch introduces a new driver for the SMBus adapter that is built in to most Nuvoton Super-IO chips. This SMBus adapter is used for RGB lighting control on some ASUS motherboards with Intel chipsets.

The interface's register description is available in the supported devices' datasheets. Operation of this interface has been verified with OpenRGB on an ASUS PRIME Z270-A motherboard.

Care to point me to one such datasheet?

The following errors are reported by ./scripts/checkpatch.pl (which I invite you to run before posting any patch):

RROR: "foo * bar" should be "foo *bar"
#452: FILE: drivers/i2c/busses/i2c-nct6793.c:295:
+static struct i2c_adapter * nct6793_add_adapter(unsigned short smba, const char *name)

ERROR: trailing whitespace
#526: FILE: drivers/i2c/busses/i2c-nct6793.c:369:
+^I^I$

ERROR: space required before the open parenthesis '(' #527: FILE: drivers/i2c/busses/i2c-nct6793.c:370:
+ if(IS_ERR(sio_data->adapter))

Please fix before resubmitting.

Also, would you consider declaring yourself the maintainer of this new driver? If so, please add a new entry in MAINTAINERS and add yourself there. You can use the "I2C/SMBUS ISMT DRIVER" entry as an example.

If not, no worry, I'll add the driver to my own list.

I see that there already seem to be a driver for the SMBus interface of Novoton Super-I/O chipsets:

drivers/hwmon/nct6775-i2c.c

However that driver seems to be fairly limited in capabilities (on purpose). I'm adding the author of this driver and the maintainer of the hwmon subsystem to Cc. How do the two drivers relate to each other? Are they for the same, or different interfaces? If different, we need to come up with names to designate them unambiguously. If the same, then I'm afraid both drivers will step on each other's toes?

Anyway, here's my review of your driver, inline below.

Quoted 97 lines
---
 drivers/i2c/busses/Kconfig       |   9 +
 drivers/i2c/busses/Makefile      |   1 +
 drivers/i2c/busses/i2c-nct6793.c | 550 +++++++++++++++++++++++++++++++
 3 files changed, 560 insertions(+)
 create mode 100644 drivers/i2c/busses/i2c-nct6793.c
drivers/i2c/busses/Kconfig +9 -0
index a1bae59208e3..ef679c5141e5 100644
@@ -227,6 +227,15 @@ config I2C_CHT_WC
 	  combined with a FUSB302 Type-C port-controller as such it is advised
 	  to also select CONFIG_TYPEC_FUSB302=m.
 
+config I2C_NCT6793
+	tristate "Nuvoton NCT6793D and compatible SMBus controller"
+	help
+		If you say yes to this option, support will be included for the
+		Nuvoton NCT6793D and compatible SMBus controllers.
+
+		This driver can also be built as a module.  If so, the module
+		will be called i2c-nct6793.
+
 config I2C_NFORCE2
 	tristate "Nvidia nForce2, nForce3 and nForce4"
 	depends on PCI
drivers/i2c/busses/Makefile +1 -0
index 479f60e4ee3d..ab3506e40ecf 100644
@@ -20,6 +20,7 @@ obj-$(CONFIG_I2C_CHT_WC)	+= i2c-cht-wc.o
 obj-$(CONFIG_I2C_I801)		+= i2c-i801.o
 obj-$(CONFIG_I2C_ISCH)		+= i2c-isch.o
 obj-$(CONFIG_I2C_ISMT)		+= i2c-ismt.o
+obj-$(CONFIG_I2C_NCT6793)	+= i2c-nct6793.o
 obj-$(CONFIG_I2C_NFORCE2)	+= i2c-nforce2.o
 obj-$(CONFIG_I2C_NFORCE2_S4985)	+= i2c-nforce2-s4985.o
 obj-$(CONFIG_I2C_NVIDIA_GPU)	+= i2c-nvidia-gpu.o
drivers/i2c/busses/i2c-nct6793.c new file +51 -0
new file mode 100644
index 000000000000..dfb2e7748cf9
@@ -0,0 +1,550 @@
+// SPDX-License-Identifier: GPL-2.0-or-later
+/*
+ * i2c-nct6793 - Driver for the SMBus master functionality of
+ *	       Nuvoton NCT679x Super-I/O chips
+ *
+ * Copyright (C) 2022  Adam Honse <[email protected]>
+ *
+ * Derived from nct6775 hwmon driver
+ * Copyright (C) 2012  Guenter Roeck <[email protected]>
+ *
+ * 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/module.h>
+#include <linux/init.h>
+#include <linux/slab.h>
+#include <linux/platform_device.h>
+#include <linux/err.h>
+#include <linux/delay.h>
+#include <linux/ioport.h>
+#include <linux/i2c.h>
+#include <linux/acpi.h>
+#include <linux/io.h>
+
+#define DRVNAME "i2c-nct6793"
+
+/* Nuvoton SMBus address offsets */
+#define SMBHSTDAT       (nuvoton_nct6793_smba + 0x0)
+#define SMBBLKSZ        (nuvoton_nct6793_smba + 0x1)
+#define SMBHSTCMD       (nuvoton_nct6793_smba + 0x2)
+#define SMBHSTIDX       (nuvoton_nct6793_smba + 0x3)
+#define SMBHSTCTL       (nuvoton_nct6793_smba + 0x4)
+#define SMBHSTADD       (nuvoton_nct6793_smba + 0x5)
+#define SMBHSTERR       (nuvoton_nct6793_smba + 0x9)
+#define SMBHSTSTS       (nuvoton_nct6793_smba + 0xE)
+
+/* Command register */
+#define NCT6793_READ_BYTE		0
+#define NCT6793_READ_WORD		1
+#define NCT6793_READ_BLOCK		2
+#define NCT6793D_BLOCK_PROC_CALL	3
+#define NCT6793_PROC_CALL		4

drivers/i2c/busses/i2c-nct6793.c line 61

Quoted 10 lines
drivers/i2c/busses/i2c-nct6793.c new file +10 -0
+#define NCT6793_WRITE_BYTE		8
+#define NCT6793_WRITE_WORD		9
+#define NCT6793_WRITE_BLOCK		10
+
+/* Control register */
+#define NCT6793_MANUAL_START		128
+#define NCT6793_SOFT_RESET		64
+
+/* Error register */
+#define NCT6793_NO_ACK			32

The 3 values above are clearly bits, so why don't use BIT() as below?

Quoted 17 lines
drivers/i2c/busses/i2c-nct6793.c new file +17 -0
+
+/* Status register */
+#define NCT6793_FIFO_EMPTY		BIT(0)
+#define NCT6793_FIFO_FULL		BIT(1)
+#define NCT6793_MANUAL_ACTIVE		BIT(2)
+
+#define NCT6793_LD_SMBUS		0x0B
+
+/* Other settings */
+#define MAX_RETRIES			400
+
+enum kinds { nct6791, nct6792, nct6793, nct6795, nct6796, nct6798 };
+
+struct nct6793_sio_data {
+	int sioreg;
+	enum kinds kind;
+	struct i2c_adapter *adapter;

drivers/i2c/busses/i2c-nct6793.c line 88

Quoted 10 lines
drivers/i2c/busses/i2c-nct6793.c new file +10 -0
+};
+
+static const char * const nct6793_sio_names[] = {
+	"NCT6791D",
+	"NCT6792D",
+	"NCT6793D",
+	"NCT6795D",
+	"NCT6796D",
+	"NCT6798D",
+};

Maybe it would make sense to list these devices in the Kconfig entry?

Quoted 68 lines
drivers/i2c/busses/i2c-nct6793.c new file +68 -0
+
+#define SIO_REG_LDSEL			0x07	/* Logical device select */
+#define SIO_REG_DEVID			0x20	/* Device ID (2 bytes) */
+#define SIO_REG_SMBA			0x62	/* SMBus base address register */
+
+#define SIO_NCT6791_ID			0xc800
+#define SIO_NCT6792_ID			0xc910
+#define SIO_NCT6793_ID			0xd120
+#define SIO_NCT6795_ID			0xd350
+#define SIO_NCT6796_ID			0xd420
+#define SIO_NCT6798_ID			0xd428
+#define SIO_ID_MASK			0xFFF0
+
+static inline int
+superio_inb(int ioreg, int reg)
+{
+	outb(reg, ioreg);
+	return inb(ioreg + 1);
+}
+
+static inline void
+superio_select(int ioreg, int ld)
+{
+	outb(SIO_REG_LDSEL, ioreg);
+	outb(ld, ioreg + 1);
+}
+
+static inline int
+superio_enter(int ioreg)
+{
+	/*
+	 * Try to reserve <ioreg> and <ioreg + 1> for exclusive access.
+	 */
+	if (!request_muxed_region(ioreg, 2, DRVNAME))
+		return -EBUSY;
+
+	outb(0x87, ioreg);
+	outb(0x87, ioreg);
+
+	return 0;
+}
+
+static inline void
+superio_exit(int ioreg)
+{
+	outb(0xaa, ioreg);
+	outb(0x02, ioreg);
+	outb(0x02, ioreg + 1);
+	release_region(ioreg, 2);
+}
+
+/*
+ * ISA constants
+ */
+
+#define IOREGION_ALIGNMENT	(~7)
+#define IOREGION_LENGTH		2
+
+struct i2c_nct6793_adapdata {
+	unsigned short smba;
+};
+
+/* Return negative errno on error. */
+static s32 nct6793_access(struct i2c_adapter *adap, u16 addr,
+		 unsigned short flags, char read_write,
+		 u8 command, int size, union i2c_smbus_data *data)
+{
+	struct i2c_nct6793_adapdata *adapdata = i2c_get_adapdata(adap);

drivers/i2c/busses/i2c-nct6793.c line 166

Quoted 10 lines
drivers/i2c/busses/i2c-nct6793.c new file +10 -0
+	unsigned short nuvoton_nct6793_smba = adapdata->smba;
+	int i, len, cnt;
+	int timeout = 0;
+
+	outb_p(NCT6793_SOFT_RESET, SMBHSTCTL);
+
+	switch (size) {
+	case I2C_SMBUS_QUICK:
+		outb_p((addr << 1) | read_write,
+				SMBHSTADD);

Do you have any reason to use slow I/O functions (*b_p) here? If not, please switch to the non-paused functions.

Is the SMBus Quick transaction really supported? There is no SMBHSTCMD value for it, which is kind of suspicious.

Quoted 4 lines
drivers/i2c/busses/i2c-nct6793.c new file +4 -0
+		break;
+	case I2C_SMBUS_BYTE_DATA:
+		fallthrough;
+	case I2C_SMBUS_BYTE:

drivers/i2c/busses/i2c-nct6793.c line 180

Quoted 10 lines
drivers/i2c/busses/i2c-nct6793.c new file +10 -0
+		outb_p((addr << 1) | read_write,
+				SMBHSTADD);
+		outb_p(command, SMBHSTIDX);
+		if (read_write == I2C_SMBUS_WRITE) {
+			outb_p(data->byte, SMBHSTDAT);
+			outb_p(NCT6793_WRITE_BYTE, SMBHSTCMD);
+		} else {
+			outb_p(NCT6793_READ_BYTE, SMBHSTCMD);
+		}
+		break;

The SMBus Receive Byte and Read Byte transactions are different on the wire, so you can't possibly implement both with exactly the same code.

From the list of command register values, I suspect that I2C_SMBUS_BYTE is not actually supported.

Quoted 87 lines
drivers/i2c/busses/i2c-nct6793.c new file +87 -0
+	case I2C_SMBUS_WORD_DATA:
+		outb_p((addr << 1) | read_write,
+				SMBHSTADD);
+		outb_p(command, SMBHSTIDX);
+		if (read_write == I2C_SMBUS_WRITE) {
+			outb_p(data->word & 0xff, SMBHSTDAT);
+			outb_p((data->word & 0xff00) >> 8, SMBHSTDAT);
+			outb_p(NCT6793_WRITE_WORD, SMBHSTCMD);
+		} else {
+			outb_p(NCT6793_READ_WORD, SMBHSTCMD);
+		}
+		break;
+	case I2C_SMBUS_BLOCK_DATA:
+		outb_p((addr << 1) | read_write,
+				SMBHSTADD);
+		outb_p(command, SMBHSTIDX);
+		if (read_write == I2C_SMBUS_WRITE) {
+			len = data->block[0];
+			if (len == 0 || len > I2C_SMBUS_BLOCK_MAX)
+				return -EINVAL;
+			outb_p(len, SMBBLKSZ);
+
+			cnt = 1;
+			if (len >= 4) {
+				for (i = cnt; i <= 4; i++)
+					outb_p(data->block[i], SMBHSTDAT);
+
+				len -= 4;
+				cnt += 4;
+			} else {
+				for (i = cnt; i <= len; i++)
+					outb_p(data->block[i], SMBHSTDAT);
+
+				len = 0;
+			}
+
+			outb_p(NCT6793_WRITE_BLOCK, SMBHSTCMD);
+		} else {
+			return -EOPNOTSUPP;
+		}
+		break;
+	default:
+		dev_warn(&adap->dev, "Unsupported transaction %d\n", size);
+		return -EOPNOTSUPP;
+	}
+
+	outb_p(NCT6793_MANUAL_START, SMBHSTCTL);
+
+	while (size == I2C_SMBUS_BLOCK_DATA && len > 0) {
+		if (read_write == I2C_SMBUS_WRITE) {
+			timeout = 0;
+			while ((inb_p(SMBHSTSTS) & NCT6793_FIFO_EMPTY) == 0) {
+				if (timeout > MAX_RETRIES)
+					return -ETIMEDOUT;
+
+				usleep_range(250, 500);
+				timeout++;
+			}
+
+			/* Load more bytes into FIFO */
+			if (len >= 4) {
+				for (i = cnt; i <= (cnt + 4); i++)
+					outb_p(data->block[i], SMBHSTDAT);
+
+				len -= 4;
+				cnt += 4;
+			} else {
+				for (i = cnt; i <= (cnt + len); i++)
+					outb_p(data->block[i], SMBHSTDAT);
+
+				len = 0;
+			}
+		}
+	}
+
+	/* Wait for manual mode to complete */
+	timeout = 0;
+	while ((inb_p(SMBHSTSTS) & NCT6793_MANUAL_ACTIVE) != 0) {
+		if (timeout > MAX_RETRIES)
+			return -ETIMEDOUT;
+
+		usleep_range(250, 500);
+		timeout++;
+	}
+
+	if ((inb_p(SMBHSTERR) & NCT6793_NO_ACK) != 0)
+		return -ENXIO;

drivers/i2c/busses/i2c-nct6793.c line 277

Quoted 10 lines
drivers/i2c/busses/i2c-nct6793.c new file +10 -0
+
+	if (read_write == I2C_SMBUS_WRITE || size == I2C_SMBUS_QUICK)
+		return 0;
+
+	switch (size) {
+	case I2C_SMBUS_BYTE_DATA:
+		data->byte = inb_p(SMBHSTDAT);
+		break;
+	case I2C_SMBUS_WORD_DATA:
+		data->word = inb_p(SMBHSTDAT) | (inb_p(SMBHSTDAT) << 8);

I am no C language nor compiler expert, but is there any guarantee that the left-hand side inb will be evaluated before the right-hand side inb with the construct above? I think it would be safer to separate into 2 operations, to guarantee which byte will be read first.

drivers/i2c/busses/i2c-nct6793.c line 287

Quoted 10 lines
drivers/i2c/busses/i2c-nct6793.c new file +10 -0
+		break;
+	}
+	return 0;
+}
+
+static u32 nct6793_func(struct i2c_adapter *adapter)
+{
+	return I2C_FUNC_SMBUS_QUICK | I2C_FUNC_SMBUS_BYTE |
+	    I2C_FUNC_SMBUS_BYTE_DATA | I2C_FUNC_SMBUS_WORD_DATA |
+	    I2C_FUNC_SMBUS_BLOCK_DATA;

You should definitely use I2C_FUNC_SMBUS_WRITE_BLOCK_DATA instead of I2C_FUNC_SMBUS_BLOCK_DATA, as function nct6793_access() explicitly rejects SMBus Read Block transactions.

You may have to remove I2C_FUNC_SMBUS_QUICK and I2C_FUNC_SMBUS_BYTE from the list, given the concerns I expressed above.

Quoted 9 lines
drivers/i2c/busses/i2c-nct6793.c new file +9 -0
+}
+
+static const struct i2c_algorithm smbus_algorithm = {
+	.smbus_xfer	= nct6793_access,
+	.functionality	= nct6793_func,
+};
+
+static struct i2c_adapter * nct6793_add_adapter(unsigned short smba, const char *name)
+{

drivers/i2c/busses/i2c-nct6793.c line 306

Quoted 10 lines
drivers/i2c/busses/i2c-nct6793.c new file +10 -0
+	struct i2c_adapter *adap;
+	struct i2c_nct6793_adapdata *adapdata;
+	int retval;
+
+	adap = kzalloc(sizeof(*adap), GFP_KERNEL);
+	if (adap == NULL)
+		return ERR_PTR(-ENOMEM);
+
+	adap->owner = THIS_MODULE;
+	adap->class = 0;

adap is already zeroed by kzalloc, so you can omit this statement.

drivers/i2c/busses/i2c-nct6793.c line 313

Quoted 7 lines
drivers/i2c/busses/i2c-nct6793.c new file +7 -0
+	adap->algo = &smbus_algorithm;
+
+	adapdata = kzalloc(sizeof(*adapdata), GFP_KERNEL);
+	if (adapdata == NULL) {
+		kfree(adap);
+		return ERR_PTR(-ENOMEM);
+	}

Consider using devm_kzalloc() so you don't have to deal with the freeing.

drivers/i2c/busses/i2c-nct6793.c line 318

Quoted 5 lines
drivers/i2c/busses/i2c-nct6793.c new file +5 -0
+
+	adapdata->smba = smba;
+
+	snprintf(adap->name, sizeof(adap->name),
+		"SMBus NCT679x adapter %s at %04x", name, smba);

The resulting string will have some redundancy. What about:

"SMBus %s adapter at %04x"

Quoted 19 lines
drivers/i2c/busses/i2c-nct6793.c new file +19 -0
+
+	i2c_set_adapdata(adap, adapdata);
+
+	retval = i2c_add_adapter(adap);
+	if (retval) {
+		kfree(adapdata);
+		kfree(adap);
+		return ERR_PTR(retval);
+	}
+
+	return adap;
+}
+
+static void nct6793_remove_adapter(struct i2c_adapter *adap)
+{
+	struct i2c_nct6793_adapdata *adapdata = i2c_get_adapdata(adap);
+
+	i2c_del_adapter(adap);
+	kfree(adapdata);

drivers/i2c/busses/i2c-nct6793.c line 347

Quoted 10 lines
drivers/i2c/busses/i2c-nct6793.c new file +10 -0
+	kfree(adap);
+}
+
+/*
+ * When Super-I/O functions move to a separate file, the Super-I/O
+ * bus will manage the lifetime of the device and this module will only keep
+ * track of the nct6793 driver. But since we use platform_device_alloc(), we
+ * must keep track of the device.
+ */
+static struct platform_device *pdev[2];

Please come up with a different name, so that local variable or function parameter "pdev" does not shadow this array.

Quoted 12 lines
drivers/i2c/busses/i2c-nct6793.c new file +12 -0
+
+static int nct6793_probe(struct platform_device *pdev)
+{
+	struct i2c_adapter *adap;
+	struct device *dev = &pdev->dev;
+	struct nct6793_sio_data *sio_data = dev_get_platdata(dev);
+	struct resource *res;
+
+	res = platform_get_resource(pdev, IORESOURCE_IO, 0);
+	if (!devm_request_region(&pdev->dev, res->start, IOREGION_LENGTH,
+				 DRVNAME))
+		return -EBUSY;

drivers/i2c/busses/i2c-nct6793.c line 369

Quoted 10 lines
drivers/i2c/busses/i2c-nct6793.c new file +10 -0
+
+	switch (sio_data->kind) {
+	case nct6791:
+	case nct6792:
+	case nct6793:
+	case nct6795:
+	case nct6796:
+	case nct6798:
+		adap = nct6793_add_adapter(res->start, nct6793_sio_names[sio_data->kind]);
+		

No blank line between assignment and test.

drivers/i2c/busses/i2c-nct6793.c line 371

Quoted 2 lines
drivers/i2c/busses/i2c-nct6793.c new file +2 -0
+		if(IS_ERR(sio_data->adapter))
+			return -ENODEV;

Please return the actual error code.

Quoted 17 lines
drivers/i2c/busses/i2c-nct6793.c new file +17 -0
+
+		sio_data->adapter = adap;
+		break;
+	default:
+		return -ENODEV;
+	}
+
+	return 0;
+}
+
+static struct platform_driver i2c_nct6793_driver = {
+	.driver = {
+		.name	= DRVNAME,
+	},
+	.probe		= nct6793_probe,
+};
+

drivers/i2c/busses/i2c-nct6793.c line 398

Quoted 10 lines
drivers/i2c/busses/i2c-nct6793.c new file +10 -0
+static void __exit i2c_nct6793_exit(void)
+{
+	int i;
+
+	for (i = 0; i < ARRAY_SIZE(pdev); i++) {
+		if (pdev[i]) {
+			struct device *dev = &pdev[i]->dev;
+			struct nct6793_sio_data *sio_data = dev_get_platdata(dev);
+
+			if (sio_data->adapter)

Is this not pretty much guaranteed to be true?

Quoted 34 lines
drivers/i2c/busses/i2c-nct6793.c new file +34 -0
+				nct6793_remove_adapter(sio_data->adapter);
+
+			platform_device_unregister(pdev[i]);
+		}
+	}
+	platform_driver_unregister(&i2c_nct6793_driver);
+}
+
+/* nct6793_find() looks for a compatible Nuvoton chip in the Super-I/O config space */
+static int __init nct6793_find(int sioaddr, struct nct6793_sio_data *sio_data)
+{
+	u16 val;
+	int err;
+	int addr;
+
+	err = superio_enter(sioaddr);
+	if (err)
+		return err;
+
+	val = (superio_inb(sioaddr, SIO_REG_DEVID) << 8) |
+		superio_inb(sioaddr, SIO_REG_DEVID + 1);
+
+	switch (val & SIO_ID_MASK) {
+	case SIO_NCT6791_ID:
+		sio_data->kind = nct6791;
+		break;
+	case SIO_NCT6792_ID:
+		sio_data->kind = nct6792;
+		break;
+	case SIO_NCT6793_ID:
+		sio_data->kind = nct6793;
+		break;
+	case SIO_NCT6795_ID:
+		sio_data->kind = nct6795;

drivers/i2c/busses/i2c-nct6793.c line 442

Quoted 10 lines
drivers/i2c/busses/i2c-nct6793.c new file +10 -0
+		break;
+	case SIO_NCT6796_ID:
+		sio_data->kind = nct6796;
+		break;
+	case SIO_NCT6798_ID:
+		sio_data->kind = nct6798;
+		break;
+	default:
+		if (val != 0xffff)
+			pr_debug("unsupported chip ID: 0x%04x\n", val);

Please include:

#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt

at the top of the file, otherwise nobody can figure where this debug message comes from.

Quoted 21 lines
drivers/i2c/busses/i2c-nct6793.c new file +21 -0
+		superio_exit(sioaddr);
+		return -ENODEV;
+	}
+
+	/* We have a known chip, find the SMBus I/O address */
+	superio_select(sioaddr, NCT6793_LD_SMBUS);
+	val = (superio_inb(sioaddr, SIO_REG_SMBA) << 8)
+	    | superio_inb(sioaddr, SIO_REG_SMBA + 1);
+	addr = val & IOREGION_ALIGNMENT;
+	if (addr == 0) {
+		pr_err("Refusing to enable a Super-I/O device with a base I/O port 0\n");
+		superio_exit(sioaddr);
+		return -ENODEV;
+	}
+
+	superio_exit(sioaddr);
+	pr_info("Found %s or compatible chip at %#x:%#x\n",
+		nct6793_sio_names[sio_data->kind], sioaddr, addr);
+	sio_data->sioreg = sioaddr;
+
+	return addr;

drivers/i2c/busses/i2c-nct6793.c line 473

Quoted 10 lines
drivers/i2c/busses/i2c-nct6793.c new file +10 -0
+}
+
+static int __init i2c_nct6793_init(void)
+{
+	int i, err;
+	bool found = false;
+	int address;
+	struct resource res;
+	struct nct6793_sio_data sio_data;
+	int sioaddr[2] = { 0x2e, 0x4e };

Can presumably be const?

Quoted 31 lines
drivers/i2c/busses/i2c-nct6793.c new file +31 -0
+
+	err = platform_driver_register(&i2c_nct6793_driver);
+	if (err)
+		return err;
+
+	/*
+	 * Initialize sio_data->kind and sio_data->sioreg.
+	 *
+	 * When Super-I/O functions move to a separate file, the Super-I/O
+	 * driver will probe 0x2e and 0x4e and auto-detect the presence of a
+	 * nct6775 hardware monitor, and call probe().
+	 */
+	for (i = 0; i < ARRAY_SIZE(pdev); i++) {
+		address = nct6793_find(sioaddr[i], &sio_data);
+		if (address <= 0)
+			continue;
+
+		found = true;
+
+		pdev[i] = platform_device_alloc(DRVNAME, address);
+		if (!pdev[i]) {
+			err = -ENOMEM;
+			goto exit_device_unregister;
+		}
+
+		err = platform_device_add_data(pdev[i], &sio_data,
+					       sizeof(struct nct6793_sio_data));
+		if (err)
+			goto exit_device_put;
+
+		memset(&res, 0, sizeof(res));

drivers/i2c/busses/i2c-nct6793.c line 514

Quoted 10 lines
drivers/i2c/busses/i2c-nct6793.c new file +10 -0
+		res.name = DRVNAME;
+		res.start = address;
+		res.end = address + IOREGION_LENGTH - 1;
+		res.flags = IORESOURCE_IO;
+
+		err = acpi_check_resource_conflict(&res);
+		if (err) {
+			platform_device_put(pdev[i]);
+			pdev[i] = NULL;
+			continue;

This looks wrong. The platform device is still registered and will never be freed?

Shouldn't you check for the conflict first?

Quoted 22 lines
drivers/i2c/busses/i2c-nct6793.c new file +22 -0
+		}
+
+		err = platform_device_add_resources(pdev[i], &res, 1);
+		if (err)
+			goto exit_device_put;
+
+		/* platform_device_add calls probe() */
+		err = platform_device_add(pdev[i]);
+		if (err)
+			goto exit_device_put;
+	}
+	if (!found) {
+		err = -ENODEV;
+		goto exit_unregister;
+	}
+
+	return 0;
+
+exit_device_put:
+	platform_device_put(pdev[i]);
+exit_device_unregister:
+	while (--i >= 0) {

drivers/i2c/busses/i2c-nct6793.c line 546

Quoted 10 lines
drivers/i2c/busses/i2c-nct6793.c new file +10 -0
+		if (pdev[i])
+			platform_device_unregister(pdev[i]);
+	}
+exit_unregister:
+	platform_driver_unregister(&i2c_nct6793_driver);
+	return err;
+}
+
+MODULE_AUTHOR("Adam Honse <[email protected]>");
+MODULE_DESCRIPTION("SMBus driver for NCT6793D and compatible chips");

Please include "Nuvoton" in the description.

Quoted 4 lines
drivers/i2c/busses/i2c-nct6793.c new file +4 -0
+MODULE_LICENSE("GPL");
+
+module_init(i2c_nct6793_init);
+module_exit(i2c_nct6793_exit);
Signature · 2 lines
Jean Delvare
SUSE L3 Support
#2 lore raw
Quoted 39 lines · Jean Delvare

Hi Adam,

Quoted 7 lines · Adam Honse

This patch introduces a new driver for the SMBus adapter that is built in to most Nuvoton Super-IO chips. This SMBus adapter is used for RGB lighting control on some ASUS motherboards with Intel chipsets.

The interface's register description is available in the supported devices' datasheets. Operation of this interface has been verified with OpenRGB on an ASUS PRIME Z270-A motherboard.

Care to point me to one such datasheet?

The following errors are reported by ./scripts/checkpatch.pl (which I invite you to run before posting any patch):

RROR: "foo * bar" should be "foo *bar"
#452: FILE: drivers/i2c/busses/i2c-nct6793.c:295:
+static struct i2c_adapter * nct6793_add_adapter(unsigned short smba, const char *name)

ERROR: trailing whitespace
#526: FILE: drivers/i2c/busses/i2c-nct6793.c:369:
+^I^I$

ERROR: space required before the open parenthesis '(' #527: FILE: drivers/i2c/busses/i2c-nct6793.c:370:

drivers/i2c/busses/i2c-nct6793.c new file +1 -0
+		if(IS_ERR(sio_data->adapter))

Please fix before resubmitting.

Also, would you consider declaring yourself the maintainer of this new driver? If so, please add a new entry in MAINTAINERS and add yourself there. You can use the "I2C/SMBUS ISMT DRIVER" entry as an example.

If not, no worry, I'll add the driver to my own list.

I see that there already seem to be a driver for the SMBus interface of Novoton Super-I/O chipsets:

Quoted 9 lines

drivers/hwmon/nct6775-i2c.c

However that driver seems to be fairly limited in capabilities (on purpose). I'm adding the author of this driver and the maintainer of the hwmon subsystem to Cc. How do the two drivers relate to each other? Are they for the same, or different interfaces? If different, we need to come up with names to designate them unambiguously. If the same, then I'm afraid both drivers will step on each other's toes?

That driver connects to the I2C slave interface on Nuvoton chips. The driver here implements support for its I2C master. The driver here talks to the master interface on the chip through superio, and is typically connected to the main processor on a system. The other driver is an I2C slave driver. The slave interface on NCT chips is normally connected to a BMC.

The i/o address by this driver uses a different base address register than its hwmon platform driver (which also connects to the chip through superio), so this driver should hopefully be able to interoperate with that driver. It would be desirable to confirm that the two drivers do not step on each other, though (especially since the sio register page is the same).

Thanks,
Guenter