freebsd/share/examples/isdn

$FreeBSD$

Note: This is a modified README from the isdn4bsd 0.83.00 ftp-distribution. 

      In December 1998, i4b was integrated into the FreeBSD sourcetree
      and so the following parts about FreeBSD may not apply completely
      anymore. 

      For information of how isdn4bsd is integrated into FreeBSD now, please
      read the file ROADMAP in this directory.

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

                                  isdn4bsd
                                  ========

                       beta Version 0.83.0 / July 1999

                                 written by:

			     Hellmuth Michaelis
                               Hallstrasse 20
                             D-25462 Rellingen

                           voice: +49 4101 473574
                            fax: +49 4101 473575
                             email: hm@kts.org

                                    -----

                          The isdn4bsd package is:

     Copyright (c) 1997, 1999 by Hellmuth Michaelis. All rights reserved. 

                      For details see the file LICENSE.

                                    -----

                   isdn4bsd would not be what it is without
                      the help and support of many people,
                           see file ACKNOWLEDGMENTS !

                                    -----

        Vote with your wallet: in case you want to buy new ISDN hardware,
          buy it from manufacturers who support the development of i4b,
         for a list of supporters have a look at file ACKNOWLEDGMENTS!

                                    -----

                       This package is postcard-ware:
                       ==============================

        The (for laywer infected places: optional) license fee for using
            isdn4bsd is sending a picture postcard of your home town.
                 My address can be found at the top of this file.


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

Contents:
---------
	1.  Disclaimer
	2.  What is isdn4bsd ?
        3.  Which BSD's are supported ?
	4.  Which ISDN cards are supported ?
	5.  Where do i find documentation for isdn4bsd ?
	6.  How do i install isdn4bsd ?
	7.  Where do i get support for isdn4bsd ?
	8.  Where do i get commercial support for isdn4bsd ?
	9.  How can i help and/or support isdn4bsd ?
	10. How do i report bugs ?
	11. Is there a mailing-list available for isdn4bsd ?
	12. Where can i get isdn4bsd ?
	13. What is the reward for reading everything in this file ?


1. Disclaimer:
--------------

  It may be illegal in your country to connect an isdn4bsd based machine 
  using a passive ISDN card to the ISDN at your site because the protocol 
  stack of isdn4bsd, which is necessary to run passive cards, has not been 
  approved by the telecommunication certification authority of your country. 
  If in doubt, please contact your local ISDN provider !


  THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  SUCH DAMAGE.


2. What is isdn4bsd ?
---------------------

Isdn4bsd (or in short i4b) is a package for interfacing a computer running
FreeBSD, NetBSD, OpenBSD or BSD/OS to the ISDN.

The only ISDN protocol currently supported is the BRI protocol specified in
I.430, Q.921 and Q.931; better known as DSS1 or Euro-ISDN.  

Isdn4bsd allows you to make IP network connections by using either IP packets
sent in raw HDLC frames on the B channel or by using built-in synchronous PPP
(or using userland ppp, this is experimental and only available in FreeBSD).

For telephony, isdn4bsd can answer incoming phone calls like an answering 
machine and now has preliminary dialout capabilities for voice and data calls.


3. Which BSD's are supported ?
------------------------------

FreeBSD:
--------
	I4b was integrated into FreeBSD in January 1999, so it is part
	of FreeBSD-current and FreeBSD 3.x.

	Usually i will commit a new i4b release as soon as possible to
	FreeBSD-current, but not to FreeBSD 3.x - this means that 
	FreeBSD 3.x now has a relatively old version of i4b in its tree
	and i recommend for FreeBSD 3.x users to upgrade via the scripts
	found in the FreeBSD directory of the i4b ftp release.

	FreeBSD 2.2.x is no longer actively supported by i4b but there is
	a good chance that this release will compile and run under 2.2.x.

	I4b version 0.8x is the last i4b release which has support for 
	FreeBSD < 3.x !

	Please take the time to read the file FreeBSD/INSTALLATION (and 
	the other available documentation) carefully. Thank you!

NetBSD/i386:
------------
	The NetBSD specific support and the Diehl driver was written by 
	Martin Husemann, (martin@rumolt.teuto.de). Since i do not intend
	to run NetBSD and/or Diehl cards, i suggest contacting him in 
	case of problems in this two areas. 

	Martin has NetBSD/i386 running and is supporting isdn4bsd for
	that platform as his time permits it.

