soc/amd/common: factor out SMU code from Picasso

The SMU mailbox access code from Picasso can be reused in the next
generation, so factor out the code to soc/amd/common/block/smu. Since
the mailbox register offsets in the indirect address space, the number
of arguments and the message IDs don't always match between different
devices, keep those in the soc-specific directories.

Change-Id: Ibaf5b91ab35428e4c771e7163c6e0c4fc50371e7
Signed-off-by: Felix Held <felix-coreboot@felixheld.de>
Reviewed-on: https://review.coreboot.org/c/coreboot/+/47483
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
Reviewed-by: Jeremy Soller <jeremy@system76.com>
Reviewed-by: Marshall Dawson <marshalldawson3rd@gmail.com>

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

@@ -0,0 +1,26 @@
+/* SPDX-License-Identifier: GPL-2.0-only */
+
+#ifndef __AMD_BLOCK_SMU_H__
+#define __AMD_BLOCK_SMU_H__
+
+#include <types.h>
+#include <soc/smu.h> /* SoC-dependent definitions for SMU access */
+
+/* SMU registers accessed indirectly using an index/data pair in D0F00 config space */
+#define SMU_INDEX_ADDR		0xb8 /* 32 bit */
+#define SMU_DATA_ADDR		0xbc /* 32 bit */
+
+/* Arguments indexed locations are contiguous; the number is SoC-dependent */
+#define REG_ADDR_MESG_ARG(x)	(REG_ADDR_MESG_ARGS_BASE + ((x) * sizeof(uint32_t)))
+
+struct smu_payload {
+	uint32_t msg[SMU_NUM_ARGS];
+};
+
+/*
+ * Send a message and bi-directional payload to the SMU. The SMU's response, if any, is
+ * returned via *arg. Returns CB_SUCCESS if success or CB_ERR on failure.
+ */
+enum cb_err send_smu_message(enum smu_message_id message_id, struct smu_payload *arg);
+
+#endif /* __AMD_BLOCK_SMU_H__ */

src/soc/amd/common/block/smu/Kconfig

@@ -0,0 +1,5 @@
+config SOC_AMD_COMMON_BLOCK_SMU
+	bool
+	default n
+	help
+	  Select this option to add functions to communicate with the SMU to the build.

src/soc/amd/common/block/smu/Makefile.inc

@@ -0,0 +1 @@
+smm-$(CONFIG_SOC_AMD_COMMON_BLOCK_SMU) += smu.c

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

