3 * 10/100/1000 Base-T Ethernet Driver for the ET1301 and ET131x series MACs
5 * Copyright © 2005 Agere Systems Inc.
9 *------------------------------------------------------------------------------
11 * et131x_netdev.c - Routines and data required by all Linux network devices.
13 *------------------------------------------------------------------------------
17 * This software is provided subject to the following terms and conditions,
18 * which you should read carefully before using the software. Using this
19 * software indicates your acceptance of these terms and conditions. If you do
20 * not agree with these terms and conditions, do not use the software.
22 * Copyright © 2005 Agere Systems Inc.
23 * All rights reserved.
25 * Redistribution and use in source or binary forms, with or without
26 * modifications, are permitted provided that the following conditions are met:
28 * . Redistributions of source code must retain the above copyright notice, this
29 * list of conditions and the following Disclaimer as comments in the code as
30 * well as in the documentation and/or other materials provided with the
33 * . Redistributions in binary form must reproduce the above copyright notice,
34 * this list of conditions and the following Disclaimer in the documentation
35 * and/or other materials provided with the distribution.
37 * . Neither the name of Agere Systems Inc. nor the names of the contributors
38 * may be used to endorse or promote products derived from this software
39 * without specific prior written permission.
43 * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
44 * INCLUDING, BUT NOT LIMITED TO, INFRINGEMENT AND THE IMPLIED WARRANTIES OF
45 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. ANY
46 * USE, MODIFICATION OR DISTRIBUTION OF THIS SOFTWARE IS SOLELY AT THE USERS OWN
47 * RISK. IN NO EVENT SHALL AGERE SYSTEMS INC. OR CONTRIBUTORS BE LIABLE FOR ANY
48 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
49 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
50 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
51 * ON ANY THEORY OF LIABILITY, INCLUDING, BUT NOT LIMITED TO, CONTRACT, STRICT
52 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
53 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
58 #include "et131x_version.h"
59 #include "et131x_defs.h"
61 #include <linux/init.h>
62 #include <linux/module.h>
63 #include <linux/types.h>
64 #include <linux/kernel.h>
66 #include <linux/sched.h>
67 #include <linux/ptrace.h>
68 #include <linux/ctype.h>
69 #include <linux/string.h>
70 #include <linux/timer.h>
71 #include <linux/interrupt.h>
73 #include <linux/delay.h>
75 #include <linux/bitops.h>
76 #include <linux/pci.h>
77 #include <asm/system.h>
79 #include <linux/mii.h>
80 #include <linux/netdevice.h>
81 #include <linux/etherdevice.h>
82 #include <linux/skbuff.h>
83 #include <linux/if_arp.h>
84 #include <linux/ioport.h>
86 #include "et1310_phy.h"
87 #include "et1310_tx.h"
88 #include "et131x_adapter.h"
92 * et131x_stats - Return the current device statistics.
93 * @netdev: device whose stats are being queried
95 * Returns 0 on success, errno on failure (as defined in errno.h)
97 static struct net_device_stats *et131x_stats(struct net_device *netdev)
99 struct et131x_adapter *adapter = netdev_priv(netdev);
100 struct net_device_stats *stats = &adapter->net_stats;
101 struct ce_stats *devstat = &adapter->stats;
103 stats->rx_errors = devstat->rx_length_errs +
104 devstat->rx_align_errs +
105 devstat->rx_crc_errs +
106 devstat->rx_code_violations +
107 devstat->rx_other_errs;
108 stats->tx_errors = devstat->tx_max_pkt_errs;
109 stats->multicast = devstat->multicast_pkts_rcvd;
110 stats->collisions = devstat->tx_collisions;
112 stats->rx_length_errors = devstat->rx_length_errs;
113 stats->rx_over_errors = devstat->rx_overflows;
114 stats->rx_crc_errors = devstat->rx_crc_errs;
116 /* NOTE: These stats don't have corresponding values in CE_STATS,
117 * so we're going to have to update these directly from within the
120 /* stats->rx_bytes = 20; devstat->; */
121 /* stats->tx_bytes = 20; devstat->; */
122 /* stats->rx_dropped = devstat->; */
123 /* stats->tx_dropped = devstat->; */
125 /* NOTE: Not used, can't find analogous statistics */
126 /* stats->rx_frame_errors = devstat->; */
127 /* stats->rx_fifo_errors = devstat->; */
128 /* stats->rx_missed_errors = devstat->; */
130 /* stats->tx_aborted_errors = devstat->; */
131 /* stats->tx_carrier_errors = devstat->; */
132 /* stats->tx_fifo_errors = devstat->; */
133 /* stats->tx_heartbeat_errors = devstat->; */
134 /* stats->tx_window_errors = devstat->; */
139 * et131x_open - Open the device for use.
140 * @netdev: device to be opened
142 * Returns 0 on success, errno on failure (as defined in errno.h)
144 int et131x_open(struct net_device *netdev)
147 struct et131x_adapter *adapter = netdev_priv(netdev);
149 /* Start the timer to track NIC errors */
150 add_timer(&adapter->error_timer);
152 /* Register our IRQ */
153 result = request_irq(netdev->irq, et131x_isr, IRQF_SHARED,
154 netdev->name, netdev);
156 dev_err(&adapter->pdev->dev, "could not register IRQ %d\n",
161 /* Enable the Tx and Rx DMA engines (if not already enabled) */
162 et131x_rx_dma_enable(adapter);
163 et131x_tx_dma_enable(adapter);
165 /* Enable device interrupts */
166 et131x_enable_interrupts(adapter);
168 adapter->flags |= fMP_ADAPTER_INTERRUPT_IN_USE;
170 /* We're ready to move some data, so start the queue */
171 netif_start_queue(netdev);
176 * et131x_close - Close the device
177 * @netdev: device to be closed
179 * Returns 0 on success, errno on failure (as defined in errno.h)
181 int et131x_close(struct net_device *netdev)
183 struct et131x_adapter *adapter = netdev_priv(netdev);
185 /* Save the timestamp for the TX watchdog, prevent a timeout */
186 netdev->trans_start = jiffies;
188 /* First thing is to stop the queue */
189 netif_stop_queue(netdev);
191 /* Stop the Tx and Rx DMA engines */
192 et131x_rx_dma_disable(adapter);
193 et131x_tx_dma_disable(adapter);
195 /* Disable device interrupts */
196 et131x_disable_interrupts(adapter);
198 /* Deregistering ISR */
199 adapter->flags &= ~fMP_ADAPTER_INTERRUPT_IN_USE;
200 free_irq(netdev->irq, netdev);
202 /* Stop the error timer */
203 del_timer_sync(&adapter->error_timer);
208 * et131x_ioctl_mii - The function which handles MII IOCTLs
209 * @netdev: device on which the query is being made
210 * @reqbuf: the request-specific data buffer
211 * @cmd: the command request code
213 * Returns 0 on success, errno on failure (as defined in errno.h)
215 int et131x_ioctl_mii(struct net_device *netdev, struct ifreq *reqbuf, int cmd)
218 struct et131x_adapter *adapter = netdev_priv(netdev);
219 struct mii_ioctl_data *data = if_mii(reqbuf);
223 data->phy_id = adapter->stats.xcvr_addr;
227 if (!capable(CAP_NET_ADMIN))
230 status = et131x_mii_read(adapter,
231 data->reg_num, &data->val_out);
235 if (!capable(CAP_NET_ADMIN))
238 status = et131x_mii_write(adapter, data->reg_num,
243 status = -EOPNOTSUPP;
249 * et131x_ioctl - The I/O Control handler for the driver
250 * @netdev: device on which the control request is being made
251 * @reqbuf: a pointer to the IOCTL request buffer
252 * @cmd: the IOCTL command code
254 * Returns 0 on success, errno on failure (as defined in errno.h)
256 int et131x_ioctl(struct net_device *netdev, struct ifreq *reqbuf, int cmd)
264 status = et131x_ioctl_mii(netdev, reqbuf, cmd);
268 status = -EOPNOTSUPP;
274 * et131x_set_packet_filter - Configures the Rx Packet filtering on the device
275 * @adapter: pointer to our private adapter structure
277 * FIXME: lot of dups with MAC code
279 * Returns 0 on success, errno on failure
281 int et131x_set_packet_filter(struct et131x_adapter *adapter)
284 uint32_t filter = adapter->packet_filter;
288 ctrl = readl(&adapter->regs->rxmac.ctrl);
289 pf_ctrl = readl(&adapter->regs->rxmac.pf_ctrl);
291 /* Default to disabled packet filtering. Enable it in the individual
292 * case statements that require the device to filter something
296 /* Set us to be in promiscuous mode so we receive everything, this
297 * is also true when we get a packet filter of 0
299 if ((filter & ET131X_PACKET_TYPE_PROMISCUOUS) || filter == 0)
300 pf_ctrl &= ~7; /* Clear filter bits */
303 * Set us up with Multicast packet filtering. Three cases are
304 * possible - (1) we have a multi-cast list, (2) we receive ALL
305 * multicast entries or (3) we receive none.
307 if (filter & ET131X_PACKET_TYPE_ALL_MULTICAST)
308 pf_ctrl &= ~2; /* Multicast filter bit */
310 et1310_setup_device_for_multicast(adapter);
315 /* Set us up with Unicast packet filtering */
316 if (filter & ET131X_PACKET_TYPE_DIRECTED) {
317 et1310_setup_device_for_unicast(adapter);
322 /* Set us up with Broadcast packet filtering */
323 if (filter & ET131X_PACKET_TYPE_BROADCAST) {
324 pf_ctrl |= 1; /* Broadcast filter bit */
329 /* Setup the receive mac configuration registers - Packet
330 * Filter control + the enable / disable for packet filter
331 * in the control reg.
333 writel(pf_ctrl, &adapter->regs->rxmac.pf_ctrl);
334 writel(ctrl, &adapter->regs->rxmac.ctrl);
340 * et131x_multicast - The handler to configure multicasting on the interface
341 * @netdev: a pointer to a net_device struct representing the device
343 void et131x_multicast(struct net_device *netdev)
345 struct et131x_adapter *adapter = netdev_priv(netdev);
346 uint32_t packet_filter = 0;
348 struct netdev_hw_addr *ha;
351 spin_lock_irqsave(&adapter->lock, flags);
353 /* Before we modify the platform-independent filter flags, store them
354 * locally. This allows us to determine if anything's changed and if
355 * we even need to bother the hardware
357 packet_filter = adapter->packet_filter;
359 /* Clear the 'multicast' flag locally; because we only have a single
360 * flag to check multicast, and multiple multicast addresses can be
361 * set, this is the easiest way to determine if more than one
362 * multicast address is being set.
364 packet_filter &= ~ET131X_PACKET_TYPE_MULTICAST;
366 /* Check the net_device flags and set the device independent flags
370 if (netdev->flags & IFF_PROMISC)
371 adapter->packet_filter |= ET131X_PACKET_TYPE_PROMISCUOUS;
373 adapter->packet_filter &= ~ET131X_PACKET_TYPE_PROMISCUOUS;
375 if (netdev->flags & IFF_ALLMULTI)
376 adapter->packet_filter |= ET131X_PACKET_TYPE_ALL_MULTICAST;
378 if (netdev_mc_count(netdev) > NIC_MAX_MCAST_LIST)
379 adapter->packet_filter |= ET131X_PACKET_TYPE_ALL_MULTICAST;
381 if (netdev_mc_count(netdev) < 1) {
382 adapter->packet_filter &= ~ET131X_PACKET_TYPE_ALL_MULTICAST;
383 adapter->packet_filter &= ~ET131X_PACKET_TYPE_MULTICAST;
385 adapter->packet_filter |= ET131X_PACKET_TYPE_MULTICAST;
387 /* Set values in the private adapter struct */
389 netdev_for_each_mc_addr(ha, netdev) {
390 if (i == NIC_MAX_MCAST_LIST)
392 memcpy(adapter->multicast_list[i++], ha->addr, ETH_ALEN);
394 adapter->multicast_addr_count = i;
396 /* Are the new flags different from the previous ones? If not, then no
399 * NOTE - This block will always update the multicast_list with the
400 * hardware, even if the addresses aren't the same.
402 if (packet_filter != adapter->packet_filter) {
403 /* Call the device's filter function */
404 et131x_set_packet_filter(adapter);
406 spin_unlock_irqrestore(&adapter->lock, flags);
410 * et131x_tx - The handler to tx a packet on the device
411 * @skb: data to be Tx'd
412 * @netdev: device on which data is to be Tx'd
414 * Returns 0 on success, errno on failure (as defined in errno.h)
416 int et131x_tx(struct sk_buff *skb, struct net_device *netdev)
420 /* Save the timestamp for the TX timeout watchdog */
421 netdev->trans_start = jiffies;
423 /* Call the device-specific data Tx routine */
424 status = et131x_send_packets(skb, netdev);
426 /* Check status and manage the netif queue if necessary */
428 if (status == -ENOMEM) {
429 /* Put the queue to sleep until resources are
432 netif_stop_queue(netdev);
433 status = NETDEV_TX_BUSY;
435 status = NETDEV_TX_OK;
442 * et131x_tx_timeout - Timeout handler
443 * @netdev: a pointer to a net_device struct representing the device
445 * The handler called when a Tx request times out. The timeout period is
446 * specified by the 'tx_timeo" element in the net_device structure (see
447 * et131x_alloc_device() to see how this value is set).
449 void et131x_tx_timeout(struct net_device *netdev)
451 struct et131x_adapter *adapter = netdev_priv(netdev);
455 /* If the device is closed, ignore the timeout */
456 if (~(adapter->flags & fMP_ADAPTER_INTERRUPT_IN_USE));
459 /* Any nonrecoverable hardware error?
460 * Checks adapter->flags for any failure in phy reading
462 if (adapter->flags & fMP_ADAPTER_NON_RECOVER_ERROR)
465 /* Hardware failure? */
466 if (adapter->flags & fMP_ADAPTER_HARDWARE_ERROR) {
467 dev_err(&adapter->pdev->dev, "hardware error - reset\n");
472 spin_lock_irqsave(&adapter->tcb_send_qlock, flags);
474 tcb = adapter->tx_ring.send_head;
479 if (tcb->count > NIC_SEND_HANG_THRESHOLD) {
480 spin_unlock_irqrestore(&adapter->tcb_send_qlock,
483 dev_warn(&adapter->pdev->dev,
484 "Send stuck - reset. tcb->WrIndex %x, flags 0x%08x\n",
488 adapter->net_stats.tx_errors++;
491 /* First thing is to stop the queue */
492 netif_stop_queue(netdev);
494 /* Stop the Tx and Rx DMA engines */
495 et131x_rx_dma_disable(adapter);
496 et131x_tx_dma_disable(adapter);
498 /* Disable device interrupts */
499 et131x_disable_interrupts(adapter);
501 /* Enable the Tx and Rx DMA engines (if not already enabled) */
502 et131x_rx_dma_enable(adapter);
503 et131x_tx_dma_enable(adapter);
505 /* Enable device interrupts */
506 et131x_enable_interrupts(adapter);
508 /* We're ready to move some data, so start the queue */
509 netif_start_queue(netdev);
514 spin_unlock_irqrestore(&adapter->tcb_send_qlock, flags);
518 * et131x_change_mtu - The handler called to change the MTU for the device
519 * @netdev: device whose MTU is to be changed
520 * @new_mtu: the desired MTU
522 * Returns 0 on success, errno on failure (as defined in errno.h)
524 int et131x_change_mtu(struct net_device *netdev, int new_mtu)
527 struct et131x_adapter *adapter = netdev_priv(netdev);
529 /* Make sure the requested MTU is valid */
530 if (new_mtu < 64 || new_mtu > 9216)
533 /* Stop the netif queue */
534 netif_stop_queue(netdev);
536 /* Stop the Tx and Rx DMA engines */
537 et131x_rx_dma_disable(adapter);
538 et131x_tx_dma_disable(adapter);
540 /* Disable device interrupts */
541 et131x_disable_interrupts(adapter);
542 et131x_handle_send_interrupt(adapter);
543 et131x_handle_recv_interrupt(adapter);
545 /* Set the new MTU */
546 netdev->mtu = new_mtu;
548 /* Free Rx DMA memory */
549 et131x_adapter_memory_free(adapter);
551 /* Set the config parameter for Jumbo Packet support */
552 adapter->registry_jumbo_packet = new_mtu + 14;
553 et131x_soft_reset(adapter);
555 /* Alloc and init Rx DMA memory */
556 result = et131x_adapter_memory_alloc(adapter);
558 dev_warn(&adapter->pdev->dev,
559 "Change MTU failed; couldn't re-alloc DMA memory\n");
563 et131x_init_send(adapter);
565 et131x_hwaddr_init(adapter);
566 memcpy(netdev->dev_addr, adapter->addr, ETH_ALEN);
568 /* Init the device with the new settings */
569 et131x_adapter_setup(adapter);
571 /* Enable interrupts */
572 if (adapter->flags & fMP_ADAPTER_INTERRUPT_IN_USE)
573 et131x_enable_interrupts(adapter);
575 /* Restart the Tx and Rx DMA engines */
576 et131x_rx_dma_enable(adapter);
577 et131x_tx_dma_enable(adapter);
579 /* Restart the netif queue */
580 netif_wake_queue(netdev);
585 * et131x_set_mac_addr - handler to change the MAC address for the device
586 * @netdev: device whose MAC is to be changed
587 * @new_mac: the desired MAC address
589 * Returns 0 on success, errno on failure (as defined in errno.h)
591 * IMPLEMENTED BY : blux http://berndlux.de 22.01.2007 21:14
593 int et131x_set_mac_addr(struct net_device *netdev, void *new_mac)
596 struct et131x_adapter *adapter = netdev_priv(netdev);
597 struct sockaddr *address = new_mac;
604 /* Make sure the requested MAC is valid */
605 if (!is_valid_ether_addr(address->sa_data))
608 /* Stop the netif queue */
609 netif_stop_queue(netdev);
611 /* Stop the Tx and Rx DMA engines */
612 et131x_rx_dma_disable(adapter);
613 et131x_tx_dma_disable(adapter);
615 /* Disable device interrupts */
616 et131x_disable_interrupts(adapter);
617 et131x_handle_send_interrupt(adapter);
618 et131x_handle_recv_interrupt(adapter);
620 /* Set the new MAC */
621 /* netdev->set_mac_address = &new_mac; */
623 memcpy(netdev->dev_addr, address->sa_data, netdev->addr_len);
625 printk(KERN_INFO "%s: Setting MAC address to %pM\n",
626 netdev->name, netdev->dev_addr);
628 /* Free Rx DMA memory */
629 et131x_adapter_memory_free(adapter);
631 et131x_soft_reset(adapter);
633 /* Alloc and init Rx DMA memory */
634 result = et131x_adapter_memory_alloc(adapter);
636 dev_err(&adapter->pdev->dev,
637 "Change MAC failed; couldn't re-alloc DMA memory\n");
641 et131x_init_send(adapter);
643 et131x_hwaddr_init(adapter);
645 /* Init the device with the new settings */
646 et131x_adapter_setup(adapter);
648 /* Enable interrupts */
649 if (adapter->flags & fMP_ADAPTER_INTERRUPT_IN_USE)
650 et131x_enable_interrupts(adapter);
652 /* Restart the Tx and Rx DMA engines */
653 et131x_rx_dma_enable(adapter);
654 et131x_tx_dma_enable(adapter);
656 /* Restart the netif queue */
657 netif_wake_queue(netdev);
661 static const struct net_device_ops et131x_netdev_ops = {
662 .ndo_open = et131x_open,
663 .ndo_stop = et131x_close,
664 .ndo_start_xmit = et131x_tx,
665 .ndo_set_multicast_list = et131x_multicast,
666 .ndo_tx_timeout = et131x_tx_timeout,
667 .ndo_change_mtu = et131x_change_mtu,
668 .ndo_set_mac_address = et131x_set_mac_addr,
669 .ndo_validate_addr = eth_validate_addr,
670 .ndo_get_stats = et131x_stats,
671 .ndo_do_ioctl = et131x_ioctl,
675 * et131x_device_alloc
677 * Returns pointer to the allocated and initialized net_device struct for
680 * Create instances of net_device and wl_private for the new adapter and
681 * register the device's entry points in the net_device structure.
683 struct net_device *et131x_device_alloc(void)
685 struct net_device *netdev;
687 /* Alloc net_device and adapter structs */
688 netdev = alloc_etherdev(sizeof(struct et131x_adapter));
690 if (netdev == NULL) {
691 printk(KERN_ERR "et131x: Alloc of net_device struct failed\n");
696 * Setup the function registration table (and other data) for a
699 netdev->watchdog_timeo = ET131X_TX_TIMEOUT;
700 netdev->netdev_ops = &et131x_netdev_ops;
702 /* netdev->ethtool_ops = &et131x_ethtool_ops; */
705 /* netdev->poll = &et131x_poll; */
706 /* netdev->poll_controller = &et131x_poll_controller; */