Subversion Repositories test_project

/****************************************************************

 *

 *     kaweth.c - driver for KL5KUSB101 based USB->Ethernet

 *

 *     (c) 2000 Interlan Communications

 *     (c) 2000 Stephane Alnet

 *     (C) 2001 Brad Hards

 *     (C) 2002 Oliver Neukum

 *

 *     Original author: The Zapman <zapman@interlan.net>

 *     Inspired by, and much credit goes to Michael Rothwell

 *     <rothwell@interlan.net> for the test equipment, help, and patience

 *     Based off of (and with thanks to) Petko Manolov's pegaus.c driver.

 *     Also many thanks to Joel Silverman and Ed Surprenant at Kawasaki

 *     for providing the firmware and driver resources.

 *

 *     This program is free software; you can redistribute it and/or

 *     modify it under the terms of the GNU General Public License as

 *     published by the Free Software Foundation; either version 2, or

 *     (at your option) any later version.

 *

 *     This program is distributed in the hope that it will be useful,

 *     but WITHOUT ANY WARRANTY; without even the implied warranty of

 *     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 *     GNU General Public License for more details.

 *

 *     You should have received a copy of the GNU General Public License

 *     along with this program; if not, write to the Free Software Foundation,

 *     Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.

 *

 ****************************************************************/

/* TODO:

 * Fix in_interrupt() problem

 * Develop test procedures for USB net interfaces

 * Run test procedures

 * Fix bugs from previous two steps

 * Snoop other OSs for any tricks we're not doing

 * SMP locking

 * Reduce arbitrary timeouts

 * Smart multicast support

 * Temporary MAC change support

 * Tunable SOFs parameter - ioctl()?

 * Ethernet stats collection

 * Code formatting improvements

 */

#include <linux/module.h>

#include <linux/slab.h>

#include <linux/string.h>

#include <linux/init.h>

#include <linux/delay.h>

#include <linux/netdevice.h>

#include <linux/etherdevice.h>

#include <linux/usb.h>

#include <linux/types.h>

#include <linux/ethtool.h>

#include <linux/dma-mapping.h>

#include <linux/wait.h>

#include <asm/uaccess.h>

#include <asm/semaphore.h>

#include <asm/byteorder.h>

#undef DEBUG

#include "kawethfw.h"

#define KAWETH_MTU                      1514

#define KAWETH_BUF_SIZE                 1664

#define KAWETH_TX_TIMEOUT               (5 * HZ)

#define KAWETH_SCRATCH_SIZE             32

#define KAWETH_FIRMWARE_BUF_SIZE        4096

#define KAWETH_CONTROL_TIMEOUT          (30000)

#define KAWETH_STATUS_BROKEN            0x0000001

#define KAWETH_STATUS_CLOSING           0x0000002

#define KAWETH_STATUS_SUSPENDING        0x0000004

#define KAWETH_STATUS_BLOCKED (KAWETH_STATUS_CLOSING | KAWETH_STATUS_SUSPENDING)

#define KAWETH_PACKET_FILTER_PROMISCUOUS        0x01

#define KAWETH_PACKET_FILTER_ALL_MULTICAST      0x02

#define KAWETH_PACKET_FILTER_DIRECTED           0x04

#define KAWETH_PACKET_FILTER_BROADCAST          0x08

#define KAWETH_PACKET_FILTER_MULTICAST          0x10

/* Table 7 */

#define KAWETH_COMMAND_GET_ETHERNET_DESC        0x00

#define KAWETH_COMMAND_MULTICAST_FILTERS        0x01

#define KAWETH_COMMAND_SET_PACKET_FILTER        0x02

#define KAWETH_COMMAND_STATISTICS               0x03

#define KAWETH_COMMAND_SET_TEMP_MAC             0x06

#define KAWETH_COMMAND_GET_TEMP_MAC             0x07

#define KAWETH_COMMAND_SET_URB_SIZE             0x08

#define KAWETH_COMMAND_SET_SOFS_WAIT            0x09

#define KAWETH_COMMAND_SCAN                     0xFF

#define KAWETH_SOFS_TO_WAIT                     0x05

