usr/src/cmd/bhyve/inout.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   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  * This file and its contents are supplied under the terms of the
  32  * Common Development and Distribution License ("CDDL"), version 1.0.
  33  * You may only use this file in accordance with the terms of version
  34  * 1.0 of the CDDL.
  35  *
  36  * A full copy of the text of the CDDL should have accompanied this
  37  * source.  A copy of the CDDL is also available via the Internet at
  38  * http://www.illumos.org/license/CDDL.
  39  *
  40  * Copyright 2014 Pluribus Networks Inc.
  41  */
  42
  43 #ifndef _INOUT_H_
  44 #define _INOUT_H_
  45
  46 #include <sys/linker_set.h>
  47
  48 struct vmctx;
  49 struct vm_exit;
  50 #ifndef __FreeBSD__
  51 struct vm_inout;
  52 #endif
  53
  54 /*
  55  * inout emulation handlers return 0 on success and -1 on failure.
  56  */
  57 typedef int (*inout_func_t)(struct vmctx *ctx, int in, int port,
  58                             int bytes, uint32_t *eax, void *arg);
  59
  60 struct inout_port {
  61         const char      *name;
  62         int             port;
  63         int             size;
  64         int             flags;
  65         inout_func_t    handler;
  66         void            *arg;
  67 };
  68 #define IOPORT_F_IN             0x1
  69 #define IOPORT_F_OUT            0x2
  70 #define IOPORT_F_INOUT          (IOPORT_F_IN | IOPORT_F_OUT)
  71
  72 /*
  73  * The following flags are used internally and must not be used by
  74  * device models.
  75  */
  76 #define IOPORT_F_DEFAULT        0x80000000      /* claimed by default handler */
  77
  78 #define INOUT_PORT(name, port, flags, handler)                          \
  79         static struct inout_port __CONCAT(__inout_port, __LINE__) = {   \
  80                 #name,                                                  \
  81                 (port),                                                 \
  82                 1,                                                      \
  83                 (flags),                                                \
  84                 (handler),                                              \
  85                 0                                                       \
  86         };                                                              \
  87         DATA_SET(inout_port_set, __CONCAT(__inout_port, __LINE__))
  88
  89 void    init_inout(void);
  90 #ifdef __FreeBSD__
  91 int     emulate_inout(struct vmctx *, int vcpu, struct vm_exit *vmexit);
  92 #else
  93 int     emulate_inout(struct vmctx *, int vcpu, struct vm_inout *inout);
  94 #endif
  95 int     register_inout(struct inout_port *iop);
  96 int     unregister_inout(struct inout_port *iop);
  97
  98 #endif  /* _INOUT_H_ */