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.
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of version 2 of the GNU General Public License as
11 * published by the Free Software Foundation.
15 * Copyright(c) 2012 Intel Corporation. All rights reserved.
17 * Redistribution and use in source and binary forms, with or without
18 * modification, are permitted provided that the following conditions
21 * * Redistributions of source code must retain the above copyright
22 * notice, this list of conditions and the following disclaimer.
23 * * Redistributions in binary form must reproduce the above copy
24 * notice, this list of conditions and the following disclaimer in
25 * the documentation and/or other materials provided with the
27 * * Neither the name of Intel Corporation nor the names of its
28 * contributors may be used to endorse or promote products derived
29 * from this software without specific prior written permission.
31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
36 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
37 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
38 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
39 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
40 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
41 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
43 * Intel PCIe NTB Linux driver
45 * Contact Information:
46 * Jon Mason <jon.mason@intel.com>
48 #include <linux/debugfs.h>
49 #include <linux/delay.h>
50 #include <linux/dma-mapping.h>
51 #include <linux/errno.h>
52 #include <linux/export.h>
53 #include <linux/interrupt.h>
54 #include <linux/module.h>
55 #include <linux/pci.h>
56 #include <linux/slab.h>
57 #include <linux/types.h>
58 #include <linux/ntb.h>
61 #define NTB_TRANSPORT_VERSION 2
63 static unsigned int transport_mtu = 0x401E;
64 module_param(transport_mtu, uint, 0644);
65 MODULE_PARM_DESC(transport_mtu, "Maximum size of NTB transport packets");
67 static unsigned char max_num_clients = 2;
68 module_param(max_num_clients, byte, 0644);
69 MODULE_PARM_DESC(max_num_clients, "Maximum number of NTB transport clients");
71 struct ntb_queue_entry {
72 /* ntb_queue list reference */
73 struct list_head entry;
74 /* pointers to data to be transfered */
85 struct ntb_transport_qp {
86 struct ntb_transport *transport;
87 struct ntb_device *ndev;
92 u8 qp_num; /* Only 64 QP's are allowed. 0-63 */
94 struct ntb_rx_info __iomem *rx_info;
95 struct ntb_rx_info *remote_rx_info;
97 void (*tx_handler) (struct ntb_transport_qp *qp, void *qp_data,
99 struct list_head tx_free_q;
100 spinlock_t ntb_tx_free_q_lock;
102 unsigned int tx_index;
103 unsigned int tx_max_entry;
104 unsigned int tx_max_frame;
106 void (*rx_handler) (struct ntb_transport_qp *qp, void *qp_data,
107 void *data, int len);
108 struct tasklet_struct rx_work;
109 struct list_head rx_pend_q;
110 struct list_head rx_free_q;
111 spinlock_t ntb_rx_pend_q_lock;
112 spinlock_t ntb_rx_free_q_lock;
114 unsigned int rx_index;
115 unsigned int rx_max_entry;
116 unsigned int rx_max_frame;
118 void (*event_handler) (void *data, int status);
119 struct delayed_work link_work;
120 struct work_struct link_cleanup;
122 struct dentry *debugfs_dir;
123 struct dentry *debugfs_stats;
137 struct ntb_transport_mw {
143 struct ntb_transport_client_dev {
144 struct list_head entry;
148 struct ntb_transport {
149 struct list_head entry;
150 struct list_head client_devs;
152 struct ntb_device *ndev;
153 struct ntb_transport_mw mw[NTB_NUM_MW];
154 struct ntb_transport_qp *qps;
155 unsigned int max_qps;
156 unsigned long qp_bitmap;
158 struct delayed_work link_work;
159 struct work_struct link_cleanup;
160 struct dentry *debugfs_dir;
164 DESC_DONE_FLAG = 1 << 0,
165 LINK_DOWN_FLAG = 1 << 1,
168 struct ntb_payload_header {
183 #define QP_TO_MW(qp) ((qp) % NTB_NUM_MW)
184 #define NTB_QP_DEF_NUM_ENTRIES 100
185 #define NTB_LINK_DOWN_TIMEOUT 10
187 static int ntb_match_bus(struct device *dev, struct device_driver *drv)
189 return !strncmp(dev_name(dev), drv->name, strlen(drv->name));
192 static int ntb_client_probe(struct device *dev)
194 const struct ntb_client *drv = container_of(dev->driver,
195 struct ntb_client, driver);
196 struct pci_dev *pdev = container_of(dev->parent, struct pci_dev, dev);
200 if (drv && drv->probe)
201 rc = drv->probe(pdev);
208 static int ntb_client_remove(struct device *dev)
210 const struct ntb_client *drv = container_of(dev->driver,
211 struct ntb_client, driver);
212 struct pci_dev *pdev = container_of(dev->parent, struct pci_dev, dev);
214 if (drv && drv->remove)
222 static struct bus_type ntb_bus_type = {
224 .match = ntb_match_bus,
225 .probe = ntb_client_probe,
226 .remove = ntb_client_remove,
229 static LIST_HEAD(ntb_transport_list);
231 static int ntb_bus_init(struct ntb_transport *nt)
233 if (list_empty(&ntb_transport_list)) {
234 int rc = bus_register(&ntb_bus_type);
239 list_add(&nt->entry, &ntb_transport_list);
244 static void ntb_bus_remove(struct ntb_transport *nt)
246 struct ntb_transport_client_dev *client_dev, *cd;
248 list_for_each_entry_safe(client_dev, cd, &nt->client_devs, entry) {
249 dev_err(client_dev->dev.parent, "%s still attached to bus, removing\n",
250 dev_name(&client_dev->dev));
251 list_del(&client_dev->entry);
252 device_unregister(&client_dev->dev);
255 list_del(&nt->entry);
257 if (list_empty(&ntb_transport_list))
258 bus_unregister(&ntb_bus_type);
261 static void ntb_client_release(struct device *dev)
263 struct ntb_transport_client_dev *client_dev;
264 client_dev = container_of(dev, struct ntb_transport_client_dev, dev);
270 * ntb_unregister_client_dev - Unregister NTB client device
271 * @device_name: Name of NTB client device
273 * Unregister an NTB client device with the NTB transport layer
275 void ntb_unregister_client_dev(char *device_name)
277 struct ntb_transport_client_dev *client, *cd;
278 struct ntb_transport *nt;
280 list_for_each_entry(nt, &ntb_transport_list, entry)
281 list_for_each_entry_safe(client, cd, &nt->client_devs, entry)
282 if (!strncmp(dev_name(&client->dev), device_name,
283 strlen(device_name))) {
284 list_del(&client->entry);
285 device_unregister(&client->dev);
288 EXPORT_SYMBOL_GPL(ntb_unregister_client_dev);
291 * ntb_register_client_dev - Register NTB client device
292 * @device_name: Name of NTB client device
294 * Register an NTB client device with the NTB transport layer
296 int ntb_register_client_dev(char *device_name)
298 struct ntb_transport_client_dev *client_dev;
299 struct ntb_transport *nt;
302 if (list_empty(&ntb_transport_list))
305 list_for_each_entry(nt, &ntb_transport_list, entry) {
308 client_dev = kzalloc(sizeof(struct ntb_transport_client_dev),
315 dev = &client_dev->dev;
317 /* setup and register client devices */
318 dev_set_name(dev, "%s", device_name);
319 dev->bus = &ntb_bus_type;
320 dev->release = ntb_client_release;
321 dev->parent = &ntb_query_pdev(nt->ndev)->dev;
323 rc = device_register(dev);
329 list_add_tail(&client_dev->entry, &nt->client_devs);
335 ntb_unregister_client_dev(device_name);
339 EXPORT_SYMBOL_GPL(ntb_register_client_dev);
342 * ntb_register_client - Register NTB client driver
343 * @drv: NTB client driver to be registered
345 * Register an NTB client driver with the NTB transport layer
347 * RETURNS: An appropriate -ERRNO error value on error, or zero for success.
349 int ntb_register_client(struct ntb_client *drv)
351 drv->driver.bus = &ntb_bus_type;
353 if (list_empty(&ntb_transport_list))
356 return driver_register(&drv->driver);
358 EXPORT_SYMBOL_GPL(ntb_register_client);
361 * ntb_unregister_client - Unregister NTB client driver
362 * @drv: NTB client driver to be unregistered
364 * Unregister an NTB client driver with the NTB transport layer
366 * RETURNS: An appropriate -ERRNO error value on error, or zero for success.
368 void ntb_unregister_client(struct ntb_client *drv)
370 driver_unregister(&drv->driver);
372 EXPORT_SYMBOL_GPL(ntb_unregister_client);
374 static ssize_t debugfs_read(struct file *filp, char __user *ubuf, size_t count,
377 struct ntb_transport_qp *qp;
379 ssize_t ret, out_offset, out_count;
383 buf = kmalloc(out_count, GFP_KERNEL);
387 qp = filp->private_data;
389 out_offset += snprintf(buf + out_offset, out_count - out_offset,
391 out_offset += snprintf(buf + out_offset, out_count - out_offset,
392 "rx_bytes - \t%llu\n", qp->rx_bytes);
393 out_offset += snprintf(buf + out_offset, out_count - out_offset,
394 "rx_pkts - \t%llu\n", qp->rx_pkts);
395 out_offset += snprintf(buf + out_offset, out_count - out_offset,
396 "rx_ring_empty - %llu\n", qp->rx_ring_empty);
397 out_offset += snprintf(buf + out_offset, out_count - out_offset,
398 "rx_err_no_buf - %llu\n", qp->rx_err_no_buf);
399 out_offset += snprintf(buf + out_offset, out_count - out_offset,
400 "rx_err_oflow - \t%llu\n", qp->rx_err_oflow);
401 out_offset += snprintf(buf + out_offset, out_count - out_offset,
402 "rx_err_ver - \t%llu\n", qp->rx_err_ver);
403 out_offset += snprintf(buf + out_offset, out_count - out_offset,
404 "rx_buff - \t%p\n", qp->rx_buff);
405 out_offset += snprintf(buf + out_offset, out_count - out_offset,
406 "rx_index - \t%u\n", qp->rx_index);
407 out_offset += snprintf(buf + out_offset, out_count - out_offset,
408 "rx_max_entry - \t%u\n", qp->rx_max_entry);
410 out_offset += snprintf(buf + out_offset, out_count - out_offset,
411 "tx_bytes - \t%llu\n", qp->tx_bytes);
412 out_offset += snprintf(buf + out_offset, out_count - out_offset,
413 "tx_pkts - \t%llu\n", qp->tx_pkts);
414 out_offset += snprintf(buf + out_offset, out_count - out_offset,
415 "tx_ring_full - \t%llu\n", qp->tx_ring_full);
416 out_offset += snprintf(buf + out_offset, out_count - out_offset,
417 "tx_mw - \t%p\n", qp->tx_mw);
418 out_offset += snprintf(buf + out_offset, out_count - out_offset,
419 "tx_index - \t%u\n", qp->tx_index);
420 out_offset += snprintf(buf + out_offset, out_count - out_offset,
421 "tx_max_entry - \t%u\n", qp->tx_max_entry);
423 out_offset += snprintf(buf + out_offset, out_count - out_offset,
424 "\nQP Link %s\n", (qp->qp_link == NTB_LINK_UP) ?
426 if (out_offset > out_count)
427 out_offset = out_count;
429 ret = simple_read_from_buffer(ubuf, count, offp, buf, out_offset);
434 static const struct file_operations ntb_qp_debugfs_stats = {
435 .owner = THIS_MODULE,
437 .read = debugfs_read,
440 static void ntb_list_add(spinlock_t *lock, struct list_head *entry,
441 struct list_head *list)
445 spin_lock_irqsave(lock, flags);
446 list_add_tail(entry, list);
447 spin_unlock_irqrestore(lock, flags);
450 static struct ntb_queue_entry *ntb_list_rm(spinlock_t *lock,
451 struct list_head *list)
453 struct ntb_queue_entry *entry;
456 spin_lock_irqsave(lock, flags);
457 if (list_empty(list)) {
461 entry = list_first_entry(list, struct ntb_queue_entry, entry);
462 list_del(&entry->entry);
464 spin_unlock_irqrestore(lock, flags);
469 static void ntb_transport_setup_qp_mw(struct ntb_transport *nt,
472 struct ntb_transport_qp *qp = &nt->qps[qp_num];
473 unsigned int rx_size, num_qps_mw;
474 u8 mw_num = QP_TO_MW(qp_num);
477 WARN_ON(nt->mw[mw_num].virt_addr == NULL);
479 if (nt->max_qps % NTB_NUM_MW && mw_num < nt->max_qps % NTB_NUM_MW)
480 num_qps_mw = nt->max_qps / NTB_NUM_MW + 1;
482 num_qps_mw = nt->max_qps / NTB_NUM_MW;
484 rx_size = (unsigned int) nt->mw[mw_num].size / num_qps_mw;
485 qp->remote_rx_info = nt->mw[mw_num].virt_addr +
486 (qp_num / NTB_NUM_MW * rx_size);
487 rx_size -= sizeof(struct ntb_rx_info);
489 qp->rx_buff = qp->remote_rx_info + sizeof(struct ntb_rx_info);
490 qp->rx_max_frame = min(transport_mtu, rx_size);
491 qp->rx_max_entry = rx_size / qp->rx_max_frame;
494 qp->remote_rx_info->entry = qp->rx_max_entry;
496 /* setup the hdr offsets with 0's */
497 for (i = 0; i < qp->rx_max_entry; i++) {
498 void *offset = qp->rx_buff + qp->rx_max_frame * (i + 1) -
499 sizeof(struct ntb_payload_header);
500 memset(offset, 0, sizeof(struct ntb_payload_header));
507 static int ntb_set_mw(struct ntb_transport *nt, int num_mw, unsigned int size)
509 struct ntb_transport_mw *mw = &nt->mw[num_mw];
510 struct pci_dev *pdev = ntb_query_pdev(nt->ndev);
512 /* Alloc memory for receiving data. Must be 4k aligned */
513 mw->size = ALIGN(size, 4096);
515 mw->virt_addr = dma_alloc_coherent(&pdev->dev, mw->size, &mw->dma_addr,
517 if (!mw->virt_addr) {
518 dev_err(&pdev->dev, "Unable to allocate MW buffer of size %d\n",
523 /* Notify HW the memory location of the receive buffer */
524 ntb_set_mw_addr(nt->ndev, num_mw, mw->dma_addr);
529 static void ntb_qp_link_cleanup(struct work_struct *work)
531 struct ntb_transport_qp *qp = container_of(work,
532 struct ntb_transport_qp,
534 struct ntb_transport *nt = qp->transport;
535 struct pci_dev *pdev = ntb_query_pdev(nt->ndev);
537 if (qp->qp_link == NTB_LINK_DOWN) {
538 cancel_delayed_work_sync(&qp->link_work);
542 if (qp->event_handler)
543 qp->event_handler(qp->cb_data, NTB_LINK_DOWN);
545 dev_info(&pdev->dev, "qp %d: Link Down\n", qp->qp_num);
546 qp->qp_link = NTB_LINK_DOWN;
548 if (nt->transport_link == NTB_LINK_UP)
549 schedule_delayed_work(&qp->link_work,
550 msecs_to_jiffies(NTB_LINK_DOWN_TIMEOUT));
553 static void ntb_qp_link_down(struct ntb_transport_qp *qp)
555 schedule_work(&qp->link_cleanup);
558 static void ntb_transport_link_cleanup(struct work_struct *work)
560 struct ntb_transport *nt = container_of(work, struct ntb_transport,
564 if (nt->transport_link == NTB_LINK_DOWN)
565 cancel_delayed_work_sync(&nt->link_work);
567 nt->transport_link = NTB_LINK_DOWN;
569 /* Pass along the info to any clients */
570 for (i = 0; i < nt->max_qps; i++)
571 if (!test_bit(i, &nt->qp_bitmap))
572 ntb_qp_link_down(&nt->qps[i]);
574 /* The scratchpad registers keep the values if the remote side
575 * goes down, blast them now to give them a sane value the next
576 * time they are accessed
578 for (i = 0; i < MAX_SPAD; i++)
579 ntb_write_local_spad(nt->ndev, i, 0);
582 static void ntb_transport_event_callback(void *data, enum ntb_hw_event event)
584 struct ntb_transport *nt = data;
587 case NTB_EVENT_HW_LINK_UP:
588 schedule_delayed_work(&nt->link_work, 0);
590 case NTB_EVENT_HW_LINK_DOWN:
591 schedule_work(&nt->link_cleanup);
598 static void ntb_transport_link_work(struct work_struct *work)
600 struct ntb_transport *nt = container_of(work, struct ntb_transport,
602 struct ntb_device *ndev = nt->ndev;
603 struct pci_dev *pdev = ntb_query_pdev(ndev);
607 /* send the local info */
608 rc = ntb_write_remote_spad(ndev, VERSION, NTB_TRANSPORT_VERSION);
610 dev_err(&pdev->dev, "Error writing %x to remote spad %d\n",
615 rc = ntb_write_remote_spad(ndev, MW0_SZ, ntb_get_mw_size(ndev, 0));
617 dev_err(&pdev->dev, "Error writing %x to remote spad %d\n",
618 (u32) ntb_get_mw_size(ndev, 0), MW0_SZ);
622 rc = ntb_write_remote_spad(ndev, MW1_SZ, ntb_get_mw_size(ndev, 1));
624 dev_err(&pdev->dev, "Error writing %x to remote spad %d\n",
625 (u32) ntb_get_mw_size(ndev, 1), MW1_SZ);
629 rc = ntb_write_remote_spad(ndev, NUM_QPS, nt->max_qps);
631 dev_err(&pdev->dev, "Error writing %x to remote spad %d\n",
632 nt->max_qps, NUM_QPS);
636 rc = ntb_read_local_spad(nt->ndev, QP_LINKS, &val);
638 dev_err(&pdev->dev, "Error reading spad %d\n", QP_LINKS);
642 rc = ntb_write_remote_spad(ndev, QP_LINKS, val);
644 dev_err(&pdev->dev, "Error writing %x to remote spad %d\n",
649 /* Query the remote side for its info */
650 rc = ntb_read_remote_spad(ndev, VERSION, &val);
652 dev_err(&pdev->dev, "Error reading remote spad %d\n", VERSION);
656 if (val != NTB_TRANSPORT_VERSION)
658 dev_dbg(&pdev->dev, "Remote version = %d\n", val);
660 rc = ntb_read_remote_spad(ndev, NUM_QPS, &val);
662 dev_err(&pdev->dev, "Error reading remote spad %d\n", NUM_QPS);
666 if (val != nt->max_qps)
668 dev_dbg(&pdev->dev, "Remote max number of qps = %d\n", val);
670 rc = ntb_read_remote_spad(ndev, MW0_SZ, &val);
672 dev_err(&pdev->dev, "Error reading remote spad %d\n", MW0_SZ);
678 dev_dbg(&pdev->dev, "Remote MW0 size = %d\n", val);
680 rc = ntb_set_mw(nt, 0, val);
684 rc = ntb_read_remote_spad(ndev, MW1_SZ, &val);
686 dev_err(&pdev->dev, "Error reading remote spad %d\n", MW1_SZ);
692 dev_dbg(&pdev->dev, "Remote MW1 size = %d\n", val);
694 rc = ntb_set_mw(nt, 1, val);
698 nt->transport_link = NTB_LINK_UP;
700 for (i = 0; i < nt->max_qps; i++) {
701 struct ntb_transport_qp *qp = &nt->qps[i];
703 ntb_transport_setup_qp_mw(nt, i);
705 if (qp->client_ready == NTB_LINK_UP)
706 schedule_delayed_work(&qp->link_work, 0);
712 if (ntb_hw_link_status(ndev))
713 schedule_delayed_work(&nt->link_work,
714 msecs_to_jiffies(NTB_LINK_DOWN_TIMEOUT));
717 static void ntb_qp_link_work(struct work_struct *work)
719 struct ntb_transport_qp *qp = container_of(work,
720 struct ntb_transport_qp,
722 struct pci_dev *pdev = ntb_query_pdev(qp->ndev);
723 struct ntb_transport *nt = qp->transport;
726 WARN_ON(nt->transport_link != NTB_LINK_UP);
728 rc = ntb_read_local_spad(nt->ndev, QP_LINKS, &val);
730 dev_err(&pdev->dev, "Error reading spad %d\n", QP_LINKS);
734 rc = ntb_write_remote_spad(nt->ndev, QP_LINKS, val | 1 << qp->qp_num);
736 dev_err(&pdev->dev, "Error writing %x to remote spad %d\n",
737 val | 1 << qp->qp_num, QP_LINKS);
739 /* query remote spad for qp ready bits */
740 rc = ntb_read_remote_spad(nt->ndev, QP_LINKS, &val);
742 dev_err(&pdev->dev, "Error reading remote spad %d\n", QP_LINKS);
744 dev_dbg(&pdev->dev, "Remote QP link status = %x\n", val);
746 /* See if the remote side is up */
747 if (1 << qp->qp_num & val) {
748 qp->qp_link = NTB_LINK_UP;
750 dev_info(&pdev->dev, "qp %d: Link Up\n", qp->qp_num);
751 if (qp->event_handler)
752 qp->event_handler(qp->cb_data, NTB_LINK_UP);
753 } else if (nt->transport_link == NTB_LINK_UP)
754 schedule_delayed_work(&qp->link_work,
755 msecs_to_jiffies(NTB_LINK_DOWN_TIMEOUT));
758 static void ntb_transport_init_queue(struct ntb_transport *nt,
761 struct ntb_transport_qp *qp;
762 unsigned int num_qps_mw, tx_size;
763 u8 mw_num = QP_TO_MW(qp_num);
765 qp = &nt->qps[qp_num];
769 qp->qp_link = NTB_LINK_DOWN;
770 qp->client_ready = NTB_LINK_DOWN;
771 qp->event_handler = NULL;
773 if (nt->max_qps % NTB_NUM_MW && mw_num < nt->max_qps % NTB_NUM_MW)
774 num_qps_mw = nt->max_qps / NTB_NUM_MW + 1;
776 num_qps_mw = nt->max_qps / NTB_NUM_MW;
778 tx_size = (unsigned int) ntb_get_mw_size(qp->ndev, mw_num) / num_qps_mw;
779 qp->rx_info = ntb_get_mw_vbase(nt->ndev, mw_num) +
780 (qp_num / NTB_NUM_MW * tx_size);
781 tx_size -= sizeof(struct ntb_rx_info);
783 qp->tx_mw = qp->rx_info + sizeof(struct ntb_rx_info);
784 qp->tx_max_frame = min(transport_mtu, tx_size);
785 qp->tx_max_entry = tx_size / qp->tx_max_frame;
788 if (nt->debugfs_dir) {
789 char debugfs_name[4];
791 snprintf(debugfs_name, 4, "qp%d", qp_num);
792 qp->debugfs_dir = debugfs_create_dir(debugfs_name,
795 qp->debugfs_stats = debugfs_create_file("stats", S_IRUSR,
797 &ntb_qp_debugfs_stats);
800 INIT_DELAYED_WORK(&qp->link_work, ntb_qp_link_work);
801 INIT_WORK(&qp->link_cleanup, ntb_qp_link_cleanup);
803 spin_lock_init(&qp->ntb_rx_pend_q_lock);
804 spin_lock_init(&qp->ntb_rx_free_q_lock);
805 spin_lock_init(&qp->ntb_tx_free_q_lock);
807 INIT_LIST_HEAD(&qp->rx_pend_q);
808 INIT_LIST_HEAD(&qp->rx_free_q);
809 INIT_LIST_HEAD(&qp->tx_free_q);
812 int ntb_transport_init(struct pci_dev *pdev)
814 struct ntb_transport *nt;
817 nt = kzalloc(sizeof(struct ntb_transport), GFP_KERNEL);
821 if (debugfs_initialized())
822 nt->debugfs_dir = debugfs_create_dir(KBUILD_MODNAME, NULL);
824 nt->debugfs_dir = NULL;
826 nt->ndev = ntb_register_transport(pdev, nt);
832 nt->max_qps = min(nt->ndev->max_cbs, max_num_clients);
834 nt->qps = kcalloc(nt->max_qps, sizeof(struct ntb_transport_qp),
841 nt->qp_bitmap = ((u64) 1 << nt->max_qps) - 1;
843 for (i = 0; i < nt->max_qps; i++)
844 ntb_transport_init_queue(nt, i);
846 INIT_DELAYED_WORK(&nt->link_work, ntb_transport_link_work);
847 INIT_WORK(&nt->link_cleanup, ntb_transport_link_cleanup);
849 rc = ntb_register_event_callback(nt->ndev,
850 ntb_transport_event_callback);
854 INIT_LIST_HEAD(&nt->client_devs);
855 rc = ntb_bus_init(nt);
859 if (ntb_hw_link_status(nt->ndev))
860 schedule_delayed_work(&nt->link_work, 0);
865 ntb_unregister_event_callback(nt->ndev);
869 ntb_unregister_transport(nt->ndev);
871 debugfs_remove_recursive(nt->debugfs_dir);
876 void ntb_transport_free(void *transport)
878 struct ntb_transport *nt = transport;
879 struct pci_dev *pdev;
882 nt->transport_link = NTB_LINK_DOWN;
884 /* verify that all the qp's are freed */
885 for (i = 0; i < nt->max_qps; i++)
886 if (!test_bit(i, &nt->qp_bitmap))
887 ntb_transport_free_queue(&nt->qps[i]);
891 cancel_delayed_work_sync(&nt->link_work);
893 debugfs_remove_recursive(nt->debugfs_dir);
895 ntb_unregister_event_callback(nt->ndev);
897 pdev = ntb_query_pdev(nt->ndev);
899 for (i = 0; i < NTB_NUM_MW; i++)
900 if (nt->mw[i].virt_addr)
901 dma_free_coherent(&pdev->dev, nt->mw[i].size,
906 ntb_unregister_transport(nt->ndev);
910 static void ntb_rx_copy_task(struct ntb_transport_qp *qp,
911 struct ntb_queue_entry *entry, void *offset)
913 void *cb_data = entry->cb_data;
914 unsigned int len = entry->len;
916 memcpy(entry->buf, offset, entry->len);
918 ntb_list_add(&qp->ntb_rx_free_q_lock, &entry->entry, &qp->rx_free_q);
920 if (qp->rx_handler && qp->client_ready == NTB_LINK_UP)
921 qp->rx_handler(qp, qp->cb_data, cb_data, len);
924 static int ntb_process_rxc(struct ntb_transport_qp *qp)
926 struct ntb_payload_header *hdr;
927 struct ntb_queue_entry *entry;
930 offset = qp->rx_buff + qp->rx_max_frame * qp->rx_index;
931 hdr = offset + qp->rx_max_frame - sizeof(struct ntb_payload_header);
933 entry = ntb_list_rm(&qp->ntb_rx_pend_q_lock, &qp->rx_pend_q);
935 dev_dbg(&ntb_query_pdev(qp->ndev)->dev,
936 "no buffer - HDR ver %u, len %d, flags %x\n",
937 hdr->ver, hdr->len, hdr->flags);
942 if (!(hdr->flags & DESC_DONE_FLAG)) {
943 ntb_list_add(&qp->ntb_rx_pend_q_lock, &entry->entry,
949 if (hdr->ver != (u32) qp->rx_pkts) {
950 dev_dbg(&ntb_query_pdev(qp->ndev)->dev,
951 "qp %d: version mismatch, expected %llu - got %u\n",
952 qp->qp_num, qp->rx_pkts, hdr->ver);
953 ntb_list_add(&qp->ntb_rx_pend_q_lock, &entry->entry,
959 if (hdr->flags & LINK_DOWN_FLAG) {
960 ntb_qp_link_down(qp);
962 ntb_list_add(&qp->ntb_rx_pend_q_lock, &entry->entry,
967 dev_dbg(&ntb_query_pdev(qp->ndev)->dev,
968 "rx offset %u, ver %u - %d payload received, buf size %d\n",
969 qp->rx_index, hdr->ver, hdr->len, entry->len);
971 if (hdr->len <= entry->len) {
972 entry->len = hdr->len;
973 ntb_rx_copy_task(qp, entry, offset);
975 ntb_list_add(&qp->ntb_rx_pend_q_lock, &entry->entry,
979 dev_dbg(&ntb_query_pdev(qp->ndev)->dev,
980 "RX overflow! Wanted %d got %d\n",
981 hdr->len, entry->len);
984 qp->rx_bytes += hdr->len;
988 /* Ensure that the data is fully copied out before clearing the flag */
991 iowrite32(qp->rx_index, &qp->rx_info->entry);
994 qp->rx_index %= qp->rx_max_entry;
999 static void ntb_transport_rx(unsigned long data)
1001 struct ntb_transport_qp *qp = (struct ntb_transport_qp *)data;
1005 rc = ntb_process_rxc(qp);
1009 static void ntb_transport_rxc_db(void *data, int db_num)
1011 struct ntb_transport_qp *qp = data;
1013 dev_dbg(&ntb_query_pdev(qp->ndev)->dev, "%s: doorbell %d received\n",
1016 tasklet_schedule(&qp->rx_work);
1019 static void ntb_tx_copy_task(struct ntb_transport_qp *qp,
1020 struct ntb_queue_entry *entry,
1021 void __iomem *offset)
1023 struct ntb_payload_header __iomem *hdr;
1025 memcpy_toio(offset, entry->buf, entry->len);
1027 hdr = offset + qp->tx_max_frame - sizeof(struct ntb_payload_header);
1028 iowrite32(entry->len, &hdr->len);
1029 iowrite32((u32) qp->tx_pkts, &hdr->ver);
1031 /* Ensure that the data is fully copied out before setting the flag */
1033 iowrite32(entry->flags | DESC_DONE_FLAG, &hdr->flags);
1035 ntb_ring_sdb(qp->ndev, qp->qp_num);
1037 /* The entry length can only be zero if the packet is intended to be a
1038 * "link down" or similar. Since no payload is being sent in these
1039 * cases, there is nothing to add to the completion queue.
1041 if (entry->len > 0) {
1042 qp->tx_bytes += entry->len;
1045 qp->tx_handler(qp, qp->cb_data, entry->cb_data,
1049 ntb_list_add(&qp->ntb_tx_free_q_lock, &entry->entry, &qp->tx_free_q);
1052 static int ntb_process_tx(struct ntb_transport_qp *qp,
1053 struct ntb_queue_entry *entry)
1055 void __iomem *offset;
1057 offset = qp->tx_mw + qp->tx_max_frame * qp->tx_index;
1059 dev_dbg(&ntb_query_pdev(qp->ndev)->dev, "%lld - offset %p, tx %u, entry len %d flags %x buff %p\n",
1060 qp->tx_pkts, offset, qp->tx_index, entry->len, entry->flags,
1062 if (qp->tx_index == qp->remote_rx_info->entry) {
1067 if (entry->len > qp->tx_max_frame - sizeof(struct ntb_payload_header)) {
1069 qp->tx_handler(qp->cb_data, qp, NULL, -EIO);
1071 ntb_list_add(&qp->ntb_tx_free_q_lock, &entry->entry,
1076 ntb_tx_copy_task(qp, entry, offset);
1079 qp->tx_index %= qp->tx_max_entry;
1086 static void ntb_send_link_down(struct ntb_transport_qp *qp)
1088 struct pci_dev *pdev = ntb_query_pdev(qp->ndev);
1089 struct ntb_queue_entry *entry;
1092 if (qp->qp_link == NTB_LINK_DOWN)
1095 qp->qp_link = NTB_LINK_DOWN;
1096 dev_info(&pdev->dev, "qp %d: Link Down\n", qp->qp_num);
1098 for (i = 0; i < NTB_LINK_DOWN_TIMEOUT; i++) {
1099 entry = ntb_list_rm(&qp->ntb_tx_free_q_lock, &qp->tx_free_q);
1108 entry->cb_data = NULL;
1111 entry->flags = LINK_DOWN_FLAG;
1113 rc = ntb_process_tx(qp, entry);
1115 dev_err(&pdev->dev, "ntb: QP%d unable to send linkdown msg\n",
1120 * ntb_transport_create_queue - Create a new NTB transport layer queue
1121 * @rx_handler: receive callback function
1122 * @tx_handler: transmit callback function
1123 * @event_handler: event callback function
1125 * Create a new NTB transport layer queue and provide the queue with a callback
1126 * routine for both transmit and receive. The receive callback routine will be
1127 * used to pass up data when the transport has received it on the queue. The
1128 * transmit callback routine will be called when the transport has completed the
1129 * transmission of the data on the queue and the data is ready to be freed.
1131 * RETURNS: pointer to newly created ntb_queue, NULL on error.
1133 struct ntb_transport_qp *
1134 ntb_transport_create_queue(void *data, struct pci_dev *pdev,
1135 const struct ntb_queue_handlers *handlers)
1137 struct ntb_queue_entry *entry;
1138 struct ntb_transport_qp *qp;
1139 struct ntb_transport *nt;
1140 unsigned int free_queue;
1143 nt = ntb_find_transport(pdev);
1147 free_queue = ffs(nt->qp_bitmap);
1151 /* decrement free_queue to make it zero based */
1154 clear_bit(free_queue, &nt->qp_bitmap);
1156 qp = &nt->qps[free_queue];
1158 qp->rx_handler = handlers->rx_handler;
1159 qp->tx_handler = handlers->tx_handler;
1160 qp->event_handler = handlers->event_handler;
1162 for (i = 0; i < NTB_QP_DEF_NUM_ENTRIES; i++) {
1163 entry = kzalloc(sizeof(struct ntb_queue_entry), GFP_ATOMIC);
1167 ntb_list_add(&qp->ntb_rx_free_q_lock, &entry->entry,
1171 for (i = 0; i < NTB_QP_DEF_NUM_ENTRIES; i++) {
1172 entry = kzalloc(sizeof(struct ntb_queue_entry), GFP_ATOMIC);
1176 ntb_list_add(&qp->ntb_tx_free_q_lock, &entry->entry,
1180 tasklet_init(&qp->rx_work, ntb_transport_rx, (unsigned long) qp);
1182 rc = ntb_register_db_callback(qp->ndev, free_queue, qp,
1183 ntb_transport_rxc_db);
1187 dev_info(&pdev->dev, "NTB Transport QP %d created\n", qp->qp_num);
1192 tasklet_disable(&qp->rx_work);
1194 while ((entry = ntb_list_rm(&qp->ntb_tx_free_q_lock, &qp->tx_free_q)))
1197 while ((entry = ntb_list_rm(&qp->ntb_rx_free_q_lock, &qp->rx_free_q)))
1199 set_bit(free_queue, &nt->qp_bitmap);
1203 EXPORT_SYMBOL_GPL(ntb_transport_create_queue);
1206 * ntb_transport_free_queue - Frees NTB transport queue
1207 * @qp: NTB queue to be freed
1209 * Frees NTB transport queue
1211 void ntb_transport_free_queue(struct ntb_transport_qp *qp)
1213 struct pci_dev *pdev = ntb_query_pdev(qp->ndev);
1214 struct ntb_queue_entry *entry;
1219 cancel_delayed_work_sync(&qp->link_work);
1221 ntb_unregister_db_callback(qp->ndev, qp->qp_num);
1222 tasklet_disable(&qp->rx_work);
1224 while ((entry = ntb_list_rm(&qp->ntb_rx_free_q_lock, &qp->rx_free_q)))
1227 while ((entry = ntb_list_rm(&qp->ntb_rx_pend_q_lock, &qp->rx_pend_q))) {
1228 dev_warn(&pdev->dev, "Freeing item from a non-empty queue\n");
1232 while ((entry = ntb_list_rm(&qp->ntb_tx_free_q_lock, &qp->tx_free_q)))
1235 set_bit(qp->qp_num, &qp->transport->qp_bitmap);
1237 dev_info(&pdev->dev, "NTB Transport QP %d freed\n", qp->qp_num);
1239 EXPORT_SYMBOL_GPL(ntb_transport_free_queue);
1242 * ntb_transport_rx_remove - Dequeues enqueued rx packet
1243 * @qp: NTB queue to be freed
1244 * @len: pointer to variable to write enqueued buffers length
1246 * Dequeues unused buffers from receive queue. Should only be used during
1249 * RETURNS: NULL error value on error, or void* for success.
1251 void *ntb_transport_rx_remove(struct ntb_transport_qp *qp, unsigned int *len)
1253 struct ntb_queue_entry *entry;
1256 if (!qp || qp->client_ready == NTB_LINK_UP)
1259 entry = ntb_list_rm(&qp->ntb_rx_pend_q_lock, &qp->rx_pend_q);
1263 buf = entry->cb_data;
1266 ntb_list_add(&qp->ntb_rx_free_q_lock, &entry->entry, &qp->rx_free_q);
1270 EXPORT_SYMBOL_GPL(ntb_transport_rx_remove);
1273 * ntb_transport_rx_enqueue - Enqueue a new NTB queue entry
1274 * @qp: NTB transport layer queue the entry is to be enqueued on
1275 * @cb: per buffer pointer for callback function to use
1276 * @data: pointer to data buffer that incoming packets will be copied into
1277 * @len: length of the data buffer
1279 * Enqueue a new receive buffer onto the transport queue into which a NTB
1280 * payload can be received into.
1282 * RETURNS: An appropriate -ERRNO error value on error, or zero for success.
1284 int ntb_transport_rx_enqueue(struct ntb_transport_qp *qp, void *cb, void *data,
1287 struct ntb_queue_entry *entry;
1292 entry = ntb_list_rm(&qp->ntb_rx_free_q_lock, &qp->rx_free_q);
1296 entry->cb_data = cb;
1300 ntb_list_add(&qp->ntb_rx_pend_q_lock, &entry->entry, &qp->rx_pend_q);
1304 EXPORT_SYMBOL_GPL(ntb_transport_rx_enqueue);
1307 * ntb_transport_tx_enqueue - Enqueue a new NTB queue entry
1308 * @qp: NTB transport layer queue the entry is to be enqueued on
1309 * @cb: per buffer pointer for callback function to use
1310 * @data: pointer to data buffer that will be sent
1311 * @len: length of the data buffer
1313 * Enqueue a new transmit buffer onto the transport queue from which a NTB
1314 * payload will be transmitted. This assumes that a lock is behing held to
1315 * serialize access to the qp.
1317 * RETURNS: An appropriate -ERRNO error value on error, or zero for success.
1319 int ntb_transport_tx_enqueue(struct ntb_transport_qp *qp, void *cb, void *data,
1322 struct ntb_queue_entry *entry;
1325 if (!qp || qp->qp_link != NTB_LINK_UP || !len)
1328 entry = ntb_list_rm(&qp->ntb_tx_free_q_lock, &qp->tx_free_q);
1332 entry->cb_data = cb;
1337 rc = ntb_process_tx(qp, entry);
1339 ntb_list_add(&qp->ntb_tx_free_q_lock, &entry->entry,
1344 EXPORT_SYMBOL_GPL(ntb_transport_tx_enqueue);
1347 * ntb_transport_link_up - Notify NTB transport of client readiness to use queue
1348 * @qp: NTB transport layer queue to be enabled
1350 * Notify NTB transport layer of client readiness to use queue
1352 void ntb_transport_link_up(struct ntb_transport_qp *qp)
1357 qp->client_ready = NTB_LINK_UP;
1359 if (qp->transport->transport_link == NTB_LINK_UP)
1360 schedule_delayed_work(&qp->link_work, 0);
1362 EXPORT_SYMBOL_GPL(ntb_transport_link_up);
1365 * ntb_transport_link_down - Notify NTB transport to no longer enqueue data
1366 * @qp: NTB transport layer queue to be disabled
1368 * Notify NTB transport layer of client's desire to no longer receive data on
1369 * transport queue specified. It is the client's responsibility to ensure all
1370 * entries on queue are purged or otherwise handled appropraitely.
1372 void ntb_transport_link_down(struct ntb_transport_qp *qp)
1374 struct pci_dev *pdev = ntb_query_pdev(qp->ndev);
1380 qp->client_ready = NTB_LINK_DOWN;
1382 rc = ntb_read_local_spad(qp->ndev, QP_LINKS, &val);
1384 dev_err(&pdev->dev, "Error reading spad %d\n", QP_LINKS);
1388 rc = ntb_write_remote_spad(qp->ndev, QP_LINKS,
1389 val & ~(1 << qp->qp_num));
1391 dev_err(&pdev->dev, "Error writing %x to remote spad %d\n",
1392 val & ~(1 << qp->qp_num), QP_LINKS);
1394 if (qp->qp_link == NTB_LINK_UP)
1395 ntb_send_link_down(qp);
1397 cancel_delayed_work_sync(&qp->link_work);
1399 EXPORT_SYMBOL_GPL(ntb_transport_link_down);
1402 * ntb_transport_link_query - Query transport link state
1403 * @qp: NTB transport layer queue to be queried
1405 * Query connectivity to the remote system of the NTB transport queue
1407 * RETURNS: true for link up or false for link down
1409 bool ntb_transport_link_query(struct ntb_transport_qp *qp)
1411 return qp->qp_link == NTB_LINK_UP;
1413 EXPORT_SYMBOL_GPL(ntb_transport_link_query);
1416 * ntb_transport_qp_num - Query the qp number
1417 * @qp: NTB transport layer queue to be queried
1419 * Query qp number of the NTB transport queue
1421 * RETURNS: a zero based number specifying the qp number
1423 unsigned char ntb_transport_qp_num(struct ntb_transport_qp *qp)
1427 EXPORT_SYMBOL_GPL(ntb_transport_qp_num);
1430 * ntb_transport_max_size - Query the max payload size of a qp
1431 * @qp: NTB transport layer queue to be queried
1433 * Query the maximum payload size permissible on the given qp
1435 * RETURNS: the max payload size of a qp
1437 unsigned int ntb_transport_max_size(struct ntb_transport_qp *qp)
1439 return qp->tx_max_frame - sizeof(struct ntb_payload_header);
1441 EXPORT_SYMBOL_GPL(ntb_transport_max_size);