xref: /freebsd/sys/dev/hyperv/netvsc/if_hnvar.h (revision eb9da1ada8b6b2c74378a5c17029ec5a7fb199e6)
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 #include <dev/hyperv/netvsc/hv_net_vsc.h>
34 
35 struct netvsc_dev_;
36 struct nvsp_msg_;
37 
38 struct vmbus_channel;
39 struct hn_send_ctx;
40 
41 typedef void		(*hn_sent_callback_t)
42 			(struct hn_send_ctx *, struct netvsc_dev_ *,
43 			 struct vmbus_channel *, const struct nvsp_msg_ *, int);
44 
45 struct hn_send_ctx {
46 	hn_sent_callback_t	hn_cb;
47 	void			*hn_cbarg;
48 	uint32_t		hn_chim_idx;
49 	int			hn_chim_sz;
50 };
51 
52 #define HN_SEND_CTX_INITIALIZER(cb, cbarg)				\
53 {									\
54 	.hn_cb		= cb,						\
55 	.hn_cbarg	= cbarg,					\
56 	.hn_chim_idx	= NVSP_1_CHIMNEY_SEND_INVALID_SECTION_INDEX,	\
57 	.hn_chim_sz	= 0						\
58 }
59 
60 static __inline void
61 hn_send_ctx_init(struct hn_send_ctx *sndc, hn_sent_callback_t cb,
62     void *cbarg, uint32_t chim_idx, int chim_sz)
63 {
64 	sndc->hn_cb = cb;
65 	sndc->hn_cbarg = cbarg;
66 	sndc->hn_chim_idx = chim_idx;
67 	sndc->hn_chim_sz = chim_sz;
68 }
69 
70 static __inline void
71 hn_send_ctx_init_simple(struct hn_send_ctx *sndc, hn_sent_callback_t cb,
72     void *cbarg)
73 {
74 	hn_send_ctx_init(sndc, cb, cbarg,
75 	    NVSP_1_CHIMNEY_SEND_INVALID_SECTION_INDEX, 0);
76 }
77 
78 void		hn_nvs_sent_wakeup(struct hn_send_ctx *sndc,
79 		    struct netvsc_dev_ *net_dev, struct vmbus_channel *chan,
80 		    const struct nvsp_msg_ *msg, int dlen);
81 void		hn_chim_free(struct netvsc_dev_ *net_dev, uint32_t chim_idx);
82 
83 #endif	/* !_IF_HNVAR_H_ */
84