
  		    Chipmunk CAD  (Jan 1993 Revision)
		    -------- ---   --- ---- --------

This directory contains a revised public beta-test version of the
Caltech electronic CAD distribution. This distribution contains tools
for schematic capture, netlist creation, and analog and digital
simulation (log), IC mask layout, extraction, and DRC (wol), simple
chip compilation (wolcomp), MOSIS fabrication request generation
(mosis), netlist comparison (netcmp), data plotting (view) and
postscript graphics editing (until). 

Note: This tar file only contains the chipmunk log schematic
entry and digital/analog simulation program.  It also contains
the psys library source, which is needed to build all these tools.
This entire package was ported to Linux some time ago, but
unfortunately, something changed with gcc, I believe after 2.4.5,
and this entire package no longer builds.  This tar file you've
downloaded is a "quick-fix", which contains the original source,
and the binary for log, which still works.  The binary depends on
being installed in /usr/chipmunk, and it's linked to the older
X libs (XFree86-2.x).  X is obviously required, and it doesn't
seem to work in anything but 8 bits per pixel.

These tools were used exclusively for the design and test of all
the integrated circuits described in Carver Mead's book "Analog
VLSI and Neural Systems".  Until was used as the primary tool for
figure creation for the book.  The directory also contains an example
of an analog VLSI chip that was designed and fabricated with these
tools, and an example of an Actel field-programmable gate array
design that was simulated and converted to Actel format with these
tools (example).

These tools were originally written for HP 200 Series ("Chipmunk")
computers, and were later ported to Unix and the X Windows System.
Many people contributed to the design and porting of these tools; we
have made an attempt to credit authors in each package, and regret any
omisions.  Carver Mead provided the inspiration, initiative, and
financial support for many of the tools in this package; in several
cases (wol and wolcomp) he wrote the original prototypes as well. The
Systems Development Foundation, Hewlett Packard, and the Office of
Naval Research were the main sources of funding for these tools. These
tools are distributed under a license very similar to the GNU license;
the minor changes protect Caltech from liability. Each tar file
contains this license.

To use these tools, you need:

1) A unix workstation that runs X11r3, X11r4, or Openwindows
2) A color screen (some tools work with black & white screens, see below)
3) Gcc (for most platforms; see below)


This distribution has been built successfully by the maintainers,
using gcc 1.4X, on Sun Sparcstations, HP Series 300, HP/Apollo Series
400, and Apple Macintosh under AU/X. On Suns, 24-bit displays are not
presently supported. 

For these machines, gcc 1.XX is recommended at the present time.
However, in most cases the 2.XX will work well, if installing gcc 1.4X
on your machine is not possible. This distribution has been built
successfully by the maintainers, on DEC Ultrix MIPS-based machines,
using gcc 2.2.2; on these machines gcc 1.XX is NOT recommended, and
gcc 2.2.3 is NOT recommended.

This distribution has also been built successfully by the maintainers,
using the HP cc compiler with the extra-cost ANSI-option, on HP Series
700/800 machines; presently (Oct 1992) gcc 1.xx and 2.xx do not handle
varargs correctly on these machines, but this hopefully will be
supported soon, and gcc can be used on these machines as well.
However, in some versions of HP compilers (8.05 and earlier), the file
math.c causes an internal compiler bug; if your version of the
compiler has this problem, you will need to compile this file
separately with gcc, while compiling all other files with cc.
Alternatively you can get a patch tape from HP.

This distribution has been updated with suggested changes from users
who have successfully ported the chipmunk tools to the IBM RS/6000
archiecture, using the xlc compiler, but the maintainers have not
tested the distribution on this machine.

The distribution has been built successfully under Linux, using gcc
2.3.3 and the xfree1.1 Xserver. 

If your configuration is different than the ones described above, only
take the package if you feel confident in your C/Unix abilities to do
the porting required. If you do successfully port to a new
architecture or OS, send us the changes required, and we will
incorporate your port in the next release of the chipmunk tools.

The C sources contain ANSI C prototypes in a few places, and several
source files are *very* large.  These two reasons prompt us to require
the use of gcc as the system compiler for most platforms. The specific
gcc version recommendations, as well as non-gcc compiler
recommendations, for different platforms, reflect the current bugs in
gcc versions and cc's on different machines.  If you don't have gcc,
but have an ANSI-standard compiler on your system, psys and the CAD
tools may compile.

Most of the tools require the p-system emulation library, psys. To get
this library, you need to pick up psys-Y.YY.tar.Z from this directory,
where Y.YY is a version number. 

