xref: /freebsd/sys/dev/hyperv/vmbus/vmbus_brvar.h (revision 2c8d04d0228871c24017509cf039e7c5d97d97be)
1 /*-
2  * Copyright (c) 2009-2012,2016 Microsoft Corp.
3  * Copyright (c) 2012 NetApp Inc.
4  * Copyright (c) 2012 Citrix Inc.
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice unmodified, this list of conditions, and the following
12  *    disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  *
28  * $FreeBSD$
29  */
30 
31 #ifndef _VMBUS_BRVAR_H_
32 #define _VMBUS_BRVAR_H_
33 
34 #include <sys/param.h>
35 #include <sys/lock.h>
36 #include <sys/mutex.h>
37 #include <sys/_iovec.h>
38 
39 typedef struct {
40 	struct vmbus_bufring	*ring_buffer;
41 	struct mtx		ring_lock;
42 	uint32_t		ring_data_size;	/* ring_size */
43 } hv_vmbus_ring_buffer_info;
44 
45 struct sysctl_ctx_list;
46 struct sysctl_oid;
47 
48 void	vmbus_br_sysctl_create(struct sysctl_ctx_list *ctx,
49 	    struct sysctl_oid *br_tree, hv_vmbus_ring_buffer_info *br,
50 	    const char *name);
51 
52 int			hv_vmbus_ring_buffer_init(
53 				hv_vmbus_ring_buffer_info	*ring_info,
54 				void				*buffer,
55 				uint32_t			buffer_len);
56 
57 void			hv_ring_buffer_cleanup(
58 				hv_vmbus_ring_buffer_info	*ring_info);
59 
60 int			hv_ring_buffer_write(
61 				hv_vmbus_ring_buffer_info	*ring_info,
62 				const struct iovec		iov[],
63 				uint32_t			iovlen,
64 				boolean_t			*need_sig);
65 
66 int			hv_ring_buffer_peek(
67 				hv_vmbus_ring_buffer_info	*ring_info,
68 				void				*buffer,
69 				uint32_t			buffer_len);
70 
71 int			hv_ring_buffer_read(
72 				hv_vmbus_ring_buffer_info	*ring_info,
73 				void				*buffer,
74 				uint32_t			buffer_len,
75 				uint32_t			offset);
76 
77 void			hv_ring_buffer_read_begin(
78 				hv_vmbus_ring_buffer_info	*ring_info);
79 
80 uint32_t		hv_ring_buffer_read_end(
81 				hv_vmbus_ring_buffer_info	*ring_info);
82 
83 #endif  /* _VMBUS_BRVAR_H_ */
84