Intel® Simics® Simulator for Intel® FPGAs: User Guide

Download PDF
ID 784383
Date 4/01/2024
Public
Document Table of Contents
Document Table of Contents x
1. About This Document 2. Intel® Simics® Simulator and Virtual Platforms 3. Intel® Simics® Simulator for Intel® FPGAs Device Portfolio 4. Installing the Intel® Simics® Simulator for Intel® FPGAs 5. Getting Started with Intel® Simics® Simulator 6. Debugging Target Software 7. Networking with the Simulated Target System 8. Intel® Simics® Scripting 9. Software Debug Examples with Intel® Simics® Simulator 10. Document Revision History for Intel® Simics® Simulator for Intel FPGAs User Guide A. Intel® Simics® Simulator Command Reference
1. About This Document x
1.1. Documentation Conventions for Examples 1.2. Terminology 1.3. List of Acronyms
2. Intel® Simics® Simulator and Virtual Platforms x
2.1. Device Model and Virtual Platforms 2.2. Intel® Simics® Simulator 2.3. Intel® Simics® Simulator Architecture
2.2. Intel® Simics® Simulator x
2.2.1. Intel® Simics® Simulator for Intel FPGAs Capabilities
4. Installing the Intel® Simics® Simulator for Intel® FPGAs x
4.1. Installing the Intel® Simics® Simulator for Intel® FPGAs on Linux* Systems 4.2. Installing the Intel® Simics® Simulator for Intel® FPGAs on Microsoft Windows* Systems 4.3. Installing Ashling* RiscFree* IDE for Intel® FPGAs 4.4. Intel® Simics® Simulator for Intel® FPGAs Support
5. Getting Started with Intel® Simics® Simulator x
5.1. Simulation Set Up 5.2. Starting the Simulation 5.3. Intel® Simics® Simulator Command-Line Interface (CLI) 5.4. Hardware Inspection 5.5. Intel® Simics® Simulator Timing
5.1. Simulation Set Up x
5.1.1. Initializing an Intel® Simics® Project and Deploying a Virtual Platform 5.1.2. Understanding Target Scripts
5.2. Starting the Simulation x
5.2.1. Starting a Simulation from a Command Prompt 5.2.2. Starting a Simulation with Ashling* RiscFree* IDE
5.3. Intel® Simics® Simulator Command-Line Interface (CLI) x
5.3.1. Version of the Intel® Simics® Simulator for Intel FPGAs Software 5.3.2. Simulation Run Control from CLI 5.3.3. Intel® Simics® Simulator Command Scope 5.3.4. Intel® Simics® Simulator CLI Variables and Operations 5.3.5. Intel® Simics® Simulator CLI Command Completion and Command History 5.3.6. Intel® Simics® Command-Line Interface Help 5.3.7. Capture of CLI Session to a File 5.3.8. Intel® Simics® Simulator File Location and Intel® Simics® Search Path
5.4. Hardware Inspection x
5.4.1. Listing Objects in the Target System 5.4.2. Processor (CPU) Inspection 5.4.3. Device Inspection 5.4.4. Memory Mapping and Memory Inspection 5.4.5. Logging
5.4.2. Processor (CPU) Inspection x
5.4.2.1. Listing Processors 5.4.2.2. Inspect Processor Registers
5.4.3. Device Inspection x
5.4.3.1. Retrieve List of Devices 5.4.3.2. Inspecting Device Registers
5.4.4. Memory Mapping and Memory Inspection x
5.4.4.1. Memory Mapping Inspection 5.4.4.2. Memory Inspection
5.4.5. Logging x
5.4.5.1. Breakpoints on CLI Log Messages
5.5. Intel® Simics® Simulator Timing x
5.5.1. CPU Frequency 5.5.2. CPU Cycles and Steps 5.5.3. Events 5.5.4. Enable Real Time
6. Debugging Target Software x
6.1. Intel® Simics® Debugger and Debug Context 6.2. Capturing Serial Console Output 6.3. Breakpoints 6.4. Debugging Target Software with Symbol Files 6.5. Debugging Target Software with Ashling* RiscFree* Debugger 6.6. Capturing CPU Instruction Execution Trace
6.3. Breakpoints x
6.3.1. Memory Breakpoints 6.3.2. Temporal Breakpoints 6.3.3. CPU Control Register Breakpoints 6.3.4. Hardware Access Breakpoints 6.3.5. CPU Register Breakpoints 6.3.6. Tracing Breakpoints 6.3.7. Text Console Activity Breakpoints
6.4. Debugging Target Software with Symbol Files x
6.4.1. Loading Symbol Files in a Simulation
6.5. Debugging Target Software with Ashling* RiscFree* Debugger x
6.5.1. Remote Debugging with RiscFree* IDE
6.5.1. Remote Debugging with RiscFree* IDE x
6.5.1.1. Remote Debugging With Intel® Simics® Simulation and RiscFree* IDE on the Same System 6.5.1.2. Remote Debugging With Intel® Simics® Simulation and RiscFree* IDE on Different Systems 6.5.1.3. Remote Access to the Target System Serial Console
7. Networking with the Simulated Target System x
7.1. Network Simulation and Service Node 7.2. Connectivity Between Host PC and Target System
7.2. Connectivity Between Host PC and Target System x
7.2.1. Port Forwarding 7.2.2. Transferring Files Between Host PC and Target System 7.2.3. Accessing Target System from Host PC Through HTTP 7.2.4. Networking Commands Reference Table
7.2.1. Port Forwarding x
7.2.1.1. Incoming Port Forwarding 7.2.1.2. Outgoing Port Forwarding
7.2.1.1. Incoming Port Forwarding x
7.2.1.1.1. Example of an SSH Connection with Incoming Port Forwarding
7.2.1.2. Outgoing Port Forwarding x
7.2.1.2.1. Example of SSH Connection With Outgoing Port Forwarding 7.2.1.2.2. Example of SSH Connection via NAPT
7.2.2. Transferring Files Between Host PC and Target System x
7.2.2.1. Transferring Files with SCP service 7.2.2.2. Transferring Files with TFTP service
7.2.2.1. Transferring Files with SCP service x
7.2.2.1.1. Transferring Files With SCP Service via Forwarding Ports 7.2.2.1.2. Transferring Files with SCP from Target System to Host PC via NAPT
7.2.2.2. Transferring Files with TFTP service x
7.2.2.2.1. TFTP Using Forwarding Port 7.2.2.2.2. TFTP via NAPT 7.2.2.2.3. TFTP Using TFTP Server in Intel® Simics® Service Node
8. Intel® Simics® Scripting x
8.1. Scripts in CLI
8.1. Scripts in CLI x
8.1.1. Variables 8.1.2. Command Return Values 8.1.3. Control Flow Commands 8.1.4. Local Variables 8.1.5. Integer Conversion 8.1.6. Accessing Configuration Parameters 8.1.7. Error Handling in Scripts 8.1.8. Script Branches
8.1.8. Script Branches x
8.1.8.1. Script Branches Commands 8.1.8.2. Variables in Script Branches 8.1.8.3. Branch Synchronization 8.1.8.4. Canceling Script Branches 8.1.8.5. Script Branches Restrictions
9. Software Debug Examples with Intel® Simics® Simulator x
9.1. Debugging Linux* User-Mode Application
9.1. Debugging Linux* User-Mode Application x
9.1.1. Debugging a Linux Application with GDB 9.1.2. Debugging a Linux Application with RiscFree* IDE
9.1.1. Debugging a Linux Application with GDB x
9.1.1.1. Debugging with GDB Debug from Host PC Using Forwarding Ports 9.1.1.2. Debugging with GDB from Host PC with Intel® Simics® Simulator GDB Server
1. About This Document
2. Intel® Simics® Simulator and Virtual Platforms
3. Intel® Simics® Simulator for Intel® FPGAs Device Portfolio
4. Installing the Intel® Simics® Simulator for Intel® FPGAs
5. Getting Started with Intel® Simics® Simulator
6. Debugging Target Software
7. Networking with the Simulated Target System
8. Intel® Simics® Scripting
9. Software Debug Examples with Intel® Simics® Simulator
10. Document Revision History for Intel® Simics® Simulator for Intel FPGAs User Guide
A. Intel® Simics® Simulator Command Reference

