search

verilog-to-routing / vtr-verilog-to-routing

Verilog to Routing -- Open Source CAD Flow for FPGA Research
https://verilogtorouting.org
Other
981 stars 378 forks source link

Add some overview to the RRGraphView doxygen documentation #2361

Open vaughnbetz opened 11 months ago

vaughnbetz commented 11 months ago

Proposed Behaviour

We should give a high level overview of the RRGraphView data structure / API in our doxygen documentation.

Current Behaviour

Currently we dive right into methods.

Possible Solution

Explain the RRGraph describes the programmable routing fabric of the FPGA (all wires and switches). RRGraphView provides a read-only interface, which tools like the router, graphics, and statistics need. Should also explain that the fundamental data structures is a graph (nodes and out-going edges) with extra information like the location within the chip and electrical parameters added to help make algorithms more efficient, draw the chip, and estimate delays.

vaughnbetz commented 3 weeks ago

Re assigning to @tangxifan . This might be a duplicate though!

vaughnbetz commented 3 weeks ago

Is a duplicate of the remaining work in https://github.com/verilog-to-routing/vtr-verilog-to-routing/issues/1834 . We can close both together.

tangxifan commented 3 weeks ago

@vaughnbetz Indeed. We may close this one and keep #1834 open. My team will follow up. A PR will happen this summer.