2 * drivers/net/ibm_emac/ibm_emac_mal.c
4 * Memory Access Layer (MAL) support
6 * Copyright (c) 2004, 2005 Zultys Technologies.
7 * Eugene Surovegin <eugene.surovegin@zultys.com> or <ebs@ebshome.net>
9 * Based on original work by
10 * Benjamin Herrenschmidt <benh@kernel.crashing.org>,
11 * David Gibson <hermes@gibson.dropbear.id.au>,
13 * Armin Kuster <akuster@mvista.com>
14 * Copyright 2002 MontaVista Softare Inc.
16 * This program is free software; you can redistribute it and/or modify it
17 * under the terms of the GNU General Public License as published by the
18 * Free Software Foundation; either version 2 of the License, or (at your
19 * option) any later version.
22 #include <linux/config.h>
23 #include <linux/module.h>
24 #include <linux/kernel.h>
25 #include <linux/errno.h>
26 #include <linux/netdevice.h>
27 #include <linux/init.h>
28 #include <linux/interrupt.h>
29 #include <linux/dma-mapping.h>
33 #include "ibm_emac_core.h"
34 #include "ibm_emac_mal.h"
35 #include "ibm_emac_debug.h"
37 int __init mal_register_commac(struct ibm_ocp_mal *mal,
38 struct mal_commac *commac)
41 local_irq_save(flags);
43 MAL_DBG("%d: reg(%08x, %08x)" NL, mal->def->index,
44 commac->tx_chan_mask, commac->rx_chan_mask);
46 /* Don't let multiple commacs claim the same channel(s) */
47 if ((mal->tx_chan_mask & commac->tx_chan_mask) ||
48 (mal->rx_chan_mask & commac->rx_chan_mask)) {
49 local_irq_restore(flags);
50 printk(KERN_WARNING "mal%d: COMMAC channels conflict!\n",
55 mal->tx_chan_mask |= commac->tx_chan_mask;
56 mal->rx_chan_mask |= commac->rx_chan_mask;
57 list_add(&commac->list, &mal->list);
59 local_irq_restore(flags);
63 void __exit mal_unregister_commac(struct ibm_ocp_mal *mal,
64 struct mal_commac *commac)
67 local_irq_save(flags);
69 MAL_DBG("%d: unreg(%08x, %08x)" NL, mal->def->index,
70 commac->tx_chan_mask, commac->rx_chan_mask);
72 mal->tx_chan_mask &= ~commac->tx_chan_mask;
73 mal->rx_chan_mask &= ~commac->rx_chan_mask;
74 list_del_init(&commac->list);
76 local_irq_restore(flags);
79 int mal_set_rcbs(struct ibm_ocp_mal *mal, int channel, unsigned long size)
81 struct ocp_func_mal_data *maldata = mal->def->additions;
82 BUG_ON(channel < 0 || channel >= maldata->num_rx_chans ||
83 size > MAL_MAX_RX_SIZE);
85 MAL_DBG("%d: set_rbcs(%d, %lu)" NL, mal->def->index, channel, size);
89 "mal%d: incorrect RX size %lu for the channel %d\n",
90 mal->def->index, size, channel);
94 set_mal_dcrn(mal, MAL_RCBS(channel), size >> 4);
98 int mal_tx_bd_offset(struct ibm_ocp_mal *mal, int channel)
100 struct ocp_func_mal_data *maldata = mal->def->additions;
101 BUG_ON(channel < 0 || channel >= maldata->num_tx_chans);
102 return channel * NUM_TX_BUFF;
105 int mal_rx_bd_offset(struct ibm_ocp_mal *mal, int channel)
107 struct ocp_func_mal_data *maldata = mal->def->additions;
108 BUG_ON(channel < 0 || channel >= maldata->num_rx_chans);
109 return maldata->num_tx_chans * NUM_TX_BUFF + channel * NUM_RX_BUFF;
112 void mal_enable_tx_channel(struct ibm_ocp_mal *mal, int channel)
115 MAL_DBG("%d: enable_tx(%d)" NL, mal->def->index, channel);
116 set_mal_dcrn(mal, MAL_TXCASR,
117 get_mal_dcrn(mal, MAL_TXCASR) | MAL_CHAN_MASK(channel));
121 void mal_disable_tx_channel(struct ibm_ocp_mal *mal, int channel)
123 set_mal_dcrn(mal, MAL_TXCARR, MAL_CHAN_MASK(channel));
124 MAL_DBG("%d: disable_tx(%d)" NL, mal->def->index, channel);
127 void mal_enable_rx_channel(struct ibm_ocp_mal *mal, int channel)
130 MAL_DBG("%d: enable_rx(%d)" NL, mal->def->index, channel);
131 set_mal_dcrn(mal, MAL_RXCASR,
132 get_mal_dcrn(mal, MAL_RXCASR) | MAL_CHAN_MASK(channel));
136 void mal_disable_rx_channel(struct ibm_ocp_mal *mal, int channel)
138 set_mal_dcrn(mal, MAL_RXCARR, MAL_CHAN_MASK(channel));
139 MAL_DBG("%d: disable_rx(%d)" NL, mal->def->index, channel);
142 void mal_poll_add(struct ibm_ocp_mal *mal, struct mal_commac *commac)
145 MAL_DBG("%d: poll_add(%p)" NL, mal->def->index, commac);
146 list_add_tail(&commac->poll_list, &mal->poll_list);
150 void mal_poll_del(struct ibm_ocp_mal *mal, struct mal_commac *commac)
153 MAL_DBG("%d: poll_del(%p)" NL, mal->def->index, commac);
154 list_del(&commac->poll_list);
158 /* synchronized by mal_poll() */
159 static inline void mal_enable_eob_irq(struct ibm_ocp_mal *mal)
161 MAL_DBG2("%d: enable_irq" NL, mal->def->index);
162 set_mal_dcrn(mal, MAL_CFG, get_mal_dcrn(mal, MAL_CFG) | MAL_CFG_EOPIE);
165 /* synchronized by __LINK_STATE_RX_SCHED bit in ndev->state */
166 static inline void mal_disable_eob_irq(struct ibm_ocp_mal *mal)
168 set_mal_dcrn(mal, MAL_CFG, get_mal_dcrn(mal, MAL_CFG) & ~MAL_CFG_EOPIE);
169 MAL_DBG2("%d: disable_irq" NL, mal->def->index);
172 static irqreturn_t mal_serr(int irq, void *dev_instance, struct pt_regs *regs)
174 struct ibm_ocp_mal *mal = dev_instance;
175 u32 esr = get_mal_dcrn(mal, MAL_ESR);
177 /* Clear the error status register */
178 set_mal_dcrn(mal, MAL_ESR, esr);
180 MAL_DBG("%d: SERR %08x" NL, mal->def->index, esr);
182 if (esr & MAL_ESR_EVB) {
183 if (esr & MAL_ESR_DE) {
184 /* We ignore Descriptor error,
185 * TXDE or RXDE interrupt will be generated anyway.
190 if (esr & MAL_ESR_PEIN) {
191 /* PLB error, it's probably buggy hardware or
192 * incorrect physical address in BD (i.e. bug)
196 "mal%d: system error, PLB (ESR = 0x%08x)\n",
197 mal->def->index, esr);
201 /* OPB error, it's probably buggy hardware or incorrect EBC setup */
204 "mal%d: system error, OPB (ESR = 0x%08x)\n",
205 mal->def->index, esr);
210 static inline void mal_schedule_poll(struct ibm_ocp_mal *mal)
212 if (likely(netif_rx_schedule_prep(&mal->poll_dev))) {
213 MAL_DBG2("%d: schedule_poll" NL, mal->def->index);
214 mal_disable_eob_irq(mal);
215 __netif_rx_schedule(&mal->poll_dev);
217 MAL_DBG2("%d: already in poll" NL, mal->def->index);
220 static irqreturn_t mal_txeob(int irq, void *dev_instance, struct pt_regs *regs)
222 struct ibm_ocp_mal *mal = dev_instance;
223 u32 r = get_mal_dcrn(mal, MAL_TXEOBISR);
224 MAL_DBG2("%d: txeob %08x" NL, mal->def->index, r);
225 mal_schedule_poll(mal);
226 set_mal_dcrn(mal, MAL_TXEOBISR, r);
230 static irqreturn_t mal_rxeob(int irq, void *dev_instance, struct pt_regs *regs)
232 struct ibm_ocp_mal *mal = dev_instance;
233 u32 r = get_mal_dcrn(mal, MAL_RXEOBISR);
234 MAL_DBG2("%d: rxeob %08x" NL, mal->def->index, r);
235 mal_schedule_poll(mal);
236 set_mal_dcrn(mal, MAL_RXEOBISR, r);
240 static irqreturn_t mal_txde(int irq, void *dev_instance, struct pt_regs *regs)
242 struct ibm_ocp_mal *mal = dev_instance;
243 u32 deir = get_mal_dcrn(mal, MAL_TXDEIR);
244 set_mal_dcrn(mal, MAL_TXDEIR, deir);
246 MAL_DBG("%d: txde %08x" NL, mal->def->index, deir);
250 "mal%d: TX descriptor error (TXDEIR = 0x%08x)\n",
251 mal->def->index, deir);
256 static irqreturn_t mal_rxde(int irq, void *dev_instance, struct pt_regs *regs)
258 struct ibm_ocp_mal *mal = dev_instance;
260 u32 deir = get_mal_dcrn(mal, MAL_RXDEIR);
262 MAL_DBG("%d: rxde %08x" NL, mal->def->index, deir);
264 list_for_each(l, &mal->list) {
265 struct mal_commac *mc = list_entry(l, struct mal_commac, list);
266 if (deir & mc->rx_chan_mask) {
268 mc->ops->rxde(mc->dev);
272 mal_schedule_poll(mal);
273 set_mal_dcrn(mal, MAL_RXDEIR, deir);
278 static int mal_poll(struct net_device *ndev, int *budget)
280 struct ibm_ocp_mal *mal = ndev->priv;
282 int rx_work_limit = min(ndev->quota, *budget), received = 0, done;
284 MAL_DBG2("%d: poll(%d) %d ->" NL, mal->def->index, *budget,
287 /* Process TX skbs */
288 list_for_each(l, &mal->poll_list) {
289 struct mal_commac *mc =
290 list_entry(l, struct mal_commac, poll_list);
291 mc->ops->poll_tx(mc->dev);
295 * We _might_ need something more smart here to enforce polling fairness.
297 list_for_each(l, &mal->poll_list) {
298 struct mal_commac *mc =
299 list_entry(l, struct mal_commac, poll_list);
300 int n = mc->ops->poll_rx(mc->dev, rx_work_limit);
304 if (rx_work_limit <= 0) {
306 goto more_work; // XXX What if this is the last one ?
311 /* We need to disable IRQs to protect from RXDE IRQ here */
313 __netif_rx_complete(ndev);
314 mal_enable_eob_irq(mal);
319 /* Check for "rotting" packet(s) */
320 list_for_each(l, &mal->poll_list) {
321 struct mal_commac *mc =
322 list_entry(l, struct mal_commac, poll_list);
323 if (unlikely(mc->ops->peek_rx(mc->dev) || mc->rx_stopped)) {
324 MAL_DBG2("%d: rotting packet" NL, mal->def->index);
325 if (netif_rx_reschedule(ndev, received))
326 mal_disable_eob_irq(mal);
328 MAL_DBG2("%d: already in poll list" NL,
331 if (rx_work_limit > 0)
336 mc->ops->poll_tx(mc->dev);
340 ndev->quota -= received;
343 MAL_DBG2("%d: poll() %d <- %d" NL, mal->def->index, *budget,
348 static void mal_reset(struct ibm_ocp_mal *mal)
351 MAL_DBG("%d: reset" NL, mal->def->index);
353 set_mal_dcrn(mal, MAL_CFG, MAL_CFG_SR);
355 /* Wait for reset to complete (1 system clock) */
356 while ((get_mal_dcrn(mal, MAL_CFG) & MAL_CFG_SR) && n)
360 printk(KERN_ERR "mal%d: reset timeout\n", mal->def->index);
363 int mal_get_regs_len(struct ibm_ocp_mal *mal)
365 return sizeof(struct emac_ethtool_regs_subhdr) +
366 sizeof(struct ibm_mal_regs);
369 void *mal_dump_regs(struct ibm_ocp_mal *mal, void *buf)
371 struct emac_ethtool_regs_subhdr *hdr = buf;
372 struct ibm_mal_regs *regs = (struct ibm_mal_regs *)(hdr + 1);
373 struct ocp_func_mal_data *maldata = mal->def->additions;
376 hdr->version = MAL_VERSION;
377 hdr->index = mal->def->index;
379 regs->tx_count = maldata->num_tx_chans;
380 regs->rx_count = maldata->num_rx_chans;
382 regs->cfg = get_mal_dcrn(mal, MAL_CFG);
383 regs->esr = get_mal_dcrn(mal, MAL_ESR);
384 regs->ier = get_mal_dcrn(mal, MAL_IER);
385 regs->tx_casr = get_mal_dcrn(mal, MAL_TXCASR);
386 regs->tx_carr = get_mal_dcrn(mal, MAL_TXCARR);
387 regs->tx_eobisr = get_mal_dcrn(mal, MAL_TXEOBISR);
388 regs->tx_deir = get_mal_dcrn(mal, MAL_TXDEIR);
389 regs->rx_casr = get_mal_dcrn(mal, MAL_RXCASR);
390 regs->rx_carr = get_mal_dcrn(mal, MAL_RXCARR);
391 regs->rx_eobisr = get_mal_dcrn(mal, MAL_RXEOBISR);
392 regs->rx_deir = get_mal_dcrn(mal, MAL_RXDEIR);
394 for (i = 0; i < regs->tx_count; ++i)
395 regs->tx_ctpr[i] = get_mal_dcrn(mal, MAL_TXCTPR(i));
397 for (i = 0; i < regs->rx_count; ++i) {
398 regs->rx_ctpr[i] = get_mal_dcrn(mal, MAL_RXCTPR(i));
399 regs->rcbs[i] = get_mal_dcrn(mal, MAL_RCBS(i));
404 static int __init mal_probe(struct ocp_device *ocpdev)
406 struct ibm_ocp_mal *mal;
407 struct ocp_func_mal_data *maldata;
408 int err = 0, i, bd_size;
410 MAL_DBG("%d: probe" NL, ocpdev->def->index);
412 maldata = ocpdev->def->additions;
413 if (maldata == NULL) {
414 printk(KERN_ERR "mal%d: missing additional data!\n",
419 mal = kzalloc(sizeof(struct ibm_ocp_mal), GFP_KERNEL);
422 "mal%d: out of memory allocating MAL structure!\n",
426 mal->dcrbase = maldata->dcr_base;
427 mal->def = ocpdev->def;
429 INIT_LIST_HEAD(&mal->poll_list);
430 set_bit(__LINK_STATE_START, &mal->poll_dev.state);
431 mal->poll_dev.weight = CONFIG_IBM_EMAC_POLL_WEIGHT;
432 mal->poll_dev.poll = mal_poll;
433 mal->poll_dev.priv = mal;
434 atomic_set(&mal->poll_dev.refcnt, 1);
436 INIT_LIST_HEAD(&mal->list);
438 /* Load power-on reset defaults */
441 /* Set the MAL configuration register */
442 set_mal_dcrn(mal, MAL_CFG, MAL_CFG_DEFAULT | MAL_CFG_PLBB |
443 MAL_CFG_OPBBL | MAL_CFG_LEA);
445 mal_enable_eob_irq(mal);
447 /* Allocate space for BD rings */
448 BUG_ON(maldata->num_tx_chans <= 0 || maldata->num_tx_chans > 32);
449 BUG_ON(maldata->num_rx_chans <= 0 || maldata->num_rx_chans > 32);
450 bd_size = sizeof(struct mal_descriptor) *
451 (NUM_TX_BUFF * maldata->num_tx_chans +
452 NUM_RX_BUFF * maldata->num_rx_chans);
454 dma_alloc_coherent(&ocpdev->dev, bd_size, &mal->bd_dma, GFP_KERNEL);
458 "mal%d: out of memory allocating RX/TX descriptors!\n",
463 memset(mal->bd_virt, 0, bd_size);
465 for (i = 0; i < maldata->num_tx_chans; ++i)
466 set_mal_dcrn(mal, MAL_TXCTPR(i), mal->bd_dma +
467 sizeof(struct mal_descriptor) *
468 mal_tx_bd_offset(mal, i));
470 for (i = 0; i < maldata->num_rx_chans; ++i)
471 set_mal_dcrn(mal, MAL_RXCTPR(i), mal->bd_dma +
472 sizeof(struct mal_descriptor) *
473 mal_rx_bd_offset(mal, i));
475 err = request_irq(maldata->serr_irq, mal_serr, 0, "MAL SERR", mal);
478 err = request_irq(maldata->txde_irq, mal_txde, 0, "MAL TX DE", mal);
481 err = request_irq(maldata->txeob_irq, mal_txeob, 0, "MAL TX EOB", mal);
484 err = request_irq(maldata->rxde_irq, mal_rxde, 0, "MAL RX DE", mal);
487 err = request_irq(maldata->rxeob_irq, mal_rxeob, 0, "MAL RX EOB", mal);
491 /* Enable all MAL SERR interrupt sources */
492 set_mal_dcrn(mal, MAL_IER, MAL_IER_EVENTS);
494 /* Advertise this instance to the rest of the world */
495 ocp_set_drvdata(ocpdev, mal);
497 mal_dbg_register(mal->def->index, mal);
499 printk(KERN_INFO "mal%d: initialized, %d TX channels, %d RX channels\n",
500 mal->def->index, maldata->num_tx_chans, maldata->num_rx_chans);
504 free_irq(maldata->rxde_irq, mal);
506 free_irq(maldata->txeob_irq, mal);
508 free_irq(maldata->txde_irq, mal);
510 free_irq(maldata->serr_irq, mal);
512 dma_free_coherent(&ocpdev->dev, bd_size, mal->bd_virt, mal->bd_dma);
518 static void __exit mal_remove(struct ocp_device *ocpdev)
520 struct ibm_ocp_mal *mal = ocp_get_drvdata(ocpdev);
521 struct ocp_func_mal_data *maldata = mal->def->additions;
523 MAL_DBG("%d: remove" NL, mal->def->index);
525 /* Syncronize with scheduled polling,
526 stolen from net/core/dev.c:dev_close()
528 clear_bit(__LINK_STATE_START, &mal->poll_dev.state);
529 netif_poll_disable(&mal->poll_dev);
531 if (!list_empty(&mal->list)) {
532 /* This is *very* bad */
534 "mal%d: commac list is not empty on remove!\n",
538 ocp_set_drvdata(ocpdev, NULL);
540 free_irq(maldata->serr_irq, mal);
541 free_irq(maldata->txde_irq, mal);
542 free_irq(maldata->txeob_irq, mal);
543 free_irq(maldata->rxde_irq, mal);
544 free_irq(maldata->rxeob_irq, mal);
548 mal_dbg_register(mal->def->index, NULL);
550 dma_free_coherent(&ocpdev->dev,
551 sizeof(struct mal_descriptor) *
552 (NUM_TX_BUFF * maldata->num_tx_chans +
553 NUM_RX_BUFF * maldata->num_rx_chans), mal->bd_virt,
559 /* Structure for a device driver */
560 static struct ocp_device_id mal_ids[] = {
561 { .vendor = OCP_VENDOR_IBM, .function = OCP_FUNC_MAL },
562 { .vendor = OCP_VENDOR_INVALID}
565 static struct ocp_driver mal_driver = {
570 .remove = mal_remove,
573 int __init mal_init(void)
575 MAL_DBG(": init" NL);
576 return ocp_register_driver(&mal_driver);
579 void __exit mal_exit(void)
581 MAL_DBG(": exit" NL);
582 ocp_unregister_driver(&mal_driver);