sys/dev/virtual/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
  34 struct vmbus_pcpu_data {
  35         struct vmbus_message    *message;       /* shared messages */
  36         int                     event_flags_cnt;/* # of event flags */
  37         struct vmbus_evtflags   *event_flags;   /* event flags from host */
  38
  39         struct vmbus_softc      *sc;
  40         int                     cpuid;
  41         int                     vcpuid;
  42
  43         uint64_t                timer_last;
  44
  45         /*
  46          * Rarely used fields
  47          */
  48
  49         struct hyperv_dma       message_dma;    /* busdma glue */
  50         struct hyperv_dma       event_flags_dma;/* busdma glue */
  51
  52         /* Interrupt stuffs */
  53         void                    *intr_hand;
  54         struct resource         *intr_res;
  55         int                     intr_rid;
  56         int                     intr_irq;
  57         int                     intr_vec;
  58         char                    intr_desc[20];
  59 } __cachealign;
  60
  61 struct vmbus_softc {
  62         u_long                  *vmbus_tx_evtflags;
  63                                                 /* event flags to host */
  64         void                    *vmbus_mnf2;    /* monitored by host */
  65
  66         u_long                  *vmbus_rx_evtflags;
  67                                                 /* compat evtflgs from host */
  68         struct vmbus_pcpu_data  vmbus_pcpu[MAXCPU];
  69
  70         /*
  71          * Rarely used fields
  72          */
  73
  74         device_t                vmbus_dev;
  75         struct vmbus_msghc_ctx  *vmbus_msg_hc;
  76         uint32_t                vmbus_flags;    /* see VMBUS_FLAG_ */
  77         uint32_t                vmbus_version;  /* VMBUS_VERSION_ */
  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
  88 #define VMBUS_FLAG_SYNIC        0x0002  /* SynIC was setup */
  89
  90 #define VMBUS_PCPU(sc, cpu)     &(sc)->vmbus_pcpu[(cpu)]
  91
  92 struct vmbus_message;
  93 struct vmbus_msghc;
  94
  95 struct vmbus_msghc *vmbus_msghc_get(struct vmbus_softc *, size_t);
  96 void    vmbus_msghc_put(struct vmbus_softc *, struct vmbus_msghc *);
  97 void    *vmbus_msghc_dataptr(struct vmbus_msghc *);
  98 int     vmbus_msghc_exec_noresult(struct vmbus_msghc *);
  99 int     vmbus_msghc_exec(struct vmbus_softc *, struct vmbus_msghc *);
 100 const struct vmbus_message *vmbus_msghc_wait_result(struct vmbus_softc *,
 101             struct vmbus_msghc *);
 102 void    vmbus_msghc_wakeup(struct vmbus_softc *, const struct vmbus_message *);
 103
 104 #endif  /* !_VMBUS_VAR_H_ */