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"
69 #define NTB_TRANSPORT_MIN_SPADS (MW0_SZ_HIGH + 2)
71 MODULE_DESCRIPTION(NTB_TRANSPORT_DESC
);
72 MODULE_VERSION(NTB_TRANSPORT_VER
);
73 MODULE_LICENSE("Dual BSD/GPL");
74 MODULE_AUTHOR("Intel Corporation");
76 static unsigned long max_mw_size
;
77 module_param(max_mw_size
, ulong
, 0644);
78 MODULE_PARM_DESC(max_mw_size
, "Limit size of large memory windows");
80 static unsigned int transport_mtu
= 0x10000;
81 module_param(transport_mtu
, uint
, 0644);
82 MODULE_PARM_DESC(transport_mtu
, "Maximum size of NTB transport packets");
84 static unsigned char max_num_clients
;
85 module_param(max_num_clients
, byte
, 0644);
86 MODULE_PARM_DESC(max_num_clients
, "Maximum number of NTB transport clients");
88 static unsigned int copy_bytes
= 1024;
89 module_param(copy_bytes
, uint
, 0644);
90 MODULE_PARM_DESC(copy_bytes
, "Threshold under which NTB will use the CPU to copy instead of DMA");
93 module_param(use_dma
, bool, 0644);
94 MODULE_PARM_DESC(use_dma
, "Use DMA engine to perform large data copy");
96 static struct dentry
*nt_debugfs_dir
;
98 /* Only two-ports NTB devices are supported */
99 #define PIDX NTB_DEF_PEER_IDX
101 struct ntb_queue_entry
{
102 /* ntb_queue list reference */
103 struct list_head entry
;
104 /* pointers to data to be transferred */
111 unsigned int tx_index
;
112 unsigned int rx_index
;
114 struct ntb_transport_qp
*qp
;
116 struct ntb_payload_header __iomem
*tx_hdr
;
117 struct ntb_payload_header
*rx_hdr
;
125 struct ntb_transport_qp
{
126 struct ntb_transport_ctx
*transport
;
127 struct ntb_dev
*ndev
;
129 struct dma_chan
*tx_dma_chan
;
130 struct dma_chan
*rx_dma_chan
;
136 u8 qp_num
; /* Only 64 QP's are allowed. 0-63 */
139 struct ntb_rx_info __iomem
*rx_info
;
140 struct ntb_rx_info
*remote_rx_info
;
142 void (*tx_handler
)(struct ntb_transport_qp
*qp
, void *qp_data
,
143 void *data
, int len
);
144 struct list_head tx_free_q
;
145 spinlock_t ntb_tx_free_q_lock
;
147 dma_addr_t tx_mw_phys
;
148 unsigned int tx_index
;
149 unsigned int tx_max_entry
;
150 unsigned int tx_max_frame
;
152 void (*rx_handler
)(struct ntb_transport_qp
*qp
, void *qp_data
,
153 void *data
, int len
);
154 struct list_head rx_post_q
;
155 struct list_head rx_pend_q
;
156 struct list_head rx_free_q
;
157 /* ntb_rx_q_lock: synchronize access to rx_XXXX_q */
158 spinlock_t ntb_rx_q_lock
;
160 unsigned int rx_index
;
161 unsigned int rx_max_entry
;
162 unsigned int rx_max_frame
;
163 unsigned int rx_alloc_entry
;
164 dma_cookie_t last_cookie
;
165 struct tasklet_struct rxc_db_work
;
167 void (*event_handler
)(void *data
, int status
);
168 struct delayed_work link_work
;
169 struct work_struct link_cleanup
;
171 struct dentry
*debugfs_dir
;
172 struct dentry
*debugfs_stats
;
191 struct ntb_transport_mw
{
192 phys_addr_t phys_addr
;
193 resource_size_t phys_size
;
194 resource_size_t xlat_align
;
195 resource_size_t xlat_align_size
;
203 struct ntb_transport_client_dev
{
204 struct list_head entry
;
205 struct ntb_transport_ctx
*nt
;
209 struct ntb_transport_ctx
{
210 struct list_head entry
;
211 struct list_head client_devs
;
213 struct ntb_dev
*ndev
;
215 struct ntb_transport_mw
*mw_vec
;
216 struct ntb_transport_qp
*qp_vec
;
217 unsigned int mw_count
;
218 unsigned int qp_count
;
223 struct delayed_work link_work
;
224 struct work_struct link_cleanup
;
226 struct dentry
*debugfs_node_dir
;
230 DESC_DONE_FLAG
= BIT(0),
231 LINK_DOWN_FLAG
= BIT(1),
234 struct ntb_payload_header
{
249 #define dev_client_dev(__dev) \
250 container_of((__dev), struct ntb_transport_client_dev, dev)
252 #define drv_client(__drv) \
253 container_of((__drv), struct ntb_transport_client, driver)
255 #define QP_TO_MW(nt, qp) ((qp) % nt->mw_count)
256 #define NTB_QP_DEF_NUM_ENTRIES 100
257 #define NTB_LINK_DOWN_TIMEOUT 10
259 static void ntb_transport_rxc_db(unsigned long data
);
260 static const struct ntb_ctx_ops ntb_transport_ops
;
261 static struct ntb_client ntb_transport_client
;
262 static int ntb_async_tx_submit(struct ntb_transport_qp
*qp
,
263 struct ntb_queue_entry
*entry
);
264 static void ntb_memcpy_tx(struct ntb_queue_entry
*entry
, void __iomem
*offset
);
265 static int ntb_async_rx_submit(struct ntb_queue_entry
*entry
, void *offset
);
266 static void ntb_memcpy_rx(struct ntb_queue_entry
*entry
, void *offset
);
269 static int ntb_transport_bus_match(struct device
*dev
,
270 struct device_driver
*drv
)
272 return !strncmp(dev_name(dev
), drv
->name
, strlen(drv
->name
));
275 static int ntb_transport_bus_probe(struct device
*dev
)
277 const struct ntb_transport_client
*client
;
282 client
= drv_client(dev
->driver
);
283 rc
= client
->probe(dev
);
290 static int ntb_transport_bus_remove(struct device
*dev
)
292 const struct ntb_transport_client
*client
;
294 client
= drv_client(dev
->driver
);
302 static struct bus_type ntb_transport_bus
= {
303 .name
= "ntb_transport",
304 .match
= ntb_transport_bus_match
,
305 .probe
= ntb_transport_bus_probe
,
306 .remove
= ntb_transport_bus_remove
,
309 static LIST_HEAD(ntb_transport_list
);
311 static int ntb_bus_init(struct ntb_transport_ctx
*nt
)
313 list_add_tail(&nt
->entry
, &ntb_transport_list
);
317 static void ntb_bus_remove(struct ntb_transport_ctx
*nt
)
319 struct ntb_transport_client_dev
*client_dev
, *cd
;
321 list_for_each_entry_safe(client_dev
, cd
, &nt
->client_devs
, entry
) {
322 dev_err(client_dev
->dev
.parent
, "%s still attached to bus, removing\n",
323 dev_name(&client_dev
->dev
));
324 list_del(&client_dev
->entry
);
325 device_unregister(&client_dev
->dev
);
328 list_del(&nt
->entry
);
331 static void ntb_transport_client_release(struct device
*dev
)
333 struct ntb_transport_client_dev
*client_dev
;
335 client_dev
= dev_client_dev(dev
);
340 * ntb_transport_unregister_client_dev - Unregister NTB client device
341 * @device_name: Name of NTB client device
343 * Unregister an NTB client device with the NTB transport layer
345 void ntb_transport_unregister_client_dev(char *device_name
)
347 struct ntb_transport_client_dev
*client
, *cd
;
348 struct ntb_transport_ctx
*nt
;
350 list_for_each_entry(nt
, &ntb_transport_list
, entry
)
351 list_for_each_entry_safe(client
, cd
, &nt
->client_devs
, entry
)
352 if (!strncmp(dev_name(&client
->dev
), device_name
,
353 strlen(device_name
))) {
354 list_del(&client
->entry
);
355 device_unregister(&client
->dev
);
358 EXPORT_SYMBOL_GPL(ntb_transport_unregister_client_dev
);
361 * ntb_transport_register_client_dev - Register NTB client device
362 * @device_name: Name of NTB client device
364 * Register an NTB client device with the NTB transport layer
366 int ntb_transport_register_client_dev(char *device_name
)
368 struct ntb_transport_client_dev
*client_dev
;
369 struct ntb_transport_ctx
*nt
;
373 if (list_empty(&ntb_transport_list
))
376 list_for_each_entry(nt
, &ntb_transport_list
, entry
) {
379 node
= dev_to_node(&nt
->ndev
->dev
);
381 client_dev
= kzalloc_node(sizeof(*client_dev
),
388 dev
= &client_dev
->dev
;
390 /* setup and register client devices */
391 dev_set_name(dev
, "%s%d", device_name
, i
);
392 dev
->bus
= &ntb_transport_bus
;
393 dev
->release
= ntb_transport_client_release
;
394 dev
->parent
= &nt
->ndev
->dev
;
396 rc
= device_register(dev
);
402 list_add_tail(&client_dev
->entry
, &nt
->client_devs
);
409 ntb_transport_unregister_client_dev(device_name
);
413 EXPORT_SYMBOL_GPL(ntb_transport_register_client_dev
);
416 * ntb_transport_register_client - Register NTB client driver
417 * @drv: NTB client driver to be registered
419 * Register an NTB client driver with the NTB transport layer
421 * RETURNS: An appropriate -ERRNO error value on error, or zero for success.
423 int ntb_transport_register_client(struct ntb_transport_client
*drv
)
425 drv
->driver
.bus
= &ntb_transport_bus
;
427 if (list_empty(&ntb_transport_list
))
430 return driver_register(&drv
->driver
);
432 EXPORT_SYMBOL_GPL(ntb_transport_register_client
);
435 * ntb_transport_unregister_client - Unregister NTB client driver
436 * @drv: NTB client driver to be unregistered
438 * Unregister an NTB client driver with the NTB transport layer
440 * RETURNS: An appropriate -ERRNO error value on error, or zero for success.
442 void ntb_transport_unregister_client(struct ntb_transport_client
*drv
)
444 driver_unregister(&drv
->driver
);
446 EXPORT_SYMBOL_GPL(ntb_transport_unregister_client
);
448 static ssize_t
debugfs_read(struct file
*filp
, char __user
*ubuf
, size_t count
,
451 struct ntb_transport_qp
*qp
;
453 ssize_t ret
, out_offset
, out_count
;
455 qp
= filp
->private_data
;
457 if (!qp
|| !qp
->link_is_up
)
462 buf
= kmalloc(out_count
, GFP_KERNEL
);
467 out_offset
+= snprintf(buf
+ out_offset
, out_count
- out_offset
,
468 "\nNTB QP stats:\n\n");
469 out_offset
+= snprintf(buf
+ out_offset
, out_count
- out_offset
,
470 "rx_bytes - \t%llu\n", qp
->rx_bytes
);
471 out_offset
+= snprintf(buf
+ out_offset
, out_count
- out_offset
,
472 "rx_pkts - \t%llu\n", qp
->rx_pkts
);
473 out_offset
+= snprintf(buf
+ out_offset
, out_count
- out_offset
,
474 "rx_memcpy - \t%llu\n", qp
->rx_memcpy
);
475 out_offset
+= snprintf(buf
+ out_offset
, out_count
- out_offset
,
476 "rx_async - \t%llu\n", qp
->rx_async
);
477 out_offset
+= snprintf(buf
+ out_offset
, out_count
- out_offset
,
478 "rx_ring_empty - %llu\n", qp
->rx_ring_empty
);
479 out_offset
+= snprintf(buf
+ out_offset
, out_count
- out_offset
,
480 "rx_err_no_buf - %llu\n", qp
->rx_err_no_buf
);
481 out_offset
+= snprintf(buf
+ out_offset
, out_count
- out_offset
,
482 "rx_err_oflow - \t%llu\n", qp
->rx_err_oflow
);
483 out_offset
+= snprintf(buf
+ out_offset
, out_count
- out_offset
,
484 "rx_err_ver - \t%llu\n", qp
->rx_err_ver
);
485 out_offset
+= snprintf(buf
+ out_offset
, out_count
- out_offset
,
486 "rx_buff - \t0x%p\n", qp
->rx_buff
);
487 out_offset
+= snprintf(buf
+ out_offset
, out_count
- out_offset
,
488 "rx_index - \t%u\n", qp
->rx_index
);
489 out_offset
+= snprintf(buf
+ out_offset
, out_count
- out_offset
,
490 "rx_max_entry - \t%u\n", qp
->rx_max_entry
);
491 out_offset
+= snprintf(buf
+ out_offset
, out_count
- out_offset
,
492 "rx_alloc_entry - \t%u\n\n", qp
->rx_alloc_entry
);
494 out_offset
+= snprintf(buf
+ out_offset
, out_count
- out_offset
,
495 "tx_bytes - \t%llu\n", qp
->tx_bytes
);
496 out_offset
+= snprintf(buf
+ out_offset
, out_count
- out_offset
,
497 "tx_pkts - \t%llu\n", qp
->tx_pkts
);
498 out_offset
+= snprintf(buf
+ out_offset
, out_count
- out_offset
,
499 "tx_memcpy - \t%llu\n", qp
->tx_memcpy
);
500 out_offset
+= snprintf(buf
+ out_offset
, out_count
- out_offset
,
501 "tx_async - \t%llu\n", qp
->tx_async
);
502 out_offset
+= snprintf(buf
+ out_offset
, out_count
- out_offset
,
503 "tx_ring_full - \t%llu\n", qp
->tx_ring_full
);
504 out_offset
+= snprintf(buf
+ out_offset
, out_count
- out_offset
,
505 "tx_err_no_buf - %llu\n", qp
->tx_err_no_buf
);
506 out_offset
+= snprintf(buf
+ out_offset
, out_count
- out_offset
,
507 "tx_mw - \t0x%p\n", qp
->tx_mw
);
508 out_offset
+= snprintf(buf
+ out_offset
, out_count
- out_offset
,
509 "tx_index (H) - \t%u\n", qp
->tx_index
);
510 out_offset
+= snprintf(buf
+ out_offset
, out_count
- out_offset
,
512 qp
->remote_rx_info
->entry
);
513 out_offset
+= snprintf(buf
+ out_offset
, out_count
- out_offset
,
514 "tx_max_entry - \t%u\n", qp
->tx_max_entry
);
515 out_offset
+= snprintf(buf
+ out_offset
, out_count
- out_offset
,
517 ntb_transport_tx_free_entry(qp
));
519 out_offset
+= snprintf(buf
+ out_offset
, out_count
- out_offset
,
521 out_offset
+= snprintf(buf
+ out_offset
, out_count
- out_offset
,
522 "Using TX DMA - \t%s\n",
523 qp
->tx_dma_chan
? "Yes" : "No");
524 out_offset
+= snprintf(buf
+ out_offset
, out_count
- out_offset
,
525 "Using RX DMA - \t%s\n",
526 qp
->rx_dma_chan
? "Yes" : "No");
527 out_offset
+= snprintf(buf
+ out_offset
, out_count
- out_offset
,
529 qp
->link_is_up
? "Up" : "Down");
530 out_offset
+= snprintf(buf
+ out_offset
, out_count
- out_offset
,
533 if (out_offset
> out_count
)
534 out_offset
= out_count
;
536 ret
= simple_read_from_buffer(ubuf
, count
, offp
, buf
, out_offset
);
541 static const struct file_operations ntb_qp_debugfs_stats
= {
542 .owner
= THIS_MODULE
,
544 .read
= debugfs_read
,
547 static void ntb_list_add(spinlock_t
*lock
, struct list_head
*entry
,
548 struct list_head
*list
)
552 spin_lock_irqsave(lock
, flags
);
553 list_add_tail(entry
, list
);
554 spin_unlock_irqrestore(lock
, flags
);
557 static struct ntb_queue_entry
*ntb_list_rm(spinlock_t
*lock
,
558 struct list_head
*list
)
560 struct ntb_queue_entry
*entry
;
563 spin_lock_irqsave(lock
, flags
);
564 if (list_empty(list
)) {
568 entry
= list_first_entry(list
, struct ntb_queue_entry
, entry
);
569 list_del(&entry
->entry
);
572 spin_unlock_irqrestore(lock
, flags
);
577 static struct ntb_queue_entry
*ntb_list_mv(spinlock_t
*lock
,
578 struct list_head
*list
,
579 struct list_head
*to_list
)
581 struct ntb_queue_entry
*entry
;
584 spin_lock_irqsave(lock
, flags
);
586 if (list_empty(list
)) {
589 entry
= list_first_entry(list
, struct ntb_queue_entry
, entry
);
590 list_move_tail(&entry
->entry
, to_list
);
593 spin_unlock_irqrestore(lock
, flags
);
598 static int ntb_transport_setup_qp_mw(struct ntb_transport_ctx
*nt
,
601 struct ntb_transport_qp
*qp
= &nt
->qp_vec
[qp_num
];
602 struct ntb_transport_mw
*mw
;
603 struct ntb_dev
*ndev
= nt
->ndev
;
604 struct ntb_queue_entry
*entry
;
605 unsigned int rx_size
, num_qps_mw
;
606 unsigned int mw_num
, mw_count
, qp_count
;
610 mw_count
= nt
->mw_count
;
611 qp_count
= nt
->qp_count
;
613 mw_num
= QP_TO_MW(nt
, qp_num
);
614 mw
= &nt
->mw_vec
[mw_num
];
619 if (mw_num
< qp_count
% mw_count
)
620 num_qps_mw
= qp_count
/ mw_count
+ 1;
622 num_qps_mw
= qp_count
/ mw_count
;
624 rx_size
= (unsigned int)mw
->xlat_size
/ num_qps_mw
;
625 qp
->rx_buff
= mw
->virt_addr
+ rx_size
* (qp_num
/ mw_count
);
626 rx_size
-= sizeof(struct ntb_rx_info
);
628 qp
->remote_rx_info
= qp
->rx_buff
+ rx_size
;
630 /* Due to housekeeping, there must be atleast 2 buffs */
631 qp
->rx_max_frame
= min(transport_mtu
, rx_size
/ 2);
632 qp
->rx_max_entry
= rx_size
/ qp
->rx_max_frame
;
636 * Checking to see if we have more entries than the default.
637 * We should add additional entries if that is the case so we
638 * can be in sync with the transport frames.
640 node
= dev_to_node(&ndev
->dev
);
641 for (i
= qp
->rx_alloc_entry
; i
< qp
->rx_max_entry
; i
++) {
642 entry
= kzalloc_node(sizeof(*entry
), GFP_ATOMIC
, node
);
647 ntb_list_add(&qp
->ntb_rx_q_lock
, &entry
->entry
,
649 qp
->rx_alloc_entry
++;
652 qp
->remote_rx_info
->entry
= qp
->rx_max_entry
- 1;
654 /* setup the hdr offsets with 0's */
655 for (i
= 0; i
< qp
->rx_max_entry
; i
++) {
656 void *offset
= (qp
->rx_buff
+ qp
->rx_max_frame
* (i
+ 1) -
657 sizeof(struct ntb_payload_header
));
658 memset(offset
, 0, sizeof(struct ntb_payload_header
));
668 static void ntb_free_mw(struct ntb_transport_ctx
*nt
, int num_mw
)
670 struct ntb_transport_mw
*mw
= &nt
->mw_vec
[num_mw
];
671 struct pci_dev
*pdev
= nt
->ndev
->pdev
;
676 ntb_mw_clear_trans(nt
->ndev
, PIDX
, num_mw
);
677 dma_free_coherent(&pdev
->dev
, mw
->buff_size
,
678 mw
->virt_addr
, mw
->dma_addr
);
681 mw
->virt_addr
= NULL
;
684 static int ntb_set_mw(struct ntb_transport_ctx
*nt
, int num_mw
,
685 resource_size_t size
)
687 struct ntb_transport_mw
*mw
= &nt
->mw_vec
[num_mw
];
688 struct pci_dev
*pdev
= nt
->ndev
->pdev
;
689 size_t xlat_size
, buff_size
;
695 xlat_size
= round_up(size
, mw
->xlat_align_size
);
696 buff_size
= round_up(size
, mw
->xlat_align
);
698 /* No need to re-setup */
699 if (mw
->xlat_size
== xlat_size
)
703 ntb_free_mw(nt
, num_mw
);
705 /* Alloc memory for receiving data. Must be aligned */
706 mw
->xlat_size
= xlat_size
;
707 mw
->buff_size
= buff_size
;
709 mw
->virt_addr
= dma_alloc_coherent(&pdev
->dev
, buff_size
,
710 &mw
->dma_addr
, GFP_KERNEL
);
711 if (!mw
->virt_addr
) {
714 dev_err(&pdev
->dev
, "Unable to alloc MW buff of size %zu\n",
720 * we must ensure that the memory address allocated is BAR size
721 * aligned in order for the XLAT register to take the value. This
722 * is a requirement of the hardware. It is recommended to setup CMA
723 * for BAR sizes equal or greater than 4MB.
725 if (!IS_ALIGNED(mw
->dma_addr
, mw
->xlat_align
)) {
726 dev_err(&pdev
->dev
, "DMA memory %pad is not aligned\n",
728 ntb_free_mw(nt
, num_mw
);
732 /* Notify HW the memory location of the receive buffer */
733 rc
= ntb_mw_set_trans(nt
->ndev
, PIDX
, num_mw
, mw
->dma_addr
,
736 dev_err(&pdev
->dev
, "Unable to set mw%d translation", num_mw
);
737 ntb_free_mw(nt
, num_mw
);
744 static void ntb_qp_link_down_reset(struct ntb_transport_qp
*qp
)
746 qp
->link_is_up
= false;
753 qp
->rx_ring_empty
= 0;
754 qp
->rx_err_no_buf
= 0;
755 qp
->rx_err_oflow
= 0;
761 qp
->tx_ring_full
= 0;
762 qp
->tx_err_no_buf
= 0;
767 static void ntb_qp_link_cleanup(struct ntb_transport_qp
*qp
)
769 struct ntb_transport_ctx
*nt
= qp
->transport
;
770 struct pci_dev
*pdev
= nt
->ndev
->pdev
;
772 dev_info(&pdev
->dev
, "qp %d: Link Cleanup\n", qp
->qp_num
);
774 cancel_delayed_work_sync(&qp
->link_work
);
775 ntb_qp_link_down_reset(qp
);
777 if (qp
->event_handler
)
778 qp
->event_handler(qp
->cb_data
, qp
->link_is_up
);
781 static void ntb_qp_link_cleanup_work(struct work_struct
*work
)
783 struct ntb_transport_qp
*qp
= container_of(work
,
784 struct ntb_transport_qp
,
786 struct ntb_transport_ctx
*nt
= qp
->transport
;
788 ntb_qp_link_cleanup(qp
);
791 schedule_delayed_work(&qp
->link_work
,
792 msecs_to_jiffies(NTB_LINK_DOWN_TIMEOUT
));
795 static void ntb_qp_link_down(struct ntb_transport_qp
*qp
)
797 schedule_work(&qp
->link_cleanup
);
800 static void ntb_transport_link_cleanup(struct ntb_transport_ctx
*nt
)
802 struct ntb_transport_qp
*qp
;
804 unsigned int i
, count
;
806 qp_bitmap_alloc
= nt
->qp_bitmap
& ~nt
->qp_bitmap_free
;
808 /* Pass along the info to any clients */
809 for (i
= 0; i
< nt
->qp_count
; i
++)
810 if (qp_bitmap_alloc
& BIT_ULL(i
)) {
812 ntb_qp_link_cleanup(qp
);
813 cancel_work_sync(&qp
->link_cleanup
);
814 cancel_delayed_work_sync(&qp
->link_work
);
818 cancel_delayed_work_sync(&nt
->link_work
);
820 /* The scratchpad registers keep the values if the remote side
821 * goes down, blast them now to give them a sane value the next
822 * time they are accessed
824 count
= ntb_spad_count(nt
->ndev
);
825 for (i
= 0; i
< count
; i
++)
826 ntb_spad_write(nt
->ndev
, i
, 0);
829 static void ntb_transport_link_cleanup_work(struct work_struct
*work
)
831 struct ntb_transport_ctx
*nt
=
832 container_of(work
, struct ntb_transport_ctx
, link_cleanup
);
834 ntb_transport_link_cleanup(nt
);
837 static void ntb_transport_event_callback(void *data
)
839 struct ntb_transport_ctx
*nt
= data
;
841 if (ntb_link_is_up(nt
->ndev
, NULL
, NULL
) == 1)
842 schedule_delayed_work(&nt
->link_work
, 0);
844 schedule_work(&nt
->link_cleanup
);
847 static void ntb_transport_link_work(struct work_struct
*work
)
849 struct ntb_transport_ctx
*nt
=
850 container_of(work
, struct ntb_transport_ctx
, link_work
.work
);
851 struct ntb_dev
*ndev
= nt
->ndev
;
852 struct pci_dev
*pdev
= ndev
->pdev
;
853 resource_size_t size
;
857 /* send the local info, in the opposite order of the way we read it */
858 for (i
= 0; i
< nt
->mw_count
; i
++) {
859 size
= nt
->mw_vec
[i
].phys_size
;
861 if (max_mw_size
&& size
> max_mw_size
)
864 spad
= MW0_SZ_HIGH
+ (i
* 2);
865 ntb_peer_spad_write(ndev
, PIDX
, spad
, upper_32_bits(size
));
867 spad
= MW0_SZ_LOW
+ (i
* 2);
868 ntb_peer_spad_write(ndev
, PIDX
, spad
, lower_32_bits(size
));
871 ntb_peer_spad_write(ndev
, PIDX
, NUM_MWS
, nt
->mw_count
);
873 ntb_peer_spad_write(ndev
, PIDX
, NUM_QPS
, nt
->qp_count
);
875 ntb_peer_spad_write(ndev
, PIDX
, VERSION
, NTB_TRANSPORT_VERSION
);
877 /* Query the remote side for its info */
878 val
= ntb_spad_read(ndev
, VERSION
);
879 dev_dbg(&pdev
->dev
, "Remote version = %d\n", val
);
880 if (val
!= NTB_TRANSPORT_VERSION
)
883 val
= ntb_spad_read(ndev
, NUM_QPS
);
884 dev_dbg(&pdev
->dev
, "Remote max number of qps = %d\n", val
);
885 if (val
!= nt
->qp_count
)
888 val
= ntb_spad_read(ndev
, NUM_MWS
);
889 dev_dbg(&pdev
->dev
, "Remote number of mws = %d\n", val
);
890 if (val
!= nt
->mw_count
)
893 for (i
= 0; i
< nt
->mw_count
; i
++) {
896 val
= ntb_spad_read(ndev
, MW0_SZ_HIGH
+ (i
* 2));
897 val64
= (u64
)val
<< 32;
899 val
= ntb_spad_read(ndev
, MW0_SZ_LOW
+ (i
* 2));
902 dev_dbg(&pdev
->dev
, "Remote MW%d size = %#llx\n", i
, val64
);
904 rc
= ntb_set_mw(nt
, i
, val64
);
909 nt
->link_is_up
= true;
911 for (i
= 0; i
< nt
->qp_count
; i
++) {
912 struct ntb_transport_qp
*qp
= &nt
->qp_vec
[i
];
914 ntb_transport_setup_qp_mw(nt
, i
);
916 if (qp
->client_ready
)
917 schedule_delayed_work(&qp
->link_work
, 0);
923 for (i
= 0; i
< nt
->mw_count
; i
++)
926 /* if there's an actual failure, we should just bail */
928 ntb_link_disable(ndev
);
933 if (ntb_link_is_up(ndev
, NULL
, NULL
) == 1)
934 schedule_delayed_work(&nt
->link_work
,
935 msecs_to_jiffies(NTB_LINK_DOWN_TIMEOUT
));
938 static void ntb_qp_link_work(struct work_struct
*work
)
940 struct ntb_transport_qp
*qp
= container_of(work
,
941 struct ntb_transport_qp
,
943 struct pci_dev
*pdev
= qp
->ndev
->pdev
;
944 struct ntb_transport_ctx
*nt
= qp
->transport
;
947 WARN_ON(!nt
->link_is_up
);
949 val
= ntb_spad_read(nt
->ndev
, QP_LINKS
);
951 ntb_peer_spad_write(nt
->ndev
, PIDX
, QP_LINKS
, val
| BIT(qp
->qp_num
));
953 /* query remote spad for qp ready bits */
954 dev_dbg_ratelimited(&pdev
->dev
, "Remote QP link status = %x\n", val
);
956 /* See if the remote side is up */
957 if (val
& BIT(qp
->qp_num
)) {
958 dev_info(&pdev
->dev
, "qp %d: Link Up\n", qp
->qp_num
);
959 qp
->link_is_up
= true;
962 if (qp
->event_handler
)
963 qp
->event_handler(qp
->cb_data
, qp
->link_is_up
);
966 tasklet_schedule(&qp
->rxc_db_work
);
967 } else if (nt
->link_is_up
)
968 schedule_delayed_work(&qp
->link_work
,
969 msecs_to_jiffies(NTB_LINK_DOWN_TIMEOUT
));
972 static int ntb_transport_init_queue(struct ntb_transport_ctx
*nt
,
975 struct ntb_transport_qp
*qp
;
977 resource_size_t mw_size
;
978 unsigned int num_qps_mw
, tx_size
;
979 unsigned int mw_num
, mw_count
, qp_count
;
982 mw_count
= nt
->mw_count
;
983 qp_count
= nt
->qp_count
;
985 mw_num
= QP_TO_MW(nt
, qp_num
);
987 qp
= &nt
->qp_vec
[qp_num
];
991 qp
->client_ready
= false;
992 qp
->event_handler
= NULL
;
993 ntb_qp_link_down_reset(qp
);
995 if (mw_num
< qp_count
% mw_count
)
996 num_qps_mw
= qp_count
/ mw_count
+ 1;
998 num_qps_mw
= qp_count
/ mw_count
;
1000 mw_base
= nt
->mw_vec
[mw_num
].phys_addr
;
1001 mw_size
= nt
->mw_vec
[mw_num
].phys_size
;
1003 tx_size
= (unsigned int)mw_size
/ num_qps_mw
;
1004 qp_offset
= tx_size
* (qp_num
/ mw_count
);
1006 qp
->tx_mw
= nt
->mw_vec
[mw_num
].vbase
+ qp_offset
;
1010 qp
->tx_mw_phys
= mw_base
+ qp_offset
;
1011 if (!qp
->tx_mw_phys
)
1014 tx_size
-= sizeof(struct ntb_rx_info
);
1015 qp
->rx_info
= qp
->tx_mw
+ tx_size
;
1017 /* Due to housekeeping, there must be atleast 2 buffs */
1018 qp
->tx_max_frame
= min(transport_mtu
, tx_size
/ 2);
1019 qp
->tx_max_entry
= tx_size
/ qp
->tx_max_frame
;
1021 if (nt
->debugfs_node_dir
) {
1022 char debugfs_name
[4];
1024 snprintf(debugfs_name
, 4, "qp%d", qp_num
);
1025 qp
->debugfs_dir
= debugfs_create_dir(debugfs_name
,
1026 nt
->debugfs_node_dir
);
1028 qp
->debugfs_stats
= debugfs_create_file("stats", S_IRUSR
,
1029 qp
->debugfs_dir
, qp
,
1030 &ntb_qp_debugfs_stats
);
1032 qp
->debugfs_dir
= NULL
;
1033 qp
->debugfs_stats
= NULL
;
1036 INIT_DELAYED_WORK(&qp
->link_work
, ntb_qp_link_work
);
1037 INIT_WORK(&qp
->link_cleanup
, ntb_qp_link_cleanup_work
);
1039 spin_lock_init(&qp
->ntb_rx_q_lock
);
1040 spin_lock_init(&qp
->ntb_tx_free_q_lock
);
1042 INIT_LIST_HEAD(&qp
->rx_post_q
);
1043 INIT_LIST_HEAD(&qp
->rx_pend_q
);
1044 INIT_LIST_HEAD(&qp
->rx_free_q
);
1045 INIT_LIST_HEAD(&qp
->tx_free_q
);
1047 tasklet_init(&qp
->rxc_db_work
, ntb_transport_rxc_db
,
1053 static int ntb_transport_probe(struct ntb_client
*self
, struct ntb_dev
*ndev
)
1055 struct ntb_transport_ctx
*nt
;
1056 struct ntb_transport_mw
*mw
;
1057 unsigned int mw_count
, qp_count
, spad_count
, max_mw_count_for_spads
;
1062 mw_count
= ntb_mw_count(ndev
, PIDX
);
1064 if (!ndev
->ops
->mw_set_trans
) {
1065 dev_err(&ndev
->dev
, "Inbound MW based NTB API is required\n");
1069 if (ntb_db_is_unsafe(ndev
))
1071 "doorbell is unsafe, proceed anyway...\n");
1072 if (ntb_spad_is_unsafe(ndev
))
1074 "scratchpad is unsafe, proceed anyway...\n");
1076 if (ntb_peer_port_count(ndev
) != NTB_DEF_PEER_CNT
)
1077 dev_warn(&ndev
->dev
, "Multi-port NTB devices unsupported\n");
1079 node
= dev_to_node(&ndev
->dev
);
1081 nt
= kzalloc_node(sizeof(*nt
), GFP_KERNEL
, node
);
1086 spad_count
= ntb_spad_count(ndev
);
1088 /* Limit the MW's based on the availability of scratchpads */
1090 if (spad_count
< NTB_TRANSPORT_MIN_SPADS
) {
1096 max_mw_count_for_spads
= (spad_count
- MW0_SZ_HIGH
) / 2;
1097 nt
->mw_count
= min(mw_count
, max_mw_count_for_spads
);
1099 nt
->mw_vec
= kzalloc_node(mw_count
* sizeof(*nt
->mw_vec
),
1106 for (i
= 0; i
< mw_count
; i
++) {
1107 mw
= &nt
->mw_vec
[i
];
1109 rc
= ntb_mw_get_align(ndev
, PIDX
, i
, &mw
->xlat_align
,
1110 &mw
->xlat_align_size
, NULL
);
1114 rc
= ntb_peer_mw_get_addr(ndev
, i
, &mw
->phys_addr
,
1119 mw
->vbase
= ioremap_wc(mw
->phys_addr
, mw
->phys_size
);
1127 mw
->virt_addr
= NULL
;
1131 qp_bitmap
= ntb_db_valid_mask(ndev
);
1133 qp_count
= ilog2(qp_bitmap
);
1134 if (max_num_clients
&& max_num_clients
< qp_count
)
1135 qp_count
= max_num_clients
;
1136 else if (nt
->mw_count
< qp_count
)
1137 qp_count
= nt
->mw_count
;
1139 qp_bitmap
&= BIT_ULL(qp_count
) - 1;
1141 nt
->qp_count
= qp_count
;
1142 nt
->qp_bitmap
= qp_bitmap
;
1143 nt
->qp_bitmap_free
= qp_bitmap
;
1145 nt
->qp_vec
= kzalloc_node(qp_count
* sizeof(*nt
->qp_vec
),
1152 if (nt_debugfs_dir
) {
1153 nt
->debugfs_node_dir
=
1154 debugfs_create_dir(pci_name(ndev
->pdev
),
1158 for (i
= 0; i
< qp_count
; i
++) {
1159 rc
= ntb_transport_init_queue(nt
, i
);
1164 INIT_DELAYED_WORK(&nt
->link_work
, ntb_transport_link_work
);
1165 INIT_WORK(&nt
->link_cleanup
, ntb_transport_link_cleanup_work
);
1167 rc
= ntb_set_ctx(ndev
, nt
, &ntb_transport_ops
);
1171 INIT_LIST_HEAD(&nt
->client_devs
);
1172 rc
= ntb_bus_init(nt
);
1176 nt
->link_is_up
= false;
1177 ntb_link_enable(ndev
, NTB_SPEED_AUTO
, NTB_WIDTH_AUTO
);
1178 ntb_link_event(ndev
);
1183 ntb_clear_ctx(ndev
);
1188 mw
= &nt
->mw_vec
[i
];
1197 static void ntb_transport_free(struct ntb_client
*self
, struct ntb_dev
*ndev
)
1199 struct ntb_transport_ctx
*nt
= ndev
->ctx
;
1200 struct ntb_transport_qp
*qp
;
1201 u64 qp_bitmap_alloc
;
1204 ntb_transport_link_cleanup(nt
);
1205 cancel_work_sync(&nt
->link_cleanup
);
1206 cancel_delayed_work_sync(&nt
->link_work
);
1208 qp_bitmap_alloc
= nt
->qp_bitmap
& ~nt
->qp_bitmap_free
;
1210 /* verify that all the qp's are freed */
1211 for (i
= 0; i
< nt
->qp_count
; i
++) {
1212 qp
= &nt
->qp_vec
[i
];
1213 if (qp_bitmap_alloc
& BIT_ULL(i
))
1214 ntb_transport_free_queue(qp
);
1215 debugfs_remove_recursive(qp
->debugfs_dir
);
1218 ntb_link_disable(ndev
);
1219 ntb_clear_ctx(ndev
);
1223 for (i
= nt
->mw_count
; i
--; ) {
1225 iounmap(nt
->mw_vec
[i
].vbase
);
1233 static void ntb_complete_rxc(struct ntb_transport_qp
*qp
)
1235 struct ntb_queue_entry
*entry
;
1238 unsigned long irqflags
;
1240 spin_lock_irqsave(&qp
->ntb_rx_q_lock
, irqflags
);
1242 while (!list_empty(&qp
->rx_post_q
)) {
1243 entry
= list_first_entry(&qp
->rx_post_q
,
1244 struct ntb_queue_entry
, entry
);
1245 if (!(entry
->flags
& DESC_DONE_FLAG
))
1248 entry
->rx_hdr
->flags
= 0;
1249 iowrite32(entry
->rx_index
, &qp
->rx_info
->entry
);
1251 cb_data
= entry
->cb_data
;
1254 list_move_tail(&entry
->entry
, &qp
->rx_free_q
);
1256 spin_unlock_irqrestore(&qp
->ntb_rx_q_lock
, irqflags
);
1258 if (qp
->rx_handler
&& qp
->client_ready
)
1259 qp
->rx_handler(qp
, qp
->cb_data
, cb_data
, len
);
1261 spin_lock_irqsave(&qp
->ntb_rx_q_lock
, irqflags
);
1264 spin_unlock_irqrestore(&qp
->ntb_rx_q_lock
, irqflags
);
1267 static void ntb_rx_copy_callback(void *data
,
1268 const struct dmaengine_result
*res
)
1270 struct ntb_queue_entry
*entry
= data
;
1272 /* we need to check DMA results if we are using DMA */
1274 enum dmaengine_tx_result dma_err
= res
->result
;
1277 case DMA_TRANS_READ_FAILED
:
1278 case DMA_TRANS_WRITE_FAILED
:
1280 case DMA_TRANS_ABORTED
:
1282 struct ntb_transport_qp
*qp
= entry
->qp
;
1283 void *offset
= qp
->rx_buff
+ qp
->rx_max_frame
*
1286 ntb_memcpy_rx(entry
, offset
);
1291 case DMA_TRANS_NOERROR
:
1297 entry
->flags
|= DESC_DONE_FLAG
;
1299 ntb_complete_rxc(entry
->qp
);
1302 static void ntb_memcpy_rx(struct ntb_queue_entry
*entry
, void *offset
)
1304 void *buf
= entry
->buf
;
1305 size_t len
= entry
->len
;
1307 memcpy(buf
, offset
, len
);
1309 /* Ensure that the data is fully copied out before clearing the flag */
1312 ntb_rx_copy_callback(entry
, NULL
);
1315 static int ntb_async_rx_submit(struct ntb_queue_entry
*entry
, void *offset
)
1317 struct dma_async_tx_descriptor
*txd
;
1318 struct ntb_transport_qp
*qp
= entry
->qp
;
1319 struct dma_chan
*chan
= qp
->rx_dma_chan
;
1320 struct dma_device
*device
;
1321 size_t pay_off
, buff_off
, len
;
1322 struct dmaengine_unmap_data
*unmap
;
1323 dma_cookie_t cookie
;
1324 void *buf
= entry
->buf
;
1327 device
= chan
->device
;
1328 pay_off
= (size_t)offset
& ~PAGE_MASK
;
1329 buff_off
= (size_t)buf
& ~PAGE_MASK
;
1331 if (!is_dma_copy_aligned(device
, pay_off
, buff_off
, len
))
1334 unmap
= dmaengine_get_unmap_data(device
->dev
, 2, GFP_NOWAIT
);
1339 unmap
->addr
[0] = dma_map_page(device
->dev
, virt_to_page(offset
),
1340 pay_off
, len
, DMA_TO_DEVICE
);
1341 if (dma_mapping_error(device
->dev
, unmap
->addr
[0]))
1346 unmap
->addr
[1] = dma_map_page(device
->dev
, virt_to_page(buf
),
1347 buff_off
, len
, DMA_FROM_DEVICE
);
1348 if (dma_mapping_error(device
->dev
, unmap
->addr
[1]))
1351 unmap
->from_cnt
= 1;
1353 txd
= device
->device_prep_dma_memcpy(chan
, unmap
->addr
[1],
1354 unmap
->addr
[0], len
,
1355 DMA_PREP_INTERRUPT
);
1359 txd
->callback_result
= ntb_rx_copy_callback
;
1360 txd
->callback_param
= entry
;
1361 dma_set_unmap(txd
, unmap
);
1363 cookie
= dmaengine_submit(txd
);
1364 if (dma_submit_error(cookie
))
1367 dmaengine_unmap_put(unmap
);
1369 qp
->last_cookie
= cookie
;
1376 dmaengine_unmap_put(unmap
);
1378 dmaengine_unmap_put(unmap
);
1383 static void ntb_async_rx(struct ntb_queue_entry
*entry
, void *offset
)
1385 struct ntb_transport_qp
*qp
= entry
->qp
;
1386 struct dma_chan
*chan
= qp
->rx_dma_chan
;
1392 if (entry
->len
< copy_bytes
)
1395 res
= ntb_async_rx_submit(entry
, offset
);
1399 if (!entry
->retries
)
1405 ntb_memcpy_rx(entry
, offset
);
1409 static int ntb_process_rxc(struct ntb_transport_qp
*qp
)
1411 struct ntb_payload_header
*hdr
;
1412 struct ntb_queue_entry
*entry
;
1415 offset
= qp
->rx_buff
+ qp
->rx_max_frame
* qp
->rx_index
;
1416 hdr
= offset
+ qp
->rx_max_frame
- sizeof(struct ntb_payload_header
);
1418 dev_dbg(&qp
->ndev
->pdev
->dev
, "qp %d: RX ver %u len %d flags %x\n",
1419 qp
->qp_num
, hdr
->ver
, hdr
->len
, hdr
->flags
);
1421 if (!(hdr
->flags
& DESC_DONE_FLAG
)) {
1422 dev_dbg(&qp
->ndev
->pdev
->dev
, "done flag not set\n");
1423 qp
->rx_ring_empty
++;
1427 if (hdr
->flags
& LINK_DOWN_FLAG
) {
1428 dev_dbg(&qp
->ndev
->pdev
->dev
, "link down flag set\n");
1429 ntb_qp_link_down(qp
);
1434 if (hdr
->ver
!= (u32
)qp
->rx_pkts
) {
1435 dev_dbg(&qp
->ndev
->pdev
->dev
,
1436 "version mismatch, expected %llu - got %u\n",
1437 qp
->rx_pkts
, hdr
->ver
);
1442 entry
= ntb_list_mv(&qp
->ntb_rx_q_lock
, &qp
->rx_pend_q
, &qp
->rx_post_q
);
1444 dev_dbg(&qp
->ndev
->pdev
->dev
, "no receive buffer\n");
1445 qp
->rx_err_no_buf
++;
1449 entry
->rx_hdr
= hdr
;
1450 entry
->rx_index
= qp
->rx_index
;
1452 if (hdr
->len
> entry
->len
) {
1453 dev_dbg(&qp
->ndev
->pdev
->dev
,
1454 "receive buffer overflow! Wanted %d got %d\n",
1455 hdr
->len
, entry
->len
);
1459 entry
->flags
|= DESC_DONE_FLAG
;
1461 ntb_complete_rxc(qp
);
1463 dev_dbg(&qp
->ndev
->pdev
->dev
,
1464 "RX OK index %u ver %u size %d into buf size %d\n",
1465 qp
->rx_index
, hdr
->ver
, hdr
->len
, entry
->len
);
1467 qp
->rx_bytes
+= hdr
->len
;
1470 entry
->len
= hdr
->len
;
1472 ntb_async_rx(entry
, offset
);
1476 qp
->rx_index
%= qp
->rx_max_entry
;
1481 static void ntb_transport_rxc_db(unsigned long data
)
1483 struct ntb_transport_qp
*qp
= (void *)data
;
1486 dev_dbg(&qp
->ndev
->pdev
->dev
, "%s: doorbell %d received\n",
1487 __func__
, qp
->qp_num
);
1489 /* Limit the number of packets processed in a single interrupt to
1490 * provide fairness to others
1492 for (i
= 0; i
< qp
->rx_max_entry
; i
++) {
1493 rc
= ntb_process_rxc(qp
);
1498 if (i
&& qp
->rx_dma_chan
)
1499 dma_async_issue_pending(qp
->rx_dma_chan
);
1501 if (i
== qp
->rx_max_entry
) {
1502 /* there is more work to do */
1504 tasklet_schedule(&qp
->rxc_db_work
);
1505 } else if (ntb_db_read(qp
->ndev
) & BIT_ULL(qp
->qp_num
)) {
1506 /* the doorbell bit is set: clear it */
1507 ntb_db_clear(qp
->ndev
, BIT_ULL(qp
->qp_num
));
1508 /* ntb_db_read ensures ntb_db_clear write is committed */
1509 ntb_db_read(qp
->ndev
);
1511 /* an interrupt may have arrived between finishing
1512 * ntb_process_rxc and clearing the doorbell bit:
1513 * there might be some more work to do.
1516 tasklet_schedule(&qp
->rxc_db_work
);
1520 static void ntb_tx_copy_callback(void *data
,
1521 const struct dmaengine_result
*res
)
1523 struct ntb_queue_entry
*entry
= data
;
1524 struct ntb_transport_qp
*qp
= entry
->qp
;
1525 struct ntb_payload_header __iomem
*hdr
= entry
->tx_hdr
;
1527 /* we need to check DMA results if we are using DMA */
1529 enum dmaengine_tx_result dma_err
= res
->result
;
1532 case DMA_TRANS_READ_FAILED
:
1533 case DMA_TRANS_WRITE_FAILED
:
1535 case DMA_TRANS_ABORTED
:
1537 void __iomem
*offset
=
1538 qp
->tx_mw
+ qp
->tx_max_frame
*
1541 /* resubmit via CPU */
1542 ntb_memcpy_tx(entry
, offset
);
1547 case DMA_TRANS_NOERROR
:
1553 iowrite32(entry
->flags
| DESC_DONE_FLAG
, &hdr
->flags
);
1555 ntb_peer_db_set(qp
->ndev
, BIT_ULL(qp
->qp_num
));
1557 /* The entry length can only be zero if the packet is intended to be a
1558 * "link down" or similar. Since no payload is being sent in these
1559 * cases, there is nothing to add to the completion queue.
1561 if (entry
->len
> 0) {
1562 qp
->tx_bytes
+= entry
->len
;
1565 qp
->tx_handler(qp
, qp
->cb_data
, entry
->cb_data
,
1569 ntb_list_add(&qp
->ntb_tx_free_q_lock
, &entry
->entry
, &qp
->tx_free_q
);
1572 static void ntb_memcpy_tx(struct ntb_queue_entry
*entry
, void __iomem
*offset
)
1574 #ifdef ARCH_HAS_NOCACHE_UACCESS
1576 * Using non-temporal mov to improve performance on non-cached
1577 * writes, even though we aren't actually copying from user space.
1579 __copy_from_user_inatomic_nocache(offset
, entry
->buf
, entry
->len
);
1581 memcpy_toio(offset
, entry
->buf
, entry
->len
);
1584 /* Ensure that the data is fully copied out before setting the flags */
1587 ntb_tx_copy_callback(entry
, NULL
);
1590 static int ntb_async_tx_submit(struct ntb_transport_qp
*qp
,
1591 struct ntb_queue_entry
*entry
)
1593 struct dma_async_tx_descriptor
*txd
;
1594 struct dma_chan
*chan
= qp
->tx_dma_chan
;
1595 struct dma_device
*device
;
1596 size_t len
= entry
->len
;
1597 void *buf
= entry
->buf
;
1598 size_t dest_off
, buff_off
;
1599 struct dmaengine_unmap_data
*unmap
;
1601 dma_cookie_t cookie
;
1603 device
= chan
->device
;
1604 dest
= qp
->tx_mw_phys
+ qp
->tx_max_frame
* entry
->tx_index
;
1605 buff_off
= (size_t)buf
& ~PAGE_MASK
;
1606 dest_off
= (size_t)dest
& ~PAGE_MASK
;
1608 if (!is_dma_copy_aligned(device
, buff_off
, dest_off
, len
))
1611 unmap
= dmaengine_get_unmap_data(device
->dev
, 1, GFP_NOWAIT
);
1616 unmap
->addr
[0] = dma_map_page(device
->dev
, virt_to_page(buf
),
1617 buff_off
, len
, DMA_TO_DEVICE
);
1618 if (dma_mapping_error(device
->dev
, unmap
->addr
[0]))
1623 txd
= device
->device_prep_dma_memcpy(chan
, dest
, unmap
->addr
[0], len
,
1624 DMA_PREP_INTERRUPT
);
1628 txd
->callback_result
= ntb_tx_copy_callback
;
1629 txd
->callback_param
= entry
;
1630 dma_set_unmap(txd
, unmap
);
1632 cookie
= dmaengine_submit(txd
);
1633 if (dma_submit_error(cookie
))
1636 dmaengine_unmap_put(unmap
);
1638 dma_async_issue_pending(chan
);
1642 dmaengine_unmap_put(unmap
);
1644 dmaengine_unmap_put(unmap
);
1649 static void ntb_async_tx(struct ntb_transport_qp
*qp
,
1650 struct ntb_queue_entry
*entry
)
1652 struct ntb_payload_header __iomem
*hdr
;
1653 struct dma_chan
*chan
= qp
->tx_dma_chan
;
1654 void __iomem
*offset
;
1657 entry
->tx_index
= qp
->tx_index
;
1658 offset
= qp
->tx_mw
+ qp
->tx_max_frame
* entry
->tx_index
;
1659 hdr
= offset
+ qp
->tx_max_frame
- sizeof(struct ntb_payload_header
);
1660 entry
->tx_hdr
= hdr
;
1662 iowrite32(entry
->len
, &hdr
->len
);
1663 iowrite32((u32
)qp
->tx_pkts
, &hdr
->ver
);
1668 if (entry
->len
< copy_bytes
)
1671 res
= ntb_async_tx_submit(qp
, entry
);
1675 if (!entry
->retries
)
1681 ntb_memcpy_tx(entry
, offset
);
1685 static int ntb_process_tx(struct ntb_transport_qp
*qp
,
1686 struct ntb_queue_entry
*entry
)
1688 if (qp
->tx_index
== qp
->remote_rx_info
->entry
) {
1693 if (entry
->len
> qp
->tx_max_frame
- sizeof(struct ntb_payload_header
)) {
1695 qp
->tx_handler(qp
, qp
->cb_data
, NULL
, -EIO
);
1697 ntb_list_add(&qp
->ntb_tx_free_q_lock
, &entry
->entry
,
1702 ntb_async_tx(qp
, entry
);
1705 qp
->tx_index
%= qp
->tx_max_entry
;
1712 static void ntb_send_link_down(struct ntb_transport_qp
*qp
)
1714 struct pci_dev
*pdev
= qp
->ndev
->pdev
;
1715 struct ntb_queue_entry
*entry
;
1718 if (!qp
->link_is_up
)
1721 dev_info(&pdev
->dev
, "qp %d: Send Link Down\n", qp
->qp_num
);
1723 for (i
= 0; i
< NTB_LINK_DOWN_TIMEOUT
; i
++) {
1724 entry
= ntb_list_rm(&qp
->ntb_tx_free_q_lock
, &qp
->tx_free_q
);
1733 entry
->cb_data
= NULL
;
1736 entry
->flags
= LINK_DOWN_FLAG
;
1738 rc
= ntb_process_tx(qp
, entry
);
1740 dev_err(&pdev
->dev
, "ntb: QP%d unable to send linkdown msg\n",
1743 ntb_qp_link_down_reset(qp
);
1746 static bool ntb_dma_filter_fn(struct dma_chan
*chan
, void *node
)
1748 return dev_to_node(&chan
->dev
->device
) == (int)(unsigned long)node
;
1752 * ntb_transport_create_queue - Create a new NTB transport layer queue
1753 * @rx_handler: receive callback function
1754 * @tx_handler: transmit callback function
1755 * @event_handler: event callback function
1757 * Create a new NTB transport layer queue and provide the queue with a callback
1758 * routine for both transmit and receive. The receive callback routine will be
1759 * used to pass up data when the transport has received it on the queue. The
1760 * transmit callback routine will be called when the transport has completed the
1761 * transmission of the data on the queue and the data is ready to be freed.
1763 * RETURNS: pointer to newly created ntb_queue, NULL on error.
1765 struct ntb_transport_qp
*
1766 ntb_transport_create_queue(void *data
, struct device
*client_dev
,
1767 const struct ntb_queue_handlers
*handlers
)
1769 struct ntb_dev
*ndev
;
1770 struct pci_dev
*pdev
;
1771 struct ntb_transport_ctx
*nt
;
1772 struct ntb_queue_entry
*entry
;
1773 struct ntb_transport_qp
*qp
;
1775 unsigned int free_queue
;
1776 dma_cap_mask_t dma_mask
;
1780 ndev
= dev_ntb(client_dev
->parent
);
1784 node
= dev_to_node(&ndev
->dev
);
1786 free_queue
= ffs(nt
->qp_bitmap_free
);
1790 /* decrement free_queue to make it zero based */
1793 qp
= &nt
->qp_vec
[free_queue
];
1794 qp_bit
= BIT_ULL(qp
->qp_num
);
1796 nt
->qp_bitmap_free
&= ~qp_bit
;
1799 qp
->rx_handler
= handlers
->rx_handler
;
1800 qp
->tx_handler
= handlers
->tx_handler
;
1801 qp
->event_handler
= handlers
->event_handler
;
1803 dma_cap_zero(dma_mask
);
1804 dma_cap_set(DMA_MEMCPY
, dma_mask
);
1808 dma_request_channel(dma_mask
, ntb_dma_filter_fn
,
1809 (void *)(unsigned long)node
);
1810 if (!qp
->tx_dma_chan
)
1811 dev_info(&pdev
->dev
, "Unable to allocate TX DMA channel\n");
1814 dma_request_channel(dma_mask
, ntb_dma_filter_fn
,
1815 (void *)(unsigned long)node
);
1816 if (!qp
->rx_dma_chan
)
1817 dev_info(&pdev
->dev
, "Unable to allocate RX DMA channel\n");
1819 qp
->tx_dma_chan
= NULL
;
1820 qp
->rx_dma_chan
= NULL
;
1823 dev_dbg(&pdev
->dev
, "Using %s memcpy for TX\n",
1824 qp
->tx_dma_chan
? "DMA" : "CPU");
1826 dev_dbg(&pdev
->dev
, "Using %s memcpy for RX\n",
1827 qp
->rx_dma_chan
? "DMA" : "CPU");
1829 for (i
= 0; i
< NTB_QP_DEF_NUM_ENTRIES
; i
++) {
1830 entry
= kzalloc_node(sizeof(*entry
), GFP_ATOMIC
, node
);
1835 ntb_list_add(&qp
->ntb_rx_q_lock
, &entry
->entry
,
1838 qp
->rx_alloc_entry
= NTB_QP_DEF_NUM_ENTRIES
;
1840 for (i
= 0; i
< qp
->tx_max_entry
; i
++) {
1841 entry
= kzalloc_node(sizeof(*entry
), GFP_ATOMIC
, node
);
1846 ntb_list_add(&qp
->ntb_tx_free_q_lock
, &entry
->entry
,
1850 ntb_db_clear(qp
->ndev
, qp_bit
);
1851 ntb_db_clear_mask(qp
->ndev
, qp_bit
);
1853 dev_info(&pdev
->dev
, "NTB Transport QP %d created\n", qp
->qp_num
);
1858 while ((entry
= ntb_list_rm(&qp
->ntb_tx_free_q_lock
, &qp
->tx_free_q
)))
1861 qp
->rx_alloc_entry
= 0;
1862 while ((entry
= ntb_list_rm(&qp
->ntb_rx_q_lock
, &qp
->rx_free_q
)))
1864 if (qp
->tx_dma_chan
)
1865 dma_release_channel(qp
->tx_dma_chan
);
1866 if (qp
->rx_dma_chan
)
1867 dma_release_channel(qp
->rx_dma_chan
);
1868 nt
->qp_bitmap_free
|= qp_bit
;
1872 EXPORT_SYMBOL_GPL(ntb_transport_create_queue
);
1875 * ntb_transport_free_queue - Frees NTB transport queue
1876 * @qp: NTB queue to be freed
1878 * Frees NTB transport queue
1880 void ntb_transport_free_queue(struct ntb_transport_qp
*qp
)
1882 struct pci_dev
*pdev
;
1883 struct ntb_queue_entry
*entry
;
1889 pdev
= qp
->ndev
->pdev
;
1893 if (qp
->tx_dma_chan
) {
1894 struct dma_chan
*chan
= qp
->tx_dma_chan
;
1895 /* Putting the dma_chan to NULL will force any new traffic to be
1896 * processed by the CPU instead of the DAM engine
1898 qp
->tx_dma_chan
= NULL
;
1900 /* Try to be nice and wait for any queued DMA engine
1901 * transactions to process before smashing it with a rock
1903 dma_sync_wait(chan
, qp
->last_cookie
);
1904 dmaengine_terminate_all(chan
);
1905 dma_release_channel(chan
);
1908 if (qp
->rx_dma_chan
) {
1909 struct dma_chan
*chan
= qp
->rx_dma_chan
;
1910 /* Putting the dma_chan to NULL will force any new traffic to be
1911 * processed by the CPU instead of the DAM engine
1913 qp
->rx_dma_chan
= NULL
;
1915 /* Try to be nice and wait for any queued DMA engine
1916 * transactions to process before smashing it with a rock
1918 dma_sync_wait(chan
, qp
->last_cookie
);
1919 dmaengine_terminate_all(chan
);
1920 dma_release_channel(chan
);
1923 qp_bit
= BIT_ULL(qp
->qp_num
);
1925 ntb_db_set_mask(qp
->ndev
, qp_bit
);
1926 tasklet_kill(&qp
->rxc_db_work
);
1928 cancel_delayed_work_sync(&qp
->link_work
);
1931 qp
->rx_handler
= NULL
;
1932 qp
->tx_handler
= NULL
;
1933 qp
->event_handler
= NULL
;
1935 while ((entry
= ntb_list_rm(&qp
->ntb_rx_q_lock
, &qp
->rx_free_q
)))
1938 while ((entry
= ntb_list_rm(&qp
->ntb_rx_q_lock
, &qp
->rx_pend_q
))) {
1939 dev_warn(&pdev
->dev
, "Freeing item from non-empty rx_pend_q\n");
1943 while ((entry
= ntb_list_rm(&qp
->ntb_rx_q_lock
, &qp
->rx_post_q
))) {
1944 dev_warn(&pdev
->dev
, "Freeing item from non-empty rx_post_q\n");
1948 while ((entry
= ntb_list_rm(&qp
->ntb_tx_free_q_lock
, &qp
->tx_free_q
)))
1951 qp
->transport
->qp_bitmap_free
|= qp_bit
;
1953 dev_info(&pdev
->dev
, "NTB Transport QP %d freed\n", qp
->qp_num
);
1955 EXPORT_SYMBOL_GPL(ntb_transport_free_queue
);
1958 * ntb_transport_rx_remove - Dequeues enqueued rx packet
1959 * @qp: NTB queue to be freed
1960 * @len: pointer to variable to write enqueued buffers length
1962 * Dequeues unused buffers from receive queue. Should only be used during
1965 * RETURNS: NULL error value on error, or void* for success.
1967 void *ntb_transport_rx_remove(struct ntb_transport_qp
*qp
, unsigned int *len
)
1969 struct ntb_queue_entry
*entry
;
1972 if (!qp
|| qp
->client_ready
)
1975 entry
= ntb_list_rm(&qp
->ntb_rx_q_lock
, &qp
->rx_pend_q
);
1979 buf
= entry
->cb_data
;
1982 ntb_list_add(&qp
->ntb_rx_q_lock
, &entry
->entry
, &qp
->rx_free_q
);
1986 EXPORT_SYMBOL_GPL(ntb_transport_rx_remove
);
1989 * ntb_transport_rx_enqueue - Enqueue a new NTB queue entry
1990 * @qp: NTB transport layer queue the entry is to be enqueued on
1991 * @cb: per buffer pointer for callback function to use
1992 * @data: pointer to data buffer that incoming packets will be copied into
1993 * @len: length of the data buffer
1995 * Enqueue a new receive buffer onto the transport queue into which a NTB
1996 * payload can be received into.
1998 * RETURNS: An appropriate -ERRNO error value on error, or zero for success.
2000 int ntb_transport_rx_enqueue(struct ntb_transport_qp
*qp
, void *cb
, void *data
,
2003 struct ntb_queue_entry
*entry
;
2008 entry
= ntb_list_rm(&qp
->ntb_rx_q_lock
, &qp
->rx_free_q
);
2012 entry
->cb_data
= cb
;
2018 entry
->rx_index
= 0;
2020 ntb_list_add(&qp
->ntb_rx_q_lock
, &entry
->entry
, &qp
->rx_pend_q
);
2023 tasklet_schedule(&qp
->rxc_db_work
);
2027 EXPORT_SYMBOL_GPL(ntb_transport_rx_enqueue
);
2030 * ntb_transport_tx_enqueue - Enqueue a new NTB queue entry
2031 * @qp: NTB transport layer queue the entry is to be enqueued on
2032 * @cb: per buffer pointer for callback function to use
2033 * @data: pointer to data buffer that will be sent
2034 * @len: length of the data buffer
2036 * Enqueue a new transmit buffer onto the transport queue from which a NTB
2037 * payload will be transmitted. This assumes that a lock is being held to
2038 * serialize access to the qp.
2040 * RETURNS: An appropriate -ERRNO error value on error, or zero for success.
2042 int ntb_transport_tx_enqueue(struct ntb_transport_qp
*qp
, void *cb
, void *data
,
2045 struct ntb_queue_entry
*entry
;
2048 if (!qp
|| !qp
->link_is_up
|| !len
)
2051 entry
= ntb_list_rm(&qp
->ntb_tx_free_q_lock
, &qp
->tx_free_q
);
2053 qp
->tx_err_no_buf
++;
2057 entry
->cb_data
= cb
;
2063 entry
->tx_index
= 0;
2065 rc
= ntb_process_tx(qp
, entry
);
2067 ntb_list_add(&qp
->ntb_tx_free_q_lock
, &entry
->entry
,
2072 EXPORT_SYMBOL_GPL(ntb_transport_tx_enqueue
);
2075 * ntb_transport_link_up - Notify NTB transport of client readiness to use queue
2076 * @qp: NTB transport layer queue to be enabled
2078 * Notify NTB transport layer of client readiness to use queue
2080 void ntb_transport_link_up(struct ntb_transport_qp
*qp
)
2085 qp
->client_ready
= true;
2087 if (qp
->transport
->link_is_up
)
2088 schedule_delayed_work(&qp
->link_work
, 0);
2090 EXPORT_SYMBOL_GPL(ntb_transport_link_up
);
2093 * ntb_transport_link_down - Notify NTB transport to no longer enqueue data
2094 * @qp: NTB transport layer queue to be disabled
2096 * Notify NTB transport layer of client's desire to no longer receive data on
2097 * transport queue specified. It is the client's responsibility to ensure all
2098 * entries on queue are purged or otherwise handled appropriately.
2100 void ntb_transport_link_down(struct ntb_transport_qp
*qp
)
2107 qp
->client_ready
= false;
2109 val
= ntb_spad_read(qp
->ndev
, QP_LINKS
);
2111 ntb_peer_spad_write(qp
->ndev
, PIDX
, QP_LINKS
, val
& ~BIT(qp
->qp_num
));
2114 ntb_send_link_down(qp
);
2116 cancel_delayed_work_sync(&qp
->link_work
);
2118 EXPORT_SYMBOL_GPL(ntb_transport_link_down
);
2121 * ntb_transport_link_query - Query transport link state
2122 * @qp: NTB transport layer queue to be queried
2124 * Query connectivity to the remote system of the NTB transport queue
2126 * RETURNS: true for link up or false for link down
2128 bool ntb_transport_link_query(struct ntb_transport_qp
*qp
)
2133 return qp
->link_is_up
;
2135 EXPORT_SYMBOL_GPL(ntb_transport_link_query
);
2138 * ntb_transport_qp_num - Query the qp number
2139 * @qp: NTB transport layer queue to be queried
2141 * Query qp number of the NTB transport queue
2143 * RETURNS: a zero based number specifying the qp number
2145 unsigned char ntb_transport_qp_num(struct ntb_transport_qp
*qp
)
2152 EXPORT_SYMBOL_GPL(ntb_transport_qp_num
);
2155 * ntb_transport_max_size - Query the max payload size of a qp
2156 * @qp: NTB transport layer queue to be queried
2158 * Query the maximum payload size permissible on the given qp
2160 * RETURNS: the max payload size of a qp
2162 unsigned int ntb_transport_max_size(struct ntb_transport_qp
*qp
)
2164 unsigned int max_size
;
2165 unsigned int copy_align
;
2166 struct dma_chan
*rx_chan
, *tx_chan
;
2171 rx_chan
= qp
->rx_dma_chan
;
2172 tx_chan
= qp
->tx_dma_chan
;
2174 copy_align
= max(rx_chan
? rx_chan
->device
->copy_align
: 0,
2175 tx_chan
? tx_chan
->device
->copy_align
: 0);
2177 /* If DMA engine usage is possible, try to find the max size for that */
2178 max_size
= qp
->tx_max_frame
- sizeof(struct ntb_payload_header
);
2179 max_size
= round_down(max_size
, 1 << copy_align
);
2183 EXPORT_SYMBOL_GPL(ntb_transport_max_size
);
2185 unsigned int ntb_transport_tx_free_entry(struct ntb_transport_qp
*qp
)
2187 unsigned int head
= qp
->tx_index
;
2188 unsigned int tail
= qp
->remote_rx_info
->entry
;
2190 return tail
> head
? tail
- head
: qp
->tx_max_entry
+ tail
- head
;
2192 EXPORT_SYMBOL_GPL(ntb_transport_tx_free_entry
);
2194 static void ntb_transport_doorbell_callback(void *data
, int vector
)
2196 struct ntb_transport_ctx
*nt
= data
;
2197 struct ntb_transport_qp
*qp
;
2199 unsigned int qp_num
;
2201 db_bits
= (nt
->qp_bitmap
& ~nt
->qp_bitmap_free
&
2202 ntb_db_vector_mask(nt
->ndev
, vector
));
2205 qp_num
= __ffs(db_bits
);
2206 qp
= &nt
->qp_vec
[qp_num
];
2209 tasklet_schedule(&qp
->rxc_db_work
);
2211 db_bits
&= ~BIT_ULL(qp_num
);
2215 static const struct ntb_ctx_ops ntb_transport_ops
= {
2216 .link_event
= ntb_transport_event_callback
,
2217 .db_event
= ntb_transport_doorbell_callback
,
2220 static struct ntb_client ntb_transport_client
= {
2222 .probe
= ntb_transport_probe
,
2223 .remove
= ntb_transport_free
,
2227 static int __init
ntb_transport_init(void)
2231 pr_info("%s, version %s\n", NTB_TRANSPORT_DESC
, NTB_TRANSPORT_VER
);
2233 if (debugfs_initialized())
2234 nt_debugfs_dir
= debugfs_create_dir(KBUILD_MODNAME
, NULL
);
2236 rc
= bus_register(&ntb_transport_bus
);
2240 rc
= ntb_register_client(&ntb_transport_client
);
2247 bus_unregister(&ntb_transport_bus
);
2249 debugfs_remove_recursive(nt_debugfs_dir
);
2252 module_init(ntb_transport_init
);
2254 static void __exit
ntb_transport_exit(void)
2256 ntb_unregister_client(&ntb_transport_client
);
2257 bus_unregister(&ntb_transport_bus
);
2258 debugfs_remove_recursive(nt_debugfs_dir
);
2260 module_exit(ntb_transport_exit
);