1
/*****************************************************************************/
4
* baycom_ser_fdx.c -- baycom ser12 fullduplex radio modem driver.
6
* Copyright (C) 1996-2000 Thomas Sailer (sailer@ife.ee.ethz.ch)
8
* This program is free software; you can redistribute it and/or modify
9
* it under the terms of the GNU General Public License as published by
10
* the Free Software Foundation; either version 2 of the License, or
11
* (at your option) any later version.
13
* This program is distributed in the hope that it will be useful,
14
* but WITHOUT ANY WARRANTY; without even the implied warranty of
15
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16
* GNU General Public License for more details.
18
* You should have received a copy of the GNU General Public License
19
* along with this program; if not, write to the Free Software
20
* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
22
* Please note that the GPL allows you to use the driver, NOT the radio.
23
* In order to use the radio, you need a license from the communications
24
* authority of your country.
29
* ser12: This is a very simple 1200 baud AFSK modem. The modem consists only
30
* of a modulator/demodulator chip, usually a TI TCM3105. The computer
31
* is responsible for regenerating the receiver bit clock, as well as
32
* for handling the HDLC protocol. The modem connects to a serial port,
33
* hence the name. Since the serial port is not used as an async serial
34
* port, the kernel driver for serial ports cannot be used, and this
35
* driver only supports standard serial hardware (8250, 16450, 16550A)
37
* This modem usually draws its supply current out of the otherwise unused
38
* TXD pin of the serial port. Thus a contiguous stream of 0x00-bytes
39
* is transmitted to achieve a positive supply voltage.
41
* hsk: This is a 4800 baud FSK modem, designed for TNC use. It works fine
42
* in 'baycom-mode' :-) In contrast to the TCM3105 modem, power is
43
* externally supplied. So there's no need to provide the 0x00-byte-stream
44
* when receiving or idle, which drastically reduces interrupt load.
46
* Command line options (insmod command line)
48
* mode ser# hardware DCD
50
* ser#+ hardware DCD, inverted signal at DCD pin
51
* '#' denotes the baud rate / 100, eg. ser12* is '1200 baud, soft DCD'
52
* iobase base address of the port; common values are 0x3f8, 0x2f8, 0x3e8, 0x2e8
53
* baud baud rate (between 300 and 4800)
54
* irq interrupt line of the port; common values are 4,3
58
* 0.1 26.06.1996 Adapted from baycom.c and made network driver interface
59
* 18.10.1996 Changed to new user space access routines (copy_{to,from}_user)
60
* 0.3 26.04.1997 init code/data tagged
61
* 0.4 08.07.1997 alternative ser12 decoding algorithm (uses delta CTS ints)
62
* 0.5 11.11.1997 ser12/par96 split into separate files
63
* 0.6 24.01.1998 Thorsten Kranzkowski, dl8bcu and Thomas Sailer:
64
* reduced interrupt load in transmit case
66
* 0.7 03.08.1999 adapt to Linus' new __setup/__initcall
67
* 0.8 10.08.1999 use module_init/module_exit
68
* 0.9 12.02.2000 adapted to softnet driver interface
69
* 0.10 03.07.2000 fix interface name handling
72
/*****************************************************************************/
74
#include <linux/capability.h>
75
#include <linux/module.h>
76
#include <linux/ioport.h>
77
#include <linux/string.h>
78
#include <linux/init.h>
79
#include <linux/interrupt.h>
80
#include <linux/hdlcdrv.h>
81
#include <linux/baycom.h>
82
#include <linux/jiffies.h>
84
#include <asm/uaccess.h>
88
/* --------------------------------------------------------------------- */
92
/* --------------------------------------------------------------------- */
94
static const char bc_drvname[] = "baycom_ser_fdx";
95
static const char bc_drvinfo[] = KERN_INFO "baycom_ser_fdx: (C) 1996-2000 Thomas Sailer, HB9JNX/AE4WA\n"
96
"baycom_ser_fdx: version 0.10\n";
98
/* --------------------------------------------------------------------- */
102
static struct net_device *baycom_device[NR_PORTS];
104
/* --------------------------------------------------------------------- */
106
#define RBR(iobase) (iobase+0)
107
#define THR(iobase) (iobase+0)
108
#define IER(iobase) (iobase+1)
109
#define IIR(iobase) (iobase+2)
110
#define FCR(iobase) (iobase+2)
111
#define LCR(iobase) (iobase+3)
112
#define MCR(iobase) (iobase+4)
113
#define LSR(iobase) (iobase+5)
114
#define MSR(iobase) (iobase+6)
115
#define SCR(iobase) (iobase+7)
116
#define DLL(iobase) (iobase+0)
117
#define DLM(iobase) (iobase+1)
119
#define SER12_EXTENT 8
121
/* ---------------------------------------------------------------------- */
123
* Information that need to be kept for each board.
126
struct baycom_state {
127
struct hdlcdrv_state hdrv;
129
unsigned int baud, baud_us, baud_arbdiv, baud_uartdiv, baud_dcdtimeout;
136
struct modem_state_ser12 {
137
unsigned char tx_bit;
138
unsigned char last_rxbit;
139
int dcd_sum0, dcd_sum1, dcd_sum2;
141
unsigned int pll_time;
142
unsigned int txshreg;
148
unsigned long last_jiffies;
150
unsigned last_intcnt;
154
#endif /* BAYCOM_DEBUG */
157
/* --------------------------------------------------------------------- */
159
static inline void baycom_int_freq(struct baycom_state *bc)
162
unsigned long cur_jiffies = jiffies;
164
* measure the interrupt frequency
166
bc->debug_vals.cur_intcnt++;
167
if (time_after_eq(cur_jiffies, bc->debug_vals.last_jiffies + HZ)) {
168
bc->debug_vals.last_jiffies = cur_jiffies;
169
bc->debug_vals.last_intcnt = bc->debug_vals.cur_intcnt;
170
bc->debug_vals.cur_intcnt = 0;
171
bc->debug_vals.last_pllcorr = bc->debug_vals.cur_pllcorr;
172
bc->debug_vals.cur_pllcorr = 0;
174
#endif /* BAYCOM_DEBUG */
177
/* --------------------------------------------------------------------- */
179
* ===================== SER12 specific routines =========================
182
/* --------------------------------------------------------------------- */
184
static inline void ser12_set_divisor(struct net_device *dev,
185
unsigned int divisor)
187
outb(0x81, LCR(dev->base_addr)); /* DLAB = 1 */
188
outb(divisor, DLL(dev->base_addr));
189
outb(divisor >> 8, DLM(dev->base_addr));
190
outb(0x01, LCR(dev->base_addr)); /* word length = 6 */
192
* make sure the next interrupt is generated;
193
* 0 must be used to power the modem; the modem draws its
194
* power from the TxD line
196
outb(0x00, THR(dev->base_addr));
198
* it is important not to set the divider while transmitting;
199
* this reportedly makes some UARTs generating interrupts
200
* in the hundredthousands per second region
201
* Reported by: Ignacio.Arenaza@studi.epfl.ch (Ignacio Arenaza Nuno)
205
/* --------------------------------------------------------------------- */
208
static inline unsigned int hweight16(unsigned int w)
209
__attribute__ ((unused));
210
static inline unsigned int hweight8(unsigned int w)
211
__attribute__ ((unused));
213
static inline unsigned int hweight16(unsigned int w)
215
unsigned short res = (w & 0x5555) + ((w >> 1) & 0x5555);
216
res = (res & 0x3333) + ((res >> 2) & 0x3333);
217
res = (res & 0x0F0F) + ((res >> 4) & 0x0F0F);
218
return (res & 0x00FF) + ((res >> 8) & 0x00FF);
221
static inline unsigned int hweight8(unsigned int w)
223
unsigned short res = (w & 0x55) + ((w >> 1) & 0x55);
224
res = (res & 0x33) + ((res >> 2) & 0x33);
225
return (res & 0x0F) + ((res >> 4) & 0x0F);
229
/* --------------------------------------------------------------------- */
231
static __inline__ void ser12_rx(struct net_device *dev, struct baycom_state *bc, struct timeval *tv, unsigned char curs)
234
int bdus8 = bc->baud_us >> 3;
235
int bdus4 = bc->baud_us >> 2;
236
int bdus2 = bc->baud_us >> 1;
238
timediff = 1000000 + tv->tv_usec - bc->modem.ser12.pll_time;
239
while (timediff >= 500000)
241
while (timediff >= bdus2) {
242
timediff -= bc->baud_us;
243
bc->modem.ser12.pll_time += bc->baud_us;
244
bc->modem.ser12.dcd_time--;
245
/* first check if there is room to add a bit */
246
if (bc->modem.shreg & 1) {
247
hdlcdrv_putbits(&bc->hdrv, (bc->modem.shreg >> 1) ^ 0xffff);
248
bc->modem.shreg = 0x10000;
251
bc->modem.shreg >>= 1;
253
if (bc->modem.ser12.dcd_time <= 0) {
255
hdlcdrv_setdcd(&bc->hdrv, (bc->modem.ser12.dcd_sum0 +
256
bc->modem.ser12.dcd_sum1 +
257
bc->modem.ser12.dcd_sum2) < 0);
258
bc->modem.ser12.dcd_sum2 = bc->modem.ser12.dcd_sum1;
259
bc->modem.ser12.dcd_sum1 = bc->modem.ser12.dcd_sum0;
260
bc->modem.ser12.dcd_sum0 = 2; /* slight bias */
261
bc->modem.ser12.dcd_time += 120;
263
if (bc->modem.ser12.last_rxbit != curs) {
264
bc->modem.ser12.last_rxbit = curs;
265
bc->modem.shreg |= 0x10000;
268
bc->modem.ser12.pll_time += bdus8;
270
bc->modem.ser12.pll_time += 1000000 - bdus8;
272
if (abs(timediff) > bdus4)
273
bc->modem.ser12.dcd_sum0 += 4;
275
bc->modem.ser12.dcd_sum0--;
277
bc->debug_vals.cur_pllcorr = timediff;
278
#endif /* BAYCOM_DEBUG */
280
while (bc->modem.ser12.pll_time >= 1000000)
281
bc->modem.ser12.pll_time -= 1000000;
284
/* --------------------------------------------------------------------- */
286
static irqreturn_t ser12_interrupt(int irq, void *dev_id)
288
struct net_device *dev = (struct net_device *)dev_id;
289
struct baycom_state *bc = netdev_priv(dev);
291
unsigned char iir, msr;
292
unsigned int txcount = 0;
294
if (!bc || bc->hdrv.magic != HDLCDRV_MAGIC)
296
/* fast way out for shared irq */
297
if ((iir = inb(IIR(dev->base_addr))) & 1)
299
/* get current time */
300
do_gettimeofday(&tv);
301
msr = inb(MSR(dev->base_addr));
303
if ((msr & 8) && bc->opt_dcd)
304
hdlcdrv_setdcd(&bc->hdrv, !((msr ^ bc->opt_dcd) & 0x80));
308
inb(LSR(dev->base_addr));
312
inb(RBR(dev->base_addr));
317
* make sure the next interrupt is generated;
318
* 0 must be used to power the modem; the modem draws its
319
* power from the TxD line
321
outb(0x00, THR(dev->base_addr));
325
* first output the last bit (!) then call HDLC transmitter,
326
* since this may take quite long
329
outb(0x0e | (!!bc->modem.ser12.tx_bit), MCR(dev->base_addr));
331
outb(0x0d, MCR(dev->base_addr)); /* transmitter off */
335
msr = inb(MSR(dev->base_addr));
337
if ((msr & 8) && bc->opt_dcd)
338
hdlcdrv_setdcd(&bc->hdrv, !((msr ^ bc->opt_dcd) & 0x80));
341
iir = inb(IIR(dev->base_addr));
342
} while (!(iir & 1));
343
ser12_rx(dev, bc, &tv, msr & 0x10); /* CTS */
344
if (bc->modem.ptt && txcount) {
345
if (bc->modem.ser12.txshreg <= 1) {
346
bc->modem.ser12.txshreg = 0x10000 | hdlcdrv_getbits(&bc->hdrv);
347
if (!hdlcdrv_ptt(&bc->hdrv)) {
348
ser12_set_divisor(dev, 115200/100/8);
353
bc->modem.ser12.tx_bit = !(bc->modem.ser12.tx_bit ^ (bc->modem.ser12.txshreg & 1));
354
bc->modem.ser12.txshreg >>= 1;
358
if (!bc->modem.ptt && txcount) {
359
hdlcdrv_arbitrate(dev, &bc->hdrv);
360
if (hdlcdrv_ptt(&bc->hdrv)) {
361
ser12_set_divisor(dev, bc->baud_uartdiv);
362
bc->modem.ser12.txshreg = 1;
366
hdlcdrv_transmitter(dev, &bc->hdrv);
367
hdlcdrv_receiver(dev, &bc->hdrv);
372
/* --------------------------------------------------------------------- */
374
enum uart { c_uart_unknown, c_uart_8250,
375
c_uart_16450, c_uart_16550, c_uart_16550A};
376
static const char *uart_str[] = {
377
"unknown", "8250", "16450", "16550", "16550A"
380
static enum uart ser12_check_uart(unsigned int iobase)
382
unsigned char b1,b2,b3;
384
enum uart uart_tab[] =
385
{ c_uart_16450, c_uart_unknown, c_uart_16550, c_uart_16550A };
387
b1 = inb(MCR(iobase));
388
outb(b1 | 0x10, MCR(iobase)); /* loopback mode */
389
b2 = inb(MSR(iobase));
390
outb(0x1a, MCR(iobase));
391
b3 = inb(MSR(iobase)) & 0xf0;
392
outb(b1, MCR(iobase)); /* restore old values */
393
outb(b2, MSR(iobase));
395
return c_uart_unknown;
398
outb(0x01, FCR(iobase)); /* enable FIFOs */
399
u = uart_tab[(inb(IIR(iobase)) >> 6) & 3];
400
if (u == c_uart_16450) {
401
outb(0x5a, SCR(iobase));
402
b1 = inb(SCR(iobase));
403
outb(0xa5, SCR(iobase));
404
b2 = inb(SCR(iobase));
405
if ((b1 != 0x5a) || (b2 != 0xa5))
411
/* --------------------------------------------------------------------- */
413
static int ser12_open(struct net_device *dev)
415
struct baycom_state *bc = netdev_priv(dev);
420
if (!dev->base_addr || dev->base_addr > 0xffff-SER12_EXTENT ||
421
dev->irq < 2 || dev->irq > nr_irqs) {
422
printk(KERN_INFO "baycom_ser_fdx: invalid portnumber (max %u) "
423
"or irq (2 <= irq <= %d)\n",
424
0xffff-SER12_EXTENT, nr_irqs);
427
if (bc->baud < 300 || bc->baud > 4800) {
428
printk(KERN_INFO "baycom_ser_fdx: invalid baudrate "
432
if (!request_region(dev->base_addr, SER12_EXTENT, "baycom_ser_fdx")) {
433
printk(KERN_WARNING "BAYCOM_SER_FSX: I/O port 0x%04lx busy\n",
437
memset(&bc->modem, 0, sizeof(bc->modem));
438
bc->hdrv.par.bitrate = bc->baud;
439
bc->baud_us = 1000000/bc->baud;
440
bc->baud_uartdiv = (115200/8)/bc->baud;
441
if ((u = ser12_check_uart(dev->base_addr)) == c_uart_unknown){
442
release_region(dev->base_addr, SER12_EXTENT);
445
outb(0, FCR(dev->base_addr)); /* disable FIFOs */
446
outb(0x0d, MCR(dev->base_addr));
447
outb(0, IER(dev->base_addr));
448
if (request_irq(dev->irq, ser12_interrupt, IRQF_DISABLED | IRQF_SHARED,
449
"baycom_ser_fdx", dev)) {
450
release_region(dev->base_addr, SER12_EXTENT);
454
* set the SIO to 6 Bits/character; during receive,
455
* the baud rate is set to produce 100 ints/sec
456
* to feed the channel arbitration process,
457
* during transmit to baud ints/sec to run
460
ser12_set_divisor(dev, 115200/100/8);
462
* enable transmitter empty interrupt and modem status interrupt
464
outb(0x0a, IER(dev->base_addr));
466
* make sure the next interrupt is generated;
467
* 0 must be used to power the modem; the modem draws its
468
* power from the TxD line
470
outb(0x00, THR(dev->base_addr));
471
hdlcdrv_setdcd(&bc->hdrv, 0);
472
printk(KERN_INFO "%s: ser_fdx at iobase 0x%lx irq %u baud %u uart %s\n",
473
bc_drvname, dev->base_addr, dev->irq, bc->baud, uart_str[u]);
477
/* --------------------------------------------------------------------- */
479
static int ser12_close(struct net_device *dev)
481
struct baycom_state *bc = netdev_priv(dev);
488
outb(0, IER(dev->base_addr));
489
outb(1, MCR(dev->base_addr));
490
free_irq(dev->irq, dev);
491
release_region(dev->base_addr, SER12_EXTENT);
492
printk(KERN_INFO "%s: close ser_fdx at iobase 0x%lx irq %u\n",
493
bc_drvname, dev->base_addr, dev->irq);
497
/* --------------------------------------------------------------------- */
499
* ===================== hdlcdrv driver interface =========================
502
/* --------------------------------------------------------------------- */
504
static int baycom_ioctl(struct net_device *dev, struct ifreq *ifr,
505
struct hdlcdrv_ioctl *hi, int cmd);
507
/* --------------------------------------------------------------------- */
509
static struct hdlcdrv_ops ser12_ops = {
510
.drvname = bc_drvname,
511
.drvinfo = bc_drvinfo,
513
.close = ser12_close,
514
.ioctl = baycom_ioctl,
517
/* --------------------------------------------------------------------- */
519
static int baycom_setmode(struct baycom_state *bc, const char *modestr)
523
if (!strncmp(modestr, "ser", 3)) {
524
baud = simple_strtoul(modestr+3, NULL, 10);
525
if (baud >= 3 && baud <= 48)
528
if (strchr(modestr, '*'))
530
else if (strchr(modestr, '+'))
537
/* --------------------------------------------------------------------- */
539
static int baycom_ioctl(struct net_device *dev, struct ifreq *ifr,
540
struct hdlcdrv_ioctl *hi, int cmd)
542
struct baycom_state *bc;
543
struct baycom_ioctl bi;
548
bc = netdev_priv(dev);
549
BUG_ON(bc->hdrv.magic != HDLCDRV_MAGIC);
551
if (cmd != SIOCDEVPRIVATE)
557
case HDLCDRVCTL_GETMODE:
558
sprintf(hi->data.modename, "ser%u", bc->baud / 100);
559
if (bc->opt_dcd <= 0)
560
strcat(hi->data.modename, (!bc->opt_dcd) ? "*" : "+");
561
if (copy_to_user(ifr->ifr_data, hi, sizeof(struct hdlcdrv_ioctl)))
565
case HDLCDRVCTL_SETMODE:
566
if (netif_running(dev) || !capable(CAP_NET_ADMIN))
568
hi->data.modename[sizeof(hi->data.modename)-1] = '\0';
569
return baycom_setmode(bc, hi->data.modename);
571
case HDLCDRVCTL_MODELIST:
572
strcpy(hi->data.modename, "ser12,ser3,ser24");
573
if (copy_to_user(ifr->ifr_data, hi, sizeof(struct hdlcdrv_ioctl)))
577
case HDLCDRVCTL_MODEMPARMASK:
578
return HDLCDRV_PARMASK_IOBASE | HDLCDRV_PARMASK_IRQ;
582
if (copy_from_user(&bi, ifr->ifr_data, sizeof(bi)))
589
case BAYCOMCTL_GETDEBUG:
590
bi.data.dbg.debug1 = bc->hdrv.ptt_keyed;
591
bi.data.dbg.debug2 = bc->debug_vals.last_intcnt;
592
bi.data.dbg.debug3 = bc->debug_vals.last_pllcorr;
594
#endif /* BAYCOM_DEBUG */
597
if (copy_to_user(ifr->ifr_data, &bi, sizeof(bi)))
603
/* --------------------------------------------------------------------- */
606
* command line settable parameters
608
static char *mode[NR_PORTS] = { "ser12*", };
609
static int iobase[NR_PORTS] = { 0x3f8, };
610
static int irq[NR_PORTS] = { 4, };
611
static int baud[NR_PORTS] = { [0 ... NR_PORTS-1] = 1200 };
613
module_param_array(mode, charp, NULL, 0);
614
MODULE_PARM_DESC(mode, "baycom operating mode; * for software DCD");
615
module_param_array(iobase, int, NULL, 0);
616
MODULE_PARM_DESC(iobase, "baycom io base address");
617
module_param_array(irq, int, NULL, 0);
618
MODULE_PARM_DESC(irq, "baycom irq number");
619
module_param_array(baud, int, NULL, 0);
620
MODULE_PARM_DESC(baud, "baycom baud rate (300 to 4800)");
622
MODULE_AUTHOR("Thomas M. Sailer, sailer@ife.ee.ethz.ch, hb9jnx@hb9w.che.eu");
623
MODULE_DESCRIPTION("Baycom ser12 full duplex amateur radio modem driver");
624
MODULE_LICENSE("GPL");
626
/* --------------------------------------------------------------------- */
628
static int __init init_baycomserfdx(void)
635
* register net devices
637
for (i = 0; i < NR_PORTS; i++) {
638
struct net_device *dev;
639
struct baycom_state *bc;
640
char ifname[IFNAMSIZ];
642
sprintf(ifname, "bcsf%d", i);
647
iobase[i] = irq[i] = 0;
649
dev = hdlcdrv_register(&ser12_ops,
650
sizeof(struct baycom_state),
651
ifname, iobase[i], irq[i], 0);
655
bc = netdev_priv(dev);
656
if (set_hw && baycom_setmode(bc, mode[i]))
660
baycom_device[i] = dev;
668
static void __exit cleanup_baycomserfdx(void)
672
for(i = 0; i < NR_PORTS; i++) {
673
struct net_device *dev = baycom_device[i];
675
hdlcdrv_unregister(dev);
679
module_init(init_baycomserfdx);
680
module_exit(cleanup_baycomserfdx);
682
/* --------------------------------------------------------------------- */
687
* format: baycom_ser_fdx=io,irq,mode
688
* mode: ser# hardware DCD
690
* ser#+ hardware DCD, inverted signal at DCD pin
691
* '#' denotes the baud rate / 100, eg. ser12* is '1200 baud, soft DCD'
694
static int __init baycom_ser_fdx_setup(char *str)
696
static unsigned nr_dev;
699
if (nr_dev >= NR_PORTS)
701
str = get_options(str, 4, ints);
705
iobase[nr_dev] = ints[1];
706
irq[nr_dev] = ints[2];
708
baud[nr_dev] = ints[3];
713
__setup("baycom_ser_fdx=", baycom_ser_fdx_setup);
716
/* --------------------------------------------------------------------- */