=======================================================================================
                     Vivado Flow for Placement Evaluation
=======================================================================================

For ISPD 2016 contest, we use a special version of Vivado 2015.4 to evaluate FPGA placements 
generated by participating placers. The instructions of using Vivado flow is the following:

1. Download and install Vivado 2015.4
  - Visit http://www.xilinx.com/support/download
  - Sign in using UserID/Password. Create a new account if you do not have one.
  - Download "Vivado HLx 2015.4: Full Installer For Linux Single File Download Image Including SDK (TAR/GZIP - 8.68 GB)"
  - Install Vivado on Linux machine

2. Vivado License
  - Get the hostid of your linux machine;
  - Email ispd2016contest@gmail.com with your team(placer) name, hostname and hostid (ethernet MAC address);
  - You will receive a license key within 24 hours;
  - Install license using Vivado license manager;

3. Vivado 2015.4 Patch
  - Go to https://www.github.com and create an account;
  - Send your GitHub account name to ispd2016contest@gmail.com. You will be added into GitHub collaborator list;
  - Log in Github, search for repository "ispd2016contest/vivado_patches";
  - Get ISPD_Contest_Patch_01.tar.gz
  - Install the patch following the instructions in the readme file;

4. Run Vivado to evaluate FPGA placement
  - Re-download the full designs: http://www.ispd.cc/contests/16/FPGA-example1.tar.gz and http://www.ispd.cc/contests/16/FPGA-example2.tar.gz
  - Prepare your placement file placement.pl
  - Run: $VIVADO_INSTALL_PATH/installs/lin64/Vivado/2015.4/bin/vivado -mode batch -source flow.tcl
  - In case of illegal placement, Vivado will error out with illegal placement information;
  - If the placement is legal, Vivado router starts and completes routing, or report unroutable design:
    * If routing completes successfully, the following message indicates total routed wirelength:
	  Total Routed Wirelength: xxxxx (Vertical xxxx, Horizontal xxxx)
    * In case of unroutable placement, the following message shows up:
	  CRITICAL WARNING: [Route 35-162] xxxx signals failed to route due to routing congestion. 



Please report issues about installation/licensing/evaluation-flow to ispd2016contest@gmail.com