en Home

源文档 / Source · 中文

Toffee user manual

This manual describes Toffee 2, migrated from XReactor. Legacy Toffee remains on master; see the migration guide.

A hardware test supplies inputs, waits for results, and checks them against the specification. Toffee expresses these operations as Python tests and helps organize repeated behavior into reusable components. Choose the section that matches your current task; each section can be read independently.

Your goal	Start here	What you will learn
Follow a first exercise	Tutorials	Test an 8-bit accumulator with assertions, drivers, automatic checking, and coverage
Complete a project task	How-to guides	Connect a DUT, assemble verification components, run regressions, or migrate a project
Look up an interface	Reference	Find APIs, defaults, CLI options, and supported behavior
Understand the design	Explanation	Understand simulation progress, resource ownership, and what coverage proves

Write your first test

Start with installation and your first PASS and FAIL. The first exercises use Python without an RTL simulator. Every lesson identifies its source file, command, and expected result, introducing concepts as the exercise needs them.

Common tasks

• Configure simulation: create a backend and release its resources.
• Drive inputs and capture outputs: reuse interface timing.
• Connect a reference model: advance it at acceptance and compare responses.
• Run regressions: select tests, use multiple workers, and diagnose collection failures.

See runnable examples for complete programs and the feature map for implementation and regression links.