dev-arm, system-arm: Remove HDLcd from VExpress_GEM5_VX platforms

This is a major change in our platform configuration.
At the moment the VExpress_GEM5_V1 and VExpress_GEM5_V2 platforms
both instantiate an HDLcd device. As the presence of the device
can slow down host performances when the software stack is
aware of its presence, we have historically been providing
an entry in the hdlcd DTB node to "hide" the entry from the
DTB parser:

status = "disable";

This default entry in the hdlcd node will in fact prevent the driver
from bringing up the device. Unfortunately this is useful for
experienced users only which are aware of this knob.

In order to make things more transparent, and to avoid any confusion
(e.g. having the hdlcd present in the config.ini, but not being able to
program it in Linux) we are deprecating this solution; we are removing
the HDLcd from the aforementioned platforms.

Users not interested on simulating a display controller won't
notice the difference.
Users interested on including it, will now have to switch to a new

VExpress_GEM5_Vx_HLCD platform

which will enabled the HDLcd without any further tweaking required

JIRA: https://gem5.atlassian.net/browse/GEM5-866

Change-Id: I4b1920efe764080115a57f52d8a3df2e6e2386a0
Signed-off-by: Giacomo Travaglini <giacomo.travaglini@arm.com>
Reviewed-on: https://gem5-review.googlesource.com/c/public/gem5/+/38796
Tested-by: kokoro <noreply+kokoro@google.com>
Reviewed-by: Andreas Sandberg <andreas.sandberg@arm.com>
Maintainer: Andreas Sandberg <andreas.sandberg@arm.com>

diff --git a/src/dev/arm/RealView.py b/src/dev/arm/RealView.py
index f988452b2c4d956a72b635b5fe648ace07f49d29..c168cfdd7ff949444401c7f9d3be58bfec04390c 100644 (file)
--- a/src/dev/arm/RealView.py
+++ b/src/dev/arm/RealView.py
@@ -1,4 +1,4 @@
-# Copyright (c) 2009-2020 ARM Limited
+# Copyright (c) 2009-2021 ARM Limited
 # All rights reserved.
 #
 # The license below extends only to copyright in the software and shall
@@ -1299,11 +1299,18 @@ class VExpress_GEM5_V1_Base(VExpress_GEM5_Base):
             ]
 
 class VExpress_GEM5_V1(VExpress_GEM5_V1_Base):
+    """
+    We subclass VExpress_GEM5_V1_Base in order to alias it to
+    VExpress_GEM5_V1, which is what gem5 scripts are currently using
+    """
+    pass
+
+class VExpress_GEM5_V1_HDLcd(VExpress_GEM5_V1_Base):
     hdlcd  = HDLcd(pxl_clk=VExpress_GEM5_V1_Base.dcc.osc_pxl,
                    pio_addr=0x2b000000, interrupt=ArmSPI(num=95))
 
     def _on_chip_devices(self):
-        return super(VExpress_GEM5_V1,self)._on_chip_devices() + [
+        return super(VExpress_GEM5_V1_HDLcd,self)._on_chip_devices() + [
                 self.hdlcd,
             ]
 
@@ -1327,11 +1334,18 @@ class VExpress_GEM5_V2_Base(VExpress_GEM5_Base):
                 cur_sys, boot_loader)
 
 class VExpress_GEM5_V2(VExpress_GEM5_V2_Base):
+    """
+    We subclass VExpress_GEM5_V2_Base in order to alias it to
+    VExpress_GEM5_V2, which is what gem5 scripts are currently using
+    """
+    pass
+
+class VExpress_GEM5_V2_HDLcd(VExpress_GEM5_V2_Base):
     hdlcd  = HDLcd(pxl_clk=VExpress_GEM5_V2_Base.dcc.osc_pxl,
                    pio_addr=0x2b000000, interrupt=ArmSPI(num=95))
 
     def _on_chip_devices(self):
