2 * Hitachi (now Renesas) SCA-II HD64572 driver for Linux
4 * Copyright (C) 1998-2008 Krzysztof Halasa <khc@pm.waw.pl>
6 * This program is free software; you can redistribute it and/or modify it
7 * under the terms of version 2 of the GNU General Public License
8 * as published by the Free Software Foundation.
10 * Source of information: HD64572 SCA-II User's Manual
12 * We use the following SCA memory map:
14 * Packet buffer descriptor rings - starting from winbase or win0base:
15 * rx_ring_buffers * sizeof(pkt_desc) = logical channel #0 RX ring
16 * tx_ring_buffers * sizeof(pkt_desc) = logical channel #0 TX ring
17 * rx_ring_buffers * sizeof(pkt_desc) = logical channel #1 RX ring (if used)
18 * tx_ring_buffers * sizeof(pkt_desc) = logical channel #1 TX ring (if used)
20 * Packet data buffers - starting from winbase + buff_offset:
21 * rx_ring_buffers * HDLC_MAX_MRU = logical channel #0 RX buffers
22 * tx_ring_buffers * HDLC_MAX_MRU = logical channel #0 TX buffers
23 * rx_ring_buffers * HDLC_MAX_MRU = logical channel #0 RX buffers (if used)
24 * tx_ring_buffers * HDLC_MAX_MRU = logical channel #0 TX buffers (if used)
27 #include <linux/bitops.h>
28 #include <linux/errno.h>
29 #include <linux/fcntl.h>
30 #include <linux/hdlc.h>
32 #include <linux/init.h>
33 #include <linux/interrupt.h>
34 #include <linux/ioport.h>
35 #include <linux/jiffies.h>
36 #include <linux/kernel.h>
37 #include <linux/module.h>
38 #include <linux/netdevice.h>
39 #include <linux/skbuff.h>
40 #include <linux/slab.h>
41 #include <linux/string.h>
42 #include <linux/types.h>
44 #include <asm/system.h>
45 #include <asm/uaccess.h>
48 #define NAPI_WEIGHT 16
50 #define get_msci(port) (phy_node(port) ? MSCI1_OFFSET : MSCI0_OFFSET)
51 #define get_dmac_rx(port) (phy_node(port) ? DMAC1RX_OFFSET : DMAC0RX_OFFSET)
52 #define get_dmac_tx(port) (phy_node(port) ? DMAC1TX_OFFSET : DMAC0TX_OFFSET)
54 #define SCA_INTR_MSCI(node) (node ? 0x10 : 0x01)
55 #define SCA_INTR_DMAC_RX(node) (node ? 0x20 : 0x02)
56 #define SCA_INTR_DMAC_TX(node) (node ? 0x40 : 0x04)
58 static int sca_poll(struct napi_struct *napi, int budget);
60 static inline struct net_device *port_to_dev(port_t *port)
65 static inline int sca_intr_status(card_t *card)
68 u32 isr0 = sca_inl(ISR0, card);
70 if (isr0 & 0x0000000F) result |= SCA_INTR_DMAC_RX(0);
71 if (isr0 & 0x000000F0) result |= SCA_INTR_DMAC_TX(0);
72 if (isr0 & 0x00000F00) result |= SCA_INTR_DMAC_RX(1);
73 if (isr0 & 0x0000F000) result |= SCA_INTR_DMAC_TX(1);
74 if (isr0 & 0x003E0000) result |= SCA_INTR_MSCI(0);
75 if (isr0 & 0x3E000000) result |= SCA_INTR_MSCI(1);
77 if (!(result & SCA_INTR_DMAC_TX(0)))
78 if (sca_in(DSR_TX(0), card) & DSR_EOM)
79 result |= SCA_INTR_DMAC_TX(0);
80 if (!(result & SCA_INTR_DMAC_TX(1)))
81 if (sca_in(DSR_TX(1), card) & DSR_EOM)
82 result |= SCA_INTR_DMAC_TX(1);
87 static inline port_t* dev_to_port(struct net_device *dev)
89 return dev_to_hdlc(dev)->priv;
92 static inline void enable_intr(port_t *port)
94 /* DMA & MSCI IRQ enable */
95 /* IR0_TXINT | IR0_RXINTA | IR0_DMIB* | IR0_DMIA* */
96 sca_outl(sca_inl(IER0, port->card) |
97 (phy_node(port) ? 0x0A006600 : 0x000A0066), IER0, port->card);
100 static inline void disable_intr(port_t *port)
102 sca_outl(sca_inl(IER0, port->card) &
103 (phy_node(port) ? 0x00FF00FF : 0xFF00FF00), IER0, port->card);
106 static inline u16 next_desc(port_t *port, u16 desc, int transmit)
108 return (desc + 1) % (transmit ? port_to_card(port)->tx_ring_buffers
109 : port_to_card(port)->rx_ring_buffers);
113 static inline u16 desc_abs_number(port_t *port, u16 desc, int transmit)
115 u16 rx_buffs = port_to_card(port)->rx_ring_buffers;
116 u16 tx_buffs = port_to_card(port)->tx_ring_buffers;
118 desc %= (transmit ? tx_buffs : rx_buffs); // called with "X + 1" etc.
119 return log_node(port) * (rx_buffs + tx_buffs) +
120 transmit * rx_buffs + desc;
124 static inline u16 desc_offset(port_t *port, u16 desc, int transmit)
126 /* Descriptor offset always fits in 16 bytes */
127 return desc_abs_number(port, desc, transmit) * sizeof(pkt_desc);
131 static inline pkt_desc __iomem *desc_address(port_t *port, u16 desc,
134 return (pkt_desc __iomem *)(winbase(port_to_card(port))
135 + desc_offset(port, desc, transmit));
139 static inline u32 buffer_offset(port_t *port, u16 desc, int transmit)
141 return port_to_card(port)->buff_offset +
142 desc_abs_number(port, desc, transmit) * (u32)HDLC_MAX_MRU;
146 static inline void sca_set_carrier(port_t *port)
148 if (!(sca_in(get_msci(port) + ST3, port_to_card(port)) & ST3_DCD)) {
150 printk(KERN_DEBUG "%s: sca_set_carrier on\n",
151 port_to_dev(port)->name);
153 netif_carrier_on(port_to_dev(port));
156 printk(KERN_DEBUG "%s: sca_set_carrier off\n",
157 port_to_dev(port)->name);
159 netif_carrier_off(port_to_dev(port));
164 static void sca_init_port(port_t *port)
166 card_t *card = port_to_card(port);
173 for (transmit = 0; transmit < 2; transmit++) {
174 u16 dmac = transmit ? get_dmac_tx(port) : get_dmac_rx(port);
175 u16 buffs = transmit ? card->tx_ring_buffers
176 : card->rx_ring_buffers;
178 for (i = 0; i < buffs; i++) {
179 pkt_desc __iomem *desc = desc_address(port, i, transmit);
180 u16 chain_off = desc_offset(port, i + 1, transmit);
181 u32 buff_off = buffer_offset(port, i, transmit);
183 writel(chain_off, &desc->cp);
184 writel(buff_off, &desc->bp);
185 writew(0, &desc->len);
186 writeb(0, &desc->stat);
189 /* DMA disable - to halt state */
190 sca_out(0, transmit ? DSR_TX(phy_node(port)) :
191 DSR_RX(phy_node(port)), card);
192 /* software ABORT - to initial state */
193 sca_out(DCR_ABORT, transmit ? DCR_TX(phy_node(port)) :
194 DCR_RX(phy_node(port)), card);
196 /* current desc addr */
197 sca_outl(desc_offset(port, 0, transmit), dmac + CDAL, card);
199 sca_outl(desc_offset(port, buffs - 1, transmit),
202 sca_outl(desc_offset(port, 0, transmit), dmac + EDAL,
205 /* clear frame end interrupt counter */
206 sca_out(DCR_CLEAR_EOF, transmit ? DCR_TX(phy_node(port)) :
207 DCR_RX(phy_node(port)), card);
209 if (!transmit) { /* Receive */
210 /* set buffer length */
211 sca_outw(HDLC_MAX_MRU, dmac + BFLL, card);
212 /* Chain mode, Multi-frame */
213 sca_out(0x14, DMR_RX(phy_node(port)), card);
214 sca_out(DIR_EOME | DIR_BOFE, DIR_RX(phy_node(port)),
217 sca_out(DSR_DE, DSR_RX(phy_node(port)), card);
218 } else { /* Transmit */
219 /* Chain mode, Multi-frame */
220 sca_out(0x14, DMR_TX(phy_node(port)), card);
221 /* enable underflow interrupts */
222 sca_out(DIR_BOFE, DIR_TX(phy_node(port)), card);
225 sca_set_carrier(port);
226 netif_napi_add(port_to_dev(port), &port->napi, sca_poll, NAPI_WEIGHT);
230 /* MSCI interrupt service */
231 static inline void sca_msci_intr(port_t *port)
233 u16 msci = get_msci(port);
234 card_t* card = port_to_card(port);
235 u8 stat = sca_in(msci + ST1, card); /* read MSCI ST1 status */
237 /* Reset MSCI TX underrun and CDCD status bit */
238 sca_out(stat & (ST1_UDRN | ST1_CDCD), msci + ST1, card);
240 if (stat & ST1_UDRN) {
241 /* TX Underrun error detected */
242 port_to_dev(port)->stats.tx_errors++;
243 port_to_dev(port)->stats.tx_fifo_errors++;
247 sca_set_carrier(port);
251 static inline void sca_rx(card_t *card, port_t *port, pkt_desc __iomem *desc,
254 struct net_device *dev = port_to_dev(port);
259 len = readw(&desc->len);
260 skb = dev_alloc_skb(len);
262 dev->stats.rx_dropped++;
266 buff = buffer_offset(port, rxin, 0);
267 memcpy_fromio(skb->data, winbase(card) + buff, len);
271 printk(KERN_DEBUG "%s RX(%i):", dev->name, skb->len);
274 dev->stats.rx_packets++;
275 dev->stats.rx_bytes += skb->len;
276 skb->protocol = hdlc_type_trans(skb, dev);
277 netif_receive_skb(skb);
281 /* Receive DMA service */
282 static inline int sca_rx_done(port_t *port, int budget)
284 struct net_device *dev = port_to_dev(port);
285 u16 dmac = get_dmac_rx(port);
286 card_t *card = port_to_card(port);
287 u8 stat = sca_in(DSR_RX(phy_node(port)), card); /* read DMA Status */
290 /* Reset DSR status bits */
291 sca_out((stat & (DSR_EOT | DSR_EOM | DSR_BOF | DSR_COF)) | DSR_DWE,
292 DSR_RX(phy_node(port)), card);
295 /* Dropped one or more frames */
296 dev->stats.rx_over_errors++;
298 while (received < budget) {
299 u32 desc_off = desc_offset(port, port->rxin, 0);
300 pkt_desc __iomem *desc;
301 u32 cda = sca_inl(dmac + CDAL, card);
303 if ((cda >= desc_off) && (cda < desc_off + sizeof(pkt_desc)))
304 break; /* No frame received */
306 desc = desc_address(port, port->rxin, 0);
307 stat = readb(&desc->stat);
308 if (!(stat & ST_RX_EOM))
309 port->rxpart = 1; /* partial frame received */
310 else if ((stat & ST_ERROR_MASK) || port->rxpart) {
311 dev->stats.rx_errors++;
312 if (stat & ST_RX_OVERRUN)
313 dev->stats.rx_fifo_errors++;
314 else if ((stat & (ST_RX_SHORT | ST_RX_ABORT |
315 ST_RX_RESBIT)) || port->rxpart)
316 dev->stats.rx_frame_errors++;
317 else if (stat & ST_RX_CRC)
318 dev->stats.rx_crc_errors++;
319 if (stat & ST_RX_EOM)
320 port->rxpart = 0; /* received last fragment */
322 sca_rx(card, port, desc, port->rxin);
326 /* Set new error descriptor address */
327 sca_outl(desc_off, dmac + EDAL, card);
328 port->rxin = next_desc(port, port->rxin, 0);
331 /* make sure RX DMA is enabled */
332 sca_out(DSR_DE, DSR_RX(phy_node(port)), card);
337 /* Transmit DMA service */
338 static inline void sca_tx_done(port_t *port)
340 struct net_device *dev = port_to_dev(port);
341 card_t* card = port_to_card(port);
344 spin_lock(&port->lock);
346 stat = sca_in(DSR_TX(phy_node(port)), card); /* read DMA Status */
348 /* Reset DSR status bits */
349 sca_out((stat & (DSR_EOT | DSR_EOM | DSR_BOF | DSR_COF)) | DSR_DWE,
350 DSR_TX(phy_node(port)), card);
353 pkt_desc __iomem *desc = desc_address(port, port->txlast, 1);
355 if (!(readb(&desc->stat) & ST_TX_OWNRSHP))
356 break; /* not yet transmitted */
357 dev->stats.tx_packets++;
358 dev->stats.tx_bytes += readw(&desc->len);
359 writeb(0, &desc->stat); /* Free descriptor */
360 port->txlast = next_desc(port, port->txlast, 1);
363 netif_wake_queue(dev);
364 spin_unlock(&port->lock);
368 static int sca_poll(struct napi_struct *napi, int budget)
370 port_t *port = container_of(napi, port_t, napi);
371 u8 stat = sca_intr_status(port->card);
374 if (stat & SCA_INTR_MSCI(port->phy_node))
377 if (stat & SCA_INTR_DMAC_TX(port->phy_node))
380 if (stat & SCA_INTR_DMAC_RX(port->phy_node))
381 received = sca_rx_done(port, budget);
383 if (received < budget) {
384 netif_rx_complete(port->dev, napi);
391 static irqreturn_t sca_intr(int irq, void* dev_id)
393 card_t *card = dev_id;
395 u8 stat = sca_intr_status(card);
398 for (i = 0; i < 2; i++) {
399 port_t *port = get_port(card, i);
400 if (port && (stat & (SCA_INTR_MSCI(i) | SCA_INTR_DMAC_RX(i) |
401 SCA_INTR_DMAC_TX(i)))) {
404 netif_rx_schedule(port->dev, &port->napi);
408 return IRQ_RETVAL(handled);
412 static void sca_set_port(port_t *port)
414 card_t* card = port_to_card(port);
415 u16 msci = get_msci(port);
416 u8 md2 = sca_in(msci + MD2, card);
417 unsigned int tmc, br = 10, brv = 1024;
420 if (port->settings.clock_rate > 0) {
421 /* Try lower br for better accuracy*/
424 brv >>= 1; /* brv = 2^9 = 512 max in specs */
426 /* Baud Rate = CLOCK_BASE / TMC / 2^BR */
427 tmc = CLOCK_BASE / brv / port->settings.clock_rate;
428 }while (br > 1 && tmc <= 128);
432 br = 0; /* For baud=CLOCK_BASE we use tmc=1 br=0 */
434 } else if (tmc > 255)
435 tmc = 256; /* tmc=0 means 256 - low baud rates */
437 port->settings.clock_rate = CLOCK_BASE / brv / tmc;
439 br = 9; /* Minimum clock rate */
440 tmc = 256; /* 8bit = 0 */
441 port->settings.clock_rate = CLOCK_BASE / (256 * 512);
444 port->rxs = (port->rxs & ~CLK_BRG_MASK) | br;
445 port->txs = (port->txs & ~CLK_BRG_MASK) | br;
448 /* baud divisor - time constant*/
449 sca_out(port->tmc, msci + TMCR, card);
450 sca_out(port->tmc, msci + TMCT, card);
453 sca_out(port->rxs, msci + RXS, card);
454 sca_out(port->txs, msci + TXS, card);
456 if (port->settings.loopback)
459 md2 &= ~MD2_LOOPBACK;
461 sca_out(md2, msci + MD2, card);
466 static void sca_open(struct net_device *dev)
468 port_t *port = dev_to_port(dev);
469 card_t* card = port_to_card(port);
470 u16 msci = get_msci(port);
473 switch(port->encoding) {
474 case ENCODING_NRZ: md2 = MD2_NRZ; break;
475 case ENCODING_NRZI: md2 = MD2_NRZI; break;
476 case ENCODING_FM_MARK: md2 = MD2_FM_MARK; break;
477 case ENCODING_FM_SPACE: md2 = MD2_FM_SPACE; break;
478 default: md2 = MD2_MANCHESTER;
481 if (port->settings.loopback)
484 switch(port->parity) {
485 case PARITY_CRC16_PR0: md0 = MD0_HDLC | MD0_CRC_16_0; break;
486 case PARITY_CRC16_PR1: md0 = MD0_HDLC | MD0_CRC_16; break;
487 case PARITY_CRC32_PR1_CCITT: md0 = MD0_HDLC | MD0_CRC_ITU32; break;
488 case PARITY_CRC16_PR1_CCITT: md0 = MD0_HDLC | MD0_CRC_ITU; break;
489 default: md0 = MD0_HDLC | MD0_CRC_NONE;
492 sca_out(CMD_RESET, msci + CMD, card);
493 sca_out(md0, msci + MD0, card);
494 sca_out(0x00, msci + MD1, card); /* no address field check */
495 sca_out(md2, msci + MD2, card);
496 sca_out(0x7E, msci + IDL, card); /* flag character 0x7E */
497 /* Skip the rest of underrun frame */
498 sca_out(CTL_IDLE | CTL_URCT | CTL_URSKP, msci + CTL, card);
499 sca_out(0x0F, msci + RNR, card); /* +1=RX DMA activation condition */
500 sca_out(0x3C, msci + TFS, card); /* +1 = TX start */
501 sca_out(0x38, msci + TCR, card); /* =Critical TX DMA activ condition */
502 sca_out(0x38, msci + TNR0, card); /* =TX DMA activation condition */
503 sca_out(0x3F, msci + TNR1, card); /* +1=TX DMA deactivation condition*/
505 /* We're using the following interrupts:
506 - TXINT (DMAC completed all transmissions, underrun or DCD change)
509 /* MSCI TXINT and RXINTA interrupt enable */
510 sca_outl(IE0_TXINT | IE0_RXINTA | IE0_UDRN | IE0_CDCD, msci + IE0,
513 sca_out(port->tmc, msci + TMCR, card);
514 sca_out(port->tmc, msci + TMCT, card);
515 sca_out(port->rxs, msci + RXS, card);
516 sca_out(port->txs, msci + TXS, card);
517 sca_out(CMD_TX_ENABLE, msci + CMD, card);
518 sca_out(CMD_RX_ENABLE, msci + CMD, card);
520 sca_set_carrier(port);
522 napi_enable(&port->napi);
523 netif_start_queue(dev);
527 static void sca_close(struct net_device *dev)
529 port_t *port = dev_to_port(dev);
532 sca_out(CMD_RESET, get_msci(port) + CMD, port_to_card(port));
534 napi_disable(&port->napi);
535 netif_stop_queue(dev);
539 static int sca_attach(struct net_device *dev, unsigned short encoding,
540 unsigned short parity)
542 if (encoding != ENCODING_NRZ &&
543 encoding != ENCODING_NRZI &&
544 encoding != ENCODING_FM_MARK &&
545 encoding != ENCODING_FM_SPACE &&
546 encoding != ENCODING_MANCHESTER)
549 if (parity != PARITY_NONE &&
550 parity != PARITY_CRC16_PR0 &&
551 parity != PARITY_CRC16_PR1 &&
552 parity != PARITY_CRC32_PR1_CCITT &&
553 parity != PARITY_CRC16_PR1_CCITT)
556 dev_to_port(dev)->encoding = encoding;
557 dev_to_port(dev)->parity = parity;
563 static void sca_dump_rings(struct net_device *dev)
565 port_t *port = dev_to_port(dev);
566 card_t *card = port_to_card(port);
569 printk(KERN_DEBUG "RX ring: CDA=%u EDA=%u DSR=%02X in=%u %sactive",
570 sca_inl(get_dmac_rx(port) + CDAL, card),
571 sca_inl(get_dmac_rx(port) + EDAL, card),
572 sca_in(DSR_RX(phy_node(port)), card), port->rxin,
573 sca_in(DSR_RX(phy_node(port)), card) & DSR_DE ? "" : "in");
574 for (cnt = 0; cnt < port_to_card(port)->rx_ring_buffers; cnt++)
575 printk(" %02X", readb(&(desc_address(port, cnt, 0)->stat)));
577 printk("\n" KERN_DEBUG "TX ring: CDA=%u EDA=%u DSR=%02X in=%u "
579 sca_inl(get_dmac_tx(port) + CDAL, card),
580 sca_inl(get_dmac_tx(port) + EDAL, card),
581 sca_in(DSR_TX(phy_node(port)), card), port->txin, port->txlast,
582 sca_in(DSR_TX(phy_node(port)), card) & DSR_DE ? "" : "in");
584 for (cnt = 0; cnt < port_to_card(port)->tx_ring_buffers; cnt++)
585 printk(" %02X", readb(&(desc_address(port, cnt, 1)->stat)));
588 printk(KERN_DEBUG "MSCI: MD: %02x %02x %02x,"
589 " ST: %02x %02x %02x %02x %02x, FST: %02x CST: %02x %02x\n",
590 sca_in(get_msci(port) + MD0, card),
591 sca_in(get_msci(port) + MD1, card),
592 sca_in(get_msci(port) + MD2, card),
593 sca_in(get_msci(port) + ST0, card),
594 sca_in(get_msci(port) + ST1, card),
595 sca_in(get_msci(port) + ST2, card),
596 sca_in(get_msci(port) + ST3, card),
597 sca_in(get_msci(port) + ST4, card),
598 sca_in(get_msci(port) + FST, card),
599 sca_in(get_msci(port) + CST0, card),
600 sca_in(get_msci(port) + CST1, card));
602 printk(KERN_DEBUG "ILAR: %02x ISR: %08x %08x\n", sca_in(ILAR, card),
603 sca_inl(ISR0, card), sca_inl(ISR1, card));
605 #endif /* DEBUG_RINGS */
608 static int sca_xmit(struct sk_buff *skb, struct net_device *dev)
610 port_t *port = dev_to_port(dev);
611 card_t *card = port_to_card(port);
612 pkt_desc __iomem *desc;
615 spin_lock_irq(&port->lock);
617 desc = desc_address(port, port->txin + 1, 1);
618 BUG_ON(readb(&desc->stat)); /* previous xmit should stop queue */
621 printk(KERN_DEBUG "%s TX(%i):", dev->name, skb->len);
625 desc = desc_address(port, port->txin, 1);
626 buff = buffer_offset(port, port->txin, 1);
628 memcpy_toio(winbase(card) + buff, skb->data, len);
630 writew(len, &desc->len);
631 writeb(ST_TX_EOM, &desc->stat);
632 dev->trans_start = jiffies;
634 port->txin = next_desc(port, port->txin, 1);
635 sca_outl(desc_offset(port, port->txin, 1),
636 get_dmac_tx(port) + EDAL, card);
638 sca_out(DSR_DE, DSR_TX(phy_node(port)), card); /* Enable TX DMA */
640 desc = desc_address(port, port->txin + 1, 1);
641 if (readb(&desc->stat)) /* allow 1 packet gap */
642 netif_stop_queue(dev);
644 spin_unlock_irq(&port->lock);
651 static u32 __devinit sca_detect_ram(card_t *card, u8 __iomem *rambase,
654 /* Round RAM size to 32 bits, fill from end to start */
655 u32 i = ramsize &= ~3;
659 writel(i ^ 0x12345678, rambase + i);
662 for (i = 0; i < ramsize ; i += 4) {
663 if (readl(rambase + i) != (i ^ 0x12345678))
671 static void __devinit sca_init(card_t *card, int wait_states)
673 sca_out(wait_states, WCRL, card); /* Wait Control */
674 sca_out(wait_states, WCRM, card);
675 sca_out(wait_states, WCRH, card);
677 sca_out(0, DMER, card); /* DMA Master disable */
678 sca_out(0x03, PCR, card); /* DMA priority */
679 sca_out(0, DSR_RX(0), card); /* DMA disable - to halt state */
680 sca_out(0, DSR_TX(0), card);
681 sca_out(0, DSR_RX(1), card);
682 sca_out(0, DSR_TX(1), card);
683 sca_out(DMER_DME, DMER, card); /* DMA Master enable */