#define INTBUFFERSIZE                           4

#define STATE_OFFSET                            0

#define STATE_MASK                              0x40

#define STATE_SHIFT                             5

#define IS_BLOCKED(s) (s & KAWETH_STATUS_BLOCKED)

MODULE_AUTHOR("Michael Zappe <zapman@interlan.net>, Stephane Alnet <stephane@u-picardie.fr>, Brad Hards <bhards@bigpond.net.au> and Oliver Neukum <oliver@neukum.org>");

MODULE_DESCRIPTION("KL5USB101 USB Ethernet driver");

MODULE_LICENSE("GPL");

static const char driver_name[] = "kaweth";

static int kaweth_probe(

                struct usb_interface *intf,

                const struct usb_device_id *id  /* from id_table */

        );

static void kaweth_disconnect(struct usb_interface *intf);

static int kaweth_internal_control_msg(struct usb_device *usb_dev,

                                       unsigned int pipe,

                                       struct usb_ctrlrequest *cmd, void *data,

                                       int len, int timeout);

static int kaweth_suspend(struct usb_interface *intf, pm_message_t message);

static int kaweth_resume(struct usb_interface *intf);

/****************************************************************

 *     usb_device_id

 ****************************************************************/

static struct usb_device_id usb_klsi_table[] = {

        { USB_DEVICE(0x03e8, 0x0008) }, /* AOX Endpoints USB Ethernet */

        { USB_DEVICE(0x04bb, 0x0901) }, /* I-O DATA USB-ET/T */

        { USB_DEVICE(0x0506, 0x03e8) }, /* 3Com 3C19250 */

        { USB_DEVICE(0x0506, 0x11f8) }, /* 3Com 3C460 */

        { USB_DEVICE(0x0557, 0x2002) }, /* ATEN USB Ethernet */

        { USB_DEVICE(0x0557, 0x4000) }, /* D-Link DSB-650C */

        { USB_DEVICE(0x0565, 0x0002) }, /* Peracom Enet */

        { USB_DEVICE(0x0565, 0x0003) }, /* Optus@Home UEP1045A */

        { USB_DEVICE(0x0565, 0x0005) }, /* Peracom Enet2 */

        { USB_DEVICE(0x05e9, 0x0008) }, /* KLSI KL5KUSB101B */

        { USB_DEVICE(0x05e9, 0x0009) }, /* KLSI KL5KUSB101B (Board change) */

        { USB_DEVICE(0x066b, 0x2202) }, /* Linksys USB10T */

        { USB_DEVICE(0x06e1, 0x0008) }, /* ADS USB-10BT */

        { USB_DEVICE(0x06e1, 0x0009) }, /* ADS USB-10BT */

        { USB_DEVICE(0x0707, 0x0100) }, /* SMC 2202USB */

        { USB_DEVICE(0x07aa, 0x0001) }, /* Correga K.K. */

        { USB_DEVICE(0x07b8, 0x4000) }, /* D-Link DU-E10 */

        { USB_DEVICE(0x0846, 0x1001) }, /* NetGear EA-101 */

        { USB_DEVICE(0x0846, 0x1002) }, /* NetGear EA-101 */

        { USB_DEVICE(0x085a, 0x0008) }, /* PortGear Ethernet Adapter */

        { USB_DEVICE(0x085a, 0x0009) }, /* PortGear Ethernet Adapter */

        { USB_DEVICE(0x087d, 0x5704) }, /* Jaton USB Ethernet Device Adapter */

        { USB_DEVICE(0x0951, 0x0008) }, /* Kingston Technology USB Ethernet Adapter */

        { USB_DEVICE(0x095a, 0x3003) }, /* Portsmith Express Ethernet Adapter */

        { USB_DEVICE(0x10bd, 0x1427) }, /* ASANTE USB To Ethernet Adapter */

        { USB_DEVICE(0x1342, 0x0204) }, /* Mobility USB-Ethernet Adapter */

        { USB_DEVICE(0x13d2, 0x0400) }, /* Shark Pocket Adapter */

        { USB_DEVICE(0x1485, 0x0001) }, /* Silicom U2E */

