README

MCluster Packer (MPack)
Creator : Pierre - Emmanuel Gaillardon
Copyright (c) 2014, EPFL, Integrated Systems Laboratory

This tool handles the packing of MCluster-based FPGA architectures
Brief Instructions

Install: type make to compile

Run the mapper: ./mpack input.blif output_basename [options]

The input.blif is the input netlist whose logic elements are mapped on a simple primitive library (primitives.genlib)
output_basename is the basename for all the output files generated by the tool - ex: ./out will be used to generate ./out_formatted.blif, ...

Options:
-matrix_width int : Specify the width of the MCluster [1-5]
-matrix_depth int : Specify the width of the MCluster [1-5]

-global_clock on|off : Specify if the clocks are global or not
-echo_dot on|off : Generates the dot files corresponding to the different mapped graphs


Copyright (c) 2014, The Regents of the Ecole Polytechnique Federale de Lausanne.
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright
  notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright
  notice, this list of conditions and the following disclaimer in the
  documentation and/or other materials provided with the distribution.
* Neither the name of the Ecole Polytechnique Federale de Lausanne nor the
  names of its contributors may be used to endorse or promote products
  derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.