staging: et131x: Remove redundant phy code

[linux-2.6/linux-acpi-2.6/ibm-acpi-2.6.git] / drivers / staging / et131x / et131x_netdev.c

/*
 * Agere Systems Inc.
 * 10/100/1000 Base-T Ethernet Driver for the ET1310 and ET131x series MACs
 *
 * Copyright © 2005 Agere Systems Inc.
 * All rights reserved.
 *   http://www.agere.com
 *
 *------------------------------------------------------------------------------
 *
 * et131x_netdev.c - Routines and data required by all Linux network devices.
 *
 *------------------------------------------------------------------------------
 *
 * SOFTWARE LICENSE
 *
 * This software is provided subject to the following terms and conditions,
 * which you should read carefully before using the software.  Using this
 * software indicates your acceptance of these terms and conditions.  If you do
 * not agree with these terms and conditions, do not use the software.
 *
 * Copyright © 2005 Agere Systems Inc.
 * All rights reserved.
 *
 * Redistribution and use in source or binary forms, with or without
 * modifications, are permitted provided that the following conditions are met:
 *
 * . Redistributions of source code must retain the above copyright notice, this
 *    list of conditions and the following Disclaimer as comments in the code as
 *    well as in the documentation and/or other materials provided with the
 *    distribution.
 *
 * . Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following Disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *
 * . Neither the name of Agere Systems Inc. nor the names of the contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * Disclaimer
 *
 * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
 * INCLUDING, BUT NOT LIMITED TO, INFRINGEMENT AND THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  ANY
 * USE, MODIFICATION OR DISTRIBUTION OF THIS SOFTWARE IS SOLELY AT THE USERS OWN
 * RISK. IN NO EVENT SHALL AGERE SYSTEMS INC. OR CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, INCLUDING, BUT NOT LIMITED TO, CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
 * DAMAGE.
 *
 */

#include "et131x_version.h"
#include "et131x_defs.h"

#include <linux/init.h>
#include <linux/module.h>
#include <linux/types.h>
#include <linux/kernel.h>

#include <linux/sched.h>
#include <linux/ptrace.h>
#include <linux/ctype.h>
#include <linux/string.h>
#include <linux/timer.h>
#include <linux/interrupt.h>
#include <linux/in.h>
#include <linux/delay.h>
#include <linux/io.h>
#include <linux/bitops.h>
#include <linux/pci.h>
#include <asm/system.h>

#include <linux/mii.h>
#include <linux/netdevice.h>
#include <linux/etherdevice.h>
#include <linux/skbuff.h>
#include <linux/if_arp.h>
#include <linux/ioport.h>
#include <linux/phy.h>

#include "et1310_phy.h"
#include "et1310_tx.h"
#include "et131x_adapter.h"
#include "et131x.h"

/**
 * et131x_stats - Return the current device statistics.
 * @netdev: device whose stats are being queried
 *
 * Returns 0 on success, errno on failure (as defined in errno.h)
 */
static struct net_device_stats *et131x_stats(struct net_device *netdev)
{
        struct et131x_adapter *adapter = netdev_priv(netdev);
        struct net_device_stats *stats = &adapter->net_stats;
        struct ce_stats *devstat = &adapter->stats;

        stats->rx_errors = devstat->rx_length_errs +
                           devstat->rx_align_errs +
                           devstat->rx_crc_errs +
                           devstat->rx_code_violations +
                           devstat->rx_other_errs;
        stats->tx_errors = devstat->tx_max_pkt_errs;
        stats->multicast = devstat->multicast_pkts_rcvd;
        stats->collisions = devstat->tx_collisions;

        stats->rx_length_errors = devstat->rx_length_errs;
        stats->rx_over_errors = devstat->rx_overflows;
        stats->rx_crc_errors = devstat->rx_crc_errs;

        /* NOTE: These stats don't have corresponding values in CE_STATS,
         * so we're going to have to update these directly from within the
         * TX/RX code
         */
        /* stats->rx_bytes            = 20; devstat->; */
        /* stats->tx_bytes            = 20;  devstat->; */
        /* stats->rx_dropped          = devstat->; */
        /* stats->tx_dropped          = devstat->; */

        /*  NOTE: Not used, can't find analogous statistics */
        /* stats->rx_frame_errors     = devstat->; */
        /* stats->rx_fifo_errors      = devstat->; */
        /* stats->rx_missed_errors    = devstat->; */

