[linux-block.git] / drivers / net / usb / dm9601.c

/*
 * Davicom DM9601 USB 1.1 10/100Mbps ethernet devices
 *
 * Peter Korsgaard <jacmet@sunsite.dk>
 *
 * This file is licensed under the terms of the GNU General Public License
 * version 2.  This program is licensed "as is" without any warranty of any
 * kind, whether express or implied.
 */

//#define DEBUG

#include <linux/module.h>
#include <linux/sched.h>
#include <linux/stddef.h>
#include <linux/init.h>
#include <linux/netdevice.h>
#include <linux/etherdevice.h>
#include <linux/ethtool.h>
#include <linux/mii.h>
#include <linux/usb.h>
#include <linux/crc32.h>
#include <linux/usb/usbnet.h>

/* datasheet:
 http://www.davicom.com.tw/big5/download/Data%20Sheet/DM9601-DS-P01-930914.pdf
*/

/* control requests */
#define DM_READ_REGS	0x00
#define DM_WRITE_REGS	0x01
#define DM_READ_MEMS	0x02
#define DM_WRITE_REG	0x03
#define DM_WRITE_MEMS	0x05
#define DM_WRITE_MEM	0x07

/* registers */
#define DM_NET_CTRL	0x00
#define DM_RX_CTRL	0x05
#define DM_SHARED_CTRL	0x0b
#define DM_SHARED_ADDR	0x0c
#define DM_SHARED_DATA	0x0d	/* low + high */
#define DM_PHY_ADDR	0x10	/* 6 bytes */
#define DM_MCAST_ADDR	0x16	/* 8 bytes */
#define DM_GPR_CTRL	0x1e
#define DM_GPR_DATA	0x1f

#define DM_MAX_MCAST	64
#define DM_MCAST_SIZE	8
#define DM_EEPROM_LEN	256
#define DM_TX_OVERHEAD	2	/* 2 byte header */
#define DM_RX_OVERHEAD	7	/* 3 byte header + 4 byte crc tail */
#define DM_TIMEOUT	1000


static int dm_read(struct usbnet *dev, u8 reg, u16 length, void *data)
{
	void *buf;
	int err = -ENOMEM;

	devdbg(dev, "dm_read() reg=0x%02x length=%d", reg, length);

	buf = kmalloc(length, GFP_KERNEL);
	if (!buf)
		goto out;

	err = usb_control_msg(dev->udev,
			      usb_rcvctrlpipe(dev->udev, 0),
			      DM_READ_REGS,
			      USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
			      0, reg, buf, length, USB_CTRL_SET_TIMEOUT);
	if (err == length)
		memcpy(data, buf, length);
	else if (err >= 0)
		err = -EINVAL;
	kfree(buf);

 out:
	return err;
}

static int dm_read_reg(struct usbnet *dev, u8 reg, u8 *value)
{
	return dm_read(dev, reg, 1, value);
}

static int dm_write(struct usbnet *dev, u8 reg, u16 length, void *data)
{
	void *buf = NULL;
	int err = -ENOMEM;

	devdbg(dev, "dm_write() reg=0x%02x, length=%d", reg, length);

	if (data) {
		buf = kmalloc(length, GFP_KERNEL);
		if (!buf)
			goto out;
		memcpy(buf, data, length);
	}

	err = usb_control_msg(dev->udev,
			      usb_sndctrlpipe(dev->udev, 0),
			      DM_WRITE_REGS,
			      USB_DIR_OUT | USB_TYPE_VENDOR |USB_RECIP_DEVICE,
			      0, reg, buf, length, USB_CTRL_SET_TIMEOUT);
	kfree(buf);
	if (err >= 0 && err < length)
		err = -EINVAL;
 out:
	return err;
}

static int dm_write_reg(struct usbnet *dev, u8 reg, u8 value)
{
	devdbg(dev, "dm_write_reg() reg=0x%02x, value=0x%02x", reg, value);
	return usb_control_msg(dev->udev,
			       usb_sndctrlpipe(dev->udev, 0),
			       DM_WRITE_REG,
			       USB_DIR_OUT | USB_TYPE_VENDOR |USB_RECIP_DEVICE,
			       value, reg, NULL, 0, USB_CTRL_SET_TIMEOUT);
}

static void dm_write_async_callback(struct urb *urb)
{
	struct usb_ctrlrequest *req = (struct usb_ctrlrequest *)urb->context;
	int status = urb->status;

	if (status < 0)
		printk(KERN_DEBUG "dm_write_async_callback() failed with %d\n",
		       status);

	kfree(req);
	usb_free_urb(urb);
}

static void dm_write_async_helper(struct usbnet *dev, u8 reg, u8 value,
				  u16 length, void *data)
{
	struct usb_ctrlrequest *req;
	struct urb *urb;
	int status;

	urb = usb_alloc_urb(0, GFP_ATOMIC);
	if (!urb) {
		deverr(dev, "Error allocating URB in dm_write_async_helper!");
		return;
	}

	req = kmalloc(sizeof(struct usb_ctrlrequest), GFP_ATOMIC);
	if (!req) {
		deverr(dev, "Failed to allocate memory for control request");
		usb_free_urb(urb);
		return;
	}

	req->bRequestType = USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_DEVICE;
	req->bRequest = length ? DM_WRITE_REGS : DM_WRITE_REG;
	req->wValue = cpu_to_le16(value);
	req->wIndex = cpu_to_le16(reg);
	req->wLength = cpu_to_le16(length);

	usb_fill_control_urb(urb, dev->udev,
			     usb_sndctrlpipe(dev->udev, 0),
			     (void *)req, data, length,
			     dm_write_async_callback, req);

	status = usb_submit_urb(urb, GFP_ATOMIC);
	if (status < 0) {
		deverr(dev, "Error submitting the control message: status=%d",
		       status);
		kfree(req);
		usb_free_urb(urb);
	}
}

