1 // SPDX-License-Identifier: GPL-2.0
2 /* Huawei HiNIC PCI Express Linux driver
3 * Copyright(c) 2017 Huawei Technologies Co., Ltd
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms and conditions of the GNU General Public License,
7 * version 2, as published by the Free Software Foundation.
9 * This program is distributed in the hope it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
15 #include <linux/netlink.h>
16 #include <net/devlink.h>
17 #include <linux/firmware.h>
19 #include "hinic_port.h"
20 #include "hinic_devlink.h"
21 #include "hinic_hw_dev.h"
23 static bool check_image_valid(struct hinic_devlink_priv *priv, const u8 *buf,
24 u32 image_size, struct host_image_st *host_image)
26 struct fw_image_st *fw_image = NULL;
30 fw_image = (struct fw_image_st *)buf;
32 if (fw_image->fw_magic != HINIC_MAGIC_NUM) {
33 dev_err(&priv->hwdev->hwif->pdev->dev, "Wrong fw_magic read from file, fw_magic: 0x%x\n",
38 if (fw_image->fw_info.fw_section_cnt > MAX_FW_TYPE_NUM) {
39 dev_err(&priv->hwdev->hwif->pdev->dev, "Wrong fw_type_num read from file, fw_type_num: 0x%x\n",
40 fw_image->fw_info.fw_section_cnt);
44 for (i = 0; i < fw_image->fw_info.fw_section_cnt; i++) {
45 len += fw_image->fw_section_info[i].fw_section_len;
46 host_image->image_section_info[i] = fw_image->fw_section_info[i];
49 if (len != fw_image->fw_len ||
50 (fw_image->fw_len + UPDATEFW_IMAGE_HEAD_SIZE) != image_size) {
51 dev_err(&priv->hwdev->hwif->pdev->dev, "Wrong data size read from file\n");
55 host_image->image_info.up_total_len = fw_image->fw_len;
56 host_image->image_info.fw_version = fw_image->fw_version;
57 host_image->section_type_num = fw_image->fw_info.fw_section_cnt;
58 host_image->device_id = fw_image->device_id;
63 static bool check_image_integrity(struct hinic_devlink_priv *priv,
64 struct host_image_st *host_image,
67 u32 collect_section_type = 0;
70 for (i = 0; i < host_image->section_type_num; i++) {
71 type = host_image->image_section_info[i].fw_section_type;
72 if (collect_section_type & (1U << type)) {
73 dev_err(&priv->hwdev->hwif->pdev->dev, "Duplicate section type: %u\n",
77 collect_section_type |= (1U << type);
80 if (update_type == FW_UPDATE_COLD &&
81 (((collect_section_type & _IMAGE_COLD_SUB_MODULES_MUST_IN) ==
82 _IMAGE_COLD_SUB_MODULES_MUST_IN) ||
83 collect_section_type == _IMAGE_CFG_SUB_MODULES_MUST_IN))
86 if (update_type == FW_UPDATE_HOT &&
87 (collect_section_type & _IMAGE_HOT_SUB_MODULES_MUST_IN) ==
88 _IMAGE_HOT_SUB_MODULES_MUST_IN)
91 if (update_type == FW_UPDATE_COLD)
92 dev_err(&priv->hwdev->hwif->pdev->dev, "Check file integrity failed, valid: 0x%x or 0x%lx, current: 0x%x\n",
93 _IMAGE_COLD_SUB_MODULES_MUST_IN,
94 _IMAGE_CFG_SUB_MODULES_MUST_IN, collect_section_type);
96 dev_err(&priv->hwdev->hwif->pdev->dev, "Check file integrity failed, valid:0x%x, current: 0x%x\n",
97 _IMAGE_HOT_SUB_MODULES_MUST_IN, collect_section_type);
102 static int check_image_device_type(struct hinic_devlink_priv *priv,
103 u32 image_device_type)
105 struct hinic_comm_board_info board_info = {0};
107 if (hinic_get_board_info(priv->hwdev, &board_info)) {
108 dev_err(&priv->hwdev->hwif->pdev->dev, "Get board info failed\n");
112 if (image_device_type == board_info.info.board_type)
115 dev_err(&priv->hwdev->hwif->pdev->dev, "The device type of upgrade file doesn't match the device type of current firmware, please check the upgrade file\n");
116 dev_err(&priv->hwdev->hwif->pdev->dev, "The image device type: 0x%x, firmware device type: 0x%x\n",
117 image_device_type, board_info.info.board_type);
122 static int hinic_flash_fw(struct hinic_devlink_priv *priv, const u8 *data,
123 struct host_image_st *host_image)
125 u32 section_remain_send_len, send_fragment_len, send_pos, up_total_len;
126 struct hinic_cmd_update_fw *fw_update_msg = NULL;
127 u32 section_type, section_crc, section_version;
128 u32 i, len, section_len, section_offset;
129 u16 out_size = sizeof(*fw_update_msg);
130 int total_len_flag = 0;
133 fw_update_msg = kzalloc(sizeof(*fw_update_msg), GFP_KERNEL);
137 up_total_len = host_image->image_info.up_total_len;
139 for (i = 0; i < host_image->section_type_num; i++) {
140 len = host_image->image_section_info[i].fw_section_len;
141 if (host_image->image_section_info[i].fw_section_type ==
143 up_total_len = up_total_len - len;
148 for (i = 0; i < host_image->section_type_num; i++) {
150 host_image->image_section_info[i].fw_section_len;
152 host_image->image_section_info[i].fw_section_offset;
153 section_remain_send_len = section_len;
155 host_image->image_section_info[i].fw_section_type;
156 section_crc = host_image->image_section_info[i].fw_section_crc;
158 host_image->image_section_info[i].fw_section_version;
160 if (section_type == UP_FW_UPDATE_BOOT)
163 send_fragment_len = 0;
166 while (section_remain_send_len > 0) {
167 if (!total_len_flag) {
168 fw_update_msg->total_len = up_total_len;
171 fw_update_msg->total_len = 0;
174 memset(fw_update_msg->data, 0, MAX_FW_FRAGMENT_LEN);
176 fw_update_msg->ctl_info.SF =
177 (section_remain_send_len == section_len) ?
179 fw_update_msg->section_info.FW_section_CRC = section_crc;
180 fw_update_msg->fw_section_version = section_version;
181 fw_update_msg->ctl_info.flag = UP_TYPE_A;
183 if (section_type <= UP_FW_UPDATE_UP_DATA_B) {
184 fw_update_msg->section_info.FW_section_type =
186 UP_FW_UPDATE_UP_DATA :
187 UP_FW_UPDATE_UP_TEXT;
189 fw_update_msg->ctl_info.flag = UP_TYPE_B;
190 if (section_type <= UP_FW_UPDATE_UP_DATA_A)
191 fw_update_msg->ctl_info.flag = UP_TYPE_A;
193 fw_update_msg->section_info.FW_section_type =
197 fw_update_msg->setion_total_len = section_len;
198 fw_update_msg->section_offset = send_pos;
200 if (section_remain_send_len <= MAX_FW_FRAGMENT_LEN) {
201 fw_update_msg->ctl_info.SL = true;
202 fw_update_msg->ctl_info.fragment_len =
203 section_remain_send_len;
204 send_fragment_len += section_remain_send_len;
206 fw_update_msg->ctl_info.SL = false;
207 fw_update_msg->ctl_info.fragment_len =
209 send_fragment_len += MAX_FW_FRAGMENT_LEN;
212 memcpy(fw_update_msg->data,
213 data + UPDATEFW_IMAGE_HEAD_SIZE +
214 section_offset + send_pos,
215 fw_update_msg->ctl_info.fragment_len);
217 err = hinic_port_msg_cmd(priv->hwdev,
218 HINIC_PORT_CMD_UPDATE_FW,
220 sizeof(*fw_update_msg),
221 fw_update_msg, &out_size);
222 if (err || !out_size || fw_update_msg->status) {
223 dev_err(&priv->hwdev->hwif->pdev->dev, "Failed to update firmware, err: %d, status: 0x%x, out size: 0x%x\n",
224 err, fw_update_msg->status, out_size);
225 err = fw_update_msg->status ?
226 fw_update_msg->status : -EIO;
227 kfree(fw_update_msg);
231 send_pos = send_fragment_len;
232 section_remain_send_len = section_len -
237 kfree(fw_update_msg);
242 static int hinic_firmware_update(struct hinic_devlink_priv *priv,
243 const struct firmware *fw,
244 struct netlink_ext_ack *extack)
246 struct host_image_st host_image;
249 memset(&host_image, 0, sizeof(struct host_image_st));
251 if (!check_image_valid(priv, fw->data, fw->size, &host_image) ||
252 !check_image_integrity(priv, &host_image, FW_UPDATE_COLD) ||
253 !check_image_device_type(priv, host_image.device_id)) {
254 NL_SET_ERR_MSG_MOD(extack, "Check image failed");
258 dev_info(&priv->hwdev->hwif->pdev->dev, "Flash firmware begin\n");
260 err = hinic_flash_fw(priv, fw->data, &host_image);
262 if (err == HINIC_FW_DISMATCH_ERROR) {
263 dev_err(&priv->hwdev->hwif->pdev->dev, "Firmware image doesn't match this card, please use newer image, err: %d\n",
265 NL_SET_ERR_MSG_MOD(extack,
266 "Firmware image doesn't match this card, please use newer image");
268 dev_err(&priv->hwdev->hwif->pdev->dev, "Send firmware image data failed, err: %d\n",
270 NL_SET_ERR_MSG_MOD(extack, "Send firmware image data failed");
276 dev_info(&priv->hwdev->hwif->pdev->dev, "Flash firmware end\n");
281 static int hinic_devlink_flash_update(struct devlink *devlink,
282 struct devlink_flash_update_params *params,
283 struct netlink_ext_ack *extack)
285 struct hinic_devlink_priv *priv = devlink_priv(devlink);
287 return hinic_firmware_update(priv, params->fw, extack);
290 static const struct devlink_ops hinic_devlink_ops = {
291 .flash_update = hinic_devlink_flash_update,
294 struct devlink *hinic_devlink_alloc(struct device *dev)
296 return devlink_alloc(&hinic_devlink_ops, sizeof(struct hinic_dev), dev);
299 void hinic_devlink_free(struct devlink *devlink)
301 devlink_free(devlink);
304 void hinic_devlink_register(struct hinic_devlink_priv *priv)
306 struct devlink *devlink = priv_to_devlink(priv);
308 devlink_register(devlink);
311 void hinic_devlink_unregister(struct hinic_devlink_priv *priv)
313 struct devlink *devlink = priv_to_devlink(priv);
315 devlink_unregister(devlink);
318 static void chip_fault_show(struct devlink_fmsg *fmsg,
319 struct hinic_fault_event *event)
321 const char * const level_str[FAULT_LEVEL_MAX + 1] = {
322 "fatal", "reset", "flr", "general", "suggestion", "Unknown"};
325 fault_level = (event->event.chip.err_level < FAULT_LEVEL_MAX) ?
326 event->event.chip.err_level : FAULT_LEVEL_MAX;
327 if (fault_level == FAULT_LEVEL_SERIOUS_FLR)
328 devlink_fmsg_u32_pair_put(fmsg, "Function level err func_id",
329 (u32)event->event.chip.func_id);
330 devlink_fmsg_u8_pair_put(fmsg, "module_id", event->event.chip.node_id);
331 devlink_fmsg_u32_pair_put(fmsg, "err_type", (u32)event->event.chip.err_type);
332 devlink_fmsg_string_pair_put(fmsg, "err_level", level_str[fault_level]);
333 devlink_fmsg_u32_pair_put(fmsg, "err_csr_addr",
334 event->event.chip.err_csr_addr);
335 devlink_fmsg_u32_pair_put(fmsg, "err_csr_value",
336 event->event.chip.err_csr_value);
339 static void fault_report_show(struct devlink_fmsg *fmsg,
340 struct hinic_fault_event *event)
342 const char * const type_str[FAULT_TYPE_MAX + 1] = {
343 "chip", "ucode", "mem rd timeout", "mem wr timeout",
344 "reg rd timeout", "reg wr timeout", "phy fault", "Unknown"};
347 fault_type = (event->type < FAULT_TYPE_MAX) ? event->type : FAULT_TYPE_MAX;
349 devlink_fmsg_string_pair_put(fmsg, "Fault type", type_str[fault_type]);
350 devlink_fmsg_binary_pair_put(fmsg, "Fault raw data", event->event.val,
351 sizeof(event->event.val));
353 switch (event->type) {
354 case FAULT_TYPE_CHIP:
355 chip_fault_show(fmsg, event);
357 case FAULT_TYPE_UCODE:
358 devlink_fmsg_u8_pair_put(fmsg, "Cause_id", event->event.ucode.cause_id);
359 devlink_fmsg_u8_pair_put(fmsg, "core_id", event->event.ucode.core_id);
360 devlink_fmsg_u8_pair_put(fmsg, "c_id", event->event.ucode.c_id);
361 devlink_fmsg_u8_pair_put(fmsg, "epc", event->event.ucode.epc);
363 case FAULT_TYPE_MEM_RD_TIMEOUT:
364 case FAULT_TYPE_MEM_WR_TIMEOUT:
365 devlink_fmsg_u32_pair_put(fmsg, "Err_csr_ctrl",
366 event->event.mem_timeout.err_csr_ctrl);
367 devlink_fmsg_u32_pair_put(fmsg, "err_csr_data",
368 event->event.mem_timeout.err_csr_data);
369 devlink_fmsg_u32_pair_put(fmsg, "ctrl_tab",
370 event->event.mem_timeout.ctrl_tab);
371 devlink_fmsg_u32_pair_put(fmsg, "mem_index",
372 event->event.mem_timeout.mem_index);
374 case FAULT_TYPE_REG_RD_TIMEOUT:
375 case FAULT_TYPE_REG_WR_TIMEOUT:
376 devlink_fmsg_u32_pair_put(fmsg, "Err_csr", event->event.reg_timeout.err_csr);
378 case FAULT_TYPE_PHY_FAULT:
379 devlink_fmsg_u8_pair_put(fmsg, "Op_type", event->event.phy_fault.op_type);
380 devlink_fmsg_u8_pair_put(fmsg, "port_id", event->event.phy_fault.port_id);
381 devlink_fmsg_u8_pair_put(fmsg, "dev_ad", event->event.phy_fault.dev_ad);
382 devlink_fmsg_u32_pair_put(fmsg, "csr_addr", event->event.phy_fault.csr_addr);
383 devlink_fmsg_u32_pair_put(fmsg, "op_data", event->event.phy_fault.op_data);
390 static int hinic_hw_reporter_dump(struct devlink_health_reporter *reporter,
391 struct devlink_fmsg *fmsg, void *priv_ctx,
392 struct netlink_ext_ack *extack)
395 fault_report_show(fmsg, priv_ctx);
400 static void mgmt_watchdog_report_show(struct devlink_fmsg *fmsg,
401 struct hinic_mgmt_watchdog_info *winfo)
403 devlink_fmsg_u32_pair_put(fmsg, "Mgmt deadloop time_h", winfo->curr_time_h);
404 devlink_fmsg_u32_pair_put(fmsg, "time_l", winfo->curr_time_l);
405 devlink_fmsg_u32_pair_put(fmsg, "task_id", winfo->task_id);
406 devlink_fmsg_u32_pair_put(fmsg, "sp", winfo->sp);
407 devlink_fmsg_u32_pair_put(fmsg, "stack_current_used", winfo->curr_used);
408 devlink_fmsg_u32_pair_put(fmsg, "peak_used", winfo->peak_used);
409 devlink_fmsg_u32_pair_put(fmsg, "\n Overflow_flag", winfo->is_overflow);
410 devlink_fmsg_u32_pair_put(fmsg, "stack_top", winfo->stack_top);
411 devlink_fmsg_u32_pair_put(fmsg, "stack_bottom", winfo->stack_bottom);
412 devlink_fmsg_u32_pair_put(fmsg, "mgmt_pc", winfo->pc);
413 devlink_fmsg_u32_pair_put(fmsg, "lr", winfo->lr);
414 devlink_fmsg_u32_pair_put(fmsg, "cpsr", winfo->cpsr);
415 devlink_fmsg_binary_pair_put(fmsg, "Mgmt register info", winfo->reg,
417 devlink_fmsg_binary_pair_put(fmsg, "Mgmt dump stack(start from sp)",
418 winfo->data, sizeof(winfo->data));
421 static int hinic_fw_reporter_dump(struct devlink_health_reporter *reporter,
422 struct devlink_fmsg *fmsg, void *priv_ctx,
423 struct netlink_ext_ack *extack)
426 mgmt_watchdog_report_show(fmsg, priv_ctx);
431 static const struct devlink_health_reporter_ops hinic_hw_fault_reporter_ops = {
433 .dump = hinic_hw_reporter_dump,
436 static const struct devlink_health_reporter_ops hinic_fw_fault_reporter_ops = {
438 .dump = hinic_fw_reporter_dump,
441 int hinic_health_reporters_create(struct hinic_devlink_priv *priv)
443 struct devlink *devlink = priv_to_devlink(priv);
445 priv->hw_fault_reporter =
446 devlink_health_reporter_create(devlink, &hinic_hw_fault_reporter_ops,
448 if (IS_ERR(priv->hw_fault_reporter)) {
449 dev_warn(&priv->hwdev->hwif->pdev->dev, "Failed to create hw fault reporter, err: %ld\n",
450 PTR_ERR(priv->hw_fault_reporter));
451 return PTR_ERR(priv->hw_fault_reporter);
454 priv->fw_fault_reporter =
455 devlink_health_reporter_create(devlink, &hinic_fw_fault_reporter_ops,
457 if (IS_ERR(priv->fw_fault_reporter)) {
458 dev_warn(&priv->hwdev->hwif->pdev->dev, "Failed to create fw fault reporter, err: %ld\n",
459 PTR_ERR(priv->fw_fault_reporter));
460 devlink_health_reporter_destroy(priv->hw_fault_reporter);
461 priv->hw_fault_reporter = NULL;
462 return PTR_ERR(priv->fw_fault_reporter);
468 void hinic_health_reporters_destroy(struct hinic_devlink_priv *priv)
470 if (!IS_ERR_OR_NULL(priv->fw_fault_reporter)) {
471 devlink_health_reporter_destroy(priv->fw_fault_reporter);
472 priv->fw_fault_reporter = NULL;
475 if (!IS_ERR_OR_NULL(priv->hw_fault_reporter)) {
476 devlink_health_reporter_destroy(priv->hw_fault_reporter);
477 priv->hw_fault_reporter = NULL;