        /* stats->tx_aborted_errors   = devstat->; */
        /* stats->tx_carrier_errors   = devstat->; */
        /* stats->tx_fifo_errors      = devstat->; */
        /* stats->tx_heartbeat_errors = devstat->; */
        /* stats->tx_window_errors    = devstat->; */
        return stats;
}

/**
 * et131x_open - Open the device for use.
 * @netdev: device to be opened
 *
 * Returns 0 on success, errno on failure (as defined in errno.h)
 */
int et131x_open(struct net_device *netdev)
{
        int result = 0;
        struct et131x_adapter *adapter = netdev_priv(netdev);

        /* Start the timer to track NIC errors */
        add_timer(&adapter->error_timer);

        /* Register our IRQ */
        result = request_irq(netdev->irq, et131x_isr, IRQF_SHARED,
                                        netdev->name, netdev);
        if (result) {
                dev_err(&adapter->pdev->dev, "could not register IRQ %d\n",
                        netdev->irq);
                return result;
        }

        /* Enable the Tx and Rx DMA engines (if not already enabled) */
        et131x_rx_dma_enable(adapter);
        et131x_tx_dma_enable(adapter);

        /* Enable device interrupts */
        et131x_enable_interrupts(adapter);

        adapter->flags |= fMP_ADAPTER_INTERRUPT_IN_USE;

        phy_start(adapter->phydev);

        /* We're ready to move some data, so start the queue */
        netif_start_queue(netdev);
        return result;
}

/**
 * et131x_close - Close the device
 * @netdev: device to be closed
 *
 * Returns 0 on success, errno on failure (as defined in errno.h)
 */
int et131x_close(struct net_device *netdev)
{
        struct et131x_adapter *adapter = netdev_priv(netdev);

        /* Save the timestamp for the TX watchdog, prevent a timeout */
        netdev->trans_start = jiffies;

        /* First thing is to stop the queue */
        netif_stop_queue(netdev);

        /* Stop the Tx and Rx DMA engines */
        et131x_rx_dma_disable(adapter);
        et131x_tx_dma_disable(adapter);

        /* Disable device interrupts */
        et131x_disable_interrupts(adapter);

        /* Deregistering ISR */
        adapter->flags &= ~fMP_ADAPTER_INTERRUPT_IN_USE;
        free_irq(netdev->irq, netdev);

        /* Stop the error timer */
        del_timer_sync(&adapter->error_timer);
        return 0;
}

/**
 * et131x_ioctl - The I/O Control handler for the driver
 * @netdev: device on which the control request is being made
 * @reqbuf: a pointer to the IOCTL request buffer
 * @cmd: the IOCTL command code
 *
 * Returns 0 on success, errno on failure (as defined in errno.h)
 */
int et131x_ioctl(struct net_device *netdev, struct ifreq *reqbuf, int cmd)
{
        struct et131x_adapter *adapter = netdev_priv(netdev);

        if (!adapter->phydev)
                return -EINVAL;

        return phy_mii_ioctl(adapter->phydev, reqbuf, cmd);
}

/**
 * et131x_set_packet_filter - Configures the Rx Packet filtering on the device
 * @adapter: pointer to our private adapter structure
 *
 * FIXME: lot of dups with MAC code
 *
 * Returns 0 on success, errno on failure
 */
int et131x_set_packet_filter(struct et131x_adapter *adapter)
{
        int status = 0;
        uint32_t filter = adapter->packet_filter;
        u32 ctrl;
        u32 pf_ctrl;

        ctrl = readl(&adapter->regs->rxmac.ctrl);
        pf_ctrl = readl(&adapter->regs->rxmac.pf_ctrl);

        /* Default to disabled packet filtering.  Enable it in the individual
         * case statements that require the device to filter something
         */
        ctrl |= 0x04;

        /* Set us to be in promiscuous mode so we receive everything, this
         * is also true when we get a packet filter of 0
         */
        if ((filter & ET131X_PACKET_TYPE_PROMISCUOUS) || filter == 0)
                pf_ctrl &= ~7;  /* Clear filter bits */
        else {
                /*
                 * Set us up with Multicast packet filtering.  Three cases are
                 * possible - (1) we have a multi-cast list, (2) we receive ALL
                 * multicast entries or (3) we receive none.
                 */
                if (filter & ET131X_PACKET_TYPE_ALL_MULTICAST)
                        pf_ctrl &= ~2;  /* Multicast filter bit */
                else {
                        et1310_setup_device_for_multicast(adapter);
                        pf_ctrl |= 2;
                        ctrl &= ~0x04;
                }

                /* Set us up with Unicast packet filtering */
                if (filter & ET131X_PACKET_TYPE_DIRECTED) {
                        et1310_setup_device_for_unicast(adapter);
                        pf_ctrl |= 4;
                        ctrl &= ~0x04;
                }

                /* Set us up with Broadcast packet filtering */
                if (filter & ET131X_PACKET_TYPE_BROADCAST) {
                        pf_ctrl |= 1;   /* Broadcast filter bit */
                        ctrl &= ~0x04;
                } else
                        pf_ctrl &= ~1;

                /* Setup the receive mac configuration registers - Packet
                 * Filter control + the enable / disable for packet filter
                 * in the control reg.
                 */
                writel(pf_ctrl, &adapter->regs->rxmac.pf_ctrl);
                writel(ctrl, &adapter->regs->rxmac.ctrl);
        }
        return status;
}