5.1.1. Initializing an Intel® Simics® Project and Deploying a Virtual Platform

After the Intel® Simics® simulator is installed, you must initialize an Intel® Simics® project. Initializing an Intel® Simics® project prepares a directory for use by Intel® Simics® Simulator. You can create a new directory or use an existing directory as an Intel® Simics® project directory. You must initialize an Intel® Simics® project before you can do anything else in the Intel® Simics® project directory. However, you can also initialize an Intel® Simics® Project in conjunction with deploying an Intel® Simics® virtual platform (a reference design provided for your reference). Alternatively, you can reinitialize an already available project directory by skipping the virtual platform components and related target scripts deployment. This feature is useful when you have created your own virtual platform and target script and maintained them in your own repository, so in this case, you only need to initialize the project directory and not bring up all modules and target script files that integrate the example virtual platform provided as reference.

During the project initialization, some trampoline files are created. These trampoline files correspond to executable files that are linked to files under the Intel® Simics® simulator installation directory. ./simics and ./simics-gui files are examples of trampoline files.

After initializing the Intel® Simics® project, deploy the virtual platform reference design. Deploying a virtual platform initializes the Intel® Simics® project directory as an Intel® Simics® simulator workspace and copies all the files required to enable the virtual platform to the Intel® Simics® project directory. These files can include .simics scripts, Python components, DML models, and documentation.

