2 * This file is provided under a dual BSD/GPLv2 license. When using or
3 * redistributing this file, you may do so under either license.
7 * Copyright(c) 2012 Intel Corporation. All rights reserved.
8 * Copyright (C) 2015 EMC Corporation. All Rights Reserved.
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of version 2 of the GNU General Public License as
12 * published by the Free Software Foundation.
16 * Copyright(c) 2012 Intel Corporation. All rights reserved.
17 * Copyright (C) 2015 EMC Corporation. All Rights Reserved.
19 * Redistribution and use in source and binary forms, with or without
20 * modification, are permitted provided that the following conditions
23 * * Redistributions of source code must retain the above copyright
24 * notice, this list of conditions and the following disclaimer.
25 * * Redistributions in binary form must reproduce the above copy
26 * notice, this list of conditions and the following disclaimer in
27 * the documentation and/or other materials provided with the
29 * * Neither the name of Intel Corporation nor the names of its
30 * contributors may be used to endorse or promote products derived
31 * from this software without specific prior written permission.
33 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
34 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
35 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
36 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
37 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
38 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
39 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
40 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
41 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
42 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
43 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
45 * PCIe NTB Transport Linux driver
47 * Contact Information:
48 * Jon Mason <jon.mason@intel.com>
50 #include <linux/debugfs.h>
51 #include <linux/delay.h>
52 #include <linux/dmaengine.h>
53 #include <linux/dma-mapping.h>
54 #include <linux/errno.h>
55 #include <linux/export.h>
56 #include <linux/interrupt.h>
57 #include <linux/module.h>
58 #include <linux/pci.h>
59 #include <linux/slab.h>
60 #include <linux/types.h>
61 #include "linux/ntb.h"
62 #include "linux/ntb_transport.h"
64 #define NTB_TRANSPORT_VERSION 4
65 #define NTB_TRANSPORT_VER "4"
66 #define NTB_TRANSPORT_NAME "ntb_transport"
67 #define NTB_TRANSPORT_DESC "Software Queue-Pair Transport over NTB"
69 MODULE_DESCRIPTION(NTB_TRANSPORT_DESC);
70 MODULE_VERSION(NTB_TRANSPORT_VER);
71 MODULE_LICENSE("Dual BSD/GPL");
72 MODULE_AUTHOR("Intel Corporation");
74 static unsigned long max_mw_size;
75 module_param(max_mw_size, ulong, 0644);
76 MODULE_PARM_DESC(max_mw_size, "Limit size of large memory windows");
78 static unsigned int transport_mtu = 0x401E;
79 module_param(transport_mtu, uint, 0644);
80 MODULE_PARM_DESC(transport_mtu, "Maximum size of NTB transport packets");
82 static unsigned char max_num_clients;
83 module_param(max_num_clients, byte, 0644);
84 MODULE_PARM_DESC(max_num_clients, "Maximum number of NTB transport clients");
86 static unsigned int copy_bytes = 1024;
87 module_param(copy_bytes, uint, 0644);
88 MODULE_PARM_DESC(copy_bytes, "Threshold under which NTB will use the CPU to copy instead of DMA");
90 static struct dentry *nt_debugfs_dir;
92 struct ntb_queue_entry {
93 /* ntb_queue list reference */
94 struct list_head entry;
95 /* pointers to data to be transferred */
101 struct ntb_transport_qp *qp;
103 struct ntb_payload_header __iomem *tx_hdr;
104 struct ntb_payload_header *rx_hdr;
113 struct ntb_transport_qp {
114 struct ntb_transport_ctx *transport;
115 struct ntb_dev *ndev;
117 struct dma_chan *dma_chan;
122 u8 qp_num; /* Only 64 QP's are allowed. 0-63 */
125 struct ntb_rx_info __iomem *rx_info;
126 struct ntb_rx_info *remote_rx_info;
128 void (*tx_handler)(struct ntb_transport_qp *qp, void *qp_data,
129 void *data, int len);
130 struct list_head tx_free_q;
131 spinlock_t ntb_tx_free_q_lock;
133 dma_addr_t tx_mw_phys;
134 unsigned int tx_index;
135 unsigned int tx_max_entry;
136 unsigned int tx_max_frame;
138 void (*rx_handler)(struct ntb_transport_qp *qp, void *qp_data,
139 void *data, int len);
140 struct list_head rx_pend_q;
141 struct list_head rx_free_q;
142 spinlock_t ntb_rx_pend_q_lock;
143 spinlock_t ntb_rx_free_q_lock;
145 unsigned int rx_index;
146 unsigned int rx_max_entry;
147 unsigned int rx_max_frame;
148 dma_cookie_t last_cookie;
149 struct tasklet_struct rxc_db_work;
151 void (*event_handler)(void *data, int status);
152 struct delayed_work link_work;
153 struct work_struct link_cleanup;
155 struct dentry *debugfs_dir;
156 struct dentry *debugfs_stats;
175 struct ntb_transport_mw {
176 phys_addr_t phys_addr;
177 resource_size_t phys_size;
178 resource_size_t xlat_align;
179 resource_size_t xlat_align_size;
187 struct ntb_transport_client_dev {
188 struct list_head entry;
189 struct ntb_transport_ctx *nt;
193 struct ntb_transport_ctx {
194 struct list_head entry;
195 struct list_head client_devs;
197 struct ntb_dev *ndev;
199 struct ntb_transport_mw *mw_vec;
200 struct ntb_transport_qp *qp_vec;
201 unsigned int mw_count;
202 unsigned int qp_count;
207 struct delayed_work link_work;
208 struct work_struct link_cleanup;
212 DESC_DONE_FLAG = BIT(0),
213 LINK_DOWN_FLAG = BIT(1),
216 struct ntb_payload_header {
234 #define dev_client_dev(__dev) \
235 container_of((__dev), struct ntb_transport_client_dev, dev)
237 #define drv_client(__drv) \
238 container_of((__drv), struct ntb_transport_client, driver)
240 #define QP_TO_MW(nt, qp) ((qp) % nt->mw_count)
241 #define NTB_QP_DEF_NUM_ENTRIES 100
242 #define NTB_LINK_DOWN_TIMEOUT 10
244 static void ntb_transport_rxc_db(unsigned long data);
245 static const struct ntb_ctx_ops ntb_transport_ops;
246 static struct ntb_client ntb_transport_client;
248 static int ntb_transport_bus_match(struct device *dev,
249 struct device_driver *drv)
251 return !strncmp(dev_name(dev), drv->name, strlen(drv->name));
254 static int ntb_transport_bus_probe(struct device *dev)
256 const struct ntb_transport_client *client;
261 client = drv_client(dev->driver);
262 rc = client->probe(dev);
269 static int ntb_transport_bus_remove(struct device *dev)
271 const struct ntb_transport_client *client;
273 client = drv_client(dev->driver);
281 static struct bus_type ntb_transport_bus = {
282 .name = "ntb_transport",
283 .match = ntb_transport_bus_match,
284 .probe = ntb_transport_bus_probe,
285 .remove = ntb_transport_bus_remove,
288 static LIST_HEAD(ntb_transport_list);
290 static int ntb_bus_init(struct ntb_transport_ctx *nt)
292 list_add(&nt->entry, &ntb_transport_list);
296 static void ntb_bus_remove(struct ntb_transport_ctx *nt)
298 struct ntb_transport_client_dev *client_dev, *cd;
300 list_for_each_entry_safe(client_dev, cd, &nt->client_devs, entry) {
301 dev_err(client_dev->dev.parent, "%s still attached to bus, removing\n",
302 dev_name(&client_dev->dev));
303 list_del(&client_dev->entry);
304 device_unregister(&client_dev->dev);
307 list_del(&nt->entry);
310 static void ntb_transport_client_release(struct device *dev)
312 struct ntb_transport_client_dev *client_dev;
314 client_dev = dev_client_dev(dev);
319 * ntb_transport_unregister_client_dev - Unregister NTB client device
320 * @device_name: Name of NTB client device
322 * Unregister an NTB client device with the NTB transport layer
324 void ntb_transport_unregister_client_dev(char *device_name)
326 struct ntb_transport_client_dev *client, *cd;
327 struct ntb_transport_ctx *nt;
329 list_for_each_entry(nt, &ntb_transport_list, entry)
330 list_for_each_entry_safe(client, cd, &nt->client_devs, entry)
331 if (!strncmp(dev_name(&client->dev), device_name,
332 strlen(device_name))) {
333 list_del(&client->entry);
334 device_unregister(&client->dev);
337 EXPORT_SYMBOL_GPL(ntb_transport_unregister_client_dev);
340 * ntb_transport_register_client_dev - Register NTB client device
341 * @device_name: Name of NTB client device
343 * Register an NTB client device with the NTB transport layer
345 int ntb_transport_register_client_dev(char *device_name)
347 struct ntb_transport_client_dev *client_dev;
348 struct ntb_transport_ctx *nt;
352 if (list_empty(&ntb_transport_list))
355 list_for_each_entry(nt, &ntb_transport_list, entry) {
358 node = dev_to_node(&nt->ndev->dev);
360 client_dev = kzalloc_node(sizeof(*client_dev),
367 dev = &client_dev->dev;
369 /* setup and register client devices */
370 dev_set_name(dev, "%s%d", device_name, i);
371 dev->bus = &ntb_transport_bus;
372 dev->release = ntb_transport_client_release;
373 dev->parent = &nt->ndev->dev;
375 rc = device_register(dev);
381 list_add_tail(&client_dev->entry, &nt->client_devs);
388 ntb_transport_unregister_client_dev(device_name);
392 EXPORT_SYMBOL_GPL(ntb_transport_register_client_dev);
395 * ntb_transport_register_client - Register NTB client driver
396 * @drv: NTB client driver to be registered
398 * Register an NTB client driver with the NTB transport layer
400 * RETURNS: An appropriate -ERRNO error value on error, or zero for success.
402 int ntb_transport_register_client(struct ntb_transport_client *drv)
404 drv->driver.bus = &ntb_transport_bus;
406 if (list_empty(&ntb_transport_list))
409 return driver_register(&drv->driver);
411 EXPORT_SYMBOL_GPL(ntb_transport_register_client);
414 * ntb_transport_unregister_client - Unregister NTB client driver
415 * @drv: NTB client driver to be unregistered
417 * Unregister an NTB client driver with the NTB transport layer
419 * RETURNS: An appropriate -ERRNO error value on error, or zero for success.
421 void ntb_transport_unregister_client(struct ntb_transport_client *drv)
423 driver_unregister(&drv->driver);
425 EXPORT_SYMBOL_GPL(ntb_transport_unregister_client);
427 static ssize_t debugfs_read(struct file *filp, char __user *ubuf, size_t count,
430 struct ntb_transport_qp *qp;
432 ssize_t ret, out_offset, out_count;
436 buf = kmalloc(out_count, GFP_KERNEL);
440 qp = filp->private_data;
442 out_offset += snprintf(buf + out_offset, out_count - out_offset,
444 out_offset += snprintf(buf + out_offset, out_count - out_offset,
445 "rx_bytes - \t%llu\n", qp->rx_bytes);
446 out_offset += snprintf(buf + out_offset, out_count - out_offset,
447 "rx_pkts - \t%llu\n", qp->rx_pkts);
448 out_offset += snprintf(buf + out_offset, out_count - out_offset,
449 "rx_memcpy - \t%llu\n", qp->rx_memcpy);
450 out_offset += snprintf(buf + out_offset, out_count - out_offset,
451 "rx_async - \t%llu\n", qp->rx_async);
452 out_offset += snprintf(buf + out_offset, out_count - out_offset,
453 "rx_ring_empty - %llu\n", qp->rx_ring_empty);
454 out_offset += snprintf(buf + out_offset, out_count - out_offset,
455 "rx_err_no_buf - %llu\n", qp->rx_err_no_buf);
456 out_offset += snprintf(buf + out_offset, out_count - out_offset,
457 "rx_err_oflow - \t%llu\n", qp->rx_err_oflow);
458 out_offset += snprintf(buf + out_offset, out_count - out_offset,
459 "rx_err_ver - \t%llu\n", qp->rx_err_ver);
460 out_offset += snprintf(buf + out_offset, out_count - out_offset,
461 "rx_buff - \t%p\n", qp->rx_buff);
462 out_offset += snprintf(buf + out_offset, out_count - out_offset,
463 "rx_index - \t%u\n", qp->rx_index);
464 out_offset += snprintf(buf + out_offset, out_count - out_offset,
465 "rx_max_entry - \t%u\n", qp->rx_max_entry);
467 out_offset += snprintf(buf + out_offset, out_count - out_offset,
468 "tx_bytes - \t%llu\n", qp->tx_bytes);
469 out_offset += snprintf(buf + out_offset, out_count - out_offset,
470 "tx_pkts - \t%llu\n", qp->tx_pkts);
471 out_offset += snprintf(buf + out_offset, out_count - out_offset,
472 "tx_memcpy - \t%llu\n", qp->tx_memcpy);
473 out_offset += snprintf(buf + out_offset, out_count - out_offset,
474 "tx_async - \t%llu\n", qp->tx_async);
475 out_offset += snprintf(buf + out_offset, out_count - out_offset,
476 "tx_ring_full - \t%llu\n", qp->tx_ring_full);
477 out_offset += snprintf(buf + out_offset, out_count - out_offset,
478 "tx_err_no_buf - %llu\n", qp->tx_err_no_buf);
479 out_offset += snprintf(buf + out_offset, out_count - out_offset,
480 "tx_mw - \t%p\n", qp->tx_mw);
481 out_offset += snprintf(buf + out_offset, out_count - out_offset,
482 "tx_index - \t%u\n", qp->tx_index);
483 out_offset += snprintf(buf + out_offset, out_count - out_offset,
484 "tx_max_entry - \t%u\n", qp->tx_max_entry);
486 out_offset += snprintf(buf + out_offset, out_count - out_offset,
488 qp->link_is_up ? "Up" : "Down");
489 if (out_offset > out_count)
490 out_offset = out_count;
492 ret = simple_read_from_buffer(ubuf, count, offp, buf, out_offset);
497 static const struct file_operations ntb_qp_debugfs_stats = {
498 .owner = THIS_MODULE,
500 .read = debugfs_read,
503 static void ntb_list_add(spinlock_t *lock, struct list_head *entry,
504 struct list_head *list)
508 spin_lock_irqsave(lock, flags);
509 list_add_tail(entry, list);
510 spin_unlock_irqrestore(lock, flags);
513 static struct ntb_queue_entry *ntb_list_rm(spinlock_t *lock,
514 struct list_head *list)
516 struct ntb_queue_entry *entry;
519 spin_lock_irqsave(lock, flags);
520 if (list_empty(list)) {
524 entry = list_first_entry(list, struct ntb_queue_entry, entry);
525 list_del(&entry->entry);
527 spin_unlock_irqrestore(lock, flags);
532 static int ntb_transport_setup_qp_mw(struct ntb_transport_ctx *nt,
535 struct ntb_transport_qp *qp = &nt->qp_vec[qp_num];
536 struct ntb_transport_mw *mw;
537 unsigned int rx_size, num_qps_mw;
538 unsigned int mw_num, mw_count, qp_count;
541 mw_count = nt->mw_count;
542 qp_count = nt->qp_count;
544 mw_num = QP_TO_MW(nt, qp_num);
545 mw = &nt->mw_vec[mw_num];
550 if (qp_count % mw_count && mw_num + 1 < qp_count / mw_count)
551 num_qps_mw = qp_count / mw_count + 1;
553 num_qps_mw = qp_count / mw_count;
555 rx_size = (unsigned int)mw->xlat_size / num_qps_mw;
556 qp->rx_buff = mw->virt_addr + rx_size * qp_num / mw_count;
557 rx_size -= sizeof(struct ntb_rx_info);
559 qp->remote_rx_info = qp->rx_buff + rx_size;
561 /* Due to housekeeping, there must be atleast 2 buffs */
562 qp->rx_max_frame = min(transport_mtu, rx_size / 2);
563 qp->rx_max_entry = rx_size / qp->rx_max_frame;
566 qp->remote_rx_info->entry = qp->rx_max_entry - 1;
568 /* setup the hdr offsets with 0's */
569 for (i = 0; i < qp->rx_max_entry; i++) {
570 void *offset = (qp->rx_buff + qp->rx_max_frame * (i + 1) -
571 sizeof(struct ntb_payload_header));
572 memset(offset, 0, sizeof(struct ntb_payload_header));
582 static void ntb_free_mw(struct ntb_transport_ctx *nt, int num_mw)
584 struct ntb_transport_mw *mw = &nt->mw_vec[num_mw];
585 struct pci_dev *pdev = nt->ndev->pdev;
590 ntb_mw_clear_trans(nt->ndev, num_mw);
591 dma_free_coherent(&pdev->dev, mw->buff_size,
592 mw->virt_addr, mw->dma_addr);
595 mw->virt_addr = NULL;
598 static int ntb_set_mw(struct ntb_transport_ctx *nt, int num_mw,
601 struct ntb_transport_mw *mw = &nt->mw_vec[num_mw];
602 struct pci_dev *pdev = nt->ndev->pdev;
603 unsigned int xlat_size, buff_size;
606 xlat_size = round_up(size, mw->xlat_align_size);
607 buff_size = round_up(size, mw->xlat_align);
609 /* No need to re-setup */
610 if (mw->xlat_size == xlat_size)
614 ntb_free_mw(nt, num_mw);
616 /* Alloc memory for receiving data. Must be aligned */
617 mw->xlat_size = xlat_size;
618 mw->buff_size = buff_size;
620 mw->virt_addr = dma_alloc_coherent(&pdev->dev, buff_size,
621 &mw->dma_addr, GFP_KERNEL);
622 if (!mw->virt_addr) {
625 dev_err(&pdev->dev, "Unable to alloc MW buff of size %d\n",
631 * we must ensure that the memory address allocated is BAR size
632 * aligned in order for the XLAT register to take the value. This
633 * is a requirement of the hardware. It is recommended to setup CMA
634 * for BAR sizes equal or greater than 4MB.
636 if (!IS_ALIGNED(mw->dma_addr, mw->xlat_align)) {
637 dev_err(&pdev->dev, "DMA memory %pad is not aligned\n",
639 ntb_free_mw(nt, num_mw);
643 /* Notify HW the memory location of the receive buffer */
644 rc = ntb_mw_set_trans(nt->ndev, num_mw, mw->dma_addr, mw->xlat_size);
646 dev_err(&pdev->dev, "Unable to set mw%d translation", num_mw);
647 ntb_free_mw(nt, num_mw);
654 static void ntb_qp_link_down_reset(struct ntb_transport_qp *qp)
656 qp->link_is_up = false;
662 qp->rx_ring_empty = 0;
663 qp->rx_err_no_buf = 0;
664 qp->rx_err_oflow = 0;
670 qp->tx_ring_full = 0;
671 qp->tx_err_no_buf = 0;
676 static void ntb_qp_link_cleanup(struct ntb_transport_qp *qp)
678 struct ntb_transport_ctx *nt = qp->transport;
679 struct pci_dev *pdev = nt->ndev->pdev;
681 dev_info(&pdev->dev, "qp %d: Link Cleanup\n", qp->qp_num);
683 cancel_delayed_work_sync(&qp->link_work);
684 ntb_qp_link_down_reset(qp);
686 if (qp->event_handler)
687 qp->event_handler(qp->cb_data, qp->link_is_up);
690 static void ntb_qp_link_cleanup_work(struct work_struct *work)
692 struct ntb_transport_qp *qp = container_of(work,
693 struct ntb_transport_qp,
695 struct ntb_transport_ctx *nt = qp->transport;
697 ntb_qp_link_cleanup(qp);
700 schedule_delayed_work(&qp->link_work,
701 msecs_to_jiffies(NTB_LINK_DOWN_TIMEOUT));
704 static void ntb_qp_link_down(struct ntb_transport_qp *qp)
706 schedule_work(&qp->link_cleanup);
709 static void ntb_transport_link_cleanup(struct ntb_transport_ctx *nt)
711 struct ntb_transport_qp *qp;
715 qp_bitmap_alloc = nt->qp_bitmap & ~nt->qp_bitmap_free;
717 /* Pass along the info to any clients */
718 for (i = 0; i < nt->qp_count; i++)
719 if (qp_bitmap_alloc & BIT_ULL(i)) {
721 ntb_qp_link_cleanup(qp);
722 cancel_work_sync(&qp->link_cleanup);
723 cancel_delayed_work_sync(&qp->link_work);
727 cancel_delayed_work_sync(&nt->link_work);
729 /* The scratchpad registers keep the values if the remote side
730 * goes down, blast them now to give them a sane value the next
731 * time they are accessed
733 for (i = 0; i < MAX_SPAD; i++)
734 ntb_spad_write(nt->ndev, i, 0);
737 static void ntb_transport_link_cleanup_work(struct work_struct *work)
739 struct ntb_transport_ctx *nt =
740 container_of(work, struct ntb_transport_ctx, link_cleanup);
742 ntb_transport_link_cleanup(nt);
745 static void ntb_transport_event_callback(void *data)
747 struct ntb_transport_ctx *nt = data;
749 if (ntb_link_is_up(nt->ndev, NULL, NULL) == 1)
750 schedule_delayed_work(&nt->link_work, 0);
752 schedule_work(&nt->link_cleanup);
755 static void ntb_transport_link_work(struct work_struct *work)
757 struct ntb_transport_ctx *nt =
758 container_of(work, struct ntb_transport_ctx, link_work.work);
759 struct ntb_dev *ndev = nt->ndev;
760 struct pci_dev *pdev = ndev->pdev;
761 resource_size_t size;
765 /* send the local info, in the opposite order of the way we read it */
766 for (i = 0; i < nt->mw_count; i++) {
767 size = nt->mw_vec[i].phys_size;
769 if (max_mw_size && size > max_mw_size)
772 spad = MW0_SZ_HIGH + (i * 2);
773 ntb_peer_spad_write(ndev, spad, (u32)(size >> 32));
775 spad = MW0_SZ_LOW + (i * 2);
776 ntb_peer_spad_write(ndev, spad, (u32)size);
779 ntb_peer_spad_write(ndev, NUM_MWS, nt->mw_count);
781 ntb_peer_spad_write(ndev, NUM_QPS, nt->qp_count);
783 ntb_peer_spad_write(ndev, VERSION, NTB_TRANSPORT_VERSION);
785 /* Query the remote side for its info */
786 val = ntb_spad_read(ndev, VERSION);
787 dev_dbg(&pdev->dev, "Remote version = %d\n", val);
788 if (val != NTB_TRANSPORT_VERSION)
791 val = ntb_spad_read(ndev, NUM_QPS);
792 dev_dbg(&pdev->dev, "Remote max number of qps = %d\n", val);
793 if (val != nt->qp_count)
796 val = ntb_spad_read(ndev, NUM_MWS);
797 dev_dbg(&pdev->dev, "Remote number of mws = %d\n", val);
798 if (val != nt->mw_count)
801 for (i = 0; i < nt->mw_count; i++) {
804 val = ntb_spad_read(ndev, MW0_SZ_HIGH + (i * 2));
805 val64 = (u64)val << 32;
807 val = ntb_spad_read(ndev, MW0_SZ_LOW + (i * 2));
810 dev_dbg(&pdev->dev, "Remote MW%d size = %#llx\n", i, val64);
812 rc = ntb_set_mw(nt, i, val64);
817 nt->link_is_up = true;
819 for (i = 0; i < nt->qp_count; i++) {
820 struct ntb_transport_qp *qp = &nt->qp_vec[i];
822 ntb_transport_setup_qp_mw(nt, i);
824 if (qp->client_ready)
825 schedule_delayed_work(&qp->link_work, 0);
831 for (i = 0; i < nt->mw_count; i++)
834 if (ntb_link_is_up(ndev, NULL, NULL) == 1)
835 schedule_delayed_work(&nt->link_work,
836 msecs_to_jiffies(NTB_LINK_DOWN_TIMEOUT));
839 static void ntb_qp_link_work(struct work_struct *work)
841 struct ntb_transport_qp *qp = container_of(work,
842 struct ntb_transport_qp,
844 struct pci_dev *pdev = qp->ndev->pdev;
845 struct ntb_transport_ctx *nt = qp->transport;
848 WARN_ON(!nt->link_is_up);
850 val = ntb_spad_read(nt->ndev, QP_LINKS);
852 ntb_peer_spad_write(nt->ndev, QP_LINKS, val | BIT(qp->qp_num));
854 /* query remote spad for qp ready bits */
855 ntb_peer_spad_read(nt->ndev, QP_LINKS);
856 dev_dbg_ratelimited(&pdev->dev, "Remote QP link status = %x\n", val);
858 /* See if the remote side is up */
859 if (val & BIT(qp->qp_num)) {
860 dev_info(&pdev->dev, "qp %d: Link Up\n", qp->qp_num);
861 qp->link_is_up = true;
863 if (qp->event_handler)
864 qp->event_handler(qp->cb_data, qp->link_is_up);
865 } else if (nt->link_is_up)
866 schedule_delayed_work(&qp->link_work,
867 msecs_to_jiffies(NTB_LINK_DOWN_TIMEOUT));
870 static int ntb_transport_init_queue(struct ntb_transport_ctx *nt,
873 struct ntb_transport_qp *qp;
874 struct ntb_transport_mw *mw;
876 resource_size_t mw_size;
877 unsigned int num_qps_mw, tx_size;
878 unsigned int mw_num, mw_count, qp_count;
881 mw_count = nt->mw_count;
882 qp_count = nt->qp_count;
884 mw_num = QP_TO_MW(nt, qp_num);
885 mw = &nt->mw_vec[mw_num];
887 qp = &nt->qp_vec[qp_num];
891 qp->client_ready = false;
892 qp->event_handler = NULL;
893 ntb_qp_link_down_reset(qp);
895 if (qp_count % mw_count && mw_num + 1 < qp_count / mw_count)
896 num_qps_mw = qp_count / mw_count + 1;
898 num_qps_mw = qp_count / mw_count;
900 mw_base = nt->mw_vec[mw_num].phys_addr;
901 mw_size = nt->mw_vec[mw_num].phys_size;
903 tx_size = (unsigned int)mw_size / num_qps_mw;
904 qp_offset = tx_size * qp_num / mw_count;
906 qp->tx_mw = nt->mw_vec[mw_num].vbase + qp_offset;
910 qp->tx_mw_phys = mw_base + qp_offset;
914 tx_size -= sizeof(struct ntb_rx_info);
915 qp->rx_info = qp->tx_mw + tx_size;
917 /* Due to housekeeping, there must be atleast 2 buffs */
918 qp->tx_max_frame = min(transport_mtu, tx_size / 2);
919 qp->tx_max_entry = tx_size / qp->tx_max_frame;
921 if (nt_debugfs_dir) {
922 char debugfs_name[4];
924 snprintf(debugfs_name, 4, "qp%d", qp_num);
925 qp->debugfs_dir = debugfs_create_dir(debugfs_name,
928 qp->debugfs_stats = debugfs_create_file("stats", S_IRUSR,
930 &ntb_qp_debugfs_stats);
932 qp->debugfs_dir = NULL;
933 qp->debugfs_stats = NULL;
936 INIT_DELAYED_WORK(&qp->link_work, ntb_qp_link_work);
937 INIT_WORK(&qp->link_cleanup, ntb_qp_link_cleanup_work);
939 spin_lock_init(&qp->ntb_rx_pend_q_lock);
940 spin_lock_init(&qp->ntb_rx_free_q_lock);
941 spin_lock_init(&qp->ntb_tx_free_q_lock);
943 INIT_LIST_HEAD(&qp->rx_pend_q);
944 INIT_LIST_HEAD(&qp->rx_free_q);
945 INIT_LIST_HEAD(&qp->tx_free_q);
947 tasklet_init(&qp->rxc_db_work, ntb_transport_rxc_db,
953 static int ntb_transport_probe(struct ntb_client *self, struct ntb_dev *ndev)
955 struct ntb_transport_ctx *nt;
956 struct ntb_transport_mw *mw;
957 unsigned int mw_count, qp_count;
962 if (ntb_db_is_unsafe(ndev))
964 "doorbell is unsafe, proceed anyway...\n");
965 if (ntb_spad_is_unsafe(ndev))
967 "scratchpad is unsafe, proceed anyway...\n");
969 node = dev_to_node(&ndev->dev);
971 nt = kzalloc_node(sizeof(*nt), GFP_KERNEL, node);
977 mw_count = ntb_mw_count(ndev);
979 nt->mw_count = mw_count;
981 nt->mw_vec = kzalloc_node(mw_count * sizeof(*nt->mw_vec),
988 for (i = 0; i < mw_count; i++) {
991 rc = ntb_mw_get_range(ndev, i, &mw->phys_addr, &mw->phys_size,
992 &mw->xlat_align, &mw->xlat_align_size);
996 mw->vbase = ioremap(mw->phys_addr, mw->phys_size);
1004 mw->virt_addr = NULL;
1008 qp_bitmap = ntb_db_valid_mask(ndev);
1010 qp_count = ilog2(qp_bitmap);
1011 if (max_num_clients && max_num_clients < qp_count)
1012 qp_count = max_num_clients;
1013 else if (mw_count < qp_count)
1014 qp_count = mw_count;
1016 qp_bitmap &= BIT_ULL(qp_count) - 1;
1018 nt->qp_count = qp_count;
1019 nt->qp_bitmap = qp_bitmap;
1020 nt->qp_bitmap_free = qp_bitmap;
1022 nt->qp_vec = kzalloc_node(qp_count * sizeof(*nt->qp_vec),
1029 for (i = 0; i < qp_count; i++) {
1030 rc = ntb_transport_init_queue(nt, i);
1035 INIT_DELAYED_WORK(&nt->link_work, ntb_transport_link_work);
1036 INIT_WORK(&nt->link_cleanup, ntb_transport_link_cleanup_work);
1038 rc = ntb_set_ctx(ndev, nt, &ntb_transport_ops);
1042 INIT_LIST_HEAD(&nt->client_devs);
1043 rc = ntb_bus_init(nt);
1047 nt->link_is_up = false;
1048 ntb_link_enable(ndev, NTB_SPEED_AUTO, NTB_WIDTH_AUTO);
1049 ntb_link_event(ndev);
1054 ntb_clear_ctx(ndev);
1061 mw = &nt->mw_vec[i];
1069 static void ntb_transport_free(struct ntb_client *self, struct ntb_dev *ndev)
1071 struct ntb_transport_ctx *nt = ndev->ctx;
1072 struct ntb_transport_qp *qp;
1073 u64 qp_bitmap_alloc;
1076 ntb_transport_link_cleanup(nt);
1077 cancel_work_sync(&nt->link_cleanup);
1078 cancel_delayed_work_sync(&nt->link_work);
1080 qp_bitmap_alloc = nt->qp_bitmap & ~nt->qp_bitmap_free;
1082 /* verify that all the qp's are freed */
1083 for (i = 0; i < nt->qp_count; i++) {
1084 qp = &nt->qp_vec[i];
1085 if (qp_bitmap_alloc & BIT_ULL(i))
1086 ntb_transport_free_queue(qp);
1087 debugfs_remove_recursive(qp->debugfs_dir);
1090 ntb_link_disable(ndev);
1091 ntb_clear_ctx(ndev);
1095 for (i = nt->mw_count; i--; ) {
1097 iounmap(nt->mw_vec[i].vbase);
1105 static void ntb_rx_copy_callback(void *data)
1107 struct ntb_queue_entry *entry = data;
1108 struct ntb_transport_qp *qp = entry->qp;
1109 void *cb_data = entry->cb_data;
1110 unsigned int len = entry->len;
1111 struct ntb_payload_header *hdr = entry->rx_hdr;
1115 iowrite32(entry->index, &qp->rx_info->entry);
1117 ntb_list_add(&qp->ntb_rx_free_q_lock, &entry->entry, &qp->rx_free_q);
1119 if (qp->rx_handler && qp->client_ready)
1120 qp->rx_handler(qp, qp->cb_data, cb_data, len);
1123 static void ntb_memcpy_rx(struct ntb_queue_entry *entry, void *offset)
1125 void *buf = entry->buf;
1126 size_t len = entry->len;
1128 memcpy(buf, offset, len);
1130 /* Ensure that the data is fully copied out before clearing the flag */
1133 ntb_rx_copy_callback(entry);
1136 static void ntb_async_rx(struct ntb_queue_entry *entry, void *offset,
1139 struct dma_async_tx_descriptor *txd;
1140 struct ntb_transport_qp *qp = entry->qp;
1141 struct dma_chan *chan = qp->dma_chan;
1142 struct dma_device *device;
1143 size_t pay_off, buff_off;
1144 struct dmaengine_unmap_data *unmap;
1145 dma_cookie_t cookie;
1146 void *buf = entry->buf;
1153 if (len < copy_bytes)
1156 device = chan->device;
1157 pay_off = (size_t)offset & ~PAGE_MASK;
1158 buff_off = (size_t)buf & ~PAGE_MASK;
1160 if (!is_dma_copy_aligned(device, pay_off, buff_off, len))
1163 unmap = dmaengine_get_unmap_data(device->dev, 2, GFP_NOWAIT);
1168 unmap->addr[0] = dma_map_page(device->dev, virt_to_page(offset),
1169 pay_off, len, DMA_TO_DEVICE);
1170 if (dma_mapping_error(device->dev, unmap->addr[0]))
1175 unmap->addr[1] = dma_map_page(device->dev, virt_to_page(buf),
1176 buff_off, len, DMA_FROM_DEVICE);
1177 if (dma_mapping_error(device->dev, unmap->addr[1]))
1180 unmap->from_cnt = 1;
1182 txd = device->device_prep_dma_memcpy(chan, unmap->addr[1],
1183 unmap->addr[0], len,
1184 DMA_PREP_INTERRUPT);
1188 txd->callback = ntb_rx_copy_callback;
1189 txd->callback_param = entry;
1190 dma_set_unmap(txd, unmap);
1192 cookie = dmaengine_submit(txd);
1193 if (dma_submit_error(cookie))
1196 dmaengine_unmap_put(unmap);
1198 qp->last_cookie = cookie;
1205 dmaengine_unmap_put(unmap);
1207 dmaengine_unmap_put(unmap);
1209 /* If the callbacks come out of order, the writing of the index to the
1210 * last completed will be out of order. This may result in the
1211 * receive stalling forever.
1213 dma_sync_wait(chan, qp->last_cookie);
1215 ntb_memcpy_rx(entry, offset);
1219 static int ntb_process_rxc(struct ntb_transport_qp *qp)
1221 struct ntb_payload_header *hdr;
1222 struct ntb_queue_entry *entry;
1226 offset = qp->rx_buff + qp->rx_max_frame * qp->rx_index;
1227 hdr = offset + qp->rx_max_frame - sizeof(struct ntb_payload_header);
1229 dev_dbg(&qp->ndev->pdev->dev, "qp %d: RX ver %u len %d flags %x\n",
1230 qp->qp_num, hdr->ver, hdr->len, hdr->flags);
1232 if (!(hdr->flags & DESC_DONE_FLAG)) {
1233 dev_dbg(&qp->ndev->pdev->dev, "done flag not set\n");
1234 qp->rx_ring_empty++;
1238 if (hdr->flags & LINK_DOWN_FLAG) {
1239 dev_dbg(&qp->ndev->pdev->dev, "link down flag set\n");
1240 ntb_qp_link_down(qp);
1245 if (hdr->ver != (u32)qp->rx_pkts) {
1246 dev_dbg(&qp->ndev->pdev->dev,
1247 "version mismatch, expected %llu - got %u\n",
1248 qp->rx_pkts, hdr->ver);
1253 entry = ntb_list_rm(&qp->ntb_rx_pend_q_lock, &qp->rx_pend_q);
1255 dev_dbg(&qp->ndev->pdev->dev, "no receive buffer\n");
1256 qp->rx_err_no_buf++;
1262 if (hdr->len > entry->len) {
1263 dev_dbg(&qp->ndev->pdev->dev,
1264 "receive buffer overflow! Wanted %d got %d\n",
1265 hdr->len, entry->len);
1272 dev_dbg(&qp->ndev->pdev->dev,
1273 "RX OK index %u ver %u size %d into buf size %d\n",
1274 qp->rx_index, hdr->ver, hdr->len, entry->len);
1276 qp->rx_bytes += hdr->len;
1279 entry->index = qp->rx_index;
1280 entry->rx_hdr = hdr;
1282 ntb_async_rx(entry, offset, hdr->len);
1285 qp->rx_index %= qp->rx_max_entry;
1290 /* FIXME: if this syncrhonous update of the rx_index gets ahead of
1291 * asyncrhonous ntb_rx_copy_callback of previous entry, there are three
1294 * 1) The peer might miss this update, but observe the update
1295 * from the memcpy completion callback. In this case, the buffer will
1296 * not be freed on the peer to be reused for a different packet. The
1297 * successful rx of a later packet would clear the condition, but the
1298 * condition could persist if several rx fail in a row.
1300 * 2) The peer may observe this update before the asyncrhonous copy of
1301 * prior packets is completed. The peer may overwrite the buffers of
1302 * the prior packets before they are copied.
1304 * 3) Both: the peer may observe the update, and then observe the index
1305 * decrement by the asynchronous completion callback. Who knows what
1306 * badness that will cause.
1309 iowrite32(qp->rx_index, &qp->rx_info->entry);
1314 static void ntb_transport_rxc_db(unsigned long data)
1316 struct ntb_transport_qp *qp = (void *)data;
1319 dev_dbg(&qp->ndev->pdev->dev, "%s: doorbell %d received\n",
1320 __func__, qp->qp_num);
1322 /* Limit the number of packets processed in a single interrupt to
1323 * provide fairness to others
1325 for (i = 0; i < qp->rx_max_entry; i++) {
1326 rc = ntb_process_rxc(qp);
1332 dma_async_issue_pending(qp->dma_chan);
1334 if (i == qp->rx_max_entry) {
1335 /* there is more work to do */
1336 tasklet_schedule(&qp->rxc_db_work);
1337 } else if (ntb_db_read(qp->ndev) & BIT_ULL(qp->qp_num)) {
1338 /* the doorbell bit is set: clear it */
1339 ntb_db_clear(qp->ndev, BIT_ULL(qp->qp_num));
1340 /* ntb_db_read ensures ntb_db_clear write is committed */
1341 ntb_db_read(qp->ndev);
1343 /* an interrupt may have arrived between finishing
1344 * ntb_process_rxc and clearing the doorbell bit:
1345 * there might be some more work to do.
1347 tasklet_schedule(&qp->rxc_db_work);
1351 static void ntb_tx_copy_callback(void *data)
1353 struct ntb_queue_entry *entry = data;
1354 struct ntb_transport_qp *qp = entry->qp;
1355 struct ntb_payload_header __iomem *hdr = entry->tx_hdr;
1357 iowrite32(entry->flags | DESC_DONE_FLAG, &hdr->flags);
1359 ntb_peer_db_set(qp->ndev, BIT_ULL(qp->qp_num));
1361 /* The entry length can only be zero if the packet is intended to be a
1362 * "link down" or similar. Since no payload is being sent in these
1363 * cases, there is nothing to add to the completion queue.
1365 if (entry->len > 0) {
1366 qp->tx_bytes += entry->len;
1369 qp->tx_handler(qp, qp->cb_data, entry->cb_data,
1373 ntb_list_add(&qp->ntb_tx_free_q_lock, &entry->entry, &qp->tx_free_q);
1376 static void ntb_memcpy_tx(struct ntb_queue_entry *entry, void __iomem *offset)
1378 memcpy_toio(offset, entry->buf, entry->len);
1380 /* Ensure that the data is fully copied out before setting the flags */
1383 ntb_tx_copy_callback(entry);
1386 static void ntb_async_tx(struct ntb_transport_qp *qp,
1387 struct ntb_queue_entry *entry)
1389 struct ntb_payload_header __iomem *hdr;
1390 struct dma_async_tx_descriptor *txd;
1391 struct dma_chan *chan = qp->dma_chan;
1392 struct dma_device *device;
1393 size_t dest_off, buff_off;
1394 struct dmaengine_unmap_data *unmap;
1396 dma_cookie_t cookie;
1397 void __iomem *offset;
1398 size_t len = entry->len;
1399 void *buf = entry->buf;
1401 offset = qp->tx_mw + qp->tx_max_frame * qp->tx_index;
1402 hdr = offset + qp->tx_max_frame - sizeof(struct ntb_payload_header);
1403 entry->tx_hdr = hdr;
1405 iowrite32(entry->len, &hdr->len);
1406 iowrite32((u32)qp->tx_pkts, &hdr->ver);
1411 if (len < copy_bytes)
1414 device = chan->device;
1415 dest = qp->tx_mw_phys + qp->tx_max_frame * qp->tx_index;
1416 buff_off = (size_t)buf & ~PAGE_MASK;
1417 dest_off = (size_t)dest & ~PAGE_MASK;
1419 if (!is_dma_copy_aligned(device, buff_off, dest_off, len))
1422 unmap = dmaengine_get_unmap_data(device->dev, 1, GFP_NOWAIT);
1427 unmap->addr[0] = dma_map_page(device->dev, virt_to_page(buf),
1428 buff_off, len, DMA_TO_DEVICE);
1429 if (dma_mapping_error(device->dev, unmap->addr[0]))
1434 txd = device->device_prep_dma_memcpy(chan, dest, unmap->addr[0], len,
1435 DMA_PREP_INTERRUPT);
1439 txd->callback = ntb_tx_copy_callback;
1440 txd->callback_param = entry;
1441 dma_set_unmap(txd, unmap);
1443 cookie = dmaengine_submit(txd);
1444 if (dma_submit_error(cookie))
1447 dmaengine_unmap_put(unmap);
1449 dma_async_issue_pending(chan);
1454 dmaengine_unmap_put(unmap);
1456 dmaengine_unmap_put(unmap);
1458 ntb_memcpy_tx(entry, offset);
1462 static int ntb_process_tx(struct ntb_transport_qp *qp,
1463 struct ntb_queue_entry *entry)
1465 if (qp->tx_index == qp->remote_rx_info->entry) {
1470 if (entry->len > qp->tx_max_frame - sizeof(struct ntb_payload_header)) {
1472 qp->tx_handler(qp->cb_data, qp, NULL, -EIO);
1474 ntb_list_add(&qp->ntb_tx_free_q_lock, &entry->entry,
1479 ntb_async_tx(qp, entry);
1482 qp->tx_index %= qp->tx_max_entry;
1489 static void ntb_send_link_down(struct ntb_transport_qp *qp)
1491 struct pci_dev *pdev = qp->ndev->pdev;
1492 struct ntb_queue_entry *entry;
1495 if (!qp->link_is_up)
1498 dev_info(&pdev->dev, "qp %d: Send Link Down\n", qp->qp_num);
1500 for (i = 0; i < NTB_LINK_DOWN_TIMEOUT; i++) {
1501 entry = ntb_list_rm(&qp->ntb_tx_free_q_lock, &qp->tx_free_q);
1510 entry->cb_data = NULL;
1513 entry->flags = LINK_DOWN_FLAG;
1515 rc = ntb_process_tx(qp, entry);
1517 dev_err(&pdev->dev, "ntb: QP%d unable to send linkdown msg\n",
1520 ntb_qp_link_down_reset(qp);
1523 static bool ntb_dma_filter_fn(struct dma_chan *chan, void *node)
1525 return dev_to_node(&chan->dev->device) == (int)(unsigned long)node;
1529 * ntb_transport_create_queue - Create a new NTB transport layer queue
1530 * @rx_handler: receive callback function
1531 * @tx_handler: transmit callback function
1532 * @event_handler: event callback function
1534 * Create a new NTB transport layer queue and provide the queue with a callback
1535 * routine for both transmit and receive. The receive callback routine will be
1536 * used to pass up data when the transport has received it on the queue. The
1537 * transmit callback routine will be called when the transport has completed the
1538 * transmission of the data on the queue and the data is ready to be freed.
1540 * RETURNS: pointer to newly created ntb_queue, NULL on error.
1542 struct ntb_transport_qp *
1543 ntb_transport_create_queue(void *data, struct device *client_dev,
1544 const struct ntb_queue_handlers *handlers)
1546 struct ntb_dev *ndev;
1547 struct pci_dev *pdev;
1548 struct ntb_transport_ctx *nt;
1549 struct ntb_queue_entry *entry;
1550 struct ntb_transport_qp *qp;
1552 unsigned int free_queue;
1553 dma_cap_mask_t dma_mask;
1557 ndev = dev_ntb(client_dev->parent);
1561 node = dev_to_node(&ndev->dev);
1563 free_queue = ffs(nt->qp_bitmap);
1567 /* decrement free_queue to make it zero based */
1570 qp = &nt->qp_vec[free_queue];
1571 qp_bit = BIT_ULL(qp->qp_num);
1573 nt->qp_bitmap_free &= ~qp_bit;
1576 qp->rx_handler = handlers->rx_handler;
1577 qp->tx_handler = handlers->tx_handler;
1578 qp->event_handler = handlers->event_handler;
1580 dma_cap_zero(dma_mask);
1581 dma_cap_set(DMA_MEMCPY, dma_mask);
1583 qp->dma_chan = dma_request_channel(dma_mask, ntb_dma_filter_fn,
1584 (void *)(unsigned long)node);
1586 dev_info(&pdev->dev, "Unable to allocate DMA channel, using CPU instead\n");
1588 for (i = 0; i < NTB_QP_DEF_NUM_ENTRIES; i++) {
1589 entry = kzalloc_node(sizeof(*entry), GFP_ATOMIC, node);
1594 ntb_list_add(&qp->ntb_rx_free_q_lock, &entry->entry,
1598 for (i = 0; i < NTB_QP_DEF_NUM_ENTRIES; i++) {
1599 entry = kzalloc_node(sizeof(*entry), GFP_ATOMIC, node);
1604 ntb_list_add(&qp->ntb_tx_free_q_lock, &entry->entry,
1608 ntb_db_clear(qp->ndev, qp_bit);
1609 ntb_db_clear_mask(qp->ndev, qp_bit);
1611 dev_info(&pdev->dev, "NTB Transport QP %d created\n", qp->qp_num);
1616 while ((entry = ntb_list_rm(&qp->ntb_tx_free_q_lock, &qp->tx_free_q)))
1619 while ((entry = ntb_list_rm(&qp->ntb_rx_free_q_lock, &qp->rx_free_q)))
1622 dma_release_channel(qp->dma_chan);
1623 nt->qp_bitmap_free |= qp_bit;
1627 EXPORT_SYMBOL_GPL(ntb_transport_create_queue);
1630 * ntb_transport_free_queue - Frees NTB transport queue
1631 * @qp: NTB queue to be freed
1633 * Frees NTB transport queue
1635 void ntb_transport_free_queue(struct ntb_transport_qp *qp)
1637 struct ntb_transport_ctx *nt = qp->transport;
1638 struct pci_dev *pdev;
1639 struct ntb_queue_entry *entry;
1645 pdev = qp->ndev->pdev;
1648 struct dma_chan *chan = qp->dma_chan;
1649 /* Putting the dma_chan to NULL will force any new traffic to be
1650 * processed by the CPU instead of the DAM engine
1652 qp->dma_chan = NULL;
1654 /* Try to be nice and wait for any queued DMA engine
1655 * transactions to process before smashing it with a rock
1657 dma_sync_wait(chan, qp->last_cookie);
1658 dmaengine_terminate_all(chan);
1659 dma_release_channel(chan);
1662 qp_bit = BIT_ULL(qp->qp_num);
1664 ntb_db_set_mask(qp->ndev, qp_bit);
1665 tasklet_disable(&qp->rxc_db_work);
1667 cancel_delayed_work_sync(&qp->link_work);
1670 qp->rx_handler = NULL;
1671 qp->tx_handler = NULL;
1672 qp->event_handler = NULL;
1674 while ((entry = ntb_list_rm(&qp->ntb_rx_free_q_lock, &qp->rx_free_q)))
1677 while ((entry = ntb_list_rm(&qp->ntb_rx_pend_q_lock, &qp->rx_pend_q))) {
1678 dev_warn(&pdev->dev, "Freeing item from a non-empty queue\n");
1682 while ((entry = ntb_list_rm(&qp->ntb_tx_free_q_lock, &qp->tx_free_q)))
1685 nt->qp_bitmap_free |= qp_bit;
1687 dev_info(&pdev->dev, "NTB Transport QP %d freed\n", qp->qp_num);
1689 EXPORT_SYMBOL_GPL(ntb_transport_free_queue);
1692 * ntb_transport_rx_remove - Dequeues enqueued rx packet
1693 * @qp: NTB queue to be freed
1694 * @len: pointer to variable to write enqueued buffers length
1696 * Dequeues unused buffers from receive queue. Should only be used during
1699 * RETURNS: NULL error value on error, or void* for success.
1701 void *ntb_transport_rx_remove(struct ntb_transport_qp *qp, unsigned int *len)
1703 struct ntb_queue_entry *entry;
1706 if (!qp || qp->client_ready)
1709 entry = ntb_list_rm(&qp->ntb_rx_pend_q_lock, &qp->rx_pend_q);
1713 buf = entry->cb_data;
1716 ntb_list_add(&qp->ntb_rx_free_q_lock, &entry->entry, &qp->rx_free_q);
1720 EXPORT_SYMBOL_GPL(ntb_transport_rx_remove);
1723 * ntb_transport_rx_enqueue - Enqueue a new NTB queue entry
1724 * @qp: NTB transport layer queue the entry is to be enqueued on
1725 * @cb: per buffer pointer for callback function to use
1726 * @data: pointer to data buffer that incoming packets will be copied into
1727 * @len: length of the data buffer
1729 * Enqueue a new receive buffer onto the transport queue into which a NTB
1730 * payload can be received into.
1732 * RETURNS: An appropriate -ERRNO error value on error, or zero for success.
1734 int ntb_transport_rx_enqueue(struct ntb_transport_qp *qp, void *cb, void *data,
1737 struct ntb_queue_entry *entry;
1742 entry = ntb_list_rm(&qp->ntb_rx_free_q_lock, &qp->rx_free_q);
1746 entry->cb_data = cb;
1750 ntb_list_add(&qp->ntb_rx_pend_q_lock, &entry->entry, &qp->rx_pend_q);
1754 EXPORT_SYMBOL_GPL(ntb_transport_rx_enqueue);
1757 * ntb_transport_tx_enqueue - Enqueue a new NTB queue entry
1758 * @qp: NTB transport layer queue the entry is to be enqueued on
1759 * @cb: per buffer pointer for callback function to use
1760 * @data: pointer to data buffer that will be sent
1761 * @len: length of the data buffer
1763 * Enqueue a new transmit buffer onto the transport queue from which a NTB
1764 * payload will be transmitted. This assumes that a lock is being held to
1765 * serialize access to the qp.
1767 * RETURNS: An appropriate -ERRNO error value on error, or zero for success.
1769 int ntb_transport_tx_enqueue(struct ntb_transport_qp *qp, void *cb, void *data,
1772 struct ntb_queue_entry *entry;
1775 if (!qp || !qp->link_is_up || !len)
1778 entry = ntb_list_rm(&qp->ntb_tx_free_q_lock, &qp->tx_free_q);
1780 qp->tx_err_no_buf++;
1784 entry->cb_data = cb;
1789 rc = ntb_process_tx(qp, entry);
1791 ntb_list_add(&qp->ntb_tx_free_q_lock, &entry->entry,
1796 EXPORT_SYMBOL_GPL(ntb_transport_tx_enqueue);
1799 * ntb_transport_link_up - Notify NTB transport of client readiness to use queue
1800 * @qp: NTB transport layer queue to be enabled
1802 * Notify NTB transport layer of client readiness to use queue
1804 void ntb_transport_link_up(struct ntb_transport_qp *qp)
1809 qp->client_ready = true;
1811 if (qp->transport->link_is_up)
1812 schedule_delayed_work(&qp->link_work, 0);
1814 EXPORT_SYMBOL_GPL(ntb_transport_link_up);
1817 * ntb_transport_link_down - Notify NTB transport to no longer enqueue data
1818 * @qp: NTB transport layer queue to be disabled
1820 * Notify NTB transport layer of client's desire to no longer receive data on
1821 * transport queue specified. It is the client's responsibility to ensure all
1822 * entries on queue are purged or otherwise handled appropriately.
1824 void ntb_transport_link_down(struct ntb_transport_qp *qp)
1826 struct pci_dev *pdev;
1832 pdev = qp->ndev->pdev;
1833 qp->client_ready = false;
1835 val = ntb_spad_read(qp->ndev, QP_LINKS);
1837 ntb_peer_spad_write(qp->ndev, QP_LINKS,
1838 val & ~BIT(qp->qp_num));
1841 ntb_send_link_down(qp);
1843 cancel_delayed_work_sync(&qp->link_work);
1845 EXPORT_SYMBOL_GPL(ntb_transport_link_down);
1848 * ntb_transport_link_query - Query transport link state
1849 * @qp: NTB transport layer queue to be queried
1851 * Query connectivity to the remote system of the NTB transport queue
1853 * RETURNS: true for link up or false for link down
1855 bool ntb_transport_link_query(struct ntb_transport_qp *qp)
1860 return qp->link_is_up;
1862 EXPORT_SYMBOL_GPL(ntb_transport_link_query);
1865 * ntb_transport_qp_num - Query the qp number
1866 * @qp: NTB transport layer queue to be queried
1868 * Query qp number of the NTB transport queue
1870 * RETURNS: a zero based number specifying the qp number
1872 unsigned char ntb_transport_qp_num(struct ntb_transport_qp *qp)
1879 EXPORT_SYMBOL_GPL(ntb_transport_qp_num);
1882 * ntb_transport_max_size - Query the max payload size of a qp
1883 * @qp: NTB transport layer queue to be queried
1885 * Query the maximum payload size permissible on the given qp
1887 * RETURNS: the max payload size of a qp
1889 unsigned int ntb_transport_max_size(struct ntb_transport_qp *qp)
1897 return qp->tx_max_frame - sizeof(struct ntb_payload_header);
1899 /* If DMA engine usage is possible, try to find the max size for that */
1900 max = qp->tx_max_frame - sizeof(struct ntb_payload_header);
1901 max -= max % (1 << qp->dma_chan->device->copy_align);
1905 EXPORT_SYMBOL_GPL(ntb_transport_max_size);
1907 static void ntb_transport_doorbell_callback(void *data, int vector)
1909 struct ntb_transport_ctx *nt = data;
1910 struct ntb_transport_qp *qp;
1912 unsigned int qp_num;
1914 db_bits = (nt->qp_bitmap & ~nt->qp_bitmap_free &
1915 ntb_db_vector_mask(nt->ndev, vector));
1918 qp_num = __ffs(db_bits);
1919 qp = &nt->qp_vec[qp_num];
1921 tasklet_schedule(&qp->rxc_db_work);
1923 db_bits &= ~BIT_ULL(qp_num);
1927 static const struct ntb_ctx_ops ntb_transport_ops = {
1928 .link_event = ntb_transport_event_callback,
1929 .db_event = ntb_transport_doorbell_callback,
1932 static struct ntb_client ntb_transport_client = {
1934 .probe = ntb_transport_probe,
1935 .remove = ntb_transport_free,
1939 static int __init ntb_transport_init(void)
1943 if (debugfs_initialized())
1944 nt_debugfs_dir = debugfs_create_dir(KBUILD_MODNAME, NULL);
1946 rc = bus_register(&ntb_transport_bus);
1950 rc = ntb_register_client(&ntb_transport_client);
1957 bus_unregister(&ntb_transport_bus);
1959 debugfs_remove_recursive(nt_debugfs_dir);
1962 module_init(ntb_transport_init);
1964 static void __exit ntb_transport_exit(void)
1966 debugfs_remove_recursive(nt_debugfs_dir);
1968 ntb_unregister_client(&ntb_transport_client);
1969 bus_unregister(&ntb_transport_bus);
1971 module_exit(ntb_transport_exit);