2 * drivers/net/ibm_newemac/mal.c
4 * Memory Access Layer (MAL) support
6 * Copyright 2007 Benjamin Herrenschmidt, IBM Corp.
7 * <benh@kernel.crashing.org>
9 * Based on the arch/ppc version of the driver:
11 * Copyright (c) 2004, 2005 Zultys Technologies.
12 * Eugene Surovegin <eugene.surovegin@zultys.com> or <ebs@ebshome.net>
14 * Based on original work by
15 * Benjamin Herrenschmidt <benh@kernel.crashing.org>,
16 * David Gibson <hermes@gibson.dropbear.id.au>,
18 * Armin Kuster <akuster@mvista.com>
19 * Copyright 2002 MontaVista Softare Inc.
21 * This program is free software; you can redistribute it and/or modify it
22 * under the terms of the GNU General Public License as published by the
23 * Free Software Foundation; either version 2 of the License, or (at your
24 * option) any later version.
28 #include <linux/delay.h>
31 #include <asm/dcr-regs.h>
35 int __devinit mal_register_commac(struct mal_instance *mal,
36 struct mal_commac *commac)
40 spin_lock_irqsave(&mal->lock, flags);
42 MAL_DBG(mal, "reg(%08x, %08x)" NL,
43 commac->tx_chan_mask, commac->rx_chan_mask);
45 /* Don't let multiple commacs claim the same channel(s) */
46 if ((mal->tx_chan_mask & commac->tx_chan_mask) ||
47 (mal->rx_chan_mask & commac->rx_chan_mask)) {
48 spin_unlock_irqrestore(&mal->lock, flags);
49 printk(KERN_WARNING "mal%d: COMMAC channels conflict!\n",
54 if (list_empty(&mal->list))
55 napi_enable(&mal->napi);
56 mal->tx_chan_mask |= commac->tx_chan_mask;
57 mal->rx_chan_mask |= commac->rx_chan_mask;
58 list_add(&commac->list, &mal->list);
60 spin_unlock_irqrestore(&mal->lock, flags);
65 void mal_unregister_commac(struct mal_instance *mal,
66 struct mal_commac *commac)
70 spin_lock_irqsave(&mal->lock, flags);
72 MAL_DBG(mal, "unreg(%08x, %08x)" NL,
73 commac->tx_chan_mask, commac->rx_chan_mask);
75 mal->tx_chan_mask &= ~commac->tx_chan_mask;
76 mal->rx_chan_mask &= ~commac->rx_chan_mask;
77 list_del_init(&commac->list);
78 if (list_empty(&mal->list))
79 napi_disable(&mal->napi);
81 spin_unlock_irqrestore(&mal->lock, flags);
84 int mal_set_rcbs(struct mal_instance *mal, int channel, unsigned long size)
86 BUG_ON(channel < 0 || channel >= mal->num_rx_chans ||
87 size > MAL_MAX_RX_SIZE);
89 MAL_DBG(mal, "set_rbcs(%d, %lu)" NL, channel, size);
93 "mal%d: incorrect RX size %lu for the channel %d\n",
94 mal->index, size, channel);
98 set_mal_dcrn(mal, MAL_RCBS(channel), size >> 4);
102 int mal_tx_bd_offset(struct mal_instance *mal, int channel)
104 BUG_ON(channel < 0 || channel >= mal->num_tx_chans);
106 return channel * NUM_TX_BUFF;
109 int mal_rx_bd_offset(struct mal_instance *mal, int channel)
111 BUG_ON(channel < 0 || channel >= mal->num_rx_chans);
112 return mal->num_tx_chans * NUM_TX_BUFF + channel * NUM_RX_BUFF;
115 void mal_enable_tx_channel(struct mal_instance *mal, int channel)
119 spin_lock_irqsave(&mal->lock, flags);
121 MAL_DBG(mal, "enable_tx(%d)" NL, channel);
123 set_mal_dcrn(mal, MAL_TXCASR,
124 get_mal_dcrn(mal, MAL_TXCASR) | MAL_CHAN_MASK(channel));
126 spin_unlock_irqrestore(&mal->lock, flags);
129 void mal_disable_tx_channel(struct mal_instance *mal, int channel)
131 set_mal_dcrn(mal, MAL_TXCARR, MAL_CHAN_MASK(channel));
133 MAL_DBG(mal, "disable_tx(%d)" NL, channel);
136 void mal_enable_rx_channel(struct mal_instance *mal, int channel)
141 * On some 4xx PPC's (e.g. 460EX/GT), the rx channel is a multiple
142 * of 8, but enabling in MAL_RXCASR needs the divided by 8 value
148 spin_lock_irqsave(&mal->lock, flags);
150 MAL_DBG(mal, "enable_rx(%d)" NL, channel);
152 set_mal_dcrn(mal, MAL_RXCASR,
153 get_mal_dcrn(mal, MAL_RXCASR) | MAL_CHAN_MASK(channel));
155 spin_unlock_irqrestore(&mal->lock, flags);
158 void mal_disable_rx_channel(struct mal_instance *mal, int channel)
161 * On some 4xx PPC's (e.g. 460EX/GT), the rx channel is a multiple
162 * of 8, but enabling in MAL_RXCASR needs the divided by 8 value
168 set_mal_dcrn(mal, MAL_RXCARR, MAL_CHAN_MASK(channel));
170 MAL_DBG(mal, "disable_rx(%d)" NL, channel);
173 void mal_poll_add(struct mal_instance *mal, struct mal_commac *commac)
177 spin_lock_irqsave(&mal->lock, flags);
179 MAL_DBG(mal, "poll_add(%p)" NL, commac);
181 /* starts disabled */
182 set_bit(MAL_COMMAC_POLL_DISABLED, &commac->flags);
184 list_add_tail(&commac->poll_list, &mal->poll_list);
186 spin_unlock_irqrestore(&mal->lock, flags);
189 void mal_poll_del(struct mal_instance *mal, struct mal_commac *commac)
193 spin_lock_irqsave(&mal->lock, flags);
195 MAL_DBG(mal, "poll_del(%p)" NL, commac);
197 list_del(&commac->poll_list);
199 spin_unlock_irqrestore(&mal->lock, flags);
202 /* synchronized by mal_poll() */
203 static inline void mal_enable_eob_irq(struct mal_instance *mal)
205 MAL_DBG2(mal, "enable_irq" NL);
207 // XXX might want to cache MAL_CFG as the DCR read can be slooooow
208 set_mal_dcrn(mal, MAL_CFG, get_mal_dcrn(mal, MAL_CFG) | MAL_CFG_EOPIE);
211 /* synchronized by NAPI state */
212 static inline void mal_disable_eob_irq(struct mal_instance *mal)
214 // XXX might want to cache MAL_CFG as the DCR read can be slooooow
215 set_mal_dcrn(mal, MAL_CFG, get_mal_dcrn(mal, MAL_CFG) & ~MAL_CFG_EOPIE);
217 MAL_DBG2(mal, "disable_irq" NL);
220 static irqreturn_t mal_serr(int irq, void *dev_instance)
222 struct mal_instance *mal = dev_instance;
224 u32 esr = get_mal_dcrn(mal, MAL_ESR);
226 /* Clear the error status register */
227 set_mal_dcrn(mal, MAL_ESR, esr);
229 MAL_DBG(mal, "SERR %08x" NL, esr);
231 if (esr & MAL_ESR_EVB) {
232 if (esr & MAL_ESR_DE) {
233 /* We ignore Descriptor error,
234 * TXDE or RXDE interrupt will be generated anyway.
239 if (esr & MAL_ESR_PEIN) {
240 /* PLB error, it's probably buggy hardware or
241 * incorrect physical address in BD (i.e. bug)
245 "mal%d: system error, "
246 "PLB (ESR = 0x%08x)\n",
251 /* OPB error, it's probably buggy hardware or incorrect
256 "mal%d: system error, OPB (ESR = 0x%08x)\n",
262 static inline void mal_schedule_poll(struct mal_instance *mal)
264 if (likely(napi_schedule_prep(&mal->napi))) {
265 MAL_DBG2(mal, "schedule_poll" NL);
266 mal_disable_eob_irq(mal);
267 __napi_schedule(&mal->napi);
269 MAL_DBG2(mal, "already in poll" NL);
272 static irqreturn_t mal_txeob(int irq, void *dev_instance)
274 struct mal_instance *mal = dev_instance;
276 u32 r = get_mal_dcrn(mal, MAL_TXEOBISR);
278 MAL_DBG2(mal, "txeob %08x" NL, r);
280 mal_schedule_poll(mal);
281 set_mal_dcrn(mal, MAL_TXEOBISR, r);
283 #ifdef CONFIG_PPC_DCR_NATIVE
284 if (mal_has_feature(mal, MAL_FTR_CLEAR_ICINTSTAT))
285 mtdcri(SDR0, DCRN_SDR_ICINTSTAT,
286 (mfdcri(SDR0, DCRN_SDR_ICINTSTAT) | ICINTSTAT_ICTX));
292 static irqreturn_t mal_rxeob(int irq, void *dev_instance)
294 struct mal_instance *mal = dev_instance;
296 u32 r = get_mal_dcrn(mal, MAL_RXEOBISR);
298 MAL_DBG2(mal, "rxeob %08x" NL, r);
300 mal_schedule_poll(mal);
301 set_mal_dcrn(mal, MAL_RXEOBISR, r);
303 #ifdef CONFIG_PPC_DCR_NATIVE
304 if (mal_has_feature(mal, MAL_FTR_CLEAR_ICINTSTAT))
305 mtdcri(SDR0, DCRN_SDR_ICINTSTAT,
306 (mfdcri(SDR0, DCRN_SDR_ICINTSTAT) | ICINTSTAT_ICRX));
312 static irqreturn_t mal_txde(int irq, void *dev_instance)
314 struct mal_instance *mal = dev_instance;
316 u32 deir = get_mal_dcrn(mal, MAL_TXDEIR);
317 set_mal_dcrn(mal, MAL_TXDEIR, deir);
319 MAL_DBG(mal, "txde %08x" NL, deir);
323 "mal%d: TX descriptor error (TXDEIR = 0x%08x)\n",
329 static irqreturn_t mal_rxde(int irq, void *dev_instance)
331 struct mal_instance *mal = dev_instance;
334 u32 deir = get_mal_dcrn(mal, MAL_RXDEIR);
336 MAL_DBG(mal, "rxde %08x" NL, deir);
338 list_for_each(l, &mal->list) {
339 struct mal_commac *mc = list_entry(l, struct mal_commac, list);
340 if (deir & mc->rx_chan_mask) {
341 set_bit(MAL_COMMAC_RX_STOPPED, &mc->flags);
342 mc->ops->rxde(mc->dev);
346 mal_schedule_poll(mal);
347 set_mal_dcrn(mal, MAL_RXDEIR, deir);
352 static irqreturn_t mal_int(int irq, void *dev_instance)
354 struct mal_instance *mal = dev_instance;
355 u32 esr = get_mal_dcrn(mal, MAL_ESR);
357 if (esr & MAL_ESR_EVB) {
358 /* descriptor error */
359 if (esr & MAL_ESR_DE) {
360 if (esr & MAL_ESR_CIDT)
361 return mal_rxde(irq, dev_instance);
363 return mal_txde(irq, dev_instance);
365 return mal_serr(irq, dev_instance);
371 void mal_poll_disable(struct mal_instance *mal, struct mal_commac *commac)
373 /* Spinlock-type semantics: only one caller disable poll at a time */
374 while (test_and_set_bit(MAL_COMMAC_POLL_DISABLED, &commac->flags))
377 /* Synchronize with the MAL NAPI poller */
378 napi_synchronize(&mal->napi);
381 void mal_poll_enable(struct mal_instance *mal, struct mal_commac *commac)
384 clear_bit(MAL_COMMAC_POLL_DISABLED, &commac->flags);
386 /* Feels better to trigger a poll here to catch up with events that
387 * may have happened on this channel while disabled. It will most
388 * probably be delayed until the next interrupt but that's mostly a
389 * non-issue in the context where this is called.
391 napi_schedule(&mal->napi);
394 static int mal_poll(struct napi_struct *napi, int budget)
396 struct mal_instance *mal = container_of(napi, struct mal_instance, napi);
401 MAL_DBG2(mal, "poll(%d)" NL, budget);
403 /* Process TX skbs */
404 list_for_each(l, &mal->poll_list) {
405 struct mal_commac *mc =
406 list_entry(l, struct mal_commac, poll_list);
407 mc->ops->poll_tx(mc->dev);
412 * We _might_ need something more smart here to enforce polling
415 list_for_each(l, &mal->poll_list) {
416 struct mal_commac *mc =
417 list_entry(l, struct mal_commac, poll_list);
419 if (unlikely(test_bit(MAL_COMMAC_POLL_DISABLED, &mc->flags)))
421 n = mc->ops->poll_rx(mc->dev, budget);
426 goto more_work; // XXX What if this is the last one ?
430 /* We need to disable IRQs to protect from RXDE IRQ here */
431 spin_lock_irqsave(&mal->lock, flags);
432 __napi_complete(napi);
433 mal_enable_eob_irq(mal);
434 spin_unlock_irqrestore(&mal->lock, flags);
436 /* Check for "rotting" packet(s) */
437 list_for_each(l, &mal->poll_list) {
438 struct mal_commac *mc =
439 list_entry(l, struct mal_commac, poll_list);
440 if (unlikely(test_bit(MAL_COMMAC_POLL_DISABLED, &mc->flags)))
442 if (unlikely(mc->ops->peek_rx(mc->dev) ||
443 test_bit(MAL_COMMAC_RX_STOPPED, &mc->flags))) {
444 MAL_DBG2(mal, "rotting packet" NL);
445 if (napi_reschedule(napi))
446 mal_disable_eob_irq(mal);
448 MAL_DBG2(mal, "already in poll list" NL);
455 mc->ops->poll_tx(mc->dev);
459 MAL_DBG2(mal, "poll() %d <- %d" NL, budget, received);
463 static void mal_reset(struct mal_instance *mal)
467 MAL_DBG(mal, "reset" NL);
469 set_mal_dcrn(mal, MAL_CFG, MAL_CFG_SR);
471 /* Wait for reset to complete (1 system clock) */
472 while ((get_mal_dcrn(mal, MAL_CFG) & MAL_CFG_SR) && n)
476 printk(KERN_ERR "mal%d: reset timeout\n", mal->index);
479 int mal_get_regs_len(struct mal_instance *mal)
481 return sizeof(struct emac_ethtool_regs_subhdr) +
482 sizeof(struct mal_regs);
485 void *mal_dump_regs(struct mal_instance *mal, void *buf)
487 struct emac_ethtool_regs_subhdr *hdr = buf;
488 struct mal_regs *regs = (struct mal_regs *)(hdr + 1);
491 hdr->version = mal->version;
492 hdr->index = mal->index;
494 regs->tx_count = mal->num_tx_chans;
495 regs->rx_count = mal->num_rx_chans;
497 regs->cfg = get_mal_dcrn(mal, MAL_CFG);
498 regs->esr = get_mal_dcrn(mal, MAL_ESR);
499 regs->ier = get_mal_dcrn(mal, MAL_IER);
500 regs->tx_casr = get_mal_dcrn(mal, MAL_TXCASR);
501 regs->tx_carr = get_mal_dcrn(mal, MAL_TXCARR);
502 regs->tx_eobisr = get_mal_dcrn(mal, MAL_TXEOBISR);
503 regs->tx_deir = get_mal_dcrn(mal, MAL_TXDEIR);
504 regs->rx_casr = get_mal_dcrn(mal, MAL_RXCASR);
505 regs->rx_carr = get_mal_dcrn(mal, MAL_RXCARR);
506 regs->rx_eobisr = get_mal_dcrn(mal, MAL_RXEOBISR);
507 regs->rx_deir = get_mal_dcrn(mal, MAL_RXDEIR);
509 for (i = 0; i < regs->tx_count; ++i)
510 regs->tx_ctpr[i] = get_mal_dcrn(mal, MAL_TXCTPR(i));
512 for (i = 0; i < regs->rx_count; ++i) {
513 regs->rx_ctpr[i] = get_mal_dcrn(mal, MAL_RXCTPR(i));
514 regs->rcbs[i] = get_mal_dcrn(mal, MAL_RCBS(i));
519 static int __devinit mal_probe(struct of_device *ofdev,
520 const struct of_device_id *match)
522 struct mal_instance *mal;
523 int err = 0, i, bd_size;
524 int index = mal_count++;
525 unsigned int dcr_base;
528 unsigned long irqflags;
529 irq_handler_t hdlr_serr, hdlr_txde, hdlr_rxde;
531 mal = kzalloc(sizeof(struct mal_instance), GFP_KERNEL);
534 "mal%d: out of memory allocating MAL structure!\n",
540 mal->version = of_device_is_compatible(ofdev->node, "ibm,mcmal2") ? 2 : 1;
542 MAL_DBG(mal, "probe" NL);
544 prop = of_get_property(ofdev->node, "num-tx-chans", NULL);
547 "mal%d: can't find MAL num-tx-chans property!\n",
552 mal->num_tx_chans = prop[0];
554 prop = of_get_property(ofdev->node, "num-rx-chans", NULL);
557 "mal%d: can't find MAL num-rx-chans property!\n",
562 mal->num_rx_chans = prop[0];
564 dcr_base = dcr_resource_start(ofdev->node, 0);
567 "mal%d: can't find DCR resource!\n", index);
571 mal->dcr_host = dcr_map(ofdev->node, dcr_base, 0x100);
572 if (!DCR_MAP_OK(mal->dcr_host)) {
574 "mal%d: failed to map DCRs !\n", index);
579 if (of_device_is_compatible(ofdev->node, "ibm,mcmal-405ez")) {
580 #if defined(CONFIG_IBM_NEW_EMAC_MAL_CLR_ICINTSTAT) && \
581 defined(CONFIG_IBM_NEW_EMAC_MAL_COMMON_ERR)
582 mal->features |= (MAL_FTR_CLEAR_ICINTSTAT |
583 MAL_FTR_COMMON_ERR_INT);
585 printk(KERN_ERR "%s: Support for 405EZ not enabled!\n",
586 ofdev->node->full_name);
592 mal->txeob_irq = irq_of_parse_and_map(ofdev->node, 0);
593 mal->rxeob_irq = irq_of_parse_and_map(ofdev->node, 1);
594 mal->serr_irq = irq_of_parse_and_map(ofdev->node, 2);
596 if (mal_has_feature(mal, MAL_FTR_COMMON_ERR_INT)) {
597 mal->txde_irq = mal->rxde_irq = mal->serr_irq;
599 mal->txde_irq = irq_of_parse_and_map(ofdev->node, 3);
600 mal->rxde_irq = irq_of_parse_and_map(ofdev->node, 4);
603 if (mal->txeob_irq == NO_IRQ || mal->rxeob_irq == NO_IRQ ||
604 mal->serr_irq == NO_IRQ || mal->txde_irq == NO_IRQ ||
605 mal->rxde_irq == NO_IRQ) {
607 "mal%d: failed to map interrupts !\n", index);
612 INIT_LIST_HEAD(&mal->poll_list);
613 INIT_LIST_HEAD(&mal->list);
614 spin_lock_init(&mal->lock);
616 netif_napi_add(NULL, &mal->napi, mal_poll,
617 CONFIG_IBM_NEW_EMAC_POLL_WEIGHT);
619 /* Load power-on reset defaults */
622 /* Set the MAL configuration register */
623 cfg = (mal->version == 2) ? MAL2_CFG_DEFAULT : MAL1_CFG_DEFAULT;
624 cfg |= MAL_CFG_PLBB | MAL_CFG_OPBBL | MAL_CFG_LEA;
626 /* Current Axon is not happy with priority being non-0, it can
627 * deadlock, fix it up here
629 if (of_device_is_compatible(ofdev->node, "ibm,mcmal-axon"))
630 cfg &= ~(MAL2_CFG_RPP_10 | MAL2_CFG_WPP_10);
632 /* Apply configuration */
633 set_mal_dcrn(mal, MAL_CFG, cfg);
635 /* Allocate space for BD rings */
636 BUG_ON(mal->num_tx_chans <= 0 || mal->num_tx_chans > 32);
637 BUG_ON(mal->num_rx_chans <= 0 || mal->num_rx_chans > 32);
639 bd_size = sizeof(struct mal_descriptor) *
640 (NUM_TX_BUFF * mal->num_tx_chans +
641 NUM_RX_BUFF * mal->num_rx_chans);
643 dma_alloc_coherent(&ofdev->dev, bd_size, &mal->bd_dma,
645 if (mal->bd_virt == NULL) {
647 "mal%d: out of memory allocating RX/TX descriptors!\n",
652 memset(mal->bd_virt, 0, bd_size);
654 for (i = 0; i < mal->num_tx_chans; ++i)
655 set_mal_dcrn(mal, MAL_TXCTPR(i), mal->bd_dma +
656 sizeof(struct mal_descriptor) *
657 mal_tx_bd_offset(mal, i));
659 for (i = 0; i < mal->num_rx_chans; ++i)
660 set_mal_dcrn(mal, MAL_RXCTPR(i), mal->bd_dma +
661 sizeof(struct mal_descriptor) *
662 mal_rx_bd_offset(mal, i));
664 if (mal_has_feature(mal, MAL_FTR_COMMON_ERR_INT)) {
665 irqflags = IRQF_SHARED;
666 hdlr_serr = hdlr_txde = hdlr_rxde = mal_int;
669 hdlr_serr = mal_serr;
670 hdlr_txde = mal_txde;
671 hdlr_rxde = mal_rxde;
674 err = request_irq(mal->serr_irq, hdlr_serr, irqflags, "MAL SERR", mal);
677 err = request_irq(mal->txde_irq, hdlr_txde, irqflags, "MAL TX DE", mal);
680 err = request_irq(mal->txeob_irq, mal_txeob, 0, "MAL TX EOB", mal);
683 err = request_irq(mal->rxde_irq, hdlr_rxde, irqflags, "MAL RX DE", mal);
686 err = request_irq(mal->rxeob_irq, mal_rxeob, 0, "MAL RX EOB", mal);
690 /* Enable all MAL SERR interrupt sources */
691 if (mal->version == 2)
692 set_mal_dcrn(mal, MAL_IER, MAL2_IER_EVENTS);
694 set_mal_dcrn(mal, MAL_IER, MAL1_IER_EVENTS);
696 /* Enable EOB interrupt */
697 mal_enable_eob_irq(mal);
700 "MAL v%d %s, %d TX channels, %d RX channels\n",
701 mal->version, ofdev->node->full_name,
702 mal->num_tx_chans, mal->num_rx_chans);
704 /* Advertise this instance to the rest of the world */
706 dev_set_drvdata(&ofdev->dev, mal);
708 mal_dbg_register(mal);
713 free_irq(mal->rxde_irq, mal);
715 free_irq(mal->txeob_irq, mal);
717 free_irq(mal->txde_irq, mal);
719 free_irq(mal->serr_irq, mal);
721 dma_free_coherent(&ofdev->dev, bd_size, mal->bd_virt, mal->bd_dma);
723 dcr_unmap(mal->dcr_host, 0x100);
730 static int __devexit mal_remove(struct of_device *ofdev)
732 struct mal_instance *mal = dev_get_drvdata(&ofdev->dev);
734 MAL_DBG(mal, "remove" NL);
736 /* Synchronize with scheduled polling */
737 napi_disable(&mal->napi);
739 if (!list_empty(&mal->list)) {
740 /* This is *very* bad */
742 "mal%d: commac list is not empty on remove!\n",
747 dev_set_drvdata(&ofdev->dev, NULL);
749 free_irq(mal->serr_irq, mal);
750 free_irq(mal->txde_irq, mal);
751 free_irq(mal->txeob_irq, mal);
752 free_irq(mal->rxde_irq, mal);
753 free_irq(mal->rxeob_irq, mal);
757 mal_dbg_unregister(mal);
759 dma_free_coherent(&ofdev->dev,
760 sizeof(struct mal_descriptor) *
761 (NUM_TX_BUFF * mal->num_tx_chans +
762 NUM_RX_BUFF * mal->num_rx_chans), mal->bd_virt,
769 static struct of_device_id mal_platform_match[] =
772 .compatible = "ibm,mcmal",
775 .compatible = "ibm,mcmal2",
777 /* Backward compat */
780 .compatible = "ibm,mcmal",
784 .compatible = "ibm,mcmal2",
789 static struct of_platform_driver mal_of_driver = {
791 .match_table = mal_platform_match,
794 .remove = mal_remove,
797 int __init mal_init(void)
799 return of_register_platform_driver(&mal_of_driver);
804 of_unregister_platform_driver(&mal_of_driver);