Important: Before you run a simulation, ensure that your project contains the target scripts.

Use the simics_intelfpga_cli command (in the <simics_installdir>/simics/bin directory) to both initialize a project and deploy a virtual platform. The following command options are typically used when you initialize a project and deploy a virtual platform:

Table 6.   Intel® Simics® Commands to Initialize a Project and Deploy a Virtual Platform
Argument Description
--help Shows the description of the command and arguments supported.
--list-platforms Lists all virtual platforms available.
--deploy Deploys a specific virtual platform initializing the current directory as an Intel® Simics® simulator workspace and copies all required files to the directory (components required by the virtual platform and the target script itself).
--reinitialize Reinitializes an existing directory. This option only initializes the current directory as an Intel® Simics® simulator workspace, but it does not copy virtual platforms and target scripts-related files to this directory. It is expected to be used when virtual platforms and target scripts-related files already exist.
--force Forces deploy if files already exist.
--pltaform-info Gives detailed information on a platform.

The typical flow of initializing a project and deploying a virtual platform is as follows:

  1. Create a project directory and change directories to it:
    mkdir <projectDir>
cd <projectDir>
  2. List the available platforms:
    <simics_installdir>/simics/bin/simics_intelfpga_cli --list-platforms
  3. Initialize the project directory and deploy a virtual platform: 
    <simics_installdir>/simics/bin/simics_intelfpga_cli --deploy <virtual_platform>

    This command creates the target script corresponding to the virtual platform selected ( <virtual_platform>.simics) in the <projectDir>/targets/<virtual_platform> directory.

    If you only want to reinitialize the project directory without the platform deployment, run the following command: 

    <installDir>/simics/bin/simics_intelfpga_cli --reinitialize
  4. Customize the virtual platform. Component that you can customize are described later.
  5. Build the virtual platform: 
    make
    Note: The Linux system must support make and gcc commands as indicated in Installing the Intel Simics Simulator for Intel FPGAs on Linux* Systems.
  6. Run the simulation with target script (.simics):
    ./simics  <projectDir>/targets/<virtual_platform>/<virtual_platform>.simics
    ./simics-gui  <projectDir>/targets/<virtual_platform>/<virtual_platform>.simics
Level Two Title