sys/dev/virtual/hyperv/vmbus/vmbus_reg.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_REG_H_
  30 #define _VMBUS_REG_H_
  31
  32 #include <sys/param.h>
  33
  34 /*
  35  * Hyper-V SynIC message format.
  36  */
  37
  38 #define VMBUS_MSG_DSIZE_MAX             240
  39 #define VMBUS_MSG_SIZE                  256
  40
  41 struct vmbus_message {
  42         uint32_t        msg_type;       /* HYPERV_MSGTYPE_ */
  43         uint8_t         msg_dsize;      /* data size */
  44         uint8_t         msg_flags;      /* VMBUS_MSGFLAG_ */
  45         uint16_t        msg_rsvd;
  46         uint64_t        msg_id;
  47         uint8_t         msg_data[VMBUS_MSG_DSIZE_MAX];
  48 } __packed;
  49 CTASSERT(sizeof(struct vmbus_message) == VMBUS_MSG_SIZE);
  50
  51 #define VMBUS_MSGFLAG_PENDING           0x01
  52
  53 /*
  54  * Hyper-V SynIC event flags
  55  */
  56
  57 #ifdef __LP64__
  58 #define VMBUS_EVTFLAGS_MAX      32
  59 #define VMBUS_EVTFLAG_SHIFT     6
  60 #else
  61 #define VMBUS_EVTFLAGS_MAX      64
  62 #define VMBUS_EVTFLAG_SHIFT     5
  63 #endif
  64 #define VMBUS_EVTFLAG_LEN       (1 << VMBUS_EVTFLAG_SHIFT)
  65 #define VMBUS_EVTFLAG_MASK      (VMBUS_EVTFLAG_LEN - 1)
  66 #define VMBUS_EVTFLAGS_SIZE     256
  67
  68 struct vmbus_evtflags {
  69         u_long          evt_flags[VMBUS_EVTFLAGS_MAX];
  70 } __packed;
  71 CTASSERT(sizeof(struct vmbus_evtflags) == VMBUS_EVTFLAGS_SIZE);
  72
  73 /*
  74  * Hyper-V vmbus version
  75  *
  76  * 0.13  --  Windows Server 2008
  77  * 1.1   --  Windows 7
  78  * 2.4   --  Windows 8
  79  * 3.0   --  Windows 8.1
  80  */
  81 #define VMBUS_VERSION_WS2008            ((0 << 16) | 13)
  82 #define VMBUS_VERSION_WIN7              ((1 << 16) | 1)
  83 #define VMBUS_VERSION_WIN8              ((2 << 16) | 4)
  84 #define VMBUS_VERSION_WIN8_1            ((3 << 16) | 0)
  85
  86 /*
  87  * Channel
  88  */
  89
  90 #define VMBUS_CHAN_MAX_COMPAT   256
  91 #define VMBUS_CHAN_MAX          (VMBUS_EVTFLAG_LEN * VMBUS_EVTFLAGS_MAX)
  92
  93 /*
  94  * Channel messages
  95  * - Embedded in vmbus_message.msg_data, e.g. response.
  96  * - Embedded in hypercall_postmsg_in.hc_data, e.g. request.
  97  */
  98
  99 #define VMBUS_CHANMSG_TYPE_CHANNEL_REQ          3       /* REQ */
 100 #define VMBUS_CHANMSG_TYPE_INIT_CONTACT         14      /* REQ */
 101 #define VMBUS_CHANMSG_TYPE_VERSION_RESP         15      /* RESP */
 102
 103 struct vmbus_chanmsg_hdr {
 104         uint32_t        chm_type;       /* VMBUS_CHANMSG_TYPE_ */
 105         uint32_t        chm_rsvd;
 106 } __packed;
 107
 108 /* VMBUS_CHANMSG_TYPE_INIT_CONTACT */
 109 struct vmbus_chanmsg_init_contact {
 110         struct vmbus_chanmsg_hdr chm_hdr;
 111         uint32_t        chm_ver;
 112         uint32_t        chm_rsvd;
 113         uint64_t        chm_evtflags;
 114         uint64_t        chm_mnf1;
 115         uint64_t        chm_mnf2;
 116 } __packed;
 117
 118 /* VMBUS_CHANMSG_TYPE_VERSION_RESP */
 119 struct vmbus_chanmsg_version_resp {
 120         struct vmbus_chanmsg_hdr chm_hdr;
 121         uint8_t         chm_supp;
 122 } __packed;
 123
 124 /* VMBUS_CHANMSG_TYPE_CHANNEL_REQ */
 125 struct vmbus_chanmsg_channel_req {
 126         struct vmbus_chanmsg_hdr chm_hdr;
 127 } __packed;
 128
 129 #endif  /* !_VMBUS_REG_H_ */