add Intel Stratix10 remote system update driver
v5 cover add Intel Stratix10 remote system update driver
From: Richard Gong <[email protected]>
This is the 5th submission of Intel Stratix10 remote system update (RSU) driver.
Intel Stratix10 remote system update driver patches have been reviewed by Alan Tull and other colleagues at Intel.
The Intel Stratix10 Remote System Update driver exposes interfaces access through the Intel Stratix10 Service Layer to user space via sysfs interface. The RSU interfaces report and control some of the optional RSU features on Intel Stratix 10 SoC.
The RSU feature provides a way for customers to update the boot configuration of a Intel Stratix 10 SoC device with significantly reduced risk of corrupting the bitstream storage and bricking the system.
v5: changed to use dev_group pointer from driver core
changed to support max_retry with watchdog event
s/KernelVersion:5.3/KernelVersion:5.4
replaced /sys/devices/.../stratix10-rsu.0/driver/ with
/sys/devices/platform/stratix10-rsu.0/
replace contact email address with [email protected]v4: removed devm_device_add_groups() & devm_device_remove_groups(), then
utilized groups at struct device_driver
replaced /sys/devices/platform/stratix10-rsu.0/ with /sys/devices/.../ stratix10-rsu.0/driver/
removed spaces
v3: changed kernel version from 5.2 to 5.3 in RSU sysfs interface document
v2: removed compatible = "intel,stratix10-rsu"
added intel stratix10 RSU device
changed to support RSU in handling watchdog timeout s/attr_group/ATTRIBUTE_GROUPS, use devm_device_add_groups() and devm_device_remove_groups()
added check the return value from rsu_send_msg()
removed RSU binding text file
other corrections/change
Richard Gong (4):
firmware: stratix10-svc: extend svc to support new RSU features
firmware: add Intel Stratix10 remote system update driver
firmware: rsu: document sysfs interface
MAINTAINERS: add maintainer for Intel Stratix10 FW drivers
.../testing/sysfs-devices-platform-stratix10-rsu | 128 ++++++ MAINTAINERS | 11 + drivers/firmware/Kconfig | 18 + drivers/firmware/Makefile | 1 + drivers/firmware/stratix10-rsu.c | 451 +++++++++++++++++++++ drivers/firmware/stratix10-svc.c | 76 +++- include/linux/firmware/intel/stratix10-smc.h | 51 ++- .../linux/firmware/intel/stratix10-svc-client.h | 11 +- 8 files changed, 737 insertions(+), 10 deletions(-) create mode 100644 Documentation/ABI/testing/sysfs-devices-platform-stratix10-rsu create mode 100644 drivers/firmware/stratix10-rsu.c
Signature · 1 line
2.7.4
PATCH v5 1/4 firmware: stratix10-svc: extend svc to support new RSU features
From: Richard Gong <[email protected]>
Extend Intel Stratix10 service layer driver to support new RSU notify and MAX_RETRY with watchdog event.
RSU is used to provide our customers with protection against loading bad bitstream onto their devices when those devices are booting from flash
RSU notifies provides users with an API to notify the firmware of the state of hard processor system.
To deal with watchdog event, RSU provides a way for user to retry the current running image several times before giving up and starting normal RSU failover flow.
---
v2: changed to add intel stratix10 RSU device
changed to support RSU in handling a watchdog timeout
v3: no change
v4: no change
v5: changed to support max_retry with watchdog event
--- drivers/firmware/stratix10-svc.c | 76 +++++++++++++++++++++- include/linux/firmware/intel/stratix10-smc.h | 51 +++++++++++++-- .../linux/firmware/intel/stratix10-svc-client.h | 11 +++- 3 files changed, 128 insertions(+), 10 deletions(-)
drivers/firmware/stratix10-svc.c +73 -3
@@ -38,6 +38,9 @@#define FPGA_CONFIG_DATA_CLAIM_TIMEOUT_MS 200#define FPGA_CONFIG_STATUS_TIMEOUT_SEC 30 +/* stratix10 service layer clients */ +#define STRATIX10_RSU "stratix10-rsu" + typedef void (svc_invoke_fn)(unsigned long, unsigned long, unsigned long, unsigned long, unsigned long, unsigned long, unsigned long, unsigned long,
@@ -45,6 +48,14 @@ typedef void (svc_invoke_fn)(unsigned long, unsigned long, unsigned long,struct stratix10_svc_chan ;/** +* struct stratix10_svc - svc private data +* @stratix10_svc_rsu: pointer to stratix10 RSU device +*/ +struct stratix10_svc { +struct platform_device *stratix10_svc_rsu; +}; + +/** * struct stratix10_svc_sh_memory - service shared memory structure * @sync_complete: state for a completion * @addr: physical address of shared memory block
@@ -296,7 +307,12 @@ static void svc_thread_recv_status_ok(struct stratix10_svc_data *p_data, cb_data->status =BIT (SVC_STATUS_RECONFIG_COMPLETED );break ;case COMMAND_RSU_UPDATE : +case COMMAND_RSU_NOTIFY : + cb_data->status =BIT (SVC_STATUS_RSU_OK ); +break ; +case COMMAND_RSU_RETRY : cb_data->status =BIT (SVC_STATUS_RSU_OK ); + cb_data->kaddr1 = &res.a1;break ;default :pr_warn ("it shouldn't happen\n" );
@@ -386,6 +402,16 @@ static int svc_normal_to_secure_thread(void *data) a1 = pdata->arg[0 ]; a2 =0 ;break ; +case COMMAND_RSU_NOTIFY : + a0 =INTEL_SIP_SMC_RSU_NOTIFY ; + a1 = pdata->arg[0 ]; + a2 =0 ; +break ; +case COMMAND_RSU_RETRY : + a0 =INTEL_SIP_SMC_RSU_RETRY_COUNTER ; + a1 =0 ; + a2 =0 ; +break ;default :pr_warn ("it shouldn't happen\n" );break ;
@@ -438,7 +464,28 @@ static int svc_normal_to_secure_thread(void *data)pr_debug ("%s: STATUS_REJECTED\n" , __func__);break ;case INTEL_SIP_SMC_FPGA_CONFIG_STATUS_ERROR : +case INTEL_SIP_SMC_RSU_ERROR :pr_err ("%s: STATUS_ERROR\n" , __func__); +switch (pdata->command) { +/* for FPGA mgr */ +case COMMAND_RECONFIG_DATA_CLAIM : +case COMMAND_RECONFIG : +case COMMAND_RECONFIG_DATA_SUBMIT : +case COMMAND_RECONFIG_STATUS : + cbdata->status = +BIT (SVC_STATUS_RECONFIG_ERROR ); +break ; + +/* for RSU */ +case COMMAND_RSU_STATUS : +case COMMAND_RSU_UPDATE : +case COMMAND_RSU_NOTIFY : +case COMMAND_RSU_RETRY : + cbdata->status = +BIT (SVC_STATUS_RSU_ERROR ); +break ; + } + cbdata->status =BIT (SVC_STATUS_RECONFIG_ERROR ); cbdata->kaddr1 =NULL ; cbdata->kaddr2 =NULL ;
@@ -530,7 +577,7 @@ static int svc_get_sh_memory(struct platform_device *pdev,if (!sh_memory->addr || !sh_memory->size) {dev_err (dev, -"fails to get shared memory info from secure world\n" ); +"failed to get shared memory info from secure world\n" );return -ENOMEM ; }
@@ -768,7 +815,7 @@ int stratix10_svc_send(struct stratix10_svc_chan *chan, void *msg) "svc_smc_hvc_thread");if (IS_ERR (chan->ctrl->task)) {dev_err (chan->ctrl->dev, -"fails to create svc_smc_hvc_thread\n" ); +"failed to create svc_smc_hvc_thread\n" );kfree (p_data);return -EINVAL ; }
@@ -913,6 +960,8 @@ static int stratix10_svc_drv_probe(struct platform_device *pdev)struct stratix10_svc_chan *chans;struct gen_pool *genpool;struct stratix10_svc_sh_memory *sh_memory; +struct stratix10_svc *svc; +svc_invoke_fn *invoke_fn;size_t fifo_size;int ret;
@@ -957,7 +1006,7 @@ static int stratix10_svc_drv_probe(struct platform_device *pdev) fifo_size =sizeof (struct stratix10_svc_data ) *SVC_NUM_DATA_IN_FIFO ; ret =kfifo_alloc (&controller->svc_fifo, fifo_size,GFP_KERNEL );if (ret) { -dev_err (dev,"fails to allocate FIFO\n" ); +dev_err (dev,"failed to allocate FIFO\n" );return ret; }spin_lock_init (&controller->svc_fifo_lock);
@@ -975,6 +1024,24 @@ static int stratix10_svc_drv_probe(struct platform_device *pdev)list_add_tail (&controller->node, &svc_ctrl);platform_set_drvdata (pdev, controller); +/* add svc client device(s) */ + svc =devm_kzalloc (dev,sizeof (*svc),GFP_KERNEL ); +if (!svc) +return -ENOMEM ; + + svc->stratix10_svc_rsu =platform_device_alloc (STRATIX10_RSU ,0 ); +if (!svc->stratix10_svc_rsu) { +dev_err (dev,"failed to allocate %s device\n" ,STRATIX10_RSU ); +return -ENOMEM ; + } + + ret =platform_device_add (svc->stratix10_svc_rsu); +if (ret) { +platform_device_put (svc->stratix10_svc_rsu); +return ret; + } +dev_set_drvdata (dev, svc); +pr_info ("Intel Service Layer Driver Initialized\n" );return ret;
@@ -982,8 +1049,11 @@ static int stratix10_svc_drv_probe(struct platform_device *pdev)static int stratix10_svc_drv_remove (struct platform_device *pdev) { +struct stratix10_svc *svc =dev_get_drvdata (&pdev->dev);struct stratix10_svc_controller *ctrl =platform_get_drvdata (pdev); +platform_device_unregister (svc->stratix10_svc_rsu); +kfifo_free (&ctrl->svc_fifo);if (ctrl->task) {kthread_stop (ctrl->task);
include/linux/firmware/intel/stratix10-smc.h +45 -6
90 lines not on this page · raw message
include/linux/firmware/intel/stratix10-svc-client.h +10 -1
@@ -95,6 +95,13 @@ struct stratix10_svc_chan;* * @COMMAND_RSU_UPDATE: set the offset of the bitstream to boot after reboot, * return status is SVC_STATUS_RSU_OK or SVC_STATUS_RSU_ERROR +* +* @COMMAND_RSU_NOTIFY: report the status of hard processor system +* software to firmware, return status is SVC_STATUS_RSU_OK or +* SVC_STATUS_RSU_ERROR +* +* @COMMAND_RSU_RETRY: query firmware for the current image's retry counter, +* return status is SVC_STATUS_RSU_OK or SVC_STATUS_RSU_ERROR */ enum stratix10_svc_command_code {COMMAND_NOOP =0 ,
@@ -103,7 +110,9 @@ enum stratix10_svc_command_code {COMMAND_RECONFIG_DATA_CLAIM ,COMMAND_RECONFIG_STATUS ,COMMAND_RSU_STATUS , - COMMAND_RSU_UPDATE +COMMAND_RSU_UPDATE , +COMMAND_RSU_NOTIFY , + COMMAND_RSU_RETRY, };/**
Signature · 1 line
2.7.4
PATCH v5 2/4 firmware: add Intel Stratix10 remote system update driver
In reply to [email protected]From: Richard Gong <[email protected]>
The Intel Remote System Update (RSU) driver exposes interfaces access through the Intel Service Layer to user space via sysfs interface. The RSU interfaces report and control some of the optional RSU features on Intel Stratix 10 SoC.
The RSU feature provides a way for customers to update the boot configuration of a Intel Stratix 10 SoC device with significantly reduced risk of corrupting the bitstream storage and bricking the system.
---
v2: s/SysFS/sysfs, s/scnprintf/sprintf,
s/attr_group/ATTRIBUTE_GROUPS, use devm_device_add_groups() and devm_device_remove_groups()
added check the return value from rsu_send_msg() removed a pr_info in stratix10_rsu_probe()
removed compatible = "intel,stratix10-rsu"
v3: no change
v4: removed devm_device_add_groups() & devm_device_remove_groups(),
utilized groups at struct device_driver
v5: changed to use dev_group pointer from driver core
added max_retry with watchdog event
--- drivers/firmware/Kconfig | 18 ++ drivers/firmware/Makefile | 1 + drivers/firmware/stratix10-rsu.c | 451 +++++++++++++++++++++++++++++++++++++++ 3 files changed, 470 insertions(+) create mode 100644 drivers/firmware/stratix10-rsu.c
drivers/firmware/Kconfig +18 -0
@@ -216,6 +216,24 @@ config INTEL_STRATIX10_SERVICE Say Y here if you want Stratix10 service layer support. +config INTEL_STRATIX10_RSU + tristate "Intel Stratix10 Remote System Update" + depends on INTEL_STRATIX10_SERVICE + help + The Intel Remote System Update (RSU) driver exposes interfaces + access through the Intel Service Layer to user space via sysfs + device attribute nodes. The RSU interfaces report/control some of + the optional RSU features of the Stratix 10 SoC FPGA. + + The RSU provides a way for customers to update the boot + configuration of a Stratix 10 SoC device with significantly reduced + risk of corrupting the bitstream storage and bricking the system. + + Enable RSU support if you are using an Intel SoC FPGA with the RSU + feature enabled and you want Linux user space control. + + Say Y here if you want Intel RSU support. + config QCOM_SCM bool depends on ARM || ARM64
drivers/firmware/Makefile +1 -0
@@ -11,6 +11,7 @@ obj-$(CONFIG_EDD) += edd.o obj-$(CONFIG_EFI_PCDP) += pcdp.o obj-$(CONFIG_DMIID) += dmi-id.o obj-$(CONFIG_INTEL_STRATIX10_SERVICE) += stratix10-svc.o +obj-$(CONFIG_INTEL_STRATIX10_RSU) += stratix10-rsu.o obj-$(CONFIG_ISCSI_IBFT_FIND) += iscsi_ibft_find.o obj-$(CONFIG_ISCSI_IBFT) += iscsi_ibft.o obj-$(CONFIG_FIRMWARE_MEMMAP) += memmap.o
drivers/firmware/stratix10-rsu.c new file +451 -0
451 lines not on this page · raw message
Signature · 1 line
2.7.4
kbuild test robot
build botRe: [PATCHv5 2/4] firmware: add Intel Stratix10 remote system update driver
Thank you for the patch! Yet something to improve:
Hi,
Thank you for the patch! Yet something to improve:
[auto build test ERROR on linus/master]
[cannot apply to v5.3-rc7 next-20190903]
[if your patch is applied to the wrong git tree, please drop us a note to help improve the system]
url: https://github.com/0day-ci/linux/commits/richard-gong-linux-intel-com/add-Intel-Stratix10-remote-system-update-driver/20190904-072434
config: arm64-allyesconfig (attached as .config)
compiler: aarch64-linux-gcc (GCC) 7.4.0
reproduce:
wget https://raw.githubusercontent.com/intel/lkp-tests/master/sbin/make.cross -O ~/bin/make.cross chmod +x ~/bin/make.cross
# save the attached .config to linux build tree
GCC_VERSION=7.4.0 make.cross ARCH=arm64
If you fix the issue, kindly add following tag
All errors (new ones prefixed by >>):
>> drivers/firmware/stratix10-rsu.c:443:4: error: 'struct device_driver' has no member named 'dev_groups'; did you mean 'groups'?
.dev_groups = rsu_groups,
^~~~~~~~~~
groups
>> drivers/firmware/stratix10-rsu.c:443:17: error: initialization from incompatible pointer type [-Werror=incompatible-pointer-types] .dev_groups = rsu_groups,
^~~~~~~~~~
drivers/firmware/stratix10-rsu.c:443:17: note: (near initialization for 'stratix10_rsu_driver.driver.bus')
cc1: some warnings being treated as errors
vim +443 drivers/firmware/stratix10-rsu.c
437
438 static struct platform_driver stratix10_rsu_driver = {
439 .probe = stratix10_rsu_probe,
440 .remove = stratix10_rsu_remove,
441 .driver = {
442 .name = "stratix10-rsu",
> 443 .dev_groups = rsu_groups,
444 },
445 };
446
---
0-DAY kernel test infrastructure Open Source Technology Center
https://lists.01.org/pipermail/kbuild-all Intel Corporation
PATCH v5 3/4 firmware: rsu: document sysfs interface
In reply to [email protected]From: Richard Gong <[email protected]>
Describe Intel Stratix10 Remote System Update (RSU) device attributes
---
v2: changed to use tab everywhere and wrap lines at 72 columns
s/soc:firmware:svc:rsu/stratix10-rsu.0
added for watchdog
v3: s/KernelVersion:5.2/KernelVersion:5.3
v4: replaced /sys/devices/platform/stratix10-rsu.0/ with
/sys/devices/.../stratix10-rsu.0/driver/
removed spaces
v5: corrected typo in the previous version
s/KernelVersion:5.3/KernelVersion:5.4
replace contact email address with [email protected]
replaced /sys/devices/.../stratix10-rsu.0/driver/ with
/sys/devices/platform/stratix10-rsu.0/
---
.../testing/sysfs-devices-platform-stratix10-rsu | 128 +++++++++++++++++++++
1 file changed, 128 insertions(+)
create mode 100644 Documentation/ABI/testing/sysfs-devices-platform-stratix10-rsuDocumentation/ABI/testing/sysfs-devices-platform-stratix10-rsu new file +128 -0
@@ -0,0 +1,128 @@ + Intel Stratix10 Remote System Update (RSU) device attributes + +What: /sys/devices/platform/stratix10-rsu.0/current_image +Date: August 2019 +KernelVersion: 5.4 +Contact: Richard Gong <[email protected]> +Description: + (RO) the address in flash of currently running image. + +What: /sys/devices/platform/stratix10-rsu.0/fail_image +Date: August 2019 +KernelVersion: 5.4 +Contact: Richard Gong <[email protected]> +Description: + (RO) the address in flash of failed image. + +What: /sys/devices/platform/stratix10-rsu.0/state +Date: August 2019 +KernelVersion: 5.4 +Contact: Richard Gong <[email protected]> +Description: + (RO) the state of RSU system. + The state field has two parts: major error code in + upper 16 bits and minor error code in lower 16 bits. + + b[15:0] + Currently used only when major error is 0xF006 + (CPU watchdog timeout), in which case the minor + error code is the value reported by CPU to + firmware through the RSU notify command before + the watchdog timeout occurs. + + b[31:16] + 0xF001 bitstream error + 0xF002 hardware access failure + 0xF003 bitstream corruption + 0xF004 internal error + 0xF005 device error + 0xF006 CPU watchdog timeout + 0xF007 internal unknown error + +What: /sys/devices/platform/stratix10-rsu.0/version +Date: August 2019 +KernelVersion: 5.4 +Contact: Richard Gong <[email protected]> +Description: + (RO) the version number of RSU firmware. 19.3 or late + version includes information about the firmware which + reported the error. + + pre 19.3: + b[31:0] + 0x0 version number + + 19.3 or late: + b[15:0] + 0x1 version number + b[31:16] + 0x0 no error + 0x0DCF Decision CMF error + 0x0ACF Application CMF error + +What: /sys/devices/platform/stratix10-rsu.0/error_location +Date: August 2019 +KernelVersion: 5.4 +Contact: Richard Gong <[email protected]> +Description: + (RO) the error offset inside the image that failed. + +What: /sys/devices/platform/stratix10-rsu.0/error_details +Date: August 2019 +KernelVersion: 5.4 +Contact: Richard Gong <[email protected]> +Description: + (RO) error code. + +What: /sys/devices/platform/stratix10-rsu.0/retry_counter +Date: August 2019 +KernelVersion: 5.4 +Contact: Richard Gong <[email protected]> +Description: + (RO) the current image's retry counter, which is used by + user to know how many times the images is still allowed + to reload itself before giving up and starting RSU + fail-over flow. + +What: /sys/devices/platform/stratix10-rsu.0/reboot_image +Date: August 2019 +KernelVersion: 5.4 +Contact: Richard Gong <[email protected]> +Description: + (WO) the address in flash of image to be loaded on next + reboot command. + +What: /sys/devices/platform/stratix10-rsu.0/notify +Date: August 2019 +KernelVersion: 5.4 +Contact: Richard Gong <[email protected]> +Description: + (WO) client to notify firmware with different actions. + + b[15:0] + inform firmware the current software execution + stage. + 0 the first stage bootloader didn't run or + didn't reach the point of launching second + stage bootloader. + 1 failed in second bootloader or didn't get + to the point of launching the operating + system. + 2 both first and second stage bootloader ran + and the operating system launch was + attempted. + + b[16] + 1 firmware to reset current image retry + counter. + 0 no action. + + b[17] + 1 firmware to clear RSU log + 0 no action. + + b[18] + this is negative logic + 1 no action + 0 firmware record the notify code defined + in b[15:0].
Signature · 1 line
2.7.4
PATCH v5 4/4 MAINTAINERS: add maintainer for Intel Stratix10 FW drivers
In reply to [email protected]From: Richard Gong <[email protected]>
Add myself as maintainer for the newly created Intel Stratix10 firmware drivers.
---
v2: removed RSU binding text file
v3: no change
v4: no change
v5: s/[email protected]/[email protected]
--- MAINTAINERS | 11 +++++++++++ 1 file changed, 11 insertions(+)
MAINTAINERS +11 -0
@@ -8396,6 +8396,17 @@ F: drivers/platform/x86/intel_speed_select_if/ F: tools/power/x86/intel-speed-select/ F: include/uapi/linux/isst_if.h +INTEL STRATIX10 FIRMWARE DRIVERS +M: Richard Gong <[email protected]> +L: [email protected] +S: Maintained +F: drivers/firmware/stratix10-rsu.c +F: drivers/firmware/stratix10-svc.c +F: include/linux/firmware/intel/stratix10-smc.h +F: include/linux/firmware/intel/stratix10-svc-client.h +F: Documentation/ABI/testing/sysfs-devices-platform-stratix10-rsu +F: Documentation/devicetree/bindings/firmware/intel,stratix10-svc.txt + INTEL TELEMETRY DRIVER M: Rajneesh Bhardwaj <[email protected]> M: "David E. Box" <[email protected]>
Signature · 1 line
2.7.4