Go to file
Jorge Marques ef9c98f9b9 docs: Include sphinx documentation
The parameters directive allows to almost automatically generate the
parameters table.
It allows to add rich descriptions to the parameters, such as references,
while checking if they exist in the *_hw.tcl file a obtaining the types
and default values.
However, it cannot obtain parameters generated from a foreach loop yet,
making it incompatible with the axi_dmac_hw.tcl file for example.
This commit also joins the other extensions into a single adi_links
extension.

Signed-off-by: Jorge Marques <jorge.marques@analog.com>
2023-09-27 14:36:34 -03:00
.github projects/cn0501: Removed CN0501 project. 2023-09-21 09:00:57 +03:00
docs docs: Include sphinx documentation 2023-09-27 14:36:34 -03:00
library up_dac_channel: Cosmetic additions 2023-09-26 18:39:28 +03:00
projects projects/cn0501: Removed CN0501 project. 2023-09-21 09:00:57 +03:00
scripts Add copyright and license to .tcl, .ttcl files 2023-07-25 15:22:26 +03:00
.gitattributes Update .gitattributes 2016-02-12 14:27:35 +02:00
.gitignore .gitignore: Ignore CODEOWNERS and PR template 2023-08-11 11:57:20 +03:00
LICENSE LICENSE_*: Update the year and format of the copyright 2023-07-11 15:12:28 +03:00
LICENSE_ADIBSD LICENSE_ADIBSD: Add short identifier 2023-09-07 10:45:49 +03:00
LICENSE_ADIJESD204 Add LICENSE_ADIJESD204. Delete jesd204/README.md 2023-09-07 10:45:49 +03:00
LICENSE_BSD-1-Clause LICENSE_*: Update the year and format of the copyright 2023-07-11 15:12:28 +03:00
LICENSE_GPL2 license: Add top level license files 2017-05-29 09:57:39 +03:00
LICENSE_LGPL License: Update LGPL to version 2.1 2020-03-06 16:07:18 +02:00
Makefile Makefiles: Update header with the appropriate license 2021-09-16 16:50:53 +03:00
README.md README.md: Add link to boot partition files download link 2021-12-07 14:42:42 +02:00
quiet.mk Make system: Be explicit in license that cover the make/build system 2021-09-16 16:50:53 +03:00

README.md

HDL Reference Designs

Analog Devices Inc. HDL libraries and projects for various reference design and prototyping systems. This repository contains HDL code (Verilog or VHDL) and the required Tcl scripts to create and build a specific FPGA example design using Xilinx and/or Intel tool chain.

Support

The HDL is provided "AS IS", support is only provided on EngineerZone.

If you feel you can not, or do not want to ask questions on EngineerZone, you should not use or look at the HDL found in this repository. Just like you have the freedom and rights to use this software in your products (with the obligations found in individual licenses) and get support on EngineerZone, you have the freedom and rights not to use this software and get datasheet level support from traditional ADI contacts that you may have.

There is no free replacement for consulting services. If you have questions that are best handed one-on-one engagement, and are time sensitive, consider hiring a consultant. If you want to find a consultant who is familar with the HDL found in this repository - ask on EngineerZone.

Getting started

This repository supports reference designs for different Analog Devices boards based on Intel and Xilinx FPGA development boards or standalone.

Prerequisites

or

Please make sure that you have the required tool version.

How to build a project

For building a project (generate a bitstream), you have to use the GNU Make tool. If you're a Windows user please checkout this page, to see how you can install this tool.

To build a project, checkout the latest release, 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

In general all the projects have no-OS (baremetal) and a Linux support. See no-OS or Linux for more information.

Which branch should I use?

Use already built files

You can download already built files and use them as they are. They are available on this link.
The files are built from master branch whenever there are new commits in HDL or Linux repositories.

⚠️ Pay attention when using already built files, since they are not tested in HW!

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 for more details. The separate license files cab be found here:

Comprehensive user guide

See HDL User Guide for a more detailed guide.