[PATCH v5 0/3] Add support for runtime features

[PATCH v5 0/3] Add support for runtime features

[Ronak Jain]

Add support for runtime feature configuration by using the IOCTL
 calls. The user can enable or disable as well as can configure the
 runtime features. The support is added for the over temperature and
 external watchdog. The user can configure the over temperature limit
 and external watchdog timer interval at runtime by using PM_IOCTL
 calls.
 
Also, added support for sysfs interface for runtime feature
configuration for the over temperature and external watchdog features.

Added zynqmp_devinfo structure to handle multiple driver instances
 when accessed by multiple devices.

Changes in v5:
- Resolved merge conflict
- Update kernel version for sysfs documentation

Changes in v4:
- Update documentation for sysfs entries in #2 patch
- Add separate entries for sysfs files

Changes in v3:
- Added zynqmp_devinfo structure to store device instances
- Modified feature_conf_id from atomic variable to u32
- Update commit message
- Resolved merge conflict

Changes in v2:
- Remove default footer from email
- Update commit message
- Resolved merged conflict

Ronak Jain (3):
  firmware: xilinx: Add support for runtime features
  firmware: zynqmp: Add documentation for runtime feature config
  firmware: xilinx: Add sysfs support for feature config

 .../ABI/stable/sysfs-driver-firmware-zynqmp   | 141 ++++++++++++++++++
 drivers/firmware/xilinx/zynqmp.c              | 120 +++++++++++++++
 include/linux/firmware/xlnx-zynqmp.h          |  25 ++++
 3 files changed, 286 insertions(+)

-- 
2.32.0.93.g670b81a

[PATCH v5 1/3] firmware: xilinx: Add support for runtime features

[Ronak Jain]

Add support for runtime features by using an IOCTL call. The features
 can be enabled or disabled from the firmware as well as the features
 can be configured at runtime by querying IOCTL_SET_FEATURE_CONFIG id.
 Similarly, the user can get the configured values of features by
 querying IOCTL_GET_FEATURE_CONFIG id.

Signed-off-by: Ronak Jain <ronak.jain@xilinx.com>
---
Changes in v5:
- Resolved merge conflicts

Changes in v4:
- Update commit message

Changes in v3:
- Resolved merged conflict

Changes in v2:
- Resolved merged conflict
- Update commit message
---
 drivers/firmware/xilinx/zynqmp.c     | 27 +++++++++++++++++++++++++++
 include/linux/firmware/xlnx-zynqmp.h | 25 +++++++++++++++++++++++++
 2 files changed, 52 insertions(+)

diff --git a/drivers/firmware/xilinx/zynqmp.c b/drivers/firmware/xilinx/zynqmp.c
index 450c5f6a1cbf..0fa6cae4969d 100644
--- a/drivers/firmware/xilinx/zynqmp.c
+++ b/drivers/firmware/xilinx/zynqmp.c
@@ -1156,6 +1156,33 @@ int zynqmp_pm_system_shutdown(const u32 type, const u32 subtype)
 				   0, 0, NULL);
 }
 
+/**
+ * zynqmp_pm_set_feature_config - PM call to request IOCTL for feature config
+ * @id:         The config ID of the feature to be configured
+ * @value:      The config value of the feature to be configured
+ *
+ * Return:      Returns 0 on success or error value on failure.
+ */
+int zynqmp_pm_set_feature_config(enum pm_feature_config_id id, u32 value)
+{
+	return zynqmp_pm_invoke_fn(PM_IOCTL, 0, IOCTL_SET_FEATURE_CONFIG,
+				   id, value, NULL);
+}
+
+/**
+ * zynqmp_pm_get_feature_config - PM call to get value of configured feature
+ * @id:         The config id of the feature to be queried
+ * @payload:    Returned value array
+ *
+ * Return:      Returns 0 on success or error value on failure.
+ */
+int zynqmp_pm_get_feature_config(enum pm_feature_config_id id,
+				 u32 *payload)
+{
+	return zynqmp_pm_invoke_fn(PM_IOCTL, 0, IOCTL_GET_FEATURE_CONFIG,
+				   id, 0, payload);
+}
+
 /**
  * struct zynqmp_pm_shutdown_scope - Struct for shutdown scope
  * @subtype:	Shutdown subtype
diff --git a/include/linux/firmware/xlnx-zynqmp.h b/include/linux/firmware/xlnx-zynqmp.h
index 907cb01890cf..cf557fbeb8c7 100644
--- a/include/linux/firmware/xlnx-zynqmp.h
+++ b/include/linux/firmware/xlnx-zynqmp.h
@@ -143,6 +143,9 @@ enum pm_ioctl_id {
 	IOCTL_OSPI_MUX_SELECT = 21,
 	/* Register SGI to ATF */
 	IOCTL_REGISTER_SGI = 25,
