soc/amd/common/block/i2c: Move SoC agnostic parts into common

The logic behind I2C bus initialization, I2C MMIO base address getter
and setter, I2C bus ACPI name resolution are identical for all the AMD
SoCs. Hence moving all the SoC agnotic parts of the driver into the
common driver and just configure the SoC specific parts into individual
I2C drivers.

BUG=None
TEST=Build Dalboz and Grunt. Boot to OS in Dalboz. Ensure that the I2C
peripherals are detected as earlier in Dalboz. Verify some I2C
peripheral functionality like trackpad and touchscreen.

Change-Id: Ic9c99ec769d7d8ad7e1e566fdf42a5206657183d
Signed-off-by: Karthikeyan Ramasubramanian <kramasub@google.com>
Suggested-by: Kyosti Malkki <kyosti.malkki@gmail.com>
Reviewed-on: https://review.coreboot.org/c/coreboot/+/51509
Reviewed-by: Furquan Shaikh <furquan@google.com>
Reviewed-by: Raul Rangel <rrangel@chromium.org>
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>

src/mainboard/google/kahlee/mainboard.c

@@ -7,6 +7,7 @@
 #include <acpi/acpi.h>
 #include <amdblocks/agesawrapper.h>
 #include <amdblocks/amd_pci_util.h>
+#include <amdblocks/i2c.h>
 #include <baseboard/variants.h>
 #include <boardid.h>
 #include <smbios.h>

src/mainboard/google/zork/verstage.c

@@ -1,6 +1,7 @@
 /* SPDX-License-Identifier: GPL-2.0-or-later */
 
 #include <amdblocks/gpio_banks.h>
+#include <amdblocks/i2c.h>
 #include <baseboard/variants.h>
 #include <console/console.h>
 #include <security/vboot/vboot_common.h>

src/soc/amd/common/block/i2c/i2c.c

@@ -1,14 +1,132 @@
 /* SPDX-License-Identifier: GPL-2.0-only */
 
+#include <acpi/acpi.h>
 #include <assert.h>
-#include <delay.h>
 #include <amdblocks/acpimmio.h>
 #include <amdblocks/gpio_banks.h>
 #include <amdblocks/gpio_defs.h>
 #include <amdblocks/i2c.h>
+#include <console/console.h>
+#include <delay.h>
+#include <device/device.h>
+#include <device/i2c.h>
+#include <device/mmio.h>
+#include <drivers/i2c/designware/dw_i2c.h>
 
 #define MAX_PIN_COUNT 4
 
