1 // SPDX-License-Identifier: GPL-2.0 OR BSD-2-Clause
3 * Copyright 2018-2021 Amazon.com, Inc. or its affiliates. All rights reserved.
6 #include <linux/module.h>
8 #include <linux/utsname.h>
9 #include <linux/version.h>
11 #include <rdma/ib_user_verbs.h>
15 #define PCI_DEV_ID_EFA0_VF 0xefa0
16 #define PCI_DEV_ID_EFA1_VF 0xefa1
18 static const struct pci_device_id efa_pci_tbl[] = {
19 { PCI_VDEVICE(AMAZON, PCI_DEV_ID_EFA0_VF) },
20 { PCI_VDEVICE(AMAZON, PCI_DEV_ID_EFA1_VF) },
24 MODULE_AUTHOR("Amazon.com, Inc. or its affiliates");
25 MODULE_LICENSE("Dual BSD/GPL");
26 MODULE_DESCRIPTION(DEVICE_NAME);
27 MODULE_DEVICE_TABLE(pci, efa_pci_tbl);
31 #define EFA_BASE_BAR_MASK (BIT(EFA_REG_BAR) | BIT(EFA_MEM_BAR))
33 #define EFA_AENQ_ENABLED_GROUPS \
34 (BIT(EFA_ADMIN_FATAL_ERROR) | BIT(EFA_ADMIN_WARNING) | \
35 BIT(EFA_ADMIN_NOTIFICATION) | BIT(EFA_ADMIN_KEEP_ALIVE))
37 /* This handler will called for unknown event group or unimplemented handlers */
38 static void unimplemented_aenq_handler(void *data,
39 struct efa_admin_aenq_entry *aenq_e)
41 struct efa_dev *dev = (struct efa_dev *)data;
43 ibdev_err(&dev->ibdev,
44 "Unknown event was received or event with unimplemented handler\n");
47 static void efa_keep_alive(void *data, struct efa_admin_aenq_entry *aenq_e)
49 struct efa_dev *dev = (struct efa_dev *)data;
51 atomic64_inc(&dev->stats.keep_alive_rcvd);
54 static struct efa_aenq_handlers aenq_handlers = {
56 [EFA_ADMIN_KEEP_ALIVE] = efa_keep_alive,
58 .unimplemented_handler = unimplemented_aenq_handler
61 static void efa_release_bars(struct efa_dev *dev, int bars_mask)
63 struct pci_dev *pdev = dev->pdev;
66 release_bars = pci_select_bars(pdev, IORESOURCE_MEM) & bars_mask;
67 pci_release_selected_regions(pdev, release_bars);
70 static void efa_process_comp_eqe(struct efa_dev *dev, struct efa_admin_eqe *eqe)
72 u16 cqn = eqe->u.comp_event.cqn;
75 /* Safe to load as we're in irq and removal calls synchronize_irq() */
76 cq = xa_load(&dev->cqs_xa, cqn);
78 ibdev_err_ratelimited(&dev->ibdev,
79 "Completion event on non-existent CQ[%u]",
84 cq->ibcq.comp_handler(&cq->ibcq, cq->ibcq.cq_context);
87 static void efa_process_eqe(struct efa_com_eq *eeq, struct efa_admin_eqe *eqe)
89 struct efa_dev *dev = container_of(eeq->edev, struct efa_dev, edev);
91 if (likely(EFA_GET(&eqe->common, EFA_ADMIN_EQE_EVENT_TYPE) ==
92 EFA_ADMIN_EQE_EVENT_TYPE_COMPLETION))
93 efa_process_comp_eqe(dev, eqe);
95 ibdev_err_ratelimited(&dev->ibdev,
96 "Unknown event type received %lu",
98 EFA_ADMIN_EQE_EVENT_TYPE));
101 static irqreturn_t efa_intr_msix_comp(int irq, void *data)
103 struct efa_eq *eq = data;
104 struct efa_com_dev *edev = eq->eeq.edev;
106 efa_com_eq_comp_intr_handler(edev, &eq->eeq);
111 static irqreturn_t efa_intr_msix_mgmnt(int irq, void *data)
113 struct efa_dev *dev = data;
115 efa_com_admin_q_comp_intr_handler(&dev->edev);
116 efa_com_aenq_intr_handler(&dev->edev, data);
121 static int efa_request_irq(struct efa_dev *dev, struct efa_irq *irq)
125 err = request_irq(irq->irqn, irq->handler, 0, irq->name, irq->data);
127 dev_err(&dev->pdev->dev, "Failed to request irq %s (%d)\n",
132 irq_set_affinity_hint(irq->irqn, &irq->affinity_hint_mask);
137 static void efa_setup_comp_irq(struct efa_dev *dev, struct efa_eq *eq,
142 cpu = vector - EFA_COMP_EQS_VEC_BASE;
143 snprintf(eq->irq.name, EFA_IRQNAME_SIZE, "efa-comp%d@pci:%s", cpu,
144 pci_name(dev->pdev));
145 eq->irq.handler = efa_intr_msix_comp;
147 eq->irq.vector = vector;
148 eq->irq.irqn = pci_irq_vector(dev->pdev, vector);
149 cpumask_set_cpu(cpu, &eq->irq.affinity_hint_mask);
152 static void efa_free_irq(struct efa_dev *dev, struct efa_irq *irq)
154 irq_set_affinity_hint(irq->irqn, NULL);
155 free_irq(irq->irqn, irq->data);
158 static void efa_setup_mgmnt_irq(struct efa_dev *dev)
162 snprintf(dev->admin_irq.name, EFA_IRQNAME_SIZE,
163 "efa-mgmnt@pci:%s", pci_name(dev->pdev));
164 dev->admin_irq.handler = efa_intr_msix_mgmnt;
165 dev->admin_irq.data = dev;
166 dev->admin_irq.vector = dev->admin_msix_vector_idx;
167 dev->admin_irq.irqn = pci_irq_vector(dev->pdev,
168 dev->admin_msix_vector_idx);
169 cpu = cpumask_first(cpu_online_mask);
171 &dev->admin_irq.affinity_hint_mask);
172 dev_info(&dev->pdev->dev, "Setup irq:%d name:%s\n",
174 dev->admin_irq.name);
177 static int efa_set_mgmnt_irq(struct efa_dev *dev)
179 efa_setup_mgmnt_irq(dev);
181 return efa_request_irq(dev, &dev->admin_irq);
184 static int efa_request_doorbell_bar(struct efa_dev *dev)
186 u8 db_bar_idx = dev->dev_attr.db_bar;
187 struct pci_dev *pdev = dev->pdev;
191 if (!(BIT(db_bar_idx) & EFA_BASE_BAR_MASK)) {
192 bars = pci_select_bars(pdev, IORESOURCE_MEM) & BIT(db_bar_idx);
194 err = pci_request_selected_regions(pdev, bars, DRV_MODULE_NAME);
196 dev_err(&dev->pdev->dev,
197 "pci_request_selected_regions for bar %d failed %d\n",
203 dev->db_bar_addr = pci_resource_start(dev->pdev, db_bar_idx);
204 dev->db_bar_len = pci_resource_len(dev->pdev, db_bar_idx);
209 static void efa_release_doorbell_bar(struct efa_dev *dev)
211 if (!(BIT(dev->dev_attr.db_bar) & EFA_BASE_BAR_MASK))
212 efa_release_bars(dev, BIT(dev->dev_attr.db_bar));
215 static void efa_update_hw_hints(struct efa_dev *dev,
216 struct efa_com_get_hw_hints_result *hw_hints)
218 struct efa_com_dev *edev = &dev->edev;
220 if (hw_hints->mmio_read_timeout)
221 edev->mmio_read.mmio_read_timeout =
222 hw_hints->mmio_read_timeout * 1000;
224 if (hw_hints->poll_interval)
225 edev->aq.poll_interval = hw_hints->poll_interval;
227 if (hw_hints->admin_completion_timeout)
228 edev->aq.completion_timeout =
229 hw_hints->admin_completion_timeout;
232 static void efa_stats_init(struct efa_dev *dev)
234 atomic64_t *s = (atomic64_t *)&dev->stats;
237 for (i = 0; i < sizeof(dev->stats) / sizeof(*s); i++, s++)
241 static void efa_set_host_info(struct efa_dev *dev)
243 struct efa_admin_set_feature_resp resp = {};
244 struct efa_admin_set_feature_cmd cmd = {};
245 struct efa_admin_host_info *hinf;
246 u32 bufsz = sizeof(*hinf);
249 if (!efa_com_check_supported_feature_id(&dev->edev,
250 EFA_ADMIN_HOST_INFO))
253 /* Failures in host info set shall not disturb probe */
254 hinf = dma_alloc_coherent(&dev->pdev->dev, bufsz, &hinf_dma,
259 strscpy(hinf->os_dist_str, utsname()->release,
260 sizeof(hinf->os_dist_str));
261 hinf->os_type = EFA_ADMIN_OS_LINUX;
262 strscpy(hinf->kernel_ver_str, utsname()->version,
263 sizeof(hinf->kernel_ver_str));
264 hinf->kernel_ver = LINUX_VERSION_CODE;
265 EFA_SET(&hinf->driver_ver, EFA_ADMIN_HOST_INFO_DRIVER_MAJOR, 0);
266 EFA_SET(&hinf->driver_ver, EFA_ADMIN_HOST_INFO_DRIVER_MINOR, 0);
267 EFA_SET(&hinf->driver_ver, EFA_ADMIN_HOST_INFO_DRIVER_SUB_MINOR, 0);
268 EFA_SET(&hinf->driver_ver, EFA_ADMIN_HOST_INFO_DRIVER_MODULE_TYPE, 0);
269 EFA_SET(&hinf->bdf, EFA_ADMIN_HOST_INFO_BUS, dev->pdev->bus->number);
270 EFA_SET(&hinf->bdf, EFA_ADMIN_HOST_INFO_DEVICE,
271 PCI_SLOT(dev->pdev->devfn));
272 EFA_SET(&hinf->bdf, EFA_ADMIN_HOST_INFO_FUNCTION,
273 PCI_FUNC(dev->pdev->devfn));
274 EFA_SET(&hinf->spec_ver, EFA_ADMIN_HOST_INFO_SPEC_MAJOR,
275 EFA_COMMON_SPEC_VERSION_MAJOR);
276 EFA_SET(&hinf->spec_ver, EFA_ADMIN_HOST_INFO_SPEC_MINOR,
277 EFA_COMMON_SPEC_VERSION_MINOR);
278 EFA_SET(&hinf->flags, EFA_ADMIN_HOST_INFO_INTREE, 1);
279 EFA_SET(&hinf->flags, EFA_ADMIN_HOST_INFO_GDR, 0);
281 efa_com_set_feature_ex(&dev->edev, &resp, &cmd, EFA_ADMIN_HOST_INFO,
284 dma_free_coherent(&dev->pdev->dev, bufsz, hinf, hinf_dma);
287 static void efa_destroy_eq(struct efa_dev *dev, struct efa_eq *eq)
289 efa_com_eq_destroy(&dev->edev, &eq->eeq);
290 efa_free_irq(dev, &eq->irq);
293 static int efa_create_eq(struct efa_dev *dev, struct efa_eq *eq, u8 msix_vec)
297 efa_setup_comp_irq(dev, eq, msix_vec);
298 err = efa_request_irq(dev, &eq->irq);
302 err = efa_com_eq_init(&dev->edev, &eq->eeq, efa_process_eqe,
303 dev->dev_attr.max_eq_depth, msix_vec);
305 goto err_free_comp_irq;
310 efa_free_irq(dev, &eq->irq);
314 static int efa_create_eqs(struct efa_dev *dev)
316 unsigned int neqs = dev->dev_attr.max_eq;
320 neqs = min_t(unsigned int, neqs, num_online_cpus());
322 dev->eqs = kcalloc(neqs, sizeof(*dev->eqs), GFP_KERNEL);
326 for (i = 0; i < neqs; i++) {
327 err = efa_create_eq(dev, &dev->eqs[i],
328 i + EFA_COMP_EQS_VEC_BASE);
330 goto err_destroy_eqs;
336 for (i--; i >= 0; i--)
337 efa_destroy_eq(dev, &dev->eqs[i]);
343 static void efa_destroy_eqs(struct efa_dev *dev)
347 for (i = 0; i < dev->neqs; i++)
348 efa_destroy_eq(dev, &dev->eqs[i]);
353 static const struct ib_device_ops efa_dev_ops = {
354 .owner = THIS_MODULE,
355 .driver_id = RDMA_DRIVER_EFA,
356 .uverbs_abi_ver = EFA_UVERBS_ABI_VERSION,
358 .alloc_hw_port_stats = efa_alloc_hw_port_stats,
359 .alloc_hw_device_stats = efa_alloc_hw_device_stats,
360 .alloc_pd = efa_alloc_pd,
361 .alloc_ucontext = efa_alloc_ucontext,
362 .create_cq = efa_create_cq,
363 .create_qp = efa_create_qp,
364 .create_user_ah = efa_create_ah,
365 .dealloc_pd = efa_dealloc_pd,
366 .dealloc_ucontext = efa_dealloc_ucontext,
367 .dereg_mr = efa_dereg_mr,
368 .destroy_ah = efa_destroy_ah,
369 .destroy_cq = efa_destroy_cq,
370 .destroy_qp = efa_destroy_qp,
371 .get_hw_stats = efa_get_hw_stats,
372 .get_link_layer = efa_port_link_layer,
373 .get_port_immutable = efa_get_port_immutable,
375 .mmap_free = efa_mmap_free,
376 .modify_qp = efa_modify_qp,
377 .query_device = efa_query_device,
378 .query_gid = efa_query_gid,
379 .query_pkey = efa_query_pkey,
380 .query_port = efa_query_port,
381 .query_qp = efa_query_qp,
382 .reg_user_mr = efa_reg_mr,
383 .reg_user_mr_dmabuf = efa_reg_user_mr_dmabuf,
385 INIT_RDMA_OBJ_SIZE(ib_ah, efa_ah, ibah),
386 INIT_RDMA_OBJ_SIZE(ib_cq, efa_cq, ibcq),
387 INIT_RDMA_OBJ_SIZE(ib_pd, efa_pd, ibpd),
388 INIT_RDMA_OBJ_SIZE(ib_qp, efa_qp, ibqp),
389 INIT_RDMA_OBJ_SIZE(ib_ucontext, efa_ucontext, ibucontext),
392 static int efa_ib_device_add(struct efa_dev *dev)
394 struct efa_com_get_hw_hints_result hw_hints;
395 struct pci_dev *pdev = dev->pdev;
400 err = efa_com_get_device_attr(&dev->edev, &dev->dev_attr);
404 dev_dbg(&dev->pdev->dev, "Doorbells bar (%d)\n", dev->dev_attr.db_bar);
405 err = efa_request_doorbell_bar(dev);
409 err = efa_com_get_hw_hints(&dev->edev, &hw_hints);
411 goto err_release_doorbell_bar;
413 efa_update_hw_hints(dev, &hw_hints);
415 /* Try to enable all the available aenq groups */
416 err = efa_com_set_aenq_config(&dev->edev, EFA_AENQ_ENABLED_GROUPS);
418 goto err_release_doorbell_bar;
420 err = efa_create_eqs(dev);
422 goto err_release_doorbell_bar;
424 efa_set_host_info(dev);
426 dev->ibdev.node_type = RDMA_NODE_UNSPECIFIED;
427 dev->ibdev.phys_port_cnt = 1;
428 dev->ibdev.num_comp_vectors = dev->neqs ?: 1;
429 dev->ibdev.dev.parent = &pdev->dev;
431 ib_set_device_ops(&dev->ibdev, &efa_dev_ops);
433 err = ib_register_device(&dev->ibdev, "efa_%d", &pdev->dev);
435 goto err_destroy_eqs;
437 ibdev_info(&dev->ibdev, "IB device registered\n");
442 efa_destroy_eqs(dev);
443 err_release_doorbell_bar:
444 efa_release_doorbell_bar(dev);
448 static void efa_ib_device_remove(struct efa_dev *dev)
450 ibdev_info(&dev->ibdev, "Unregister ib device\n");
451 ib_unregister_device(&dev->ibdev);
452 efa_destroy_eqs(dev);
453 efa_com_dev_reset(&dev->edev, EFA_REGS_RESET_NORMAL);
454 efa_release_doorbell_bar(dev);
457 static void efa_disable_msix(struct efa_dev *dev)
459 pci_free_irq_vectors(dev->pdev);
462 static int efa_enable_msix(struct efa_dev *dev)
464 int msix_vecs, irq_num;
467 * Reserve the max msix vectors we might need, one vector is reserved
470 msix_vecs = min_t(int, pci_msix_vec_count(dev->pdev),
471 num_online_cpus() + 1);
472 dev_dbg(&dev->pdev->dev, "Trying to enable MSI-X, vectors %d\n",
475 dev->admin_msix_vector_idx = EFA_MGMNT_MSIX_VEC_IDX;
476 irq_num = pci_alloc_irq_vectors(dev->pdev, msix_vecs,
477 msix_vecs, PCI_IRQ_MSIX);
480 dev_err(&dev->pdev->dev, "Failed to enable MSI-X. irq_num %d\n",
485 if (irq_num != msix_vecs) {
486 efa_disable_msix(dev);
487 dev_err(&dev->pdev->dev,
488 "Allocated %d MSI-X (out of %d requested)\n",
496 static int efa_device_init(struct efa_com_dev *edev, struct pci_dev *pdev)
501 err = efa_com_dev_reset(edev, EFA_REGS_RESET_NORMAL);
505 err = efa_com_validate_version(edev);
509 dma_width = efa_com_get_dma_width(edev);
515 err = dma_set_mask_and_coherent(&pdev->dev, DMA_BIT_MASK(dma_width));
517 dev_err(&pdev->dev, "dma_set_mask_and_coherent failed %d\n", err);
521 dma_set_max_seg_size(&pdev->dev, UINT_MAX);
525 static struct efa_dev *efa_probe_device(struct pci_dev *pdev)
527 struct efa_com_dev *edev;
532 err = pci_enable_device_mem(pdev);
534 dev_err(&pdev->dev, "pci_enable_device_mem() failed!\n");
538 pci_set_master(pdev);
540 dev = ib_alloc_device(efa_dev, ibdev);
542 dev_err(&pdev->dev, "Device alloc failed\n");
544 goto err_disable_device;
547 pci_set_drvdata(pdev, dev);
550 edev->dmadev = &pdev->dev;
552 xa_init(&dev->cqs_xa);
554 bars = pci_select_bars(pdev, IORESOURCE_MEM) & EFA_BASE_BAR_MASK;
555 err = pci_request_selected_regions(pdev, bars, DRV_MODULE_NAME);
557 dev_err(&pdev->dev, "pci_request_selected_regions failed %d\n",
559 goto err_ibdev_destroy;
562 dev->reg_bar_addr = pci_resource_start(pdev, EFA_REG_BAR);
563 dev->reg_bar_len = pci_resource_len(pdev, EFA_REG_BAR);
564 dev->mem_bar_addr = pci_resource_start(pdev, EFA_MEM_BAR);
565 dev->mem_bar_len = pci_resource_len(pdev, EFA_MEM_BAR);
567 edev->reg_bar = devm_ioremap(&pdev->dev,
570 if (!edev->reg_bar) {
571 dev_err(&pdev->dev, "Failed to remap register bar\n");
573 goto err_release_bars;
576 err = efa_com_mmio_reg_read_init(edev);
578 dev_err(&pdev->dev, "Failed to init readless MMIO\n");
582 err = efa_device_init(edev, pdev);
584 dev_err(&pdev->dev, "EFA device init failed\n");
587 goto err_reg_read_destroy;
590 err = efa_enable_msix(dev);
592 goto err_reg_read_destroy;
594 edev->aq.msix_vector_idx = dev->admin_msix_vector_idx;
595 edev->aenq.msix_vector_idx = dev->admin_msix_vector_idx;
597 err = efa_set_mgmnt_irq(dev);
599 goto err_disable_msix;
601 err = efa_com_admin_init(edev, &aenq_handlers);
603 goto err_free_mgmnt_irq;
608 efa_free_irq(dev, &dev->admin_irq);
610 efa_disable_msix(dev);
611 err_reg_read_destroy:
612 efa_com_mmio_reg_read_destroy(edev);
614 devm_iounmap(&pdev->dev, edev->reg_bar);
616 efa_release_bars(dev, EFA_BASE_BAR_MASK);
618 ib_dealloc_device(&dev->ibdev);
620 pci_disable_device(pdev);
624 static void efa_remove_device(struct pci_dev *pdev)
626 struct efa_dev *dev = pci_get_drvdata(pdev);
627 struct efa_com_dev *edev;
630 efa_com_admin_destroy(edev);
631 efa_free_irq(dev, &dev->admin_irq);
632 efa_disable_msix(dev);
633 efa_com_mmio_reg_read_destroy(edev);
634 devm_iounmap(&pdev->dev, edev->reg_bar);
635 efa_release_bars(dev, EFA_BASE_BAR_MASK);
636 xa_destroy(&dev->cqs_xa);
637 ib_dealloc_device(&dev->ibdev);
638 pci_disable_device(pdev);
641 static int efa_probe(struct pci_dev *pdev, const struct pci_device_id *ent)
646 dev = efa_probe_device(pdev);
650 err = efa_ib_device_add(dev);
652 goto err_remove_device;
657 efa_remove_device(pdev);
661 static void efa_remove(struct pci_dev *pdev)
663 struct efa_dev *dev = pci_get_drvdata(pdev);
665 efa_ib_device_remove(dev);
666 efa_remove_device(pdev);
669 static struct pci_driver efa_pci_driver = {
670 .name = DRV_MODULE_NAME,
671 .id_table = efa_pci_tbl,
673 .remove = efa_remove,
676 module_pci_driver(efa_pci_driver);