
		===================================
		HARP  |  Host ATM Research Platform
		===================================

		              HARP 2


What is this stuff?
-------------------
The Advanced Networking Group (ANG) at the Minnesota Supercomputer Center,
Inc. (MSCI), as part of its work on the MAGIC Gigabit Testbed, developed
the Host ATM Research Platform (HARP) software, which allows IP hosts to
communicate over ATM networks using standard protocols.  It is intended to
be a high-quality platform for IP/ATM research and is available free of
charge for non-commercial use.

HARP provides a way for IP hosts to connect to ATM networks.  It supports 
standard methods of communication using IP over ATM.  A host's standard IP 
software sends and receives datagrams via a HARP ATM interface.  HARP provides 
functionality similar to (and typically replaces) vendor-provided ATM device 
driver software.

In order to provide high performance, HARP was implemented as kernel software.
To minimize the run-time size of the kernel, only a small "ATM Core Services"
component is always resident in the kernel; all other kernel modules will be
loaded when the software is configured, so that they will reside in the kernel
only if their use is required.

HARP includes full source code, making it possible for researchers to
experiment with different approaches to running IP over ATM.  HARP is 
self-contained; it requires no other licenses or commercial software packages.

HARP implements support for the IETF Classical IP model for using IP over ATM 
networks, including:

   o IETF ATMARP address resolution client
   o IETF ATMARP address resolution server
   o UNI 3.0 signalling protocol
   o Fore Systems's SPANS signalling protocol



What's supported
----------------
The following are supported by the current development:

   o Hosts and Operating Systems
	- SunOS 4.1.x for SPARC (sun4c, sun4m) workstations
	- FreeBSD 2.1.5 (and higher), FreeBSD 2.2.x

   o ATM Host Interfaces
	- FORE Systems, Inc. SBA-200 and SBA-200E ATM SBus Adapters
	- FORE Systems, Inc. PCA-200E ATM PCI Adapters
	- Efficient Networks, Inc. ENI-155p ATM PCI Adapters

   o ATM Signalling Protocols
	- Permanent Virtual Channels (PVCs)
	- The ATM Forum UNI 3.0 signalling protocol
	- FORE Systems's proprietary SPANS signalling protocol

   o IETF "Classical IP and ARP over ATM" model
	- RFC 1483, "Multiprotocol Encapsulation over ATM Adaptation Layer 5"
	- RFC 1577, "Classical IP and ARP over ATM"
	- RFC 1626, "Default IP MTU for use over ATM AAL5"
	- RFC 1755, "ATM Signaling Support for IP over ATM"
	- Internet Draft draft-ietf-ipatm-classic2-02, 
		"Classical IP and ARP over ATM"

See the file doc/Tested for a list of the environments in which HARP has 
actually been tested.


What's not supported
--------------------
The following major features of the above list are not currently supported:

	o UNI ILMI support
	o UNI point-to-multipoint support
	o SPANS multicast and MPP support
	o Traffic Control/Quality of Service support
	o SPANS signalling using Efficient adapters


How to obtain the software
--------------------------
For additional information about HARP, or to download the current software 
distribution, please see:

	http://www.msci.magic.net



Getting started
---------------
To configure, compile and install this software, please see the file 
doc/Install for (hopefully) complete instructions.  Also look through the
file doc/NOTES for any information applicable to your installation.

To actually run the ATM software on a host, check out the instructions in 
the file doc/Startup.



What's included in the distribution
-----------------------------------
README			- This file

config			- Directory containing configuration scripts/data

doc			- Documentation directory

man			- Manual pages

patch			- Directory containing the patch files required for
			  each environment

src/adapters/fore	- Source code to support the FORE Systems 200-Series
			  ATM Adapter Cards

src/adapters/eni	- Source code to support the Efficient Networks ATM 
			  Adapter Cards

src/ipatm		- Source code to support IP over an ATM network

src/netatm		- Source code for the kernel-resident "core" ATM
			  services

src/sigpvc		- Source code to support a PVC-only signalling manager

src/spans		- Source code to support a SPANS and PVC signalling
			  manager

src/tools		- Source code for various testing/debugging tools

src/uni			- Source code to support an ATM Forum UNI and PVC 
			  signalling manager

src/utils		- Source code for user utility programs



Suggestions and Problem Reports
-------------------------------
While HARP is made available "as is" and is not supported, ANG is continuing
development of HARP.  We welcome suggestions for new or enhanced features, 
summaries of your experience with HARP, as well as reports of problems which
you may experience.  Feel free to contact us at harp-bugs@magic.net.

ANG is maintaining a mail list of those who wish to share their experiences
with HARP, learn of others' experiences, or receive information about future 
releases of HARP.  The HARP mailing list is at harp@magic.net.  To be added
to the list, send email to harp-request@magic.net.



Acknowledgments
---------------
This software was developed under the sponsorship of the Defense Advanced 
Research Projects Agency (DARPA) under contract numbers F19628-92-C-0072 
and F19628-95-C-0215.  



--------------------------------------------------------------------------------

			DISTRIBUTION TERMS
			==================

CITING HARP
-----------
When citing HARP in published works, please use the following citation:

Host ATM Research Platform (HARP), Minnesota Supercomputer Center, Inc.
This software was developed with the support of the Defense Advanced
Research Projects Agency (DARPA).


SUPPORT AND DISCLAIMER
----------------------
HARP (the "Software") is made available by the Minnesota Supercomputer
Center, Inc. (MSCI) "AS IS".  MSCI does not provide maintenance
improvements or support of any kind, however, comments, suggestions and
problem reports are welcome and may be addressed to MSCI by email to the
following address: harp-bugs@magic.net.

MSCI MAKES NO WARRANTIES OR REPRESENTATIONS, EXPRESS OR IMPLIED, INCLUDING,
BUT NOT LIMITED TO, IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE AND NON-INFRINGEMENT, AS TO ANY ELEMENT OF THE SOFTWARE OR
ANY SUPPORT WHICH MAY BE PROVIDED IN CONNECTION WITH THE USE OF THE SOFTWARE.
In no event shall MSCI be responsible for any damages, including, but not
limited to, direct, indirect, consequential, special or incidental damages,
arising from or relating to any use of the Software or provided support.


COPYRIGHT AND PERMITTED USE
---------------------------
Copyright (c) 1994-1997, Network Computing Services, Inc.  All rights reserved.

Persons obtaining this Software through distribution by MSCI or redistribution
as permitted in this paragraph ("Users") are permitted to use the Software for
their non-commercial research and internal use only.  For these purposes, 
non-commercial use means that no portion of the Software is incorporated in 
any program or other tangible or intangible product or service which is 
licensed or sold in any manner, or for use of which charges of any kind are 
otherwise imposed.  Copies of the Software may be made for use permitted in 
this paragraph; Users must reproduce and include this copyright notice in all 
copies of the Software made by them.  Modifications of the Software for use in
accordance with this paragraph are permitted.  The Software may be 
redistributed to others so long as the User making that redistribution has 
provided an accurate list of the email addresses of each recipient of that 
redistribution to MSCI by email addressed to: harp-bugs@magic.net.  No use, 
copying, distribution, or display of the Software is permitted except as set 
forth in this paragraph.

Portions of this Software include materials copyrighted by the Regents of
the University of California and by Sun Microsystems, Inc.  The applicable
copyright notices are reproduced in the files where the material appears.

--------------------------------------------------------------------------------

	@(#) README,v 1.3 1997/08/22 22:13:17 mks Exp