NetBSD/Amiga:
-------------
	The NetBSD/Amiga specific support was done by Ignatios Souvatzis,
	(is@netbsd.org).

NetBSD/Atari:
-------------
	The NetBSD/Atari specific support was done by Leo Weppelman,
	(leo@netbsd.org).

NetBSD/Alpha:
-------------
	This port is still experimental!

	The NetBSD/Alpha specific support was done by Jan-Hinrich Fessel,
	(oskar@zippo.unna.ping.de)

OpenBSD/i386:
-------------
	OpenBSD/i386 2.5 (and only 2.5!) is supported by isdn4bsd. I've 
	just tested it with the Teles 16.3 card and i am not using
	it daily, so please let me hear how it works for you and which 
	cards you were able to use.

BSD/OS:
-------
	The BSD/OS 4.0 specific support was done by Bert Driehuis. The
	support is not yet complete. Please contact Bert directly in case
	of questions regarding this at driehuis@playbeing.org.


4. Which ISDN cards are supported ?
-----------------------------------

	YES - card is supported for this OS
	NO  - card is NOT supported for this OS
	EXP - card is in an experimental status for this OS
	DEV - card driver is under development
	??? - card status is unknown for this OS


  Type (passive, ISA)	FreeBSD	NetBSD	OpenBSD	BSD/OS	Notes
  --------------------- -------	------	-------	------	-----------------------
  AVM A1		YES	YES	???	???		
  AVM Fritz!CardClassic YES	YES	???	???
  Creatix ISDN-S0/8	YES	YES	???	???	( = Teles S0/8 )
  Creatix ISDN-S0/16	YES	YES	???	???	( = Teles S0/16 )
  Dr.Neuhaus Niccy 1008	YES	YES	???	???	( = Teles S0/8 )
  Dr.Neuhaus Niccy 1016	YES	YES	???	???	( = Teles S0/16 )
  ELSA PCC-16		YES	???	???	???	(Note 14)
  ITK ix1 micro		YES	YES	???	???	(Note 13)
  Stollmann Tina-pp	YES	YES	???	???
  Teles S0/8		YES	YES	???	???
  Teles S0/16		YES	YES	???	???
  Teles S0/16.3		YES	YES	YES	YES	(Note 4)
  3Com/USR SportsterInt	YES	YES	???	???	( = Stollmann Tina-pp )

  Type (passive, ISAPnP)FreeBSD NetBSD OpenBSD BSD/OS	Notes
  --------------------- -------	------ ------- ------	-----------------------
  AVM Fritz!Card PnP	YES	NO	NO	NO	(Note 1)
  Asuscom I-IN100-ST-DV ???	???	???	???	( = Dynalink IS64PH )
  Asuscom ISDNlink 128K YES	???	???	???	(Note 16)
  Creatix ISDN-S0 PnP	YES	YES	???	???	(Note 2)
  Dr.Neuhaus Niccy GO@	YES	YES	???	???	(Note 2)
  Dynalink IS64PH	???	???	???	YES	(Note 11)
  ELSA 1000pro ISA	YES	YES	???	???	(Note 3)
  ITK ix1 micro V.3	YES	???	???	???	(Note 13)
  Sagem Cybermod	YES	YES	???	???	( = Niccy GO@ )
  Sedlbauer Win Speed	YES	YES	???	???	(Note 9)
  Siemens I-Surf 2.0	YES	NO	NO	NO	(Note 15)
  Teles S0 PnP		???	???	???	???	(Note 5)
  3Com USR PnP internal DEV	NO	NO	NO	(under development)


  Type (passive, PCI)	FreeBSD NetBSD OpenBSD BSD/OS	Notes
  --------------------- -------	------ ------- ------	-----------------------
  ELSA 1000pro PCI	YES	YES	???	???	
  AVM Fritz!Card PCI	YES	YES	???	???	(Note 14)

  Type (passive, PCMCIA)FreeBSD NetBSD OpenBSD BSD/OS	Notes
  --------------------- -------	------ ------- ------	-----------------------
  AVM Fritz!Card PCMCIA	YES	YES	???	???	(Note 10)
  ELSA ISDN/MC		NO	YES	???	???
  ELSA MC/ALL		NO	DEV	???	???

  Type (passive, Zorro2)FreeBSD NetBSD OpenBSD BSD/OS	Notes
  --------------------- -------	------ ------- ------	-----------------------
  ISDN Blaster		NO	YES	???	NO	(Note 12, Amiga/NetBSD)
  ISDN Master		NO	YES	???	NO	(Note 12, Amiga/NetBSD)
  ISDN Master II	NO	YES	???	NO	(Note 12, Amiga/NetBSD)

  Type (active, ISA)	FreeBSD NetBSD OpenBSD BSD/OS	Notes
  --------------------- -------	------ ------- ------	-----------------------
  AVM B1		DEV	NO	NO	NO	(Note 6)
  DiehlS,SX,SCOM,QUATRO	NO	DEV	NO	NO	(Note 7)
  Miro P1		DEV	NO	NO	NO	( = Tina-dd )
  Stollmann Tina-dd	DEV	NO	NO	NO	(Note 8)



