Skip to contentSkip to conversation

firmware: xilinx: Add missing debug firmware interfaces

PATCH Applied Ronak Jain 3 participants 3 messages Jul 30, 2024 – Sep 9, 2024 Arm/Zynq architecture

lore
Share & tools
lore

Ronak Jain

author
#0 lore raw

PATCH v2 1/1 firmware: xilinx: Add missing debug firmware interfaces

Add missing PM EEMI APIs interface in debug firmware driver.

The debugfs firmware driver interface is intended for testing and debugging the EEMI APIs only. This interface does not contain any checking regarding improper usage, and the number, type and valid ranges of the arguments. This interface must be used with a lot of care. In fact, accessing this interface during normal PM operation will very likely cause unexpected problems.

The debugfs interface shouldn't be used in the production system and hence it is disabled by default in defconfig.

---
Changes in v2:
- Address the compilation error

References to the public documents who talks about the debugfs interface.
https://xilinx-wiki.atlassian.net/wiki/spaces/A/pages/18842232/Zynq+UltraScale+MPSoC+Power+Management+-+Linux+Kernel#ZynqUltraScale%EF%BC%8BMPSoCPowerManagement-LinuxKernel-Debugfs

https://docs.amd.com/r/en-US/ug1137-zynq-ultrascale-mpsoc-swdev/Debug-Interface

---
 drivers/firmware/xilinx/zynqmp-debug.c | 162 ++++++++++++++++++++++++-
 include/linux/firmware/xlnx-zynqmp.h   |   4 +
 2 files changed, 165 insertions(+), 1 deletion(-)
drivers/firmware/xilinx/zynqmp-debug.c +161 -1
index 8528850af889..22853ae0efdf 100644
@@ -31,12 +31,50 @@ static char debugfs_buf[PAGE_SIZE];
 
 #define PM_API(id)		 {id, #id, strlen(#id)}
 static struct pm_api_info pm_api_list[] = {
+	PM_API(PM_FORCE_POWERDOWN),
+	PM_API(PM_REQUEST_WAKEUP),
+	PM_API(PM_SYSTEM_SHUTDOWN),
+	PM_API(PM_REQUEST_NODE),
+	PM_API(PM_RELEASE_NODE),
+	PM_API(PM_SET_REQUIREMENT),
 	PM_API(PM_GET_API_VERSION),
+	PM_API(PM_REGISTER_NOTIFIER),
+	PM_API(PM_RESET_ASSERT),
+	PM_API(PM_RESET_GET_STATUS),
+	PM_API(PM_GET_CHIPID),
+	PM_API(PM_PINCTRL_SET_FUNCTION),
+	PM_API(PM_PINCTRL_CONFIG_PARAM_GET),
+	PM_API(PM_PINCTRL_CONFIG_PARAM_SET),
+	PM_API(PM_IOCTL),
+	PM_API(PM_CLOCK_ENABLE),
+	PM_API(PM_CLOCK_DISABLE),
+	PM_API(PM_CLOCK_GETSTATE),
+	PM_API(PM_CLOCK_SETDIVIDER),
+	PM_API(PM_CLOCK_GETDIVIDER),
+	PM_API(PM_CLOCK_SETPARENT),
+	PM_API(PM_CLOCK_GETPARENT),
 	PM_API(PM_QUERY_DATA),
 };
 
 static struct dentry *firmware_debugfs_root;
 
