Zena debug part 1

Author: RonanSynnottArm

content/learning-paths/automotive/zenacssdebug/_index.md

@@ -0,0 +1,51 @@
+---
+title: Debug Arm Zena CSS Reference Software Stack with Arm Development Studio
+
+description: Learn how to set up a debug environment for Arm Zena CSS Reference Software Stack
+
+minutes_to_complete: 60
+
+who_is_this_for: This topic is for software developers who wish to use Arm Development Studio to explore and debug the Arm Zena CSS Reference Software Stack
+
+learning_objectives: 
+    - Set up debug configuration for the Arm Zena CSS FVP
+    - Debug System Control Processor (SCP) from boot time
+    - Debug Safety Island (SI) processor
+    - Debug Linux OS on Applications Processor
+    - Debug Linux application
+
+prerequisites:
+    - Ubuntu 22.04 host machine
+    - Arm Development Studio 2024.1 (or later) and an appropriate license
+    - A basic understanding of the Arm Zena CSS software stack
+
+author: Ronan Synnott
+
+### Tags
+skilllevels: Introductory
+subjects: 
+armips:
+    - Arm Zena CSS
+operatingsystems:
+    - Linux
+tools_software_languages:
+    - Arm Development Studio
+
+
+further_reading:
+    - resource:
+        title: Arm Zena Compute System (CSS)
+        link: https://developer.arm.com/Compute%20Subsystems/Arm%20Zena%20Compute%20Subsystem
+        type: website
+    - resource:
+        title: Arm Development Studio
+        link: https://developer.arm.com/Tools%20and%20Software/Arm%20Development%20Studio
+        type: website
+
+
+### FIXED, DO NOT MODIFY
+# ================================================================================
+weight: 1                       # _index.md always has weight of 1 to order correctly
+layout: "learningpathall"       # All files under learning paths have this same wrapper
+learning_path_main_page: "yes"  # This should be surfaced when looking for related content. Only set for _index.md of learning path content.
+---

content/learning-paths/automotive/zenacssdebug/_next-steps.md

@@ -0,0 +1,8 @@
+---
+# ================================================================================
+#       FIXED, DO NOT MODIFY THIS FILE
+# ================================================================================
+weight: 21                  # Set to always be larger than the content in this path to be at the end of the navigation.
+title: "Next Steps"         # Always the same, html page title.
+layout: "learningpathall"   # All files under learning paths have this same wrapper for Hugo processing.
+---

content/learning-paths/automotive/zenacssdebug/config.md

