Skip to content
Deploys bitfiles to Xilinx FPGAs
Ruby
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
bin
lib/xilinx
spec
.document
.gitignore
.project
.rspec
Gemfile
Gemfile.lock
LICENSE.txt
README.rdoc
Rakefile
VERSION
xilinx-provision.gemspec

README.rdoc

xilinx-provision

Automates the tasks involved in uploading a bitfile to a Xilinx FPGA board.

Disclaimer

The authors are not affiliated in any way with Xilinx, Inc. We are sharing this code so that other researches won't have to duplicate the effort.

Features

The gem automates the following tasks:

  • builds a recent version of the USB cable driver

  • writes udev rules for the USB cable driver

  • writes udev rules for uploading firmware to the cable

  • uploads a bitfile to a FPGA

Usage

After installing the ruby gem, perform a one-time setup to get the USB cable set up.

sudo xilinx-provision-setup

Then upload a bitfile to your FPGA using

xilinx-provision path/to/bitfile

Notice that the setup command requires root access, but normal operation does not.

To program FPGAs automatically, use the following Ruby code.

require 'xilinx/provision'
Xilinx::Provision.fpga 'path/to/bitfile'

For advanced usage, see the examples in the bin/ and spec/ directories.

Dependencies

Right now, the gem works in Debian-based Linux distributions. It should be easy to extend it to other Linux distributions.

I have no interest in making the gem work on Windows, but I would welcome patches that do so.

The gem assumes Xilinx ISE is installed. Any edition will work, including the WebPACK free edition. Download the software from: www.xilinx.com/support/download/index.htm

Contributing to xilinx-provision

  • Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet

  • Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it

  • Fork the project

  • Start a feature/bugfix branch

  • Commit and push until you are happy with your contribution

  • Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.

  • Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.

Copyright

Copyright © 2011 Massachusetts Institute of Technology. See LICENSE.txt for further details.

Something went wrong with that request. Please try again.