sys/dev/hyperv/vmbus/hv_vmbus_priv.h

   1 /*-
   2  * Copyright (c) 2009-2012,2016 Microsoft Corp.
   3  * Copyright (c) 2012 NetApp Inc.
   4  * Copyright (c) 2012 Citrix Inc.
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice unmodified, this list of conditions, and the following
  12  *    disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the distribution.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  18  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  19  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  20  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  21  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  22  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  *
  28  * $FreeBSD$
  29  */
  30
  31 #ifndef __HYPERV_PRIV_H__
  32 #define __HYPERV_PRIV_H__
  33
  34 #include <sys/param.h>
  35 #include <sys/lock.h>
  36 #include <sys/mutex.h>
  37 #include <sys/sema.h>
  38 #include <sys/_iovec.h>
  39
  40 #include <dev/hyperv/vmbus/vmbus_chanvar.h>
  41
  42 struct vmbus_softc;
  43
  44 /*
  45  * Private, VM Bus functions
  46  */
  47 struct sysctl_ctx_list;
  48 struct sysctl_oid;
  49
  50 void    vmbus_br_sysctl_create(struct sysctl_ctx_list *ctx,
  51             struct sysctl_oid *br_tree, hv_vmbus_ring_buffer_info *br,
  52             const char *name);
  53
  54 int                     hv_vmbus_ring_buffer_init(
  55                                 hv_vmbus_ring_buffer_info       *ring_info,
  56                                 void                            *buffer,
  57                                 uint32_t                        buffer_len);
  58
  59 void                    hv_ring_buffer_cleanup(
  60                                 hv_vmbus_ring_buffer_info       *ring_info);
  61
  62 int                     hv_ring_buffer_write(
  63                                 hv_vmbus_ring_buffer_info       *ring_info,
  64                                 const struct iovec              iov[],
  65                                 uint32_t                        iovlen,
  66                                 boolean_t                       *need_sig);
  67
  68 int                     hv_ring_buffer_peek(
  69                                 hv_vmbus_ring_buffer_info       *ring_info,
  70                                 void                            *buffer,
  71                                 uint32_t                        buffer_len);
  72
  73 int                     hv_ring_buffer_read(
  74                                 hv_vmbus_ring_buffer_info       *ring_info,
  75                                 void                            *buffer,
  76                                 uint32_t                        buffer_len,
  77                                 uint32_t                        offset);
  78
  79 void                    hv_ring_buffer_read_begin(
  80                                 hv_vmbus_ring_buffer_info       *ring_info);
  81
  82 uint32_t                hv_ring_buffer_read_end(
  83                                 hv_vmbus_ring_buffer_info       *ring_info);
  84
  85 #endif  /* __HYPERV_PRIV_H__ */