mellanox/mlxfw/mlxfw.h

0001 /* SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0 */
0002 /* Copyright (c) 2017-2019 Mellanox Technologies. All rights reserved */
0003
0004 #ifndef _MLXFW_H
0005 #define _MLXFW_H
0006
0007 #include <linux/firmware.h>
0008 #include <linux/netlink.h>
0009 #include <linux/device.h>
0010 #include <net/devlink.h>
0011
0012 struct mlxfw_dev {
0013     const struct mlxfw_dev_ops *ops;
0014     const char *psid;
0015     u16 psid_size;
0016     struct devlink *devlink;
0017 };
0018
0019 static inline
0020 struct device *mlxfw_dev_dev(struct mlxfw_dev *mlxfw_dev)
0021 {
0022     return devlink_to_dev(mlxfw_dev->devlink);
0023 }
0024
0025 #define MLXFW_PRFX "mlxfw: "
0026
0027 #define mlxfw_info(mlxfw_dev, fmt, ...) \
0028     dev_info(mlxfw_dev_dev(mlxfw_dev), MLXFW_PRFX fmt, ## __VA_ARGS__)
0029 #define mlxfw_err(mlxfw_dev, fmt, ...) \
0030     dev_err(mlxfw_dev_dev(mlxfw_dev), MLXFW_PRFX fmt, ## __VA_ARGS__)
0031 #define mlxfw_dbg(mlxfw_dev, fmt, ...) \
0032     dev_dbg(mlxfw_dev_dev(mlxfw_dev), MLXFW_PRFX fmt, ## __VA_ARGS__)
0033
0034 enum mlxfw_fsm_state {
0035     MLXFW_FSM_STATE_IDLE,
0036     MLXFW_FSM_STATE_LOCKED,
0037     MLXFW_FSM_STATE_INITIALIZE,
0038     MLXFW_FSM_STATE_DOWNLOAD,
0039     MLXFW_FSM_STATE_VERIFY,
0040     MLXFW_FSM_STATE_APPLY,
0041     MLXFW_FSM_STATE_ACTIVATE,
0042 };
0043
0044 enum mlxfw_fsm_state_err {
0045     MLXFW_FSM_STATE_ERR_OK,
0046     MLXFW_FSM_STATE_ERR_ERROR,
0047     MLXFW_FSM_STATE_ERR_REJECTED_DIGEST_ERR,
0048     MLXFW_FSM_STATE_ERR_REJECTED_NOT_APPLICABLE,
0049     MLXFW_FSM_STATE_ERR_REJECTED_UNKNOWN_KEY,
0050     MLXFW_FSM_STATE_ERR_REJECTED_AUTH_FAILED,
0051     MLXFW_FSM_STATE_ERR_REJECTED_UNSIGNED,
0052     MLXFW_FSM_STATE_ERR_REJECTED_KEY_NOT_APPLICABLE,
0053     MLXFW_FSM_STATE_ERR_REJECTED_BAD_FORMAT,
0054     MLXFW_FSM_STATE_ERR_BLOCKED_PENDING_RESET,
0055     MLXFW_FSM_STATE_ERR_MAX,
0056 };
0057
0058 enum mlxfw_fsm_reactivate_status {
0059     MLXFW_FSM_REACTIVATE_STATUS_OK,
0060     MLXFW_FSM_REACTIVATE_STATUS_BUSY,
0061     MLXFW_FSM_REACTIVATE_STATUS_PROHIBITED_FW_VER_ERR,
0062     MLXFW_FSM_REACTIVATE_STATUS_FIRST_PAGE_COPY_FAILED,
0063     MLXFW_FSM_REACTIVATE_STATUS_FIRST_PAGE_ERASE_FAILED,
0064     MLXFW_FSM_REACTIVATE_STATUS_FIRST_PAGE_RESTORE_FAILED,
0065     MLXFW_FSM_REACTIVATE_STATUS_CANDIDATE_FW_DEACTIVATION_FAILED,
0066     MLXFW_FSM_REACTIVATE_STATUS_FW_ALREADY_ACTIVATED,
0067     MLXFW_FSM_REACTIVATE_STATUS_ERR_DEVICE_RESET_REQUIRED,
0068     MLXFW_FSM_REACTIVATE_STATUS_ERR_FW_PROGRAMMING_NEEDED,
0069     MLXFW_FSM_REACTIVATE_STATUS_MAX,
0070 };
0071
0072 struct mlxfw_dev_ops {
0073     int (*component_query)(struct mlxfw_dev *mlxfw_dev, u16 component_index,
0074                    u32 *p_max_size, u8 *p_align_bits,
0075                    u16 *p_max_write_size);
0076
0077     int (*fsm_lock)(struct mlxfw_dev *mlxfw_dev, u32 *fwhandle);
0078
0079     int (*fsm_component_update)(struct mlxfw_dev *mlxfw_dev, u32 fwhandle,
0080                     u16 component_index, u32 component_size);
0081
0082     int (*fsm_block_download)(struct mlxfw_dev *mlxfw_dev, u32 fwhandle,
0083                   u8 *data, u16 size, u32 offset);
0084
0085     int (*fsm_component_verify)(struct mlxfw_dev *mlxfw_dev, u32 fwhandle,
0086                     u16 component_index);
0087
0088     int (*fsm_activate)(struct mlxfw_dev *mlxfw_dev, u32 fwhandle);
0089
0090     int (*fsm_reactivate)(struct mlxfw_dev *mlxfw_dev, u8 *status);
0091
0092     int (*fsm_query_state)(struct mlxfw_dev *mlxfw_dev, u32 fwhandle,
0093                    enum mlxfw_fsm_state *fsm_state,
0094                    enum mlxfw_fsm_state_err *fsm_state_err);
0095
0096     void (*fsm_cancel)(struct mlxfw_dev *mlxfw_dev, u32 fwhandle);
0097
0098     void (*fsm_release)(struct mlxfw_dev *mlxfw_dev, u32 fwhandle);
0099 };
0100
0101 #if IS_REACHABLE(CONFIG_MLXFW)
0102 int mlxfw_firmware_flash(struct mlxfw_dev *mlxfw_dev,
0103              const struct firmware *firmware,
0104              struct netlink_ext_ack *extack);
0105 #else
0106 static inline
0107 int mlxfw_firmware_flash(struct mlxfw_dev *mlxfw_dev,
0108              const struct firmware *firmware,
0109              struct netlink_ext_ack *extack)
0110 {
0111     return -EOPNOTSUPP;
0112 }
0113 #endif
0114
0115 #endif