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/uaccess.h>
62 #include "linux/ntb.h"
63 #include "linux/ntb_transport.h"
65 #define NTB_TRANSPORT_VERSION 4
66 #define NTB_TRANSPORT_VER "4"
67 #define NTB_TRANSPORT_NAME "ntb_transport"
68 #define NTB_TRANSPORT_DESC "Software Queue-Pair Transport over NTB"
70 MODULE_DESCRIPTION(NTB_TRANSPORT_DESC
);
71 MODULE_VERSION(NTB_TRANSPORT_VER
);
72 MODULE_LICENSE("Dual BSD/GPL");
73 MODULE_AUTHOR("Intel Corporation");
75 static unsigned long max_mw_size
;
76 module_param(max_mw_size
, ulong
, 0644);
77 MODULE_PARM_DESC(max_mw_size
, "Limit size of large memory windows");
79 static unsigned int transport_mtu
= 0x10000;
80 module_param(transport_mtu
, uint
, 0644);
81 MODULE_PARM_DESC(transport_mtu
, "Maximum size of NTB transport packets");
83 static unsigned char max_num_clients
;
84 module_param(max_num_clients
, byte
, 0644);
85 MODULE_PARM_DESC(max_num_clients
, "Maximum number of NTB transport clients");
87 static unsigned int copy_bytes
= 1024;
88 module_param(copy_bytes
, uint
, 0644);
89 MODULE_PARM_DESC(copy_bytes
, "Threshold under which NTB will use the CPU to copy instead of DMA");
92 module_param(use_dma
, bool, 0644);
93 MODULE_PARM_DESC(use_dma
, "Use DMA engine to perform large data copy");
95 static struct dentry
*nt_debugfs_dir
;
97 struct ntb_queue_entry
{
98 /* ntb_queue list reference */
99 struct list_head entry
;
100 /* pointers to data to be transferred */
106 struct ntb_transport_qp
*qp
;
108 struct ntb_payload_header __iomem
*tx_hdr
;
109 struct ntb_payload_header
*rx_hdr
;
118 struct ntb_transport_qp
{
119 struct ntb_transport_ctx
*transport
;
120 struct ntb_dev
*ndev
;
122 struct dma_chan
*dma_chan
;
127 u8 qp_num
; /* Only 64 QP's are allowed. 0-63 */
130 struct ntb_rx_info __iomem
*rx_info
;
131 struct ntb_rx_info
*remote_rx_info
;
133 void (*tx_handler
)(struct ntb_transport_qp
*qp
, void *qp_data
,
134 void *data
, int len
);
135 struct list_head tx_free_q
;
136 spinlock_t ntb_tx_free_q_lock
;
138 dma_addr_t tx_mw_phys
;
139 unsigned int tx_index
;
140 unsigned int tx_max_entry
;
141 unsigned int tx_max_frame
;
143 void (*rx_handler
)(struct ntb_transport_qp
*qp
, void *qp_data
,
144 void *data
, int len
);
145 struct list_head rx_post_q
;
146 struct list_head rx_pend_q
;
147 struct list_head rx_free_q
;
148 /* ntb_rx_q_lock: synchronize access to rx_XXXX_q */
149 spinlock_t ntb_rx_q_lock
;
151 unsigned int rx_index
;
152 unsigned int rx_max_entry
;
153 unsigned int rx_max_frame
;
154 dma_cookie_t last_cookie
;
155 struct tasklet_struct rxc_db_work
;
157 void (*event_handler
)(void *data
, int status
);
158 struct delayed_work link_work
;
159 struct work_struct link_cleanup
;
161 struct dentry
*debugfs_dir
;
162 struct dentry
*debugfs_stats
;
181 struct ntb_transport_mw
{
182 phys_addr_t phys_addr
;
183 resource_size_t phys_size
;
184 resource_size_t xlat_align
;
185 resource_size_t xlat_align_size
;
193 struct ntb_transport_client_dev
{
194 struct list_head entry
;
195 struct ntb_transport_ctx
*nt
;
199 struct ntb_transport_ctx
{
200 struct list_head entry
;
201 struct list_head client_devs
;
203 struct ntb_dev
*ndev
;
205 struct ntb_transport_mw
*mw_vec
;
206 struct ntb_transport_qp
*qp_vec
;
207 unsigned int mw_count
;
208 unsigned int qp_count
;
213 struct delayed_work link_work
;
214 struct work_struct link_cleanup
;
216 struct dentry
*debugfs_node_dir
;
220 DESC_DONE_FLAG
= BIT(0),
221 LINK_DOWN_FLAG
= BIT(1),
224 struct ntb_payload_header
{
242 #define dev_client_dev(__dev) \
243 container_of((__dev), struct ntb_transport_client_dev, dev)
245 #define drv_client(__drv) \
246 container_of((__drv), struct ntb_transport_client, driver)
248 #define QP_TO_MW(nt, qp) ((qp) % nt->mw_count)
249 #define NTB_QP_DEF_NUM_ENTRIES 100
250 #define NTB_LINK_DOWN_TIMEOUT 10
252 static void ntb_transport_rxc_db(unsigned long data
);
253 static const struct ntb_ctx_ops ntb_transport_ops
;
254 static struct ntb_client ntb_transport_client
;
256 static int ntb_transport_bus_match(struct device
*dev
,
257 struct device_driver
*drv
)
259 return !strncmp(dev_name(dev
), drv
->name
, strlen(drv
->name
));
262 static int ntb_transport_bus_probe(struct device
*dev
)
264 const struct ntb_transport_client
*client
;
269 client
= drv_client(dev
->driver
);
270 rc
= client
->probe(dev
);
277 static int ntb_transport_bus_remove(struct device
*dev
)
279 const struct ntb_transport_client
*client
;
281 client
= drv_client(dev
->driver
);
289 static struct bus_type ntb_transport_bus
= {
290 .name
= "ntb_transport",
291 .match
= ntb_transport_bus_match
,
292 .probe
= ntb_transport_bus_probe
,
293 .remove
= ntb_transport_bus_remove
,
296 static LIST_HEAD(ntb_transport_list
);
298 static int ntb_bus_init(struct ntb_transport_ctx
*nt
)
300 list_add(&nt
->entry
, &ntb_transport_list
);
304 static void ntb_bus_remove(struct ntb_transport_ctx
*nt
)
306 struct ntb_transport_client_dev
*client_dev
, *cd
;
308 list_for_each_entry_safe(client_dev
, cd
, &nt
->client_devs
, entry
) {
309 dev_err(client_dev
->dev
.parent
, "%s still attached to bus, removing\n",
310 dev_name(&client_dev
->dev
));
311 list_del(&client_dev
->entry
);
312 device_unregister(&client_dev
->dev
);
315 list_del(&nt
->entry
);
318 static void ntb_transport_client_release(struct device
*dev
)
320 struct ntb_transport_client_dev
*client_dev
;
322 client_dev
= dev_client_dev(dev
);
327 * ntb_transport_unregister_client_dev - Unregister NTB client device
328 * @device_name: Name of NTB client device
330 * Unregister an NTB client device with the NTB transport layer
332 void ntb_transport_unregister_client_dev(char *device_name
)
334 struct ntb_transport_client_dev
*client
, *cd
;
335 struct ntb_transport_ctx
*nt
;
337 list_for_each_entry(nt
, &ntb_transport_list
, entry
)
338 list_for_each_entry_safe(client
, cd
, &nt
->client_devs
, entry
)
339 if (!strncmp(dev_name(&client
->dev
), device_name
,
340 strlen(device_name
))) {
341 list_del(&client
->entry
);
342 device_unregister(&client
->dev
);
345 EXPORT_SYMBOL_GPL(ntb_transport_unregister_client_dev
);
348 * ntb_transport_register_client_dev - Register NTB client device
349 * @device_name: Name of NTB client device
351 * Register an NTB client device with the NTB transport layer
353 int ntb_transport_register_client_dev(char *device_name
)
355 struct ntb_transport_client_dev
*client_dev
;
356 struct ntb_transport_ctx
*nt
;
360 if (list_empty(&ntb_transport_list
))
363 list_for_each_entry(nt
, &ntb_transport_list
, entry
) {
366 node
= dev_to_node(&nt
->ndev
->dev
);
368 client_dev
= kzalloc_node(sizeof(*client_dev
),
375 dev
= &client_dev
->dev
;
377 /* setup and register client devices */
378 dev_set_name(dev
, "%s%d", device_name
, i
);
379 dev
->bus
= &ntb_transport_bus
;
380 dev
->release
= ntb_transport_client_release
;
381 dev
->parent
= &nt
->ndev
->dev
;
383 rc
= device_register(dev
);
389 list_add_tail(&client_dev
->entry
, &nt
->client_devs
);
396 ntb_transport_unregister_client_dev(device_name
);
400 EXPORT_SYMBOL_GPL(ntb_transport_register_client_dev
);
403 * ntb_transport_register_client - Register NTB client driver
404 * @drv: NTB client driver to be registered
406 * Register an NTB client driver with the NTB transport layer
408 * RETURNS: An appropriate -ERRNO error value on error, or zero for success.
410 int ntb_transport_register_client(struct ntb_transport_client
*drv
)
412 drv
->driver
.bus
= &ntb_transport_bus
;
414 if (list_empty(&ntb_transport_list
))
417 return driver_register(&drv
->driver
);
419 EXPORT_SYMBOL_GPL(ntb_transport_register_client
);
422 * ntb_transport_unregister_client - Unregister NTB client driver
423 * @drv: NTB client driver to be unregistered
425 * Unregister an NTB client driver with the NTB transport layer
427 * RETURNS: An appropriate -ERRNO error value on error, or zero for success.
429 void ntb_transport_unregister_client(struct ntb_transport_client
*drv
)
431 driver_unregister(&drv
->driver
);
433 EXPORT_SYMBOL_GPL(ntb_transport_unregister_client
);
435 static ssize_t
debugfs_read(struct file
*filp
, char __user
*ubuf
, size_t count
,
438 struct ntb_transport_qp
*qp
;
440 ssize_t ret
, out_offset
, out_count
;
442 qp
= filp
->private_data
;
444 if (!qp
|| !qp
->link_is_up
)
449 buf
= kmalloc(out_count
, GFP_KERNEL
);
454 out_offset
+= snprintf(buf
+ out_offset
, out_count
- out_offset
,
456 out_offset
+= snprintf(buf
+ out_offset
, out_count
- out_offset
,
457 "rx_bytes - \t%llu\n", qp
->rx_bytes
);
458 out_offset
+= snprintf(buf
+ out_offset
, out_count
- out_offset
,
459 "rx_pkts - \t%llu\n", qp
->rx_pkts
);
460 out_offset
+= snprintf(buf
+ out_offset
, out_count
- out_offset
,
461 "rx_memcpy - \t%llu\n", qp
->rx_memcpy
);
462 out_offset
+= snprintf(buf
+ out_offset
, out_count
- out_offset
,
463 "rx_async - \t%llu\n", qp
->rx_async
);
464 out_offset
+= snprintf(buf
+ out_offset
, out_count
- out_offset
,
465 "rx_ring_empty - %llu\n", qp
->rx_ring_empty
);
466 out_offset
+= snprintf(buf
+ out_offset
, out_count
- out_offset
,
467 "rx_err_no_buf - %llu\n", qp
->rx_err_no_buf
);
468 out_offset
+= snprintf(buf
+ out_offset
, out_count
- out_offset
,
469 "rx_err_oflow - \t%llu\n", qp
->rx_err_oflow
);
470 out_offset
+= snprintf(buf
+ out_offset
, out_count
- out_offset
,
471 "rx_err_ver - \t%llu\n", qp
->rx_err_ver
);
472 out_offset
+= snprintf(buf
+ out_offset
, out_count
- out_offset
,
473 "rx_buff - \t%p\n", qp
->rx_buff
);
474 out_offset
+= snprintf(buf
+ out_offset
, out_count
- out_offset
,
475 "rx_index - \t%u\n", qp
->rx_index
);
476 out_offset
+= snprintf(buf
+ out_offset
, out_count
- out_offset
,
477 "rx_max_entry - \t%u\n", qp
->rx_max_entry
);
479 out_offset
+= snprintf(buf
+ out_offset
, out_count
- out_offset
,
480 "tx_bytes - \t%llu\n", qp
->tx_bytes
);
481 out_offset
+= snprintf(buf
+ out_offset
, out_count
- out_offset
,
482 "tx_pkts - \t%llu\n", qp
->tx_pkts
);
483 out_offset
+= snprintf(buf
+ out_offset
, out_count
- out_offset
,
484 "tx_memcpy - \t%llu\n", qp
->tx_memcpy
);
485 out_offset
+= snprintf(buf
+ out_offset
, out_count
- out_offset
,
486 "tx_async - \t%llu\n", qp
->tx_async
);
487 out_offset
+= snprintf(buf
+ out_offset
, out_count
- out_offset
,
488 "tx_ring_full - \t%llu\n", qp
->tx_ring_full
);
489 out_offset
+= snprintf(buf
+ out_offset
, out_count
- out_offset
,
490 "tx_err_no_buf - %llu\n", qp
->tx_err_no_buf
);
491 out_offset
+= snprintf(buf
+ out_offset
, out_count
- out_offset
,
492 "tx_mw - \t%p\n", qp
->tx_mw
);
493 out_offset
+= snprintf(buf
+ out_offset
, out_count
- out_offset
,
494 "tx_index - \t%u\n", qp
->tx_index
);
495 out_offset
+= snprintf(buf
+ out_offset
, out_count
- out_offset
,
496 "tx_max_entry - \t%u\n", qp
->tx_max_entry
);
498 out_offset
+= snprintf(buf
+ out_offset
, out_count
- out_offset
,
500 qp
->link_is_up
? "Up" : "Down");
501 if (out_offset
> out_count
)
502 out_offset
= out_count
;
504 ret
= simple_read_from_buffer(ubuf
, count
, offp
, buf
, out_offset
);
509 static const struct file_operations ntb_qp_debugfs_stats
= {
510 .owner
= THIS_MODULE
,
512 .read
= debugfs_read
,
515 static void ntb_list_add(spinlock_t
*lock
, struct list_head
*entry
,
516 struct list_head
*list
)
520 spin_lock_irqsave(lock
, flags
);
521 list_add_tail(entry
, list
);
522 spin_unlock_irqrestore(lock
, flags
);
525 static struct ntb_queue_entry
*ntb_list_rm(spinlock_t
*lock
,
526 struct list_head
*list
)
528 struct ntb_queue_entry
*entry
;
531 spin_lock_irqsave(lock
, flags
);
532 if (list_empty(list
)) {
536 entry
= list_first_entry(list
, struct ntb_queue_entry
, entry
);
537 list_del(&entry
->entry
);
539 spin_unlock_irqrestore(lock
, flags
);
544 static struct ntb_queue_entry
*ntb_list_mv(spinlock_t
*lock
,
545 struct list_head
*list
,
546 struct list_head
*to_list
)
548 struct ntb_queue_entry
*entry
;
551 spin_lock_irqsave(lock
, flags
);
553 if (list_empty(list
)) {
556 entry
= list_first_entry(list
, struct ntb_queue_entry
, entry
);
557 list_move_tail(&entry
->entry
, to_list
);
560 spin_unlock_irqrestore(lock
, flags
);
565 static int ntb_transport_setup_qp_mw(struct ntb_transport_ctx
*nt
,
568 struct ntb_transport_qp
*qp
= &nt
->qp_vec
[qp_num
];
569 struct ntb_transport_mw
*mw
;
570 unsigned int rx_size
, num_qps_mw
;
571 unsigned int mw_num
, mw_count
, qp_count
;
574 mw_count
= nt
->mw_count
;
575 qp_count
= nt
->qp_count
;
577 mw_num
= QP_TO_MW(nt
, qp_num
);
578 mw
= &nt
->mw_vec
[mw_num
];
583 if (qp_count
% mw_count
&& mw_num
+ 1 < qp_count
/ mw_count
)
584 num_qps_mw
= qp_count
/ mw_count
+ 1;
586 num_qps_mw
= qp_count
/ mw_count
;
588 rx_size
= (unsigned int)mw
->xlat_size
/ num_qps_mw
;
589 qp
->rx_buff
= mw
->virt_addr
+ rx_size
* qp_num
/ mw_count
;
590 rx_size
-= sizeof(struct ntb_rx_info
);
592 qp
->remote_rx_info
= qp
->rx_buff
+ rx_size
;
594 /* Due to housekeeping, there must be atleast 2 buffs */
595 qp
->rx_max_frame
= min(transport_mtu
, rx_size
/ 2);
596 qp
->rx_max_entry
= rx_size
/ qp
->rx_max_frame
;
599 qp
->remote_rx_info
->entry
= qp
->rx_max_entry
- 1;
601 /* setup the hdr offsets with 0's */
602 for (i
= 0; i
< qp
->rx_max_entry
; i
++) {
603 void *offset
= (qp
->rx_buff
+ qp
->rx_max_frame
* (i
+ 1) -
604 sizeof(struct ntb_payload_header
));
605 memset(offset
, 0, sizeof(struct ntb_payload_header
));
615 static void ntb_free_mw(struct ntb_transport_ctx
*nt
, int num_mw
)
617 struct ntb_transport_mw
*mw
= &nt
->mw_vec
[num_mw
];
618 struct pci_dev
*pdev
= nt
->ndev
->pdev
;
623 ntb_mw_clear_trans(nt
->ndev
, num_mw
);
624 dma_free_coherent(&pdev
->dev
, mw
->buff_size
,
625 mw
->virt_addr
, mw
->dma_addr
);
628 mw
->virt_addr
= NULL
;
631 static int ntb_set_mw(struct ntb_transport_ctx
*nt
, int num_mw
,
634 struct ntb_transport_mw
*mw
= &nt
->mw_vec
[num_mw
];
635 struct pci_dev
*pdev
= nt
->ndev
->pdev
;
636 unsigned int xlat_size
, buff_size
;
639 xlat_size
= round_up(size
, mw
->xlat_align_size
);
640 buff_size
= round_up(size
, mw
->xlat_align
);
642 /* No need to re-setup */
643 if (mw
->xlat_size
== xlat_size
)
647 ntb_free_mw(nt
, num_mw
);
649 /* Alloc memory for receiving data. Must be aligned */
650 mw
->xlat_size
= xlat_size
;
651 mw
->buff_size
= buff_size
;
653 mw
->virt_addr
= dma_alloc_coherent(&pdev
->dev
, buff_size
,
654 &mw
->dma_addr
, GFP_KERNEL
);
655 if (!mw
->virt_addr
) {
658 dev_err(&pdev
->dev
, "Unable to alloc MW buff of size %d\n",
664 * we must ensure that the memory address allocated is BAR size
665 * aligned in order for the XLAT register to take the value. This
666 * is a requirement of the hardware. It is recommended to setup CMA
667 * for BAR sizes equal or greater than 4MB.
669 if (!IS_ALIGNED(mw
->dma_addr
, mw
->xlat_align
)) {
670 dev_err(&pdev
->dev
, "DMA memory %pad is not aligned\n",
672 ntb_free_mw(nt
, num_mw
);
676 /* Notify HW the memory location of the receive buffer */
677 rc
= ntb_mw_set_trans(nt
->ndev
, num_mw
, mw
->dma_addr
, mw
->xlat_size
);
679 dev_err(&pdev
->dev
, "Unable to set mw%d translation", num_mw
);
680 ntb_free_mw(nt
, num_mw
);
687 static void ntb_qp_link_down_reset(struct ntb_transport_qp
*qp
)
689 qp
->link_is_up
= false;
695 qp
->rx_ring_empty
= 0;
696 qp
->rx_err_no_buf
= 0;
697 qp
->rx_err_oflow
= 0;
703 qp
->tx_ring_full
= 0;
704 qp
->tx_err_no_buf
= 0;
709 static void ntb_qp_link_cleanup(struct ntb_transport_qp
*qp
)
711 struct ntb_transport_ctx
*nt
= qp
->transport
;
712 struct pci_dev
*pdev
= nt
->ndev
->pdev
;
714 dev_info(&pdev
->dev
, "qp %d: Link Cleanup\n", qp
->qp_num
);
716 cancel_delayed_work_sync(&qp
->link_work
);
717 ntb_qp_link_down_reset(qp
);
719 if (qp
->event_handler
)
720 qp
->event_handler(qp
->cb_data
, qp
->link_is_up
);
723 static void ntb_qp_link_cleanup_work(struct work_struct
*work
)
725 struct ntb_transport_qp
*qp
= container_of(work
,
726 struct ntb_transport_qp
,
728 struct ntb_transport_ctx
*nt
= qp
->transport
;
730 ntb_qp_link_cleanup(qp
);
733 schedule_delayed_work(&qp
->link_work
,
734 msecs_to_jiffies(NTB_LINK_DOWN_TIMEOUT
));
737 static void ntb_qp_link_down(struct ntb_transport_qp
*qp
)
739 schedule_work(&qp
->link_cleanup
);
742 static void ntb_transport_link_cleanup(struct ntb_transport_ctx
*nt
)
744 struct ntb_transport_qp
*qp
;
748 qp_bitmap_alloc
= nt
->qp_bitmap
& ~nt
->qp_bitmap_free
;
750 /* Pass along the info to any clients */
751 for (i
= 0; i
< nt
->qp_count
; i
++)
752 if (qp_bitmap_alloc
& BIT_ULL(i
)) {
754 ntb_qp_link_cleanup(qp
);
755 cancel_work_sync(&qp
->link_cleanup
);
756 cancel_delayed_work_sync(&qp
->link_work
);
760 cancel_delayed_work_sync(&nt
->link_work
);
762 /* The scratchpad registers keep the values if the remote side
763 * goes down, blast them now to give them a sane value the next
764 * time they are accessed
766 for (i
= 0; i
< MAX_SPAD
; i
++)
767 ntb_spad_write(nt
->ndev
, i
, 0);
770 static void ntb_transport_link_cleanup_work(struct work_struct
*work
)
772 struct ntb_transport_ctx
*nt
=
773 container_of(work
, struct ntb_transport_ctx
, link_cleanup
);
775 ntb_transport_link_cleanup(nt
);
778 static void ntb_transport_event_callback(void *data
)
780 struct ntb_transport_ctx
*nt
= data
;
782 if (ntb_link_is_up(nt
->ndev
, NULL
, NULL
) == 1)
783 schedule_delayed_work(&nt
->link_work
, 0);
785 schedule_work(&nt
->link_cleanup
);
788 static void ntb_transport_link_work(struct work_struct
*work
)
790 struct ntb_transport_ctx
*nt
=
791 container_of(work
, struct ntb_transport_ctx
, link_work
.work
);
792 struct ntb_dev
*ndev
= nt
->ndev
;
793 struct pci_dev
*pdev
= ndev
->pdev
;
794 resource_size_t size
;
798 /* send the local info, in the opposite order of the way we read it */
799 for (i
= 0; i
< nt
->mw_count
; i
++) {
800 size
= nt
->mw_vec
[i
].phys_size
;
802 if (max_mw_size
&& size
> max_mw_size
)
805 spad
= MW0_SZ_HIGH
+ (i
* 2);
806 ntb_peer_spad_write(ndev
, spad
, (u32
)(size
>> 32));
808 spad
= MW0_SZ_LOW
+ (i
* 2);
809 ntb_peer_spad_write(ndev
, spad
, (u32
)size
);
812 ntb_peer_spad_write(ndev
, NUM_MWS
, nt
->mw_count
);
814 ntb_peer_spad_write(ndev
, NUM_QPS
, nt
->qp_count
);
816 ntb_peer_spad_write(ndev
, VERSION
, NTB_TRANSPORT_VERSION
);
818 /* Query the remote side for its info */
819 val
= ntb_spad_read(ndev
, VERSION
);
820 dev_dbg(&pdev
->dev
, "Remote version = %d\n", val
);
821 if (val
!= NTB_TRANSPORT_VERSION
)
824 val
= ntb_spad_read(ndev
, NUM_QPS
);
825 dev_dbg(&pdev
->dev
, "Remote max number of qps = %d\n", val
);
826 if (val
!= nt
->qp_count
)
829 val
= ntb_spad_read(ndev
, NUM_MWS
);
830 dev_dbg(&pdev
->dev
, "Remote number of mws = %d\n", val
);
831 if (val
!= nt
->mw_count
)
834 for (i
= 0; i
< nt
->mw_count
; i
++) {
837 val
= ntb_spad_read(ndev
, MW0_SZ_HIGH
+ (i
* 2));
838 val64
= (u64
)val
<< 32;
840 val
= ntb_spad_read(ndev
, MW0_SZ_LOW
+ (i
* 2));
843 dev_dbg(&pdev
->dev
, "Remote MW%d size = %#llx\n", i
, val64
);
845 rc
= ntb_set_mw(nt
, i
, val64
);
850 nt
->link_is_up
= true;
852 for (i
= 0; i
< nt
->qp_count
; i
++) {
853 struct ntb_transport_qp
*qp
= &nt
->qp_vec
[i
];
855 ntb_transport_setup_qp_mw(nt
, i
);
857 if (qp
->client_ready
)
858 schedule_delayed_work(&qp
->link_work
, 0);
864 for (i
= 0; i
< nt
->mw_count
; i
++)
867 if (ntb_link_is_up(ndev
, NULL
, NULL
) == 1)
868 schedule_delayed_work(&nt
->link_work
,
869 msecs_to_jiffies(NTB_LINK_DOWN_TIMEOUT
));
872 static void ntb_qp_link_work(struct work_struct
*work
)
874 struct ntb_transport_qp
*qp
= container_of(work
,
875 struct ntb_transport_qp
,
877 struct pci_dev
*pdev
= qp
->ndev
->pdev
;
878 struct ntb_transport_ctx
*nt
= qp
->transport
;
881 WARN_ON(!nt
->link_is_up
);
883 val
= ntb_spad_read(nt
->ndev
, QP_LINKS
);
885 ntb_peer_spad_write(nt
->ndev
, QP_LINKS
, val
| BIT(qp
->qp_num
));
887 /* query remote spad for qp ready bits */
888 ntb_peer_spad_read(nt
->ndev
, QP_LINKS
);
889 dev_dbg_ratelimited(&pdev
->dev
, "Remote QP link status = %x\n", val
);
891 /* See if the remote side is up */
892 if (val
& BIT(qp
->qp_num
)) {
893 dev_info(&pdev
->dev
, "qp %d: Link Up\n", qp
->qp_num
);
894 qp
->link_is_up
= true;
896 if (qp
->event_handler
)
897 qp
->event_handler(qp
->cb_data
, qp
->link_is_up
);
899 tasklet_schedule(&qp
->rxc_db_work
);
900 } else if (nt
->link_is_up
)
901 schedule_delayed_work(&qp
->link_work
,
902 msecs_to_jiffies(NTB_LINK_DOWN_TIMEOUT
));
905 static int ntb_transport_init_queue(struct ntb_transport_ctx
*nt
,
908 struct ntb_transport_qp
*qp
;
909 struct ntb_transport_mw
*mw
;
911 resource_size_t mw_size
;
912 unsigned int num_qps_mw
, tx_size
;
913 unsigned int mw_num
, mw_count
, qp_count
;
916 mw_count
= nt
->mw_count
;
917 qp_count
= nt
->qp_count
;
919 mw_num
= QP_TO_MW(nt
, qp_num
);
920 mw
= &nt
->mw_vec
[mw_num
];
922 qp
= &nt
->qp_vec
[qp_num
];
926 qp
->client_ready
= false;
927 qp
->event_handler
= NULL
;
928 ntb_qp_link_down_reset(qp
);
930 if (qp_count
% mw_count
&& mw_num
+ 1 < qp_count
/ mw_count
)
931 num_qps_mw
= qp_count
/ mw_count
+ 1;
933 num_qps_mw
= qp_count
/ mw_count
;
935 mw_base
= nt
->mw_vec
[mw_num
].phys_addr
;
936 mw_size
= nt
->mw_vec
[mw_num
].phys_size
;
938 tx_size
= (unsigned int)mw_size
/ num_qps_mw
;
939 qp_offset
= tx_size
* qp_num
/ mw_count
;
941 qp
->tx_mw
= nt
->mw_vec
[mw_num
].vbase
+ qp_offset
;
945 qp
->tx_mw_phys
= mw_base
+ qp_offset
;
949 tx_size
-= sizeof(struct ntb_rx_info
);
950 qp
->rx_info
= qp
->tx_mw
+ tx_size
;
952 /* Due to housekeeping, there must be atleast 2 buffs */
953 qp
->tx_max_frame
= min(transport_mtu
, tx_size
/ 2);
954 qp
->tx_max_entry
= tx_size
/ qp
->tx_max_frame
;
956 if (nt
->debugfs_node_dir
) {
957 char debugfs_name
[4];
959 snprintf(debugfs_name
, 4, "qp%d", qp_num
);
960 qp
->debugfs_dir
= debugfs_create_dir(debugfs_name
,
961 nt
->debugfs_node_dir
);
963 qp
->debugfs_stats
= debugfs_create_file("stats", S_IRUSR
,
965 &ntb_qp_debugfs_stats
);
967 qp
->debugfs_dir
= NULL
;
968 qp
->debugfs_stats
= NULL
;
971 INIT_DELAYED_WORK(&qp
->link_work
, ntb_qp_link_work
);
972 INIT_WORK(&qp
->link_cleanup
, ntb_qp_link_cleanup_work
);
974 spin_lock_init(&qp
->ntb_rx_q_lock
);
975 spin_lock_init(&qp
->ntb_tx_free_q_lock
);
977 INIT_LIST_HEAD(&qp
->rx_post_q
);
978 INIT_LIST_HEAD(&qp
->rx_pend_q
);
979 INIT_LIST_HEAD(&qp
->rx_free_q
);
980 INIT_LIST_HEAD(&qp
->tx_free_q
);
982 tasklet_init(&qp
->rxc_db_work
, ntb_transport_rxc_db
,
988 static int ntb_transport_probe(struct ntb_client
*self
, struct ntb_dev
*ndev
)
990 struct ntb_transport_ctx
*nt
;
991 struct ntb_transport_mw
*mw
;
992 unsigned int mw_count
, qp_count
;
997 if (ntb_db_is_unsafe(ndev
))
999 "doorbell is unsafe, proceed anyway...\n");
1000 if (ntb_spad_is_unsafe(ndev
))
1002 "scratchpad is unsafe, proceed anyway...\n");
1004 node
= dev_to_node(&ndev
->dev
);
1006 nt
= kzalloc_node(sizeof(*nt
), GFP_KERNEL
, node
);
1012 mw_count
= ntb_mw_count(ndev
);
1014 nt
->mw_count
= mw_count
;
1016 nt
->mw_vec
= kzalloc_node(mw_count
* sizeof(*nt
->mw_vec
),
1023 for (i
= 0; i
< mw_count
; i
++) {
1024 mw
= &nt
->mw_vec
[i
];
1026 rc
= ntb_mw_get_range(ndev
, i
, &mw
->phys_addr
, &mw
->phys_size
,
1027 &mw
->xlat_align
, &mw
->xlat_align_size
);
1031 mw
->vbase
= ioremap_wc(mw
->phys_addr
, mw
->phys_size
);
1039 mw
->virt_addr
= NULL
;
1043 qp_bitmap
= ntb_db_valid_mask(ndev
);
1045 qp_count
= ilog2(qp_bitmap
);
1046 if (max_num_clients
&& max_num_clients
< qp_count
)
1047 qp_count
= max_num_clients
;
1048 else if (mw_count
< qp_count
)
1049 qp_count
= mw_count
;
1051 qp_bitmap
&= BIT_ULL(qp_count
) - 1;
1053 nt
->qp_count
= qp_count
;
1054 nt
->qp_bitmap
= qp_bitmap
;
1055 nt
->qp_bitmap_free
= qp_bitmap
;
1057 nt
->qp_vec
= kzalloc_node(qp_count
* sizeof(*nt
->qp_vec
),
1064 if (nt_debugfs_dir
) {
1065 nt
->debugfs_node_dir
=
1066 debugfs_create_dir(pci_name(ndev
->pdev
),
1070 for (i
= 0; i
< qp_count
; i
++) {
1071 rc
= ntb_transport_init_queue(nt
, i
);
1076 INIT_DELAYED_WORK(&nt
->link_work
, ntb_transport_link_work
);
1077 INIT_WORK(&nt
->link_cleanup
, ntb_transport_link_cleanup_work
);
1079 rc
= ntb_set_ctx(ndev
, nt
, &ntb_transport_ops
);
1083 INIT_LIST_HEAD(&nt
->client_devs
);
1084 rc
= ntb_bus_init(nt
);
1088 nt
->link_is_up
= false;
1089 ntb_link_enable(ndev
, NTB_SPEED_AUTO
, NTB_WIDTH_AUTO
);
1090 ntb_link_event(ndev
);
1095 ntb_clear_ctx(ndev
);
1102 mw
= &nt
->mw_vec
[i
];
1110 static void ntb_transport_free(struct ntb_client
*self
, struct ntb_dev
*ndev
)
1112 struct ntb_transport_ctx
*nt
= ndev
->ctx
;
1113 struct ntb_transport_qp
*qp
;
1114 u64 qp_bitmap_alloc
;
1117 ntb_transport_link_cleanup(nt
);
1118 cancel_work_sync(&nt
->link_cleanup
);
1119 cancel_delayed_work_sync(&nt
->link_work
);
1121 qp_bitmap_alloc
= nt
->qp_bitmap
& ~nt
->qp_bitmap_free
;
1123 /* verify that all the qp's are freed */
1124 for (i
= 0; i
< nt
->qp_count
; i
++) {
1125 qp
= &nt
->qp_vec
[i
];
1126 if (qp_bitmap_alloc
& BIT_ULL(i
))
1127 ntb_transport_free_queue(qp
);
1128 debugfs_remove_recursive(qp
->debugfs_dir
);
1131 ntb_link_disable(ndev
);
1132 ntb_clear_ctx(ndev
);
1136 for (i
= nt
->mw_count
; i
--; ) {
1138 iounmap(nt
->mw_vec
[i
].vbase
);
1146 static void ntb_complete_rxc(struct ntb_transport_qp
*qp
)
1148 struct ntb_queue_entry
*entry
;
1151 unsigned long irqflags
;
1153 spin_lock_irqsave(&qp
->ntb_rx_q_lock
, irqflags
);
1155 while (!list_empty(&qp
->rx_post_q
)) {
1156 entry
= list_first_entry(&qp
->rx_post_q
,
1157 struct ntb_queue_entry
, entry
);
1158 if (!(entry
->flags
& DESC_DONE_FLAG
))
1161 entry
->rx_hdr
->flags
= 0;
1162 iowrite32(entry
->index
, &qp
->rx_info
->entry
);
1164 cb_data
= entry
->cb_data
;
1167 list_move_tail(&entry
->entry
, &qp
->rx_free_q
);
1169 spin_unlock_irqrestore(&qp
->ntb_rx_q_lock
, irqflags
);
1171 if (qp
->rx_handler
&& qp
->client_ready
)
1172 qp
->rx_handler(qp
, qp
->cb_data
, cb_data
, len
);
1174 spin_lock_irqsave(&qp
->ntb_rx_q_lock
, irqflags
);
1177 spin_unlock_irqrestore(&qp
->ntb_rx_q_lock
, irqflags
);
1180 static void ntb_rx_copy_callback(void *data
)
1182 struct ntb_queue_entry
*entry
= data
;
1184 entry
->flags
|= DESC_DONE_FLAG
;
1186 ntb_complete_rxc(entry
->qp
);
1189 static void ntb_memcpy_rx(struct ntb_queue_entry
*entry
, void *offset
)
1191 void *buf
= entry
->buf
;
1192 size_t len
= entry
->len
;
1194 memcpy(buf
, offset
, len
);
1196 /* Ensure that the data is fully copied out before clearing the flag */
1199 ntb_rx_copy_callback(entry
);
1202 static void ntb_async_rx(struct ntb_queue_entry
*entry
, void *offset
)
1204 struct dma_async_tx_descriptor
*txd
;
1205 struct ntb_transport_qp
*qp
= entry
->qp
;
1206 struct dma_chan
*chan
= qp
->dma_chan
;
1207 struct dma_device
*device
;
1208 size_t pay_off
, buff_off
, len
;
1209 struct dmaengine_unmap_data
*unmap
;
1210 dma_cookie_t cookie
;
1211 void *buf
= entry
->buf
;
1218 if (len
< copy_bytes
)
1221 device
= chan
->device
;
1222 pay_off
= (size_t)offset
& ~PAGE_MASK
;
1223 buff_off
= (size_t)buf
& ~PAGE_MASK
;
1225 if (!is_dma_copy_aligned(device
, pay_off
, buff_off
, len
))
1228 unmap
= dmaengine_get_unmap_data(device
->dev
, 2, GFP_NOWAIT
);
1233 unmap
->addr
[0] = dma_map_page(device
->dev
, virt_to_page(offset
),
1234 pay_off
, len
, DMA_TO_DEVICE
);
1235 if (dma_mapping_error(device
->dev
, unmap
->addr
[0]))
1240 unmap
->addr
[1] = dma_map_page(device
->dev
, virt_to_page(buf
),
1241 buff_off
, len
, DMA_FROM_DEVICE
);
1242 if (dma_mapping_error(device
->dev
, unmap
->addr
[1]))
1245 unmap
->from_cnt
= 1;
1247 txd
= device
->device_prep_dma_memcpy(chan
, unmap
->addr
[1],
1248 unmap
->addr
[0], len
,
1249 DMA_PREP_INTERRUPT
);
1253 txd
->callback
= ntb_rx_copy_callback
;
1254 txd
->callback_param
= entry
;
1255 dma_set_unmap(txd
, unmap
);
1257 cookie
= dmaengine_submit(txd
);
1258 if (dma_submit_error(cookie
))
1261 dmaengine_unmap_put(unmap
);
1263 qp
->last_cookie
= cookie
;
1270 dmaengine_unmap_put(unmap
);
1272 dmaengine_unmap_put(unmap
);
1274 /* If the callbacks come out of order, the writing of the index to the
1275 * last completed will be out of order. This may result in the
1276 * receive stalling forever.
1278 dma_sync_wait(chan
, qp
->last_cookie
);
1280 ntb_memcpy_rx(entry
, offset
);
1284 static int ntb_process_rxc(struct ntb_transport_qp
*qp
)
1286 struct ntb_payload_header
*hdr
;
1287 struct ntb_queue_entry
*entry
;
1290 offset
= qp
->rx_buff
+ qp
->rx_max_frame
* qp
->rx_index
;
1291 hdr
= offset
+ qp
->rx_max_frame
- sizeof(struct ntb_payload_header
);
1293 dev_dbg(&qp
->ndev
->pdev
->dev
, "qp %d: RX ver %u len %d flags %x\n",
1294 qp
->qp_num
, hdr
->ver
, hdr
->len
, hdr
->flags
);
1296 if (!(hdr
->flags
& DESC_DONE_FLAG
)) {
1297 dev_dbg(&qp
->ndev
->pdev
->dev
, "done flag not set\n");
1298 qp
->rx_ring_empty
++;
1302 if (hdr
->flags
& LINK_DOWN_FLAG
) {
1303 dev_dbg(&qp
->ndev
->pdev
->dev
, "link down flag set\n");
1304 ntb_qp_link_down(qp
);
1309 if (hdr
->ver
!= (u32
)qp
->rx_pkts
) {
1310 dev_dbg(&qp
->ndev
->pdev
->dev
,
1311 "version mismatch, expected %llu - got %u\n",
1312 qp
->rx_pkts
, hdr
->ver
);
1317 entry
= ntb_list_mv(&qp
->ntb_rx_q_lock
, &qp
->rx_pend_q
, &qp
->rx_post_q
);
1319 dev_dbg(&qp
->ndev
->pdev
->dev
, "no receive buffer\n");
1320 qp
->rx_err_no_buf
++;
1324 entry
->rx_hdr
= hdr
;
1325 entry
->index
= qp
->rx_index
;
1327 if (hdr
->len
> entry
->len
) {
1328 dev_dbg(&qp
->ndev
->pdev
->dev
,
1329 "receive buffer overflow! Wanted %d got %d\n",
1330 hdr
->len
, entry
->len
);
1334 entry
->flags
|= DESC_DONE_FLAG
;
1336 ntb_complete_rxc(qp
);
1338 dev_dbg(&qp
->ndev
->pdev
->dev
,
1339 "RX OK index %u ver %u size %d into buf size %d\n",
1340 qp
->rx_index
, hdr
->ver
, hdr
->len
, entry
->len
);
1342 qp
->rx_bytes
+= hdr
->len
;
1345 entry
->len
= hdr
->len
;
1347 ntb_async_rx(entry
, offset
);
1351 qp
->rx_index
%= qp
->rx_max_entry
;
1356 static void ntb_transport_rxc_db(unsigned long data
)
1358 struct ntb_transport_qp
*qp
= (void *)data
;
1361 dev_dbg(&qp
->ndev
->pdev
->dev
, "%s: doorbell %d received\n",
1362 __func__
, qp
->qp_num
);
1364 /* Limit the number of packets processed in a single interrupt to
1365 * provide fairness to others
1367 for (i
= 0; i
< qp
->rx_max_entry
; i
++) {
1368 rc
= ntb_process_rxc(qp
);
1373 if (i
&& qp
->dma_chan
)
1374 dma_async_issue_pending(qp
->dma_chan
);
1376 if (i
== qp
->rx_max_entry
) {
1377 /* there is more work to do */
1378 tasklet_schedule(&qp
->rxc_db_work
);
1379 } else if (ntb_db_read(qp
->ndev
) & BIT_ULL(qp
->qp_num
)) {
1380 /* the doorbell bit is set: clear it */
1381 ntb_db_clear(qp
->ndev
, BIT_ULL(qp
->qp_num
));
1382 /* ntb_db_read ensures ntb_db_clear write is committed */
1383 ntb_db_read(qp
->ndev
);
1385 /* an interrupt may have arrived between finishing
1386 * ntb_process_rxc and clearing the doorbell bit:
1387 * there might be some more work to do.
1389 tasklet_schedule(&qp
->rxc_db_work
);
1393 static void ntb_tx_copy_callback(void *data
)
1395 struct ntb_queue_entry
*entry
= data
;
1396 struct ntb_transport_qp
*qp
= entry
->qp
;
1397 struct ntb_payload_header __iomem
*hdr
= entry
->tx_hdr
;
1399 iowrite32(entry
->flags
| DESC_DONE_FLAG
, &hdr
->flags
);
1401 ntb_peer_db_set(qp
->ndev
, BIT_ULL(qp
->qp_num
));
1403 /* The entry length can only be zero if the packet is intended to be a
1404 * "link down" or similar. Since no payload is being sent in these
1405 * cases, there is nothing to add to the completion queue.
1407 if (entry
->len
> 0) {
1408 qp
->tx_bytes
+= entry
->len
;
1411 qp
->tx_handler(qp
, qp
->cb_data
, entry
->cb_data
,
1415 ntb_list_add(&qp
->ntb_tx_free_q_lock
, &entry
->entry
, &qp
->tx_free_q
);
1418 static void ntb_memcpy_tx(struct ntb_queue_entry
*entry
, void __iomem
*offset
)
1420 #ifdef ARCH_HAS_NOCACHE_UACCESS
1422 * Using non-temporal mov to improve performance on non-cached
1423 * writes, even though we aren't actually copying from user space.
1425 __copy_from_user_inatomic_nocache(offset
, entry
->buf
, entry
->len
);
1427 memcpy_toio(offset
, entry
->buf
, entry
->len
);
1430 /* Ensure that the data is fully copied out before setting the flags */
1433 ntb_tx_copy_callback(entry
);
1436 static void ntb_async_tx(struct ntb_transport_qp
*qp
,
1437 struct ntb_queue_entry
*entry
)
1439 struct ntb_payload_header __iomem
*hdr
;
1440 struct dma_async_tx_descriptor
*txd
;
1441 struct dma_chan
*chan
= qp
->dma_chan
;
1442 struct dma_device
*device
;
1443 size_t dest_off
, buff_off
;
1444 struct dmaengine_unmap_data
*unmap
;
1446 dma_cookie_t cookie
;
1447 void __iomem
*offset
;
1448 size_t len
= entry
->len
;
1449 void *buf
= entry
->buf
;
1451 offset
= qp
->tx_mw
+ qp
->tx_max_frame
* qp
->tx_index
;
1452 hdr
= offset
+ qp
->tx_max_frame
- sizeof(struct ntb_payload_header
);
1453 entry
->tx_hdr
= hdr
;
1455 iowrite32(entry
->len
, &hdr
->len
);
1456 iowrite32((u32
)qp
->tx_pkts
, &hdr
->ver
);
1461 if (len
< copy_bytes
)
1464 device
= chan
->device
;
1465 dest
= qp
->tx_mw_phys
+ qp
->tx_max_frame
* qp
->tx_index
;
1466 buff_off
= (size_t)buf
& ~PAGE_MASK
;
1467 dest_off
= (size_t)dest
& ~PAGE_MASK
;
1469 if (!is_dma_copy_aligned(device
, buff_off
, dest_off
, len
))
1472 unmap
= dmaengine_get_unmap_data(device
->dev
, 1, GFP_NOWAIT
);
1477 unmap
->addr
[0] = dma_map_page(device
->dev
, virt_to_page(buf
),
1478 buff_off
, len
, DMA_TO_DEVICE
);
1479 if (dma_mapping_error(device
->dev
, unmap
->addr
[0]))
1484 txd
= device
->device_prep_dma_memcpy(chan
, dest
, unmap
->addr
[0], len
,
1485 DMA_PREP_INTERRUPT
);
1489 txd
->callback
= ntb_tx_copy_callback
;
1490 txd
->callback_param
= entry
;
1491 dma_set_unmap(txd
, unmap
);
1493 cookie
= dmaengine_submit(txd
);
1494 if (dma_submit_error(cookie
))
1497 dmaengine_unmap_put(unmap
);
1499 dma_async_issue_pending(chan
);
1504 dmaengine_unmap_put(unmap
);
1506 dmaengine_unmap_put(unmap
);
1508 ntb_memcpy_tx(entry
, offset
);
1512 static int ntb_process_tx(struct ntb_transport_qp
*qp
,
1513 struct ntb_queue_entry
*entry
)
1515 if (qp
->tx_index
== qp
->remote_rx_info
->entry
) {
1520 if (entry
->len
> qp
->tx_max_frame
- sizeof(struct ntb_payload_header
)) {
1522 qp
->tx_handler(qp
->cb_data
, qp
, NULL
, -EIO
);
1524 ntb_list_add(&qp
->ntb_tx_free_q_lock
, &entry
->entry
,
1529 ntb_async_tx(qp
, entry
);
1532 qp
->tx_index
%= qp
->tx_max_entry
;
1539 static void ntb_send_link_down(struct ntb_transport_qp
*qp
)
1541 struct pci_dev
*pdev
= qp
->ndev
->pdev
;
1542 struct ntb_queue_entry
*entry
;
1545 if (!qp
->link_is_up
)
1548 dev_info(&pdev
->dev
, "qp %d: Send Link Down\n", qp
->qp_num
);
1550 for (i
= 0; i
< NTB_LINK_DOWN_TIMEOUT
; i
++) {
1551 entry
= ntb_list_rm(&qp
->ntb_tx_free_q_lock
, &qp
->tx_free_q
);
1560 entry
->cb_data
= NULL
;
1563 entry
->flags
= LINK_DOWN_FLAG
;
1565 rc
= ntb_process_tx(qp
, entry
);
1567 dev_err(&pdev
->dev
, "ntb: QP%d unable to send linkdown msg\n",
1570 ntb_qp_link_down_reset(qp
);
1573 static bool ntb_dma_filter_fn(struct dma_chan
*chan
, void *node
)
1575 return dev_to_node(&chan
->dev
->device
) == (int)(unsigned long)node
;
1579 * ntb_transport_create_queue - Create a new NTB transport layer queue
1580 * @rx_handler: receive callback function
1581 * @tx_handler: transmit callback function
1582 * @event_handler: event callback function
1584 * Create a new NTB transport layer queue and provide the queue with a callback
1585 * routine for both transmit and receive. The receive callback routine will be
1586 * used to pass up data when the transport has received it on the queue. The
1587 * transmit callback routine will be called when the transport has completed the
1588 * transmission of the data on the queue and the data is ready to be freed.
1590 * RETURNS: pointer to newly created ntb_queue, NULL on error.
1592 struct ntb_transport_qp
*
1593 ntb_transport_create_queue(void *data
, struct device
*client_dev
,
1594 const struct ntb_queue_handlers
*handlers
)
1596 struct ntb_dev
*ndev
;
1597 struct pci_dev
*pdev
;
1598 struct ntb_transport_ctx
*nt
;
1599 struct ntb_queue_entry
*entry
;
1600 struct ntb_transport_qp
*qp
;
1602 unsigned int free_queue
;
1603 dma_cap_mask_t dma_mask
;
1607 ndev
= dev_ntb(client_dev
->parent
);
1611 node
= dev_to_node(&ndev
->dev
);
1613 free_queue
= ffs(nt
->qp_bitmap
);
1617 /* decrement free_queue to make it zero based */
1620 qp
= &nt
->qp_vec
[free_queue
];
1621 qp_bit
= BIT_ULL(qp
->qp_num
);
1623 nt
->qp_bitmap_free
&= ~qp_bit
;
1626 qp
->rx_handler
= handlers
->rx_handler
;
1627 qp
->tx_handler
= handlers
->tx_handler
;
1628 qp
->event_handler
= handlers
->event_handler
;
1630 dma_cap_zero(dma_mask
);
1631 dma_cap_set(DMA_MEMCPY
, dma_mask
);
1634 qp
->dma_chan
= dma_request_channel(dma_mask
, ntb_dma_filter_fn
,
1635 (void *)(unsigned long)node
);
1637 dev_info(&pdev
->dev
, "Unable to allocate DMA channel\n");
1639 qp
->dma_chan
= NULL
;
1641 dev_dbg(&pdev
->dev
, "Using %s memcpy\n", qp
->dma_chan
? "DMA" : "CPU");
1643 for (i
= 0; i
< NTB_QP_DEF_NUM_ENTRIES
; i
++) {
1644 entry
= kzalloc_node(sizeof(*entry
), GFP_ATOMIC
, node
);
1649 ntb_list_add(&qp
->ntb_rx_q_lock
, &entry
->entry
,
1653 for (i
= 0; i
< NTB_QP_DEF_NUM_ENTRIES
; i
++) {
1654 entry
= kzalloc_node(sizeof(*entry
), GFP_ATOMIC
, node
);
1659 ntb_list_add(&qp
->ntb_tx_free_q_lock
, &entry
->entry
,
1663 ntb_db_clear(qp
->ndev
, qp_bit
);
1664 ntb_db_clear_mask(qp
->ndev
, qp_bit
);
1666 dev_info(&pdev
->dev
, "NTB Transport QP %d created\n", qp
->qp_num
);
1671 while ((entry
= ntb_list_rm(&qp
->ntb_tx_free_q_lock
, &qp
->tx_free_q
)))
1674 while ((entry
= ntb_list_rm(&qp
->ntb_rx_q_lock
, &qp
->rx_free_q
)))
1677 dma_release_channel(qp
->dma_chan
);
1678 nt
->qp_bitmap_free
|= qp_bit
;
1682 EXPORT_SYMBOL_GPL(ntb_transport_create_queue
);
1685 * ntb_transport_free_queue - Frees NTB transport queue
1686 * @qp: NTB queue to be freed
1688 * Frees NTB transport queue
1690 void ntb_transport_free_queue(struct ntb_transport_qp
*qp
)
1692 struct ntb_transport_ctx
*nt
= qp
->transport
;
1693 struct pci_dev
*pdev
;
1694 struct ntb_queue_entry
*entry
;
1700 pdev
= qp
->ndev
->pdev
;
1703 struct dma_chan
*chan
= qp
->dma_chan
;
1704 /* Putting the dma_chan to NULL will force any new traffic to be
1705 * processed by the CPU instead of the DAM engine
1707 qp
->dma_chan
= NULL
;
1709 /* Try to be nice and wait for any queued DMA engine
1710 * transactions to process before smashing it with a rock
1712 dma_sync_wait(chan
, qp
->last_cookie
);
1713 dmaengine_terminate_all(chan
);
1714 dma_release_channel(chan
);
1717 qp_bit
= BIT_ULL(qp
->qp_num
);
1719 ntb_db_set_mask(qp
->ndev
, qp_bit
);
1720 tasklet_disable(&qp
->rxc_db_work
);
1722 cancel_delayed_work_sync(&qp
->link_work
);
1725 qp
->rx_handler
= NULL
;
1726 qp
->tx_handler
= NULL
;
1727 qp
->event_handler
= NULL
;
1729 while ((entry
= ntb_list_rm(&qp
->ntb_rx_q_lock
, &qp
->rx_free_q
)))
1732 while ((entry
= ntb_list_rm(&qp
->ntb_rx_q_lock
, &qp
->rx_pend_q
))) {
1733 dev_warn(&pdev
->dev
, "Freeing item from non-empty rx_pend_q\n");
1737 while ((entry
= ntb_list_rm(&qp
->ntb_rx_q_lock
, &qp
->rx_post_q
))) {
1738 dev_warn(&pdev
->dev
, "Freeing item from non-empty rx_post_q\n");
1742 while ((entry
= ntb_list_rm(&qp
->ntb_tx_free_q_lock
, &qp
->tx_free_q
)))
1745 nt
->qp_bitmap_free
|= qp_bit
;
1747 dev_info(&pdev
->dev
, "NTB Transport QP %d freed\n", qp
->qp_num
);
1749 EXPORT_SYMBOL_GPL(ntb_transport_free_queue
);
1752 * ntb_transport_rx_remove - Dequeues enqueued rx packet
1753 * @qp: NTB queue to be freed
1754 * @len: pointer to variable to write enqueued buffers length
1756 * Dequeues unused buffers from receive queue. Should only be used during
1759 * RETURNS: NULL error value on error, or void* for success.
1761 void *ntb_transport_rx_remove(struct ntb_transport_qp
*qp
, unsigned int *len
)
1763 struct ntb_queue_entry
*entry
;
1766 if (!qp
|| qp
->client_ready
)
1769 entry
= ntb_list_rm(&qp
->ntb_rx_q_lock
, &qp
->rx_pend_q
);
1773 buf
= entry
->cb_data
;
1776 ntb_list_add(&qp
->ntb_rx_q_lock
, &entry
->entry
, &qp
->rx_free_q
);
1780 EXPORT_SYMBOL_GPL(ntb_transport_rx_remove
);
1783 * ntb_transport_rx_enqueue - Enqueue a new NTB queue entry
1784 * @qp: NTB transport layer queue the entry is to be enqueued on
1785 * @cb: per buffer pointer for callback function to use
1786 * @data: pointer to data buffer that incoming packets will be copied into
1787 * @len: length of the data buffer
1789 * Enqueue a new receive buffer onto the transport queue into which a NTB
1790 * payload can be received into.
1792 * RETURNS: An appropriate -ERRNO error value on error, or zero for success.
1794 int ntb_transport_rx_enqueue(struct ntb_transport_qp
*qp
, void *cb
, void *data
,
1797 struct ntb_queue_entry
*entry
;
1802 entry
= ntb_list_rm(&qp
->ntb_rx_q_lock
, &qp
->rx_free_q
);
1806 entry
->cb_data
= cb
;
1811 ntb_list_add(&qp
->ntb_rx_q_lock
, &entry
->entry
, &qp
->rx_pend_q
);
1813 tasklet_schedule(&qp
->rxc_db_work
);
1817 EXPORT_SYMBOL_GPL(ntb_transport_rx_enqueue
);
1820 * ntb_transport_tx_enqueue - Enqueue a new NTB queue entry
1821 * @qp: NTB transport layer queue the entry is to be enqueued on
1822 * @cb: per buffer pointer for callback function to use
1823 * @data: pointer to data buffer that will be sent
1824 * @len: length of the data buffer
1826 * Enqueue a new transmit buffer onto the transport queue from which a NTB
1827 * payload will be transmitted. This assumes that a lock is being held to
1828 * serialize access to the qp.
1830 * RETURNS: An appropriate -ERRNO error value on error, or zero for success.
1832 int ntb_transport_tx_enqueue(struct ntb_transport_qp
*qp
, void *cb
, void *data
,
1835 struct ntb_queue_entry
*entry
;
1838 if (!qp
|| !qp
->link_is_up
|| !len
)
1841 entry
= ntb_list_rm(&qp
->ntb_tx_free_q_lock
, &qp
->tx_free_q
);
1843 qp
->tx_err_no_buf
++;
1847 entry
->cb_data
= cb
;
1852 rc
= ntb_process_tx(qp
, entry
);
1854 ntb_list_add(&qp
->ntb_tx_free_q_lock
, &entry
->entry
,
1859 EXPORT_SYMBOL_GPL(ntb_transport_tx_enqueue
);
1862 * ntb_transport_link_up - Notify NTB transport of client readiness to use queue
1863 * @qp: NTB transport layer queue to be enabled
1865 * Notify NTB transport layer of client readiness to use queue
1867 void ntb_transport_link_up(struct ntb_transport_qp
*qp
)
1872 qp
->client_ready
= true;
1874 if (qp
->transport
->link_is_up
)
1875 schedule_delayed_work(&qp
->link_work
, 0);
1877 EXPORT_SYMBOL_GPL(ntb_transport_link_up
);
1880 * ntb_transport_link_down - Notify NTB transport to no longer enqueue data
1881 * @qp: NTB transport layer queue to be disabled
1883 * Notify NTB transport layer of client's desire to no longer receive data on
1884 * transport queue specified. It is the client's responsibility to ensure all
1885 * entries on queue are purged or otherwise handled appropriately.
1887 void ntb_transport_link_down(struct ntb_transport_qp
*qp
)
1889 struct pci_dev
*pdev
;
1895 pdev
= qp
->ndev
->pdev
;
1896 qp
->client_ready
= false;
1898 val
= ntb_spad_read(qp
->ndev
, QP_LINKS
);
1900 ntb_peer_spad_write(qp
->ndev
, QP_LINKS
,
1901 val
& ~BIT(qp
->qp_num
));
1904 ntb_send_link_down(qp
);
1906 cancel_delayed_work_sync(&qp
->link_work
);
1908 EXPORT_SYMBOL_GPL(ntb_transport_link_down
);
1911 * ntb_transport_link_query - Query transport link state
1912 * @qp: NTB transport layer queue to be queried
1914 * Query connectivity to the remote system of the NTB transport queue
1916 * RETURNS: true for link up or false for link down
1918 bool ntb_transport_link_query(struct ntb_transport_qp
*qp
)
1923 return qp
->link_is_up
;
1925 EXPORT_SYMBOL_GPL(ntb_transport_link_query
);
1928 * ntb_transport_qp_num - Query the qp number
1929 * @qp: NTB transport layer queue to be queried
1931 * Query qp number of the NTB transport queue
1933 * RETURNS: a zero based number specifying the qp number
1935 unsigned char ntb_transport_qp_num(struct ntb_transport_qp
*qp
)
1942 EXPORT_SYMBOL_GPL(ntb_transport_qp_num
);
1945 * ntb_transport_max_size - Query the max payload size of a qp
1946 * @qp: NTB transport layer queue to be queried
1948 * Query the maximum payload size permissible on the given qp
1950 * RETURNS: the max payload size of a qp
1952 unsigned int ntb_transport_max_size(struct ntb_transport_qp
*qp
)
1960 return qp
->tx_max_frame
- sizeof(struct ntb_payload_header
);
1962 /* If DMA engine usage is possible, try to find the max size for that */
1963 max
= qp
->tx_max_frame
- sizeof(struct ntb_payload_header
);
1964 max
-= max
% (1 << qp
->dma_chan
->device
->copy_align
);
1968 EXPORT_SYMBOL_GPL(ntb_transport_max_size
);
1970 static void ntb_transport_doorbell_callback(void *data
, int vector
)
1972 struct ntb_transport_ctx
*nt
= data
;
1973 struct ntb_transport_qp
*qp
;
1975 unsigned int qp_num
;
1977 db_bits
= (nt
->qp_bitmap
& ~nt
->qp_bitmap_free
&
1978 ntb_db_vector_mask(nt
->ndev
, vector
));
1981 qp_num
= __ffs(db_bits
);
1982 qp
= &nt
->qp_vec
[qp_num
];
1984 tasklet_schedule(&qp
->rxc_db_work
);
1986 db_bits
&= ~BIT_ULL(qp_num
);
1990 static const struct ntb_ctx_ops ntb_transport_ops
= {
1991 .link_event
= ntb_transport_event_callback
,
1992 .db_event
= ntb_transport_doorbell_callback
,
1995 static struct ntb_client ntb_transport_client
= {
1997 .probe
= ntb_transport_probe
,
1998 .remove
= ntb_transport_free
,
2002 static int __init
ntb_transport_init(void)
2006 pr_info("%s, version %s\n", NTB_TRANSPORT_DESC
, NTB_TRANSPORT_VER
);
2008 if (debugfs_initialized())
2009 nt_debugfs_dir
= debugfs_create_dir(KBUILD_MODNAME
, NULL
);
2011 rc
= bus_register(&ntb_transport_bus
);
2015 rc
= ntb_register_client(&ntb_transport_client
);
2022 bus_unregister(&ntb_transport_bus
);
2024 debugfs_remove_recursive(nt_debugfs_dir
);
2027 module_init(ntb_transport_init
);
2029 static void __exit
ntb_transport_exit(void)
2031 debugfs_remove_recursive(nt_debugfs_dir
);
2033 ntb_unregister_client(&ntb_transport_client
);
2034 bus_unregister(&ntb_transport_bus
);
2036 module_exit(ntb_transport_exit
);