diff mbox series

[v2] platform/x86: amd-pmc: Add AMD platform support for S2Idle

Message ID 20201028185654.2692118-1-Shyam-sundar.S-k@amd.com (mailing list archive)
State Superseded, archived
Headers show
Series [v2] platform/x86: amd-pmc: Add AMD platform support for S2Idle | expand

Commit Message

Shyam Sundar S K Oct. 28, 2020, 6:56 p.m. UTC
AMD Power Management Controller driver aka. amd-pmc driver is the
controller which is meant for final S2Idle transaction that goes to the
PMFW running on the AMD SMU (System Management Unit) responsible for
tuning of the VDD.

Once all the monitored list or the idle constraints are met, this driver
would go and set the OS_HINT (meaning all the devices have reached to
their lowest state possible) via the SMU mailboxes.

This driver would also provide some debug capabilities via debugfs.

Signed-off-by: Shyam Sundar S K <Shyam-sundar.S-k@amd.com>
---
Changes since v1:(https://www.spinics.net/lists/platform-driver-x86/msg23269.html)
- Remove duplicate code and make a common routine for polling SMU
- Reorg Maintainers info
- add missing iounmap() during erroneous case.

 MAINTAINERS                    |   7 +
 drivers/platform/x86/Kconfig   |   9 ++
 drivers/platform/x86/Makefile  |   3 +
 drivers/platform/x86/amd-pmc.c | 274 +++++++++++++++++++++++++++++++++
 drivers/platform/x86/amd-pmc.h |  64 ++++++++
 5 files changed, 357 insertions(+)
 create mode 100644 drivers/platform/x86/amd-pmc.c
 create mode 100644 drivers/platform/x86/amd-pmc.h

Comments

Shyam Sundar S K Nov. 3, 2020, 12:28 p.m. UTC | #1
Hi Hans,

On 10/29/2020 12:26 AM, Shyam Sundar S K wrote:
> AMD Power Management Controller driver aka. amd-pmc driver is the
> controller which is meant for final S2Idle transaction that goes to the
> PMFW running on the AMD SMU (System Management Unit) responsible for
> tuning of the VDD.
> 
> Once all the monitored list or the idle constraints are met, this driver
> would go and set the OS_HINT (meaning all the devices have reached to
> their lowest state possible) via the SMU mailboxes.
> 
> This driver would also provide some debug capabilities via debugfs.
> 
> Signed-off-by: Shyam Sundar S K <Shyam-sundar.S-k@amd.com>
> ---
> Changes since v1:(https://www.spinics.net/lists/platform-driver-x86/msg23269.html)
> - Remove duplicate code and make a common routine for polling SMU
> - Reorg Maintainers info
> - add missing iounmap() during erroneous case.
> 

any feedback on this patch, please?

- Shyam
Hans de Goede Nov. 3, 2020, 1:04 p.m. UTC | #2
Hi,

On 11/3/20 1:28 PM, Shyam Sundar S K wrote:
> Hi Hans,
> 
> On 10/29/2020 12:26 AM, Shyam Sundar S K wrote:
>> AMD Power Management Controller driver aka. amd-pmc driver is the
>> controller which is meant for final S2Idle transaction that goes to the
>> PMFW running on the AMD SMU (System Management Unit) responsible for
>> tuning of the VDD.
>>
>> Once all the monitored list or the idle constraints are met, this driver
>> would go and set the OS_HINT (meaning all the devices have reached to
>> their lowest state possible) via the SMU mailboxes.
>>
>> This driver would also provide some debug capabilities via debugfs.
>>
>> Signed-off-by: Shyam Sundar S K <Shyam-sundar.S-k@amd.com>
>> ---
>> Changes since v1:(https://www.spinics.net/lists/platform-driver-x86/msg23269.html)
>> - Remove duplicate code and make a common routine for polling SMU
>> - Reorg Maintainers info
>> - add missing iounmap() during erroneous case.
>>
> 
> any feedback on this patch, please?

I have reviewing this on my to do list, some patience please.

Regards,

Hans
Andy Shevchenko Nov. 3, 2020, 10:49 p.m. UTC | #3
On Thu, Oct 29, 2020 at 10:57 AM Shyam Sundar S K
<Shyam-sundar.S-k@amd.com> wrote:
>
> AMD Power Management Controller driver aka. amd-pmc driver is the

aka. -> a.k.a. or AKA

> controller which is meant for final S2Idle transaction that goes to the

for the final

> PMFW running on the AMD SMU (System Management Unit) responsible for
> tuning of the VDD.
>
> Once all the monitored list or the idle constraints are met, this driver
> would go and set the OS_HINT (meaning all the devices have reached to
> their lowest state possible) via the SMU mailboxes.
>
> This driver would also provide some debug capabilities via debugfs.

...

> +F:     drivers/platform/x86/amd-pmc.c
> +F:     drivers/platform/x86/amd-pmc.h

Can be one entry.

...

> +       help
> +         The driver provides support for AMD Power Management Controller
> +         primarily responsible for S2Idle transactions that are driven from
> +         a platform firmware running on SMU. This driver also provides debug

a debug

> +         mechanism to investigate the S2Idle transactions and failures.

How will the module be called?

...

> +static void amd_pmc_dbgfs_register(struct amd_pmc_dev *dev)
> +{
> +       struct dentry *dir;

What is the point of having the temporary variable?

> +       dir = debugfs_create_dir("amd_pmc", NULL);
> +       dev->dbgfs_dir = dir;
> +       debugfs_create_file("smu_fw_info", 0644, dir, dev, &smu_fw_info_fops);
> +}

...

> +static int amd_pmc_poll_smu_response(struct amd_pmc_dev *dev)
> +{
> +       int rc = 0, index;

Redundant assignment.

> +       for (index = 0; index < RESPONSE_REGISTER_LOOP_MAX; index++) {
> +               rc = amd_pmc_reg_read(dev, AMD_PMC_REGISTER_RESPONSE);

> +               if (rc != 0)
> +                       break;

if (rc)
  return rc;

> +
> +               usleep_range(PMC_MSG_DELAY_MIN, PMC_MSG_DELAY_MAX);
> +       }
> +
> +       return rc;
> +}

Seems like home grown readx_poll_timeout().

...

> +       int rc = 0;

Redundant assignment.

...

> +       /* Wait until the response register is non-zero */

This comment is confusing.

I guess you rather need to return an error code from the called function...

> +       rc = amd_pmc_poll_smu_response(dev);
> +       if (!rc) {
> +               dev_err(dev->dev, "failed to talk to SMU\n");

> +               return -EIO;

...and propagate it here.

> +       }

...

> +       if (arg) {
> +               /* Wait until the response register is non-zero */
> +               rc = amd_pmc_poll_smu_response(dev);

> +               if (!rc) {

As above. This is an unusual pattern in the kernel.

> +                       dev_err(dev->dev, "failed to talk to SMU\n");
> +                       return -EIO;
> +               }

> +               /* If message register is OK, then SMU has finished processing
> +                * the message, and then read back from AMD_PMC_REGISTER_ARGUMENT
> +                */

Comment style!

> +               rc = amd_pmc_reg_read(dev, AMD_PMC_REGISTER_ARGUMENT);

And where is rc going?

> +       }
> +
> +       return 0;

...

> +#ifdef CONFIG_PM_SLEEP

__maybe_unused is slightly better.

...

> +static int amd_pmc_suspend(struct device *dev)
> +{
> +       struct amd_pmc_dev *pdev = dev_get_drvdata(dev);

> +       int rc = 0;

What is the point?

> +       rc = amd_pmc_send_cmd(pdev, 1, 0);
> +       if (rc)
> +               dev_err(pdev->dev, "suspend failed\n");
> +
> +       amd_pmc_dump_registers(pdev);
> +
> +       return 0;
> +}
> +
> +static int amd_pmc_resume(struct device *dev)
> +{
> +       struct amd_pmc_dev *pdev = dev_get_drvdata(dev);

> +       int rc = 0;

Ditto.

> +       rc = amd_pmc_send_cmd(pdev, 0, 0);
> +       if (rc)
> +               dev_err(pdev->dev, "resume failed\n");
> +
> +       amd_pmc_dump_registers(pdev);
> +
> +       return 0;
> +}
> +#endif

...

> +       rdev = pci_get_domain_bus_and_slot(0, 0, PCI_DEVFN(0, 0));
> +       if (!rdev || (!(rdev->vendor == PCI_VENDOR_ID_AMD) &&
> +                     (rdev->device == AMD_CPU_ID_PCO ||
> +                       rdev->device == AMD_CPU_ID_RN))) {
> +               return -ENODEV;
> +       }

Can you rather create an additional PCI ID table and simple use pci_match_id()?

> +       err = pci_write_config_dword(rdev, AMD_PMC_SMU_INDEX_ADDRESS, AMD_PMC_BASE_ADDR_LO);
> +       if (err) {
> +               dev_err(dev->dev, "error writing to 0x%x\n", AMD_PMC_SMU_INDEX_ADDRESS);
> +               return err;
> +       }

Returning positive error codes?!

...

> +       dev->smu_base = ioremap(base_addr, AMD_PMC_MAPPING_SIZE);

devm_ioremap()?

> +       if (!dev->smu_base)
> +               return -ENOMEM;
> +
> +       dev->regbase = ioremap(base_addr + AMD_PMC_BASE_ADDR_OFFSET, AMD_PMC_MAPPING_SIZE);

Ditto.

> +       if (!dev->regbase) {
> +               iounmap(dev->smu_base);
> +               return -ENOMEM;
> +       }

...

> +               .acpi_match_table = ACPI_PTR(amd_pmc_acpi_ids),

It depends on ACPI. What is the point of ACPI_PTR?

...

> +

Redundant blank line

> +module_platform_driver(amd_pmc_driver);

...

> +++ b/drivers/platform/x86/amd-pmc.h

Who is going to use this file?

...

> +#define AMD_PMC_BASE_ADDR_HI_MASK      0xFFF00000L
> +#define AMD_PMC_BASE_ADDR_LO_MASK      0x0000FFFFL

You included bits.h and not using it, why?

...

> +#define PMC_MSG_DELAY_MIN              100
> +#define PMC_MSG_DELAY_MAX              200

Units?

...

> +enum amd_pmc_def {
> +       msg_test = 0x01,
> +       msg_os_hint_pco,
> +       msg_os_hint_rn,
> +};

Hmm... Perhaps capital letters?
Shyam Sundar S K Nov. 4, 2020, 3:34 p.m. UTC | #4
Hi Andy,

On 11/4/2020 4:19 AM, Andy Shevchenko wrote:
> [CAUTION: External Email]
> 
> On Thu, Oct 29, 2020 at 10:57 AM Shyam Sundar S K
> <Shyam-sundar.S-k@amd.com> wrote:
>>
>> AMD Power Management Controller driver aka. amd-pmc driver is the
> 
> aka. -> a.k.a. or AKA
> 
>> controller which is meant for final S2Idle transaction that goes to the
> 
> for the final
> 
>> PMFW running on the AMD SMU (System Management Unit) responsible for
>> tuning of the VDD.
>>
>> Once all the monitored list or the idle constraints are met, this driver
>> would go and set the OS_HINT (meaning all the devices have reached to
>> their lowest state possible) via the SMU mailboxes.
>>
>> This driver would also provide some debug capabilities via debugfs.
> 
> ...
> 
>> +F:     drivers/platform/x86/amd-pmc.c
>> +F:     drivers/platform/x86/amd-pmc.h
> 
> Can be one entry.
> 
I have addressed the comments. can you please review it again?

- Shyam
diff mbox series

Patch

diff --git a/MAINTAINERS b/MAINTAINERS
index e2a8ad69c262..95374000044d 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -929,6 +929,13 @@  L:	linux-i2c@vger.kernel.org
 S:	Maintained
 F:	drivers/i2c/busses/i2c-amd-mp2*
 
+AMD PMC DRIVER
+M:	Shyam Sundar S K <Shyam-sundar.S-k@amd.com>
+L:	platform-driver-x86@vger.kernel.org
+S:	Maintained
+F:	drivers/platform/x86/amd-pmc.c
+F:	drivers/platform/x86/amd-pmc.h
+
 AMD POWERPLAY
 M:	Evan Quan <evan.quan@amd.com>
 L:	amd-gfx@lists.freedesktop.org
diff --git a/drivers/platform/x86/Kconfig b/drivers/platform/x86/Kconfig
index 0d91d136bc3b..665ba3264374 100644
--- a/drivers/platform/x86/Kconfig
+++ b/drivers/platform/x86/Kconfig
@@ -180,6 +180,15 @@  config ACER_WMI
 	  If you have an ACPI-WMI compatible Acer/ Wistron laptop, say Y or M
 	  here.
 
+config AMD_PMC
+	tristate "AMD SoC PMC driver"
+	depends on ACPI && PCI
+	help
+	  The driver provides support for AMD Power Management Controller
+	  primarily responsible for S2Idle transactions that are driven from
+	  a platform firmware running on SMU. This driver also provides debug
+	  mechanism to investigate the S2Idle transactions and failures.
+
 config APPLE_GMUX
 	tristate "Apple Gmux Driver"
 	depends on ACPI && PCI
diff --git a/drivers/platform/x86/Makefile b/drivers/platform/x86/Makefile
index 5f823f7eff45..48203e87240c 100644
--- a/drivers/platform/x86/Makefile
+++ b/drivers/platform/x86/Makefile
@@ -22,6 +22,9 @@  obj-$(CONFIG_ACERHDF)		+= acerhdf.o
 obj-$(CONFIG_ACER_WIRELESS)	+= acer-wireless.o
 obj-$(CONFIG_ACER_WMI)		+= acer-wmi.o
 
+# AMD
+obj-$(CONFIG_AMD_PMC)		+= amd-pmc.o
+
 # Apple
 obj-$(CONFIG_APPLE_GMUX)	+= apple-gmux.o
 
diff --git a/drivers/platform/x86/amd-pmc.c b/drivers/platform/x86/amd-pmc.c
new file mode 100644
index 000000000000..8da4efeefb19
--- /dev/null
+++ b/drivers/platform/x86/amd-pmc.c
@@ -0,0 +1,274 @@ 
+// SPDX-License-Identifier: GPL-2.0-or-later
+/*
+ * AMD SoC Power Management Controller Driver
+ *
+ * Copyright (c) 2020, Advanced Micro Devices, Inc.
+ * All Rights Reserved.
+ *
+ * Author: Shyam Sundar S K <Shyam-sundar.S-k@amd.com>
+ */
+
+#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
+
+#include <linux/acpi.h>
+#include <linux/bitfield.h>
+#include <linux/debugfs.h>
+#include <linux/delay.h>
+#include <linux/io.h>
+#include <linux/module.h>
+#include <linux/pci.h>
+#include <linux/platform_device.h>
+#include <linux/suspend.h>
+#include <linux/seq_file.h>
+#include <linux/uaccess.h>
+
+#include "amd-pmc.h"
+
+static struct amd_pmc_dev pmc;
+
+static inline u32 amd_pmc_reg_read(struct amd_pmc_dev *dev, int reg_offset)
+{
+	return ioread32(dev->regbase + reg_offset);
+}
+
+static inline void amd_pmc_reg_write(struct amd_pmc_dev *dev, int reg_offset, u32 val)
+{
+	iowrite32(val, dev->regbase + reg_offset);
+}
+
+#if CONFIG_DEBUG_FS
+static int smu_fw_info_show(struct seq_file *s, void *unused)
+{
+	struct amd_pmc_dev *dev = s->private;
+	unsigned int value;
+
+	value = ioread32(dev->smu_base + AMD_SMU_FW_VERSION);
+	seq_printf(s, "SMU FW Info: %x\n", value);
+	return 0;
+}
+DEFINE_SHOW_ATTRIBUTE(smu_fw_info);
+
+static void amd_pmc_dbgfs_unregister(struct amd_pmc_dev *dev)
+{
+	debugfs_remove_recursive(dev->dbgfs_dir);
+}
+
+static void amd_pmc_dbgfs_register(struct amd_pmc_dev *dev)
+{
+	struct dentry *dir;
+
+	dir = debugfs_create_dir("amd_pmc", NULL);
+	dev->dbgfs_dir = dir;
+	debugfs_create_file("smu_fw_info", 0644, dir, dev, &smu_fw_info_fops);
+}
+
+#else
+static inline void amd_pmc_dbgfs_register(struct amd_pmc_dev *dev)
+{
+}
+
+static inline void amd_pmc_dbgfs_unregister(struct amd_pmc_dev *dev)
+{
+}
+#endif /* CONFIG_DEBUG_FS */
+
+static void amd_pmc_dump_registers(struct amd_pmc_dev *dev)
+{
+	u32 value;
+
+	value = amd_pmc_reg_read(dev, AMD_PMC_REGISTER_RESPONSE);
+	dev_dbg(dev->dev, "AMD_PMC_REGISTER_RESPONSE:%x\n", value);
+
+	value = amd_pmc_reg_read(dev, AMD_PMC_REGISTER_ARGUMENT);
+	dev_dbg(dev->dev, "AMD_PMC_REGISTER_ARGUMENT:%x\n", value);
+
+	value = amd_pmc_reg_read(dev, AMD_PMC_REGISTER_MESSAGE);
+	dev_dbg(dev->dev, "AMD_PMC_REGISTER_MESSAGE:%x\n", value);
+}
+
+static int amd_pmc_poll_smu_response(struct amd_pmc_dev *dev)
+{
+	int rc = 0, index;
+
+	for (index = 0; index < RESPONSE_REGISTER_LOOP_MAX; index++) {
+		rc = amd_pmc_reg_read(dev, AMD_PMC_REGISTER_RESPONSE);
+		if (rc != 0)
+			break;
+
+		usleep_range(PMC_MSG_DELAY_MIN, PMC_MSG_DELAY_MAX);
+	}
+
+	return rc;
+}
+
+static int amd_pmc_send_cmd(struct amd_pmc_dev *dev, bool set, int arg)
+{
+	int rc = 0;
+	u8 msg;
+
+	/* Wait until the response register is non-zero */
+	rc = amd_pmc_poll_smu_response(dev);
+	if (!rc) {
+		dev_err(dev->dev, "failed to talk to SMU\n");
+		return -EIO;
+	}
+
+	/* Write zero to response register */
+	amd_pmc_reg_write(dev, AMD_PMC_REGISTER_RESPONSE, 0);
+
+	/* Write argument into response register */
+	amd_pmc_reg_write(dev, AMD_PMC_REGISTER_ARGUMENT, set);
+
+	/* Write message ID to message ID register */
+	msg = (dev->cpu_id == AMD_CPU_ID_RN) ? msg_os_hint_rn : msg_os_hint_pco;
+	amd_pmc_reg_write(dev, AMD_PMC_REGISTER_MESSAGE, msg);
+
+	if (arg) {
+		/* Wait until the response register is non-zero */
+		rc = amd_pmc_poll_smu_response(dev);
+		if (!rc) {
+			dev_err(dev->dev, "failed to talk to SMU\n");
+			return -EIO;
+		}
+		/* If message register is OK, then SMU has finished processing
+		 * the message, and then read back from AMD_PMC_REGISTER_ARGUMENT
+		 */
+		rc = amd_pmc_reg_read(dev, AMD_PMC_REGISTER_ARGUMENT);
+	}
+
+	return 0;
+}
+
+#ifdef CONFIG_PM_SLEEP
+static int amd_pmc_suspend(struct device *dev)
+{
+	struct amd_pmc_dev *pdev = dev_get_drvdata(dev);
+	int rc = 0;
+
+	rc = amd_pmc_send_cmd(pdev, 1, 0);
+	if (rc)
+		dev_err(pdev->dev, "suspend failed\n");
+
+	amd_pmc_dump_registers(pdev);
+
+	return 0;
+}
+
+static int amd_pmc_resume(struct device *dev)
+{
+	struct amd_pmc_dev *pdev = dev_get_drvdata(dev);
+	int rc = 0;
+
+	rc = amd_pmc_send_cmd(pdev, 0, 0);
+	if (rc)
+		dev_err(pdev->dev, "resume failed\n");
+
+	amd_pmc_dump_registers(pdev);
+
+	return 0;
+}
+#endif
+
+static const struct dev_pm_ops amd_pmc_pm_ops = {
+	SET_NOIRQ_SYSTEM_SLEEP_PM_OPS(amd_pmc_suspend, amd_pmc_resume)
+};
+
+static int amd_pmc_probe(struct platform_device *pdev)
+{
+	struct amd_pmc_dev *dev = &pmc;
+	struct pci_dev *rdev;
+	u32 base_addr_lo;
+	u32 base_addr_hi;
+	u64 base_addr;
+	int err = 0;
+	u32 val;
+
+	dev->dev = &pdev->dev;
+
+	rdev = pci_get_domain_bus_and_slot(0, 0, PCI_DEVFN(0, 0));
+	if (!rdev || (!(rdev->vendor == PCI_VENDOR_ID_AMD) &&
+		      (rdev->device == AMD_CPU_ID_PCO ||
+			rdev->device == AMD_CPU_ID_RN))) {
+		return -ENODEV;
+	}
+
+	dev->cpu_id = rdev->device;
+	err = pci_write_config_dword(rdev, AMD_PMC_SMU_INDEX_ADDRESS, AMD_PMC_BASE_ADDR_LO);
+	if (err) {
+		dev_err(dev->dev, "error writing to 0x%x\n", AMD_PMC_SMU_INDEX_ADDRESS);
+		return err;
+	}
+
+	err = pci_read_config_dword(rdev, AMD_PMC_SMU_INDEX_DATA, &val);
+	if (err) {
+		dev_err(dev->dev, "error reading from 0x%x\n", AMD_PMC_SMU_INDEX_ADDRESS);
+		return err;
+	}
+
+	base_addr_lo = val & AMD_PMC_BASE_ADDR_HI_MASK;
+
+	err = pci_write_config_dword(rdev, AMD_PMC_SMU_INDEX_ADDRESS, AMD_PMC_BASE_ADDR_HI);
+	if (err) {
+		dev_err(dev->dev, "error writing to 0x%x\n", AMD_PMC_SMU_INDEX_ADDRESS);
+		return err;
+	}
+
+	err = pci_read_config_dword(rdev, AMD_PMC_SMU_INDEX_DATA, &val);
+	if (err) {
+		dev_err(dev->dev, "error reading from 0x%x\n", AMD_PMC_SMU_INDEX_ADDRESS);
+		return err;
+	}
+
+	base_addr_hi = val & AMD_PMC_BASE_ADDR_LO_MASK;
+	pci_dev_put(rdev);
+	base_addr = ((u64)base_addr_hi << 32 | base_addr_lo);
+
+	dev->smu_base = ioremap(base_addr, AMD_PMC_MAPPING_SIZE);
+	if (!dev->smu_base)
+		return -ENOMEM;
+
+	dev->regbase = ioremap(base_addr + AMD_PMC_BASE_ADDR_OFFSET, AMD_PMC_MAPPING_SIZE);
+	if (!dev->regbase) {
+		iounmap(dev->smu_base);
+		return -ENOMEM;
+	}
+
+	amd_pmc_dump_registers(dev);
+
+	platform_set_drvdata(pdev, dev);
+	amd_pmc_dbgfs_register(dev);
+
+	return 0;
+}
+
+static int amd_pmc_remove(struct platform_device *pdev)
+{
+	struct amd_pmc_dev *dev = platform_get_drvdata(pdev);
+
+	amd_pmc_dbgfs_unregister(dev);
+	iounmap(dev->regbase);
+	iounmap(dev->smu_base);
+	return 0;
+}
+
+static const struct acpi_device_id amd_pmc_acpi_ids[] = {
+	{"AMDI0005", 0},
+	{"AMD0004", 0},
+	{ }
+};
+MODULE_DEVICE_TABLE(acpi, amd_pmc_acpi_ids);
+
+static struct platform_driver amd_pmc_driver = {
+	.driver = {
+		.name = "amd_pmc",
+		.acpi_match_table = ACPI_PTR(amd_pmc_acpi_ids),
+		.pm = &amd_pmc_pm_ops,
+	},
+	.probe = amd_pmc_probe,
+	.remove = amd_pmc_remove,
+};
+
+module_platform_driver(amd_pmc_driver);
+
+MODULE_LICENSE("GPL v2");
+MODULE_DESCRIPTION("AMD PMC Driver");
diff --git a/drivers/platform/x86/amd-pmc.h b/drivers/platform/x86/amd-pmc.h
new file mode 100644
index 000000000000..8cd7821af505
--- /dev/null
+++ b/drivers/platform/x86/amd-pmc.h
@@ -0,0 +1,64 @@ 
+/* SPDX-License-Identifier: GPL-2.0-or-later */
+/*
+ * AMD SoC Power Management Controller Driver
+ *
+ * Copyright (c) 2020, Advanced Micro Devices, Inc.
+ * All Rights Reserved.
+ *
+ * Author: Shyam Sundar S K <Shyam-sundar.S-k@amd.com>
+ */
+
+#ifndef AMD_PMC_H
+#define AMD_PMC_H
+
+#include <linux/bits.h>
+
+/* SMU Communcation Registers */
+#define AMD_PMC_REGISTER_RESPONSE	0x980
+#define AMD_PMC_REGISTER_ARGUMENT	0x9BC
+#define AMD_PMC_REGISTER_MESSAGE	0x538
+
+/* Base address of SMU for mapping physical address to virtual address */
+#define AMD_PMC_BASE_ADDR_LO		0x13B102E8
+#define AMD_PMC_BASE_ADDR_HI		0x13B102EC
+#define AMD_PMC_BASE_ADDR_HI_MASK	0xFFF00000L
+#define AMD_PMC_BASE_ADDR_LO_MASK	0x0000FFFFL
+#define AMD_PMC_BASE_ADDR_OFFSET	0x10000
+#define AMD_PMC_MAPPING_SIZE		0x01000
+#define AMD_PMC_SMU_INDEX_ADDRESS	0xB8
+#define AMD_PMC_SMU_INDEX_DATA		0xBC
+
+/* SMU Response Codes */
+#define AMD_PMC_RESULT_OK                    0x1
+#define AMD_PMC_RESULT_FAILED                0xFF
+#define AMD_PMC_RESULT_CMD_UNKNOWN           0xFE
+#define AMD_PMC_RESULT_CMD_REJECT_PREREQ     0xFD
+#define AMD_PMC_RESULT_CMD_REJECT_BUSY       0xFC
+
+#define PMC_MSG_DELAY_MIN		100
+#define PMC_MSG_DELAY_MAX		200
+#define AMD_CPU_ID_RV			0x15d0
+#define AMD_CPU_ID_PCO			AMD_CPU_ID_RV
+#define AMD_CPU_ID_RN			0x1630
+#define AMD_SMU_FW_VERSION		0x0
+
+#define RESPONSE_REGISTER_LOOP_MAX	20
+
+enum amd_pmc_def {
+	msg_test = 0x01,
+	msg_os_hint_pco,
+	msg_os_hint_rn,
+};
+
+struct amd_pmc_dev {
+	u32 base_addr;
+	u32 cpu_id;
+	void __iomem *regbase;
+	void __iomem *smu_base;
+	struct device *dev;
+#if IS_ENABLED(CONFIG_DEBUG_FS)
+	struct dentry *dbgfs_dir;
+#endif /* CONFIG_DEBUG_FS */
+};
+
+#endif /* AMD_PMC_H */