-        return super(VExpress_GEM5_V2,self)._on_chip_devices() + [
+        return super(VExpress_GEM5_V2_HDLcd,self)._on_chip_devices() + [
                 self.hdlcd,
             ]
 

diff --git a/system/arm/dt/Makefile b/system/arm/dt/Makefile
index fb7ac301e7a6c9091df286174d8f33850ac28e93..8332f762c73a78eac41eee5f9b43864621539bc0 100644 (file)
--- a/system/arm/dt/Makefile
+++ b/system/arm/dt/Makefile
@@ -1,4 +1,4 @@
-# Copyright (c) 2015-2016, 2019-2020 ARM Limited
+# Copyright (c) 2015-2016, 2019-2021 ARM Limited
 # All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without
@@ -36,21 +36,34 @@ CREATE_TARGET=$(foreach n, $(NUM_CPUS), $(1)_$(n)cpu.dtb)
 TARGET_PREFIX=\
        armv7_gem5_v1 \
        armv8_gem5_v1 \
-       armv8_gem5_v2
+       armv8_gem5_v2 \
+       armv7_gem5_v1_hdlcd \
+       armv8_gem5_v1_hdlcd \
+       armv8_gem5_v2_hdlcd
 
 TARGETS=\
        $(foreach prefix, $(TARGET_PREFIX), $(call CREATE_TARGET, $(prefix))) \
        armv8_gem5_v1_big_little_2_2.dtb \
        armv8_gem5_v1_big_little_2_4.dtb \
        armv8_gem5_v2_big_little_2_2.dtb \
-       armv8_gem5_v2_big_little_2_4.dtb
+       armv8_gem5_v2_big_little_2_4.dtb \
+       armv8_gem5_v1_hdlcd_big_little_2_2.dtb \
+       armv8_gem5_v1_hdlcd_big_little_2_4.dtb \
+       armv8_gem5_v2_hdlcd_big_little_2_2.dtb \
+       armv8_gem5_v2_hdlcd_big_little_2_4.dtb
 
 VEXPRESS_GEM5_V1_DTSIS=\
-       platforms/vexpress_gem5_v1.dtsi \
+       platforms/vexpress_gem5_v1_base.dtsi
+
+VEXPRESS_GEM5_V1_HDLCD_DTSIS=\
+       platforms/vexpress_gem5_v1_hdlcd.dtsi \
        platforms/vexpress_gem5_v1_base.dtsi
 
 VEXPRESS_GEM5_V2_DTSIS=\
-       platforms/vexpress_gem5_v2.dtsi \
+       platforms/vexpress_gem5_v2_base.dtsi
+
+VEXPRESS_GEM5_V2_HDLCD_DTSIS=\
+       platforms/vexpress_gem5_v2_hdlcd.dtsi \
        platforms/vexpress_gem5_v2_base.dtsi
 
 GEN_DTS=mkdir -p .gen; \
@@ -62,22 +75,45 @@ GEN_DTS=mkdir -p .gen; \
 
 all: $(TARGETS)
 
-.gen/armv7_gem5_v1_%cpu.dts: armv7.dts $(VEXPRESS_GEM5_V1_DTSIS)
-       $(call GEN_DTS,vexpress_gem5_v1.dtsi,$*)
+.gen/armv7_gem5_v1_%cpu.dts: armv7.dts \
+       $(VEXPRESS_GEM5_V1_DTSIS)
+       $(call GEN_DTS,vexpress_gem5_v1_base.dtsi,$*)
+
+.gen/armv7_gem5_v1_hdlcd_%cpu.dts: armv7.dts \
+       $(VEXPRESS_GEM5_V1_HDLCD_DTSIS)
+       $(call GEN_DTS,vexpress_gem5_v1_hdlcd.dtsi,$*)
 
-.gen/armv8_gem5_v1_%cpu.dts: armv8.dts $(VEXPRESS_GEM5_V1_DTSIS)
-       $(call GEN_DTS,vexpress_gem5_v1.dtsi,$*)
+.gen/armv8_gem5_v1_%cpu.dts: armv8.dts \
+       $(VEXPRESS_GEM5_V1_DTSIS)
+       $(call GEN_DTS,vexpress_gem5_v1_base.dtsi,$*)
+
+.gen/armv8_gem5_v1_hdlcd_%cpu.dts: armv8.dts \
+       $(VEXPRESS_GEM5_V1_HDLCD_DTSIS)
+       $(call GEN_DTS,vexpress_gem5_v1_hdlcd.dtsi,$*)
+
+.gen/armv8_gem5_v2_%cpu.dts: armv8.dts \
+       $(VEXPRESS_GEM5_V2_DTSIS)
+       $(call GEN_DTS,vexpress_gem5_v2_base.dtsi,$*)
 
-.gen/armv8_gem5_v2_%cpu.dts: armv8.dts $(VEXPRESS_GEM5_V2_DTSIS)
-       $(call GEN_DTS,vexpress_gem5_v2.dtsi,$*)
+.gen/armv8_gem5_v2_hdlcd_%cpu.dts: armv8.dts \
+       $(VEXPRESS_GEM5_V2_HDLCD_DTSIS)
+       $(call GEN_DTS,vexpress_gem5_v2_hdlcd.dtsi,$*)
 
 .gen/armv8_gem5_v1_big_little%.dts: armv8_big_little.dts \
        $(VEXPRESS_GEM5_V1_DTSIS)
-       $(call GEN_DTS,vexpress_gem5_v1.dtsi,$*)
+       $(call GEN_DTS,vexpress_gem5_v1_base.dtsi,$*)
+
+.gen/armv8_gem5_v1_hdlcd_big_little%.dts: armv8_big_little.dts \
+       $(VEXPRESS_GEM5_V1_HDLCD_DTSIS)
+       $(call GEN_DTS,vexpress_gem5_v1_hdlcd.dtsi,$*)
 
 .gen/armv8_gem5_v2_big_little%.dts: armv8_big_little.dts \
        $(VEXPRESS_GEM5_V2_DTSIS)
-       $(call GEN_DTS,vexpress_gem5_v2.dtsi,$*)
+       $(call GEN_DTS,vexpress_gem5_v2_base.dtsi,$*)
+
+.gen/armv8_gem5_v2_hdlcd_big_little%.dts: armv8_big_little.dts \
+       $(VEXPRESS_GEM5_V2_HDLCD_DTSIS)
+       $(call GEN_DTS,vexpress_gem5_v2_hdlcd.dtsi,$*)
 
 %.dtb: .gen/%.dts
        $(DTC) -I dts -O dtb -o $@ $<

diff --git a/system/arm/dt/platforms/vexpress_gem5_v1.dtsi b/system/arm/dt/platforms/vexpress_gem5_v1.dtsi
deleted file mode 100644 (file)
index efca66d..0000000
--- a/system/arm/dt/platforms/vexpress_gem5_v1.dtsi
+++ /dev/null
@@ -1,47 +0,0 @@
-/*
- * Copyright (c) 2015-2019 ARM Limited
- * 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/ "vexpress_gem5_v1_base.dtsi"
-
-/ {
-       /* The display processor needs custom configuration to setup its
-         * output ports. Disable it by default in the platform until the
-         * DT bindings have stabilize.
-        */
-       dp0: hdlcd@2b000000 {
-               compatible = "arm,hdlcd";
-               reg = <0x0 0x2b000000 0x0 0x1000>;
-               interrupts = <0 63 4>;
-               clocks = <&osc_pxl>;
-               clock-names = "pxlclk";
-
-               status = "disabled";
-       };
-};
-
-/include/ "display.dtsi"

