Melissa Jost has uploaded this change for review. (
https://gem5-review.googlesource.com/c/public/gem5/+/53033 )
Change subject: dev: Added new Lupio-BLK Device
......................................................................
dev: Added new Lupio-BLK Device
This is a virtual block device that provides a disk-like interface
for second level storage. It is implemented as a DMADevice, and
allows for the transfer of blocks from the block device to main
memory, and vice versa.
The following are the specifications regarding the LupIO-BLK:
https://gitlab.com/luplab/lupio/lupio-specs/-/blob/main/lupio-blk.md
Change-Id: Ifabc9b715fadb218e84952694d666b803e46e1f7
---
A src/dev/lupio/LupioBLK.py
A src/dev/lupio/lupio_blk.cc
A src/dev/lupio/lupio_blk.hh
M src/dev/lupio/SConscript
4 files changed, 417 insertions(+), 0 deletions(-)
diff --git a/src/dev/lupio/LupioBLK.py b/src/dev/lupio/LupioBLK.py
new file mode 100644
index 0000000..fc3479f
--- /dev/null
+++ b/src/dev/lupio/LupioBLK.py
@@ -0,0 +1,43 @@
+# 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 DmaDevice
+
+from m5.params import Param
+from m5.proxy import Parent
+
+class LupioBLK(DmaDevice):
+
+ type = 'LupioBLK'
+ cxx_class='gem5::LupioBLK'
+ cxx_header = 'dev/lupio/lupio_blk.hh'
+ pio_size = Param.Addr(0x1000, "PIO Size")
+ image = Param.DiskImage("Disk image")
+ pio_addr = Param.Addr("Device Address")
+ latency = Param.Latency('0ns', "DMA Device Latency")
+ platform = Param.Platform(Parent.any,
+ "Platform this device is part of.")
+ int_id = Param.Int("Interrupt ID for the PIC to use")
diff --git a/src/dev/lupio/SConscript b/src/dev/lupio/SConscript
index 94ede45..db50b51 100644
--- a/src/dev/lupio/SConscript
+++ b/src/dev/lupio/SConscript
@@ -26,14 +26,17 @@
Import('*')
+SimObject('LupioBLK.py')
SimObject('LupioRNG.py')
SimObject('LupioRTC.py')
SimObject('LupioTTY.py')
+DebugFlag('LupioBLK')
DebugFlag('LupioRNG')
DebugFlag('LupioRTC')
DebugFlag('LupioTTY')
+Source('lupio_blk.cc')
Source('lupio_rng.cc')
Source('lupio_rtc.cc')
Source('lupio_tty.cc')
diff --git a/src/dev/lupio/lupio_blk.cc b/src/dev/lupio/lupio_blk.cc
new file mode 100644
index 0000000..643c52c
--- /dev/null
+++ b/src/dev/lupio/lupio_blk.cc
@@ -0,0 +1,237 @@
+/*
+ * 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_blk.hh"
+
+#include "debug/LupioBLK.hh"
+#include "dev/dma_device.hh"
+#include "mem/packet_access.hh"
+#include "params/LupioBLK.hh"
+
+/* Shared fields for CTRL and STAT registers */
+#define LUPIO_BLK_TYPE 0x2
+
+/* Specific fields for CTRL */
+#define LUPIO_BLK_IRQE 0x1
+
+/* Specific fields for STAT */
+#define LUPIO_BLK_BUSY 0x1
+#define LUPIO_BLK_ERRR 0x4
+
+/* Fixed sector size of 512 bytes */
+#define SECTOR_BITS 9
+#define SECTOR_SIZE (1ULL << SECTOR_BITS)
+
+namespace gem5
+{
+
+LupioBLK::LupioBLK(const Params ¶ms) :
+ DmaDevice(params),
+ platform(params.platform),
+ dmaEvent([this]{ dmaEventDone(); }, name()),
+ pioAddr(params.pio_addr),
+ pioSize(params.pio_size),
+ image(*params.image),
+ lupioBLKIntID(params.int_id)
+{
+ static_assert(SECTOR_SIZE == SectorSize, "Sector size of disk image
must"
+ " match LupIO device\n");
+ nbBlocks = image.size();
+ gem5_assert(isPowerOf2(nbBlocks));
+ gem5_assert(ceilLog2(nbBlocks) <= 32, "Max number of blocks is
2^32\n");
+ DPRINTF(LupioBLK, "LupioBLK initalized\n");
+}
+
+void
+LupioBLK::dmaEventDone()
+{
+ int64_t _offset = lba;
+
+ if (writeOp) {
+ for (int i = 0; i < reqLen; i += SECTOR_SIZE, _offset++) {
+ image.write(&reqData[i], _offset);
+ }
+ }
+
+ delete[] reqData;
+ busy = false;
+ DPRINTF(LupioBLK, "Done with DMA event\n");
+ platform->postPciInt(lupioBLKIntID);
+}
+
+uint64_t
+LupioBLK::lupioBLKRead(const uint8_t addr)
+{
+ uint64_t r = 0;
+
+ switch (addr >> 2) {
+ case LUPIO_BLK_CONF:
+ r = SECTOR_BITS << 16 // log2(512B / block)
+ | floorLog2(nbBlocks);
+ DPRINTF(LupioBLK, "Read LUPIO_BLK_CONF: %d\n", r);
+ break;
+ case LUPIO_BLK_NBLK:
+ r = nblk;
+ DPRINTF(LupioBLK, "Read LUPIO_BLK_NBLK: %d\n", r);
+ break;
+ case LUPIO_BLK_BLKA:
+ r = lba;
+ DPRINTF(LupioBLK, "Read LUPIO_BLK_BLKA: %d\n", r);
+ break;
+ case LUPIO_BLK_MEMA:
+ r = mem;
+ DPRINTF(LupioBLK, "Read LUPIO_BLK_MEMA: %d\n", r);
+ break;
+
+ case LUPIO_BLK_STAT:
+ r = busy;
+ if (writeOp) {
+ r |= LUPIO_BLK_TYPE; // Write command
+ }
+ if (err) {
+ r |= LUPIO_BLK_ERRR; // Error
+ }
+ DPRINTF(LupioBLK, "Read LUPIO_BLK_STAT: %d\n", r);
+
+ // Acknowledge IRQ
+ platform->clearPciInt(lupioBLKIntID);
+ break;
+
+ default:
+ panic("Unexpected read to the LupioBLK device at address"
+ " %#llx!\n", addr);
+ break;
+ }
+ return r;
+}
+
+void
+LupioBLK::lupioBLKWrite(const uint8_t addr, uint64_t val64)
+{
+ uint32_t val = val64;
+
+ switch (addr >> 2) {
+ case LUPIO_BLK_NBLK:
+ nblk = val;
+ DPRINTF(LupioBLK, "Write LUPIO_BLK_NBLK: %d\n", nblk);
+ break;
+ case LUPIO_BLK_BLKA:
+ lba = val;
+ DPRINTF(LupioBLK, "Write LUPIO_BLK_BLKA: %d\n", lba);
+ break;
+ case LUPIO_BLK_MEMA:
+ mem = val;
+ DPRINTF(LupioBLK, "Write LUPIO_BLK_MEMA: %d\n", mem);
+ break;
+
+ case LUPIO_BLK_CTRL:
+ // Perform command
+ if (!busy) {
+ err = false;
+ writeOp = val & LUPIO_BLK_TYPE;
+ lupioBLKCmd();
+ } else {
+ panic("Attempting to write to LupioBLK device while
transfer"
+ " is ongoing!\n");
+ }
+ break;
+
+ default:
+ panic("Unexpected write to the LupioBLK device at address"
+ " %#llx!\n", addr);
+ break;
+ }
+}
+
+void
+LupioBLK::lupioBLKCmd(void)
+{
+ // Check parameters
+ if ((uint64_t)lba + nblk > nbBlocks) {
+ panic("Bad LBA range\n");
+ }
+
+ // Block device is busy when a transfer occurs
+ busy = true;
+
+ // Perform transfer
+ reqLen = nblk * SECTOR_SIZE;
+ reqData = new uint8_t[reqLen];
+ int64_t _offset = lba;
+
+ if (!writeOp) {
+ // Read command (block -> mem)
+ for (int i = 0; i < reqLen; i += SECTOR_SIZE, _offset++) {
+ image.read(&reqData[i], _offset);
+ }
+ dmaWrite(mem, reqLen, &dmaEvent, reqData, 0);
+ } else {
+ // Write command (mem -> block)
+ dmaRead(mem, reqLen, &dmaEvent, reqData, 0);
+ }
+}
+
+AddrRangeList
+LupioBLK::getAddrRanges() const
+{
+ AddrRangeList ranges = { RangeSize(pioAddr, pioSize) };
+ return ranges;
+}
+
+Tick
+LupioBLK::read(PacketPtr pkt)
+{
+ Addr addr = pkt->getAddr() - pioAddr;
+
+ DPRINTF(LupioBLK,
+ "Read request - addr: %#x, size: %#x\n", addr, pkt->getSize());
+
+ uint64_t read_request = lupioBLKRead(addr);
+ DPRINTF(LupioBLK, "Packet Read: %d\n", read_request);
+ pkt->setUintX(read_request, byteOrder);
+ pkt->makeResponse();
+
+ return pioDelay;
+}
+
+Tick
+LupioBLK::write(PacketPtr pkt)
+{
+ Addr daddr = pkt->getAddr() - pioAddr;
+
+ DPRINTF(LupioBLK, "Write register %#x value %#x\n", daddr,
+ pkt->getUintX(byteOrder));
+
+ lupioBLKWrite(daddr, pkt->getUintX(byteOrder));
+ DPRINTF(LupioBLK, "Packet Write Value: %d\n",
pkt->getUintX(byteOrder));
+
+ pkt->makeResponse();
+
+ return pioDelay;
+}
+} // namespace gem5
diff --git a/src/dev/lupio/lupio_blk.hh b/src/dev/lupio/lupio_blk.hh
new file mode 100644
index 0000000..c767ad1
--- /dev/null
+++ b/src/dev/lupio/lupio_blk.hh
@@ -0,0 +1,117 @@
+/*
+ * 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_BLK_HH__
+#define __DEV_LUPIO_LUPIO_BLK_HH__
+
+#include "debug/LupioBLK.hh"
+#include "dev/dma_device.hh"
+#include "dev/io_device.hh"
+#include "dev/platform.hh"
+#include "dev/storage/disk_image.hh"
+#include "params/LupioBLK.hh"
+#include "sim/system.hh"
+
+namespace gem5
+{
+
+/**
+ * LupioBLK:
+ * A virtual block device which aims to provide a disk-like interface for
+ * second-level storage. It enables the transfer of blocks from the block
+ * device to the system's main memory, and vice-versa.
+ */
+class LupioBLK : public DmaDevice
+{
+ protected:
+ const ByteOrder byteOrder = ByteOrder::little;
+ Platform *platform;
+ EventFunctionWrapper dmaEvent;
+ Addr pioAddr;
+ Tick pioDelay;
+ Addr pioSize;
+ DiskImage ℑ
+ int lupioBLKIntID;
+
+ void dmaEventDone();
+
+ // Register map
+ private:
+ enum
+ {
+ LUPIO_BLK_CONF,
+
+ LUPIO_BLK_NBLK,
+ LUPIO_BLK_BLKA,
+ LUPIO_BLK_MEMA,
+
+ LUPIO_BLK_CTRL,
+ LUPIO_BLK_STAT
+ };
+
+ int reqLen = 0;
+ uint8_t *reqData = nullptr;
+
+ uint64_t nbBlocks = 0;
+ uint32_t nblk = 0;
+ uint32_t lba = 0;
+ Addr mem = 0;
+
+ bool writeOp = false;
+ bool err = false;
+ bool busy = false;
+ /**
+ * Function to return data pertaining to blocks being transferred
+ */
+ uint64_t lupioBLKRead(const uint8_t addr);
+ /**
+ * Function to write to registers containing data pertaining to
+ * block transfers
+ */
+ void lupioBLKWrite(const uint8_t addr, uint64_t val64);
+ /**
+ * Function to initiate and direct the transfer of data by the
+ * DMA device
+ **/
+ void lupioBLKCmd(void);
+
+ public:
+ PARAMS(LupioBLK);
+ LupioBLK(const Params ¶ms);
+
+ /**
+ * Implement BasicPioDevice virtual functions
+ */
+ AddrRangeList getAddrRanges() const override;
+ Tick read(PacketPtr pkt) override;
+ Tick write(PacketPtr pkt) override;
+};
+
+} // namespace gem5
+
+#endif // __DEV_LUPIO_LUPIO_BLK_HH_
--
To view, visit https://gem5-review.googlesource.com/c/public/gem5/+/53033
To unsubscribe, or for help writing mail filters, visit
https://gem5-review.googlesource.com/settings
Gerrit-Project: public/gem5
Gerrit-Branch: develop
Gerrit-Change-Id: Ifabc9b715fadb218e84952694d666b803e46e1f7
Gerrit-Change-Number: 53033
Gerrit-PatchSet: 1
Gerrit-Owner: Melissa Jost <melissakj...@gmail.com>
Gerrit-MessageType: newchange
_______________________________________________
gem5-dev mailing list -- gem5-dev@gem5.org
To unsubscribe send an email to gem5-dev-le...@gem5.org
%(web_page_url)slistinfo%(cgiext)s/%(_internal_name)s
