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/hdlcdrv.h>
80 #include <linux/baycom.h>
81 #include <linux/jiffies.h>
83 #include <asm/uaccess.h>
87 /* --------------------------------------------------------------------- */
91 /* --------------------------------------------------------------------- */
93 static const char bc_drvname
[] = "baycom_ser_fdx";
94 static const char bc_drvinfo
[] = KERN_INFO
"baycom_ser_fdx: (C) 1996-2000 Thomas Sailer, HB9JNX/AE4WA\n"
95 "baycom_ser_fdx: version 0.10 compiled " __TIME__
" " __DATE__
"\n";
97 /* --------------------------------------------------------------------- */
101 static struct net_device
*baycom_device
[NR_PORTS
];
103 /* --------------------------------------------------------------------- */
105 #define RBR(iobase) (iobase+0)
106 #define THR(iobase) (iobase+0)
107 #define IER(iobase) (iobase+1)
108 #define IIR(iobase) (iobase+2)
109 #define FCR(iobase) (iobase+2)
110 #define LCR(iobase) (iobase+3)
111 #define MCR(iobase) (iobase+4)
112 #define LSR(iobase) (iobase+5)
113 #define MSR(iobase) (iobase+6)
114 #define SCR(iobase) (iobase+7)
115 #define DLL(iobase) (iobase+0)
116 #define DLM(iobase) (iobase+1)
118 #define SER12_EXTENT 8
120 /* ---------------------------------------------------------------------- */
122 * Information that need to be kept for each board.
125 struct baycom_state
{
126 struct hdlcdrv_state hdrv
;
128 unsigned int baud
, baud_us
, baud_arbdiv
, baud_uartdiv
, baud_dcdtimeout
;
135 struct modem_state_ser12
{
136 unsigned char tx_bit
;
137 unsigned char last_rxbit
;
138 int dcd_sum0
, dcd_sum1
, dcd_sum2
;
140 unsigned int pll_time
;
141 unsigned int txshreg
;
147 unsigned long last_jiffies
;
149 unsigned last_intcnt
;
153 #endif /* BAYCOM_DEBUG */
156 /* --------------------------------------------------------------------- */
158 static inline void baycom_int_freq(struct baycom_state
*bc
)
161 unsigned long cur_jiffies
= jiffies
;
163 * measure the interrupt frequency
165 bc
->debug_vals
.cur_intcnt
++;
166 if (time_after_eq(cur_jiffies
, bc
->debug_vals
.last_jiffies
+ HZ
)) {
167 bc
->debug_vals
.last_jiffies
= cur_jiffies
;
168 bc
->debug_vals
.last_intcnt
= bc
->debug_vals
.cur_intcnt
;
169 bc
->debug_vals
.cur_intcnt
= 0;
170 bc
->debug_vals
.last_pllcorr
= bc
->debug_vals
.cur_pllcorr
;
171 bc
->debug_vals
.cur_pllcorr
= 0;
173 #endif /* BAYCOM_DEBUG */
176 /* --------------------------------------------------------------------- */
178 * ===================== SER12 specific routines =========================
181 /* --------------------------------------------------------------------- */
183 static inline void ser12_set_divisor(struct net_device
*dev
,
184 unsigned int divisor
)
186 outb(0x81, LCR(dev
->base_addr
)); /* DLAB = 1 */
187 outb(divisor
, DLL(dev
->base_addr
));
188 outb(divisor
>> 8, DLM(dev
->base_addr
));
189 outb(0x01, LCR(dev
->base_addr
)); /* word length = 6 */
191 * make sure the next interrupt is generated;
192 * 0 must be used to power the modem; the modem draws its
193 * power from the TxD line
195 outb(0x00, THR(dev
->base_addr
));
197 * it is important not to set the divider while transmitting;
198 * this reportedly makes some UARTs generating interrupts
199 * in the hundredthousands per second region
200 * Reported by: Ignacio.Arenaza@studi.epfl.ch (Ignacio Arenaza Nuno)
204 /* --------------------------------------------------------------------- */
207 /* --------------------------------------------------------------------- */
209 static __inline__
void ser12_rx(struct net_device
*dev
, struct baycom_state
*bc
, struct timeval
*tv
, unsigned char curs
)
212 int bdus8
= bc
->baud_us
>> 3;
213 int bdus4
= bc
->baud_us
>> 2;
214 int bdus2
= bc
->baud_us
>> 1;
216 timediff
= 1000000 + tv
->tv_usec
- bc
->modem
.ser12
.pll_time
;
217 while (timediff
>= 500000)
219 while (timediff
>= bdus2
) {
220 timediff
-= bc
->baud_us
;
221 bc
->modem
.ser12
.pll_time
+= bc
->baud_us
;
222 bc
->modem
.ser12
.dcd_time
--;
223 /* first check if there is room to add a bit */
224 if (bc
->modem
.shreg
& 1) {
225 hdlcdrv_putbits(&bc
->hdrv
, (bc
->modem
.shreg
>> 1) ^ 0xffff);
226 bc
->modem
.shreg
= 0x10000;
229 bc
->modem
.shreg
>>= 1;
231 if (bc
->modem
.ser12
.dcd_time
<= 0) {
233 hdlcdrv_setdcd(&bc
->hdrv
, (bc
->modem
.ser12
.dcd_sum0
+
234 bc
->modem
.ser12
.dcd_sum1
+
235 bc
->modem
.ser12
.dcd_sum2
) < 0);
236 bc
->modem
.ser12
.dcd_sum2
= bc
->modem
.ser12
.dcd_sum1
;
237 bc
->modem
.ser12
.dcd_sum1
= bc
->modem
.ser12
.dcd_sum0
;
238 bc
->modem
.ser12
.dcd_sum0
= 2; /* slight bias */
239 bc
->modem
.ser12
.dcd_time
+= 120;
241 if (bc
->modem
.ser12
.last_rxbit
!= curs
) {
242 bc
->modem
.ser12
.last_rxbit
= curs
;
243 bc
->modem
.shreg
|= 0x10000;
246 bc
->modem
.ser12
.pll_time
+= bdus8
;
248 bc
->modem
.ser12
.pll_time
+= 1000000 - bdus8
;
250 if (abs(timediff
) > bdus4
)
251 bc
->modem
.ser12
.dcd_sum0
+= 4;
253 bc
->modem
.ser12
.dcd_sum0
--;
255 bc
->debug_vals
.cur_pllcorr
= timediff
;
256 #endif /* BAYCOM_DEBUG */
258 while (bc
->modem
.ser12
.pll_time
>= 1000000)
259 bc
->modem
.ser12
.pll_time
-= 1000000;
262 /* --------------------------------------------------------------------- */
264 static irqreturn_t
ser12_interrupt(int irq
, void *dev_id
)
266 struct net_device
*dev
= (struct net_device
*)dev_id
;
267 struct baycom_state
*bc
= netdev_priv(dev
);
269 unsigned char iir
, msr
;
270 unsigned int txcount
= 0;
272 if (!bc
|| bc
->hdrv
.magic
!= HDLCDRV_MAGIC
)
274 /* fast way out for shared irq */
275 if ((iir
= inb(IIR(dev
->base_addr
))) & 1)
277 /* get current time */
278 do_gettimeofday(&tv
);
279 msr
= inb(MSR(dev
->base_addr
));
281 if ((msr
& 8) && bc
->opt_dcd
)
282 hdlcdrv_setdcd(&bc
->hdrv
, !((msr
^ bc
->opt_dcd
) & 0x80));
286 inb(LSR(dev
->base_addr
));
290 inb(RBR(dev
->base_addr
));
295 * make sure the next interrupt is generated;
296 * 0 must be used to power the modem; the modem draws its
297 * power from the TxD line
299 outb(0x00, THR(dev
->base_addr
));
303 * first output the last bit (!) then call HDLC transmitter,
304 * since this may take quite long
307 outb(0x0e | (!!bc
->modem
.ser12
.tx_bit
), MCR(dev
->base_addr
));
309 outb(0x0d, MCR(dev
->base_addr
)); /* transmitter off */
313 msr
= inb(MSR(dev
->base_addr
));
315 if ((msr
& 8) && bc
->opt_dcd
)
316 hdlcdrv_setdcd(&bc
->hdrv
, !((msr
^ bc
->opt_dcd
) & 0x80));
319 iir
= inb(IIR(dev
->base_addr
));
320 } while (!(iir
& 1));
321 ser12_rx(dev
, bc
, &tv
, msr
& 0x10); /* CTS */
322 if (bc
->modem
.ptt
&& txcount
) {
323 if (bc
->modem
.ser12
.txshreg
<= 1) {
324 bc
->modem
.ser12
.txshreg
= 0x10000 | hdlcdrv_getbits(&bc
->hdrv
);
325 if (!hdlcdrv_ptt(&bc
->hdrv
)) {
326 ser12_set_divisor(dev
, 115200/100/8);
331 bc
->modem
.ser12
.tx_bit
= !(bc
->modem
.ser12
.tx_bit
^ (bc
->modem
.ser12
.txshreg
& 1));
332 bc
->modem
.ser12
.txshreg
>>= 1;
336 if (!bc
->modem
.ptt
&& txcount
) {
337 hdlcdrv_arbitrate(dev
, &bc
->hdrv
);
338 if (hdlcdrv_ptt(&bc
->hdrv
)) {
339 ser12_set_divisor(dev
, bc
->baud_uartdiv
);
340 bc
->modem
.ser12
.txshreg
= 1;
344 hdlcdrv_transmitter(dev
, &bc
->hdrv
);
345 hdlcdrv_receiver(dev
, &bc
->hdrv
);
350 /* --------------------------------------------------------------------- */
352 enum uart
{ c_uart_unknown
, c_uart_8250
,
353 c_uart_16450
, c_uart_16550
, c_uart_16550A
};
354 static const char *uart_str
[] = {
355 "unknown", "8250", "16450", "16550", "16550A"
358 static enum uart
ser12_check_uart(unsigned int iobase
)
360 unsigned char b1
,b2
,b3
;
362 enum uart uart_tab
[] =
363 { c_uart_16450
, c_uart_unknown
, c_uart_16550
, c_uart_16550A
};
365 b1
= inb(MCR(iobase
));
366 outb(b1
| 0x10, MCR(iobase
)); /* loopback mode */
367 b2
= inb(MSR(iobase
));
368 outb(0x1a, MCR(iobase
));
369 b3
= inb(MSR(iobase
)) & 0xf0;
370 outb(b1
, MCR(iobase
)); /* restore old values */
371 outb(b2
, MSR(iobase
));
373 return c_uart_unknown
;
376 outb(0x01, FCR(iobase
)); /* enable FIFOs */
377 u
= uart_tab
[(inb(IIR(iobase
)) >> 6) & 3];
378 if (u
== c_uart_16450
) {
379 outb(0x5a, SCR(iobase
));
380 b1
= inb(SCR(iobase
));
381 outb(0xa5, SCR(iobase
));
382 b2
= inb(SCR(iobase
));
383 if ((b1
!= 0x5a) || (b2
!= 0xa5))
389 /* --------------------------------------------------------------------- */
391 static int ser12_open(struct net_device
*dev
)
393 struct baycom_state
*bc
= netdev_priv(dev
);
398 if (!dev
->base_addr
|| dev
->base_addr
> 0xffff-SER12_EXTENT
||
399 dev
->irq
< 2 || dev
->irq
> nr_irqs
) {
400 printk(KERN_INFO
"baycom_ser_fdx: invalid portnumber (max %u) "
401 "or irq (2 <= irq <= %d)\n",
402 0xffff-SER12_EXTENT
, nr_irqs
);
405 if (bc
->baud
< 300 || bc
->baud
> 4800) {
406 printk(KERN_INFO
"baycom_ser_fdx: invalid baudrate "
410 if (!request_region(dev
->base_addr
, SER12_EXTENT
, "baycom_ser_fdx")) {
411 printk(KERN_WARNING
"BAYCOM_SER_FSX: I/O port 0x%04lx busy\n",
415 memset(&bc
->modem
, 0, sizeof(bc
->modem
));
416 bc
->hdrv
.par
.bitrate
= bc
->baud
;
417 bc
->baud_us
= 1000000/bc
->baud
;
418 bc
->baud_uartdiv
= (115200/8)/bc
->baud
;
419 if ((u
= ser12_check_uart(dev
->base_addr
)) == c_uart_unknown
){
420 release_region(dev
->base_addr
, SER12_EXTENT
);
423 outb(0, FCR(dev
->base_addr
)); /* disable FIFOs */
424 outb(0x0d, MCR(dev
->base_addr
));
425 outb(0, IER(dev
->base_addr
));
426 if (request_irq(dev
->irq
, ser12_interrupt
, IRQF_DISABLED
| IRQF_SHARED
,
427 "baycom_ser_fdx", dev
)) {
428 release_region(dev
->base_addr
, SER12_EXTENT
);
432 * set the SIO to 6 Bits/character; during receive,
433 * the baud rate is set to produce 100 ints/sec
434 * to feed the channel arbitration process,
435 * during transmit to baud ints/sec to run
438 ser12_set_divisor(dev
, 115200/100/8);
440 * enable transmitter empty interrupt and modem status interrupt
442 outb(0x0a, IER(dev
->base_addr
));
444 * make sure the next interrupt is generated;
445 * 0 must be used to power the modem; the modem draws its
446 * power from the TxD line
448 outb(0x00, THR(dev
->base_addr
));
449 hdlcdrv_setdcd(&bc
->hdrv
, 0);
450 printk(KERN_INFO
"%s: ser_fdx at iobase 0x%lx irq %u baud %u uart %s\n",
451 bc_drvname
, dev
->base_addr
, dev
->irq
, bc
->baud
, uart_str
[u
]);
455 /* --------------------------------------------------------------------- */
457 static int ser12_close(struct net_device
*dev
)
459 struct baycom_state
*bc
= netdev_priv(dev
);
466 outb(0, IER(dev
->base_addr
));
467 outb(1, MCR(dev
->base_addr
));
468 free_irq(dev
->irq
, dev
);
469 release_region(dev
->base_addr
, SER12_EXTENT
);
470 printk(KERN_INFO
"%s: close ser_fdx at iobase 0x%lx irq %u\n",
471 bc_drvname
, dev
->base_addr
, dev
->irq
);
475 /* --------------------------------------------------------------------- */
477 * ===================== hdlcdrv driver interface =========================
480 /* --------------------------------------------------------------------- */
482 static int baycom_ioctl(struct net_device
*dev
, struct ifreq
*ifr
,
483 struct hdlcdrv_ioctl
*hi
, int cmd
);
485 /* --------------------------------------------------------------------- */
487 static struct hdlcdrv_ops ser12_ops
= {
488 .drvname
= bc_drvname
,
489 .drvinfo
= bc_drvinfo
,
491 .close
= ser12_close
,
492 .ioctl
= baycom_ioctl
,
495 /* --------------------------------------------------------------------- */
497 static int baycom_setmode(struct baycom_state
*bc
, const char *modestr
)
501 if (!strncmp(modestr
, "ser", 3)) {
502 baud
= simple_strtoul(modestr
+3, NULL
, 10);
503 if (baud
>= 3 && baud
<= 48)
506 if (strchr(modestr
, '*'))
508 else if (strchr(modestr
, '+'))
515 /* --------------------------------------------------------------------- */
517 static int baycom_ioctl(struct net_device
*dev
, struct ifreq
*ifr
,
518 struct hdlcdrv_ioctl
*hi
, int cmd
)
520 struct baycom_state
*bc
;
521 struct baycom_ioctl bi
;
526 bc
= netdev_priv(dev
);
527 BUG_ON(bc
->hdrv
.magic
!= HDLCDRV_MAGIC
);
529 if (cmd
!= SIOCDEVPRIVATE
)
535 case HDLCDRVCTL_GETMODE
:
536 sprintf(hi
->data
.modename
, "ser%u", bc
->baud
/ 100);
537 if (bc
->opt_dcd
<= 0)
538 strcat(hi
->data
.modename
, (!bc
->opt_dcd
) ? "*" : "+");
539 if (copy_to_user(ifr
->ifr_data
, hi
, sizeof(struct hdlcdrv_ioctl
)))
543 case HDLCDRVCTL_SETMODE
:
544 if (netif_running(dev
) || !capable(CAP_NET_ADMIN
))
546 hi
->data
.modename
[sizeof(hi
->data
.modename
)-1] = '\0';
547 return baycom_setmode(bc
, hi
->data
.modename
);
549 case HDLCDRVCTL_MODELIST
:
550 strcpy(hi
->data
.modename
, "ser12,ser3,ser24");
551 if (copy_to_user(ifr
->ifr_data
, hi
, sizeof(struct hdlcdrv_ioctl
)))
555 case HDLCDRVCTL_MODEMPARMASK
:
556 return HDLCDRV_PARMASK_IOBASE
| HDLCDRV_PARMASK_IRQ
;
560 if (copy_from_user(&bi
, ifr
->ifr_data
, sizeof(bi
)))
567 case BAYCOMCTL_GETDEBUG
:
568 bi
.data
.dbg
.debug1
= bc
->hdrv
.ptt_keyed
;
569 bi
.data
.dbg
.debug2
= bc
->debug_vals
.last_intcnt
;
570 bi
.data
.dbg
.debug3
= bc
->debug_vals
.last_pllcorr
;
572 #endif /* BAYCOM_DEBUG */
575 if (copy_to_user(ifr
->ifr_data
, &bi
, sizeof(bi
)))
581 /* --------------------------------------------------------------------- */
584 * command line settable parameters
586 static char *mode
[NR_PORTS
] = { "ser12*", };
587 static int iobase
[NR_PORTS
] = { 0x3f8, };
588 static int irq
[NR_PORTS
] = { 4, };
589 static int baud
[NR_PORTS
] = { [0 ... NR_PORTS
-1] = 1200 };
591 module_param_array(mode
, charp
, NULL
, 0);
592 MODULE_PARM_DESC(mode
, "baycom operating mode; * for software DCD");
593 module_param_array(iobase
, int, NULL
, 0);
594 MODULE_PARM_DESC(iobase
, "baycom io base address");
595 module_param_array(irq
, int, NULL
, 0);
596 MODULE_PARM_DESC(irq
, "baycom irq number");
597 module_param_array(baud
, int, NULL
, 0);
598 MODULE_PARM_DESC(baud
, "baycom baud rate (300 to 4800)");
600 MODULE_AUTHOR("Thomas M. Sailer, sailer@ife.ee.ethz.ch, hb9jnx@hb9w.che.eu");
601 MODULE_DESCRIPTION("Baycom ser12 full duplex amateur radio modem driver");
602 MODULE_LICENSE("GPL");
604 /* --------------------------------------------------------------------- */
606 static int __init
init_baycomserfdx(void)
613 * register net devices
615 for (i
= 0; i
< NR_PORTS
; i
++) {
616 struct net_device
*dev
;
617 struct baycom_state
*bc
;
618 char ifname
[IFNAMSIZ
];
620 sprintf(ifname
, "bcsf%d", i
);
625 iobase
[i
] = irq
[i
] = 0;
627 dev
= hdlcdrv_register(&ser12_ops
,
628 sizeof(struct baycom_state
),
629 ifname
, iobase
[i
], irq
[i
], 0);
633 bc
= netdev_priv(dev
);
634 if (set_hw
&& baycom_setmode(bc
, mode
[i
]))
638 baycom_device
[i
] = dev
;
646 static void __exit
cleanup_baycomserfdx(void)
650 for(i
= 0; i
< NR_PORTS
; i
++) {
651 struct net_device
*dev
= baycom_device
[i
];
653 hdlcdrv_unregister(dev
);
657 module_init(init_baycomserfdx
);
658 module_exit(cleanup_baycomserfdx
);
660 /* --------------------------------------------------------------------- */
665 * format: baycom_ser_fdx=io,irq,mode
666 * mode: ser# hardware DCD
668 * ser#+ hardware DCD, inverted signal at DCD pin
669 * '#' denotes the baud rate / 100, eg. ser12* is '1200 baud, soft DCD'
672 static int __init
baycom_ser_fdx_setup(char *str
)
674 static unsigned nr_dev
;
677 if (nr_dev
>= NR_PORTS
)
679 str
= get_options(str
, 4, ints
);
683 iobase
[nr_dev
] = ints
[1];
684 irq
[nr_dev
] = ints
[2];
686 baud
[nr_dev
] = ints
[3];
691 __setup("baycom_ser_fdx=", baycom_ser_fdx_setup
);
694 /* --------------------------------------------------------------------- */