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 contignuous 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/module.h>
75 #include <linux/ioport.h>
76 #include <linux/string.h>
77 #include <linux/init.h>
78 #include <asm/uaccess.h>
80 #include <linux/hdlcdrv.h>
81 #include <linux/baycom.h>
83 /* --------------------------------------------------------------------- */
87 /* --------------------------------------------------------------------- */
89 static const char bc_drvname[] = "baycom_ser_fdx";
90 static const char bc_drvinfo[] = KERN_INFO "baycom_ser_fdx: (C) 1996-2000 Thomas Sailer, HB9JNX/AE4WA\n"
91 KERN_INFO "baycom_ser_fdx: version 0.10 compiled " __TIME__ " " __DATE__ "\n";
93 /* --------------------------------------------------------------------- */
97 static struct net_device *baycom_device[NR_PORTS];
99 /* --------------------------------------------------------------------- */
101 #define RBR(iobase) (iobase+0)
102 #define THR(iobase) (iobase+0)
103 #define IER(iobase) (iobase+1)
104 #define IIR(iobase) (iobase+2)
105 #define FCR(iobase) (iobase+2)
106 #define LCR(iobase) (iobase+3)
107 #define MCR(iobase) (iobase+4)
108 #define LSR(iobase) (iobase+5)
109 #define MSR(iobase) (iobase+6)
110 #define SCR(iobase) (iobase+7)
111 #define DLL(iobase) (iobase+0)
112 #define DLM(iobase) (iobase+1)
114 #define SER12_EXTENT 8
116 /* ---------------------------------------------------------------------- */
118 * Information that need to be kept for each board.
121 struct baycom_state {
122 struct hdlcdrv_state hdrv;
124 unsigned int baud, baud_us, baud_arbdiv, baud_uartdiv, baud_dcdtimeout;
131 struct modem_state_ser12 {
132 unsigned char tx_bit;
133 unsigned char last_rxbit;
134 int dcd_sum0, dcd_sum1, dcd_sum2;
136 unsigned int pll_time;
137 unsigned int txshreg;
143 unsigned long last_jiffies;
145 unsigned last_intcnt;
149 #endif /* BAYCOM_DEBUG */
152 /* --------------------------------------------------------------------- */
154 static inline void baycom_int_freq(struct baycom_state *bc)
157 unsigned long cur_jiffies = jiffies;
159 * measure the interrupt frequency
161 bc->debug_vals.cur_intcnt++;
162 if ((cur_jiffies - bc->debug_vals.last_jiffies) >= HZ) {
163 bc->debug_vals.last_jiffies = cur_jiffies;
164 bc->debug_vals.last_intcnt = bc->debug_vals.cur_intcnt;
165 bc->debug_vals.cur_intcnt = 0;
166 bc->debug_vals.last_pllcorr = bc->debug_vals.cur_pllcorr;
167 bc->debug_vals.cur_pllcorr = 0;
169 #endif /* BAYCOM_DEBUG */
172 /* --------------------------------------------------------------------- */
174 * ===================== SER12 specific routines =========================
177 /* --------------------------------------------------------------------- */
179 static inline void ser12_set_divisor(struct net_device *dev,
180 unsigned int divisor)
182 outb(0x81, LCR(dev->base_addr)); /* DLAB = 1 */
183 outb(divisor, DLL(dev->base_addr));
184 outb(divisor >> 8, DLM(dev->base_addr));
185 outb(0x01, LCR(dev->base_addr)); /* word length = 6 */
187 * make sure the next interrupt is generated;
188 * 0 must be used to power the modem; the modem draws its
189 * power from the TxD line
191 outb(0x00, THR(dev->base_addr));
193 * it is important not to set the divider while transmitting;
194 * this reportedly makes some UARTs generating interrupts
195 * in the hundredthousands per second region
196 * Reported by: Ignacio.Arenaza@studi.epfl.ch (Ignacio Arenaza Nuno)
200 /* --------------------------------------------------------------------- */
203 static inline unsigned int hweight16(unsigned int w)
204 __attribute__ ((unused));
205 static inline unsigned int hweight8(unsigned int w)
206 __attribute__ ((unused));
208 static inline unsigned int hweight16(unsigned int w)
210 unsigned short res = (w & 0x5555) + ((w >> 1) & 0x5555);
211 res = (res & 0x3333) + ((res >> 2) & 0x3333);
212 res = (res & 0x0F0F) + ((res >> 4) & 0x0F0F);
213 return (res & 0x00FF) + ((res >> 8) & 0x00FF);
216 static inline unsigned int hweight8(unsigned int w)
218 unsigned short res = (w & 0x55) + ((w >> 1) & 0x55);
219 res = (res & 0x33) + ((res >> 2) & 0x33);
220 return (res & 0x0F) + ((res >> 4) & 0x0F);
224 /* --------------------------------------------------------------------- */
226 static __inline__ void ser12_rx(struct net_device *dev, struct baycom_state *bc, struct timeval *tv, unsigned char curs)
229 int bdus8 = bc->baud_us >> 3;
230 int bdus4 = bc->baud_us >> 2;
231 int bdus2 = bc->baud_us >> 1;
233 timediff = 1000000 + tv->tv_usec - bc->modem.ser12.pll_time;
234 while (timediff >= 500000)
236 while (timediff >= bdus2) {
237 timediff -= bc->baud_us;
238 bc->modem.ser12.pll_time += bc->baud_us;
239 bc->modem.ser12.dcd_time--;
240 /* first check if there is room to add a bit */
241 if (bc->modem.shreg & 1) {
242 hdlcdrv_putbits(&bc->hdrv, (bc->modem.shreg >> 1) ^ 0xffff);
243 bc->modem.shreg = 0x10000;
246 bc->modem.shreg >>= 1;
248 if (bc->modem.ser12.dcd_time <= 0) {
250 hdlcdrv_setdcd(&bc->hdrv, (bc->modem.ser12.dcd_sum0 +
251 bc->modem.ser12.dcd_sum1 +
252 bc->modem.ser12.dcd_sum2) < 0);
253 bc->modem.ser12.dcd_sum2 = bc->modem.ser12.dcd_sum1;
254 bc->modem.ser12.dcd_sum1 = bc->modem.ser12.dcd_sum0;
255 bc->modem.ser12.dcd_sum0 = 2; /* slight bias */
256 bc->modem.ser12.dcd_time += 120;
258 if (bc->modem.ser12.last_rxbit != curs) {
259 bc->modem.ser12.last_rxbit = curs;
260 bc->modem.shreg |= 0x10000;
263 bc->modem.ser12.pll_time += bdus8;
265 bc->modem.ser12.pll_time += 1000000 - bdus8;
267 if (abs(timediff) > bdus4)
268 bc->modem.ser12.dcd_sum0 += 4;
270 bc->modem.ser12.dcd_sum0--;
272 bc->debug_vals.cur_pllcorr = timediff;
273 #endif /* BAYCOM_DEBUG */
275 while (bc->modem.ser12.pll_time >= 1000000)
276 bc->modem.ser12.pll_time -= 1000000;
279 /* --------------------------------------------------------------------- */
281 static irqreturn_t ser12_interrupt(int irq, void *dev_id, struct pt_regs *regs)
283 struct net_device *dev = (struct net_device *)dev_id;
284 struct baycom_state *bc = netdev_priv(dev);
286 unsigned char iir, msr;
287 unsigned int txcount = 0;
289 if (!bc || bc->hdrv.magic != HDLCDRV_MAGIC)
291 /* fast way out for shared irq */
292 if ((iir = inb(IIR(dev->base_addr))) & 1)
294 /* get current time */
295 do_gettimeofday(&tv);
296 msr = inb(MSR(dev->base_addr));
298 if ((msr & 8) && bc->opt_dcd)
299 hdlcdrv_setdcd(&bc->hdrv, !((msr ^ bc->opt_dcd) & 0x80));
303 inb(LSR(dev->base_addr));
307 inb(RBR(dev->base_addr));
312 * make sure the next interrupt is generated;
313 * 0 must be used to power the modem; the modem draws its
314 * power from the TxD line
316 outb(0x00, THR(dev->base_addr));
320 * first output the last bit (!) then call HDLC transmitter,
321 * since this may take quite long
324 outb(0x0e | (!!bc->modem.ser12.tx_bit), MCR(dev->base_addr));
326 outb(0x0d, MCR(dev->base_addr)); /* transmitter off */
330 msr = inb(MSR(dev->base_addr));
332 if ((msr & 8) && bc->opt_dcd)
333 hdlcdrv_setdcd(&bc->hdrv, !((msr ^ bc->opt_dcd) & 0x80));
336 iir = inb(IIR(dev->base_addr));
337 } while (!(iir & 1));
338 ser12_rx(dev, bc, &tv, msr & 0x10); /* CTS */
339 if (bc->modem.ptt && txcount) {
340 if (bc->modem.ser12.txshreg <= 1) {
341 bc->modem.ser12.txshreg = 0x10000 | hdlcdrv_getbits(&bc->hdrv);
342 if (!hdlcdrv_ptt(&bc->hdrv)) {
343 ser12_set_divisor(dev, 115200/100/8);
348 bc->modem.ser12.tx_bit = !(bc->modem.ser12.tx_bit ^ (bc->modem.ser12.txshreg & 1));
349 bc->modem.ser12.txshreg >>= 1;
353 if (!bc->modem.ptt && txcount) {
354 hdlcdrv_arbitrate(dev, &bc->hdrv);
355 if (hdlcdrv_ptt(&bc->hdrv)) {
356 ser12_set_divisor(dev, bc->baud_uartdiv);
357 bc->modem.ser12.txshreg = 1;
361 hdlcdrv_transmitter(dev, &bc->hdrv);
362 hdlcdrv_receiver(dev, &bc->hdrv);
367 /* --------------------------------------------------------------------- */
369 enum uart { c_uart_unknown, c_uart_8250,
370 c_uart_16450, c_uart_16550, c_uart_16550A};
371 static const char *uart_str[] = {
372 "unknown", "8250", "16450", "16550", "16550A"
375 static enum uart ser12_check_uart(unsigned int iobase)
377 unsigned char b1,b2,b3;
379 enum uart uart_tab[] =
380 { c_uart_16450, c_uart_unknown, c_uart_16550, c_uart_16550A };
382 b1 = inb(MCR(iobase));
383 outb(b1 | 0x10, MCR(iobase)); /* loopback mode */
384 b2 = inb(MSR(iobase));
385 outb(0x1a, MCR(iobase));
386 b3 = inb(MSR(iobase)) & 0xf0;
387 outb(b1, MCR(iobase)); /* restore old values */
388 outb(b2, MSR(iobase));
390 return c_uart_unknown;
393 outb(0x01, FCR(iobase)); /* enable FIFOs */
394 u = uart_tab[(inb(IIR(iobase)) >> 6) & 3];
395 if (u == c_uart_16450) {
396 outb(0x5a, SCR(iobase));
397 b1 = inb(SCR(iobase));
398 outb(0xa5, SCR(iobase));
399 b2 = inb(SCR(iobase));
400 if ((b1 != 0x5a) || (b2 != 0xa5))
406 /* --------------------------------------------------------------------- */
408 static int ser12_open(struct net_device *dev)
410 struct baycom_state *bc = netdev_priv(dev);
415 if (!dev->base_addr || dev->base_addr > 0x1000-SER12_EXTENT ||
416 dev->irq < 2 || dev->irq > 15)
418 if (bc->baud < 300 || bc->baud > 4800)
420 if (!request_region(dev->base_addr, SER12_EXTENT, "baycom_ser_fdx")) {
421 printk(KERN_WARNING "BAYCOM_SER_FSX: I/O port 0x%04lx busy \n",
425 memset(&bc->modem, 0, sizeof(bc->modem));
426 bc->hdrv.par.bitrate = bc->baud;
427 bc->baud_us = 1000000/bc->baud;
428 bc->baud_uartdiv = (115200/8)/bc->baud;
429 if ((u = ser12_check_uart(dev->base_addr)) == c_uart_unknown){
430 release_region(dev->base_addr, SER12_EXTENT);
433 outb(0, FCR(dev->base_addr)); /* disable FIFOs */
434 outb(0x0d, MCR(dev->base_addr));
435 outb(0, IER(dev->base_addr));
436 if (request_irq(dev->irq, ser12_interrupt, SA_INTERRUPT | SA_SHIRQ,
437 "baycom_ser_fdx", dev)) {
438 release_region(dev->base_addr, SER12_EXTENT);
442 * set the SIO to 6 Bits/character; during receive,
443 * the baud rate is set to produce 100 ints/sec
444 * to feed the channel arbitration process,
445 * during transmit to baud ints/sec to run
448 ser12_set_divisor(dev, 115200/100/8);
450 * enable transmitter empty interrupt and modem status interrupt
452 outb(0x0a, IER(dev->base_addr));
454 * make sure the next interrupt is generated;
455 * 0 must be used to power the modem; the modem draws its
456 * power from the TxD line
458 outb(0x00, THR(dev->base_addr));
459 hdlcdrv_setdcd(&bc->hdrv, 0);
460 printk(KERN_INFO "%s: ser_fdx at iobase 0x%lx irq %u baud %u uart %s\n",
461 bc_drvname, dev->base_addr, dev->irq, bc->baud, uart_str[u]);
465 /* --------------------------------------------------------------------- */
467 static int ser12_close(struct net_device *dev)
469 struct baycom_state *bc = netdev_priv(dev);
476 outb(0, IER(dev->base_addr));
477 outb(1, MCR(dev->base_addr));
478 free_irq(dev->irq, dev);
479 release_region(dev->base_addr, SER12_EXTENT);
480 printk(KERN_INFO "%s: close ser_fdx at iobase 0x%lx irq %u\n",
481 bc_drvname, dev->base_addr, dev->irq);
485 /* --------------------------------------------------------------------- */
487 * ===================== hdlcdrv driver interface =========================
490 /* --------------------------------------------------------------------- */
492 static int baycom_ioctl(struct net_device *dev, struct ifreq *ifr,
493 struct hdlcdrv_ioctl *hi, int cmd);
495 /* --------------------------------------------------------------------- */
497 static struct hdlcdrv_ops ser12_ops = {
498 .drvname = bc_drvname,
499 .drvinfo = bc_drvinfo,
501 .close = ser12_close,
502 .ioctl = baycom_ioctl,
505 /* --------------------------------------------------------------------- */
507 static int baycom_setmode(struct baycom_state *bc, const char *modestr)
511 if (!strncmp(modestr, "ser", 3)) {
512 baud = simple_strtoul(modestr+3, NULL, 10);
513 if (baud >= 3 && baud <= 48)
516 if (strchr(modestr, '*'))
518 else if (strchr(modestr, '+'))
525 /* --------------------------------------------------------------------- */
527 static int baycom_ioctl(struct net_device *dev, struct ifreq *ifr,
528 struct hdlcdrv_ioctl *hi, int cmd)
530 struct baycom_state *bc;
531 struct baycom_ioctl bi;
536 bc = netdev_priv(dev);
537 BUG_ON(bc->hdrv.magic != HDLCDRV_MAGIC);
539 if (cmd != SIOCDEVPRIVATE)
545 case HDLCDRVCTL_GETMODE:
546 sprintf(hi->data.modename, "ser%u", bc->baud / 100);
547 if (bc->opt_dcd <= 0)
548 strcat(hi->data.modename, (!bc->opt_dcd) ? "*" : "+");
549 if (copy_to_user(ifr->ifr_data, hi, sizeof(struct hdlcdrv_ioctl)))
553 case HDLCDRVCTL_SETMODE:
554 if (netif_running(dev) || !capable(CAP_NET_ADMIN))
556 hi->data.modename[sizeof(hi->data.modename)-1] = '\0';
557 return baycom_setmode(bc, hi->data.modename);
559 case HDLCDRVCTL_MODELIST:
560 strcpy(hi->data.modename, "ser12,ser3,ser24");
561 if (copy_to_user(ifr->ifr_data, hi, sizeof(struct hdlcdrv_ioctl)))
565 case HDLCDRVCTL_MODEMPARMASK:
566 return HDLCDRV_PARMASK_IOBASE | HDLCDRV_PARMASK_IRQ;
570 if (copy_from_user(&bi, ifr->ifr_data, sizeof(bi)))
577 case BAYCOMCTL_GETDEBUG:
578 bi.data.dbg.debug1 = bc->hdrv.ptt_keyed;
579 bi.data.dbg.debug2 = bc->debug_vals.last_intcnt;
580 bi.data.dbg.debug3 = bc->debug_vals.last_pllcorr;
582 #endif /* BAYCOM_DEBUG */
585 if (copy_to_user(ifr->ifr_data, &bi, sizeof(bi)))
591 /* --------------------------------------------------------------------- */
594 * command line settable parameters
596 static char *mode[NR_PORTS] = { "ser12*", };
597 static int iobase[NR_PORTS] = { 0x3f8, };
598 static int irq[NR_PORTS] = { 4, };
599 static int baud[NR_PORTS] = { [0 ... NR_PORTS-1] = 1200 };
601 module_param_array(mode, charp, NULL, 0);
602 MODULE_PARM_DESC(mode, "baycom operating mode; * for software DCD");
603 module_param_array(iobase, int, NULL, 0);
604 MODULE_PARM_DESC(iobase, "baycom io base address");
605 module_param_array(irq, int, NULL, 0);
606 MODULE_PARM_DESC(irq, "baycom irq number");
607 module_param_array(baud, int, NULL, 0);
608 MODULE_PARM_DESC(baud, "baycom baud rate (300 to 4800)");
610 MODULE_AUTHOR("Thomas M. Sailer, sailer@ife.ee.ethz.ch, hb9jnx@hb9w.che.eu");
611 MODULE_DESCRIPTION("Baycom ser12 full duplex amateur radio modem driver");
612 MODULE_LICENSE("GPL");
614 /* --------------------------------------------------------------------- */
616 static int __init init_baycomserfdx(void)
623 * register net devices
625 for (i = 0; i < NR_PORTS; i++) {
626 struct net_device *dev;
627 struct baycom_state *bc;
628 char ifname[IFNAMSIZ];
630 sprintf(ifname, "bcsf%d", i);
635 iobase[i] = irq[i] = 0;
637 dev = hdlcdrv_register(&ser12_ops,
638 sizeof(struct baycom_state),
639 ifname, iobase[i], irq[i], 0);
643 bc = netdev_priv(dev);
644 if (set_hw && baycom_setmode(bc, mode[i]))
648 baycom_device[i] = dev;
656 static void __exit cleanup_baycomserfdx(void)
660 for(i = 0; i < NR_PORTS; i++) {
661 struct net_device *dev = baycom_device[i];
663 hdlcdrv_unregister(dev);
667 module_init(init_baycomserfdx);
668 module_exit(cleanup_baycomserfdx);
670 /* --------------------------------------------------------------------- */
675 * format: baycom_ser_fdx=io,irq,mode
676 * mode: ser# hardware DCD
678 * ser#+ hardware DCD, inverted signal at DCD pin
679 * '#' denotes the baud rate / 100, eg. ser12* is '1200 baud, soft DCD'
682 static int __init baycom_ser_fdx_setup(char *str)
684 static unsigned nr_dev;
687 if (nr_dev >= NR_PORTS)
689 str = get_options(str, 4, ints);
693 iobase[nr_dev] = ints[1];
694 irq[nr_dev] = ints[2];
696 baud[nr_dev] = ints[3];
701 __setup("baycom_ser_fdx=", baycom_ser_fdx_setup);
704 /* --------------------------------------------------------------------- */