-------------------------------------------------------------------
-- Title:               A part of reuse documentation
-- Path			/romdhane/TOP/VHDL/VHDL_compass
-- Filename:            README 
-- Written by           M.S. Ben Romdhane
-------------------------------------------------------------------

-1. Parametrized design of FIR filters: you can change
    the precision of the design and the number of taps.
    different time multiplexing alternatives are also
    provided (0, 2, and 4). 
    The designs are conducted in a hierarchical manner.
    parameters can be changed manually by accessing  
    a parameter passing package (passpara.vhd), or can 
    be entered from the shell by running the shell script:
    "executem".
    look at passpara.backup for more explanation about the 
    the parameters.
    If you want to run the design manually (not using the 
    shell script) than copy passpara.backup to passpara.vhd
    and change the parameters in passpara.vhd to fit
    your design specification. 
    (ALWAYS enter the design parameters -1. i.e., if you want
    a 8-tap fir filter, enter 7).
    * for not multiplexed designs compile top_gun.vhd
    * for muxed by 2 compile top_gun2.vhd (number of taps should
      be even in this case)
    * for muxed by 4 compile top_gun4.vhd ( number of taps should
      be multiple of 4 in this case)

   Note the FIR structure is double programmable "Transpose-form".

   The result is a full ASIC design (Datapath, controller)
   with your design spec.

   Use the ASIC synthesizer of COMPASS.


   If you want to use the shell script type "executem"
   enter the parameters
   when asked to enter a file: enter top_gun  (if not muxed is desired) 
                                     top_gun2 ( if mux by 2)
                                     top_gun4 (if mux by 4)

   Good luck !

  

0. Interface to LMSGEN is a Shell script:
-----------------------------------------
			executem
			   |
		           |
		---------------------------------
		  User is asked to enter Parameters
			a. data precision
		        b. coefficient precision -- no
			c. intermediate precision -- no
			d. accumulator precision
			e. number of tabs
		---------------------------------
			   |
			   |
	------------------------------------------------------------ 
	A package : "passpara.vhd" is automatically created 
	passpara.vhd passes the parameters to the library components
	------------------------------------------------------------
                           |
			   |
	------------------------------------------------------------ 
        Several Top-gun filter generators are presented to the designer
        the designer has to choose the one that fits the specifications
        knowing the characteristics of every alternative
	------------------------------------------------------------
			   |
			   |
	------------------------------------------------------------ 
		The design tool is then invoked 
		and the design is automatically generated
	------------------------------------------------------------ 
			    |
			    |
        	  ---------------------
	         |                    |
	         |                    |
ctl_genX.vhd --->CONTROLLER           DATAPATH <----- FilterX.vhd
	         |                    |
	         |                    |
	          ---------> <--------
                            |
			    |
			NETLIST









1. Synthesis of parallel double programmable FIR filters:
---------------------------------------------------------

	      top_gun.vhd
		    |
		    |
        -------------------------------------------------	
       |                         |                       |
       |                         |                       |
       |                         |                       |
  ctl_gen.vhd                filter.vhd            passpara.vhd
				 |
				 |
                      -------------------------
	             |                         |
	             |                         |
            cell1_front_end.vhd            cell1.vhd
			


2. Synthesis of parallel Muxed by 2 double programmable FIR filters:
--------------------------------------------------------------------

	      top_gun2.vhd
		    |
		    |
        -------------------------------------------------	
       |                         |                       |
       |                         |                       |
       |                         |                       |
  ctl_gen2.vhd                filter2.vhd            passpara.vhd
				 |
				 |
                      -------------------------
	             |                         |
	             |                         |
            cell5_front_end.vhd            cell5.vhd
			

3. Synthesis of parallel Muxed by 4 double programmable FIR filters:
--------------------------------------------------------------------

	      top_gun4.vhd
		    |
		    |
        -------------------------------------------------	
       |                         |                       |
       |                         |                       |
       |                         |                       |
  ctl_gen4.vhd                filter4.vhd            passpara.vhd
				 |
				 |
                      -------------------------
	             |                         |
	             |                         |
            cell9_front_end.vhd            cell9.vhd
			











