usr.sbin/bhyve/inout.h

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