Note 1:	The driver for the Fritz!Card PnP was developed by Udo Schweigert 
	(ust@cert.siemens.de) who develops under FreeBSD only.
	Please contact Udo in case of trouble.

Note 2:	FreeBSD
		This is a PnP card. To run it under FreeBSD, you need
		FreeBSD 2.2.6 RELEASE or higher.
	NetBSD
		The NetBSD version has not been verified to work yet.

Note 3: Due to its design, this card produces 128 IRQs/sec. This can be
	reportedly stopped by disconnecting pin 12 of the 7474 and wiring
	it to pin 15 of the 74175. Be careful! This procedure has not been
	verified and doing this will immediately terminate your warranty !!
	The card will not function anymore with drivers for other OSes and
	you may not get any further support from the manufacturer! YMMV!

Note 4: Only the 16.3 is supported; the 16.3c and the 16.3 PnP are currently
	unsupported !

Note 5: The card has not been verified to work yet.

Note 6: This driver is currently under development by Gary Jennejohn who
	develops under FreeBSD only.

Note 7: This driver is currently under construction by Martin Husemann who
	develops under NetBSD only.

Note 8: This driver is currently under development by Hellmuth Michaelis who
	develops under FreeBSD only.

Note 9: This driver was developed by German Tischler, tanis@gaspode.franken.de.
	Please contact him in case of trouble. The "Teledat 100" sold by the 
	german Telekom is identical with this card.
	
Note 10: This driver is developed by Matthias Apitz, matthias.apitz@sisis.de.
	Please contact him in case of trouble. Please read the file 
	misc/README.PCCARD in the i4b distribution for additional installation
	instructions.

Note 11: This driver was developed by Martijn Plak (tigrfhur@xs4all.nl)
	This driver might also work for Asuscom cards. (Andrew Gordon 
	wrote: Just to let you know that I've now tried the i4b "dynalink"
	driver with the ASUSCOM I-IN100-ST-DV card, and it appears to work
	fine.)

	Note: This driver is now unsupported as Martijn is no longer able
	      to maintain this driver.

	The BSD/OS support for this card was written by Bert Driehuis.

Note 12: This driver was developed by Ignatios Souvatzis (is@netbsd.org)
	Please contact him in case of trouble.
	This driver is supposed to work on the ISDN Master versions and
	lookalikes, like the ISDN Blaster, and on the ISDN Master II.
	Note that the ISDN Master II does not AutoConfig(tm)ure in the
	DraCo Zorro bus and thus only works in real Amigas. This is no
	i4b problem, but general.

Note 13: This driver was developed by Martin Husemann, please contact him
	in case of trouble. The FreeBSD PnP support for version 3 of the 
	card was done by Philippe Guezou <Philippe.Guezou@wanadoo.fr>.

Note 14: This driver was developed by Gary Jennejohn who develops under
	FreeBSD only. In case of problems with this driver, please contact
	him directly at garyj@muc.de. This driver is reported to run with
	the ELSA MicroLink ISDN/PCF.

Note 15: The driver for the Siemens I-Surf 2.0 was developed by Udo Schweigert 
	(ust@cert.siemens.de) who develops under FreeBSD only.
	Please contact Udo in case of trouble.

Note 16: The driver for the Asuscom ISDNlink 128K PnP was developed by
	Ari Suutari (ari@suutari.iki.fi). Please contact Ari directly
	in case of trouble with this driver.

5. Where do i find documentation for isdn4bsd ?
-----------------------------------------------

- For installation instructions have a look under the the FreeBSD, NetBSD
  and OpenBSD directories, each of these contains a file "INSTALLATION"
  which describes the installation procedure for isdn4bsd on those operating
  systems.

- handbook/i4b.ps contains a handbook for isdn4bsd describing how i4b is
  unpacked, configured, compiled and run on a FreeBSD system. With minor
  differences this applies to the other supported Operating Systems as
  well.