+/**
+ * zynqmp_pm_ioctl - PM IOCTL for device control and configs
+ * @node:	Node ID of the device
+ * @ioctl:	ID of the requested IOCTL
+ * @arg1:	Argument 1 of requested IOCTL call
+ * @arg2:	Argument 2 of requested IOCTL call
+ * @arg3:	Argument 3 of requested IOCTL call
+ * @out:	Returned output value
+ *
+ * Return:	Returns status, either success or error+reason
+ */
+static int zynqmp_pm_ioctl(const u32 node, const u32 ioctl, const u32 arg1,
+			   const u32 arg2, const u32 arg3, u32 *out)
+{
+	return zynqmp_pm_invoke_fn(PM_IOCTL, out, 5, node, ioctl, arg1, arg2, arg3);
+}
+
 /**
  * zynqmp_pm_argument_value() - Extract argument value from a PM-API request
  * @arg:	Entered PM-API argument in string format
@@ -95,6 +133,128 @@ static int process_api_request(u32 pm_id, u64 *pm_api_arg, u32 *pm_api_ret)
 		sprintf(debugfs_buf, "PM-API Version = %d.%d\n",
 			pm_api_version >> 16, pm_api_version & 0xffff);
 		break;
+	case PM_FORCE_POWERDOWN:
+		ret = zynqmp_pm_force_pwrdwn(pm_api_arg[0],
+					     pm_api_arg[1] ? pm_api_arg[1] :
+					     ZYNQMP_PM_REQUEST_ACK_NO);
+		break;
+	case PM_REQUEST_WAKEUP:
+		ret = zynqmp_pm_request_wake(pm_api_arg[0],
+					     pm_api_arg[1], pm_api_arg[2],
+					     pm_api_arg[3] ? pm_api_arg[3] :
+					     ZYNQMP_PM_REQUEST_ACK_NO);
+		break;
+	case PM_SYSTEM_SHUTDOWN:
+		ret = zynqmp_pm_system_shutdown(pm_api_arg[0], pm_api_arg[1]);
+		break;
+	case PM_REQUEST_NODE:
+		ret = zynqmp_pm_request_node(pm_api_arg[0],
+					     pm_api_arg[1] ? pm_api_arg[1] :
+					     ZYNQMP_PM_CAPABILITY_ACCESS,
+					     pm_api_arg[2] ? pm_api_arg[2] : 0,
+					     pm_api_arg[3] ? pm_api_arg[3] :
+					     ZYNQMP_PM_REQUEST_ACK_BLOCKING);
+		break;
+	case PM_RELEASE_NODE:
+		ret = zynqmp_pm_release_node(pm_api_arg[0]);
+		break;
+	case PM_SET_REQUIREMENT:
+		ret = zynqmp_pm_set_requirement(pm_api_arg[0],
+						pm_api_arg[1] ? pm_api_arg[1] :
+						ZYNQMP_PM_CAPABILITY_CONTEXT,
+						pm_api_arg[2] ?
+						pm_api_arg[2] : 0,
+						pm_api_arg[3] ? pm_api_arg[3] :
+						ZYNQMP_PM_REQUEST_ACK_BLOCKING);
+		break;
+	case PM_REGISTER_NOTIFIER:
+		ret = zynqmp_pm_register_notifier(pm_api_arg[0],
+						  pm_api_arg[1] ?
+						  pm_api_arg[1] : 0,
+						  pm_api_arg[2] ?
+						  pm_api_arg[2] : 0,
+						  pm_api_arg[3] ?
+						  pm_api_arg[3] : 0);
+		break;
+	case PM_RESET_ASSERT:
+		ret = zynqmp_pm_reset_assert(pm_api_arg[0], pm_api_arg[1]);
+		break;
+	case PM_RESET_GET_STATUS:
+		ret = zynqmp_pm_reset_get_status(pm_api_arg[0], &pm_api_ret[0]);
+		if (!ret)
+			sprintf(debugfs_buf, "Reset status: %u\n",
+				pm_api_ret[0]);
+		break;
+	case PM_GET_CHIPID:
+		ret = zynqmp_pm_get_chipid(&pm_api_ret[0], &pm_api_ret[1]);
+		if (!ret)
+			sprintf(debugfs_buf, "Idcode: %#x, Version:%#x\n",
+				pm_api_ret[0], pm_api_ret[1]);
+		break;
+	case PM_PINCTRL_SET_FUNCTION:
+		ret = zynqmp_pm_pinctrl_set_function(pm_api_arg[0],
+						     pm_api_arg[1]);
+		break;
+	case PM_PINCTRL_CONFIG_PARAM_GET:
+		ret = zynqmp_pm_pinctrl_get_config(pm_api_arg[0], pm_api_arg[1],
+						   &pm_api_ret[0]);
+		if (!ret)
+			sprintf(debugfs_buf,
+				"Pin: %llu, Param: %llu, Value: %u\n",
+				pm_api_arg[0], pm_api_arg[1],
+				pm_api_ret[0]);
+		break;
+	case PM_PINCTRL_CONFIG_PARAM_SET:
+		ret = zynqmp_pm_pinctrl_set_config(pm_api_arg[0],
+						   pm_api_arg[1],
+						   pm_api_arg[2]);
+		break;
+	case PM_IOCTL:
+		ret = zynqmp_pm_ioctl(pm_api_arg[0], pm_api_arg[1],
+				      pm_api_arg[2], pm_api_arg[3],
+				      pm_api_arg[4], &pm_api_ret[0]);
+		if (!ret && (pm_api_arg[1] == IOCTL_GET_RPU_OPER_MODE ||
+			     pm_api_arg[1] == IOCTL_GET_PLL_FRAC_MODE ||
+			     pm_api_arg[1] == IOCTL_GET_PLL_FRAC_DATA ||
+			     pm_api_arg[1] == IOCTL_READ_GGS ||
+			     pm_api_arg[1] == IOCTL_READ_PGGS ||
+			     pm_api_arg[1] == IOCTL_READ_REG))
+			sprintf(debugfs_buf, "IOCTL return value: %u\n",
+				pm_api_ret[1]);
+		if (!ret && pm_api_arg[1] == IOCTL_GET_QOS)
+			sprintf(debugfs_buf, "Default QoS: %u\nCurrent QoS: %u\n",
+				pm_api_ret[1], pm_api_ret[2]);
+		break;
+	case PM_CLOCK_ENABLE:
+		ret = zynqmp_pm_clock_enable(pm_api_arg[0]);
+		break;
+	case PM_CLOCK_DISABLE:
+		ret = zynqmp_pm_clock_disable(pm_api_arg[0]);
+		break;
+	case PM_CLOCK_GETSTATE:
+		ret = zynqmp_pm_clock_getstate(pm_api_arg[0], &pm_api_ret[0]);
+		if (!ret)
+			sprintf(debugfs_buf, "Clock state: %u\n",
+				pm_api_ret[0]);
+		break;
+	case PM_CLOCK_SETDIVIDER:
+		ret = zynqmp_pm_clock_setdivider(pm_api_arg[0], pm_api_arg[1]);
+		break;
+	case PM_CLOCK_GETDIVIDER:
+		ret = zynqmp_pm_clock_getdivider(pm_api_arg[0], &pm_api_ret[0]);
+		if (!ret)
+			sprintf(debugfs_buf, "Divider Value: %d\n",
+				pm_api_ret[0]);
+		break;
+	case PM_CLOCK_SETPARENT:
+		ret = zynqmp_pm_clock_setparent(pm_api_arg[0], pm_api_arg[1]);
+		break;
+	case PM_CLOCK_GETPARENT:
+		ret = zynqmp_pm_clock_getparent(pm_api_arg[0], &pm_api_ret[0]);
+		if (!ret)
+			sprintf(debugfs_buf,
+				"Clock parent Index: %u\n", pm_api_ret[0]);
+		break;
 	case PM_QUERY_DATA:
 		qdata.qid = pm_api_arg[0];
 		qdata.arg1 = pm_api_arg[1];
@@ -150,7 +310,7 @@ static ssize_t zynqmp_pm_debugfs_api_write(struct file *file,
 	char *kern_buff, *tmp_buff;
 	char *pm_api_req;
 	u32 pm_id = 0;
-	u64 pm_api_arg[4] = {0, 0, 0, 0};
+	u64 pm_api_arg[5] = {0, 0, 0, 0, 0};
 	/* Return values from PM APIs calls */
 	u32 pm_api_ret[4] = {0, 0, 0, 0};
 
