Skip to content

Commit a1159e7

Browse files
robtaylorclaude
andcommitted
Add warning about custom model API stability
Note that the custom simulation model interface is subject to change in future releases, while built-in models remain stable. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 6aac8dc commit a1159e7

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

docs/simulation-guide.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -372,6 +372,9 @@ Adding Custom Models
372372

373373
ChipFlow's built-in simulation models cover common peripherals (UART, SPI, I2C, GPIO, QSPI Flash). For custom peripherals, you'll need to write C++ models that interact with the CXXRTL-generated design.
374374

375+
.. warning::
376+
The custom simulation model interface is subject to change. Model APIs may be updated in future ChipFlow releases. Built-in models (UART, SPI, etc.) are stable, but custom model registration and integration mechanisms may evolve.
377+
375378
**Learning Resources:**
376379

377380
1. **Study existing models**: The best way to learn is to examine ChipFlow's built-in implementations:

0 commit comments

Comments
 (0)