@@ -0,0 +1,53 @@
+---
+# User change
+title: "Model Configuration"
+
+weight: 4 # 1 is first, 2 is second, etc.
+
+# Do not modify these elements
+layout: "learningpathall"
+---
+
+# Debug Configuration
+
+Arm Development Studio requires a `Debug Configuration` of the target that it will connect to.
+
+As of 2025.0, there is no such configuration provided 'out-of-the-box' for the Zena CSS FVP. However creating such a configuration is straight forward.
+
+See the Arm Development Studio [Getting Started Guide](https://developer.arm.com/documentation/101469/latest/Migrating-from-DS-5-to-Arm-Development-Studio/Connect-to-new-or-custom-models) for full instructions, but summarized below.
+
+## Launch FVP
+
+As per previous section, launch FVP with the Iris server enabled:
+
+```command
+kas shell -c "../layers/meta-arm/scripts/runfvp -t tmux --verbose -- --iris-server --iris-port 7100"
+```
+
+## Configuration Database
+
+Debug Configurations are stored in a configuration database. You must first create a local database in which to store the configuration.
+
+Navigate to `File` > `New` > `Other`, and then select `Configuration Database` > `Configuration Database` from the drop-down list.
+
+![New Configuration Database](configdb.png)
+
+Click `Next`. Give the Database a meaningful name, and click `Finish`.
+
+## Debug Configuration
+
+Navigate to the same wizard as above, and select `Model Configuration`.
+
+Click `Next`, and you will be prompted to select the above `Configuration Database`. Click `Next` again, and you will be prompted to select a Model Interface.
+
+Select `Iris` from the pulldown, and click `Next`.
+
+You will then be prompted to locate the model to connect to.
+
+Select `Browse for model running on local host`. The FVP will be detected and interrogated by the debugger.
+
+A `model.mdf` file will be created that identifies all CPUs within the FVP.
+
+You can change the `Manufacturer Name` and `Platform Name` to something more meaningful (such as `Arm` and `Zena_CSS_FVP`), then `Save`, and `Import` into the configuration database.
+
+The debugger is now aware of the FVP and you are ready to debug.

content/learning-paths/automotive/zenacssdebug/configdb.png

@@ -0,0 +1,67 @@
+---
+# User change
+title: "Debug Connections"
+
+weight: 5 # 1 is first, 2 is second, etc.
+
+# Do not modify these elements
+layout: "learningpathall"
+---
+
+You are now ready to create debug connections for each of the sub-systems within Zena CSS. This section will create the connections, which will be subsequently enhanced in the following section. You may prefer to fully set up one such connection before moving to others.
+
+Development Studio has full support for Heterogeneous systems such as Zena CSS, and so you can connect to all processors simultaneously.
+
+### Debug connection project
+
+It may be sensible to create a project to store these connections (`.launch` files) in.
+
+Select `File` > `New...` > `Project` > `General` > `Project`, and give it a meaningful name (`Connections`).
+
+## RSE (Cortex-M55)
+
+Runtime Security Engine (RSE) is based on [Cortex-M55](https://developer.arm.com/Processors/Cortex-M55) core and is a security subsystem fulfilling the role of Root of Trust.
+
+Select `File` > `New` > `Model Connection`.
+
+{{% notice Note %}}
+You can also use `File` > `New` > `Other` > `Arm Debugger` > `Model Connection`, or
+
+`Create a debug connection...` shortcut in the `Debug Control` pane.
+{{% /notice %}}
+
+Specify a connection name (`RSE`), and associate with the above project. Click `Next`.
+
+Locate the FVP based on the name you gave it previously (`Zena_CSS_FVP`). The text filter can help locate easily.
+
+You will then be presented with the `Edit configuration` pane. In the `Connection` tab, scroll down to locate `Bare Metal Debug` > `Arm_Cortex-M55`.
+
+As we shall be later launching the FVP with the software stack loaded, select `Connect to an already running model`.
+
+Assuming the same host will be running both the FVP and the debugger, specify the `Connection address` as the default `127.0.0.1:7100`.
+
+{{% notice Note %}}
+`127.0.0.1` is the same as `localhost`. It is also possible to connect to a remote host by specifying appropriate address.
+
+`7100` is the default port number. You may need to change this if necessary.
+{{% /notice %}}
+
+Click `Apply` to save the connection information, and `Close`. Observe that `RSE.launch` is created inside the `Connections` project.
+
+## Safety Island (Cortex-R82AE)
+
+The Safety Island is a subsystem based on [Cortex-R82AE](https://developer.arm.com/Processors/Cortex-R82AE) core. The software running on the Safety Island is responsible for power, clock and CMN control.
+
+The procedure to create this connection is very similar to the above, other than to select `Bare Metal Debug` > `Arm_Cortex-R82AE` from the pull down.
+
+You can copy-and-paste `RSE.launch` as `SI.launch` and open to change the CPU.
+
+## Primary Compute (Cortex-A720AE)
+
+The Primary Compute consists of four processor clusters to run a rich OS such as Linux. Each processor cluster includes four [Cortex-A720AE](https://developer.arm.com/Processors/Cortex-A720AE) cores and a [DSU-120AE](https://developer.arm.com/Processors/DSU-120AE) DynamIQ Shared Unit.
+
+The application processors will be debugged in an SMP configuration with Linux Kernel awareness.
+
+As above, create `Primary.launch` connection and scroll to `Linux Kernel Debug` > `ARM_Cortex-A720AEx16 SMP Cluster 1`.
+
+This will connect to all Cortex-A720AE processors present in the FVP, though only cores 0-3 are used.

content/learning-paths/automotive/zenacssdebug/connect.md

@@ -0,0 +1,52 @@
+---
+# User change
+title: "Launch FVP"
+
+weight: 3 # 1 is first, 2 is second, etc.
+
+# Do not modify these elements
+layout: "learningpathall"
+---
+
+From the [documentation](https://arm-auto-solutions.docs.arm.com/en/v2.0/rd-aspen/user_guide/reproduce.html#run-the-fvp) the default command to launch the FVP with the software stack loaded is:
+
+```command
+kas shell -c "../layers/meta-arm/scripts/runfvp -t tmux --verbose"
+```
+
+However this does not enable the Iris debug server inside the model, and so will not be debuggable. Additional command options are necessary.
+
+We will use the following. See output of `FVP_RD_Aspen --help` for full list and explanation. Options are case-sensitive.
+
+| Option                | Alias    | Notes                                         |
+|---------------------- |--------- |---------------------------------------------- |
+| \-\-iris-server       | -I       | Start Iris Debug Server                       |
+| \-\-iris-port         |          | Specify a port number (default = `7100`)      |
+| \-\-run               | -R       | Run simulation when debug server started      |
+| \-\-iris-allow-remote | -A       | Allow remote connections (if different hosts) |
+
+## Launch FVP with additional options
+
+To launch the FVP with additional options, modify the above command by adding `--` and then the options.
+
+For example, to launch the model with the debug server and hold at the initial reset condition:
+
+```command
+kas shell -c "../layers/meta-arm/scripts/runfvp -t tmux --verbose -- --iris-server --iris-port 7100"
+```
+
+To launch the model and start running (so that it can start to boot up):
+
+```command
+kas shell -c "../layers/meta-arm/scripts/runfvp -t tmux --verbose -- --iris-server --iris-port 7100 --run"
+```
+
+To launch the model so that remote hosts can access it (not recommended if not needed), using options aliases:
+
+```command
+kas shell -c "../layers/meta-arm/scripts/runfvp -t tmux --verbose -- -I -A --iris-port 7100"
+```
+
+{{% notice Note %}}
+It is recommended to specify the port number used even if it is the default as that must match the debug connection setting (see later).
+{{% /notice %}}

content/learning-paths/automotive/zenacssdebug/launch.md

@@ -0,0 +1,73 @@
+---
+# User change
+title: "Getting started"
+
+weight: 2 # 1 is first, 2 is second, etc.
+
+# Do not modify these elements
+layout: "learningpathall"
+---
+
+# Arm Zena Compute Subsystem
+
+The Arm Zena Compute Subsystem (CSS) consists of a high-performance Arm Cortex-A720AE Application Processor (Primary Compute) system augmented with an Arm Cortex-R82AE based Safety Island (SI) and real-time domain to host additional system safety monitoring and real-time services.
+
+The system additionally includes a Runtime Security Engine (RSE) used for the secure boot of the system elements and the runtime secure services.
+
+The Arm Zena CSS software stack provides an open-source, integrated solution running on a Fixed Virtual Platform (FVP).
+
+The reference software stack and the FVP are freely available.
+
+For more information, see [Arm Zena Compute Subsystem (CSS)](https://developer.arm.com/Compute%20Subsystems/Arm%20Zena%20Compute%20Subsystem) and associated links.
+
+## Build software stack
+
+The steps to download and build the software stack are described in the [User Guide](https://arm-auto-solutions.docs.arm.com/en/v2.0/rd-aspen/user_guide/reproduce.html).
+
+The default `Arm Automotive Solutions Demo` build is used.
+
+{{% notice Note %}}
+This learning path is focused on **debugging** the software stack only.
+{{% /notice %}}
+
+## Verify correct build and execution
+
+Once the software stack has been built, you can verify that it runs successfully with the command:
+
+``` command
+kas shell -c "../layers/meta-arm/scripts/runfvp -t tmux --verbose"
+```
+
+The system will run through the boot process until a Linux prompt is available (in `terminal_ns_uart0`).
+
+Use `Ctrl+C` on the command terminal to terminate.
+
+## Install FVP (optional)
+
+The FVP is downloaded and installed as part of the build process above.
+
+The `Arm-Zena-CSS-FVP` can also be independently downloaded from the Arm Developer [website](https://developer.arm.com/Tools%20and%20Software/Fixed%20Virtual%20Platforms/Automotive%20FVPs).
+
+See also the Arm Ecosystem FVPs and Architecture Envelope Models [Install Guide](/install-guides/fm_fvp/eco_fvp/).
+
+{{% notice Note %}}
+For legacy reasons the FVP is named is `FVP_RD_Aspen`.
+{{% /notice %}}
+
+# Arm Development Studio
+
+Arm Development Studio is a software development solution with support of multicore debug for Arm CPUs. It provides the earliest support for the latest processors.
+
+The CPUs implemented within Arm Zena CSS are supported by Arm Development Studio 2024.0 and later, though 2024.1 or later is recommended for appropriate Linux OS support. At time of writing the latest version available is 2025.0, and that is the version used for screenshots etc in this learning path.
+
+For more information see [Arm Development Studio](https://developer.arm.com/Tools%20and%20Software/Arm%20Development%20Studio).
+
+Arm Development Studio is a commercial, license managed, product. For installation and set up instructions, see this [Install Guide](/install-guides/armds/).
+
+Launch the IDE. We recommend creating a new workspace folder.
+
+If prompted by the launcher (this is disabled by default) create a new folder there, else select `File` > `Switch Workspace` > `Other...`.
+
+{{% notice %}}
+To enable this prompt by default, navigate to `Window` > `Preferences` > `General` > `Startup and Shutdown` > `Workspaces`, and enable `Prompt for workspace on startup`.
+{{% /notice %}}