static void dm_write_async(struct usbnet *dev, u8 reg, u16 length, void *data)
{
	devdbg(dev, "dm_write_async() reg=0x%02x length=%d", reg, length);

	dm_write_async_helper(dev, reg, 0, length, data);
}

static void dm_write_reg_async(struct usbnet *dev, u8 reg, u8 value)
{
	devdbg(dev, "dm_write_reg_async() reg=0x%02x value=0x%02x",
	       reg, value);

	dm_write_async_helper(dev, reg, value, 0, NULL);
}

static int dm_read_shared_word(struct usbnet *dev, int phy, u8 reg, __le16 *value)
{
	int ret, i;

	mutex_lock(&dev->phy_mutex);

	dm_write_reg(dev, DM_SHARED_ADDR, phy ? (reg | 0x40) : reg);
	dm_write_reg(dev, DM_SHARED_CTRL, phy ? 0xc : 0x4);

	for (i = 0; i < DM_TIMEOUT; i++) {
		u8 tmp;

		udelay(1);
		ret = dm_read_reg(dev, DM_SHARED_CTRL, &tmp);
		if (ret < 0)
			goto out;

		/* ready */
		if ((tmp & 1) == 0)
			break;
	}

	if (i == DM_TIMEOUT) {
		deverr(dev, "%s read timed out!", phy ? "phy" : "eeprom");
		ret = -EIO;
		goto out;
	}

	dm_write_reg(dev, DM_SHARED_CTRL, 0x0);
	ret = dm_read(dev, DM_SHARED_DATA, 2, value);

	devdbg(dev, "read shared %d 0x%02x returned 0x%04x, %d",
	       phy, reg, *value, ret);

 out:
	mutex_unlock(&dev->phy_mutex);
	return ret;
}

static int dm_write_shared_word(struct usbnet *dev, int phy, u8 reg, __le16 value)
{
	int ret, i;

	mutex_lock(&dev->phy_mutex);

	ret = dm_write(dev, DM_SHARED_DATA, 2, &value);
	if (ret < 0)
		goto out;

	dm_write_reg(dev, DM_SHARED_ADDR, phy ? (reg | 0x40) : reg);
	dm_write_reg(dev, DM_SHARED_CTRL, phy ? 0x1c : 0x14);

	for (i = 0; i < DM_TIMEOUT; i++) {
		u8 tmp;

		udelay(1);
		ret = dm_read_reg(dev, DM_SHARED_CTRL, &tmp);
		if (ret < 0)
			goto out;

		/* ready */
		if ((tmp & 1) == 0)
			break;
	}

	if (i == DM_TIMEOUT) {
		deverr(dev, "%s write timed out!", phy ? "phy" : "eeprom");
		ret = -EIO;
		goto out;
	}

	dm_write_reg(dev, DM_SHARED_CTRL, 0x0);

out:
	mutex_unlock(&dev->phy_mutex);
	return ret;
}

static int dm_read_eeprom_word(struct usbnet *dev, u8 offset, void *value)
{
	return dm_read_shared_word(dev, 0, offset, value);
}


static int dm9601_get_eeprom_len(struct net_device *dev)
{
	return DM_EEPROM_LEN;
}

static int dm9601_get_eeprom(struct net_device *net,
			     struct ethtool_eeprom *eeprom, u8 * data)
{
	struct usbnet *dev = netdev_priv(net);
	__le16 *ebuf = (__le16 *) data;
	int i;

	/* access is 16bit */
	if ((eeprom->offset % 2) || (eeprom->len % 2))
		return -EINVAL;

	for (i = 0; i < eeprom->len / 2; i++) {
		if (dm_read_eeprom_word(dev, eeprom->offset / 2 + i,
					&ebuf[i]) < 0)
			return -EINVAL;
	}
	return 0;
}

static int dm9601_mdio_read(struct net_device *netdev, int phy_id, int loc)
{
	struct usbnet *dev = netdev_priv(netdev);

	__le16 res;

	if (phy_id) {
		devdbg(dev, "Only internal phy supported");
		return 0;
	}

	dm_read_shared_word(dev, 1, loc, &res);

	devdbg(dev,
	       "dm9601_mdio_read() phy_id=0x%02x, loc=0x%02x, returns=0x%04x",
	       phy_id, loc, le16_to_cpu(res));

	return le16_to_cpu(res);
}

static void dm9601_mdio_write(struct net_device *netdev, int phy_id, int loc,
			      int val)
{
	struct usbnet *dev = netdev_priv(netdev);
	__le16 res = cpu_to_le16(val);

	if (phy_id) {
		devdbg(dev, "Only internal phy supported");
		return;
	}

	devdbg(dev,"dm9601_mdio_write() phy_id=0x%02x, loc=0x%02x, val=0x%04x",
	       phy_id, loc, val);

	dm_write_shared_word(dev, 1, loc, res);
}

static void dm9601_get_drvinfo(struct net_device *net,
			       struct ethtool_drvinfo *info)
{
	/* Inherit standard device info */
	usbnet_get_drvinfo(net, info);
	info->eedump_len = DM_EEPROM_LEN;
}

static u32 dm9601_get_link(struct net_device *net)
{
	struct usbnet *dev = netdev_priv(net);

	return mii_link_ok(&dev->mii);
}

static int dm9601_ioctl(struct net_device *net, struct ifreq *rq, int cmd)
{
	struct usbnet *dev = netdev_priv(net);

	return generic_mii_ioctl(&dev->mii, if_mii(rq), cmd, NULL);
}

static struct ethtool_ops dm9601_ethtool_ops = {
	.get_drvinfo	= dm9601_get_drvinfo,
	.get_link	= dm9601_get_link,
	.get_msglevel	= usbnet_get_msglevel,
	.set_msglevel	= usbnet_set_msglevel,
	.get_eeprom_len	= dm9601_get_eeprom_len,
	.get_eeprom	= dm9601_get_eeprom,
	.get_settings	= usbnet_get_settings,
	.set_settings	= usbnet_set_settings,
	.nway_reset	= usbnet_nway_reset,
};

