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 */
107 unsigned int tx_index
;
108 unsigned int rx_index
;
110 struct ntb_transport_qp
*qp
;
112 struct ntb_payload_header __iomem
*tx_hdr
;
113 struct ntb_payload_header
*rx_hdr
;
121 struct ntb_transport_qp
{
122 struct ntb_transport_ctx
*transport
;
123 struct ntb_dev
*ndev
;
125 struct dma_chan
*tx_dma_chan
;
126 struct dma_chan
*rx_dma_chan
;
132 u8 qp_num
; /* Only 64 QP's are allowed. 0-63 */
135 struct ntb_rx_info __iomem
*rx_info
;
136 struct ntb_rx_info
*remote_rx_info
;
138 void (*tx_handler
)(struct ntb_transport_qp
*qp
, void *qp_data
,
139 void *data
, int len
);
140 struct list_head tx_free_q
;
141 spinlock_t ntb_tx_free_q_lock
;
143 dma_addr_t tx_mw_phys
;
144 unsigned int tx_index
;
145 unsigned int tx_max_entry
;
146 unsigned int tx_max_frame
;
148 void (*rx_handler
)(struct ntb_transport_qp
*qp
, void *qp_data
,
149 void *data
, int len
);
150 struct list_head rx_post_q
;
151 struct list_head rx_pend_q
;
152 struct list_head rx_free_q
;
153 /* ntb_rx_q_lock: synchronize access to rx_XXXX_q */
154 spinlock_t ntb_rx_q_lock
;
156 unsigned int rx_index
;
157 unsigned int rx_max_entry
;
158 unsigned int rx_max_frame
;
159 unsigned int rx_alloc_entry
;
160 dma_cookie_t last_cookie
;
161 struct tasklet_struct rxc_db_work
;
163 void (*event_handler
)(void *data
, int status
);
164 struct delayed_work link_work
;
165 struct work_struct link_cleanup
;
167 struct dentry
*debugfs_dir
;
168 struct dentry
*debugfs_stats
;
189 struct ntb_transport_mw
{
190 phys_addr_t phys_addr
;
191 resource_size_t phys_size
;
192 resource_size_t xlat_align
;
193 resource_size_t xlat_align_size
;
201 struct ntb_transport_client_dev
{
202 struct list_head entry
;
203 struct ntb_transport_ctx
*nt
;
207 struct ntb_transport_ctx
{
208 struct list_head entry
;
209 struct list_head client_devs
;
211 struct ntb_dev
*ndev
;
213 struct ntb_transport_mw
*mw_vec
;
214 struct ntb_transport_qp
*qp_vec
;
215 unsigned int mw_count
;
216 unsigned int qp_count
;
221 struct delayed_work link_work
;
222 struct work_struct link_cleanup
;
224 struct dentry
*debugfs_node_dir
;
228 DESC_DONE_FLAG
= BIT(0),
229 LINK_DOWN_FLAG
= BIT(1),
232 struct ntb_payload_header
{
250 #define dev_client_dev(__dev) \
251 container_of((__dev), struct ntb_transport_client_dev, dev)
253 #define drv_client(__drv) \
254 container_of((__drv), struct ntb_transport_client, driver)
256 #define QP_TO_MW(nt, qp) ((qp) % nt->mw_count)
257 #define NTB_QP_DEF_NUM_ENTRIES 100
258 #define NTB_LINK_DOWN_TIMEOUT 10
259 #define DMA_RETRIES 20
260 #define DMA_OUT_RESOURCE_TO msecs_to_jiffies(50)
262 static void ntb_transport_rxc_db(unsigned long data
);
263 static const struct ntb_ctx_ops ntb_transport_ops
;
264 static struct ntb_client ntb_transport_client
;
265 static int ntb_async_tx_submit(struct ntb_transport_qp
*qp
,
266 struct ntb_queue_entry
*entry
);
267 static void ntb_memcpy_tx(struct ntb_queue_entry
*entry
, void __iomem
*offset
);
268 static int ntb_async_rx_submit(struct ntb_queue_entry
*entry
, void *offset
);
269 static void ntb_memcpy_rx(struct ntb_queue_entry
*entry
, void *offset
);
272 static int ntb_transport_bus_match(struct device
*dev
,
273 struct device_driver
*drv
)
275 return !strncmp(dev_name(dev
), drv
->name
, strlen(drv
->name
));
278 static int ntb_transport_bus_probe(struct device
*dev
)
280 const struct ntb_transport_client
*client
;
285 client
= drv_client(dev
->driver
);
286 rc
= client
->probe(dev
);
293 static int ntb_transport_bus_remove(struct device
*dev
)
295 const struct ntb_transport_client
*client
;
297 client
= drv_client(dev
->driver
);
305 static struct bus_type ntb_transport_bus
= {
306 .name
= "ntb_transport",
307 .match
= ntb_transport_bus_match
,
308 .probe
= ntb_transport_bus_probe
,
309 .remove
= ntb_transport_bus_remove
,
312 static LIST_HEAD(ntb_transport_list
);
314 static int ntb_bus_init(struct ntb_transport_ctx
*nt
)
316 list_add_tail(&nt
->entry
, &ntb_transport_list
);
320 static void ntb_bus_remove(struct ntb_transport_ctx
*nt
)
322 struct ntb_transport_client_dev
*client_dev
, *cd
;
324 list_for_each_entry_safe(client_dev
, cd
, &nt
->client_devs
, entry
) {
325 dev_err(client_dev
->dev
.parent
, "%s still attached to bus, removing\n",
326 dev_name(&client_dev
->dev
));
327 list_del(&client_dev
->entry
);
328 device_unregister(&client_dev
->dev
);
331 list_del(&nt
->entry
);
334 static void ntb_transport_client_release(struct device
*dev
)
336 struct ntb_transport_client_dev
*client_dev
;
338 client_dev
= dev_client_dev(dev
);
343 * ntb_transport_unregister_client_dev - Unregister NTB client device
344 * @device_name: Name of NTB client device
346 * Unregister an NTB client device with the NTB transport layer
348 void ntb_transport_unregister_client_dev(char *device_name
)
350 struct ntb_transport_client_dev
*client
, *cd
;
351 struct ntb_transport_ctx
*nt
;
353 list_for_each_entry(nt
, &ntb_transport_list
, entry
)
354 list_for_each_entry_safe(client
, cd
, &nt
->client_devs
, entry
)
355 if (!strncmp(dev_name(&client
->dev
), device_name
,
356 strlen(device_name
))) {
357 list_del(&client
->entry
);
358 device_unregister(&client
->dev
);
361 EXPORT_SYMBOL_GPL(ntb_transport_unregister_client_dev
);
364 * ntb_transport_register_client_dev - Register NTB client device
365 * @device_name: Name of NTB client device
367 * Register an NTB client device with the NTB transport layer
369 int ntb_transport_register_client_dev(char *device_name
)
371 struct ntb_transport_client_dev
*client_dev
;
372 struct ntb_transport_ctx
*nt
;
376 if (list_empty(&ntb_transport_list
))
379 list_for_each_entry(nt
, &ntb_transport_list
, entry
) {
382 node
= dev_to_node(&nt
->ndev
->dev
);
384 client_dev
= kzalloc_node(sizeof(*client_dev
),
391 dev
= &client_dev
->dev
;
393 /* setup and register client devices */
394 dev_set_name(dev
, "%s%d", device_name
, i
);
395 dev
->bus
= &ntb_transport_bus
;
396 dev
->release
= ntb_transport_client_release
;
397 dev
->parent
= &nt
->ndev
->dev
;
399 rc
= device_register(dev
);
405 list_add_tail(&client_dev
->entry
, &nt
->client_devs
);
412 ntb_transport_unregister_client_dev(device_name
);
416 EXPORT_SYMBOL_GPL(ntb_transport_register_client_dev
);
419 * ntb_transport_register_client - Register NTB client driver
420 * @drv: NTB client driver to be registered
422 * Register an NTB client driver with the NTB transport layer
424 * RETURNS: An appropriate -ERRNO error value on error, or zero for success.
426 int ntb_transport_register_client(struct ntb_transport_client
*drv
)
428 drv
->driver
.bus
= &ntb_transport_bus
;
430 if (list_empty(&ntb_transport_list
))
433 return driver_register(&drv
->driver
);
435 EXPORT_SYMBOL_GPL(ntb_transport_register_client
);
438 * ntb_transport_unregister_client - Unregister NTB client driver
439 * @drv: NTB client driver to be unregistered
441 * Unregister an NTB client driver with the NTB transport layer
443 * RETURNS: An appropriate -ERRNO error value on error, or zero for success.
445 void ntb_transport_unregister_client(struct ntb_transport_client
*drv
)
447 driver_unregister(&drv
->driver
);
449 EXPORT_SYMBOL_GPL(ntb_transport_unregister_client
);
451 static ssize_t
debugfs_read(struct file
*filp
, char __user
*ubuf
, size_t count
,
454 struct ntb_transport_qp
*qp
;
456 ssize_t ret
, out_offset
, out_count
;
458 qp
= filp
->private_data
;
460 if (!qp
|| !qp
->link_is_up
)
465 buf
= kmalloc(out_count
, GFP_KERNEL
);
470 out_offset
+= snprintf(buf
+ out_offset
, out_count
- out_offset
,
471 "\nNTB QP stats:\n\n");
472 out_offset
+= snprintf(buf
+ out_offset
, out_count
- out_offset
,
473 "rx_bytes - \t%llu\n", qp
->rx_bytes
);
474 out_offset
+= snprintf(buf
+ out_offset
, out_count
- out_offset
,
475 "rx_pkts - \t%llu\n", qp
->rx_pkts
);
476 out_offset
+= snprintf(buf
+ out_offset
, out_count
- out_offset
,
477 "rx_memcpy - \t%llu\n", qp
->rx_memcpy
);
478 out_offset
+= snprintf(buf
+ out_offset
, out_count
- out_offset
,
479 "rx_async - \t%llu\n", qp
->rx_async
);
480 out_offset
+= snprintf(buf
+ out_offset
, out_count
- out_offset
,
481 "rx_ring_empty - %llu\n", qp
->rx_ring_empty
);
482 out_offset
+= snprintf(buf
+ out_offset
, out_count
- out_offset
,
483 "rx_err_no_buf - %llu\n", qp
->rx_err_no_buf
);
484 out_offset
+= snprintf(buf
+ out_offset
, out_count
- out_offset
,
485 "rx_err_oflow - \t%llu\n", qp
->rx_err_oflow
);
486 out_offset
+= snprintf(buf
+ out_offset
, out_count
- out_offset
,
487 "rx_err_ver - \t%llu\n", qp
->rx_err_ver
);
488 out_offset
+= snprintf(buf
+ out_offset
, out_count
- out_offset
,
489 "rx_buff - \t0x%p\n", qp
->rx_buff
);
490 out_offset
+= snprintf(buf
+ out_offset
, out_count
- out_offset
,
491 "rx_index - \t%u\n", qp
->rx_index
);
492 out_offset
+= snprintf(buf
+ out_offset
, out_count
- out_offset
,
493 "rx_max_entry - \t%u\n", qp
->rx_max_entry
);
494 out_offset
+= snprintf(buf
+ out_offset
, out_count
- out_offset
,
495 "rx_alloc_entry - \t%u\n\n", qp
->rx_alloc_entry
);
497 out_offset
+= snprintf(buf
+ out_offset
, out_count
- out_offset
,
498 "tx_bytes - \t%llu\n", qp
->tx_bytes
);
499 out_offset
+= snprintf(buf
+ out_offset
, out_count
- out_offset
,
500 "tx_pkts - \t%llu\n", qp
->tx_pkts
);
501 out_offset
+= snprintf(buf
+ out_offset
, out_count
- out_offset
,
502 "tx_memcpy - \t%llu\n", qp
->tx_memcpy
);
503 out_offset
+= snprintf(buf
+ out_offset
, out_count
- out_offset
,
504 "tx_async - \t%llu\n", qp
->tx_async
);
505 out_offset
+= snprintf(buf
+ out_offset
, out_count
- out_offset
,
506 "tx_ring_full - \t%llu\n", qp
->tx_ring_full
);
507 out_offset
+= snprintf(buf
+ out_offset
, out_count
- out_offset
,
508 "tx_err_no_buf - %llu\n", qp
->tx_err_no_buf
);
509 out_offset
+= snprintf(buf
+ out_offset
, out_count
- out_offset
,
510 "tx_mw - \t0x%p\n", qp
->tx_mw
);
511 out_offset
+= snprintf(buf
+ out_offset
, out_count
- out_offset
,
512 "tx_index (H) - \t%u\n", qp
->tx_index
);
513 out_offset
+= snprintf(buf
+ out_offset
, out_count
- out_offset
,
515 qp
->remote_rx_info
->entry
);
516 out_offset
+= snprintf(buf
+ out_offset
, out_count
- out_offset
,
517 "tx_max_entry - \t%u\n", qp
->tx_max_entry
);
518 out_offset
+= snprintf(buf
+ out_offset
, out_count
- out_offset
,
520 ntb_transport_tx_free_entry(qp
));
521 out_offset
+= snprintf(buf
+ out_offset
, out_count
- out_offset
,
522 "DMA tx prep err - \t%llu\n",
523 qp
->dma_tx_prep_err
);
524 out_offset
+= snprintf(buf
+ out_offset
, out_count
- out_offset
,
525 "DMA rx prep err - \t%llu\n",
526 qp
->dma_rx_prep_err
);
528 out_offset
+= snprintf(buf
+ out_offset
, out_count
- out_offset
,
530 out_offset
+= snprintf(buf
+ out_offset
, out_count
- out_offset
,
531 "Using TX DMA - \t%s\n",
532 qp
->tx_dma_chan
? "Yes" : "No");
533 out_offset
+= snprintf(buf
+ out_offset
, out_count
- out_offset
,
534 "Using RX DMA - \t%s\n",
535 qp
->rx_dma_chan
? "Yes" : "No");
536 out_offset
+= snprintf(buf
+ out_offset
, out_count
- out_offset
,
538 qp
->link_is_up
? "Up" : "Down");
539 out_offset
+= snprintf(buf
+ out_offset
, out_count
- out_offset
,
542 if (out_offset
> out_count
)
543 out_offset
= out_count
;
545 ret
= simple_read_from_buffer(ubuf
, count
, offp
, buf
, out_offset
);
550 static const struct file_operations ntb_qp_debugfs_stats
= {
551 .owner
= THIS_MODULE
,
553 .read
= debugfs_read
,
556 static void ntb_list_add(spinlock_t
*lock
, struct list_head
*entry
,
557 struct list_head
*list
)
561 spin_lock_irqsave(lock
, flags
);
562 list_add_tail(entry
, list
);
563 spin_unlock_irqrestore(lock
, flags
);
566 static struct ntb_queue_entry
*ntb_list_rm(spinlock_t
*lock
,
567 struct list_head
*list
)
569 struct ntb_queue_entry
*entry
;
572 spin_lock_irqsave(lock
, flags
);
573 if (list_empty(list
)) {
577 entry
= list_first_entry(list
, struct ntb_queue_entry
, entry
);
578 list_del(&entry
->entry
);
581 spin_unlock_irqrestore(lock
, flags
);
586 static struct ntb_queue_entry
*ntb_list_mv(spinlock_t
*lock
,
587 struct list_head
*list
,
588 struct list_head
*to_list
)
590 struct ntb_queue_entry
*entry
;
593 spin_lock_irqsave(lock
, flags
);
595 if (list_empty(list
)) {
598 entry
= list_first_entry(list
, struct ntb_queue_entry
, entry
);
599 list_move_tail(&entry
->entry
, to_list
);
602 spin_unlock_irqrestore(lock
, flags
);
607 static int ntb_transport_setup_qp_mw(struct ntb_transport_ctx
*nt
,
610 struct ntb_transport_qp
*qp
= &nt
->qp_vec
[qp_num
];
611 struct ntb_transport_mw
*mw
;
612 struct ntb_dev
*ndev
= nt
->ndev
;
613 struct ntb_queue_entry
*entry
;
614 unsigned int rx_size
, num_qps_mw
;
615 unsigned int mw_num
, mw_count
, qp_count
;
619 mw_count
= nt
->mw_count
;
620 qp_count
= nt
->qp_count
;
622 mw_num
= QP_TO_MW(nt
, qp_num
);
623 mw
= &nt
->mw_vec
[mw_num
];
628 if (qp_count
% mw_count
&& mw_num
+ 1 < qp_count
/ mw_count
)
629 num_qps_mw
= qp_count
/ mw_count
+ 1;
631 num_qps_mw
= qp_count
/ mw_count
;
633 rx_size
= (unsigned int)mw
->xlat_size
/ num_qps_mw
;
634 qp
->rx_buff
= mw
->virt_addr
+ rx_size
* (qp_num
/ mw_count
);
635 rx_size
-= sizeof(struct ntb_rx_info
);
637 qp
->remote_rx_info
= qp
->rx_buff
+ rx_size
;
639 /* Due to housekeeping, there must be atleast 2 buffs */
640 qp
->rx_max_frame
= min(transport_mtu
, rx_size
/ 2);
641 qp
->rx_max_entry
= rx_size
/ qp
->rx_max_frame
;
645 * Checking to see if we have more entries than the default.
646 * We should add additional entries if that is the case so we
647 * can be in sync with the transport frames.
649 node
= dev_to_node(&ndev
->dev
);
650 for (i
= qp
->rx_alloc_entry
; i
< qp
->rx_max_entry
; i
++) {
651 entry
= kzalloc_node(sizeof(*entry
), GFP_ATOMIC
, node
);
656 ntb_list_add(&qp
->ntb_rx_q_lock
, &entry
->entry
,
658 qp
->rx_alloc_entry
++;
661 qp
->remote_rx_info
->entry
= qp
->rx_max_entry
- 1;
663 /* setup the hdr offsets with 0's */
664 for (i
= 0; i
< qp
->rx_max_entry
; i
++) {
665 void *offset
= (qp
->rx_buff
+ qp
->rx_max_frame
* (i
+ 1) -
666 sizeof(struct ntb_payload_header
));
667 memset(offset
, 0, sizeof(struct ntb_payload_header
));
677 static void ntb_free_mw(struct ntb_transport_ctx
*nt
, int num_mw
)
679 struct ntb_transport_mw
*mw
= &nt
->mw_vec
[num_mw
];
680 struct pci_dev
*pdev
= nt
->ndev
->pdev
;
685 ntb_mw_clear_trans(nt
->ndev
, num_mw
);
686 dma_free_coherent(&pdev
->dev
, mw
->buff_size
,
687 mw
->virt_addr
, mw
->dma_addr
);
690 mw
->virt_addr
= NULL
;
693 static int ntb_set_mw(struct ntb_transport_ctx
*nt
, int num_mw
,
694 resource_size_t size
)
696 struct ntb_transport_mw
*mw
= &nt
->mw_vec
[num_mw
];
697 struct pci_dev
*pdev
= nt
->ndev
->pdev
;
698 size_t xlat_size
, buff_size
;
704 xlat_size
= round_up(size
, mw
->xlat_align_size
);
705 buff_size
= round_up(size
, mw
->xlat_align
);
707 /* No need to re-setup */
708 if (mw
->xlat_size
== xlat_size
)
712 ntb_free_mw(nt
, num_mw
);
714 /* Alloc memory for receiving data. Must be aligned */
715 mw
->xlat_size
= xlat_size
;
716 mw
->buff_size
= buff_size
;
718 mw
->virt_addr
= dma_alloc_coherent(&pdev
->dev
, buff_size
,
719 &mw
->dma_addr
, GFP_KERNEL
);
720 if (!mw
->virt_addr
) {
723 dev_err(&pdev
->dev
, "Unable to alloc MW buff of size %zu\n",
729 * we must ensure that the memory address allocated is BAR size
730 * aligned in order for the XLAT register to take the value. This
731 * is a requirement of the hardware. It is recommended to setup CMA
732 * for BAR sizes equal or greater than 4MB.
734 if (!IS_ALIGNED(mw
->dma_addr
, mw
->xlat_align
)) {
735 dev_err(&pdev
->dev
, "DMA memory %pad is not aligned\n",
737 ntb_free_mw(nt
, num_mw
);
741 /* Notify HW the memory location of the receive buffer */
742 rc
= ntb_mw_set_trans(nt
->ndev
, num_mw
, mw
->dma_addr
, mw
->xlat_size
);
744 dev_err(&pdev
->dev
, "Unable to set mw%d translation", num_mw
);
745 ntb_free_mw(nt
, num_mw
);
752 static void ntb_qp_link_down_reset(struct ntb_transport_qp
*qp
)
754 qp
->link_is_up
= false;
761 qp
->rx_ring_empty
= 0;
762 qp
->rx_err_no_buf
= 0;
763 qp
->rx_err_oflow
= 0;
769 qp
->tx_ring_full
= 0;
770 qp
->tx_err_no_buf
= 0;
773 qp
->dma_tx_prep_err
= 0;
774 qp
->dma_rx_prep_err
= 0;
777 static void ntb_qp_link_cleanup(struct ntb_transport_qp
*qp
)
779 struct ntb_transport_ctx
*nt
= qp
->transport
;
780 struct pci_dev
*pdev
= nt
->ndev
->pdev
;
782 dev_info(&pdev
->dev
, "qp %d: Link Cleanup\n", qp
->qp_num
);
784 cancel_delayed_work_sync(&qp
->link_work
);
785 ntb_qp_link_down_reset(qp
);
787 if (qp
->event_handler
)
788 qp
->event_handler(qp
->cb_data
, qp
->link_is_up
);
791 static void ntb_qp_link_cleanup_work(struct work_struct
*work
)
793 struct ntb_transport_qp
*qp
= container_of(work
,
794 struct ntb_transport_qp
,
796 struct ntb_transport_ctx
*nt
= qp
->transport
;
798 ntb_qp_link_cleanup(qp
);
801 schedule_delayed_work(&qp
->link_work
,
802 msecs_to_jiffies(NTB_LINK_DOWN_TIMEOUT
));
805 static void ntb_qp_link_down(struct ntb_transport_qp
*qp
)
807 schedule_work(&qp
->link_cleanup
);
810 static void ntb_transport_link_cleanup(struct ntb_transport_ctx
*nt
)
812 struct ntb_transport_qp
*qp
;
816 qp_bitmap_alloc
= nt
->qp_bitmap
& ~nt
->qp_bitmap_free
;
818 /* Pass along the info to any clients */
819 for (i
= 0; i
< nt
->qp_count
; i
++)
820 if (qp_bitmap_alloc
& BIT_ULL(i
)) {
822 ntb_qp_link_cleanup(qp
);
823 cancel_work_sync(&qp
->link_cleanup
);
824 cancel_delayed_work_sync(&qp
->link_work
);
828 cancel_delayed_work_sync(&nt
->link_work
);
830 /* The scratchpad registers keep the values if the remote side
831 * goes down, blast them now to give them a sane value the next
832 * time they are accessed
834 for (i
= 0; i
< MAX_SPAD
; i
++)
835 ntb_spad_write(nt
->ndev
, i
, 0);
838 static void ntb_transport_link_cleanup_work(struct work_struct
*work
)
840 struct ntb_transport_ctx
*nt
=
841 container_of(work
, struct ntb_transport_ctx
, link_cleanup
);
843 ntb_transport_link_cleanup(nt
);
846 static void ntb_transport_event_callback(void *data
)
848 struct ntb_transport_ctx
*nt
= data
;
850 if (ntb_link_is_up(nt
->ndev
, NULL
, NULL
) == 1)
851 schedule_delayed_work(&nt
->link_work
, 0);
853 schedule_work(&nt
->link_cleanup
);
856 static void ntb_transport_link_work(struct work_struct
*work
)
858 struct ntb_transport_ctx
*nt
=
859 container_of(work
, struct ntb_transport_ctx
, link_work
.work
);
860 struct ntb_dev
*ndev
= nt
->ndev
;
861 struct pci_dev
*pdev
= ndev
->pdev
;
862 resource_size_t size
;
866 /* send the local info, in the opposite order of the way we read it */
867 for (i
= 0; i
< nt
->mw_count
; i
++) {
868 size
= nt
->mw_vec
[i
].phys_size
;
870 if (max_mw_size
&& size
> max_mw_size
)
873 spad
= MW0_SZ_HIGH
+ (i
* 2);
874 ntb_peer_spad_write(ndev
, spad
, upper_32_bits(size
));
876 spad
= MW0_SZ_LOW
+ (i
* 2);
877 ntb_peer_spad_write(ndev
, spad
, lower_32_bits(size
));
880 ntb_peer_spad_write(ndev
, NUM_MWS
, nt
->mw_count
);
882 ntb_peer_spad_write(ndev
, NUM_QPS
, nt
->qp_count
);
884 ntb_peer_spad_write(ndev
, VERSION
, NTB_TRANSPORT_VERSION
);
886 /* Query the remote side for its info */
887 val
= ntb_spad_read(ndev
, VERSION
);
888 dev_dbg(&pdev
->dev
, "Remote version = %d\n", val
);
889 if (val
!= NTB_TRANSPORT_VERSION
)
892 val
= ntb_spad_read(ndev
, NUM_QPS
);
893 dev_dbg(&pdev
->dev
, "Remote max number of qps = %d\n", val
);
894 if (val
!= nt
->qp_count
)
897 val
= ntb_spad_read(ndev
, NUM_MWS
);
898 dev_dbg(&pdev
->dev
, "Remote number of mws = %d\n", val
);
899 if (val
!= nt
->mw_count
)
902 for (i
= 0; i
< nt
->mw_count
; i
++) {
905 val
= ntb_spad_read(ndev
, MW0_SZ_HIGH
+ (i
* 2));
906 val64
= (u64
)val
<< 32;
908 val
= ntb_spad_read(ndev
, MW0_SZ_LOW
+ (i
* 2));
911 dev_dbg(&pdev
->dev
, "Remote MW%d size = %#llx\n", i
, val64
);
913 rc
= ntb_set_mw(nt
, i
, val64
);
918 nt
->link_is_up
= true;
920 for (i
= 0; i
< nt
->qp_count
; i
++) {
921 struct ntb_transport_qp
*qp
= &nt
->qp_vec
[i
];
923 ntb_transport_setup_qp_mw(nt
, i
);
925 if (qp
->client_ready
)
926 schedule_delayed_work(&qp
->link_work
, 0);
932 for (i
= 0; i
< nt
->mw_count
; i
++)
935 /* if there's an actual failure, we should just bail */
937 ntb_link_disable(ndev
);
942 if (ntb_link_is_up(ndev
, NULL
, NULL
) == 1)
943 schedule_delayed_work(&nt
->link_work
,
944 msecs_to_jiffies(NTB_LINK_DOWN_TIMEOUT
));
947 static void ntb_qp_link_work(struct work_struct
*work
)
949 struct ntb_transport_qp
*qp
= container_of(work
,
950 struct ntb_transport_qp
,
952 struct pci_dev
*pdev
= qp
->ndev
->pdev
;
953 struct ntb_transport_ctx
*nt
= qp
->transport
;
956 WARN_ON(!nt
->link_is_up
);
958 val
= ntb_spad_read(nt
->ndev
, QP_LINKS
);
960 ntb_peer_spad_write(nt
->ndev
, QP_LINKS
, val
| BIT(qp
->qp_num
));
962 /* query remote spad for qp ready bits */
963 ntb_peer_spad_read(nt
->ndev
, QP_LINKS
);
964 dev_dbg_ratelimited(&pdev
->dev
, "Remote QP link status = %x\n", val
);
966 /* See if the remote side is up */
967 if (val
& BIT(qp
->qp_num
)) {
968 dev_info(&pdev
->dev
, "qp %d: Link Up\n", qp
->qp_num
);
969 qp
->link_is_up
= true;
972 if (qp
->event_handler
)
973 qp
->event_handler(qp
->cb_data
, qp
->link_is_up
);
976 tasklet_schedule(&qp
->rxc_db_work
);
977 } else if (nt
->link_is_up
)
978 schedule_delayed_work(&qp
->link_work
,
979 msecs_to_jiffies(NTB_LINK_DOWN_TIMEOUT
));
982 static int ntb_transport_init_queue(struct ntb_transport_ctx
*nt
,
985 struct ntb_transport_qp
*qp
;
987 resource_size_t mw_size
;
988 unsigned int num_qps_mw
, tx_size
;
989 unsigned int mw_num
, mw_count
, qp_count
;
992 mw_count
= nt
->mw_count
;
993 qp_count
= nt
->qp_count
;
995 mw_num
= QP_TO_MW(nt
, qp_num
);
997 qp
= &nt
->qp_vec
[qp_num
];
1000 qp
->ndev
= nt
->ndev
;
1001 qp
->client_ready
= false;
1002 qp
->event_handler
= NULL
;
1003 ntb_qp_link_down_reset(qp
);
1005 if (qp_count
% mw_count
&& mw_num
+ 1 < qp_count
/ mw_count
)
1006 num_qps_mw
= qp_count
/ mw_count
+ 1;
1008 num_qps_mw
= qp_count
/ mw_count
;
1010 mw_base
= nt
->mw_vec
[mw_num
].phys_addr
;
1011 mw_size
= nt
->mw_vec
[mw_num
].phys_size
;
1013 tx_size
= (unsigned int)mw_size
/ num_qps_mw
;
1014 qp_offset
= tx_size
* (qp_num
/ mw_count
);
1016 qp
->tx_mw
= nt
->mw_vec
[mw_num
].vbase
+ qp_offset
;
1020 qp
->tx_mw_phys
= mw_base
+ qp_offset
;
1021 if (!qp
->tx_mw_phys
)
1024 tx_size
-= sizeof(struct ntb_rx_info
);
1025 qp
->rx_info
= qp
->tx_mw
+ tx_size
;
1027 /* Due to housekeeping, there must be atleast 2 buffs */
1028 qp
->tx_max_frame
= min(transport_mtu
, tx_size
/ 2);
1029 qp
->tx_max_entry
= tx_size
/ qp
->tx_max_frame
;
1031 if (nt
->debugfs_node_dir
) {
1032 char debugfs_name
[4];
1034 snprintf(debugfs_name
, 4, "qp%d", qp_num
);
1035 qp
->debugfs_dir
= debugfs_create_dir(debugfs_name
,
1036 nt
->debugfs_node_dir
);
1038 qp
->debugfs_stats
= debugfs_create_file("stats", S_IRUSR
,
1039 qp
->debugfs_dir
, qp
,
1040 &ntb_qp_debugfs_stats
);
1042 qp
->debugfs_dir
= NULL
;
1043 qp
->debugfs_stats
= NULL
;
1046 INIT_DELAYED_WORK(&qp
->link_work
, ntb_qp_link_work
);
1047 INIT_WORK(&qp
->link_cleanup
, ntb_qp_link_cleanup_work
);
1049 spin_lock_init(&qp
->ntb_rx_q_lock
);
1050 spin_lock_init(&qp
->ntb_tx_free_q_lock
);
1052 INIT_LIST_HEAD(&qp
->rx_post_q
);
1053 INIT_LIST_HEAD(&qp
->rx_pend_q
);
1054 INIT_LIST_HEAD(&qp
->rx_free_q
);
1055 INIT_LIST_HEAD(&qp
->tx_free_q
);
1057 tasklet_init(&qp
->rxc_db_work
, ntb_transport_rxc_db
,
1063 static int ntb_transport_probe(struct ntb_client
*self
, struct ntb_dev
*ndev
)
1065 struct ntb_transport_ctx
*nt
;
1066 struct ntb_transport_mw
*mw
;
1067 unsigned int mw_count
, qp_count
;
1072 mw_count
= ntb_mw_count(ndev
);
1073 if (ntb_spad_count(ndev
) < (NUM_MWS
+ 1 + mw_count
* 2)) {
1074 dev_err(&ndev
->dev
, "Not enough scratch pad registers for %s",
1075 NTB_TRANSPORT_NAME
);
1079 if (ntb_db_is_unsafe(ndev
))
1081 "doorbell is unsafe, proceed anyway...\n");
1082 if (ntb_spad_is_unsafe(ndev
))
1084 "scratchpad is unsafe, proceed anyway...\n");
1086 node
= dev_to_node(&ndev
->dev
);
1088 nt
= kzalloc_node(sizeof(*nt
), GFP_KERNEL
, node
);
1094 nt
->mw_count
= mw_count
;
1096 nt
->mw_vec
= kzalloc_node(mw_count
* sizeof(*nt
->mw_vec
),
1103 for (i
= 0; i
< mw_count
; i
++) {
1104 mw
= &nt
->mw_vec
[i
];
1106 rc
= ntb_mw_get_range(ndev
, i
, &mw
->phys_addr
, &mw
->phys_size
,
1107 &mw
->xlat_align
, &mw
->xlat_align_size
);
1111 mw
->vbase
= ioremap_wc(mw
->phys_addr
, mw
->phys_size
);
1119 mw
->virt_addr
= NULL
;
1123 qp_bitmap
= ntb_db_valid_mask(ndev
);
1125 qp_count
= ilog2(qp_bitmap
);
1126 if (max_num_clients
&& max_num_clients
< qp_count
)
1127 qp_count
= max_num_clients
;
1128 else if (mw_count
< qp_count
)
1129 qp_count
= mw_count
;
1131 qp_bitmap
&= BIT_ULL(qp_count
) - 1;
1133 nt
->qp_count
= qp_count
;
1134 nt
->qp_bitmap
= qp_bitmap
;
1135 nt
->qp_bitmap_free
= qp_bitmap
;
1137 nt
->qp_vec
= kzalloc_node(qp_count
* sizeof(*nt
->qp_vec
),
1144 if (nt_debugfs_dir
) {
1145 nt
->debugfs_node_dir
=
1146 debugfs_create_dir(pci_name(ndev
->pdev
),
1150 for (i
= 0; i
< qp_count
; i
++) {
1151 rc
= ntb_transport_init_queue(nt
, i
);
1156 INIT_DELAYED_WORK(&nt
->link_work
, ntb_transport_link_work
);
1157 INIT_WORK(&nt
->link_cleanup
, ntb_transport_link_cleanup_work
);
1159 rc
= ntb_set_ctx(ndev
, nt
, &ntb_transport_ops
);
1163 INIT_LIST_HEAD(&nt
->client_devs
);
1164 rc
= ntb_bus_init(nt
);
1168 nt
->link_is_up
= false;
1169 ntb_link_enable(ndev
, NTB_SPEED_AUTO
, NTB_WIDTH_AUTO
);
1170 ntb_link_event(ndev
);
1175 ntb_clear_ctx(ndev
);
1180 mw
= &nt
->mw_vec
[i
];
1189 static void ntb_transport_free(struct ntb_client
*self
, struct ntb_dev
*ndev
)
1191 struct ntb_transport_ctx
*nt
= ndev
->ctx
;
1192 struct ntb_transport_qp
*qp
;
1193 u64 qp_bitmap_alloc
;
1196 ntb_transport_link_cleanup(nt
);
1197 cancel_work_sync(&nt
->link_cleanup
);
1198 cancel_delayed_work_sync(&nt
->link_work
);
1200 qp_bitmap_alloc
= nt
->qp_bitmap
& ~nt
->qp_bitmap_free
;
1202 /* verify that all the qp's are freed */
1203 for (i
= 0; i
< nt
->qp_count
; i
++) {
1204 qp
= &nt
->qp_vec
[i
];
1205 if (qp_bitmap_alloc
& BIT_ULL(i
))
1206 ntb_transport_free_queue(qp
);
1207 debugfs_remove_recursive(qp
->debugfs_dir
);
1210 ntb_link_disable(ndev
);
1211 ntb_clear_ctx(ndev
);
1215 for (i
= nt
->mw_count
; i
--; ) {
1217 iounmap(nt
->mw_vec
[i
].vbase
);
1225 static void ntb_complete_rxc(struct ntb_transport_qp
*qp
)
1227 struct ntb_queue_entry
*entry
;
1230 unsigned long irqflags
;
1232 spin_lock_irqsave(&qp
->ntb_rx_q_lock
, irqflags
);
1234 while (!list_empty(&qp
->rx_post_q
)) {
1235 entry
= list_first_entry(&qp
->rx_post_q
,
1236 struct ntb_queue_entry
, entry
);
1237 if (!(entry
->flags
& DESC_DONE_FLAG
))
1240 entry
->rx_hdr
->flags
= 0;
1241 iowrite32(entry
->rx_index
, &qp
->rx_info
->entry
);
1243 cb_data
= entry
->cb_data
;
1246 list_move_tail(&entry
->entry
, &qp
->rx_free_q
);
1248 spin_unlock_irqrestore(&qp
->ntb_rx_q_lock
, irqflags
);
1250 if (qp
->rx_handler
&& qp
->client_ready
)
1251 qp
->rx_handler(qp
, qp
->cb_data
, cb_data
, len
);
1253 spin_lock_irqsave(&qp
->ntb_rx_q_lock
, irqflags
);
1256 spin_unlock_irqrestore(&qp
->ntb_rx_q_lock
, irqflags
);
1259 static void ntb_rx_copy_callback(void *data
,
1260 const struct dmaengine_result
*res
)
1262 struct ntb_queue_entry
*entry
= data
;
1264 /* we need to check DMA results if we are using DMA */
1266 enum dmaengine_tx_result dma_err
= res
->result
;
1269 case DMA_TRANS_READ_FAILED
:
1270 case DMA_TRANS_WRITE_FAILED
:
1272 case DMA_TRANS_ABORTED
:
1274 struct ntb_transport_qp
*qp
= entry
->qp
;
1275 void *offset
= qp
->rx_buff
+ qp
->rx_max_frame
*
1278 ntb_memcpy_rx(entry
, offset
);
1283 case DMA_TRANS_NOERROR
:
1289 entry
->flags
|= DESC_DONE_FLAG
;
1291 ntb_complete_rxc(entry
->qp
);
1294 static void ntb_memcpy_rx(struct ntb_queue_entry
*entry
, void *offset
)
1296 void *buf
= entry
->buf
;
1297 size_t len
= entry
->len
;
1299 memcpy(buf
, offset
, len
);
1301 /* Ensure that the data is fully copied out before clearing the flag */
1304 ntb_rx_copy_callback(entry
, NULL
);
1307 static int ntb_async_rx_submit(struct ntb_queue_entry
*entry
, void *offset
)
1309 struct dma_async_tx_descriptor
*txd
;
1310 struct ntb_transport_qp
*qp
= entry
->qp
;
1311 struct dma_chan
*chan
= qp
->rx_dma_chan
;
1312 struct dma_device
*device
;
1313 size_t pay_off
, buff_off
, len
;
1314 struct dmaengine_unmap_data
*unmap
;
1315 dma_cookie_t cookie
;
1316 void *buf
= entry
->buf
;
1320 device
= chan
->device
;
1321 pay_off
= (size_t)offset
& ~PAGE_MASK
;
1322 buff_off
= (size_t)buf
& ~PAGE_MASK
;
1324 if (!is_dma_copy_aligned(device
, pay_off
, buff_off
, len
))
1327 unmap
= dmaengine_get_unmap_data(device
->dev
, 2, GFP_NOWAIT
);
1332 unmap
->addr
[0] = dma_map_page(device
->dev
, virt_to_page(offset
),
1333 pay_off
, len
, DMA_TO_DEVICE
);
1334 if (dma_mapping_error(device
->dev
, unmap
->addr
[0]))
1339 unmap
->addr
[1] = dma_map_page(device
->dev
, virt_to_page(buf
),
1340 buff_off
, len
, DMA_FROM_DEVICE
);
1341 if (dma_mapping_error(device
->dev
, unmap
->addr
[1]))
1344 unmap
->from_cnt
= 1;
1346 for (retries
= 0; retries
< DMA_RETRIES
; retries
++) {
1347 txd
= device
->device_prep_dma_memcpy(chan
,
1349 unmap
->addr
[0], len
,
1350 DMA_PREP_INTERRUPT
);
1354 set_current_state(TASK_INTERRUPTIBLE
);
1355 schedule_timeout(DMA_OUT_RESOURCE_TO
);
1359 qp
->dma_rx_prep_err
++;
1363 txd
->callback_result
= ntb_rx_copy_callback
;
1364 txd
->callback_param
= entry
;
1365 dma_set_unmap(txd
, unmap
);
1367 cookie
= dmaengine_submit(txd
);
1368 if (dma_submit_error(cookie
))
1371 dmaengine_unmap_put(unmap
);
1373 qp
->last_cookie
= cookie
;
1380 dmaengine_unmap_put(unmap
);
1382 dmaengine_unmap_put(unmap
);
1387 static void ntb_async_rx(struct ntb_queue_entry
*entry
, void *offset
)
1389 struct ntb_transport_qp
*qp
= entry
->qp
;
1390 struct dma_chan
*chan
= qp
->rx_dma_chan
;
1396 if (entry
->len
< copy_bytes
)
1399 res
= ntb_async_rx_submit(entry
, offset
);
1403 if (!entry
->retries
)
1409 ntb_memcpy_rx(entry
, offset
);
1413 static int ntb_process_rxc(struct ntb_transport_qp
*qp
)
1415 struct ntb_payload_header
*hdr
;
1416 struct ntb_queue_entry
*entry
;
1419 offset
= qp
->rx_buff
+ qp
->rx_max_frame
* qp
->rx_index
;
1420 hdr
= offset
+ qp
->rx_max_frame
- sizeof(struct ntb_payload_header
);
1422 dev_dbg(&qp
->ndev
->pdev
->dev
, "qp %d: RX ver %u len %d flags %x\n",
1423 qp
->qp_num
, hdr
->ver
, hdr
->len
, hdr
->flags
);
1425 if (!(hdr
->flags
& DESC_DONE_FLAG
)) {
1426 dev_dbg(&qp
->ndev
->pdev
->dev
, "done flag not set\n");
1427 qp
->rx_ring_empty
++;
1431 if (hdr
->flags
& LINK_DOWN_FLAG
) {
1432 dev_dbg(&qp
->ndev
->pdev
->dev
, "link down flag set\n");
1433 ntb_qp_link_down(qp
);
1438 if (hdr
->ver
!= (u32
)qp
->rx_pkts
) {
1439 dev_dbg(&qp
->ndev
->pdev
->dev
,
1440 "version mismatch, expected %llu - got %u\n",
1441 qp
->rx_pkts
, hdr
->ver
);
1446 entry
= ntb_list_mv(&qp
->ntb_rx_q_lock
, &qp
->rx_pend_q
, &qp
->rx_post_q
);
1448 dev_dbg(&qp
->ndev
->pdev
->dev
, "no receive buffer\n");
1449 qp
->rx_err_no_buf
++;
1453 entry
->rx_hdr
= hdr
;
1454 entry
->rx_index
= qp
->rx_index
;
1456 if (hdr
->len
> entry
->len
) {
1457 dev_dbg(&qp
->ndev
->pdev
->dev
,
1458 "receive buffer overflow! Wanted %d got %d\n",
1459 hdr
->len
, entry
->len
);
1463 entry
->flags
|= DESC_DONE_FLAG
;
1465 ntb_complete_rxc(qp
);
1467 dev_dbg(&qp
->ndev
->pdev
->dev
,
1468 "RX OK index %u ver %u size %d into buf size %d\n",
1469 qp
->rx_index
, hdr
->ver
, hdr
->len
, entry
->len
);
1471 qp
->rx_bytes
+= hdr
->len
;
1474 entry
->len
= hdr
->len
;
1476 ntb_async_rx(entry
, offset
);
1480 qp
->rx_index
%= qp
->rx_max_entry
;
1485 static void ntb_transport_rxc_db(unsigned long data
)
1487 struct ntb_transport_qp
*qp
= (void *)data
;
1490 dev_dbg(&qp
->ndev
->pdev
->dev
, "%s: doorbell %d received\n",
1491 __func__
, qp
->qp_num
);
1493 /* Limit the number of packets processed in a single interrupt to
1494 * provide fairness to others
1496 for (i
= 0; i
< qp
->rx_max_entry
; i
++) {
1497 rc
= ntb_process_rxc(qp
);
1502 if (i
&& qp
->rx_dma_chan
)
1503 dma_async_issue_pending(qp
->rx_dma_chan
);
1505 if (i
== qp
->rx_max_entry
) {
1506 /* there is more work to do */
1508 tasklet_schedule(&qp
->rxc_db_work
);
1509 } else if (ntb_db_read(qp
->ndev
) & BIT_ULL(qp
->qp_num
)) {
1510 /* the doorbell bit is set: clear it */
1511 ntb_db_clear(qp
->ndev
, BIT_ULL(qp
->qp_num
));
1512 /* ntb_db_read ensures ntb_db_clear write is committed */
1513 ntb_db_read(qp
->ndev
);
1515 /* an interrupt may have arrived between finishing
1516 * ntb_process_rxc and clearing the doorbell bit:
1517 * there might be some more work to do.
1520 tasklet_schedule(&qp
->rxc_db_work
);
1524 static void ntb_tx_copy_callback(void *data
,
1525 const struct dmaengine_result
*res
)
1527 struct ntb_queue_entry
*entry
= data
;
1528 struct ntb_transport_qp
*qp
= entry
->qp
;
1529 struct ntb_payload_header __iomem
*hdr
= entry
->tx_hdr
;
1531 /* we need to check DMA results if we are using DMA */
1533 enum dmaengine_tx_result dma_err
= res
->result
;
1536 case DMA_TRANS_READ_FAILED
:
1537 case DMA_TRANS_WRITE_FAILED
:
1539 case DMA_TRANS_ABORTED
:
1541 void __iomem
*offset
=
1542 qp
->tx_mw
+ qp
->tx_max_frame
*
1545 /* resubmit via CPU */
1546 ntb_memcpy_tx(entry
, offset
);
1551 case DMA_TRANS_NOERROR
:
1557 iowrite32(entry
->flags
| DESC_DONE_FLAG
, &hdr
->flags
);
1559 ntb_peer_db_set(qp
->ndev
, BIT_ULL(qp
->qp_num
));
1561 /* The entry length can only be zero if the packet is intended to be a
1562 * "link down" or similar. Since no payload is being sent in these
1563 * cases, there is nothing to add to the completion queue.
1565 if (entry
->len
> 0) {
1566 qp
->tx_bytes
+= entry
->len
;
1569 qp
->tx_handler(qp
, qp
->cb_data
, entry
->cb_data
,
1573 ntb_list_add(&qp
->ntb_tx_free_q_lock
, &entry
->entry
, &qp
->tx_free_q
);
1576 static void ntb_memcpy_tx(struct ntb_queue_entry
*entry
, void __iomem
*offset
)
1578 #ifdef ARCH_HAS_NOCACHE_UACCESS
1580 * Using non-temporal mov to improve performance on non-cached
1581 * writes, even though we aren't actually copying from user space.
1583 __copy_from_user_inatomic_nocache(offset
, entry
->buf
, entry
->len
);
1585 memcpy_toio(offset
, entry
->buf
, entry
->len
);
1588 /* Ensure that the data is fully copied out before setting the flags */
1591 ntb_tx_copy_callback(entry
, NULL
);
1594 static int ntb_async_tx_submit(struct ntb_transport_qp
*qp
,
1595 struct ntb_queue_entry
*entry
)
1597 struct dma_async_tx_descriptor
*txd
;
1598 struct dma_chan
*chan
= qp
->tx_dma_chan
;
1599 struct dma_device
*device
;
1600 size_t len
= entry
->len
;
1601 void *buf
= entry
->buf
;
1602 size_t dest_off
, buff_off
;
1603 struct dmaengine_unmap_data
*unmap
;
1605 dma_cookie_t cookie
;
1608 device
= chan
->device
;
1609 dest
= qp
->tx_mw_phys
+ qp
->tx_max_frame
* entry
->tx_index
;
1610 buff_off
= (size_t)buf
& ~PAGE_MASK
;
1611 dest_off
= (size_t)dest
& ~PAGE_MASK
;
1613 if (!is_dma_copy_aligned(device
, buff_off
, dest_off
, len
))
1616 unmap
= dmaengine_get_unmap_data(device
->dev
, 1, GFP_NOWAIT
);
1621 unmap
->addr
[0] = dma_map_page(device
->dev
, virt_to_page(buf
),
1622 buff_off
, len
, DMA_TO_DEVICE
);
1623 if (dma_mapping_error(device
->dev
, unmap
->addr
[0]))
1628 for (retries
= 0; retries
< DMA_RETRIES
; retries
++) {
1629 txd
= device
->device_prep_dma_memcpy(chan
, dest
,
1630 unmap
->addr
[0], len
,
1631 DMA_PREP_INTERRUPT
);
1635 set_current_state(TASK_INTERRUPTIBLE
);
1636 schedule_timeout(DMA_OUT_RESOURCE_TO
);
1640 qp
->dma_tx_prep_err
++;
1644 txd
->callback_result
= ntb_tx_copy_callback
;
1645 txd
->callback_param
= entry
;
1646 dma_set_unmap(txd
, unmap
);
1648 cookie
= dmaengine_submit(txd
);
1649 if (dma_submit_error(cookie
))
1652 dmaengine_unmap_put(unmap
);
1654 dma_async_issue_pending(chan
);
1658 dmaengine_unmap_put(unmap
);
1660 dmaengine_unmap_put(unmap
);
1665 static void ntb_async_tx(struct ntb_transport_qp
*qp
,
1666 struct ntb_queue_entry
*entry
)
1668 struct ntb_payload_header __iomem
*hdr
;
1669 struct dma_chan
*chan
= qp
->tx_dma_chan
;
1670 void __iomem
*offset
;
1673 entry
->tx_index
= qp
->tx_index
;
1674 offset
= qp
->tx_mw
+ qp
->tx_max_frame
* entry
->tx_index
;
1675 hdr
= offset
+ qp
->tx_max_frame
- sizeof(struct ntb_payload_header
);
1676 entry
->tx_hdr
= hdr
;
1678 iowrite32(entry
->len
, &hdr
->len
);
1679 iowrite32((u32
)qp
->tx_pkts
, &hdr
->ver
);
1684 if (entry
->len
< copy_bytes
)
1687 res
= ntb_async_tx_submit(qp
, entry
);
1691 if (!entry
->retries
)
1697 ntb_memcpy_tx(entry
, offset
);
1701 static int ntb_process_tx(struct ntb_transport_qp
*qp
,
1702 struct ntb_queue_entry
*entry
)
1704 if (qp
->tx_index
== qp
->remote_rx_info
->entry
) {
1709 if (entry
->len
> qp
->tx_max_frame
- sizeof(struct ntb_payload_header
)) {
1711 qp
->tx_handler(qp
, qp
->cb_data
, NULL
, -EIO
);
1713 ntb_list_add(&qp
->ntb_tx_free_q_lock
, &entry
->entry
,
1718 ntb_async_tx(qp
, entry
);
1721 qp
->tx_index
%= qp
->tx_max_entry
;
1728 static void ntb_send_link_down(struct ntb_transport_qp
*qp
)
1730 struct pci_dev
*pdev
= qp
->ndev
->pdev
;
1731 struct ntb_queue_entry
*entry
;
1734 if (!qp
->link_is_up
)
1737 dev_info(&pdev
->dev
, "qp %d: Send Link Down\n", qp
->qp_num
);
1739 for (i
= 0; i
< NTB_LINK_DOWN_TIMEOUT
; i
++) {
1740 entry
= ntb_list_rm(&qp
->ntb_tx_free_q_lock
, &qp
->tx_free_q
);
1749 entry
->cb_data
= NULL
;
1752 entry
->flags
= LINK_DOWN_FLAG
;
1754 rc
= ntb_process_tx(qp
, entry
);
1756 dev_err(&pdev
->dev
, "ntb: QP%d unable to send linkdown msg\n",
1759 ntb_qp_link_down_reset(qp
);
1762 static bool ntb_dma_filter_fn(struct dma_chan
*chan
, void *node
)
1764 return dev_to_node(&chan
->dev
->device
) == (int)(unsigned long)node
;
1768 * ntb_transport_create_queue - Create a new NTB transport layer queue
1769 * @rx_handler: receive callback function
1770 * @tx_handler: transmit callback function
1771 * @event_handler: event callback function
1773 * Create a new NTB transport layer queue and provide the queue with a callback
1774 * routine for both transmit and receive. The receive callback routine will be
1775 * used to pass up data when the transport has received it on the queue. The
1776 * transmit callback routine will be called when the transport has completed the
1777 * transmission of the data on the queue and the data is ready to be freed.
1779 * RETURNS: pointer to newly created ntb_queue, NULL on error.
1781 struct ntb_transport_qp
*
1782 ntb_transport_create_queue(void *data
, struct device
*client_dev
,
1783 const struct ntb_queue_handlers
*handlers
)
1785 struct ntb_dev
*ndev
;
1786 struct pci_dev
*pdev
;
1787 struct ntb_transport_ctx
*nt
;
1788 struct ntb_queue_entry
*entry
;
1789 struct ntb_transport_qp
*qp
;
1791 unsigned int free_queue
;
1792 dma_cap_mask_t dma_mask
;
1796 ndev
= dev_ntb(client_dev
->parent
);
1800 node
= dev_to_node(&ndev
->dev
);
1802 free_queue
= ffs(nt
->qp_bitmap_free
);
1806 /* decrement free_queue to make it zero based */
1809 qp
= &nt
->qp_vec
[free_queue
];
1810 qp_bit
= BIT_ULL(qp
->qp_num
);
1812 nt
->qp_bitmap_free
&= ~qp_bit
;
1815 qp
->rx_handler
= handlers
->rx_handler
;
1816 qp
->tx_handler
= handlers
->tx_handler
;
1817 qp
->event_handler
= handlers
->event_handler
;
1819 dma_cap_zero(dma_mask
);
1820 dma_cap_set(DMA_MEMCPY
, dma_mask
);
1824 dma_request_channel(dma_mask
, ntb_dma_filter_fn
,
1825 (void *)(unsigned long)node
);
1826 if (!qp
->tx_dma_chan
)
1827 dev_info(&pdev
->dev
, "Unable to allocate TX DMA channel\n");
1830 dma_request_channel(dma_mask
, ntb_dma_filter_fn
,
1831 (void *)(unsigned long)node
);
1832 if (!qp
->rx_dma_chan
)
1833 dev_info(&pdev
->dev
, "Unable to allocate RX DMA channel\n");
1835 qp
->tx_dma_chan
= NULL
;
1836 qp
->rx_dma_chan
= NULL
;
1839 dev_dbg(&pdev
->dev
, "Using %s memcpy for TX\n",
1840 qp
->tx_dma_chan
? "DMA" : "CPU");
1842 dev_dbg(&pdev
->dev
, "Using %s memcpy for RX\n",
1843 qp
->rx_dma_chan
? "DMA" : "CPU");
1845 for (i
= 0; i
< NTB_QP_DEF_NUM_ENTRIES
; i
++) {
1846 entry
= kzalloc_node(sizeof(*entry
), GFP_ATOMIC
, node
);
1851 ntb_list_add(&qp
->ntb_rx_q_lock
, &entry
->entry
,
1854 qp
->rx_alloc_entry
= NTB_QP_DEF_NUM_ENTRIES
;
1856 for (i
= 0; i
< qp
->tx_max_entry
; i
++) {
1857 entry
= kzalloc_node(sizeof(*entry
), GFP_ATOMIC
, node
);
1862 ntb_list_add(&qp
->ntb_tx_free_q_lock
, &entry
->entry
,
1866 ntb_db_clear(qp
->ndev
, qp_bit
);
1867 ntb_db_clear_mask(qp
->ndev
, qp_bit
);
1869 dev_info(&pdev
->dev
, "NTB Transport QP %d created\n", qp
->qp_num
);
1874 while ((entry
= ntb_list_rm(&qp
->ntb_tx_free_q_lock
, &qp
->tx_free_q
)))
1877 qp
->rx_alloc_entry
= 0;
1878 while ((entry
= ntb_list_rm(&qp
->ntb_rx_q_lock
, &qp
->rx_free_q
)))
1880 if (qp
->tx_dma_chan
)
1881 dma_release_channel(qp
->tx_dma_chan
);
1882 if (qp
->rx_dma_chan
)
1883 dma_release_channel(qp
->rx_dma_chan
);
1884 nt
->qp_bitmap_free
|= qp_bit
;
1888 EXPORT_SYMBOL_GPL(ntb_transport_create_queue
);
1891 * ntb_transport_free_queue - Frees NTB transport queue
1892 * @qp: NTB queue to be freed
1894 * Frees NTB transport queue
1896 void ntb_transport_free_queue(struct ntb_transport_qp
*qp
)
1898 struct pci_dev
*pdev
;
1899 struct ntb_queue_entry
*entry
;
1905 pdev
= qp
->ndev
->pdev
;
1909 if (qp
->tx_dma_chan
) {
1910 struct dma_chan
*chan
= qp
->tx_dma_chan
;
1911 /* Putting the dma_chan to NULL will force any new traffic to be
1912 * processed by the CPU instead of the DAM engine
1914 qp
->tx_dma_chan
= NULL
;
1916 /* Try to be nice and wait for any queued DMA engine
1917 * transactions to process before smashing it with a rock
1919 dma_sync_wait(chan
, qp
->last_cookie
);
1920 dmaengine_terminate_all(chan
);
1921 dma_release_channel(chan
);
1924 if (qp
->rx_dma_chan
) {
1925 struct dma_chan
*chan
= qp
->rx_dma_chan
;
1926 /* Putting the dma_chan to NULL will force any new traffic to be
1927 * processed by the CPU instead of the DAM engine
1929 qp
->rx_dma_chan
= NULL
;
1931 /* Try to be nice and wait for any queued DMA engine
1932 * transactions to process before smashing it with a rock
1934 dma_sync_wait(chan
, qp
->last_cookie
);
1935 dmaengine_terminate_all(chan
);
1936 dma_release_channel(chan
);
1939 qp_bit
= BIT_ULL(qp
->qp_num
);
1941 ntb_db_set_mask(qp
->ndev
, qp_bit
);
1942 tasklet_kill(&qp
->rxc_db_work
);
1944 cancel_delayed_work_sync(&qp
->link_work
);
1947 qp
->rx_handler
= NULL
;
1948 qp
->tx_handler
= NULL
;
1949 qp
->event_handler
= NULL
;
1951 while ((entry
= ntb_list_rm(&qp
->ntb_rx_q_lock
, &qp
->rx_free_q
)))
1954 while ((entry
= ntb_list_rm(&qp
->ntb_rx_q_lock
, &qp
->rx_pend_q
))) {
1955 dev_warn(&pdev
->dev
, "Freeing item from non-empty rx_pend_q\n");
1959 while ((entry
= ntb_list_rm(&qp
->ntb_rx_q_lock
, &qp
->rx_post_q
))) {
1960 dev_warn(&pdev
->dev
, "Freeing item from non-empty rx_post_q\n");
1964 while ((entry
= ntb_list_rm(&qp
->ntb_tx_free_q_lock
, &qp
->tx_free_q
)))
1967 qp
->transport
->qp_bitmap_free
|= qp_bit
;
1969 dev_info(&pdev
->dev
, "NTB Transport QP %d freed\n", qp
->qp_num
);
1971 EXPORT_SYMBOL_GPL(ntb_transport_free_queue
);
1974 * ntb_transport_rx_remove - Dequeues enqueued rx packet
1975 * @qp: NTB queue to be freed
1976 * @len: pointer to variable to write enqueued buffers length
1978 * Dequeues unused buffers from receive queue. Should only be used during
1981 * RETURNS: NULL error value on error, or void* for success.
1983 void *ntb_transport_rx_remove(struct ntb_transport_qp
*qp
, unsigned int *len
)
1985 struct ntb_queue_entry
*entry
;
1988 if (!qp
|| qp
->client_ready
)
1991 entry
= ntb_list_rm(&qp
->ntb_rx_q_lock
, &qp
->rx_pend_q
);
1995 buf
= entry
->cb_data
;
1998 ntb_list_add(&qp
->ntb_rx_q_lock
, &entry
->entry
, &qp
->rx_free_q
);
2002 EXPORT_SYMBOL_GPL(ntb_transport_rx_remove
);
2005 * ntb_transport_rx_enqueue - Enqueue a new NTB queue entry
2006 * @qp: NTB transport layer queue the entry is to be enqueued on
2007 * @cb: per buffer pointer for callback function to use
2008 * @data: pointer to data buffer that incoming packets will be copied into
2009 * @len: length of the data buffer
2011 * Enqueue a new receive buffer onto the transport queue into which a NTB
2012 * payload can be received into.
2014 * RETURNS: An appropriate -ERRNO error value on error, or zero for success.
2016 int ntb_transport_rx_enqueue(struct ntb_transport_qp
*qp
, void *cb
, void *data
,
2019 struct ntb_queue_entry
*entry
;
2024 entry
= ntb_list_rm(&qp
->ntb_rx_q_lock
, &qp
->rx_free_q
);
2028 entry
->cb_data
= cb
;
2034 entry
->rx_index
= 0;
2036 ntb_list_add(&qp
->ntb_rx_q_lock
, &entry
->entry
, &qp
->rx_pend_q
);
2039 tasklet_schedule(&qp
->rxc_db_work
);
2043 EXPORT_SYMBOL_GPL(ntb_transport_rx_enqueue
);
2046 * ntb_transport_tx_enqueue - Enqueue a new NTB queue entry
2047 * @qp: NTB transport layer queue the entry is to be enqueued on
2048 * @cb: per buffer pointer for callback function to use
2049 * @data: pointer to data buffer that will be sent
2050 * @len: length of the data buffer
2052 * Enqueue a new transmit buffer onto the transport queue from which a NTB
2053 * payload will be transmitted. This assumes that a lock is being held to
2054 * serialize access to the qp.
2056 * RETURNS: An appropriate -ERRNO error value on error, or zero for success.
2058 int ntb_transport_tx_enqueue(struct ntb_transport_qp
*qp
, void *cb
, void *data
,
2061 struct ntb_queue_entry
*entry
;
2064 if (!qp
|| !qp
->link_is_up
|| !len
)
2067 entry
= ntb_list_rm(&qp
->ntb_tx_free_q_lock
, &qp
->tx_free_q
);
2069 qp
->tx_err_no_buf
++;
2073 entry
->cb_data
= cb
;
2079 entry
->tx_index
= 0;
2081 rc
= ntb_process_tx(qp
, entry
);
2083 ntb_list_add(&qp
->ntb_tx_free_q_lock
, &entry
->entry
,
2088 EXPORT_SYMBOL_GPL(ntb_transport_tx_enqueue
);
2091 * ntb_transport_link_up - Notify NTB transport of client readiness to use queue
2092 * @qp: NTB transport layer queue to be enabled
2094 * Notify NTB transport layer of client readiness to use queue
2096 void ntb_transport_link_up(struct ntb_transport_qp
*qp
)
2101 qp
->client_ready
= true;
2103 if (qp
->transport
->link_is_up
)
2104 schedule_delayed_work(&qp
->link_work
, 0);
2106 EXPORT_SYMBOL_GPL(ntb_transport_link_up
);
2109 * ntb_transport_link_down - Notify NTB transport to no longer enqueue data
2110 * @qp: NTB transport layer queue to be disabled
2112 * Notify NTB transport layer of client's desire to no longer receive data on
2113 * transport queue specified. It is the client's responsibility to ensure all
2114 * entries on queue are purged or otherwise handled appropriately.
2116 void ntb_transport_link_down(struct ntb_transport_qp
*qp
)
2123 qp
->client_ready
= false;
2125 val
= ntb_spad_read(qp
->ndev
, QP_LINKS
);
2127 ntb_peer_spad_write(qp
->ndev
, QP_LINKS
,
2128 val
& ~BIT(qp
->qp_num
));
2131 ntb_send_link_down(qp
);
2133 cancel_delayed_work_sync(&qp
->link_work
);
2135 EXPORT_SYMBOL_GPL(ntb_transport_link_down
);
2138 * ntb_transport_link_query - Query transport link state
2139 * @qp: NTB transport layer queue to be queried
2141 * Query connectivity to the remote system of the NTB transport queue
2143 * RETURNS: true for link up or false for link down
2145 bool ntb_transport_link_query(struct ntb_transport_qp
*qp
)
2150 return qp
->link_is_up
;
2152 EXPORT_SYMBOL_GPL(ntb_transport_link_query
);
2155 * ntb_transport_qp_num - Query the qp number
2156 * @qp: NTB transport layer queue to be queried
2158 * Query qp number of the NTB transport queue
2160 * RETURNS: a zero based number specifying the qp number
2162 unsigned char ntb_transport_qp_num(struct ntb_transport_qp
*qp
)
2169 EXPORT_SYMBOL_GPL(ntb_transport_qp_num
);
2172 * ntb_transport_max_size - Query the max payload size of a qp
2173 * @qp: NTB transport layer queue to be queried
2175 * Query the maximum payload size permissible on the given qp
2177 * RETURNS: the max payload size of a qp
2179 unsigned int ntb_transport_max_size(struct ntb_transport_qp
*qp
)
2181 unsigned int max_size
;
2182 unsigned int copy_align
;
2183 struct dma_chan
*rx_chan
, *tx_chan
;
2188 rx_chan
= qp
->rx_dma_chan
;
2189 tx_chan
= qp
->tx_dma_chan
;
2191 copy_align
= max(rx_chan
? rx_chan
->device
->copy_align
: 0,
2192 tx_chan
? tx_chan
->device
->copy_align
: 0);
2194 /* If DMA engine usage is possible, try to find the max size for that */
2195 max_size
= qp
->tx_max_frame
- sizeof(struct ntb_payload_header
);
2196 max_size
= round_down(max_size
, 1 << copy_align
);
2200 EXPORT_SYMBOL_GPL(ntb_transport_max_size
);
2202 unsigned int ntb_transport_tx_free_entry(struct ntb_transport_qp
*qp
)
2204 unsigned int head
= qp
->tx_index
;
2205 unsigned int tail
= qp
->remote_rx_info
->entry
;
2207 return tail
> head
? tail
- head
: qp
->tx_max_entry
+ tail
- head
;
2209 EXPORT_SYMBOL_GPL(ntb_transport_tx_free_entry
);
2211 static void ntb_transport_doorbell_callback(void *data
, int vector
)
2213 struct ntb_transport_ctx
*nt
= data
;
2214 struct ntb_transport_qp
*qp
;
2216 unsigned int qp_num
;
2218 db_bits
= (nt
->qp_bitmap
& ~nt
->qp_bitmap_free
&
2219 ntb_db_vector_mask(nt
->ndev
, vector
));
2222 qp_num
= __ffs(db_bits
);
2223 qp
= &nt
->qp_vec
[qp_num
];
2226 tasklet_schedule(&qp
->rxc_db_work
);
2228 db_bits
&= ~BIT_ULL(qp_num
);
2232 static const struct ntb_ctx_ops ntb_transport_ops
= {
2233 .link_event
= ntb_transport_event_callback
,
2234 .db_event
= ntb_transport_doorbell_callback
,
2237 static struct ntb_client ntb_transport_client
= {
2239 .probe
= ntb_transport_probe
,
2240 .remove
= ntb_transport_free
,
2244 static int __init
ntb_transport_init(void)
2248 pr_info("%s, version %s\n", NTB_TRANSPORT_DESC
, NTB_TRANSPORT_VER
);
2250 if (debugfs_initialized())
2251 nt_debugfs_dir
= debugfs_create_dir(KBUILD_MODNAME
, NULL
);
2253 rc
= bus_register(&ntb_transport_bus
);
2257 rc
= ntb_register_client(&ntb_transport_client
);
2264 bus_unregister(&ntb_transport_bus
);
2266 debugfs_remove_recursive(nt_debugfs_dir
);
2269 module_init(ntb_transport_init
);
2271 static void __exit
ntb_transport_exit(void)
2273 ntb_unregister_client(&ntb_transport_client
);
2274 bus_unregister(&ntb_transport_bus
);
2275 debugfs_remove_recursive(nt_debugfs_dir
);
2277 module_exit(ntb_transport_exit
);