src/dev/arm/vio_mmio.hh

   1 /*
   2  * Copyright (c) 2016-2018 ARM Limited
   3  * All rights reserved
   4  *
   5  * The license below extends only to copyright in the software and shall
   6  * not be construed as granting a license to any other intellectual
   7  * property including but not limited to intellectual property relating
   8  * to a hardware implementation of the functionality of the software
   9  * licensed hereunder.  You may use the software subject to the license
  10  * terms below provided that you ensure that this notice is replicated
  11  * unmodified and in its entirety in all distributions of the software,
  12  * modified or unmodified, in source code or in binary form.
  13  *
  14  * Redistribution and use in source and binary forms, with or without
  15  * modification, are permitted provided that the following conditions are
  16  * met: redistributions of source code must retain the above copyright
  17  * notice, this list of conditions and the following disclaimer;
  18  * redistributions in binary form must reproduce the above copyright
  19  * notice, this list of conditions and the following disclaimer in the
  20  * documentation and/or other materials provided with the distribution;
  21  * neither the name of the copyright holders nor the names of its
  22  * contributors may be used to endorse or promote products derived from
  23  * this software without specific prior written permission.
  24  *
  25  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  26  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  27  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  28  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  29  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  30  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  31  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  32  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  33  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  34  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  35  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  36  */
  37
  38 #ifndef __DEV_ARM_VIO_MMIO_HH__
  39 #define __DEV_ARM_VIO_MMIO_HH__
  40
  41 #include "dev/io_device.hh"
  42 #include "dev/virtio/base.hh"
  43
  44 class ArmInterruptPin;
  45 struct MmioVirtIOParams;
  46
  47 class MmioVirtIO : public BasicPioDevice
  48 {
  49   public:
  50     MmioVirtIO(const MmioVirtIOParams *params);
  51     virtual ~MmioVirtIO();
  52
  53   protected: // BasicPioDevice
  54     Tick read(PacketPtr pkt) override;
  55     Tick write(PacketPtr pkt) override;
  56
  57   protected:
  58     /** @{ */
  59     /** Offsets into VirtIO MMIO space. */
  60
  61     enum : Addr {
  62         OFF_MAGIC = 0x00,
  63         OFF_VERSION = 0x04,
  64         OFF_DEVICE_ID = 0x08,
  65         OFF_VENDOR_ID = 0x0C,
  66         OFF_HOST_FEATURES = 0x10,
  67         OFF_HOST_FEATURES_SELECT = 0x14,
  68         OFF_GUEST_FEATURES = 0x20,
  69         OFF_GUEST_FEATURES_SELECT = 0x24,
  70         OFF_GUEST_PAGE_SIZE = 0x28,
  71         OFF_QUEUE_SELECT = 0x30,
  72         OFF_QUEUE_NUM_MAX = 0x34,
  73         OFF_QUEUE_NUM = 0x38,
  74         OFF_QUEUE_ALIGN = 0x3C,
  75         OFF_QUEUE_PFN = 0x40,
  76         OFF_QUEUE_NOTIFY = 0x50,
  77         OFF_INTERRUPT_STATUS = 0x60,
  78         OFF_INTERRUPT_ACK = 0x64,
  79         OFF_STATUS = 0x70,
  80         OFF_CONFIG = 0x100,
  81     };
  82
  83     /** @} */
  84
  85     enum {
  86         INT_USED_RING = 1 << 0,
  87         INT_CONFIG = 1 << 1,
  88     };
  89
  90     static const uint32_t MAGIC = 0x74726976;
  91     static const uint32_t VERSION = 1;
  92     static const uint32_t VENDOR_ID = 0x1AF4;
  93
  94
  95     uint32_t read(Addr offset);
  96     void write(Addr offset, uint32_t value);
  97
  98     void kick();
  99     void setInterrupts(uint32_t value);
 100
 101     uint32_t hostFeaturesSelect;
 102     uint32_t guestFeaturesSelect;
 103     uint32_t pageSize;
 104     uint32_t interruptStatus;
 105
 106     MakeCallback<MmioVirtIO, &MmioVirtIO::kick> callbackKick;
 107
 108   protected: // Params
 109     VirtIODeviceBase &vio;
 110     ArmInterruptPin *const interrupt;
 111 };
 112
 113 #endif // __DEV_ARM_VIO_MMIO_HH__