include/linux/firmware/xlnx-zynqmp.h +4 -0
index d7d07afc0532..563382cf16f2 100644
@@ -218,9 +218,13 @@ enum pm_ioctl_id {
 	/* Runtime feature configuration */
 	IOCTL_SET_FEATURE_CONFIG = 26,
 	IOCTL_GET_FEATURE_CONFIG = 27,
+	/* IOCTL for Secure Read/Write Interface */
+	IOCTL_READ_REG = 28,
 	/* Dynamic SD/GEM configuration */
 	IOCTL_SET_SD_CONFIG = 30,
 	IOCTL_SET_GEM_CONFIG = 31,
+	/* IOCTL to get default/current QoS */
+	IOCTL_GET_QOS = 34,
 };
 
 enum pm_query_id {
Signature · 1 line
2.25.1
maintainer Applied
#1 lore raw

Hi,

Quoted 230 lines · Ronak Jain

Add missing PM EEMI APIs interface in debug firmware driver.

The debugfs firmware driver interface is intended for testing and debugging the EEMI APIs only. This interface does not contain any checking regarding improper usage, and the number, type and valid ranges of the arguments. This interface must be used with a lot of care. In fact, accessing this interface during normal PM operation will very likely cause unexpected problems.

The debugfs interface shouldn't be used in the production system and hence it is disabled by default in defconfig.

---
Changes in v2:
- Address the compilation error

References to the public documents who talks about the debugfs interface.
https://xilinx-wiki.atlassian.net/wiki/spaces/A/pages/18842232/Zynq+UltraScale+MPSoC+Power+Management+-+Linux+Kernel#ZynqUltraScale%EF%BC%8BMPSoCPowerManagement-LinuxKernel-Debugfs

https://docs.amd.com/r/en-US/ug1137-zynq-ultrascale-mpsoc-swdev/Debug-Interface

---
  drivers/firmware/xilinx/zynqmp-debug.c | 162 ++++++++++++++++++++++++-
  include/linux/firmware/xlnx-zynqmp.h   |   4 +
  2 files changed, 165 insertions(+), 1 deletion(-)
drivers/firmware/xilinx/zynqmp-debug.c +161 -1
index 8528850af889..22853ae0efdf 100644
@@ -31,12 +31,50 @@ static char debugfs_buf[PAGE_SIZE];
 
  #define PM_API(id)		 {id, #id, strlen(#id)}
  static struct pm_api_info pm_api_list[] = {
+	PM_API(PM_FORCE_POWERDOWN),
+	PM_API(PM_REQUEST_WAKEUP),
+	PM_API(PM_SYSTEM_SHUTDOWN),
+	PM_API(PM_REQUEST_NODE),
+	PM_API(PM_RELEASE_NODE),
+	PM_API(PM_SET_REQUIREMENT),
  	PM_API(PM_GET_API_VERSION),
+	PM_API(PM_REGISTER_NOTIFIER),
+	PM_API(PM_RESET_ASSERT),
+	PM_API(PM_RESET_GET_STATUS),
+	PM_API(PM_GET_CHIPID),
+	PM_API(PM_PINCTRL_SET_FUNCTION),
+	PM_API(PM_PINCTRL_CONFIG_PARAM_GET),
+	PM_API(PM_PINCTRL_CONFIG_PARAM_SET),
+	PM_API(PM_IOCTL),
+	PM_API(PM_CLOCK_ENABLE),
+	PM_API(PM_CLOCK_DISABLE),
+	PM_API(PM_CLOCK_GETSTATE),
+	PM_API(PM_CLOCK_SETDIVIDER),
+	PM_API(PM_CLOCK_GETDIVIDER),
+	PM_API(PM_CLOCK_SETPARENT),
+	PM_API(PM_CLOCK_GETPARENT),
  	PM_API(PM_QUERY_DATA),
  };
 
  static struct dentry *firmware_debugfs_root;
 
+/**
+ * zynqmp_pm_ioctl - PM IOCTL for device control and configs
+ * @node:	Node ID of the device
+ * @ioctl:	ID of the requested IOCTL
+ * @arg1:	Argument 1 of requested IOCTL call
+ * @arg2:	Argument 2 of requested IOCTL call
+ * @arg3:	Argument 3 of requested IOCTL call
+ * @out:	Returned output value
+ *
+ * Return:	Returns status, either success or error+reason
+ */
+static int zynqmp_pm_ioctl(const u32 node, const u32 ioctl, const u32 arg1,
+			   const u32 arg2, const u32 arg3, u32 *out)
+{
+	return zynqmp_pm_invoke_fn(PM_IOCTL, out, 5, node, ioctl, arg1, arg2, arg3);
+}
+
  /**
   * zynqmp_pm_argument_value() - Extract argument value from a PM-API request
   * @arg:	Entered PM-API argument in string format
@@ -95,6 +133,128 @@ static int process_api_request(u32 pm_id, u64 *pm_api_arg, u32 *pm_api_ret)
  		sprintf(debugfs_buf, "PM-API Version = %d.%d\n",
  			pm_api_version >> 16, pm_api_version & 0xffff);
  		break;
+	case PM_FORCE_POWERDOWN:
+		ret = zynqmp_pm_force_pwrdwn(pm_api_arg[0],
+					     pm_api_arg[1] ? pm_api_arg[1] :
+					     ZYNQMP_PM_REQUEST_ACK_NO);
+		break;
+	case PM_REQUEST_WAKEUP:
+		ret = zynqmp_pm_request_wake(pm_api_arg[0],
+					     pm_api_arg[1], pm_api_arg[2],
+					     pm_api_arg[3] ? pm_api_arg[3] :
+					     ZYNQMP_PM_REQUEST_ACK_NO);
+		break;
+	case PM_SYSTEM_SHUTDOWN:
+		ret = zynqmp_pm_system_shutdown(pm_api_arg[0], pm_api_arg[1]);
+		break;
+	case PM_REQUEST_NODE:
+		ret = zynqmp_pm_request_node(pm_api_arg[0],
+					     pm_api_arg[1] ? pm_api_arg[1] :
+					     ZYNQMP_PM_CAPABILITY_ACCESS,
+					     pm_api_arg[2] ? pm_api_arg[2] : 0,
+					     pm_api_arg[3] ? pm_api_arg[3] :
+					     ZYNQMP_PM_REQUEST_ACK_BLOCKING);
+		break;
+	case PM_RELEASE_NODE:
+		ret = zynqmp_pm_release_node(pm_api_arg[0]);
+		break;
+	case PM_SET_REQUIREMENT:
+		ret = zynqmp_pm_set_requirement(pm_api_arg[0],
+						pm_api_arg[1] ? pm_api_arg[1] :
+						ZYNQMP_PM_CAPABILITY_CONTEXT,
+						pm_api_arg[2] ?
+						pm_api_arg[2] : 0,
+						pm_api_arg[3] ? pm_api_arg[3] :
+						ZYNQMP_PM_REQUEST_ACK_BLOCKING);
+		break;
+	case PM_REGISTER_NOTIFIER:
+		ret = zynqmp_pm_register_notifier(pm_api_arg[0],
+						  pm_api_arg[1] ?
+						  pm_api_arg[1] : 0,
+						  pm_api_arg[2] ?
+						  pm_api_arg[2] : 0,
+						  pm_api_arg[3] ?
+						  pm_api_arg[3] : 0);
+		break;
+	case PM_RESET_ASSERT:
+		ret = zynqmp_pm_reset_assert(pm_api_arg[0], pm_api_arg[1]);
+		break;
+	case PM_RESET_GET_STATUS:
+		ret = zynqmp_pm_reset_get_status(pm_api_arg[0], &pm_api_ret[0]);
+		if (!ret)
+			sprintf(debugfs_buf, "Reset status: %u\n",
+				pm_api_ret[0]);
+		break;
+	case PM_GET_CHIPID:
+		ret = zynqmp_pm_get_chipid(&pm_api_ret[0], &pm_api_ret[1]);
+		if (!ret)
+			sprintf(debugfs_buf, "Idcode: %#x, Version:%#x\n",
+				pm_api_ret[0], pm_api_ret[1]);
+		break;
+	case PM_PINCTRL_SET_FUNCTION:
+		ret = zynqmp_pm_pinctrl_set_function(pm_api_arg[0],
+						     pm_api_arg[1]);
+		break;
+	case PM_PINCTRL_CONFIG_PARAM_GET:
+		ret = zynqmp_pm_pinctrl_get_config(pm_api_arg[0], pm_api_arg[1],
+						   &pm_api_ret[0]);
+		if (!ret)
+			sprintf(debugfs_buf,
+				"Pin: %llu, Param: %llu, Value: %u\n",
+				pm_api_arg[0], pm_api_arg[1],
+				pm_api_ret[0]);
+		break;
+	case PM_PINCTRL_CONFIG_PARAM_SET:
+		ret = zynqmp_pm_pinctrl_set_config(pm_api_arg[0],
+						   pm_api_arg[1],
+						   pm_api_arg[2]);
+		break;
+	case PM_IOCTL:
+		ret = zynqmp_pm_ioctl(pm_api_arg[0], pm_api_arg[1],
+				      pm_api_arg[2], pm_api_arg[3],
+				      pm_api_arg[4], &pm_api_ret[0]);
+		if (!ret && (pm_api_arg[1] == IOCTL_GET_RPU_OPER_MODE ||
+			     pm_api_arg[1] == IOCTL_GET_PLL_FRAC_MODE ||
+			     pm_api_arg[1] == IOCTL_GET_PLL_FRAC_DATA ||
+			     pm_api_arg[1] == IOCTL_READ_GGS ||
+			     pm_api_arg[1] == IOCTL_READ_PGGS ||
+			     pm_api_arg[1] == IOCTL_READ_REG))
+			sprintf(debugfs_buf, "IOCTL return value: %u\n",
+				pm_api_ret[1]);
+		if (!ret && pm_api_arg[1] == IOCTL_GET_QOS)
+			sprintf(debugfs_buf, "Default QoS: %u\nCurrent QoS: %u\n",
+				pm_api_ret[1], pm_api_ret[2]);
+		break;
+	case PM_CLOCK_ENABLE:
+		ret = zynqmp_pm_clock_enable(pm_api_arg[0]);
+		break;
+	case PM_CLOCK_DISABLE:
+		ret = zynqmp_pm_clock_disable(pm_api_arg[0]);
+		break;
+	case PM_CLOCK_GETSTATE:
+		ret = zynqmp_pm_clock_getstate(pm_api_arg[0], &pm_api_ret[0]);
+		if (!ret)
+			sprintf(debugfs_buf, "Clock state: %u\n",
+				pm_api_ret[0]);
+		break;
+	case PM_CLOCK_SETDIVIDER:
+		ret = zynqmp_pm_clock_setdivider(pm_api_arg[0], pm_api_arg[1]);
+		break;
+	case PM_CLOCK_GETDIVIDER:
+		ret = zynqmp_pm_clock_getdivider(pm_api_arg[0], &pm_api_ret[0]);
+		if (!ret)
+			sprintf(debugfs_buf, "Divider Value: %d\n",
+				pm_api_ret[0]);
+		break;
+	case PM_CLOCK_SETPARENT:
+		ret = zynqmp_pm_clock_setparent(pm_api_arg[0], pm_api_arg[1]);
+		break;
+	case PM_CLOCK_GETPARENT:
+		ret = zynqmp_pm_clock_getparent(pm_api_arg[0], &pm_api_ret[0]);
+		if (!ret)
+			sprintf(debugfs_buf,
+				"Clock parent Index: %u\n", pm_api_ret[0]);
+		break;
  	case PM_QUERY_DATA:
  		qdata.qid = pm_api_arg[0];
  		qdata.arg1 = pm_api_arg[1];
@@ -150,7 +310,7 @@ static ssize_t zynqmp_pm_debugfs_api_write(struct file *file,
  	char *kern_buff, *tmp_buff;
  	char *pm_api_req;
  	u32 pm_id = 0;
-	u64 pm_api_arg[4] = {0, 0, 0, 0};
+	u64 pm_api_arg[5] = {0, 0, 0, 0, 0};
  	/* Return values from PM APIs calls */
  	u32 pm_api_ret[4] = {0, 0, 0, 0};
 
include/linux/firmware/xlnx-zynqmp.h +0 -0
index d7d07afc0532..563382cf16f2 100644
@@ -218,9 +218,13 @@ enum pm_ioctl_id {
  	/* Runtime feature configuration */
  	IOCTL_SET_FEATURE_CONFIG = 26,
  	IOCTL_GET_FEATURE_CONFIG = 27,

include/linux/firmware/xlnx-zynqmp.h enum pm_ioctl_id { · line 230

Quoted 10 lines
include/linux/firmware/xlnx-zynqmp.h +4 -0
+	/* IOCTL for Secure Read/Write Interface */
+	IOCTL_READ_REG = 28,
  	/* Dynamic SD/GEM configuration */
  	IOCTL_SET_SD_CONFIG = 30,
  	IOCTL_SET_GEM_CONFIG = 31,
+	/* IOCTL to get default/current QoS */
+	IOCTL_GET_QOS = 34,
  };
 
  enum pm_query_id {

Applied.
M

#2 lore raw

LGTM

Best regards,
Senthil

Quoted 274 lines

-----Original Message-----
From: linux-arm-kernel <[email protected]> On Behalf Of Michal Simek
Sent: Monday, September 2, 2024 12:07 AM
To: Jain, Ronak <[email protected]>
Cc: [email protected]; [email protected]
Subject: Re: [PATCH v2] firmware: xilinx: Add missing debug firmware interfaces

Caution: This message originated from an External Source. Use proper caution when opening attachments, clicking links, or responding.

Hi,

Quoted 15 lines · Ronak Jain

Add missing PM EEMI APIs interface in debug firmware driver.

The debugfs firmware driver interface is intended for testing and debugging the EEMI APIs only. This interface does not contain any checking regarding improper usage, and the number, type and valid ranges of the arguments. This interface must be used with a lot of care. In fact, accessing this interface during normal PM operation will very likely cause unexpected problems.

The debugfs interface shouldn't be used in the production system and hence it is disabled by default in defconfig.

Quoted 8 lines

---
Changes in v2:
- Address the compilation error

References to the public documents who talks about the debugfs interface.
https://xilinx-wiki.atlassian.net/wiki/spaces/A/pages/18842232/Zynq+Ul
traScale+MPSoC+Power+Management+-

+Linux+Kernel#ZynqUltraScale%EF%BC%8B

Quoted 3 lines

MPSoCPowerManagement-LinuxKernel-Debugfs

https://docs.amd.com/r/en-US/ug1137-zynq-ultrascale-mpsoc-

swdev/Debug-

Quoted 3 lines

Interface

---
  drivers/firmware/xilinx/zynqmp-debug.c | 162

++++++++++++++++++++++++-

Quoted 41 lines
  include/linux/firmware/xlnx-zynqmp.h   |   4 +
  2 files changed, 165 insertions(+), 1 deletion(-)
drivers/firmware/xilinx/zynqmp-debug.c +23 -0
index 8528850af889..22853ae0efdf 100644
@@ -31,12 +31,50 @@ static char debugfs_buf[PAGE_SIZE];
 
  #define PM_API(id)           {id, #id, strlen(#id)}
  static struct pm_api_info pm_api_list[] = {
+     PM_API(PM_FORCE_POWERDOWN),
+     PM_API(PM_REQUEST_WAKEUP),
+     PM_API(PM_SYSTEM_SHUTDOWN),
+     PM_API(PM_REQUEST_NODE),
+     PM_API(PM_RELEASE_NODE),
+     PM_API(PM_SET_REQUIREMENT),
      PM_API(PM_GET_API_VERSION),
+     PM_API(PM_REGISTER_NOTIFIER),
+     PM_API(PM_RESET_ASSERT),
+     PM_API(PM_RESET_GET_STATUS),
+     PM_API(PM_GET_CHIPID),
+     PM_API(PM_PINCTRL_SET_FUNCTION),
+     PM_API(PM_PINCTRL_CONFIG_PARAM_GET),
+     PM_API(PM_PINCTRL_CONFIG_PARAM_SET),
+     PM_API(PM_IOCTL),
+     PM_API(PM_CLOCK_ENABLE),
+     PM_API(PM_CLOCK_DISABLE),
+     PM_API(PM_CLOCK_GETSTATE),
+     PM_API(PM_CLOCK_SETDIVIDER),
+     PM_API(PM_CLOCK_GETDIVIDER),
+     PM_API(PM_CLOCK_SETPARENT),
+     PM_API(PM_CLOCK_GETPARENT),
      PM_API(PM_QUERY_DATA),
  };
 
  static struct dentry *firmware_debugfs_root;
 
+/**
+ * zynqmp_pm_ioctl - PM IOCTL for device control and configs

drivers/firmware/xilinx/zynqmp-debug.c static char debugfs_buf[PAGE_SIZE]; · line 72

Quoted 10 lines
drivers/firmware/xilinx/zynqmp-debug.c +10 -0
+ * @node:    Node ID of the device
+ * @ioctl:   ID of the requested IOCTL
+ * @arg1:    Argument 1 of requested IOCTL call
+ * @arg2:    Argument 2 of requested IOCTL call
+ * @arg3:    Argument 3 of requested IOCTL call
+ * @out:     Returned output value
+ *
+ * Return:   Returns status, either success or error+reason
+ */
+static int zynqmp_pm_ioctl(const u32 node, const u32 ioctl, const u32

arg1,

drivers/firmware/xilinx/zynqmp-debug.c static char debugfs_buf[PAGE_SIZE]; · line 78

Quoted 6 lines
drivers/firmware/xilinx/zynqmp-debug.c +4 -0
+                        const u32 arg2, const u32 arg3, u32 *out) {
+     return zynqmp_pm_invoke_fn(PM_IOCTL, out, 5, node, ioctl, arg1,
+arg2, arg3); }
+
  /**
   * zynqmp_pm_argument_value() - Extract argument value from a PM-API

request

drivers/firmware/xilinx/zynqmp-debug.c static int process_api_request(u32 pm_id, u64

Quoted 2 lines
drivers/firmware/xilinx/zynqmp-debug.c +0 -0
   * @arg:    Entered PM-API argument in string format
@@ -95,6 +133,128 @@ static int process_api_request(u32 pm_id, u64

*pm_api_arg, u32 *pm_api_ret)

Quoted 6 lines
drivers/firmware/xilinx/zynqmp-debug.c +3 -0
              sprintf(debugfs_buf, "PM-API Version = %d.%d\n",
                      pm_api_version >> 16, pm_api_version & 0xffff);
              break;
+     case PM_FORCE_POWERDOWN:
+             ret = zynqmp_pm_force_pwrdwn(pm_api_arg[0],
+                                          pm_api_arg[1] ? pm_api_arg[1] :

drivers/firmware/xilinx/zynqmp-debug.c static int process_api_request(u32 pm_id, u64 *pm_api_arg, u32 *pm_api_ret)

Quoted 10 lines
drivers/firmware/xilinx/zynqmp-debug.c +10 -0
+                                          ZYNQMP_PM_REQUEST_ACK_NO);
+             break;
+     case PM_REQUEST_WAKEUP:
+             ret = zynqmp_pm_request_wake(pm_api_arg[0],
+                                          pm_api_arg[1], pm_api_arg[2],
+                                          pm_api_arg[3] ? pm_api_arg[3] :
+                                          ZYNQMP_PM_REQUEST_ACK_NO);
+             break;
+     case PM_SYSTEM_SHUTDOWN:
+             ret = zynqmp_pm_system_shutdown(pm_api_arg[0],

pm_api_arg[1]);

Quoted 25 lines
drivers/firmware/xilinx/zynqmp-debug.c +25 -0
+             break;
+     case PM_REQUEST_NODE:
+             ret = zynqmp_pm_request_node(pm_api_arg[0],
+                                          pm_api_arg[1] ? pm_api_arg[1] :
+                                          ZYNQMP_PM_CAPABILITY_ACCESS,
+                                          pm_api_arg[2] ? pm_api_arg[2] : 0,
+                                          pm_api_arg[3] ? pm_api_arg[3] :
+                                          ZYNQMP_PM_REQUEST_ACK_BLOCKING);
+             break;
+     case PM_RELEASE_NODE:
+             ret = zynqmp_pm_release_node(pm_api_arg[0]);
+             break;
+     case PM_SET_REQUIREMENT:
+             ret = zynqmp_pm_set_requirement(pm_api_arg[0],
+                                             pm_api_arg[1] ? pm_api_arg[1] :
+                                             ZYNQMP_PM_CAPABILITY_CONTEXT,
+                                             pm_api_arg[2] ?
+                                             pm_api_arg[2] : 0,
+                                             pm_api_arg[3] ? pm_api_arg[3] :
+                                             ZYNQMP_PM_REQUEST_ACK_BLOCKING);
+             break;
+     case PM_REGISTER_NOTIFIER:
+             ret = zynqmp_pm_register_notifier(pm_api_arg[0],
+                                               pm_api_arg[1] ?
+                                               pm_api_arg[1] : 0,

drivers/firmware/xilinx/zynqmp-debug.c static int process_api_request(u32 pm_id, u64 *pm_api_arg, u32 *pm_api_ret)

Quoted 10 lines
drivers/firmware/xilinx/zynqmp-debug.c +10 -0
+                                               pm_api_arg[2] ?
+                                               pm_api_arg[2] : 0,
+                                               pm_api_arg[3] ?
+                                               pm_api_arg[3] : 0);
+             break;
+     case PM_RESET_ASSERT:
+             ret = zynqmp_pm_reset_assert(pm_api_arg[0], pm_api_arg[1]);
+             break;
+     case PM_RESET_GET_STATUS:
+             ret = zynqmp_pm_reset_get_status(pm_api_arg[0],

&pm_api_ret[0]);

Quoted 6 lines
drivers/firmware/xilinx/zynqmp-debug.c +6 -0
+             if (!ret)
+                     sprintf(debugfs_buf, "Reset status: %u\n",
+                             pm_api_ret[0]);
+             break;
+     case PM_GET_CHIPID:
+             ret = zynqmp_pm_get_chipid(&pm_api_ret[0], &pm_api_ret[1]);

drivers/firmware/xilinx/zynqmp-debug.c static int process_api_request(u32 pm_id, u64 *pm_api_arg, u32 *pm_api_ret)

Quoted 10 lines
drivers/firmware/xilinx/zynqmp-debug.c +10 -0
+             if (!ret)
+                     sprintf(debugfs_buf, "Idcode: %#x, Version:%#x\n",
+                             pm_api_ret[0], pm_api_ret[1]);
+             break;
+     case PM_PINCTRL_SET_FUNCTION:
+             ret = zynqmp_pm_pinctrl_set_function(pm_api_arg[0],
+                                                  pm_api_arg[1]);
+             break;
+     case PM_PINCTRL_CONFIG_PARAM_GET:
+             ret = zynqmp_pm_pinctrl_get_config(pm_api_arg[0],

pm_api_arg[1],

Quoted 35 lines
drivers/firmware/xilinx/zynqmp-debug.c +35 -0
+                                                &pm_api_ret[0]);
+             if (!ret)
+                     sprintf(debugfs_buf,
+                             "Pin: %llu, Param: %llu, Value: %u\n",
+                             pm_api_arg[0], pm_api_arg[1],
+                             pm_api_ret[0]);
+             break;
+     case PM_PINCTRL_CONFIG_PARAM_SET:
+             ret = zynqmp_pm_pinctrl_set_config(pm_api_arg[0],
+                                                pm_api_arg[1],
+                                                pm_api_arg[2]);
+             break;
+     case PM_IOCTL:
+             ret = zynqmp_pm_ioctl(pm_api_arg[0], pm_api_arg[1],
+                                   pm_api_arg[2], pm_api_arg[3],
+                                   pm_api_arg[4], &pm_api_ret[0]);
+             if (!ret && (pm_api_arg[1] == IOCTL_GET_RPU_OPER_MODE ||
+                          pm_api_arg[1] == IOCTL_GET_PLL_FRAC_MODE ||
+                          pm_api_arg[1] == IOCTL_GET_PLL_FRAC_DATA ||
+                          pm_api_arg[1] == IOCTL_READ_GGS ||
+                          pm_api_arg[1] == IOCTL_READ_PGGS ||
+                          pm_api_arg[1] == IOCTL_READ_REG))
+                     sprintf(debugfs_buf, "IOCTL return value: %u\n",
+                             pm_api_ret[1]);
+             if (!ret && pm_api_arg[1] == IOCTL_GET_QOS)
+                     sprintf(debugfs_buf, "Default QoS: %u\nCurrent QoS: %u\n",
+                             pm_api_ret[1], pm_api_ret[2]);
+             break;
+     case PM_CLOCK_ENABLE:
+             ret = zynqmp_pm_clock_enable(pm_api_arg[0]);
+             break;
+     case PM_CLOCK_DISABLE:
+             ret = zynqmp_pm_clock_disable(pm_api_arg[0]);
+             break;
+     case PM_CLOCK_GETSTATE:

drivers/firmware/xilinx/zynqmp-debug.c static int process_api_request(u32 pm_id, u64 *pm_api_arg, u32 *pm_api_ret)

Quoted 10 lines
drivers/firmware/xilinx/zynqmp-debug.c +10 -0
+             ret = zynqmp_pm_clock_getstate(pm_api_arg[0], &pm_api_ret[0]);
+             if (!ret)
+                     sprintf(debugfs_buf, "Clock state: %u\n",
+                             pm_api_ret[0]);
+             break;
+     case PM_CLOCK_SETDIVIDER:
+             ret = zynqmp_pm_clock_setdivider(pm_api_arg[0], pm_api_arg[1]);
+             break;
+     case PM_CLOCK_GETDIVIDER:
+             ret = zynqmp_pm_clock_getdivider(pm_api_arg[0],

&pm_api_ret[0]);

drivers/firmware/xilinx/zynqmp-debug.c static int process_api_request(u32 pm_id, u64 *pm_api_arg, u32 *pm_api_ret)

Quoted 9 lines
drivers/firmware/xilinx/zynqmp-debug.c +9 -0
+             if (!ret)
+                     sprintf(debugfs_buf, "Divider Value: %d\n",
+                             pm_api_ret[0]);
+             break;
+     case PM_CLOCK_SETPARENT:
+             ret = zynqmp_pm_clock_setparent(pm_api_arg[0], pm_api_arg[1]);
+             break;
+     case PM_CLOCK_GETPARENT:
+             ret = zynqmp_pm_clock_getparent(pm_api_arg[0],

&pm_api_ret[0]);

Quoted 25 lines
drivers/firmware/xilinx/zynqmp-debug.c +4 -0
+             if (!ret)
+                     sprintf(debugfs_buf,
+                             "Clock parent Index: %u\n", pm_api_ret[0]);
+             break;
      case PM_QUERY_DATA:
              qdata.qid = pm_api_arg[0];
              qdata.arg1 = pm_api_arg[1]; @@ -150,7 +310,7 @@ static

ssize_t zynqmp_pm_debugfs_api_write(struct file *file,

      char *kern_buff, *tmp_buff;
      char *pm_api_req;
      u32 pm_id = 0;
drivers/firmware/xilinx/zynqmp-debug.c +1 -1
-     u64 pm_api_arg[4] = {0, 0, 0, 0};
+     u64 pm_api_arg[5] = {0, 0, 0, 0, 0};
      /* Return values from PM APIs calls */
      u32 pm_api_ret[4] = {0, 0, 0, 0};
include/linux/firmware/xlnx-zynqmp.h +0 -0
index d7d07afc0532..563382cf16f2 100644
@@ -218,9 +218,13 @@ enum pm_ioctl_id {
      /* Runtime feature configuration */
      IOCTL_SET_FEATURE_CONFIG = 26,
      IOCTL_GET_FEATURE_CONFIG = 27,

include/linux/firmware/xlnx-zynqmp.h enum pm_ioctl_id { · line 230

Quoted 10 lines
include/linux/firmware/xlnx-zynqmp.h +4 -0
+     /* IOCTL for Secure Read/Write Interface */
+     IOCTL_READ_REG = 28,
      /* Dynamic SD/GEM configuration */
      IOCTL_SET_SD_CONFIG = 30,
      IOCTL_SET_GEM_CONFIG = 31,
+     /* IOCTL to get default/current QoS */
+     IOCTL_GET_QOS = 34,
  };
 
  enum pm_query_id {

Applied.
M