/*
|
* drivers/net/ethernet/mellanox/mlxfw/mlxfw.h
|
* Copyright (c) 2017 Mellanox Technologies. All rights reserved.
|
* Copyright (c) 2017 Yotam Gigi <yotamg@mellanox.com>
|
*
|
* Redistribution and use in source and binary forms, with or without
|
* modification, are permitted provided that the following conditions are met:
|
*
|
* 1. Redistributions of source code must retain the above copyright
|
* notice, this list of conditions and the following disclaimer.
|
* 2. Redistributions in binary form must reproduce the above copyright
|
* notice, this list of conditions and the following disclaimer in the
|
* documentation and/or other materials provided with the distribution.
|
* 3. Neither the names of the copyright holders nor the names of its
|
* contributors may be used to endorse or promote products derived from
|
* this software without specific prior written permission.
|
*
|
* Alternatively, this software may be distributed under the terms of the
|
* GNU General Public License ("GPL") version 2 as published by the Free
|
* Software Foundation.
|
*
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
|
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
* POSSIBILITY OF SUCH DAMAGE.
|
*/
|
|
#ifndef _MLXFW_H
|
#define _MLXFW_H
|
|
#include <linux/firmware.h>
|
|
enum mlxfw_fsm_state {
|
MLXFW_FSM_STATE_IDLE,
|
MLXFW_FSM_STATE_LOCKED,
|
MLXFW_FSM_STATE_INITIALIZE,
|
MLXFW_FSM_STATE_DOWNLOAD,
|
MLXFW_FSM_STATE_VERIFY,
|
MLXFW_FSM_STATE_APPLY,
|
MLXFW_FSM_STATE_ACTIVATE,
|
};
|
|
enum mlxfw_fsm_state_err {
|
MLXFW_FSM_STATE_ERR_OK,
|
MLXFW_FSM_STATE_ERR_ERROR,
|
MLXFW_FSM_STATE_ERR_REJECTED_DIGEST_ERR,
|
MLXFW_FSM_STATE_ERR_REJECTED_NOT_APPLICABLE,
|
MLXFW_FSM_STATE_ERR_REJECTED_UNKNOWN_KEY,
|
MLXFW_FSM_STATE_ERR_REJECTED_AUTH_FAILED,
|
MLXFW_FSM_STATE_ERR_REJECTED_UNSIGNED,
|
MLXFW_FSM_STATE_ERR_REJECTED_KEY_NOT_APPLICABLE,
|
MLXFW_FSM_STATE_ERR_REJECTED_BAD_FORMAT,
|
MLXFW_FSM_STATE_ERR_BLOCKED_PENDING_RESET,
|
MLXFW_FSM_STATE_ERR_MAX,
|
};
|
|
struct mlxfw_dev;
|
|
struct mlxfw_dev_ops {
|
int (*component_query)(struct mlxfw_dev *mlxfw_dev, u16 component_index,
|
u32 *p_max_size, u8 *p_align_bits,
|
u16 *p_max_write_size);
|
|
int (*fsm_lock)(struct mlxfw_dev *mlxfw_dev, u32 *fwhandle);
|
|
int (*fsm_component_update)(struct mlxfw_dev *mlxfw_dev, u32 fwhandle,
|
u16 component_index, u32 component_size);
|
|
int (*fsm_block_download)(struct mlxfw_dev *mlxfw_dev, u32 fwhandle,
|
u8 *data, u16 size, u32 offset);
|
|
int (*fsm_component_verify)(struct mlxfw_dev *mlxfw_dev, u32 fwhandle,
|
u16 component_index);
|
|
int (*fsm_activate)(struct mlxfw_dev *mlxfw_dev, u32 fwhandle);
|
|
int (*fsm_query_state)(struct mlxfw_dev *mlxfw_dev, u32 fwhandle,
|
enum mlxfw_fsm_state *fsm_state,
|
enum mlxfw_fsm_state_err *fsm_state_err);
|
|
void (*fsm_cancel)(struct mlxfw_dev *mlxfw_dev, u32 fwhandle);
|
|
void (*fsm_release)(struct mlxfw_dev *mlxfw_dev, u32 fwhandle);
|
};
|
|
struct mlxfw_dev {
|
const struct mlxfw_dev_ops *ops;
|
const char *psid;
|
u16 psid_size;
|
};
|
|
#if IS_REACHABLE(CONFIG_MLXFW)
|
int mlxfw_firmware_flash(struct mlxfw_dev *mlxfw_dev,
|
const struct firmware *firmware);
|
#else
|
static inline
|
int mlxfw_firmware_flash(struct mlxfw_dev *mlxfw_dev,
|
const struct firmware *firmware)
|
{
|
return -EOPNOTSUPP;
|
}
|
#endif
|
|
#endif
|
