dev: Added new Lupio-IPI device
Added the LupIO inter-processor interrupt controller
device which will allow for us to use an SMP system
with the LupIO devices.
Change-Id: Iceab7446b36fb4d9b7605f3ba28665fca509d55d
Reviewed-on: https://gem5-review.googlesource.com/c/public/gem5/+/53041
Maintainer: Bobby Bruce <bbruce@ucdavis.edu>
Tested-by: kokoro <noreply+kokoro@google.com>
Reviewed-by: Jason Lowe-Power <power.jg@gmail.com>
diff --git a/src/dev/lupio/LupioIPI.py b/src/dev/lupio/LupioIPI.py
new file mode 100644
index 0000000..f74c5c6
--- /dev/null
+++ b/src/dev/lupio/LupioIPI.py
@@ -0,0 +1,36 @@
+# Copyright (c) 2021 The Regents of the University of California
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are
+# met: redistributions of source code must retain the above copyright
+# notice, this list of conditions and the following disclaimer;
+# redistributions in binary form must reproduce the above copyright
+# notice, this list of conditions and the following disclaimer in the
+# documentation and/or other materials provided with the distribution;
+# neither the name of the copyright holders nor the names of its
+# contributors may be used to endorse or promote products derived from
+# this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+from m5.objects.Device import BasicPioDevice
+from m5.params import Param
+
+class LupioIPI(BasicPioDevice):
+ type = 'LupioIPI'
+ cxx_class='gem5::LupioIPI'
+ cxx_header = 'dev/lupio/lupio_ipi.hh'
+ pio_size = Param.Addr(0x1000, "PIO Size")
+ int_type = Param.Int("Type of interrupt")
+ num_threads = Param.Int("Number of threads")
diff --git a/src/dev/lupio/SConscript b/src/dev/lupio/SConscript
index 93600236..47087f0 100644
--- a/src/dev/lupio/SConscript
+++ b/src/dev/lupio/SConscript
@@ -27,6 +27,7 @@
Import('*')
SimObject('LupioBLK.py', tags='riscv isa')
+SimObject('LupioIPI.py', tags='riscv isa')
SimObject('LupioPIC.py', tags='riscv isa')
SimObject('LupioRNG.py', tags='riscv isa')
SimObject('LupioRTC.py', tags='riscv isa')
@@ -34,6 +35,7 @@
SimObject('LupioTTY.py', tags='riscv isa')
DebugFlag('LupioBLK')
+DebugFlag('LupioIPI')
DebugFlag('LupioPIC')
DebugFlag('LupioRNG')
DebugFlag('LupioRTC')
@@ -41,6 +43,7 @@
DebugFlag('LupioTTY')
Source('lupio_blk.cc', tags='riscv isa')
+Source('lupio_ipi.cc', tags='riscv isa')
Source('lupio_pic.cc', tags='riscv isa')
Source('lupio_rng.cc', tags='riscv isa')
Source('lupio_rtc.cc', tags='riscv isa')
diff --git a/src/dev/lupio/lupio_ipi.cc b/src/dev/lupio/lupio_ipi.cc
new file mode 100644
index 0000000..1504275
--- /dev/null
+++ b/src/dev/lupio/lupio_ipi.cc
@@ -0,0 +1,112 @@
+/*
+ * Copyright (c) 2021 The Regents of the University of California
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are
+ * met: redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer;
+ * redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the distribution;
+ * neither the name of the copyright holders nor the names of its
+ * contributors may be used to endorse or promote products derived from
+ * this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#include "dev/lupio/lupio_ipi.hh"
+
+#include "cpu/base.hh"
+#include "debug/LupioIPI.hh"
+#include "mem/packet_access.hh"
+#include "params/LupioIPI.hh"
+
+namespace gem5
+{
+
+LupioIPI::LupioIPI(const Params ¶ms) :
+ BasicPioDevice(params, params.pio_size),
+ system(params.system),
+ intType(params.int_type),
+ nThread(params.num_threads)
+{
+ word.resize(nThread, 0);
+
+ DPRINTF(LupioIPI, "LupioIPI initalized--number of CPUs: %d\n", nThread);
+}
+
+uint64_t
+LupioIPI::lupioIPIRead(uint8_t addr, int size)
+{
+ int cpu = addr >> 2;
+ uint32_t r = 0;
+ // Reading automatically lowers corresponding IRQ
+ r = word[cpu];
+
+ auto tc = system->threads[cpu];
+ tc->getCpuPtr()->clearInterrupt(tc->threadId(), intType, 0);
+ // Also reset value after reading
+ word[cpu] = 0;
+
+ return r;
+}
+
+void
+LupioIPI::lupioIPIWrite(uint8_t addr, uint64_t val64, int size)
+{
+ int cpu = addr >> 2;;
+ uint32_t val = val64;
+
+ word[cpu] = val;
+
+ // Raise IRQ
+ auto tc = system->threads[cpu];
+
+ tc->getCpuPtr()->postInterrupt(tc->threadId(), intType, 0);
+}
+
+Tick
+LupioIPI::read(PacketPtr pkt)
+{
+ Addr ipi_addr = pkt->getAddr() - pioAddr;
+
+ DPRINTF(LupioIPI,
+ "Read request - addr: %#x, size: %#x\n", ipi_addr, pkt->getSize());
+
+ uint64_t read_val = lupioIPIRead(ipi_addr, pkt->getSize());
+ DPRINTF(LupioIPI, "Packet Read: %#x\n", read_val);
+ pkt->setUintX(read_val, byteOrder);
+ pkt->makeResponse();
+
+ return pioDelay;
+}
+
+Tick
+LupioIPI::write(PacketPtr pkt)
+{
+ Addr ipi_addr = pkt->getAddr() - pioAddr;
+
+ DPRINTF(LupioIPI, "Write register %#x value %#x\n", ipi_addr,
+ pkt->getUintX(byteOrder));
+
+ lupioIPIWrite(ipi_addr, pkt->getUintX(byteOrder), pkt->getSize());
+ DPRINTF(LupioIPI, "Packet Write Value: %d\n", pkt->getUintX(byteOrder));
+
+ pkt->makeResponse();
+
+ return pioDelay;
+}
+} // namespace gem5
+
diff --git a/src/dev/lupio/lupio_ipi.hh b/src/dev/lupio/lupio_ipi.hh
new file mode 100644
index 0000000..7133ff2
--- /dev/null
+++ b/src/dev/lupio/lupio_ipi.hh
@@ -0,0 +1,93 @@
+/*
+ * Copyright (c) 2021 The Regents of the University of California
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are
+ * met: redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer;
+ * redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the distribution;
+ * neither the name of the copyright holders nor the names of its
+ * contributors may be used to endorse or promote products derived from
+ * this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#ifndef __DEV_LUPIO_LUPIO_IPI_HH__
+#define __DEV_LUPIO_LUPIO_IPI_HH__
+
+#include "arch/riscv/interrupts.hh"
+#include "dev/io_device.hh"
+#include "dev/platform.hh"
+#include "params/LupioIPI.hh"
+
+namespace gem5
+{
+
+/**
+ * LupioIPI:
+ * An inter-processor interrupt virtual device
+ */
+
+class LupioIPI : public BasicPioDevice
+{
+ private:
+ const ByteOrder byteOrder = ByteOrder::little;
+ System *system;
+ int intType;
+
+ // Register map
+ enum
+ {
+ LUPIO_IPI_WORD,
+
+ // Max offset
+ LUPIO_IPI_MAX,
+ };
+
+ uint32_t nThread;
+ /**
+ * Set of registers corresponding to each CPU for sending
+ * inter-processor interrupts
+ */
+ std::vector<uint32_t> word;
+
+ /**
+ * Function to return the value in the word register of the corresponding
+ * CPU and lower the IRQ
+ */
+ uint64_t lupioIPIRead(const uint8_t addr, int size);
+ /**
+ * Function to write to the word register of the corresponding CPU and
+ * raise the IRQ
+ */
+ void lupioIPIWrite(const uint8_t addr, uint64_t val64, int size);
+
+ public:
+ PARAMS(LupioIPI);
+ LupioIPI(const Params ¶ms);
+
+ /**
+ * Implement BasicPioDevice virtual functions
+ */
+ Tick read(PacketPtr pkt) override;
+ Tick write(PacketPtr pkt) override;
+};
+
+} // namespace gem5
+
+#endif // __DEV_LUPIO_LUPIO_IPI_HH
+
