sys/dev/virtio/mmio/virtio_mmio_if.m

   1 #-
   2 # Copyright (c) 2014 Ruslan Bukin <br@bsdpad.com>
   3 # All rights reserved.
   4 #
   5 # This software was developed by SRI International and the University of
   6 # Cambridge Computer Laboratory under DARPA/AFRL contract (FA8750-10-C-0237)
   7 # ("CTSRD"), as part of the DARPA CRASH research programme.
   8 #
   9 # Redistribution and use in source and binary forms, with or without
  10 # modification, are permitted provided that the following conditions
  11 # are met:
  12 # 1. Redistributions of source code must retain the above copyright
  13 #    notice, this list of conditions and the following disclaimer.
  14 # 2. Redistributions in binary form must reproduce the above copyright
  15 #    notice, this list of conditions and the following disclaimer in the
  16 #    documentation and/or other materials provided with the distribution.
  17 #
  18 # THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  19 # ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20 # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21 # ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  22 # FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23 # DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24 # OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25 # HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26 # LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27 # OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28 # SUCH DAMAGE.
  29 #
  30 # $FreeBSD$
  31 #
  32
  33 #include <sys/types.h>
  34
  35 #
  36 # This is optional interface to virtio mmio backend.
  37 # Useful when backend is implemented not by the hardware but software, e.g.
  38 # by using another cpu core.
  39 #
  40
  41 INTERFACE virtio_mmio;
  42
  43 CODE {
  44         static int
  45         virtio_mmio_prewrite(device_t dev, size_t offset, int val)
  46         {
  47
  48                 return (1);
  49         }
  50
  51         static int
  52         virtio_mmio_note(device_t dev, size_t offset, int val)
  53         {
  54
  55                 return (1);
  56         }
  57
  58         static int
  59         virtio_mmio_setup_intr(device_t dev, device_t mmio_dev,
  60                                         void *handler, void *ih_user)
  61         {
  62
  63                 return (1);
  64         }
  65 };
  66
  67 #
  68 # Inform backend we are going to write data at offset.
  69 #
  70 METHOD int prewrite {
  71         device_t        dev;
  72         size_t          offset;
  73         int             val;
  74 } DEFAULT virtio_mmio_prewrite;
  75
  76 #
  77 # Inform backend we have data wrotten to offset.
  78 #
  79 METHOD int note {
  80         device_t        dev;
  81         size_t          offset;
  82         int             val;
  83 } DEFAULT virtio_mmio_note;
  84
  85 #
  86 # Inform backend we are going to poll virtqueue.
  87 #
  88 METHOD int poll {
  89         device_t        dev;
  90 };
  91
  92 #
  93 # Setup backend-specific interrupts.
  94 #
  95 METHOD int setup_intr {
  96         device_t        dev;
  97         device_t        mmio_dev;
  98         void            *handler;
  99         void            *ih_user;
 100 } DEFAULT virtio_mmio_setup_intr;