====== fpga-utils Readme ======

===== Introduction =====

fpga-utils is a collection of utilities for working with FPGAs.

===== ucf-insert-io.py =====

ucf-insert-io.py is used to add bank and IO comments to UCF files.  It reads
pinout definition files from Xilinx to fill in the information based on the
LOC constraint.  

For example, UCF lines like this:

<code>
NET "clk"          LOC = "L8"  | IOSTANDARD=LVCMOS33;
NET "clk"          LOC = "L8"  | IOSTANDARD=LVCMOS33; # (GCLK)
NET "clk"          LOC = "L8"  | IOSTANDARD=LVCMOS33; # Bank = ?, IO_? (GCLK)
</code>

run through ucf-insert-io.py like so:

<code>
./ucf-insert-io.py -p s3e_ft256_pinout.csv --ioc 8 -u input.ucf -o output.ucf
</code>

will be converted to:

<code>
NET "clk"          LOC = "L8"  | IOSTANDARD=LVCMOS33; # Bank = 2, IO_L09N_2/D6/GCLK13
NET "clk"          LOC = "L8"  | IOSTANDARD=LVCMOS33; # Bank = 2, IO_L09N_2/D6/GCLK13 (GCLK)
NET "clk"          LOC = "L8"  | IOSTANDARD=LVCMOS33; # Bank = 2, IO_L09N_2/D6/GCLK13 (GCLK)
</code>

The script is not guaranteed to be perfect so the output may require cleanup,
but it saves a great deal of time looking up each pin individually.