Extend Intel service layer, FPGA manager and region
v4 cover Extend Intel service layer, FPGA manager and region
From: Richard Gong <[email protected]>
This is 4th submission of Intel service layer and FPGA patches.
This submission includes additional changes for Intel service layer driver to get the firmware version running at FPGA SoC device. Then FPGA manager driver, one of Intel service layer driver's client, can decide whether to handle the newly added bitstream authentication function based on the retrieved firmware version. So that we can maintain FPGA manager driver the back compatible.
Bitstream authentication makes sure a signed bitstream has valid signatures.
The customer sends the bitstream via FPGA framework and overlay, the firmware will authenticate the bitstream but not program the bitstream to device. If the authentication passes, the bitstream will be programmed into QSPI flash and will be expected to boot without issues.
Extend Intel service layer, FPGA manager and region drivers to support the bitstream authentication feature.
Richard Gong (6):
firmware: stratix10-svc: add COMMAND_AUTHENTICATE_BITSTREAM flag
firmware: stratix10-svc: extend SVC driver to get the firmware version
fpga: fpga-mgr: add FPGA_MGR_BITSTREAM_AUTHENTICATE flag
fpga: of-fpga-region: add authenticate-fpga-config property
dt-bindings: fpga: add authenticate-fpga-config property
fpga: stratix10-soc: extend driver for bitstream authentication
.../devicetree/bindings/fpga/fpga-region.txt | 4 ++ drivers/firmware/stratix10-svc.c | 12 ++++- drivers/fpga/of-fpga-region.c | 24 ++++++--- drivers/fpga/stratix10-soc.c | 62 +++++++++++++++++++--- include/linux/firmware/intel/stratix10-smc.h | 21 +++++++- .../linux/firmware/intel/stratix10-svc-client.h | 9 ++++ include/linux/fpga/fpga-mgr.h | 3 ++ 7 files changed, 118 insertions(+), 17 deletions(-)
Signature · 1 line
2.7.4
PATCH v4 1/6 firmware: stratix10-svc: add COMMAND_AUTHENTICATE_BITSTREAM flag
From: Richard Gong <[email protected]>
Add COMMAND_AUTHENTICATE_BITSTREAM command flag for new added bitstream authentication feature. Authenticating a bitstream is to make sure a signed bitstream has the valid signatures.
Except for the actual configuration of the device, the bitstream authentication works the same way as FPGA configuration does. If the authentication passes, the signed bitstream will be programmed into QSPI flash memory and will be expected to boot without issues.
---
v4: remove change at COMMAND_RECONFIG_FLAG_PARTIAL flag & add that to a
separate commit 27ad5309c247b6bde8a098e17e9bd9b1576b7f71. v3: no change v2: new added --- include/linux/firmware/intel/stratix10-svc-client.h | 5 +++++ 1 file changed, 5 insertions(+)
include/linux/firmware/intel/stratix10-svc-client.h +5 -0
@@ -55,8 +55,13 @@* * COMMAND_RECONFIG_FLAG_PARTIAL: * Set to FPGA configuration type (full or partial). +* +* COMMAND_AUTHENTICATE_BITSTREAM: +* Set for bitstream authentication, which makes sure a signed bitstream +* has valid signatures before committing it to device. */ #define COMMAND_RECONFIG_FLAG_PARTIAL 0 +#define COMMAND_AUTHENTICATE_BITSTREAM 1/** * Timeout settings for service clients:
Signature · 1 line
2.7.4
PATCH v4 2/6 firmware: stratix10-svc: extend SVC driver to get the firmware version
In reply to [email protected]From: Richard Gong <[email protected]>
Extend Intel service layer driver to get the firmware version running at FPGA device. Therefore FPGA manager driver, one of Intel service layer driver's client, can decide whether to handle the newly added bitstream authentication function based on the retrieved firmware version.
---
v4: no change
v3: new added, changes for getting firmware version
--- drivers/firmware/stratix10-svc.c | 12 ++++++++++-- include/linux/firmware/intel/stratix10-smc.h | 21 +++++++++++++++++++-- include/linux/firmware/intel/stratix10-svc-client.h | 4 ++++ 3 files changed, 33 insertions(+), 4 deletions(-)
drivers/firmware/stratix10-svc.c +10 -2
@@ -306,6 +306,7 @@ static void svc_thread_recv_status_ok(struct stratix10_svc_data *p_data,break ;case COMMAND_RSU_RETRY :case COMMAND_RSU_MAX_RETRY : +case COMMAND_FIRMWARE_VERSION : cb_data->status =BIT (SVC_STATUS_OK ); cb_data->kaddr1 = &res.a1;break ;
@@ -422,6 +423,11 @@ static int svc_normal_to_secure_thread(void *data) a1 =0 ; a2 =0 ;break ; +case COMMAND_FIRMWARE_VERSION : + a0 =INTEL_SIP_SMC_FIRMWARE_VERSION ; + a1 =0 ; + a2 =0 ; +break ;default :pr_warn ("it shouldn't happen\n" );break ;
@@ -487,11 +493,13 @@ static int svc_normal_to_secure_thread(void *data)/* * be compatible with older version firmware which -* doesn't support RSU notify or retry +* doesn't support RSU notify, retry or bitstream +* authentication. */ if ((pdata->command ==COMMAND_RSU_RETRY ) || (pdata->command ==COMMAND_RSU_MAX_RETRY ) || - (pdata->command ==COMMAND_RSU_NOTIFY )) { + (pdata->command ==COMMAND_RSU_NOTIFY ) || + (pdata->command ==COMMAND_FIRMWARE_VERSION )) { cbdata->status =BIT (SVC_STATUS_NO_SUPPORT ); cbdata->kaddr1 =NULL ;
include/linux/firmware/intel/stratix10-smc.h +19 -2
@@ -321,8 +321,6 @@ INTEL_SIP_SMC_FAST_CALL_VAL(INTEL_SIP_SMC_FUNCID_FPGA_CONFIG_COMPLETED_WRITE)#define INTEL_SIP_SMC_ECC_DBE \ INTEL_SIP_SMC_FAST_CALL_VAL(INTEL_SIP_SMC_FUNCID_ECC_DBE) -#endif -/** * Request INTEL_SIP_SMC_RSU_NOTIFY *
@@ -404,3 +402,22 @@ INTEL_SIP_SMC_FAST_CALL_VAL(INTEL_SIP_SMC_FUNCID_FPGA_CONFIG_COMPLETED_WRITE)#define INTEL_SIP_SMC_FUNCID_RSU_MAX_RETRY 18#define INTEL_SIP_SMC_RSU_MAX_RETRY \ INTEL_SIP_SMC_FAST_CALL_VAL(INTEL_SIP_SMC_FUNCID_RSU_MAX_RETRY) + +/** +* Request INTEL_SIP_SMC_FIRMWARE_VERSION +* +* Sync call used to query the version of running firmware +* +* Call register usage: +* a0 INTEL_SIP_SMC_FIRMWARE_VERSION +* a1-a7 not used +* +* Return status: +* a0 INTEL_SIP_SMC_STATUS_OK or INTEL_SIP_SMC_STATUS_ERROR +* a1 running firmware version +*/ +#define INTEL_SIP_SMC_FUNCID_FIRMWARE_VERSION 31 +#define INTEL_SIP_SMC_FIRMWARE_VERSION \ + INTEL_SIP_SMC_FAST_CALL_VAL(INTEL_SIP_SMC_FUNCID_FIRMWARE_VERSION) + +#endif
include/linux/firmware/intel/stratix10-svc-client.h +4 -0
@@ -109,6 +109,9 @@ struct stratix10_svc_chan;* * @COMMAND_RSU_DCMF_VERSION: query firmware for the DCMF version, return status * is SVC_STATUS_OK or SVC_STATUS_ERROR +* +* @COMMAND_FIRMWARE_VERSION: query running firmware version, return status +* is SVC_STATUS_OK or SVC_STATUS_ERROR */ enum stratix10_svc_command_code {COMMAND_NOOP =0 ,
@@ -122,6 +125,7 @@ enum stratix10_svc_command_code {COMMAND_RSU_RETRY ,COMMAND_RSU_MAX_RETRY ,COMMAND_RSU_DCMF_VERSION , + COMMAND_FIRMWARE_VERSION, };/**
Signature · 1 line
2.7.4
PATCH v4 3/6 fpga: fpga-mgr: add FPGA_MGR_BITSTREAM_AUTHENTICATE flag
In reply to [email protected]From: Richard Gong <[email protected]>
Add FPGA_MGR_BITSTREAM_AUTHENTICATE flag for FPGA bitstream authentication, which makes sure a signed bitstream has valid signatures.
Except for the actual configuration of the device, the authentication works the same way as FPGA configuration does. If the authentication passes, the bitstream will be programmed into QSPI flash and will be expected to boot without issues.
---
v4: s/FPGA_MGR_BITSTREM_AUTHENTICATION/FPGA_MGR_BITSTREAM_AUTHENTICATE
v3: no change
v2: align all FPGA_MGR_* flags
update the commit messages
--- include/linux/fpga/fpga-mgr.h | 3 +++ 1 file changed, 3 insertions(+)
include/linux/fpga/fpga-mgr.h +3 -0
@@ -67,12 +67,15 @@ enum fpga_mgr_states {* %FPGA_MGR_BITSTREAM_LSB_FIRST: SPI bitstream bit order is LSB first * * %FPGA_MGR_COMPRESSED_BITSTREAM: FPGA bitstream is compressed +* +* %FPGA_MGR_BITSTREAM_AUTHENTICATE: do FPGA bitstream authentication only */ #define FPGA_MGR_PARTIAL_RECONFIG BIT(0)#define FPGA_MGR_EXTERNAL_CONFIG BIT(1)#define FPGA_MGR_ENCRYPTED_BITSTREAM BIT(2)#define FPGA_MGR_BITSTREAM_LSB_FIRST BIT(3)#define FPGA_MGR_COMPRESSED_BITSTREAM BIT(4) +#define FPGA_MGR_BITSTREAM_AUTHENTICATE BIT(5)/** * struct fpga_image_info - information specific to a FPGA image
Signature · 1 line
2.7.4
PATCH v4 4/6 fpga: of-fpga-region: add authenticate-fpga-config property
In reply to [email protected]From: Richard Gong <[email protected]>
Add authenticate-fpga-config property to support FPGA bitstream authentication, which makes sure a signed bitstream has valid signatures.
---
v4: add additional checks to make sure *only* authenticate
v3: no change
v2: changed in alphabetical order
--- drivers/fpga/of-fpga-region.c | 24 +++++++++++++++++------- 1 file changed, 17 insertions(+), 7 deletions(-)
drivers/fpga/of-fpga-region.c +17 -7
@@ -218,15 +218,25 @@ static struct fpga_image_info *of_fpga_region_parse_ov( info->overlay = overlay; -/* Read FPGA region properties from the overlay */ -if (of_property_read_bool (overlay,"partial-fpga-config" )) - info->flags |=FPGA_MGR_PARTIAL_RECONFIG ; +/* +* Read FPGA region properties from the overlay. +* +* First check the integrity of the bitstream. If the +* authentication is passed, the user can perform other +* operations. +*/ +if (of_property_read_bool (overlay,"authenticate-fpga-config" )) { + info->flags |=FPGA_MGR_BITSTREAM_AUTHENTICATE ; + }else { +if (of_property_read_bool (overlay,"partial-fpga-config" )) + info->flags |=FPGA_MGR_PARTIAL_RECONFIG ; -if (of_property_read_bool (overlay,"external-fpga-config" )) - info->flags |=FPGA_MGR_EXTERNAL_CONFIG ; +if (of_property_read_bool (overlay,"external-fpga-config" )) + info->flags |=FPGA_MGR_EXTERNAL_CONFIG ; -if (of_property_read_bool (overlay,"encrypted-fpga-config" )) - info->flags |=FPGA_MGR_ENCRYPTED_BITSTREAM ; +if (of_property_read_bool (overlay,"encrypted-fpga-config" )) + info->flags |=FPGA_MGR_ENCRYPTED_BITSTREAM ; + }if (!of_property_read_string (overlay,"firmware-name" , &firmware_name)) {
Signature · 1 line
2.7.4
PATCH v4 5/6 dt-bindings: fpga: add authenticate-fpga-config property
In reply to [email protected]From: Richard Gong <[email protected]>
Add authenticate-fpga-config property for FPGA bitstream authentication, which makes sure a signed bitstream has valid signatures.
---
v4: explain authenticate-fpga-config flag further
v3: no change
v2: put authenticate-fpga-config above partial-fpga-config
update commit messages
--- Documentation/devicetree/bindings/fpga/fpga-region.txt | 4 ++++ 1 file changed, 4 insertions(+)
Documentation/devicetree/bindings/fpga/fpga-region.txt +4 -0
@@ -182,6 +182,10 @@ Optional properties: This property is optional if the FPGA Manager handles the bridges. If the fpga-region is the child of a fpga-bridge, the list should not contain the parent bridge. +- authenticate-fpga-config : boolean, set if do bitstream authentication only. + flag authenticate-fpga-config is used to first check the integrity of + the bitstream. If the authentication is passed, the user can perform + other operations. - partial-fpga-config : boolean, set if partial reconfiguration is to be done, otherwise full reconfiguration is done. - external-fpga-config : boolean, set if the FPGA has already been configured
Signature · 1 line
2.7.4
Moritz Fischer
maintainerRe: [PATCHv4 5/6] dt-bindings: fpga: add authenticate-fpga-config property
Quoted 20 lines · On Mon, Feb 01, 2021 at 09:21:58AM -0600, [email protected] wrote:
From: Richard Gong <[email protected]>
Add authenticate-fpga-config property for FPGA bitstream authentication, which makes sure a signed bitstream has valid signatures.
Signed-off-by Richard Gong <[email protected]>---
v4: explain authenticate-fpga-config flag further
v3: no change
v2: put authenticate-fpga-config above partial-fpga-config
update commit messages--- Documentation/devicetree/bindings/fpga/fpga-region.txt | 4 ++++ 1 file changed, 4 insertions(+)Documentation/devicetree/bindings/fpga/fpga-region.txt +0
-0
Documentation/devicetree/bindings/fpga/fpga-region.txt Optional properties: · line 188
Quoted 7 lines
Documentation/devicetree/bindings/fpga/fpga-region.txt +4
-0@@ -182,6 +182,10 @@ Optional properties: This property is optional if the FPGA Manager handles the bridges. If the fpga-region is the child of a fpga-bridge, the list should not contain the parent bridge. +- authenticate-fpga-config : boolean, set if do bitstream authentication only. + flag authenticate-fpga-config is used to first check the integrity of + the bitstream. If the authentication is passed, the user can perform + other operations.
From the other commits it looks like it *also* writes to QSPI? If so please document that.
If not, feel free to ignore :)
Maybe I would highlight two things:
a) If you add 'authenticate-fpga-config' you are not allowed to add new nodes
b) If you add 'authenticate-fpga-config' you are not alllowed to add other operations
Quoted 6 lines
Documentation/devicetree/bindings/fpga/fpga-region.txt +0
-0- partial-fpga-config : boolean, set if partial reconfiguration is to be done, otherwise full reconfiguration is done. - external-fpga-config : boolean, set if the FPGA has already been configuredSignature · 1 line
2.7.4
Thanks,
Moritz
Re: [PATCHv4 5/6] dt-bindings: fpga: add authenticate-fpga-config property
Hi Moritz,
Quoted 31 lines · Moritz Fischer
Quoted 20 lines · On Mon, Feb 01, 2021 at 09:21:58AM -0600, [email protected] wrote:
From: Richard Gong <[email protected]>
Add authenticate-fpga-config property for FPGA bitstream authentication, which makes sure a signed bitstream has valid signatures.
Signed-off-by Richard Gong <[email protected]>---
v4: explain authenticate-fpga-config flag further
v3: no change
v2: put authenticate-fpga-config above partial-fpga-config
update commit messages--- Documentation/devicetree/bindings/fpga/fpga-region.txt | 4 ++++ 1 file changed, 4 insertions(+)Documentation/devicetree/bindings/fpga/fpga-region.txt +0
-0Documentation/devicetree/bindings/fpga/fpga-region.txt Optional properties: · line 188
Quoted 7 lines
Documentation/devicetree/bindings/fpga/fpga-region.txt +4
-0@@ -182,6 +182,10 @@ Optional properties: This property is optional if the FPGA Manager handles the bridges. If the fpga-region is the child of a fpga-bridge, the list should not contain the parent bridge. +- authenticate-fpga-config : boolean, set if do bitstream authentication only. + flag authenticate-fpga-config is used to first check the integrity of + the bitstream. If the authentication is passed, the user can perform + other operations.From the other commits it looks like it *also* writes to QSPI? If so
please document that.
Quoted 7 lines
If not, feel free to ignore :)
Maybe I would highlight two things:
a) If you add 'authenticate-fpga-config' you are not allowed to add new nodes
b) If you add 'authenticate-fpga-config' you are not alllowed to add other operations
How about the descriptions below?
- authenticate-fpga-config : boolean, set if do bitstream authentication only.
If 'authenticate-fpga-config' is added then adding a new node or another operation is not allowed.
Flag authenticate-fpga-config is used to check the integrity of the bitstream.
Except for the actual configuration of the device, the authentication works in the same way as FPGA configuration. If the authentication passes, other operations such as full or partial reconfiguration can be performed. When the bitstream into QSPI flash memory at device is programmed, it is expected that there will be no issue when starting the device.
Quoted 9 lines
Quoted 6 lines
Documentation/devicetree/bindings/fpga/fpga-region.txt +0
-0- partial-fpga-config : boolean, set if partial reconfiguration is to be done, otherwise full reconfiguration is done. - external-fpga-config : boolean, set if the FPGA has already been configuredSignature · 1 line
2.7.4Thanks,
Moritz
Regards,
Richard
PATCH v4 6/6 fpga: stratix10-soc: extend driver for bitstream authentication
In reply to [email protected]From: Richard Gong <[email protected]>
Extend FPGA manager driver to support FPGA bitstream authentication on Intel SocFPGA platforms.
---
v4: s/FPGA_MGR_BITSTREM_AUTHENTICATION/FPGA_MGR_BITSTREAM_AUTHENTICATE
v3: add handle to retriev the firmware version to keep driver
back compatible
v2: use flag defined in stratix10-svc driver
--- drivers/fpga/stratix10-soc.c | 62 +++++++++++++++++++++++++++++++++++++++----- 1 file changed, 56 insertions(+), 6 deletions(-)
drivers/fpga/stratix10-soc.c +56 -6
@@ -24,6 +24,10 @@#define S10_BUFFER_TIMEOUT (msecs_to_jiffies(SVC_RECONFIG_BUFFER_TIMEOUT_MS))#define S10_RECONFIG_TIMEOUT (msecs_to_jiffies(SVC_RECONFIG_REQUEST_TIMEOUT_MS)) +#define INVALID_FIRMWARE_VERSION 0xFFFF +typedef void (*s10_callback )(struct stratix10_svc_client *client, +struct stratix10_svc_cb_data *data); +/* * struct s10_svc_buf * buf: virtual address of buf provided by service layer
@@ -40,11 +44,13 @@ struct s10_priv {struct completion status_return_completion;struct s10_svc_buf svc_bufs[NUM_SVC_BUFS ];unsigned long status; +unsigned int fw_version; };static int s10_svc_send_msg (struct s10_priv *priv,enum stratix10_svc_command_code command, -void *payload,u32 payload_length) +void *payload,u32 payload_length, +s10_callback callback) {struct stratix10_svc_chan *chan = priv->chan;struct device *dev = priv->client.dev;
@@ -57,6 +63,7 @@ static int s10_svc_send_msg(struct s10_priv *priv, msg.command = command; msg.payload = payload; msg.payload_length = payload_length; + priv->client.receive_cb = callback; ret =stratix10_svc_send (chan, &msg);dev_dbg (dev,"stratix10_svc_send returned status %d\n" , ret);
@@ -134,6 +141,29 @@ static void s10_unlock_bufs(struct s10_priv *priv, void *kaddr) }/* +* s10_fw_version_callback - callback for the version of running firmware +* @client: service layer client struct +* @data: message from service layer +*/ +static void s10_fw_version_callback (struct stratix10_svc_client *client, +struct stratix10_svc_cb_data *data) +{ +struct s10_priv *priv = client->priv; +unsigned int *version = (unsigned int *)data->kaddr1; + +if (data->status ==BIT (SVC_STATUS_OK )) + priv->fw_version = *version; +else if (data->status ==BIT (SVC_STATUS_NO_SUPPORT )) +dev_warn (client->dev, +"FW doesn't support bitstream authentication\n" ); +else +dev_err (client->dev,"Failed to get FW version %lu\n" , +BIT (data->status)); + +complete (&priv->status_return_completion); +} + +/* * s10_receive_callback - callback for service layer to use to provide client * (this driver) messages received through the mailbox. * client: service layer client struct
@@ -186,13 +216,22 @@ static int s10_ops_write_init(struct fpga_manager *mgr,if (info->flags &FPGA_MGR_PARTIAL_RECONFIG ) {dev_dbg (dev,"Requesting partial reconfiguration.\n" ); ctype.flags |=BIT (COMMAND_RECONFIG_FLAG_PARTIAL ); + }else if (info->flags &FPGA_MGR_BITSTREAM_AUTHENTICATE ) { +if (priv->fw_version ==INVALID_FIRMWARE_VERSION ) { +dev_err (dev,"FW doesn't support\n" ); +return -EINVAL ; + } + +dev_dbg (dev,"Requesting bitstream authentication.\n" ); + ctype.flags |=BIT (COMMAND_AUTHENTICATE_BITSTREAM ); }else {dev_dbg (dev,"Requesting full reconfiguration.\n" ); }reinit_completion (&priv->status_return_completion); ret =s10_svc_send_msg (priv,COMMAND_RECONFIG , - &ctype,sizeof (ctype)); + &ctype,sizeof (ctype), + s10_receive_callback);if (ret <0 ) goto init_done;
@@ -259,7 +298,7 @@ static int s10_send_buf(struct fpga_manager *mgr, const char *buf, size_t count) svc_buf = priv->svc_bufs[i].buf;memcpy (svc_buf, buf, xfer_sz); ret =s10_svc_send_msg (priv,COMMAND_RECONFIG_DATA_SUBMIT , - svc_buf, xfer_sz); + svc_buf, xfer_sz, s10_receive_callback);if (ret <0 ) {dev_err (dev,"Error while sending data to service layer (%d)" , ret);
@@ -303,7 +342,7 @@ static int s10_ops_write(struct fpga_manager *mgr, const char *buf, ret =s10_svc_send_msg ( priv,COMMAND_RECONFIG_DATA_CLAIM , -NULL ,0 ); +NULL ,0 , s10_receive_callback);if (ret <0 )break ; }
@@ -357,7 +396,8 @@ static int s10_ops_write_complete(struct fpga_manager *mgr, do { reinit_completion(&priv->status_return_completion); - ret = s10_svc_send_msg(priv, COMMAND_RECONFIG_STATUS, NULL, 0); + ret = s10_svc_send_msg(priv, COMMAND_RECONFIG_STATUS, + NULL, 0, s10_receive_callback); if (ret < 0) break;
@@ -411,8 +451,9 @@ static int s10_probe(struct platform_device *pdev)if (!priv)return -ENOMEM ; + priv->fw_version =INVALID_FIRMWARE_VERSION ; priv->client.dev = dev; - priv->client.receive_cb = s10_receive_callback; + priv->client.receive_cb =NULL ; priv->client.priv = priv; priv->chan = stratix10_svc_request_channel_byname(&priv->client,
@@ -440,6 +481,15 @@ static int s10_probe(struct platform_device *pdev) goto probe_err; } +/* get the running firmware version */ + ret =s10_svc_send_msg (priv,COMMAND_FIRMWARE_VERSION , +NULL ,0 , s10_fw_version_callback); +if (ret) { +dev_err (dev,"couldn't get firmware version\n" ); +fpga_mgr_free (mgr); + goto probe_err; + } +platform_set_drvdata (pdev, mgr);return ret;
Signature · 1 line
2.7.4