vmbus_var.h revision 302170 
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 302170 2016-06-24 02:30:14Z sephe $
27 */
28
29#ifndef _VMBUS_VAR_H_
30#define _VMBUS_VAR_H_
31
32#include <sys/param.h>
33#include <sys/taskqueue.h>
34
35#include <dev/hyperv/include/hyperv_busdma.h>
36
37/*
38 * NOTE: DO NOT CHANGE THIS.
39 */
40#define VMBUS_SINT_MESSAGE	2
41/*
42 * NOTE:
43 * - DO NOT set it to the same value as VMBUS_SINT_MESSAGE.
44 * - DO NOT set it to 0.
45 */
46#define VMBUS_SINT_TIMER	4
47
48struct vmbus_pcpu_data {
49	u_long			*intr_cnt;	/* Hyper-V interrupt counter */
50	struct vmbus_message	*message;	/* shared messages */
51	uint32_t		vcpuid;		/* virtual cpuid */
52	int			event_flags_cnt;/* # of event flags */
53	struct vmbus_evtflags	*event_flags;	/* event flags from host */
54
55	/* Rarely used fields */
56	struct hyperv_dma	message_dma;	/* busdma glue */
57	struct hyperv_dma	event_flags_dma;/* busdma glue */
58	struct taskqueue	*event_tq;	/* event taskq */
59	struct taskqueue	*message_tq;	/* message taskq */
60	struct task		message_task;	/* message task */
61} __aligned(CACHE_LINE_SIZE);
62
63struct vmbus_softc {
64	void			(*vmbus_event_proc)(struct vmbus_softc *, int);
65	u_long			*vmbus_tx_evtflags;
66						/* event flags to host */
67	void			*vmbus_mnf2;	/* monitored by host */
68
69	u_long			*vmbus_rx_evtflags;
70						/* compat evtflgs from host */
71	struct vmbus_pcpu_data	vmbus_pcpu[MAXCPU];
72
73	/* Rarely used fields */
74	device_t		vmbus_dev;
75	int			vmbus_idtvec;
76	uint32_t		vmbus_flags;	/* see VMBUS_FLAG_ */
77
78	/* Shared memory for vmbus_{rx,tx}_evtflags */
79	void			*vmbus_evtflags;
80	struct hyperv_dma	vmbus_evtflags_dma;
81
82	void			*vmbus_mnf1;	/* monitored by VM, unused */
83	struct hyperv_dma	vmbus_mnf1_dma;
84	struct hyperv_dma	vmbus_mnf2_dma;
85};
86
87#define VMBUS_FLAG_ATTACHED	0x0001	/* vmbus was attached */
88#define VMBUS_FLAG_SYNIC	0x0002	/* SynIC was setup */
89
90extern struct vmbus_softc	*vmbus_sc;
91
92static __inline struct vmbus_softc *
93vmbus_get_softc(void)
94{
95	return vmbus_sc;
96}
97
98static __inline device_t
99vmbus_get_device(void)
100{
101	return vmbus_sc->vmbus_dev;
102}
103
104#define VMBUS_PCPU_GET(sc, field, cpu)	(sc)->vmbus_pcpu[(cpu)].field
105#define VMBUS_PCPU_PTR(sc, field, cpu)	&(sc)->vmbus_pcpu[(cpu)].field
106
107struct hv_vmbus_channel;
108struct trapframe;
109struct vmbus_message;
110
111void	vmbus_on_channel_open(const struct hv_vmbus_channel *);
112void	vmbus_event_proc(struct vmbus_softc *, int);
113void	vmbus_event_proc_compat(struct vmbus_softc *, int);
114void	vmbus_handle_intr(struct trapframe *);
115
116void	vmbus_et_intr(struct trapframe *);
117
118void	vmbus_chan_msgproc(struct vmbus_softc *, const struct vmbus_message *);
119
120#endif	/* !_VMBUS_VAR_H_ */
121