xref: /freebsd/sys/dev/hyperv/include/vmbus_xact.h (revision 8ddb146abcdf061be9f2c0db7e391697dafad85c)
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 _VMBUS_XACT_H_
30 #define _VMBUS_XACT_H_
31 
32 #include <sys/param.h>
33 #include <sys/bus.h>
34 
35 struct vmbus_xact;
36 struct vmbus_xact_ctx;
37 
38 struct vmbus_xact_ctx	*vmbus_xact_ctx_create(bus_dma_tag_t dtag,
39 			    size_t req_size, size_t resp_size,
40 			    size_t priv_size);
41 void			vmbus_xact_ctx_destroy(struct vmbus_xact_ctx *ctx);
42 bool			vmbus_xact_ctx_orphan(struct vmbus_xact_ctx *ctx);
43 
44 struct vmbus_xact	*vmbus_xact_get(struct vmbus_xact_ctx *ctx,
45 			    size_t req_len);
46 void			vmbus_xact_put(struct vmbus_xact *xact);
47 
48 void			*vmbus_xact_req_data(const struct vmbus_xact *xact);
49 bus_addr_t		vmbus_xact_req_paddr(const struct vmbus_xact *xact);
50 void			*vmbus_xact_priv(const struct vmbus_xact *xact,
51 			    size_t priv_len);
52 void			vmbus_xact_activate(struct vmbus_xact *xact);
53 void			vmbus_xact_deactivate(struct vmbus_xact *xact);
54 const void		*vmbus_xact_wait(struct vmbus_xact *xact,
55 			    size_t *resp_len);
56 const void		*vmbus_xact_busywait(struct vmbus_xact *xact,
57 			    size_t *resp_len);
58 const void		*vmbus_xact_poll(struct vmbus_xact *xact,
59 			    size_t *resp_len);
60 void			vmbus_xact_wakeup(struct vmbus_xact *xact,
61 			    const void *data, size_t dlen);
62 void			vmbus_xact_ctx_wakeup(struct vmbus_xact_ctx *ctx,
63 			    const void *data, size_t dlen);
64 
65 #endif	/* !_VMBUS_XACT_H_ */
66