Directory Organization

<body topmargin=0 leftmargin=0 marginheight=0 marginwidth=0> <table cellpadding=0 cellspacing=0 border=0><tr> <td valign="top" colspan=2 height=90 BGCOLOR="#CC9900" TEXT="#080000" bgproperties="fixed" background="045005a0dwnjzk.gif"> <div> <A HREF="index.htm" TARGET="_top" TITLE="HDLmaker"><U><B>home</B></U></A><B>     | </B><B> </B><B> </B><B>  </B><FONT SIZE="5" COLOR="#FFCC66" FACE="Arial" ><B>HDLmaker</B></FONT></div> <div> <A HREF="id22.htm" TARGET="_top" TITLE="Top Files"><U><B>Top Files</B></U></A><B>   |   </B><A HREF="id23.htm" TARGET="_top" TITLE="Pin Files"><U><B>Pin Files</B></U></A><B>   |   </B><A HREF="id24.htm" TARGET="_top" TITLE="Language"><U><B>Language</B></U></A><B>   |   </B><B>Directory Organization</B><B>   |   </B><A HREF="id29.htm" TARGET="_top" TITLE="Simulation"><U><B>Simulation</B></U></A><B>   |   </B><A HREF="id30.htm" TARGET="_top" TITLE="Synthesis"><U><B>Synthesis</B></U></A><B>   |   </B><A HREF="id33.htm" TARGET="_top" TITLE="Xilinx Tools"><U><B>Xilinx Tools</B></U></A><B>   |   </B><A HREF="id25.htm" TARGET="_top" TITLE="Examples"><U><B>Examples</B></U></A></div> <div> </div> </td> </tr><tr> <td valign="top" width=210 BGCOLOR="#FFFFFF" TEXT="#080000"> <div> Directory Organization</div> <div> <B><IMG SRC="05a69830.gif" border=0 width="105" height="131" ALIGN="BOTTOM" HSPACE="0" VSPACE="0"></B><A HREF="http://www.polybus.com" TARGET="_top" TITLE="http://www.polybus.com"><U><B>Polybus</B></U></A></div> <bR> <div> <A HREF="id28_m.htm#hdlmaker_project_subdirectories" TARGET="TRLX_Middle" TITLE="Directory Organization"><U><B>HDLmaker Subdirectories</B></U></A></div> <div> <A HREF="id28_m.htm#hdlmaker_search_path" TARGET="TRLX_Middle" TITLE="Directory Organization"><U><B>Search Path</B></U></A></div> <div> <A HREF="id28_m.htm#_update" TARGET="TRLX_Middle" TITLE="Directory Organization"><U><B>-update</B></U></A></div> <div> <A HREF="id28_m.htm#_library" TARGET="TRLX_Middle" TITLE="Directory Organization"><U><B>-library</B></U></A></div> <bR> <div> <A HREF="id28_m.htm#polybus_lib_file_format" TARGET="TRLX_Middle" TITLE="Directory Organization"><U><B>Polybus.lib File</B></U></A></div> </td> <td valign="top" height=390 BGCOLOR="#FFFFFF" TEXT="#080000"> <div> The HDLmaker project directory is organized as a set of subdirectories,</div> <bR> <div> <B> <A NAME="hdlmaker_project_subdirectories"><IMG BORDER="0" SRC="1x1.gif" HEIGHT="1" ALIGN="bottom" WIDTH="1" HSPACE="0" VSPACE="0" ></A></B><B>Hdlmaker Project Subdirectories</B></div> <div> <B> <TABLE BORDER="2" CELLPADDING="2" CELLSPACING="1" WIDTH="529" BORDERCOLORLIGHT="#C0C0C0" BORDERCOLORDARK="#808080" FRAME="BOX" RULES="ALL" ALIGN="BOTTOM" HSPACE="0" VSPACE="0" > <tR> <tD VALIGN=TOP HEIGHT= 19 WIDTH="91"><div> top</div> </tD> <tD VALIGN=TOP WIDTH="419"><div> Hdlmaker .top files</div> </tD> </tR> <tR> <tD VALIGN=TOP HEIGHT= 19 WIDTH="91"><div> pin</div> </tD> <tD VALIGN=TOP WIDTH="419"><div> .pin files</div> </tD> </tR> <tR> <tD VALIGN=TOP HEIGHT= 19 WIDTH="91"><div> v</div> </tD> <tD VALIGN=TOP WIDTH="419"><div> Verilog .v and .vh </div> </tD> </tR> <tR> <tD VALIGN=TOP HEIGHT= 19 WIDTH="91"><div> vhd</div> </tD> <tD VALIGN=TOP WIDTH="419"><div> VHDL .vhd files</div> </tD> </tR> <tR> <tD VALIGN=TOP HEIGHT= 19 WIDTH="91"><div> info</div> </tD> <tD VALIGN=TOP WIDTH="419"><div> .error, .rpt, .pinlist files</div> </tD> </tR> <tR> <tD VALIGN=TOP HEIGHT= 38 WIDTH="91"><div> scripts</div> </tD> <tD VALIGN=TOP WIDTH="419"><div> Synplify .prj files, Verilog simulation .cmd files,Component list file .flist</div> </tD> </tR> <tR> <tD VALIGN=TOP HEIGHT= 19 WIDTH="91"><div> misc</div> </tD> <tD VALIGN=TOP WIDTH="419"><div> HDLmaker intermediate files</div> </tD> </tR> <tR> <tD VALIGN=TOP HEIGHT= 38 ><NOBR><div> constraints</div> </NOBR></tD> <tD VALIGN=TOP WIDTH="419"><div> Xilinx constraint files, .ucf and .cst (obsolete). Synplify timing constraints, .sdc.</div> </tD> </tR> <tR> <tD VALIGN=TOP HEIGHT= 38 WIDTH="91"><div> conn</div> </tD> <tD VALIGN=TOP WIDTH="419"><div> HDLmaker .conn files. .conn files are an alternate means of making connections in HDLmaker.</div> </tD> </tR> <tR> <tD VALIGN=TOP HEIGHT= 19 ><NOBR><div> schematics</div> </NOBR></tD> <tD VALIGN=TOP WIDTH="419"><div> TCL and Postscript schematic files.</div> </tD> </tR> <tR> <tD VALIGN=TOP HEIGHT= 56 WIDTH="91"><div> netlist</div> </tD> <tD VALIGN=TOP WIDTH="419"><div> PCB netlist files, </div> <div> .cnet and .alg for concise netlist.</div> <div> .pnl, .ref, .tel, .pkg for PADS</div> </tD> </tR> </TABLE></B></div> <bR> <div> HDLmaker creates these subdirectories if required. For new projects HDLmaker will automatically move files found in the project directory into the approriate subdirectories.</div> <bR> <div> <B> <A NAME="hdlmaker_search_path"><IMG BORDER="0" SRC="1x1.gif" HEIGHT="1" ALIGN="bottom" WIDTH="1" HSPACE="0" VSPACE="0" ></A></B><B>HDLmaker Search Path</B></div> <div> HDLmaker searches for files in the following order:</div> <div> 1) Local subdirectory (.v, .top, .pin, .. as appropriate)</div> <div> 2) Directories specified in polybus.lib file.</div> <div> 3) HDLmaker familiy library ($HDLMAKER_LIB/virtex/* for example)</div> <div> 4) HDLmaker common library ($HDLMAKER_LIB/common/*)</div> <bR> <div> If a file is found it is copied into the project subdirectory.</div> <bR> <div> <B> <A NAME="_update"><IMG BORDER="0" SRC="1x1.gif" HEIGHT="1" ALIGN="bottom" WIDTH="1" HSPACE="0" VSPACE="0" ></A></B><B>-update</B></div> <div> HDLmaker has an -update switch that changes the search order so that the local directories are searched last. This switch is used to update the local copies of the source files from the user and HDLmaker library directories.</div> <bR> <div> hdlmaker -update foo.top</div> <bR> <div> <B> <A NAME="_library"><IMG BORDER="0" SRC="1x1.gif" HEIGHT="1" ALIGN="bottom" WIDTH="1" HSPACE="0" VSPACE="0" ></A></B><B>-library</B></div> <div> The -library switch places the specified path at the head of HDLmakers search order. For example,</div> <bR> <div> hdlmaker -libary ../my_lib foo.top</div> <bR> <div> will search for files in the directory ../my_lib first .</div> <bR> <div> The -update and -library swtiches may be used together. The -library switch is also useful for creating a clean version of a HDLmaker project. By clean I mean a project directory that contains only the files used in the design. As a project evolves it's frequently the case that a lot of obsolete files tend to accumulate in the project directory. To create a new clean version, sans the obsolete files, you would do the following:</div> <bR> <div> mkdir new_project</div> <div> cd new_project</div> <div> hdlmaker -library ../old_project project.top</div> <bR> <bR> <div> <B> <A NAME="polybus_lib_file_format"><IMG BORDER="0" SRC="1x1.gif" HEIGHT="1" ALIGN="bottom" WIDTH="1" HSPACE="0" VSPACE="0" ></A></B><B>Polybus.lib File format</B></div> <div> The polybus.lib file is an optional file that may be placed in the HDLmaker project directory. Polybus.lib specifies the search path for an arbitrary number of HDLmaker directories. In addition the polybus.lib file can be used to specify default HDLmaker variables.</div> <bR> <div> The format of polybus.lib is similar to the Cadence cds.lib file. An entry starts with a #define statement, followed by an library name, the library path and then a semicolon. Example</div> <bR> <div> #family "spartan2";</div> <div> #part_type "XC2S200";</div> <div> #package "fg256";</div> <div> #HDLMAKER_LOCAL_COPY "FALSE";</div> <div> #HDLMAKER_USE_SUB_DIRECTORY "TRUE";</div> <div> #engineer "B. Joshua Rosen";</div> <div> #company "Polybus Systems Corp";</div> <div> #define "cache_unit" "/home/bjrosen/processor/cache_unit";</div> <div> #define "sdram_unit" "/home/bjrosen/mem_system/sdram_interface";</div> <bR> <bR> <bR> <bR> </td> </tr></table></body>