2 * Copyright 2014 Cisco Systems, Inc. All rights reserved.
4 * This program is free software; you may redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; version 2 of the License.
8 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
9 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
10 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
11 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
12 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
13 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
14 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
18 #include <linux/kernel.h>
19 #include <linux/errno.h>
20 #include <linux/types.h>
21 #include <linux/pci.h>
22 #include <linux/delay.h>
23 #include <linux/if_ether.h>
24 #include <linux/slab.h>
25 #include "vnic_resource.h"
26 #include "vnic_devcmd.h"
28 #include "vnic_stats.h"
31 #define VNIC_DVCMD_TMO 10000 /* Devcmd Timeout value */
32 #define VNIC_NOTIFY_INTR_MASK 0x0000ffff00000000ULL
34 struct devcmd2_controller {
35 struct vnic_wq_ctrl __iomem *wq_ctrl;
36 struct vnic_dev_ring results_ring;
38 struct vnic_devcmd2 *cmd_ring;
39 struct devcmd2_result *result;
53 struct vnic_res res[RES_TYPE_MAX];
54 enum vnic_dev_intr_mode intr_mode;
55 struct vnic_devcmd __iomem *devcmd;
56 struct vnic_devcmd_notify *notify;
57 struct vnic_devcmd_notify notify_copy;
60 dma_addr_t linkstatus_pa;
61 struct vnic_stats *stats;
63 struct vnic_devcmd_fw_info *fw_info;
64 dma_addr_t fw_info_pa;
65 u64 args[VNIC_DEVCMD_NARGS];
66 struct devcmd2_controller *devcmd2;
68 int (*devcmd_rtn)(struct vnic_dev *vdev, enum vnic_devcmd_cmd cmd,
72 #define VNIC_MAX_RES_HDR_SIZE \
73 (sizeof(struct vnic_resource_header) + \
74 sizeof(struct vnic_resource) * RES_TYPE_MAX)
75 #define VNIC_RES_STRIDE 128
77 void *svnic_dev_priv(struct vnic_dev *vdev)
82 static int vnic_dev_discover_res(struct vnic_dev *vdev,
83 struct vnic_dev_bar *bar, unsigned int num_bars)
85 struct vnic_resource_header __iomem *rh;
86 struct vnic_resource __iomem *r;
92 if (bar->len < VNIC_MAX_RES_HDR_SIZE) {
93 pr_err("vNIC BAR0 res hdr length error\n");
100 pr_err("vNIC BAR0 res hdr not mem-mapped\n");
105 if (ioread32(&rh->magic) != VNIC_RES_MAGIC ||
106 ioread32(&rh->version) != VNIC_RES_VERSION) {
107 pr_err("vNIC BAR0 res magic/version error exp (%lx/%lx) curr (%x/%x)\n",
108 VNIC_RES_MAGIC, VNIC_RES_VERSION,
109 ioread32(&rh->magic), ioread32(&rh->version));
114 r = (struct vnic_resource __iomem *)(rh + 1);
116 while ((type = ioread8(&r->type)) != RES_TYPE_EOL) {
118 u8 bar_num = ioread8(&r->bar);
119 u32 bar_offset = ioread32(&r->bar_offset);
120 u32 count = ioread32(&r->count);
125 if (bar_num >= num_bars)
128 if (!bar[bar_num].len || !bar[bar_num].vaddr)
135 case RES_TYPE_INTR_CTRL:
136 /* each count is stride bytes long */
137 len = count * VNIC_RES_STRIDE;
138 if (len + bar_offset > bar->len) {
139 pr_err("vNIC BAR0 resource %d out-of-bounds, offset 0x%x + size 0x%x > bar len 0x%lx\n",
148 case RES_TYPE_INTR_PBA_LEGACY:
149 case RES_TYPE_DEVCMD:
150 case RES_TYPE_DEVCMD2:
158 vdev->res[type].count = count;
159 vdev->res[type].vaddr = (char __iomem *)bar->vaddr + bar_offset;
165 unsigned int svnic_dev_get_res_count(struct vnic_dev *vdev,
166 enum vnic_res_type type)
168 return vdev->res[type].count;
171 void __iomem *svnic_dev_get_res(struct vnic_dev *vdev, enum vnic_res_type type,
174 if (!vdev->res[type].vaddr)
181 case RES_TYPE_INTR_CTRL:
182 return (char __iomem *)vdev->res[type].vaddr +
183 index * VNIC_RES_STRIDE;
186 return (char __iomem *)vdev->res[type].vaddr;
190 unsigned int svnic_dev_desc_ring_size(struct vnic_dev_ring *ring,
191 unsigned int desc_count,
192 unsigned int desc_size)
194 /* The base address of the desc rings must be 512 byte aligned.
195 * Descriptor count is aligned to groups of 32 descriptors. A
196 * count of 0 means the maximum 4096 descriptors. Descriptor
197 * size is aligned to 16 bytes.
200 unsigned int count_align = 32;
201 unsigned int desc_align = 16;
203 ring->base_align = 512;
208 ring->desc_count = ALIGN(desc_count, count_align);
210 ring->desc_size = ALIGN(desc_size, desc_align);
212 ring->size = ring->desc_count * ring->desc_size;
213 ring->size_unaligned = ring->size + ring->base_align;
215 return ring->size_unaligned;
218 void svnic_dev_clear_desc_ring(struct vnic_dev_ring *ring)
220 memset(ring->descs, 0, ring->size);
223 int svnic_dev_alloc_desc_ring(struct vnic_dev *vdev, struct vnic_dev_ring *ring,
224 unsigned int desc_count, unsigned int desc_size)
226 svnic_dev_desc_ring_size(ring, desc_count, desc_size);
228 ring->descs_unaligned = dma_alloc_coherent(&vdev->pdev->dev,
229 ring->size_unaligned, &ring->base_addr_unaligned,
231 if (!ring->descs_unaligned) {
232 pr_err("Failed to allocate ring (size=%d), aborting\n",
238 ring->base_addr = ALIGN(ring->base_addr_unaligned,
240 ring->descs = (u8 *)ring->descs_unaligned +
241 (ring->base_addr - ring->base_addr_unaligned);
243 svnic_dev_clear_desc_ring(ring);
245 ring->desc_avail = ring->desc_count - 1;
250 void svnic_dev_free_desc_ring(struct vnic_dev *vdev, struct vnic_dev_ring *ring)
253 dma_free_coherent(&vdev->pdev->dev,
254 ring->size_unaligned,
255 ring->descs_unaligned,
256 ring->base_addr_unaligned);
261 static int _svnic_dev_cmd2(struct vnic_dev *vdev, enum vnic_devcmd_cmd cmd,
264 struct devcmd2_controller *dc2c = vdev->devcmd2;
265 struct devcmd2_result *result = NULL;
274 fetch_idx = ioread32(&dc2c->wq_ctrl->fetch_index);
275 if (fetch_idx == 0xFFFFFFFF) { /* check for hardware gone */
276 /* Hardware surprise removal: return error */
280 posted = ioread32(&dc2c->wq_ctrl->posted_index);
282 if (posted == 0xFFFFFFFF) { /* check for hardware gone */
283 /* Hardware surprise removal: return error */
287 new_posted = (posted + 1) % DEVCMD2_RING_SIZE;
288 if (new_posted == fetch_idx) {
289 pr_err("%s: wq is full while issuing devcmd2 command %d, fetch index: %u, posted index: %u\n",
290 pci_name(vdev->pdev), _CMD_N(cmd), fetch_idx, posted);
295 dc2c->cmd_ring[posted].cmd = cmd;
296 dc2c->cmd_ring[posted].flags = 0;
298 if ((_CMD_FLAGS(cmd) & _CMD_FLAGS_NOWAIT))
299 dc2c->cmd_ring[posted].flags |= DEVCMD2_FNORESULT;
301 if (_CMD_DIR(cmd) & _CMD_DIR_WRITE) {
302 for (i = 0; i < VNIC_DEVCMD_NARGS; i++)
303 dc2c->cmd_ring[posted].args[i] = vdev->args[i];
305 /* Adding write memory barrier prevents compiler and/or CPU
306 * reordering, thus avoiding descriptor posting before
307 * descriptor is initialized. Otherwise, hardware can read
308 * stale descriptor fields.
311 iowrite32(new_posted, &dc2c->wq_ctrl->posted_index);
313 if (dc2c->cmd_ring[posted].flags & DEVCMD2_FNORESULT)
316 result = dc2c->result + dc2c->next_result;
320 * Increment next_result, after posting the devcmd, irrespective of
321 * devcmd result, and it should be done only once.
324 if (dc2c->next_result == dc2c->result_size) {
325 dc2c->next_result = 0;
326 dc2c->color = dc2c->color ? 0 : 1;
329 for (delay = 0; delay < wait; delay++) {
331 if (result->color == color) {
333 err = (int) result->error;
334 if (err != ERR_ECMDUNKNOWN ||
335 cmd != CMD_CAPABILITY)
336 pr_err("Error %d devcmd %d\n",
341 if (_CMD_DIR(cmd) & _CMD_DIR_READ) {
342 for (i = 0; i < VNIC_DEVCMD_NARGS; i++)
343 vdev->args[i] = result->results[i];
350 pr_err("Timed out devcmd %d\n", _CMD_N(cmd));
355 static int svnic_dev_init_devcmd2(struct vnic_dev *vdev)
357 struct devcmd2_controller *dc2c = NULL;
358 unsigned int fetch_idx;
365 p = svnic_dev_get_res(vdev, RES_TYPE_DEVCMD2, 0);
369 dc2c = kzalloc(sizeof(*dc2c), GFP_ATOMIC);
373 vdev->devcmd2 = dc2c;
376 dc2c->result_size = DEVCMD2_RING_SIZE;
378 ret = vnic_wq_devcmd2_alloc(vdev,
383 goto err_free_devcmd2;
385 fetch_idx = ioread32(&dc2c->wq.ctrl->fetch_index);
386 if (fetch_idx == 0xFFFFFFFF) { /* check for hardware gone */
387 /* Hardware surprise removal: reset fetch_index */
392 * Don't change fetch_index ever and
393 * set posted_index same as fetch_index
394 * when setting up the WQ for devcmd2.
396 vnic_wq_init_start(&dc2c->wq, 0, fetch_idx, fetch_idx, 0, 0);
397 svnic_wq_enable(&dc2c->wq);
398 ret = svnic_dev_alloc_desc_ring(vdev,
405 dc2c->result = (struct devcmd2_result *) dc2c->results_ring.descs;
406 dc2c->cmd_ring = (struct vnic_devcmd2 *) dc2c->wq.ring.descs;
407 dc2c->wq_ctrl = dc2c->wq.ctrl;
408 vdev->args[0] = (u64) dc2c->results_ring.base_addr | VNIC_PADDR_TARGET;
409 vdev->args[1] = DEVCMD2_RING_SIZE;
411 ret = _svnic_dev_cmd2(vdev, CMD_INITIALIZE_DEVCMD2, VNIC_DVCMD_TMO);
413 goto err_free_desc_ring;
415 vdev->devcmd_rtn = &_svnic_dev_cmd2;
416 pr_info("DEVCMD2 Initialized.\n");
421 svnic_dev_free_desc_ring(vdev, &dc2c->results_ring);
424 svnic_wq_disable(&dc2c->wq);
425 svnic_wq_free(&dc2c->wq);
429 vdev->devcmd2 = NULL;
432 } /* end of svnic_dev_init_devcmd2 */
434 static void vnic_dev_deinit_devcmd2(struct vnic_dev *vdev)
436 struct devcmd2_controller *dc2c = vdev->devcmd2;
438 vdev->devcmd2 = NULL;
439 vdev->devcmd_rtn = NULL;
441 svnic_dev_free_desc_ring(vdev, &dc2c->results_ring);
442 svnic_wq_disable(&dc2c->wq);
443 svnic_wq_free(&dc2c->wq);
447 int svnic_dev_cmd(struct vnic_dev *vdev, enum vnic_devcmd_cmd cmd,
448 u64 *a0, u64 *a1, int wait)
452 memset(vdev->args, 0, sizeof(vdev->args));
456 err = (*vdev->devcmd_rtn)(vdev, cmd, wait);
464 int svnic_dev_fw_info(struct vnic_dev *vdev,
465 struct vnic_devcmd_fw_info **fw_info)
468 int wait = VNIC_DVCMD_TMO;
471 if (!vdev->fw_info) {
472 vdev->fw_info = dma_alloc_coherent(&vdev->pdev->dev,
473 sizeof(struct vnic_devcmd_fw_info),
474 &vdev->fw_info_pa, GFP_KERNEL);
478 a0 = vdev->fw_info_pa;
480 /* only get fw_info once and cache it */
481 err = svnic_dev_cmd(vdev, CMD_MCPU_FW_INFO, &a0, &a1, wait);
484 *fw_info = vdev->fw_info;
489 int svnic_dev_spec(struct vnic_dev *vdev, unsigned int offset,
490 unsigned int size, void *value)
493 int wait = VNIC_DVCMD_TMO;
499 err = svnic_dev_cmd(vdev, CMD_DEV_SPEC, &a0, &a1, wait);
503 *(u8 *)value = (u8)a0;
506 *(u16 *)value = (u16)a0;
509 *(u32 *)value = (u32)a0;
522 int svnic_dev_stats_clear(struct vnic_dev *vdev)
525 int wait = VNIC_DVCMD_TMO;
527 return svnic_dev_cmd(vdev, CMD_STATS_CLEAR, &a0, &a1, wait);
530 int svnic_dev_stats_dump(struct vnic_dev *vdev, struct vnic_stats **stats)
533 int wait = VNIC_DVCMD_TMO;
536 vdev->stats = dma_alloc_coherent(&vdev->pdev->dev,
537 sizeof(struct vnic_stats), &vdev->stats_pa, GFP_KERNEL);
542 *stats = vdev->stats;
544 a1 = sizeof(struct vnic_stats);
546 return svnic_dev_cmd(vdev, CMD_STATS_DUMP, &a0, &a1, wait);
549 int svnic_dev_close(struct vnic_dev *vdev)
552 int wait = VNIC_DVCMD_TMO;
554 return svnic_dev_cmd(vdev, CMD_CLOSE, &a0, &a1, wait);
557 int svnic_dev_enable_wait(struct vnic_dev *vdev)
560 int wait = VNIC_DVCMD_TMO;
563 err = svnic_dev_cmd(vdev, CMD_ENABLE_WAIT, &a0, &a1, wait);
564 if (err == ERR_ECMDUNKNOWN)
565 return svnic_dev_cmd(vdev, CMD_ENABLE, &a0, &a1, wait);
570 int svnic_dev_disable(struct vnic_dev *vdev)
573 int wait = VNIC_DVCMD_TMO;
575 return svnic_dev_cmd(vdev, CMD_DISABLE, &a0, &a1, wait);
578 int svnic_dev_open(struct vnic_dev *vdev, int arg)
580 u64 a0 = (u32)arg, a1 = 0;
581 int wait = VNIC_DVCMD_TMO;
583 return svnic_dev_cmd(vdev, CMD_OPEN, &a0, &a1, wait);
586 int svnic_dev_open_done(struct vnic_dev *vdev, int *done)
589 int wait = VNIC_DVCMD_TMO;
594 err = svnic_dev_cmd(vdev, CMD_OPEN_STATUS, &a0, &a1, wait);
603 int svnic_dev_notify_set(struct vnic_dev *vdev, u16 intr)
606 int wait = VNIC_DVCMD_TMO;
609 vdev->notify = dma_alloc_coherent(&vdev->pdev->dev,
610 sizeof(struct vnic_devcmd_notify),
611 &vdev->notify_pa, GFP_KERNEL);
616 a0 = vdev->notify_pa;
617 a1 = ((u64)intr << 32) & VNIC_NOTIFY_INTR_MASK;
618 a1 += sizeof(struct vnic_devcmd_notify);
620 return svnic_dev_cmd(vdev, CMD_NOTIFY, &a0, &a1, wait);
623 void svnic_dev_notify_unset(struct vnic_dev *vdev)
626 int wait = VNIC_DVCMD_TMO;
628 a0 = 0; /* paddr = 0 to unset notify buffer */
629 a1 = VNIC_NOTIFY_INTR_MASK; /* intr num = -1 to unreg for intr */
630 a1 += sizeof(struct vnic_devcmd_notify);
632 svnic_dev_cmd(vdev, CMD_NOTIFY, &a0, &a1, wait);
635 static int vnic_dev_notify_ready(struct vnic_dev *vdev)
638 unsigned int nwords = sizeof(struct vnic_devcmd_notify) / 4;
647 memcpy(&vdev->notify_copy, vdev->notify,
648 sizeof(struct vnic_devcmd_notify));
649 words = (u32 *)&vdev->notify_copy;
650 for (i = 1; i < nwords; i++)
652 } while (csum != words[0]);
657 int svnic_dev_init(struct vnic_dev *vdev, int arg)
659 u64 a0 = (u32)arg, a1 = 0;
660 int wait = VNIC_DVCMD_TMO;
662 return svnic_dev_cmd(vdev, CMD_INIT, &a0, &a1, wait);
665 int svnic_dev_link_status(struct vnic_dev *vdev)
667 if (vdev->linkstatus)
668 return *vdev->linkstatus;
670 if (!vnic_dev_notify_ready(vdev))
673 return vdev->notify_copy.link_state;
676 u32 svnic_dev_link_down_cnt(struct vnic_dev *vdev)
678 if (!vnic_dev_notify_ready(vdev))
681 return vdev->notify_copy.link_down_cnt;
684 void svnic_dev_set_intr_mode(struct vnic_dev *vdev,
685 enum vnic_dev_intr_mode intr_mode)
687 vdev->intr_mode = intr_mode;
690 enum vnic_dev_intr_mode svnic_dev_get_intr_mode(struct vnic_dev *vdev)
692 return vdev->intr_mode;
695 void svnic_dev_unregister(struct vnic_dev *vdev)
699 dma_free_coherent(&vdev->pdev->dev,
700 sizeof(struct vnic_devcmd_notify),
703 if (vdev->linkstatus)
704 dma_free_coherent(&vdev->pdev->dev,
707 vdev->linkstatus_pa);
709 dma_free_coherent(&vdev->pdev->dev,
710 sizeof(struct vnic_stats),
711 vdev->stats, vdev->stats_pa);
713 dma_free_coherent(&vdev->pdev->dev,
714 sizeof(struct vnic_devcmd_fw_info),
715 vdev->fw_info, vdev->fw_info_pa);
717 vnic_dev_deinit_devcmd2(vdev);
722 struct vnic_dev *svnic_dev_alloc_discover(struct vnic_dev *vdev,
724 struct pci_dev *pdev,
725 struct vnic_dev_bar *bar,
726 unsigned int num_bars)
729 vdev = kzalloc(sizeof(struct vnic_dev), GFP_ATOMIC);
737 if (vnic_dev_discover_res(vdev, bar, num_bars))
743 svnic_dev_unregister(vdev);
746 } /* end of svnic_dev_alloc_discover */
749 * fallback option is left to keep the interface common for other vnics.
751 int svnic_dev_cmd_init(struct vnic_dev *vdev, int fallback)
756 p = svnic_dev_get_res(vdev, RES_TYPE_DEVCMD2, 0);
758 err = svnic_dev_init_devcmd2(vdev);
760 pr_err("DEVCMD2 resource not found.\n");
763 } /* end of svnic_dev_cmd_init */