import of upstream 2.4.34.4 from kernel.org
[linux-2.4.git] / Documentation / networking / soundmodem.txt
1              LINUX DRIVER FOR SOUNDCARDS AS AX.25 MODEMS
2
3        Thomas M. Sailer, HB9JNX/AE4WA, <sailer@ife.ee.ethz.ch>
4
5 This driver allows either SoundBlaster (sbc) or Windows Sound System (wss)
6 compatible soundcards to be used as either 1200 baud AFSK or 9600 baud FSK
7 AX.25 packet radio modems. Only half duplex operation is supported; an
8 attempt to include full duplex support failed because the hardware did
9 not support it (it appeared that the card only provides one DMA channel,
10 although the codec chip would support two channels). The driver needs
11 some processing power! A 66 MHz 486 DX2 is a minimum requirement.  Otherwise
12 interactive performance of the computer may become sluggish. This driver
13 does *not* support telephone modem standards, it is intended for radio
14 use only.
15
16
17 The Interface of the driver
18
19 The driver provides kernel network drivers named sm[0-3]. sethdlc 
20 from the ax25 utilities may be used to set driver states etc. Users
21 of userland AX.25 stacks may use the net2kiss utility (also available
22 in the ax25 utilities package) to convert packets of a network interface
23 to a KISS stream on a pseudo tty. There's also a patch available from
24 me for WAMPES which allows attaching a kernel network interface directly.
25
26
27 Configuring the driver
28
29 Some sound cards need to be initialized before they operate in either
30 SoundBlaster or WSS compatibility mode. The driver does _NOT_ do this;
31 you may use the standard linux sound driver to initialize the soundcard;
32 compile it as a module, and do
33   insmod sound
34   rmmod sound
35 The soundcard should then be initialized correctly. If this does not help,
36 you'll have to write your own initialization utility.
37
38 Every time the driver is inserted into the kernel, it has to know which
39 modems it should access at which ports. This can be done with the setbaycom
40 utility. If you are only using one modem, you can also configure the
41 driver from the insmod command line (or by means of an option line in
42 /etc/modules.conf).
43
44 Examples:
45   insmod soundmodem mode="sbc:afsk1200" iobase=0x220 irq=5 dma=1
46   sethdlc -i sm0 -p mode "sbc:afsk1200" io 0x220 irq 5 dma 1
47
48 Both lines configure the first port to drive a soundblaster card
49 in 1200 baud AFSK mode.
50
51 The channel access parameters can be set with sethdlc -a or kissparms.
52 Note that both utilities interpret the values slightly different.
53
54
55 Input and output levels
56
57 It is important that the input and output levels are adjusted properly.
58 There are two utilities, available in the ax25 utilities distribution,
59 to facilitate this: smmixer and smdiag. smdiag allows you to display
60 the input signal in an oscilloscope like display or an eye diagram.
61 smmixer allows you to adjust input/output levels. See the respective
62 man pages.
63
64
65 Transmitter keying
66
67 Since soundcards do not have a DC coupled output; PTT keying options include
68 the following:
69 * VOX circuitry
70 * Serial port pin
71 * Parallel port pin
72 * MPU401 MIDI output via a retriggerable monoflop.
73 Circuit schematics may be found at
74 http://www.ife.ee.ethz.ch/~sailer/pcf/ptt_circ/ptt.html.
75
76
77 Compatibility with the rest of the Linux kernel
78
79 The sound driver and the soundcard modem driver compete for the same
80 hardware resources. Of course only one driver can access a given
81 interface at a time. Worse yet, the sound driver grabs the soundcard
82 at startup time. Therefore the soundcard modem driver subsequently won't
83 be able to access the soundcard. You might therefore find it necessary to
84 unload the sound driver before using the soundcard modem driver.
85
86
87
88 vy 73s de
89 Tom Sailer, sailer@ife.ee.ethz.ch
90 hb9jnx @ hb9w.ampr.org