sys/dev/hyperv/vmbus/vmbus_var.h

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