devlink: move common flash_update calls to core
Subsystems (12)
v3 cover devlink: move common flash_update calls to core
This series moves a couple common pieces done by all drivers of the ->flash_update interface into devlink.c flash update handler. Specifically, the core code will now request_firmware and devlink_flash_update_(begin|end)_notify.
This cleanup is intended to simplify driver implementations so that they have less work to do and are less capable of doing the "wrong" thing.
For request_firmware, this simplification is done as it is not expected that drivers would do anything else. It also standardizes all drivers so that they use the same interface (request_firmware, as opposed to request_firmware_direct), and allows reporting the netlink extended ack with the file name attribute.
For status notification, this change prevents drivers from sending a status message without properly sending the status end notification. The current userspace implementation of devlink relies on this end notification to properly close the flash update channel. Without this, the flash update process may hang indefinitely. By moving the begin and end calls into the core code, it is no longer possible for a driver author to get this wrong.
For the original patch that moved request_firmware, see [1]. For the v2 see [2]. For further discussion of the issues with devlink flash status see [3].
[1] https://lore.kernel.org/netdev/[email protected]/
[2] https://lore.kernel.org/netdev/[email protected]/
[3] https://lore.kernel.org/netdev/[email protected]/
Jacob Keller (2):
devlink: move request_firmware out of driver
devlink: move flash end and begin to core devlink
.../net/ethernet/broadcom/bnxt/bnxt_devlink.c | 4 +-- .../net/ethernet/broadcom/bnxt/bnxt_ethtool.c | 33 +++++++++++------ .../net/ethernet/broadcom/bnxt/bnxt_ethtool.h | 4 +-- .../net/ethernet/huawei/hinic/hinic_devlink.c | 12 +------ drivers/net/ethernet/intel/ice/ice_devlink.c | 17 +-------- .../net/ethernet/mellanox/mlx5/core/devlink.c | 11 +----- .../net/ethernet/mellanox/mlxfw/mlxfw_fsm.c | 3 -- drivers/net/ethernet/mellanox/mlxsw/core.c | 11 +----- .../net/ethernet/netronome/nfp/nfp_devlink.c | 2 +- drivers/net/ethernet/netronome/nfp/nfp_main.c | 17 ++------- drivers/net/ethernet/netronome/nfp/nfp_main.h | 2 +- .../ethernet/pensando/ionic/ionic_devlink.c | 2 +- .../ethernet/pensando/ionic/ionic_devlink.h | 2 +- .../net/ethernet/pensando/ionic/ionic_fw.c | 14 +------- drivers/net/netdevsim/dev.c | 2 -- include/net/devlink.h | 9 +++-- net/core/devlink.c | 36 ++++++++++++++----- 17 files changed, 67 insertions(+), 114 deletions(-)
base-commit: 83c317d7b36bb3858cf1cb86d2635ec3f3bd6ea3
Signature · 1 line
2.29.0
PATCH v3 1/2 devlink: move request_firmware out of driver
All drivers which implement the devlink flash update support, with the exception of netdevsim, use either request_firmware or request_firmware_direct to locate the firmware file. Rather than having each driver do this separately as part of its .flash_update implementation, perform the request_firmware within net/core/devlink.c
Replace the file_name parameter in the struct devlink_flash_update_params with a pointer to the fw object.
Use request_firmware rather than request_firmware_direct. Although most Linux distributions today do not have the fallback mechanism implemented, only about half the drivers used the _direct request, as compared to the generic request_firmware. In the event that a distribution does support the fallback mechanism, the devlink flash update ought to be able to use it to provide the firmware contents. For distributions which do not support the fallback userspace mechanism, there should be essentially no difference between request_firmware and request_firmware_direct.
--- .../net/ethernet/broadcom/bnxt/bnxt_devlink.c | 2 +- .../net/ethernet/broadcom/bnxt/bnxt_ethtool.c | 33 ++++++++++++------- .../net/ethernet/broadcom/bnxt/bnxt_ethtool.h | 4 +-- .../net/ethernet/huawei/hinic/hinic_devlink.c | 12 +------ drivers/net/ethernet/intel/ice/ice_devlink.c | 14 +------- .../net/ethernet/mellanox/mlx5/core/devlink.c | 11 +------ drivers/net/ethernet/mellanox/mlxsw/core.c | 11 +------ .../net/ethernet/netronome/nfp/nfp_devlink.c | 2 +- drivers/net/ethernet/netronome/nfp/nfp_main.c | 17 ++-------- drivers/net/ethernet/netronome/nfp/nfp_main.h | 2 +- .../ethernet/pensando/ionic/ionic_devlink.c | 2 +- .../ethernet/pensando/ionic/ionic_devlink.h | 2 +- .../net/ethernet/pensando/ionic/ionic_fw.c | 12 +------ include/net/devlink.h | 7 ++-- net/core/devlink.c | 26 ++++++++++++--- 15 files changed, 61 insertions(+), 96 deletions(-)
drivers/net/ethernet/broadcom/bnxt/bnxt_devlink.c +1 -1
@@ -32,7 +32,7 @@ bnxt_dl_flash_update(struct devlink *dl,devlink_flash_update_begin_notify (dl);devlink_flash_update_status_notify (dl,"Preparing to flash" ,NULL ,0 ,0 ); - rc =bnxt_flash_package_from_file (bp->dev, params->file_name,0 ); + rc =bnxt_flash_package_from_fw_obj (bp->dev, params->fw,0 );if (!rc)devlink_flash_update_status_notify (dl,"Flashing done" ,NULL ,0 ,0 );else
drivers/net/ethernet/broadcom/bnxt/bnxt_ethtool.c +22 -11
@@ -2416,13 +2416,12 @@ static int bnxt_flash_firmware_from_file(struct net_device *dev,return rc; } -int bnxt_flash_package_from_file (struct net_device *dev,const char *filename, -u32 install_type) +int bnxt_flash_package_from_fw_obj (struct net_device *dev,const struct firmware *fw, +u32 install_type) {struct bnxt *bp =netdev_priv (dev);struct hwrm_nvm_install_update_output *resp = bp->hwrm_cmd_resp_addr;struct hwrm_nvm_install_update_input install = {0 }; -const struct firmware *fw;u32 item_len;int rc =0 ;u16 index;
@@ -2437,13 +2436,6 @@ int bnxt_flash_package_from_file(struct net_device *dev, const char *filename,return rc; } - rc =request_firmware (&fw, filename, &dev->dev); -if (rc !=0 ) { -netdev_err (dev,"PKG error %d requesting file: %s\n" , - rc, filename); -return rc; - } -if (fw->size > item_len) {netdev_err (dev,"PKG insufficient update area in nvram: %lu\n" , (unsigned long )fw->size);
@@ -2475,7 +2467,6 @@ int bnxt_flash_package_from_file(struct net_device *dev, const char *filename, dma_handle); } } -release_firmware (fw);if (rc) goto err_exit;
@@ -2514,6 +2505,26 @@ int bnxt_flash_package_from_file(struct net_device *dev, const char *filename,return rc; } +static int bnxt_flash_package_from_file (struct net_device *dev,const char *filename, +u32 install_type) +{ +const struct firmware *fw; +int rc; + + rc =request_firmware (&fw, filename, &dev->dev); +if (rc !=0 ) { +netdev_err (dev,"PKG error %d requesting file: %s\n" , + rc, filename); +return rc; + } + + rc =bnxt_flash_package_from_fw_obj (dev, fw, install_type); + +release_firmware (fw); + +return rc; +} +static int bnxt_flash_device (struct net_device *dev,struct ethtool_flash *flash) {
drivers/net/ethernet/broadcom/bnxt/bnxt_ethtool.h +2 -2
@@ -94,8 +94,8 @@ u32 bnxt_fw_to_ethtool_speed(u16);u16 bnxt_get_fw_auto_link_speeds (u32 );int bnxt_hwrm_nvm_get_dev_info (struct bnxt *bp,struct hwrm_nvm_get_dev_info_output *nvm_dev_info); -int bnxt_flash_package_from_file (struct net_device *dev,const char *filename, -u32 install_type); +int bnxt_flash_package_from_fw_obj (struct net_device *dev,const struct firmware *fw, +u32 install_type);void bnxt_ethtool_init (struct bnxt *bp);void bnxt_ethtool_free (struct bnxt *bp);
drivers/net/ethernet/huawei/hinic/hinic_devlink.c +1 -11
@@ -285,18 +285,8 @@ static int hinic_devlink_flash_update(struct devlink *devlink, struct netlink_ext_ack *extack) {struct hinic_devlink_priv *priv =devlink_priv (devlink); -const struct firmware *fw; -int err; - err =request_firmware_direct (&fw, params->file_name, - &priv->hwdev->hwif->pdev->dev); -if (err) -return err; - - err =hinic_firmware_update (priv, fw, extack); -release_firmware (fw); - -return err; +return hinic_firmware_update (priv, params->fw, extack); }static const struct devlink_ops hinic_devlink_ops = {
drivers/net/ethernet/intel/ice/ice_devlink.c +1 -13
@@ -247,9 +247,7 @@ ice_devlink_flash_update(struct devlink *devlink, struct netlink_ext_ack *extack) {struct ice_pf *pf =devlink_priv (devlink); -struct device *dev = &pf->pdev->dev;struct ice_hw *hw = &pf->hw; -const struct firmware *fw;u8 preservation;int err;
@@ -277,21 +275,11 @@ ice_devlink_flash_update(struct devlink *devlink,if (err)return err; - err =request_firmware (&fw, params->file_name, dev); -if (err) { -NL_SET_ERR_MSG_MOD (extack,"Unable to read file from disk" ); -return err; - } - -dev_dbg (dev,"Beginning flash update with file '%s'\n" , params->file_name); -devlink_flash_update_begin_notify (devlink);devlink_flash_update_status_notify (devlink,"Preparing to flash" ,NULL ,0 ,0 ); - err =ice_flash_pldm_image (pf, fw, preservation, extack); + err =ice_flash_pldm_image (pf, params->fw, preservation, extack);devlink_flash_update_end_notify (devlink); -release_firmware (fw); -return err; }
drivers/net/ethernet/mellanox/mlx5/core/devlink.c +1 -10
@@ -13,17 +13,8 @@ static int mlx5_devlink_flash_update(struct devlink *devlink, struct netlink_ext_ack *extack) {struct mlx5_core_dev *dev =devlink_priv (devlink); -const struct firmware *fw; -int err; - err =request_firmware_direct (&fw, params->file_name, &dev->pdev->dev); -if (err) -return err; - - err =mlx5_firmware_flash (dev, fw, extack); -release_firmware (fw); - -return err; +return mlx5_firmware_flash (dev, params->fw, extack); }static u8 mlx5_fw_ver_major (u32 version)
drivers/net/ethernet/mellanox/mlxsw/core.c +1 -10
@@ -1116,16 +1116,7 @@ static int mlxsw_core_fw_flash_update(struct mlxsw_core *mlxsw_core,struct devlink_flash_update_params *params, struct netlink_ext_ack *extack) { - const struct firmware *firmware; -int err; - - err =request_firmware_direct (&firmware, params->file_name, mlxsw_core->bus_info->dev); -if (err) -return err; - err =mlxsw_core_fw_flash (mlxsw_core, firmware, extack); -release_firmware (firmware); - -return err; + return mlxsw_core_fw_flash(mlxsw_core, params->fw, extack); } static int mlxsw_core_devlink_param_fw_load_policy_validate(struct devlink *devlink, u32 id,
drivers/net/ethernet/netronome/nfp/nfp_devlink.c +1 -1
@@ -333,7 +333,7 @@ nfp_devlink_flash_update(struct devlink *devlink,struct devlink_flash_update_params *params, struct netlink_ext_ack *extack) { - return nfp_flash_update_common(devlink_priv(devlink), params->file_name, extack); + return nfp_flash_update_common(devlink_priv(devlink), params->fw, extack); } const struct devlink_ops nfp_devlink_ops = {
drivers/net/ethernet/netronome/nfp/nfp_main.c +2 -15
@@ -301,11 +301,10 @@ static int nfp_pcie_sriov_configure(struct pci_dev *pdev, int num_vfs)return nfp_pcie_sriov_enable (pdev, num_vfs); } -int nfp_flash_update_common (struct nfp_pf *pf,const char *path, +int nfp_flash_update_common (struct nfp_pf *pf,const struct firmware *fw,struct netlink_ext_ack *extack) {struct device *dev = &pf->pdev->dev; -const struct firmware *fw;struct nfp_nsp *nsp;int err;
@@ -319,24 +318,12 @@ int nfp_flash_update_common(struct nfp_pf *pf, const char *path,return err; } - err =request_firmware_direct (&fw, path, dev); -if (err) { -NL_SET_ERR_MSG_MOD (extack, -"unable to read flash file from disk" ); - goto exit_close_nsp; - } - -dev_info (dev,"Please be patient while writing flash image: %s\n" , - path); - err =nfp_nsp_write_flash (nsp, fw);if (err <0 ) - goto exit_release_fw; + goto exit_close_nsp;dev_info (dev,"Finished writing flash image\n" ); err =0 ; -exit_release_fw: -release_firmware (fw); exit_close_nsp:nfp_nsp_close (nsp);return err;
drivers/net/ethernet/netronome/nfp/nfp_main.h +1 -1
@@ -166,7 +166,7 @@ nfp_pf_map_rtsym(struct nfp_pf *pf, const char *name, const char *sym_fmt, unsigned int min_size, struct nfp_cpp_area **area);int nfp_mbox_cmd (struct nfp_pf *pf,u32 cmd,void *in_data,u64 in_length,void *out_data,u64 out_length); -int nfp_flash_update_common (struct nfp_pf *pf,const char *path, +int nfp_flash_update_common (struct nfp_pf *pf,const struct firmware *fw,struct netlink_ext_ack *extack);enum nfp_dump_diag {
drivers/net/ethernet/pensando/ionic/ionic_devlink.c +1 -1
@@ -15,7 +15,7 @@ static int ionic_dl_flash_update(struct devlink *dl, {struct ionic *ionic =devlink_priv (dl); -return ionic_firmware_update (ionic->lif, params->file_name, extack); +return ionic_firmware_update (ionic->lif, params->fw, extack); } static int ionic_dl_info_get(struct devlink *dl, struct devlink_info_req *req,
drivers/net/ethernet/pensando/ionic/ionic_devlink.h +1 -1
@@ -6,7 +6,7 @@#include <net/devlink.h> -int ionic_firmware_update (struct ionic_lif *lif,const char *fw_name, +int ionic_firmware_update (struct ionic_lif *lif,const struct firmware *fw,struct netlink_ext_ack *extack);struct ionic *ionic_devlink_alloc (struct device *dev);
drivers/net/ethernet/pensando/ionic/ionic_fw.c +1 -11
@@ -91,7 +91,7 @@ static int ionic_fw_status_long_wait(struct ionic *ionic,return err; } -int ionic_firmware_update (struct ionic_lif *lif,const char *fw_name, +int ionic_firmware_update (struct ionic_lif *lif,const struct firmware *fw,struct netlink_ext_ack *extack) {struct ionic_dev *idev = &lif->ionic->idev;
@@ -99,24 +99,15 @@ int ionic_firmware_update(struct ionic_lif *lif, const char *fw_name,struct ionic *ionic = lif->ionic;union ionic_dev_cmd_comp comp;u32 buf_sz, copy_sz, offset; -const struct firmware *fw;struct devlink *dl;int next_interval;int err =0 ;u8 fw_slot; -netdev_info (netdev,"Installing firmware %s\n" , fw_name); - dl =priv_to_devlink (ionic);devlink_flash_update_begin_notify (dl);devlink_flash_update_status_notify (dl,"Preparing to flash" ,NULL ,0 ,0 ); - err =request_firmware (&fw, fw_name, ionic->dev); -if (err) { -NL_SET_ERR_MSG_MOD (extack,"Unable to find firmware file" ); - goto err_out; - } - buf_sz =sizeof (idev->dev_cmd_regs->data); netdev_dbg(netdev,
@@ -200,7 +191,6 @@ int ionic_firmware_update(struct ionic_lif *lif, const char *fw_name,devlink_flash_update_status_notify (dl,"Flash failed" ,NULL ,0 ,0 ); else devlink_flash_update_status_notify(dl, "Flash done", NULL, 0, 0); -release_firmware (fw);devlink_flash_update_end_notify (dl);return err; }
include/net/devlink.h +4 -3
@@ -19,6 +19,7 @@#include <net/flow_offload.h> #include <uapi/linux/devlink.h> #include <linux/xarray.h> +#include <linux/firmware.h> #define DEVLINK_RELOAD_STATS_ARRAY_SIZE \ (__DEVLINK_RELOAD_LIMIT_MAX * __DEVLINK_RELOAD_ACTION_MAX)
@@ -566,15 +567,15 @@ enum devlink_param_generic_id {/** * struct devlink_flash_update_params - Flash Update parameters -* @file_name: the name of the flash firmware file to update from +* @fw: pointer to the firmware data to update from * @component: the flash component to update * -* With the exception of file_name, drivers must opt-in to parameters by +* With the exception of fw, drivers must opt-in to parameters by * setting the appropriate bit in the supported_flash_update_params field in * their devlink_ops structure. */ struct devlink_flash_update_params { -const char *file_name; +const struct firmware *fw;const char *component;u32 overwrite_mask; };
net/core/devlink.c +21 -5
@@ -3429,10 +3429,12 @@ EXPORT_SYMBOL_GPL(devlink_flash_update_timeout_notify);static int devlink_nl_cmd_flash_update (struct sk_buff *skb,struct genl_info *info) { -struct nlattr *nla_component, *nla_overwrite_mask; +struct nlattr *nla_component, *nla_overwrite_mask, *nla_file_name;struct devlink_flash_update_params params = {};struct devlink *devlink = info->user_ptr[0 ]; +const char *file_name;u32 supported_params; +int ret;if (!devlink->ops->flash_update)return -EOPNOTSUPP ;
@@ -3442,8 +3444,6 @@ static int devlink_nl_cmd_flash_update(struct sk_buff *skb, supported_params = devlink->ops->supported_flash_update_params; - params.file_name =nla_data (info->attrs[DEVLINK_ATTR_FLASH_UPDATE_FILE_NAME ]); - nla_component = info->attrs[DEVLINK_ATTR_FLASH_UPDATE_COMPONENT ];if (nla_component) {if (!(supported_params &DEVLINK_SUPPORT_FLASH_UPDATE_COMPONENT )) {
@@ -3467,7 +3467,19 @@ static int devlink_nl_cmd_flash_update(struct sk_buff *skb, params.overwrite_mask = sections.value & sections.selector; } -return devlink->ops->flash_update (devlink, ¶ms, info->extack); + nla_file_name = info->attrs[DEVLINK_ATTR_FLASH_UPDATE_FILE_NAME ]; + file_name =nla_data (nla_file_name); + ret =request_firmware (¶ms.fw, file_name, devlink->dev); +if (ret) { +NL_SET_ERR_MSG_ATTR (info->extack, nla_file_name,"failed to locate the requested firmware file" ); +return ret; + } + + ret = devlink->ops->flash_update (devlink, ¶ms, info->extack); + +release_firmware (params.fw); + +return ret; }static const struct devlink_param devlink_param_generic[] = {
@@ -10225,12 +10237,16 @@ int devlink_compat_flash_update(struct net_device *dev, const char *file_name) goto out; } - params.file_name = file_name; + ret =request_firmware (¶ms.fw, file_name, devlink->dev); +if (ret) + goto out;mutex_lock (&devlink->lock); ret = devlink->ops->flash_update (devlink, ¶ms,NULL );mutex_unlock (&devlink->lock); +release_firmware (params.fw); + out:rtnl_lock ();dev_put (dev);
Signature · 1 line
2.29.0
Re: [net-next v3 1/2] devlink: move request_firmware out of driver
Quoted 27 lines · Jacob Keller
All drivers which implement the devlink flash update support, with the exception of netdevsim, use either
request_firmwareorrequest_firmware_directto locate the firmware file. Rather than having each driver do this separately as part of its .flash_update implementation, perform therequest_firmwarewithinnet/core/devlink.cReplace the
file_nameparameter in the structdevlink_flash_update_paramswith a pointer to the fw object.Use
request_firmwarerather thanrequest_firmware_direct. Although most Linux distributions today do not have the fallback mechanism implemented, only about half the drivers used the_directrequest, as compared to the genericrequest_firmware. In the event that a distribution does support the fallback mechanism, the devlink flash update ought to be able to use it to provide the firmware contents. For distributions which do not support the fallback userspace mechanism, there should be essentially no difference betweenrequest_firmwareandrequest_firmware_direct.Signed-off-by Jacob Keller <[email protected]>Cc Jiri Pirko <[email protected]>Cc Michael Chan <[email protected]>Cc Shannon Nelson <[email protected]>Cc Saeed Mahameed <[email protected]>Cc Boris Pismenny <[email protected]>Cc Bin Luo <[email protected]>Cc Jakub Kicinksi <[email protected]>
Quoted 1 line
---
Oof, forgot to metion that the only change since v2 is to fix the typo in the commit message pointed out by Shannon. Otherwise, this patch is identical and just comes in series with the other change.
Quoted 459 lines
.../net/ethernet/broadcom/bnxt/bnxt_devlink.c | 2 +- .../net/ethernet/broadcom/bnxt/bnxt_ethtool.c | 33 ++++++++++++------- .../net/ethernet/broadcom/bnxt/bnxt_ethtool.h | 4 +-- .../net/ethernet/huawei/hinic/hinic_devlink.c | 12 +------ drivers/net/ethernet/intel/ice/ice_devlink.c | 14 +------- .../net/ethernet/mellanox/mlx5/core/devlink.c | 11 +------ drivers/net/ethernet/mellanox/mlxsw/core.c | 11 +------ .../net/ethernet/netronome/nfp/nfp_devlink.c | 2 +- drivers/net/ethernet/netronome/nfp/nfp_main.c | 17 ++-------- drivers/net/ethernet/netronome/nfp/nfp_main.h | 2 +- .../ethernet/pensando/ionic/ionic_devlink.c | 2 +- .../ethernet/pensando/ionic/ionic_devlink.h | 2 +- .../net/ethernet/pensando/ionic/ionic_fw.c | 12 +------ include/net/devlink.h | 7 ++-- net/core/devlink.c | 26 ++++++++++++--- 15 files changed, 61 insertions(+), 96 deletions(-)drivers/net/ethernet/broadcom/bnxt/bnxt_devlink.c +1
-1@@ -32,7 +32,7 @@ bnxt_dl_flash_update(struct devlink *dl,devlink_flash_update_begin_notify (dl);devlink_flash_update_status_notify (dl,"Preparing to flash" ,NULL ,0 ,0 ); - rc =bnxt_flash_package_from_file (bp->dev, params->file_name,0 ); + rc =bnxt_flash_package_from_fw_obj (bp->dev, params->fw,0 );if (!rc)devlink_flash_update_status_notify (dl,"Flashing done" ,NULL ,0 ,0 );else drivers/net/ethernet/broadcom/bnxt/bnxt_ethtool.c +22
-11@@ -2416,13 +2416,12 @@ static int bnxt_flash_firmware_from_file(struct net_device *dev,return rc; } -int bnxt_flash_package_from_file (struct net_device *dev,const char *filename, -u32 install_type) +int bnxt_flash_package_from_fw_obj (struct net_device *dev,const struct firmware *fw, +u32 install_type) {struct bnxt *bp =netdev_priv (dev);struct hwrm_nvm_install_update_output *resp = bp->hwrm_cmd_resp_addr;struct hwrm_nvm_install_update_input install = {0 }; -const struct firmware *fw;u32 item_len;int rc =0 ;u16 index;@@ -2437,13 +2436,6 @@ int bnxt_flash_package_from_file(struct net_device *dev, const char *filename,return rc; } - rc =request_firmware (&fw, filename, &dev->dev); -if (rc !=0 ) { -netdev_err (dev,"PKG error %d requesting file: %s\n" , - rc, filename); -return rc; - } -if (fw->size > item_len) {netdev_err (dev,"PKG insufficient update area in nvram: %lu\n" , (unsigned long )fw->size);@@ -2475,7 +2467,6 @@ int bnxt_flash_package_from_file(struct net_device *dev, const char *filename, dma_handle); } } -release_firmware (fw);if (rc) goto err_exit;@@ -2514,6 +2505,26 @@ int bnxt_flash_package_from_file(struct net_device *dev, const char *filename,return rc; } +static int bnxt_flash_package_from_file (struct net_device *dev,const char *filename, +u32 install_type) +{ +const struct firmware *fw; +int rc; + + rc =request_firmware (&fw, filename, &dev->dev); +if (rc !=0 ) { +netdev_err (dev,"PKG error %d requesting file: %s\n" , + rc, filename); +return rc; + } + + rc =bnxt_flash_package_from_fw_obj (dev, fw, install_type); + +release_firmware (fw); + +return rc; +} +static int bnxt_flash_device (struct net_device *dev,struct ethtool_flash *flash) {drivers/net/ethernet/broadcom/bnxt/bnxt_ethtool.h +2
-2@@ -94,8 +94,8 @@ u32 bnxt_fw_to_ethtool_speed(u16);u16 bnxt_get_fw_auto_link_speeds (u32 );int bnxt_hwrm_nvm_get_dev_info (struct bnxt *bp,struct hwrm_nvm_get_dev_info_output *nvm_dev_info); -int bnxt_flash_package_from_file (struct net_device *dev,const char *filename, -u32 install_type); +int bnxt_flash_package_from_fw_obj (struct net_device *dev,const struct firmware *fw, +u32 install_type);void bnxt_ethtool_init (struct bnxt *bp);void bnxt_ethtool_free (struct bnxt *bp);drivers/net/ethernet/huawei/hinic/hinic_devlink.c +1
-11@@ -285,18 +285,8 @@ static int hinic_devlink_flash_update(struct devlink *devlink, struct netlink_ext_ack *extack) {struct hinic_devlink_priv *priv =devlink_priv (devlink); -const struct firmware *fw; -int err; - err =request_firmware_direct (&fw, params->file_name, - &priv->hwdev->hwif->pdev->dev); -if (err) -return err; - - err =hinic_firmware_update (priv, fw, extack); -release_firmware (fw); - -return err; +return hinic_firmware_update (priv, params->fw, extack); }static const struct devlink_ops hinic_devlink_ops = {drivers/net/ethernet/intel/ice/ice_devlink.c +1
-13@@ -247,9 +247,7 @@ ice_devlink_flash_update(struct devlink *devlink, struct netlink_ext_ack *extack) {struct ice_pf *pf =devlink_priv (devlink); -struct device *dev = &pf->pdev->dev;struct ice_hw *hw = &pf->hw; -const struct firmware *fw;u8 preservation;int err;@@ -277,21 +275,11 @@ ice_devlink_flash_update(struct devlink *devlink,if (err)return err; - err =request_firmware (&fw, params->file_name, dev); -if (err) { -NL_SET_ERR_MSG_MOD (extack,"Unable to read file from disk" ); -return err; - } - -dev_dbg (dev,"Beginning flash update with file '%s'\n" , params->file_name); -devlink_flash_update_begin_notify (devlink);devlink_flash_update_status_notify (devlink,"Preparing to flash" ,NULL ,0 ,0 ); - err =ice_flash_pldm_image (pf, fw, preservation, extack); + err =ice_flash_pldm_image (pf, params->fw, preservation, extack);devlink_flash_update_end_notify (devlink); -release_firmware (fw); -return err; }drivers/net/ethernet/mellanox/mlx5/core/devlink.c +1
-10@@ -13,17 +13,8 @@ static int mlx5_devlink_flash_update(struct devlink *devlink, struct netlink_ext_ack *extack) {struct mlx5_core_dev *dev =devlink_priv (devlink); -const struct firmware *fw; -int err; - err =request_firmware_direct (&fw, params->file_name, &dev->pdev->dev); -if (err) -return err; - - err =mlx5_firmware_flash (dev, fw, extack); -release_firmware (fw); - -return err; +return mlx5_firmware_flash (dev, params->fw, extack); }static u8 mlx5_fw_ver_major (u32 version)drivers/net/ethernet/mellanox/mlxsw/core.c +1
-10@@ -1116,16 +1116,7 @@ static int mlxsw_core_fw_flash_update(struct mlxsw_core *mlxsw_core,struct devlink_flash_update_params *params, struct netlink_ext_ack *extack) { - const struct firmware *firmware; -int err; - - err =request_firmware_direct (&firmware, params->file_name, mlxsw_core->bus_info->dev); -if (err) -return err; - err =mlxsw_core_fw_flash (mlxsw_core, firmware, extack); -release_firmware (firmware); - -return err; + return mlxsw_core_fw_flash(mlxsw_core, params->fw, extack); } static int mlxsw_core_devlink_param_fw_load_policy_validate(struct devlink *devlink, u32 id,drivers/net/ethernet/netronome/nfp/nfp_devlink.c +1
-1@@ -333,7 +333,7 @@ nfp_devlink_flash_update(struct devlink *devlink,struct devlink_flash_update_params *params, struct netlink_ext_ack *extack) { - return nfp_flash_update_common(devlink_priv(devlink), params->file_name, extack); + return nfp_flash_update_common(devlink_priv(devlink), params->fw, extack); } const struct devlink_ops nfp_devlink_ops = {drivers/net/ethernet/netronome/nfp/nfp_main.c +2
-15@@ -301,11 +301,10 @@ static int nfp_pcie_sriov_configure(struct pci_dev *pdev, int num_vfs)return nfp_pcie_sriov_enable (pdev, num_vfs); } -int nfp_flash_update_common (struct nfp_pf *pf,const char *path, +int nfp_flash_update_common (struct nfp_pf *pf,const struct firmware *fw,struct netlink_ext_ack *extack) {struct device *dev = &pf->pdev->dev; -const struct firmware *fw;struct nfp_nsp *nsp;int err;@@ -319,24 +318,12 @@ int nfp_flash_update_common(struct nfp_pf *pf, const char *path,return err; } - err =request_firmware_direct (&fw, path, dev); -if (err) { -NL_SET_ERR_MSG_MOD (extack, -"unable to read flash file from disk" ); - goto exit_close_nsp; - } - -dev_info (dev,"Please be patient while writing flash image: %s\n" , - path); - err =nfp_nsp_write_flash (nsp, fw);if (err <0 ) - goto exit_release_fw; + goto exit_close_nsp;dev_info (dev,"Finished writing flash image\n" ); err =0 ; -exit_release_fw: -release_firmware (fw); exit_close_nsp:nfp_nsp_close (nsp);return err;drivers/net/ethernet/netronome/nfp/nfp_main.h +1
-1@@ -166,7 +166,7 @@ nfp_pf_map_rtsym(struct nfp_pf *pf, const char *name, const char *sym_fmt, unsigned int min_size, struct nfp_cpp_area **area);int nfp_mbox_cmd (struct nfp_pf *pf,u32 cmd,void *in_data,u64 in_length,void *out_data,u64 out_length); -int nfp_flash_update_common (struct nfp_pf *pf,const char *path, +int nfp_flash_update_common (struct nfp_pf *pf,const struct firmware *fw,struct netlink_ext_ack *extack);enum nfp_dump_diag {drivers/net/ethernet/pensando/ionic/ionic_devlink.c +1
-1@@ -15,7 +15,7 @@ static int ionic_dl_flash_update(struct devlink *dl, {struct ionic *ionic =devlink_priv (dl); -return ionic_firmware_update (ionic->lif, params->file_name, extack); +return ionic_firmware_update (ionic->lif, params->fw, extack); } static int ionic_dl_info_get(struct devlink *dl, struct devlink_info_req *req,drivers/net/ethernet/pensando/ionic/ionic_devlink.h +1
-1@@ -6,7 +6,7 @@#include <net/devlink.h> -int ionic_firmware_update (struct ionic_lif *lif,const char *fw_name, +int ionic_firmware_update (struct ionic_lif *lif,const struct firmware *fw,struct netlink_ext_ack *extack);struct ionic *ionic_devlink_alloc (struct device *dev);drivers/net/ethernet/pensando/ionic/ionic_fw.c +1
-11@@ -91,7 +91,7 @@ static int ionic_fw_status_long_wait(struct ionic *ionic,return err; } -int ionic_firmware_update (struct ionic_lif *lif,const char *fw_name, +int ionic_firmware_update (struct ionic_lif *lif,const struct firmware *fw,struct netlink_ext_ack *extack) {struct ionic_dev *idev = &lif->ionic->idev;@@ -99,24 +99,15 @@ int ionic_firmware_update(struct ionic_lif *lif, const char *fw_name,struct ionic *ionic = lif->ionic;union ionic_dev_cmd_comp comp;u32 buf_sz, copy_sz, offset; -const struct firmware *fw;struct devlink *dl;int next_interval;int err =0 ;u8 fw_slot; -netdev_info (netdev,"Installing firmware %s\n" , fw_name); - dl =priv_to_devlink (ionic);devlink_flash_update_begin_notify (dl);devlink_flash_update_status_notify (dl,"Preparing to flash" ,NULL ,0 ,0 ); - err =request_firmware (&fw, fw_name, ionic->dev); -if (err) { -NL_SET_ERR_MSG_MOD (extack,"Unable to find firmware file" ); - goto err_out; - } - buf_sz =sizeof (idev->dev_cmd_regs->data); netdev_dbg(netdev,@@ -200,7 +191,6 @@ int ionic_firmware_update(struct ionic_lif *lif, const char *fw_name,devlink_flash_update_status_notify (dl,"Flash failed" ,NULL ,0 ,0 ); else devlink_flash_update_status_notify(dl, "Flash done", NULL, 0, 0); -release_firmware (fw);devlink_flash_update_end_notify (dl);return err; }include/net/devlink.h +4
-3@@ -19,6 +19,7 @@#include <net/flow_offload.h> #include <uapi/linux/devlink.h> #include <linux/xarray.h> +#include <linux/firmware.h> #define DEVLINK_RELOAD_STATS_ARRAY_SIZE \ (__DEVLINK_RELOAD_LIMIT_MAX * __DEVLINK_RELOAD_ACTION_MAX)@@ -566,15 +567,15 @@ enum devlink_param_generic_id {/** * struct devlink_flash_update_params - Flash Update parameters -* @file_name: the name of the flash firmware file to update from +* @fw: pointer to the firmware data to update from * @component: the flash component to update * -* With the exception of file_name, drivers must opt-in to parameters by +* With the exception of fw, drivers must opt-in to parameters by * setting the appropriate bit in the supported_flash_update_params field in * their devlink_ops structure. */ struct devlink_flash_update_params { -const char *file_name; +const struct firmware *fw;const char *component;u32 overwrite_mask; };net/core/devlink.c +21
-5@@ -3429,10 +3429,12 @@ EXPORT_SYMBOL_GPL(devlink_flash_update_timeout_notify);static int devlink_nl_cmd_flash_update (struct sk_buff *skb,struct genl_info *info) { -struct nlattr *nla_component, *nla_overwrite_mask; +struct nlattr *nla_component, *nla_overwrite_mask, *nla_file_name;struct devlink_flash_update_params params = {};struct devlink *devlink = info->user_ptr[0 ]; +const char *file_name;u32 supported_params; +int ret;if (!devlink->ops->flash_update)return -EOPNOTSUPP ;@@ -3442,8 +3444,6 @@ static int devlink_nl_cmd_flash_update(struct sk_buff *skb, supported_params = devlink->ops->supported_flash_update_params; - params.file_name =nla_data (info->attrs[DEVLINK_ATTR_FLASH_UPDATE_FILE_NAME ]); - nla_component = info->attrs[DEVLINK_ATTR_FLASH_UPDATE_COMPONENT ];if (nla_component) {if (!(supported_params &DEVLINK_SUPPORT_FLASH_UPDATE_COMPONENT )) {@@ -3467,7 +3467,19 @@ static int devlink_nl_cmd_flash_update(struct sk_buff *skb, params.overwrite_mask = sections.value & sections.selector; } -return devlink->ops->flash_update (devlink, ¶ms, info->extack); + nla_file_name = info->attrs[DEVLINK_ATTR_FLASH_UPDATE_FILE_NAME ]; + file_name =nla_data (nla_file_name); + ret =request_firmware (¶ms.fw, file_name, devlink->dev); +if (ret) { +NL_SET_ERR_MSG_ATTR (info->extack, nla_file_name,"failed to locate the requested firmware file" ); +return ret; + } + + ret = devlink->ops->flash_update (devlink, ¶ms, info->extack); + +release_firmware (params.fw); + +return ret; }static const struct devlink_param devlink_param_generic[] = {@@ -10225,12 +10237,16 @@ int devlink_compat_flash_update(struct net_device *dev, const char *file_name) goto out; } - params.file_name = file_name; + ret =request_firmware (¶ms.fw, file_name, devlink->dev); +if (ret) + goto out;mutex_lock (&devlink->lock); ret = devlink->ops->flash_update (devlink, ¶ms,NULL );mutex_unlock (&devlink->lock); +release_firmware (params.fw); + out:rtnl_lock ();dev_put (dev);
Vasundhara Volam
Acked-byRe: [net-next v3 1/2] devlink: move request_firmware out of driver
Quoted 490 lines · Jacob Keller
Quoted 27 lines · Jacob Keller
All drivers which implement the devlink flash update support, with the exception of netdevsim, use either
request_firmwareorrequest_firmware_directto locate the firmware file. Rather than having each driver do this separately as part of its .flash_update implementation, perform therequest_firmwarewithinnet/core/devlink.cReplace the
file_nameparameter in the structdevlink_flash_update_paramswith a pointer to the fw object.Use
request_firmwarerather thanrequest_firmware_direct. Although most Linux distributions today do not have the fallback mechanism implemented, only about half the drivers used the_directrequest, as compared to the genericrequest_firmware. In the event that a distribution does support the fallback mechanism, the devlink flash update ought to be able to use it to provide the firmware contents. For distributions which do not support the fallback userspace mechanism, there should be essentially no difference betweenrequest_firmwareandrequest_firmware_direct.Signed-off-by Jacob Keller <[email protected]>Cc Jiri Pirko <[email protected]>Cc Michael Chan <[email protected]>Cc Shannon Nelson <[email protected]>Cc Saeed Mahameed <[email protected]>Cc Boris Pismenny <[email protected]>Cc Bin Luo <[email protected]>Cc Jakub Kicinksi <[email protected]>Quoted 1 line
---
Oof, forgot to metion that the only change since v2 is to fix the typo in the commit message pointed out by Shannon. Otherwise, this patch is identical and just comes in series with the other change.
Quoted 453 lines
.../net/ethernet/broadcom/bnxt/bnxt_devlink.c | 2 +- .../net/ethernet/broadcom/bnxt/bnxt_ethtool.c | 33 ++++++++++++------- .../net/ethernet/broadcom/bnxt/bnxt_ethtool.h | 4 +-- .../net/ethernet/huawei/hinic/hinic_devlink.c | 12 +------ drivers/net/ethernet/intel/ice/ice_devlink.c | 14 +------- .../net/ethernet/mellanox/mlx5/core/devlink.c | 11 +------ drivers/net/ethernet/mellanox/mlxsw/core.c | 11 +------ .../net/ethernet/netronome/nfp/nfp_devlink.c | 2 +- drivers/net/ethernet/netronome/nfp/nfp_main.c | 17 ++-------- drivers/net/ethernet/netronome/nfp/nfp_main.h | 2 +- .../ethernet/pensando/ionic/ionic_devlink.c | 2 +- .../ethernet/pensando/ionic/ionic_devlink.h | 2 +- .../net/ethernet/pensando/ionic/ionic_fw.c | 12 +------ include/net/devlink.h | 7 ++-- net/core/devlink.c | 26 ++++++++++++--- 15 files changed, 61 insertions(+), 96 deletions(-)drivers/net/ethernet/broadcom/bnxt/bnxt_devlink.c +1
-1@@ -32,7 +32,7 @@ bnxt_dl_flash_update(struct devlink *dl,devlink_flash_update_begin_notify (dl);devlink_flash_update_status_notify (dl,"Preparing to flash" ,NULL ,0 ,0 ); - rc =bnxt_flash_package_from_file (bp->dev, params->file_name,0 ); + rc =bnxt_flash_package_from_fw_obj (bp->dev, params->fw,0 );if (!rc)devlink_flash_update_status_notify (dl,"Flashing done" ,NULL ,0 ,0 );else drivers/net/ethernet/broadcom/bnxt/bnxt_ethtool.c +22
-11@@ -2416,13 +2416,12 @@ static int bnxt_flash_firmware_from_file(struct net_device *dev,return rc; } -int bnxt_flash_package_from_file (struct net_device *dev,const char *filename, -u32 install_type) +int bnxt_flash_package_from_fw_obj (struct net_device *dev,const struct firmware *fw, +u32 install_type) {struct bnxt *bp =netdev_priv (dev);struct hwrm_nvm_install_update_output *resp = bp->hwrm_cmd_resp_addr;struct hwrm_nvm_install_update_input install = {0 }; -const struct firmware *fw;u32 item_len;int rc =0 ;u16 index;@@ -2437,13 +2436,6 @@ int bnxt_flash_package_from_file(struct net_device *dev, const char *filename,return rc; } - rc =request_firmware (&fw, filename, &dev->dev); -if (rc !=0 ) { -netdev_err (dev,"PKG error %d requesting file: %s\n" , - rc, filename); -return rc; - } -if (fw->size > item_len) {netdev_err (dev,"PKG insufficient update area in nvram: %lu\n" , (unsigned long )fw->size);@@ -2475,7 +2467,6 @@ int bnxt_flash_package_from_file(struct net_device *dev, const char *filename, dma_handle); } } -release_firmware (fw);if (rc) goto err_exit;@@ -2514,6 +2505,26 @@ int bnxt_flash_package_from_file(struct net_device *dev, const char *filename,return rc; } +static int bnxt_flash_package_from_file (struct net_device *dev,const char *filename, +u32 install_type) +{ +const struct firmware *fw; +int rc; + + rc =request_firmware (&fw, filename, &dev->dev); +if (rc !=0 ) { +netdev_err (dev,"PKG error %d requesting file: %s\n" , + rc, filename); +return rc; + } + + rc =bnxt_flash_package_from_fw_obj (dev, fw, install_type); + +release_firmware (fw); + +return rc; +} +static int bnxt_flash_device (struct net_device *dev,struct ethtool_flash *flash) {drivers/net/ethernet/broadcom/bnxt/bnxt_ethtool.h +2
-2@@ -94,8 +94,8 @@ u32 bnxt_fw_to_ethtool_speed(u16);u16 bnxt_get_fw_auto_link_speeds (u32 );int bnxt_hwrm_nvm_get_dev_info (struct bnxt *bp,struct hwrm_nvm_get_dev_info_output *nvm_dev_info); -int bnxt_flash_package_from_file (struct net_device *dev,const char *filename, -u32 install_type); +int bnxt_flash_package_from_fw_obj (struct net_device *dev,const struct firmware *fw, +u32 install_type);void bnxt_ethtool_init (struct bnxt *bp);void bnxt_ethtool_free (struct bnxt *bp);drivers/net/ethernet/huawei/hinic/hinic_devlink.c +1
-11@@ -285,18 +285,8 @@ static int hinic_devlink_flash_update(struct devlink *devlink, struct netlink_ext_ack *extack) {struct hinic_devlink_priv *priv =devlink_priv (devlink); -const struct firmware *fw; -int err; - err =request_firmware_direct (&fw, params->file_name, - &priv->hwdev->hwif->pdev->dev); -if (err) -return err; - - err =hinic_firmware_update (priv, fw, extack); -release_firmware (fw); - -return err; +return hinic_firmware_update (priv, params->fw, extack); }static const struct devlink_ops hinic_devlink_ops = {drivers/net/ethernet/intel/ice/ice_devlink.c +1
-13@@ -247,9 +247,7 @@ ice_devlink_flash_update(struct devlink *devlink, struct netlink_ext_ack *extack) {struct ice_pf *pf =devlink_priv (devlink); -struct device *dev = &pf->pdev->dev;struct ice_hw *hw = &pf->hw; -const struct firmware *fw;u8 preservation;int err;@@ -277,21 +275,11 @@ ice_devlink_flash_update(struct devlink *devlink,if (err)return err; - err =request_firmware (&fw, params->file_name, dev); -if (err) { -NL_SET_ERR_MSG_MOD (extack,"Unable to read file from disk" ); -return err; - } - -dev_dbg (dev,"Beginning flash update with file '%s'\n" , params->file_name); -devlink_flash_update_begin_notify (devlink);devlink_flash_update_status_notify (devlink,"Preparing to flash" ,NULL ,0 ,0 ); - err =ice_flash_pldm_image (pf, fw, preservation, extack); + err =ice_flash_pldm_image (pf, params->fw, preservation, extack);devlink_flash_update_end_notify (devlink); -release_firmware (fw); -return err; }drivers/net/ethernet/mellanox/mlx5/core/devlink.c +1
-10@@ -13,17 +13,8 @@ static int mlx5_devlink_flash_update(struct devlink *devlink, struct netlink_ext_ack *extack) {struct mlx5_core_dev *dev =devlink_priv (devlink); -const struct firmware *fw; -int err; - err =request_firmware_direct (&fw, params->file_name, &dev->pdev->dev); -if (err) -return err; - - err =mlx5_firmware_flash (dev, fw, extack); -release_firmware (fw); - -return err; +return mlx5_firmware_flash (dev, params->fw, extack); }static u8 mlx5_fw_ver_major (u32 version)drivers/net/ethernet/mellanox/mlxsw/core.c +1
-10@@ -1116,16 +1116,7 @@ static int mlxsw_core_fw_flash_update(struct mlxsw_core *mlxsw_core,struct devlink_flash_update_params *params, struct netlink_ext_ack *extack) { - const struct firmware *firmware; -int err; - - err =request_firmware_direct (&firmware, params->file_name, mlxsw_core->bus_info->dev); -if (err) -return err; - err =mlxsw_core_fw_flash (mlxsw_core, firmware, extack); -release_firmware (firmware); - -return err; + return mlxsw_core_fw_flash(mlxsw_core, params->fw, extack); } static int mlxsw_core_devlink_param_fw_load_policy_validate(struct devlink *devlink, u32 id,drivers/net/ethernet/netronome/nfp/nfp_devlink.c +1
-1@@ -333,7 +333,7 @@ nfp_devlink_flash_update(struct devlink *devlink,struct devlink_flash_update_params *params, struct netlink_ext_ack *extack) { - return nfp_flash_update_common(devlink_priv(devlink), params->file_name, extack); + return nfp_flash_update_common(devlink_priv(devlink), params->fw, extack); } const struct devlink_ops nfp_devlink_ops = {drivers/net/ethernet/netronome/nfp/nfp_main.c +2
-15@@ -301,11 +301,10 @@ static int nfp_pcie_sriov_configure(struct pci_dev *pdev, int num_vfs)return nfp_pcie_sriov_enable (pdev, num_vfs); } -int nfp_flash_update_common (struct nfp_pf *pf,const char *path, +int nfp_flash_update_common (struct nfp_pf *pf,const struct firmware *fw,struct netlink_ext_ack *extack) {struct device *dev = &pf->pdev->dev; -const struct firmware *fw;struct nfp_nsp *nsp;int err;@@ -319,24 +318,12 @@ int nfp_flash_update_common(struct nfp_pf *pf, const char *path,return err; } - err =request_firmware_direct (&fw, path, dev); -if (err) { -NL_SET_ERR_MSG_MOD (extack, -"unable to read flash file from disk" ); - goto exit_close_nsp; - } - -dev_info (dev,"Please be patient while writing flash image: %s\n" , - path); - err =nfp_nsp_write_flash (nsp, fw);if (err <0 ) - goto exit_release_fw; + goto exit_close_nsp;dev_info (dev,"Finished writing flash image\n" ); err =0 ; -exit_release_fw: -release_firmware (fw); exit_close_nsp:nfp_nsp_close (nsp);return err;drivers/net/ethernet/netronome/nfp/nfp_main.h +1
-1@@ -166,7 +166,7 @@ nfp_pf_map_rtsym(struct nfp_pf *pf, const char *name, const char *sym_fmt, unsigned int min_size, struct nfp_cpp_area **area);int nfp_mbox_cmd (struct nfp_pf *pf,u32 cmd,void *in_data,u64 in_length,void *out_data,u64 out_length); -int nfp_flash_update_common (struct nfp_pf *pf,const char *path, +int nfp_flash_update_common (struct nfp_pf *pf,const struct firmware *fw,struct netlink_ext_ack *extack);enum nfp_dump_diag {drivers/net/ethernet/pensando/ionic/ionic_devlink.c +1
-1@@ -15,7 +15,7 @@ static int ionic_dl_flash_update(struct devlink *dl, {struct ionic *ionic =devlink_priv (dl); -return ionic_firmware_update (ionic->lif, params->file_name, extack); +return ionic_firmware_update (ionic->lif, params->fw, extack); } static int ionic_dl_info_get(struct devlink *dl, struct devlink_info_req *req,drivers/net/ethernet/pensando/ionic/ionic_devlink.h +1
-1@@ -6,7 +6,7 @@#include <net/devlink.h> -int ionic_firmware_update (struct ionic_lif *lif,const char *fw_name, +int ionic_firmware_update (struct ionic_lif *lif,const struct firmware *fw,struct netlink_ext_ack *extack);struct ionic *ionic_devlink_alloc (struct device *dev);drivers/net/ethernet/pensando/ionic/ionic_fw.c +1
-11@@ -91,7 +91,7 @@ static int ionic_fw_status_long_wait(struct ionic *ionic,return err; } -int ionic_firmware_update (struct ionic_lif *lif,const char *fw_name, +int ionic_firmware_update (struct ionic_lif *lif,const struct firmware *fw,struct netlink_ext_ack *extack) {struct ionic_dev *idev = &lif->ionic->idev;@@ -99,24 +99,15 @@ int ionic_firmware_update(struct ionic_lif *lif, const char *fw_name,struct ionic *ionic = lif->ionic;union ionic_dev_cmd_comp comp;u32 buf_sz, copy_sz, offset; -const struct firmware *fw;struct devlink *dl;int next_interval;int err =0 ;u8 fw_slot; -netdev_info (netdev,"Installing firmware %s\n" , fw_name); - dl =priv_to_devlink (ionic);devlink_flash_update_begin_notify (dl);devlink_flash_update_status_notify (dl,"Preparing to flash" ,NULL ,0 ,0 ); - err =request_firmware (&fw, fw_name, ionic->dev); -if (err) { -NL_SET_ERR_MSG_MOD (extack,"Unable to find firmware file" ); - goto err_out; - } - buf_sz =sizeof (idev->dev_cmd_regs->data); netdev_dbg(netdev,@@ -200,7 +191,6 @@ int ionic_firmware_update(struct ionic_lif *lif, const char *fw_name,devlink_flash_update_status_notify (dl,"Flash failed" ,NULL ,0 ,0 ); else devlink_flash_update_status_notify(dl, "Flash done", NULL, 0, 0); -release_firmware (fw);devlink_flash_update_end_notify (dl);return err; }include/net/devlink.h +4
-3@@ -19,6 +19,7 @@#include <net/flow_offload.h> #include <uapi/linux/devlink.h> #include <linux/xarray.h> +#include <linux/firmware.h> #define DEVLINK_RELOAD_STATS_ARRAY_SIZE \ (__DEVLINK_RELOAD_LIMIT_MAX * __DEVLINK_RELOAD_ACTION_MAX)@@ -566,15 +567,15 @@ enum devlink_param_generic_id {/** * struct devlink_flash_update_params - Flash Update parameters -* @file_name: the name of the flash firmware file to update from +* @fw: pointer to the firmware data to update from * @component: the flash component to update * -* With the exception of file_name, drivers must opt-in to parameters by +* With the exception of fw, drivers must opt-in to parameters by * setting the appropriate bit in the supported_flash_update_params field in * their devlink_ops structure. */ struct devlink_flash_update_params { -const char *file_name; +const struct firmware *fw;const char *component;u32 overwrite_mask; };net/core/devlink.c +19
-5@@ -3429,10 +3429,12 @@ EXPORT_SYMBOL_GPL(devlink_flash_update_timeout_notify);static int devlink_nl_cmd_flash_update (struct sk_buff *skb,struct genl_info *info) { -struct nlattr *nla_component, *nla_overwrite_mask; +struct nlattr *nla_component, *nla_overwrite_mask, *nla_file_name;struct devlink_flash_update_params params = {};struct devlink *devlink = info->user_ptr[0 ]; +const char *file_name;u32 supported_params; +int ret;if (!devlink->ops->flash_update)return -EOPNOTSUPP ;@@ -3442,8 +3444,6 @@ static int devlink_nl_cmd_flash_update(struct sk_buff *skb, supported_params = devlink->ops->supported_flash_update_params; - params.file_name =nla_data (info->attrs[DEVLINK_ATTR_FLASH_UPDATE_FILE_NAME ]); - nla_component = info->attrs[DEVLINK_ATTR_FLASH_UPDATE_COMPONENT ];if (nla_component) {if (!(supported_params &DEVLINK_SUPPORT_FLASH_UPDATE_COMPONENT )) {@@ -3467,7 +3467,19 @@ static int devlink_nl_cmd_flash_update(struct sk_buff *skb, params.overwrite_mask = sections.value & sections.selector; } -return devlink->ops->flash_update (devlink, ¶ms, info->extack); + nla_file_name = info->attrs[DEVLINK_ATTR_FLASH_UPDATE_FILE_NAME ]; + file_name =nla_data (nla_file_name); + ret =request_firmware (¶ms.fw, file_name, devlink->dev); +if (ret) { +NL_SET_ERR_MSG_ATTR (info->extack, nla_file_name,"failed to locate the requested firmware file" ); +return ret; + } + + ret = devlink->ops->flash_update (devlink, ¶ms, info->extack); + +release_firmware (params.fw); + +return ret; }static const struct devlink_param devlink_param_generic[] = {@@ -10225,12 +10237,16 @@ int devlink_compat_flash_update(struct net_device *dev, const char *file_name) goto out; } - params.file_name = file_name; + ret =request_firmware (¶ms.fw, file_name, devlink->dev); +if (ret) + goto out;mutex_lock (&devlink->lock); ret = devlink->ops->flash_update (devlink, ¶ms,NULL );mutex_unlock (&devlink->lock);
Quoted 6 lines
net/core/devlink.c int devlink_compat_flash_update(struct net_device *dev, const char *file_name) · line 10252
Quoted 6 lines
net/core/devlink.c +2
-0+release_firmware (params.fw); + out:rtnl_lock ();dev_put (dev);
Jakub Kicinski
maintainerRe: [net-next v3 1/2] devlink: move request_firmware out of driver
In reply to Jacob KellerQuoted 3 lines · On Tue, 17 Nov 2020 12:10:49 -0800 Jacob Keller wrote:
Oof, forgot to metion that the only change since v2 is to fix the typo in the commit message pointed out by Shannon. Otherwise, this patch is identical and just comes in series with the other change.
Fine by me, although I thought Shannon asked for some changes to debug prints in ionic?
RE: [net-next v3 1/2] devlink: move request_firmware out of driver
Quoted 12 lines
-----Original Message-----
From: Jakub Kicinski <[email protected]>
Sent: Wednesday, November 18, 2020 10:32 AM
To: Keller, Jacob E <[email protected]>
Cc: [email protected]; Jiri Pirko <[email protected]>; Michael Chan <[email protected]>; Shannon Nelson <[email protected]>; Saeed Mahameed <[email protected]>; Boris Pismenny <[email protected]>; Bin Luo <[email protected]>
Subject: Re: [net-next v3 1/2] devlink: moverequest_firmwareout of driver
Quoted 7 lines
Quoted 3 lines · On Tue, 17 Nov 2020 12:10:49 -0800 Jacob Keller wrote:
Oof, forgot to metion that the only change since v2 is to fix the typo in the commit message pointed out by Shannon. Otherwise, this patch is identical and just comes in series with the other change.
Fine by me, although I thought Shannon asked for some changes to debug prints in ionic?
Oh I might have missed those comments let me go look.
Re: [net-next v3 1/2] devlink: move request_firmware out of driver
In reply to Jacob KellerQuoted 19 lines · Tue, Nov 17, 2020 at 09:08:19PM CET, [email protected] wrote:
All drivers which implement the devlink flash update support, with the exception of netdevsim, use either
request_firmwareorrequest_firmware_directto locate the firmware file. Rather than having each driver do this separately as part of its .flash_update implementation, perform therequest_firmwarewithinnet/core/devlink.cReplace the
file_nameparameter in the structdevlink_flash_update_paramswith a pointer to the fw object.Use
request_firmwarerather thanrequest_firmware_direct. Although most Linux distributions today do not have the fallback mechanism implemented, only about half the drivers used the_directrequest, as compared to the genericrequest_firmware. In the event that a distribution does support the fallback mechanism, the devlink flash update ought to be able to use it to provide the firmware contents. For distributions which do not support the fallback userspace mechanism, there should be essentially no difference betweenrequest_firmwareandrequest_firmware_direct.
Quoted 1 line
Signed-off-by Jacob Keller <[email protected]>
PATCH v3 2/2 devlink: move flash end and begin to core devlink
In reply to Jacob KellerWhen performing a flash update via devlink, device drivers may inform user space of status updates via devlink_flash_update_(begin|end|timeout|status)_notify functions.
It is expected that drivers do not send any status notifications unless they send a begin and end message. If a driver sends a status notification without sending the appropriate end notification upon finishing (regardless of success or failure), the current implementation of the devlink userspace program can get stuck endlessly waiting for the end notification that will never come.
The current ice driver implementation may send such a status message without the appropriate end notification in rare cases.
Fixing the ice driver is relatively simple: we just need to send the begin_notify at the start of the function and always send an end_notify no matter how the function exits.
Rather than assuming driver authors will always get this right in the future, lets just fix the API so that it is not possible to get wrong. Make devlink_flash_update_begin_notify and devlink_flash_update_end_notify static, and call them in devlink.c core code. Always send the begin_notify just before calling the driver's flash_update routine. Always send the end_notify just after the routine returns regardless of success or failure.
Doing this makes the status notification easier to use from the driver, as it no longer needs to worry about catching failures and cleaning up by calling devlink_flash_update_end_notify. It is now no longer possible to do the wrong thing in this regard. We also save a couple of lines of code in each driver.
--- drivers/net/ethernet/broadcom/bnxt/bnxt_devlink.c | 2 -- drivers/net/ethernet/intel/ice/ice_devlink.c | 5 +---- drivers/net/ethernet/mellanox/mlxfw/mlxfw_fsm.c | 3 --- drivers/net/ethernet/pensando/ionic/ionic_fw.c | 2 -- drivers/net/netdevsim/dev.c | 2 -- include/net/devlink.h | 2 -- net/core/devlink.c | 10 ++++++---- 7 files changed, 7 insertions(+), 19 deletions(-)
drivers/net/ethernet/broadcom/bnxt/bnxt_devlink.c +0 -2
@@ -30,14 +30,12 @@ bnxt_dl_flash_update(struct devlink *dl,return -EPERM ; } -devlink_flash_update_begin_notify (dl);devlink_flash_update_status_notify (dl,"Preparing to flash" ,NULL ,0 ,0 ); rc =bnxt_flash_package_from_fw_obj (bp->dev, params->fw,0 );if (!rc)devlink_flash_update_status_notify (dl,"Flashing done" ,NULL ,0 ,0 );else devlink_flash_update_status_notify (dl,"Flashing failed" ,NULL ,0 ,0 ); -devlink_flash_update_end_notify (dl);return rc; }
drivers/net/ethernet/intel/ice/ice_devlink.c +1 -4
@@ -275,12 +275,9 @@ ice_devlink_flash_update(struct devlink *devlink,if (err)return err; -devlink_flash_update_begin_notify (devlink);devlink_flash_update_status_notify (devlink,"Preparing to flash" ,NULL ,0 ,0 ); - err =ice_flash_pldm_image (pf, params->fw, preservation, extack); -devlink_flash_update_end_notify (devlink); -return err; +return ice_flash_pldm_image (pf, params->fw, preservation, extack); }static const struct devlink_ops ice_devlink_ops = {
drivers/net/ethernet/mellanox/mlxfw/mlxfw_fsm.c +0 -3
@@ -368,7 +368,6 @@ int mlxfw_firmware_flash(struct mlxfw_dev *mlxfw_dev, }mlxfw_info (mlxfw_dev,"Initialize firmware flash process\n" ); -devlink_flash_update_begin_notify (mlxfw_dev->devlink);mlxfw_status_notify (mlxfw_dev,"Initializing firmware flash process" ,NULL ,0 ,0 ); err = mlxfw_dev->ops->fsm_lock (mlxfw_dev, &fwhandle);
@@ -417,7 +416,6 @@ int mlxfw_firmware_flash(struct mlxfw_dev *mlxfw_dev,mlxfw_info (mlxfw_dev,"Firmware flash done\n" );mlxfw_status_notify (mlxfw_dev,"Firmware flash done" ,NULL ,0 ,0 );mlxfw_mfa2_file_fini (mfa2_file); -devlink_flash_update_end_notify (mlxfw_dev->devlink);return 0 ; err_state_wait_activate_to_locked:
@@ -429,7 +427,6 @@ int mlxfw_firmware_flash(struct mlxfw_dev *mlxfw_dev, mlxfw_dev->ops->fsm_release (mlxfw_dev, fwhandle); err_fsm_lock:mlxfw_mfa2_file_fini (mfa2_file); -devlink_flash_update_end_notify (mlxfw_dev->devlink);return err; }EXPORT_SYMBOL (mlxfw_firmware_flash);
drivers/net/ethernet/pensando/ionic/ionic_fw.c +0 -2
@@ -105,7 +105,6 @@ int ionic_firmware_update(struct ionic_lif *lif, const struct firmware *fw,u8 fw_slot; dl =priv_to_devlink (ionic); -devlink_flash_update_begin_notify (dl);devlink_flash_update_status_notify (dl,"Preparing to flash" ,NULL ,0 ,0 ); buf_sz =sizeof (idev->dev_cmd_regs->data);
@@ -191,6 +190,5 @@ int ionic_firmware_update(struct ionic_lif *lif, const struct firmware *fw,devlink_flash_update_status_notify (dl,"Flash failed" ,NULL ,0 ,0 ); else devlink_flash_update_status_notify(dl, "Flash done", NULL, 0, 0); -devlink_flash_update_end_notify (dl);return err; }
drivers/net/netdevsim/dev.c +0 -2
@@ -764,7 +764,6 @@ static int nsim_dev_flash_update(struct devlink *devlink,return -EOPNOTSUPP ;if (nsim_dev->fw_update_status) { -devlink_flash_update_begin_notify (devlink);devlink_flash_update_status_notify (devlink,"Preparing to flash" , params->component,0 ,0 );
@@ -788,7 +787,6 @@ static int nsim_dev_flash_update(struct devlink *devlink, params->component, 81);devlink_flash_update_status_notify (devlink,"Flashing done" , params->component,0 ,0 ); -devlink_flash_update_end_notify (devlink); }return 0 ;
include/net/devlink.h +0 -2
@@ -1577,8 +1577,6 @@ void devlink_remote_reload_actions_performed(struct devlink *devlink,enum devlink_reload_limit limit, u32 actions_performed); -void devlink_flash_update_begin_notify (struct devlink *devlink); -void devlink_flash_update_end_notify (struct devlink *devlink); void devlink_flash_update_status_notify(struct devlink *devlink, const char *status_msg, const char *component,
net/core/devlink.c +6 -4
@@ -3370,7 +3370,7 @@ static void __devlink_flash_update_notify(struct devlink *devlink,nlmsg_free (msg); } -void devlink_flash_update_begin_notify (struct devlink *devlink) +static void devlink_flash_update_begin_notify (struct devlink *devlink) {struct devlink_flash_notify params = {0 };
@@ -3378,9 +3378,8 @@ void devlink_flash_update_begin_notify(struct devlink *devlink)DEVLINK_CMD_FLASH_UPDATE , ¶ms); } -EXPORT_SYMBOL_GPL (devlink_flash_update_begin_notify); -void devlink_flash_update_end_notify (struct devlink *devlink) +static void devlink_flash_update_end_notify (struct devlink *devlink) {struct devlink_flash_notify params = {0 };
@@ -3388,7 +3387,6 @@ void devlink_flash_update_end_notify(struct devlink *devlink)DEVLINK_CMD_FLASH_UPDATE_END , ¶ms); } -EXPORT_SYMBOL_GPL (devlink_flash_update_end_notify); void devlink_flash_update_status_notify(struct devlink *devlink, const char *status_msg,
@@ -3475,7 +3473,9 @@ static int devlink_nl_cmd_flash_update(struct sk_buff *skb,return ret; } +devlink_flash_update_begin_notify (devlink); ret = devlink->ops->flash_update (devlink, ¶ms, info->extack); +devlink_flash_update_end_notify (devlink);release_firmware (params.fw);
@@ -10242,7 +10242,9 @@ int devlink_compat_flash_update(struct net_device *dev, const char *file_name) goto out;mutex_lock (&devlink->lock); +devlink_flash_update_begin_notify (devlink); ret = devlink->ops->flash_update (devlink, ¶ms,NULL ); +devlink_flash_update_end_notify (devlink);mutex_unlock (&devlink->lock);release_firmware (params.fw);
Signature · 1 line
2.29.0
Re: [net-next v3 2/2] devlink: move flash end and begin to core devlink
Quoted 221 lines · Jacob Keller
When performing a flash update via devlink, device drivers may inform user space of status updates via devlink_flash_update_(begin|end|timeout|status)_notify functions.
It is expected that drivers do not send any status notifications unless they send a begin and end message. If a driver sends a status notification without sending the appropriate end notification upon finishing (regardless of success or failure), the current implementation of the devlink userspace program can get stuck endlessly waiting for the end notification that will never come.
The current ice driver implementation may send such a status message without the appropriate end notification in rare cases.
Fixing the ice driver is relatively simple: we just need to send the
begin_notifyat the start of the function and always send anend_notifyno matter how the function exits.Rather than assuming driver authors will always get this right in the future, lets just fix the API so that it is not possible to get wrong. Make
devlink_flash_update_begin_notifyanddevlink_flash_update_end_notifystatic, and call them indevlink.ccore code. Always send thebegin_notifyjust before calling the driver'sflash_updateroutine. Always send theend_notifyjust after the routine returns regardless of success or failure.Doing this makes the status notification easier to use from the driver, as it no longer needs to worry about catching failures and cleaning up by calling
devlink_flash_update_end_notify. It is now no longer possible to do the wrong thing in this regard. We also save a couple of lines of code in each driver.Signed-off-by Jacob Keller <[email protected]>Cc Jiri Pirko <[email protected]>Cc Michael Chan <[email protected]>Cc Shannon Nelson <[email protected]>Cc Saeed Mahameed <[email protected]>Cc Boris Pismenny <[email protected]>Cc Bin Luo <[email protected]>Cc Jakub Kicinksi <[email protected]>--- drivers/net/ethernet/broadcom/bnxt/bnxt_devlink.c | 2 -- drivers/net/ethernet/intel/ice/ice_devlink.c | 5 +---- drivers/net/ethernet/mellanox/mlxfw/mlxfw_fsm.c | 3 --- drivers/net/ethernet/pensando/ionic/ionic_fw.c | 2 -- drivers/net/netdevsim/dev.c | 2 -- include/net/devlink.h | 2 -- net/core/devlink.c | 10 ++++++---- 7 files changed, 7 insertions(+), 19 deletions(-)drivers/net/ethernet/broadcom/bnxt/bnxt_devlink.c +0
-2@@ -30,14 +30,12 @@ bnxt_dl_flash_update(struct devlink *dl,return -EPERM ; } -devlink_flash_update_begin_notify (dl);devlink_flash_update_status_notify (dl,"Preparing to flash" ,NULL ,0 ,0 ); rc =bnxt_flash_package_from_fw_obj (bp->dev, params->fw,0 );if (!rc)devlink_flash_update_status_notify (dl,"Flashing done" ,NULL ,0 ,0 );else devlink_flash_update_status_notify (dl,"Flashing failed" ,NULL ,0 ,0 ); -devlink_flash_update_end_notify (dl);return rc; }drivers/net/ethernet/intel/ice/ice_devlink.c +1
-4@@ -275,12 +275,9 @@ ice_devlink_flash_update(struct devlink *devlink,if (err)return err; -devlink_flash_update_begin_notify (devlink);devlink_flash_update_status_notify (devlink,"Preparing to flash" ,NULL ,0 ,0 ); - err =ice_flash_pldm_image (pf, params->fw, preservation, extack); -devlink_flash_update_end_notify (devlink); -return err; +return ice_flash_pldm_image (pf, params->fw, preservation, extack); }static const struct devlink_ops ice_devlink_ops = {drivers/net/ethernet/mellanox/mlxfw/mlxfw_fsm.c +0
-3@@ -368,7 +368,6 @@ int mlxfw_firmware_flash(struct mlxfw_dev *mlxfw_dev, }mlxfw_info (mlxfw_dev,"Initialize firmware flash process\n" ); -devlink_flash_update_begin_notify (mlxfw_dev->devlink);mlxfw_status_notify (mlxfw_dev,"Initializing firmware flash process" ,NULL ,0 ,0 ); err = mlxfw_dev->ops->fsm_lock (mlxfw_dev, &fwhandle);@@ -417,7 +416,6 @@ int mlxfw_firmware_flash(struct mlxfw_dev *mlxfw_dev,mlxfw_info (mlxfw_dev,"Firmware flash done\n" );mlxfw_status_notify (mlxfw_dev,"Firmware flash done" ,NULL ,0 ,0 );mlxfw_mfa2_file_fini (mfa2_file); -devlink_flash_update_end_notify (mlxfw_dev->devlink);return 0 ; err_state_wait_activate_to_locked:@@ -429,7 +427,6 @@ int mlxfw_firmware_flash(struct mlxfw_dev *mlxfw_dev, mlxfw_dev->ops->fsm_release (mlxfw_dev, fwhandle); err_fsm_lock:mlxfw_mfa2_file_fini (mfa2_file); -devlink_flash_update_end_notify (mlxfw_dev->devlink);return err; }EXPORT_SYMBOL (mlxfw_firmware_flash);drivers/net/ethernet/pensando/ionic/ionic_fw.c +0
-2@@ -105,7 +105,6 @@ int ionic_firmware_update(struct ionic_lif *lif, const struct firmware *fw,u8 fw_slot; dl =priv_to_devlink (ionic); -devlink_flash_update_begin_notify (dl);devlink_flash_update_status_notify (dl,"Preparing to flash" ,NULL ,0 ,0 ); buf_sz =sizeof (idev->dev_cmd_regs->data);@@ -191,6 +190,5 @@ int ionic_firmware_update(struct ionic_lif *lif, const struct firmware *fw,devlink_flash_update_status_notify (dl,"Flash failed" ,NULL ,0 ,0 ); else devlink_flash_update_status_notify(dl, "Flash done", NULL, 0, 0); -devlink_flash_update_end_notify (dl);return err; }drivers/net/netdevsim/dev.c +0
-2@@ -764,7 +764,6 @@ static int nsim_dev_flash_update(struct devlink *devlink,return -EOPNOTSUPP ;if (nsim_dev->fw_update_status) { -devlink_flash_update_begin_notify (devlink);devlink_flash_update_status_notify (devlink,"Preparing to flash" , params->component,0 ,0 );@@ -788,7 +787,6 @@ static int nsim_dev_flash_update(struct devlink *devlink, params->component, 81);devlink_flash_update_status_notify (devlink,"Flashing done" , params->component,0 ,0 ); -devlink_flash_update_end_notify (devlink); }return 0 ;include/net/devlink.h +0
-2@@ -1577,8 +1577,6 @@ void devlink_remote_reload_actions_performed(struct devlink *devlink,enum devlink_reload_limit limit, u32 actions_performed); -void devlink_flash_update_begin_notify (struct devlink *devlink); -void devlink_flash_update_end_notify (struct devlink *devlink); void devlink_flash_update_status_notify(struct devlink *devlink, const char *status_msg, const char *component,net/core/devlink.c +6
-5@@ -3370,7 +3370,7 @@ static void __devlink_flash_update_notify(struct devlink *devlink,nlmsg_free (msg); } -void devlink_flash_update_begin_notify (struct devlink *devlink) +static void devlink_flash_update_begin_notify (struct devlink *devlink) {struct devlink_flash_notify params = {0 };@@ -3378,9 +3378,8 @@ void devlink_flash_update_begin_notify(struct devlink *devlink)DEVLINK_CMD_FLASH_UPDATE , ¶ms); } -EXPORT_SYMBOL_GPL (devlink_flash_update_begin_notify); -void devlink_flash_update_end_notify (struct devlink *devlink) +static void devlink_flash_update_end_notify (struct devlink *devlink) {struct devlink_flash_notify params = {0 };@@ -3388,7 +3387,6 @@ void devlink_flash_update_end_notify(struct devlink *devlink)DEVLINK_CMD_FLASH_UPDATE_END , ¶ms); } -EXPORT_SYMBOL_GPL (devlink_flash_update_end_notify); void devlink_flash_update_status_notify(struct devlink *devlink, const char *status_msg,@@ -3475,7 +3473,9 @@ static int devlink_nl_cmd_flash_update(struct sk_buff *skb,return ret; } +devlink_flash_update_begin_notify (devlink); ret = devlink->ops->flash_update (devlink, ¶ms, info->extack); +devlink_flash_update_end_notify (devlink);release_firmware (params.fw);@@ -10242,7 +10242,9 @@ int devlink_compat_flash_update(struct net_device *dev, const char *file_name) goto out;mutex_lock (&devlink->lock); +devlink_flash_update_begin_notify (devlink); ret = devlink->ops->flash_update (devlink, ¶ms,NULL ); +devlink_flash_update_end_notify (devlink);mutex_unlock (&devlink->lock);release_firmware (params.fw); --
Quoted 2 lines
2.29.0
Re: [net-next v3 2/2] devlink: move flash end and begin to core devlink
In reply to Jacob KellerQuoted 26 lines · Tue, Nov 17, 2020 at 09:08:20PM CET, [email protected] wrote:
When performing a flash update via devlink, device drivers may inform user space of status updates via devlink_flash_update_(begin|end|timeout|status)_notify functions.
It is expected that drivers do not send any status notifications unless they send a begin and end message. If a driver sends a status notification without sending the appropriate end notification upon finishing (regardless of success or failure), the current implementation of the devlink userspace program can get stuck endlessly waiting for the end notification that will never come.
The current ice driver implementation may send such a status message without the appropriate end notification in rare cases.
Fixing the ice driver is relatively simple: we just need to send the
begin_notifyat the start of the function and always send anend_notifyno matter how the function exits.Rather than assuming driver authors will always get this right in the future, lets just fix the API so that it is not possible to get wrong. Make
devlink_flash_update_begin_notifyanddevlink_flash_update_end_notifystatic, and call them indevlink.ccore code. Always send thebegin_notifyjust before calling the driver'sflash_updateroutine. Always send theend_notifyjust after the routine returns regardless of success or failure.
Quoted 7 lines
Doing this makes the status notification easier to use from the driver, as it no longer needs to worry about catching failures and cleaning up by calling
devlink_flash_update_end_notify. It is now no longer possible to do the wrong thing in this regard. We also save a couple of lines of code in each driver.Signed-off-by Jacob Keller <[email protected]>
Good idea.