# Project X-Ray
[![Documentation Status](https://readthedocs.org/projects/pyxray/badge/?version=latest)](http://prjxray.readthedocs.org/) [![License](https://img.shields.io/github/license/SymbiFlow/prjxray.svg)](https://github.com/SymbiFlow/prjxray/blob/master/LICENSE) [![Build Status](https://travis-ci.org/SymbiFlow/prjxray.svg?branch=master)](https://travis-ci.com/github/SymbiFlow/prjxray) [![Tests](http://storage.googleapis.com/symbiflow-badges/prjxray/tests.svg)](http://storage.googleapis.com/symbiflow-badges/prjxray/tests.html)
[![Database Generation](http://storage.googleapis.com/symbiflow-badges/prjxray/database.svg)](http://storage.googleapis.com/symbiflow-badges/prjxray/database.html) [![Artix 7 Database](http://storage.googleapis.com/symbiflow-badges/prjxray/artix7.svg)](http://storage.googleapis.com/symbiflow-badges/prjxray/artix7.html) [![Kintex 7 Database](http://storage.googleapis.com/symbiflow-badges/prjxray/kintex7.svg)](http://storage.googleapis.com/symbiflow-badges/prjxray/kintex7.html) [![Zynq 7 Database](http://storage.googleapis.com/symbiflow-badges/prjxray/zynq7.svg)](http://storage.googleapis.com/symbiflow-badges/prjxray/zynq7.html)
Documenting the Xilinx 7-series bit-stream format.
This repository contains both tools and scripts which allow you to document the bit-stream format of Xilinx 7-series FPGAs.
- More documentation can be found published on [prjxray ReadTheDocs site](https://prjxray.readthedocs.io/en/latest/) - this includes;
[Highlevel Bitstream Architecture](https://prjxray.readthedocs.io/en/latest/architecture/overview.html)
[Overview of DB Development Process](https://prjxray.readthedocs.io/en/latest/db_dev_process/index.html)
# Quickstart Guide Instructions were originally written for Ubuntu 16.04. Please let us know if you have information on other distributions.
### Step 1: ### Install Vivado 2017.2. If you did not install to /opt/Xilinx default, then set the environment variable XRAY_VIVADO_SETTINGS to point to the settings64.sh file of the installed vivado version, ie
Do not source the settings64.sh in your shell, since this adds directories of the Vivado installation at the beginning of your PATH and LD_LIBRARY_PATH variables, which will likely interfere with or break non-Vivado applications in that shell. The Vivado wrapper utils/vivado.sh makes sure that the environment variables from XRAY_VIVADO_SETTINGS are automatically sourced in a separate shell that is then only used to run Vivado to avoid these problems.
Why 2017.2? Currently the fuzzers only work on 2017.2, see [Issue #14 on prjxray](https://github.com/SymbiFlow/prjxray/issues/14).
Is 2017.2 really required? Yes, only 2017.2 works. Until Issue #14 is solved, only 2017.2 works and will be supported.
### Step 2: ### Pull submodules:
git submodule update –init –recursive
### Step 3: ### Install CMake:
- sudo apt-get install cmake # version 3.5.0 or later required,
# for Ubuntu Trusty pkg is called cmake3
### Step 4: ### Build the C++ tools:
### Step 5: ### Choose one of the following options:
(Option 1) - Install the Python environment locally
sudo apt-get install virtualenv python3 python3-pip python3-virtualenv python3-yaml make env
(Option 2) - Install the Python environment globally
sudo apt-get install python3 python3-pip python3-yaml sudo -H pip3 install -r requirements.txt
This step is known to fail with a compiler error while building the pyjson5 library when using Arch Linux and Fedora. If this occurs, pyjson5 needs one change to build correctly:
git clone https://github.com/Kijewski/pyjson5.git cd pyjson5 sed -i ‘s/char *PyUnicode/const char *PyUnicode/’ src/_imports.pyx sudo make
This might give you an error about sphinx_autodoc_typehints but it should correctly build and install pyjson5. After this, run either option 1 or 2 again.
### Step 6: ### Always make sure to set the environment for the device you are working on before running any other commands:
### Step 7: ### (Option 1, recommended) - Download a current stable version (you can use the Python API with a pre-generated database)
(Option 2) - (Re-)create the entire database (this will take a very long time!)
cd fuzzers make -j$(nproc)
### Step 8: ### Pick a fuzzer (or write your own) and run:
cd fuzzers/010-clb-lutinit make -j$(nproc) run
### Step 9: ### Create HTML documentation:
cd htmlgen python3 htmlgen.py
# C++ Development
Tests are not built by default. Setting the PRJXRAY_BUILD_TESTING option to ON when running cmake will include them:
cmake -DPRJXRAY_BUILD_TESTING=ON .. make
The default C++ build configuration is for releases (optimizations enabled, no debug info). A build configuration for debugging (no optimizations, debug info) can be chosen via the CMAKE_BUILD_TYPE option:
cmake -DCMAKE_BUILD_TYPE=Debug .. make
The options to build tests and use a debug build configuration are independent to allow testing that optimizations do not cause bugs. The build configuration and build tests options may be combined to allow all permutations.
The documentation is done through a “black box” process were Vivado is asked to generate a large number of designs which then used to create bitstreams. The resulting bit streams are then cross correlated to discover what different bits do.
There are also “minitests” which are designs which can be viewed by a human in Vivado to better understand how to generate more useful designs.
Experiments are like “minitests” except are only useful for a short period of time. Files are committed here to allow people to see how we are trying to understand the bitstream.
When an experiment is finished with, it will be moved from this directory into the latest “prjxray-experiments-archive-XXXX” repository.
Fuzzers are the scripts which generate the large number of bitstream.
They are called “fuzzers” because they follow an approach similar to the [idea of software testing through fuzzing](https://en.wikipedia.org/wiki/Fuzzing).
### [Tools](tools) & [Libs](lib)
Tools & libs are useful tools (and libraries) for converting the resulting bitstreams into various formats.
Binaries in the tools directory are considered more mature and stable then those in the [utils](utils) directory and could be actively used in other projects.
Utils are various tools which are still highly experimental. These tools should only be used inside this repository.
### [Third Party](third_party)
Third party contains code not developed as part of Project X-Ray.
Running the all fuzzers in order will produce a database which documents the bitstream format in the [database](database) directory.
As running all these fuzzers can take significant time, [Tim ‘mithro’ Ansell <email@example.com>](https://github.com/mithro) has graciously agreed to maintain a copy of the database in the [prjxray-db](https://github.com/SymbiFlow/prjxray-db) repository.
Please direct enquires to [Tim](mailto:firstname.lastname@example.org) if there are any issues with it.
# Current Focus
Current the focus has been on the Artix-7 50T part. This structure is common between all footprints of the 15T, 35T and 50T varieties.
We have also started experimenting with the Kintex-7 parts.
The aim is to eventually document all parts in the Xilinx 7-series FPGAs but we can not do this alone, we need your help!
## Adding a new part to an existing family
We have written a [detailed guide](https://symbiflow.readthedocs.io/projects/prjxray/en/latest/db_dev_process/newpart.html) that walks through the process of adding a new part to an existing family.
## TODO List
[ ] Write a TODO list
There are a couple of guidelines when contributing to Project X-Ray which are listed here.
All contributions should be sent as [GitHub Pull requests](https://help.github.com/articles/creating-a-pull-request-from-a-fork/).
All software (code, associated documentation, support files, etc) in the Project X-Ray repository are licensed under the very permissive [ISC Licence](https://opensource.org/licenses/ISC). A copy can be found in the [LICENSE](LICENSE) file.
All new contributions must also be released under this license.
### Code of Conduct
By contributing you agree to the [code of conduct](CODE_OF_CONDUCT.md). We follow the open source best practice of using the [Contributor Covenant](https://www.contributor-covenant.org/) for our Code of Conduct.
### Sign your work
To improve tracking of who did what, we follow the Linux Kernel’s [“sign your work” system](https://github.com/wking/signed-off-by). This is also called a [“DCO” or “Developer’s Certificate of Origin”](https://developercertificate.org/).
All commits are required to include this sign off and we use the [Probot DCO App](https://github.com/probot/dco) to check pull requests for this.
The sign-off is a simple line at the end of the explanation for the patch, which certifies that you wrote it or otherwise have the right to pass it on as a open-source patch. The rules are pretty simple: if you can certify the below:
Developer’s Certificate of Origin 1.1
By making a contribution to this project, I certify that:
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
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
The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it.
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 <email@example.com>
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 the following command to add signoffs to all commits between you and the upstream master:
git rebase –signoff upstream/master
### Contributing to the docs
In addition to the above contribution guidelines, see the guide to [updating the Project X-Ray docs](UPDATING-THE-DOCS.md).