@@ -0,0 +1,80 @@
+/* SPDX-License-Identifier: GPL-2.0-only */
+
+#include <timer.h>
+#include <console/console.h>
+#include <device/pci_ops.h>
+#include <amdblocks/smu.h>
+#include <soc/pci_devs.h>
+#include <soc/smu.h>
+#include <types.h>
+
+static uint32_t smu_read32(uint32_t reg)
+{
+	pci_write_config32(SOC_GNB_DEV, SMU_INDEX_ADDR, reg);
+	return pci_read_config32(SOC_GNB_DEV, SMU_DATA_ADDR);
+}
+
+static void smu_write32(uint32_t reg, uint32_t val)
+{
+	pci_write_config32(SOC_GNB_DEV, SMU_INDEX_ADDR, reg);
+	pci_write_config32(SOC_GNB_DEV, SMU_DATA_ADDR, val);
+}
+
+#define SMU_MESG_RESP_TIMEOUT	0x00
+#define SMU_MESG_RESP_OK	0x01
+
+/* returns SMU_MESG_RESP_OK, SMU_MESG_RESP_TIMEOUT or a negative number */
+static int32_t smu_poll_response(bool print_command_duration)
+{
+	struct stopwatch sw;
+	const long timeout_ms = 10 * MSECS_PER_SEC;
+	int32_t result;
+
+	stopwatch_init_msecs_expire(&sw, timeout_ms);
+
+	do {
+		result = smu_read32(REG_ADDR_MESG_RESP);
+		if (result) {
+			if (print_command_duration)
+				printk(BIOS_SPEW, "SMU command consumed %ld usecs\n",
+					stopwatch_duration_usecs(&sw));
+			return result;
+		}
+	} while (!stopwatch_expired(&sw));
+
+	printk(BIOS_ERR, "Error: timeout sending SMU message\n");
+	return SMU_MESG_RESP_TIMEOUT;
+}
+
+/*
+ * Send a message and bi-directional payload to the SMU. SMU response, if any, is returned via
+ * *arg.
+ */
+enum cb_err send_smu_message(enum smu_message_id message_id, struct smu_payload *arg)
+{
+	size_t i;
+
+	/* wait until SMU can process a new request; don't care if an old request failed */
+	if (smu_poll_response(false) == SMU_MESG_RESP_TIMEOUT)
+		return CB_ERR;
+
+	/* clear response register */
+	smu_write32(REG_ADDR_MESG_RESP, 0);
+
+	/* populate arguments */
+	for (i = 0 ; i < SMU_NUM_ARGS ; i++)
+		smu_write32(REG_ADDR_MESG_ARG(i), arg->msg[i]);
+
+	/* send message to SMU */
+	smu_write32(REG_ADDR_MESG_ID, message_id);
+
+	/* wait until SMU has processed the message and check if it was successful */
+	if (smu_poll_response(true) != SMU_MESG_RESP_OK)
+		return CB_ERR;
+
+	/* copy returned values */
+	for (i = 0 ; i < SMU_NUM_ARGS ; i++)
+		arg->msg[i] = smu_read32(REG_ADDR_MESG_ARG(i));
+
+	return CB_SUCCESS;
+}

src/soc/amd/picasso/Kconfig

@@ -41,6 +41,7 @@ config CPU_SPECIFIC_OPTIONS
 	select SOC_AMD_COMMON_BLOCK_HDA
 	select SOC_AMD_COMMON_BLOCK_SATA
 	select SOC_AMD_COMMON_BLOCK_SMBUS
+	select SOC_AMD_COMMON_BLOCK_SMU
 	select SOC_AMD_COMMON_BLOCK_PSP_GEN2
 	select PROVIDES_ROM_SHARING
 	select BOOT_DEVICE_SUPPORTS_WRITES if BOOT_DEVICE_SPI_FLASH

src/soc/amd/picasso/include/soc/smu.h

@@ -3,37 +3,23 @@
 #ifndef __PICASSO_SMU_H__
 #define __PICASSO_SMU_H__
 
-#include <types.h>
+/*
-
+ * SMU mailbox register offsets in indirect address space accessed by an index/data pair in
-/* SMU registers accessed indirectly using an index/data pair in D0F00 config space */
+ * D0F00 config space.
-#define SMU_INDEX_ADDR		0xb8 /* 32 bit */
+ */
-#define SMU_DATA_ADDR		0xbc /* 32 bit */
-
 #define REG_ADDR_MESG_ID	0x3b10528
 #define REG_ADDR_MESG_RESP	0x3b10564
 #define REG_ADDR_MESG_ARGS_BASE	0x3b10998
 
-/* Argument 0-5 indexed locations are contiguous */
 #define SMU_NUM_ARGS		6
-#define REG_ADDR_MESG_ARG(x)	(REG_ADDR_MESG_ARGS_BASE + ((x) * sizeof(uint32_t)))
 
 enum smu_message_id {
 	SMC_MSG_S3ENTRY = 0x0c,
 };
 
