xref: /freebsd/sys/dev/ntb/ntb_transport.h (revision 8657387683946d0c03e09fe77029edfe309eeb20)
1 /*-
2  * Copyright (c) 2016 Alexander Motin <mav@FreeBSD.org>
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24  * SUCH DAMAGE.
25  *
26  * $FreeBSD$
27  */
28 
29 struct ntb_transport_qp;
30 
31 extern devclass_t ntb_transport_devclass;
32 
33 enum ntb_link_event {
34 	NTB_LINK_DOWN = 0,
35 	NTB_LINK_UP,
36 };
37 
38 struct ntb_queue_handlers {
39 	void (*rx_handler)(struct ntb_transport_qp *qp, void *qp_data,
40 	    void *data, int len);
41 	void (*tx_handler)(struct ntb_transport_qp *qp, void *qp_data,
42 	    void *data, int len);
43 	void (*event_handler)(void *data, enum ntb_link_event status);
44 };
45 
46 int ntb_transport_queue_count(device_t dev);
47 struct ntb_transport_qp *
48 ntb_transport_create_queue(device_t dev, int q,
49     const struct ntb_queue_handlers *handlers, void *data);
50 void ntb_transport_free_queue(struct ntb_transport_qp *qp);
51 unsigned char ntb_transport_qp_num(struct ntb_transport_qp *qp);
52 unsigned int ntb_transport_max_size(struct ntb_transport_qp *qp);
53 int ntb_transport_rx_enqueue(struct ntb_transport_qp *qp, void *cb, void *data,
54 			     unsigned int len);
55 int ntb_transport_tx_enqueue(struct ntb_transport_qp *qp, void *cb, void *data,
56 			     unsigned int len);
57 void *ntb_transport_rx_remove(struct ntb_transport_qp *qp, unsigned int *len);
58 void ntb_transport_link_up(struct ntb_transport_qp *qp);
59 void ntb_transport_link_down(struct ntb_transport_qp *qp);
60 bool ntb_transport_link_query(struct ntb_transport_qp *qp);
61 uint64_t ntb_transport_link_speed(struct ntb_transport_qp *qp);
62 unsigned int ntb_transport_tx_free_entry(struct ntb_transport_qp *qp);
63