drivers/hv/hyperv_vmbus.h

   1 /*
   2  *
   3  * Copyright (c) 2011, Microsoft Corporation.
   4  *
   5  * This program is free software; you can redistribute it and/or modify it
   6  * under the terms and conditions of the GNU General Public License,
   7  * version 2, as published by the Free Software Foundation.
   8  *
   9  * This program is distributed in the hope it will be useful, but WITHOUT
  10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  12  * more details.
  13  *
  14  * You should have received a copy of the GNU General Public License along with
  15  * this program; if not, write to the Free Software Foundation, Inc., 59 Temple
  16  * Place - Suite 330, Boston, MA 02111-1307 USA.
  17  *
  18  * Authors:
  19  *   Haiyang Zhang <haiyangz@microsoft.com>
  20  *   Hank Janssen  <hjanssen@microsoft.com>
  21  *   K. Y. Srinivasan <kys@microsoft.com>
  22  *
  23  */
  24
  25 #ifndef _HYPERV_VMBUS_H
  26 #define _HYPERV_VMBUS_H
  27
  28 #include <linux/list.h>
  29 #include <asm/sync_bitops.h>
  30 #include <linux/atomic.h>
  31 #include <linux/hyperv.h>
  32
  33 /*
  34  * Timeout for services such as KVP and fcopy.
  35  */
  36 #define HV_UTIL_TIMEOUT 30
  37
  38 /*
  39  * Timeout for guest-host handshake for services.
  40  */
  41 #define HV_UTIL_NEGO_TIMEOUT 55
  42
  43
  44
  45
  46 #define HV_EVENT_FLAGS_BYTE_COUNT       (256)
  47 #define HV_EVENT_FLAGS_DWORD_COUNT      (256 / sizeof(u32))
  48
  49 /*
  50  * Timer configuration register.
  51  */
  52 union hv_timer_config {
  53         u64 as_uint64;
  54         struct {
  55                 u64 enable:1;
  56                 u64 periodic:1;
  57                 u64 lazy:1;
  58                 u64 auto_enable:1;
  59                 u64 reserved_z0:12;
  60                 u64 sintx:4;
  61                 u64 reserved_z1:44;
  62         };
  63 };
  64
  65
  66 /* Define the synthetic interrupt controller event flags format. */
  67 union hv_synic_event_flags {
  68         u8 flags8[HV_EVENT_FLAGS_BYTE_COUNT];
  69         u32 flags32[HV_EVENT_FLAGS_DWORD_COUNT];
  70 };
  71
  72 /* Define SynIC control register. */
  73 union hv_synic_scontrol {
  74         u64 as_uint64;
  75         struct {
  76                 u64 enable:1;
  77                 u64 reserved:63;
  78         };
  79 };
  80
  81 /* Define synthetic interrupt source. */
  82 union hv_synic_sint {
  83         u64 as_uint64;
  84         struct {
  85                 u64 vector:8;
  86                 u64 reserved1:8;
  87                 u64 masked:1;
  88                 u64 auto_eoi:1;
  89                 u64 reserved2:46;
  90         };
  91 };
  92
  93 /* Define the format of the SIMP register */
  94 union hv_synic_simp {
  95         u64 as_uint64;
  96         struct {
  97                 u64 simp_enabled:1;
  98                 u64 preserved:11;
  99                 u64 base_simp_gpa:52;
 100         };
 101 };
 102
 103 /* Define the format of the SIEFP register */
 104 union hv_synic_siefp {
 105         u64 as_uint64;
 106         struct {
 107                 u64 siefp_enabled:1;
 108                 u64 preserved:11;
 109                 u64 base_siefp_gpa:52;
 110         };
 111 };
 112
 113 /* Definitions for the monitored notification facility */
 114 union hv_monitor_trigger_group {
 115         u64 as_uint64;
 116         struct {
 117                 u32 pending;
 118                 u32 armed;
 119         };
 120 };
 121
 122 struct hv_monitor_parameter {
 123         union hv_connection_id connectionid;
 124         u16 flagnumber;
 125         u16 rsvdz;
 126 };
 127
 128 union hv_monitor_trigger_state {
 129         u32 asu32;
 130
 131         struct {
 132                 u32 group_enable:4;
 133                 u32 rsvdz:28;
 134         };
 135 };
 136
 137 /* struct hv_monitor_page Layout */
 138 /* ------------------------------------------------------ */
 139 /* | 0   | TriggerState (4 bytes) | Rsvd1 (4 bytes)     | */
 140 /* | 8   | TriggerGroup[0]                              | */
 141 /* | 10  | TriggerGroup[1]                              | */
 142 /* | 18  | TriggerGroup[2]                              | */
 143 /* | 20  | TriggerGroup[3]                              | */
 144 /* | 28  | Rsvd2[0]                                     | */
 145 /* | 30  | Rsvd2[1]                                     | */
 146 /* | 38  | Rsvd2[2]                                     | */
 147 /* | 40  | NextCheckTime[0][0]    | NextCheckTime[0][1] | */
 148 /* | ...                                                | */
 149 /* | 240 | Latency[0][0..3]                             | */
 150 /* | 340 | Rsvz3[0]                                     | */
 151 /* | 440 | Parameter[0][0]                              | */
 152 /* | 448 | Parameter[0][1]                              | */
 153 /* | ...                                                | */
 154 /* | 840 | Rsvd4[0]                                     | */
 155 /* ------------------------------------------------------ */
 156 struct hv_monitor_page {
 157         union hv_monitor_trigger_state trigger_state;
 158         u32 rsvdz1;
 159
 160         union hv_monitor_trigger_group trigger_group[4];
 161         u64 rsvdz2[3];
 162
 163         s32 next_checktime[4][32];
 164
 165         u16 latency[4][32];
 166         u64 rsvdz3[32];
 167
 168         struct hv_monitor_parameter parameter[4][32];
 169
 170         u8 rsvdz4[1984];
 171 };
 172
 173 #define HV_HYPERCALL_PARAM_ALIGN        sizeof(u64)
 174
 175 /* Definition of the hv_post_message hypercall input structure. */
 176 struct hv_input_post_message {
 177         union hv_connection_id connectionid;
 178         u32 reserved;
 179         u32 message_type;
 180         u32 payload_size;
 181         u64 payload[HV_MESSAGE_PAYLOAD_QWORD_COUNT];
 182 };
 183
 184
 185 enum {
 186         VMBUS_MESSAGE_CONNECTION_ID     = 1,
 187         VMBUS_MESSAGE_PORT_ID           = 1,
 188         VMBUS_EVENT_CONNECTION_ID       = 2,
 189         VMBUS_EVENT_PORT_ID             = 2,
 190         VMBUS_MONITOR_CONNECTION_ID     = 3,
 191         VMBUS_MONITOR_PORT_ID           = 3,
 192         VMBUS_MESSAGE_SINT              = 2,
 193 };
 194
 195 struct hv_context {
 196         /* We only support running on top of Hyper-V
 197         * So at this point this really can only contain the Hyper-V ID
 198         */
 199         u64 guestid;
 200
 201         void *tsc_page;
 202
 203         bool synic_initialized;
 204
 205         void *synic_message_page[NR_CPUS];
 206         void *synic_event_page[NR_CPUS];
 207         /*
 208          * Hypervisor's notion of virtual processor ID is different from
 209          * Linux' notion of CPU ID. This information can only be retrieved
 210          * in the context of the calling CPU. Setup a map for easy access
 211          * to this information:
 212          *
 213          * vp_index[a] is the Hyper-V's processor ID corresponding to
 214          * Linux cpuid 'a'.
 215          */
 216         u32 vp_index[NR_CPUS];
 217         /*
 218          * Starting with win8, we can take channel interrupts on any CPU;
 219          * we will manage the tasklet that handles events messages on a per CPU
 220          * basis.
 221          */
 222         struct tasklet_struct *event_dpc[NR_CPUS];
 223         struct tasklet_struct *msg_dpc[NR_CPUS];
 224         /*
 225          * To optimize the mapping of relid to channel, maintain
 226          * per-cpu list of the channels based on their CPU affinity.
 227          */
 228         struct list_head percpu_list[NR_CPUS];
 229         /*
 230          * buffer to post messages to the host.
 231          */
 232         void *post_msg_page[NR_CPUS];
 233         /*
 234          * Support PV clockevent device.
 235          */
 236         struct clock_event_device *clk_evt[NR_CPUS];
 237         /*
 238          * To manage allocations in a NUMA node.
 239          * Array indexed by numa node ID.
 240          */
 241         struct cpumask *hv_numa_map;
 242 };
 243
 244 extern struct hv_context hv_context;
 245
 246 struct hv_ring_buffer_debug_info {
 247         u32 current_interrupt_mask;
 248         u32 current_read_index;
 249         u32 current_write_index;
 250         u32 bytes_avail_toread;
 251         u32 bytes_avail_towrite;
 252 };
 253
 254 /* Hv Interface */
 255
 256 extern int hv_init(void);
 257
 258 extern int hv_post_message(union hv_connection_id connection_id,
 259                          enum hv_message_type message_type,
 260                          void *payload, size_t payload_size);
 261
 262 extern int hv_synic_alloc(void);
 263
 264 extern void hv_synic_free(void);
 265
 266 extern int hv_synic_init(unsigned int cpu);
 267
 268 extern int hv_synic_cleanup(unsigned int cpu);
 269
 270 extern void hv_synic_clockevents_cleanup(void);
 271
 272 /* Interface */
 273
 274
 275 int hv_ringbuffer_init(struct hv_ring_buffer_info *ring_info,
 276                        struct page *pages, u32 pagecnt);
 277
 278 void hv_ringbuffer_cleanup(struct hv_ring_buffer_info *ring_info);
 279
 280 int hv_ringbuffer_write(struct vmbus_channel *channel,
 281                     struct kvec *kv_list,
 282                     u32 kv_count, bool lock,
 283                     bool kick_q);
 284
 285 int hv_ringbuffer_read(struct vmbus_channel *channel,
 286                        void *buffer, u32 buflen, u32 *buffer_actual_len,
 287                        u64 *requestid, bool raw);
 288
 289 void hv_ringbuffer_get_debuginfo(struct hv_ring_buffer_info *ring_info,
 290                             struct hv_ring_buffer_debug_info *debug_info);
 291
 292 void hv_begin_read(struct hv_ring_buffer_info *rbi);
 293
 294 u32 hv_end_read(struct hv_ring_buffer_info *rbi);
 295
 296 /*
 297  * Maximum channels is determined by the size of the interrupt page
 298  * which is PAGE_SIZE. 1/2 of PAGE_SIZE is for send endpoint interrupt
 299  * and the other is receive endpoint interrupt
 300  */
 301 #define MAX_NUM_CHANNELS        ((PAGE_SIZE >> 1) << 3) /* 16348 channels */
 302
 303 /* The value here must be in multiple of 32 */
 304 /* TODO: Need to make this configurable */
 305 #define MAX_NUM_CHANNELS_SUPPORTED      256
 306
 307
 308 enum vmbus_connect_state {
 309         DISCONNECTED,
 310         CONNECTING,
 311         CONNECTED,
 312         DISCONNECTING
 313 };
 314
 315 #define MAX_SIZE_CHANNEL_MESSAGE        HV_MESSAGE_PAYLOAD_BYTE_COUNT
 316
 317 struct vmbus_connection {
 318         enum vmbus_connect_state conn_state;
 319
 320         atomic_t next_gpadl_handle;
 321
 322         struct completion  unload_event;
 323         /*
 324          * Represents channel interrupts. Each bit position represents a
 325          * channel.  When a channel sends an interrupt via VMBUS, it finds its
 326          * bit in the sendInterruptPage, set it and calls Hv to generate a port
 327          * event. The other end receives the port event and parse the
 328          * recvInterruptPage to see which bit is set
 329          */
 330         void *int_page;
 331         void *send_int_page;
 332         void *recv_int_page;
 333
 334         /*
 335          * 2 pages - 1st page for parent->child notification and 2nd
 336          * is child->parent notification
 337          */
 338         struct hv_monitor_page *monitor_pages[2];
 339         struct list_head chn_msg_list;
 340         spinlock_t channelmsg_lock;
 341
 342         /* List of channels */
 343         struct list_head chn_list;
 344         struct mutex channel_mutex;
 345
 346         struct workqueue_struct *work_queue;
 347 };
 348
 349
 350 struct vmbus_msginfo {
 351         /* Bookkeeping stuff */
 352         struct list_head msglist_entry;
 353
 354         /* The message itself */
 355         unsigned char msg[0];
 356 };
 357
 358
 359 extern struct vmbus_connection vmbus_connection;
 360
 361 enum vmbus_message_handler_type {
 362         /* The related handler can sleep. */
 363         VMHT_BLOCKING = 0,
 364
 365         /* The related handler must NOT sleep. */
 366         VMHT_NON_BLOCKING = 1,
 367 };
 368
 369 struct vmbus_channel_message_table_entry {
 370         enum vmbus_channel_message_type message_type;
 371         enum vmbus_message_handler_type handler_type;
 372         void (*message_handler)(struct vmbus_channel_message_header *msg);
 373 };
 374
 375 extern struct vmbus_channel_message_table_entry
 376         channel_message_table[CHANNELMSG_COUNT];
 377
 378
 379 /* General vmbus interface */
 380
 381 struct hv_device *vmbus_device_create(const uuid_le *type,
 382                                       const uuid_le *instance,
 383                                       struct vmbus_channel *channel);
 384
 385 int vmbus_device_register(struct hv_device *child_device_obj);
 386 void vmbus_device_unregister(struct hv_device *device_obj);
 387
 388 struct vmbus_channel *relid2channel(u32 relid);
 389
 390 void vmbus_free_channels(void);
 391
 392 /* Connection interface */
 393
 394 int vmbus_connect(void);
 395 void vmbus_disconnect(void);
 396
 397 int vmbus_post_msg(void *buffer, size_t buflen, bool can_sleep);
 398
 399 void vmbus_on_event(unsigned long data);
 400 void vmbus_on_msg_dpc(unsigned long data);
 401
 402 int hv_kvp_init(struct hv_util_service *);
 403 void hv_kvp_deinit(void);
 404 void hv_kvp_onchannelcallback(void *);
 405
 406 int hv_vss_init(struct hv_util_service *);
 407 void hv_vss_deinit(void);
 408 void hv_vss_onchannelcallback(void *);
 409
 410 int hv_fcopy_init(struct hv_util_service *);
 411 void hv_fcopy_deinit(void);
 412 void hv_fcopy_onchannelcallback(void *);
 413 void vmbus_initiate_unload(bool crash);
 414
 415 static inline void hv_poll_channel(struct vmbus_channel *channel,
 416                                    void (*cb)(void *))
 417 {
 418         if (!channel)
 419                 return;
 420
 421         smp_call_function_single(channel->target_cpu, cb, channel, true);
 422 }
 423
 424 enum hvutil_device_state {
 425         HVUTIL_DEVICE_INIT = 0,  /* driver is loaded, waiting for userspace */
 426         HVUTIL_READY,            /* userspace is registered */
 427         HVUTIL_HOSTMSG_RECEIVED, /* message from the host was received */
 428         HVUTIL_USERSPACE_REQ,    /* request to userspace was sent */
 429         HVUTIL_USERSPACE_RECV,   /* reply from userspace was received */
 430         HVUTIL_DEVICE_DYING,     /* driver unload is in progress */
 431 };
 432
 433 #endif /* _HYPERV_VMBUS_H */