static void dm9601_set_multicast(struct net_device *net)
{
	struct usbnet *dev = netdev_priv(net);
	/* We use the 20 byte dev->data for our 8 byte filter buffer
	 * to avoid allocating memory that is tricky to free later */
	u8 *hashes = (u8 *) & dev->data;
	u8 rx_ctl = 0x31;

	memset(hashes, 0x00, DM_MCAST_SIZE);
	hashes[DM_MCAST_SIZE - 1] |= 0x80;	/* broadcast address */

	if (net->flags & IFF_PROMISC) {
		rx_ctl |= 0x02;
	} else if (net->flags & IFF_ALLMULTI || net->mc_count > DM_MAX_MCAST) {
		rx_ctl |= 0x04;
	} else if (net->mc_count) {
		struct dev_mc_list *mc_list = net->mc_list;
		int i;

		for (i = 0; i < net->mc_count; i++, mc_list = mc_list->next) {
			u32 crc = ether_crc(ETH_ALEN, mc_list->dmi_addr) >> 26;
			hashes[crc >> 3] |= 1 << (crc & 0x7);
		}
	}

	dm_write_async(dev, DM_MCAST_ADDR, DM_MCAST_SIZE, hashes);
	dm_write_reg_async(dev, DM_RX_CTRL, rx_ctl);
}

static int dm9601_set_mac_address(struct net_device *net, void *p)
{
	struct sockaddr *addr = p;
	struct usbnet *dev = netdev_priv(net);

	if (!is_valid_ether_addr(addr->sa_data))
		return -EINVAL;

	memcpy(net->dev_addr, addr->sa_data, net->addr_len);
	dm_write_async(dev, DM_PHY_ADDR, net->addr_len, net->dev_addr);

	return 0;
}

static int dm9601_bind(struct usbnet *dev, struct usb_interface *intf)
{
	int ret;
	u8 mac[ETH_ALEN];

	ret = usbnet_get_endpoints(dev, intf);
	if (ret)
		goto out;

	dev->net->do_ioctl = dm9601_ioctl;
	dev->net->set_multicast_list = dm9601_set_multicast;
	dev->net->set_mac_address = dm9601_set_mac_address;
	dev->net->ethtool_ops = &dm9601_ethtool_ops;
	dev->net->hard_header_len += DM_TX_OVERHEAD;
	dev->hard_mtu = dev->net->mtu + dev->net->hard_header_len;
	dev->rx_urb_size = dev->net->mtu + ETH_HLEN + DM_RX_OVERHEAD;

	dev->mii.dev = dev->net;
	dev->mii.mdio_read = dm9601_mdio_read;
	dev->mii.mdio_write = dm9601_mdio_write;
	dev->mii.phy_id_mask = 0x1f;
	dev->mii.reg_num_mask = 0x1f;

	/* reset */
	dm_write_reg(dev, DM_NET_CTRL, 1);
	udelay(20);

	/* read MAC */
	if (dm_read(dev, DM_PHY_ADDR, ETH_ALEN, mac) < 0) {
		printk(KERN_ERR "Error reading MAC address\n");
		ret = -ENODEV;
		goto out;
	}

	/*
	 * Overwrite the auto-generated address only with good ones.
	 */
	if (is_valid_ether_addr(mac))
		memcpy(dev->net->dev_addr, mac, ETH_ALEN);

	/* power up phy */
	dm_write_reg(dev, DM_GPR_CTRL, 1);
	dm_write_reg(dev, DM_GPR_DATA, 0);

	/* receive broadcast packets */
	dm9601_set_multicast(dev->net);

	dm9601_mdio_write(dev->net, dev->mii.phy_id, MII_BMCR, BMCR_RESET);
	dm9601_mdio_write(dev->net, dev->mii.phy_id, MII_ADVERTISE,
			  ADVERTISE_ALL | ADVERTISE_CSMA | ADVERTISE_PAUSE_CAP);
	mii_nway_restart(&dev->mii);

out:
	return ret;
}

static int dm9601_rx_fixup(struct usbnet *dev, struct sk_buff *skb)
{
	u8 status;
	int len;

	/* format:
	   b0: rx status
	   b1: packet length (incl crc) low
	   b2: packet length (incl crc) high
	   b3..n-4: packet data
	   bn-3..bn: ethernet crc
	 */

	if (unlikely(skb->len < DM_RX_OVERHEAD)) {
		dev_err(&dev->udev->dev, "unexpected tiny rx frame\n");
		return 0;
	}

	status = skb->data[0];
	len = (skb->data[1] | (skb->data[2] << 8)) - 4;

	if (unlikely(status & 0xbf)) {
		if (status & 0x01) dev->stats.rx_fifo_errors++;
		if (status & 0x02) dev->stats.rx_crc_errors++;
		if (status & 0x04) dev->stats.rx_frame_errors++;
		if (status & 0x20) dev->stats.rx_missed_errors++;
		if (status & 0x90) dev->stats.rx_length_errors++;
		return 0;
	}

	skb_pull(skb, 3);
	skb_trim(skb, len);

	return 1;
}

static struct sk_buff *dm9601_tx_fixup(struct usbnet *dev, struct sk_buff *skb,
				       gfp_t flags)
{
	int len;

	/* format:
	   b0: packet length low
	   b1: packet length high
	   b3..n: packet data
	*/

	len = skb->len;

	if (skb_headroom(skb) < DM_TX_OVERHEAD) {
		struct sk_buff *skb2;

		skb2 = skb_copy_expand(skb, DM_TX_OVERHEAD, 0, flags);
		dev_kfree_skb_any(skb);
		skb = skb2;
		if (!skb)
			return NULL;
	}

	__skb_push(skb, DM_TX_OVERHEAD);

	/* usbnet adds padding if length is a multiple of packet size
	   if so, adjust length value in header */
	if ((skb->len % dev->maxpacket) == 0)
		len++;

	skb->data[0] = len;
	skb->data[1] = len >> 8;

	return skb;
}

