Intel MAX10 BMC Secure Update Driver
v3 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 passes call-back function pointers to the FPGA Security Manager Class Driver to support the following functions:
(1) Instantiate and monitor a secure update
(2) Display security information including: Root Entry Hashes (REH), Canceled Code Signing Keys (CSK), and flash update counts for both BMC and FPGA images.
These patches are dependent on other patches that are under review. If you want to apply these patches on linux-next, please apply these patches first, in the following order:
(1 patch) https://marc.info/?l=linux-fpga&m=159782339732362&w=2
(4 patches) https://marc.info/?l=linux-fpga&m=160014074806950&w=2
(7 patches) https://marc.info/?l=linux-fpga&m=160211621032687&w=2
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 counts
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
MAINTAINERS | 1 + drivers/fpga/Kconfig | 11 + drivers/fpga/Makefile | 3 + drivers/fpga/intel-m10-bmc-secure.c | 599 ++++++++++++++++++++++++++++ include/linux/mfd/intel-m10-bmc.h | 85 ++++ 5 files changed, 699 insertions(+) create mode 100644 drivers/fpga/intel-m10-bmc-secure.c
Signature · 1 line
2.17.1
PATCH v3 1/6 mfd: intel-m10-bmc: support for MAX10 BMC Secure Updates
Add macros and definitions required by the MAX10 BMC Secure Update driver.
---
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 inverted bit vector containing user the image FLASH count */ +#define USER_FLASH_COUNT 0x17ffb000 +/** * struct intel_m10bmc - Intel MAX 10 BMC parent driver data structure * @dev: this device
Signature · 1 line
2.17.1
Re: [PATCH v3 1/6] mfd: intel-m10-bmc: support for MAX10 BMC Secure Updates
Quoted 18 lines · Russ Weight
Add macros and definitions required by the MAX10 BMC Secure Update driver.
Signed-off-by Russ Weight <[email protected]>---
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.
- AddedDRBL_prefix to some definitions
- Some address definitions were moved here from the .c files that use them.
Quoted 3 lines
--- include/linux/mfd/intel-m10-bmc.h | 85 +++++++++++++++++++++++++++++++ 1 file changed, 85 insertions(+)
Signature · 4 lines
Lee Jones [李琼斯] Senior Technical Lead - Developer Services Linaro.org │ Open source software for Arm SoCs Follow Linaro: Facebook | Twitter | Blog
PATCH v3 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 support for displaying the current root entry hashes for the FPGA static region, the FPGA PR region, and the MAX10 BMC.
---
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().
--- MAINTAINERS | 1 + drivers/fpga/Kconfig | 11 ++ drivers/fpga/Makefile | 3 + drivers/fpga/intel-m10-bmc-secure.c | 166 ++++++++++++++++++++++++++++ 4 files changed, 181 insertions(+) create mode 100644 drivers/fpga/intel-m10-bmc-secure.c
MAINTAINERS +1 -0
@@ -6908,6 +6908,7 @@ S: Maintained F: Documentation/ABI/testing/sysfs-class-fpga-sec-mgr 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 +166 -0
166 lines not on this page · raw message
Signature · 1 line
2.17.1
PATCH v3 3/6 fpga: m10bmc-sec: expose max10 flash update counts
In reply to Russ WeightExtend the MAX10 BMC Secure Update driver to provide a handler to expose the flash update count for the FPGA user image in sysfs.
---
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
--- drivers/fpga/intel-m10-bmc-secure.c | 33 +++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+)
drivers/fpga/intel-m10-bmc-secure.c +33 -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> #include <linux/vmalloc.h> struct m10bmc_sec {
@@ -106,7 +107,39 @@ static int m10bmc_pr_reh(struct fpga_sec_mgr *smgr, u8 *hash,return m10bmc_reh (smgr,PR_REH_ADDR , hash, size); } +#define FLASH_COUNT_SIZE 4096/* count stored in inverted bit vector */ + +static int m10bmc_user_flash_count (struct fpga_sec_mgr *smgr) +{ +struct m10bmc_sec *sec = smgr->priv; +unsigned int stride =regmap_get_reg_stride (sec->m10bmc->regmap); +unsigned int num_bits =FLASH_COUNT_SIZE *8 ; +u8 *flash_buf; +int ret; + + flash_buf =kmalloc (FLASH_COUNT_SIZE ,GFP_KERNEL ); +if (!flash_buf) +return -ENOMEM ; + + ret =regmap_bulk_read (sec->m10bmc->regmap,USER_FLASH_COUNT , + flash_buf,FLASH_COUNT_SIZE / stride); +if (ret) { +dev_err (sec->dev, +"failed to read flash count: %x cnt %x: %d\n" , +USER_FLASH_COUNT ,FLASH_COUNT_SIZE / stride, ret); + goto exit_free; + } + + ret = num_bits -bitmap_weight ((unsigned long *)flash_buf, num_bits); + +exit_free: +kfree (flash_buf); + +return ret; +} +static const struct fpga_sec_mgr_ops m10bmc_sops = { + .user_flash_count = m10bmc_user_flash_count, .bmc_root_entry_hash = m10bmc_bmc_reh, .sr_root_entry_hash = m10bmc_sr_reh, .pr_root_entry_hash = m10bmc_pr_reh,
Signature · 1 line
2.17.1
PATCH v3 4/6 fpga: m10bmc-sec: expose max10 canceled keys in sysfs
In reply to Russ WeightExtend the MAX10 BMC Secure Update driver to provide a handler to expose the canceled code signing key (CSK) bit vectors in sysfs. These use the standard bitmap list format (e.g. 1,2-6,9).
---
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
--- drivers/fpga/intel-m10-bmc-secure.c | 73 +++++++++++++++++++++++++++++ 1 file changed, 73 insertions(+)
drivers/fpga/intel-m10-bmc-secure.c +73 -0
@@ -138,14 +138,87 @@ static int m10bmc_user_flash_count(struct fpga_sec_mgr *smgr)return ret; } +#define CSK_BIT_LEN 128U +#define CSK_32ARRAY_SIZE (_nbits) DIV_ROUND_UP(_nbits, 32) + +static int m10bmc_csk_cancel_nbits (struct fpga_sec_mgr *smgr) +{ +return (int )CSK_BIT_LEN ; +} + +static int m10bmc_csk_vector (struct fpga_sec_mgr *smgr,u32 addr, +unsigned long *csk_map,unsigned int nbits) +{ +unsigned int i, size, arr_size =CSK_32ARRAY_SIZE (nbits); +struct m10bmc_sec *sec = smgr->priv; +unsigned int stride; +u32 *csk32; +int ret; + + stride =regmap_get_reg_stride (sec->m10bmc->regmap); + size = arr_size *sizeof (u32); + csk32 =vmalloc (size); +if (!csk32) +return -ENOMEM ; + + ret =regmap_bulk_read (sec->m10bmc->regmap, addr, csk32, size / stride); +if (ret) { +dev_err (sec->dev,"failed to read CSK vector: %x cnt %x: %d\n" , + addr, size / stride, ret); + goto vfree_exit; + } + +for (i =0 ; i < arr_size; i++) + csk32[i] =le32_to_cpu (csk32[i]); + +bitmap_from_arr32 (csk_map, csk32, nbits); +bitmap_complement (csk_map, csk_map, nbits); + +vfree_exit: +vfree (csk32); +return ret; +} + +#define CSK_VEC_OFFSET 0x34 + +static int m10bmc_bmc_canceled_csks (struct fpga_sec_mgr *smgr, +unsigned long *csk_map, +unsigned int nbits) +{ +return m10bmc_csk_vector (smgr,BMC_PROG_ADDR +CSK_VEC_OFFSET , + csk_map, nbits); +} + +static int m10bmc_sr_canceled_csks (struct fpga_sec_mgr *smgr, +unsigned long *csk_map, +unsigned int nbits) +{ +return m10bmc_csk_vector (smgr,SR_PROG_ADDR +CSK_VEC_OFFSET , + csk_map, nbits); +} + +static int m10bmc_pr_canceled_csks (struct fpga_sec_mgr *smgr, +unsigned long *csk_map, +unsigned int nbits) +{ +return m10bmc_csk_vector (smgr,PR_PROG_ADDR +CSK_VEC_OFFSET , + csk_map, nbits); +} +static const struct fpga_sec_mgr_ops m10bmc_sops = { .user_flash_count = m10bmc_user_flash_count, .bmc_root_entry_hash = m10bmc_bmc_reh, .sr_root_entry_hash = m10bmc_sr_reh, .pr_root_entry_hash = m10bmc_pr_reh, + .bmc_canceled_csks = m10bmc_bmc_canceled_csks, + .sr_canceled_csks = m10bmc_sr_canceled_csks, + .pr_canceled_csks = m10bmc_pr_canceled_csks, .bmc_reh_size = m10bmc_bmc_reh_size, .sr_reh_size = m10bmc_sr_reh_size, .pr_reh_size = m10bmc_pr_reh_size, + .bmc_canceled_csk_nbits = m10bmc_csk_cancel_nbits, + .sr_canceled_csk_nbits = m10bmc_csk_cancel_nbits, + .pr_canceled_csk_nbits = m10bmc_csk_cancel_nbits, };static int m10bmc_secure_probe (struct platform_device *pdev)
Signature · 1 line
2.17.1
PATCH v3 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.
---
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 | 302 ++++++++++++++++++++++++++++ 1 file changed, 302 insertions(+)
drivers/fpga/intel-m10-bmc-secure.c +302 -0
@@ -205,6 +205,304 @@ static int m10bmc_pr_canceled_csks(struct fpga_sec_mgr *smgr, csk_map, nbits); } +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 = { .user_flash_count = m10bmc_user_flash_count, .bmc_root_entry_hash = m10bmc_bmc_reh,
@@ -219,6 +517,10 @@ static const struct fpga_sec_mgr_ops m10bmc_sops = { .bmc_canceled_csk_nbits = m10bmc_csk_cancel_nbits, .sr_canceled_csk_nbits = m10bmc_csk_cancel_nbits, .pr_canceled_csk_nbits = m10bmc_csk_cancel_nbits, + .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.17.1
PATCH v3 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.
---
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
@@ -503,6 +503,30 @@ 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 = { .user_flash_count = m10bmc_user_flash_count, .bmc_root_entry_hash = m10bmc_bmc_reh,
@@ -521,6 +545,7 @@ static const struct fpga_sec_mgr_ops m10bmc_sops = { .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.17.1