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
->length_err
+ devstat
->alignment_err
+
104 devstat
->crc_err
+ devstat
->code_violations
+ devstat
->other_errors
;
105 stats
->tx_errors
= devstat
->max_pkt_error
;
106 stats
->multicast
= devstat
->multircv
;
107 stats
->collisions
= devstat
->collisions
;
109 stats
->rx_length_errors
= devstat
->length_err
;
110 stats
->rx_over_errors
= devstat
->rx_ov_flow
;
111 stats
->rx_crc_errors
= devstat
->crc_err
;
113 /* NOTE: These stats don't have corresponding values in CE_STATS,
114 * so we're going to have to update these directly from within the
117 /* stats->rx_bytes = 20; devstat->; */
118 /* stats->tx_bytes = 20; devstat->; */
119 /* stats->rx_dropped = devstat->; */
120 /* stats->tx_dropped = devstat->; */
122 /* NOTE: Not used, can't find analogous statistics */
123 /* stats->rx_frame_errors = devstat->; */
124 /* stats->rx_fifo_errors = devstat->; */
125 /* stats->rx_missed_errors = devstat->; */
127 /* stats->tx_aborted_errors = devstat->; */
128 /* stats->tx_carrier_errors = devstat->; */
129 /* stats->tx_fifo_errors = devstat->; */
130 /* stats->tx_heartbeat_errors = devstat->; */
131 /* stats->tx_window_errors = devstat->; */
136 * et131x_open - Open the device for use.
137 * @netdev: device to be opened
139 * Returns 0 on success, errno on failure (as defined in errno.h)
141 int et131x_open(struct net_device
*netdev
)
144 struct et131x_adapter
*adapter
= netdev_priv(netdev
);
146 /* Start the timer to track NIC errors */
147 add_timer(&adapter
->ErrorTimer
);
149 /* Register our IRQ */
150 result
= request_irq(netdev
->irq
, et131x_isr
, IRQF_SHARED
,
151 netdev
->name
, netdev
);
153 dev_err(&adapter
->pdev
->dev
, "c ould not register IRQ %d\n",
158 /* Enable the Tx and Rx DMA engines (if not already enabled) */
159 et131x_rx_dma_enable(adapter
);
160 et131x_tx_dma_enable(adapter
);
162 /* Enable device interrupts */
163 et131x_enable_interrupts(adapter
);
165 adapter
->flags
|= fMP_ADAPTER_INTERRUPT_IN_USE
;
167 /* We're ready to move some data, so start the queue */
168 netif_start_queue(netdev
);
173 * et131x_close - Close the device
174 * @netdev: device to be closed
176 * Returns 0 on success, errno on failure (as defined in errno.h)
178 int et131x_close(struct net_device
*netdev
)
180 struct et131x_adapter
*adapter
= netdev_priv(netdev
);
182 /* First thing is to stop the queue */
183 netif_stop_queue(netdev
);
185 /* Stop the Tx and Rx DMA engines */
186 et131x_rx_dma_disable(adapter
);
187 et131x_tx_dma_disable(adapter
);
189 /* Disable device interrupts */
190 et131x_disable_interrupts(adapter
);
192 /* Deregistering ISR */
193 adapter
->flags
&= ~fMP_ADAPTER_INTERRUPT_IN_USE
;
194 free_irq(netdev
->irq
, netdev
);
196 /* Stop the error timer */
197 del_timer_sync(&adapter
->ErrorTimer
);
202 * et131x_ioctl_mii - The function which handles MII IOCTLs
203 * @netdev: device on which the query is being made
204 * @reqbuf: the request-specific data buffer
205 * @cmd: the command request code
207 * Returns 0 on success, errno on failure (as defined in errno.h)
209 int et131x_ioctl_mii(struct net_device
*netdev
, struct ifreq
*reqbuf
, int cmd
)
212 struct et131x_adapter
*etdev
= netdev_priv(netdev
);
213 struct mii_ioctl_data
*data
= if_mii(reqbuf
);
217 data
->phy_id
= etdev
->stats
.xcvr_addr
;
221 if (!capable(CAP_NET_ADMIN
))
224 status
= MiRead(etdev
,
225 data
->reg_num
, &data
->val_out
);
229 if (!capable(CAP_NET_ADMIN
))
232 status
= MiWrite(etdev
, data
->reg_num
,
237 status
= -EOPNOTSUPP
;
243 * et131x_ioctl - The I/O Control handler for the driver
244 * @netdev: device on which the control request is being made
245 * @reqbuf: a pointer to the IOCTL request buffer
246 * @cmd: the IOCTL command code
248 * Returns 0 on success, errno on failure (as defined in errno.h)
250 int et131x_ioctl(struct net_device
*netdev
, struct ifreq
*reqbuf
, int cmd
)
258 status
= et131x_ioctl_mii(netdev
, reqbuf
, cmd
);
262 status
= -EOPNOTSUPP
;
268 * et131x_set_packet_filter - Configures the Rx Packet filtering on the device
269 * @adapter: pointer to our private adapter structure
271 * FIXME: lot of dups with MAC code
273 * Returns 0 on success, errno on failure
275 int et131x_set_packet_filter(struct et131x_adapter
*adapter
)
278 uint32_t filter
= adapter
->PacketFilter
;
282 ctrl
= readl(&adapter
->regs
->rxmac
.ctrl
);
283 pf_ctrl
= readl(&adapter
->regs
->rxmac
.pf_ctrl
);
285 /* Default to disabled packet filtering. Enable it in the individual
286 * case statements that require the device to filter something
290 /* Set us to be in promiscuous mode so we receive everything, this
291 * is also true when we get a packet filter of 0
293 if ((filter
& ET131X_PACKET_TYPE_PROMISCUOUS
) || filter
== 0)
294 pf_ctrl
&= ~7; /* Clear filter bits */
297 * Set us up with Multicast packet filtering. Three cases are
298 * possible - (1) we have a multi-cast list, (2) we receive ALL
299 * multicast entries or (3) we receive none.
301 if (filter
& ET131X_PACKET_TYPE_ALL_MULTICAST
)
302 pf_ctrl
&= ~2; /* Multicast filter bit */
304 SetupDeviceForMulticast(adapter
);
309 /* Set us up with Unicast packet filtering */
310 if (filter
& ET131X_PACKET_TYPE_DIRECTED
) {
311 SetupDeviceForUnicast(adapter
);
316 /* Set us up with Broadcast packet filtering */
317 if (filter
& ET131X_PACKET_TYPE_BROADCAST
) {
318 pf_ctrl
|= 1; /* Broadcast filter bit */
323 /* Setup the receive mac configuration registers - Packet
324 * Filter control + the enable / disable for packet filter
325 * in the control reg.
327 writel(pf_ctrl
, &adapter
->regs
->rxmac
.pf_ctrl
);
328 writel(ctrl
, &adapter
->regs
->rxmac
.ctrl
);
334 * et131x_multicast - The handler to configure multicasting on the interface
335 * @netdev: a pointer to a net_device struct representing the device
337 void et131x_multicast(struct net_device
*netdev
)
339 struct et131x_adapter
*adapter
= netdev_priv(netdev
);
340 uint32_t PacketFilter
= 0;
342 struct netdev_hw_addr
*ha
;
345 spin_lock_irqsave(&adapter
->Lock
, flags
);
347 /* Before we modify the platform-independent filter flags, store them
348 * locally. This allows us to determine if anything's changed and if
349 * we even need to bother the hardware
351 PacketFilter
= adapter
->PacketFilter
;
353 /* Clear the 'multicast' flag locally; because we only have a single
354 * flag to check multicast, and multiple multicast addresses can be
355 * set, this is the easiest way to determine if more than one
356 * multicast address is being set.
358 PacketFilter
&= ~ET131X_PACKET_TYPE_MULTICAST
;
360 /* Check the net_device flags and set the device independent flags
364 if (netdev
->flags
& IFF_PROMISC
)
365 adapter
->PacketFilter
|= ET131X_PACKET_TYPE_PROMISCUOUS
;
367 adapter
->PacketFilter
&= ~ET131X_PACKET_TYPE_PROMISCUOUS
;
369 if (netdev
->flags
& IFF_ALLMULTI
)
370 adapter
->PacketFilter
|= ET131X_PACKET_TYPE_ALL_MULTICAST
;
372 if (netdev_mc_count(netdev
) > NIC_MAX_MCAST_LIST
)
373 adapter
->PacketFilter
|= ET131X_PACKET_TYPE_ALL_MULTICAST
;
375 if (netdev_mc_count(netdev
) < 1) {
376 adapter
->PacketFilter
&= ~ET131X_PACKET_TYPE_ALL_MULTICAST
;
377 adapter
->PacketFilter
&= ~ET131X_PACKET_TYPE_MULTICAST
;
379 adapter
->PacketFilter
|= ET131X_PACKET_TYPE_MULTICAST
;
381 /* Set values in the private adapter struct */
383 netdev_for_each_mc_addr(ha
, netdev
) {
384 if (i
== NIC_MAX_MCAST_LIST
)
386 memcpy(adapter
->MCList
[i
++], ha
->addr
, ETH_ALEN
);
388 adapter
->MCAddressCount
= i
;
390 /* Are the new flags different from the previous ones? If not, then no
393 * NOTE - This block will always update the MCList with the hardware,
394 * even if the addresses aren't the same.
396 if (PacketFilter
!= adapter
->PacketFilter
) {
397 /* Call the device's filter function */
398 et131x_set_packet_filter(adapter
);
400 spin_unlock_irqrestore(&adapter
->Lock
, flags
);
404 * et131x_tx - The handler to tx a packet on the device
405 * @skb: data to be Tx'd
406 * @netdev: device on which data is to be Tx'd
408 * Returns 0 on success, errno on failure (as defined in errno.h)
410 int et131x_tx(struct sk_buff
*skb
, struct net_device
*netdev
)
414 /* Save the timestamp for the TX timeout watchdog */
415 netdev
->trans_start
= jiffies
;
417 /* Call the device-specific data Tx routine */
418 status
= et131x_send_packets(skb
, netdev
);
420 /* Check status and manage the netif queue if necessary */
422 if (status
== -ENOMEM
) {
423 /* Put the queue to sleep until resources are
426 netif_stop_queue(netdev
);
427 status
= NETDEV_TX_BUSY
;
429 status
= NETDEV_TX_OK
;
436 * et131x_tx_timeout - Timeout handler
437 * @netdev: a pointer to a net_device struct representing the device
439 * The handler called when a Tx request times out. The timeout period is
440 * specified by the 'tx_timeo" element in the net_device structure (see
441 * et131x_alloc_device() to see how this value is set).
443 void et131x_tx_timeout(struct net_device
*netdev
)
445 struct et131x_adapter
*etdev
= netdev_priv(netdev
);
449 /* Any nonrecoverable hardware error?
450 * Checks adapter->flags for any failure in phy reading
452 if (etdev
->flags
& fMP_ADAPTER_NON_RECOVER_ERROR
)
455 /* Hardware failure? */
456 if (etdev
->flags
& fMP_ADAPTER_HARDWARE_ERROR
) {
457 dev_err(&etdev
->pdev
->dev
, "hardware error - reset\n");
462 spin_lock_irqsave(&etdev
->TCBSendQLock
, flags
);
464 tcb
= etdev
->tx_ring
.send_head
;
469 if (tcb
->count
> NIC_SEND_HANG_THRESHOLD
) {
470 spin_unlock_irqrestore(&etdev
->TCBSendQLock
,
473 dev_warn(&etdev
->pdev
->dev
,
474 "Send stuck - reset. tcb->WrIndex %x, flags 0x%08x\n",
478 et131x_close(netdev
);
485 spin_unlock_irqrestore(&etdev
->TCBSendQLock
, flags
);
489 * et131x_change_mtu - The handler called to change the MTU for the device
490 * @netdev: device whose MTU is to be changed
491 * @new_mtu: the desired MTU
493 * Returns 0 on success, errno on failure (as defined in errno.h)
495 int et131x_change_mtu(struct net_device
*netdev
, int new_mtu
)
498 struct et131x_adapter
*adapter
= netdev_priv(netdev
);
500 /* Make sure the requested MTU is valid */
501 if (new_mtu
< 64 || new_mtu
> 9216)
504 /* Stop the netif queue */
505 netif_stop_queue(netdev
);
507 /* Stop the Tx and Rx DMA engines */
508 et131x_rx_dma_disable(adapter
);
509 et131x_tx_dma_disable(adapter
);
511 /* Disable device interrupts */
512 et131x_disable_interrupts(adapter
);
513 et131x_handle_send_interrupt(adapter
);
514 et131x_handle_recv_interrupt(adapter
);
516 /* Set the new MTU */
517 netdev
->mtu
= new_mtu
;
519 /* Free Rx DMA memory */
520 et131x_adapter_memory_free(adapter
);
522 /* Set the config parameter for Jumbo Packet support */
523 adapter
->RegistryJumboPacket
= new_mtu
+ 14;
524 et131x_soft_reset(adapter
);
526 /* Alloc and init Rx DMA memory */
527 result
= et131x_adapter_memory_alloc(adapter
);
529 dev_warn(&adapter
->pdev
->dev
,
530 "Change MTU failed; couldn't re-alloc DMA memory\n");
534 et131x_init_send(adapter
);
536 et131x_hwaddr_init(adapter
);
537 memcpy(netdev
->dev_addr
, adapter
->addr
, ETH_ALEN
);
539 /* Init the device with the new settings */
540 et131x_adapter_setup(adapter
);
542 /* Enable interrupts */
543 if (adapter
->flags
& fMP_ADAPTER_INTERRUPT_IN_USE
)
544 et131x_enable_interrupts(adapter
);
546 /* Restart the Tx and Rx DMA engines */
547 et131x_rx_dma_enable(adapter
);
548 et131x_tx_dma_enable(adapter
);
550 /* Restart the netif queue */
551 netif_wake_queue(netdev
);
556 * et131x_set_mac_addr - handler to change the MAC address for the device
557 * @netdev: device whose MAC is to be changed
558 * @new_mac: the desired MAC address
560 * Returns 0 on success, errno on failure (as defined in errno.h)
562 * IMPLEMENTED BY : blux http://berndlux.de 22.01.2007 21:14
564 int et131x_set_mac_addr(struct net_device
*netdev
, void *new_mac
)
567 struct et131x_adapter
*adapter
= netdev_priv(netdev
);
568 struct sockaddr
*address
= new_mac
;
575 /* Make sure the requested MAC is valid */
576 if (!is_valid_ether_addr(address
->sa_data
))
579 /* Stop the netif queue */
580 netif_stop_queue(netdev
);
582 /* Stop the Tx and Rx DMA engines */
583 et131x_rx_dma_disable(adapter
);
584 et131x_tx_dma_disable(adapter
);
586 /* Disable device interrupts */
587 et131x_disable_interrupts(adapter
);
588 et131x_handle_send_interrupt(adapter
);
589 et131x_handle_recv_interrupt(adapter
);
591 /* Set the new MAC */
592 /* netdev->set_mac_address = &new_mac; */
593 /* netdev->mtu = new_mtu; */
595 memcpy(netdev
->dev_addr
, address
->sa_data
, netdev
->addr_len
);
597 printk(KERN_INFO
"%s: Setting MAC address to %pM\n",
598 netdev
->name
, netdev
->dev_addr
);
600 /* Free Rx DMA memory */
601 et131x_adapter_memory_free(adapter
);
603 /* Set the config parameter for Jumbo Packet support */
604 /* adapter->RegistryJumboPacket = new_mtu + 14; */
605 /* blux: not needet here, we'll change the MAC */
607 et131x_soft_reset(adapter
);
609 /* Alloc and init Rx DMA memory */
610 result
= et131x_adapter_memory_alloc(adapter
);
612 dev_err(&adapter
->pdev
->dev
,
613 "Change MAC failed; couldn't re-alloc DMA memory\n");
617 et131x_init_send(adapter
);
619 et131x_hwaddr_init(adapter
);
621 /* Init the device with the new settings */
622 et131x_adapter_setup(adapter
);
624 /* Enable interrupts */
625 if (adapter
->flags
& fMP_ADAPTER_INTERRUPT_IN_USE
)
626 et131x_enable_interrupts(adapter
);
628 /* Restart the Tx and Rx DMA engines */
629 et131x_rx_dma_enable(adapter
);
630 et131x_tx_dma_enable(adapter
);
632 /* Restart the netif queue */
633 netif_wake_queue(netdev
);
637 static const struct net_device_ops et131x_netdev_ops
= {
638 .ndo_open
= et131x_open
,
639 .ndo_stop
= et131x_close
,
640 .ndo_start_xmit
= et131x_tx
,
641 .ndo_set_multicast_list
= et131x_multicast
,
642 .ndo_tx_timeout
= et131x_tx_timeout
,
643 .ndo_change_mtu
= et131x_change_mtu
,
644 .ndo_set_mac_address
= et131x_set_mac_addr
,
645 .ndo_validate_addr
= eth_validate_addr
,
646 .ndo_get_stats
= et131x_stats
,
647 .ndo_do_ioctl
= et131x_ioctl
,
651 * et131x_device_alloc
653 * Returns pointer to the allocated and initialized net_device struct for
656 * Create instances of net_device and wl_private for the new adapter and
657 * register the device's entry points in the net_device structure.
659 struct net_device
*et131x_device_alloc(void)
661 struct net_device
*netdev
;
663 /* Alloc net_device and adapter structs */
664 netdev
= alloc_etherdev(sizeof(struct et131x_adapter
));
666 if (netdev
== NULL
) {
667 printk(KERN_ERR
"et131x: Alloc of net_device struct failed\n");
671 /* Setup the function registration table (and other data) for a
674 /* netdev->init = &et131x_init; */
675 /* netdev->set_config = &et131x_config; */
676 netdev
->watchdog_timeo
= ET131X_TX_TIMEOUT
;
677 netdev
->netdev_ops
= &et131x_netdev_ops
;
679 /* netdev->ethtool_ops = &et131x_ethtool_ops; */
682 /* netdev->poll = &et131x_poll; */
683 /* netdev->poll_controller = &et131x_poll_controller; */