





		Cross Reference File Generator

			User's Manual





			     Draft







		      Michael K. Nakagawa

		 Last revision: 1 February 1992

	    Copyright (c) 1992, Michael K. Nakagawa




		      Product Description



XRGEN is a program that extracts component information from P-CAD
netlist files and builds a component cross reference file (.fil file)
template.  This program is useful in designs that use the discrete
component library, or any schematic symbols that don't have packaged part
symbols of the same name (an example would be the resh.sym schematic
symbol and the rc05.prt symbol).



		      Hardware Requirements



Any hardware configuration that supports P-CAD products will run xrgen. 
Xrgen doesn't require special hardware keys or licenses to run.  



			  Running XRGEN



DOS Command Line


To run XRGEN from the DOS command line, the following objects are
required:

	* A binary netlist produced by pcnodes.

	* The xrgen.exe file.

	* The cross reference filename must not exist in the current
	  directory

	

The command line for running XRGEN reads as follows:



	xrgen <netlist filename> [<cross reference filename>]



where:

<netlist filename> is a .nlt or .xnl file produced by pcnodes or
pclink.



[<cross reference filename>] is optional.  This field names the
cross reference file to be constructed.  If this filename exists
in the current directory, XRGEN will quit without writing this
file.  If you don't supply this parameter, the default filename
will be the netlist filename with a ".fil" extension.



	       The Component Cross Reference File



The component cross reference file template (.fil file) created by XRGEN
has a comment field (used to create column heads) and cross reference
records containing five fields.  The following is an example of a cross
reference template:



% cross-reference file
%  
%   #gates       device          part name       pin/net        symbol name 
%__________________________________________________________________________
% 
        1        NPNBCE          NPNBCE.PRT                     NPNBCE.SYM
        1        RESV            RESV.PRT                       RESV.SYM
        1        RESH            RESH.PRT                       RESH.SYM
        1        CAPH            CAPH.PRT                       CAPH.SYM



XRGEN won't overwrite an existing component cross reference file.


For a schematic symbol to be included in the component cross reference
file template, the schematic symbol must contain packaging information
(pin numbers, reference designator location, and number of gates per
physical package).  XRGEN ignores symbols missing this information so
non-component items (an example might be a schematic boarder) will not
appear in the template.  The component must have a component type
(sometimes called a "SCAT Code") greater than 0.



The first field in a component cross reference record is the number of
schematic symbols represented by one physical package symbol.  This
information is entered during symbol creation.



XRGEN creates the next field (device name) by stripping the file extension
from the schematic symbol name.  This field is a place holder for a
manufacturer's part name, or a generic part name.



XRGEN creates the next field (part name) by appending the ".prt" file
extension to the device name.  This field is a place holder for the "real"
part and would most likely be edited to specify the desired package part
symbol.



The next field (pin/net) is always blank.  This field usually specifies the
power and ground connections to the part.  The format for this field is 

(<pin no>=<net name>,<pin no>=<netname>, . . .).  For example:

(7=gnd,14=+5V).



The last field is the schematic symbol field.  This is the name of the
symbol that was instanced on the schematic. 



				Log File


Messages are posted to a log file.  For DOS the name of the logfile is
xrgen.log.  



			     Error Messages



Message:	** Could not open global log file.


Cause: 	This message is issued for the PREMIER version of xrgen.  The
log file couldn't be opened.  You may not have write permissions
for the current design directory.


Action:	Check the permissions for the design directory.





Message:	<subroutine>  failed , cdfid: <number>


Cause:	A program subroutine failed.  The database specified may be
incompatible with xrgen, or the database may be corrupt.


Action:	Delete the .nlt or .xnl file, extract the netlist again, then try
running xrgen.




Message:	<subroutine>  failed


Cause: 	A program subroutine failed.  The database specified may be
incompatible with xrgen, or the database may be corrupt.


Action: 	Delete the .nlt or .xnl file, extract the netlist again, then try
running xrgen.





Message:	Setup netlist enviornment failed, file -- <filename>


Cause:	This message will follow some other message.  The netlist
<filename> may not be a compatible database, or the database
may be corrupt.


Action: 	Check the action sections for the previous error message.




Message:	component definition index overflow. . .


Cause:	The netlist may be corrupt.  


Action: 	Delete the .nlt or .xnl file, extract the netlist again, then try
running xrgen.





Message:  NLLOAD  failed , file -- <filename>


Cause:	The netlist database is incompatible or corrupt.  The filename
extension should be either ".nlt" or ".xnl".  The size of the file
should be greater than 0. 


Action:	 Assuming the netlist file is of the correct type and size, delete
the .nlt or .xnl file, extract the netlist again, then try running
xrgen.




Message:  ***  Could not open cross-reference file --  <filename>


Cause:	You may not have write permissions for the current design
directory.


Action: 	Check the permissions for the design directory.




Message:	<filename> already exists, delete or rename this file


Cause:	The file specified, or the default filename for the component
cross reference template is the name of a file that already
exists.  XRGEN will not overwrite a file.  This allows XRGEN to
be placed in a batch file without overwriting a modified
template.


Action:	Ignore this message if the existing file is correct.  If you want
to generate a new template, delete or rename the existing file
or specify a different template name.


