Commit b1bc816
committed
Documentation clean up
- Add architecture documentation
- High-level design flow with ASCII diagrams
- Core components (signatures, annotations, packages, platforms, steps)
- Detailed flow from Python → RTLIL → target outputs
- Pin allocation flow diagram
- Annotation system architecture
- Package system architecture
- Configuration system
- Extension points (custom signatures, steps, packages, platforms)
- Add simulation documentation
- Basic simulation workflow
- What happens during simulation (6-stage process)
- SimPlatform internals and automatic model matching
- Port instantiation and clock/reset handling
- Generated main.cc structure
- Configuration options
- Simulation commands (build/run/check)
- RTL Debugger integration
- Event logging for automated testing
- Customizing simulation (adding models, custom drivers)
- Performance tips and troubleshooting
- Complete working example
- Created detailed documentation covering:
- How to use pin signatures (UARTSignature, GPIOSignature, etc.)
- How to create peripherals with SoftwareDriverSignature
- Organizing driver C/H files alongside Python peripherals
- Using attach_data() to load software into flash
- Complete working examples from chipflow-digital-ip
- Added comprehensive IOModelOptions documentation:
- Full reference of all available options
- Examples showing basic and advanced usage
- Details on invert, individual_oe, power_domain, clock_domain
- Trip point options (CMOS, TTL, VCORE, VREF, SCHMITT_TRIGGER)
- Buffer control and initialization options
- Add contributor documentation for pin signature architecture
- Annotation infrastructure (amaranth_annotate, submodule_metadata)
- IOSignature base classes and IOModelOptions
- Concrete pin signatures (UART, GPIO, SPI, etc.)
- simulatable_interface and SoftwareDriverSignature decorators
- Platform consumption patterns (silicon, software)
- Complete flow example from signature definition to code generation
- Guide for adding new signatures and platform backends1 parent 23110ab commit b1bc816
File tree
12 files changed
+2432
-729
lines changed- chipflow_lib/platform
- docs
- unfinished
12 files changed
+2432
-729
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
108 | 108 | | |
109 | 109 | | |
110 | 110 | | |
| 111 | + | |
111 | 112 | | |
112 | | - | |
113 | | - | |
114 | | - | |
| 113 | + | |
| 114 | + | |
| 115 | + | |
115 | 116 | | |
116 | 117 | | |
117 | 118 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
| 76 | + | |
| 77 | + | |
| 78 | + | |
| 79 | + | |
| 80 | + | |
| 81 | + | |
| 82 | + | |
| 83 | + | |
| 84 | + | |
| 85 | + | |
| 86 | + | |
| 87 | + | |
| 88 | + | |
| 89 | + | |
| 90 | + | |
| 91 | + | |
| 92 | + | |
| 93 | + | |
| 94 | + | |
| 95 | + | |
| 96 | + | |
| 97 | + | |
| 98 | + | |
| 99 | + | |
| 100 | + | |
| 101 | + | |
| 102 | + | |
| 103 | + | |
| 104 | + | |
| 105 | + | |
0 commit comments