        { USB_DEVICE(0x1485, 0x0002) }, /* Psion Dacom Gold Port Ethernet */

        { USB_DEVICE(0x1645, 0x0005) }, /* Entrega E45 */

        { USB_DEVICE(0x1645, 0x0008) }, /* Entrega USB Ethernet Adapter */

        { USB_DEVICE(0x1645, 0x8005) }, /* PortGear Ethernet Adapter */

        { USB_DEVICE(0x1668, 0x0323) }, /* Actiontec USB Ethernet */

        { USB_DEVICE(0x2001, 0x4000) }, /* D-link DSB-650C */

        {} /* Null terminator */

};

MODULE_DEVICE_TABLE (usb, usb_klsi_table);

/****************************************************************

 *     kaweth_driver

 ****************************************************************/

static struct usb_driver kaweth_driver = {

        .name =         driver_name,

        .probe =        kaweth_probe,

        .disconnect =   kaweth_disconnect,

        .suspend =      kaweth_suspend,

        .resume =       kaweth_resume,

        .id_table =     usb_klsi_table,

        .supports_autosuspend = 1,

};

typedef __u8 eth_addr_t[6];

/****************************************************************

 *     usb_eth_dev

 ****************************************************************/

struct usb_eth_dev {

        char *name;

        __u16 vendor;

        __u16 device;

        void *pdata;

};

/****************************************************************

 *     kaweth_ethernet_configuration

 *     Refer Table 8

 ****************************************************************/

struct kaweth_ethernet_configuration

{

        __u8 size;

        __u8 reserved1;

        __u8 reserved2;

        eth_addr_t hw_addr;

        __u32 statistics_mask;

        __le16 segment_size;

        __u16 max_multicast_filters;

        __u8 reserved3;

} __attribute__ ((packed));

/****************************************************************

 *     kaweth_device

 ****************************************************************/

struct kaweth_device

{

        spinlock_t device_lock;

        __u32 status;

        int end;

        int suspend_lowmem_rx;

        int suspend_lowmem_ctrl;

        int linkstate;

        int opened;

        struct delayed_work lowmem_work;

        struct usb_device *dev;

        struct usb_interface *intf;

        struct net_device *net;

        wait_queue_head_t term_wait;

        struct urb *rx_urb;

        struct urb *tx_urb;

        struct urb *irq_urb;

        dma_addr_t intbufferhandle;

        __u8 *intbuffer;

        dma_addr_t rxbufferhandle;

        __u8 *rx_buf;

        struct sk_buff *tx_skb;

        __u8 *firmware_buf;

        __u8 scratch[KAWETH_SCRATCH_SIZE];

        __u16 packet_filter_bitmap;

        struct kaweth_ethernet_configuration configuration;

        struct net_device_stats stats;

};

/****************************************************************

 *     kaweth_control

 ****************************************************************/

static int kaweth_control(struct kaweth_device *kaweth,

                          unsigned int pipe,

                          __u8 request,

                          __u8 requesttype,

                          __u16 value,

                          __u16 index,

                          void *data,

                          __u16 size,

                          int timeout)

{

        struct usb_ctrlrequest *dr;

        dbg("kaweth_control()");

        if(in_interrupt()) {

                dbg("in_interrupt()");

                return -EBUSY;

        }

        dr = kmalloc(sizeof(struct usb_ctrlrequest), GFP_ATOMIC);

        if (!dr) {

                dbg("kmalloc() failed");

                return -ENOMEM;

        }

        dr->bRequestType= requesttype;

        dr->bRequest = request;

        dr->wValue = cpu_to_le16p(&value);

        dr->wIndex = cpu_to_le16p(&index);

        dr->wLength = cpu_to_le16p(&size);

        return kaweth_internal_control_msg(kaweth->dev,

                                        pipe,

                                        dr,

                                        data,

                                        size,

                                        timeout);

}

/****************************************************************

 *     kaweth_read_configuration

 ****************************************************************/

static int kaweth_read_configuration(struct kaweth_device *kaweth)