- Every program has a man page in the respective subdirectory and every 
  driver has a man page in the "man" subdirectory. All the man pages are 
  installed by running "make install" so its very easy to access them
  (hint: try "apropos isdn4bsd" after you installed isdn4bsd, it displays
   all available manual pages).

- misc/Overview contains a short technical overview of the inner workings 
  of isdn4bsd.

- misc/Resources contains URL's and ISBN's to more interesting ISDN related
  stuff.


6. How do i install isdn4bsd ?
------------------------------

Read the instructions in the file {FreeBSD|NetBSD|OpenBSD|BSDI}/INSTALLATION. 

In case they are incomplete, unclear, wrong or outdated, please send me an 
update for inclusion into a future distribution!

The handbook contains detailed installation instructions for FreeBSD.


7. Where do i get support for isdn4bsd ?
----------------------------------------

I will support and help with isdn4bsd as my time permits it. Please 
keep in mind that in this case support is given on a voluntary basis
and your questions might not be answered immediately.

Also, i recommend subscribing to the mailing list mentioned below.

Due to the experience gained supporting the predecessor of isdn4bsd, let
me please clearly state that there is no guarantee that your bug will be
fixed within some specific amount of time, in fact there is no guarantee 
that your bug will be fixed at all; i'll do my best but there might be
more important things going on in my life than giving free support for
isdn4bsd. 

Some bugs seem to occur only in certain environments and are not 
reproduceable here without access to the equipment you are connected
to or other equipment like ISDN simulators (which i don't get access to
for free): in this case you are the only person being able to trace down
the bug and fix it.

There is a web page for i4b at http://www.freebsd-support.de/i4b available
where i will put bugfixes, updates and contributions. In particular it has
an "errata" page, where you should look in case you have problems with i4b.


8.  Where do i get commercial support for isdn4bsd ?
----------------------------------------------------

In case you want to pay for support, maintenance, enhancements, extensions
to isdn4bsd or whatever else you may need, it is possible to hire me for
reasonable rates through my employer HCS GmbH; in this case please contact 
me for details at hm@hcs.de and/or look at http://www.freebsd-support.de


9. How can i help and/or support isdn4bsd ?
-------------------------------------------

Send a postcard! :-)

I really like to hear from you! (even if it runs out of the box)

I'm open for suggestions, bugreports, fixes, patches, enhancements and 
comments to improve isdn4bsd. 

Please send flames to /dev/null and/or start writing your own ISDN package.

Isdn4bsd is a project on a voluntary basis and writing and supporting
communication systems like isdn4bsd costs much money and much time.

Any contribution in terms of equipment, cards, documentation, cash
and/or daytime payed work on isdn4bsd would be highly appreciated.

You can help by not only reporting bugs, but by sending in a patch for
the problem together with a bugreport.

In case you cannot fix something yourself, please describe your problem
as detailed as possible, include information which version of an operating
system you are running, which ISDN board you are using, to which kind
of ISDN equipment (like the brand of PBX) you are connected etc. etc.

In case you want to get a currently unsupported card supported, write a
low level driver for it yourself and submit it. In case you can't write
it yourself there is a good chance to get it supported if you can donate
one of those cards and - if at all possible - docs for it.


10. How do i report bugs ?
--------------------------

Please submit patches ONLY as context diffs (diff -c)!

I vastly prefer receiving bug fixes and enhancements that are clearly
differentiated. I don't always know what to do with large patches that
contain many bugs and enhances folded into the same context diffs. 

Please keep it to one fix or enhancement per patch!

If your change modifies the external interface of an isdn4bsd program,
i.e. more config options, command-line switches, new programs, etc., 
then please also include patches for the manual pages and documentation.

Thank you!


11. Is there a mailing-list available for isdn4bsd ?
---------------------------------------------------

There is a mailing list available at

        freebsd-isdn@freebsd.org

The list is maintained by majordomo, so i.e. to subscribe,
send a mail with the text

        subscribe freebsd-isdn
        
in the message body sent to

        majordomo@freebsd.org

This mailing list is NOT (!) FreeBSD specific, everyone is welcome there!


12. Where can i get isdn4bsd ?
------------------------------

The isdn4bsd package is available from:

	ftp://i4b.consol.de/pub


Finally, i4b got an own web-page at 

	http://www.freebsd-support.de/i4b



13. What is the reward for reading everything in this file ?
------------------------------------------------------------

Have fun!
hellmuth