pluto_hdl_adi/README.md

73 lines
2.5 KiB
Markdown
Raw Normal View History

2016-03-31 16:42:52 +00:00
# HDL Reference Designs
2014-02-20 20:49:14 +00:00
2018-02-28 17:57:05 +00:00
[Analog Devices Inc.](http://www.analog.com/en/index.html) HDL libraries and projects.
2014-03-10 20:41:22 +00:00
2018-02-28 17:57:05 +00:00
## Getting started
2014-03-13 18:03:15 +00:00
This repository supports reference designs for different [Analog Devices boards](../master/projects) based on [Intel and Xilinx FPGA development boards](../master/projects/common) or standalone.
2018-02-28 17:57:05 +00:00
### Prerequisites
2014-03-13 18:02:46 +00:00
2018-02-28 17:57:05 +00:00
* [Vivado Design Suite](https://www.xilinx.com/support/download.html)
**or**
* [Quartus Prime Design Suite](https://www.altera.com/downloads/download-center.html)
Please make sure that you have the [required](https://github.com/analogdevicesinc/hdl/releases) tool version.
### How to build a project
For building a projects, you have to use the [GNU Make tool](https://www.gnu.org/software/make/). If you're a
Windows user please checkout [this page](https://wiki.analog.com/resources/fpga/docs/build#windows_environment_setup), to see how you can install this tool.
2018-02-28 17:57:05 +00:00
To build a project, checkout the [latest release](https://github.com/analogdevicesinc/hdl/releases), after that just **cd** to the
project that you want to build and run make:
```
[~]cd projects/fmcomms2/zc706
[~]make
```
A more comprehensive build guide can be found under the following link:
<https://wiki.analog.com/resources/fpga/docs/build>
## Software
2018-02-28 17:57:05 +00:00
In general all the projects have no-OS (baremetal) and a Linux support. See [no-OS](https://github.com/analogdevicesinc/no-OS) or [Linux](https://github.com/analogdevicesinc/Linux) for
more information.
2018-02-28 17:57:05 +00:00
## Which branch should I use?
2018-02-28 17:57:05 +00:00
* If you want to use the most stable code base, always use the [latest release branch](https://github.com/analogdevicesinc/hdl/releases).
2018-02-28 17:57:05 +00:00
* If you want to use the greatest and latest, check out the master branch.
2018-02-28 17:57:05 +00:00
## License
In this HDL repository, there are many different and unique modules, consisting
of various HDL (Verilog or VHDL) components. The individual modules are
developed independently, and may be accompanied by separate and unique license
terms.
The user should read each of these license terms, and understand the
freedoms and responsibilities that he or she has by using this source/core.
See [LICENSE](../master/LICENSE) for more details. The separate license files
cab be found here:
* [LICENSE_ADIBSD](../master/LICENSE_ADIBSD)
* [LICENSE_GPL2](../master/LICENSE_GPL2)
* [LICENSE_LGPL](../master/LICENSE_LGPL)
## Comprehensive user guide
See [HDL User Guide](https://wiki.analog.com/resources/fpga/docs/hdl) for a more detailed guide.
2018-02-28 17:57:05 +00:00
## Support
Feel free to ask any question at [EngineerZone](https://ez.analog.com/community/fpga).