From 15606481974b6c8cd266b4cfe0e473e18592f611 Mon Sep 17 00:00:00 2001
From: Jan Samek <jan.samek@siemens.com>
Date: Fri, 11 Nov 2022 15:59:05 +0100
Subject: [PATCH] drivers/i2c/rv3028c7: Add ACPI generation callbacks

Add ACPI generation callback to the driver after obtaining the
ACPI HID "MCRY3028" for this device from Microcrystal AG (VID: "MCRY").

Also add I2C bus speed field to the device config structure, which
is a required ACPI entry.

BUG=none
TEST=Disassemble the SSDT table and see whether the device entry
"MC28" is generated correctly. Also check whether the RV3028 driver
in Linux (drivers/rtc/rtc-rv-3028.c) is bound correctly after adding
an ACPI match table to it containing the HID. A proper kernel patch
is pending.

Change-Id: I3b8cf5c8dc551439755992ff05b6693e91cc3f21
Signed-off-by: Jan Samek <jan.samek@siemens.com>
Reviewed-on: https://review.coreboot.org/c/coreboot/+/69543
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
Reviewed-by: Werner Zeh <werner.zeh@siemens.com>
---
 src/drivers/i2c/rv3028c7/chip.h     |  1 +
 src/drivers/i2c/rv3028c7/rv3028c7.c | 62 +++++++++++++++++++++++++++++++++++++
 src/drivers/i2c/rv3028c7/rv3028c7.h |  4 +++
 3 files changed, 67 insertions(+)

diff --git a/src/drivers/i2c/rv3028c7/chip.h b/src/drivers/i2c/rv3028c7/chip.h
index 0ac400531b..0ed86ffeff 100644
--- a/src/drivers/i2c/rv3028c7/chip.h
+++ b/src/drivers/i2c/rv3028c7/chip.h
@@ -35,6 +35,7 @@ enum charge_mode {
 };
 
 struct drivers_i2c_rv3028c7_config {
+	unsigned int bus_speed;		/* Bus clock in Hz */
 	unsigned char user_weekday;	/* User day of the week to set */
 	unsigned char user_day;		/* User day to set */
 	unsigned char user_month;	/* User month to set */
diff --git a/src/drivers/i2c/rv3028c7/rv3028c7.c b/src/drivers/i2c/rv3028c7/rv3028c7.c
index e7e3b47ece..87cbc24785 100644
--- a/src/drivers/i2c/rv3028c7/rv3028c7.c
+++ b/src/drivers/i2c/rv3028c7/rv3028c7.c
@@ -1,5 +1,7 @@
 /* SPDX-License-Identifier: GPL-2.0-only */
 
+#include <acpi/acpi_device.h>
+#include <acpi/acpigen.h>
 #include <commonlib/bsd/bcd.h>
 #include <console/console.h>
 #include <delay.h>
@@ -176,11 +178,71 @@ static void rtc_init(struct device *dev)
 	}
 }
 
+#if CONFIG(HAVE_ACPI_TABLES)
+static void rv3028c7_fill_ssdt(const struct device *dev)
+{
+	const char *scope = acpi_device_scope(dev);
+	struct drivers_i2c_rv3028c7_config *config = dev->chip_info;
+	enum i2c_speed bus_speed;
+
+	if (!scope)
+		return;
+
+	switch (config->bus_speed) {
+	case I2C_SPEED_STANDARD:
+	case I2C_SPEED_FAST:
+		bus_speed = config->bus_speed;
+		break;
+	default:
+		bus_speed = I2C_SPEED_STANDARD;
+		printk(BIOS_INFO, "%s: Bus speed unsupported, fall back to %d kHz!\n",
+			dev->chip_ops->name, bus_speed / 1000);
+		break;
+	}
+
+	struct acpi_i2c i2c = {
+		.address = dev->path.i2c.device,
+		.mode_10bit = dev->path.i2c.mode_10bit,
+		.speed = bus_speed,
+		.resource = scope,
+	};
+
+	/* Device */
+	acpigen_write_scope(scope);
+	acpigen_write_device(acpi_device_name(dev));
+	acpigen_write_name_string("_HID", RV3028C7_HID_NAME);
+	acpigen_write_name_string("_DDN", RV3028C7_HID_DESC);
+	acpigen_write_STA(acpi_device_status(dev));
+
+	/* Resources */
+	acpigen_write_name("_CRS");
+
+	acpigen_write_resourcetemplate_header();
+	acpi_device_write_i2c(&i2c);
+	acpigen_write_resourcetemplate_footer();
+
+	acpigen_pop_len(); /* Device */
+	acpigen_pop_len(); /* Scope */
+
+	printk(BIOS_INFO, "%s: %s at %s\n", acpi_device_path(dev), dev->chip_ops->name,
+			dev_path(dev));
+}
+
+static const char *rv3028c7_acpi_name(const struct device *dev)
+{
+	return RV3028C7_ACPI_NAME;
+}
+#endif
+
 static struct device_operations rv3028c7_ops = {
 	.read_resources		= noop_read_resources,
 	.set_resources		= noop_set_resources,
 	.init			= rtc_init,
 	.final			= rtc_final,
+#if CONFIG(HAVE_ACPI_TABLES)
+	.acpi_name		= rv3028c7_acpi_name,
+	.acpi_fill_ssdt		= rv3028c7_fill_ssdt,
+#endif
 };
 
 static void rtc_enable(struct device *dev)
diff --git a/src/drivers/i2c/rv3028c7/rv3028c7.h b/src/drivers/i2c/rv3028c7/rv3028c7.h
index 55617a724f..b1f9971bbe 100644
--- a/src/drivers/i2c/rv3028c7/rv3028c7.h
+++ b/src/drivers/i2c/rv3028c7/rv3028c7.h
@@ -3,6 +3,10 @@
 #ifndef _I2C_RV3028C7_H_
 #define _I2C_RV3028C7_H_
 
+#define RV3028C7_ACPI_NAME		"MC28"
+#define RV3028C7_HID_NAME		"MCRY3028"
+#define RV3028C7_HID_DESC		"Real Time Clock"
+
 /* Register layout */
 #define SECOND_REG			0x00
 #define MINUTE_REG			0x01
-- 
2.11.4.GIT