static void dm9601_status(struct usbnet *dev, struct urb *urb)
{
	int link;
	u8 *buf;

	/* format:
	   b0: net status
	   b1: tx status 1
	   b2: tx status 2
	   b3: rx status
	   b4: rx overflow
	   b5: rx count
	   b6: tx count
	   b7: gpr
	*/

	if (urb->actual_length < 8)
		return;

	buf = urb->transfer_buffer;

	link = !!(buf[0] & 0x40);
	if (netif_carrier_ok(dev->net) != link) {
		if (link) {
			netif_carrier_on(dev->net);
			usbnet_defer_kevent (dev, EVENT_LINK_RESET);
		}
		else
			netif_carrier_off(dev->net);
		devdbg(dev, "Link Status is: %d", link);
	}
}

static int dm9601_link_reset(struct usbnet *dev)
{
	struct ethtool_cmd ecmd;

	mii_check_media(&dev->mii, 1, 1);
	mii_ethtool_gset(&dev->mii, &ecmd);

	devdbg(dev, "link_reset() speed: %d duplex: %d",
	       ecmd.speed, ecmd.duplex);

	return 0;
}

static const struct driver_info dm9601_info = {
	.description	= "Davicom DM9601 USB Ethernet",
	.flags		= FLAG_ETHER,
	.bind		= dm9601_bind,
	.rx_fixup	= dm9601_rx_fixup,
	.tx_fixup	= dm9601_tx_fixup,
	.status		= dm9601_status,
	.link_reset	= dm9601_link_reset,
	.reset		= dm9601_link_reset,
};

static const struct usb_device_id products[] = {
	{
	 USB_DEVICE(0x07aa, 0x9601),	/* Corega FEther USB-TXC */
	 .driver_info = (unsigned long)&dm9601_info,
	 },
	{
	 USB_DEVICE(0x0a46, 0x9601),	/* Davicom USB-100 */
	 .driver_info = (unsigned long)&dm9601_info,
	 },
	{
	 USB_DEVICE(0x0a46, 0x6688),	/* ZT6688 USB NIC */
	 .driver_info = (unsigned long)&dm9601_info,
	 },
	{
	 USB_DEVICE(0x0a46, 0x0268),	/* ShanTou ST268 USB NIC */
	 .driver_info = (unsigned long)&dm9601_info,
	 },
	{
	 USB_DEVICE(0x0a46, 0x8515),	/* ADMtek ADM8515 USB NIC */
	 .driver_info = (unsigned long)&dm9601_info,
	 },
	{
	USB_DEVICE(0x0a47, 0x9601),	/* Hirose USB-100 */
	.driver_info = (unsigned long)&dm9601_info,
	 },
	{},			// END
};

MODULE_DEVICE_TABLE(usb, products);

static struct usb_driver dm9601_driver = {
	.name = "dm9601",
	.id_table = products,
	.probe = usbnet_probe,
	.disconnect = usbnet_disconnect,
	.suspend = usbnet_suspend,
	.resume = usbnet_resume,
};

static int __init dm9601_init(void)
{
	return usb_register(&dm9601_driver);
}

static void __exit dm9601_exit(void)
{
	usb_deregister(&dm9601_driver);
}

module_init(dm9601_init);
module_exit(dm9601_exit);

MODULE_AUTHOR("Peter Korsgaard <jacmet@sunsite.dk>");
MODULE_DESCRIPTION("Davicom DM9601 USB 1.1 ethernet devices");
MODULE_LICENSE("GPL");
Commit	Line	Data
d0374f4f PK	1	/*
	2	* Davicom DM9601 USB 1.1 10/100Mbps ethernet devices
	3	*
	4	* Peter Korsgaard <jacmet@sunsite.dk>
	5	*
	6	* This file is licensed under the terms of the GNU General Public License
	7	* version 2. This program is licensed "as is" without any warranty of any
	8	* kind, whether express or implied.
	9	*/
	10
	11	//#define DEBUG
	12
	13	#include <linux/module.h>
	14	#include <linux/sched.h>
686149f4	15	#include <linux/stddef.h>
d0374f4f PK	16	#include <linux/init.h>
	17	#include <linux/netdevice.h>
	18	#include <linux/etherdevice.h>
	19	#include <linux/ethtool.h>
	20	#include <linux/mii.h>
	21	#include <linux/usb.h>
	22	#include <linux/crc32.h>
