Intel MAX10 BMC Secure Update Driver
v5 cover Intel MAX10 BMC Secure Update Driver
The Intel MAX10 BMC Secure Update driver instantiates the FPGA Security Manager class driver 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. Future instances of the MAX10 BMC will support other devices as well (e.g. d5005) and this same MAX10 BMC Secure Update driver will receive modifications to support that device.
This driver interacts with the HW secure update engine of the BMC in order to transfer new FPGA and BMC images to FLASH so that they will be automatically loaded when the FPGA card reboots. Security is enforced by hardware and firmware. The MAX10 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.
These patches are dependent on other patches that are under review. If you want to apply and compile these patches on linux-next, please apply these patches first:
(7 patches) https://marc.info/?l=linux-fpga&m=160462501901359&w=2
If you have an n3000 PAC card and want to test this driver, you will also need this patch:
(1 patch) https://marc.info/?l=linux-fpga&m=160379607703940&w=2
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 (6):
mfd: intel-m10-bmc: support for MAX10 BMC Secure Updates
fpga: m10bmc-sec: create max10 bmc secure update driver
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
fpga: m10bmc-sec: add max10 get_hw_errinfo callback func
.../testing/sysfs-driver-intel-m10-bmc-secure | 61 ++ MAINTAINERS | 2 + drivers/fpga/Kconfig | 11 + drivers/fpga/Makefile | 3 + drivers/fpga/intel-m10-bmc-secure.c | 542 ++++++++++++++++++ include/linux/mfd/intel-m10-bmc.h | 85 +++ 6 files changed, 704 insertions(+) create mode 100644 Documentation/ABI/testing/sysfs-driver-intel-m10-bmc-secure create mode 100644 drivers/fpga/intel-m10-bmc-secure.c
Signature · 1 line
2.25.1
PATCH v5 1/6 mfd: intel-m10-bmc: support for MAX10 BMC Secure Updates
Add macros and definitions required by the MAX10 BMC Secure Update driver.
---
v5:
- Renamed USER_FLASH_COUNT to STAGING_FLASH_COUNT
v4:
- No change
v3:
- Changed "MAX10 BMC Secure Engine driver" to "MAX10 BMC Secure Update driver"
- Removed wrapper functions (m10bmc_raw_*, m10bmc_sys_*). The underlying functions will be called directly.
v2:
- These functions and macros were previously distributed among the patches that needed them. They are now grouped together in a single patch containing changes to the Intel MAX10 BMC driver.
- Added DRBL_ prefix to some definitions
- Some address definitions were moved here from the .c files that use them.
--- include/linux/mfd/intel-m10-bmc.h | 85 +++++++++++++++++++++++++++++++ 1 file changed, 85 insertions(+)
include/linux/mfd/intel-m10-bmc.h +85 -0
@@ -13,6 +13,9 @@#define M10BMC_SYS_BASE 0x300800#define M10BMC_MEM_END 0x200000fc +#define M10BMC_STAGING_BASE 0x18000000 +#define M10BMC_STAGING_SIZE 0x3800000 +/* Register offset of system registers */ #define NIOS2_FW_VERSION 0x0#define M10BMC_TEST_REG 0x3c
@@ -21,6 +24,88 @@#define M10BMC_VER_PCB_INFO_MSK GENMASK(31, 24)#define M10BMC_VER_LEGACY_INVALID 0xffffffff +/* Secure update doorbell register, in system register region */ +#define M10BMC_DOORBELL 0x400 + +/* Authorization Result register, in system register region */ +#define M10BMC_AUTH_RESULT 0x404 + +/* Doorbell register fields */ +#define DRBL_RSU_REQUEST BIT(0) +#define DRBL_RSU_PROGRESS GENMASK(7, 4) +#define DRBL_HOST_STATUS GENMASK(11, 8) +#define DRBL_RSU_STATUS GENMASK(23, 16) +#define DRBL_PKVL_EEPROM_LOAD_SEC BIT(24) +#define DRBL_PKVL1_POLL_EN BIT(25) +#define DRBL_PKVL2_POLL_EN BIT(26) +#define DRBL_CONFIG_SEL BIT(28) +#define DRBL_REBOOT_REQ BIT(29) +#define DRBL_REBOOT_DISABLED BIT(30) + +/* Progress states */ +#define RSU_PROG_IDLE 0x0 +#define RSU_PROG_PREPARE 0x1 +#define RSU_PROG_READY 0x3 +#define RSU_PROG_AUTHENTICATING 0x4 +#define RSU_PROG_COPYING 0x5 +#define RSU_PROG_UPDATE_CANCEL 0x6 +#define RSU_PROG_PROGRAM_KEY_HASH 0x7 +#define RSU_PROG_RSU_DONE 0x8 +#define RSU_PROG_PKVL_PROM_DONE 0x9 + +/* Device and error states */ +#define RSU_STAT_NORMAL 0x0 +#define RSU_STAT_TIMEOUT 0x1 +#define RSU_STAT_AUTH_FAIL 0x2 +#define RSU_STAT_COPY_FAIL 0x3 +#define RSU_STAT_FATAL 0x4 +#define RSU_STAT_PKVL_REJECT 0x5 +#define RSU_STAT_NON_INC 0x6 +#define RSU_STAT_ERASE_FAIL 0x7 +#define RSU_STAT_WEAROUT 0x8 +#define RSU_STAT_NIOS_OK 0x80 +#define RSU_STAT_USER_OK 0x81 +#define RSU_STAT_FACTORY_OK 0x82 +#define RSU_STAT_USER_FAIL 0x83 +#define RSU_STAT_FACTORY_FAIL 0x84 +#define RSU_STAT_NIOS_FLASH_ERR 0x85 +#define RSU_STAT_FPGA_FLASH_ERR 0x86 + +#define HOST_STATUS_IDLE 0x0 +#define HOST_STATUS_WRITE_DONE 0x1 +#define HOST_STATUS_ABORT_RSU 0x2 + +#define rsu_prog (doorbell) FIELD_GET(DRBL_RSU_PROGRESS, doorbell) +#define rsu_stat (doorbell) FIELD_GET(DRBL_RSU_STATUS, doorbell) + +/* interval 100ms and timeout 5s */ +#define NIOS_HANDSHAKE_INTERVAL_US (100 * 1000) +#define NIOS_HANDSHAKE_TIMEOUT_US (5 * 1000 * 1000) + +/* RSU PREP Timeout (2 minutes) to erase flash staging area */ +#define RSU_PREP_INTERVAL_MS 100 +#define RSU_PREP_TIMEOUT_MS (2 * 60 * 1000) + +/* RSU Complete Timeout (40 minutes) for full flash update */ +#define RSU_COMPLETE_INTERVAL_MS 1000 +#define RSU_COMPLETE_TIMEOUT_MS (40 * 60 * 1000) + +/* Addresses for security related data in FLASH */ +#define BMC_REH_ADDR 0x17ffc004 +#define BMC_PROG_ADDR 0x17ffc000 +#define BMC_PROG_MAGIC 0x5746 + +#define SR_REH_ADDR 0x17ffd004 +#define SR_PROG_ADDR 0x17ffd000 +#define SR_PROG_MAGIC 0x5253 + +#define PR_REH_ADDR 0x17ffe004 +#define PR_PROG_ADDR 0x17ffe000 +#define PR_PROG_MAGIC 0x5250 + +/* Address of 4KB inverted bit vector containing staging area FLASH count */ +#define STAGING_FLASH_COUNT 0x17ffb000 +/** * struct intel_m10bmc - Intel MAX 10 BMC parent driver data structure * @dev: this device
Signature · 1 line
2.25.1
PATCH v5 2/6 fpga: m10bmc-sec: create max10 bmc secure update driver
In reply to Russ WeightCreate a platform driver that can be invoked as a sub driver for the Intel MAX10 BMC in order to support secure updates. This sub-driver will invoke an instance of the FPGA Security Manager class driver in order to expose sysfs interfaces for managing and monitoring secure updates to FPGA and BMC images.
This patch creates the MAX10 BMC Secure Update driver and provides sysfs files for displaying the current root entry hashes for the FPGA static region, the FPGA PR region, and the MAX10 BMC.
---
v5:
- No change
v4:
- Moved sysfs files for displaying the root entry hashes (REH) from the FPGA Security Manager class driver to here. The m10bmc_reh() and m10bmc_reh_size() functions are removed and the functionality from these functions is moved into a show_root_entry_hash() function for displaying the REHs.
- Added ABI documentation for 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.
v3:
- Changed from "Intel FPGA Security Manager" to FPGA Security Manager"
- Changed: iops -> sops, imgr -> smgr, IFPGA_ -> FPGA_, ifpga_ to fpga_
- Changed "MAX10 BMC Secure Engine driver" to "MAX10 BMC Secure Update driver"
- 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.
v2:
- Added drivers/fpga/intel-m10-bmc-secure.c file to MAINTAINERS.
- Switched to GENMASK(31, 16) for a couple of mask definitions.
- Moved MAX10 BMC address and function definitions to a separate patch.
- Replaced small function-creation macros with explicit function declarations.
- 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().
--- .../testing/sysfs-driver-intel-m10-bmc-secure | 29 ++++ MAINTAINERS | 2 + drivers/fpga/Kconfig | 11 ++ drivers/fpga/Makefile | 3 + drivers/fpga/intel-m10-bmc-secure.c | 134 ++++++++++++++++++ 5 files changed, 179 insertions(+) create mode 100644 Documentation/ABI/testing/sysfs-driver-intel-m10-bmc-secure create mode 100644 drivers/fpga/intel-m10-bmc-secure.c
Documentation/ABI/testing/sysfs-driver-intel-m10-bmc-secure new file +29 -0
@@ -0,0 +1,29 @@ +What: /sys/bus/platform/devices/n3000bmc-secure.*.auto/security/sr_root_entry_hash +Date: Oct 2020 +KernelVersion: 5.11 +Contact: Russ Weight <[email protected]> +Description: Read only. Returns the root entry hash for the static + region if one is programmed, else it returns the + string: "hash not programmed". This file is only + visible if the underlying device supports it. + Format: "0x%x". + +What: /sys/bus/platform/devices/n3000bmc-secure.*.auto/security/pr_root_entry_hash +Date: Oct 2020 +KernelVersion: 5.11 +Contact: Russ Weight <[email protected]> +Description: Read only. Returns the root entry hash for the partial + reconfiguration region if one is programmed, else it + returns the string: "hash not programmed". This file + is only visible if the underlying device supports it. + Format: "0x%x". + +What: /sys/bus/platform/devices/n3000bmc-secure.*.auto/security/bmc_root_entry_hash +Date: Oct 2020 +KernelVersion: 5.11 +Contact: Russ Weight <[email protected]> +Description: Read only. Returns the root entry hash for the BMC image + if one is programmed, else it returns the string: + "hash not programmed". This file is only visible if the + underlying device supports it. + Format: "0x%x".
MAINTAINERS +2 -0
@@ -6941,8 +6941,10 @@ M: Russ Weight <[email protected]> L: [email protected] S: Maintained F: Documentation/ABI/testing/sysfs-class-fpga-sec-mgr +F: Documentation/ABI/testing/sysfs-driver-intel-m10-bmc-secure F: Documentation/fpga/fpga-sec-mgr.rst F: drivers/fpga/fpga-sec-mgr.c +F: drivers/fpga/intel-m10-bmc-secure.c F: include/linux/fpga/fpga-sec-mgr.h FPU EMULATOR
drivers/fpga/Kconfig +11 -0
@@ -235,4 +235,15 @@ config FPGA_SEC_MGR region and for the BMC. Select this option to enable updates for secure FPGA devices. +config IFPGA_M10_BMC_SECURE + tristate "Intel MAX10 BMC Secure Update driver" + depends on MFD_INTEL_M10_BMC && FPGA_SEC_MGR + help + Secure update support for the Intel MAX10 board management + controller. + + This is a subdriver of the Intel MAX10 board management controller + (BMC) and provides support for secure updates for the BMC image, + the FPGA image, the Root Entry Hashes, etc. + endif # FPGA
drivers/fpga/Makefile +3 -0
@@ -24,6 +24,9 @@ obj-$(CONFIG_ALTERA_PR_IP_CORE_PLAT) += altera-pr-ip-core-plat.o # FPGA Security Manager Framework obj-$(CONFIG_FPGA_SEC_MGR) += fpga-sec-mgr.o +# FPGA Secure Update Drivers +obj-$(CONFIG_IFPGA_M10_BMC_SECURE) += intel-m10-bmc-secure.o + # FPGA Bridge Drivers obj-$(CONFIG_FPGA_BRIDGE) += fpga-bridge.o obj-$(CONFIG_SOCFPGA_FPGA_BRIDGE) += altera-hps2fpga.o altera-fpga2sdram.o
drivers/fpga/intel-m10-bmc-secure.c new file +134 -0
134 lines not on this page · raw message
Signature · 1 line
2.25.1
Tom Rix
reviewerRe: [PATCH v5 2/6] fpga: m10bmc-sec: create max10 bmc secure update driver
Quoted 194 lines · Russ Weight
Create a platform driver that can be invoked as a sub driver for the Intel MAX10 BMC in order to support secure updates. This sub-driver will invoke an instance of the FPGA Security Manager class driver in order to expose sysfs interfaces for managing and monitoring secure updates to FPGA and BMC images.
This patch creates the MAX10 BMC Secure Update driver and provides sysfs files for displaying the current root entry hashes for the FPGA static region, the FPGA PR region, and the MAX10 BMC.
Signed-off-by Russ Weight <[email protected]>---
v5:
- No change
v4:
- Moved sysfs files for displaying the root entry hashes (REH) from the FPGA Security Manager class driver to here. Them10bmc_reh()andm10bmc_reh_size()functions are removed and the functionality from these functions is moved into ashow_root_entry_hash()function for displaying the REHs.
- Added ABI documentation for the new sysfs entries:
sysfs-driver-intel-m10-bmc-secure
- Updated theMAINTAINERSfile to add the new ABI documentation
file: sysfs-driver-intel-m10-bmc-secure
- Removed unnecessary ret variable fromm10bmc_secure_probe()
- Incorporated newdevm_fpga_sec_mgr_register()function intom10bmc_secure_probe()and removed them10bmc_secure_remove()function.
v3:
- Changed from "Intel FPGA Security Manager" to FPGA Security Manager"
- Changed: iops -> sops, imgr -> smgr,IFPGA_->FPGA_,ifpga_tofpga_
- Changed "MAX10 BMC Secure Engine driver" to "MAX10 BMC Secure Update driver"
- 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.
v2:
- Addeddrivers/fpga/intel-m10-bmc-secure.cfile toMAINTAINERS.
- Switched toGENMASK(31, 16)for a couple of mask definitions.
- Moved MAX10 BMC address and function definitions to a separate patch.
- Replaced small function-creation macros with explicit function declarations.
- Removedifpga_sec_mgr_init()andifpga_sec_mgr_uinit()functions.
- Adapted to changes in the Intel FPGA Security Manager by splitting the single call toifpga_sec_mgr_register()into two function
calls:devm_ifpga_sec_mgr_create()andifpga_sec_mgr_register().--- .../testing/sysfs-driver-intel-m10-bmc-secure | 29 ++++ MAINTAINERS | 2 + drivers/fpga/Kconfig | 11 ++ drivers/fpga/Makefile | 3 + drivers/fpga/intel-m10-bmc-secure.c | 134 ++++++++++++++++++ 5 files changed, 179 insertions(+) create mode 100644 Documentation/ABI/testing/sysfs-driver-intel-m10-bmc-secure create mode 100644 drivers/fpga/intel-m10-bmc-secure.cDocumentation/ABI/testing/sysfs-driver-intel-m10-bmc-secure new file +29
-0@@ -0,0 +1,29 @@ +What: /sys/bus/platform/devices/n3000bmc-secure.*.auto/security/sr_root_entry_hash +Date: Oct 2020 +KernelVersion: 5.11 +Contact: Russ Weight <[email protected]> +Description: Read only. Returns the root entry hash for the static + region if one is programmed, else it returns the + string: "hash not programmed". This file is only + visible if the underlying device supports it. + Format: "0x%x". + +What: /sys/bus/platform/devices/n3000bmc-secure.*.auto/security/pr_root_entry_hash +Date: Oct 2020 +KernelVersion: 5.11 +Contact: Russ Weight <[email protected]> +Description: Read only. Returns the root entry hash for the partial + reconfiguration region if one is programmed, else it + returns the string: "hash not programmed". This file + is only visible if the underlying device supports it. + Format: "0x%x". + +What: /sys/bus/platform/devices/n3000bmc-secure.*.auto/security/bmc_root_entry_hash +Date: Oct 2020 +KernelVersion: 5.11 +Contact: Russ Weight <[email protected]> +Description: Read only. Returns the root entry hash for the BMC image + if one is programmed, else it returns the string: + "hash not programmed". This file is only visible if the + underlying device supports it. + Format: "0x%x".MAINTAINERS +2
-0@@ -6941,8 +6941,10 @@ M: Russ Weight <[email protected]> L: [email protected] S: Maintained F: Documentation/ABI/testing/sysfs-class-fpga-sec-mgr +F: Documentation/ABI/testing/sysfs-driver-intel-m10-bmc-secure F: Documentation/fpga/fpga-sec-mgr.rst F: drivers/fpga/fpga-sec-mgr.c +F: drivers/fpga/intel-m10-bmc-secure.c F: include/linux/fpga/fpga-sec-mgr.h FPU EMULATORdrivers/fpga/Kconfig +11
-0@@ -235,4 +235,15 @@ config FPGA_SEC_MGR region and for the BMC. Select this option to enable updates for secure FPGA devices. +config IFPGA_M10_BMC_SECURE + tristate "Intel MAX10 BMC Secure Update driver" + depends on MFD_INTEL_M10_BMC && FPGA_SEC_MGR + help + Secure update support for the Intel MAX10 board management + controller. + + This is a subdriver of the Intel MAX10 board management controller + (BMC) and provides support for secure updates for the BMC image, + the FPGA image, the Root Entry Hashes, etc. + endif # FPGAdrivers/fpga/Makefile +3
-0@@ -24,6 +24,9 @@ obj-$(CONFIG_ALTERA_PR_IP_CORE_PLAT) += altera-pr-ip-core-plat.o # FPGA Security Manager Framework obj-$(CONFIG_FPGA_SEC_MGR) += fpga-sec-mgr.o +# FPGA Secure Update Drivers +obj-$(CONFIG_IFPGA_M10_BMC_SECURE) += intel-m10-bmc-secure.o + # FPGA Bridge Drivers obj-$(CONFIG_FPGA_BRIDGE) += fpga-bridge.o obj-$(CONFIG_SOCFPGA_FPGA_BRIDGE) += altera-hps2fpga.o altera-fpga2sdram.odrivers/fpga/intel-m10-bmc-secure.c new file +44
-0@@ -0,0 +1,134 @@ +// SPDX-License-Identifier: GPL-2.0 +/* +* Intel Max10 Board Management Controller Secure Update Driver +* +* Copyright (C) 2019-2020 Intel Corporation. All rights reserved. +* +*/ +#include <linux/bitfield.h> +#include <linux/device.h> +#include <linux/fpga/fpga-sec-mgr.h> +#include <linux/mfd/intel-m10-bmc.h> +#include <linux/module.h> +#include <linux/platform_device.h> + +struct m10bmc_sec { +struct device *dev; +struct intel_m10bmc *m10bmc; +}; + +/* Root Entry Hash (REH) support */ +#define REH_SHA256_SIZE 32 +#define REH_SHA384_SIZE 48 +#define REH_MAGIC GENMASK(15, 0) +#define REH_SHA_NUM_BYTES GENMASK(31, 16) + +static ssize_t +show_root_entry_hash (struct device *dev,u32 exp_magic, +u32 prog_addr,u32 reh_addr,char *buf) +{ +struct m10bmc_sec *sec =dev_get_drvdata (dev); +unsigned int stride =regmap_get_reg_stride (sec->m10bmc->regmap); +int sha_num_bytes, i, cnt, ret; +u8 hash[REH_SHA384_SIZE ]; +u32 magic; + + ret =m10bmc_raw_read (sec->m10bmc, prog_addr, &magic); +if (ret) +return ret; + +dev_dbg (dev,"%s magic 0x%08x\n" , __func__, magic); + +if (FIELD_GET (REH_MAGIC , magic) != exp_magic) +return sysfs_emit (buf,"hash not programmed\n" ); +
drivers/fpga/intel-m10-bmc-secure.c line 54
Quoted 10 lines
drivers/fpga/intel-m10-bmc-secure.c new file +10
-0+ sha_num_bytes =FIELD_GET (REH_SHA_NUM_BYTES , magic) /8 ; +if (sha_num_bytes !=REH_SHA256_SIZE && + sha_num_bytes !=REH_SHA384_SIZE ) { +dev_err (sec->dev,"%s bad sha num bytes %d\n" , __func__, + sha_num_bytes); +return -EINVAL ; + } + + ret =regmap_bulk_read (sec->m10bmc->regmap, reh_addr, + hash, sha_num_bytes / stride);
Assumes !(sha_num_bytes % stride)
Maybe add an assert.
Tom
Quoted 80 lines
drivers/fpga/intel-m10-bmc-secure.c new file +80
-0+if (ret) { +dev_err (dev,"failed to read root entry hash: %x cnt %x: %d\n" , + reh_addr, sha_num_bytes / stride, ret); +return ret; + } + + cnt =sprintf (buf,"0x" ); +for (i =0 ; i < sha_num_bytes; i++) + cnt +=sprintf (buf + cnt,"%02x" , hash[i]); + cnt +=sprintf (buf + cnt,"\n" ); + +return cnt; +} + +#define DEVICE_ATTR_SEC_REH_RO (_name, _magic, _prog_addr, _reh_addr) \ +static ssize_t _name##_root_entry_hash_show(struct device *dev, \ + struct device_attribute *attr, \ + char *buf) \ +{ return show_root_entry_hash(dev, _magic, _prog_addr, _reh_addr, buf); } \ +static DEVICE_ATTR_RO(_name##_root_entry_hash) + +DEVICE_ATTR_SEC_REH_RO (bmc,BMC_PROG_MAGIC ,BMC_PROG_ADDR ,BMC_REH_ADDR ); +DEVICE_ATTR_SEC_REH_RO (sr,SR_PROG_MAGIC ,SR_PROG_ADDR ,SR_REH_ADDR ); +DEVICE_ATTR_SEC_REH_RO (pr,PR_PROG_MAGIC ,PR_PROG_ADDR ,PR_REH_ADDR ); + +static struct attribute *m10bmc_security_attrs[] = { + &dev_attr_bmc_root_entry_hash.attr, + &dev_attr_sr_root_entry_hash.attr, + &dev_attr_pr_root_entry_hash.attr, +NULL , +}; + +static struct attribute_group m10bmc_security_attr_group = { + .name ="security" , + .attrs = m10bmc_security_attrs, +}; + +static const struct attribute_group *m10bmc_sec_attr_groups[] = { + &m10bmc_security_attr_group, +NULL , +}; + +static const struct fpga_sec_mgr_ops m10bmc_sops = { }; + +static int m10bmc_secure_probe (struct platform_device *pdev) +{ +struct fpga_sec_mgr *smgr; +struct m10bmc_sec *sec; + + sec =devm_kzalloc (&pdev->dev,sizeof (*sec),GFP_KERNEL ); +if (!sec) +return -ENOMEM ; + + sec->dev = &pdev->dev; + sec->m10bmc =dev_get_drvdata (pdev->dev.parent); +dev_set_drvdata (&pdev->dev, sec); + + smgr =devm_fpga_sec_mgr_create (sec->dev,"Max10 BMC Secure Update" , + &m10bmc_sops, sec); +if (!smgr) { +dev_err (sec->dev,"Security manager failed to start\n" ); +return -ENOMEM ; + } + +return devm_fpga_sec_mgr_register (sec->dev, smgr); +} + +static struct platform_driver intel_m10bmc_secure_driver = { + .probe = m10bmc_secure_probe, + .driver = { + .name ="n3000bmc-secure" , + .dev_groups = m10bmc_sec_attr_groups, + }, +}; +module_platform_driver (intel_m10bmc_secure_driver); + +MODULE_ALIAS ("platform:n3000bmc-secure" ); +MODULE_AUTHOR ("Intel Corporation" ); +MODULE_DESCRIPTION ("Intel MAX10 BMC Secure Update" ); +MODULE_LICENSE ("GPL v2" );
Re: [PATCH v5 2/6] fpga: m10bmc-sec: create max10 bmc secure update driver
Quoted 198 lines · Tom Rix
Quoted 197 lines · Russ Weight
Create a platform driver that can be invoked as a sub driver for the Intel MAX10 BMC in order to support secure updates. This sub-driver will invoke an instance of the FPGA Security Manager class driver in order to expose sysfs interfaces for managing and monitoring secure updates to FPGA and BMC images.
This patch creates the MAX10 BMC Secure Update driver and provides sysfs files for displaying the current root entry hashes for the FPGA static region, the FPGA PR region, and the MAX10 BMC.
Signed-off-by Russ Weight <[email protected]>---
v5:
- No change
v4:
- Moved sysfs files for displaying the root entry hashes (REH) from the FPGA Security Manager class driver to here. Them10bmc_reh()andm10bmc_reh_size()functions are removed and the functionality from these functions is moved into ashow_root_entry_hash()function for displaying the REHs.
- Added ABI documentation for the new sysfs entries:
sysfs-driver-intel-m10-bmc-secure
- Updated theMAINTAINERSfile to add the new ABI documentation
file: sysfs-driver-intel-m10-bmc-secure
- Removed unnecessary ret variable fromm10bmc_secure_probe()
- Incorporated newdevm_fpga_sec_mgr_register()function intom10bmc_secure_probe()and removed them10bmc_secure_remove()function.
v3:
- Changed from "Intel FPGA Security Manager" to FPGA Security Manager"
- Changed: iops -> sops, imgr -> smgr,IFPGA_->FPGA_,ifpga_tofpga_
- Changed "MAX10 BMC Secure Engine driver" to "MAX10 BMC Secure Update driver"
- 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.
v2:
- Addeddrivers/fpga/intel-m10-bmc-secure.cfile toMAINTAINERS.
- Switched toGENMASK(31, 16)for a couple of mask definitions.
- Moved MAX10 BMC address and function definitions to a separate patch.
- Replaced small function-creation macros with explicit function declarations.
- Removedifpga_sec_mgr_init()andifpga_sec_mgr_uinit()functions.
- Adapted to changes in the Intel FPGA Security Manager by splitting the single call toifpga_sec_mgr_register()into two function
calls:devm_ifpga_sec_mgr_create()andifpga_sec_mgr_register().--- .../testing/sysfs-driver-intel-m10-bmc-secure | 29 ++++ MAINTAINERS | 2 + drivers/fpga/Kconfig | 11 ++ drivers/fpga/Makefile | 3 + drivers/fpga/intel-m10-bmc-secure.c | 134 ++++++++++++++++++ 5 files changed, 179 insertions(+) create mode 100644 Documentation/ABI/testing/sysfs-driver-intel-m10-bmc-secure create mode 100644 drivers/fpga/intel-m10-bmc-secure.cDocumentation/ABI/testing/sysfs-driver-intel-m10-bmc-secure new file +29
-0@@ -0,0 +1,29 @@ +What: /sys/bus/platform/devices/n3000bmc-secure.*.auto/security/sr_root_entry_hash +Date: Oct 2020 +KernelVersion: 5.11 +Contact: Russ Weight <[email protected]> +Description: Read only. Returns the root entry hash for the static + region if one is programmed, else it returns the + string: "hash not programmed". This file is only + visible if the underlying device supports it. + Format: "0x%x". + +What: /sys/bus/platform/devices/n3000bmc-secure.*.auto/security/pr_root_entry_hash +Date: Oct 2020 +KernelVersion: 5.11 +Contact: Russ Weight <[email protected]> +Description: Read only. Returns the root entry hash for the partial + reconfiguration region if one is programmed, else it + returns the string: "hash not programmed". This file + is only visible if the underlying device supports it. + Format: "0x%x". + +What: /sys/bus/platform/devices/n3000bmc-secure.*.auto/security/bmc_root_entry_hash +Date: Oct 2020 +KernelVersion: 5.11 +Contact: Russ Weight <[email protected]> +Description: Read only. Returns the root entry hash for the BMC image + if one is programmed, else it returns the string: + "hash not programmed". This file is only visible if the + underlying device supports it. + Format: "0x%x".MAINTAINERS +2
-0@@ -6941,8 +6941,10 @@ M: Russ Weight <[email protected]> L: [email protected] S: Maintained F: Documentation/ABI/testing/sysfs-class-fpga-sec-mgr +F: Documentation/ABI/testing/sysfs-driver-intel-m10-bmc-secure F: Documentation/fpga/fpga-sec-mgr.rst F: drivers/fpga/fpga-sec-mgr.c +F: drivers/fpga/intel-m10-bmc-secure.c F: include/linux/fpga/fpga-sec-mgr.h FPU EMULATORdrivers/fpga/Kconfig +11
-0@@ -235,4 +235,15 @@ config FPGA_SEC_MGR region and for the BMC. Select this option to enable updates for secure FPGA devices. +config IFPGA_M10_BMC_SECURE + tristate "Intel MAX10 BMC Secure Update driver" + depends on MFD_INTEL_M10_BMC && FPGA_SEC_MGR + help + Secure update support for the Intel MAX10 board management + controller. + + This is a subdriver of the Intel MAX10 board management controller + (BMC) and provides support for secure updates for the BMC image, + the FPGA image, the Root Entry Hashes, etc. + endif # FPGAdrivers/fpga/Makefile +3
-0@@ -24,6 +24,9 @@ obj-$(CONFIG_ALTERA_PR_IP_CORE_PLAT) += altera-pr-ip-core-plat.o # FPGA Security Manager Framework obj-$(CONFIG_FPGA_SEC_MGR) += fpga-sec-mgr.o +# FPGA Secure Update Drivers +obj-$(CONFIG_IFPGA_M10_BMC_SECURE) += intel-m10-bmc-secure.o + # FPGA Bridge Drivers obj-$(CONFIG_FPGA_BRIDGE) += fpga-bridge.o obj-$(CONFIG_SOCFPGA_FPGA_BRIDGE) += altera-hps2fpga.o altera-fpga2sdram.odrivers/fpga/intel-m10-bmc-secure.c new file +47
-0@@ -0,0 +1,134 @@ +// SPDX-License-Identifier: GPL-2.0 +/* +* Intel Max10 Board Management Controller Secure Update Driver +* +* Copyright (C) 2019-2020 Intel Corporation. All rights reserved. +* +*/ +#include <linux/bitfield.h> +#include <linux/device.h> +#include <linux/fpga/fpga-sec-mgr.h> +#include <linux/mfd/intel-m10-bmc.h> +#include <linux/module.h> +#include <linux/platform_device.h> + +struct m10bmc_sec { +struct device *dev; +struct intel_m10bmc *m10bmc; +}; + +/* Root Entry Hash (REH) support */ +#define REH_SHA256_SIZE 32 +#define REH_SHA384_SIZE 48 +#define REH_MAGIC GENMASK(15, 0) +#define REH_SHA_NUM_BYTES GENMASK(31, 16) + +static ssize_t +show_root_entry_hash (struct device *dev,u32 exp_magic, +u32 prog_addr,u32 reh_addr,char *buf) +{ +struct m10bmc_sec *sec =dev_get_drvdata (dev); +unsigned int stride =regmap_get_reg_stride (sec->m10bmc->regmap); +int sha_num_bytes, i, cnt, ret; +u8 hash[REH_SHA384_SIZE ]; +u32 magic; + + ret =m10bmc_raw_read (sec->m10bmc, prog_addr, &magic); +if (ret) +return ret; + +dev_dbg (dev,"%s magic 0x%08x\n" , __func__, magic); + +if (FIELD_GET (REH_MAGIC , magic) != exp_magic) +return sysfs_emit (buf,"hash not programmed\n" ); + + sha_num_bytes =FIELD_GET (REH_SHA_NUM_BYTES , magic) /8 ; +if (sha_num_bytes !=REH_SHA256_SIZE && + sha_num_bytes !=REH_SHA384_SIZE ) {
Quoted 8 lines
drivers/fpga/intel-m10-bmc-secure.c line 54
Quoted 7 lines
drivers/fpga/intel-m10-bmc-secure.c new file +7
-0+dev_err (sec->dev,"%s bad sha num bytes %d\n" , __func__, + sha_num_bytes); +return -EINVAL ; + } + + ret =regmap_bulk_read (sec->m10bmc->regmap, reh_addr, + hash, sha_num_bytes / stride);Assumes !(sha_num_bytes % stride)
Yes - good point. I'll add WARN_ON() here and for the CSK cancellation vectors. In these cases, the size values are fixed, so a WARN_ON should be sufficient.
Thanks,
- Russ
Quoted 85 lines
Maybe add an assert.
Tom
Quoted 80 lines
drivers/fpga/intel-m10-bmc-secure.c new file +80
-0+if (ret) { +dev_err (dev,"failed to read root entry hash: %x cnt %x: %d\n" , + reh_addr, sha_num_bytes / stride, ret); +return ret; + } + + cnt =sprintf (buf,"0x" ); +for (i =0 ; i < sha_num_bytes; i++) + cnt +=sprintf (buf + cnt,"%02x" , hash[i]); + cnt +=sprintf (buf + cnt,"\n" ); + +return cnt; +} + +#define DEVICE_ATTR_SEC_REH_RO (_name, _magic, _prog_addr, _reh_addr) \ +static ssize_t _name##_root_entry_hash_show(struct device *dev, \ + struct device_attribute *attr, \ + char *buf) \ +{ return show_root_entry_hash(dev, _magic, _prog_addr, _reh_addr, buf); } \ +static DEVICE_ATTR_RO(_name##_root_entry_hash) + +DEVICE_ATTR_SEC_REH_RO (bmc,BMC_PROG_MAGIC ,BMC_PROG_ADDR ,BMC_REH_ADDR ); +DEVICE_ATTR_SEC_REH_RO (sr,SR_PROG_MAGIC ,SR_PROG_ADDR ,SR_REH_ADDR ); +DEVICE_ATTR_SEC_REH_RO (pr,PR_PROG_MAGIC ,PR_PROG_ADDR ,PR_REH_ADDR ); + +static struct attribute *m10bmc_security_attrs[] = { + &dev_attr_bmc_root_entry_hash.attr, + &dev_attr_sr_root_entry_hash.attr, + &dev_attr_pr_root_entry_hash.attr, +NULL , +}; + +static struct attribute_group m10bmc_security_attr_group = { + .name ="security" , + .attrs = m10bmc_security_attrs, +}; + +static const struct attribute_group *m10bmc_sec_attr_groups[] = { + &m10bmc_security_attr_group, +NULL , +}; + +static const struct fpga_sec_mgr_ops m10bmc_sops = { }; + +static int m10bmc_secure_probe (struct platform_device *pdev) +{ +struct fpga_sec_mgr *smgr; +struct m10bmc_sec *sec; + + sec =devm_kzalloc (&pdev->dev,sizeof (*sec),GFP_KERNEL ); +if (!sec) +return -ENOMEM ; + + sec->dev = &pdev->dev; + sec->m10bmc =dev_get_drvdata (pdev->dev.parent); +dev_set_drvdata (&pdev->dev, sec); + + smgr =devm_fpga_sec_mgr_create (sec->dev,"Max10 BMC Secure Update" , + &m10bmc_sops, sec); +if (!smgr) { +dev_err (sec->dev,"Security manager failed to start\n" ); +return -ENOMEM ; + } + +return devm_fpga_sec_mgr_register (sec->dev, smgr); +} + +static struct platform_driver intel_m10bmc_secure_driver = { + .probe = m10bmc_secure_probe, + .driver = { + .name ="n3000bmc-secure" , + .dev_groups = m10bmc_sec_attr_groups, + }, +}; +module_platform_driver (intel_m10bmc_secure_driver); + +MODULE_ALIAS ("platform:n3000bmc-secure" ); +MODULE_AUTHOR ("Intel Corporation" ); +MODULE_DESCRIPTION ("Intel MAX10 BMC Secure Update" ); +MODULE_LICENSE ("GPL v2" );
Tom Rix
reviewerRe: [PATCH v5 2/6] fpga: m10bmc-sec: create max10 bmc secure update driver
Quoted 9 lines
Quoted 7 lines
drivers/fpga/intel-m10-bmc-secure.c line 54
Quoted 6 lines
drivers/fpga/intel-m10-bmc-secure.c new file +5
-0+return -EINVAL ; + } + + ret =regmap_bulk_read (sec->m10bmc->regmap, reh_addr, + hash, sha_num_bytes / stride);Assumes !(sha_num_bytes % stride)
Yes - good point. I'll add
WARN_ON()here and for the CSK cancellation vectors. In these cases, the size values are fixed, so aWARN_ONshould be sufficient.
Yes, thanks.
Tom
Quoted 3 lines
Thanks,
- Russ
PATCH v5 3/6 fpga: m10bmc-sec: expose max10 flash update count
In reply to Russ WeightExtend the MAX10 BMC Secure Update driver to provide a sysfs file to expose the flash update count for the FPGA user image.
---
v5:
- Renamed sysfs node user_flash_count to flash_count and updated the sysfs documentation accordingly.
v4:
- Moved the sysfs file for displaying the flash count from the FPGA Security Manager class driver to here. The m10bmc_user_flash_count() function is removed and the functionality is moved into a user_flash_count_show() function.
- Added ABI documentation for the new sysfs entry
v3:
- Changed: iops -> sops, imgr -> smgr, IFPGA_ -> FPGA_, ifpga_ to fpga_
- Changed "MAX10 BMC Secure Engine driver" to "MAX10 BMC Secure Update driver"
- Removed wrapper functions (m10bmc_raw_*, m10bmc_sys_*). The underlying functions are now called directly.
v2:
- Renamed get_qspi_flash_count() to m10bmc_user_flash_count()
- Minor code cleanup per review comments
- Added m10bmc_ prefix to functions in m10bmc_iops structure
--- .../testing/sysfs-driver-intel-m10-bmc-secure | 8 +++++ drivers/fpga/intel-m10-bmc-secure.c | 34 +++++++++++++++++++ 2 files changed, 42 insertions(+)
Documentation/ABI/testing/sysfs-driver-intel-m10-bmc-secure +8 -0
@@ -27,3 +27,11 @@ Description: Read only. Returns the root entry hash for the BMC image "hash not programmed". This file is only visible if the underlying device supports it. Format: "0x%x". + +What: /sys/bus/platform/devices/n3000bmc-secure.*.auto/security/flash_count +Date: Oct 2020 +KernelVersion: 5.11 +Contact: Russ Weight <[email protected]> +Description: Read only. Returns number of times the secure update + staging area has been flashed. + Format: "%u".
drivers/fpga/intel-m10-bmc-secure.c +34 -0
@@ -11,6 +11,7 @@#include <linux/mfd/intel-m10-bmc.h> #include <linux/module.h> #include <linux/platform_device.h> +#include <linux/slab.h> struct m10bmc_sec {struct device *dev;
@@ -77,7 +78,40 @@ DEVICE_ATTR_SEC_REH_RO(bmc, BMC_PROG_MAGIC, BMC_PROG_ADDR, BMC_REH_ADDR);DEVICE_ATTR_SEC_REH_RO (sr,SR_PROG_MAGIC ,SR_PROG_ADDR ,SR_REH_ADDR );DEVICE_ATTR_SEC_REH_RO (pr,PR_PROG_MAGIC ,PR_PROG_ADDR ,PR_REH_ADDR ); +#define FLASH_COUNT_SIZE 4096/* count stored as inverted bit vector */ + +static ssize_t flash_count_show (struct device *dev, +struct device_attribute *attr,char *buf) +{ +struct m10bmc_sec *sec =dev_get_drvdata (dev); +unsigned int stride =regmap_get_reg_stride (sec->m10bmc->regmap); +unsigned int num_bits =FLASH_COUNT_SIZE *8 ; +u8 *flash_buf; +int cnt, ret; + + flash_buf =kmalloc (FLASH_COUNT_SIZE ,GFP_KERNEL ); +if (!flash_buf) +return -ENOMEM ; + + ret =regmap_bulk_read (sec->m10bmc->regmap,STAGING_FLASH_COUNT , + flash_buf,FLASH_COUNT_SIZE / stride); +if (ret) { +dev_err (sec->dev, +"failed to read flash count: %x cnt %x: %d\n" , +STAGING_FLASH_COUNT ,FLASH_COUNT_SIZE / stride, ret); + goto exit_free; + } + cnt = num_bits -bitmap_weight ((unsigned long *)flash_buf, num_bits); + +exit_free: +kfree (flash_buf); + +return ret ? :sysfs_emit (buf,"%u\n" , cnt); +} +static DEVICE_ATTR_RO (flash_count); +static struct attribute *m10bmc_security_attrs[] = { + &dev_attr_flash_count.attr, &dev_attr_bmc_root_entry_hash.attr, &dev_attr_sr_root_entry_hash.attr, &dev_attr_pr_root_entry_hash.attr,
Signature · 1 line
2.25.1
Moritz Fischer
maintainerRe: [PATCH v5 3/6] fpga: m10bmc-sec: expose max10 flash update count
Quoted 64 lines · Russ Weight
Extend the MAX10 BMC Secure Update driver to provide a sysfs file to expose the flash update count for the FPGA user image.
Signed-off-by Russ Weight <[email protected]>Reviewed-by Tom Rix <[email protected]>---
v5:
- Renamed sysfs nodeuser_flash_counttoflash_countand updated the sysfs documentation accordingly.
v4:
- Moved the sysfs file for displaying the flash count from the FPGA Security Manager class driver to here. Them10bmc_user_flash_count()function is removed and the functionality is moved into auser_flash_count_show()function.
- Added ABI documentation for the new sysfs entry
v3:
- Changed: iops -> sops, imgr -> smgr,IFPGA_->FPGA_,ifpga_tofpga_
- Changed "MAX10 BMC Secure Engine driver" to "MAX10 BMC Secure Update driver"
- Removed wrapper functions (m10bmc_raw_*, m10bmc_sys_*). The underlying functions are now called directly.
v2:
- Renamedget_qspi_flash_count()tom10bmc_user_flash_count()
- Minor code cleanup per review comments
- Addedm10bmc_prefix to functions inm10bmc_iopsstructure--- .../testing/sysfs-driver-intel-m10-bmc-secure | 8 +++++ drivers/fpga/intel-m10-bmc-secure.c | 34 +++++++++++++++++++ 2 files changed, 42 insertions(+)Documentation/ABI/testing/sysfs-driver-intel-m10-bmc-secure +8
-0@@ -27,3 +27,11 @@ Description: Read only. Returns the root entry hash for the BMC image "hash not programmed". This file is only visible if the underlying device supports it. Format: "0x%x". + +What: /sys/bus/platform/devices/n3000bmc-secure.*.auto/security/flash_count +Date: Oct 2020 +KernelVersion: 5.11 +Contact: Russ Weight <[email protected]> +Description: Read only. Returns number of times the secure update + staging area has been flashed. + Format: "%u".drivers/fpga/intel-m10-bmc-secure.c +1
-0@@ -11,6 +11,7 @@#include <linux/mfd/intel-m10-bmc.h> #include <linux/module.h> #include <linux/platform_device.h> +#include <linux/slab.h> struct m10bmc_sec {struct device *dev;@@ -77,7 +78,40 @@ DEVICE_ATTR_SEC_REH_RO(bmc, BMC_PROG_MAGIC, BMC_PROG_ADDR, BMC_REH_ADDR);DEVICE_ATTR_SEC_REH_RO (sr,SR_PROG_MAGIC ,SR_PROG_ADDR ,SR_REH_ADDR );DEVICE_ATTR_SEC_REH_RO (pr,PR_PROG_MAGIC ,PR_PROG_ADDR ,PR_REH_ADDR );
drivers/fpga/intel-m10-bmc-secure.c DEVICE_ATTR_SEC_REH_RO(bmc, BMC_PROG_MAGIC, BMC_PROG_ADDR, BMC_REH_ADDR); · line 90
Quoted 10 lines
drivers/fpga/intel-m10-bmc-secure.c +10
-0+#define FLASH_COUNT_SIZE 4096/* count stored as inverted bit vector */ + +static ssize_t flash_count_show (struct device *dev, +struct device_attribute *attr,char *buf) +{ +struct m10bmc_sec *sec =dev_get_drvdata (dev); +unsigned int stride =regmap_get_reg_stride (sec->m10bmc->regmap); +unsigned int num_bits =FLASH_COUNT_SIZE *8 ; +u8 *flash_buf; +int cnt, ret;
(Nit) Can you make this:
struct m10bmc_sec *sec = dev_get_drvdata(dev); unsigned int stride, num_bits; u8 *flash_buf; int cnt, ret; stride = regmap_get_reg_stride(sec->m10bmc->regmap); num_bits = FLASH_COUNT_SIZE * 8;
Quoted 30 lines
drivers/fpga/intel-m10-bmc-secure.c +23
-0+ + flash_buf =kmalloc (FLASH_COUNT_SIZE ,GFP_KERNEL ); +if (!flash_buf) +return -ENOMEM ; + + ret =regmap_bulk_read (sec->m10bmc->regmap,STAGING_FLASH_COUNT , + flash_buf,FLASH_COUNT_SIZE / stride); +if (ret) { +dev_err (sec->dev, +"failed to read flash count: %x cnt %x: %d\n" , +STAGING_FLASH_COUNT ,FLASH_COUNT_SIZE / stride, ret); + goto exit_free; + } + cnt = num_bits -bitmap_weight ((unsigned long *)flash_buf, num_bits); + +exit_free: +kfree (flash_buf); + +return ret ? :sysfs_emit (buf,"%u\n" , cnt); +} +static DEVICE_ATTR_RO (flash_count); +static struct attribute *m10bmc_security_attrs[] = { + &dev_attr_flash_count.attr, &dev_attr_bmc_root_entry_hash.attr, &dev_attr_sr_root_entry_hash.attr, &dev_attr_pr_root_entry_hash.attr,Signature · 1 line
2.25.1
Otherwise looks good to me,
- Moritz
Re: [PATCH v5 3/6] fpga: m10bmc-sec: expose max10 flash update count
Quoted 77 lines · Moritz Fischer
Quoted 64 lines · Russ Weight
Extend the MAX10 BMC Secure Update driver to provide a sysfs file to expose the flash update count for the FPGA user image.
Signed-off-by Russ Weight <[email protected]>Reviewed-by Tom Rix <[email protected]>---
v5:
- Renamed sysfs nodeuser_flash_counttoflash_countand updated the sysfs documentation accordingly.
v4:
- Moved the sysfs file for displaying the flash count from the FPGA Security Manager class driver to here. Them10bmc_user_flash_count()function is removed and the functionality is moved into auser_flash_count_show()function.
- Added ABI documentation for the new sysfs entry
v3:
- Changed: iops -> sops, imgr -> smgr,IFPGA_->FPGA_,ifpga_tofpga_
- Changed "MAX10 BMC Secure Engine driver" to "MAX10 BMC Secure Update driver"
- Removed wrapper functions (m10bmc_raw_*, m10bmc_sys_*). The underlying functions are now called directly.
v2:
- Renamedget_qspi_flash_count()tom10bmc_user_flash_count()
- Minor code cleanup per review comments
- Addedm10bmc_prefix to functions inm10bmc_iopsstructure--- .../testing/sysfs-driver-intel-m10-bmc-secure | 8 +++++ drivers/fpga/intel-m10-bmc-secure.c | 34 +++++++++++++++++++ 2 files changed, 42 insertions(+)Documentation/ABI/testing/sysfs-driver-intel-m10-bmc-secure +8
-0@@ -27,3 +27,11 @@ Description: Read only. Returns the root entry hash for the BMC image "hash not programmed". This file is only visible if the underlying device supports it. Format: "0x%x". + +What: /sys/bus/platform/devices/n3000bmc-secure.*.auto/security/flash_count +Date: Oct 2020 +KernelVersion: 5.11 +Contact: Russ Weight <[email protected]> +Description: Read only. Returns number of times the secure update + staging area has been flashed. + Format: "%u".drivers/fpga/intel-m10-bmc-secure.c +1
-0@@ -11,6 +11,7 @@#include <linux/mfd/intel-m10-bmc.h> #include <linux/module.h> #include <linux/platform_device.h> +#include <linux/slab.h> struct m10bmc_sec {struct device *dev;@@ -77,7 +78,40 @@ DEVICE_ATTR_SEC_REH_RO(bmc, BMC_PROG_MAGIC, BMC_PROG_ADDR, BMC_REH_ADDR);DEVICE_ATTR_SEC_REH_RO (sr,SR_PROG_MAGIC ,SR_PROG_ADDR ,SR_REH_ADDR );DEVICE_ATTR_SEC_REH_RO (pr,PR_PROG_MAGIC ,PR_PROG_ADDR ,PR_REH_ADDR );drivers/fpga/intel-m10-bmc-secure.c DEVICE_ATTR_SEC_REH_RO(bmc, BMC_PROG_MAGIC, BMC_PROG_ADDR, BMC_REH_ADDR); · line 90
Quoted 10 lines
drivers/fpga/intel-m10-bmc-secure.c +10
-0+#define FLASH_COUNT_SIZE 4096/* count stored as inverted bit vector */ + +static ssize_t flash_count_show (struct device *dev, +struct device_attribute *attr,char *buf) +{ +struct m10bmc_sec *sec =dev_get_drvdata (dev); +unsigned int stride =regmap_get_reg_stride (sec->m10bmc->regmap); +unsigned int num_bits =FLASH_COUNT_SIZE *8 ; +u8 *flash_buf; +int cnt, ret;(Nit) Can you make this:
Quoted 7 lines
struct m10bmc_sec *sec = dev_get_drvdata(dev); unsigned int stride, num_bits; u8 *flash_buf; int cnt, ret; stride = regmap_get_reg_stride(sec->m10bmc->regmap); num_bits = FLASH_COUNT_SIZE * 8;
Sure - I'll make the change. Thanks,
- Russ
Quoted 35 lines
Quoted 32 lines
drivers/fpga/intel-m10-bmc-secure.c +23
-0+ + flash_buf =kmalloc (FLASH_COUNT_SIZE ,GFP_KERNEL ); +if (!flash_buf) +return -ENOMEM ; + + ret =regmap_bulk_read (sec->m10bmc->regmap,STAGING_FLASH_COUNT , + flash_buf,FLASH_COUNT_SIZE / stride); +if (ret) { +dev_err (sec->dev, +"failed to read flash count: %x cnt %x: %d\n" , +STAGING_FLASH_COUNT ,FLASH_COUNT_SIZE / stride, ret); + goto exit_free; + } + cnt = num_bits -bitmap_weight ((unsigned long *)flash_buf, num_bits); + +exit_free: +kfree (flash_buf); + +return ret ? :sysfs_emit (buf,"%u\n" , cnt); +} +static DEVICE_ATTR_RO (flash_count); +static struct attribute *m10bmc_security_attrs[] = { + &dev_attr_flash_count.attr, &dev_attr_bmc_root_entry_hash.attr, &dev_attr_sr_root_entry_hash.attr, &dev_attr_pr_root_entry_hash.attr,Signature · 1 line
2.25.1Otherwise looks good to me,
- Moritz
PATCH v5 4/6 fpga: m10bmc-sec: expose max10 canceled keys in sysfs
In reply to Russ WeightExtend the MAX10 BMC Secure Update driver to provide sysfs files to expose the canceled code signing key (CSK) bit vectors. These use the standard bitmap list format (e.g. 1,2-6,9).
---
v5:
- No change
v4:
- Moved sysfs files for displaying the code-signing-key (CSK) cancellation vectors from the FPGA Security Manger class driver to here. The m10bmc_csk_vector() and m10bmc_csk_cancel_nbits() functions are removed and the functionality from these functions is moved into a show_canceled_csk() function for for displaying the CSK vectors.
- Added ABI documentation for new sysfs entries
v3:
- Changed: iops -> sops, imgr -> smgr, IFPGA_ -> FPGA_, ifpga_ to fpga_
- Changed "MAX10 BMC Secure Engine driver" to "MAX10 BMC Secure Update driver"
- Removed wrapper functions (m10bmc_raw_*, m10bmc_sys_*). The underlying functions are now called directly.
- Renamed get_csk_vector() to m10bmc_csk_vector()
v2:
- Replaced small function-creation macros for explicit function declarations.
- Fixed 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
--- .../testing/sysfs-driver-intel-m10-bmc-secure | 24 ++++++++++ drivers/fpga/intel-m10-bmc-secure.c | 46 +++++++++++++++++++ 2 files changed, 70 insertions(+)
Documentation/ABI/testing/sysfs-driver-intel-m10-bmc-secure +24 -0
@@ -28,6 +28,30 @@ Description: Read only. Returns the root entry hash for the BMC image underlying device supports it. Format: "0x%x". +What: /sys/bus/platform/devices/n3000bmc-secure.*.auto/security/sr_canceled_csks +Date: Oct 2020 +KernelVersion: 5.11 +Contact: Russ Weight <[email protected]> +Description: Read only. Returns a list of indices for canceled code + signing keys for the static region. The standard bitmap + list format is used (e.g. "1,2-6,9"). + +What: /sys/bus/platform/devices/n3000bmc-secure.*.auto/security/pr_canceled_csks +Date: Oct 2020 +KernelVersion: 5.11 +Contact: Russ Weight <[email protected]> +Description: Read only. Returns a list of indices for canceled code + signing keys for the partial reconfiguration region. The + standard bitmap list format is used (e.g. "1,2-6,9"). + +What: /sys/bus/platform/devices/n3000bmc-secure.*.auto/security/bmc_canceled_csks +Date: Oct 2020 +KernelVersion: 5.11 +Contact: Russ Weight <[email protected]> +Description: Read only. Returns a list of indices for canceled code + signing keys for the BMC. The standard bitmap list format + is used (e.g. "1,2-6,9"). + What: /sys/bus/platform/devices/n3000bmc-secure.*.auto/security/flash_count Date: Oct 2020 KernelVersion: 5.11
drivers/fpga/intel-m10-bmc-secure.c +46 -0
58 lines not on this page · raw message
Signature · 1 line
2.25.1
PATCH v5 5/6 fpga: m10bmc-sec: add max10 secure update functions
In reply to Russ WeightExtend the MAX10 BMC Secure Update driver to include the functions that enable secure updates of BMC images, FPGA images, etc.
---
v5:
- No change
v4:
- No change
v3:
- Changed: iops -> sops, imgr -> smgr, IFPGA_ -> FPGA_, ifpga_ to fpga_
- Changed "MAX10 BMC Secure Engine driver" to "MAX10 BMC Secure Update driver"
- Removed wrapper functions (m10bmc_raw_*, m10bmc_sys_*). The underlying functions are now called directly.
- Changed calling functions of functions that return "enum fpga_sec_err"
to check for (ret != FPGA_SEC_ERR_NONE) instead of (ret)
v2:
- Reworked the rsu_start_done() function to make it more readable
- Reworked while-loop condition/content in rsu_prog_ready()
- Minor code cleanup per review comments
- Added a comment to the m10bmc_sec_poll_complete() function to explain the context (could take 30+ minutes to complete).
- Added m10bmc_ prefix to functions in m10bmc_iops structure
- Moved MAX10 BMC address and function definitions to a separate patch.
--- drivers/fpga/intel-m10-bmc-secure.c | 305 +++++++++++++++++++++++++++- 1 file changed, 304 insertions(+), 1 deletion(-)
drivers/fpga/intel-m10-bmc-secure.c +304 -1
@@ -174,7 +174,310 @@ static const struct attribute_group *m10bmc_sec_attr_groups[] = { NULL, }; -static const struct fpga_sec_mgr_ops m10bmc_sops = { }; +static void log_error_regs (struct m10bmc_sec *sec,u32 doorbell) +{ +u32 auth_result; + +dev_err (sec->dev,"RSU error status: 0x%08x\n" , doorbell); + +if (!m10bmc_sys_read (sec->m10bmc,M10BMC_AUTH_RESULT , &auth_result)) +dev_err (sec->dev,"RSU auth result: 0x%08x\n" , auth_result); +} + +static enum fpga_sec_err rsu_check_idle (struct m10bmc_sec *sec) +{ +u32 doorbell; +int ret; + + ret =m10bmc_sys_read (sec->m10bmc,M10BMC_DOORBELL , &doorbell); +if (ret) +return FPGA_SEC_ERR_RW_ERROR ; + +if (rsu_prog (doorbell) !=RSU_PROG_IDLE && +rsu_prog (doorbell) !=RSU_PROG_RSU_DONE ) { +log_error_regs (sec, doorbell); +return FPGA_SEC_ERR_BUSY ; + } + +return FPGA_SEC_ERR_NONE ; +} + +static inline bool rsu_start_done (u32 doorbell) +{ +u32 status, progress; + +if (doorbell &DRBL_RSU_REQUEST ) +return false; + + status =rsu_stat (doorbell); +if (status ==RSU_STAT_ERASE_FAIL || status ==RSU_STAT_WEAROUT ) +return true; + + progress =rsu_prog (doorbell); +if (progress !=RSU_PROG_IDLE && progress !=RSU_PROG_RSU_DONE ) +return true; + +return false; +} + +static enum fpga_sec_err rsu_update_init (struct m10bmc_sec *sec) +{ +u32 doorbell, status; +int ret; + + ret =regmap_update_bits (sec->m10bmc->regmap, +M10BMC_SYS_BASE +M10BMC_DOORBELL , +DRBL_RSU_REQUEST |DRBL_HOST_STATUS , +DRBL_RSU_REQUEST | +FIELD_PREP (DRBL_HOST_STATUS , +HOST_STATUS_IDLE )); +if (ret) +return FPGA_SEC_ERR_RW_ERROR ; + + ret =regmap_read_poll_timeout (sec->m10bmc->regmap, +M10BMC_SYS_BASE +M10BMC_DOORBELL , + doorbell, +rsu_start_done (doorbell), +NIOS_HANDSHAKE_INTERVAL_US , +NIOS_HANDSHAKE_TIMEOUT_US ); + +if (ret == -ETIMEDOUT ) { +log_error_regs (sec, doorbell); +return FPGA_SEC_ERR_TIMEOUT ; + }else if (ret) { +return FPGA_SEC_ERR_RW_ERROR ; + } + + status =rsu_stat (doorbell); +if (status ==RSU_STAT_WEAROUT ) { +dev_warn (sec->dev,"Excessive flash update count detected\n" ); +return FPGA_SEC_ERR_WEAROUT ; + }else if (status ==RSU_STAT_ERASE_FAIL ) { +log_error_regs (sec, doorbell); +return FPGA_SEC_ERR_HW_ERROR ; + } + +return FPGA_SEC_ERR_NONE ; +} + +static enum fpga_sec_err rsu_prog_ready (struct m10bmc_sec *sec) +{ +unsigned long poll_timeout; +u32 doorbell, progress; +int ret; + + ret =m10bmc_sys_read (sec->m10bmc,M10BMC_DOORBELL , &doorbell); +if (ret) +return FPGA_SEC_ERR_RW_ERROR ; + + poll_timeout = jiffies +msecs_to_jiffies (RSU_PREP_TIMEOUT_MS ); +while (rsu_prog (doorbell) ==RSU_PROG_PREPARE ) { +msleep (RSU_PREP_INTERVAL_MS ); +if (time_after (jiffies, poll_timeout)) +break ; + + ret =m10bmc_sys_read (sec->m10bmc,M10BMC_DOORBELL , &doorbell); +if (ret) +return FPGA_SEC_ERR_RW_ERROR ; + } + + progress =rsu_prog (doorbell); +if (progress ==RSU_PROG_PREPARE ) { +log_error_regs (sec, doorbell); +return FPGA_SEC_ERR_TIMEOUT ; + }else if (progress !=RSU_PROG_READY ) { +log_error_regs (sec, doorbell); +return FPGA_SEC_ERR_HW_ERROR ; + } + +return FPGA_SEC_ERR_NONE ; +} + +static enum fpga_sec_err rsu_send_data (struct m10bmc_sec *sec) +{ +u32 doorbell; +int ret; + + ret =regmap_update_bits (sec->m10bmc->regmap, +M10BMC_SYS_BASE +M10BMC_DOORBELL , +DRBL_HOST_STATUS , +FIELD_PREP (DRBL_HOST_STATUS , +HOST_STATUS_WRITE_DONE )); +if (ret) +return FPGA_SEC_ERR_RW_ERROR ; + + ret =regmap_read_poll_timeout (sec->m10bmc->regmap, +M10BMC_SYS_BASE +M10BMC_DOORBELL , + doorbell, +rsu_prog (doorbell) !=RSU_PROG_READY , +NIOS_HANDSHAKE_INTERVAL_US , +NIOS_HANDSHAKE_TIMEOUT_US ); + +if (ret == -ETIMEDOUT ) { +log_error_regs (sec, doorbell); +return FPGA_SEC_ERR_TIMEOUT ; + }else if (ret) { +return FPGA_SEC_ERR_RW_ERROR ; + } + +switch (rsu_stat (doorbell)) { +case RSU_STAT_NORMAL : +case RSU_STAT_NIOS_OK : +case RSU_STAT_USER_OK : +case RSU_STAT_FACTORY_OK : +break ; +default : +log_error_regs (sec, doorbell); +return FPGA_SEC_ERR_HW_ERROR ; + } + +return FPGA_SEC_ERR_NONE ; +} + +static int rsu_check_complete (struct m10bmc_sec *sec,u32 *doorbell) +{ +if (m10bmc_sys_read (sec->m10bmc,M10BMC_DOORBELL , doorbell)) +return -EIO ; + +switch (rsu_stat (*doorbell)) { +case RSU_STAT_NORMAL : +case RSU_STAT_NIOS_OK : +case RSU_STAT_USER_OK : +case RSU_STAT_FACTORY_OK : +case RSU_STAT_WEAROUT : +break ; +default : +return -EINVAL ; + } + +switch (rsu_prog (*doorbell)) { +case RSU_PROG_IDLE : +case RSU_PROG_RSU_DONE : +return 0 ; +case RSU_PROG_AUTHENTICATING : +case RSU_PROG_COPYING : +case RSU_PROG_UPDATE_CANCEL : +case RSU_PROG_PROGRAM_KEY_HASH : +return -EAGAIN ; +default : +return -EINVAL ; + } +} + +static enum fpga_sec_err m10bmc_sec_prepare (struct fpga_sec_mgr *smgr) +{ +struct m10bmc_sec *sec = smgr->priv; +enum fpga_sec_err ret; + +if (smgr->remaining_size >M10BMC_STAGING_SIZE ) +return FPGA_SEC_ERR_INVALID_SIZE ; + + ret =rsu_check_idle (sec); +if (ret !=FPGA_SEC_ERR_NONE ) +return ret; + + ret =rsu_update_init (sec); +if (ret !=FPGA_SEC_ERR_NONE ) +return ret; + +return rsu_prog_ready (sec); +} + +static enum fpga_sec_err +m10bmc_sec_write_blk (struct fpga_sec_mgr *smgr,u32 offset,u32 size) +{ +struct m10bmc_sec *sec = smgr->priv; +unsigned int stride =regmap_get_reg_stride (sec->m10bmc->regmap); +u32 doorbell; +int ret; + + ret =m10bmc_sys_read (sec->m10bmc,M10BMC_DOORBELL , &doorbell); +if (ret) { +return FPGA_SEC_ERR_RW_ERROR ; + }else if (rsu_prog (doorbell) !=RSU_PROG_READY ) { +log_error_regs (sec, doorbell); +return FPGA_SEC_ERR_HW_ERROR ; + } + + ret =regmap_bulk_write (sec->m10bmc->regmap, +M10BMC_STAGING_BASE + offset, + (void *)smgr->data + offset, size / stride); + +return ret ?FPGA_SEC_ERR_RW_ERROR :FPGA_SEC_ERR_NONE ; +} + +/* +* m10bmc_sec_poll_complete() is called after handing things off to +* the BMC firmware. Depending on the type of update, it could be +* 30+ minutes before the BMC firmware completes the update. The +* smgr->driver_unload check allows the driver to be unloaded, +* but the BMC firmware will continue the update and no further +* secure updates can be started for this device until the update +* is complete. +*/ +static enum fpga_sec_err m10bmc_sec_poll_complete (struct fpga_sec_mgr *smgr) +{ +struct m10bmc_sec *sec = smgr->priv; +unsigned long poll_timeout; +enum fpga_sec_err result; +u32 doorbell; +int ret; + + result =rsu_send_data (sec); +if (result !=FPGA_SEC_ERR_NONE ) +return result; + + ret =rsu_check_complete (sec, &doorbell); + poll_timeout = jiffies +msecs_to_jiffies (RSU_COMPLETE_TIMEOUT_MS ); + +while (ret == -EAGAIN && !time_after (jiffies, poll_timeout)) { +msleep (RSU_COMPLETE_INTERVAL_MS ); + ret =rsu_check_complete (sec, &doorbell); +if (smgr->driver_unload) +return FPGA_SEC_ERR_CANCELED ; + } + +if (ret == -EAGAIN ) { +log_error_regs (sec, doorbell); +return FPGA_SEC_ERR_TIMEOUT ; + }else if (ret == -EIO ) { +return FPGA_SEC_ERR_RW_ERROR ; + }else if (ret) { +log_error_regs (sec, doorbell); +return FPGA_SEC_ERR_HW_ERROR ; + } + +return FPGA_SEC_ERR_NONE ; +} + +static enum fpga_sec_err m10bmc_sec_cancel (struct fpga_sec_mgr *smgr) +{ +struct m10bmc_sec *sec = smgr->priv; +u32 doorbell; +int ret; + + ret =m10bmc_sys_read (sec->m10bmc,M10BMC_DOORBELL , &doorbell); +if (ret) +return FPGA_SEC_ERR_RW_ERROR ; + +if (rsu_prog (doorbell) !=RSU_PROG_READY ) +return FPGA_SEC_ERR_BUSY ; + + ret =regmap_update_bits (sec->m10bmc->regmap, +M10BMC_SYS_BASE +M10BMC_DOORBELL , +DRBL_HOST_STATUS , +FIELD_PREP (DRBL_HOST_STATUS , +HOST_STATUS_ABORT_RSU )); + +return ret ?FPGA_SEC_ERR_RW_ERROR :FPGA_SEC_ERR_NONE ; +} + +static const struct fpga_sec_mgr_ops m10bmc_sops = { + .prepare = m10bmc_sec_prepare, + .write_blk = m10bmc_sec_write_blk, + .poll_complete = m10bmc_sec_poll_complete, + .cancel = m10bmc_sec_cancel, +};static int m10bmc_secure_probe (struct platform_device *pdev) {
Signature · 1 line
2.25.1
Tom Rix
reviewerRe: [PATCH v5 5/6] fpga: m10bmc-sec: add max10 secure update functions
Quoted 107 lines · Russ Weight
Extend the MAX10 BMC Secure Update driver to include the functions that enable secure updates of BMC images, FPGA images, etc.
Signed-off-by Russ Weight <[email protected]>---
v5:
- No change
v4:
- No change
v3:
- Changed: iops -> sops, imgr -> smgr,IFPGA_->FPGA_,ifpga_tofpga_
- Changed "MAX10 BMC Secure Engine driver" to "MAX10 BMC Secure Update driver"
- Removed wrapper functions (m10bmc_raw_*, m10bmc_sys_*). The underlying functions are now called directly.
- Changed calling functions of functions that return "enumfpga_sec_err"to check for (ret != FPGA_SEC_ERR_NONE) instead of (ret)v2:
- Reworked thersu_start_done()function to make it more readable
- Reworked while-loop condition/content inrsu_prog_ready()
- Minor code cleanup per review comments
- Added a comment to them10bmc_sec_poll_complete()function to explain the context (could take 30+ minutes to complete).
- Addedm10bmc_prefix to functions inm10bmc_iopsstructure
- Moved MAX10 BMC address and function definitions to a separate patch.--- drivers/fpga/intel-m10-bmc-secure.c | 305 +++++++++++++++++++++++++++- 1 file changed, 304 insertions(+), 1 deletion(-)drivers/fpga/intel-m10-bmc-secure.c +67
-1@@ -174,7 +174,310 @@ static const struct attribute_group *m10bmc_sec_attr_groups[] = { NULL, }; -static const struct fpga_sec_mgr_ops m10bmc_sops = { }; +static void log_error_regs (struct m10bmc_sec *sec,u32 doorbell) +{ +u32 auth_result; + +dev_err (sec->dev,"RSU error status: 0x%08x\n" , doorbell); + +if (!m10bmc_sys_read (sec->m10bmc,M10BMC_AUTH_RESULT , &auth_result)) +dev_err (sec->dev,"RSU auth result: 0x%08x\n" , auth_result); +} + +static enum fpga_sec_err rsu_check_idle (struct m10bmc_sec *sec) +{ +u32 doorbell; +int ret; + + ret =m10bmc_sys_read (sec->m10bmc,M10BMC_DOORBELL , &doorbell); +if (ret) +return FPGA_SEC_ERR_RW_ERROR ; + +if (rsu_prog (doorbell) !=RSU_PROG_IDLE && +rsu_prog (doorbell) !=RSU_PROG_RSU_DONE ) { +log_error_regs (sec, doorbell); +return FPGA_SEC_ERR_BUSY ; + } + +return FPGA_SEC_ERR_NONE ; +} + +static inline bool rsu_start_done (u32 doorbell) +{ +u32 status, progress; + +if (doorbell &DRBL_RSU_REQUEST ) +return false; + + status =rsu_stat (doorbell); +if (status ==RSU_STAT_ERASE_FAIL || status ==RSU_STAT_WEAROUT ) +return true; + + progress =rsu_prog (doorbell); +if (progress !=RSU_PROG_IDLE && progress !=RSU_PROG_RSU_DONE ) +return true; + +return false; +} + +static enum fpga_sec_err rsu_update_init (struct m10bmc_sec *sec) +{ +u32 doorbell, status; +int ret; + + ret =regmap_update_bits (sec->m10bmc->regmap, +M10BMC_SYS_BASE +M10BMC_DOORBELL , +DRBL_RSU_REQUEST |DRBL_HOST_STATUS , +DRBL_RSU_REQUEST | +FIELD_PREP (DRBL_HOST_STATUS , +HOST_STATUS_IDLE )); +if (ret) +return FPGA_SEC_ERR_RW_ERROR ; + + ret =regmap_read_poll_timeout (sec->m10bmc->regmap, +M10BMC_SYS_BASE +M10BMC_DOORBELL , + doorbell, +rsu_start_done (doorbell), +NIOS_HANDSHAKE_INTERVAL_US , +NIOS_HANDSHAKE_TIMEOUT_US ); +
drivers/fpga/intel-m10-bmc-secure.c static const struct attribute_group *m10bmc_sec_attr_groups[] = { · line 253
Quoted 10 lines
drivers/fpga/intel-m10-bmc-secure.c +10
-0+if (ret == -ETIMEDOUT ) { +log_error_regs (sec, doorbell); +return FPGA_SEC_ERR_TIMEOUT ; + }else if (ret) { +return FPGA_SEC_ERR_RW_ERROR ; + } + + status =rsu_stat (doorbell); +if (status ==RSU_STAT_WEAROUT ) { +dev_warn (sec->dev,"Excessive flash update count detected\n" );
If wear out is going to flood logs, move this to a warn once.
Maybe make rsu_stat a function.
Quoted 64 lines
drivers/fpga/intel-m10-bmc-secure.c +64
-0+return FPGA_SEC_ERR_WEAROUT ; + }else if (status ==RSU_STAT_ERASE_FAIL ) { +log_error_regs (sec, doorbell); +return FPGA_SEC_ERR_HW_ERROR ; + } + +return FPGA_SEC_ERR_NONE ; +} + +static enum fpga_sec_err rsu_prog_ready (struct m10bmc_sec *sec) +{ +unsigned long poll_timeout; +u32 doorbell, progress; +int ret; + + ret =m10bmc_sys_read (sec->m10bmc,M10BMC_DOORBELL , &doorbell); +if (ret) +return FPGA_SEC_ERR_RW_ERROR ; + + poll_timeout = jiffies +msecs_to_jiffies (RSU_PREP_TIMEOUT_MS ); +while (rsu_prog (doorbell) ==RSU_PROG_PREPARE ) { +msleep (RSU_PREP_INTERVAL_MS ); +if (time_after (jiffies, poll_timeout)) +break ; + + ret =m10bmc_sys_read (sec->m10bmc,M10BMC_DOORBELL , &doorbell); +if (ret) +return FPGA_SEC_ERR_RW_ERROR ; + } + + progress =rsu_prog (doorbell); +if (progress ==RSU_PROG_PREPARE ) { +log_error_regs (sec, doorbell); +return FPGA_SEC_ERR_TIMEOUT ; + }else if (progress !=RSU_PROG_READY ) { +log_error_regs (sec, doorbell); +return FPGA_SEC_ERR_HW_ERROR ; + } + +return FPGA_SEC_ERR_NONE ; +} + +static enum fpga_sec_err rsu_send_data (struct m10bmc_sec *sec) +{ +u32 doorbell; +int ret; + + ret =regmap_update_bits (sec->m10bmc->regmap, +M10BMC_SYS_BASE +M10BMC_DOORBELL , +DRBL_HOST_STATUS , +FIELD_PREP (DRBL_HOST_STATUS , +HOST_STATUS_WRITE_DONE )); +if (ret) +return FPGA_SEC_ERR_RW_ERROR ; + + ret =regmap_read_poll_timeout (sec->m10bmc->regmap, +M10BMC_SYS_BASE +M10BMC_DOORBELL , + doorbell, +rsu_prog (doorbell) !=RSU_PROG_READY , +NIOS_HANDSHAKE_INTERVAL_US , +NIOS_HANDSHAKE_TIMEOUT_US ); + +if (ret == -ETIMEDOUT ) { +log_error_regs (sec, doorbell);
drivers/fpga/intel-m10-bmc-secure.c static const struct attribute_group *m10bmc_sec_attr_groups[] = { · line 327
Quoted 10 lines
drivers/fpga/intel-m10-bmc-secure.c +10
-0+return FPGA_SEC_ERR_TIMEOUT ; + }else if (ret) { +return FPGA_SEC_ERR_RW_ERROR ; + } + +switch (rsu_stat (doorbell)) { +case RSU_STAT_NORMAL : +case RSU_STAT_NIOS_OK : +case RSU_STAT_USER_OK : +case RSU_STAT_FACTORY_OK :
wear out is ok below but not here. why ?
Quoted 67 lines
drivers/fpga/intel-m10-bmc-secure.c +67
-0+break ; +default : +log_error_regs (sec, doorbell); +return FPGA_SEC_ERR_HW_ERROR ; + } + +return FPGA_SEC_ERR_NONE ; +} + +static int rsu_check_complete (struct m10bmc_sec *sec,u32 *doorbell) +{ +if (m10bmc_sys_read (sec->m10bmc,M10BMC_DOORBELL , doorbell)) +return -EIO ; + +switch (rsu_stat (*doorbell)) { +case RSU_STAT_NORMAL : +case RSU_STAT_NIOS_OK : +case RSU_STAT_USER_OK : +case RSU_STAT_FACTORY_OK : +case RSU_STAT_WEAROUT : +break ; +default : +return -EINVAL ; + } + +switch (rsu_prog (*doorbell)) { +case RSU_PROG_IDLE : +case RSU_PROG_RSU_DONE : +return 0 ; +case RSU_PROG_AUTHENTICATING : +case RSU_PROG_COPYING : +case RSU_PROG_UPDATE_CANCEL : +case RSU_PROG_PROGRAM_KEY_HASH : +return -EAGAIN ; +default : +return -EINVAL ; + } +} + +static enum fpga_sec_err m10bmc_sec_prepare (struct fpga_sec_mgr *smgr) +{ +struct m10bmc_sec *sec = smgr->priv; +enum fpga_sec_err ret; + +if (smgr->remaining_size >M10BMC_STAGING_SIZE ) +return FPGA_SEC_ERR_INVALID_SIZE ; + + ret =rsu_check_idle (sec); +if (ret !=FPGA_SEC_ERR_NONE ) +return ret; + + ret =rsu_update_init (sec); +if (ret !=FPGA_SEC_ERR_NONE ) +return ret; + +return rsu_prog_ready (sec); +} + +static enum fpga_sec_err +m10bmc_sec_write_blk (struct fpga_sec_mgr *smgr,u32 offset,u32 size) +{ +struct m10bmc_sec *sec = smgr->priv; +unsigned int stride =regmap_get_reg_stride (sec->m10bmc->regmap); +u32 doorbell; +int ret; + + ret =m10bmc_sys_read (sec->m10bmc,M10BMC_DOORBELL , &doorbell);
drivers/fpga/intel-m10-bmc-secure.c static const struct attribute_group *m10bmc_sec_attr_groups[] = { · line 404
Quoted 10 lines
drivers/fpga/intel-m10-bmc-secure.c +10
-0+if (ret) { +return FPGA_SEC_ERR_RW_ERROR ; + }else if (rsu_prog (doorbell) !=RSU_PROG_READY ) { +log_error_regs (sec, doorbell); +return FPGA_SEC_ERR_HW_ERROR ; + } + + ret =regmap_bulk_write (sec->m10bmc->regmap, +M10BMC_STAGING_BASE + offset, + (void *)smgr->data + offset, size / stride);
Lose trailing bytes if (size % stride)
maybe change to (size + stride - 1) / stride
Quoted 16 lines
drivers/fpga/intel-m10-bmc-secure.c +16
-0+ +return ret ?FPGA_SEC_ERR_RW_ERROR :FPGA_SEC_ERR_NONE ; +} + +/* +* m10bmc_sec_poll_complete() is called after handing things off to +* the BMC firmware. Depending on the type of update, it could be +* 30+ minutes before the BMC firmware completes the update. The +* smgr->driver_unload check allows the driver to be unloaded, +* but the BMC firmware will continue the update and no further +* secure updates can be started for this device until the update +* is complete. +*/ +static enum fpga_sec_err m10bmc_sec_poll_complete (struct fpga_sec_mgr *smgr) +{ +struct m10bmc_sec *sec = smgr->priv;
drivers/fpga/intel-m10-bmc-secure.c static const struct attribute_group *m10bmc_sec_attr_groups[] = { · line 430
Quoted 10 lines
drivers/fpga/intel-m10-bmc-secure.c +10
-0+unsigned long poll_timeout; +enum fpga_sec_err result; +u32 doorbell; +int ret; + + result =rsu_send_data (sec); +if (result !=FPGA_SEC_ERR_NONE ) +return result; + + ret =rsu_check_complete (sec, &doorbell);
If the first iteration will never be successful, just replace call with
ret = -EAGAIN;
Tom
Quoted 53 lines
drivers/fpga/intel-m10-bmc-secure.c +50
-0+ poll_timeout = jiffies +msecs_to_jiffies (RSU_COMPLETE_TIMEOUT_MS ); + +while (ret == -EAGAIN && !time_after (jiffies, poll_timeout)) { +msleep (RSU_COMPLETE_INTERVAL_MS ); + ret =rsu_check_complete (sec, &doorbell); +if (smgr->driver_unload) +return FPGA_SEC_ERR_CANCELED ; + } + +if (ret == -EAGAIN ) { +log_error_regs (sec, doorbell); +return FPGA_SEC_ERR_TIMEOUT ; + }else if (ret == -EIO ) { +return FPGA_SEC_ERR_RW_ERROR ; + }else if (ret) { +log_error_regs (sec, doorbell); +return FPGA_SEC_ERR_HW_ERROR ; + } + +return FPGA_SEC_ERR_NONE ; +} + +static enum fpga_sec_err m10bmc_sec_cancel (struct fpga_sec_mgr *smgr) +{ +struct m10bmc_sec *sec = smgr->priv; +u32 doorbell; +int ret; + + ret =m10bmc_sys_read (sec->m10bmc,M10BMC_DOORBELL , &doorbell); +if (ret) +return FPGA_SEC_ERR_RW_ERROR ; + +if (rsu_prog (doorbell) !=RSU_PROG_READY ) +return FPGA_SEC_ERR_BUSY ; + + ret =regmap_update_bits (sec->m10bmc->regmap, +M10BMC_SYS_BASE +M10BMC_DOORBELL , +DRBL_HOST_STATUS , +FIELD_PREP (DRBL_HOST_STATUS , +HOST_STATUS_ABORT_RSU )); + +return ret ?FPGA_SEC_ERR_RW_ERROR :FPGA_SEC_ERR_NONE ; +} + +static const struct fpga_sec_mgr_ops m10bmc_sops = { + .prepare = m10bmc_sec_prepare, + .write_blk = m10bmc_sec_write_blk, + .poll_complete = m10bmc_sec_poll_complete, + .cancel = m10bmc_sec_cancel, +};static int m10bmc_secure_probe (struct platform_device *pdev) {
Re: [PATCH v5 5/6] fpga: m10bmc-sec: add max10 secure update functions
Quoted 111 lines · Tom Rix
Quoted 110 lines · Russ Weight
Extend the MAX10 BMC Secure Update driver to include the functions that enable secure updates of BMC images, FPGA images, etc.
Signed-off-by Russ Weight <[email protected]>---
v5:
- No change
v4:
- No change
v3:
- Changed: iops -> sops, imgr -> smgr,IFPGA_->FPGA_,ifpga_tofpga_
- Changed "MAX10 BMC Secure Engine driver" to "MAX10 BMC Secure Update driver"
- Removed wrapper functions (m10bmc_raw_*, m10bmc_sys_*). The underlying functions are now called directly.
- Changed calling functions of functions that return "enumfpga_sec_err"to check for (ret != FPGA_SEC_ERR_NONE) instead of (ret)v2:
- Reworked thersu_start_done()function to make it more readable
- Reworked while-loop condition/content inrsu_prog_ready()
- Minor code cleanup per review comments
- Added a comment to them10bmc_sec_poll_complete()function to explain the context (could take 30+ minutes to complete).
- Addedm10bmc_prefix to functions inm10bmc_iopsstructure
- Moved MAX10 BMC address and function definitions to a separate patch.--- drivers/fpga/intel-m10-bmc-secure.c | 305 +++++++++++++++++++++++++++- 1 file changed, 304 insertions(+), 1 deletion(-)drivers/fpga/intel-m10-bmc-secure.c +70
-1@@ -174,7 +174,310 @@ static const struct attribute_group *m10bmc_sec_attr_groups[] = { NULL, }; -static const struct fpga_sec_mgr_ops m10bmc_sops = { }; +static void log_error_regs (struct m10bmc_sec *sec,u32 doorbell) +{ +u32 auth_result; + +dev_err (sec->dev,"RSU error status: 0x%08x\n" , doorbell); + +if (!m10bmc_sys_read (sec->m10bmc,M10BMC_AUTH_RESULT , &auth_result)) +dev_err (sec->dev,"RSU auth result: 0x%08x\n" , auth_result); +} + +static enum fpga_sec_err rsu_check_idle (struct m10bmc_sec *sec) +{ +u32 doorbell; +int ret; + + ret =m10bmc_sys_read (sec->m10bmc,M10BMC_DOORBELL , &doorbell); +if (ret) +return FPGA_SEC_ERR_RW_ERROR ; + +if (rsu_prog (doorbell) !=RSU_PROG_IDLE && +rsu_prog (doorbell) !=RSU_PROG_RSU_DONE ) { +log_error_regs (sec, doorbell); +return FPGA_SEC_ERR_BUSY ; + } + +return FPGA_SEC_ERR_NONE ; +} + +static inline bool rsu_start_done (u32 doorbell) +{ +u32 status, progress; + +if (doorbell &DRBL_RSU_REQUEST ) +return false; + + status =rsu_stat (doorbell); +if (status ==RSU_STAT_ERASE_FAIL || status ==RSU_STAT_WEAROUT ) +return true; + + progress =rsu_prog (doorbell); +if (progress !=RSU_PROG_IDLE && progress !=RSU_PROG_RSU_DONE ) +return true; + +return false; +} + +static enum fpga_sec_err rsu_update_init (struct m10bmc_sec *sec) +{ +u32 doorbell, status; +int ret; + + ret =regmap_update_bits (sec->m10bmc->regmap, +M10BMC_SYS_BASE +M10BMC_DOORBELL , +DRBL_RSU_REQUEST |DRBL_HOST_STATUS , +DRBL_RSU_REQUEST | +FIELD_PREP (DRBL_HOST_STATUS , +HOST_STATUS_IDLE )); +if (ret) +return FPGA_SEC_ERR_RW_ERROR ; + + ret =regmap_read_poll_timeout (sec->m10bmc->regmap, +M10BMC_SYS_BASE +M10BMC_DOORBELL , + doorbell, +rsu_start_done (doorbell), +NIOS_HANDSHAKE_INTERVAL_US , +NIOS_HANDSHAKE_TIMEOUT_US ); + +if (ret == -ETIMEDOUT ) { +log_error_regs (sec, doorbell); +return FPGA_SEC_ERR_TIMEOUT ;
Quoted 8 lines
drivers/fpga/intel-m10-bmc-secure.c static const struct attribute_group *m10bmc_sec_attr_groups[] = { · line 253
Quoted 7 lines
drivers/fpga/intel-m10-bmc-secure.c +7
-0+ }else if (ret) { +return FPGA_SEC_ERR_RW_ERROR ; + } + + status =rsu_stat (doorbell); +if (status ==RSU_STAT_WEAROUT ) { +dev_warn (sec->dev,"Excessive flash update count detected\n" );If wear out is going to flood logs, move this to a warn once.
There is no danger of flooding. The WEAROUT error will only be seen after 1000 flash updates have occurred - an unlikely condition. It will also only occur once on an update, and only if they attempt to flash within 60 seconds of power-on or within 60 seconds of a previous flash.
Quoted 2 lines
Maybe make
rsu_stata function.
Is there a reason to prefer a function in this case? Or should I change rsu_stat() to RSU_STAT() to make it more clear that it is a macro?
Quoted 68 lines
Quoted 68 lines
drivers/fpga/intel-m10-bmc-secure.c +67
-0+return FPGA_SEC_ERR_WEAROUT ; + }else if (status ==RSU_STAT_ERASE_FAIL ) { +log_error_regs (sec, doorbell); +return FPGA_SEC_ERR_HW_ERROR ; + } + +return FPGA_SEC_ERR_NONE ; +} + +static enum fpga_sec_err rsu_prog_ready (struct m10bmc_sec *sec) +{ +unsigned long poll_timeout; +u32 doorbell, progress; +int ret; + + ret =m10bmc_sys_read (sec->m10bmc,M10BMC_DOORBELL , &doorbell); +if (ret) +return FPGA_SEC_ERR_RW_ERROR ; + + poll_timeout = jiffies +msecs_to_jiffies (RSU_PREP_TIMEOUT_MS ); +while (rsu_prog (doorbell) ==RSU_PROG_PREPARE ) { +msleep (RSU_PREP_INTERVAL_MS ); +if (time_after (jiffies, poll_timeout)) +break ; + + ret =m10bmc_sys_read (sec->m10bmc,M10BMC_DOORBELL , &doorbell); +if (ret) +return FPGA_SEC_ERR_RW_ERROR ; + } + + progress =rsu_prog (doorbell); +if (progress ==RSU_PROG_PREPARE ) { +log_error_regs (sec, doorbell); +return FPGA_SEC_ERR_TIMEOUT ; + }else if (progress !=RSU_PROG_READY ) { +log_error_regs (sec, doorbell); +return FPGA_SEC_ERR_HW_ERROR ; + } + +return FPGA_SEC_ERR_NONE ; +} + +static enum fpga_sec_err rsu_send_data (struct m10bmc_sec *sec) +{ +u32 doorbell; +int ret; + + ret =regmap_update_bits (sec->m10bmc->regmap, +M10BMC_SYS_BASE +M10BMC_DOORBELL , +DRBL_HOST_STATUS , +FIELD_PREP (DRBL_HOST_STATUS , +HOST_STATUS_WRITE_DONE )); +if (ret) +return FPGA_SEC_ERR_RW_ERROR ; + + ret =regmap_read_poll_timeout (sec->m10bmc->regmap, +M10BMC_SYS_BASE +M10BMC_DOORBELL , + doorbell, +rsu_prog (doorbell) !=RSU_PROG_READY , +NIOS_HANDSHAKE_INTERVAL_US , +NIOS_HANDSHAKE_TIMEOUT_US ); + +if (ret == -ETIMEDOUT ) { +log_error_regs (sec, doorbell); +return FPGA_SEC_ERR_TIMEOUT ; + }else if (ret) { +return FPGA_SEC_ERR_RW_ERROR ;
Quoted 8 lines
drivers/fpga/intel-m10-bmc-secure.c static const struct attribute_group *m10bmc_sec_attr_groups[] = { · line 327
Quoted 7 lines
drivers/fpga/intel-m10-bmc-secure.c +7
-0+ } + +switch (rsu_stat (doorbell)) { +case RSU_STAT_NORMAL : +case RSU_STAT_NIOS_OK : +case RSU_STAT_USER_OK : +case RSU_STAT_FACTORY_OK :wear out is ok below but not here. why ?
Actually, wearout should not be seen while waiting for completion either. I'll remove it from the code below. Good catch!
Quoted 79 lines
Quoted 67 lines
drivers/fpga/intel-m10-bmc-secure.c +67
-0+break ; +default : +log_error_regs (sec, doorbell); +return FPGA_SEC_ERR_HW_ERROR ; + } + +return FPGA_SEC_ERR_NONE ; +} + +static int rsu_check_complete (struct m10bmc_sec *sec,u32 *doorbell) +{ +if (m10bmc_sys_read (sec->m10bmc,M10BMC_DOORBELL , doorbell)) +return -EIO ; + +switch (rsu_stat (*doorbell)) { +case RSU_STAT_NORMAL : +case RSU_STAT_NIOS_OK : +case RSU_STAT_USER_OK : +case RSU_STAT_FACTORY_OK : +case RSU_STAT_WEAROUT : +break ; +default : +return -EINVAL ; + } + +switch (rsu_prog (*doorbell)) { +case RSU_PROG_IDLE : +case RSU_PROG_RSU_DONE : +return 0 ; +case RSU_PROG_AUTHENTICATING : +case RSU_PROG_COPYING : +case RSU_PROG_UPDATE_CANCEL : +case RSU_PROG_PROGRAM_KEY_HASH : +return -EAGAIN ; +default : +return -EINVAL ; + } +} + +static enum fpga_sec_err m10bmc_sec_prepare (struct fpga_sec_mgr *smgr) +{ +struct m10bmc_sec *sec = smgr->priv; +enum fpga_sec_err ret; + +if (smgr->remaining_size >M10BMC_STAGING_SIZE ) +return FPGA_SEC_ERR_INVALID_SIZE ; + + ret =rsu_check_idle (sec); +if (ret !=FPGA_SEC_ERR_NONE ) +return ret; + + ret =rsu_update_init (sec); +if (ret !=FPGA_SEC_ERR_NONE ) +return ret; + +return rsu_prog_ready (sec); +} + +static enum fpga_sec_err +m10bmc_sec_write_blk (struct fpga_sec_mgr *smgr,u32 offset,u32 size) +{ +struct m10bmc_sec *sec = smgr->priv; +unsigned int stride =regmap_get_reg_stride (sec->m10bmc->regmap); +u32 doorbell; +int ret; + + ret =m10bmc_sys_read (sec->m10bmc,M10BMC_DOORBELL , &doorbell);drivers/fpga/intel-m10-bmc-secure.c static const struct attribute_group *m10bmc_sec_attr_groups[] = { · line 404
Quoted 10 lines
drivers/fpga/intel-m10-bmc-secure.c +10
-0+if (ret) { +return FPGA_SEC_ERR_RW_ERROR ; + }else if (rsu_prog (doorbell) !=RSU_PROG_READY ) { +log_error_regs (sec, doorbell); +return FPGA_SEC_ERR_HW_ERROR ; + } + + ret =regmap_bulk_write (sec->m10bmc->regmap, +M10BMC_STAGING_BASE + offset, + (void *)smgr->data + offset, size / stride);Lose trailing bytes if (size % stride)
Quoted 1 line
maybe change to (size + stride - 1) / stride
Yes - I'll make this change.
Quoted 29 lines
Quoted 17 lines
drivers/fpga/intel-m10-bmc-secure.c +16
-0+ +return ret ?FPGA_SEC_ERR_RW_ERROR :FPGA_SEC_ERR_NONE ; +} + +/* +* m10bmc_sec_poll_complete() is called after handing things off to +* the BMC firmware. Depending on the type of update, it could be +* 30+ minutes before the BMC firmware completes the update. The +* smgr->driver_unload check allows the driver to be unloaded, +* but the BMC firmware will continue the update and no further +* secure updates can be started for this device until the update +* is complete. +*/ +static enum fpga_sec_err m10bmc_sec_poll_complete (struct fpga_sec_mgr *smgr) +{ +struct m10bmc_sec *sec = smgr->priv;drivers/fpga/intel-m10-bmc-secure.c static const struct attribute_group *m10bmc_sec_attr_groups[] = { · line 430
Quoted 10 lines
drivers/fpga/intel-m10-bmc-secure.c +10
-0+unsigned long poll_timeout; +enum fpga_sec_err result; +u32 doorbell; +int ret; + + result =rsu_send_data (sec); +if (result !=FPGA_SEC_ERR_NONE ) +return result; + + ret =rsu_check_complete (sec, &doorbell);If the first iteration will never be successful, just replace call with
Quoted 1 line
ret =
-EAGAIN;
It is unlikely that it would ever be successful on the first iteration. I'll make this change, or perhaps change it to a do-while loop.
Thanks!
- Russ
Quoted 56 lines
Tom
Quoted 53 lines
drivers/fpga/intel-m10-bmc-secure.c +50
-0+ poll_timeout = jiffies +msecs_to_jiffies (RSU_COMPLETE_TIMEOUT_MS ); + +while (ret == -EAGAIN && !time_after (jiffies, poll_timeout)) { +msleep (RSU_COMPLETE_INTERVAL_MS ); + ret =rsu_check_complete (sec, &doorbell); +if (smgr->driver_unload) +return FPGA_SEC_ERR_CANCELED ; + } + +if (ret == -EAGAIN ) { +log_error_regs (sec, doorbell); +return FPGA_SEC_ERR_TIMEOUT ; + }else if (ret == -EIO ) { +return FPGA_SEC_ERR_RW_ERROR ; + }else if (ret) { +log_error_regs (sec, doorbell); +return FPGA_SEC_ERR_HW_ERROR ; + } + +return FPGA_SEC_ERR_NONE ; +} + +static enum fpga_sec_err m10bmc_sec_cancel (struct fpga_sec_mgr *smgr) +{ +struct m10bmc_sec *sec = smgr->priv; +u32 doorbell; +int ret; + + ret =m10bmc_sys_read (sec->m10bmc,M10BMC_DOORBELL , &doorbell); +if (ret) +return FPGA_SEC_ERR_RW_ERROR ; + +if (rsu_prog (doorbell) !=RSU_PROG_READY ) +return FPGA_SEC_ERR_BUSY ; + + ret =regmap_update_bits (sec->m10bmc->regmap, +M10BMC_SYS_BASE +M10BMC_DOORBELL , +DRBL_HOST_STATUS , +FIELD_PREP (DRBL_HOST_STATUS , +HOST_STATUS_ABORT_RSU )); + +return ret ?FPGA_SEC_ERR_RW_ERROR :FPGA_SEC_ERR_NONE ; +} + +static const struct fpga_sec_mgr_ops m10bmc_sops = { + .prepare = m10bmc_sec_prepare, + .write_blk = m10bmc_sec_write_blk, + .poll_complete = m10bmc_sec_poll_complete, + .cancel = m10bmc_sec_cancel, +};static int m10bmc_secure_probe (struct platform_device *pdev) {
Tom Rix
reviewerRe: [PATCH v5 5/6] fpga: m10bmc-sec: add max10 secure update functions
Quoted 10 lines · Russ Weight
Quoted 8 lines · Tom Rix
drivers/fpga/intel-m10-bmc-secure.c static const struct attribute_group *m10bmc_sec_attr_groups[] = { · line 253
Quoted 6 lines · Russ Weight
Extend the MAX10 BMC Secure Update driver to include
drivers/fpga/intel-m10-bmc-secure.c +4
-0+ + status =rsu_stat (doorbell); +if (status ==RSU_STAT_WEAROUT ) { +dev_warn (sec->dev,"Excessive flash update count detected\n" );If wear out is going to flood logs, move this to a warn once.
Quoted 7 lines
There is no danger of flooding. The WEAROUT error will only be seen after 1000 flash updates have occurred - an unlikely condition. It will also only occur once on an update, and only if they attempt to flash within 60 seconds of power-on or within 60 seconds of a previous flash.
Quoted 1 line
Maybe make
rsu_stata function.Is there a reason to prefer a function in this case? Or should I change
rsu_stat()toRSU_STAT()to make it more clear that it is a macro?
i was thinking a function could manage the warning messages.
If it will not flood, it is ok as-is.
Tom
PATCH v5 6/6 fpga: m10bmc-sec: add max10 get_hw_errinfo callback func
In reply to Russ WeightExtend the MAX10 BMC Secure Update driver to include a function that returns 64 bits of additional HW specific data for errors that require additional information. This callback function enables the hw_errinfo sysfs node in the Intel Security Manager class driver.
---
v5:
- No change
v4:
- No change
v3:
- Changed: iops -> sops, imgr -> smgr, IFPGA_ -> FPGA_, ifpga_ to fpga_
- Changed "MAX10 BMC Secure Engine driver" to "MAX10 BMC Secure Update driver"
v2:
- 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 m10bmc_ prefix to functions in m10bmc_iops structure
--- drivers/fpga/intel-m10-bmc-secure.c | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+)
drivers/fpga/intel-m10-bmc-secure.c +25 -0
@@ -472,11 +472,36 @@ static enum fpga_sec_err m10bmc_sec_cancel(struct fpga_sec_mgr *smgr)return ret ?FPGA_SEC_ERR_RW_ERROR :FPGA_SEC_ERR_NONE ; } +#define HW_ERRINFO_POISON GENMASK(31, 0) +static u64 m10bmc_sec_hw_errinfo (struct fpga_sec_mgr *smgr) +{ +struct m10bmc_sec *sec = smgr->priv; +u32 doorbell, auth_result; + +switch (smgr->err_code) { +case FPGA_SEC_ERR_HW_ERROR : +case FPGA_SEC_ERR_TIMEOUT : +case FPGA_SEC_ERR_BUSY : +case FPGA_SEC_ERR_WEAROUT : +if (m10bmc_sys_read (sec->m10bmc,M10BMC_DOORBELL , &doorbell)) + doorbell =HW_ERRINFO_POISON ; + +if (m10bmc_sys_read (sec->m10bmc,M10BMC_AUTH_RESULT , + &auth_result)) + auth_result =HW_ERRINFO_POISON ; + +return (u64 )doorbell <<32 | (u64 )auth_result; +default : +return 0 ; + } +} +static const struct fpga_sec_mgr_ops m10bmc_sops = { .prepare = m10bmc_sec_prepare, .write_blk = m10bmc_sec_write_blk, .poll_complete = m10bmc_sec_poll_complete, .cancel = m10bmc_sec_cancel, + .get_hw_errinfo = m10bmc_sec_hw_errinfo, };static int m10bmc_secure_probe (struct platform_device *pdev)
Signature · 1 line
2.25.1
Tom Rix
reviewerRe: [PATCH v5 6/6] fpga: m10bmc-sec: add max10 get_hw_errinfo callback func
Quoted 30 lines · Russ Weight
Extend the MAX10 BMC Secure Update driver to include a function that returns 64 bits of additional HW specific data for errors that require additional information. This callback function enables the
hw_errinfosysfs node in the Intel Security Manager class driver.Signed-off-by Russ Weight <[email protected]>---
v5:
- No change
v4:
- No change
v3:
- Changed: iops -> sops, imgr -> smgr,IFPGA_->FPGA_,ifpga_tofpga_
- Changed "MAX10 BMC Secure Engine driver" to "MAX10 BMC Secure Update driver"
v2:
- ImplementedHW_ERRINFO_POISONform10bmc_sec_hw_errinfo()to ensure that corresponding bits are set to 1 if we are unable to read the doorbell orauth_resultregisters.
- Addedm10bmc_prefix to functions inm10bmc_iopsstructure--- drivers/fpga/intel-m10-bmc-secure.c | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+)drivers/fpga/intel-m10-bmc-secure.c +0
-0
drivers/fpga/intel-m10-bmc-secure.c static enum fpga_sec_err m10bmc_sec_cancel(struct fpga_sec_mgr *smgr) · line 479
Quoted 8 lines
drivers/fpga/intel-m10-bmc-secure.c +5
-0@@ -472,11 +472,36 @@ static enum fpga_sec_err m10bmc_sec_cancel(struct fpga_sec_mgr *smgr)return ret ?FPGA_SEC_ERR_RW_ERROR :FPGA_SEC_ERR_NONE ; } +#define HW_ERRINFO_POISON GENMASK(31, 0) +static u64 m10bmc_sec_hw_errinfo (struct fpga_sec_mgr *smgr) +{ +struct m10bmc_sec *sec = smgr->priv; +u32 doorbell, auth_result;
If doorbell and auth_result were poisoned at initialization, the if-checks could be skipped.
Tom
Quoted 28 lines
drivers/fpga/intel-m10-bmc-secure.c +20
-0+ +switch (smgr->err_code) { +case FPGA_SEC_ERR_HW_ERROR : +case FPGA_SEC_ERR_TIMEOUT : +case FPGA_SEC_ERR_BUSY : +case FPGA_SEC_ERR_WEAROUT : +if (m10bmc_sys_read (sec->m10bmc,M10BMC_DOORBELL , &doorbell)) + doorbell =HW_ERRINFO_POISON ; + +if (m10bmc_sys_read (sec->m10bmc,M10BMC_AUTH_RESULT , + &auth_result)) + auth_result =HW_ERRINFO_POISON ; + +return (u64 )doorbell <<32 | (u64 )auth_result; +default : +return 0 ; + } +} +static const struct fpga_sec_mgr_ops m10bmc_sops = { .prepare = m10bmc_sec_prepare, .write_blk = m10bmc_sec_write_blk, .poll_complete = m10bmc_sec_poll_complete, .cancel = m10bmc_sec_cancel, + .get_hw_errinfo = m10bmc_sec_hw_errinfo, };static int m10bmc_secure_probe (struct platform_device *pdev)
Re: [PATCH v5 6/6] fpga: m10bmc-sec: add max10 get_hw_errinfo callback func
Quoted 34 lines · Tom Rix
Quoted 33 lines · Russ Weight
Extend the MAX10 BMC Secure Update driver to include a function that returns 64 bits of additional HW specific data for errors that require additional information. This callback function enables the
hw_errinfosysfs node in the Intel Security Manager class driver.Signed-off-by Russ Weight <[email protected]>---
v5:
- No change
v4:
- No change
v3:
- Changed: iops -> sops, imgr -> smgr,IFPGA_->FPGA_,ifpga_tofpga_
- Changed "MAX10 BMC Secure Engine driver" to "MAX10 BMC Secure Update driver"
v2:
- ImplementedHW_ERRINFO_POISONform10bmc_sec_hw_errinfo()to ensure that corresponding bits are set to 1 if we are unable to read the doorbell orauth_resultregisters.
- Addedm10bmc_prefix to functions inm10bmc_iopsstructure--- drivers/fpga/intel-m10-bmc-secure.c | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+)drivers/fpga/intel-m10-bmc-secure.c +0
-0@@ -472,11 +472,36 @@ static enum fpga_sec_err m10bmc_sec_cancel(struct fpga_sec_mgr *smgr)return ret ?FPGA_SEC_ERR_RW_ERROR :FPGA_SEC_ERR_NONE ; }
Quoted 6 lines
drivers/fpga/intel-m10-bmc-secure.c static enum fpga_sec_err m10bmc_sec_cancel(struct fpga_sec_mgr *smgr) · line 479
Quoted 5 lines
drivers/fpga/intel-m10-bmc-secure.c +5
-0+#define HW_ERRINFO_POISON GENMASK(31, 0) +static u64 m10bmc_sec_hw_errinfo (struct fpga_sec_mgr *smgr) +{ +struct m10bmc_sec *sec = smgr->priv; +u32 doorbell, auth_result;If doorbell and
auth_resultwere poisoned at initialization, the if-checks could be skipped.
Yes - I'll make this change.
- Russ
Quoted 31 lines
Tom
Quoted 28 lines
drivers/fpga/intel-m10-bmc-secure.c +20
-0+ +switch (smgr->err_code) { +case FPGA_SEC_ERR_HW_ERROR : +case FPGA_SEC_ERR_TIMEOUT : +case FPGA_SEC_ERR_BUSY : +case FPGA_SEC_ERR_WEAROUT : +if (m10bmc_sys_read (sec->m10bmc,M10BMC_DOORBELL , &doorbell)) + doorbell =HW_ERRINFO_POISON ; + +if (m10bmc_sys_read (sec->m10bmc,M10BMC_AUTH_RESULT , + &auth_result)) + auth_result =HW_ERRINFO_POISON ; + +return (u64 )doorbell <<32 | (u64 )auth_result; +default : +return 0 ; + } +} +static const struct fpga_sec_mgr_ops m10bmc_sops = { .prepare = m10bmc_sec_prepare, .write_blk = m10bmc_sec_write_blk, .poll_complete = m10bmc_sec_poll_complete, .cancel = m10bmc_sec_cancel, + .get_hw_errinfo = m10bmc_sec_hw_errinfo, };static int m10bmc_secure_probe (struct platform_device *pdev)