drivers/i2c/ck505: Add generic driver to configure clockgen

Replaces the ics/954309 driver with a more generic version to
accommodate clockgens with a different amount of registers.

It also features a mask to only touch certain bits of the clockgen.

TODO: set appropriate mask for X60/T60 since the datasheets for their
clockgens can be found.

Change-Id: Ie43c4de7891a39f2f443e78213ecd688134e68d7
Signed-off-by: Arthur Heymans <arthur@aheymans.xyz>
Reviewed-on: https://review.coreboot.org/20042
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
Reviewed-by: Kyösti Mälkki <kyosti.malkki@gmail.com>

src/drivers/i2c/ck505/Kconfig

@@ -0,0 +1,2 @@
+config DRIVERS_I2C_CK505
+	bool

src/drivers/i2c/ck505/Makefile.inc

@@ -0,0 +1 @@
+ramstage-$(CONFIG_DRIVERS_I2C_CK505) += ck505.c

src/drivers/i2c/ck505/chip.h

@@ -14,17 +14,13 @@
  * GNU General Public License for more details.
  */
 
-struct drivers_ics_954309_config {
+#ifndef DRIVERS_CK505_CHIP_H
-	u8 reg0;
+#define DRIVERS_CK505_CHIP_H
-	u8 reg1;
+
-	u8 reg2;
+struct drivers_i2c_ck505_config {
-	u8 reg3;
+	const int nregs;
-	u8 reg4;
+	const u8 regs[32];
-	u8 reg5;
+	const u8 mask[32];
-	u8 reg6;
-	u8 reg7;
-	u8 reg8;
-	u8 reg9;
-	u8 reg10;
-	u8 reg11;
 };
+
+#endif

src/drivers/i2c/ck505/ck505.c

@@ -0,0 +1,81 @@
+/*
+ * This file is part of the coreboot project.
+ *
+ * Copyright (C) 2011 Sven Schnelle <svens@stackframe.org>
+ *
+ * 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; version 2 of
+ * the License.
+ *
+ * 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 <assert.h>
+#include <console/console.h>
+#include <device/device.h>
+#include <device/smbus.h>
+#include <device/pci.h>
+#include <device/pci_ids.h>
+#include <device/pci_ops.h>
+#include <cpu/x86/msr.h>
+#include "chip.h"
+#include <string.h>
+
+#define SMBUS_BLOCK_SIZE 32
+
+static void ck505_init(struct device *dev)
+{
+	struct drivers_i2c_ck505_config *config;
+	int dev_nregs, nregs;
+	u8 block[SMBUS_BLOCK_SIZE];
+	int i;
+
+	if (!dev->enabled || dev->path.type != DEVICE_PATH_I2C)
+		return;
+
+	config = dev->chip_info;
+
+	dev_nregs = smbus_block_read(dev, 0, sizeof(block), block);
+
+	if (dev_nregs < 0) {
+		printk(BIOS_ERR, "Failed reading ck505 configuration!\n");
+		return;
+	}
+
+	/* This means that the devicetree doesn't have to specify nregs */
+	nregs = MIN(MIN(dev_nregs, config->nregs == 0 ? SMBUS_BLOCK_SIZE
+				: config->nregs), ARRAY_SIZE(config->mask));
+
+
+	printk(BIOS_DEBUG, "Changing %d of the %d ck505 config bytes.\n",
+		nregs, dev_nregs);
+
+	assert(ARRAY_SIZE(config->mask) == ARRAY_SIZE(config->regs));
+
+	for (i = 0; i < nregs && i < SMBUS_BLOCK_SIZE; i++)
+		block[i] = (block[i] & ~config->mask[i]) | config->regs[i];
+
+	if (smbus_block_write(dev, 0, dev_nregs, block) < 0)
+		printk(BIOS_ERR, "Failed writing ck505 configuration!\n");
+}
+
+static struct device_operations ck505_operations = {
+	.read_resources		= DEVICE_NOOP,
+	.set_resources		= DEVICE_NOOP,
+	.enable_resources	= DEVICE_NOOP,
+	.init			= ck505_init,
+};
+
+static void enable_dev(struct device *dev)
+{
+	dev->ops = &ck505_operations;
+}
+
+struct chip_operations drivers_i2c_ck505_ops = {
+	CHIP_NAME("CK505 Clock generator")
+	.enable_dev = enable_dev,
+};

src/drivers/ics/954309/Kconfig

@@ -1,2 +0,0 @@
-config DRIVERS_ICS_954309
-	bool

src/drivers/ics/954309/Makefile.inc

@@ -1 +0,0 @@
-ramstage-$(CONFIG_DRIVERS_ICS_954309) += ics954309.c

src/drivers/ics/954309/ics954309.c

