1 |
7 |
danv |
# RadioHDL
|
2 |
|
|
|
3 |
|
|
The purpose of RadioHDL is to speed up HDL development by providing a uniform and automated way of using tools and building code for FPGAs. The RadioHDL user guide provides the introduction to RadioHDL and a quick start example:
|
4 |
|
|
|
5 |
|
|
* [radiohdl_user_guide.md](./doc/radiohdl_user_guide.md)
|
6 |
|
|
|
7 |
|
|
The RadioHDL package consists of a set of scripts that interpret configuration files and that setup or run tools. RadioHDL uses three kinds of configuration files to setup your source code and tools:
|
8 |
|
|
|
9 |
|
|
- ***hdl_buildset_.cfg*** configuration file per FPGA board
|
10 |
|
|
- ***hdl_tool_.cfg*** configuration file per vendor tool
|
11 |
|
|
- ***hdllib.cfg*** configuration file per HDL library
|
12 |
|
|
|
13 |
|
|
A RadioHDL configuration file contains a collection of key-value pairs. The configuration files are described in:
|
14 |
|
|
|
15 |
|
|
* [radiohdl_hdl_buildset_key_descriptions.md](./doc/radiohdl_hdl_buildset_key_descriptions.md)
|
16 |
|
|
* [radiohdl_hdl_library_key_descriptions.md](./doc/radiohdl_hdl_library_key_descriptions.md)
|
17 |
|
|
|
18 |
|
|
RadioHDL was first applied for an FPGA board called UniBoard1. The buildset description for the UniBoard1 provides a more advanced example, that shows how RadioHDL is used to develop HDL for an FPGA board using Mentor Modelsim for simulation and Intel/Altera Quartus for synthesis.
|
19 |
|
|
|
20 |
|
|
Currently these vendor tools are supported:
|
21 |
|
|
|
22 |
|
|
* [radiohdl_hdl_tool_modelsim.md](./doc/radiohdl_hdl_tool_modelsim.md)
|
23 |
|
|
* [radiohdl_hdl_tool_quartus.md](./doc/radiohdl_hdl_tool_quartus.md)
|
24 |
|
|
|
25 |
|
|
Currently these FPGA boards are supported:
|
26 |
|
|
|
27 |
|
|
* [radiohdl_hdl_buildset_uniboard1.md](./doc/doc/radiohdl_hdl_buildset_uniboard1.md)
|
28 |
|
|
|
29 |
|
|
The RadioHDL user guide describes how support for more FPGA boards and more vendor tools can be added to RadioHDL.
|
30 |
|
|
|
31 |
|
|
The concepts and working of the RadioHDL scripts are described in the RadioHDL programmer guide:
|
32 |
|
|
|
33 |
|
|
* [radiohdl_programmer_guide.md](./doc/radiohdl_programmer_guide.md)
|
34 |
|
|
|
35 |
|
|
|
36 |
|
|
If you use (part of) the RadioHDL package please attribute the use as indicated this citation NOTICE:
|
37 |
|
|
|
38 |
|
|
### [NOTICE](NOTICE.md)
|
39 |
|
|
|
40 |
|
|
The RadioHDL package is Open Source and available under the following LICENSE:
|
41 |
|
|
|
42 |
|
|
### [LICENSE](LICENSE.md)
|
43 |
|
|
|
44 |
|
|
The RadioHDL package was developed at [ASTRON] and used in several projects, but others have contributed and are welcome to contribute as well. The CREDITS lists the contributers of RadioHDL:
|
45 |
|
|
|
46 |
|
|
### [CREDITS](CREDITS.md)
|
47 |
|
|
|
48 |
|
|
|
49 |
|
|
[ASTRON]:https://www.astron.nl
|