> -----Original Message-----
> From: Weight, Russell H <russell.h.weight@xxxxxxxxx>
> Sent: Saturday, May 21, 2022 8:36 AM
> To: mdf@xxxxxxxxxx; Wu, Hao <hao.wu@xxxxxxxxx>; Xu, Yilun
> <yilun.xu@xxxxxxxxx>; lee.jones@xxxxxxxxxx; linux-fpga@xxxxxxxxxxxxxxx; linux-
> kernel@xxxxxxxxxxxxxxx
> Cc: trix@xxxxxxxxxx; marpagan@xxxxxxxxxx; lgoncalv@xxxxxxxxxx;
> matthew.gerlach@xxxxxxxxxxxxxxx; Muddebihal, Basheer Ahmed
> <basheer.ahmed.muddebihal@xxxxxxxxx>; Zhang, Tianfei
> <tianfei.zhang@xxxxxxxxx>; Weight, Russell H <russell.h.weight@xxxxxxxxx>
> Subject: [PATCH v21 0/5] FPGA MAX10 BMC Secure Update Driver
>
> The MAX10 BMC Secure Update driver instantiates the new Firmware Upload
> functionality of the Firmware Loader and provides the callback functions
> required to support secure updates on Intel n3000 PAC devices. This driver is
> implemented as a sub-driver of the Intel MAX10 BMC mfd driver.
>
> This driver interacts with the HW secure update engine of the FPGA card BMC in
> order to transfer new FPGA and BMC images to FLASH on the FPGA card.
> Security is enforced by hardware and firmware. The FPGA Card BMC Secure
> Update driver interacts with the firmware to initiate an update, pass in the
> necessary data, and collect status on the update.
>
> This driver provides sysfs files for displaying the flash count, the root entry
> hashes (REH), and the code-signing-key (CSK) cancellation vectors.
>
> Changelog v20 -> v21:
> - Replace WARN_ON() calls in flash_count_show() and show_canceled_csk()
> with a more elaborate test. Return -EINVAL and write a message to the
> kernel log. Call WARN_ON_ONCE().
> - Update m10bmc_sec_prepare() to ensure that the base address for an
> update image is aligned with stride.
> - Update m10bmc_sec_write() to handle a block size that is not aligned
> with stride by allocating a zero-filled block that is aligned, and
> copying the data before calling regmap_bulk_write().
>
> Changelog v19 -> v20:
> - Added text to commit messages to describe Root Entry Hashes (REH) and
> Code Signing Key (CSK) cancellation.
> - Use reverse christmas tree format for local variable declarations in
> show_root_entry_hash().
> - Remove WARN_ON() from show_root_entry_hash() and return -EINVAL if
> sha_num_bytes is not a multiple of stride.
> - Move MODULE_DEVICE_TABLE() macro to just beneath the definition of
> intel_m10bmc_sec_ids[].
>
> Changelog v18 -> v19:
> - Change "card bmc" naming back to "m10 bmc" naming to be consistent
> with the parent driver.
>
> Changelog v17 -> v18:
> - Changed the ABI documentation for the Root Entry Hashes to specify
> string as the format for the output.
> - Updated comments, strings and config options to more consistently
> refer to the driver as the Intel FPGA Card BMC Secure Update driver.
> - Removed an instance of dev_dbg().
> - Deferred the call to firmware_upload_register() to a later patch
> where the required ops are provided.
> - Switched from MODULE_ALIAS() to MODULE_DEVICE_TABLE() in anticipation
> of additional cards to be supported by the same driver.
>
> Changelog v16 -> v17:
> - Change m10bmc to cardbmc to reflect the fact that the future devices
> will not necessarily use the MAX10. This affects filenames, configs,
> symbol names, and the driver name.
> - Update the Date and KernelVersion for the ABI documentation to Jul 2022
> and 5.19 respectively.
> - Updated the copyright end-date to 2022 for the secure update driver.
> - Removed references to the FPGA Image Load class driver and replaced
> them with the new firmware-upload service from the firmware loader.
> - Use xarray_alloc to generate a unique number/name firmware-upload.
> - Chang the license from GPL to GPLv2 per commit bf7fbeeae6db ("module:
> Cure the MODULE_LICENSE "GPL" vs. "GPL v2" bogosity")
> - fw_upload_ops functions will return "enum fw_upload_err" data types
> instead of integer values.
>
> Changelog v15 -> v16:
> - Use 0 instead of FPGA_IMAGE_ERR_NONE to indicate success.
> - The size alignment check was moved from the FPGA Image Load framework
> to the prepare() op.
> - Added cancel_request boolean flag to struct m10bmc_sec.
> - Moved the RSU cancellation logic from m10bmc_sec_cancel() to a new
> rsu_cancel() function.
> - The m10bmc_sec_cancel() function ONLY sets the cancel_request flag.
> The cancel_request flag is checked at the beginning of the
> m10bmc_sec_write() and m10bmc_sec_poll_complete() functions.
> - Adapt to changed prototypes for the prepare() and write() ops. The
> m10bmc_sec_write_blk() function has been renamed to
> m10bmc_sec_write().
> - Created a cleanup op, m10bmc_sec_cleanup(), to attempt to cancel an
> ongoing op during when exiting the update process.
>
> Changelog v14 -> v15:
> - Updated the Dates and KernelVersions in the ABI documentation
> - Change driver name from "n3000bmc-secure" to "n3000bmc-sec-update".
> - Change CONFIG_FPGA_M10_BMC_SECURE to
> CONFIG_FPGA_M10_BMC_SEC_UPDATE.
> - Change instances of *bmc-secure to *bmc-sec-update in file name
> and symbol names.
> - Change instances of *m10bmc_secure* to *m10bmc-sec_update* in symbol
> names.
> - Adapted to changes in the FPGA Image Load framework:
> (1) All enum types (progress and errors) are now type u32
> (2) m10bmc_sec_write_blk() adds *blk_size and max_size parameters
> and uses *blk_size as provided by the caller.
> (3) m10bmc_sec_poll_complete() no long checks the driver_unload
> flag.
>
> Changelog v13 -> v14:
> - Changed symbol and text references to reflect the renaming of the
> Security Manager Class driver to FPGA Image Load.
>
> Changelog v12 -> v13:
> - Updated copyright to 2021
> - Updated Date and KernelVersion fields in ABI documentation
> - Call updated fpga_sec_mgr_register() and fpga_sec_mgr_unregister()
> functions instead of devm_fpga_sec_mgr_create() and
> devm_fpga_sec_mgr_register().
>
> Changelog v11 -> v12:
> - Updated Date and KernelVersion fields in ABI documentation
> - Removed size parameter from the write_blk() op. m10bmc_sec_write_blk()
> no longer has a size parameter, and the block size is determined
> in this (the lower-level) driver.
>
> Changelog v10 -> v11:
> - Added Reviewed-by tag to patch #1
>
> Changelog v9 -> v10:
> - Changed the path expressions in the sysfs documentation to
> replace the n3000 reference with something more generic to
> accommodate other devices that use the same driver.
>
> Changelog v8 -> v9:
> - Rebased to 5.12-rc2 next
> - Updated Date and KernelVersion in ABI documentation
>
> Changelog v7 -> v8:
> - Split out patch "mfd: intel-m10-bmc: support for MAX10 BMC Secure
> Updates" and submitted it separately:
> https://marc.info/?l=linux-kernel&m=161126987101096&w=2
>
> Changelog v6 -> v7:
> - Rebased patches for 5.11-rc2
> - Updated Date and KernelVersion in ABI documentation
>
> Changelog v5 -> v6:
> - Added WARN_ON() prior to several calls to regmap_bulk_read()
> to assert that the (SIZE / stride) calculations did not result
> in remainders.
> - Changed the (size / stride) calculation in regmap_bulk_write()
> call to ensure that we don't write one less than intended.
> - Changed flash_count_show() parameter list to achieve
> reverse-christmas tree format.
> - Removed unnecessary call to rsu_check_complete() in
> m10bmc_sec_poll_complete() and changed while loop to
> do/while loop.
> - Initialized auth_result and doorbell to HW_ERRINFO_POISON
> in m10bmc_sec_hw_errinfo() and removed unnecessary if statements.
>
> Changelog v4 -> v5:
> - Renamed sysfs node user_flash_count to flash_count and updated
> the sysfs documentation accordingly to more accurately descirbe
> the purpose of the count.
>
> Changelog v3 -> v4:
> - Moved sysfs files for displaying the flash count, the root
> entry hashes (REH), and the code-signing-key (CSK) cancellation
> vectors from the FPGA Security Manager class driver to this
> driver (as they are not generic enough for the class driver).
> - Added a new ABI documentation file with informtaion about the
> new sysfs entries: sysfs-driver-intel-m10-bmc-secure
> - Updated the MAINTAINERS file to add the new ABI documentation
> file: sysfs-driver-intel-m10-bmc-secure
> - Removed unnecessary ret variable from m10bmc_secure_probe()
> - Incorporated new devm_fpga_sec_mgr_register() function into
> m10bmc_secure_probe() and removed the m10bmc_secure_remove()
> function.
>
> Changelog v2 -> v3:
> - Changed "MAX10 BMC Security Engine driver" to "MAX10 BMC Secure
> Update driver"
> - Changed from "Intel FPGA Security Manager" to FPGA Security Manager"
> - Changed: iops -> sops, imgr -> smgr, IFPGA_ -> FPGA_, ifpga_ to fpga_
> - Removed wrapper functions (m10bmc_raw_*, m10bmc_sys_*). The
> underlying functions are now called directly.
> - Changed "_root_entry_hash" to "_reh", with a comment explaining
> what reh is.
> - Renamed get_csk_vector() to m10bmc_csk_vector()
> - Changed calling functions of functions that return "enum fpga_sec_err"
> to check for (ret != FPGA_SEC_ERR_NONE) instead of (ret)
>
> Changelog v1 -> v2:
> - These patches were previously submitted as part of a larger V1
> patch set under the title "Intel FPGA Security Manager Class Driver".
> - Grouped all changes to include/linux/mfd/intel-m10-bmc.h into a
> single patch: "mfd: intel-m10-bmc: support for MAX10 BMC Security
> Engine".
> - Removed ifpga_sec_mgr_init() and ifpga_sec_mgr_uinit() functions.
> - Adapted to changes in the Intel FPGA Security Manager by splitting
> the single call to ifpga_sec_mgr_register() into two function
> calls: devm_ifpga_sec_mgr_create() and ifpga_sec_mgr_register().
> - Replaced small function-creation macros for explicit function
> declarations.
> - Bug fix for the get_csk_vector() function to properly apply the
> stride variable in calls to m10bmc_raw_bulk_read().
> - Added m10bmc_ prefix to functions in m10bmc_iops structure
> - Implemented HW_ERRINFO_POISON for m10bmc_sec_hw_errinfo() to
> ensure that corresponding bits are set to 1 if we are unable
> to read the doorbell or auth_result registers.
> - Added comments and additional code cleanup per V1 review.
>
> Russ Weight (5):
> mfd: intel-m10-bmc: Rename n3000bmc-secure driver
> fpga: m10bmc-sec: create max10 bmc secure update
> fpga: m10bmc-sec: expose max10 flash update count
> fpga: m10bmc-sec: expose max10 canceled keys in sysfs
> fpga: m10bmc-sec: add max10 secure update functions
>
> .../sysfs-driver-intel-m10-bmc-sec-update | 61 ++
> MAINTAINERS | 7 +
> drivers/fpga/Kconfig | 12 +
> drivers/fpga/Makefile | 3 +
> drivers/fpga/intel-m10-bmc-sec-update.c | 640 ++++++++++++++++++
> drivers/mfd/intel-m10-bmc.c | 2 +-
> 6 files changed, 724 insertions(+), 1 deletion(-) create mode 100644
> Documentation/ABI/testing/sysfs-driver-intel-m10-bmc-sec-update
> create mode 100644 drivers/fpga/intel-m10-bmc-sec-update.c
>
>
> base-commit: 18ecd30af1a8402c162cca1bd58771c0e5be7815
Hi Russ,
I have tested this patch set Intel PAC N3000 card, it woks fine and this patch set looks good for me. You can add:
Tested-by: Tianfei Zhang <tianfei.zhang@xxxxxxxxx>
