2 * drivers/net/wan/dscc4/dscc4.c: a DSCC4 HDLC driver for Linux
4 * This software may be used and distributed according to the terms of the
5 * GNU General Public License.
7 * The author may be reached as romieu@cogenit.fr.
8 * Specific bug reports/asian food will be welcome.
10 * Special thanks to the nice people at CS-Telecom for the hardware and the
11 * access to the test/measure tools.
16 * I. Board Compatibility
18 * This device driver is designed for the Siemens PEB20534 4 ports serial
19 * controller as found on Etinc PCISYNC cards. The documentation for the
20 * chipset is available at http://www.infineon.com:
21 * - Data Sheet "DSCC4, DMA Supported Serial Communication Controller with
22 * 4 Channels, PEB 20534 Version 2.1, PEF 20534 Version 2.1";
23 * - Application Hint "Management of DSCC4 on-chip FIFO resources".
24 * - Errata sheet DS5 (courtesy of Michael Skerritt).
25 * Jens David has built an adapter based on the same chipset. Take a look
26 * at http://www.afthd.tu-darmstadt.de/~dg1kjd/pciscc4 for a specific
28 * Sample code (2 revisions) is available at Infineon.
30 * II. Board-specific settings
32 * Pcisync can transmit some clock signal to the outside world on the
33 * *first two* ports provided you put a quartz and a line driver on it and
34 * remove the jumpers. The operation is described on Etinc web site. If you
35 * go DCE on these ports, don't forget to use an adequate cable.
37 * Sharing of the PCI interrupt line for this board is possible.
39 * III. Driver operation
41 * The rx/tx operations are based on a linked list of descriptors. The driver
42 * doesn't use HOLD mode any more. HOLD mode is definitely buggy and the more
43 * I tried to fix it, the more it started to look like (convoluted) software
44 * mutation of LxDA method. Errata sheet DS5 suggests to use LxDA: consider
45 * this a rfc2119 MUST.
48 * When the tx ring is full, the xmit routine issues a call to netdev_stop.
49 * The device is supposed to be enabled again during an ALLS irq (we could
50 * use HI but as it's easy to lose events, it's fscked).
53 * The received frames aren't supposed to span over multiple receiving areas.
54 * I may implement it some day but it isn't the highest ranked item.
57 * The current error (XDU, RFO) recovery code is untested.
58 * So far, RDO takes his RX channel down and the right sequence to enable it
59 * again is still a mistery. If RDO happens, plan a reboot. More details
60 * in the code (NB: as this happens, TX still works).
61 * Don't mess the cables during operation, especially on DTE ports. I don't
62 * suggest it for DCE either but at least one can get some messages instead
63 * of a complete instant freeze.
64 * Tests are done on Rev. 20 of the silicium. The RDO handling changes with
65 * the documentation/chipset releases.
69 * - use polling at high irq/s,
70 * - performance analysis,
73 * 2001/12/10 Daniela Squassoni <daniela@cyclades.com>
74 * - Contribution to support the new generic HDLC layer.
77 * - old style interface removal
78 * - dscc4_release_ring fix (related to DMA mapping)
79 * - hard_start_xmit fix (hint: TxSizeMax)
83 #include <linux/module.h>
84 #include <linux/types.h>
85 #include <linux/errno.h>
86 #include <linux/list.h>
87 #include <linux/ioport.h>
88 #include <linux/pci.h>
89 #include <linux/kernel.h>
92 #include <asm/system.h>
93 #include <asm/cache.h>
94 #include <asm/byteorder.h>
95 #include <asm/uaccess.h>
99 #include <linux/init.h>
100 #include <linux/string.h>
102 #include <linux/if_arp.h>
103 #include <linux/netdevice.h>
104 #include <linux/skbuff.h>
105 #include <linux/delay.h>
106 #include <linux/hdlc.h>
107 #include <linux/mutex.h>
110 static const char version[] = "$Id: dscc4.c,v 1.173 2003/09/20 23:55:34 romieu Exp $ for Linux\n";
114 #ifdef CONFIG_DSCC4_PCI_RST
115 static DEFINE_MUTEX(dscc4_mutex);
116 static u32 dscc4_pci_config_store[16];
119 #define DRV_NAME "dscc4"
123 /* Module parameters */
125 MODULE_AUTHOR("Maintainer: Francois Romieu <romieu@cogenit.fr>");
126 MODULE_DESCRIPTION("Siemens PEB20534 PCI Controler");
127 MODULE_LICENSE("GPL");
128 module_param(debug, int, 0);
129 MODULE_PARM_DESC(debug,"Enable/disable extra messages");
130 module_param(quartz, int, 0);
131 MODULE_PARM_DESC(quartz,"If present, on-board quartz frequency (Hz)");
145 u32 jiffies; /* Allows sizeof(TxFD) == sizeof(RxFD) + extra hack */
146 /* FWIW, datasheet calls that "dummy" and says that card
147 * never looks at it; neither does the driver */
158 #define DUMMY_SKB_SIZE 64
160 #define TX_RING_SIZE 32
161 #define RX_RING_SIZE 32
162 #define TX_TOTAL_SIZE TX_RING_SIZE*sizeof(struct TxFD)
163 #define RX_TOTAL_SIZE RX_RING_SIZE*sizeof(struct RxFD)
164 #define IRQ_RING_SIZE 64 /* Keep it a multiple of 32 */
165 #define TX_TIMEOUT (HZ/10)
166 #define DSCC4_HZ_MAX 33000000
167 #define BRR_DIVIDER_MAX 64*0x00004000 /* Cf errata DS5 p.10 */
168 #define dev_per_card 4
169 #define SCC_REGISTERS_MAX 23 /* Cf errata DS5 p.4 */
171 #define SOURCE_ID(flags) (((flags) >> 28) & 0x03)
172 #define TO_SIZE(state) (((state) >> 16) & 0x1fff)
175 * Given the operating range of Linux HDLC, the 2 defines below could be
176 * made simpler. However they are a fine reminder for the limitations of
177 * the driver: it's better to stay < TxSizeMax and < RxSizeMax.
179 #define TO_STATE_TX(len) cpu_to_le32(((len) & TxSizeMax) << 16)
180 #define TO_STATE_RX(len) cpu_to_le32((RX_MAX(len) % RxSizeMax) << 16)
181 #define RX_MAX(len) ((((len) >> 5) + 1) << 5) /* Cf RLCR */
182 #define SCC_REG_START(dpriv) (SCC_START+(dpriv->dev_id)*SCC_OFFSET)
184 struct dscc4_pci_priv {
188 struct pci_dev *pdev;
190 struct dscc4_dev_priv *root;
191 dma_addr_t iqcfg_dma;
195 struct dscc4_dev_priv {
196 struct sk_buff *rx_skbuff[RX_RING_SIZE];
197 struct sk_buff *tx_skbuff[TX_RING_SIZE];
204 /* FIXME: check all the volatile are required */
205 volatile u32 tx_current;
210 volatile u32 tx_dirty;
215 dma_addr_t tx_fd_dma;
216 dma_addr_t rx_fd_dma;
220 u32 scc_regs[SCC_REGISTERS_MAX]; /* Cf errata DS5 p.4 */
222 struct timer_list timer;
224 struct dscc4_pci_priv *pci_priv;
231 unsigned short encoding;
232 unsigned short parity;
233 struct net_device *dev;
234 sync_serial_settings settings;
235 void __iomem *base_addr;
236 u32 __pad __attribute__ ((aligned (4)));
239 /* GLOBAL registers definitions */
260 /* SCC registers definitions */
261 #define SCC_START 0x0100
262 #define SCC_OFFSET 0x80
274 #define GPDATA 0x0404
278 #define EncodingMask 0x00700000
279 #define CrcMask 0x00000003
281 #define IntRxScc0 0x10000000
282 #define IntTxScc0 0x01000000
284 #define TxPollCmd 0x00000400
285 #define RxActivate 0x08000000
286 #define MTFi 0x04000000
287 #define Rdr 0x00400000
288 #define Rdt 0x00200000
289 #define Idr 0x00100000
290 #define Idt 0x00080000
291 #define TxSccRes 0x01000000
292 #define RxSccRes 0x00010000
293 #define TxSizeMax 0x1fff /* Datasheet DS1 - 11.1.1.1 */
294 #define RxSizeMax 0x1ffc /* Datasheet DS1 - 11.1.2.1 */
296 #define Ccr0ClockMask 0x0000003f
297 #define Ccr1LoopMask 0x00000200
298 #define IsrMask 0x000fffff
299 #define BrrExpMask 0x00000f00
300 #define BrrMultMask 0x0000003f
301 #define EncodingMask 0x00700000
302 #define Hold cpu_to_le32(0x40000000)
303 #define SccBusy 0x10000000
304 #define PowerUp 0x80000000
305 #define Vis 0x00001000
306 #define FrameOk (FrameVfr | FrameCrc)
307 #define FrameVfr 0x80
308 #define FrameRdo 0x40
309 #define FrameCrc 0x20
310 #define FrameRab 0x10
311 #define FrameAborted cpu_to_le32(0x00000200)
312 #define FrameEnd cpu_to_le32(0x80000000)
313 #define DataComplete cpu_to_le32(0x40000000)
314 #define LengthCheck 0x00008000
315 #define SccEvt 0x02000000
316 #define NoAck 0x00000200
317 #define Action 0x00000001
318 #define HiDesc cpu_to_le32(0x20000000)
321 #define RxEvt 0xf0000000
322 #define TxEvt 0x0f000000
323 #define Alls 0x00040000
324 #define Xdu 0x00010000
325 #define Cts 0x00004000
326 #define Xmr 0x00002000
327 #define Xpr 0x00001000
328 #define Rdo 0x00000080
329 #define Rfs 0x00000040
330 #define Cd 0x00000004
331 #define Rfo 0x00000002
332 #define Flex 0x00000001
334 /* DMA core events */
335 #define Cfg 0x00200000
336 #define Hi 0x00040000
337 #define Fi 0x00020000
338 #define Err 0x00010000
339 #define Arf 0x00000002
340 #define ArAck 0x00000001
343 #define Ready 0x00000000
344 #define NeedIDR 0x00000001
345 #define NeedIDT 0x00000002
346 #define RdoSet 0x00000004
347 #define FakeReset 0x00000008
349 /* Don't mask RDO. Ever. */
351 #define EventsMask 0xfffeef7f
353 #define EventsMask 0xfffa8f7a
356 /* Functions prototypes */
357 static void dscc4_rx_irq(struct dscc4_pci_priv *, struct dscc4_dev_priv *);
358 static void dscc4_tx_irq(struct dscc4_pci_priv *, struct dscc4_dev_priv *);
359 static int dscc4_found1(struct pci_dev *, void __iomem *ioaddr);
360 static int dscc4_init_one(struct pci_dev *, const struct pci_device_id *ent);
361 static int dscc4_open(struct net_device *);
362 static int dscc4_start_xmit(struct sk_buff *, struct net_device *);
363 static int dscc4_close(struct net_device *);
364 static int dscc4_ioctl(struct net_device *dev, struct ifreq *rq, int cmd);
365 static int dscc4_init_ring(struct net_device *);
366 static void dscc4_release_ring(struct dscc4_dev_priv *);
367 static void dscc4_timer(unsigned long);
368 static void dscc4_tx_timeout(struct net_device *);
369 static irqreturn_t dscc4_irq(int irq, void *dev_id);
370 static int dscc4_hdlc_attach(struct net_device *, unsigned short, unsigned short);
371 static int dscc4_set_iface(struct dscc4_dev_priv *, struct net_device *);
373 static int dscc4_tx_poll(struct dscc4_dev_priv *, struct net_device *);
376 static inline struct dscc4_dev_priv *dscc4_priv(struct net_device *dev)
378 return dev_to_hdlc(dev)->priv;
381 static inline struct net_device *dscc4_to_dev(struct dscc4_dev_priv *p)
386 static void scc_patchl(u32 mask, u32 value, struct dscc4_dev_priv *dpriv,
387 struct net_device *dev, int offset)
391 /* Cf scc_writel for concern regarding thread-safety */
392 state = dpriv->scc_regs[offset >> 2];
395 dpriv->scc_regs[offset >> 2] = state;
396 writel(state, dpriv->base_addr + SCC_REG_START(dpriv) + offset);
399 static void scc_writel(u32 bits, struct dscc4_dev_priv *dpriv,
400 struct net_device *dev, int offset)
404 * As of 2002/02/16, there are no thread racing for access.
406 dpriv->scc_regs[offset >> 2] = bits;
407 writel(bits, dpriv->base_addr + SCC_REG_START(dpriv) + offset);
410 static inline u32 scc_readl(struct dscc4_dev_priv *dpriv, int offset)
412 return dpriv->scc_regs[offset >> 2];
415 static u32 scc_readl_star(struct dscc4_dev_priv *dpriv, struct net_device *dev)
417 /* Cf errata DS5 p.4 */
418 readl(dpriv->base_addr + SCC_REG_START(dpriv) + STAR);
419 return readl(dpriv->base_addr + SCC_REG_START(dpriv) + STAR);
422 static inline void dscc4_do_tx(struct dscc4_dev_priv *dpriv,
423 struct net_device *dev)
425 dpriv->ltda = dpriv->tx_fd_dma +
426 ((dpriv->tx_current-1)%TX_RING_SIZE)*sizeof(struct TxFD);
427 writel(dpriv->ltda, dpriv->base_addr + CH0LTDA + dpriv->dev_id*4);
428 /* Flush posted writes *NOW* */
429 readl(dpriv->base_addr + CH0LTDA + dpriv->dev_id*4);
432 static inline void dscc4_rx_update(struct dscc4_dev_priv *dpriv,
433 struct net_device *dev)
435 dpriv->lrda = dpriv->rx_fd_dma +
436 ((dpriv->rx_dirty - 1)%RX_RING_SIZE)*sizeof(struct RxFD);
437 writel(dpriv->lrda, dpriv->base_addr + CH0LRDA + dpriv->dev_id*4);
440 static inline unsigned int dscc4_tx_done(struct dscc4_dev_priv *dpriv)
442 return dpriv->tx_current == dpriv->tx_dirty;
445 static inline unsigned int dscc4_tx_quiescent(struct dscc4_dev_priv *dpriv,
446 struct net_device *dev)
448 return readl(dpriv->base_addr + CH0FTDA + dpriv->dev_id*4) == dpriv->ltda;
451 static int state_check(u32 state, struct dscc4_dev_priv *dpriv,
452 struct net_device *dev, const char *msg)
457 if (SOURCE_ID(state) != dpriv->dev_id) {
458 printk(KERN_DEBUG "%s (%s): Source Id=%d, state=%08x\n",
459 dev->name, msg, SOURCE_ID(state), state );
462 if (state & 0x0df80c00) {
463 printk(KERN_DEBUG "%s (%s): state=%08x (UFO alert)\n",
464 dev->name, msg, state);
471 static void dscc4_tx_print(struct net_device *dev,
472 struct dscc4_dev_priv *dpriv,
475 printk(KERN_DEBUG "%s: tx_current=%02d tx_dirty=%02d (%s)\n",
476 dev->name, dpriv->tx_current, dpriv->tx_dirty, msg);
479 static void dscc4_release_ring(struct dscc4_dev_priv *dpriv)
481 struct pci_dev *pdev = dpriv->pci_priv->pdev;
482 struct TxFD *tx_fd = dpriv->tx_fd;
483 struct RxFD *rx_fd = dpriv->rx_fd;
484 struct sk_buff **skbuff;
487 pci_free_consistent(pdev, TX_TOTAL_SIZE, tx_fd, dpriv->tx_fd_dma);
488 pci_free_consistent(pdev, RX_TOTAL_SIZE, rx_fd, dpriv->rx_fd_dma);
490 skbuff = dpriv->tx_skbuff;
491 for (i = 0; i < TX_RING_SIZE; i++) {
493 pci_unmap_single(pdev, le32_to_cpu(tx_fd->data),
494 (*skbuff)->len, PCI_DMA_TODEVICE);
495 dev_kfree_skb(*skbuff);
501 skbuff = dpriv->rx_skbuff;
502 for (i = 0; i < RX_RING_SIZE; i++) {
504 pci_unmap_single(pdev, le32_to_cpu(rx_fd->data),
505 RX_MAX(HDLC_MAX_MRU), PCI_DMA_FROMDEVICE);
506 dev_kfree_skb(*skbuff);
513 static inline int try_get_rx_skb(struct dscc4_dev_priv *dpriv,
514 struct net_device *dev)
516 unsigned int dirty = dpriv->rx_dirty%RX_RING_SIZE;
517 struct RxFD *rx_fd = dpriv->rx_fd + dirty;
518 const int len = RX_MAX(HDLC_MAX_MRU);
522 skb = dev_alloc_skb(len);
523 dpriv->rx_skbuff[dirty] = skb;
525 skb->protocol = hdlc_type_trans(skb, dev);
526 rx_fd->data = cpu_to_le32(pci_map_single(dpriv->pci_priv->pdev,
527 skb->data, len, PCI_DMA_FROMDEVICE));
536 * IRQ/thread/whatever safe
538 static int dscc4_wait_ack_cec(struct dscc4_dev_priv *dpriv,
539 struct net_device *dev, char *msg)
544 if (!(scc_readl_star(dpriv, dev) & SccBusy)) {
545 printk(KERN_DEBUG "%s: %s ack (%d try)\n", dev->name,
549 schedule_timeout_uninterruptible(10);
552 printk(KERN_ERR "%s: %s timeout\n", dev->name, msg);
554 return (i >= 0) ? i : -EAGAIN;
557 static int dscc4_do_action(struct net_device *dev, char *msg)
559 void __iomem *ioaddr = dscc4_priv(dev)->base_addr;
562 writel(Action, ioaddr + GCMDR);
565 u32 state = readl(ioaddr);
568 printk(KERN_DEBUG "%s: %s ack\n", dev->name, msg);
569 writel(ArAck, ioaddr);
571 } else if (state & Arf) {
572 printk(KERN_ERR "%s: %s failed\n", dev->name, msg);
579 printk(KERN_ERR "%s: %s timeout\n", dev->name, msg);
584 static inline int dscc4_xpr_ack(struct dscc4_dev_priv *dpriv)
586 int cur = dpriv->iqtx_current%IRQ_RING_SIZE;
590 if (!(dpriv->flags & (NeedIDR | NeedIDT)) ||
591 (dpriv->iqtx[cur] & cpu_to_le32(Xpr)))
594 schedule_timeout_uninterruptible(10);
597 return (i >= 0 ) ? i : -EAGAIN;
600 #if 0 /* dscc4_{rx/tx}_reset are both unreliable - more tweak needed */
601 static void dscc4_rx_reset(struct dscc4_dev_priv *dpriv, struct net_device *dev)
605 spin_lock_irqsave(&dpriv->pci_priv->lock, flags);
606 /* Cf errata DS5 p.6 */
607 writel(0x00000000, dpriv->base_addr + CH0LRDA + dpriv->dev_id*4);
608 scc_patchl(PowerUp, 0, dpriv, dev, CCR0);
609 readl(dpriv->base_addr + CH0LRDA + dpriv->dev_id*4);
610 writel(MTFi|Rdr, dpriv->base_addr + dpriv->dev_id*0x0c + CH0CFG);
611 writel(Action, dpriv->base_addr + GCMDR);
612 spin_unlock_irqrestore(&dpriv->pci_priv->lock, flags);
618 static void dscc4_tx_reset(struct dscc4_dev_priv *dpriv, struct net_device *dev)
622 /* Cf errata DS5 p.7 */
623 scc_patchl(PowerUp, 0, dpriv, dev, CCR0);
624 scc_writel(0x00050000, dpriv, dev, CCR2);
626 * Must be longer than the time required to fill the fifo.
628 while (!dscc4_tx_quiescent(dpriv, dev) && ++i) {
633 writel(MTFi|Rdt, dpriv->base_addr + dpriv->dev_id*0x0c + CH0CFG);
634 if (dscc4_do_action(dev, "Rdt") < 0)
635 printk(KERN_ERR "%s: Tx reset failed\n", dev->name);
639 /* TODO: (ab)use this function to refill a completely depleted RX ring. */
640 static inline void dscc4_rx_skb(struct dscc4_dev_priv *dpriv,
641 struct net_device *dev)
643 struct RxFD *rx_fd = dpriv->rx_fd + dpriv->rx_current%RX_RING_SIZE;
644 struct pci_dev *pdev = dpriv->pci_priv->pdev;
648 skb = dpriv->rx_skbuff[dpriv->rx_current++%RX_RING_SIZE];
650 printk(KERN_DEBUG "%s: skb=0 (%s)\n", dev->name, __func__);
653 pkt_len = TO_SIZE(le32_to_cpu(rx_fd->state2));
654 pci_unmap_single(pdev, le32_to_cpu(rx_fd->data),
655 RX_MAX(HDLC_MAX_MRU), PCI_DMA_FROMDEVICE);
656 if ((skb->data[--pkt_len] & FrameOk) == FrameOk) {
657 dev->stats.rx_packets++;
658 dev->stats.rx_bytes += pkt_len;
659 skb_put(skb, pkt_len);
660 if (netif_running(dev))
661 skb->protocol = hdlc_type_trans(skb, dev);
664 if (skb->data[pkt_len] & FrameRdo)
665 dev->stats.rx_fifo_errors++;
666 else if (!(skb->data[pkt_len] | ~FrameCrc))
667 dev->stats.rx_crc_errors++;
668 else if (!(skb->data[pkt_len] | ~(FrameVfr | FrameRab)))
669 dev->stats.rx_length_errors++;
671 dev->stats.rx_errors++;
672 dev_kfree_skb_irq(skb);
675 while ((dpriv->rx_dirty - dpriv->rx_current) % RX_RING_SIZE) {
676 if (try_get_rx_skb(dpriv, dev) < 0)
680 dscc4_rx_update(dpriv, dev);
681 rx_fd->state2 = 0x00000000;
682 rx_fd->end = cpu_to_le32(0xbabeface);
685 static void dscc4_free1(struct pci_dev *pdev)
687 struct dscc4_pci_priv *ppriv;
688 struct dscc4_dev_priv *root;
691 ppriv = pci_get_drvdata(pdev);
694 for (i = 0; i < dev_per_card; i++)
695 unregister_hdlc_device(dscc4_to_dev(root + i));
697 pci_set_drvdata(pdev, NULL);
699 for (i = 0; i < dev_per_card; i++)
700 free_netdev(root[i].dev);
705 static int __devinit dscc4_init_one(struct pci_dev *pdev,
706 const struct pci_device_id *ent)
708 struct dscc4_pci_priv *priv;
709 struct dscc4_dev_priv *dpriv;
710 void __iomem *ioaddr;
713 printk(KERN_DEBUG "%s", version);
715 rc = pci_enable_device(pdev);
719 rc = pci_request_region(pdev, 0, "registers");
721 printk(KERN_ERR "%s: can't reserve MMIO region (regs)\n",
725 rc = pci_request_region(pdev, 1, "LBI interface");
727 printk(KERN_ERR "%s: can't reserve MMIO region (lbi)\n",
729 goto err_free_mmio_region_1;
732 ioaddr = pci_ioremap_bar(pdev, 0);
734 printk(KERN_ERR "%s: cannot remap MMIO region %llx @ %llx\n",
735 DRV_NAME, (unsigned long long)pci_resource_len(pdev, 0),
736 (unsigned long long)pci_resource_start(pdev, 0));
738 goto err_free_mmio_regions_2;
740 printk(KERN_DEBUG "Siemens DSCC4, MMIO at %#llx (regs), %#llx (lbi), IRQ %d\n",
741 (unsigned long long)pci_resource_start(pdev, 0),
742 (unsigned long long)pci_resource_start(pdev, 1), pdev->irq);
744 /* Cf errata DS5 p.2 */
745 pci_write_config_byte(pdev, PCI_LATENCY_TIMER, 0xf8);
746 pci_set_master(pdev);
748 rc = dscc4_found1(pdev, ioaddr);
752 priv = pci_get_drvdata(pdev);
754 rc = request_irq(pdev->irq, dscc4_irq, IRQF_SHARED, DRV_NAME, priv->root);
756 printk(KERN_WARNING "%s: IRQ %d busy\n", DRV_NAME, pdev->irq);
760 /* power up/little endian/dma core controlled via lrda/ltda */
761 writel(0x00000001, ioaddr + GMODE);
762 /* Shared interrupt queue */
766 bits = (IRQ_RING_SIZE >> 5) - 1;
770 writel(bits, ioaddr + IQLENR0);
772 /* Global interrupt queue */
773 writel((u32)(((IRQ_RING_SIZE >> 5) - 1) << 20), ioaddr + IQLENR1);
774 priv->iqcfg = (__le32 *) pci_alloc_consistent(pdev,
775 IRQ_RING_SIZE*sizeof(__le32), &priv->iqcfg_dma);
778 writel(priv->iqcfg_dma, ioaddr + IQCFG);
783 * SCC 0-3 private rx/tx irq structures
784 * IQRX/TXi needs to be set soon. Learned it the hard way...
786 for (i = 0; i < dev_per_card; i++) {
787 dpriv = priv->root + i;
788 dpriv->iqtx = (__le32 *) pci_alloc_consistent(pdev,
789 IRQ_RING_SIZE*sizeof(u32), &dpriv->iqtx_dma);
791 goto err_free_iqtx_6;
792 writel(dpriv->iqtx_dma, ioaddr + IQTX0 + i*4);
794 for (i = 0; i < dev_per_card; i++) {
795 dpriv = priv->root + i;
796 dpriv->iqrx = (__le32 *) pci_alloc_consistent(pdev,
797 IRQ_RING_SIZE*sizeof(u32), &dpriv->iqrx_dma);
799 goto err_free_iqrx_7;
800 writel(dpriv->iqrx_dma, ioaddr + IQRX0 + i*4);
803 /* Cf application hint. Beware of hard-lock condition on threshold. */
804 writel(0x42104000, ioaddr + FIFOCR1);
805 //writel(0x9ce69800, ioaddr + FIFOCR2);
806 writel(0xdef6d800, ioaddr + FIFOCR2);
807 //writel(0x11111111, ioaddr + FIFOCR4);
808 writel(0x18181818, ioaddr + FIFOCR4);
809 // FIXME: should depend on the chipset revision
810 writel(0x0000000e, ioaddr + FIFOCR3);
812 writel(0xff200001, ioaddr + GCMDR);
820 dpriv = priv->root + i;
821 pci_free_consistent(pdev, IRQ_RING_SIZE*sizeof(u32),
822 dpriv->iqrx, dpriv->iqrx_dma);
827 dpriv = priv->root + i;
828 pci_free_consistent(pdev, IRQ_RING_SIZE*sizeof(u32),
829 dpriv->iqtx, dpriv->iqtx_dma);
831 pci_free_consistent(pdev, IRQ_RING_SIZE*sizeof(u32), priv->iqcfg,
834 free_irq(pdev->irq, priv->root);
839 err_free_mmio_regions_2:
840 pci_release_region(pdev, 1);
841 err_free_mmio_region_1:
842 pci_release_region(pdev, 0);
844 pci_disable_device(pdev);
849 * Let's hope the default values are decent enough to protect my
850 * feet from the user's gun - Ueimor
852 static void dscc4_init_registers(struct dscc4_dev_priv *dpriv,
853 struct net_device *dev)
855 /* No interrupts, SCC core disabled. Let's relax */
856 scc_writel(0x00000000, dpriv, dev, CCR0);
858 scc_writel(LengthCheck | (HDLC_MAX_MRU >> 5), dpriv, dev, RLCR);
861 * No address recognition/crc-CCITT/cts enabled
862 * Shared flags transmission disabled - cf errata DS5 p.11
863 * Carrier detect disabled - cf errata p.14
864 * FIXME: carrier detection/polarity may be handled more gracefully.
866 scc_writel(0x02408000, dpriv, dev, CCR1);
868 /* crc not forwarded - Cf errata DS5 p.11 */
869 scc_writel(0x00050008 & ~RxActivate, dpriv, dev, CCR2);
871 //scc_writel(0x00250008 & ~RxActivate, dpriv, dev, CCR2);
874 static inline int dscc4_set_quartz(struct dscc4_dev_priv *dpriv, int hz)
878 if ((hz < 0) || (hz > DSCC4_HZ_MAX))
881 dpriv->pci_priv->xtal_hz = hz;
886 static int dscc4_found1(struct pci_dev *pdev, void __iomem *ioaddr)
888 struct dscc4_pci_priv *ppriv;
889 struct dscc4_dev_priv *root;
890 int i, ret = -ENOMEM;
892 root = kcalloc(dev_per_card, sizeof(*root), GFP_KERNEL);
894 printk(KERN_ERR "%s: can't allocate data\n", DRV_NAME);
898 for (i = 0; i < dev_per_card; i++) {
899 root[i].dev = alloc_hdlcdev(root + i);
904 ppriv = kzalloc(sizeof(*ppriv), GFP_KERNEL);
906 printk(KERN_ERR "%s: can't allocate private data\n", DRV_NAME);
911 spin_lock_init(&ppriv->lock);
913 for (i = 0; i < dev_per_card; i++) {
914 struct dscc4_dev_priv *dpriv = root + i;
915 struct net_device *d = dscc4_to_dev(dpriv);
916 hdlc_device *hdlc = dev_to_hdlc(d);
918 d->base_addr = (unsigned long)ioaddr;
921 d->open = dscc4_open;
922 d->stop = dscc4_close;
923 d->set_multicast_list = NULL;
924 d->do_ioctl = dscc4_ioctl;
925 d->tx_timeout = dscc4_tx_timeout;
926 d->watchdog_timeo = TX_TIMEOUT;
927 SET_NETDEV_DEV(d, &pdev->dev);
930 dpriv->pci_priv = ppriv;
931 dpriv->base_addr = ioaddr;
932 spin_lock_init(&dpriv->lock);
934 hdlc->xmit = dscc4_start_xmit;
935 hdlc->attach = dscc4_hdlc_attach;
937 dscc4_init_registers(dpriv, d);
938 dpriv->parity = PARITY_CRC16_PR0_CCITT;
939 dpriv->encoding = ENCODING_NRZ;
941 ret = dscc4_init_ring(d);
945 ret = register_hdlc_device(d);
947 printk(KERN_ERR "%s: unable to register\n", DRV_NAME);
948 dscc4_release_ring(dpriv);
953 ret = dscc4_set_quartz(root, quartz);
957 pci_set_drvdata(pdev, ppriv);
962 dscc4_release_ring(root + i);
963 unregister_hdlc_device(dscc4_to_dev(root + i));
969 free_netdev(root[i].dev);
975 /* FIXME: get rid of the unneeded code */
976 static void dscc4_timer(unsigned long data)
978 struct net_device *dev = (struct net_device *)data;
979 struct dscc4_dev_priv *dpriv = dscc4_priv(dev);
980 // struct dscc4_pci_priv *ppriv;
984 dpriv->timer.expires = jiffies + TX_TIMEOUT;
985 add_timer(&dpriv->timer);
988 static void dscc4_tx_timeout(struct net_device *dev)
990 /* FIXME: something is missing there */
993 static int dscc4_loopback_check(struct dscc4_dev_priv *dpriv)
995 sync_serial_settings *settings = &dpriv->settings;
997 if (settings->loopback && (settings->clock_type != CLOCK_INT)) {
998 struct net_device *dev = dscc4_to_dev(dpriv);
1000 printk(KERN_INFO "%s: loopback requires clock\n", dev->name);
1006 #ifdef CONFIG_DSCC4_PCI_RST
1008 * Some DSCC4-based cards wires the GPIO port and the PCI #RST pin together
1009 * so as to provide a safe way to reset the asic while not the whole machine
1012 * This code doesn't need to be efficient. Keep It Simple
1014 static void dscc4_pci_reset(struct pci_dev *pdev, void __iomem *ioaddr)
1018 mutex_lock(&dscc4_mutex);
1019 for (i = 0; i < 16; i++)
1020 pci_read_config_dword(pdev, i << 2, dscc4_pci_config_store + i);
1022 /* Maximal LBI clock divider (who cares ?) and whole GPIO range. */
1023 writel(0x001c0000, ioaddr + GMODE);
1024 /* Configure GPIO port as output */
1025 writel(0x0000ffff, ioaddr + GPDIR);
1026 /* Disable interruption */
1027 writel(0x0000ffff, ioaddr + GPIM);
1029 writel(0x0000ffff, ioaddr + GPDATA);
1030 writel(0x00000000, ioaddr + GPDATA);
1032 /* Flush posted writes */
1033 readl(ioaddr + GSTAR);
1035 schedule_timeout_uninterruptible(10);
1037 for (i = 0; i < 16; i++)
1038 pci_write_config_dword(pdev, i << 2, dscc4_pci_config_store[i]);
1039 mutex_unlock(&dscc4_mutex);
1042 #define dscc4_pci_reset(pdev,ioaddr) do {} while (0)
1043 #endif /* CONFIG_DSCC4_PCI_RST */
1045 static int dscc4_open(struct net_device *dev)
1047 struct dscc4_dev_priv *dpriv = dscc4_priv(dev);
1048 struct dscc4_pci_priv *ppriv;
1051 if ((dscc4_loopback_check(dpriv) < 0) || !dev->hard_start_xmit)
1054 if ((ret = hdlc_open(dev)))
1057 ppriv = dpriv->pci_priv;
1060 * Due to various bugs, there is no way to reliably reset a
1061 * specific port (manufacturer's dependant special PCI #RST wiring
1062 * apart: it affects all ports). Thus the device goes in the best
1063 * silent mode possible at dscc4_close() time and simply claims to
1064 * be up if it's opened again. It still isn't possible to change
1065 * the HDLC configuration without rebooting but at least the ports
1066 * can be up/down ifconfig'ed without killing the host.
1068 if (dpriv->flags & FakeReset) {
1069 dpriv->flags &= ~FakeReset;
1070 scc_patchl(0, PowerUp, dpriv, dev, CCR0);
1071 scc_patchl(0, 0x00050000, dpriv, dev, CCR2);
1072 scc_writel(EventsMask, dpriv, dev, IMR);
1073 printk(KERN_INFO "%s: up again.\n", dev->name);
1077 /* IDT+IDR during XPR */
1078 dpriv->flags = NeedIDR | NeedIDT;
1080 scc_patchl(0, PowerUp | Vis, dpriv, dev, CCR0);
1083 * The following is a bit paranoid...
1085 * NB: the datasheet "...CEC will stay active if the SCC is in
1086 * power-down mode or..." and CCR2.RAC = 1 are two different
1089 if (scc_readl_star(dpriv, dev) & SccBusy) {
1090 printk(KERN_ERR "%s busy. Try later\n", dev->name);
1094 printk(KERN_INFO "%s: available. Good\n", dev->name);
1096 scc_writel(EventsMask, dpriv, dev, IMR);
1098 /* Posted write is flushed in the wait_ack loop */
1099 scc_writel(TxSccRes | RxSccRes, dpriv, dev, CMDR);
1101 if ((ret = dscc4_wait_ack_cec(dpriv, dev, "Cec")) < 0)
1102 goto err_disable_scc_events;
1105 * I would expect XPR near CE completion (before ? after ?).
1106 * At worst, this code won't see a late XPR and people
1107 * will have to re-issue an ifconfig (this is harmless).
1108 * WARNING, a really missing XPR usually means a hardware
1109 * reset is needed. Suggestions anyone ?
1111 if ((ret = dscc4_xpr_ack(dpriv)) < 0) {
1112 printk(KERN_ERR "%s: %s timeout\n", DRV_NAME, "XPR");
1113 goto err_disable_scc_events;
1117 dscc4_tx_print(dev, dpriv, "Open");
1120 netif_start_queue(dev);
1122 init_timer(&dpriv->timer);
1123 dpriv->timer.expires = jiffies + 10*HZ;
1124 dpriv->timer.data = (unsigned long)dev;
1125 dpriv->timer.function = &dscc4_timer;
1126 add_timer(&dpriv->timer);
1127 netif_carrier_on(dev);
1131 err_disable_scc_events:
1132 scc_writel(0xffffffff, dpriv, dev, IMR);
1133 scc_patchl(PowerUp | Vis, 0, dpriv, dev, CCR0);
1140 #ifdef DSCC4_POLLING
1141 static int dscc4_tx_poll(struct dscc4_dev_priv *dpriv, struct net_device *dev)
1143 /* FIXME: it's gonna be easy (TM), for sure */
1145 #endif /* DSCC4_POLLING */
1147 static int dscc4_start_xmit(struct sk_buff *skb, struct net_device *dev)
1149 struct dscc4_dev_priv *dpriv = dscc4_priv(dev);
1150 struct dscc4_pci_priv *ppriv = dpriv->pci_priv;
1154 next = dpriv->tx_current%TX_RING_SIZE;
1155 dpriv->tx_skbuff[next] = skb;
1156 tx_fd = dpriv->tx_fd + next;
1157 tx_fd->state = FrameEnd | TO_STATE_TX(skb->len);
1158 tx_fd->data = cpu_to_le32(pci_map_single(ppriv->pdev, skb->data, skb->len,
1160 tx_fd->complete = 0x00000000;
1161 tx_fd->jiffies = jiffies;
1164 #ifdef DSCC4_POLLING
1165 spin_lock(&dpriv->lock);
1166 while (dscc4_tx_poll(dpriv, dev));
1167 spin_unlock(&dpriv->lock);
1170 dev->trans_start = jiffies;
1173 dscc4_tx_print(dev, dpriv, "Xmit");
1174 /* To be cleaned(unsigned int)/optimized. Later, ok ? */
1175 if (!((++dpriv->tx_current - dpriv->tx_dirty)%TX_RING_SIZE))
1176 netif_stop_queue(dev);
1178 if (dscc4_tx_quiescent(dpriv, dev))
1179 dscc4_do_tx(dpriv, dev);
1184 static int dscc4_close(struct net_device *dev)
1186 struct dscc4_dev_priv *dpriv = dscc4_priv(dev);
1188 del_timer_sync(&dpriv->timer);
1189 netif_stop_queue(dev);
1191 scc_patchl(PowerUp | Vis, 0, dpriv, dev, CCR0);
1192 scc_patchl(0x00050000, 0, dpriv, dev, CCR2);
1193 scc_writel(0xffffffff, dpriv, dev, IMR);
1195 dpriv->flags |= FakeReset;
1202 static inline int dscc4_check_clock_ability(int port)
1206 #ifdef CONFIG_DSCC4_PCISYNC
1214 * DS1 p.137: "There are a total of 13 different clocking modes..."
1217 * - by default, assume a clock is provided on pin RxClk/TxClk (clock mode 0a).
1218 * Clock mode 3b _should_ work but the testing seems to make this point
1219 * dubious (DIY testing requires setting CCR0 at 0x00000033).
1220 * This is supposed to provide least surprise "DTE like" behavior.
1221 * - if line rate is specified, clocks are assumed to be locally generated.
1222 * A quartz must be available (on pin XTAL1). Modes 6b/7b are used. Choosing
1223 * between these it automagically done according on the required frequency
1224 * scaling. Of course some rounding may take place.
1225 * - no high speed mode (40Mb/s). May be trivial to do but I don't have an
1226 * appropriate external clocking device for testing.
1227 * - no time-slot/clock mode 5: shameless lazyness.
1229 * The clock signals wiring can be (is ?) manufacturer dependant. Good luck.
1231 * BIG FAT WARNING: if the device isn't provided enough clocking signal, it
1232 * won't pass the init sequence. For example, straight back-to-back DTE without
1233 * external clock will fail when dscc4_open() (<- 'ifconfig hdlcx xxx') is
1236 * Typos lurk in datasheet (missing divier in clock mode 7a figure 51 p.153
1239 * Clock mode related bits of CCR0:
1240 * +------------ TOE: output TxClk (0b/2b/3a/3b/6b/7a/7b only)
1241 * | +---------- SSEL: sub-mode select 0 -> a, 1 -> b
1242 * | | +-------- High Speed: say 0
1243 * | | | +-+-+-- Clock Mode: 0..7
1246 * x|x|5|4|3|2|1|0| lower bits
1248 * Division factor of BRR: k = (N+1)x2^M (total divider = 16xk in mode 6b)
1249 * +-+-+-+------------------ M (0..15)
1250 * | | | | +-+-+-+-+-+-- N (0..63)
1251 * 0 0 0 0 | | | | 0 0 | | | | | |
1252 * ...-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1253 * f|e|d|c|b|a|9|8|7|6|5|4|3|2|1|0| lower bits
1256 static int dscc4_set_clock(struct net_device *dev, u32 *bps, u32 *state)
1258 struct dscc4_dev_priv *dpriv = dscc4_priv(dev);
1262 *state &= ~Ccr0ClockMask;
1263 if (*bps) { /* Clock generated - required for DCE */
1264 u32 n = 0, m = 0, divider;
1267 xtal = dpriv->pci_priv->xtal_hz;
1270 if (dscc4_check_clock_ability(dpriv->dev_id) < 0)
1272 divider = xtal / *bps;
1273 if (divider > BRR_DIVIDER_MAX) {
1275 *state |= 0x00000036; /* Clock mode 6b (BRG/16) */
1277 *state |= 0x00000037; /* Clock mode 7b (BRG) */
1278 if (divider >> 22) {
1281 } else if (divider) {
1282 /* Extraction of the 6 highest weighted bits */
1284 while (0xffffffc0 & divider) {
1292 if (!(*state & 0x00000001)) /* ?b mode mask => clock mode 6b */
1294 *bps = xtal / divider;
1297 * External clock - DTE
1298 * "state" already reflects Clock mode 0a (CCR0 = 0xzzzzzz00).
1299 * Nothing more to be done
1303 scc_writel(brr, dpriv, dev, BRR);
1309 static int dscc4_ioctl(struct net_device *dev, struct ifreq *ifr, int cmd)
1311 sync_serial_settings __user *line = ifr->ifr_settings.ifs_ifsu.sync;
1312 struct dscc4_dev_priv *dpriv = dscc4_priv(dev);
1313 const size_t size = sizeof(dpriv->settings);
1316 if (dev->flags & IFF_UP)
1319 if (cmd != SIOCWANDEV)
1322 switch(ifr->ifr_settings.type) {
1324 ifr->ifr_settings.type = IF_IFACE_SYNC_SERIAL;
1325 if (ifr->ifr_settings.size < size) {
1326 ifr->ifr_settings.size = size; /* data size wanted */
1329 if (copy_to_user(line, &dpriv->settings, size))
1333 case IF_IFACE_SYNC_SERIAL:
1334 if (!capable(CAP_NET_ADMIN))
1337 if (dpriv->flags & FakeReset) {
1338 printk(KERN_INFO "%s: please reset the device"
1339 " before this command\n", dev->name);
1342 if (copy_from_user(&dpriv->settings, line, size))
1344 ret = dscc4_set_iface(dpriv, dev);
1348 ret = hdlc_ioctl(dev, ifr, cmd);
1355 static int dscc4_match(struct thingie *p, int value)
1359 for (i = 0; p[i].define != -1; i++) {
1360 if (value == p[i].define)
1363 if (p[i].define == -1)
1369 static int dscc4_clock_setting(struct dscc4_dev_priv *dpriv,
1370 struct net_device *dev)
1372 sync_serial_settings *settings = &dpriv->settings;
1373 int ret = -EOPNOTSUPP;
1376 bps = settings->clock_rate;
1377 state = scc_readl(dpriv, CCR0);
1378 if (dscc4_set_clock(dev, &bps, &state) < 0)
1380 if (bps) { /* DCE */
1381 printk(KERN_DEBUG "%s: generated RxClk (DCE)\n", dev->name);
1382 if (settings->clock_rate != bps) {
1383 printk(KERN_DEBUG "%s: clock adjusted (%08d -> %08d)\n",
1384 dev->name, settings->clock_rate, bps);
1385 settings->clock_rate = bps;
1388 state |= PowerUp | Vis;
1389 printk(KERN_DEBUG "%s: external RxClk (DTE)\n", dev->name);
1391 scc_writel(state, dpriv, dev, CCR0);
1397 static int dscc4_encoding_setting(struct dscc4_dev_priv *dpriv,
1398 struct net_device *dev)
1400 struct thingie encoding[] = {
1401 { ENCODING_NRZ, 0x00000000 },
1402 { ENCODING_NRZI, 0x00200000 },
1403 { ENCODING_FM_MARK, 0x00400000 },
1404 { ENCODING_FM_SPACE, 0x00500000 },
1405 { ENCODING_MANCHESTER, 0x00600000 },
1410 i = dscc4_match(encoding, dpriv->encoding);
1412 scc_patchl(EncodingMask, encoding[i].bits, dpriv, dev, CCR0);
1418 static int dscc4_loopback_setting(struct dscc4_dev_priv *dpriv,
1419 struct net_device *dev)
1421 sync_serial_settings *settings = &dpriv->settings;
1424 state = scc_readl(dpriv, CCR1);
1425 if (settings->loopback) {
1426 printk(KERN_DEBUG "%s: loopback\n", dev->name);
1427 state |= 0x00000100;
1429 printk(KERN_DEBUG "%s: normal\n", dev->name);
1430 state &= ~0x00000100;
1432 scc_writel(state, dpriv, dev, CCR1);
1436 static int dscc4_crc_setting(struct dscc4_dev_priv *dpriv,
1437 struct net_device *dev)
1439 struct thingie crc[] = {
1440 { PARITY_CRC16_PR0_CCITT, 0x00000010 },
1441 { PARITY_CRC16_PR1_CCITT, 0x00000000 },
1442 { PARITY_CRC32_PR0_CCITT, 0x00000011 },
1443 { PARITY_CRC32_PR1_CCITT, 0x00000001 }
1447 i = dscc4_match(crc, dpriv->parity);
1449 scc_patchl(CrcMask, crc[i].bits, dpriv, dev, CCR1);
1455 static int dscc4_set_iface(struct dscc4_dev_priv *dpriv, struct net_device *dev)
1458 int (*action)(struct dscc4_dev_priv *, struct net_device *);
1459 } *p, do_setting[] = {
1460 { dscc4_encoding_setting },
1461 { dscc4_clock_setting },
1462 { dscc4_loopback_setting },
1463 { dscc4_crc_setting },
1468 for (p = do_setting; p->action; p++) {
1469 if ((ret = p->action(dpriv, dev)) < 0)
1475 static irqreturn_t dscc4_irq(int irq, void *token)
1477 struct dscc4_dev_priv *root = token;
1478 struct dscc4_pci_priv *priv;
1479 struct net_device *dev;
1480 void __iomem *ioaddr;
1482 unsigned long flags;
1485 priv = root->pci_priv;
1486 dev = dscc4_to_dev(root);
1488 spin_lock_irqsave(&priv->lock, flags);
1490 ioaddr = root->base_addr;
1492 state = readl(ioaddr + GSTAR);
1498 printk(KERN_DEBUG "%s: GSTAR = 0x%08x\n", DRV_NAME, state);
1499 writel(state, ioaddr + GSTAR);
1502 printk(KERN_ERR "%s: failure (Arf). Harass the maintener\n",
1509 printk(KERN_DEBUG "%s: CfgIV\n", DRV_NAME);
1510 if (priv->iqcfg[priv->cfg_cur++%IRQ_RING_SIZE] & cpu_to_le32(Arf))
1511 printk(KERN_ERR "%s: %s failed\n", dev->name, "CFG");
1512 if (!(state &= ~Cfg))
1515 if (state & RxEvt) {
1516 i = dev_per_card - 1;
1518 dscc4_rx_irq(priv, root + i);
1522 if (state & TxEvt) {
1523 i = dev_per_card - 1;
1525 dscc4_tx_irq(priv, root + i);
1530 spin_unlock_irqrestore(&priv->lock, flags);
1531 return IRQ_RETVAL(handled);
1534 static void dscc4_tx_irq(struct dscc4_pci_priv *ppriv,
1535 struct dscc4_dev_priv *dpriv)
1537 struct net_device *dev = dscc4_to_dev(dpriv);
1542 cur = dpriv->iqtx_current%IRQ_RING_SIZE;
1543 state = le32_to_cpu(dpriv->iqtx[cur]);
1546 printk(KERN_DEBUG "%s: Tx ISR = 0x%08x\n", dev->name,
1548 if ((debug > 1) && (loop > 1))
1549 printk(KERN_DEBUG "%s: Tx irq loop=%d\n", dev->name, loop);
1550 if (loop && netif_queue_stopped(dev))
1551 if ((dpriv->tx_current - dpriv->tx_dirty)%TX_RING_SIZE)
1552 netif_wake_queue(dev);
1554 if (netif_running(dev) && dscc4_tx_quiescent(dpriv, dev) &&
1555 !dscc4_tx_done(dpriv))
1556 dscc4_do_tx(dpriv, dev);
1560 dpriv->iqtx[cur] = 0;
1561 dpriv->iqtx_current++;
1563 if (state_check(state, dpriv, dev, "Tx") < 0)
1566 if (state & SccEvt) {
1568 struct sk_buff *skb;
1572 dscc4_tx_print(dev, dpriv, "Alls");
1574 * DataComplete can't be trusted for Tx completion.
1577 cur = dpriv->tx_dirty%TX_RING_SIZE;
1578 tx_fd = dpriv->tx_fd + cur;
1579 skb = dpriv->tx_skbuff[cur];
1581 pci_unmap_single(ppriv->pdev, le32_to_cpu(tx_fd->data),
1582 skb->len, PCI_DMA_TODEVICE);
1583 if (tx_fd->state & FrameEnd) {
1584 dev->stats.tx_packets++;
1585 dev->stats.tx_bytes += skb->len;
1587 dev_kfree_skb_irq(skb);
1588 dpriv->tx_skbuff[cur] = NULL;
1592 printk(KERN_ERR "%s Tx: NULL skb %d\n",
1596 * If the driver ends sending crap on the wire, it
1597 * will be way easier to diagnose than the (not so)
1598 * random freeze induced by null sized tx frames.
1600 tx_fd->data = tx_fd->next;
1601 tx_fd->state = FrameEnd | TO_STATE_TX(2*DUMMY_SKB_SIZE);
1602 tx_fd->complete = 0x00000000;
1605 if (!(state &= ~Alls))
1609 * Transmit Data Underrun
1612 printk(KERN_ERR "%s: XDU. Ask maintainer\n", DRV_NAME);
1613 dpriv->flags = NeedIDT;
1616 dpriv->base_addr + 0x0c*dpriv->dev_id + CH0CFG);
1617 writel(Action, dpriv->base_addr + GCMDR);
1621 printk(KERN_INFO "%s: CTS transition\n", dev->name);
1622 if (!(state &= ~Cts)) /* DEBUG */
1626 /* Frame needs to be sent again - FIXME */
1627 printk(KERN_ERR "%s: Xmr. Ask maintainer\n", DRV_NAME);
1628 if (!(state &= ~Xmr)) /* DEBUG */
1632 void __iomem *scc_addr;
1637 * - the busy condition happens (sometimes);
1638 * - it doesn't seem to make the handler unreliable.
1640 for (i = 1; i; i <<= 1) {
1641 if (!(scc_readl_star(dpriv, dev) & SccBusy))
1645 printk(KERN_INFO "%s busy in irq\n", dev->name);
1647 scc_addr = dpriv->base_addr + 0x0c*dpriv->dev_id;
1648 /* Keep this order: IDT before IDR */
1649 if (dpriv->flags & NeedIDT) {
1651 dscc4_tx_print(dev, dpriv, "Xpr");
1652 ring = dpriv->tx_fd_dma +
1653 (dpriv->tx_dirty%TX_RING_SIZE)*
1654 sizeof(struct TxFD);
1655 writel(ring, scc_addr + CH0BTDA);
1656 dscc4_do_tx(dpriv, dev);
1657 writel(MTFi | Idt, scc_addr + CH0CFG);
1658 if (dscc4_do_action(dev, "IDT") < 0)
1660 dpriv->flags &= ~NeedIDT;
1662 if (dpriv->flags & NeedIDR) {
1663 ring = dpriv->rx_fd_dma +
1664 (dpriv->rx_current%RX_RING_SIZE)*
1665 sizeof(struct RxFD);
1666 writel(ring, scc_addr + CH0BRDA);
1667 dscc4_rx_update(dpriv, dev);
1668 writel(MTFi | Idr, scc_addr + CH0CFG);
1669 if (dscc4_do_action(dev, "IDR") < 0)
1671 dpriv->flags &= ~NeedIDR;
1673 /* Activate receiver and misc */
1674 scc_writel(0x08050008, dpriv, dev, CCR2);
1677 if (!(state &= ~Xpr))
1682 printk(KERN_INFO "%s: CD transition\n", dev->name);
1683 if (!(state &= ~Cd)) /* DEBUG */
1686 } else { /* ! SccEvt */
1688 #ifdef DSCC4_POLLING
1689 while (!dscc4_tx_poll(dpriv, dev));
1691 printk(KERN_INFO "%s: Tx Hi\n", dev->name);
1695 printk(KERN_INFO "%s: Tx ERR\n", dev->name);
1696 dev->stats.tx_errors++;
1703 static void dscc4_rx_irq(struct dscc4_pci_priv *priv,
1704 struct dscc4_dev_priv *dpriv)
1706 struct net_device *dev = dscc4_to_dev(dpriv);
1711 cur = dpriv->iqrx_current%IRQ_RING_SIZE;
1712 state = le32_to_cpu(dpriv->iqrx[cur]);
1715 dpriv->iqrx[cur] = 0;
1716 dpriv->iqrx_current++;
1718 if (state_check(state, dpriv, dev, "Rx") < 0)
1721 if (!(state & SccEvt)){
1725 printk(KERN_DEBUG "%s: Rx ISR = 0x%08x\n", dev->name,
1727 state &= 0x00ffffff;
1728 if (state & Err) { /* Hold or reset */
1729 printk(KERN_DEBUG "%s: Rx ERR\n", dev->name);
1730 cur = dpriv->rx_current%RX_RING_SIZE;
1731 rx_fd = dpriv->rx_fd + cur;
1733 * Presume we're not facing a DMAC receiver reset.
1734 * As We use the rx size-filtering feature of the
1735 * DSCC4, the beginning of a new frame is waiting in
1736 * the rx fifo. I bet a Receive Data Overflow will
1737 * happen most of time but let's try and avoid it.
1738 * Btw (as for RDO) if one experiences ERR whereas
1739 * the system looks rather idle, there may be a
1740 * problem with latency. In this case, increasing
1741 * RX_RING_SIZE may help.
1743 //while (dpriv->rx_needs_refill) {
1744 while (!(rx_fd->state1 & Hold)) {
1747 if (!(cur = cur%RX_RING_SIZE))
1748 rx_fd = dpriv->rx_fd;
1750 //dpriv->rx_needs_refill--;
1751 try_get_rx_skb(dpriv, dev);
1754 rx_fd->state1 &= ~Hold;
1755 rx_fd->state2 = 0x00000000;
1756 rx_fd->end = cpu_to_le32(0xbabeface);
1761 dscc4_rx_skb(dpriv, dev);
1764 if (state & Hi ) { /* HI bit */
1765 printk(KERN_INFO "%s: Rx Hi\n", dev->name);
1769 } else { /* SccEvt */
1771 //FIXME: verifier la presence de tous les evenements
1774 const char *irq_name;
1776 { 0x00008000, "TIN"},
1777 { 0x00000020, "RSC"},
1778 { 0x00000010, "PCE"},
1779 { 0x00000008, "PLLA"},
1783 for (evt = evts; evt->irq_name; evt++) {
1784 if (state & evt->mask) {
1785 printk(KERN_DEBUG "%s: %s\n",
1786 dev->name, evt->irq_name);
1787 if (!(state &= ~evt->mask))
1792 if (!(state &= ~0x0000c03c))
1796 printk(KERN_INFO "%s: CTS transition\n", dev->name);
1797 if (!(state &= ~Cts)) /* DEBUG */
1801 * Receive Data Overflow (FIXME: fscked)
1805 void __iomem *scc_addr;
1809 // dscc4_rx_dump(dpriv);
1810 scc_addr = dpriv->base_addr + 0x0c*dpriv->dev_id;
1812 scc_patchl(RxActivate, 0, dpriv, dev, CCR2);
1814 * This has no effect. Why ?
1815 * ORed with TxSccRes, one sees the CFG ack (for
1816 * the TX part only).
1818 scc_writel(RxSccRes, dpriv, dev, CMDR);
1819 dpriv->flags |= RdoSet;
1822 * Let's try and save something in the received data.
1823 * rx_current must be incremented at least once to
1824 * avoid HOLD in the BRDA-to-be-pointed desc.
1827 cur = dpriv->rx_current++%RX_RING_SIZE;
1828 rx_fd = dpriv->rx_fd + cur;
1829 if (!(rx_fd->state2 & DataComplete))
1831 if (rx_fd->state2 & FrameAborted) {
1832 dev->stats.rx_over_errors++;
1833 rx_fd->state1 |= Hold;
1834 rx_fd->state2 = 0x00000000;
1835 rx_fd->end = cpu_to_le32(0xbabeface);
1837 dscc4_rx_skb(dpriv, dev);
1841 if (dpriv->flags & RdoSet)
1843 "%s: no RDO in Rx data\n", DRV_NAME);
1845 #ifdef DSCC4_RDO_EXPERIMENTAL_RECOVERY
1847 * FIXME: must the reset be this violent ?
1849 #warning "FIXME: CH0BRDA"
1850 writel(dpriv->rx_fd_dma +
1851 (dpriv->rx_current%RX_RING_SIZE)*
1852 sizeof(struct RxFD), scc_addr + CH0BRDA);
1853 writel(MTFi|Rdr|Idr, scc_addr + CH0CFG);
1854 if (dscc4_do_action(dev, "RDR") < 0) {
1855 printk(KERN_ERR "%s: RDO recovery failed(%s)\n",
1859 writel(MTFi|Idr, scc_addr + CH0CFG);
1860 if (dscc4_do_action(dev, "IDR") < 0) {
1861 printk(KERN_ERR "%s: RDO recovery failed(%s)\n",
1867 scc_patchl(0, RxActivate, dpriv, dev, CCR2);
1871 printk(KERN_INFO "%s: CD transition\n", dev->name);
1872 if (!(state &= ~Cd)) /* DEBUG */
1876 printk(KERN_DEBUG "%s: Flex. Ttttt...\n", DRV_NAME);
1877 if (!(state &= ~Flex))
1884 * I had expected the following to work for the first descriptor
1885 * (tx_fd->state = 0xc0000000)
1886 * - Hold=1 (don't try and branch to the next descripto);
1887 * - No=0 (I want an empty data section, i.e. size=0);
1888 * - Fe=1 (required by No=0 or we got an Err irq and must reset).
1889 * It failed and locked solid. Thus the introduction of a dummy skb.
1890 * Problem is acknowledged in errata sheet DS5. Joy :o/
1892 static struct sk_buff *dscc4_init_dummy_skb(struct dscc4_dev_priv *dpriv)
1894 struct sk_buff *skb;
1896 skb = dev_alloc_skb(DUMMY_SKB_SIZE);
1898 int last = dpriv->tx_dirty%TX_RING_SIZE;
1899 struct TxFD *tx_fd = dpriv->tx_fd + last;
1901 skb->len = DUMMY_SKB_SIZE;
1902 skb_copy_to_linear_data(skb, version,
1903 strlen(version) % DUMMY_SKB_SIZE);
1904 tx_fd->state = FrameEnd | TO_STATE_TX(DUMMY_SKB_SIZE);
1905 tx_fd->data = cpu_to_le32(pci_map_single(dpriv->pci_priv->pdev,
1906 skb->data, DUMMY_SKB_SIZE,
1908 dpriv->tx_skbuff[last] = skb;
1913 static int dscc4_init_ring(struct net_device *dev)
1915 struct dscc4_dev_priv *dpriv = dscc4_priv(dev);
1916 struct pci_dev *pdev = dpriv->pci_priv->pdev;
1922 ring = pci_alloc_consistent(pdev, RX_TOTAL_SIZE, &dpriv->rx_fd_dma);
1925 dpriv->rx_fd = rx_fd = (struct RxFD *) ring;
1927 ring = pci_alloc_consistent(pdev, TX_TOTAL_SIZE, &dpriv->tx_fd_dma);
1929 goto err_free_dma_rx;
1930 dpriv->tx_fd = tx_fd = (struct TxFD *) ring;
1932 memset(dpriv->tx_skbuff, 0, sizeof(struct sk_buff *)*TX_RING_SIZE);
1933 dpriv->tx_dirty = 0xffffffff;
1934 i = dpriv->tx_current = 0;
1936 tx_fd->state = FrameEnd | TO_STATE_TX(2*DUMMY_SKB_SIZE);
1937 tx_fd->complete = 0x00000000;
1938 /* FIXME: NULL should be ok - to be tried */
1939 tx_fd->data = cpu_to_le32(dpriv->tx_fd_dma);
1940 (tx_fd++)->next = cpu_to_le32(dpriv->tx_fd_dma +
1941 (++i%TX_RING_SIZE)*sizeof(*tx_fd));
1942 } while (i < TX_RING_SIZE);
1944 if (!dscc4_init_dummy_skb(dpriv))
1945 goto err_free_dma_tx;
1947 memset(dpriv->rx_skbuff, 0, sizeof(struct sk_buff *)*RX_RING_SIZE);
1948 i = dpriv->rx_dirty = dpriv->rx_current = 0;
1950 /* size set by the host. Multiple of 4 bytes please */
1951 rx_fd->state1 = HiDesc;
1952 rx_fd->state2 = 0x00000000;
1953 rx_fd->end = cpu_to_le32(0xbabeface);
1954 rx_fd->state1 |= TO_STATE_RX(HDLC_MAX_MRU);
1955 // FIXME: return value verifiee mais traitement suspect
1956 if (try_get_rx_skb(dpriv, dev) >= 0)
1958 (rx_fd++)->next = cpu_to_le32(dpriv->rx_fd_dma +
1959 (++i%RX_RING_SIZE)*sizeof(*rx_fd));
1960 } while (i < RX_RING_SIZE);
1965 pci_free_consistent(pdev, TX_TOTAL_SIZE, ring, dpriv->tx_fd_dma);
1967 pci_free_consistent(pdev, RX_TOTAL_SIZE, rx_fd, dpriv->rx_fd_dma);
1972 static void __devexit dscc4_remove_one(struct pci_dev *pdev)
1974 struct dscc4_pci_priv *ppriv;
1975 struct dscc4_dev_priv *root;
1976 void __iomem *ioaddr;
1979 ppriv = pci_get_drvdata(pdev);
1982 ioaddr = root->base_addr;
1984 dscc4_pci_reset(pdev, ioaddr);
1986 free_irq(pdev->irq, root);
1987 pci_free_consistent(pdev, IRQ_RING_SIZE*sizeof(u32), ppriv->iqcfg,
1989 for (i = 0; i < dev_per_card; i++) {
1990 struct dscc4_dev_priv *dpriv = root + i;
1992 dscc4_release_ring(dpriv);
1993 pci_free_consistent(pdev, IRQ_RING_SIZE*sizeof(u32),
1994 dpriv->iqrx, dpriv->iqrx_dma);
1995 pci_free_consistent(pdev, IRQ_RING_SIZE*sizeof(u32),
1996 dpriv->iqtx, dpriv->iqtx_dma);
2003 pci_release_region(pdev, 1);
2004 pci_release_region(pdev, 0);
2006 pci_disable_device(pdev);
2009 static int dscc4_hdlc_attach(struct net_device *dev, unsigned short encoding,
2010 unsigned short parity)
2012 struct dscc4_dev_priv *dpriv = dscc4_priv(dev);
2014 if (encoding != ENCODING_NRZ &&
2015 encoding != ENCODING_NRZI &&
2016 encoding != ENCODING_FM_MARK &&
2017 encoding != ENCODING_FM_SPACE &&
2018 encoding != ENCODING_MANCHESTER)
2021 if (parity != PARITY_NONE &&
2022 parity != PARITY_CRC16_PR0_CCITT &&
2023 parity != PARITY_CRC16_PR1_CCITT &&
2024 parity != PARITY_CRC32_PR0_CCITT &&
2025 parity != PARITY_CRC32_PR1_CCITT)
2028 dpriv->encoding = encoding;
2029 dpriv->parity = parity;
2034 static int __init dscc4_setup(char *str)
2036 int *args[] = { &debug, &quartz, NULL }, **p = args;
2038 while (*p && (get_option(&str, *p) == 2))
2043 __setup("dscc4.setup=", dscc4_setup);
2046 static struct pci_device_id dscc4_pci_tbl[] = {
2047 { PCI_VENDOR_ID_SIEMENS, PCI_DEVICE_ID_SIEMENS_DSCC4,
2048 PCI_ANY_ID, PCI_ANY_ID, },
2051 MODULE_DEVICE_TABLE(pci, dscc4_pci_tbl);
2053 static struct pci_driver dscc4_driver = {
2055 .id_table = dscc4_pci_tbl,
2056 .probe = dscc4_init_one,
2057 .remove = __devexit_p(dscc4_remove_one),
2060 static int __init dscc4_init_module(void)
2062 return pci_register_driver(&dscc4_driver);
2065 static void __exit dscc4_cleanup_module(void)
2067 pci_unregister_driver(&dscc4_driver);
2070 module_init(dscc4_init_module);
2071 module_exit(dscc4_cleanup_module);