Riescue Logo

Contents:

  • Getting Started
    • Install and Setup
      • Requirements
      • Sourcing Dependencies
        • riscv-gnu-toolchain
        • Whisper ISS
        • Spike ISS
      • Installing RiESCUE
      • Troubleshooting
      • Developing
        • Developing
    • Intro to RiESCUE, RiescueD, and RiescueC
      • What’s RiESCUE?
      • RiESCUE Directed Testing Framework - RiescueD
        • RiescueD use cases:
      • RiESCUE Compliance Testing - RiescueC
        • RiescueC Use Cases:
    • RiescueD - Getting Started
      • First RiescueD Test
        • Prerequisites
        • Running RiescueD
        • A Simple Test
        • Run RiescueD and build the test
        • Next Steps
      • Randomizing Data & Addresses
        • Adding Some Random Data and Addresses
        • Test Configuration Headers
        • Random Data Generation
        • Random Memory Initialization
        • Randomization with Seeds
      • Virtual Memory
        • Setting Up Virtual Memory
        • Test Configuration Headers
        • Random Address Generation
        • Page Mapping Configuration
        • Memory Initialization
        • Virtual Memory Test Patterns
        • Advanced Features
    • RiescueC - Getting Started
      • RiescueC Overview
        • What RiescueC Does
        • RiescueC Modes
        • Getting Started
        • Configuration
        • Two-Pass Generation
        • What You Get
        • Next Steps
      • Bringup Mode Tutorial
        • Generating a RV64I Bringup Test
        • Generating a RV64G Bringup Test
        • A closer look at the Bringup JSON file
      • Test Plan Tutorial
        • Test Plan Overview
        • Test Plan Architecture
        • Example Test Plan
        • Test Plan Structure
        • Test Execution Planning
    • CTK - Getting Started
      • CTK Tutorial
        • Basic Usage
        • Test Kit Structure
        • Advanced Usage
        • Troubleshooting
        • Bug Reporting
        • Next Steps
    • Configuration & Memory Map Basics
      • Basic Configuration
        • Required Settings
        • Memory Map Structure
        • Address Format
      • Using Configuration in Tests
      • Configuration Templates
      • Validation and Debugging
      • Advanced Configuration
  • User Guide
    • RiescueD User Guide
      • What is RiescueD?
        • Key Features
      • Getting Started
        • Basic Workflow
      • RiescueD Directives Reference
        • Test Header Directives
        • Random Data Generation
        • Random Address Generation
        • Memory Reservation
        • Page Table Generation
        • Memory Initialization
      • Example Test Structure
      • Advanced Features
        • Exception Handling with OS_SETUP_CHECK_EXCP
        • Page Map Feature
        • Environment Randomization
      • Best Practices
        • Test Organization
        • Memory Management
        • Randomization Strategy
      • Debugging Tips
        • Common Issues
        • Debug Output
      • Performance Considerations
        • Test Generation Speed
        • Simulation Performance
      • Configuration Files
        • CPU Configuration
      • Integration with Simulators
      • Further Resources
      • Need Help?
    • RiescueC User Guide
    • Generating A Vector Test Kit
      • Prerequisites
      • Quick Start
      • Complete Example
      • Vector Instruction Generation
      • Next Steps
  • Reference Documentation
    • Python API Reference
      • RiescueD
        • Command-line Interface
        • API
      • RiescueC
        • RiescueC
      • FeatMgr
        • FeatMgr
      • FeatMgrBuilder
        • FeatMgrBuilder
      • CTK
        • Command-line Interface
        • API
    • RiescueD Test File Reference
      • RiescueD Directives
        • Test Generation Directives
        • Exception Types Reference
        • Macro Reference
      • Test Headers Reference
        • Basic Test Configuration
        • Multiprocessor Configuration
        • Test Metadata
        • Extension Configuration
        • Complete Example
    • Configuration Reference
      • Configuration Schema Reference
        • Required Configuration Elements
        • Memory Map Components
        • Feature Configuration
        • Test Generation Parameters
        • Complete Configuration Example
        • Validation Rules
      • FeatMgr Command Line Interface
Riescue
  • Reference Documentation
  • View page source

Reference Documentation

Complete reference material for RiESCUE tools, organized by type of information.

Reference Sections:

  • Python API Reference
    • RiescueD
    • RiescueC
    • FeatMgr
    • FeatMgrBuilder
    • CTK
  • RiescueD Test File Reference
    • RiescueD Directives
    • Test Headers Reference
  • Configuration Reference
    • Configuration Schema Reference
    • FeatMgr Command Line Interface
Previous Next

© Copyright © 2025 Tenstorrent AI ULC.

Built with Sphinx using a theme provided by Read the Docs.