vmbus_var.h revision 309313 
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/10/sys/dev/hyperv/vmbus/vmbus_var.h 309313 2016-11-30 06:26:37Z dexuan $
27 */
28
29#ifndef _VMBUS_VAR_H_
30#define _VMBUS_VAR_H_
31
32#include <sys/param.h>
33#include <sys/taskqueue.h>
34#include <sys/rman.h>
35
36#include <dev/hyperv/include/hyperv_busdma.h>
37#include <dev/pci/pcivar.h>
38#include <dev/pci/pcib_private.h>
39
40/*
41 * NOTE: DO NOT CHANGE THIS.
42 */
43#define VMBUS_SINT_MESSAGE	2
44/*
45 * NOTE:
46 * - DO NOT set it to the same value as VMBUS_SINT_MESSAGE.
47 * - DO NOT set it to 0.
48 */
49#define VMBUS_SINT_TIMER	4
50
51/*
52 * NOTE: DO NOT CHANGE THESE
53 */
54#define VMBUS_CONNID_MESSAGE		1
55#define VMBUS_CONNID_EVENT		2
56
57struct vmbus_message;
58struct vmbus_softc;
59
60typedef void		(*vmbus_chanmsg_proc_t)(struct vmbus_softc *,
61			    const struct vmbus_message *);
62
63#define VMBUS_CHANMSG_PROC(name, func)	\
64	[VMBUS_CHANMSG_TYPE_##name] = func
65#define VMBUS_CHANMSG_PROC_WAKEUP(name)	\
66	VMBUS_CHANMSG_PROC(name, vmbus_msghc_wakeup)
67
68struct vmbus_pcpu_data {
69	u_long			*intr_cnt;	/* Hyper-V interrupt counter */
70	struct vmbus_message	*message;	/* shared messages */
71	uint32_t		vcpuid;		/* virtual cpuid */
72	int			event_flags_cnt;/* # of event flags */
73	struct vmbus_evtflags	*event_flags;	/* event flags from host */
74
75	/* Rarely used fields */
76	struct hyperv_dma	message_dma;	/* busdma glue */
77	struct hyperv_dma	event_flags_dma;/* busdma glue */
78	struct taskqueue	*event_tq;	/* event taskq */
79	struct taskqueue	*message_tq;	/* message taskq */
80	struct task		message_task;	/* message task */
81} __aligned(CACHE_LINE_SIZE);
82
83#if __FreeBSD_version < 1100000
84typedef u_long rman_res_t;
85#endif
86
87struct vmbus_softc {
88	void			(*vmbus_event_proc)(struct vmbus_softc *, int);
89	u_long			*vmbus_tx_evtflags;
90						/* event flags to host */
91	struct vmbus_mnf	*vmbus_mnf2;	/* monitored by host */
92
93	u_long			*vmbus_rx_evtflags;
94						/* compat evtflgs from host */
95	struct vmbus_channel	**vmbus_chmap;
96	struct vmbus_xact_ctx	*vmbus_xc;
97	struct vmbus_pcpu_data	vmbus_pcpu[MAXCPU];
98
99	/*
100	 * Rarely used fields
101	 */
102
103	device_t		vmbus_dev;
104	int			vmbus_idtvec;
105	uint32_t		vmbus_flags;	/* see VMBUS_FLAG_ */
106	uint32_t		vmbus_version;
107	uint32_t		vmbus_gpadl;
108
109	/* Shared memory for vmbus_{rx,tx}_evtflags */
110	void			*vmbus_evtflags;
111	struct hyperv_dma	vmbus_evtflags_dma;
112
113	void			*vmbus_mnf1;	/* monitored by VM, unused */
114	struct hyperv_dma	vmbus_mnf1_dma;
115	struct hyperv_dma	vmbus_mnf2_dma;
116
117	bool			vmbus_scandone;
118	struct task		vmbus_scandone_task;
119
120	struct taskqueue	*vmbus_devtq;	/* for dev attach/detach */
121	struct taskqueue	*vmbus_subchtq;	/* for sub-chan attach/detach */
122
123	/* Primary channels */
124	struct mtx		vmbus_prichan_lock;
125	TAILQ_HEAD(, vmbus_channel) vmbus_prichans;
126
127	/* Complete channel list */
128	struct mtx		vmbus_chan_lock;
129	TAILQ_HEAD(, vmbus_channel) vmbus_chans;
130
131#ifdef NEW_PCIB
132	/* The list of usable MMIO ranges for PCIe pass-through */
133	struct pcib_host_resources vmbus_mmio_res;
134#endif
135};
136
137#define VMBUS_FLAG_ATTACHED	0x0001	/* vmbus was attached */
138#define VMBUS_FLAG_SYNIC	0x0002	/* SynIC was setup */
139
140#define VMBUS_PCPU_GET(sc, field, cpu)	(sc)->vmbus_pcpu[(cpu)].field
141#define VMBUS_PCPU_PTR(sc, field, cpu)	&(sc)->vmbus_pcpu[(cpu)].field
142
143struct vmbus_channel;
144struct trapframe;
145struct vmbus_message;
146struct vmbus_msghc;
147
148void		vmbus_handle_intr(struct trapframe *);
149int		vmbus_add_child(struct vmbus_channel *);
150int		vmbus_delete_child(struct vmbus_channel *);
151void		vmbus_et_intr(struct trapframe *);
152uint32_t	vmbus_gpadl_alloc(struct vmbus_softc *);
153
154struct vmbus_msghc *
155		vmbus_msghc_get(struct vmbus_softc *, size_t);
156void		vmbus_msghc_put(struct vmbus_softc *, struct vmbus_msghc *);
157void		*vmbus_msghc_dataptr(struct vmbus_msghc *);
158int		vmbus_msghc_exec_noresult(struct vmbus_msghc *);
159int		vmbus_msghc_exec(struct vmbus_softc *, struct vmbus_msghc *);
160const struct vmbus_message *
161		vmbus_msghc_wait_result(struct vmbus_softc *,
162		    struct vmbus_msghc *);
163void		vmbus_msghc_wakeup(struct vmbus_softc *,
164		    const struct vmbus_message *);
165void		vmbus_msghc_reset(struct vmbus_msghc *, size_t);
166
167#endif	/* !_VMBUS_VAR_H_ */
168