-struct smu_payload {
-	uint32_t msg[SMU_NUM_ARGS];
-};
-
 /*
- * Send a message and bi-directional payload to the SMU.  SMU response, if
+ * Request the SMU put system into S3, S4, or S5. On entry, SlpTyp determines S-State and
- * any, is returned via arg.  Returns 0 if success or -1 on failure.
+ * SlpTypeEn gets set by the SMU. Function does not return if successful.
- */
-enum cb_err send_smu_message(enum smu_message_id id, struct smu_payload *arg);
-
-/*
- * Request the SMU put system into S3, S4, or S5.  On entry, SlpTyp determines
- * S-State and SlpTypeEn is clear.  Function does not return if successful.
  */
 void smu_sx_entry(void);
 

src/soc/amd/picasso/smu.c

@@ -1,86 +1,12 @@
 /* SPDX-License-Identifier: GPL-2.0-only */
 
-#include <timer.h>
 #include <console/console.h>
-#include <device/pci_ops.h>
+#include <amdblocks/smu.h>
-#include <soc/pci_devs.h>
 #include <soc/smu.h>
-#include <types.h>
-
-static uint32_t smu_read32(uint32_t reg)
-{
-	pci_write_config32(SOC_GNB_DEV, SMU_INDEX_ADDR, reg);
-	return pci_read_config32(SOC_GNB_DEV, SMU_DATA_ADDR);
-}
-
-static void smu_write32(uint32_t reg, uint32_t val)
-{
-	pci_write_config32(SOC_GNB_DEV, SMU_INDEX_ADDR, reg);
-	pci_write_config32(SOC_GNB_DEV, SMU_DATA_ADDR, val);
-}
-
-#define SMU_MESG_RESP_TIMEOUT	0x00
-#define SMU_MESG_RESP_OK	0x01
-
-/* returns SMU_MESG_RESP_OK, SMU_MESG_RESP_TIMEOUT or a negative number */
-static int32_t smu_poll_response(bool print_command_duration)
-{
-	struct stopwatch sw;
-	const long timeout_ms = 10 * MSECS_PER_SEC;
-	int32_t result;
-
-	stopwatch_init_msecs_expire(&sw, timeout_ms);
-
-	do {
-		result = smu_read32(REG_ADDR_MESG_RESP);
-		if (result) {
-			if (print_command_duration)
-				printk(BIOS_SPEW, "SMU command consumed %ld usecs\n",
-					stopwatch_duration_usecs(&sw));
-			return result;
-		}
-	} while (!stopwatch_expired(&sw));
-
-	printk(BIOS_ERR, "Error: timeout sending SMU message\n");
-	return SMU_MESG_RESP_TIMEOUT;
-}
-
-/*
- * Send a message and bi-directional payload to the SMU. SMU response, if any, is returned via
- * arg.
- */
-enum cb_err send_smu_message(enum smu_message_id id, struct smu_payload *arg)
-{
-	size_t i;
-
-	/* wait until SMU can process a new request; don't care if an old request failed */
-	if (smu_poll_response(false) == SMU_MESG_RESP_TIMEOUT)
-		return CB_ERR;
-
-	/* clear response register */
-	smu_write32(REG_ADDR_MESG_RESP, 0);
-
-	/* populate arguments */
-	for (i = 0 ; i < SMU_NUM_ARGS ; i++)
-		smu_write32(REG_ADDR_MESG_ARG(i), arg->msg[i]);
-
-	/* send message to SMU */
-	smu_write32(REG_ADDR_MESG_ID, id);
-
-	/* wait until SMU has processed the message and check if it was successful */
-	if (smu_poll_response(true) != SMU_MESG_RESP_OK)
-		return CB_ERR;
-
-	/* copy returned values */
-	for (i = 0 ; i < SMU_NUM_ARGS ; i++)
-		arg->msg[i] = smu_read32(REG_ADDR_MESG_ARG(i));
-
-	return CB_SUCCESS;
-}
 
 /*
  * Request the SMU to put system into S3, S4, or S5. On entry, SlpTyp determines S-State and
- * SlpTypeEn is clear. Function does not return if successful.
+ * SlpTypeEn gets set by the SMU. Function does not return if successful.
  */
 void smu_sx_entry(void)
 {