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/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
  48 struct 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
  63 struct 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_msghc_ctx  *vmbus_msg_hc;
  72         struct vmbus_pcpu_data  vmbus_pcpu[MAXCPU];
  73
  74         /* Rarely used fields */
  75         device_t                vmbus_dev;
  76         int                     vmbus_idtvec;
  77         uint32_t                vmbus_flags;    /* see VMBUS_FLAG_ */
  78
  79         /* Shared memory for vmbus_{rx,tx}_evtflags */
  80         void                    *vmbus_evtflags;
  81         struct hyperv_dma       vmbus_evtflags_dma;
  82
  83         void                    *vmbus_mnf1;    /* monitored by VM, unused */
  84         struct hyperv_dma       vmbus_mnf1_dma;
  85         struct hyperv_dma       vmbus_mnf2_dma;
  86
  87         struct mtx              vmbus_scan_lock;
  88         uint32_t                vmbus_scan_chcnt;
  89 #define VMBUS_SCAN_CHCNT_DONE   0x80000000
  90         uint32_t                vmbus_scan_devcnt;
  91 };
  92
  93 #define VMBUS_FLAG_ATTACHED     0x0001  /* vmbus was attached */
  94 #define VMBUS_FLAG_SYNIC        0x0002  /* SynIC was setup */
  95
  96 extern struct vmbus_softc       *vmbus_sc;
  97
  98 static __inline struct vmbus_softc *
  99 vmbus_get_softc(void)
 100 {
 101         return vmbus_sc;
 102 }
 103
 104 static __inline device_t
 105 vmbus_get_device(void)
 106 {
 107         return vmbus_sc->vmbus_dev;
 108 }
 109
 110 #define VMBUS_PCPU_GET(sc, field, cpu)  (sc)->vmbus_pcpu[(cpu)].field
 111 #define VMBUS_PCPU_PTR(sc, field, cpu)  &(sc)->vmbus_pcpu[(cpu)].field
 112
 113 struct hv_vmbus_channel;
 114 struct trapframe;
 115 struct vmbus_message;
 116 struct vmbus_msghc;
 117
 118 void    vmbus_on_channel_open(const struct hv_vmbus_channel *);
 119 void    vmbus_event_proc(struct vmbus_softc *, int);
 120 void    vmbus_event_proc_compat(struct vmbus_softc *, int);
 121 void    vmbus_handle_intr(struct trapframe *);
 122
 123 void    vmbus_et_intr(struct trapframe *);
 124
 125 void    vmbus_chan_msgproc(struct vmbus_softc *, const struct vmbus_message *);
 126
 127 struct vmbus_msghc *vmbus_msghc_get(struct vmbus_softc *, size_t);
 128 void    vmbus_msghc_put(struct vmbus_softc *, struct vmbus_msghc *);
 129 void    *vmbus_msghc_dataptr(struct vmbus_msghc *);
 130 int     vmbus_msghc_exec_noresult(struct vmbus_msghc *);
 131 int     vmbus_msghc_exec(struct vmbus_softc *, struct vmbus_msghc *);
 132 const struct vmbus_message *vmbus_msghc_wait_result(struct vmbus_softc *,
 133             struct vmbus_msghc *);
 134 void    vmbus_msghc_wakeup(struct vmbus_softc *, const struct vmbus_message *);
 135
 136 void    vmbus_scan_done(struct vmbus_softc *);
 137 void    vmbus_scan_newchan(struct vmbus_softc *);
 138
 139 #endif  /* !_VMBUS_VAR_H_ */