/**
 * et131x_multicast - The handler to configure multicasting on the interface
 * @netdev: a pointer to a net_device struct representing the device
 */
void et131x_multicast(struct net_device *netdev)
{
        struct et131x_adapter *adapter = netdev_priv(netdev);
        uint32_t packet_filter = 0;
        unsigned long flags;
        struct netdev_hw_addr *ha;
        int i;

        spin_lock_irqsave(&adapter->lock, flags);

        /* Before we modify the platform-independent filter flags, store them
         * locally. This allows us to determine if anything's changed and if
         * we even need to bother the hardware
         */
        packet_filter = adapter->packet_filter;

        /* Clear the 'multicast' flag locally; because we only have a single
         * flag to check multicast, and multiple multicast addresses can be
         * set, this is the easiest way to determine if more than one
         * multicast address is being set.
         */
        packet_filter &= ~ET131X_PACKET_TYPE_MULTICAST;

        /* Check the net_device flags and set the device independent flags
         * accordingly
         */

        if (netdev->flags & IFF_PROMISC)
                adapter->packet_filter |= ET131X_PACKET_TYPE_PROMISCUOUS;
        else
                adapter->packet_filter &= ~ET131X_PACKET_TYPE_PROMISCUOUS;

        if (netdev->flags & IFF_ALLMULTI)
                adapter->packet_filter |= ET131X_PACKET_TYPE_ALL_MULTICAST;

        if (netdev_mc_count(netdev) > NIC_MAX_MCAST_LIST)
                adapter->packet_filter |= ET131X_PACKET_TYPE_ALL_MULTICAST;

        if (netdev_mc_count(netdev) < 1) {
                adapter->packet_filter &= ~ET131X_PACKET_TYPE_ALL_MULTICAST;
                adapter->packet_filter &= ~ET131X_PACKET_TYPE_MULTICAST;
        } else
                adapter->packet_filter |= ET131X_PACKET_TYPE_MULTICAST;

        /* Set values in the private adapter struct */
        i = 0;
        netdev_for_each_mc_addr(ha, netdev) {
                if (i == NIC_MAX_MCAST_LIST)
                        break;
                memcpy(adapter->multicast_list[i++], ha->addr, ETH_ALEN);
        }
        adapter->multicast_addr_count = i;

        /* Are the new flags different from the previous ones? If not, then no
         * action is required
         *
         * NOTE - This block will always update the multicast_list with the
         *        hardware, even if the addresses aren't the same.
         */
        if (packet_filter != adapter->packet_filter) {
                /* Call the device's filter function */
                et131x_set_packet_filter(adapter);
        }
        spin_unlock_irqrestore(&adapter->lock, flags);
}

/**
 * et131x_tx - The handler to tx a packet on the device
 * @skb: data to be Tx'd
 * @netdev: device on which data is to be Tx'd
 *
 * Returns 0 on success, errno on failure (as defined in errno.h)
 */
int et131x_tx(struct sk_buff *skb, struct net_device *netdev)
{
        int status = 0;

        /* Save the timestamp for the TX timeout watchdog */
        netdev->trans_start = jiffies;

        /* Call the device-specific data Tx routine */
        status = et131x_send_packets(skb, netdev);

        /* Check status and manage the netif queue if necessary */
        if (status != 0) {
                if (status == -ENOMEM) {
                        /* Put the queue to sleep until resources are
                         * available
                         */
                        netif_stop_queue(netdev);
                        status = NETDEV_TX_BUSY;
                } else {
                        status = NETDEV_TX_OK;
                }
        }
        return status;
}