{

        int retval;

        dbg("Reading kaweth configuration");

        retval = kaweth_control(kaweth,

                                usb_rcvctrlpipe(kaweth->dev, 0),

                                KAWETH_COMMAND_GET_ETHERNET_DESC,

                                USB_TYPE_VENDOR | USB_DIR_IN | USB_RECIP_DEVICE,

                                0,

                                0,

                                (void *)&kaweth->configuration,

                                sizeof(kaweth->configuration),

                                KAWETH_CONTROL_TIMEOUT);

        return retval;

}

/****************************************************************

 *     kaweth_set_urb_size

 ****************************************************************/

static int kaweth_set_urb_size(struct kaweth_device *kaweth, __u16 urb_size)

{

        int retval;

        dbg("Setting URB size to %d", (unsigned)urb_size);

        retval = kaweth_control(kaweth,

                                usb_sndctrlpipe(kaweth->dev, 0),

                                KAWETH_COMMAND_SET_URB_SIZE,

                                USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_DEVICE,

                                urb_size,

                                0,

                                (void *)&kaweth->scratch,

                                0,

                                KAWETH_CONTROL_TIMEOUT);

        return retval;

}

/****************************************************************

 *     kaweth_set_sofs_wait

 ****************************************************************/

static int kaweth_set_sofs_wait(struct kaweth_device *kaweth, __u16 sofs_wait)

{

        int retval;

        dbg("Set SOFS wait to %d", (unsigned)sofs_wait);

        retval = kaweth_control(kaweth,

                                usb_sndctrlpipe(kaweth->dev, 0),

                                KAWETH_COMMAND_SET_SOFS_WAIT,

                                USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_DEVICE,

                                sofs_wait,

                                0,

                                (void *)&kaweth->scratch,

                                0,

                                KAWETH_CONTROL_TIMEOUT);

        return retval;

}

/****************************************************************

 *     kaweth_set_receive_filter

 ****************************************************************/

static int kaweth_set_receive_filter(struct kaweth_device *kaweth,

                                     __u16 receive_filter)

{

        int retval;

        dbg("Set receive filter to %d", (unsigned)receive_filter);

        retval = kaweth_control(kaweth,

                                usb_sndctrlpipe(kaweth->dev, 0),

                                KAWETH_COMMAND_SET_PACKET_FILTER,

                                USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_DEVICE,

                                receive_filter,

                                0,

                                (void *)&kaweth->scratch,

                                0,

                                KAWETH_CONTROL_TIMEOUT);

        return retval;

}

/****************************************************************

 *     kaweth_download_firmware

 ****************************************************************/

static int kaweth_download_firmware(struct kaweth_device *kaweth,

                                    __u8 *data,

                                    __u16 data_len,

                                    __u8 interrupt,

                                    __u8 type)

{

        if(data_len > KAWETH_FIRMWARE_BUF_SIZE) {

                err("Firmware too big: %d", data_len);

                return -ENOSPC;

        }

        memcpy(kaweth->firmware_buf, data, data_len);

        kaweth->firmware_buf[2] = (data_len & 0xFF) - 7;

        kaweth->firmware_buf[3] = data_len >> 8;

        kaweth->firmware_buf[4] = type;

        kaweth->firmware_buf[5] = interrupt;

        dbg("High: %i, Low:%i", kaweth->firmware_buf[3],

                   kaweth->firmware_buf[2]);

        dbg("Downloading firmware at %p to kaweth device at %p",

            data,

            kaweth);

        dbg("Firmware length: %d", data_len);

        return kaweth_control(kaweth,

                              usb_sndctrlpipe(kaweth->dev, 0),

                              KAWETH_COMMAND_SCAN,

                              USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_DEVICE,

                              0,

                              0,

                              (void *)kaweth->firmware_buf,

                              data_len,

                              KAWETH_CONTROL_TIMEOUT);

}

/****************************************************************

 *     kaweth_trigger_firmware

 ****************************************************************/

static int kaweth_trigger_firmware(struct kaweth_device *kaweth,

                                   __u8 interrupt)