+	/* Runtime feature configuration */
+	IOCTL_SET_FEATURE_CONFIG = 26,
+	IOCTL_GET_FEATURE_CONFIG = 27,
 };
 
 enum pm_query_id {
@@ -376,6 +379,14 @@ enum ospi_mux_select_type {
 	PM_OSPI_MUX_SEL_LINEAR = 1,
 };
 
+enum pm_feature_config_id {
+	PM_FEATURE_INVALID = 0,
+	PM_FEATURE_OVERTEMP_STATUS = 1,
+	PM_FEATURE_OVERTEMP_VALUE = 2,
+	PM_FEATURE_EXTWDT_STATUS = 3,
+	PM_FEATURE_EXTWDT_VALUE = 4,
+};
+
 /**
  * struct zynqmp_pm_query_data - PM query data
  * @qid:	query ID
@@ -447,6 +458,8 @@ int zynqmp_pm_load_pdi(const u32 src, const u64 address);
 int zynqmp_pm_register_notifier(const u32 node, const u32 event,
 				const u32 wake, const u32 enable);
 int zynqmp_pm_feature(const u32 api_id);
+int zynqmp_pm_set_feature_config(enum pm_feature_config_id id, u32 value);
+int zynqmp_pm_get_feature_config(enum pm_feature_config_id id, u32 *payload);
 #else
 static inline int zynqmp_pm_get_api_version(u32 *version)
 {
@@ -689,6 +702,18 @@ static inline int zynqmp_pm_feature(const u32 api_id)
 {
 	return -ENODEV;
 }
+
+static inline int zynqmp_pm_set_feature_config(enum pm_feature_config_id id,
+					       u32 value)
+{
+	return -ENODEV;
+}
+
+static inline int zynqmp_pm_get_feature_config(enum pm_feature_config_id id,
+					       u32 *payload)
+{
+	return -ENODEV;
+}
 #endif
 
 #endif /* __FIRMWARE_ZYNQMP_H__ */
-- 
2.32.0.93.g670b81a

[PATCH v5 2/3] firmware: zynqmp: Add documentation for runtime feature config

[Ronak Jain]

Add documentation for sysfs entries like feature_config_id and
 feature_config_value for runtime feature configuration. The support is
 added for an over temperature and external watchdog features.

Signed-off-by: Ronak Jain <ronak.jain@xilinx.com>
---
Changes in v5:
- Update kernel version for sysfs documentation

Changes in v4:
- Add separate sysfs entries for runtime feature config
- Update commit message

Changes in v3:
- None

Changes in v2:
- Update commit message
---
 .../ABI/stable/sysfs-driver-firmware-zynqmp   | 141 ++++++++++++++++++
 1 file changed, 141 insertions(+)

diff --git a/Documentation/ABI/stable/sysfs-driver-firmware-zynqmp b/Documentation/ABI/stable/sysfs-driver-firmware-zynqmp
index f5724bb5b462..c3fec3c835af 100644
--- a/Documentation/ABI/stable/sysfs-driver-firmware-zynqmp
+++ b/Documentation/ABI/stable/sysfs-driver-firmware-zynqmp
@@ -113,3 +113,144 @@ Description:
 		    # echo 0 > /sys/devices/platform/firmware\:zynqmp-firmware/health_status
 
 Users:		Xilinx
+
+What:		/sys/devices/platform/firmware\:zynqmp-firmware/feature_config_id
+Date:		Feb 2022
+KernelVersion:	5.18
+Contact:	"Ronak Jain" <ronak.jain@xilinx.com>
+Description:
+		This sysfs interface allows user to configure features at
+		runtime. The user can enable or disable features running at
+		firmware as well as the user can configure the parameters of
+		the features at runtime. The supported features are over
+		temperature and external watchdog. Here, the external watchdog
+		is completely different than the /dev/watchdog as the external
+		watchdog is running on the firmware and it is used to monitor
+		the health of firmware not APU(Linux). Also, the external
+		watchdog is interfaced outside of the zynqmp soc.
+
+		The supported config ids are for the feature configuration is,
+		1. PM_FEATURE_OVERTEMP_STATUS = 1, the user can enable or
+		disable the over temperature feature.
+		2. PM_FEATURE_OVERTEMP_VALUE = 2, the user can configure the
+		over temperature limit in Degree Celsius.
+		3. PM_FEATURE_EXTWDT_STATUS = 3, the user can enable or disable
+		the external watchdog feature.
+		4. PM_FEATURE_EXTWDT_VALUE = 4, the user can configure the
+		external watchdog feature.
+
+		Usage:
+
+		Select over temperature config ID to enable/disable feature
+		# echo 1 > /sys/devices/platform/firmware\:zynqmp-firmware/feature_config_id
+
+		Check over temperature config ID is selected or not
+		# cat /sys/devices/platform/firmware\:zynqmp-firmware/feature_config_id
+		The expected result is 1.
+
+		Select over temperature config ID to configure OT limit
+		# echo 2 > /sys/devices/platform/firmware\:zynqmp-firmware/feature_config_id
+
+		Check over temperature config ID is selected or not
+		# cat /sys/devices/platform/firmware\:zynqmp-firmware/feature_config_id
+		The expected result is 2.
+
+		Select external watchdog config ID to enable/disable feature
+		# echo 3 > /sys/devices/platform/firmware\:zynqmp-firmware/feature_config_id
+
+		Check external watchdog config ID is selected or not
+		# cat /sys/devices/platform/firmware\:zynqmp-firmware/feature_config_id
+		The expected result is 3.
+
+		Select external watchdog config ID to configure time interval
+		# echo 4 > /sys/devices/platform/firmware\:zynqmp-firmware/feature_config_id
+
+		Check external watchdog config ID is selected or not
+		# cat /sys/devices/platform/firmware\:zynqmp-firmware/feature_config_id
+		The expected result is 4.
+
+Users:		Xilinx
+
+What:		/sys/devices/platform/firmware\:zynqmp-firmware/feature_config_value
+Date:		Feb 2022
+KernelVersion:	5.18
+Contact:	"Ronak Jain" <ronak.jain@xilinx.com>
+Description:
+		This sysfs interface allows to configure features at runtime.
+		The user can enable or disable features running at firmware.
+		Also, the user can configure the parameters of the features
+		at runtime. The supported features are over temperature and
+		external watchdog. Here, the external watchdog is completely
+		different than the /dev/watchdog as the external watchdog is
+		running on the firmware and it is used to monitor the health
+		of firmware not APU(Linux). Also, the external watchdog is
+		interfaced outside of the zynqmp soc.
+
+		By default the features are disabled in the firmware. The user
+		can enable features by querying appropriate config id of the
+		features.
+
+		The default limit for the over temperature is 90 Degree Celsius.
+		The default timer interval for the external watchdog is 570ms.
+
+		The supported config ids are for the feature configuration is,
+		1. PM_FEATURE_OVERTEMP_STATUS = 1, the user can enable or
+		disable the over temperature feature.
+		2. PM_FEATURE_OVERTEMP_VALUE = 2, the user can configure the
+		over temperature limit in Degree Celsius.
+		3. PM_FEATURE_EXTWDT_STATUS = 3, the user can enable or disable
+		the external watchdog feature.
+		4. PM_FEATURE_EXTWDT_VALUE = 4, the user can configure the
+		external watchdog feature.
+
+		Usage:
+
+		Enable over temperature feature
+		# echo 1 > /sys/devices/platform/firmware\:zynqmp-firmware/feature_config_id
+		# echo 1 > /sys/devices/platform/firmware\:zynqmp-firmware/feature_config_value
+
+		Check whether the over temperature feature is enabled or not
+		# cat /sys/devices/platform/firmware\:zynqmp-firmware/feature_config_value
+		The expected result is 1.
+
+		Disable over temperature feature
+		# echo 1 > /sys/devices/platform/firmware\:zynqmp-firmware/feature_config_id
+		# echo 0 > /sys/devices/platform/firmware\:zynqmp-firmware/feature_config_value
+
+		Check whether the over temperature feature is disabled or not
+		# cat /sys/devices/platform/firmware\:zynqmp-firmware/feature_config_value
+		The expected result is 0.
+
+		Configure over temperature limit to 50 Degree Celsius
+		# echo 2 > /sys/devices/platform/firmware\:zynqmp-firmware/feature_config_id
+		# echo 50 > /sys/devices/platform/firmware\:zynqmp-firmware/feature_config_value
+
+		Check whether the over temperature limit is configured or not
+		# cat /sys/devices/platform/firmware\:zynqmp-firmware/feature_config_value
+		The expected result is 50.
+
+		Enable external watchdog feature
+		# echo 3 > /sys/devices/platform/firmware\:zynqmp-firmware/feature_config_id
+		# echo 1 > /sys/devices/platform/firmware\:zynqmp-firmware/feature_config_value
+
+		Check whether the external watchdog feature is enabled or not
+		# cat /sys/devices/platform/firmware\:zynqmp-firmware/feature_config_value
+		The expected result is 1.
+
+		Disable external watchdog feature
+		# echo 3 > /sys/devices/platform/firmware\:zynqmp-firmware/feature_config_id
+		# echo 0 > /sys/devices/platform/firmware\:zynqmp-firmware/feature_config_value
+
+		Check whether the external watchdog feature is disabled or not
+		# cat /sys/devices/platform/firmware\:zynqmp-firmware/feature_config_value
+		The expected result is 0.
+
+		Configure external watchdog timer interval to 500ms
+		# echo 4 > /sys/devices/platform/firmware\:zynqmp-firmware/feature_config_id
+		# echo 500 > /sys/devices/platform/firmware\:zynqmp-firmware/feature_config_value
+
+		Check whether the external watchdog timer interval is configured or not
+		# cat /sys/devices/platform/firmware\:zynqmp-firmware/feature_config_value
+		The expected result is 500.
+
+Users:		Xilinx
-- 
2.32.0.93.g670b81a

[PATCH v5 3/3] firmware: xilinx: Add sysfs support for feature config

[Ronak Jain]

Add support for sysfs interface for runtime features configuration.
 The user can configure the features at runtime. First, the user need
 to select the config id of the supported features and then the user
 can configure the parameters of the feature based on the config id.

Signed-off-by: Ronak Jain <ronak.jain@xilinx.com>
---
Changes in v5:
- None

Changes in v4:
- Update commit message

Changes in v3:
- Added zynqmp_devinfo structure to store device instances
- Modified feature_conf_id from atomic variable to u32
- Update commit message
- Resolved merge conflicts

Changes in v2:
- Update commit message
---
 drivers/firmware/xilinx/zynqmp.c | 93 ++++++++++++++++++++++++++++++++
 1 file changed, 93 insertions(+)

diff --git a/drivers/firmware/xilinx/zynqmp.c b/drivers/firmware/xilinx/zynqmp.c
index 0fa6cae4969d..7d8cb2ec6f8e 100644
--- a/drivers/firmware/xilinx/zynqmp.c
+++ b/drivers/firmware/xilinx/zynqmp.c
@@ -41,6 +41,16 @@ static DEFINE_HASHTABLE(pm_api_features_map, PM_API_FEATURE_CHECK_MAX_ORDER);
 
 static struct platform_device *em_dev;
 
+/**
+ * struct zynqmp_devinfo - Structure for Zynqmp device instance
+ * @dev:		Device Pointer
+ * @feature_conf_id:	Feature conf id
+ */
+struct zynqmp_devinfo {
+	struct device *dev;
+	u32 feature_conf_id;
+};
+
 /**
  * struct pm_api_feature_data - PM API Feature data
  * @pm_api_id:		PM API Id, used as key to index into hashmap
@@ -1451,6 +1461,78 @@ static DEVICE_ATTR_RW(pggs1);
 static DEVICE_ATTR_RW(pggs2);
 static DEVICE_ATTR_RW(pggs3);
 
+static ssize_t feature_config_id_show(struct device *device,
+				      struct device_attribute *attr,
+				      char *buf)
+{
+	struct zynqmp_devinfo *devinfo = dev_get_drvdata(device);
+
+	return sysfs_emit(buf, "%d\n", devinfo->feature_conf_id);
+}
+
+static ssize_t feature_config_id_store(struct device *device,
+				       struct device_attribute *attr,
+				       const char *buf, size_t count)
+{
+	u32 config_id;
+	int ret;
+	struct zynqmp_devinfo *devinfo = dev_get_drvdata(device);
+
+	if (!buf)
+		return -EINVAL;
+
+	ret = kstrtou32(buf, 10, &config_id);
+	if (ret)
+		return ret;
+
+	devinfo->feature_conf_id = config_id;
+
+	return count;
+}
+
+static DEVICE_ATTR_RW(feature_config_id);
+
+static ssize_t feature_config_value_show(struct device *device,
+					 struct device_attribute *attr,
+					 char *buf)
+{
+	int ret;
+	u32 ret_payload[PAYLOAD_ARG_CNT];
+	struct zynqmp_devinfo *devinfo = dev_get_drvdata(device);
+
+	ret = zynqmp_pm_get_feature_config(devinfo->feature_conf_id,
+					   ret_payload);
+	if (ret)
+		return ret;
+
+	return sysfs_emit(buf, "%d\n", ret_payload[1]);
+}
+
+static ssize_t feature_config_value_store(struct device *device,
+					  struct device_attribute *attr,
+					  const char *buf, size_t count)
+{
+	u32 value;
+	int ret;
+	struct zynqmp_devinfo *devinfo = dev_get_drvdata(device);
+
+	if (!buf)
+		return -EINVAL;
+
+	ret = kstrtou32(buf, 10, &value);
+	if (ret)
+		return ret;
+
+	ret = zynqmp_pm_set_feature_config(devinfo->feature_conf_id,
+					   value);
+	if (ret)
+		return ret;
+
+	return count;
+}
+
+static DEVICE_ATTR_RW(feature_config_value);
+
 static struct attribute *zynqmp_firmware_attrs[] = {
 	&dev_attr_ggs0.attr,
 	&dev_attr_ggs1.attr,
@@ -1462,6 +1544,8 @@ static struct attribute *zynqmp_firmware_attrs[] = {
 	&dev_attr_pggs3.attr,
 	&dev_attr_shutdown_scope.attr,
 	&dev_attr_health_status.attr,
+	&dev_attr_feature_config_id.attr,
+	&dev_attr_feature_config_value.attr,
 	NULL,
 };
 
@@ -1471,6 +1555,7 @@ static int zynqmp_firmware_probe(struct platform_device *pdev)
 {
 	struct device *dev = &pdev->dev;
 	struct device_node *np;
+	struct zynqmp_devinfo *devinfo;
 	int ret;
 
 	np = of_find_compatible_node(NULL, NULL, "xlnx,zynqmp");
@@ -1487,6 +1572,14 @@ static int zynqmp_firmware_probe(struct platform_device *pdev)
 	if (ret)
 		return ret;
 
+	devinfo = devm_kzalloc(dev, sizeof(*devinfo), GFP_KERNEL);
+	if (!devinfo)
+		return -ENOMEM;
+
+	devinfo->dev = dev;
+
+	platform_set_drvdata(pdev, devinfo);
+
 	/* Check PM API version number */
 	ret = zynqmp_pm_get_api_version(&pm_api_version);
 	if (ret)
-- 
2.32.0.93.g670b81a

Re: [PATCH v5 1/3] firmware: xilinx: Add support for runtime features

[Michal Simek]

On 2/9/22 09:27, Ronak Jain wrote:
> Add support for runtime features by using an IOCTL call. The features
>   can be enabled or disabled from the firmware as well as the features
>   can be configured at runtime by querying IOCTL_SET_FEATURE_CONFIG id.
>   Similarly, the user can get the configured values of features by
>   querying IOCTL_GET_FEATURE_CONFIG id.
> 
> Signed-off-by: Ronak Jain <ronak.jain@xilinx.com>
> ---
> Changes in v5:
> - Resolved merge conflicts
> 
> Changes in v4:
> - Update commit message
> 
> Changes in v3:
> - Resolved merged conflict
> 
> Changes in v2:
> - Resolved merged conflict
> - Update commit message
> ---
>   drivers/firmware/xilinx/zynqmp.c     | 27 +++++++++++++++++++++++++++
>   include/linux/firmware/xlnx-zynqmp.h | 25 +++++++++++++++++++++++++
>   2 files changed, 52 insertions(+)
> 
> diff --git a/drivers/firmware/xilinx/zynqmp.c b/drivers/firmware/xilinx/zynqmp.c
> index 450c5f6a1cbf..0fa6cae4969d 100644
> --- a/drivers/firmware/xilinx/zynqmp.c
> +++ b/drivers/firmware/xilinx/zynqmp.c
> @@ -1156,6 +1156,33 @@ int zynqmp_pm_system_shutdown(const u32 type, const u32 subtype)
>   				   0, 0, NULL);
>   }
>   
> +/**
> + * zynqmp_pm_set_feature_config - PM call to request IOCTL for feature config
> + * @id:         The config ID of the feature to be configured
> + * @value:      The config value of the feature to be configured
> + *
> + * Return:      Returns 0 on success or error value on failure.
> + */
> +int zynqmp_pm_set_feature_config(enum pm_feature_config_id id, u32 value)
> +{
> +	return zynqmp_pm_invoke_fn(PM_IOCTL, 0, IOCTL_SET_FEATURE_CONFIG,
> +				   id, value, NULL);
> +}
> +
> +/**
> + * zynqmp_pm_get_feature_config - PM call to get value of configured feature
> + * @id:         The config id of the feature to be queried
> + * @payload:    Returned value array
> + *
> + * Return:      Returns 0 on success or error value on failure.
> + */
> +int zynqmp_pm_get_feature_config(enum pm_feature_config_id id,
> +				 u32 *payload)
> +{
> +	return zynqmp_pm_invoke_fn(PM_IOCTL, 0, IOCTL_GET_FEATURE_CONFIG,
> +				   id, 0, payload);
> +}
> +
>   /**
>    * struct zynqmp_pm_shutdown_scope - Struct for shutdown scope
>    * @subtype:	Shutdown subtype
> diff --git a/include/linux/firmware/xlnx-zynqmp.h b/include/linux/firmware/xlnx-zynqmp.h
> index 907cb01890cf..cf557fbeb8c7 100644
> --- a/include/linux/firmware/xlnx-zynqmp.h
> +++ b/include/linux/firmware/xlnx-zynqmp.h
> @@ -143,6 +143,9 @@ enum pm_ioctl_id {
>   	IOCTL_OSPI_MUX_SELECT = 21,
>   	/* Register SGI to ATF */
>   	IOCTL_REGISTER_SGI = 25,
> +	/* Runtime feature configuration */
> +	IOCTL_SET_FEATURE_CONFIG = 26,
> +	IOCTL_GET_FEATURE_CONFIG = 27,
>   };
>   
>   enum pm_query_id {
> @@ -376,6 +379,14 @@ enum ospi_mux_select_type {
>   	PM_OSPI_MUX_SEL_LINEAR = 1,
>   };
>   
> +enum pm_feature_config_id {
> +	PM_FEATURE_INVALID = 0,
> +	PM_FEATURE_OVERTEMP_STATUS = 1,
> +	PM_FEATURE_OVERTEMP_VALUE = 2,
> +	PM_FEATURE_EXTWDT_STATUS = 3,
> +	PM_FEATURE_EXTWDT_VALUE = 4,
> +};
> +
>   /**
>    * struct zynqmp_pm_query_data - PM query data
>    * @qid:	query ID
> @@ -447,6 +458,8 @@ int zynqmp_pm_load_pdi(const u32 src, const u64 address);
>   int zynqmp_pm_register_notifier(const u32 node, const u32 event,
>   				const u32 wake, const u32 enable);
>   int zynqmp_pm_feature(const u32 api_id);
> +int zynqmp_pm_set_feature_config(enum pm_feature_config_id id, u32 value);
> +int zynqmp_pm_get_feature_config(enum pm_feature_config_id id, u32 *payload);
>   #else
>   static inline int zynqmp_pm_get_api_version(u32 *version)
>   {
> @@ -689,6 +702,18 @@ static inline int zynqmp_pm_feature(const u32 api_id)
>   {
>   	return -ENODEV;
>   }
> +
> +static inline int zynqmp_pm_set_feature_config(enum pm_feature_config_id id,
> +					       u32 value)
> +{
> +	return -ENODEV;
> +}
> +
> +static inline int zynqmp_pm_get_feature_config(enum pm_feature_config_id id,
> +					       u32 *payload)
> +{
> +	return -ENODEV;
> +}
>   #endif
>   
>   #endif /* __FIRMWARE_ZYNQMP_H__ */


Acked-by: Michal Simek <michal.simek@xilinx.com>

Thanks,
Michal

Re: [PATCH v5 2/3] firmware: zynqmp: Add documentation for runtime feature config

[Michal Simek]

On 2/9/22 09:27, Ronak Jain wrote:
> Add documentation for sysfs entries like feature_config_id and
>   feature_config_value for runtime feature configuration. The support is
>   added for an over temperature and external watchdog features.
> 
> Signed-off-by: Ronak Jain <ronak.jain@xilinx.com>
> ---
> Changes in v5:
> - Update kernel version for sysfs documentation
> 
> Changes in v4:
> - Add separate sysfs entries for runtime feature config
> - Update commit message
> 
> Changes in v3:
> - None
> 
> Changes in v2:
> - Update commit message
> ---
>   .../ABI/stable/sysfs-driver-firmware-zynqmp   | 141 ++++++++++++++++++
>   1 file changed, 141 insertions(+)
> 
> diff --git a/Documentation/ABI/stable/sysfs-driver-firmware-zynqmp b/Documentation/ABI/stable/sysfs-driver-firmware-zynqmp
> index f5724bb5b462..c3fec3c835af 100644
> --- a/Documentation/ABI/stable/sysfs-driver-firmware-zynqmp
> +++ b/Documentation/ABI/stable/sysfs-driver-firmware-zynqmp
> @@ -113,3 +113,144 @@ Description:
>   		    # echo 0 > /sys/devices/platform/firmware\:zynqmp-firmware/health_status
>   
>   Users:		Xilinx
> +
> +What:		/sys/devices/platform/firmware\:zynqmp-firmware/feature_config_id
> +Date:		Feb 2022
> +KernelVersion:	5.18
> +Contact:	"Ronak Jain" <ronak.jain@xilinx.com>
> +Description:
> +		This sysfs interface allows user to configure features at
> +		runtime. The user can enable or disable features running at
> +		firmware as well as the user can configure the parameters of
> +		the features at runtime. The supported features are over
> +		temperature and external watchdog. Here, the external watchdog
> +		is completely different than the /dev/watchdog as the external
> +		watchdog is running on the firmware and it is used to monitor
> +		the health of firmware not APU(Linux). Also, the external
> +		watchdog is interfaced outside of the zynqmp soc.
> +
> +		The supported config ids are for the feature configuration is,
> +		1. PM_FEATURE_OVERTEMP_STATUS = 1, the user can enable or
> +		disable the over temperature feature.
> +		2. PM_FEATURE_OVERTEMP_VALUE = 2, the user can configure the
> +		over temperature limit in Degree Celsius.
> +		3. PM_FEATURE_EXTWDT_STATUS = 3, the user can enable or disable
> +		the external watchdog feature.
> +		4. PM_FEATURE_EXTWDT_VALUE = 4, the user can configure the
> +		external watchdog feature.
> +
> +		Usage:
> +
> +		Select over temperature config ID to enable/disable feature
> +		# echo 1 > /sys/devices/platform/firmware\:zynqmp-firmware/feature_config_id
> +
> +		Check over temperature config ID is selected or not
> +		# cat /sys/devices/platform/firmware\:zynqmp-firmware/feature_config_id
> +		The expected result is 1.
> +
> +		Select over temperature config ID to configure OT limit
> +		# echo 2 > /sys/devices/platform/firmware\:zynqmp-firmware/feature_config_id
> +
> +		Check over temperature config ID is selected or not
> +		# cat /sys/devices/platform/firmware\:zynqmp-firmware/feature_config_id
> +		The expected result is 2.
> +
> +		Select external watchdog config ID to enable/disable feature
> +		# echo 3 > /sys/devices/platform/firmware\:zynqmp-firmware/feature_config_id
> +
> +		Check external watchdog config ID is selected or not
> +		# cat /sys/devices/platform/firmware\:zynqmp-firmware/feature_config_id
> +		The expected result is 3.
> +
> +		Select external watchdog config ID to configure time interval
> +		# echo 4 > /sys/devices/platform/firmware\:zynqmp-firmware/feature_config_id
> +
> +		Check external watchdog config ID is selected or not
> +		# cat /sys/devices/platform/firmware\:zynqmp-firmware/feature_config_id
> +		The expected result is 4.
> +
> +Users:		Xilinx
> +
> +What:		/sys/devices/platform/firmware\:zynqmp-firmware/feature_config_value
> +Date:		Feb 2022
> +KernelVersion:	5.18
> +Contact:	"Ronak Jain" <ronak.jain@xilinx.com>
> +Description:
> +		This sysfs interface allows to configure features at runtime.
> +		The user can enable or disable features running at firmware.
> +		Also, the user can configure the parameters of the features
> +		at runtime. The supported features are over temperature and
> +		external watchdog. Here, the external watchdog is completely
> +		different than the /dev/watchdog as the external watchdog is
> +		running on the firmware and it is used to monitor the health
> +		of firmware not APU(Linux). Also, the external watchdog is
> +		interfaced outside of the zynqmp soc.
> +
> +		By default the features are disabled in the firmware. The user
> +		can enable features by querying appropriate config id of the
> +		features.
> +
> +		The default limit for the over temperature is 90 Degree Celsius.
> +		The default timer interval for the external watchdog is 570ms.
> +
> +		The supported config ids are for the feature configuration is,
> +		1. PM_FEATURE_OVERTEMP_STATUS = 1, the user can enable or
> +		disable the over temperature feature.
> +		2. PM_FEATURE_OVERTEMP_VALUE = 2, the user can configure the
> +		over temperature limit in Degree Celsius.
> +		3. PM_FEATURE_EXTWDT_STATUS = 3, the user can enable or disable
> +		the external watchdog feature.
> +		4. PM_FEATURE_EXTWDT_VALUE = 4, the user can configure the
> +		external watchdog feature.
> +
> +		Usage:
> +
> +		Enable over temperature feature
> +		# echo 1 > /sys/devices/platform/firmware\:zynqmp-firmware/feature_config_id
> +		# echo 1 > /sys/devices/platform/firmware\:zynqmp-firmware/feature_config_value
> +
> +		Check whether the over temperature feature is enabled or not
> +		# cat /sys/devices/platform/firmware\:zynqmp-firmware/feature_config_value
> +		The expected result is 1.
> +
> +		Disable over temperature feature
> +		# echo 1 > /sys/devices/platform/firmware\:zynqmp-firmware/feature_config_id
> +		# echo 0 > /sys/devices/platform/firmware\:zynqmp-firmware/feature_config_value
> +
> +		Check whether the over temperature feature is disabled or not
> +		# cat /sys/devices/platform/firmware\:zynqmp-firmware/feature_config_value
> +		The expected result is 0.
> +
> +		Configure over temperature limit to 50 Degree Celsius
> +		# echo 2 > /sys/devices/platform/firmware\:zynqmp-firmware/feature_config_id
> +		# echo 50 > /sys/devices/platform/firmware\:zynqmp-firmware/feature_config_value
> +
> +		Check whether the over temperature limit is configured or not
> +		# cat /sys/devices/platform/firmware\:zynqmp-firmware/feature_config_value
> +		The expected result is 50.
> +
> +		Enable external watchdog feature
> +		# echo 3 > /sys/devices/platform/firmware\:zynqmp-firmware/feature_config_id
> +		# echo 1 > /sys/devices/platform/firmware\:zynqmp-firmware/feature_config_value
> +
> +		Check whether the external watchdog feature is enabled or not
> +		# cat /sys/devices/platform/firmware\:zynqmp-firmware/feature_config_value
> +		The expected result is 1.
> +
> +		Disable external watchdog feature
> +		# echo 3 > /sys/devices/platform/firmware\:zynqmp-firmware/feature_config_id
> +		# echo 0 > /sys/devices/platform/firmware\:zynqmp-firmware/feature_config_value
> +
> +		Check whether the external watchdog feature is disabled or not
> +		# cat /sys/devices/platform/firmware\:zynqmp-firmware/feature_config_value
> +		The expected result is 0.
> +
> +		Configure external watchdog timer interval to 500ms
> +		# echo 4 > /sys/devices/platform/firmware\:zynqmp-firmware/feature_config_id
> +		# echo 500 > /sys/devices/platform/firmware\:zynqmp-firmware/feature_config_value
> +
> +		Check whether the external watchdog timer interval is configured or not
> +		# cat /sys/devices/platform/firmware\:zynqmp-firmware/feature_config_value
> +		The expected result is 500.
> +
> +Users:		Xilinx


Acked-by: Michal Simek <michal.simek@xilinx.com>

Thanks,
Michal

Re: [PATCH v5 3/3] firmware: xilinx: Add sysfs support for feature config

[Michal Simek]

On 2/9/22 09:27, Ronak Jain wrote:
> Add support for sysfs interface for runtime features configuration.
>   The user can configure the features at runtime. First, the user need
>   to select the config id of the supported features and then the user
>   can configure the parameters of the feature based on the config id.
> 
> Signed-off-by: Ronak Jain <ronak.jain@xilinx.com>
> ---
> Changes in v5:
> - None
> 
> Changes in v4:
> - Update commit message
> 
> Changes in v3:
> - Added zynqmp_devinfo structure to store device instances
> - Modified feature_conf_id from atomic variable to u32
> - Update commit message
> - Resolved merge conflicts
> 
> Changes in v2:
> - Update commit message
> ---
>   drivers/firmware/xilinx/zynqmp.c | 93 ++++++++++++++++++++++++++++++++
>   1 file changed, 93 insertions(+)
> 
> diff --git a/drivers/firmware/xilinx/zynqmp.c b/drivers/firmware/xilinx/zynqmp.c
> index 0fa6cae4969d..7d8cb2ec6f8e 100644
> --- a/drivers/firmware/xilinx/zynqmp.c
> +++ b/drivers/firmware/xilinx/zynqmp.c
> @@ -41,6 +41,16 @@ static DEFINE_HASHTABLE(pm_api_features_map, PM_API_FEATURE_CHECK_MAX_ORDER);
>   
>   static struct platform_device *em_dev;
>   
> +/**
> + * struct zynqmp_devinfo - Structure for Zynqmp device instance
> + * @dev:		Device Pointer
> + * @feature_conf_id:	Feature conf id
> + */
> +struct zynqmp_devinfo {
> +	struct device *dev;
> +	u32 feature_conf_id;
> +};
> +
>   /**
>    * struct pm_api_feature_data - PM API Feature data
>    * @pm_api_id:		PM API Id, used as key to index into hashmap
> @@ -1451,6 +1461,78 @@ static DEVICE_ATTR_RW(pggs1);
>   static DEVICE_ATTR_RW(pggs2);
>   static DEVICE_ATTR_RW(pggs3);
>   
> +static ssize_t feature_config_id_show(struct device *device,
> +				      struct device_attribute *attr,
> +				      char *buf)
> +{
> +	struct zynqmp_devinfo *devinfo = dev_get_drvdata(device);
> +
> +	return sysfs_emit(buf, "%d\n", devinfo->feature_conf_id);
> +}
> +
> +static ssize_t feature_config_id_store(struct device *device,
> +				       struct device_attribute *attr,
> +				       const char *buf, size_t count)
> +{
> +	u32 config_id;
> +	int ret;
> +	struct zynqmp_devinfo *devinfo = dev_get_drvdata(device);
> +
> +	if (!buf)
> +		return -EINVAL;
> +
> +	ret = kstrtou32(buf, 10, &config_id);
> +	if (ret)
> +		return ret;
> +
> +	devinfo->feature_conf_id = config_id;
> +
> +	return count;
> +}
> +
> +static DEVICE_ATTR_RW(feature_config_id);
> +
> +static ssize_t feature_config_value_show(struct device *device,
> +					 struct device_attribute *attr,
> +					 char *buf)
> +{
> +	int ret;
> +	u32 ret_payload[PAYLOAD_ARG_CNT];
> +	struct zynqmp_devinfo *devinfo = dev_get_drvdata(device);
> +
> +	ret = zynqmp_pm_get_feature_config(devinfo->feature_conf_id,
> +					   ret_payload);
> +	if (ret)
> +		return ret;
> +
> +	return sysfs_emit(buf, "%d\n", ret_payload[1]);
> +}
> +
> +static ssize_t feature_config_value_store(struct device *device,
> +					  struct device_attribute *attr,
> +					  const char *buf, size_t count)
> +{
> +	u32 value;
> +	int ret;
> +	struct zynqmp_devinfo *devinfo = dev_get_drvdata(device);
> +
> +	if (!buf)
> +		return -EINVAL;
> +
> +	ret = kstrtou32(buf, 10, &value);
> +	if (ret)
> +		return ret;
> +
> +	ret = zynqmp_pm_set_feature_config(devinfo->feature_conf_id,
> +					   value);
> +	if (ret)
> +		return ret;
> +
> +	return count;
> +}
> +
> +static DEVICE_ATTR_RW(feature_config_value);
> +
>   static struct attribute *zynqmp_firmware_attrs[] = {
>   	&dev_attr_ggs0.attr,
>   	&dev_attr_ggs1.attr,
> @@ -1462,6 +1544,8 @@ static struct attribute *zynqmp_firmware_attrs[] = {
>   	&dev_attr_pggs3.attr,
>   	&dev_attr_shutdown_scope.attr,
>   	&dev_attr_health_status.attr,
> +	&dev_attr_feature_config_id.attr,
> +	&dev_attr_feature_config_value.attr,
>   	NULL,
>   };
>   
> @@ -1471,6 +1555,7 @@ static int zynqmp_firmware_probe(struct platform_device *pdev)
>   {
>   	struct device *dev = &pdev->dev;
>   	struct device_node *np;
> +	struct zynqmp_devinfo *devinfo;
>   	int ret;
>   
>   	np = of_find_compatible_node(NULL, NULL, "xlnx,zynqmp");
> @@ -1487,6 +1572,14 @@ static int zynqmp_firmware_probe(struct platform_device *pdev)
>   	if (ret)
>   		return ret;
>   
> +	devinfo = devm_kzalloc(dev, sizeof(*devinfo), GFP_KERNEL);
> +	if (!devinfo)
> +		return -ENOMEM;
> +
> +	devinfo->dev = dev;
> +
> +	platform_set_drvdata(pdev, devinfo);
> +
>   	/* Check PM API version number */
>   	ret = zynqmp_pm_get_api_version(&pm_api_version);
>   	if (ret)


Acked-by: Michal Simek <michal.simek@xilinx.com>

Thanks,
Michal

Re: [PATCH v5 3/3] firmware: xilinx: Add sysfs support for feature config

[Greg KH]

On Wed, Feb 09, 2022 at 12:27:09AM -0800, Ronak Jain wrote:
> Add support for sysfs interface for runtime features configuration.
>  The user can configure the features at runtime. First, the user need
>  to select the config id of the supported features and then the user
>  can configure the parameters of the feature based on the config id.
> 
> Signed-off-by: Ronak Jain <ronak.jain@xilinx.com>

You are adding new sysfs files, without any Documentation/ABI/ entries.
That will cause errors when you run the scripts/get_abi.pl tool, right?

Please fix.

thanks,

greg k-h

Re: [PATCH v5 2/3] firmware: zynqmp: Add documentation for runtime feature config

[Greg KH]

On Wed, Feb 09, 2022 at 12:27:08AM -0800, Ronak Jain wrote:
> Add documentation for sysfs entries like feature_config_id and
>  feature_config_value for runtime feature configuration. The support is
>  added for an over temperature and external watchdog features.
> 
> Signed-off-by: Ronak Jain <ronak.jain@xilinx.com>
> ---
> Changes in v5:
> - Update kernel version for sysfs documentation
> 

Ah, here's the documentation, sorry about that...