tjh.dev
Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
docs: networking: convert baycom.txt to ReST
- add SPDX header;
- adjust titles and chapters, adding proper markups;
- mark code blocks and literals as such;
- mark tables as such;
- adjust identation, whitespaces and blank lines;
- add to networking/index.rst.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: David S. Miller <davem@davemloft.net>
authored by
Mauro Carvalho Chehab
and committed by
David S. Miller
b5fcf32d
20b943f0
+68
-51
+63
-47
Documentation/networking/baycom.txt
Documentation/networking/baycom.rst
+63
-47
Documentation/networking/baycom.txt
Documentation/networking/baycom.rst
···
1
-
LINUX DRIVERS FOR BAYCOM MODEMS
1
+
.. SPDX-License-Identifier: GPL-2.0
2
2
3
-
Thomas M. Sailer, HB9JNX/AE4WA, <sailer@ife.ee.ethz.ch>
3
+
===============================
4
+
Linux Drivers for Baycom Modems
5
+
===============================
4
6
5
-
!!NEW!! (04/98) The drivers for the baycom modems have been split into
7
+
Thomas M. Sailer, HB9JNX/AE4WA, <sailer@ife.ee.ethz.ch>
8
+
9
+
The drivers for the baycom modems have been split into
6
10
separate drivers as they did not share any code, and the driver
7
11
and device names have changed.
8
12
9
13
This document describes the Linux Kernel Drivers for simple Baycom style
10
-
amateur radio modems.
14
+
amateur radio modems.
11
15
12
16
The following drivers are available:
17
+
====================================
13
18
14
19
baycom_ser_fdx:
15
20
This driver supports the SER12 modems either full or half duplex.
16
-
Its baud rate may be changed via the `baud' module parameter,
21
+
Its baud rate may be changed via the ``baud`` module parameter,
17
22
therefore it supports just about every bit bang modem on a
18
23
serial port. Its devices are called bcsf0 through bcsf3.
19
24
This is the recommended driver for SER12 type modems,
20
25
however if you have a broken UART clone that does not have working
21
-
delta status bits, you may try baycom_ser_hdx.
26
+
delta status bits, you may try baycom_ser_hdx.
22
27
23
-
baycom_ser_hdx:
28
+
baycom_ser_hdx:
24
29
This is an alternative driver for SER12 type modems.
25
30
It only supports half duplex, and only 1200 baud. Its devices
26
31
are called bcsh0 through bcsh3. Use this driver only if baycom_ser_fdx
···
42
37
43
38
The following modems are supported:
44
39
45
-
ser12: This is a very simple 1200 baud AFSK modem. The modem consists only
46
-
of a modulator/demodulator chip, usually a TI TCM3105. The computer
47
-
is responsible for regenerating the receiver bit clock, as well as
48
-
for handling the HDLC protocol. The modem connects to a serial port,
49
-
hence the name. Since the serial port is not used as an async serial
50
-
port, the kernel driver for serial ports cannot be used, and this
51
-
driver only supports standard serial hardware (8250, 16450, 16550)
40
+
======= ========================================================================
41
+
ser12 This is a very simple 1200 baud AFSK modem. The modem consists only
42
+
of a modulator/demodulator chip, usually a TI TCM3105. The computer
43
+
is responsible for regenerating the receiver bit clock, as well as
44
+
for handling the HDLC protocol. The modem connects to a serial port,
45
+
hence the name. Since the serial port is not used as an async serial
46
+
port, the kernel driver for serial ports cannot be used, and this
47
+
driver only supports standard serial hardware (8250, 16450, 16550)
52
48
53
-
par96: This is a modem for 9600 baud FSK compatible to the G3RUH standard.
54
-
The modem does all the filtering and regenerates the receiver clock.
55
-
Data is transferred from and to the PC via a shift register.
56
-
The shift register is filled with 16 bits and an interrupt is signalled.
57
-
The PC then empties the shift register in a burst. This modem connects
58
-
to the parallel port, hence the name. The modem leaves the
59
-
implementation of the HDLC protocol and the scrambler polynomial to
60
-
the PC.
49
+
par96 This is a modem for 9600 baud FSK compatible to the G3RUH standard.
50
+
The modem does all the filtering and regenerates the receiver clock.
51
+
Data is transferred from and to the PC via a shift register.
52
+
The shift register is filled with 16 bits and an interrupt is signalled.
53
+
The PC then empties the shift register in a burst. This modem connects
54
+
to the parallel port, hence the name. The modem leaves the
55
+
implementation of the HDLC protocol and the scrambler polynomial to
56
+
the PC.
61
57
62
-
picpar: This is a redesign of the par96 modem by Henning Rech, DF9IC. The modem
63
-
is protocol compatible to par96, but uses only three low power ICs
64
-
and can therefore be fed from the parallel port and does not require
65
-
an additional power supply. Furthermore, it incorporates a carrier
66
-
detect circuitry.
58
+
picpar This is a redesign of the par96 modem by Henning Rech, DF9IC. The modem
59
+
is protocol compatible to par96, but uses only three low power ICs
60
+
and can therefore be fed from the parallel port and does not require
61
+
an additional power supply. Furthermore, it incorporates a carrier
62
+
detect circuitry.
67
63
68
-
EPP: This is a high-speed modem adaptor that connects to an enhanced parallel port.
69
-
Its target audience is users working over a high speed hub (76.8kbit/s).
64
+
EPP This is a high-speed modem adaptor that connects to an enhanced parallel
65
+
port.
70
66
71
-
eppfpga: This is a redesign of the EPP adaptor.
67
+
Its target audience is users working over a high speed hub (76.8kbit/s).
72
68
73
-
69
+
eppfpga This is a redesign of the EPP adaptor.
70
+
======= ========================================================================
74
71
75
72
All of the above modems only support half duplex communications. However,
76
73
the driver supports the KISS (see below) fullduplex command. It then simply
77
74
starts to send as soon as there's a packet to transmit and does not care
78
75
about DCD, i.e. it starts to send even if there's someone else on the channel.
79
-
This command is required by some implementations of the DAMA channel
76
+
This command is required by some implementations of the DAMA channel
80
77
access protocol.
81
78
82
79
83
80
The Interface of the drivers
81
+
============================
84
82
85
83
Unlike previous drivers, these drivers are no longer character devices,
86
84
but they are now true kernel network interfaces. Installation is therefore
···
96
88
97
89
98
90
Configuring the driver
91
+
======================
99
92
100
93
Every time a driver is inserted into the kernel, it has to know which
101
94
modems it should access at which ports. This can be done with the setbaycom
102
95
utility. If you are only using one modem, you can also configure the
103
96
driver from the insmod command line (or by means of an option line in
104
-
/etc/modprobe.d/*.conf).
97
+
``/etc/modprobe.d/*.conf``).
105
98
106
-
Examples:
99
+
Examples::
100
+
107
101
modprobe baycom_ser_fdx mode="ser12*" iobase=0x3f8 irq=4
108
102
sethdlc -i bcsf0 -p mode "ser12*" io 0x3f8 irq 4
109
103
110
104
Both lines configure the first port to drive a ser12 modem at the first
111
-
serial port (COM1 under DOS). The * in the mode parameter instructs the driver to use
112
-
the software DCD algorithm (see below).
105
+
serial port (COM1 under DOS). The * in the mode parameter instructs the driver
106
+
to use the software DCD algorithm (see below)::
113
107
114
108
insmod baycom_par mode="picpar" iobase=0x378
115
109
sethdlc -i bcp0 -p mode "picpar" io 0x378
···
125
115
126
116
127
117
Hardware DCD versus Software DCD
118
+
================================
128
119
129
120
To avoid collisions on the air, the driver must know when the channel is
130
121
busy. This is the task of the DCD circuitry/software. The driver may either
131
122
utilise a software DCD algorithm (options=1) or use a DCD signal from
132
123
the hardware (options=0).
133
124
134
-
ser12: if software DCD is utilised, the radio's squelch should always be
135
-
open. It is highly recommended to use the software DCD algorithm,
136
-
as it is much faster than most hardware squelch circuitry. The
137
-
disadvantage is a slightly higher load on the system.
125
+
======= =================================================================
126
+
ser12 if software DCD is utilised, the radio's squelch should always be
127
+
open. It is highly recommended to use the software DCD algorithm,
128
+
as it is much faster than most hardware squelch circuitry. The
129
+
disadvantage is a slightly higher load on the system.
138
130
139
-
par96: the software DCD algorithm for this type of modem is rather poor.
140
-
The modem simply does not provide enough information to implement
141
-
a reasonable DCD algorithm in software. Therefore, if your radio
142
-
feeds the DCD input of the PAR96 modem, the use of the hardware
143
-
DCD circuitry is recommended.
131
+
par96 the software DCD algorithm for this type of modem is rather poor.
132
+
The modem simply does not provide enough information to implement
133
+
a reasonable DCD algorithm in software. Therefore, if your radio
134
+
feeds the DCD input of the PAR96 modem, the use of the hardware
135
+
DCD circuitry is recommended.
144
136
145
-
picpar: the picpar modem features a builtin DCD hardware, which is highly
146
-
recommended.
137
+
picpar the picpar modem features a builtin DCD hardware, which is highly
138
+
recommended.
139
+
======= =================================================================
147
140
148
141
149
142
150
143
Compatibility with the rest of the Linux kernel
144
+
===============================================
151
145
152
146
The serial driver and the baycom serial drivers compete
153
147
for the same hardware resources. Of course only one driver can access a given
···
168
154
to arbitrate the ports between different client drivers.
169
155
170
156
vy 73s de
157
+
171
158
Tom Sailer, sailer@ife.ee.ethz.ch
159
+
172
160
hb9jnx @ hb9w.ampr.org
+1
Documentation/networking/index.rst
+1
Documentation/networking/index.rst
+4
-4
drivers/net/hamradio/Kconfig
+4
-4
drivers/net/hamradio/Kconfig
···
127
127
your serial interface chip. To configure the driver, use the sethdlc
128
128
utility available in the standard ax25 utilities package. For
129
129
information on the modems, see <http://www.baycom.de/> and
130
-
<file:Documentation/networking/baycom.txt>.
130
+
<file:Documentation/networking/baycom.rst>.
131
131
132
132
To compile this driver as a module, choose M here: the module
133
133
will be called baycom_ser_fdx. This is recommended.
···
145
145
the driver, use the sethdlc utility available in the standard ax25
146
146
utilities package. For information on the modems, see
147
147
<http://www.baycom.de/> and
148
-
<file:Documentation/networking/baycom.txt>.
148
+
<file:Documentation/networking/baycom.rst>.
149
149
150
150
To compile this driver as a module, choose M here: the module
151
151
will be called baycom_ser_hdx. This is recommended.
···
160
160
par96 designs. To configure the driver, use the sethdlc utility
161
161
available in the standard ax25 utilities package. For information on
162
162
the modems, see <http://www.baycom.de/> and the file
163
-
<file:Documentation/networking/baycom.txt>.
163
+
<file:Documentation/networking/baycom.rst>.
164
164
165
165
To compile this driver as a module, choose M here: the module
166
166
will be called baycom_par. This is recommended.
···
175
175
designs. To configure the driver, use the sethdlc utility available
176
176
in the standard ax25 utilities package. For information on the
177
177
modems, see <http://www.baycom.de/> and the file
178
-
<file:Documentation/networking/baycom.txt>.
178
+
<file:Documentation/networking/baycom.rst>.
179
179
180
180
To compile this driver as a module, choose M here: the module
181
181
will be called baycom_epp. This is recommended.