3692e94f	23	#include <linux/usb/usbnet.h>
d0374f4f PK	24
	25	/* datasheet:
	26	http://www.davicom.com.tw/big5/download/Data%20Sheet/DM9601-DS-P01-930914.pdf
	27	*/
	28
	29	/* control requests */
	30	#define DM_READ_REGS 0x00
	31	#define DM_WRITE_REGS 0x01
	32	#define DM_READ_MEMS 0x02
	33	#define DM_WRITE_REG 0x03
	34	#define DM_WRITE_MEMS 0x05
	35	#define DM_WRITE_MEM 0x07
	36
	37	/* registers */
	38	#define DM_NET_CTRL 0x00
	39	#define DM_RX_CTRL 0x05
	40	#define DM_SHARED_CTRL 0x0b
	41	#define DM_SHARED_ADDR 0x0c
	42	#define DM_SHARED_DATA 0x0d /* low + high */
	43	#define DM_PHY_ADDR 0x10 /* 6 bytes */
	44	#define DM_MCAST_ADDR 0x16 /* 8 bytes */
	45	#define DM_GPR_CTRL 0x1e
	46	#define DM_GPR_DATA 0x1f
	47
	48	#define DM_MAX_MCAST 64
	49	#define DM_MCAST_SIZE 8
	50	#define DM_EEPROM_LEN 256
	51	#define DM_TX_OVERHEAD 2 /* 2 byte header */
	52	#define DM_RX_OVERHEAD 7 /* 3 byte header + 4 byte crc tail */
	53	#define DM_TIMEOUT 1000
	54
	55
	56	static int dm_read(struct usbnet dev, u8 reg, u16 length, void data)
	57	{
16d78bc2 PK	58	void *buf;
	59	int err = -ENOMEM;
	60
d0374f4f	61	devdbg(dev, "dm_read() reg=0x%02x length=%d", reg, length);
16d78bc2 PK	62
	63	buf = kmalloc(length, GFP_KERNEL);
	64	if (!buf)
	65	goto out;
	66
	67	err = usb_control_msg(dev->udev,
	68	usb_rcvctrlpipe(dev->udev, 0),
	69	DM_READ_REGS,
	70	USB_DIR_IN \| USB_TYPE_VENDOR \| USB_RECIP_DEVICE,
	71	0, reg, buf, length, USB_CTRL_SET_TIMEOUT);
	72	if (err == length)
	73	memcpy(data, buf, length);
	74	else if (err >= 0)
	75	err = -EINVAL;
	76	kfree(buf);
	77
	78	out:
	79	return err;
d0374f4f PK	80	}
	81
	82	static int dm_read_reg(struct usbnet dev, u8 reg, u8 value)
	83	{
	84	return dm_read(dev, reg, 1, value);
	85	}
	86
	87	static int dm_write(struct usbnet dev, u8 reg, u16 length, void data)
	88	{
16d78bc2 PK	89	void *buf = NULL;
	90	int err = -ENOMEM;
	91
d0374f4f	92	devdbg(dev, "dm_write() reg=0x%02x, length=%d", reg, length);
16d78bc2 PK	93
	94	if (data) {
	95	buf = kmalloc(length, GFP_KERNEL);
	96	if (!buf)
	97	goto out;
	98	memcpy(buf, data, length);
	99	}
	100
	101	err = usb_control_msg(dev->udev,
	102	usb_sndctrlpipe(dev->udev, 0),
	103	DM_WRITE_REGS,
	104	USB_DIR_OUT \| USB_TYPE_VENDOR \|USB_RECIP_DEVICE,
	105	0, reg, buf, length, USB_CTRL_SET_TIMEOUT);
	106	kfree(buf);
	107	if (err >= 0 && err < length)
	108	err = -EINVAL;
	109	out:
	110	return err;
d0374f4f PK	111	}
	112
	113	static int dm_write_reg(struct usbnet *dev, u8 reg, u8 value)
	114	{
	115	devdbg(dev, "dm_write_reg() reg=0x%02x, value=0x%02x", reg, value);
	116	return usb_control_msg(dev->udev,
	117	usb_sndctrlpipe(dev->udev, 0),
	118	DM_WRITE_REG,
	119	USB_DIR_OUT \| USB_TYPE_VENDOR \|USB_RECIP_DEVICE,
686149f4	120	value, reg, NULL, 0, USB_CTRL_SET_TIMEOUT);
d0374f4f PK	121	}
	122
	123	static void dm_write_async_callback(struct urb *urb)
	124	{
	125	struct usb_ctrlrequest req = (struct usb_ctrlrequest )urb->context;
c94cb314	126	int status = urb->status;
d0374f4f	127
c94cb314	128	if (status < 0)
77b69015	129	printk(KERN_DEBUG "dm_write_async_callback() failed with %d\n",
c94cb314	130	status);
d0374f4f PK	131
	132	kfree(req);
	133	usb_free_urb(urb);
	134	}
	135
ba734f34 PK	136	static void dm_write_async_helper(struct usbnet *dev, u8 reg, u8 value,
ba734f34 PK	137	u16 length, void *data)
d0374f4f PK	138	{
	139	struct usb_ctrlrequest *req;
	140	struct urb *urb;
	141	int status;
	142
d0374f4f PK	143	urb = usb_alloc_urb(0, GFP_ATOMIC);
d0374f4f PK	144	if (!urb) {
ba734f34	145	deverr(dev, "Error allocating URB in dm_write_async_helper!");
d0374f4f PK	146	return;
	147	}
	148
	149	req = kmalloc(sizeof(struct usb_ctrlrequest), GFP_ATOMIC);
	150	if (!req) {
	151	deverr(dev, "Failed to allocate memory for control request");
	152	usb_free_urb(urb);
	153	return;
	154	}
	155
	156	req->bRequestType = USB_DIR_OUT \| USB_TYPE_VENDOR \| USB_RECIP_DEVICE;
ba734f34 PK	157	req->bRequest = length ? DM_WRITE_REGS : DM_WRITE_REG;
ba734f34 PK	158	req->wValue = cpu_to_le16(value);
d0374f4f PK	159	req->wIndex = cpu_to_le16(reg);
	160	req->wLength = cpu_to_le16(length);
	161
	162	usb_fill_control_urb(urb, dev->udev,
	163	usb_sndctrlpipe(dev->udev, 0),
	164	(void *)req, data, length,
	165	dm_write_async_callback, req);
	166
	167	status = usb_submit_urb(urb, GFP_ATOMIC);
	168	if (status < 0) {
	169	deverr(dev, "Error submitting the control message: status=%d",
	170	status);
	171	kfree(req);
	172	usb_free_urb(urb);
	173	}
	174	}
	175