/**
 * et131x_tx_timeout - Timeout handler
 * @netdev: a pointer to a net_device struct representing the device
 *
 * The handler called when a Tx request times out. The timeout period is
 * specified by the 'tx_timeo" element in the net_device structure (see
 * et131x_alloc_device() to see how this value is set).
 */
void et131x_tx_timeout(struct net_device *netdev)
{
        struct et131x_adapter *adapter = netdev_priv(netdev);
        struct tcb *tcb;
        unsigned long flags;

        /* If the device is closed, ignore the timeout */
        if (~(adapter->flags & fMP_ADAPTER_INTERRUPT_IN_USE));
                return;

        /* Any nonrecoverable hardware error?
         * Checks adapter->flags for any failure in phy reading
         */
        if (adapter->flags & fMP_ADAPTER_NON_RECOVER_ERROR)
                return;

        /* Hardware failure? */
        if (adapter->flags & fMP_ADAPTER_HARDWARE_ERROR) {
                dev_err(&adapter->pdev->dev, "hardware error - reset\n");
                return;
        }

        /* Is send stuck? */
        spin_lock_irqsave(&adapter->tcb_send_qlock, flags);

        tcb = adapter->tx_ring.send_head;

        if (tcb != NULL) {
                tcb->count++;

                if (tcb->count > NIC_SEND_HANG_THRESHOLD) {
                        spin_unlock_irqrestore(&adapter->tcb_send_qlock,
                                               flags);

                        dev_warn(&adapter->pdev->dev,
                                "Send stuck - reset.  tcb->WrIndex %x, flags 0x%08x\n",
                                tcb->index,
                                tcb->flags);

                        adapter->net_stats.tx_errors++;

                        /* perform reset */
                        /* First thing is to stop the queue */
                        netif_stop_queue(netdev);

                        /* Stop the Tx and Rx DMA engines */
                        et131x_rx_dma_disable(adapter);
                        et131x_tx_dma_disable(adapter);

                        /* Disable device interrupts */
                        et131x_disable_interrupts(adapter);

                        /* Enable the Tx and Rx DMA engines (if not already enabled) */
                        et131x_rx_dma_enable(adapter);
                        et131x_tx_dma_enable(adapter);

                        /* Enable device interrupts */
                        et131x_enable_interrupts(adapter);

                        /* We're ready to move some data, so start the queue */
                        netif_start_queue(netdev);
                        return;
                }
        }

        spin_unlock_irqrestore(&adapter->tcb_send_qlock, flags);
}

/**
 * et131x_change_mtu - The handler called to change the MTU for the device
 * @netdev: device whose MTU is to be changed
 * @new_mtu: the desired MTU
 *
 * Returns 0 on success, errno on failure (as defined in errno.h)
 */
int et131x_change_mtu(struct net_device *netdev, int new_mtu)
{
        int result = 0;
        struct et131x_adapter *adapter = netdev_priv(netdev);

        /* Make sure the requested MTU is valid */
        if (new_mtu < 64 || new_mtu > 9216)
                return -EINVAL;

        /* Stop the netif queue */
        netif_stop_queue(netdev);

        /* Stop the Tx and Rx DMA engines */
        et131x_rx_dma_disable(adapter);
        et131x_tx_dma_disable(adapter);

        /* Disable device interrupts */
        et131x_disable_interrupts(adapter);
        et131x_handle_send_interrupt(adapter);
        et131x_handle_recv_interrupt(adapter);

        /* Set the new MTU */
        netdev->mtu = new_mtu;

        /* Free Rx DMA memory */
        et131x_adapter_memory_free(adapter);

        /* Set the config parameter for Jumbo Packet support */
        adapter->registry_jumbo_packet = new_mtu + 14;
        et131x_soft_reset(adapter);

        /* Alloc and init Rx DMA memory */
        result = et131x_adapter_memory_alloc(adapter);
        if (result != 0) {
                dev_warn(&adapter->pdev->dev,
                        "Change MTU failed; couldn't re-alloc DMA memory\n");
                return result;
        }

        et131x_init_send(adapter);

        et131x_hwaddr_init(adapter);
        memcpy(netdev->dev_addr, adapter->addr, ETH_ALEN);

        /* Init the device with the new settings */
        et131x_adapter_setup(adapter);

        /* Enable interrupts */
        if (adapter->flags & fMP_ADAPTER_INTERRUPT_IN_USE)
                et131x_enable_interrupts(adapter);

        /* Restart the Tx and Rx DMA engines */
        et131x_rx_dma_enable(adapter);
        et131x_tx_dma_enable(adapter);

        /* Restart the netif queue */
        netif_wake_queue(netdev);
        return result;
}

