xref: /freebsd/sys/dev/hyperv/netvsc/if_hnvar.h (revision 23648b7d730bcb5cd0ed1bc061ac18387545f814)
1 /*-
2  * Copyright (c) 2016 Microsoft Corp.
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 unmodified, this list of conditions, and the following
10  *    disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25  *
26  * $FreeBSD$
27  */
28 
29 #ifndef _IF_HNVAR_H_
30 #define _IF_HNVAR_H_
31 
32 #include <sys/param.h>
33 
34 #include <dev/hyperv/include/vmbus.h>
35 #include <dev/hyperv/netvsc/if_hnreg.h>
36 
37 struct hn_softc;
38 
39 struct vmbus_channel;
40 struct hn_send_ctx;
41 
42 typedef void		(*hn_sent_callback_t)
43 			(struct hn_send_ctx *, struct hn_softc *,
44 			 struct vmbus_channel *, const void *, int);
45 
46 struct hn_send_ctx {
47 	hn_sent_callback_t	hn_cb;
48 	void			*hn_cbarg;
49 	uint32_t		hn_chim_idx;
50 	int			hn_chim_sz;
51 };
52 
53 struct rndis_hash_info;
54 struct rndix_hash_value;
55 struct ndis_8021q_info_;
56 struct rndis_tcp_ip_csum_info_;
57 
58 #define HN_NDIS_VLAN_INFO_INVALID	0xffffffff
59 #define HN_NDIS_RXCSUM_INFO_INVALID	0
60 #define HN_NDIS_HASH_INFO_INVALID	0
61 
62 struct hn_recvinfo {
63 	uint32_t			vlan_info;
64 	uint32_t			csum_info;
65 	uint32_t			hash_info;
66 	uint32_t			hash_value;
67 };
68 
69 #define HN_SEND_CTX_INITIALIZER(cb, cbarg)		\
70 {							\
71 	.hn_cb		= cb,				\
72 	.hn_cbarg	= cbarg,			\
73 	.hn_chim_idx	= HN_NVS_CHIM_IDX_INVALID,	\
74 	.hn_chim_sz	= 0				\
75 }
76 
77 static __inline void
78 hn_send_ctx_init(struct hn_send_ctx *sndc, hn_sent_callback_t cb,
79     void *cbarg, uint32_t chim_idx, int chim_sz)
80 {
81 
82 	sndc->hn_cb = cb;
83 	sndc->hn_cbarg = cbarg;
84 	sndc->hn_chim_idx = chim_idx;
85 	sndc->hn_chim_sz = chim_sz;
86 }
87 
88 static __inline void
89 hn_send_ctx_init_simple(struct hn_send_ctx *sndc, hn_sent_callback_t cb,
90     void *cbarg)
91 {
92 
93 	hn_send_ctx_init(sndc, cb, cbarg, HN_NVS_CHIM_IDX_INVALID, 0);
94 }
95 
96 static __inline int
97 hn_nvs_send(struct vmbus_channel *chan, uint16_t flags,
98     void *nvs_msg, int nvs_msglen, struct hn_send_ctx *sndc)
99 {
100 
101 	return (vmbus_chan_send(chan, VMBUS_CHANPKT_TYPE_INBAND, flags,
102 	    nvs_msg, nvs_msglen, (uint64_t)(uintptr_t)sndc));
103 }
104 
105 static __inline int
106 hn_nvs_send_sglist(struct vmbus_channel *chan, struct vmbus_gpa sg[], int sglen,
107     void *nvs_msg, int nvs_msglen, struct hn_send_ctx *sndc)
108 {
109 
110 	return (vmbus_chan_send_sglist(chan, sg, sglen, nvs_msg, nvs_msglen,
111 	    (uint64_t)(uintptr_t)sndc));
112 }
113 
114 struct vmbus_xact;
115 struct rndis_packet_msg;
116 
117 uint32_t	hn_chim_alloc(struct hn_softc *sc);
118 void		hn_chim_free(struct hn_softc *sc, uint32_t chim_idx);
119 
120 int		hn_rndis_attach(struct hn_softc *sc);
121 int		hn_rndis_conf_rss(struct hn_softc *sc, uint16_t flags);
122 void		*hn_rndis_pktinfo_append(struct rndis_packet_msg *,
123 		    size_t pktsize, size_t pi_dlen, uint32_t pi_type);
124 int		hn_rndis_get_rsscaps(struct hn_softc *sc, int *rxr_cnt);
125 int		hn_rndis_get_eaddr(struct hn_softc *sc, uint8_t *eaddr);
126 int		hn_rndis_get_linkstatus(struct hn_softc *sc,
127 		    uint32_t *link_status);
128 
129 int		hn_nvs_attach(struct hn_softc *sc, int mtu);
130 int		hn_nvs_alloc_subchans(struct hn_softc *sc, int *nsubch);
131 void		hn_nvs_sent_xact(struct hn_send_ctx *sndc, struct hn_softc *sc,
132 		    struct vmbus_channel *chan, const void *data, int dlen);
133 
134 int		hn_rxpkt(struct hn_rx_ring *rxr, const void *data, int dlen,
135 		    const struct hn_recvinfo *info);
136 void		hn_chan_rollup(struct hn_rx_ring *rxr, struct hn_tx_ring *txr);
137 
138 extern struct hn_send_ctx	hn_send_ctx_none;
139 
140 #endif	/* !_IF_HNVAR_H_ */
141