1 // SPDX-License-Identifier: GPL-2.0+
2 // Copyright (c) 2016-2017 Hisilicon Limited.
4 #include <linux/dma-mapping.h>
5 #include <linux/slab.h>
7 #include <linux/device.h>
9 #include <linux/dma-direction.h>
10 #include "hclge_cmd.h"
12 #include "hclge_main.h"
14 #define cmq_ring_to_dev(ring) (&(ring)->dev->pdev->dev)
16 static int hclge_ring_space(struct hclge_cmq_ring *ring)
18 int ntu = ring->next_to_use;
19 int ntc = ring->next_to_clean;
20 int used = (ntu - ntc + ring->desc_num) % ring->desc_num;
22 return ring->desc_num - used - 1;
25 static int is_valid_csq_clean_head(struct hclge_cmq_ring *ring, int head)
27 int ntu = ring->next_to_use;
28 int ntc = ring->next_to_clean;
31 return head >= ntc && head <= ntu;
33 return head >= ntc || head <= ntu;
36 static int hclge_alloc_cmd_desc(struct hclge_cmq_ring *ring)
38 int size = ring->desc_num * sizeof(struct hclge_desc);
40 ring->desc = dma_alloc_coherent(cmq_ring_to_dev(ring), size,
41 &ring->desc_dma_addr, GFP_KERNEL);
48 static void hclge_free_cmd_desc(struct hclge_cmq_ring *ring)
50 int size = ring->desc_num * sizeof(struct hclge_desc);
53 dma_free_coherent(cmq_ring_to_dev(ring), size,
54 ring->desc, ring->desc_dma_addr);
59 static int hclge_alloc_cmd_queue(struct hclge_dev *hdev, int ring_type)
61 struct hclge_hw *hw = &hdev->hw;
62 struct hclge_cmq_ring *ring =
63 (ring_type == HCLGE_TYPE_CSQ) ? &hw->cmq.csq : &hw->cmq.crq;
66 ring->ring_type = ring_type;
69 ret = hclge_alloc_cmd_desc(ring);
71 dev_err(&hdev->pdev->dev, "descriptor %s alloc error %d\n",
72 (ring_type == HCLGE_TYPE_CSQ) ? "CSQ" : "CRQ", ret);
79 void hclge_cmd_reuse_desc(struct hclge_desc *desc, bool is_read)
81 desc->flag = cpu_to_le16(HCLGE_CMD_FLAG_NO_INTR | HCLGE_CMD_FLAG_IN);
83 desc->flag |= cpu_to_le16(HCLGE_CMD_FLAG_WR);
85 desc->flag &= cpu_to_le16(~HCLGE_CMD_FLAG_WR);
88 void hclge_cmd_setup_basic_desc(struct hclge_desc *desc,
89 enum hclge_opcode_type opcode, bool is_read)
91 memset((void *)desc, 0, sizeof(struct hclge_desc));
92 desc->opcode = cpu_to_le16(opcode);
93 desc->flag = cpu_to_le16(HCLGE_CMD_FLAG_NO_INTR | HCLGE_CMD_FLAG_IN);
96 desc->flag |= cpu_to_le16(HCLGE_CMD_FLAG_WR);
99 static void hclge_cmd_config_regs(struct hclge_cmq_ring *ring)
101 dma_addr_t dma = ring->desc_dma_addr;
102 struct hclge_dev *hdev = ring->dev;
103 struct hclge_hw *hw = &hdev->hw;
106 if (ring->ring_type == HCLGE_TYPE_CSQ) {
107 hclge_write_dev(hw, HCLGE_NIC_CSQ_BASEADDR_L_REG,
109 hclge_write_dev(hw, HCLGE_NIC_CSQ_BASEADDR_H_REG,
111 reg_val = hclge_read_dev(hw, HCLGE_NIC_CSQ_DEPTH_REG);
112 reg_val &= HCLGE_NIC_SW_RST_RDY;
113 reg_val |= ring->desc_num >> HCLGE_NIC_CMQ_DESC_NUM_S;
114 hclge_write_dev(hw, HCLGE_NIC_CSQ_DEPTH_REG, reg_val);
115 hclge_write_dev(hw, HCLGE_NIC_CSQ_HEAD_REG, 0);
116 hclge_write_dev(hw, HCLGE_NIC_CSQ_TAIL_REG, 0);
118 hclge_write_dev(hw, HCLGE_NIC_CRQ_BASEADDR_L_REG,
120 hclge_write_dev(hw, HCLGE_NIC_CRQ_BASEADDR_H_REG,
122 hclge_write_dev(hw, HCLGE_NIC_CRQ_DEPTH_REG,
123 ring->desc_num >> HCLGE_NIC_CMQ_DESC_NUM_S);
124 hclge_write_dev(hw, HCLGE_NIC_CRQ_HEAD_REG, 0);
125 hclge_write_dev(hw, HCLGE_NIC_CRQ_TAIL_REG, 0);
129 static void hclge_cmd_init_regs(struct hclge_hw *hw)
131 hclge_cmd_config_regs(&hw->cmq.csq);
132 hclge_cmd_config_regs(&hw->cmq.crq);
135 static int hclge_cmd_csq_clean(struct hclge_hw *hw)
137 struct hclge_dev *hdev = container_of(hw, struct hclge_dev, hw);
138 struct hclge_cmq_ring *csq = &hw->cmq.csq;
142 head = hclge_read_dev(hw, HCLGE_NIC_CSQ_HEAD_REG);
143 rmb(); /* Make sure head is ready before touch any data */
145 if (!is_valid_csq_clean_head(csq, head)) {
146 dev_warn(&hdev->pdev->dev, "wrong cmd head (%u, %d-%d)\n", head,
147 csq->next_to_use, csq->next_to_clean);
148 dev_warn(&hdev->pdev->dev,
149 "Disabling any further commands to IMP firmware\n");
150 set_bit(HCLGE_STATE_CMD_DISABLE, &hdev->state);
151 dev_warn(&hdev->pdev->dev,
152 "IMP firmware watchdog reset soon expected!\n");
156 clean = (head - csq->next_to_clean + csq->desc_num) % csq->desc_num;
157 csq->next_to_clean = head;
161 static int hclge_cmd_csq_done(struct hclge_hw *hw)
163 u32 head = hclge_read_dev(hw, HCLGE_NIC_CSQ_HEAD_REG);
164 return head == hw->cmq.csq.next_to_use;
167 static bool hclge_is_special_opcode(u16 opcode)
169 /* these commands have several descriptors,
170 * and use the first one to save opcode and return value
172 static const u16 spec_opcode[] = {
173 HCLGE_OPC_STATS_64_BIT,
174 HCLGE_OPC_STATS_32_BIT,
176 HCLGE_OPC_STATS_MAC_ALL,
177 HCLGE_OPC_QUERY_32_BIT_REG,
178 HCLGE_OPC_QUERY_64_BIT_REG,
179 HCLGE_QUERY_CLEAR_MPF_RAS_INT,
180 HCLGE_QUERY_CLEAR_PF_RAS_INT,
181 HCLGE_QUERY_CLEAR_ALL_MPF_MSIX_INT,
182 HCLGE_QUERY_CLEAR_ALL_PF_MSIX_INT,
183 HCLGE_QUERY_ALL_ERR_INFO
187 for (i = 0; i < ARRAY_SIZE(spec_opcode); i++) {
188 if (spec_opcode[i] == opcode)
200 static void hclge_cmd_copy_desc(struct hclge_hw *hw, struct hclge_desc *desc,
203 struct hclge_desc *desc_to_use;
206 while (handle < num) {
207 desc_to_use = &hw->cmq.csq.desc[hw->cmq.csq.next_to_use];
208 *desc_to_use = desc[handle];
209 (hw->cmq.csq.next_to_use)++;
210 if (hw->cmq.csq.next_to_use >= hw->cmq.csq.desc_num)
211 hw->cmq.csq.next_to_use = 0;
216 static int hclge_cmd_convert_err_code(u16 desc_ret)
218 struct errcode hclge_cmd_errcode[] = {
219 {HCLGE_CMD_EXEC_SUCCESS, 0},
220 {HCLGE_CMD_NO_AUTH, -EPERM},
221 {HCLGE_CMD_NOT_SUPPORTED, -EOPNOTSUPP},
222 {HCLGE_CMD_QUEUE_FULL, -EXFULL},
223 {HCLGE_CMD_NEXT_ERR, -ENOSR},
224 {HCLGE_CMD_UNEXE_ERR, -ENOTBLK},
225 {HCLGE_CMD_PARA_ERR, -EINVAL},
226 {HCLGE_CMD_RESULT_ERR, -ERANGE},
227 {HCLGE_CMD_TIMEOUT, -ETIME},
228 {HCLGE_CMD_HILINK_ERR, -ENOLINK},
229 {HCLGE_CMD_QUEUE_ILLEGAL, -ENXIO},
230 {HCLGE_CMD_INVALID, -EBADR},
232 u32 errcode_count = ARRAY_SIZE(hclge_cmd_errcode);
235 for (i = 0; i < errcode_count; i++)
236 if (hclge_cmd_errcode[i].imp_errcode == desc_ret)
237 return hclge_cmd_errcode[i].common_errno;
242 static int hclge_cmd_check_retval(struct hclge_hw *hw, struct hclge_desc *desc,
245 u16 opcode, desc_ret;
248 opcode = le16_to_cpu(desc[0].opcode);
249 for (handle = 0; handle < num; handle++) {
250 desc[handle] = hw->cmq.csq.desc[ntc];
252 if (ntc >= hw->cmq.csq.desc_num)
255 if (likely(!hclge_is_special_opcode(opcode)))
256 desc_ret = le16_to_cpu(desc[num - 1].retval);
258 desc_ret = le16_to_cpu(desc[0].retval);
260 hw->cmq.last_status = desc_ret;
262 return hclge_cmd_convert_err_code(desc_ret);
265 static int hclge_cmd_check_result(struct hclge_hw *hw, struct hclge_desc *desc,
268 struct hclge_dev *hdev = container_of(hw, struct hclge_dev, hw);
269 bool is_completed = false;
274 * If the command is sync, wait for the firmware to write back,
275 * if multi descriptors to be sent, use the first one to check
277 if (HCLGE_SEND_SYNC(le16_to_cpu(desc->flag))) {
279 if (hclge_cmd_csq_done(hw)) {
285 } while (timeout < hw->cmq.tx_timeout);
291 ret = hclge_cmd_check_retval(hw, desc, num, ntc);
293 /* Clean the command send queue */
294 handle = hclge_cmd_csq_clean(hw);
297 else if (handle != num)
298 dev_warn(&hdev->pdev->dev,
299 "cleaned %d, need to clean %d\n", handle, num);
304 * hclge_cmd_send - send command to command queue
305 * @hw: pointer to the hw struct
306 * @desc: prefilled descriptor for describing the command
307 * @num : the number of descriptors to be sent
309 * This is the main send command for command queue, it
310 * sends the queue, cleans the queue, etc
312 int hclge_cmd_send(struct hclge_hw *hw, struct hclge_desc *desc, int num)
314 struct hclge_dev *hdev = container_of(hw, struct hclge_dev, hw);
315 struct hclge_cmq_ring *csq = &hw->cmq.csq;
319 spin_lock_bh(&hw->cmq.csq.lock);
321 if (test_bit(HCLGE_STATE_CMD_DISABLE, &hdev->state)) {
322 spin_unlock_bh(&hw->cmq.csq.lock);
326 if (num > hclge_ring_space(&hw->cmq.csq)) {
327 /* If CMDQ ring is full, SW HEAD and HW HEAD may be different,
328 * need update the SW HEAD pointer csq->next_to_clean
330 csq->next_to_clean = hclge_read_dev(hw, HCLGE_NIC_CSQ_HEAD_REG);
331 spin_unlock_bh(&hw->cmq.csq.lock);
336 * Record the location of desc in the ring for this time
337 * which will be use for hardware to write back
339 ntc = hw->cmq.csq.next_to_use;
341 hclge_cmd_copy_desc(hw, desc, num);
343 /* Write to hardware */
344 hclge_write_dev(hw, HCLGE_NIC_CSQ_TAIL_REG, hw->cmq.csq.next_to_use);
346 ret = hclge_cmd_check_result(hw, desc, num, ntc);
348 spin_unlock_bh(&hw->cmq.csq.lock);
353 static void hclge_set_default_capability(struct hclge_dev *hdev)
355 struct hnae3_ae_dev *ae_dev = pci_get_drvdata(hdev->pdev);
357 set_bit(HNAE3_DEV_SUPPORT_FD_B, ae_dev->caps);
358 set_bit(HNAE3_DEV_SUPPORT_GRO_B, ae_dev->caps);
359 if (hdev->ae_dev->dev_version == HNAE3_DEVICE_VERSION_V2) {
360 set_bit(HNAE3_DEV_SUPPORT_FEC_B, ae_dev->caps);
361 set_bit(HNAE3_DEV_SUPPORT_PAUSE_B, ae_dev->caps);
365 static const struct hclge_caps_bit_map hclge_cmd_caps_bit_map0[] = {
366 {HCLGE_CAP_UDP_GSO_B, HNAE3_DEV_SUPPORT_UDP_GSO_B},
367 {HCLGE_CAP_PTP_B, HNAE3_DEV_SUPPORT_PTP_B},
368 {HCLGE_CAP_INT_QL_B, HNAE3_DEV_SUPPORT_INT_QL_B},
369 {HCLGE_CAP_TQP_TXRX_INDEP_B, HNAE3_DEV_SUPPORT_TQP_TXRX_INDEP_B},
370 {HCLGE_CAP_HW_TX_CSUM_B, HNAE3_DEV_SUPPORT_HW_TX_CSUM_B},
371 {HCLGE_CAP_UDP_TUNNEL_CSUM_B, HNAE3_DEV_SUPPORT_UDP_TUNNEL_CSUM_B},
372 {HCLGE_CAP_FD_FORWARD_TC_B, HNAE3_DEV_SUPPORT_FD_FORWARD_TC_B},
373 {HCLGE_CAP_FEC_B, HNAE3_DEV_SUPPORT_FEC_B},
374 {HCLGE_CAP_PAUSE_B, HNAE3_DEV_SUPPORT_PAUSE_B},
375 {HCLGE_CAP_PHY_IMP_B, HNAE3_DEV_SUPPORT_PHY_IMP_B},
376 {HCLGE_CAP_RAS_IMP_B, HNAE3_DEV_SUPPORT_RAS_IMP_B},
377 {HCLGE_CAP_RXD_ADV_LAYOUT_B, HNAE3_DEV_SUPPORT_RXD_ADV_LAYOUT_B},
378 {HCLGE_CAP_PORT_VLAN_BYPASS_B, HNAE3_DEV_SUPPORT_PORT_VLAN_BYPASS_B},
379 {HCLGE_CAP_PORT_VLAN_BYPASS_B, HNAE3_DEV_SUPPORT_VLAN_FLTR_MDF_B},
382 static void hclge_parse_capability(struct hclge_dev *hdev,
383 struct hclge_query_version_cmd *cmd)
385 struct hnae3_ae_dev *ae_dev = pci_get_drvdata(hdev->pdev);
388 caps = __le32_to_cpu(cmd->caps[0]);
389 for (i = 0; i < ARRAY_SIZE(hclge_cmd_caps_bit_map0); i++)
390 if (hnae3_get_bit(caps, hclge_cmd_caps_bit_map0[i].imp_bit))
391 set_bit(hclge_cmd_caps_bit_map0[i].local_bit,
395 static __le32 hclge_build_api_caps(void)
399 hnae3_set_bit(api_caps, HCLGE_API_CAP_FLEX_RSS_TBL_B, 1);
401 return cpu_to_le32(api_caps);
404 static enum hclge_cmd_status
405 hclge_cmd_query_version_and_capability(struct hclge_dev *hdev)
407 struct hnae3_ae_dev *ae_dev = pci_get_drvdata(hdev->pdev);
408 struct hclge_query_version_cmd *resp;
409 struct hclge_desc desc;
412 hclge_cmd_setup_basic_desc(&desc, HCLGE_OPC_QUERY_FW_VER, 1);
413 resp = (struct hclge_query_version_cmd *)desc.data;
414 resp->api_caps = hclge_build_api_caps();
416 ret = hclge_cmd_send(&hdev->hw, &desc, 1);
420 hdev->fw_version = le32_to_cpu(resp->firmware);
422 ae_dev->dev_version = le32_to_cpu(resp->hardware) <<
423 HNAE3_PCI_REVISION_BIT_SIZE;
424 ae_dev->dev_version |= hdev->pdev->revision;
426 if (ae_dev->dev_version >= HNAE3_DEVICE_VERSION_V2)
427 hclge_set_default_capability(hdev);
429 hclge_parse_capability(hdev, resp);
434 int hclge_cmd_queue_init(struct hclge_dev *hdev)
438 /* Setup the lock for command queue */
439 spin_lock_init(&hdev->hw.cmq.csq.lock);
440 spin_lock_init(&hdev->hw.cmq.crq.lock);
442 /* Setup the queue entries for use cmd queue */
443 hdev->hw.cmq.csq.desc_num = HCLGE_NIC_CMQ_DESC_NUM;
444 hdev->hw.cmq.crq.desc_num = HCLGE_NIC_CMQ_DESC_NUM;
446 /* Setup Tx write back timeout */
447 hdev->hw.cmq.tx_timeout = HCLGE_CMDQ_TX_TIMEOUT;
449 /* Setup queue rings */
450 ret = hclge_alloc_cmd_queue(hdev, HCLGE_TYPE_CSQ);
452 dev_err(&hdev->pdev->dev,
453 "CSQ ring setup error %d\n", ret);
457 ret = hclge_alloc_cmd_queue(hdev, HCLGE_TYPE_CRQ);
459 dev_err(&hdev->pdev->dev,
460 "CRQ ring setup error %d\n", ret);
466 hclge_free_cmd_desc(&hdev->hw.cmq.csq);
470 static int hclge_firmware_compat_config(struct hclge_dev *hdev, bool en)
472 struct hclge_firmware_compat_cmd *req;
473 struct hclge_desc desc;
476 hclge_cmd_setup_basic_desc(&desc, HCLGE_OPC_IMP_COMPAT_CFG, false);
479 req = (struct hclge_firmware_compat_cmd *)desc.data;
481 hnae3_set_bit(compat, HCLGE_LINK_EVENT_REPORT_EN_B, 1);
482 hnae3_set_bit(compat, HCLGE_NCSI_ERROR_REPORT_EN_B, 1);
483 if (hnae3_dev_phy_imp_supported(hdev))
484 hnae3_set_bit(compat, HCLGE_PHY_IMP_EN_B, 1);
486 req->compat = cpu_to_le32(compat);
489 return hclge_cmd_send(&hdev->hw, &desc, 1);
492 int hclge_cmd_init(struct hclge_dev *hdev)
496 spin_lock_bh(&hdev->hw.cmq.csq.lock);
497 spin_lock(&hdev->hw.cmq.crq.lock);
499 hdev->hw.cmq.csq.next_to_clean = 0;
500 hdev->hw.cmq.csq.next_to_use = 0;
501 hdev->hw.cmq.crq.next_to_clean = 0;
502 hdev->hw.cmq.crq.next_to_use = 0;
504 hclge_cmd_init_regs(&hdev->hw);
506 spin_unlock(&hdev->hw.cmq.crq.lock);
507 spin_unlock_bh(&hdev->hw.cmq.csq.lock);
509 clear_bit(HCLGE_STATE_CMD_DISABLE, &hdev->state);
511 /* Check if there is new reset pending, because the higher level
512 * reset may happen when lower level reset is being processed.
514 if ((hclge_is_reset_pending(hdev))) {
515 dev_err(&hdev->pdev->dev,
516 "failed to init cmd since reset %#lx pending\n",
517 hdev->reset_pending);
522 /* get version and device capabilities */
523 ret = hclge_cmd_query_version_and_capability(hdev);
525 dev_err(&hdev->pdev->dev,
526 "failed to query version and capabilities, ret = %d\n",
531 dev_info(&hdev->pdev->dev, "The firmware version is %lu.%lu.%lu.%lu\n",
532 hnae3_get_field(hdev->fw_version, HNAE3_FW_VERSION_BYTE3_MASK,
533 HNAE3_FW_VERSION_BYTE3_SHIFT),
534 hnae3_get_field(hdev->fw_version, HNAE3_FW_VERSION_BYTE2_MASK,
535 HNAE3_FW_VERSION_BYTE2_SHIFT),
536 hnae3_get_field(hdev->fw_version, HNAE3_FW_VERSION_BYTE1_MASK,
537 HNAE3_FW_VERSION_BYTE1_SHIFT),
538 hnae3_get_field(hdev->fw_version, HNAE3_FW_VERSION_BYTE0_MASK,
539 HNAE3_FW_VERSION_BYTE0_SHIFT));
541 /* ask the firmware to enable some features, driver can work without
544 ret = hclge_firmware_compat_config(hdev, true);
546 dev_warn(&hdev->pdev->dev,
547 "Firmware compatible features not enabled(%d).\n",
553 set_bit(HCLGE_STATE_CMD_DISABLE, &hdev->state);
558 static void hclge_cmd_uninit_regs(struct hclge_hw *hw)
560 hclge_write_dev(hw, HCLGE_NIC_CSQ_BASEADDR_L_REG, 0);
561 hclge_write_dev(hw, HCLGE_NIC_CSQ_BASEADDR_H_REG, 0);
562 hclge_write_dev(hw, HCLGE_NIC_CSQ_DEPTH_REG, 0);
563 hclge_write_dev(hw, HCLGE_NIC_CSQ_HEAD_REG, 0);
564 hclge_write_dev(hw, HCLGE_NIC_CSQ_TAIL_REG, 0);
565 hclge_write_dev(hw, HCLGE_NIC_CRQ_BASEADDR_L_REG, 0);
566 hclge_write_dev(hw, HCLGE_NIC_CRQ_BASEADDR_H_REG, 0);
567 hclge_write_dev(hw, HCLGE_NIC_CRQ_DEPTH_REG, 0);
568 hclge_write_dev(hw, HCLGE_NIC_CRQ_HEAD_REG, 0);
569 hclge_write_dev(hw, HCLGE_NIC_CRQ_TAIL_REG, 0);
572 void hclge_cmd_uninit(struct hclge_dev *hdev)
574 hclge_firmware_compat_config(hdev, false);
576 set_bit(HCLGE_STATE_CMD_DISABLE, &hdev->state);
577 /* wait to ensure that the firmware completes the possible left
580 msleep(HCLGE_CMDQ_CLEAR_WAIT_TIME);
581 spin_lock_bh(&hdev->hw.cmq.csq.lock);
582 spin_lock(&hdev->hw.cmq.crq.lock);
583 hclge_cmd_uninit_regs(&hdev->hw);
584 spin_unlock(&hdev->hw.cmq.crq.lock);
585 spin_unlock_bh(&hdev->hw.cmq.csq.lock);
587 hclge_free_cmd_desc(&hdev->hw.cmq.csq);
588 hclge_free_cmd_desc(&hdev->hw.cmq.crq);