Renode - documentation

Introduction

• Installing Renode
• Using Renode
  • Running and quitting Renode
  • Monitor (Renode CLI)
  • Basic interactive workflow
  • .resc scripts
• Running your first demo

Basic usage

• Working with machines
  • Creating machines
  • Switching between machines
  • Loading platforms
  • Accessing and manipulating peripherals
  • Loading binaries
  • Clearing the emulation
• Describing platforms
  • Defining peripherals
  • Connecting peripherals
  • Including files
• Basic execution control
  • Starting and pausing the execution
  • Executing instruction-by-instruction
  • Inspecting current location
• Using the logger
  • Logging level
  • Logging to file
  • Logging access to peripherals
• State saving and loading
• Environment
  • Creating an environment
  • Adding sensors to an environment
  • Accessing the readings of a sensor

Debugging

• Debugging with GDB
  • Connecting to GDB
  • Starting emulation

Networking

• Setting up a wired network
  • Creating a switch
  • Connecting interfaces
  • Disconnecting interfaces
  • Starting the interface
  • Controlling the traffic
• Setting up a wireless network
  • Creating a wireless medium
  • Connecting interfaces
  • Disconnecting interfaces
  • Positioning the nodes
  • Controlling the traffic
• Connecting to the host network
  • Regarding time flow
  • Opening a TAP interface
  • Connecting TAP interface switch
  • Starting the interface
• Inspecting the traffic with Wireshark
  • Logging the whole traffic
  • Observing a specific interface

Tutorials

• Microsemi Mi-V example
  • Installation
  • Starting Renode
  • Scripts
  • Loading our setup
  • Simple commands
  • Debugging and inspection
  • SoftConsole integration
• Testing Zephyr PTP support
  • Prerequisites
  • The test suite
  • Running the test
• Renode, Fomu and EtherBone bridge example
  • System architecture
  • Prerequisites
  • Loading the bitstream
  • Runnning the demo

Advanced topics

• Building Renode from source
  • Prerequisites
  • Downloading the source code
  • Building Renode
  • Creating packages
• Platform description format
  • Indentation
  • Comments
  • Basic structure
  • Depending on other files
  • Values
  • Registration info
  • Attributes
  • Inline objects
• Time framework
  • Time and performance units
  • Time sources and sinks
  • Synchronization
  • Time domain
  • Configuration and monitoring
  • CPU pausing vs. halting