+uintptr_t dw_i2c_base_address(unsigned int bus)
+{
+	size_t num_ctrlrs;
+	const struct soc_i2c_ctrlr_info *ctrlr = soc_get_i2c_ctrlr_info(&num_ctrlrs);
+
+	if (bus >= num_ctrlrs) {
+		printk(BIOS_ERR, "Bus ID %d is >= number of I2C controllers %zu\n",
+								bus, num_ctrlrs);
+		return 0;
+	}
+
+	return ctrlr[bus].bar;
+}
+
+const struct dw_i2c_bus_config *dw_i2c_get_soc_cfg(unsigned int bus)
+{
+	size_t num_buses = 0;
+	const struct dw_i2c_bus_config *cfg = soc_get_i2c_bus_config(&num_buses);
+
+	if (bus >= num_buses) {
+		printk(BIOS_ERR, "Bus ID %d is >= number of I2C buses %zu\n", bus, num_buses);
+		return NULL;
+	}
+
+	return &cfg[bus];
+}
+
+static const char *i2c_acpi_name(const struct device *dev)
+{
+	size_t i;
+	size_t num_ctrlrs;
+	const struct soc_i2c_ctrlr_info *ctrlr = soc_get_i2c_ctrlr_info(&num_ctrlrs);
+
+	if (!(uintptr_t)dev->path.mmio.addr)
+		die("NULL MMIO address at %s\n", __func__);
+
+	for (i = 0; i < num_ctrlrs; i++) {
+		if ((uintptr_t)dev->path.mmio.addr == ctrlr[i].bar)
+			return ctrlr[i].acpi_name;
+	}
+	printk(BIOS_ERR, "%s: Could not find %lu\n", __func__, (uintptr_t)dev->path.mmio.addr);
+	return NULL;
+}
+
+int dw_i2c_soc_dev_to_bus(const struct device *dev)
+{
+	size_t i;
+	size_t num_ctrlrs;
+	const struct soc_i2c_ctrlr_info *ctrlr = soc_get_i2c_ctrlr_info(&num_ctrlrs);
+
+	if (!(uintptr_t)dev->path.mmio.addr)
+		die("NULL MMIO address at %s\n", __func__);
+
+	for (i = 0; i < num_ctrlrs; i++) {
+		if ((uintptr_t)dev->path.mmio.addr == ctrlr[i].bar)
+			return i;
+	}
+	printk(BIOS_ERR, "%s: Could not find %lu\n", __func__, (uintptr_t)dev->path.mmio.addr);
+	return -1;
+}
+
+void __weak soc_i2c_misc_init(unsigned int bus, const struct dw_i2c_bus_config *cfg)
+{
+	/* Nothing by default. */
+}
+
+static void dw_i2c_soc_init(bool is_early_init)
+{
+	unsigned int bus;
+	size_t num_buses = 0, num_ctrlrs = 0;
+	const struct dw_i2c_bus_config *cfg = soc_get_i2c_bus_config(&num_buses);
+	const struct soc_i2c_ctrlr_info *ctrlr = soc_get_i2c_ctrlr_info(&num_ctrlrs);
+
+	/* Ensure that the number of controllers in devicetree and SoC match. */
+	assert(num_buses == num_ctrlrs);
+
+	for (bus = 0; bus < num_buses; bus++, cfg++, ctrlr++) {
+		/*
+		 * Skip initialization when controller is in peripheral mode or base address
+		 * is not configured or is not the expected stage to initialize.
+		 */
+		if (ctrlr->mode == I2C_PERIPHERAL_MODE || !ctrlr->bar ||
+						cfg->early_init != is_early_init)
+			continue;
+
+		if (dw_i2c_init(bus, cfg))
+			printk(BIOS_ERR, "Failed to init i2c bus %d\n", bus);
+			continue;
+
+		soc_i2c_misc_init(bus, cfg);
+	}
+}
+
+void i2c_soc_early_init(void)
+{
+	dw_i2c_soc_init(true);
+}
+
+void i2c_soc_init(void)
+{
+	dw_i2c_soc_init(false);
+}
+
+struct device_operations soc_amd_i2c_mmio_ops = {
+	/* TODO(kramasub): Move I2C resource info here. */
+	.read_resources = noop_read_resources,
+	.set_resources = noop_set_resources,
+	.scan_bus = scan_smbus,
+	.acpi_name = i2c_acpi_name,
+	.acpi_fill_ssdt = dw_i2c_acpi_fill_ssdt,
+};
+
 struct common_i2c_save {
 	uint32_t control_value;
 	uint8_t mux_value;

src/soc/amd/common/block/include/amdblocks/i2c.h

@@ -4,8 +4,27 @@
 #define AMD_COMMON_BLOCK_I2C_H
 
 #include <amdblocks/gpio_banks.h>
+#include <device/i2c.h>
+#include <drivers/i2c/designware/dw_i2c.h>
 #include <types.h>
 
+/* Enum to identify in which mode the I2C controller is operating. */
+enum i2c_ctrlr_mode {
+	I2C_MASTER_MODE,
+	I2C_PERIPHERAL_MODE,
+};
+
+/**
+ * Data structure to hold SoC I2C controller information
+ * @bar:	MMIO base address for the I2C bus.
+ * @acpi_name:	ACPI Name corresponding to the I2C bus.
+ */
+struct soc_i2c_ctrlr_info {
+	enum i2c_ctrlr_mode mode;
+	uintptr_t bar;
+	const char *acpi_name;
+};
+
 /**
  * Data structure to identify GPIO to be toggled to reset peripherals on an I2C bus.
  * @pin:	GPIO corresponding to I2C SCL that needs to be toggled/bit-banged.
@@ -30,6 +49,21 @@ struct soc_i2c_peripheral_reset_info {
 	uint32_t num_pins;
 };
 
+/* Helper function to perform misc I2C configuration specific to SoC. */
+void soc_i2c_misc_init(unsigned int bus, const struct dw_i2c_bus_config *cfg);
+
+/* Getter function to get the SoC I2C Controller Information. */
+const struct soc_i2c_ctrlr_info *soc_get_i2c_ctrlr_info(size_t *num_ctrlrs);
+
+/* Getter function to get the SoC I2C bus configuration. */
+const struct dw_i2c_bus_config *soc_get_i2c_bus_config(size_t *num_buses);
+
+/* Initialize all the i2c buses that are marked with early init. */
+void i2c_soc_early_init(void);
+
+/* Initialize all the i2c buses that are not marked with early init. */
+void i2c_soc_init(void);
+
 /* Reset I2C peripherals. */
 void sb_reset_i2c_peripherals(const struct soc_i2c_peripheral_reset_info *reset_info);
 

src/soc/amd/picasso/chip.c

@@ -14,7 +14,7 @@
 #include <fsp/api.h>
 
 /* Supplied by i2c.c */
-extern struct device_operations picasso_i2c_mmio_ops;
+extern struct device_operations soc_amd_i2c_mmio_ops;
 /* Supplied by uart.c */
 extern struct device_operations picasso_uart_mmio_ops;
 
@@ -51,7 +51,7 @@ static void set_mmio_dev_ops(struct device *dev)
 	case APU_I2C2_BASE:
 	case APU_I2C3_BASE:
 	case APU_I2C4_BASE:
-		dev->ops = &picasso_i2c_mmio_ops;
+		dev->ops = &soc_amd_i2c_mmio_ops;
 		break;
 	case APU_UART0_BASE:
 	case APU_UART1_BASE:

src/soc/amd/picasso/chip.h

@@ -105,7 +105,7 @@ struct soc_amd_picasso_config {
 	 * register i2c_scl_reset = (GPIO_I2C0_SCL | GPIO_I2C3_SCL)
 	 */
 	u8 i2c_scl_reset;
-	struct dw_i2c_bus_config i2c[I2C_MASTER_DEV_COUNT];
+	struct dw_i2c_bus_config i2c[I2C_CTRLR_COUNT];
 	enum {
 		I2S_PINS_MAX_HDA = 0,	/* HDA w/reset  3xSDI, SW w/Data0 */
 		I2S_PINS_MAX_MHDA = 1,	/* HDA no reset 3xSDI, SW w/Data0-1 */

src/soc/amd/picasso/fch.c

@@ -13,6 +13,7 @@
 #include <amdblocks/reset.h>
 #include <amdblocks/acpimmio.h>
 #include <amdblocks/acpi.h>
+#include <amdblocks/i2c.h>
 #include <amdblocks/smi.h>
 #include <soc/acpi.h>
 #include <soc/cpu.h>