sys/amd64/vmm/io/vdev.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 _VDEV_H_
  30 #define _VDEV_H_
  31
  32 typedef enum {
  33         BYTE    = 1,
  34         WORD    = 2,
  35         DWORD   = 4,
  36         QWORD   = 8,
  37 } opsize_t;
  38
  39 typedef enum {
  40         MMIO_READ = 1,
  41         MMIO_WRITE = 2,
  42 } region_attr_t;
  43
  44 struct io_region {
  45         uint64_t        base;
  46         uint64_t        len;
  47         region_attr_t   attr;
  48         int             vcpu;
  49 };
  50
  51 typedef int (*vdev_init_t)(void* dev);
  52 typedef int (*vdev_reset_t)(void* dev);
  53 typedef int (*vdev_halt_t)(void* dev);
  54 typedef int (*vdev_memread_t)(void* dev, uint64_t gpa, opsize_t size, uint64_t *data);
  55 typedef int (*vdev_memwrite_t)(void* dev, uint64_t gpa, opsize_t size, uint64_t data);
  56
  57
  58 struct vdev_ops {
  59         const char      *name;
  60         vdev_init_t     init;
  61         vdev_reset_t    reset;
  62         vdev_halt_t     halt;
  63         vdev_memread_t  memread;
  64         vdev_memwrite_t memwrite;
  65 };
  66
  67
  68 void vdev_vm_init(void);
  69 void vdev_vm_cleanup(void);
  70
  71 int  vdev_register(struct vdev_ops *ops, void *dev);
  72 void vdev_unregister(void *dev);
  73
  74 int  vdev_register_region(struct vdev_ops *ops, void *dev, struct io_region *io);
  75 void vdev_unregister_region(void *dev, struct io_region *io);
  76
  77 int vdev_init(void);
  78 int vdev_reset(void);
  79 int vdev_halt(void);
  80 int vdev_memread(uint64_t gpa, opsize_t size, uint64_t *data);
  81 int vdev_memwrite(uint64_t gpa, opsize_t size, uint64_t data);
  82
  83 #endif  /* _VDEV_H_ */
  84