4f52ed034d4865ff10df645b7c6f3d9838c2a45b
[dpdk.git] / drivers / net / hns3 / hns3_cmd.c
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright(c) 2018-2019 Hisilicon Limited.
3  */
4
5 #include <rte_ethdev_pci.h>
6 #include <rte_io.h>
7
8 #include "hns3_ethdev.h"
9 #include "hns3_regs.h"
10 #include "hns3_intr.h"
11 #include "hns3_logs.h"
12
13 #define hns3_is_csq(ring) ((ring)->flag & HNS3_TYPE_CSQ)
14
15 #define cmq_ring_to_dev(ring)   (&(ring)->dev->pdev->dev)
16
17 static int
18 hns3_ring_space(struct hns3_cmq_ring *ring)
19 {
20         int ntu = ring->next_to_use;
21         int ntc = ring->next_to_clean;
22         int used = (ntu - ntc + ring->desc_num) % ring->desc_num;
23
24         return ring->desc_num - used - 1;
25 }
26
27 static bool
28 is_valid_csq_clean_head(struct hns3_cmq_ring *ring, int head)
29 {
30         int ntu = ring->next_to_use;
31         int ntc = ring->next_to_clean;
32
33         if (ntu > ntc)
34                 return head >= ntc && head <= ntu;
35
36         return head >= ntc || head <= ntu;
37 }
38
39 /*
40  * hns3_allocate_dma_mem - Specific memory alloc for command function.
41  * Malloc a memzone, which is a contiguous portion of physical memory identified
42  * by a name.
43  * @ring: pointer to the ring structure
44  * @size: size of memory requested
45  * @alignment: what to align the allocation to
46  */
47 static int
48 hns3_allocate_dma_mem(struct hns3_hw *hw, struct hns3_cmq_ring *ring,
49                       uint64_t size, uint32_t alignment)
50 {
51         const struct rte_memzone *mz = NULL;
52         char z_name[RTE_MEMZONE_NAMESIZE];
53
54         snprintf(z_name, sizeof(z_name), "hns3_dma_%" PRIu64, rte_rand());
55         mz = rte_memzone_reserve_bounded(z_name, size, SOCKET_ID_ANY,
56                                          RTE_MEMZONE_IOVA_CONTIG, alignment,
57                                          RTE_PGSIZE_2M);
58         if (mz == NULL)
59                 return -ENOMEM;
60
61         ring->buf_size = size;
62         ring->desc = mz->addr;
63         ring->desc_dma_addr = mz->iova;
64         ring->zone = (const void *)mz;
65         hns3_dbg(hw, "memzone %s allocated with physical address: %" PRIu64,
66                  mz->name, ring->desc_dma_addr);
67
68         return 0;
69 }
70
71 static void
72 hns3_free_dma_mem(struct hns3_hw *hw, struct hns3_cmq_ring *ring)
73 {
74         hns3_dbg(hw, "memzone %s to be freed with physical address: %" PRIu64,
75                  ((const struct rte_memzone *)ring->zone)->name,
76                  ring->desc_dma_addr);
77         rte_memzone_free((const struct rte_memzone *)ring->zone);
78         ring->buf_size = 0;
79         ring->desc = NULL;
80         ring->desc_dma_addr = 0;
81         ring->zone = NULL;
82 }
83
84 static int
85 hns3_alloc_cmd_desc(struct hns3_hw *hw, struct hns3_cmq_ring *ring)
86 {
87         int size  = ring->desc_num * sizeof(struct hns3_cmd_desc);
88
89         if (hns3_allocate_dma_mem(hw, ring, size, HNS3_CMD_DESC_ALIGNMENT)) {
90                 hns3_err(hw, "allocate dma mem failed");
91                 return -ENOMEM;
92         }
93
94         return 0;
95 }
96
97 static void
98 hns3_free_cmd_desc(struct hns3_hw *hw, struct hns3_cmq_ring *ring)
99 {
100         if (ring->desc)
101                 hns3_free_dma_mem(hw, ring);
102 }
103
104 static int
105 hns3_alloc_cmd_queue(struct hns3_hw *hw, int ring_type)
106 {
107         struct hns3_cmq_ring *ring =
108                 (ring_type == HNS3_TYPE_CSQ) ? &hw->cmq.csq : &hw->cmq.crq;
109         int ret;
110
111         ring->ring_type = ring_type;
112         ring->hw = hw;
113
114         ret = hns3_alloc_cmd_desc(hw, ring);
115         if (ret)
116                 hns3_err(hw, "descriptor %s alloc error %d",
117                             (ring_type == HNS3_TYPE_CSQ) ? "CSQ" : "CRQ", ret);
118
119         return ret;
120 }
121
122 void
123 hns3_cmd_reuse_desc(struct hns3_cmd_desc *desc, bool is_read)
124 {
125         desc->flag = rte_cpu_to_le_16(HNS3_CMD_FLAG_NO_INTR | HNS3_CMD_FLAG_IN);
126         if (is_read)
127                 desc->flag |= rte_cpu_to_le_16(HNS3_CMD_FLAG_WR);
128         else
129                 desc->flag &= rte_cpu_to_le_16(~HNS3_CMD_FLAG_WR);
130 }
131
132 void
133 hns3_cmd_setup_basic_desc(struct hns3_cmd_desc *desc,
134                           enum hns3_opcode_type opcode, bool is_read)
135 {
136         memset((void *)desc, 0, sizeof(struct hns3_cmd_desc));
137         desc->opcode = rte_cpu_to_le_16(opcode);
138         desc->flag = rte_cpu_to_le_16(HNS3_CMD_FLAG_NO_INTR | HNS3_CMD_FLAG_IN);
139
140         if (is_read)
141                 desc->flag |= rte_cpu_to_le_16(HNS3_CMD_FLAG_WR);
142 }
143
144 static void
145 hns3_cmd_clear_regs(struct hns3_hw *hw)
146 {
147         hns3_write_dev(hw, HNS3_CMDQ_TX_ADDR_L_REG, 0);
148         hns3_write_dev(hw, HNS3_CMDQ_TX_ADDR_H_REG, 0);
149         hns3_write_dev(hw, HNS3_CMDQ_TX_DEPTH_REG, 0);
150         hns3_write_dev(hw, HNS3_CMDQ_TX_HEAD_REG, 0);
151         hns3_write_dev(hw, HNS3_CMDQ_TX_TAIL_REG, 0);
152         hns3_write_dev(hw, HNS3_CMDQ_RX_ADDR_L_REG, 0);
153         hns3_write_dev(hw, HNS3_CMDQ_RX_ADDR_H_REG, 0);
154         hns3_write_dev(hw, HNS3_CMDQ_RX_DEPTH_REG, 0);
155         hns3_write_dev(hw, HNS3_CMDQ_RX_HEAD_REG, 0);
156         hns3_write_dev(hw, HNS3_CMDQ_RX_TAIL_REG, 0);
157 }
158
159 static void
160 hns3_cmd_config_regs(struct hns3_cmq_ring *ring)
161 {
162         uint64_t dma = ring->desc_dma_addr;
163
164         if (ring->ring_type == HNS3_TYPE_CSQ) {
165                 hns3_write_dev(ring->hw, HNS3_CMDQ_TX_ADDR_L_REG,
166                                lower_32_bits(dma));
167                 hns3_write_dev(ring->hw, HNS3_CMDQ_TX_ADDR_H_REG,
168                                upper_32_bits(dma));
169                 hns3_write_dev(ring->hw, HNS3_CMDQ_TX_DEPTH_REG,
170                                ring->desc_num >> HNS3_NIC_CMQ_DESC_NUM_S |
171                                HNS3_NIC_SW_RST_RDY);
172                 hns3_write_dev(ring->hw, HNS3_CMDQ_TX_HEAD_REG, 0);
173                 hns3_write_dev(ring->hw, HNS3_CMDQ_TX_TAIL_REG, 0);
174         } else {
175                 hns3_write_dev(ring->hw, HNS3_CMDQ_RX_ADDR_L_REG,
176                                lower_32_bits(dma));
177                 hns3_write_dev(ring->hw, HNS3_CMDQ_RX_ADDR_H_REG,
178                                upper_32_bits(dma));
179                 hns3_write_dev(ring->hw, HNS3_CMDQ_RX_DEPTH_REG,
180                                ring->desc_num >> HNS3_NIC_CMQ_DESC_NUM_S);
181                 hns3_write_dev(ring->hw, HNS3_CMDQ_RX_HEAD_REG, 0);
182                 hns3_write_dev(ring->hw, HNS3_CMDQ_RX_TAIL_REG, 0);
183         }
184 }
185
186 static void
187 hns3_cmd_init_regs(struct hns3_hw *hw)
188 {
189         hns3_cmd_config_regs(&hw->cmq.csq);
190         hns3_cmd_config_regs(&hw->cmq.crq);
191 }
192
193 static int
194 hns3_cmd_csq_clean(struct hns3_hw *hw)
195 {
196         struct hns3_cmq_ring *csq = &hw->cmq.csq;
197         uint32_t head;
198         int clean;
199
200         head = hns3_read_dev(hw, HNS3_CMDQ_TX_HEAD_REG);
201
202         if (!is_valid_csq_clean_head(csq, head)) {
203                 hns3_err(hw, "wrong cmd head (%u, %u-%u)", head,
204                             csq->next_to_use, csq->next_to_clean);
205                 if (rte_eal_process_type() == RTE_PROC_PRIMARY) {
206                         rte_atomic16_set(&hw->reset.disable_cmd, 1);
207                         hns3_schedule_delayed_reset(HNS3_DEV_HW_TO_ADAPTER(hw));
208                 }
209
210                 return -EIO;
211         }
212
213         clean = (head - csq->next_to_clean + csq->desc_num) % csq->desc_num;
214         csq->next_to_clean = head;
215         return clean;
216 }
217
218 static int
219 hns3_cmd_csq_done(struct hns3_hw *hw)
220 {
221         uint32_t head = hns3_read_dev(hw, HNS3_CMDQ_TX_HEAD_REG);
222
223         return head == hw->cmq.csq.next_to_use;
224 }
225
226 static bool
227 hns3_is_special_opcode(uint16_t opcode)
228 {
229         /*
230          * These commands have several descriptors,
231          * and use the first one to save opcode and return value.
232          */
233         uint16_t spec_opcode[] = {HNS3_OPC_STATS_64_BIT,
234                                   HNS3_OPC_STATS_32_BIT,
235                                   HNS3_OPC_STATS_MAC,
236                                   HNS3_OPC_STATS_MAC_ALL,
237                                   HNS3_OPC_QUERY_32_BIT_REG,
238                                   HNS3_OPC_QUERY_64_BIT_REG};
239         uint32_t i;
240
241         for (i = 0; i < ARRAY_SIZE(spec_opcode); i++)
242                 if (spec_opcode[i] == opcode)
243                         return true;
244
245         return false;
246 }
247
248 static int
249 hns3_cmd_convert_err_code(uint16_t desc_ret)
250 {
251         switch (desc_ret) {
252         case HNS3_CMD_EXEC_SUCCESS:
253                 return 0;
254         case HNS3_CMD_NO_AUTH:
255                 return -EPERM;
256         case HNS3_CMD_NOT_SUPPORTED:
257                 return -EOPNOTSUPP;
258         case HNS3_CMD_QUEUE_FULL:
259                 return -EXFULL;
260         case HNS3_CMD_NEXT_ERR:
261                 return -ENOSR;
262         case HNS3_CMD_UNEXE_ERR:
263                 return -ENOTBLK;
264         case HNS3_CMD_PARA_ERR:
265                 return -EINVAL;
266         case HNS3_CMD_RESULT_ERR:
267                 return -ERANGE;
268         case HNS3_CMD_TIMEOUT:
269                 return -ETIME;
270         case HNS3_CMD_HILINK_ERR:
271                 return -ENOLINK;
272         case HNS3_CMD_QUEUE_ILLEGAL:
273                 return -ENXIO;
274         case HNS3_CMD_INVALID:
275                 return -EBADR;
276         default:
277                 return -EREMOTEIO;
278         }
279 }
280
281 static int
282 hns3_cmd_get_hardware_reply(struct hns3_hw *hw,
283                             struct hns3_cmd_desc *desc, int num, int ntc)
284 {
285         uint16_t opcode, desc_ret;
286         int current_ntc = ntc;
287         int handle;
288
289         opcode = rte_le_to_cpu_16(desc[0].opcode);
290         for (handle = 0; handle < num; handle++) {
291                 /* Get the result of hardware write back */
292                 desc[handle] = hw->cmq.csq.desc[current_ntc];
293
294                 current_ntc++;
295                 if (current_ntc == hw->cmq.csq.desc_num)
296                         current_ntc = 0;
297         }
298
299         if (likely(!hns3_is_special_opcode(opcode)))
300                 desc_ret = rte_le_to_cpu_16(desc[num - 1].retval);
301         else
302                 desc_ret = rte_le_to_cpu_16(desc[0].retval);
303
304         hw->cmq.last_status = desc_ret;
305         return hns3_cmd_convert_err_code(desc_ret);
306 }
307
308 static int hns3_cmd_poll_reply(struct hns3_hw *hw)
309 {
310         struct hns3_adapter *hns = HNS3_DEV_HW_TO_ADAPTER(hw);
311         uint32_t timeout = 0;
312
313         do {
314                 if (hns3_cmd_csq_done(hw))
315                         return 0;
316
317                 if (rte_atomic16_read(&hw->reset.disable_cmd)) {
318                         hns3_err(hw,
319                                  "Don't wait for reply because of disable_cmd");
320                         return -EBUSY;
321                 }
322
323                 if (is_reset_pending(hns)) {
324                         hns3_err(hw, "Don't wait for reply because of reset pending");
325                         return -EIO;
326                 }
327
328                 rte_delay_us(1);
329                 timeout++;
330         } while (timeout < hw->cmq.tx_timeout);
331         hns3_err(hw, "Wait for reply timeout");
332         return -ETIME;
333 }
334
335 /*
336  * hns3_cmd_send - send command to command queue
337  *
338  * @param hw
339  *   pointer to the hw struct
340  * @param desc
341  *   prefilled descriptor for describing the command
342  * @param num
343  *   the number of descriptors to be sent
344  * @return
345  *   - -EBUSY if detect device is in resetting
346  *   - -EIO   if detect cmd csq corrupted (due to reset) or
347  *            there is reset pending
348  *   - -ENOMEM/-ETIME/...(Non-Zero) if other error case
349  *   - Zero   if operation completed successfully
350  *
351  * Note -BUSY/-EIO only used in reset case
352  *
353  * Note this is the main send command for command queue, it
354  * sends the queue, cleans the queue, etc
355  */
356 int
357 hns3_cmd_send(struct hns3_hw *hw, struct hns3_cmd_desc *desc, int num)
358 {
359         struct hns3_cmd_desc *desc_to_use;
360         int handle = 0;
361         int retval;
362         uint32_t ntc;
363
364         if (rte_atomic16_read(&hw->reset.disable_cmd))
365                 return -EBUSY;
366
367         rte_spinlock_lock(&hw->cmq.csq.lock);
368
369         /* Clean the command send queue */
370         retval = hns3_cmd_csq_clean(hw);
371         if (retval < 0) {
372                 rte_spinlock_unlock(&hw->cmq.csq.lock);
373                 return retval;
374         }
375
376         if (num > hns3_ring_space(&hw->cmq.csq)) {
377                 rte_spinlock_unlock(&hw->cmq.csq.lock);
378                 return -ENOMEM;
379         }
380
381         /*
382          * Record the location of desc in the ring for this time
383          * which will be use for hardware to write back
384          */
385         ntc = hw->cmq.csq.next_to_use;
386
387         while (handle < num) {
388                 desc_to_use = &hw->cmq.csq.desc[hw->cmq.csq.next_to_use];
389                 *desc_to_use = desc[handle];
390                 (hw->cmq.csq.next_to_use)++;
391                 if (hw->cmq.csq.next_to_use == hw->cmq.csq.desc_num)
392                         hw->cmq.csq.next_to_use = 0;
393                 handle++;
394         }
395
396         /* Write to hardware */
397         hns3_write_dev(hw, HNS3_CMDQ_TX_TAIL_REG, hw->cmq.csq.next_to_use);
398
399         /*
400          * If the command is sync, wait for the firmware to write back,
401          * if multi descriptors to be sent, use the first one to check.
402          */
403         if (HNS3_CMD_SEND_SYNC(rte_le_to_cpu_16(desc->flag))) {
404                 retval = hns3_cmd_poll_reply(hw);
405                 if (!retval)
406                         retval = hns3_cmd_get_hardware_reply(hw, desc, num,
407                                                              ntc);
408         }
409
410         rte_spinlock_unlock(&hw->cmq.csq.lock);
411         return retval;
412 }
413
414 static void hns3_parse_capability(struct hns3_hw *hw,
415                                   struct hns3_query_version_cmd *cmd)
416 {
417         uint32_t caps = rte_le_to_cpu_32(cmd->caps[0]);
418
419         if (hns3_get_bit(caps, HNS3_CAPS_UDP_GSO_B))
420                 hns3_set_bit(hw->capability, HNS3_DEV_SUPPORT_UDP_GSO_B, 1);
421         if (hns3_get_bit(caps, HNS3_CAPS_FD_QUEUE_REGION_B))
422                 hns3_set_bit(hw->capability, HNS3_DEV_SUPPORT_FD_QUEUE_REGION_B,
423                              1);
424         if (hns3_get_bit(caps, HNS3_CAPS_PTP_B))
425                 hns3_set_bit(hw->capability, HNS3_DEV_SUPPORT_PTP_B, 1);
426         if (hns3_get_bit(caps, HNS3_CAPS_TX_PUSH_B))
427                 hns3_set_bit(hw->capability, HNS3_DEV_SUPPORT_TX_PUSH_B, 1);
428         if (hns3_get_bit(caps, HNS3_CAPS_PHY_IMP_B))
429                 hns3_set_bit(hw->capability, HNS3_DEV_SUPPORT_COPPER_B, 1);
430         if (hns3_get_bit(caps, HNS3_CAPS_TQP_TXRX_INDEP_B))
431                 hns3_set_bit(hw->capability, HNS3_DEV_SUPPORT_INDEP_TXRX_B, 1);
432         if (hns3_get_bit(caps, HNS3_CAPS_STASH_B))
433                 hns3_set_bit(hw->capability, HNS3_DEV_SUPPORT_STASH_B, 1);
434 }
435
436 static enum hns3_cmd_status
437 hns3_cmd_query_firmware_version_and_capability(struct hns3_hw *hw)
438 {
439         struct hns3_query_version_cmd *resp;
440         struct hns3_cmd_desc desc;
441         int ret;
442
443         hns3_cmd_setup_basic_desc(&desc, HNS3_OPC_QUERY_FW_VER, 1);
444         resp = (struct hns3_query_version_cmd *)desc.data;
445
446         /* Initialize the cmd function */
447         ret = hns3_cmd_send(hw, &desc, 1);
448         if (ret)
449                 return ret;
450
451         hw->fw_version = rte_le_to_cpu_32(resp->firmware);
452         hns3_parse_capability(hw, resp);
453
454         return 0;
455 }
456
457 int
458 hns3_cmd_init_queue(struct hns3_hw *hw)
459 {
460         int ret;
461
462         /* Setup the lock for command queue */
463         rte_spinlock_init(&hw->cmq.csq.lock);
464         rte_spinlock_init(&hw->cmq.crq.lock);
465
466         /*
467          * Clear up all command register,
468          * in case there are some residual values
469          */
470         hns3_cmd_clear_regs(hw);
471
472         /* Setup the queue entries for use cmd queue */
473         hw->cmq.csq.desc_num = HNS3_NIC_CMQ_DESC_NUM;
474         hw->cmq.crq.desc_num = HNS3_NIC_CMQ_DESC_NUM;
475
476         /* Setup Tx write back timeout */
477         hw->cmq.tx_timeout = HNS3_CMDQ_TX_TIMEOUT;
478
479         /* Setup queue rings */
480         ret = hns3_alloc_cmd_queue(hw, HNS3_TYPE_CSQ);
481         if (ret) {
482                 PMD_INIT_LOG(ERR, "CSQ ring setup error %d", ret);
483                 return ret;
484         }
485
486         ret = hns3_alloc_cmd_queue(hw, HNS3_TYPE_CRQ);
487         if (ret) {
488                 PMD_INIT_LOG(ERR, "CRQ ring setup error %d", ret);
489                 goto err_crq;
490         }
491
492         return 0;
493
494 err_crq:
495         hns3_free_cmd_desc(hw, &hw->cmq.csq);
496
497         return ret;
498 }
499
500 int
501 hns3_cmd_init(struct hns3_hw *hw)
502 {
503         uint32_t version;
504         int ret;
505
506         rte_spinlock_lock(&hw->cmq.csq.lock);
507         rte_spinlock_lock(&hw->cmq.crq.lock);
508
509         hw->cmq.csq.next_to_clean = 0;
510         hw->cmq.csq.next_to_use = 0;
511         hw->cmq.crq.next_to_clean = 0;
512         hw->cmq.crq.next_to_use = 0;
513         hw->mbx_resp.head = 0;
514         hw->mbx_resp.tail = 0;
515         hw->mbx_resp.lost = 0;
516         hns3_cmd_init_regs(hw);
517
518         rte_spinlock_unlock(&hw->cmq.crq.lock);
519         rte_spinlock_unlock(&hw->cmq.csq.lock);
520
521         /*
522          * Check if there is new reset pending, because the higher level
523          * reset may happen when lower level reset is being processed.
524          */
525         if (is_reset_pending(HNS3_DEV_HW_TO_ADAPTER(hw))) {
526                 PMD_INIT_LOG(ERR, "New reset pending, keep disable cmd");
527                 ret = -EBUSY;
528                 goto err_cmd_init;
529         }
530         rte_atomic16_clear(&hw->reset.disable_cmd);
531
532         ret = hns3_cmd_query_firmware_version_and_capability(hw);
533         if (ret) {
534                 PMD_INIT_LOG(ERR, "firmware version query failed %d", ret);
535                 goto err_cmd_init;
536         }
537
538         version = hw->fw_version;
539         PMD_INIT_LOG(INFO, "The firmware version is %lu.%lu.%lu.%lu",
540                      hns3_get_field(version, HNS3_FW_VERSION_BYTE3_M,
541                                     HNS3_FW_VERSION_BYTE3_S),
542                      hns3_get_field(version, HNS3_FW_VERSION_BYTE2_M,
543                                     HNS3_FW_VERSION_BYTE2_S),
544                      hns3_get_field(version, HNS3_FW_VERSION_BYTE1_M,
545                                     HNS3_FW_VERSION_BYTE1_S),
546                      hns3_get_field(version, HNS3_FW_VERSION_BYTE0_M,
547                                     HNS3_FW_VERSION_BYTE0_S));
548
549         return 0;
550
551 err_cmd_init:
552         rte_atomic16_set(&hw->reset.disable_cmd, 1);
553         return ret;
554 }
555
556 static void
557 hns3_destroy_queue(struct hns3_hw *hw, struct hns3_cmq_ring *ring)
558 {
559         rte_spinlock_lock(&ring->lock);
560
561         hns3_free_cmd_desc(hw, ring);
562
563         rte_spinlock_unlock(&ring->lock);
564 }
565
566 void
567 hns3_cmd_destroy_queue(struct hns3_hw *hw)
568 {
569         hns3_destroy_queue(hw, &hw->cmq.csq);
570         hns3_destroy_queue(hw, &hw->cmq.crq);
571 }
572
573 void
574 hns3_cmd_uninit(struct hns3_hw *hw)
575 {
576         rte_spinlock_lock(&hw->cmq.csq.lock);
577         rte_spinlock_lock(&hw->cmq.crq.lock);
578         rte_atomic16_set(&hw->reset.disable_cmd, 1);
579         hns3_cmd_clear_regs(hw);
580         rte_spinlock_unlock(&hw->cmq.crq.lock);
581         rte_spinlock_unlock(&hw->cmq.csq.lock);
582 }