mirror of
https://git.kernel.org/pub/scm/linux/kernel/git/chenhuacai/linux-loongson
synced 2025-09-02 08:32:55 +00:00
2e972f32ae
By default firmware will not send logs to the host. This must be explicitly
enabled by the driver. The mailbox has the concept of a flag which is a u32
used as a boolean. Lack of flag defaults to a value of false. When enabling
logging historical logs may be optionally requested. These are log messages
generated by the NIC before the driver was loaded. The driver also sends a
log version to support changing the logging format in the future.
[SEND_LOGS_REQ] = {
[SEND_LOGS] /* flag to request log reporting */
[SEND_LOGS_HISTORY] /* flag to request historical logs */
[SEND_LOGS_VERSION] /* u32 indicating the log format version */
}
Logs may be sent to the user either one at a time, or when historical logs
are requested in bulk. Firmware may not send more than 14 messages in bulk
to prevent flooding the mailbox.
[LOG_MSG] = {
[LOG_INDEX] /* entry 0 - u64 index of log */
[LOG_MSEC] /* entry 0 - u32 timestamp of log */
[LOG_MSG] /* entry 0 - char log message up to 256 */
[LOG_LENGTH] /* u32 of remaining log items in arrays */
[LOG_INDEX_ARRAY] = {
[LOG_INDEX] /* entry 1 - u64 index of log */
[LOG_INDEX] /* entry 2 - u64 index of log */
...
}
[LOG_MSEC_ARRAY] = {
[LOG_MSEC] /* entry 1 - u32 timestamp of log */
[LOG_MSEC] /* entry 2 - u32 timestamp of log */
...
}
[LOG_MSG_ARRAY] = {
[LOG_MSG] /* entry 1 - char log message up to 256 */
[LOG_MSG] /* entry 2 - char log message up to 256 */
...
}
}
Signed-off-by: Lee Trager <lee@trager.us>
Reviewed-by: Jacob Keller <jacob.e.keller@intel.com>
Link: https://patch.msgid.link/20250702192207.697368-5-lee@trager.us
Signed-off-by: Jakub Kicinski <kuba@kernel.org>
239 lines
6.8 KiB
C
239 lines
6.8 KiB
C
/* SPDX-License-Identifier: GPL-2.0 */
|
|
/* Copyright (c) Meta Platforms, Inc. and affiliates. */
|
|
|
|
#ifndef _FBNIC_FW_H_
|
|
#define _FBNIC_FW_H_
|
|
|
|
#include <linux/if_ether.h>
|
|
#include <linux/types.h>
|
|
|
|
struct fbnic_dev;
|
|
struct fbnic_tlv_msg;
|
|
|
|
struct fbnic_fw_mbx {
|
|
u8 ready, head, tail;
|
|
struct {
|
|
struct fbnic_tlv_msg *msg;
|
|
dma_addr_t addr;
|
|
} buf_info[FBNIC_IPC_MBX_DESC_LEN];
|
|
};
|
|
|
|
// FW_VER_MAX_SIZE must match ETHTOOL_FWVERS_LEN
|
|
#define FBNIC_FW_VER_MAX_SIZE 32
|
|
// Formatted version is in the format XX.YY.ZZ_RRR_COMMIT
|
|
#define FBNIC_FW_CAP_RESP_COMMIT_MAX_SIZE (FBNIC_FW_VER_MAX_SIZE - 13)
|
|
#define FBNIC_FW_LOG_VERSION 1
|
|
#define FBNIC_FW_LOG_MAX_SIZE 256
|
|
/*
|
|
* The max amount of logs which can fit in a single mailbox message. Firmware
|
|
* assumes each mailbox message is 4096B. The amount of messages supported is
|
|
* calculated as 4096 minus headers for message, arrays, and length minus the
|
|
* size of length divided by headers for each array plus the maximum LOG size,
|
|
* and the size of MSEC and INDEX. Put another way:
|
|
*
|
|
* MAX_LOG_HISTORY = ((4096 - TLV_HDR_SZ * 5 - LENGTH_SZ)
|
|
* / (FBNIC_FW_LOG_MAX_SIZE + TLV_HDR_SZ * 3 + MSEC_SZ
|
|
* + INDEX_SZ))
|
|
*/
|
|
#define FBNIC_FW_MAX_LOG_HISTORY 14
|
|
|
|
struct fbnic_fw_ver {
|
|
u32 version;
|
|
char commit[FBNIC_FW_CAP_RESP_COMMIT_MAX_SIZE];
|
|
};
|
|
|
|
struct fbnic_fw_cap {
|
|
struct {
|
|
struct fbnic_fw_ver mgmt, bootloader;
|
|
} running;
|
|
struct {
|
|
struct fbnic_fw_ver mgmt, bootloader, undi;
|
|
} stored;
|
|
u8 active_slot;
|
|
u8 bmc_mac_addr[4][ETH_ALEN];
|
|
u8 bmc_present : 1;
|
|
u8 all_multi : 1;
|
|
u8 link_speed;
|
|
u8 link_fec;
|
|
u32 anti_rollback_version;
|
|
};
|
|
|
|
struct fbnic_fw_completion {
|
|
u32 msg_type;
|
|
struct completion done;
|
|
struct kref ref_count;
|
|
int result;
|
|
union {
|
|
struct {
|
|
u32 offset;
|
|
u32 length;
|
|
} fw_update;
|
|
struct {
|
|
s32 millivolts;
|
|
s32 millidegrees;
|
|
} tsene;
|
|
} u;
|
|
};
|
|
|
|
void fbnic_mbx_init(struct fbnic_dev *fbd);
|
|
void fbnic_mbx_clean(struct fbnic_dev *fbd);
|
|
int fbnic_mbx_set_cmpl(struct fbnic_dev *fbd,
|
|
struct fbnic_fw_completion *cmpl_data);
|
|
void fbnic_mbx_clear_cmpl(struct fbnic_dev *fbd,
|
|
struct fbnic_fw_completion *cmpl_data);
|
|
void fbnic_mbx_poll(struct fbnic_dev *fbd);
|
|
int fbnic_mbx_poll_tx_ready(struct fbnic_dev *fbd);
|
|
void fbnic_mbx_flush_tx(struct fbnic_dev *fbd);
|
|
int fbnic_fw_xmit_ownership_msg(struct fbnic_dev *fbd, bool take_ownership);
|
|
int fbnic_fw_init_heartbeat(struct fbnic_dev *fbd, bool poll);
|
|
void fbnic_fw_check_heartbeat(struct fbnic_dev *fbd);
|
|
int fbnic_fw_xmit_fw_start_upgrade(struct fbnic_dev *fbd,
|
|
struct fbnic_fw_completion *cmpl_data,
|
|
unsigned int id, unsigned int len);
|
|
int fbnic_fw_xmit_fw_write_chunk(struct fbnic_dev *fbd,
|
|
const u8 *data, u32 offset, u16 length,
|
|
int cancel_error);
|
|
int fbnic_fw_xmit_tsene_read_msg(struct fbnic_dev *fbd,
|
|
struct fbnic_fw_completion *cmpl_data);
|
|
int fbnic_fw_xmit_send_logs(struct fbnic_dev *fbd, bool enable,
|
|
bool send_log_history);
|
|
struct fbnic_fw_completion *fbnic_fw_alloc_cmpl(u32 msg_type);
|
|
void fbnic_fw_put_cmpl(struct fbnic_fw_completion *cmpl_data);
|
|
|
|
#define fbnic_mk_full_fw_ver_str(_rev_id, _delim, _commit, _str, _str_sz) \
|
|
do { \
|
|
const u32 __rev_id = _rev_id; \
|
|
snprintf(_str, _str_sz, "%02lu.%02lu.%02lu-%03lu%s%s", \
|
|
FIELD_GET(FBNIC_FW_CAP_RESP_VERSION_MAJOR, __rev_id), \
|
|
FIELD_GET(FBNIC_FW_CAP_RESP_VERSION_MINOR, __rev_id), \
|
|
FIELD_GET(FBNIC_FW_CAP_RESP_VERSION_PATCH, __rev_id), \
|
|
FIELD_GET(FBNIC_FW_CAP_RESP_VERSION_BUILD, __rev_id), \
|
|
_delim, _commit); \
|
|
} while (0)
|
|
|
|
#define fbnic_mk_fw_ver_str(_rev_id, _str) \
|
|
fbnic_mk_full_fw_ver_str(_rev_id, "", "", _str, sizeof(_str))
|
|
|
|
enum {
|
|
QSPI_SECTION_CMRT = 0,
|
|
QSPI_SECTION_CONTROL_FW = 1,
|
|
QSPI_SECTION_UCODE = 2,
|
|
QSPI_SECTION_OPTION_ROM = 3,
|
|
QSPI_SECTION_USER = 4,
|
|
QSPI_SECTION_INVALID,
|
|
};
|
|
|
|
#define FW_HEARTBEAT_PERIOD (10 * HZ)
|
|
|
|
enum {
|
|
FBNIC_TLV_MSG_ID_HOST_CAP_REQ = 0x10,
|
|
FBNIC_TLV_MSG_ID_FW_CAP_RESP = 0x11,
|
|
FBNIC_TLV_MSG_ID_OWNERSHIP_REQ = 0x12,
|
|
FBNIC_TLV_MSG_ID_OWNERSHIP_RESP = 0x13,
|
|
FBNIC_TLV_MSG_ID_HEARTBEAT_REQ = 0x14,
|
|
FBNIC_TLV_MSG_ID_HEARTBEAT_RESP = 0x15,
|
|
FBNIC_TLV_MSG_ID_FW_START_UPGRADE_REQ = 0x22,
|
|
FBNIC_TLV_MSG_ID_FW_START_UPGRADE_RESP = 0x23,
|
|
FBNIC_TLV_MSG_ID_FW_WRITE_CHUNK_REQ = 0x24,
|
|
FBNIC_TLV_MSG_ID_FW_WRITE_CHUNK_RESP = 0x25,
|
|
FBNIC_TLV_MSG_ID_FW_FINISH_UPGRADE_REQ = 0x28,
|
|
FBNIC_TLV_MSG_ID_FW_FINISH_UPGRADE_RESP = 0x29,
|
|
FBNIC_TLV_MSG_ID_TSENE_READ_REQ = 0x3C,
|
|
FBNIC_TLV_MSG_ID_TSENE_READ_RESP = 0x3D,
|
|
FBNIC_TLV_MSG_ID_LOG_SEND_LOGS_REQ = 0x43,
|
|
FBNIC_TLV_MSG_ID_LOG_MSG_REQ = 0x44,
|
|
FBNIC_TLV_MSG_ID_LOG_MSG_RESP = 0x45,
|
|
};
|
|
|
|
#define FBNIC_FW_CAP_RESP_VERSION_MAJOR CSR_GENMASK(31, 24)
|
|
#define FBNIC_FW_CAP_RESP_VERSION_MINOR CSR_GENMASK(23, 16)
|
|
#define FBNIC_FW_CAP_RESP_VERSION_PATCH CSR_GENMASK(15, 8)
|
|
#define FBNIC_FW_CAP_RESP_VERSION_BUILD CSR_GENMASK(7, 0)
|
|
enum {
|
|
FBNIC_FW_CAP_RESP_VERSION = 0x0,
|
|
FBNIC_FW_CAP_RESP_BMC_PRESENT = 0x1,
|
|
FBNIC_FW_CAP_RESP_BMC_MAC_ADDR = 0x2,
|
|
FBNIC_FW_CAP_RESP_BMC_MAC_ARRAY = 0x3,
|
|
FBNIC_FW_CAP_RESP_STORED_VERSION = 0x4,
|
|
FBNIC_FW_CAP_RESP_ACTIVE_FW_SLOT = 0x5,
|
|
FBNIC_FW_CAP_RESP_VERSION_COMMIT_STR = 0x6,
|
|
FBNIC_FW_CAP_RESP_BMC_ALL_MULTI = 0x8,
|
|
FBNIC_FW_CAP_RESP_FW_STATE = 0x9,
|
|
FBNIC_FW_CAP_RESP_FW_LINK_SPEED = 0xa,
|
|
FBNIC_FW_CAP_RESP_FW_LINK_FEC = 0xb,
|
|
FBNIC_FW_CAP_RESP_STORED_COMMIT_STR = 0xc,
|
|
FBNIC_FW_CAP_RESP_CMRT_VERSION = 0xd,
|
|
FBNIC_FW_CAP_RESP_STORED_CMRT_VERSION = 0xe,
|
|
FBNIC_FW_CAP_RESP_CMRT_COMMIT_STR = 0xf,
|
|
FBNIC_FW_CAP_RESP_STORED_CMRT_COMMIT_STR = 0x10,
|
|
FBNIC_FW_CAP_RESP_UEFI_VERSION = 0x11,
|
|
FBNIC_FW_CAP_RESP_UEFI_COMMIT_STR = 0x12,
|
|
FBNIC_FW_CAP_RESP_ANTI_ROLLBACK_VERSION = 0x15,
|
|
FBNIC_FW_CAP_RESP_MSG_MAX
|
|
};
|
|
|
|
enum {
|
|
FBNIC_FW_LINK_MODE_25CR = 1,
|
|
FBNIC_FW_LINK_MODE_50CR2 = 2,
|
|
FBNIC_FW_LINK_MODE_50CR = 3,
|
|
FBNIC_FW_LINK_MODE_100CR2 = 4,
|
|
};
|
|
|
|
enum {
|
|
FBNIC_FW_LINK_FEC_NONE = 1,
|
|
FBNIC_FW_LINK_FEC_RS = 2,
|
|
FBNIC_FW_LINK_FEC_BASER = 3,
|
|
};
|
|
|
|
enum {
|
|
FBNIC_FW_TSENE_THERM = 0x0,
|
|
FBNIC_FW_TSENE_VOLT = 0x1,
|
|
FBNIC_FW_TSENE_ERROR = 0x2,
|
|
FBNIC_FW_TSENE_MSG_MAX
|
|
};
|
|
|
|
enum {
|
|
FBNIC_FW_OWNERSHIP_FLAG = 0x0,
|
|
FBNIC_FW_OWNERSHIP_MSG_MAX
|
|
};
|
|
|
|
enum {
|
|
FBNIC_FW_START_UPGRADE_ERROR = 0x0,
|
|
FBNIC_FW_START_UPGRADE_SECTION = 0x1,
|
|
FBNIC_FW_START_UPGRADE_IMAGE_LENGTH = 0x2,
|
|
FBNIC_FW_START_UPGRADE_MSG_MAX
|
|
};
|
|
|
|
enum {
|
|
FBNIC_FW_WRITE_CHUNK_OFFSET = 0x0,
|
|
FBNIC_FW_WRITE_CHUNK_LENGTH = 0x1,
|
|
FBNIC_FW_WRITE_CHUNK_DATA = 0x2,
|
|
FBNIC_FW_WRITE_CHUNK_ERROR = 0x3,
|
|
FBNIC_FW_WRITE_CHUNK_MSG_MAX
|
|
};
|
|
|
|
enum {
|
|
FBNIC_FW_FINISH_UPGRADE_ERROR = 0x0,
|
|
FBNIC_FW_FINISH_UPGRADE_MSG_MAX
|
|
};
|
|
|
|
enum {
|
|
FBNIC_SEND_LOGS = 0x0,
|
|
FBNIC_SEND_LOGS_VERSION = 0x1,
|
|
FBNIC_SEND_LOGS_HISTORY = 0x2,
|
|
FBNIC_SEND_LOGS_MSG_MAX
|
|
};
|
|
|
|
enum {
|
|
FBNIC_FW_LOG_MSEC = 0x0,
|
|
FBNIC_FW_LOG_INDEX = 0x1,
|
|
FBNIC_FW_LOG_MSG = 0x2,
|
|
FBNIC_FW_LOG_LENGTH = 0x3,
|
|
FBNIC_FW_LOG_MSEC_ARRAY = 0x4,
|
|
FBNIC_FW_LOG_INDEX_ARRAY = 0x5,
|
|
FBNIC_FW_LOG_MSG_ARRAY = 0x6,
|
|
FBNIC_FW_LOG_MSG_MAX
|
|
};
|
|
|
|
#endif /* _FBNIC_FW_H_ */
|