1/*
2 * Copyright (c) 2014 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_VIRTIO_PCI_HH__
41#define __DEV_VIRTIO_PCI_HH__
42
43#include "base/statistics.hh"
44#include "dev/virtio/base.hh"
45#include "dev/pci/device.hh"
46
47struct PciVirtIOParams;
48
49class PciVirtIO : public PciDevice
50{
51  public:
52    typedef PciVirtIOParams Params;
53    PciVirtIO(const Params *params);
54    virtual ~PciVirtIO();
55
56    Tick read(PacketPtr pkt);
57    Tick write(PacketPtr pkt);
58
59    void kick();
60
61  protected:
62    /** @{ */
63    /** Offsets into VirtIO header (BAR0 relative). */
64
65    static const Addr OFF_DEVICE_FEATURES = 0x00;
66    static const Addr OFF_GUEST_FEATURES = 0x04;
67    static const Addr OFF_QUEUE_ADDRESS = 0x08;
68    static const Addr OFF_QUEUE_SIZE = 0x0C;
69    static const Addr OFF_QUEUE_SELECT = 0x0E;
70    static const Addr OFF_QUEUE_NOTIFY = 0x10;
71    static const Addr OFF_DEVICE_STATUS = 0x12;
72    static const Addr OFF_ISR_STATUS = 0x13;
73    static const Addr OFF_VIO_DEVICE = 0x14;
74
75    /** @} */
76
77    static const Addr BAR0_SIZE_BASE = OFF_VIO_DEVICE;
78
79
80    VirtIODeviceBase::QueueID queueNotify;
81
82    bool interruptDeliveryPending;
83
84    VirtIODeviceBase &vio;
85
86    MakeCallback<PciVirtIO, &PciVirtIO::kick> callbackKick;
87};
88
89#endif // __DEV_VIRTIO_PCI_HH__
90