{

        kaweth->firmware_buf[0] = 0xB6;

        kaweth->firmware_buf[1] = 0xC3;

        kaweth->firmware_buf[2] = 0x01;

        kaweth->firmware_buf[3] = 0x00;

        kaweth->firmware_buf[4] = 0x06;

        kaweth->firmware_buf[5] = interrupt;

        kaweth->firmware_buf[6] = 0x00;

        kaweth->firmware_buf[7] = 0x00;

        dbg("Triggering firmware");

        return kaweth_control(kaweth,

                              usb_sndctrlpipe(kaweth->dev, 0),

                              KAWETH_COMMAND_SCAN,

                              USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_DEVICE,

                              0,

                              0,

                              (void *)kaweth->firmware_buf,

                              8,

                              KAWETH_CONTROL_TIMEOUT);

}

/****************************************************************

 *     kaweth_reset

 ****************************************************************/

static int kaweth_reset(struct kaweth_device *kaweth)

{

        int result;

        dbg("kaweth_reset(%p)", kaweth);

        result = kaweth_control(kaweth,

                                usb_sndctrlpipe(kaweth->dev, 0),

                                USB_REQ_SET_CONFIGURATION,

                                0,

                                kaweth->dev->config[0].desc.bConfigurationValue,

                                0,

                                NULL,

                                0,

                                KAWETH_CONTROL_TIMEOUT);

        mdelay(10);

        dbg("kaweth_reset() returns %d.",result);

        return result;

}

static void kaweth_usb_receive(struct urb *);

static int kaweth_resubmit_rx_urb(struct kaweth_device *, gfp_t);

/****************************************************************

        int_callback

*****************************************************************/

static void kaweth_resubmit_int_urb(struct kaweth_device *kaweth, gfp_t mf)

{

        int status;

        status = usb_submit_urb (kaweth->irq_urb, mf);

        if (unlikely(status == -ENOMEM)) {

                kaweth->suspend_lowmem_ctrl = 1;

                schedule_delayed_work(&kaweth->lowmem_work, HZ/4);

        } else {

                kaweth->suspend_lowmem_ctrl = 0;

        }

        if (status)

                err ("can't resubmit intr, %s-%s, status %d",

                                kaweth->dev->bus->bus_name,

                                kaweth->dev->devpath, status);

}

static void int_callback(struct urb *u)

{

        struct kaweth_device *kaweth = u->context;

        int act_state;

        switch (u->status) {

        case 0:                  /* success */

                break;

        case -ECONNRESET:       /* unlink */

        case -ENOENT:

        case -ESHUTDOWN:

                return;

        /* -EPIPE:  should clear the halt */

        default:                /* error */

                goto resubmit;

        }

        /* we check the link state to report changes */

        if (kaweth->linkstate != (act_state = ( kaweth->intbuffer[STATE_OFFSET] | STATE_MASK) >> STATE_SHIFT)) {

                if (act_state)

                        netif_carrier_on(kaweth->net);

                else

                        netif_carrier_off(kaweth->net);

                kaweth->linkstate = act_state;

        }

resubmit:

        kaweth_resubmit_int_urb(kaweth, GFP_ATOMIC);

}

static void kaweth_resubmit_tl(struct work_struct *work)

{

        struct kaweth_device *kaweth =

                container_of(work, struct kaweth_device, lowmem_work.work);

        if (IS_BLOCKED(kaweth->status))

                return;

        if (kaweth->suspend_lowmem_rx)

                kaweth_resubmit_rx_urb(kaweth, GFP_NOIO);

        if (kaweth->suspend_lowmem_ctrl)

                kaweth_resubmit_int_urb(kaweth, GFP_NOIO);

}

/****************************************************************

 *     kaweth_resubmit_rx_urb

 ****************************************************************/

static int kaweth_resubmit_rx_urb(struct kaweth_device *kaweth,

                                                gfp_t mem_flags)

