usr.sbin/bhyve/inout.h

   1 /*-
   2  * Copyright (c) 2011 NetApp, Inc.
   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, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY NETAPP, INC ``AS IS'' AND
  15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17  * ARE DISCLAIMED.  IN NO EVENT SHALL NETAPP, INC OR CONTRIBUTORS BE LIABLE
  18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24  * SUCH DAMAGE.
  25  *
  26  * $FreeBSD$
  27  */
  28
  29 #ifndef _INOUT_H_
  30 #define _INOUT_H_
  31
  32 #include <sys/linker_set.h>
  33
  34 struct vmctx;
  35 struct vm_exit;
  36
  37 /* Handler return values. */
  38 #define INOUT_ERROR     -1
  39 #define INOUT_OK        0
  40 #define INOUT_RESTART   1
  41 #define INOUT_RESET     2
  42 #define INOUT_POWEROFF  3
  43
  44 typedef int (*inout_func_t)(struct vmctx *ctx, int vcpu, int in, int port,
  45                             int bytes, uint32_t *eax, void *arg);
  46
  47 struct inout_port {
  48         const char      *name;
  49         int             port;
  50         int             size;
  51         int             flags;
  52         inout_func_t    handler;
  53         void            *arg;
  54 };
  55 #define IOPORT_F_IN             0x1
  56 #define IOPORT_F_OUT            0x2
  57 #define IOPORT_F_INOUT          (IOPORT_F_IN | IOPORT_F_OUT)
  58
  59 /*
  60  * The following flags are used internally and must not be used by
  61  * device models.
  62  */
  63 #define IOPORT_F_DEFAULT        0x80000000      /* claimed by default handler */
  64
  65 #define INOUT_PORT(name, port, flags, handler)                          \
  66         static struct inout_port __CONCAT(__inout_port, __LINE__) = {   \
  67                 #name,                                                  \
  68                 (port),                                                 \
  69                 1,                                                      \
  70                 (flags),                                                \
  71                 (handler),                                              \
  72                 0                                                       \
  73         };                                                              \
  74         DATA_SET(inout_port_set, __CONCAT(__inout_port, __LINE__))
  75
  76 void    init_inout(void);
  77 int     emulate_inout(struct vmctx *, int vcpu, struct vm_exit *vmexit,
  78                       int strict);
  79 int     register_inout(struct inout_port *iop);
  80 int     unregister_inout(struct inout_port *iop);
  81 void    init_bvmcons(void);
  82
  83 #endif  /* _INOUT_H_ */