[PATCH] aic7xxx_osm build fix
[cris-mirror.git] / drivers / net / hamradio / scc.c
blobece1b1a1318632da085d4e0a855bf4c2cb7a5e7f
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/config.h>
152 #include <linux/module.h>
153 #include <linux/errno.h>
154 #include <linux/signal.h>
155 #include <linux/timer.h>
156 #include <linux/interrupt.h>
157 #include <linux/ioport.h>
158 #include <linux/string.h>
159 #include <linux/in.h>
160 #include <linux/fcntl.h>
161 #include <linux/ptrace.h>
162 #include <linux/slab.h>
163 #include <linux/delay.h>
164 #include <linux/skbuff.h>
165 #include <linux/netdevice.h>
166 #include <linux/rtnetlink.h>
167 #include <linux/if_ether.h>
168 #include <linux/if_arp.h>
169 #include <linux/socket.h>
170 #include <linux/init.h>
171 #include <linux/scc.h>
172 #include <linux/ctype.h>
173 #include <linux/kernel.h>
174 #include <linux/proc_fs.h>
175 #include <linux/seq_file.h>
176 #include <linux/bitops.h>
178 #include <net/ax25.h>
180 #include <asm/irq.h>
181 #include <asm/system.h>
182 #include <asm/io.h>
183 #include <asm/uaccess.h>
185 #include "z8530.h"
187 static char banner[] __initdata = KERN_INFO "AX.25: Z8530 SCC driver version "VERSION".dl1bke\n";
189 static void t_dwait(unsigned long);
190 static void t_txdelay(unsigned long);
191 static void t_tail(unsigned long);
192 static void t_busy(unsigned long);
193 static void t_maxkeyup(unsigned long);
194 static void t_idle(unsigned long);
195 static void scc_tx_done(struct scc_channel *);
196 static void scc_start_tx_timer(struct scc_channel *, void (*)(unsigned long), unsigned long);
197 static void scc_start_maxkeyup(struct scc_channel *);
198 static void scc_start_defer(struct scc_channel *);
200 static void z8530_init(void);
202 static void init_channel(struct scc_channel *scc);
203 static void scc_key_trx (struct scc_channel *scc, char tx);
204 static irqreturn_t scc_isr(int irq, void *dev_id, struct pt_regs *regs);
205 static void scc_init_timer(struct scc_channel *scc);
207 static int scc_net_alloc(const char *name, struct scc_channel *scc);
208 static void scc_net_setup(struct net_device *dev);
209 static int scc_net_open(struct net_device *dev);
210 static int scc_net_close(struct net_device *dev);
211 static void scc_net_rx(struct scc_channel *scc, struct sk_buff *skb);
212 static int scc_net_tx(struct sk_buff *skb, struct net_device *dev);
213 static int scc_net_ioctl(struct net_device *dev, struct ifreq *ifr, int cmd);
214 static int scc_net_set_mac_address(struct net_device *dev, void *addr);
215 static struct net_device_stats * scc_net_get_stats(struct net_device *dev);
217 static unsigned char SCC_DriverName[] = "scc";
219 static struct irqflags { unsigned char used : 1; } Ivec[NR_IRQS];
221 static struct scc_channel SCC_Info[2 * SCC_MAXCHIPS]; /* information per channel */
223 static struct scc_ctrl {
224 io_port chan_A;
225 io_port chan_B;
226 int irq;
227 } SCC_ctrl[SCC_MAXCHIPS+1];
229 static unsigned char Driver_Initialized;
230 static int Nchips;
231 static io_port Vector_Latch;
234 /* ******************************************************************** */
235 /* * Port Access Functions * */
236 /* ******************************************************************** */
238 /* These provide interrupt save 2-step access to the Z8530 registers */
240 static DEFINE_SPINLOCK(iolock); /* Guards paired accesses */
242 static inline unsigned char InReg(io_port port, unsigned char reg)
244 unsigned long flags;
245 unsigned char r;
247 spin_lock_irqsave(&iolock, flags);
248 #ifdef SCC_LDELAY
249 Outb(port, reg);
250 udelay(SCC_LDELAY);
251 r=Inb(port);
252 udelay(SCC_LDELAY);
253 #else
254 Outb(port, reg);
255 r=Inb(port);
256 #endif
257 spin_unlock_irqrestore(&iolock, flags);
258 return r;
261 static inline void OutReg(io_port port, unsigned char reg, unsigned char val)
263 unsigned long flags;
265 spin_lock_irqsave(&iolock, flags);
266 #ifdef SCC_LDELAY
267 Outb(port, reg); udelay(SCC_LDELAY);
268 Outb(port, val); udelay(SCC_LDELAY);
269 #else
270 Outb(port, reg);
271 Outb(port, val);
272 #endif
273 spin_unlock_irqrestore(&iolock, flags);
276 static inline void wr(struct scc_channel *scc, unsigned char reg,
277 unsigned char val)
279 OutReg(scc->ctrl, reg, (scc->wreg[reg] = val));
282 static inline void or(struct scc_channel *scc, unsigned char reg, unsigned char val)
284 OutReg(scc->ctrl, reg, (scc->wreg[reg] |= val));
287 static inline void cl(struct scc_channel *scc, unsigned char reg, unsigned char val)
289 OutReg(scc->ctrl, reg, (scc->wreg[reg] &= ~val));
292 /* ******************************************************************** */
293 /* * Some useful macros * */
294 /* ******************************************************************** */
296 static inline void scc_discard_buffers(struct scc_channel *scc)
298 unsigned long flags;
300 spin_lock_irqsave(&scc->lock, flags);
301 if (scc->tx_buff != NULL)
303 dev_kfree_skb(scc->tx_buff);
304 scc->tx_buff = NULL;
307 while (skb_queue_len(&scc->tx_queue))
308 dev_kfree_skb(skb_dequeue(&scc->tx_queue));
310 spin_unlock_irqrestore(&scc->lock, flags);
315 /* ******************************************************************** */
316 /* * Interrupt Service Routines * */
317 /* ******************************************************************** */
320 /* ----> subroutines for the interrupt handlers <---- */
322 static inline void scc_notify(struct scc_channel *scc, int event)
324 struct sk_buff *skb;
325 char *bp;
327 if (scc->kiss.fulldup != KISS_DUPLEX_OPTIMA)
328 return;
330 skb = dev_alloc_skb(2);
331 if (skb != NULL)
333 bp = skb_put(skb, 2);
334 *bp++ = PARAM_HWEVENT;
335 *bp++ = event;
336 scc_net_rx(scc, skb);
337 } else
338 scc->stat.nospace++;
341 static inline void flush_rx_FIFO(struct scc_channel *scc)
343 int k;
345 for (k=0; k<3; k++)
346 Inb(scc->data);
348 if(scc->rx_buff != NULL) /* did we receive something? */
350 scc->stat.rxerrs++; /* then count it as an error */
351 dev_kfree_skb_irq(scc->rx_buff);
352 scc->rx_buff = NULL;
356 static void start_hunt(struct scc_channel *scc)
358 if ((scc->modem.clocksrc != CLK_EXTERNAL))
359 OutReg(scc->ctrl,R14,SEARCH|scc->wreg[R14]); /* DPLL: enter search mode */
360 or(scc,R3,ENT_HM|RxENABLE); /* enable the receiver, hunt mode */
363 /* ----> four different interrupt handlers for Tx, Rx, changing of */
364 /* DCD/CTS and Rx/Tx errors */
366 /* Transmitter interrupt handler */
367 static inline void scc_txint(struct scc_channel *scc)
369 struct sk_buff *skb;
371 scc->stat.txints++;
372 skb = scc->tx_buff;
374 /* send first octet */
376 if (skb == NULL)
378 skb = skb_dequeue(&scc->tx_queue);
379 scc->tx_buff = skb;
380 netif_wake_queue(scc->dev);
382 if (skb == NULL)
384 scc_tx_done(scc);
385 Outb(scc->ctrl, RES_Tx_P);
386 return;
389 if (skb->len == 0) /* Paranoia... */
391 dev_kfree_skb_irq(skb);
392 scc->tx_buff = NULL;
393 scc_tx_done(scc);
394 Outb(scc->ctrl, RES_Tx_P);
395 return;
398 scc->stat.tx_state = TXS_ACTIVE;
400 OutReg(scc->ctrl, R0, RES_Tx_CRC);
401 /* reset CRC generator */
402 or(scc,R10,ABUNDER); /* re-install underrun protection */
403 Outb(scc->data,*skb->data); /* send byte */
404 skb_pull(skb, 1);
406 if (!scc->enhanced) /* reset EOM latch */
407 Outb(scc->ctrl,RES_EOM_L);
408 return;
411 /* End Of Frame... */
413 if (skb->len == 0)
415 Outb(scc->ctrl, RES_Tx_P); /* reset pending int */
416 cl(scc, R10, ABUNDER); /* send CRC */
417 dev_kfree_skb_irq(skb);
418 scc->tx_buff = NULL;
419 scc->stat.tx_state = TXS_NEWFRAME; /* next frame... */
420 return;
423 /* send octet */
425 Outb(scc->data,*skb->data);
426 skb_pull(skb, 1);
430 /* External/Status interrupt handler */
431 static inline void scc_exint(struct scc_channel *scc)
433 unsigned char status,changes,chg_and_stat;
435 scc->stat.exints++;
437 status = InReg(scc->ctrl,R0);
438 changes = status ^ scc->status;
439 chg_and_stat = changes & status;
441 /* ABORT: generated whenever DCD drops while receiving */
443 if (chg_and_stat & BRK_ABRT) /* Received an ABORT */
444 flush_rx_FIFO(scc);
446 /* HUNT: software DCD; on = waiting for SYNC, off = receiving frame */
448 if ((changes & SYNC_HUNT) && scc->kiss.softdcd)
450 if (status & SYNC_HUNT)
452 scc->dcd = 0;
453 flush_rx_FIFO(scc);
454 if ((scc->modem.clocksrc != CLK_EXTERNAL))
455 OutReg(scc->ctrl,R14,SEARCH|scc->wreg[R14]); /* DPLL: enter search mode */
456 } else {
457 scc->dcd = 1;
460 scc_notify(scc, scc->dcd? HWEV_DCD_OFF:HWEV_DCD_ON);
463 /* DCD: on = start to receive packet, off = ABORT condition */
464 /* (a successfully received packet generates a special condition int) */
466 if((changes & DCD) && !scc->kiss.softdcd) /* DCD input changed state */
468 if(status & DCD) /* DCD is now ON */
470 start_hunt(scc);
471 scc->dcd = 1;
472 } else { /* DCD is now OFF */
473 cl(scc,R3,ENT_HM|RxENABLE); /* disable the receiver */
474 flush_rx_FIFO(scc);
475 scc->dcd = 0;
478 scc_notify(scc, scc->dcd? HWEV_DCD_ON:HWEV_DCD_OFF);
481 #ifdef notdef
482 /* CTS: use external TxDelay (what's that good for?!)
483 * Anyway: If we _could_ use it (BayCom USCC uses CTS for
484 * own purposes) we _should_ use the "autoenable" feature
485 * of the Z8530 and not this interrupt...
488 if (chg_and_stat & CTS) /* CTS is now ON */
490 if (scc->kiss.txdelay == 0) /* zero TXDELAY = wait for CTS */
491 scc_start_tx_timer(scc, t_txdelay, 0);
493 #endif
495 if (scc->stat.tx_state == TXS_ACTIVE && (status & TxEOM))
497 scc->stat.tx_under++; /* oops, an underrun! count 'em */
498 Outb(scc->ctrl, RES_EXT_INT); /* reset ext/status interrupts */
500 if (scc->tx_buff != NULL)
502 dev_kfree_skb_irq(scc->tx_buff);
503 scc->tx_buff = NULL;
506 or(scc,R10,ABUNDER);
507 scc_start_tx_timer(scc, t_txdelay, 0); /* restart transmission */
510 scc->status = status;
511 Outb(scc->ctrl,RES_EXT_INT);
515 /* Receiver interrupt handler */
516 static inline void scc_rxint(struct scc_channel *scc)
518 struct sk_buff *skb;
520 scc->stat.rxints++;
522 if((scc->wreg[5] & RTS) && scc->kiss.fulldup == KISS_DUPLEX_HALF)
524 Inb(scc->data); /* discard char */
525 or(scc,R3,ENT_HM); /* enter hunt mode for next flag */
526 return;
529 skb = scc->rx_buff;
531 if (skb == NULL)
533 skb = dev_alloc_skb(scc->stat.bufsize);
534 if (skb == NULL)
536 scc->dev_stat.rx_dropped++;
537 scc->stat.nospace++;
538 Inb(scc->data);
539 or(scc, R3, ENT_HM);
540 return;
543 scc->rx_buff = skb;
544 *(skb_put(skb, 1)) = 0; /* KISS data */
547 if (skb->len >= scc->stat.bufsize)
549 #ifdef notdef
550 printk(KERN_DEBUG "z8530drv: oops, scc_rxint() received huge frame...\n");
551 #endif
552 dev_kfree_skb_irq(skb);
553 scc->rx_buff = NULL;
554 Inb(scc->data);
555 or(scc, R3, ENT_HM);
556 return;
559 *(skb_put(skb, 1)) = Inb(scc->data);
563 /* Receive Special Condition interrupt handler */
564 static inline void scc_spint(struct scc_channel *scc)
566 unsigned char status;
567 struct sk_buff *skb;
569 scc->stat.spints++;
571 status = InReg(scc->ctrl,R1); /* read receiver status */
573 Inb(scc->data); /* throw away Rx byte */
574 skb = scc->rx_buff;
576 if(status & Rx_OVR) /* receiver overrun */
578 scc->stat.rx_over++; /* count them */
579 or(scc,R3,ENT_HM); /* enter hunt mode for next flag */
581 if (skb != NULL)
582 dev_kfree_skb_irq(skb);
583 scc->rx_buff = skb = NULL;
586 if(status & END_FR && skb != NULL) /* end of frame */
588 /* CRC okay, frame ends on 8 bit boundary and received something ? */
590 if (!(status & CRC_ERR) && (status & 0xe) == RES8 && skb->len > 0)
592 /* ignore last received byte (first of the CRC bytes) */
593 skb_trim(skb, skb->len-1);
594 scc_net_rx(scc, skb);
595 scc->rx_buff = NULL;
596 scc->stat.rxframes++;
597 } else { /* a bad frame */
598 dev_kfree_skb_irq(skb);
599 scc->rx_buff = NULL;
600 scc->stat.rxerrs++;
604 Outb(scc->ctrl,ERR_RES);
608 /* ----> interrupt service routine for the Z8530 <---- */
610 static void scc_isr_dispatch(struct scc_channel *scc, int vector)
612 spin_lock(&scc->lock);
613 switch (vector & VECTOR_MASK)
615 case TXINT: scc_txint(scc); break;
616 case EXINT: scc_exint(scc); break;
617 case RXINT: scc_rxint(scc); break;
618 case SPINT: scc_spint(scc); break;
620 spin_unlock(&scc->lock);
623 /* If the card has a latch for the interrupt vector (like the PA0HZP card)
624 use it to get the number of the chip that generated the int.
625 If not: poll all defined chips.
628 #define SCC_IRQTIMEOUT 30000
630 static irqreturn_t scc_isr(int irq, void *dev_id, struct pt_regs *regs)
632 unsigned char vector;
633 struct scc_channel *scc;
634 struct scc_ctrl *ctrl;
635 int k;
637 if (Vector_Latch)
639 for(k=0; k < SCC_IRQTIMEOUT; k++)
641 Outb(Vector_Latch, 0); /* Generate INTACK */
643 /* Read the vector */
644 if((vector=Inb(Vector_Latch)) >= 16 * Nchips) break;
645 if (vector & 0x01) break;
647 scc=&SCC_Info[vector >> 3 ^ 0x01];
648 if (!scc->dev) break;
650 scc_isr_dispatch(scc, vector);
652 OutReg(scc->ctrl,R0,RES_H_IUS); /* Reset Highest IUS */
655 if (k == SCC_IRQTIMEOUT)
656 printk(KERN_WARNING "z8530drv: endless loop in scc_isr()?\n");
658 return IRQ_HANDLED;
661 /* Find the SCC generating the interrupt by polling all attached SCCs
662 * reading RR3A (the interrupt pending register)
665 ctrl = SCC_ctrl;
666 while (ctrl->chan_A)
668 if (ctrl->irq != irq)
670 ctrl++;
671 continue;
674 scc = NULL;
675 for (k = 0; InReg(ctrl->chan_A,R3) && k < SCC_IRQTIMEOUT; k++)
677 vector=InReg(ctrl->chan_B,R2); /* Read the vector */
678 if (vector & 0x01) break;
680 scc = &SCC_Info[vector >> 3 ^ 0x01];
681 if (!scc->dev) break;
683 scc_isr_dispatch(scc, vector);
686 if (k == SCC_IRQTIMEOUT)
688 printk(KERN_WARNING "z8530drv: endless loop in scc_isr()?!\n");
689 break;
692 /* This looks weird and it is. At least the BayCom USCC doesn't
693 * use the Interrupt Daisy Chain, thus we'll have to start
694 * all over again to be sure not to miss an interrupt from
695 * (any of) the other chip(s)...
696 * Honestly, the situation *is* braindamaged...
699 if (scc != NULL)
701 OutReg(scc->ctrl,R0,RES_H_IUS);
702 ctrl = SCC_ctrl;
703 } else
704 ctrl++;
706 return IRQ_HANDLED;
711 /* ******************************************************************** */
712 /* * Init Channel */
713 /* ******************************************************************** */
716 /* ----> set SCC channel speed <---- */
718 static inline void set_brg(struct scc_channel *scc, unsigned int tc)
720 cl(scc,R14,BRENABL); /* disable baudrate generator */
721 wr(scc,R12,tc & 255); /* brg rate LOW */
722 wr(scc,R13,tc >> 8); /* brg rate HIGH */
723 or(scc,R14,BRENABL); /* enable baudrate generator */
726 static inline void set_speed(struct scc_channel *scc)
728 unsigned long flags;
729 spin_lock_irqsave(&scc->lock, flags);
731 if (scc->modem.speed > 0) /* paranoia... */
732 set_brg(scc, (unsigned) (scc->clock / (scc->modem.speed * 64)) - 2);
734 spin_unlock_irqrestore(&scc->lock, flags);
738 /* ----> initialize a SCC channel <---- */
740 static inline void init_brg(struct scc_channel *scc)
742 wr(scc, R14, BRSRC); /* BRG source = PCLK */
743 OutReg(scc->ctrl, R14, SSBR|scc->wreg[R14]); /* DPLL source = BRG */
744 OutReg(scc->ctrl, R14, SNRZI|scc->wreg[R14]); /* DPLL NRZI mode */
748 * Initialization according to the Z8530 manual (SGS-Thomson's version):
750 * 1. Modes and constants
752 * WR9 11000000 chip reset
753 * WR4 XXXXXXXX Tx/Rx control, async or sync mode
754 * WR1 0XX00X00 select W/REQ (optional)
755 * WR2 XXXXXXXX program interrupt vector
756 * WR3 XXXXXXX0 select Rx control
757 * WR5 XXXX0XXX select Tx control
758 * WR6 XXXXXXXX sync character
759 * WR7 XXXXXXXX sync character
760 * WR9 000X0XXX select interrupt control
761 * WR10 XXXXXXXX miscellaneous control (optional)
762 * WR11 XXXXXXXX clock control
763 * WR12 XXXXXXXX time constant lower byte (optional)
764 * WR13 XXXXXXXX time constant upper byte (optional)
765 * WR14 XXXXXXX0 miscellaneous control
766 * WR14 XXXSSSSS commands (optional)
768 * 2. Enables
770 * WR14 000SSSS1 baud rate enable
771 * WR3 SSSSSSS1 Rx enable
772 * WR5 SSSS1SSS Tx enable
773 * WR0 10000000 reset Tx CRG (optional)
774 * WR1 XSS00S00 DMA enable (optional)
776 * 3. Interrupt status
778 * WR15 XXXXXXXX enable external/status
779 * WR0 00010000 reset external status
780 * WR0 00010000 reset external status twice
781 * WR1 SSSXXSXX enable Rx, Tx and Ext/status
782 * WR9 000SXSSS enable master interrupt enable
784 * 1 = set to one, 0 = reset to zero
785 * X = user defined, S = same as previous init
788 * Note that the implementation differs in some points from above scheme.
792 static void init_channel(struct scc_channel *scc)
794 del_timer(&scc->tx_t);
795 del_timer(&scc->tx_wdog);
797 disable_irq(scc->irq);
799 wr(scc,R4,X1CLK|SDLC); /* *1 clock, SDLC mode */
800 wr(scc,R1,0); /* no W/REQ operation */
801 wr(scc,R3,Rx8|RxCRC_ENAB); /* RX 8 bits/char, CRC, disabled */
802 wr(scc,R5,Tx8|DTR|TxCRC_ENAB); /* TX 8 bits/char, disabled, DTR */
803 wr(scc,R6,0); /* SDLC address zero (not used) */
804 wr(scc,R7,FLAG); /* SDLC flag value */
805 wr(scc,R9,VIS); /* vector includes status */
806 wr(scc,R10,(scc->modem.nrz? NRZ : NRZI)|CRCPS|ABUNDER); /* abort on underrun, preset CRC generator, NRZ(I) */
807 wr(scc,R14, 0);
810 /* set clock sources:
812 CLK_DPLL: normal halfduplex operation
814 RxClk: use DPLL
815 TxClk: use DPLL
816 TRxC mode DPLL output
818 CLK_EXTERNAL: external clocking (G3RUH or DF9IC modem)
820 BayCom: others:
822 TxClk = pin RTxC TxClk = pin TRxC
823 RxClk = pin TRxC RxClk = pin RTxC
826 CLK_DIVIDER:
827 RxClk = use DPLL
828 TxClk = pin RTxC
830 BayCom: others:
831 pin TRxC = DPLL pin TRxC = BRG
832 (RxClk * 1) (RxClk * 32)
836 switch(scc->modem.clocksrc)
838 case CLK_DPLL:
839 wr(scc, R11, RCDPLL|TCDPLL|TRxCOI|TRxCDP);
840 init_brg(scc);
841 break;
843 case CLK_DIVIDER:
844 wr(scc, R11, ((scc->brand & BAYCOM)? TRxCDP : TRxCBR) | RCDPLL|TCRTxCP|TRxCOI);
845 init_brg(scc);
846 break;
848 case CLK_EXTERNAL:
849 wr(scc, R11, (scc->brand & BAYCOM)? RCTRxCP|TCRTxCP : RCRTxCP|TCTRxCP);
850 OutReg(scc->ctrl, R14, DISDPLL);
851 break;
855 set_speed(scc); /* set baudrate */
857 if(scc->enhanced)
859 or(scc,R15,SHDLCE|FIFOE); /* enable FIFO, SDLC/HDLC Enhancements (From now R7 is R7') */
860 wr(scc,R7,AUTOEOM);
863 if(scc->kiss.softdcd || (InReg(scc->ctrl,R0) & DCD))
864 /* DCD is now ON */
866 start_hunt(scc);
869 /* enable ABORT, DCD & SYNC/HUNT interrupts */
871 wr(scc,R15, BRKIE|TxUIE|(scc->kiss.softdcd? SYNCIE:DCDIE));
873 Outb(scc->ctrl,RES_EXT_INT); /* reset ext/status interrupts */
874 Outb(scc->ctrl,RES_EXT_INT); /* must be done twice */
876 or(scc,R1,INT_ALL_Rx|TxINT_ENAB|EXT_INT_ENAB); /* enable interrupts */
878 scc->status = InReg(scc->ctrl,R0); /* read initial status */
880 or(scc,R9,MIE); /* master interrupt enable */
882 scc_init_timer(scc);
884 enable_irq(scc->irq);
890 /* ******************************************************************** */
891 /* * SCC timer functions * */
892 /* ******************************************************************** */
895 /* ----> scc_key_trx sets the time constant for the baudrate
896 generator and keys the transmitter <---- */
898 static void scc_key_trx(struct scc_channel *scc, char tx)
900 unsigned int time_const;
902 if (scc->brand & PRIMUS)
903 Outb(scc->ctrl + 4, scc->option | (tx? 0x80 : 0));
905 if (scc->modem.speed < 300)
906 scc->modem.speed = 1200;
908 time_const = (unsigned) (scc->clock / (scc->modem.speed * (tx? 2:64))) - 2;
910 disable_irq(scc->irq);
912 if (tx)
914 or(scc, R1, TxINT_ENAB); /* t_maxkeyup may have reset these */
915 or(scc, R15, TxUIE);
918 if (scc->modem.clocksrc == CLK_DPLL)
919 { /* force simplex operation */
920 if (tx)
922 #ifdef CONFIG_SCC_TRXECHO
923 cl(scc, R3, RxENABLE|ENT_HM); /* switch off receiver */
924 cl(scc, R15, DCDIE|SYNCIE); /* No DCD changes, please */
925 #endif
926 set_brg(scc, time_const); /* reprogram baudrate generator */
928 /* DPLL -> Rx clk, BRG -> Tx CLK, TRxC mode output, TRxC = BRG */
929 wr(scc, R11, RCDPLL|TCBR|TRxCOI|TRxCBR);
931 /* By popular demand: tx_inhibit */
932 if (scc->kiss.tx_inhibit)
934 or(scc,R5, TxENAB);
935 scc->wreg[R5] |= RTS;
936 } else {
937 or(scc,R5,RTS|TxENAB); /* set the RTS line and enable TX */
939 } else {
940 cl(scc,R5,RTS|TxENAB);
942 set_brg(scc, time_const); /* reprogram baudrate generator */
944 /* DPLL -> Rx clk, DPLL -> Tx CLK, TRxC mode output, TRxC = DPLL */
945 wr(scc, R11, RCDPLL|TCDPLL|TRxCOI|TRxCDP);
947 #ifndef CONFIG_SCC_TRXECHO
948 if (scc->kiss.softdcd)
949 #endif
951 or(scc,R15, scc->kiss.softdcd? SYNCIE:DCDIE);
952 start_hunt(scc);
955 } else {
956 if (tx)
958 #ifdef CONFIG_SCC_TRXECHO
959 if (scc->kiss.fulldup == KISS_DUPLEX_HALF)
961 cl(scc, R3, RxENABLE);
962 cl(scc, R15, DCDIE|SYNCIE);
964 #endif
966 if (scc->kiss.tx_inhibit)
968 or(scc,R5, TxENAB);
969 scc->wreg[R5] |= RTS;
970 } else {
971 or(scc,R5,RTS|TxENAB); /* enable tx */
973 } else {
974 cl(scc,R5,RTS|TxENAB); /* disable tx */
976 if ((scc->kiss.fulldup == KISS_DUPLEX_HALF) &&
977 #ifndef CONFIG_SCC_TRXECHO
978 scc->kiss.softdcd)
979 #else
981 #endif
983 or(scc, R15, scc->kiss.softdcd? SYNCIE:DCDIE);
984 start_hunt(scc);
989 enable_irq(scc->irq);
993 /* ----> SCC timer interrupt handler and friends. <---- */
995 static void __scc_start_tx_timer(struct scc_channel *scc, void (*handler)(unsigned long), unsigned long when)
997 del_timer(&scc->tx_t);
999 if (when == 0)
1001 handler((unsigned long) scc);
1002 } else
1003 if (when != TIMER_OFF)
1005 scc->tx_t.data = (unsigned long) scc;
1006 scc->tx_t.function = handler;
1007 scc->tx_t.expires = jiffies + (when*HZ)/100;
1008 add_timer(&scc->tx_t);
1012 static void scc_start_tx_timer(struct scc_channel *scc, void (*handler)(unsigned long), unsigned long when)
1014 unsigned long flags;
1016 spin_lock_irqsave(&scc->lock, flags);
1017 __scc_start_tx_timer(scc, handler, when);
1018 spin_unlock_irqrestore(&scc->lock, flags);
1021 static void scc_start_defer(struct scc_channel *scc)
1023 unsigned long flags;
1025 spin_lock_irqsave(&scc->lock, flags);
1026 del_timer(&scc->tx_wdog);
1028 if (scc->kiss.maxdefer != 0 && scc->kiss.maxdefer != TIMER_OFF)
1030 scc->tx_wdog.data = (unsigned long) scc;
1031 scc->tx_wdog.function = t_busy;
1032 scc->tx_wdog.expires = jiffies + HZ*scc->kiss.maxdefer;
1033 add_timer(&scc->tx_wdog);
1035 spin_unlock_irqrestore(&scc->lock, flags);
1038 static void scc_start_maxkeyup(struct scc_channel *scc)
1040 unsigned long flags;
1042 spin_lock_irqsave(&scc->lock, flags);
1043 del_timer(&scc->tx_wdog);
1045 if (scc->kiss.maxkeyup != 0 && scc->kiss.maxkeyup != TIMER_OFF)
1047 scc->tx_wdog.data = (unsigned long) scc;
1048 scc->tx_wdog.function = t_maxkeyup;
1049 scc->tx_wdog.expires = jiffies + HZ*scc->kiss.maxkeyup;
1050 add_timer(&scc->tx_wdog);
1052 spin_unlock_irqrestore(&scc->lock, flags);
1056 * This is called from scc_txint() when there are no more frames to send.
1057 * Not exactly a timer function, but it is a close friend of the family...
1060 static void scc_tx_done(struct scc_channel *scc)
1063 * trx remains keyed in fulldup mode 2 until t_idle expires.
1066 switch (scc->kiss.fulldup)
1068 case KISS_DUPLEX_LINK:
1069 scc->stat.tx_state = TXS_IDLE2;
1070 if (scc->kiss.idletime != TIMER_OFF)
1071 scc_start_tx_timer(scc, t_idle, scc->kiss.idletime*100);
1072 break;
1073 case KISS_DUPLEX_OPTIMA:
1074 scc_notify(scc, HWEV_ALL_SENT);
1075 break;
1076 default:
1077 scc->stat.tx_state = TXS_BUSY;
1078 scc_start_tx_timer(scc, t_tail, scc->kiss.tailtime);
1081 netif_wake_queue(scc->dev);
1085 static unsigned char Rand = 17;
1087 static inline int is_grouped(struct scc_channel *scc)
1089 int k;
1090 struct scc_channel *scc2;
1091 unsigned char grp1, grp2;
1093 grp1 = scc->kiss.group;
1095 for (k = 0; k < (Nchips * 2); k++)
1097 scc2 = &SCC_Info[k];
1098 grp2 = scc2->kiss.group;
1100 if (scc2 == scc || !(scc2->dev && grp2))
1101 continue;
1103 if ((grp1 & 0x3f) == (grp2 & 0x3f))
1105 if ( (grp1 & TXGROUP) && (scc2->wreg[R5] & RTS) )
1106 return 1;
1108 if ( (grp1 & RXGROUP) && scc2->dcd )
1109 return 1;
1112 return 0;
1115 /* DWAIT and SLOTTIME expired
1117 * fulldup == 0: DCD is active or Rand > P-persistence: start t_busy timer
1118 * else key trx and start txdelay
1119 * fulldup == 1: key trx and start txdelay
1120 * fulldup == 2: mintime expired, reset status or key trx and start txdelay
1123 static void t_dwait(unsigned long channel)
1125 struct scc_channel *scc = (struct scc_channel *) channel;
1127 if (scc->stat.tx_state == TXS_WAIT) /* maxkeyup or idle timeout */
1129 if (skb_queue_len(&scc->tx_queue) == 0) /* nothing to send */
1131 scc->stat.tx_state = TXS_IDLE;
1132 netif_wake_queue(scc->dev); /* t_maxkeyup locked it. */
1133 return;
1136 scc->stat.tx_state = TXS_BUSY;
1139 if (scc->kiss.fulldup == KISS_DUPLEX_HALF)
1141 Rand = Rand * 17 + 31;
1143 if (scc->dcd || (scc->kiss.persist) < Rand || (scc->kiss.group && is_grouped(scc)) )
1145 scc_start_defer(scc);
1146 scc_start_tx_timer(scc, t_dwait, scc->kiss.slottime);
1147 return ;
1151 if ( !(scc->wreg[R5] & RTS) )
1153 scc_key_trx(scc, TX_ON);
1154 scc_start_tx_timer(scc, t_txdelay, scc->kiss.txdelay);
1155 } else {
1156 scc_start_tx_timer(scc, t_txdelay, 0);
1161 /* TXDELAY expired
1163 * kick transmission by a fake scc_txint(scc), start 'maxkeyup' watchdog.
1166 static void t_txdelay(unsigned long channel)
1168 struct scc_channel *scc = (struct scc_channel *) channel;
1170 scc_start_maxkeyup(scc);
1172 if (scc->tx_buff == NULL)
1174 disable_irq(scc->irq);
1175 scc_txint(scc);
1176 enable_irq(scc->irq);
1181 /* TAILTIME expired
1183 * switch off transmitter. If we were stopped by Maxkeyup restart
1184 * transmission after 'mintime' seconds
1187 static void t_tail(unsigned long channel)
1189 struct scc_channel *scc = (struct scc_channel *) channel;
1190 unsigned long flags;
1192 spin_lock_irqsave(&scc->lock, flags);
1193 del_timer(&scc->tx_wdog);
1194 scc_key_trx(scc, TX_OFF);
1195 spin_unlock_irqrestore(&scc->lock, flags);
1197 if (scc->stat.tx_state == TXS_TIMEOUT) /* we had a timeout? */
1199 scc->stat.tx_state = TXS_WAIT;
1200 scc_start_tx_timer(scc, t_dwait, scc->kiss.mintime*100);
1201 return;
1204 scc->stat.tx_state = TXS_IDLE;
1205 netif_wake_queue(scc->dev);
1209 /* BUSY timeout
1211 * throw away send buffers if DCD remains active too long.
1214 static void t_busy(unsigned long channel)
1216 struct scc_channel *scc = (struct scc_channel *) channel;
1218 del_timer(&scc->tx_t);
1219 netif_stop_queue(scc->dev); /* don't pile on the wabbit! */
1221 scc_discard_buffers(scc);
1222 scc->stat.txerrs++;
1223 scc->stat.tx_state = TXS_IDLE;
1225 netif_wake_queue(scc->dev);
1228 /* MAXKEYUP timeout
1230 * this is our watchdog.
1233 static void t_maxkeyup(unsigned long channel)
1235 struct scc_channel *scc = (struct scc_channel *) channel;
1236 unsigned long flags;
1238 spin_lock_irqsave(&scc->lock, flags);
1240 * let things settle down before we start to
1241 * accept new data.
1244 netif_stop_queue(scc->dev);
1245 scc_discard_buffers(scc);
1247 del_timer(&scc->tx_t);
1249 cl(scc, R1, TxINT_ENAB); /* force an ABORT, but don't */
1250 cl(scc, R15, TxUIE); /* count it. */
1251 OutReg(scc->ctrl, R0, RES_Tx_P);
1253 spin_unlock_irqrestore(&scc->lock, flags);
1255 scc->stat.txerrs++;
1256 scc->stat.tx_state = TXS_TIMEOUT;
1257 scc_start_tx_timer(scc, t_tail, scc->kiss.tailtime);
1260 /* IDLE timeout
1262 * in fulldup mode 2 it keys down the transmitter after 'idle' seconds
1263 * of inactivity. We will not restart transmission before 'mintime'
1264 * expires.
1267 static void t_idle(unsigned long channel)
1269 struct scc_channel *scc = (struct scc_channel *) channel;
1271 del_timer(&scc->tx_wdog);
1273 scc_key_trx(scc, TX_OFF);
1274 if(scc->kiss.mintime)
1275 scc_start_tx_timer(scc, t_dwait, scc->kiss.mintime*100);
1276 scc->stat.tx_state = TXS_WAIT;
1279 static void scc_init_timer(struct scc_channel *scc)
1281 unsigned long flags;
1283 spin_lock_irqsave(&scc->lock, flags);
1284 scc->stat.tx_state = TXS_IDLE;
1285 spin_unlock_irqrestore(&scc->lock, flags);
1289 /* ******************************************************************** */
1290 /* * Set/get L1 parameters * */
1291 /* ******************************************************************** */
1295 * this will set the "hardware" parameters through KISS commands or ioctl()
1298 #define CAST(x) (unsigned long)(x)
1300 static unsigned int scc_set_param(struct scc_channel *scc, unsigned int cmd, unsigned int arg)
1302 switch (cmd)
1304 case PARAM_TXDELAY: scc->kiss.txdelay=arg; break;
1305 case PARAM_PERSIST: scc->kiss.persist=arg; break;
1306 case PARAM_SLOTTIME: scc->kiss.slottime=arg; break;
1307 case PARAM_TXTAIL: scc->kiss.tailtime=arg; break;
1308 case PARAM_FULLDUP: scc->kiss.fulldup=arg; break;
1309 case PARAM_DTR: break; /* does someone need this? */
1310 case PARAM_GROUP: scc->kiss.group=arg; break;
1311 case PARAM_IDLE: scc->kiss.idletime=arg; break;
1312 case PARAM_MIN: scc->kiss.mintime=arg; break;
1313 case PARAM_MAXKEY: scc->kiss.maxkeyup=arg; break;
1314 case PARAM_WAIT: scc->kiss.waittime=arg; break;
1315 case PARAM_MAXDEFER: scc->kiss.maxdefer=arg; break;
1316 case PARAM_TX: scc->kiss.tx_inhibit=arg; break;
1318 case PARAM_SOFTDCD:
1319 scc->kiss.softdcd=arg;
1320 if (arg)
1322 or(scc, R15, SYNCIE);
1323 cl(scc, R15, DCDIE);
1324 start_hunt(scc);
1325 } else {
1326 or(scc, R15, DCDIE);
1327 cl(scc, R15, SYNCIE);
1329 break;
1331 case PARAM_SPEED:
1332 if (arg < 256)
1333 scc->modem.speed=arg*100;
1334 else
1335 scc->modem.speed=arg;
1337 if (scc->stat.tx_state == 0) /* only switch baudrate on rx... ;-) */
1338 set_speed(scc);
1339 break;
1341 case PARAM_RTS:
1342 if ( !(scc->wreg[R5] & RTS) )
1344 if (arg != TX_OFF)
1345 scc_key_trx(scc, TX_ON);
1346 scc_start_tx_timer(scc, t_txdelay, scc->kiss.txdelay);
1347 } else {
1348 if (arg == TX_OFF)
1350 scc->stat.tx_state = TXS_BUSY;
1351 scc_start_tx_timer(scc, t_tail, scc->kiss.tailtime);
1354 break;
1356 case PARAM_HWEVENT:
1357 scc_notify(scc, scc->dcd? HWEV_DCD_ON:HWEV_DCD_OFF);
1358 break;
1360 default: return -EINVAL;
1363 return 0;
1368 static unsigned long scc_get_param(struct scc_channel *scc, unsigned int cmd)
1370 switch (cmd)
1372 case PARAM_TXDELAY: return CAST(scc->kiss.txdelay);
1373 case PARAM_PERSIST: return CAST(scc->kiss.persist);
1374 case PARAM_SLOTTIME: return CAST(scc->kiss.slottime);
1375 case PARAM_TXTAIL: return CAST(scc->kiss.tailtime);
1376 case PARAM_FULLDUP: return CAST(scc->kiss.fulldup);
1377 case PARAM_SOFTDCD: return CAST(scc->kiss.softdcd);
1378 case PARAM_DTR: return CAST((scc->wreg[R5] & DTR)? 1:0);
1379 case PARAM_RTS: return CAST((scc->wreg[R5] & RTS)? 1:0);
1380 case PARAM_SPEED: return CAST(scc->modem.speed);
1381 case PARAM_GROUP: return CAST(scc->kiss.group);
1382 case PARAM_IDLE: return CAST(scc->kiss.idletime);
1383 case PARAM_MIN: return CAST(scc->kiss.mintime);
1384 case PARAM_MAXKEY: return CAST(scc->kiss.maxkeyup);
1385 case PARAM_WAIT: return CAST(scc->kiss.waittime);
1386 case PARAM_MAXDEFER: return CAST(scc->kiss.maxdefer);
1387 case PARAM_TX: return CAST(scc->kiss.tx_inhibit);
1388 default: return NO_SUCH_PARAM;
1393 #undef CAST
1395 /* ******************************************************************* */
1396 /* * Send calibration pattern * */
1397 /* ******************************************************************* */
1399 static void scc_stop_calibrate(unsigned long channel)
1401 struct scc_channel *scc = (struct scc_channel *) channel;
1402 unsigned long flags;
1404 spin_lock_irqsave(&scc->lock, flags);
1405 del_timer(&scc->tx_wdog);
1406 scc_key_trx(scc, TX_OFF);
1407 wr(scc, R6, 0);
1408 wr(scc, R7, FLAG);
1409 Outb(scc->ctrl,RES_EXT_INT); /* reset ext/status interrupts */
1410 Outb(scc->ctrl,RES_EXT_INT);
1412 netif_wake_queue(scc->dev);
1413 spin_unlock_irqrestore(&scc->lock, flags);
1417 static void
1418 scc_start_calibrate(struct scc_channel *scc, int duration, unsigned char pattern)
1420 unsigned long flags;
1422 spin_lock_irqsave(&scc->lock, flags);
1423 netif_stop_queue(scc->dev);
1424 scc_discard_buffers(scc);
1426 del_timer(&scc->tx_wdog);
1428 scc->tx_wdog.data = (unsigned long) scc;
1429 scc->tx_wdog.function = scc_stop_calibrate;
1430 scc->tx_wdog.expires = jiffies + HZ*duration;
1431 add_timer(&scc->tx_wdog);
1433 /* This doesn't seem to work. Why not? */
1434 wr(scc, R6, 0);
1435 wr(scc, R7, pattern);
1438 * Don't know if this works.
1439 * Damn, where is my Z8530 programming manual...?
1442 Outb(scc->ctrl,RES_EXT_INT); /* reset ext/status interrupts */
1443 Outb(scc->ctrl,RES_EXT_INT);
1445 scc_key_trx(scc, TX_ON);
1446 spin_unlock_irqrestore(&scc->lock, flags);
1449 /* ******************************************************************* */
1450 /* * Init channel structures, special HW, etc... * */
1451 /* ******************************************************************* */
1454 * Reset the Z8530s and setup special hardware
1457 static void z8530_init(void)
1459 struct scc_channel *scc;
1460 int chip, k;
1461 unsigned long flags;
1462 char *flag;
1465 printk(KERN_INFO "Init Z8530 driver: %u channels, IRQ", Nchips*2);
1467 flag=" ";
1468 for (k = 0; k < NR_IRQS; k++)
1469 if (Ivec[k].used)
1471 printk("%s%d", flag, k);
1472 flag=",";
1474 printk("\n");
1477 /* reset and pre-init all chips in the system */
1478 for (chip = 0; chip < Nchips; chip++)
1480 scc=&SCC_Info[2*chip];
1481 if (!scc->ctrl) continue;
1483 /* Special SCC cards */
1485 if(scc->brand & EAGLE) /* this is an EAGLE card */
1486 Outb(scc->special,0x08); /* enable interrupt on the board */
1488 if(scc->brand & (PC100 | PRIMUS)) /* this is a PC100/PRIMUS card */
1489 Outb(scc->special,scc->option); /* set the MODEM mode (0x22) */
1492 /* Reset and pre-init Z8530 */
1494 spin_lock_irqsave(&scc->lock, flags);
1496 Outb(scc->ctrl, 0);
1497 OutReg(scc->ctrl,R9,FHWRES); /* force hardware reset */
1498 udelay(100); /* give it 'a bit' more time than required */
1499 wr(scc, R2, chip*16); /* interrupt vector */
1500 wr(scc, R9, VIS); /* vector includes status */
1501 spin_unlock_irqrestore(&scc->lock, flags);
1505 Driver_Initialized = 1;
1509 * Allocate device structure, err, instance, and register driver
1512 static int scc_net_alloc(const char *name, struct scc_channel *scc)
1514 int err;
1515 struct net_device *dev;
1517 dev = alloc_netdev(0, name, scc_net_setup);
1518 if (!dev)
1519 return -ENOMEM;
1521 dev->priv = scc;
1522 scc->dev = dev;
1523 spin_lock_init(&scc->lock);
1524 init_timer(&scc->tx_t);
1525 init_timer(&scc->tx_wdog);
1527 err = register_netdevice(dev);
1528 if (err) {
1529 printk(KERN_ERR "%s: can't register network device (%d)\n",
1530 name, err);
1531 free_netdev(dev);
1532 scc->dev = NULL;
1533 return err;
1536 return 0;
1541 /* ******************************************************************** */
1542 /* * Network driver methods * */
1543 /* ******************************************************************** */
1545 static unsigned char ax25_bcast[AX25_ADDR_LEN] =
1546 {'Q' << 1, 'S' << 1, 'T' << 1, ' ' << 1, ' ' << 1, ' ' << 1, '0' << 1};
1547 static unsigned char ax25_nocall[AX25_ADDR_LEN] =
1548 {'L' << 1, 'I' << 1, 'N' << 1, 'U' << 1, 'X' << 1, ' ' << 1, '1' << 1};
1550 /* ----> Initialize device <----- */
1552 static void scc_net_setup(struct net_device *dev)
1554 SET_MODULE_OWNER(dev);
1555 dev->tx_queue_len = 16; /* should be enough... */
1557 dev->open = scc_net_open;
1558 dev->stop = scc_net_close;
1560 dev->hard_start_xmit = scc_net_tx;
1561 dev->hard_header = ax25_encapsulate;
1562 dev->rebuild_header = ax25_rebuild_header;
1563 dev->set_mac_address = scc_net_set_mac_address;
1564 dev->get_stats = scc_net_get_stats;
1565 dev->do_ioctl = scc_net_ioctl;
1566 dev->tx_timeout = NULL;
1568 memcpy(dev->broadcast, ax25_bcast, AX25_ADDR_LEN);
1569 memcpy(dev->dev_addr, ax25_nocall, AX25_ADDR_LEN);
1571 dev->flags = 0;
1573 dev->type = ARPHRD_AX25;
1574 dev->hard_header_len = AX25_MAX_HEADER_LEN + AX25_BPQ_HEADER_LEN;
1575 dev->mtu = AX25_DEF_PACLEN;
1576 dev->addr_len = AX25_ADDR_LEN;
1580 /* ----> open network device <---- */
1582 static int scc_net_open(struct net_device *dev)
1584 struct scc_channel *scc = (struct scc_channel *) dev->priv;
1586 if (!scc->init)
1587 return -EINVAL;
1589 scc->tx_buff = NULL;
1590 skb_queue_head_init(&scc->tx_queue);
1592 init_channel(scc);
1594 netif_start_queue(dev);
1595 return 0;
1598 /* ----> close network device <---- */
1600 static int scc_net_close(struct net_device *dev)
1602 struct scc_channel *scc = (struct scc_channel *) dev->priv;
1603 unsigned long flags;
1605 netif_stop_queue(dev);
1607 spin_lock_irqsave(&scc->lock, flags);
1608 Outb(scc->ctrl,0); /* Make sure pointer is written */
1609 wr(scc,R1,0); /* disable interrupts */
1610 wr(scc,R3,0);
1611 spin_unlock_irqrestore(&scc->lock, flags);
1613 del_timer_sync(&scc->tx_t);
1614 del_timer_sync(&scc->tx_wdog);
1616 scc_discard_buffers(scc);
1618 return 0;
1621 /* ----> receive frame, called from scc_rxint() <---- */
1623 static void scc_net_rx(struct scc_channel *scc, struct sk_buff *skb)
1625 if (skb->len == 0) {
1626 dev_kfree_skb_irq(skb);
1627 return;
1630 scc->dev_stat.rx_packets++;
1631 scc->dev_stat.rx_bytes += skb->len;
1633 skb->protocol = ax25_type_trans(skb, scc->dev);
1635 netif_rx(skb);
1636 scc->dev->last_rx = jiffies;
1637 return;
1640 /* ----> transmit frame <---- */
1642 static int scc_net_tx(struct sk_buff *skb, struct net_device *dev)
1644 struct scc_channel *scc = (struct scc_channel *) dev->priv;
1645 unsigned long flags;
1646 char kisscmd;
1648 if (skb->len > scc->stat.bufsize || skb->len < 2) {
1649 scc->dev_stat.tx_dropped++; /* bogus frame */
1650 dev_kfree_skb(skb);
1651 return 0;
1654 scc->dev_stat.tx_packets++;
1655 scc->dev_stat.tx_bytes += skb->len;
1656 scc->stat.txframes++;
1658 kisscmd = *skb->data & 0x1f;
1659 skb_pull(skb, 1);
1661 if (kisscmd) {
1662 scc_set_param(scc, kisscmd, *skb->data);
1663 dev_kfree_skb(skb);
1664 return 0;
1667 spin_lock_irqsave(&scc->lock, flags);
1669 if (skb_queue_len(&scc->tx_queue) > scc->dev->tx_queue_len) {
1670 struct sk_buff *skb_del;
1671 skb_del = skb_dequeue(&scc->tx_queue);
1672 dev_kfree_skb(skb_del);
1674 skb_queue_tail(&scc->tx_queue, skb);
1675 dev->trans_start = jiffies;
1679 * Start transmission if the trx state is idle or
1680 * t_idle hasn't expired yet. Use dwait/persistence/slottime
1681 * algorithm for normal halfduplex operation.
1684 if(scc->stat.tx_state == TXS_IDLE || scc->stat.tx_state == TXS_IDLE2) {
1685 scc->stat.tx_state = TXS_BUSY;
1686 if (scc->kiss.fulldup == KISS_DUPLEX_HALF)
1687 __scc_start_tx_timer(scc, t_dwait, scc->kiss.waittime);
1688 else
1689 __scc_start_tx_timer(scc, t_dwait, 0);
1691 spin_unlock_irqrestore(&scc->lock, flags);
1692 return 0;
1695 /* ----> ioctl functions <---- */
1698 * SIOCSCCCFG - configure driver arg: (struct scc_hw_config *) arg
1699 * SIOCSCCINI - initialize driver arg: ---
1700 * SIOCSCCCHANINI - initialize channel arg: (struct scc_modem *) arg
1701 * SIOCSCCSMEM - set memory arg: (struct scc_mem_config *) arg
1702 * SIOCSCCGKISS - get level 1 parameter arg: (struct scc_kiss_cmd *) arg
1703 * SIOCSCCSKISS - set level 1 parameter arg: (struct scc_kiss_cmd *) arg
1704 * SIOCSCCGSTAT - get driver status arg: (struct scc_stat *) arg
1705 * SIOCSCCCAL - send calib. pattern arg: (struct scc_calibrate *) arg
1708 static int scc_net_ioctl(struct net_device *dev, struct ifreq *ifr, int cmd)
1710 struct scc_kiss_cmd kiss_cmd;
1711 struct scc_mem_config memcfg;
1712 struct scc_hw_config hwcfg;
1713 struct scc_calibrate cal;
1714 struct scc_channel *scc = (struct scc_channel *) dev->priv;
1715 int chan;
1716 unsigned char device_name[IFNAMSIZ];
1717 void __user *arg = ifr->ifr_data;
1720 if (!Driver_Initialized)
1722 if (cmd == SIOCSCCCFG)
1724 int found = 1;
1726 if (!capable(CAP_SYS_RAWIO)) return -EPERM;
1727 if (!arg) return -EFAULT;
1729 if (Nchips >= SCC_MAXCHIPS)
1730 return -EINVAL;
1732 if (copy_from_user(&hwcfg, arg, sizeof(hwcfg)))
1733 return -EFAULT;
1735 if (hwcfg.irq == 2) hwcfg.irq = 9;
1737 if (hwcfg.irq < 0 || hwcfg.irq >= NR_IRQS)
1738 return -EINVAL;
1740 if (!Ivec[hwcfg.irq].used && hwcfg.irq)
1742 if (request_irq(hwcfg.irq, scc_isr, SA_INTERRUPT, "AX.25 SCC", NULL))
1743 printk(KERN_WARNING "z8530drv: warning, cannot get IRQ %d\n", hwcfg.irq);
1744 else
1745 Ivec[hwcfg.irq].used = 1;
1748 if (hwcfg.vector_latch && !Vector_Latch) {
1749 if (!request_region(hwcfg.vector_latch, 1, "scc vector latch"))
1750 printk(KERN_WARNING "z8530drv: warning, cannot reserve vector latch port 0x%lx\n, disabled.", hwcfg.vector_latch);
1751 else
1752 Vector_Latch = hwcfg.vector_latch;
1755 if (hwcfg.clock == 0)
1756 hwcfg.clock = SCC_DEFAULT_CLOCK;
1758 #ifndef SCC_DONT_CHECK
1760 if(request_region(hwcfg.ctrl_a, 1, "scc-probe"))
1762 disable_irq(hwcfg.irq);
1763 Outb(hwcfg.ctrl_a, 0);
1764 OutReg(hwcfg.ctrl_a, R9, FHWRES);
1765 udelay(100);
1766 OutReg(hwcfg.ctrl_a,R13,0x55); /* is this chip really there? */
1767 udelay(5);
1769 if (InReg(hwcfg.ctrl_a,R13) != 0x55)
1770 found = 0;
1771 enable_irq(hwcfg.irq);
1772 release_region(hwcfg.ctrl_a, 1);
1774 else
1775 found = 0;
1776 #endif
1778 if (found)
1780 SCC_Info[2*Nchips ].ctrl = hwcfg.ctrl_a;
1781 SCC_Info[2*Nchips ].data = hwcfg.data_a;
1782 SCC_Info[2*Nchips ].irq = hwcfg.irq;
1783 SCC_Info[2*Nchips+1].ctrl = hwcfg.ctrl_b;
1784 SCC_Info[2*Nchips+1].data = hwcfg.data_b;
1785 SCC_Info[2*Nchips+1].irq = hwcfg.irq;
1787 SCC_ctrl[Nchips].chan_A = hwcfg.ctrl_a;
1788 SCC_ctrl[Nchips].chan_B = hwcfg.ctrl_b;
1789 SCC_ctrl[Nchips].irq = hwcfg.irq;
1793 for (chan = 0; chan < 2; chan++)
1795 sprintf(device_name, "%s%i", SCC_DriverName, 2*Nchips+chan);
1797 SCC_Info[2*Nchips+chan].special = hwcfg.special;
1798 SCC_Info[2*Nchips+chan].clock = hwcfg.clock;
1799 SCC_Info[2*Nchips+chan].brand = hwcfg.brand;
1800 SCC_Info[2*Nchips+chan].option = hwcfg.option;
1801 SCC_Info[2*Nchips+chan].enhanced = hwcfg.escc;
1803 #ifdef SCC_DONT_CHECK
1804 printk(KERN_INFO "%s: data port = 0x%3.3x control port = 0x%3.3x\n",
1805 device_name,
1806 SCC_Info[2*Nchips+chan].data,
1807 SCC_Info[2*Nchips+chan].ctrl);
1809 #else
1810 printk(KERN_INFO "%s: data port = 0x%3.3lx control port = 0x%3.3lx -- %s\n",
1811 device_name,
1812 chan? hwcfg.data_b : hwcfg.data_a,
1813 chan? hwcfg.ctrl_b : hwcfg.ctrl_a,
1814 found? "found" : "missing");
1815 #endif
1817 if (found)
1819 request_region(SCC_Info[2*Nchips+chan].ctrl, 1, "scc ctrl");
1820 request_region(SCC_Info[2*Nchips+chan].data, 1, "scc data");
1821 if (Nchips+chan != 0 &&
1822 scc_net_alloc(device_name,
1823 &SCC_Info[2*Nchips+chan]))
1824 return -EINVAL;
1828 if (found) Nchips++;
1830 return 0;
1833 if (cmd == SIOCSCCINI)
1835 if (!capable(CAP_SYS_RAWIO))
1836 return -EPERM;
1838 if (Nchips == 0)
1839 return -EINVAL;
1841 z8530_init();
1842 return 0;
1845 return -EINVAL; /* confuse the user */
1848 if (!scc->init)
1850 if (cmd == SIOCSCCCHANINI)
1852 if (!capable(CAP_NET_ADMIN)) return -EPERM;
1853 if (!arg) return -EINVAL;
1855 scc->stat.bufsize = SCC_BUFSIZE;
1857 if (copy_from_user(&scc->modem, arg, sizeof(struct scc_modem)))
1858 return -EINVAL;
1860 /* default KISS Params */
1862 if (scc->modem.speed < 4800)
1864 scc->kiss.txdelay = 36; /* 360 ms */
1865 scc->kiss.persist = 42; /* 25% persistence */ /* was 25 */
1866 scc->kiss.slottime = 16; /* 160 ms */
1867 scc->kiss.tailtime = 4; /* minimal reasonable value */
1868 scc->kiss.fulldup = 0; /* CSMA */
1869 scc->kiss.waittime = 50; /* 500 ms */
1870 scc->kiss.maxkeyup = 10; /* 10 s */
1871 scc->kiss.mintime = 3; /* 3 s */
1872 scc->kiss.idletime = 30; /* 30 s */
1873 scc->kiss.maxdefer = 120; /* 2 min */
1874 scc->kiss.softdcd = 0; /* hardware dcd */
1875 } else {
1876 scc->kiss.txdelay = 10; /* 100 ms */
1877 scc->kiss.persist = 64; /* 25% persistence */ /* was 25 */
1878 scc->kiss.slottime = 8; /* 160 ms */
1879 scc->kiss.tailtime = 1; /* minimal reasonable value */
1880 scc->kiss.fulldup = 0; /* CSMA */
1881 scc->kiss.waittime = 50; /* 500 ms */
1882 scc->kiss.maxkeyup = 7; /* 7 s */
1883 scc->kiss.mintime = 3; /* 3 s */
1884 scc->kiss.idletime = 30; /* 30 s */
1885 scc->kiss.maxdefer = 120; /* 2 min */
1886 scc->kiss.softdcd = 0; /* hardware dcd */
1889 scc->tx_buff = NULL;
1890 skb_queue_head_init(&scc->tx_queue);
1891 scc->init = 1;
1893 return 0;
1896 return -EINVAL;
1899 switch(cmd)
1901 case SIOCSCCRESERVED:
1902 return -ENOIOCTLCMD;
1904 case SIOCSCCSMEM:
1905 if (!capable(CAP_SYS_RAWIO)) return -EPERM;
1906 if (!arg || copy_from_user(&memcfg, arg, sizeof(memcfg)))
1907 return -EINVAL;
1908 scc->stat.bufsize = memcfg.bufsize;
1909 return 0;
1911 case SIOCSCCGSTAT:
1912 if (!arg || copy_to_user(arg, &scc->stat, sizeof(scc->stat)))
1913 return -EINVAL;
1914 return 0;
1916 case SIOCSCCGKISS:
1917 if (!arg || copy_from_user(&kiss_cmd, arg, sizeof(kiss_cmd)))
1918 return -EINVAL;
1919 kiss_cmd.param = scc_get_param(scc, kiss_cmd.command);
1920 if (copy_to_user(arg, &kiss_cmd, sizeof(kiss_cmd)))
1921 return -EINVAL;
1922 return 0;
1924 case SIOCSCCSKISS:
1925 if (!capable(CAP_NET_ADMIN)) return -EPERM;
1926 if (!arg || copy_from_user(&kiss_cmd, arg, sizeof(kiss_cmd)))
1927 return -EINVAL;
1928 return scc_set_param(scc, kiss_cmd.command, kiss_cmd.param);
1930 case SIOCSCCCAL:
1931 if (!capable(CAP_SYS_RAWIO)) return -EPERM;
1932 if (!arg || copy_from_user(&cal, arg, sizeof(cal)) || cal.time == 0)
1933 return -EINVAL;
1935 scc_start_calibrate(scc, cal.time, cal.pattern);
1936 return 0;
1938 default:
1939 return -ENOIOCTLCMD;
1943 return -EINVAL;
1946 /* ----> set interface callsign <---- */
1948 static int scc_net_set_mac_address(struct net_device *dev, void *addr)
1950 struct sockaddr *sa = (struct sockaddr *) addr;
1951 memcpy(dev->dev_addr, sa->sa_data, dev->addr_len);
1952 return 0;
1955 /* ----> get statistics <---- */
1957 static struct net_device_stats *scc_net_get_stats(struct net_device *dev)
1959 struct scc_channel *scc = (struct scc_channel *) dev->priv;
1961 scc->dev_stat.rx_errors = scc->stat.rxerrs + scc->stat.rx_over;
1962 scc->dev_stat.tx_errors = scc->stat.txerrs + scc->stat.tx_under;
1963 scc->dev_stat.rx_fifo_errors = scc->stat.rx_over;
1964 scc->dev_stat.tx_fifo_errors = scc->stat.tx_under;
1966 return &scc->dev_stat;
1969 /* ******************************************************************** */
1970 /* * dump statistics to /proc/net/z8530drv * */
1971 /* ******************************************************************** */
1973 #ifdef CONFIG_PROC_FS
1975 static inline struct scc_channel *scc_net_seq_idx(loff_t pos)
1977 int k;
1979 for (k = 0; k < Nchips*2; ++k) {
1980 if (!SCC_Info[k].init)
1981 continue;
1982 if (pos-- == 0)
1983 return &SCC_Info[k];
1985 return NULL;
1988 static void *scc_net_seq_start(struct seq_file *seq, loff_t *pos)
1990 return *pos ? scc_net_seq_idx(*pos - 1) : SEQ_START_TOKEN;
1994 static void *scc_net_seq_next(struct seq_file *seq, void *v, loff_t *pos)
1996 unsigned k;
1997 struct scc_channel *scc = v;
1998 ++*pos;
2000 for (k = (v == SEQ_START_TOKEN) ? 0 : (scc - SCC_Info)+1;
2001 k < Nchips*2; ++k) {
2002 if (SCC_Info[k].init)
2003 return &SCC_Info[k];
2005 return NULL;
2008 static void scc_net_seq_stop(struct seq_file *seq, void *v)
2012 static int scc_net_seq_show(struct seq_file *seq, void *v)
2014 if (v == SEQ_START_TOKEN) {
2015 seq_puts(seq, "z8530drv-"VERSION"\n");
2016 } else if (!Driver_Initialized) {
2017 seq_puts(seq, "not initialized\n");
2018 } else if (!Nchips) {
2019 seq_puts(seq, "chips missing\n");
2020 } else {
2021 const struct scc_channel *scc = v;
2022 const struct scc_stat *stat = &scc->stat;
2023 const struct scc_kiss *kiss = &scc->kiss;
2026 /* dev data ctrl irq clock brand enh vector special option
2027 * baud nrz clocksrc softdcd bufsize
2028 * rxints txints exints spints
2029 * rcvd rxerrs over / xmit txerrs under / nospace bufsize
2030 * txd pers slot tail ful wait min maxk idl defr txof grp
2031 * W ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ##
2032 * R ## ## XX ## ## ## ## ## XX ## ## ## ## ## ## ##
2035 seq_printf(seq, "%s\t%3.3lx %3.3lx %d %lu %2.2x %d %3.3lx %3.3lx %d\n",
2036 scc->dev->name,
2037 scc->data, scc->ctrl, scc->irq, scc->clock, scc->brand,
2038 scc->enhanced, Vector_Latch, scc->special,
2039 scc->option);
2040 seq_printf(seq, "\t%lu %d %d %d %d\n",
2041 scc->modem.speed, scc->modem.nrz,
2042 scc->modem.clocksrc, kiss->softdcd,
2043 stat->bufsize);
2044 seq_printf(seq, "\t%lu %lu %lu %lu\n",
2045 stat->rxints, stat->txints, stat->exints, stat->spints);
2046 seq_printf(seq, "\t%lu %lu %d / %lu %lu %d / %d %d\n",
2047 stat->rxframes, stat->rxerrs, stat->rx_over,
2048 stat->txframes, stat->txerrs, stat->tx_under,
2049 stat->nospace, stat->tx_state);
2051 #define K(x) kiss->x
2052 seq_printf(seq, "\t%d %d %d %d %d %d %d %d %d %d %d %d\n",
2053 K(txdelay), K(persist), K(slottime), K(tailtime),
2054 K(fulldup), K(waittime), K(mintime), K(maxkeyup),
2055 K(idletime), K(maxdefer), K(tx_inhibit), K(group));
2056 #undef K
2057 #ifdef SCC_DEBUG
2059 int reg;
2061 seq_printf(seq, "\tW ");
2062 for (reg = 0; reg < 16; reg++)
2063 seq_printf(seq, "%2.2x ", scc->wreg[reg]);
2064 seq_printf(seq, "\n");
2066 seq_printf(seq, "\tR %2.2x %2.2x XX ", InReg(scc->ctrl,R0), InReg(scc->ctrl,R1));
2067 for (reg = 3; reg < 8; reg++)
2068 seq_printf(seq, "%2.2x ", InReg(scc->ctrl, reg));
2069 seq_printf(seq, "XX ");
2070 for (reg = 9; reg < 16; reg++)
2071 seq_printf(seq, "%2.2x ", InReg(scc->ctrl, reg));
2072 seq_printf(seq, "\n");
2074 #endif
2075 seq_putc(seq, '\n');
2078 return 0;
2081 static struct seq_operations scc_net_seq_ops = {
2082 .start = scc_net_seq_start,
2083 .next = scc_net_seq_next,
2084 .stop = scc_net_seq_stop,
2085 .show = scc_net_seq_show,
2089 static int scc_net_seq_open(struct inode *inode, struct file *file)
2091 return seq_open(file, &scc_net_seq_ops);
2094 static struct file_operations scc_net_seq_fops = {
2095 .owner = THIS_MODULE,
2096 .open = scc_net_seq_open,
2097 .read = seq_read,
2098 .llseek = seq_lseek,
2099 .release = seq_release_private,
2102 #endif /* CONFIG_PROC_FS */
2105 /* ******************************************************************** */
2106 /* * Init SCC driver * */
2107 /* ******************************************************************** */
2109 static int __init scc_init_driver (void)
2111 char devname[IFNAMSIZ];
2113 printk(banner);
2115 sprintf(devname,"%s0", SCC_DriverName);
2117 rtnl_lock();
2118 if (scc_net_alloc(devname, SCC_Info)) {
2119 rtnl_unlock();
2120 printk(KERN_ERR "z8530drv: cannot initialize module\n");
2121 return -EIO;
2123 rtnl_unlock();
2125 proc_net_fops_create("z8530drv", 0, &scc_net_seq_fops);
2127 return 0;
2130 static void __exit scc_cleanup_driver(void)
2132 io_port ctrl;
2133 int k;
2134 struct scc_channel *scc;
2135 struct net_device *dev;
2137 if (Nchips == 0 && (dev = SCC_Info[0].dev))
2139 unregister_netdev(dev);
2140 free_netdev(dev);
2143 /* Guard against chip prattle */
2144 local_irq_disable();
2146 for (k = 0; k < Nchips; k++)
2147 if ( (ctrl = SCC_ctrl[k].chan_A) )
2149 Outb(ctrl, 0);
2150 OutReg(ctrl,R9,FHWRES); /* force hardware reset */
2151 udelay(50);
2154 /* To unload the port must be closed so no real IRQ pending */
2155 for (k=0; k < NR_IRQS ; k++)
2156 if (Ivec[k].used) free_irq(k, NULL);
2158 local_irq_enable();
2160 /* Now clean up */
2161 for (k = 0; k < Nchips*2; k++)
2163 scc = &SCC_Info[k];
2164 if (scc->ctrl)
2166 release_region(scc->ctrl, 1);
2167 release_region(scc->data, 1);
2169 if (scc->dev)
2171 unregister_netdev(scc->dev);
2172 free_netdev(scc->dev);
2177 if (Vector_Latch)
2178 release_region(Vector_Latch, 1);
2180 proc_net_remove("z8530drv");
2183 MODULE_AUTHOR("Joerg Reuter <jreuter@yaina.de>");
2184 MODULE_DESCRIPTION("AX.25 Device Driver for Z8530 based HDLC cards");
2185 MODULE_SUPPORTED_DEVICE("Z8530 based SCC cards for Amateur Radio");
2186 MODULE_LICENSE("GPL");
2187 module_init(scc_init_driver);
2188 module_exit(scc_cleanup_driver);