{

        int result;

        usb_fill_bulk_urb(kaweth->rx_urb,

                      kaweth->dev,

                      usb_rcvbulkpipe(kaweth->dev, 1),

                      kaweth->rx_buf,

                      KAWETH_BUF_SIZE,

                      kaweth_usb_receive,

                      kaweth);

        kaweth->rx_urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;

        kaweth->rx_urb->transfer_dma = kaweth->rxbufferhandle;

        if((result = usb_submit_urb(kaweth->rx_urb, mem_flags))) {

                if (result == -ENOMEM) {

                        kaweth->suspend_lowmem_rx = 1;

                        schedule_delayed_work(&kaweth->lowmem_work, HZ/4);

                }

                err("resubmitting rx_urb %d failed", result);

        } else {

                kaweth->suspend_lowmem_rx = 0;

        }

        return result;

}

static void kaweth_async_set_rx_mode(struct kaweth_device *kaweth);

/****************************************************************

 *     kaweth_usb_receive

 ****************************************************************/

static void kaweth_usb_receive(struct urb *urb)

{

        struct kaweth_device *kaweth = urb->context;

        struct net_device *net = kaweth->net;

        int count = urb->actual_length;

        int count2 = urb->transfer_buffer_length;

        __u16 pkt_len = le16_to_cpup((__le16 *)kaweth->rx_buf);

        struct sk_buff *skb;

        if(unlikely(urb->status == -ECONNRESET || urb->status == -ESHUTDOWN))

        /* we are killed - set a flag and wake the disconnect handler */

        {

                kaweth->end = 1;

                wake_up(&kaweth->term_wait);

                return;

        }

        spin_lock(&kaweth->device_lock);

        if (IS_BLOCKED(kaweth->status)) {

                spin_unlock(&kaweth->device_lock);

                return;

        }

        spin_unlock(&kaweth->device_lock);

        if(urb->status && urb->status != -EREMOTEIO && count != 1) {

                err("%s RX status: %d count: %d packet_len: %d",

                           net->name,

                           urb->status,

                           count,

                           (int)pkt_len);

                kaweth_resubmit_rx_urb(kaweth, GFP_ATOMIC);

                return;

        }

        if(kaweth->net && (count > 2)) {

                if(pkt_len > (count - 2)) {

                        err("Packet length too long for USB frame (pkt_len: %x, count: %x)",pkt_len, count);

                        err("Packet len & 2047: %x", pkt_len & 2047);

                        err("Count 2: %x", count2);

                        kaweth_resubmit_rx_urb(kaweth, GFP_ATOMIC);

                        return;

                }

                if(!(skb = dev_alloc_skb(pkt_len+2))) {

                        kaweth_resubmit_rx_urb(kaweth, GFP_ATOMIC);

                        return;

                }

                skb_reserve(skb, 2);    /* Align IP on 16 byte boundaries */

                skb_copy_to_linear_data(skb, kaweth->rx_buf + 2, pkt_len);

                skb_put(skb, pkt_len);

                skb->protocol = eth_type_trans(skb, net);

                netif_rx(skb);

                kaweth->stats.rx_packets++;

                kaweth->stats.rx_bytes += pkt_len;

        }

        kaweth_resubmit_rx_urb(kaweth, GFP_ATOMIC);

}

/****************************************************************

 *     kaweth_open

 ****************************************************************/

static int kaweth_open(struct net_device *net)

{

        struct kaweth_device *kaweth = netdev_priv(net);

        int res;

        dbg("Opening network device.");

        res = usb_autopm_get_interface(kaweth->intf);

        if (res) {

                err("Interface cannot be resumed.");

                return -EIO;

        }

        res = kaweth_resubmit_rx_urb(kaweth, GFP_KERNEL);

        if (res)

                goto err_out;

        usb_fill_int_urb(

                kaweth->irq_urb,

                kaweth->dev,

                usb_rcvintpipe(kaweth->dev, 3),

                kaweth->intbuffer,

                INTBUFFERSIZE,

                int_callback,

                kaweth,

                250); /* overriding the descriptor */

        kaweth->irq_urb->transfer_dma = kaweth->intbufferhandle;

        kaweth->irq_urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;

        res = usb_submit_urb(kaweth->irq_urb, GFP_KERNEL);

        if (res) {

                usb_kill_urb(kaweth->rx_urb);

                goto err_out;

        }

        kaweth->opened = 1;