If you want log,     pick up log-X.XX.tar.Z, where X.XX is the version number. 
If you want wol,     pick up wolbeta.tar.Z. 
If you want wolcomp, pick up wolcompbeta.tar.Z. 
If you want view,    pick up viewbeta.tar.Z.
If you want until,   pick up untilbeta.tar.Z. 
If you want netcmp,  pick up netcmpbeta.tar.Z. 
If you want mosis,   pick up mosisbeta.tar.Z. 

If you want the examples of VLSI and Actel chip designs, also pick up
example.tar.Z. In addition, pick up the Makefile in this directory.

   When you get the package home, put the tar files in a good home
(ideally but not necessarily /usr/chipmunk), then uncompress and untar
psys-Y.YY.tar. The readme in /usr/chipmunk/psys/src explains how to
make the libraries. After making these libraries, return to
/usr/chipmunk and uncompress and untar one of the other tool files
(log-X.XX.tar.Z is a good choice to start with). The README in
each tool explains how to make it. Most of the tools have manuals; in
addition, the examples have handholding instructions for running the
tools.

		Changes In This New Revision
	        ------- -- ---- --- --------

This revision of the chipmunk CAD tools includes the ports to new
architectures listed above, as well as many new features and bug
fixes. Here is a list of the major changes in this revision, along
with the contributor. 

Ports
-----

DEC Mips:      Marwan Jabri (Sydney U) and Tor Sverre Lande (Oslo)
HP series 800: John Lemoncheck (Synaptics), Tobi Delbruck (Caltech)
A/UX	       Gary Stafford (Apple) and Mike Godfrey (Stanford)
IBM RS/6000    Gary Liu (Caltech)
Apollo	       MaryAnn Maher (ETH)
OpenWindows    Harry L. (JPL)
Linux          Othman Ahmad (Nanyang), Eyal Lebedinsky (Canberra), Mike Caro 
               (Ryerson), Johann Heinrichmeyer (fernuni-hagen), Bhusan
               Gupta (Caltech), Harold Levy (Caltech).
     
Additions
---------

All Tools
---------

* Newcrt and mylib window geometry and placement can now be specified
  in your .Xresources file (Jim Clark, Harvard).

* Black and white displays now supported for most tools (Tor Sverre Lande,
  Oslo)

Log
---

* A new command (logspc) for generating SPICE netlist format directly inside of
  log, and new analog transistors that work well for spice netlist
  generation (netlist generator by Harold Levy, spice transistors by
  Bhusan Gupta, Caltech). Also, new features for logspc since the alpha 
  release to selected sites.

* A new four-terminal PFET model, supported by the chipmunk maintainer, for
  floating-well transistor designs (John Lazzaro, UCB).

* new gates PWL, an arbitrary two-terminal device, and RTD, a quantum-well
  diode device (Harold Levy)

* A new display option, for workstations with small monitors. In this
  mode, the newcrt window is raised when keyboard input is necessary,
  and lowered when it is no longer needed (Gary Stafford, Apple). 

* Host for X display can be specified from the command line 
  (Gary Stafford, Apple).

* Logntk's "identify mode" and lplots "zoom mode" now work correctly 
  (Mark Smith, Sun Microsystems, Tor Sverre Lande, Oslo).

* .lfo backup files now correctly made (Lloyd Watts, Caltech).

Wol
---

* The extractor works correctly for bigger designs.
* .cfo backup files now correctly made (Lloyd Watts, Caltech) .
* The DRC error files are now correctly written (Tobi Delbruck, Caltech).
* Improvements in CPU usage; wol impacts the load average less than before.

View
----

* Measure mode now works correctly (Tom Tucker, Boeing).

* new arbitrary non-linear curve fitting package (Harold Levy, Caltech).

Until
-----

* Edit-extent mode works correctly.

* tex macros for including postscript-from-until into documents now
  work again (Tomas Rokicki, Stanford)

Mosis
-----

* new-style LAYOUT commands used, ensuring future compatability with
  the MOS Implementation Service.

			Acknowledgements
			----------------

  We hope you find these tools useful, and we thank all of our beta
test sites, in particular Tor Sverre Lande in Norway, who contributed
many bug fixes and code updates. We also thank all the contributers
for the revisions, as detailed above.  An exhaustive list of thank
you's would include many of the people who passed through Caltech CS,
EE, and CNS for the last 10 years, and many people at other
Universities and industrial sites as well; we appreciate your
contributions.  Email addresses for help with the tools are included
in each tool.

						--John Lazzaro    
						--Dave Gillespie  
				
			







