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 * Authors: Andreas Sandberg
38 */
39
40#ifndef __DEV_ARM_VIO_MMIO_HH__
41#define __DEV_ARM_VIO_MMIO_HH__
42
43#include "dev/io_device.hh"
44#include "dev/virtio/base.hh"
45
46class ArmInterruptPin;
47struct MmioVirtIOParams;
48
49class MmioVirtIO : public BasicPioDevice
50{
51  public:
52    MmioVirtIO(const MmioVirtIOParams *params);
53    virtual ~MmioVirtIO();
54
55  protected: // BasicPioDevice
56    Tick read(PacketPtr pkt) override;
57    Tick write(PacketPtr pkt) override;
58
59  protected:
60    /** @{ */
61    /** Offsets into VirtIO MMIO space. */
62
63    enum : Addr {
64        OFF_MAGIC = 0x00,
65        OFF_VERSION = 0x04,
66        OFF_DEVICE_ID = 0x08,
67        OFF_VENDOR_ID = 0x0C,
68        OFF_HOST_FEATURES = 0x10,
69        OFF_HOST_FEATURES_SELECT = 0x14,
70        OFF_GUEST_FEATURES = 0x20,
71        OFF_GUEST_FEATURES_SELECT = 0x24,
72        OFF_GUEST_PAGE_SIZE = 0x28,
73        OFF_QUEUE_SELECT = 0x30,
74        OFF_QUEUE_NUM_MAX = 0x34,
75        OFF_QUEUE_NUM = 0x38,
76        OFF_QUEUE_ALIGN = 0x3C,
77        OFF_QUEUE_PFN = 0x40,
78        OFF_QUEUE_NOTIFY = 0x50,
79        OFF_INTERRUPT_STATUS = 0x60,
80        OFF_INTERRUPT_ACK = 0x64,
81        OFF_STATUS = 0x70,
82        OFF_CONFIG = 0x100,
83    };
84
85    /** @} */
86
87    enum {
88        INT_USED_RING = 1 << 0,
89        INT_CONFIG = 1 << 1,
90    };
91
92    static const uint32_t MAGIC = 0x74726976;
93    static const uint32_t VERSION = 1;
94    static const uint32_t VENDOR_ID = 0x1AF4;
95
96
97    uint32_t read(Addr offset);
98    void write(Addr offset, uint32_t value);
99
100    void kick();
101    void setInterrupts(uint32_t value);
102
103    uint32_t hostFeaturesSelect;
104    uint32_t guestFeaturesSelect;
105    uint32_t pageSize;
106    uint32_t interruptStatus;
107
108    MakeCallback<MmioVirtIO, &MmioVirtIO::kick> callbackKick;
109
110  protected: // Params
111    VirtIODeviceBase &vio;
112    ArmInterruptPin *const interrupt;
113};
114
115#endif // __DEV_ARM_VIO_MMIO_HH__
116