Revert "[PATCH] paravirt: Add startup infrastructure for paravirtualization"
[pv_ops_mirror.git] / drivers / net / hamradio / scc.c
blob6fdaad5a457750e21adaad56dd185d928c4a92b2
1 #define RCS_ID "$Id: scc.c,v 1.75 1998/11/04 15:15:01 jreuter Exp jreuter $"
3 #define VERSION "3.0"
5 /*
6 * Please use z8530drv-utils-3.0 with this version.
7 * ------------------
9 * You can find a subset of the documentation in
10 * Documentation/networking/z8530drv.txt.
14 ********************************************************************
15 * SCC.C - Linux driver for Z8530 based HDLC cards for AX.25 *
16 ********************************************************************
19 ********************************************************************
21 Copyright (c) 1993, 2000 Joerg Reuter DL1BKE
23 portions (c) 1993 Guido ten Dolle PE1NNZ
25 ********************************************************************
27 The driver and the programs in the archive are UNDER CONSTRUCTION.
28 The code is likely to fail, and so your kernel could --- even
29 a whole network.
31 This driver is intended for Amateur Radio use. If you are running it
32 for commercial purposes, please drop me a note. I am nosy...
34 ...BUT:
36 ! You m u s t recognize the appropriate legislations of your country !
37 ! before you connect a radio to the SCC board and start to transmit or !
38 ! receive. The GPL allows you to use the d r i v e r, NOT the RADIO! !
40 For non-Amateur-Radio use please note that you might need a special
41 allowance/licence from the designer of the SCC Board and/or the
42 MODEM.
44 This program is free software; you can redistribute it and/or modify
45 it under the terms of the (modified) GNU General Public License
46 delivered with the Linux kernel source.
48 This program is distributed in the hope that it will be useful,
49 but WITHOUT ANY WARRANTY; without even the implied warranty of
50 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
51 GNU General Public License for more details.
53 You should find a copy of the GNU General Public License in
54 /usr/src/linux/COPYING;
56 ********************************************************************
59 Incomplete history of z8530drv:
60 -------------------------------
62 1994-09-13 started to write the driver, rescued most of my own
63 code (and Hans Alblas' memory buffer pool concept) from
64 an earlier project "sccdrv" which was initiated by
65 Guido ten Dolle. Not much of the old driver survived,
66 though. The first version I put my hands on was sccdrv1.3
67 from August 1993. The memory buffer pool concept
68 appeared in an unauthorized sccdrv version (1.5) from
69 August 1994.
71 1995-01-31 changed copyright notice to GPL without limitations.
74 . <SNIP>
77 1996-10-05 New semester, new driver...
79 * KISS TNC emulator removed (TTY driver)
80 * Source moved to drivers/net/
81 * Includes Z8530 defines from drivers/net/z8530.h
82 * Uses sk_buffer memory management
83 * Reduced overhead of /proc/net/z8530drv output
84 * Streamlined quite a lot things
85 * Invents brand new bugs... ;-)
87 The move to version number 3.0 reflects theses changes.
88 You can use 'kissbridge' if you need a KISS TNC emulator.
90 1996-12-13 Fixed for Linux networking changes. (G4KLX)
91 1997-01-08 Fixed the remaining problems.
92 1997-04-02 Hopefully fixed the problems with the new *_timer()
93 routines, added calibration code.
94 1997-10-12 Made SCC_DELAY a CONFIG option, added CONFIG_SCC_TRXECHO
95 1998-01-29 Small fix to avoid lock-up on initialization
96 1998-09-29 Fixed the "grouping" bugs, tx_inhibit works again,
97 using dev->tx_queue_len now instead of MAXQUEUE now.
98 1998-10-21 Postponed the spinlock changes, would need a lot of
99 testing I currently don't have the time to. Softdcd doesn't
100 work.
101 1998-11-04 Softdcd does not work correctly in DPLL mode, in fact it
102 never did. The DPLL locks on noise, the SYNC unit sees
103 flags that aren't... Restarting the DPLL does not help
104 either, it resynchronizes too slow and the first received
105 frame gets lost.
106 2000-02-13 Fixed for new network driver interface changes, still
107 does TX timeouts itself since it uses its own queue
108 scheme.
110 Thanks to all who contributed to this driver with ideas and bug
111 reports!
113 NB -- if you find errors, change something, please let me know
114 first before you distribute it... And please don't touch
115 the version number. Just replace my callsign in
116 "v3.0.dl1bke" with your own. Just to avoid confusion...
118 If you want to add your modification to the linux distribution
119 please (!) contact me first.
121 New versions of the driver will be announced on the linux-hams
122 mailing list on vger.kernel.org. To subscribe send an e-mail
123 to majordomo@vger.kernel.org with the following line in
124 the body of the mail:
126 subscribe linux-hams
128 The content of the "Subject" field will be ignored.
130 vy 73,
131 Joerg Reuter ampr-net: dl1bke@db0pra.ampr.org
132 AX-25 : DL1BKE @ DB0ABH.#BAY.DEU.EU
133 Internet: jreuter@yaina.de
134 www : http://yaina.de/jreuter
137 /* ----------------------------------------------------------------------- */
139 #undef SCC_LDELAY /* slow it even a bit more down */
140 #undef SCC_DONT_CHECK /* don't look if the SCCs you specified are available */
142 #define SCC_MAXCHIPS 4 /* number of max. supported chips */
143 #define SCC_BUFSIZE 384 /* must not exceed 4096 */
144 #undef SCC_DEBUG
146 #define SCC_DEFAULT_CLOCK 4915200
147 /* default pclock if nothing is specified */
149 /* ----------------------------------------------------------------------- */
151 #include <linux/module.h>
152 #include <linux/errno.h>
153 #include <linux/signal.h>
154 #include <linux/timer.h>
155 #include <linux/interrupt.h>
156 #include <linux/ioport.h>
157 #include <linux/string.h>
158 #include <linux/in.h>
159 #include <linux/fcntl.h>
160 #include <linux/ptrace.h>
161 #include <linux/slab.h>
162 #include <linux/delay.h>
163 #include <linux/skbuff.h>
164 #include <linux/netdevice.h>
165 #include <linux/rtnetlink.h>
166 #include <linux/if_ether.h>
167 #include <linux/if_arp.h>
168 #include <linux/socket.h>
169 #include <linux/init.h>
170 #include <linux/scc.h>
171 #include <linux/ctype.h>
172 #include <linux/kernel.h>
173 #include <linux/proc_fs.h>
174 #include <linux/seq_file.h>
175 #include <linux/bitops.h>
177 #include <net/ax25.h>
179 #include <asm/irq.h>
180 #include <asm/system.h>
181 #include <asm/io.h>
182 #include <asm/uaccess.h>
184 #include "z8530.h"
186 static char banner[] __initdata = KERN_INFO "AX.25: Z8530 SCC driver version "VERSION".dl1bke\n";
188 static void t_dwait(unsigned long);
189 static void t_txdelay(unsigned long);
190 static void t_tail(unsigned long);
191 static void t_busy(unsigned long);
192 static void t_maxkeyup(unsigned long);
193 static void t_idle(unsigned long);
194 static void scc_tx_done(struct scc_channel *);
195 static void scc_start_tx_timer(struct scc_channel *, void (*)(unsigned long), unsigned long);
196 static void scc_start_maxkeyup(struct scc_channel *);
197 static void scc_start_defer(struct scc_channel *);
199 static void z8530_init(void);
201 static void init_channel(struct scc_channel *scc);
202 static void scc_key_trx (struct scc_channel *scc, char tx);
203 static irqreturn_t scc_isr(int irq, void *dev_id);
204 static void scc_init_timer(struct scc_channel *scc);
206 static int scc_net_alloc(const char *name, struct scc_channel *scc);
207 static void scc_net_setup(struct net_device *dev);
208 static int scc_net_open(struct net_device *dev);
209 static int scc_net_close(struct net_device *dev);
210 static void scc_net_rx(struct scc_channel *scc, struct sk_buff *skb);
211 static int scc_net_tx(struct sk_buff *skb, struct net_device *dev);
212 static int scc_net_ioctl(struct net_device *dev, struct ifreq *ifr, int cmd);
213 static int scc_net_set_mac_address(struct net_device *dev, void *addr);
214 static struct net_device_stats * scc_net_get_stats(struct net_device *dev);
216 static unsigned char SCC_DriverName[] = "scc";
218 static struct irqflags { unsigned char used : 1; } Ivec[NR_IRQS];
220 static struct scc_channel SCC_Info[2 * SCC_MAXCHIPS]; /* information per channel */
222 static struct scc_ctrl {
223 io_port chan_A;
224 io_port chan_B;
225 int irq;
226 } SCC_ctrl[SCC_MAXCHIPS+1];
228 static unsigned char Driver_Initialized;
229 static int Nchips;
230 static io_port Vector_Latch;
233 /* ******************************************************************** */
234 /* * Port Access Functions * */
235 /* ******************************************************************** */
237 /* These provide interrupt save 2-step access to the Z8530 registers */
239 static DEFINE_SPINLOCK(iolock); /* Guards paired accesses */
241 static inline unsigned char InReg(io_port port, unsigned char reg)
243 unsigned long flags;
244 unsigned char r;
246 spin_lock_irqsave(&iolock, flags);
247 #ifdef SCC_LDELAY
248 Outb(port, reg);
249 udelay(SCC_LDELAY);
250 r=Inb(port);
251 udelay(SCC_LDELAY);
252 #else
253 Outb(port, reg);
254 r=Inb(port);
255 #endif
256 spin_unlock_irqrestore(&iolock, flags);
257 return r;
260 static inline void OutReg(io_port port, unsigned char reg, unsigned char val)
262 unsigned long flags;
264 spin_lock_irqsave(&iolock, flags);
265 #ifdef SCC_LDELAY
266 Outb(port, reg); udelay(SCC_LDELAY);
267 Outb(port, val); udelay(SCC_LDELAY);
268 #else
269 Outb(port, reg);
270 Outb(port, val);
271 #endif
272 spin_unlock_irqrestore(&iolock, flags);
275 static inline void wr(struct scc_channel *scc, unsigned char reg,
276 unsigned char val)
278 OutReg(scc->ctrl, reg, (scc->wreg[reg] = val));
281 static inline void or(struct scc_channel *scc, unsigned char reg, unsigned char val)
283 OutReg(scc->ctrl, reg, (scc->wreg[reg] |= val));
286 static inline void cl(struct scc_channel *scc, unsigned char reg, unsigned char val)
288 OutReg(scc->ctrl, reg, (scc->wreg[reg] &= ~val));
291 /* ******************************************************************** */
292 /* * Some useful macros * */
293 /* ******************************************************************** */
295 static inline void scc_discard_buffers(struct scc_channel *scc)
297 unsigned long flags;
299 spin_lock_irqsave(&scc->lock, flags);
300 if (scc->tx_buff != NULL)
302 dev_kfree_skb(scc->tx_buff);
303 scc->tx_buff = NULL;
306 while (!skb_queue_empty(&scc->tx_queue))
307 dev_kfree_skb(skb_dequeue(&scc->tx_queue));
309 spin_unlock_irqrestore(&scc->lock, flags);
314 /* ******************************************************************** */
315 /* * Interrupt Service Routines * */
316 /* ******************************************************************** */
319 /* ----> subroutines for the interrupt handlers <---- */
321 static inline void scc_notify(struct scc_channel *scc, int event)
323 struct sk_buff *skb;
324 char *bp;
326 if (scc->kiss.fulldup != KISS_DUPLEX_OPTIMA)
327 return;
329 skb = dev_alloc_skb(2);
330 if (skb != NULL)
332 bp = skb_put(skb, 2);
333 *bp++ = PARAM_HWEVENT;
334 *bp++ = event;
335 scc_net_rx(scc, skb);
336 } else
337 scc->stat.nospace++;
340 static inline void flush_rx_FIFO(struct scc_channel *scc)
342 int k;
344 for (k=0; k<3; k++)
345 Inb(scc->data);
347 if(scc->rx_buff != NULL) /* did we receive something? */
349 scc->stat.rxerrs++; /* then count it as an error */
350 dev_kfree_skb_irq(scc->rx_buff);
351 scc->rx_buff = NULL;
355 static void start_hunt(struct scc_channel *scc)
357 if ((scc->modem.clocksrc != CLK_EXTERNAL))
358 OutReg(scc->ctrl,R14,SEARCH|scc->wreg[R14]); /* DPLL: enter search mode */
359 or(scc,R3,ENT_HM|RxENABLE); /* enable the receiver, hunt mode */
362 /* ----> four different interrupt handlers for Tx, Rx, changing of */
363 /* DCD/CTS and Rx/Tx errors */
365 /* Transmitter interrupt handler */
366 static inline void scc_txint(struct scc_channel *scc)
368 struct sk_buff *skb;
370 scc->stat.txints++;
371 skb = scc->tx_buff;
373 /* send first octet */
375 if (skb == NULL)
377 skb = skb_dequeue(&scc->tx_queue);
378 scc->tx_buff = skb;
379 netif_wake_queue(scc->dev);
381 if (skb == NULL)
383 scc_tx_done(scc);
384 Outb(scc->ctrl, RES_Tx_P);
385 return;
388 if (skb->len == 0) /* Paranoia... */
390 dev_kfree_skb_irq(skb);
391 scc->tx_buff = NULL;
392 scc_tx_done(scc);
393 Outb(scc->ctrl, RES_Tx_P);
394 return;
397 scc->stat.tx_state = TXS_ACTIVE;
399 OutReg(scc->ctrl, R0, RES_Tx_CRC);
400 /* reset CRC generator */
401 or(scc,R10,ABUNDER); /* re-install underrun protection */
402 Outb(scc->data,*skb->data); /* send byte */
403 skb_pull(skb, 1);
405 if (!scc->enhanced) /* reset EOM latch */
406 Outb(scc->ctrl,RES_EOM_L);
407 return;
410 /* End Of Frame... */
412 if (skb->len == 0)
414 Outb(scc->ctrl, RES_Tx_P); /* reset pending int */
415 cl(scc, R10, ABUNDER); /* send CRC */
416 dev_kfree_skb_irq(skb);
417 scc->tx_buff = NULL;
418 scc->stat.tx_state = TXS_NEWFRAME; /* next frame... */
419 return;
422 /* send octet */
424 Outb(scc->data,*skb->data);
425 skb_pull(skb, 1);
429 /* External/Status interrupt handler */
430 static inline void scc_exint(struct scc_channel *scc)
432 unsigned char status,changes,chg_and_stat;
434 scc->stat.exints++;
436 status = InReg(scc->ctrl,R0);
437 changes = status ^ scc->status;
438 chg_and_stat = changes & status;
440 /* ABORT: generated whenever DCD drops while receiving */
442 if (chg_and_stat & BRK_ABRT) /* Received an ABORT */
443 flush_rx_FIFO(scc);
445 /* HUNT: software DCD; on = waiting for SYNC, off = receiving frame */
447 if ((changes & SYNC_HUNT) && scc->kiss.softdcd)
449 if (status & SYNC_HUNT)
451 scc->dcd = 0;
452 flush_rx_FIFO(scc);
453 if ((scc->modem.clocksrc != CLK_EXTERNAL))
454 OutReg(scc->ctrl,R14,SEARCH|scc->wreg[R14]); /* DPLL: enter search mode */
455 } else {
456 scc->dcd = 1;
459 scc_notify(scc, scc->dcd? HWEV_DCD_OFF:HWEV_DCD_ON);
462 /* DCD: on = start to receive packet, off = ABORT condition */
463 /* (a successfully received packet generates a special condition int) */
465 if((changes & DCD) && !scc->kiss.softdcd) /* DCD input changed state */
467 if(status & DCD) /* DCD is now ON */
469 start_hunt(scc);
470 scc->dcd = 1;
471 } else { /* DCD is now OFF */
472 cl(scc,R3,ENT_HM|RxENABLE); /* disable the receiver */
473 flush_rx_FIFO(scc);
474 scc->dcd = 0;
477 scc_notify(scc, scc->dcd? HWEV_DCD_ON:HWEV_DCD_OFF);
480 #ifdef notdef
481 /* CTS: use external TxDelay (what's that good for?!)
482 * Anyway: If we _could_ use it (BayCom USCC uses CTS for
483 * own purposes) we _should_ use the "autoenable" feature
484 * of the Z8530 and not this interrupt...
487 if (chg_and_stat & CTS) /* CTS is now ON */
489 if (scc->kiss.txdelay == 0) /* zero TXDELAY = wait for CTS */
490 scc_start_tx_timer(scc, t_txdelay, 0);
492 #endif
494 if (scc->stat.tx_state == TXS_ACTIVE && (status & TxEOM))
496 scc->stat.tx_under++; /* oops, an underrun! count 'em */
497 Outb(scc->ctrl, RES_EXT_INT); /* reset ext/status interrupts */
499 if (scc->tx_buff != NULL)
501 dev_kfree_skb_irq(scc->tx_buff);
502 scc->tx_buff = NULL;
505 or(scc,R10,ABUNDER);
506 scc_start_tx_timer(scc, t_txdelay, 0); /* restart transmission */
509 scc->status = status;
510 Outb(scc->ctrl,RES_EXT_INT);
514 /* Receiver interrupt handler */
515 static inline void scc_rxint(struct scc_channel *scc)
517 struct sk_buff *skb;
519 scc->stat.rxints++;
521 if((scc->wreg[5] & RTS) && scc->kiss.fulldup == KISS_DUPLEX_HALF)
523 Inb(scc->data); /* discard char */
524 or(scc,R3,ENT_HM); /* enter hunt mode for next flag */
525 return;
528 skb = scc->rx_buff;
530 if (skb == NULL)
532 skb = dev_alloc_skb(scc->stat.bufsize);
533 if (skb == NULL)
535 scc->dev_stat.rx_dropped++;
536 scc->stat.nospace++;
537 Inb(scc->data);
538 or(scc, R3, ENT_HM);
539 return;
542 scc->rx_buff = skb;
543 *(skb_put(skb, 1)) = 0; /* KISS data */
546 if (skb->len >= scc->stat.bufsize)
548 #ifdef notdef
549 printk(KERN_DEBUG "z8530drv: oops, scc_rxint() received huge frame...\n");
550 #endif
551 dev_kfree_skb_irq(skb);
552 scc->rx_buff = NULL;
553 Inb(scc->data);
554 or(scc, R3, ENT_HM);
555 return;
558 *(skb_put(skb, 1)) = Inb(scc->data);
562 /* Receive Special Condition interrupt handler */
563 static inline void scc_spint(struct scc_channel *scc)
565 unsigned char status;
566 struct sk_buff *skb;
568 scc->stat.spints++;
570 status = InReg(scc->ctrl,R1); /* read receiver status */
572 Inb(scc->data); /* throw away Rx byte */
573 skb = scc->rx_buff;
575 if(status & Rx_OVR) /* receiver overrun */
577 scc->stat.rx_over++; /* count them */
578 or(scc,R3,ENT_HM); /* enter hunt mode for next flag */
580 if (skb != NULL)
581 dev_kfree_skb_irq(skb);
582 scc->rx_buff = skb = NULL;
585 if(status & END_FR && skb != NULL) /* end of frame */
587 /* CRC okay, frame ends on 8 bit boundary and received something ? */
589 if (!(status & CRC_ERR) && (status & 0xe) == RES8 && skb->len > 0)
591 /* ignore last received byte (first of the CRC bytes) */
592 skb_trim(skb, skb->len-1);
593 scc_net_rx(scc, skb);
594 scc->rx_buff = NULL;
595 scc->stat.rxframes++;
596 } else { /* a bad frame */
597 dev_kfree_skb_irq(skb);
598 scc->rx_buff = NULL;
599 scc->stat.rxerrs++;
603 Outb(scc->ctrl,ERR_RES);
607 /* ----> interrupt service routine for the Z8530 <---- */
609 static void scc_isr_dispatch(struct scc_channel *scc, int vector)
611 spin_lock(&scc->lock);
612 switch (vector & VECTOR_MASK)
614 case TXINT: scc_txint(scc); break;
615 case EXINT: scc_exint(scc); break;
616 case RXINT: scc_rxint(scc); break;
617 case SPINT: scc_spint(scc); break;
619 spin_unlock(&scc->lock);
622 /* If the card has a latch for the interrupt vector (like the PA0HZP card)
623 use it to get the number of the chip that generated the int.
624 If not: poll all defined chips.
627 #define SCC_IRQTIMEOUT 30000
629 static irqreturn_t scc_isr(int irq, void *dev_id)
631 unsigned char vector;
632 struct scc_channel *scc;
633 struct scc_ctrl *ctrl;
634 int k;
636 if (Vector_Latch)
638 for(k=0; k < SCC_IRQTIMEOUT; k++)
640 Outb(Vector_Latch, 0); /* Generate INTACK */
642 /* Read the vector */
643 if((vector=Inb(Vector_Latch)) >= 16 * Nchips) break;
644 if (vector & 0x01) break;
646 scc=&SCC_Info[vector >> 3 ^ 0x01];
647 if (!scc->dev) break;
649 scc_isr_dispatch(scc, vector);
651 OutReg(scc->ctrl,R0,RES_H_IUS); /* Reset Highest IUS */
654 if (k == SCC_IRQTIMEOUT)
655 printk(KERN_WARNING "z8530drv: endless loop in scc_isr()?\n");
657 return IRQ_HANDLED;
660 /* Find the SCC generating the interrupt by polling all attached SCCs
661 * reading RR3A (the interrupt pending register)
664 ctrl = SCC_ctrl;
665 while (ctrl->chan_A)
667 if (ctrl->irq != irq)
669 ctrl++;
670 continue;
673 scc = NULL;
674 for (k = 0; InReg(ctrl->chan_A,R3) && k < SCC_IRQTIMEOUT; k++)
676 vector=InReg(ctrl->chan_B,R2); /* Read the vector */
677 if (vector & 0x01) break;
679 scc = &SCC_Info[vector >> 3 ^ 0x01];
680 if (!scc->dev) break;
682 scc_isr_dispatch(scc, vector);
685 if (k == SCC_IRQTIMEOUT)
687 printk(KERN_WARNING "z8530drv: endless loop in scc_isr()?!\n");
688 break;
691 /* This looks weird and it is. At least the BayCom USCC doesn't
692 * use the Interrupt Daisy Chain, thus we'll have to start
693 * all over again to be sure not to miss an interrupt from
694 * (any of) the other chip(s)...
695 * Honestly, the situation *is* braindamaged...
698 if (scc != NULL)
700 OutReg(scc->ctrl,R0,RES_H_IUS);
701 ctrl = SCC_ctrl;
702 } else
703 ctrl++;
705 return IRQ_HANDLED;
710 /* ******************************************************************** */
711 /* * Init Channel */
712 /* ******************************************************************** */
715 /* ----> set SCC channel speed <---- */
717 static inline void set_brg(struct scc_channel *scc, unsigned int tc)
719 cl(scc,R14,BRENABL); /* disable baudrate generator */
720 wr(scc,R12,tc & 255); /* brg rate LOW */
721 wr(scc,R13,tc >> 8); /* brg rate HIGH */
722 or(scc,R14,BRENABL); /* enable baudrate generator */
725 static inline void set_speed(struct scc_channel *scc)
727 unsigned long flags;
728 spin_lock_irqsave(&scc->lock, flags);
730 if (scc->modem.speed > 0) /* paranoia... */
731 set_brg(scc, (unsigned) (scc->clock / (scc->modem.speed * 64)) - 2);
733 spin_unlock_irqrestore(&scc->lock, flags);
737 /* ----> initialize a SCC channel <---- */
739 static inline void init_brg(struct scc_channel *scc)
741 wr(scc, R14, BRSRC); /* BRG source = PCLK */
742 OutReg(scc->ctrl, R14, SSBR|scc->wreg[R14]); /* DPLL source = BRG */
743 OutReg(scc->ctrl, R14, SNRZI|scc->wreg[R14]); /* DPLL NRZI mode */
747 * Initialization according to the Z8530 manual (SGS-Thomson's version):
749 * 1. Modes and constants
751 * WR9 11000000 chip reset
752 * WR4 XXXXXXXX Tx/Rx control, async or sync mode
753 * WR1 0XX00X00 select W/REQ (optional)
754 * WR2 XXXXXXXX program interrupt vector
755 * WR3 XXXXXXX0 select Rx control
756 * WR5 XXXX0XXX select Tx control
757 * WR6 XXXXXXXX sync character
758 * WR7 XXXXXXXX sync character
759 * WR9 000X0XXX select interrupt control
760 * WR10 XXXXXXXX miscellaneous control (optional)
761 * WR11 XXXXXXXX clock control
762 * WR12 XXXXXXXX time constant lower byte (optional)
763 * WR13 XXXXXXXX time constant upper byte (optional)
764 * WR14 XXXXXXX0 miscellaneous control
765 * WR14 XXXSSSSS commands (optional)
767 * 2. Enables
769 * WR14 000SSSS1 baud rate enable
770 * WR3 SSSSSSS1 Rx enable
771 * WR5 SSSS1SSS Tx enable
772 * WR0 10000000 reset Tx CRG (optional)
773 * WR1 XSS00S00 DMA enable (optional)
775 * 3. Interrupt status
777 * WR15 XXXXXXXX enable external/status
778 * WR0 00010000 reset external status
779 * WR0 00010000 reset external status twice
780 * WR1 SSSXXSXX enable Rx, Tx and Ext/status
781 * WR9 000SXSSS enable master interrupt enable
783 * 1 = set to one, 0 = reset to zero
784 * X = user defined, S = same as previous init
787 * Note that the implementation differs in some points from above scheme.
791 static void init_channel(struct scc_channel *scc)
793 del_timer(&scc->tx_t);
794 del_timer(&scc->tx_wdog);
796 disable_irq(scc->irq);
798 wr(scc,R4,X1CLK|SDLC); /* *1 clock, SDLC mode */
799 wr(scc,R1,0); /* no W/REQ operation */
800 wr(scc,R3,Rx8|RxCRC_ENAB); /* RX 8 bits/char, CRC, disabled */
801 wr(scc,R5,Tx8|DTR|TxCRC_ENAB); /* TX 8 bits/char, disabled, DTR */
802 wr(scc,R6,0); /* SDLC address zero (not used) */
803 wr(scc,R7,FLAG); /* SDLC flag value */
804 wr(scc,R9,VIS); /* vector includes status */
805 wr(scc,R10,(scc->modem.nrz? NRZ : NRZI)|CRCPS|ABUNDER); /* abort on underrun, preset CRC generator, NRZ(I) */
806 wr(scc,R14, 0);
809 /* set clock sources:
811 CLK_DPLL: normal halfduplex operation
813 RxClk: use DPLL
814 TxClk: use DPLL
815 TRxC mode DPLL output
817 CLK_EXTERNAL: external clocking (G3RUH or DF9IC modem)
819 BayCom: others:
821 TxClk = pin RTxC TxClk = pin TRxC
822 RxClk = pin TRxC RxClk = pin RTxC
825 CLK_DIVIDER:
826 RxClk = use DPLL
827 TxClk = pin RTxC
829 BayCom: others:
830 pin TRxC = DPLL pin TRxC = BRG
831 (RxClk * 1) (RxClk * 32)
835 switch(scc->modem.clocksrc)
837 case CLK_DPLL:
838 wr(scc, R11, RCDPLL|TCDPLL|TRxCOI|TRxCDP);
839 init_brg(scc);
840 break;
842 case CLK_DIVIDER:
843 wr(scc, R11, ((scc->brand & BAYCOM)? TRxCDP : TRxCBR) | RCDPLL|TCRTxCP|TRxCOI);
844 init_brg(scc);
845 break;
847 case CLK_EXTERNAL:
848 wr(scc, R11, (scc->brand & BAYCOM)? RCTRxCP|TCRTxCP : RCRTxCP|TCTRxCP);
849 OutReg(scc->ctrl, R14, DISDPLL);
850 break;
854 set_speed(scc); /* set baudrate */
856 if(scc->enhanced)
858 or(scc,R15,SHDLCE|FIFOE); /* enable FIFO, SDLC/HDLC Enhancements (From now R7 is R7') */
859 wr(scc,R7,AUTOEOM);
862 if(scc->kiss.softdcd || (InReg(scc->ctrl,R0) & DCD))
863 /* DCD is now ON */
865 start_hunt(scc);
868 /* enable ABORT, DCD & SYNC/HUNT interrupts */
870 wr(scc,R15, BRKIE|TxUIE|(scc->kiss.softdcd? SYNCIE:DCDIE));
872 Outb(scc->ctrl,RES_EXT_INT); /* reset ext/status interrupts */
873 Outb(scc->ctrl,RES_EXT_INT); /* must be done twice */
875 or(scc,R1,INT_ALL_Rx|TxINT_ENAB|EXT_INT_ENAB); /* enable interrupts */
877 scc->status = InReg(scc->ctrl,R0); /* read initial status */
879 or(scc,R9,MIE); /* master interrupt enable */
881 scc_init_timer(scc);
883 enable_irq(scc->irq);
889 /* ******************************************************************** */
890 /* * SCC timer functions * */
891 /* ******************************************************************** */
894 /* ----> scc_key_trx sets the time constant for the baudrate
895 generator and keys the transmitter <---- */
897 static void scc_key_trx(struct scc_channel *scc, char tx)
899 unsigned int time_const;
901 if (scc->brand & PRIMUS)
902 Outb(scc->ctrl + 4, scc->option | (tx? 0x80 : 0));
904 if (scc->modem.speed < 300)
905 scc->modem.speed = 1200;
907 time_const = (unsigned) (scc->clock / (scc->modem.speed * (tx? 2:64))) - 2;
909 disable_irq(scc->irq);
911 if (tx)
913 or(scc, R1, TxINT_ENAB); /* t_maxkeyup may have reset these */
914 or(scc, R15, TxUIE);
917 if (scc->modem.clocksrc == CLK_DPLL)
918 { /* force simplex operation */
919 if (tx)
921 #ifdef CONFIG_SCC_TRXECHO
922 cl(scc, R3, RxENABLE|ENT_HM); /* switch off receiver */
923 cl(scc, R15, DCDIE|SYNCIE); /* No DCD changes, please */
924 #endif
925 set_brg(scc, time_const); /* reprogram baudrate generator */
927 /* DPLL -> Rx clk, BRG -> Tx CLK, TRxC mode output, TRxC = BRG */
928 wr(scc, R11, RCDPLL|TCBR|TRxCOI|TRxCBR);
930 /* By popular demand: tx_inhibit */
931 if (scc->kiss.tx_inhibit)
933 or(scc,R5, TxENAB);
934 scc->wreg[R5] |= RTS;
935 } else {
936 or(scc,R5,RTS|TxENAB); /* set the RTS line and enable TX */
938 } else {
939 cl(scc,R5,RTS|TxENAB);
941 set_brg(scc, time_const); /* reprogram baudrate generator */
943 /* DPLL -> Rx clk, DPLL -> Tx CLK, TRxC mode output, TRxC = DPLL */
944 wr(scc, R11, RCDPLL|TCDPLL|TRxCOI|TRxCDP);
946 #ifndef CONFIG_SCC_TRXECHO
947 if (scc->kiss.softdcd)
948 #endif
950 or(scc,R15, scc->kiss.softdcd? SYNCIE:DCDIE);
951 start_hunt(scc);
954 } else {
955 if (tx)
957 #ifdef CONFIG_SCC_TRXECHO
958 if (scc->kiss.fulldup == KISS_DUPLEX_HALF)
960 cl(scc, R3, RxENABLE);
961 cl(scc, R15, DCDIE|SYNCIE);
963 #endif
965 if (scc->kiss.tx_inhibit)
967 or(scc,R5, TxENAB);
968 scc->wreg[R5] |= RTS;
969 } else {
970 or(scc,R5,RTS|TxENAB); /* enable tx */
972 } else {
973 cl(scc,R5,RTS|TxENAB); /* disable tx */
975 if ((scc->kiss.fulldup == KISS_DUPLEX_HALF) &&
976 #ifndef CONFIG_SCC_TRXECHO
977 scc->kiss.softdcd)
978 #else
980 #endif
982 or(scc, R15, scc->kiss.softdcd? SYNCIE:DCDIE);
983 start_hunt(scc);
988 enable_irq(scc->irq);
992 /* ----> SCC timer interrupt handler and friends. <---- */
994 static void __scc_start_tx_timer(struct scc_channel *scc, void (*handler)(unsigned long), unsigned long when)
996 del_timer(&scc->tx_t);
998 if (when == 0)
1000 handler((unsigned long) scc);
1001 } else
1002 if (when != TIMER_OFF)
1004 scc->tx_t.data = (unsigned long) scc;
1005 scc->tx_t.function = handler;
1006 scc->tx_t.expires = jiffies + (when*HZ)/100;
1007 add_timer(&scc->tx_t);
1011 static void scc_start_tx_timer(struct scc_channel *scc, void (*handler)(unsigned long), unsigned long when)
1013 unsigned long flags;
1015 spin_lock_irqsave(&scc->lock, flags);
1016 __scc_start_tx_timer(scc, handler, when);
1017 spin_unlock_irqrestore(&scc->lock, flags);
1020 static void scc_start_defer(struct scc_channel *scc)
1022 unsigned long flags;
1024 spin_lock_irqsave(&scc->lock, flags);
1025 del_timer(&scc->tx_wdog);
1027 if (scc->kiss.maxdefer != 0 && scc->kiss.maxdefer != TIMER_OFF)
1029 scc->tx_wdog.data = (unsigned long) scc;
1030 scc->tx_wdog.function = t_busy;
1031 scc->tx_wdog.expires = jiffies + HZ*scc->kiss.maxdefer;
1032 add_timer(&scc->tx_wdog);
1034 spin_unlock_irqrestore(&scc->lock, flags);
1037 static void scc_start_maxkeyup(struct scc_channel *scc)
1039 unsigned long flags;
1041 spin_lock_irqsave(&scc->lock, flags);
1042 del_timer(&scc->tx_wdog);
1044 if (scc->kiss.maxkeyup != 0 && scc->kiss.maxkeyup != TIMER_OFF)
1046 scc->tx_wdog.data = (unsigned long) scc;
1047 scc->tx_wdog.function = t_maxkeyup;
1048 scc->tx_wdog.expires = jiffies + HZ*scc->kiss.maxkeyup;
1049 add_timer(&scc->tx_wdog);
1051 spin_unlock_irqrestore(&scc->lock, flags);
1055 * This is called from scc_txint() when there are no more frames to send.
1056 * Not exactly a timer function, but it is a close friend of the family...
1059 static void scc_tx_done(struct scc_channel *scc)
1062 * trx remains keyed in fulldup mode 2 until t_idle expires.
1065 switch (scc->kiss.fulldup)
1067 case KISS_DUPLEX_LINK:
1068 scc->stat.tx_state = TXS_IDLE2;
1069 if (scc->kiss.idletime != TIMER_OFF)
1070 scc_start_tx_timer(scc, t_idle, scc->kiss.idletime*100);
1071 break;
1072 case KISS_DUPLEX_OPTIMA:
1073 scc_notify(scc, HWEV_ALL_SENT);
1074 break;
1075 default:
1076 scc->stat.tx_state = TXS_BUSY;
1077 scc_start_tx_timer(scc, t_tail, scc->kiss.tailtime);
1080 netif_wake_queue(scc->dev);
1084 static unsigned char Rand = 17;
1086 static inline int is_grouped(struct scc_channel *scc)
1088 int k;
1089 struct scc_channel *scc2;
1090 unsigned char grp1, grp2;
1092 grp1 = scc->kiss.group;
1094 for (k = 0; k < (Nchips * 2); k++)
1096 scc2 = &SCC_Info[k];
1097 grp2 = scc2->kiss.group;
1099 if (scc2 == scc || !(scc2->dev && grp2))
1100 continue;
1102 if ((grp1 & 0x3f) == (grp2 & 0x3f))
1104 if ( (grp1 & TXGROUP) && (scc2->wreg[R5] & RTS) )
1105 return 1;
1107 if ( (grp1 & RXGROUP) && scc2->dcd )
1108 return 1;
1111 return 0;
1114 /* DWAIT and SLOTTIME expired
1116 * fulldup == 0: DCD is active or Rand > P-persistence: start t_busy timer
1117 * else key trx and start txdelay
1118 * fulldup == 1: key trx and start txdelay
1119 * fulldup == 2: mintime expired, reset status or key trx and start txdelay
1122 static void t_dwait(unsigned long channel)
1124 struct scc_channel *scc = (struct scc_channel *) channel;
1126 if (scc->stat.tx_state == TXS_WAIT) /* maxkeyup or idle timeout */
1128 if (skb_queue_empty(&scc->tx_queue)) { /* nothing to send */
1129 scc->stat.tx_state = TXS_IDLE;
1130 netif_wake_queue(scc->dev); /* t_maxkeyup locked it. */
1131 return;
1134 scc->stat.tx_state = TXS_BUSY;
1137 if (scc->kiss.fulldup == KISS_DUPLEX_HALF)
1139 Rand = Rand * 17 + 31;
1141 if (scc->dcd || (scc->kiss.persist) < Rand || (scc->kiss.group && is_grouped(scc)) )
1143 scc_start_defer(scc);
1144 scc_start_tx_timer(scc, t_dwait, scc->kiss.slottime);
1145 return ;
1149 if ( !(scc->wreg[R5] & RTS) )
1151 scc_key_trx(scc, TX_ON);
1152 scc_start_tx_timer(scc, t_txdelay, scc->kiss.txdelay);
1153 } else {
1154 scc_start_tx_timer(scc, t_txdelay, 0);
1159 /* TXDELAY expired
1161 * kick transmission by a fake scc_txint(scc), start 'maxkeyup' watchdog.
1164 static void t_txdelay(unsigned long channel)
1166 struct scc_channel *scc = (struct scc_channel *) channel;
1168 scc_start_maxkeyup(scc);
1170 if (scc->tx_buff == NULL)
1172 disable_irq(scc->irq);
1173 scc_txint(scc);
1174 enable_irq(scc->irq);
1179 /* TAILTIME expired
1181 * switch off transmitter. If we were stopped by Maxkeyup restart
1182 * transmission after 'mintime' seconds
1185 static void t_tail(unsigned long channel)
1187 struct scc_channel *scc = (struct scc_channel *) channel;
1188 unsigned long flags;
1190 spin_lock_irqsave(&scc->lock, flags);
1191 del_timer(&scc->tx_wdog);
1192 scc_key_trx(scc, TX_OFF);
1193 spin_unlock_irqrestore(&scc->lock, flags);
1195 if (scc->stat.tx_state == TXS_TIMEOUT) /* we had a timeout? */
1197 scc->stat.tx_state = TXS_WAIT;
1198 scc_start_tx_timer(scc, t_dwait, scc->kiss.mintime*100);
1199 return;
1202 scc->stat.tx_state = TXS_IDLE;
1203 netif_wake_queue(scc->dev);
1207 /* BUSY timeout
1209 * throw away send buffers if DCD remains active too long.
1212 static void t_busy(unsigned long channel)
1214 struct scc_channel *scc = (struct scc_channel *) channel;
1216 del_timer(&scc->tx_t);
1217 netif_stop_queue(scc->dev); /* don't pile on the wabbit! */
1219 scc_discard_buffers(scc);
1220 scc->stat.txerrs++;
1221 scc->stat.tx_state = TXS_IDLE;
1223 netif_wake_queue(scc->dev);
1226 /* MAXKEYUP timeout
1228 * this is our watchdog.
1231 static void t_maxkeyup(unsigned long channel)
1233 struct scc_channel *scc = (struct scc_channel *) channel;
1234 unsigned long flags;
1236 spin_lock_irqsave(&scc->lock, flags);
1238 * let things settle down before we start to
1239 * accept new data.
1242 netif_stop_queue(scc->dev);
1243 scc_discard_buffers(scc);
1245 del_timer(&scc->tx_t);
1247 cl(scc, R1, TxINT_ENAB); /* force an ABORT, but don't */
1248 cl(scc, R15, TxUIE); /* count it. */
1249 OutReg(scc->ctrl, R0, RES_Tx_P);
1251 spin_unlock_irqrestore(&scc->lock, flags);
1253 scc->stat.txerrs++;
1254 scc->stat.tx_state = TXS_TIMEOUT;
1255 scc_start_tx_timer(scc, t_tail, scc->kiss.tailtime);
1258 /* IDLE timeout
1260 * in fulldup mode 2 it keys down the transmitter after 'idle' seconds
1261 * of inactivity. We will not restart transmission before 'mintime'
1262 * expires.
1265 static void t_idle(unsigned long channel)
1267 struct scc_channel *scc = (struct scc_channel *) channel;
1269 del_timer(&scc->tx_wdog);
1271 scc_key_trx(scc, TX_OFF);
1272 if(scc->kiss.mintime)
1273 scc_start_tx_timer(scc, t_dwait, scc->kiss.mintime*100);
1274 scc->stat.tx_state = TXS_WAIT;
1277 static void scc_init_timer(struct scc_channel *scc)
1279 unsigned long flags;
1281 spin_lock_irqsave(&scc->lock, flags);
1282 scc->stat.tx_state = TXS_IDLE;
1283 spin_unlock_irqrestore(&scc->lock, flags);
1287 /* ******************************************************************** */
1288 /* * Set/get L1 parameters * */
1289 /* ******************************************************************** */
1293 * this will set the "hardware" parameters through KISS commands or ioctl()
1296 #define CAST(x) (unsigned long)(x)
1298 static unsigned int scc_set_param(struct scc_channel *scc, unsigned int cmd, unsigned int arg)
1300 switch (cmd)
1302 case PARAM_TXDELAY: scc->kiss.txdelay=arg; break;
1303 case PARAM_PERSIST: scc->kiss.persist=arg; break;
1304 case PARAM_SLOTTIME: scc->kiss.slottime=arg; break;
1305 case PARAM_TXTAIL: scc->kiss.tailtime=arg; break;
1306 case PARAM_FULLDUP: scc->kiss.fulldup=arg; break;
1307 case PARAM_DTR: break; /* does someone need this? */
1308 case PARAM_GROUP: scc->kiss.group=arg; break;
1309 case PARAM_IDLE: scc->kiss.idletime=arg; break;
1310 case PARAM_MIN: scc->kiss.mintime=arg; break;
1311 case PARAM_MAXKEY: scc->kiss.maxkeyup=arg; break;
1312 case PARAM_WAIT: scc->kiss.waittime=arg; break;
1313 case PARAM_MAXDEFER: scc->kiss.maxdefer=arg; break;
1314 case PARAM_TX: scc->kiss.tx_inhibit=arg; break;
1316 case PARAM_SOFTDCD:
1317 scc->kiss.softdcd=arg;
1318 if (arg)
1320 or(scc, R15, SYNCIE);
1321 cl(scc, R15, DCDIE);
1322 start_hunt(scc);
1323 } else {
1324 or(scc, R15, DCDIE);
1325 cl(scc, R15, SYNCIE);
1327 break;
1329 case PARAM_SPEED:
1330 if (arg < 256)
1331 scc->modem.speed=arg*100;
1332 else
1333 scc->modem.speed=arg;
1335 if (scc->stat.tx_state == 0) /* only switch baudrate on rx... ;-) */
1336 set_speed(scc);
1337 break;
1339 case PARAM_RTS:
1340 if ( !(scc->wreg[R5] & RTS) )
1342 if (arg != TX_OFF)
1343 scc_key_trx(scc, TX_ON);
1344 scc_start_tx_timer(scc, t_txdelay, scc->kiss.txdelay);
1345 } else {
1346 if (arg == TX_OFF)
1348 scc->stat.tx_state = TXS_BUSY;
1349 scc_start_tx_timer(scc, t_tail, scc->kiss.tailtime);
1352 break;
1354 case PARAM_HWEVENT:
1355 scc_notify(scc, scc->dcd? HWEV_DCD_ON:HWEV_DCD_OFF);
1356 break;
1358 default: return -EINVAL;
1361 return 0;
1366 static unsigned long scc_get_param(struct scc_channel *scc, unsigned int cmd)
1368 switch (cmd)
1370 case PARAM_TXDELAY: return CAST(scc->kiss.txdelay);
1371 case PARAM_PERSIST: return CAST(scc->kiss.persist);
1372 case PARAM_SLOTTIME: return CAST(scc->kiss.slottime);
1373 case PARAM_TXTAIL: return CAST(scc->kiss.tailtime);
1374 case PARAM_FULLDUP: return CAST(scc->kiss.fulldup);
1375 case PARAM_SOFTDCD: return CAST(scc->kiss.softdcd);
1376 case PARAM_DTR: return CAST((scc->wreg[R5] & DTR)? 1:0);
1377 case PARAM_RTS: return CAST((scc->wreg[R5] & RTS)? 1:0);
1378 case PARAM_SPEED: return CAST(scc->modem.speed);
1379 case PARAM_GROUP: return CAST(scc->kiss.group);
1380 case PARAM_IDLE: return CAST(scc->kiss.idletime);
1381 case PARAM_MIN: return CAST(scc->kiss.mintime);
1382 case PARAM_MAXKEY: return CAST(scc->kiss.maxkeyup);
1383 case PARAM_WAIT: return CAST(scc->kiss.waittime);
1384 case PARAM_MAXDEFER: return CAST(scc->kiss.maxdefer);
1385 case PARAM_TX: return CAST(scc->kiss.tx_inhibit);
1386 default: return NO_SUCH_PARAM;
1391 #undef CAST
1393 /* ******************************************************************* */
1394 /* * Send calibration pattern * */
1395 /* ******************************************************************* */
1397 static void scc_stop_calibrate(unsigned long channel)
1399 struct scc_channel *scc = (struct scc_channel *) channel;
1400 unsigned long flags;
1402 spin_lock_irqsave(&scc->lock, flags);
1403 del_timer(&scc->tx_wdog);
1404 scc_key_trx(scc, TX_OFF);
1405 wr(scc, R6, 0);
1406 wr(scc, R7, FLAG);
1407 Outb(scc->ctrl,RES_EXT_INT); /* reset ext/status interrupts */
1408 Outb(scc->ctrl,RES_EXT_INT);
1410 netif_wake_queue(scc->dev);
1411 spin_unlock_irqrestore(&scc->lock, flags);
1415 static void
1416 scc_start_calibrate(struct scc_channel *scc, int duration, unsigned char pattern)
1418 unsigned long flags;
1420 spin_lock_irqsave(&scc->lock, flags);
1421 netif_stop_queue(scc->dev);
1422 scc_discard_buffers(scc);
1424 del_timer(&scc->tx_wdog);
1426 scc->tx_wdog.data = (unsigned long) scc;
1427 scc->tx_wdog.function = scc_stop_calibrate;
1428 scc->tx_wdog.expires = jiffies + HZ*duration;
1429 add_timer(&scc->tx_wdog);
1431 /* This doesn't seem to work. Why not? */
1432 wr(scc, R6, 0);
1433 wr(scc, R7, pattern);
1436 * Don't know if this works.
1437 * Damn, where is my Z8530 programming manual...?
1440 Outb(scc->ctrl,RES_EXT_INT); /* reset ext/status interrupts */
1441 Outb(scc->ctrl,RES_EXT_INT);
1443 scc_key_trx(scc, TX_ON);
1444 spin_unlock_irqrestore(&scc->lock, flags);
1447 /* ******************************************************************* */
1448 /* * Init channel structures, special HW, etc... * */
1449 /* ******************************************************************* */
1452 * Reset the Z8530s and setup special hardware
1455 static void z8530_init(void)
1457 struct scc_channel *scc;
1458 int chip, k;
1459 unsigned long flags;
1460 char *flag;
1463 printk(KERN_INFO "Init Z8530 driver: %u channels, IRQ", Nchips*2);
1465 flag=" ";
1466 for (k = 0; k < NR_IRQS; k++)
1467 if (Ivec[k].used)
1469 printk("%s%d", flag, k);
1470 flag=",";
1472 printk("\n");
1475 /* reset and pre-init all chips in the system */
1476 for (chip = 0; chip < Nchips; chip++)
1478 scc=&SCC_Info[2*chip];
1479 if (!scc->ctrl) continue;
1481 /* Special SCC cards */
1483 if(scc->brand & EAGLE) /* this is an EAGLE card */
1484 Outb(scc->special,0x08); /* enable interrupt on the board */
1486 if(scc->brand & (PC100 | PRIMUS)) /* this is a PC100/PRIMUS card */
1487 Outb(scc->special,scc->option); /* set the MODEM mode (0x22) */
1490 /* Reset and pre-init Z8530 */
1492 spin_lock_irqsave(&scc->lock, flags);
1494 Outb(scc->ctrl, 0);
1495 OutReg(scc->ctrl,R9,FHWRES); /* force hardware reset */
1496 udelay(100); /* give it 'a bit' more time than required */
1497 wr(scc, R2, chip*16); /* interrupt vector */
1498 wr(scc, R9, VIS); /* vector includes status */
1499 spin_unlock_irqrestore(&scc->lock, flags);
1503 Driver_Initialized = 1;
1507 * Allocate device structure, err, instance, and register driver
1510 static int scc_net_alloc(const char *name, struct scc_channel *scc)
1512 int err;
1513 struct net_device *dev;
1515 dev = alloc_netdev(0, name, scc_net_setup);
1516 if (!dev)
1517 return -ENOMEM;
1519 dev->priv = scc;
1520 scc->dev = dev;
1521 spin_lock_init(&scc->lock);
1522 init_timer(&scc->tx_t);
1523 init_timer(&scc->tx_wdog);
1525 err = register_netdevice(dev);
1526 if (err) {
1527 printk(KERN_ERR "%s: can't register network device (%d)\n",
1528 name, err);
1529 free_netdev(dev);
1530 scc->dev = NULL;
1531 return err;
1534 return 0;
1539 /* ******************************************************************** */
1540 /* * Network driver methods * */
1541 /* ******************************************************************** */
1543 /* ----> Initialize device <----- */
1545 static void scc_net_setup(struct net_device *dev)
1547 dev->tx_queue_len = 16; /* should be enough... */
1549 dev->open = scc_net_open;
1550 dev->stop = scc_net_close;
1552 dev->hard_start_xmit = scc_net_tx;
1553 dev->hard_header = ax25_hard_header;
1554 dev->rebuild_header = ax25_rebuild_header;
1555 dev->set_mac_address = scc_net_set_mac_address;
1556 dev->get_stats = scc_net_get_stats;
1557 dev->do_ioctl = scc_net_ioctl;
1558 dev->tx_timeout = NULL;
1560 memcpy(dev->broadcast, &ax25_bcast, AX25_ADDR_LEN);
1561 memcpy(dev->dev_addr, &ax25_defaddr, AX25_ADDR_LEN);
1563 dev->flags = 0;
1565 dev->type = ARPHRD_AX25;
1566 dev->hard_header_len = AX25_MAX_HEADER_LEN + AX25_BPQ_HEADER_LEN;
1567 dev->mtu = AX25_DEF_PACLEN;
1568 dev->addr_len = AX25_ADDR_LEN;
1572 /* ----> open network device <---- */
1574 static int scc_net_open(struct net_device *dev)
1576 struct scc_channel *scc = (struct scc_channel *) dev->priv;
1578 if (!scc->init)
1579 return -EINVAL;
1581 scc->tx_buff = NULL;
1582 skb_queue_head_init(&scc->tx_queue);
1584 init_channel(scc);
1586 netif_start_queue(dev);
1587 return 0;
1590 /* ----> close network device <---- */
1592 static int scc_net_close(struct net_device *dev)
1594 struct scc_channel *scc = (struct scc_channel *) dev->priv;
1595 unsigned long flags;
1597 netif_stop_queue(dev);
1599 spin_lock_irqsave(&scc->lock, flags);
1600 Outb(scc->ctrl,0); /* Make sure pointer is written */
1601 wr(scc,R1,0); /* disable interrupts */
1602 wr(scc,R3,0);
1603 spin_unlock_irqrestore(&scc->lock, flags);
1605 del_timer_sync(&scc->tx_t);
1606 del_timer_sync(&scc->tx_wdog);
1608 scc_discard_buffers(scc);
1610 return 0;
1613 /* ----> receive frame, called from scc_rxint() <---- */
1615 static void scc_net_rx(struct scc_channel *scc, struct sk_buff *skb)
1617 if (skb->len == 0) {
1618 dev_kfree_skb_irq(skb);
1619 return;
1622 scc->dev_stat.rx_packets++;
1623 scc->dev_stat.rx_bytes += skb->len;
1625 skb->protocol = ax25_type_trans(skb, scc->dev);
1627 netif_rx(skb);
1628 scc->dev->last_rx = jiffies;
1629 return;
1632 /* ----> transmit frame <---- */
1634 static int scc_net_tx(struct sk_buff *skb, struct net_device *dev)
1636 struct scc_channel *scc = (struct scc_channel *) dev->priv;
1637 unsigned long flags;
1638 char kisscmd;
1640 if (skb->len > scc->stat.bufsize || skb->len < 2) {
1641 scc->dev_stat.tx_dropped++; /* bogus frame */
1642 dev_kfree_skb(skb);
1643 return 0;
1646 scc->dev_stat.tx_packets++;
1647 scc->dev_stat.tx_bytes += skb->len;
1648 scc->stat.txframes++;
1650 kisscmd = *skb->data & 0x1f;
1651 skb_pull(skb, 1);
1653 if (kisscmd) {
1654 scc_set_param(scc, kisscmd, *skb->data);
1655 dev_kfree_skb(skb);
1656 return 0;
1659 spin_lock_irqsave(&scc->lock, flags);
1661 if (skb_queue_len(&scc->tx_queue) > scc->dev->tx_queue_len) {
1662 struct sk_buff *skb_del;
1663 skb_del = skb_dequeue(&scc->tx_queue);
1664 dev_kfree_skb(skb_del);
1666 skb_queue_tail(&scc->tx_queue, skb);
1667 dev->trans_start = jiffies;
1671 * Start transmission if the trx state is idle or
1672 * t_idle hasn't expired yet. Use dwait/persistence/slottime
1673 * algorithm for normal halfduplex operation.
1676 if(scc->stat.tx_state == TXS_IDLE || scc->stat.tx_state == TXS_IDLE2) {
1677 scc->stat.tx_state = TXS_BUSY;
1678 if (scc->kiss.fulldup == KISS_DUPLEX_HALF)
1679 __scc_start_tx_timer(scc, t_dwait, scc->kiss.waittime);
1680 else
1681 __scc_start_tx_timer(scc, t_dwait, 0);
1683 spin_unlock_irqrestore(&scc->lock, flags);
1684 return 0;
1687 /* ----> ioctl functions <---- */
1690 * SIOCSCCCFG - configure driver arg: (struct scc_hw_config *) arg
1691 * SIOCSCCINI - initialize driver arg: ---
1692 * SIOCSCCCHANINI - initialize channel arg: (struct scc_modem *) arg
1693 * SIOCSCCSMEM - set memory arg: (struct scc_mem_config *) arg
1694 * SIOCSCCGKISS - get level 1 parameter arg: (struct scc_kiss_cmd *) arg
1695 * SIOCSCCSKISS - set level 1 parameter arg: (struct scc_kiss_cmd *) arg
1696 * SIOCSCCGSTAT - get driver status arg: (struct scc_stat *) arg
1697 * SIOCSCCCAL - send calib. pattern arg: (struct scc_calibrate *) arg
1700 static int scc_net_ioctl(struct net_device *dev, struct ifreq *ifr, int cmd)
1702 struct scc_kiss_cmd kiss_cmd;
1703 struct scc_mem_config memcfg;
1704 struct scc_hw_config hwcfg;
1705 struct scc_calibrate cal;
1706 struct scc_channel *scc = (struct scc_channel *) dev->priv;
1707 int chan;
1708 unsigned char device_name[IFNAMSIZ];
1709 void __user *arg = ifr->ifr_data;
1712 if (!Driver_Initialized)
1714 if (cmd == SIOCSCCCFG)
1716 int found = 1;
1718 if (!capable(CAP_SYS_RAWIO)) return -EPERM;
1719 if (!arg) return -EFAULT;
1721 if (Nchips >= SCC_MAXCHIPS)
1722 return -EINVAL;
1724 if (copy_from_user(&hwcfg, arg, sizeof(hwcfg)))
1725 return -EFAULT;
1727 if (hwcfg.irq == 2) hwcfg.irq = 9;
1729 if (hwcfg.irq < 0 || hwcfg.irq >= NR_IRQS)
1730 return -EINVAL;
1732 if (!Ivec[hwcfg.irq].used && hwcfg.irq)
1734 if (request_irq(hwcfg.irq, scc_isr, IRQF_DISABLED, "AX.25 SCC", NULL))
1735 printk(KERN_WARNING "z8530drv: warning, cannot get IRQ %d\n", hwcfg.irq);
1736 else
1737 Ivec[hwcfg.irq].used = 1;
1740 if (hwcfg.vector_latch && !Vector_Latch) {
1741 if (!request_region(hwcfg.vector_latch, 1, "scc vector latch"))
1742 printk(KERN_WARNING "z8530drv: warning, cannot reserve vector latch port 0x%lx\n, disabled.", hwcfg.vector_latch);
1743 else
1744 Vector_Latch = hwcfg.vector_latch;
1747 if (hwcfg.clock == 0)
1748 hwcfg.clock = SCC_DEFAULT_CLOCK;
1750 #ifndef SCC_DONT_CHECK
1752 if(request_region(hwcfg.ctrl_a, 1, "scc-probe"))
1754 disable_irq(hwcfg.irq);
1755 Outb(hwcfg.ctrl_a, 0);
1756 OutReg(hwcfg.ctrl_a, R9, FHWRES);
1757 udelay(100);
1758 OutReg(hwcfg.ctrl_a,R13,0x55); /* is this chip really there? */
1759 udelay(5);
1761 if (InReg(hwcfg.ctrl_a,R13) != 0x55)
1762 found = 0;
1763 enable_irq(hwcfg.irq);
1764 release_region(hwcfg.ctrl_a, 1);
1766 else
1767 found = 0;
1768 #endif
1770 if (found)
1772 SCC_Info[2*Nchips ].ctrl = hwcfg.ctrl_a;
1773 SCC_Info[2*Nchips ].data = hwcfg.data_a;
1774 SCC_Info[2*Nchips ].irq = hwcfg.irq;
1775 SCC_Info[2*Nchips+1].ctrl = hwcfg.ctrl_b;
1776 SCC_Info[2*Nchips+1].data = hwcfg.data_b;
1777 SCC_Info[2*Nchips+1].irq = hwcfg.irq;
1779 SCC_ctrl[Nchips].chan_A = hwcfg.ctrl_a;
1780 SCC_ctrl[Nchips].chan_B = hwcfg.ctrl_b;
1781 SCC_ctrl[Nchips].irq = hwcfg.irq;
1785 for (chan = 0; chan < 2; chan++)
1787 sprintf(device_name, "%s%i", SCC_DriverName, 2*Nchips+chan);
1789 SCC_Info[2*Nchips+chan].special = hwcfg.special;
1790 SCC_Info[2*Nchips+chan].clock = hwcfg.clock;
1791 SCC_Info[2*Nchips+chan].brand = hwcfg.brand;
1792 SCC_Info[2*Nchips+chan].option = hwcfg.option;
1793 SCC_Info[2*Nchips+chan].enhanced = hwcfg.escc;
1795 #ifdef SCC_DONT_CHECK
1796 printk(KERN_INFO "%s: data port = 0x%3.3x control port = 0x%3.3x\n",
1797 device_name,
1798 SCC_Info[2*Nchips+chan].data,
1799 SCC_Info[2*Nchips+chan].ctrl);
1801 #else
1802 printk(KERN_INFO "%s: data port = 0x%3.3lx control port = 0x%3.3lx -- %s\n",
1803 device_name,
1804 chan? hwcfg.data_b : hwcfg.data_a,
1805 chan? hwcfg.ctrl_b : hwcfg.ctrl_a,
1806 found? "found" : "missing");
1807 #endif
1809 if (found)
1811 request_region(SCC_Info[2*Nchips+chan].ctrl, 1, "scc ctrl");
1812 request_region(SCC_Info[2*Nchips+chan].data, 1, "scc data");
1813 if (Nchips+chan != 0 &&
1814 scc_net_alloc(device_name,
1815 &SCC_Info[2*Nchips+chan]))
1816 return -EINVAL;
1820 if (found) Nchips++;
1822 return 0;
1825 if (cmd == SIOCSCCINI)
1827 if (!capable(CAP_SYS_RAWIO))
1828 return -EPERM;
1830 if (Nchips == 0)
1831 return -EINVAL;
1833 z8530_init();
1834 return 0;
1837 return -EINVAL; /* confuse the user */
1840 if (!scc->init)
1842 if (cmd == SIOCSCCCHANINI)
1844 if (!capable(CAP_NET_ADMIN)) return -EPERM;
1845 if (!arg) return -EINVAL;
1847 scc->stat.bufsize = SCC_BUFSIZE;
1849 if (copy_from_user(&scc->modem, arg, sizeof(struct scc_modem)))
1850 return -EINVAL;
1852 /* default KISS Params */
1854 if (scc->modem.speed < 4800)
1856 scc->kiss.txdelay = 36; /* 360 ms */
1857 scc->kiss.persist = 42; /* 25% persistence */ /* was 25 */
1858 scc->kiss.slottime = 16; /* 160 ms */
1859 scc->kiss.tailtime = 4; /* minimal reasonable value */
1860 scc->kiss.fulldup = 0; /* CSMA */
1861 scc->kiss.waittime = 50; /* 500 ms */
1862 scc->kiss.maxkeyup = 10; /* 10 s */
1863 scc->kiss.mintime = 3; /* 3 s */
1864 scc->kiss.idletime = 30; /* 30 s */
1865 scc->kiss.maxdefer = 120; /* 2 min */
1866 scc->kiss.softdcd = 0; /* hardware dcd */
1867 } else {
1868 scc->kiss.txdelay = 10; /* 100 ms */
1869 scc->kiss.persist = 64; /* 25% persistence */ /* was 25 */
1870 scc->kiss.slottime = 8; /* 160 ms */
1871 scc->kiss.tailtime = 1; /* minimal reasonable value */
1872 scc->kiss.fulldup = 0; /* CSMA */
1873 scc->kiss.waittime = 50; /* 500 ms */
1874 scc->kiss.maxkeyup = 7; /* 7 s */
1875 scc->kiss.mintime = 3; /* 3 s */
1876 scc->kiss.idletime = 30; /* 30 s */
1877 scc->kiss.maxdefer = 120; /* 2 min */
1878 scc->kiss.softdcd = 0; /* hardware dcd */
1881 scc->tx_buff = NULL;
1882 skb_queue_head_init(&scc->tx_queue);
1883 scc->init = 1;
1885 return 0;
1888 return -EINVAL;
1891 switch(cmd)
1893 case SIOCSCCRESERVED:
1894 return -ENOIOCTLCMD;
1896 case SIOCSCCSMEM:
1897 if (!capable(CAP_SYS_RAWIO)) return -EPERM;
1898 if (!arg || copy_from_user(&memcfg, arg, sizeof(memcfg)))
1899 return -EINVAL;
1900 scc->stat.bufsize = memcfg.bufsize;
1901 return 0;
1903 case SIOCSCCGSTAT:
1904 if (!arg || copy_to_user(arg, &scc->stat, sizeof(scc->stat)))
1905 return -EINVAL;
1906 return 0;
1908 case SIOCSCCGKISS:
1909 if (!arg || copy_from_user(&kiss_cmd, arg, sizeof(kiss_cmd)))
1910 return -EINVAL;
1911 kiss_cmd.param = scc_get_param(scc, kiss_cmd.command);
1912 if (copy_to_user(arg, &kiss_cmd, sizeof(kiss_cmd)))
1913 return -EINVAL;
1914 return 0;
1916 case SIOCSCCSKISS:
1917 if (!capable(CAP_NET_ADMIN)) return -EPERM;
1918 if (!arg || copy_from_user(&kiss_cmd, arg, sizeof(kiss_cmd)))
1919 return -EINVAL;
1920 return scc_set_param(scc, kiss_cmd.command, kiss_cmd.param);
1922 case SIOCSCCCAL:
1923 if (!capable(CAP_SYS_RAWIO)) return -EPERM;
1924 if (!arg || copy_from_user(&cal, arg, sizeof(cal)) || cal.time == 0)
1925 return -EINVAL;
1927 scc_start_calibrate(scc, cal.time, cal.pattern);
1928 return 0;
1930 default:
1931 return -ENOIOCTLCMD;
1935 return -EINVAL;
1938 /* ----> set interface callsign <---- */
1940 static int scc_net_set_mac_address(struct net_device *dev, void *addr)
1942 struct sockaddr *sa = (struct sockaddr *) addr;
1943 memcpy(dev->dev_addr, sa->sa_data, dev->addr_len);
1944 return 0;
1947 /* ----> get statistics <---- */
1949 static struct net_device_stats *scc_net_get_stats(struct net_device *dev)
1951 struct scc_channel *scc = (struct scc_channel *) dev->priv;
1953 scc->dev_stat.rx_errors = scc->stat.rxerrs + scc->stat.rx_over;
1954 scc->dev_stat.tx_errors = scc->stat.txerrs + scc->stat.tx_under;
1955 scc->dev_stat.rx_fifo_errors = scc->stat.rx_over;
1956 scc->dev_stat.tx_fifo_errors = scc->stat.tx_under;
1958 return &scc->dev_stat;
1961 /* ******************************************************************** */
1962 /* * dump statistics to /proc/net/z8530drv * */
1963 /* ******************************************************************** */
1965 #ifdef CONFIG_PROC_FS
1967 static inline struct scc_channel *scc_net_seq_idx(loff_t pos)
1969 int k;
1971 for (k = 0; k < Nchips*2; ++k) {
1972 if (!SCC_Info[k].init)
1973 continue;
1974 if (pos-- == 0)
1975 return &SCC_Info[k];
1977 return NULL;
1980 static void *scc_net_seq_start(struct seq_file *seq, loff_t *pos)
1982 return *pos ? scc_net_seq_idx(*pos - 1) : SEQ_START_TOKEN;
1986 static void *scc_net_seq_next(struct seq_file *seq, void *v, loff_t *pos)
1988 unsigned k;
1989 struct scc_channel *scc = v;
1990 ++*pos;
1992 for (k = (v == SEQ_START_TOKEN) ? 0 : (scc - SCC_Info)+1;
1993 k < Nchips*2; ++k) {
1994 if (SCC_Info[k].init)
1995 return &SCC_Info[k];
1997 return NULL;
2000 static void scc_net_seq_stop(struct seq_file *seq, void *v)
2004 static int scc_net_seq_show(struct seq_file *seq, void *v)
2006 if (v == SEQ_START_TOKEN) {
2007 seq_puts(seq, "z8530drv-"VERSION"\n");
2008 } else if (!Driver_Initialized) {
2009 seq_puts(seq, "not initialized\n");
2010 } else if (!Nchips) {
2011 seq_puts(seq, "chips missing\n");
2012 } else {
2013 const struct scc_channel *scc = v;
2014 const struct scc_stat *stat = &scc->stat;
2015 const struct scc_kiss *kiss = &scc->kiss;
2018 /* dev data ctrl irq clock brand enh vector special option
2019 * baud nrz clocksrc softdcd bufsize
2020 * rxints txints exints spints
2021 * rcvd rxerrs over / xmit txerrs under / nospace bufsize
2022 * txd pers slot tail ful wait min maxk idl defr txof grp
2023 * W ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ##
2024 * R ## ## XX ## ## ## ## ## XX ## ## ## ## ## ## ##
2027 seq_printf(seq, "%s\t%3.3lx %3.3lx %d %lu %2.2x %d %3.3lx %3.3lx %d\n",
2028 scc->dev->name,
2029 scc->data, scc->ctrl, scc->irq, scc->clock, scc->brand,
2030 scc->enhanced, Vector_Latch, scc->special,
2031 scc->option);
2032 seq_printf(seq, "\t%lu %d %d %d %d\n",
2033 scc->modem.speed, scc->modem.nrz,
2034 scc->modem.clocksrc, kiss->softdcd,
2035 stat->bufsize);
2036 seq_printf(seq, "\t%lu %lu %lu %lu\n",
2037 stat->rxints, stat->txints, stat->exints, stat->spints);
2038 seq_printf(seq, "\t%lu %lu %d / %lu %lu %d / %d %d\n",
2039 stat->rxframes, stat->rxerrs, stat->rx_over,
2040 stat->txframes, stat->txerrs, stat->tx_under,
2041 stat->nospace, stat->tx_state);
2043 #define K(x) kiss->x
2044 seq_printf(seq, "\t%d %d %d %d %d %d %d %d %d %d %d %d\n",
2045 K(txdelay), K(persist), K(slottime), K(tailtime),
2046 K(fulldup), K(waittime), K(mintime), K(maxkeyup),
2047 K(idletime), K(maxdefer), K(tx_inhibit), K(group));
2048 #undef K
2049 #ifdef SCC_DEBUG
2051 int reg;
2053 seq_printf(seq, "\tW ");
2054 for (reg = 0; reg < 16; reg++)
2055 seq_printf(seq, "%2.2x ", scc->wreg[reg]);
2056 seq_printf(seq, "\n");
2058 seq_printf(seq, "\tR %2.2x %2.2x XX ", InReg(scc->ctrl,R0), InReg(scc->ctrl,R1));
2059 for (reg = 3; reg < 8; reg++)
2060 seq_printf(seq, "%2.2x ", InReg(scc->ctrl, reg));
2061 seq_printf(seq, "XX ");
2062 for (reg = 9; reg < 16; reg++)
2063 seq_printf(seq, "%2.2x ", InReg(scc->ctrl, reg));
2064 seq_printf(seq, "\n");
2066 #endif
2067 seq_putc(seq, '\n');
2070 return 0;
2073 static struct seq_operations scc_net_seq_ops = {
2074 .start = scc_net_seq_start,
2075 .next = scc_net_seq_next,
2076 .stop = scc_net_seq_stop,
2077 .show = scc_net_seq_show,
2081 static int scc_net_seq_open(struct inode *inode, struct file *file)
2083 return seq_open(file, &scc_net_seq_ops);
2086 static const struct file_operations scc_net_seq_fops = {
2087 .owner = THIS_MODULE,
2088 .open = scc_net_seq_open,
2089 .read = seq_read,
2090 .llseek = seq_lseek,
2091 .release = seq_release_private,
2094 #endif /* CONFIG_PROC_FS */
2097 /* ******************************************************************** */
2098 /* * Init SCC driver * */
2099 /* ******************************************************************** */
2101 static int __init scc_init_driver (void)
2103 char devname[IFNAMSIZ];
2105 printk(banner);
2107 sprintf(devname,"%s0", SCC_DriverName);
2109 rtnl_lock();
2110 if (scc_net_alloc(devname, SCC_Info)) {
2111 rtnl_unlock();
2112 printk(KERN_ERR "z8530drv: cannot initialize module\n");
2113 return -EIO;
2115 rtnl_unlock();
2117 proc_net_fops_create("z8530drv", 0, &scc_net_seq_fops);
2119 return 0;
2122 static void __exit scc_cleanup_driver(void)
2124 io_port ctrl;
2125 int k;
2126 struct scc_channel *scc;
2127 struct net_device *dev;
2129 if (Nchips == 0 && (dev = SCC_Info[0].dev))
2131 unregister_netdev(dev);
2132 free_netdev(dev);
2135 /* Guard against chip prattle */
2136 local_irq_disable();
2138 for (k = 0; k < Nchips; k++)
2139 if ( (ctrl = SCC_ctrl[k].chan_A) )
2141 Outb(ctrl, 0);
2142 OutReg(ctrl,R9,FHWRES); /* force hardware reset */
2143 udelay(50);
2146 /* To unload the port must be closed so no real IRQ pending */
2147 for (k=0; k < NR_IRQS ; k++)
2148 if (Ivec[k].used) free_irq(k, NULL);
2150 local_irq_enable();
2152 /* Now clean up */
2153 for (k = 0; k < Nchips*2; k++)
2155 scc = &SCC_Info[k];
2156 if (scc->ctrl)
2158 release_region(scc->ctrl, 1);
2159 release_region(scc->data, 1);
2161 if (scc->dev)
2163 unregister_netdev(scc->dev);
2164 free_netdev(scc->dev);
2169 if (Vector_Latch)
2170 release_region(Vector_Latch, 1);
2172 proc_net_remove("z8530drv");
2175 MODULE_AUTHOR("Joerg Reuter <jreuter@yaina.de>");
2176 MODULE_DESCRIPTION("AX.25 Device Driver for Z8530 based HDLC cards");
2177 MODULE_SUPPORTED_DEVICE("Z8530 based SCC cards for Amateur Radio");
2178 MODULE_LICENSE("GPL");
2179 module_init(scc_init_driver);
2180 module_exit(scc_cleanup_driver);