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"
91 struct net_device_stats
*et131x_stats(struct net_device
*netdev
);
92 int et131x_open(struct net_device
*netdev
);
93 int et131x_close(struct net_device
*netdev
);
94 int et131x_ioctl(struct net_device
*netdev
, struct ifreq
*reqbuf
, int cmd
);
95 void et131x_multicast(struct net_device
*netdev
);
96 int et131x_tx(struct sk_buff
*skb
, struct net_device
*netdev
);
97 void et131x_tx_timeout(struct net_device
*netdev
);
98 int et131x_change_mtu(struct net_device
*netdev
, int new_mtu
);
99 int et131x_set_mac_addr(struct net_device
*netdev
, void *new_mac
);
100 void et131x_vlan_rx_register(struct net_device
*netdev
, struct vlan_group
*grp
);
101 void et131x_vlan_rx_add_vid(struct net_device
*netdev
, uint16_t vid
);
102 void et131x_vlan_rx_kill_vid(struct net_device
*netdev
, uint16_t vid
);
104 static const struct net_device_ops et131x_netdev_ops
= {
105 .ndo_open
= et131x_open
,
106 .ndo_stop
= et131x_close
,
107 .ndo_start_xmit
= et131x_tx
,
108 .ndo_set_multicast_list
= et131x_multicast
,
109 .ndo_tx_timeout
= et131x_tx_timeout
,
110 .ndo_change_mtu
= et131x_change_mtu
,
111 .ndo_set_mac_address
= et131x_set_mac_addr
,
112 .ndo_validate_addr
= eth_validate_addr
,
113 .ndo_get_stats
= et131x_stats
,
114 .ndo_do_ioctl
= et131x_ioctl
,
118 * et131x_device_alloc
120 * Returns pointer to the allocated and initialized net_device struct for
123 * Create instances of net_device and wl_private for the new adapter and
124 * register the device's entry points in the net_device structure.
126 struct net_device
*et131x_device_alloc(void)
128 struct net_device
*netdev
;
130 /* Alloc net_device and adapter structs */
131 netdev
= alloc_etherdev(sizeof(struct et131x_adapter
));
133 if (netdev
== NULL
) {
134 printk(KERN_ERR
"et131x: Alloc of net_device struct failed\n");
138 /* Setup the function registration table (and other data) for a
141 /* netdev->init = &et131x_init; */
142 /* netdev->set_config = &et131x_config; */
143 netdev
->watchdog_timeo
= ET131X_TX_TIMEOUT
;
144 netdev
->netdev_ops
= &et131x_netdev_ops
;
146 /* netdev->ethtool_ops = &et131x_ethtool_ops; */
149 /* netdev->poll = &et131x_poll; */
150 /* netdev->poll_controller = &et131x_poll_controller; */
155 * et131x_stats - Return the current device statistics.
156 * @netdev: device whose stats are being queried
158 * Returns 0 on success, errno on failure (as defined in errno.h)
160 struct net_device_stats
*et131x_stats(struct net_device
*netdev
)
162 struct et131x_adapter
*adapter
= netdev_priv(netdev
);
163 struct net_device_stats
*stats
= &adapter
->net_stats
;
164 CE_STATS_t
*devstat
= &adapter
->Stats
;
166 stats
->rx_packets
= devstat
->ipackets
;
167 stats
->tx_packets
= devstat
->opackets
;
168 stats
->rx_errors
= devstat
->length_err
+ devstat
->alignment_err
+
169 devstat
->crc_err
+ devstat
->code_violations
+ devstat
->other_errors
;
170 stats
->tx_errors
= devstat
->max_pkt_error
;
171 stats
->multicast
= devstat
->multircv
;
172 stats
->collisions
= devstat
->collisions
;
174 stats
->rx_length_errors
= devstat
->length_err
;
175 stats
->rx_over_errors
= devstat
->rx_ov_flow
;
176 stats
->rx_crc_errors
= devstat
->crc_err
;
178 /* NOTE: These stats don't have corresponding values in CE_STATS,
179 * so we're going to have to update these directly from within the
182 /* stats->rx_bytes = 20; devstat->; */
183 /* stats->tx_bytes = 20; devstat->; */
184 /* stats->rx_dropped = devstat->; */
185 /* stats->tx_dropped = devstat->; */
187 /* NOTE: Not used, can't find analogous statistics */
188 /* stats->rx_frame_errors = devstat->; */
189 /* stats->rx_fifo_errors = devstat->; */
190 /* stats->rx_missed_errors = devstat->; */
192 /* stats->tx_aborted_errors = devstat->; */
193 /* stats->tx_carrier_errors = devstat->; */
194 /* stats->tx_fifo_errors = devstat->; */
195 /* stats->tx_heartbeat_errors = devstat->; */
196 /* stats->tx_window_errors = devstat->; */
201 * et131x_open - Open the device for use.
202 * @netdev: device to be opened
204 * Returns 0 on success, errno on failure (as defined in errno.h)
206 int et131x_open(struct net_device
*netdev
)
209 struct et131x_adapter
*adapter
= netdev_priv(netdev
);
211 /* Start the timer to track NIC errors */
212 add_timer(&adapter
->ErrorTimer
);
214 /* Register our IRQ */
215 result
= request_irq(netdev
->irq
, et131x_isr
, IRQF_SHARED
,
216 netdev
->name
, netdev
);
218 dev_err(&adapter
->pdev
->dev
, "c ould not register IRQ %d\n",
223 /* Enable the Tx and Rx DMA engines (if not already enabled) */
224 et131x_rx_dma_enable(adapter
);
225 et131x_tx_dma_enable(adapter
);
227 /* Enable device interrupts */
228 et131x_enable_interrupts(adapter
);
230 adapter
->Flags
|= fMP_ADAPTER_INTERRUPT_IN_USE
;
232 /* We're ready to move some data, so start the queue */
233 netif_start_queue(netdev
);
238 * et131x_close - Close the device
239 * @netdev: device to be closed
241 * Returns 0 on success, errno on failure (as defined in errno.h)
243 int et131x_close(struct net_device
*netdev
)
245 struct et131x_adapter
*adapter
= netdev_priv(netdev
);
247 /* First thing is to stop the queue */
248 netif_stop_queue(netdev
);
250 /* Stop the Tx and Rx DMA engines */
251 et131x_rx_dma_disable(adapter
);
252 et131x_tx_dma_disable(adapter
);
254 /* Disable device interrupts */
255 et131x_disable_interrupts(adapter
);
257 /* Deregistering ISR */
258 adapter
->Flags
&= ~fMP_ADAPTER_INTERRUPT_IN_USE
;
259 free_irq(netdev
->irq
, netdev
);
261 /* Stop the error timer */
262 del_timer_sync(&adapter
->ErrorTimer
);
267 * et131x_ioctl_mii - The function which handles MII IOCTLs
268 * @netdev: device on which the query is being made
269 * @reqbuf: the request-specific data buffer
270 * @cmd: the command request code
272 * Returns 0 on success, errno on failure (as defined in errno.h)
274 int et131x_ioctl_mii(struct net_device
*netdev
, struct ifreq
*reqbuf
, int cmd
)
277 struct et131x_adapter
*etdev
= netdev_priv(netdev
);
278 struct mii_ioctl_data
*data
= if_mii(reqbuf
);
282 data
->phy_id
= etdev
->Stats
.xcvr_addr
;
286 if (!capable(CAP_NET_ADMIN
))
289 status
= MiRead(etdev
,
290 data
->reg_num
, &data
->val_out
);
294 if (!capable(CAP_NET_ADMIN
))
297 status
= MiWrite(etdev
, data
->reg_num
,
302 status
= -EOPNOTSUPP
;
308 * et131x_ioctl - The I/O Control handler for the driver
309 * @netdev: device on which the control request is being made
310 * @reqbuf: a pointer to the IOCTL request buffer
311 * @cmd: the IOCTL command code
313 * Returns 0 on success, errno on failure (as defined in errno.h)
315 int et131x_ioctl(struct net_device
*netdev
, struct ifreq
*reqbuf
, int cmd
)
323 status
= et131x_ioctl_mii(netdev
, reqbuf
, cmd
);
327 status
= -EOPNOTSUPP
;
333 * et131x_set_packet_filter - Configures the Rx Packet filtering on the device
334 * @adapter: pointer to our private adapter structure
336 * FIXME: lot of dups with MAC code
338 * Returns 0 on success, errno on failure
340 int et131x_set_packet_filter(struct et131x_adapter
*adapter
)
343 uint32_t filter
= adapter
->PacketFilter
;
347 ctrl
= readl(&adapter
->regs
->rxmac
.ctrl
);
348 pf_ctrl
= readl(&adapter
->regs
->rxmac
.pf_ctrl
);
350 /* Default to disabled packet filtering. Enable it in the individual
351 * case statements that require the device to filter something
355 /* Set us to be in promiscuous mode so we receive everything, this
356 * is also true when we get a packet filter of 0
358 if ((filter
& ET131X_PACKET_TYPE_PROMISCUOUS
) || filter
== 0)
359 pf_ctrl
&= ~7; /* Clear filter bits */
362 * Set us up with Multicast packet filtering. Three cases are
363 * possible - (1) we have a multi-cast list, (2) we receive ALL
364 * multicast entries or (3) we receive none.
366 if (filter
& ET131X_PACKET_TYPE_ALL_MULTICAST
)
367 pf_ctrl
&= ~2; /* Multicast filter bit */
369 SetupDeviceForMulticast(adapter
);
374 /* Set us up with Unicast packet filtering */
375 if (filter
& ET131X_PACKET_TYPE_DIRECTED
) {
376 SetupDeviceForUnicast(adapter
);
381 /* Set us up with Broadcast packet filtering */
382 if (filter
& ET131X_PACKET_TYPE_BROADCAST
) {
383 pf_ctrl
|= 1; /* Broadcast filter bit */
388 /* Setup the receive mac configuration registers - Packet
389 * Filter control + the enable / disable for packet filter
390 * in the control reg.
392 writel(pf_ctrl
, &adapter
->regs
->rxmac
.pf_ctrl
);
393 writel(ctrl
, &adapter
->regs
->rxmac
.ctrl
);
399 * et131x_multicast - The handler to configure multicasting on the interface
400 * @netdev: a pointer to a net_device struct representing the device
402 void et131x_multicast(struct net_device
*netdev
)
404 struct et131x_adapter
*adapter
= netdev_priv(netdev
);
405 uint32_t PacketFilter
= 0;
407 struct netdev_hw_addr
*ha
;
410 spin_lock_irqsave(&adapter
->Lock
, flags
);
412 /* Before we modify the platform-independent filter flags, store them
413 * locally. This allows us to determine if anything's changed and if
414 * we even need to bother the hardware
416 PacketFilter
= adapter
->PacketFilter
;
418 /* Clear the 'multicast' flag locally; because we only have a single
419 * flag to check multicast, and multiple multicast addresses can be
420 * set, this is the easiest way to determine if more than one
421 * multicast address is being set.
423 PacketFilter
&= ~ET131X_PACKET_TYPE_MULTICAST
;
425 /* Check the net_device flags and set the device independent flags
429 if (netdev
->flags
& IFF_PROMISC
)
430 adapter
->PacketFilter
|= ET131X_PACKET_TYPE_PROMISCUOUS
;
432 adapter
->PacketFilter
&= ~ET131X_PACKET_TYPE_PROMISCUOUS
;
434 if (netdev
->flags
& IFF_ALLMULTI
)
435 adapter
->PacketFilter
|= ET131X_PACKET_TYPE_ALL_MULTICAST
;
437 if (netdev_mc_count(netdev
) > NIC_MAX_MCAST_LIST
)
438 adapter
->PacketFilter
|= ET131X_PACKET_TYPE_ALL_MULTICAST
;
440 if (netdev_mc_count(netdev
) < 1) {
441 adapter
->PacketFilter
&= ~ET131X_PACKET_TYPE_ALL_MULTICAST
;
442 adapter
->PacketFilter
&= ~ET131X_PACKET_TYPE_MULTICAST
;
444 adapter
->PacketFilter
|= ET131X_PACKET_TYPE_MULTICAST
;
446 /* Set values in the private adapter struct */
448 netdev_for_each_mc_addr(ha
, netdev
) {
449 if (i
== NIC_MAX_MCAST_LIST
)
451 memcpy(adapter
->MCList
[i
++], ha
->addr
, ETH_ALEN
);
453 adapter
->MCAddressCount
= i
;
455 /* Are the new flags different from the previous ones? If not, then no
458 * NOTE - This block will always update the MCList with the hardware,
459 * even if the addresses aren't the same.
461 if (PacketFilter
!= adapter
->PacketFilter
) {
462 /* Call the device's filter function */
463 et131x_set_packet_filter(adapter
);
465 spin_unlock_irqrestore(&adapter
->Lock
, flags
);
469 * et131x_tx - The handler to tx a packet on the device
470 * @skb: data to be Tx'd
471 * @netdev: device on which data is to be Tx'd
473 * Returns 0 on success, errno on failure (as defined in errno.h)
475 int et131x_tx(struct sk_buff
*skb
, struct net_device
*netdev
)
479 /* Save the timestamp for the TX timeout watchdog */
480 netdev
->trans_start
= jiffies
;
482 /* Call the device-specific data Tx routine */
483 status
= et131x_send_packets(skb
, netdev
);
485 /* Check status and manage the netif queue if necessary */
487 if (status
== -ENOMEM
) {
488 /* Put the queue to sleep until resources are
491 netif_stop_queue(netdev
);
492 status
= NETDEV_TX_BUSY
;
494 status
= NETDEV_TX_OK
;
501 * et131x_tx_timeout - Timeout handler
502 * @netdev: a pointer to a net_device struct representing the device
504 * The handler called when a Tx request times out. The timeout period is
505 * specified by the 'tx_timeo" element in the net_device structure (see
506 * et131x_alloc_device() to see how this value is set).
508 void et131x_tx_timeout(struct net_device
*netdev
)
510 struct et131x_adapter
*etdev
= netdev_priv(netdev
);
514 /* Just skip this part if the adapter is doing link detection */
515 if (etdev
->Flags
& fMP_ADAPTER_LINK_DETECTION
)
518 /* Any nonrecoverable hardware error?
519 * Checks adapter->flags for any failure in phy reading
521 if (etdev
->Flags
& fMP_ADAPTER_NON_RECOVER_ERROR
)
524 /* Hardware failure? */
525 if (etdev
->Flags
& fMP_ADAPTER_HARDWARE_ERROR
) {
526 dev_err(&etdev
->pdev
->dev
, "hardware error - reset\n");
531 spin_lock_irqsave(&etdev
->TCBSendQLock
, flags
);
533 tcb
= etdev
->tx_ring
.send_head
;
538 if (tcb
->count
> NIC_SEND_HANG_THRESHOLD
) {
539 spin_unlock_irqrestore(&etdev
->TCBSendQLock
,
542 dev_warn(&etdev
->pdev
->dev
,
543 "Send stuck - reset. tcb->WrIndex %x, Flags 0x%08x\n",
547 et131x_close(netdev
);
554 spin_unlock_irqrestore(&etdev
->TCBSendQLock
, flags
);
558 * et131x_change_mtu - The handler called to change the MTU for the device
559 * @netdev: device whose MTU is to be changed
560 * @new_mtu: the desired MTU
562 * Returns 0 on success, errno on failure (as defined in errno.h)
564 int et131x_change_mtu(struct net_device
*netdev
, int new_mtu
)
567 struct et131x_adapter
*adapter
= netdev_priv(netdev
);
569 /* Make sure the requested MTU is valid */
570 if (new_mtu
< 64 || new_mtu
> 9216)
573 /* Stop the netif queue */
574 netif_stop_queue(netdev
);
576 /* Stop the Tx and Rx DMA engines */
577 et131x_rx_dma_disable(adapter
);
578 et131x_tx_dma_disable(adapter
);
580 /* Disable device interrupts */
581 et131x_disable_interrupts(adapter
);
582 et131x_handle_send_interrupt(adapter
);
583 et131x_handle_recv_interrupt(adapter
);
585 /* Set the new MTU */
586 netdev
->mtu
= new_mtu
;
588 /* Free Rx DMA memory */
589 et131x_adapter_memory_free(adapter
);
591 /* Set the config parameter for Jumbo Packet support */
592 adapter
->RegistryJumboPacket
= new_mtu
+ 14;
593 et131x_soft_reset(adapter
);
595 /* Alloc and init Rx DMA memory */
596 result
= et131x_adapter_memory_alloc(adapter
);
598 dev_warn(&adapter
->pdev
->dev
,
599 "Change MTU failed; couldn't re-alloc DMA memory\n");
603 et131x_init_send(adapter
);
605 et131x_hwaddr_init(adapter
);
606 memcpy(netdev
->dev_addr
, adapter
->addr
, ETH_ALEN
);
608 /* Init the device with the new settings */
609 et131x_adapter_setup(adapter
);
611 /* Enable interrupts */
612 if (adapter
->Flags
& fMP_ADAPTER_INTERRUPT_IN_USE
)
613 et131x_enable_interrupts(adapter
);
615 /* Restart the Tx and Rx DMA engines */
616 et131x_rx_dma_enable(adapter
);
617 et131x_tx_dma_enable(adapter
);
619 /* Restart the netif queue */
620 netif_wake_queue(netdev
);
625 * et131x_set_mac_addr - handler to change the MAC address for the device
626 * @netdev: device whose MAC is to be changed
627 * @new_mac: the desired MAC address
629 * Returns 0 on success, errno on failure (as defined in errno.h)
631 * IMPLEMENTED BY : blux http://berndlux.de 22.01.2007 21:14
633 int et131x_set_mac_addr(struct net_device
*netdev
, void *new_mac
)
636 struct et131x_adapter
*adapter
= netdev_priv(netdev
);
637 struct sockaddr
*address
= new_mac
;
644 /* Make sure the requested MAC is valid */
645 if (!is_valid_ether_addr(address
->sa_data
))
648 /* Stop the netif queue */
649 netif_stop_queue(netdev
);
651 /* Stop the Tx and Rx DMA engines */
652 et131x_rx_dma_disable(adapter
);
653 et131x_tx_dma_disable(adapter
);
655 /* Disable device interrupts */
656 et131x_disable_interrupts(adapter
);
657 et131x_handle_send_interrupt(adapter
);
658 et131x_handle_recv_interrupt(adapter
);
660 /* Set the new MAC */
661 /* netdev->set_mac_address = &new_mac; */
662 /* netdev->mtu = new_mtu; */
664 memcpy(netdev
->dev_addr
, address
->sa_data
, netdev
->addr_len
);
666 printk(KERN_INFO
"%s: Setting MAC address to %pM\n",
667 netdev
->name
, netdev
->dev_addr
);
669 /* Free Rx DMA memory */
670 et131x_adapter_memory_free(adapter
);
672 /* Set the config parameter for Jumbo Packet support */
673 /* adapter->RegistryJumboPacket = new_mtu + 14; */
674 /* blux: not needet here, we'll change the MAC */
676 et131x_soft_reset(adapter
);
678 /* Alloc and init Rx DMA memory */
679 result
= et131x_adapter_memory_alloc(adapter
);
681 dev_err(&adapter
->pdev
->dev
,
682 "Change MAC failed; couldn't re-alloc DMA memory\n");
686 et131x_init_send(adapter
);
688 et131x_hwaddr_init(adapter
);
690 /* Init the device with the new settings */
691 et131x_adapter_setup(adapter
);
693 /* Enable interrupts */
694 if (adapter
->Flags
& fMP_ADAPTER_INTERRUPT_IN_USE
)
695 et131x_enable_interrupts(adapter
);
697 /* Restart the Tx and Rx DMA engines */
698 et131x_rx_dma_enable(adapter
);
699 et131x_tx_dma_enable(adapter
);
701 /* Restart the netif queue */
702 netif_wake_queue(netdev
);