Repository files navigation

Project U-Ray is an attempt at documenting the bitstream format for theXilinx Ultrascale and Ultrascale+ partsincluding all parts from the following lines;

• Kintex Ultrascale
• Virtex Ultrascale
• Zynq UltraScale MPSoC
• Kintex UltraScale+
• Virtex UltraScale+
• Zynq UltraScale+ MPSoC

It takes a lot of the learning fromProject X-Ray andProject Trellis.

• TBD

• TBD

• TBD

• TBD

• TBD - Targetting XCKU11P?

• TBD

• TBD - Targetting XCVU13P?

• TBD

• Zynq Ultrascale+ MPSoC -ZU3EG

We have a goal of initially targeting parts supported by WebPack so that anyonecan contribute.

WebPack supports the following parts;

• Kintex UltraScale FPGA - XCKU025, XCKU035
• Kintex UltraScale+ FPGA - XCKU3P, XCKU5P

Zynq UltraScale+ MPSoC -- UltraScale+ MPSoC

• XCZU2EG, XCZU2CG, XCZU3EG, XCZU3CG, XCZU4EG, XCZU4CG, XCZU4EV, XCZU5EG,XCZU5CG, XCZU5EV, XCZU7EV, XCZU7EG, and XCZU7CG

There are a couple of guidelines when contributing to Project U-Ray which arelisted here.

All contributions should be sent asGitHub Pull requests.

All software (code, associated documentation, support files, etc) in theProject U-Ray repository are licensed under the very permissiveApache-2.0 License. A copy can be found in theLICENSE file.

All new contributions must also be released under this license.

By contributing you agree to thecode of conduct. Wefollow the open source best practice of using theContributorCovenant for our Code of Conduct.

To improve tracking of who did what, we follow the Linux Kernel's"sign your work" system.This is also called a"DCO" or "Developer's Certificate of Origin".

All commits are required to include this sign off and we use theProbot DCO App to check pull requests forthis.

The sign-off is a simple line at the end of the explanation for thepatch, which certifies that you wrote it or otherwise have the right topass it on as a open-source patch. The rules are pretty simple: if youcan certify the below:

    Developer's Certificate of Origin 1.1    By making a contribution to this project, I certify that:    (a) The contribution was created in whole or in part by me and I        have the right to submit it under the open source license        indicated in the file; or    (b) The contribution is based upon previous work that, to the best        of my knowledge, is covered under an appropriate open source        license and I have the right under that license to submit that        work with modifications, whether created in whole or in part        by me, under the same open source license (unless I am        permitted to submit under a different license), as indicated        in the file; or    (c) The contribution was provided directly to me by some other        person who certified (a), (b) or (c) and I have not modified        it.(d) I understand and agree that this project and the contribution    are public and that a record of the contribution (including all    personal information I submit with it, including my sign-off) is    maintained indefinitely and may be redistributed consistent with    this project or the open source license(s) involved.

then you just add a line saying

Signed-off-by: Random J Developer <random@developer.example.org>

using your real name (sorry, no pseudonyms or anonymous contributions.)

You can add the signoff as part of your commit statement. For example:

git commit --signoff -a -m "Fixed some errors."

Hint: If you've forgotten to add a signoff to one or more commits, you can use thefollowing command to add signoffs to all commits between you and the upstreammaster:

git rebase --signoff upstream/master

In addition to the above contribution guidelines, see the guide toupdating the Project U-Ray docs.