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.
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 sysfs entry for runtime features
firmware: xilinx: Add sysfs support for feature config
.../ABI/stable/sysfs-driver-firmware-zynqmp | 84 ++++++++++++++++
drivers/firmware/xilinx/zynqmp.c | 98 +++++++++++++++++++
include/linux/firmware/xlnx-zynqmp.h | 25 +++++
3 files changed, 207 insertions(+)
--
2.32.0.93.g670b81a
Create sysfs entry for runtime feature configuration. The support
is added for an over temperature and external watchdog feature.
The below listed files are used for runtime features configuration:
/sys/devices/platform/firmware\:zynqmp-firmware/feature_config_id
/sys/devices/platform/firmware\:zynqmp-firmware/feature_config_value
In order to configure an over temperature or external watchdog
features, first the user need to select the valid config id and then
the user can configure the value for selected feature config id.
Signed-off-by: Ronak Jain <[email protected]>
---
Changes in v2:
- Update commit message
---
.../ABI/stable/sysfs-driver-firmware-zynqmp | 84 +++++++++++++++++++
1 file changed, 84 insertions(+)
diff --git a/Documentation/ABI/stable/sysfs-driver-firmware-zynqmp b/Documentation/ABI/stable/sysfs-driver-firmware-zynqmp
index f5724bb5b462..2fde354715a5 100644
--- a/Documentation/ABI/stable/sysfs-driver-firmware-zynqmp
+++ b/Documentation/ABI/stable/sysfs-driver-firmware-zynqmp
@@ -113,3 +113,87 @@ Description:
# echo 0 > /sys/devices/platform/firmware\:zynqmp-firmware/health_status
Users: Xilinx
+
+What: /sys/devices/platform/firmware\:zynqmp-firmware/feature_config_*
+Date: Aug 2021
+KernelVersion: 5.14
+Contact: "Ronak Jain" <[email protected]>
+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
Hi Ronak,
Ronak Jain <[email protected]> writes:
> Create sysfs entry for runtime feature configuration. The support
> is added for an over temperature and external watchdog feature.
>
> The below listed files are used for runtime features configuration:
> /sys/devices/platform/firmware\:zynqmp-firmware/feature_config_id
> /sys/devices/platform/firmware\:zynqmp-firmware/feature_config_value
>
> In order to configure an over temperature or external watchdog
> features, first the user need to select the valid config id and then
> the user can configure the value for selected feature config id.
>
> Signed-off-by: Ronak Jain <[email protected]>
> ---
> Changes in v2:
> - Update commit message
> ---
> .../ABI/stable/sysfs-driver-firmware-zynqmp | 84 +++++++++++++++++++
> 1 file changed, 84 insertions(+)
>
> diff --git a/Documentation/ABI/stable/sysfs-driver-firmware-zynqmp b/Documentation/ABI/stable/sysfs-driver-firmware-zynqmp
> index f5724bb5b462..2fde354715a5 100644
> --- a/Documentation/ABI/stable/sysfs-driver-firmware-zynqmp
> +++ b/Documentation/ABI/stable/sysfs-driver-firmware-zynqmp
> @@ -113,3 +113,87 @@ Description:
> # echo 0 > /sys/devices/platform/firmware\:zynqmp-firmware/health_status
>
> Users: Xilinx
> +
> +What: /sys/devices/platform/firmware\:zynqmp-firmware/feature_config_*
> +Date: Aug 2021
> +KernelVersion: 5.14
> +Contact: "Ronak Jain" <[email protected]>
> +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.
Maybe I am missing something but I was wondering why these features are
being exposed via custom sysfs nodes - can they be integrated into the
respective subsystems?
e.g., Over temperature protection would fit in nicely with the thermal
sub-system. Did you explore integrating the feature there?
> +
> + 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.
Similarly, this would make sense to go into the watchdog subsystem.
Using sub-system interfaces would allow existing tools to just work
without having to make zynqmp specific tools or find yet another way to
interact with these features.
Thanks,
Punit