/**
 * et131x_set_mac_addr - handler to change the MAC address for the device
 * @netdev: device whose MAC is to be changed
 * @new_mac: the desired MAC address
 *
 * Returns 0 on success, errno on failure (as defined in errno.h)
 *
 * IMPLEMENTED BY : blux http://berndlux.de 22.01.2007 21:14
 */
int et131x_set_mac_addr(struct net_device *netdev, void *new_mac)
{
        int result = 0;
        struct et131x_adapter *adapter = netdev_priv(netdev);
        struct sockaddr *address = new_mac;

        /* begin blux */

        if (adapter == NULL)
                return -ENODEV;

        /* Make sure the requested MAC is valid */
        if (!is_valid_ether_addr(address->sa_data))
                return -EINVAL;

        /* Stop the netif queue */
        netif_stop_queue(netdev);

        /* Stop the Tx and Rx DMA engines */
        et131x_rx_dma_disable(adapter);
        et131x_tx_dma_disable(adapter);

        /* Disable device interrupts */
        et131x_disable_interrupts(adapter);
        et131x_handle_send_interrupt(adapter);
        et131x_handle_recv_interrupt(adapter);

        /* Set the new MAC */
        /* netdev->set_mac_address  = &new_mac; */

        memcpy(netdev->dev_addr, address->sa_data, netdev->addr_len);

        printk(KERN_INFO "%s: Setting MAC address to %pM\n",
                        netdev->name, netdev->dev_addr);

        /* Free Rx DMA memory */
        et131x_adapter_memory_free(adapter);

        et131x_soft_reset(adapter);

        /* Alloc and init Rx DMA memory */
        result = et131x_adapter_memory_alloc(adapter);
        if (result != 0) {
                dev_err(&adapter->pdev->dev,
                        "Change MAC failed; couldn't re-alloc DMA memory\n");
                return result;
        }

        et131x_init_send(adapter);

        et131x_hwaddr_init(adapter);

        /* Init the device with the new settings */
        et131x_adapter_setup(adapter);

        /* Enable interrupts */
        if (adapter->flags & fMP_ADAPTER_INTERRUPT_IN_USE)
                et131x_enable_interrupts(adapter);

        /* Restart the Tx and Rx DMA engines */
        et131x_rx_dma_enable(adapter);
        et131x_tx_dma_enable(adapter);

        /* Restart the netif queue */
        netif_wake_queue(netdev);
        return result;
}

static const struct net_device_ops et131x_netdev_ops = {
        .ndo_open               = et131x_open,
        .ndo_stop               = et131x_close,
        .ndo_start_xmit         = et131x_tx,
        .ndo_set_multicast_list = et131x_multicast,
        .ndo_tx_timeout         = et131x_tx_timeout,
        .ndo_change_mtu         = et131x_change_mtu,
        .ndo_set_mac_address    = et131x_set_mac_addr,
        .ndo_validate_addr      = eth_validate_addr,
        .ndo_get_stats          = et131x_stats,
        .ndo_do_ioctl           = et131x_ioctl,
};

/**
 * et131x_device_alloc
 *
 * Returns pointer to the allocated and initialized net_device struct for
 * this device.
 *
 * Create instances of net_device and wl_private for the new adapter and
 * register the device's entry points in the net_device structure.
 */
struct net_device *et131x_device_alloc(void)
{
        struct net_device *netdev;

        /* Alloc net_device and adapter structs */
        netdev = alloc_etherdev(sizeof(struct et131x_adapter));

        if (!netdev) {
                printk(KERN_ERR "et131x: Alloc of net_device struct failed\n");
                return NULL;
        }

        /*
         * Setup the function registration table (and other data) for a
         * net_device
         */
        netdev->watchdog_timeo = ET131X_TX_TIMEOUT;
        netdev->netdev_ops     = &et131x_netdev_ops;

        /* Poll? */
        /* netdev->poll               = &et131x_poll; */
        /* netdev->poll_controller    = &et131x_poll_controller; */
        return netdev;
}