@@ -1,68 +0,0 @@
-/*
- * This file is part of the coreboot project.
- *
- * Copyright (C) 2011 Sven Schnelle <svens@stackframe.org>
- *
- * 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; version 2 of
- * the License.
- *
- * 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 <console/console.h>
-#include <device/device.h>
-#include <device/smbus.h>
-#include <device/pci.h>
-#include <device/pci_ids.h>
-#include <device/pci_ops.h>
-#include <cpu/x86/msr.h>
-#include "chip.h"
-#include <string.h>
-
-static void ics954309_init(struct device *dev)
-{
-	struct drivers_ics_954309_config *config;
-	u8 initdata[12];
-
-	if (!dev->enabled || dev->path.type != DEVICE_PATH_I2C)
-		return;
-
-	config = dev->chip_info;
-
-	initdata[0] = config->reg0;
-	initdata[1] = config->reg1;
-	initdata[2] = config->reg2;
-	initdata[3] = config->reg3;
-	initdata[4] = config->reg4;
-	initdata[5] = config->reg5;
-	initdata[6] = config->reg6;
-	initdata[7] = config->reg7;
-	initdata[8] = config->reg8;
-	initdata[9] = config->reg9;
-	initdata[10] = config->reg10;
-	initdata[11] = config->reg11;
-
-	smbus_block_write(dev, 0, 12, initdata);
-}
-
-static struct device_operations ics954309_operations = {
-	.read_resources   = DEVICE_NOOP,
-	.set_resources    = DEVICE_NOOP,
-	.enable_resources = DEVICE_NOOP,
-	.init             = ics954309_init,
-};
-
-static void enable_dev(struct device *dev)
-{
-	dev->ops = &ics954309_operations;
-}
-
-struct chip_operations drivers_ics_954309_ops = {
-	CHIP_NAME("ICS 954309 Clock generator")
-	.enable_dev = enable_dev,
-};

src/mainboard/lenovo/t60/Kconfig

@@ -12,7 +12,7 @@ config BOARD_SPECIFIC_OPTIONS # dummy
 	select SOUTHBRIDGE_TI_PCI1X2X
 	select EC_LENOVO_PMH7
 	select EC_LENOVO_H8
-	select DRIVERS_ICS_954309
+	select DRIVERS_I2C_CK505
 	select HAVE_OPTION_TABLE
 	select INTEL_INT15
 	select HAVE_MP_TABLE

src/mainboard/lenovo/t60/devicetree.cb

@@ -209,19 +209,13 @@ chip northbridge/intel/i945
 			end
 			device pci 1f.3 on # SMBUS
 				subsystemid 0x17aa 0x200f
-				chip drivers/ics/954309
+				chip drivers/i2c/ck505
-					register "reg0" = "0x2e"
+					register "mask" = "{ 0xff, 0xff, 0xff,
-					register "reg1" = "0xf7"
+						 0xff, 0xff, 0xff, 0xff, 0xff,
-					register "reg2" = "0x3c"
+						 0xff, 0xff, 0xff, 0xff }"
-					register "reg3" = "0x20"
+					register "regs" = "{ 0x2e, 0xf7, 0x3c,
-					register "reg4" = "0x01"
+						 0x20, 0x01, 0x00, 0x1b, 0x01,
-					register "reg5" = "0x00"
+						 0x54, 0xff, 0xff, 0x07 }"
-					register "reg6" = "0x1b"
-					register "reg7" = "0x01"
-					register "reg8" = "0x54"
-					register "reg9" = "0xff"
-					register "reg10" = "0xff"
-					register "reg11" = "0x07"
 					device i2c 69 on end
 				end
 			        # eeprom, 8 virtual devices, same chip

src/mainboard/lenovo/x60/Kconfig

@@ -12,7 +12,7 @@ config BOARD_SPECIFIC_OPTIONS # dummy
 	select SUPERIO_NSC_PC87392
 	select EC_LENOVO_PMH7
 	select EC_LENOVO_H8
-	select DRIVERS_ICS_954309
+	select DRIVERS_I2C_CK505
 	select HAVE_OPTION_TABLE
 	select INTEL_INT15
 	select HAVE_CMOS_DEFAULT

src/mainboard/lenovo/x60/devicetree.cb

@@ -191,19 +191,13 @@ chip northbridge/intel/i945
 			end
 			device pci 1f.3 on # SMBUS
 				subsystemid 0x17aa 0x200f
-				chip drivers/ics/954309
+				chip drivers/i2c/ck505
-					register "reg0" = "0x2e"
+					register "mask" = "{ 0xff, 0xff, 0xff,
-					register "reg1" = "0xf7"
+						 0xff, 0xff, 0xff, 0xff, 0xff,
-					register "reg2" = "0x3c"
+						 0xff, 0xff, 0xff, 0xff }"
-					register "reg3" = "0x20"
+					register "regs" = "{ 0x2e, 0xf7, 0x3c,
-					register "reg4" = "0x01"
+						 0x20, 0x01, 0x00, 0x1b, 0x01,
-					register "reg5" = "0x00"
+						 0x54, 0xff, 0xff, 0x07 }"
-					register "reg6" = "0x1b"
-					register "reg7" = "0x01"
-					register "reg8" = "0x54"
-					register "reg9" = "0xff"
-					register "reg10" = "0xff"
-					register "reg11" = "0x07"
 					device i2c 69 on end
 				end
 			        # eeprom, 8 virtual devices, same chip