ba734f34	176	static void dm_write_async(struct usbnet dev, u8 reg, u16 length, void data)
d0374f4f	177	{
ba734f34	178	devdbg(dev, "dm_write_async() reg=0x%02x length=%d", reg, length);
d0374f4f	179
ba734f34 PK	180	dm_write_async_helper(dev, reg, 0, length, data);
	181	}
	182
	183	static void dm_write_reg_async(struct usbnet *dev, u8 reg, u8 value)
	184	{
d0374f4f PK	185	devdbg(dev, "dm_write_reg_async() reg=0x%02x value=0x%02x",
	186	reg, value);
	187
ba734f34	188	dm_write_async_helper(dev, reg, value, 0, NULL);
d0374f4f PK	189	}
d0374f4f PK	190
eca1ad82	191	static int dm_read_shared_word(struct usbnet dev, int phy, u8 reg, __le16 value)
d0374f4f PK	192	{
	193	int ret, i;
	194
	195	mutex_lock(&dev->phy_mutex);
	196
	197	dm_write_reg(dev, DM_SHARED_ADDR, phy ? (reg \| 0x40) : reg);
	198	dm_write_reg(dev, DM_SHARED_CTRL, phy ? 0xc : 0x4);
	199
	200	for (i = 0; i < DM_TIMEOUT; i++) {
	201	u8 tmp;
	202
	203	udelay(1);
	204	ret = dm_read_reg(dev, DM_SHARED_CTRL, &tmp);
	205	if (ret < 0)
	206	goto out;
	207
	208	/* ready */
	209	if ((tmp & 1) == 0)
	210	break;
	211	}
	212
	213	if (i == DM_TIMEOUT) {
	214	deverr(dev, "%s read timed out!", phy ? "phy" : "eeprom");
	215	ret = -EIO;
	216	goto out;
	217	}
	218
	219	dm_write_reg(dev, DM_SHARED_CTRL, 0x0);
	220	ret = dm_read(dev, DM_SHARED_DATA, 2, value);
	221
	222	devdbg(dev, "read shared %d 0x%02x returned 0x%04x, %d",
	223	phy, reg, *value, ret);
	224
	225	out:
	226	mutex_unlock(&dev->phy_mutex);
	227	return ret;
	228	}
	229
eca1ad82	230	static int dm_write_shared_word(struct usbnet *dev, int phy, u8 reg, __le16 value)
d0374f4f PK	231	{
	232	int ret, i;
	233
	234	mutex_lock(&dev->phy_mutex);
	235
	236	ret = dm_write(dev, DM_SHARED_DATA, 2, &value);
	237	if (ret < 0)
	238	goto out;
	239
	240	dm_write_reg(dev, DM_SHARED_ADDR, phy ? (reg \| 0x40) : reg);
	241	dm_write_reg(dev, DM_SHARED_CTRL, phy ? 0x1c : 0x14);
	242
	243	for (i = 0; i < DM_TIMEOUT; i++) {
	244	u8 tmp;
	245
	246	udelay(1);
	247	ret = dm_read_reg(dev, DM_SHARED_CTRL, &tmp);
	248	if (ret < 0)
	249	goto out;
	250
	251	/* ready */
	252	if ((tmp & 1) == 0)
	253	break;
	254	}
	255
	256	if (i == DM_TIMEOUT) {
	257	deverr(dev, "%s write timed out!", phy ? "phy" : "eeprom");
	258	ret = -EIO;
	259	goto out;
	260	}
	261
	262	dm_write_reg(dev, DM_SHARED_CTRL, 0x0);
	263
	264	out:
	265	mutex_unlock(&dev->phy_mutex);
	266	return ret;
	267	}
	268
	269	static int dm_read_eeprom_word(struct usbnet dev, u8 offset, void value)
	270	{
	271	return dm_read_shared_word(dev, 0, offset, value);
	272	}
	273
	274
	275
	276	static int dm9601_get_eeprom_len(struct net_device *dev)
	277	{
	278	return DM_EEPROM_LEN;
	279	}
	280
	281	static int dm9601_get_eeprom(struct net_device *net,
	282	struct ethtool_eeprom eeprom, u8 data)
	283	{
	284	struct usbnet *dev = netdev_priv(net);
eca1ad82	285	__le16 ebuf = (__le16 ) data;
d0374f4f PK	286	int i;
	287
	288	/* access is 16bit */
	289	if ((eeprom->offset % 2) \|\| (eeprom->len % 2))
	290	return -EINVAL;
	291
	292	for (i = 0; i < eeprom->len / 2; i++) {
	293	if (dm_read_eeprom_word(dev, eeprom->offset / 2 + i,
	294	&ebuf[i]) < 0)
	295	return -EINVAL;
	296	}
	297	return 0;
	298	}
	299
	300	static int dm9601_mdio_read(struct net_device *netdev, int phy_id, int loc)
	301	{
	302	struct usbnet *dev = netdev_priv(netdev);
	303
eca1ad82	304	__le16 res;
d0374f4f PK	305
	306	if (phy_id) {
	307	devdbg(dev, "Only internal phy supported");
	308	return 0;
	309	}
	310
	311	dm_read_shared_word(dev, 1, loc, &res);
	312
	313	devdbg(dev,
	314	"dm9601_mdio_read() phy_id=0x%02x, loc=0x%02x, returns=0x%04x",
	315	phy_id, loc, le16_to_cpu(res));
	316
	317	return le16_to_cpu(res);
	318	}
	319
	320	static void dm9601_mdio_write(struct net_device *netdev, int phy_id, int loc,
	321	int val)
	322	{
	323	struct usbnet *dev = netdev_priv(netdev);
eca1ad82	324	__le16 res = cpu_to_le16(val);
d0374f4f PK	325
	326	if (phy_id) {
	327	devdbg(dev, "Only internal phy supported");
	328	return;
	329	}
	330
	331	devdbg(dev,"dm9601_mdio_write() phy_id=0x%02x, loc=0x%02x, val=0x%04x",
	332	phy_id, loc, val);
	333
	334	dm_write_shared_word(dev, 1, loc, res);
	335	}
	336
	337	static void dm9601_get_drvinfo(struct net_device *net,
	338	struct ethtool_drvinfo *info)
	339	{
	340	/* Inherit standard device info */
	341	usbnet_get_drvinfo(net, info);
	342	info->eedump_len = DM_EEPROM_LEN;
	343	}
	344
	345	static u32 dm9601_get_link(struct net_device *net)
	346	{
	347	struct usbnet *dev = netdev_priv(net);
	348
	349	return mii_link_ok(&dev->mii);
	350	}
	351
	352	static int dm9601_ioctl(struct net_device net, struct ifreq rq, int cmd)
	353	{
	354	struct usbnet *dev = netdev_priv(net);
	355
	356	return generic_mii_ioctl(&dev->mii, if_mii(rq), cmd, NULL);
	357	}
	358
	359	static struct ethtool_ops dm9601_ethtool_ops = {
	360	.get_drvinfo = dm9601_get_drvinfo,
	361	.get_link = dm9601_get_link,
	362	.get_msglevel = usbnet_get_msglevel,
	363	.set_msglevel = usbnet_set_msglevel,
	364	.get_eeprom_len = dm9601_get_eeprom_len,
	365	.get_eeprom = dm9601_get_eeprom,
	366	.get_settings = usbnet_get_settings,
	367	.set_settings = usbnet_set_settings,
	368	.nway_reset = usbnet_nway_reset,
	369	};
	370
	371	static void dm9601_set_multicast(struct net_device *net)
	372	{
	373	struct usbnet *dev = netdev_priv(net);
	374	/* We use the 20 byte dev->data for our 8 byte filter buffer
	375	* to avoid allocating memory that is tricky to free later */
	376	u8 hashes = (u8 ) & dev->data;
33eddedb	377	u8 rx_ctl = 0x31;
d0374f4f PK	378
	379	memset(hashes, 0x00, DM_MCAST_SIZE);
	380	hashes[DM_MCAST_SIZE - 1] \|= 0x80; /* broadcast address */
	381
	382	if (net->flags & IFF_PROMISC) {
	383	rx_ctl \|= 0x02;
	384	} else if (net->flags & IFF_ALLMULTI \|\| net->mc_count > DM_MAX_MCAST) {
	385	rx_ctl \|= 0x04;
	386	} else if (net->mc_count) {
	387	struct dev_mc_list *mc_list = net->mc_list;
	388	int i;
	389
47df976c	390	for (i = 0; i < net->mc_count; i++, mc_list = mc_list->next) {
d0374f4f PK	391	u32 crc = ether_crc(ETH_ALEN, mc_list->dmi_addr) >> 26;
	392	hashes[crc >> 3] \|= 1 << (crc & 0x7);
	393	}
	394	}
	395
	396	dm_write_async(dev, DM_MCAST_ADDR, DM_MCAST_SIZE, hashes);
	397	dm_write_reg_async(dev, DM_RX_CTRL, rx_ctl);
	398	}
	399