diff --git a/system/arm/dt/platforms/vexpress_gem5_v1_hdlcd.dtsi b/system/arm/dt/platforms/vexpress_gem5_v1_hdlcd.dtsi
new file mode 100644 (file)
index 0000000..efca66d
--- /dev/null
+++ b/system/arm/dt/platforms/vexpress_gem5_v1_hdlcd.dtsi
@@ -0,0 +1,47 @@
+/*
+ * Copyright (c) 2015-2019 ARM Limited
+ * 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/ "vexpress_gem5_v1_base.dtsi"
+
+/ {
+       /* The display processor needs custom configuration to setup its
+         * output ports. Disable it by default in the platform until the
+         * DT bindings have stabilize.
+        */
+       dp0: hdlcd@2b000000 {
+               compatible = "arm,hdlcd";
+               reg = <0x0 0x2b000000 0x0 0x1000>;
+               interrupts = <0 63 4>;
+               clocks = <&osc_pxl>;
+               clock-names = "pxlclk";
+
+               status = "disabled";
+       };
+};
+
+/include/ "display.dtsi"

diff --git a/system/arm/dt/platforms/vexpress_gem5_v2.dtsi b/system/arm/dt/platforms/vexpress_gem5_v2.dtsi
deleted file mode 100644 (file)
index 6775727..0000000
--- a/system/arm/dt/platforms/vexpress_gem5_v2.dtsi
+++ /dev/null
@@ -1,46 +0,0 @@
-/*
- * Copyright (c) 2015-2019 ARM Limited
- * 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/ "vexpress_gem5_v2_base.dtsi"
-
-/ {
-       /* The display processor needs custom configuration to setup its
-        * output ports. Disable it by default in the platform until the
-        * DT bindings have stabilize.
-        */
-       dp0: hdlcd@2b000000 {
-               compatible = "arm,hdlcd";
-               reg = <0x0 0x2b000000 0x0 0x1000>;
-               interrupts = <0 63 4>;
-               clocks = <&osc_pxl>;
-               clock-names = "pxlclk";
-               status = "disabled";
-       };
-};
-
-/include/ "display.dtsi"

diff --git a/system/arm/dt/platforms/vexpress_gem5_v2_hdlcd.dtsi b/system/arm/dt/platforms/vexpress_gem5_v2_hdlcd.dtsi
new file mode 100644 (file)
index 0000000..6775727
--- /dev/null
+++ b/system/arm/dt/platforms/vexpress_gem5_v2_hdlcd.dtsi
@@ -0,0 +1,46 @@
+/*
+ * Copyright (c) 2015-2019 ARM Limited
+ * 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/ "vexpress_gem5_v2_base.dtsi"
+
+/ {
+       /* The display processor needs custom configuration to setup its
+        * output ports. Disable it by default in the platform until the
+        * DT bindings have stabilize.
+        */
+       dp0: hdlcd@2b000000 {
+               compatible = "arm,hdlcd";
+               reg = <0x0 0x2b000000 0x0 0x1000>;
+               interrupts = <0 63 4>;
+               clocks = <&osc_pxl>;
+               clock-names = "pxlclk";
+               status = "disabled";
+       };
+};
+
+/include/ "display.dtsi"