vmbus.h revision 307457 
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: stable/11/sys/dev/hyperv/include/vmbus.h 307457 2016-10-17 02:36:49Z sephe $
27 */
28
29#ifndef _VMBUS_H_
30#define _VMBUS_H_
31
32#include <sys/param.h>
33
34/*
35 * GPA stuffs.
36 */
37struct vmbus_gpa_range {
38	uint32_t	gpa_len;
39	uint32_t	gpa_ofs;
40	uint64_t	gpa_page[0];
41} __packed;
42
43/* This is actually vmbus_gpa_range.gpa_page[1] */
44struct vmbus_gpa {
45	uint32_t	gpa_len;
46	uint32_t	gpa_ofs;
47	uint64_t	gpa_page;
48} __packed;
49
50#define VMBUS_CHANPKT_SIZE_SHIFT	3
51
52#define VMBUS_CHANPKT_GETLEN(pktlen)	\
53	(((int)(pktlen)) << VMBUS_CHANPKT_SIZE_SHIFT)
54
55struct vmbus_chanpkt_hdr {
56	uint16_t	cph_type;	/* VMBUS_CHANPKT_TYPE_ */
57	uint16_t	cph_hlen;	/* header len, in 8 bytes */
58	uint16_t	cph_tlen;	/* total len, in 8 bytes */
59	uint16_t	cph_flags;	/* VMBUS_CHANPKT_FLAG_ */
60	uint64_t	cph_xactid;
61} __packed;
62
63#define VMBUS_CHANPKT_TYPE_INBAND	0x0006
64#define VMBUS_CHANPKT_TYPE_RXBUF	0x0007
65#define VMBUS_CHANPKT_TYPE_GPA		0x0009
66#define VMBUS_CHANPKT_TYPE_COMP		0x000b
67
68#define VMBUS_CHANPKT_FLAG_RC		0x0001	/* report completion */
69
70#define VMBUS_CHANPKT_CONST_DATA(pkt)		\
71	(const void *)((const uint8_t *)(pkt) +	\
72	VMBUS_CHANPKT_GETLEN((pkt)->cph_hlen))
73
74struct vmbus_rxbuf_desc {
75	uint32_t	rb_len;
76	uint32_t	rb_ofs;
77} __packed;
78
79struct vmbus_chanpkt_rxbuf {
80	struct vmbus_chanpkt_hdr cp_hdr;
81	uint16_t	cp_rxbuf_id;
82	uint16_t	cp_rsvd;
83	uint32_t	cp_rxbuf_cnt;
84	struct vmbus_rxbuf_desc cp_rxbuf[];
85} __packed;
86
87#define VMBUS_CHAN_SGLIST_MAX		32
88#define VMBUS_CHAN_PRPLIST_MAX		32
89
90struct hv_vmbus_channel;
91
92int	vmbus_chan_recv(struct hv_vmbus_channel *chan, void *data, int *dlen,
93	    uint64_t *xactid);
94int	vmbus_chan_recv_pkt(struct hv_vmbus_channel *chan,
95	    struct vmbus_chanpkt_hdr *pkt, int *pktlen);
96
97int	vmbus_chan_send(struct hv_vmbus_channel *chan, uint16_t type,
98	    uint16_t flags, void *data, int dlen, uint64_t xactid);
99int	vmbus_chan_send_sglist(struct hv_vmbus_channel *chan,
100	    struct vmbus_gpa sg[], int sglen, void *data, int dlen,
101	    uint64_t xactid);
102int	vmbus_chan_send_prplist(struct hv_vmbus_channel *chan,
103	    struct vmbus_gpa_range *prp, int prp_cnt, void *data, int dlen,
104	    uint64_t xactid);
105
106#endif	/* !_VMBUS_H_ */
107