753dcfee PK	400	static int dm9601_set_mac_address(struct net_device net, void p)
	401	{
	402	struct sockaddr *addr = p;
	403	struct usbnet *dev = netdev_priv(net);
	404
	405	if (!is_valid_ether_addr(addr->sa_data))
	406	return -EINVAL;
	407
	408	memcpy(net->dev_addr, addr->sa_data, net->addr_len);
	409	dm_write_async(dev, DM_PHY_ADDR, net->addr_len, net->dev_addr);
	410
	411	return 0;
	412	}
	413
d0374f4f PK	414	static int dm9601_bind(struct usbnet dev, struct usb_interface intf)
	415	{
	416	int ret;
20f10aa0	417	u8 mac[ETH_ALEN];
d0374f4f PK	418
	419	ret = usbnet_get_endpoints(dev, intf);
	420	if (ret)
	421	goto out;
	422
	423	dev->net->do_ioctl = dm9601_ioctl;
	424	dev->net->set_multicast_list = dm9601_set_multicast;
753dcfee	425	dev->net->set_mac_address = dm9601_set_mac_address;
d0374f4f PK	426	dev->net->ethtool_ops = &dm9601_ethtool_ops;
	427	dev->net->hard_header_len += DM_TX_OVERHEAD;
	428	dev->hard_mtu = dev->net->mtu + dev->net->hard_header_len;
f662fe5a	429	dev->rx_urb_size = dev->net->mtu + ETH_HLEN + DM_RX_OVERHEAD;
d0374f4f PK	430
	431	dev->mii.dev = dev->net;
	432	dev->mii.mdio_read = dm9601_mdio_read;
	433	dev->mii.mdio_write = dm9601_mdio_write;
	434	dev->mii.phy_id_mask = 0x1f;
	435	dev->mii.reg_num_mask = 0x1f;
	436
	437	/* reset */
b8f59586	438	dm_write_reg(dev, DM_NET_CTRL, 1);
d0374f4f PK	439	udelay(20);
	440
	441	/* read MAC */
20f10aa0	442	if (dm_read(dev, DM_PHY_ADDR, ETH_ALEN, mac) < 0) {
d0374f4f PK	443	printk(KERN_ERR "Error reading MAC address\n");
	444	ret = -ENODEV;
	445	goto out;
	446	}
	447
20f10aa0 WF	448	/*
	449	* Overwrite the auto-generated address only with good ones.
	450	*/
	451	if (is_valid_ether_addr(mac))
	452	memcpy(dev->net->dev_addr, mac, ETH_ALEN);
	453
d0374f4f PK	454	/* power up phy */
	455	dm_write_reg(dev, DM_GPR_CTRL, 1);
	456	dm_write_reg(dev, DM_GPR_DATA, 0);
	457
	458	/* receive broadcast packets */
	459	dm9601_set_multicast(dev->net);
	460
	461	dm9601_mdio_write(dev->net, dev->mii.phy_id, MII_BMCR, BMCR_RESET);
	462	dm9601_mdio_write(dev->net, dev->mii.phy_id, MII_ADVERTISE,
	463	ADVERTISE_ALL \| ADVERTISE_CSMA \| ADVERTISE_PAUSE_CAP);
	464	mii_nway_restart(&dev->mii);
	465
	466	out:
	467	return ret;
	468	}
	469
	470	static int dm9601_rx_fixup(struct usbnet dev, struct sk_buff skb)
	471	{
	472	u8 status;
	473	int len;
	474
	475	/* format:
	476	b0: rx status
	477	b1: packet length (incl crc) low
	478	b2: packet length (incl crc) high
	479	b3..n-4: packet data
	480	bn-3..bn: ethernet crc
	481	*/
	482
	483	if (unlikely(skb->len < DM_RX_OVERHEAD)) {
	484	dev_err(&dev->udev->dev, "unexpected tiny rx frame\n");
	485	return 0;
	486	}
	487
	488	status = skb->data[0];
	489	len = (skb->data[1] \| (skb->data[2] << 8)) - 4;
	490
	491	if (unlikely(status & 0xbf)) {
	492	if (status & 0x01) dev->stats.rx_fifo_errors++;
	493	if (status & 0x02) dev->stats.rx_crc_errors++;
	494	if (status & 0x04) dev->stats.rx_frame_errors++;
	495	if (status & 0x20) dev->stats.rx_missed_errors++;
	496	if (status & 0x90) dev->stats.rx_length_errors++;
	497	return 0;
	498	}
	499
	500	skb_pull(skb, 3);
	501	skb_trim(skb, len);
	502
	503	return 1;
	504	}
	505
	506	static struct sk_buff dm9601_tx_fixup(struct usbnet dev, struct sk_buff *skb,
	507	gfp_t flags)
	508	{
	509	int len;
	510
	511	/* format:
	512	b0: packet length low
	513	b1: packet length high
	514	b3..n: packet data
	515	*/
	516
23de559b PK	517	len = skb->len;
23de559b PK	518
d0374f4f PK	519	if (skb_headroom(skb) < DM_TX_OVERHEAD) {
	520	struct sk_buff *skb2;
	521
	522	skb2 = skb_copy_expand(skb, DM_TX_OVERHEAD, 0, flags);
	523	dev_kfree_skb_any(skb);
	524	skb = skb2;
	525	if (!skb)
	526	return NULL;
	527	}
	528
	529	__skb_push(skb, DM_TX_OVERHEAD);
	530
d0374f4f PK	531	/* usbnet adds padding if length is a multiple of packet size
d0374f4f PK	532	if so, adjust length value in header */
23de559b	533	if ((skb->len % dev->maxpacket) == 0)
d0374f4f PK	534	len++;
	535
	536	skb->data[0] = len;
	537	skb->data[1] = len >> 8;
	538
	539	return skb;
	540	}
	541
	542	static void dm9601_status(struct usbnet dev, struct urb urb)
	543	{
	544	int link;
	545	u8 *buf;
	546
	547	/* format:
	548	b0: net status
	549	b1: tx status 1
	550	b2: tx status 2
	551	b3: rx status
	552	b4: rx overflow
	553	b5: rx count
	554	b6: tx count
	555	b7: gpr
	556	*/
	557
	558	if (urb->actual_length < 8)
	559	return;
	560
	561	buf = urb->transfer_buffer;
	562
	563	link = !!(buf[0] & 0x40);
	564	if (netif_carrier_ok(dev->net) != link) {
	565	if (link) {
	566	netif_carrier_on(dev->net);
	567	usbnet_defer_kevent (dev, EVENT_LINK_RESET);
	568	}
	569	else
	570	netif_carrier_off(dev->net);
	571	devdbg(dev, "Link Status is: %d", link);
	572	}
	573	}
	574
	575	static int dm9601_link_reset(struct usbnet *dev)
	576	{
	577	struct ethtool_cmd ecmd;
	578
	579	mii_check_media(&dev->mii, 1, 1);
	580	mii_ethtool_gset(&dev->mii, &ecmd);
	581
	582	devdbg(dev, "link_reset() speed: %d duplex: %d",
	583	ecmd.speed, ecmd.duplex);
	584
	585	return 0;
	586	}
	587
	588	static const struct driver_info dm9601_info = {
	589	.description = "Davicom DM9601 USB Ethernet",
	590	.flags = FLAG_ETHER,
	591	.bind = dm9601_bind,
	592	.rx_fixup = dm9601_rx_fixup,
	593	.tx_fixup = dm9601_tx_fixup,
	594	.status = dm9601_status,
	595	.link_reset = dm9601_link_reset,
	596	.reset = dm9601_link_reset,
	597	};
