xref: /freebsd/sys/dev/hyperv/netvsc/if_hnvar.h (revision b5864e6de2f3aa8eb9bb269ec86282598b5201b1)
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 struct hn_recvinfo {
59 	const struct ndis_8021q_info_	*vlan_info;
60 	const struct rndis_tcp_ip_csum_info_ *csum_info;
61 	const struct rndis_hash_info	*hash_info;
62 	const struct rndis_hash_value	*hash_value;
63 };
64 
65 #define HN_SEND_CTX_INITIALIZER(cb, cbarg)		\
66 {							\
67 	.hn_cb		= cb,				\
68 	.hn_cbarg	= cbarg,			\
69 	.hn_chim_idx	= HN_NVS_CHIM_IDX_INVALID,	\
70 	.hn_chim_sz	= 0				\
71 }
72 
73 static __inline void
74 hn_send_ctx_init(struct hn_send_ctx *sndc, hn_sent_callback_t cb,
75     void *cbarg, uint32_t chim_idx, int chim_sz)
76 {
77 
78 	sndc->hn_cb = cb;
79 	sndc->hn_cbarg = cbarg;
80 	sndc->hn_chim_idx = chim_idx;
81 	sndc->hn_chim_sz = chim_sz;
82 }
83 
84 static __inline void
85 hn_send_ctx_init_simple(struct hn_send_ctx *sndc, hn_sent_callback_t cb,
86     void *cbarg)
87 {
88 
89 	hn_send_ctx_init(sndc, cb, cbarg, HN_NVS_CHIM_IDX_INVALID, 0);
90 }
91 
92 static __inline int
93 hn_nvs_send(struct vmbus_channel *chan, uint16_t flags,
94     void *nvs_msg, int nvs_msglen, struct hn_send_ctx *sndc)
95 {
96 
97 	return (vmbus_chan_send(chan, VMBUS_CHANPKT_TYPE_INBAND, flags,
98 	    nvs_msg, nvs_msglen, (uint64_t)(uintptr_t)sndc));
99 }
100 
101 static __inline int
102 hn_nvs_send_sglist(struct vmbus_channel *chan, struct vmbus_gpa sg[], int sglen,
103     void *nvs_msg, int nvs_msglen, struct hn_send_ctx *sndc)
104 {
105 
106 	return (vmbus_chan_send_sglist(chan, sg, sglen, nvs_msg, nvs_msglen,
107 	    (uint64_t)(uintptr_t)sndc));
108 }
109 
110 struct vmbus_xact;
111 
112 const void	*hn_nvs_xact_execute(struct hn_softc *sc,
113 		    struct vmbus_xact *xact, void *req, int reqlen,
114 		    size_t *resp_len);
115 uint32_t	hn_chim_alloc(struct hn_softc *sc);
116 void		hn_chim_free(struct hn_softc *sc, uint32_t chim_idx);
117 
118 extern struct hn_send_ctx	hn_send_ctx_none;
119 
120 #endif	/* !_IF_HNVAR_H_ */
121