598
599	static const struct usb_device_id products[] = {
6438ac26 YH	600	{
	601	USB_DEVICE(0x07aa, 0x9601), /* Corega FEther USB-TXC */
	602	.driver_info = (unsigned long)&dm9601_info,
	603	},
d0374f4f PK	604	{
	605	USB_DEVICE(0x0a46, 0x9601), /* Davicom USB-100 */
	606	.driver_info = (unsigned long)&dm9601_info,
	607	},
6dc477f3 JD	608	{
	609	USB_DEVICE(0x0a46, 0x6688), /* ZT6688 USB NIC */
	610	.driver_info = (unsigned long)&dm9601_info,
	611	},
	612	{
	613	USB_DEVICE(0x0a46, 0x0268), /* ShanTou ST268 USB NIC */
	614	.driver_info = (unsigned long)&dm9601_info,
	615	},
a06da754 PK	616	{
	617	USB_DEVICE(0x0a46, 0x8515), /* ADMtek ADM8515 USB NIC */
	618	.driver_info = (unsigned long)&dm9601_info,
	619	},
b47b4b22 PK	620	{
	621	USB_DEVICE(0x0a47, 0x9601), /* Hirose USB-100 */
	622	.driver_info = (unsigned long)&dm9601_info,
	623	},
d0374f4f PK	624	{}, // END
	625	};
	626
	627	MODULE_DEVICE_TABLE(usb, products);
	628
	629	static struct usb_driver dm9601_driver = {
	630	.name = "dm9601",
	631	.id_table = products,
	632	.probe = usbnet_probe,
	633	.disconnect = usbnet_disconnect,
	634	.suspend = usbnet_suspend,
	635	.resume = usbnet_resume,
	636	};
	637
	638	static int __init dm9601_init(void)
	639	{
	640	return usb_register(&dm9601_driver);
	641	}
	642
	643	static void __exit dm9601_exit(void)
	644	{
	645	usb_deregister(&dm9601_driver);
	646	}
	647
	648	module_init(dm9601_init);
	649	module_exit(dm9601_exit);
	650
	651	MODULE_AUTHOR("Peter Korsgaard <jacmet@sunsite.dk>");
	652	MODULE_DESCRIPTION("Davicom DM9601 USB 1.1 ethernet devices");
	653	MODULE_LICENSE("GPL");