[GitHub/mt8127/android_kernel_alcatel_ttab.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>
#include <linux/slab.h>

/* datasheet:
 http://ptm2.cc.utu.fi/ftp/network/cards/DM9601/From_NET/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_CHIP_ID	0x2c
#define DM_MODE_CTRL	0x91	/* only on dm9620 */

/* chip id values */
#define ID_DM9601	0
#define ID_DM9620	1

#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)
{
	int err;
	err = usbnet_read_cmd(dev, DM_READ_REGS,
			       USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
			       0, reg, data, length);
	if(err != length && err >= 0)
		err = -EINVAL;
	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)
{
	int err;
	err = usbnet_write_cmd(dev, DM_WRITE_REGS,
				USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
				0, reg, data, length);

	if (err >= 0 && err < length)
		err = -EINVAL;
	return err;
}

static int dm_write_reg(struct usbnet *dev, u8 reg, u8 value)
{
	return usbnet_write_cmd(dev, DM_WRITE_REG,
				USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
				value, reg, NULL, 0);
}

static void dm_write_async(struct usbnet *dev, u8 reg, u16 length, void *data)
{
	usbnet_write_cmd_async(dev, DM_WRITE_REGS,
			       USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
			       0, reg, data, length);
}

static void dm_write_reg_async(struct usbnet *dev, u8 reg, u8 value)
{
	usbnet_write_cmd_async(dev, DM_WRITE_REG,
			       USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
			       value, reg, NULL, 0);
}

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 = 0;

		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) {
		netdev_err(dev->net, "%s read timed out!\n", phy ? "phy" : "eeprom");
		ret = -EIO;
		goto out;
	}

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

	netdev_dbg(dev->net, "read shared %d 0x%02x returned 0x%04x, %d\n",
		   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 ? 0x1a : 0x12);

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

		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) {
		netdev_err(dev->net, "%s write timed out!\n", 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) {
		netdev_dbg(dev->net, "Only internal phy supported\n");
		return 0;
	}

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

	netdev_dbg(dev->net,
		   "dm9601_mdio_read() phy_id=0x%02x, loc=0x%02x, returns=0x%04x\n",
		   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) {
		netdev_dbg(dev->net, "Only internal phy supported\n");
		return;
	}

	netdev_dbg(dev->net, "dm9601_mdio_write() phy_id=0x%02x, loc=0x%02x, val=0x%04x\n",
		   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 const 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 ||
		   netdev_mc_count(net) > DM_MAX_MCAST) {
		rx_ctl |= 0x08;
	} else if (!netdev_mc_empty(net)) {
		struct netdev_hw_addr *ha;

		netdev_for_each_mc_addr(ha, net) {
			u32 crc = ether_crc(ETH_ALEN, ha->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 void __dm9601_set_mac_address(struct usbnet *dev)
{
	dm_write_async(dev, DM_PHY_ADDR, ETH_ALEN, dev->net->dev_addr);
}

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)) {
		dev_err(&net->dev, "not setting invalid mac address %pM\n",
								addr->sa_data);
		return -EINVAL;
	}

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

	return 0;
}

static const struct net_device_ops dm9601_netdev_ops = {
	.ndo_open		= usbnet_open,
	.ndo_stop		= usbnet_stop,
	.ndo_start_xmit		= usbnet_start_xmit,
	.ndo_tx_timeout		= usbnet_tx_timeout,
	.ndo_change_mtu		= usbnet_change_mtu,
	.ndo_validate_addr	= eth_validate_addr,
	.ndo_do_ioctl 		= dm9601_ioctl,
	.ndo_set_rx_mode	= dm9601_set_multicast,
	.ndo_set_mac_address	= dm9601_set_mac_address,
};

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

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

	dev->net->netdev_ops = &dm9601_netdev_ops;
	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;

	/* dm9620/21a require room for 4 byte padding, even in dm9601
	 * mode, so we need +1 to be able to receive full size
	 * ethernet frames.
	 */
	dev->rx_urb_size = dev->net->mtu + ETH_HLEN + DM_RX_OVERHEAD + 1;

	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);
	else {
		printk(KERN_WARNING
			"dm9601: No valid MAC address in EEPROM, using %pM\n",
			dev->net->dev_addr);
		__dm9601_set_mac_address(dev);
	}

	if (dm_read_reg(dev, DM_CHIP_ID, &id) < 0) {
		netdev_err(dev->net, "Error reading chip ID\n");
		ret = -ENODEV;
		goto out;
	}

	/* put dm9620 devices in dm9601 mode */
	if (id == ID_DM9620) {
		u8 mode;

		if (dm_read_reg(dev, DM_MODE_CTRL, &mode) < 0) {
			netdev_err(dev->net, "Error reading MODE_CTRL\n");
			ret = -ENODEV;
			goto out;
		}
		dm_write_reg(dev, DM_MODE_CTRL, mode & 0x7f);
	}

	/* 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:
	   b1: rx status
	   b2: packet length (incl crc) low
	   b3: packet length (incl crc) high
	   b4..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->net->stats.rx_fifo_errors++;
		if (status & 0x02) dev->net->stats.rx_crc_errors++;
		if (status & 0x04) dev->net->stats.rx_frame_errors++;
		if (status & 0x20) dev->net->stats.rx_missed_errors++;
		if (status & 0x90) dev->net->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, pad;

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

	len = skb->len + DM_TX_OVERHEAD;

	/* workaround for dm962x errata with tx fifo getting out of
	 * sync if a USB bulk transfer retry happens right after a
	 * packet with odd / maxpacket length by adding up to 3 bytes
	 * padding.
	 */
	while ((len & 1) || !(len % dev->maxpacket))
		len++;

	len -= DM_TX_OVERHEAD; /* hw header doesn't count as part of length */
	pad = len - skb->len;

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

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

	__skb_push(skb, DM_TX_OVERHEAD);

	if (pad) {
		memset(skb->data + skb->len, 0, pad);
		__skb_put(skb, pad);
	}

	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) {
		usbnet_link_change(dev, link, 1);
		netdev_dbg(dev->net, "Link Status is: %d\n", link);
	}
}

static int dm9601_link_reset(struct usbnet *dev)
{
	struct ethtool_cmd ecmd = { .cmd = ETHTOOL_GSET };

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

	netdev_dbg(dev->net, "link_reset() speed: %u duplex: %d\n",
		   ethtool_cmd_speed(&ecmd), ecmd.duplex);

	return 0;
}

static const struct driver_info dm9601_info = {
	.description	= "Davicom DM9601 USB Ethernet",
	.flags		= FLAG_ETHER | FLAG_LINK_INTR,
	.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,
	 },
	{
	USB_DEVICE(0x0fe6, 0x8101),	/* DM9601 USB to Fast Ethernet Adapter */
	.driver_info = (unsigned long)&dm9601_info,
	 },
	{
	 USB_DEVICE(0x0fe6, 0x9700),	/* DM9601 USB to Fast Ethernet Adapter */
	 .driver_info = (unsigned long)&dm9601_info,
	 },
	{
	 USB_DEVICE(0x0a46, 0x9000),	/* DM9000E */
	 .driver_info = (unsigned long)&dm9601_info,
	 },
	{
	 USB_DEVICE(0x0a46, 0x9620),	/* DM9620 USB to Fast Ethernet Adapter */
	 .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,
	.disable_hub_initiated_lpm = 1,
};

module_usb_driver(dm9601_driver);

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>
5a0e3ad6	24	#include <linux/slab.h>
d0374f4f PK	25
d0374f4f PK	26	/* datasheet:
98658bc9	27	http://ptm2.cc.utu.fi/ftp/network/cards/DM9601/From_NET/DM9601-DS-P01-930914.pdf
d0374f4f PK	28	*/
	29
	30	/* control requests */
	31	#define DM_READ_REGS 0x00
	32	#define DM_WRITE_REGS 0x01
	33	#define DM_READ_MEMS 0x02
	34	#define DM_WRITE_REG 0x03
	35	#define DM_WRITE_MEMS 0x05
	36	#define DM_WRITE_MEM 0x07
	37
	38	/* registers */
	39	#define DM_NET_CTRL 0x00
	40	#define DM_RX_CTRL 0x05
	41	#define DM_SHARED_CTRL 0x0b
	42	#define DM_SHARED_ADDR 0x0c
	43	#define DM_SHARED_DATA 0x0d /* low + high */
	44	#define DM_PHY_ADDR 0x10 /* 6 bytes */
	45	#define DM_MCAST_ADDR 0x16 /* 8 bytes */
	46	#define DM_GPR_CTRL 0x1e
	47	#define DM_GPR_DATA 0x1f
6642f91c PK	48	#define DM_CHIP_ID 0x2c
	49	#define DM_MODE_CTRL 0x91 /* only on dm9620 */
	50
	51	/* chip id values */
	52	#define ID_DM9601 0
	53	#define ID_DM9620 1
d0374f4f PK	54
	55	#define DM_MAX_MCAST 64
	56	#define DM_MCAST_SIZE 8
	57	#define DM_EEPROM_LEN 256
	58	#define DM_TX_OVERHEAD 2 /* 2 byte header */
	59	#define DM_RX_OVERHEAD 7 /* 3 byte header + 4 byte crc tail */
	60	#define DM_TIMEOUT 1000
	61
d0374f4f PK	62	static int dm_read(struct usbnet dev, u8 reg, u16 length, void data)
d0374f4f PK	63	{
24b1042c ML	64	int err;
	65	err = usbnet_read_cmd(dev, DM_READ_REGS,
	66	USB_DIR_IN \| USB_TYPE_VENDOR \| USB_RECIP_DEVICE,
	67	0, reg, data, length);
	68	if(err != length && err >= 0)
16d78bc2	69	err = -EINVAL;
16d78bc2	70	return err;
d0374f4f PK	71	}
	72
	73	static int dm_read_reg(struct usbnet dev, u8 reg, u8 value)
	74	{
	75	return dm_read(dev, reg, 1, value);
	76	}
	77
	78	static int dm_write(struct usbnet dev, u8 reg, u16 length, void data)
	79	{
24b1042c ML	80	int err;
	81	err = usbnet_write_cmd(dev, DM_WRITE_REGS,
	82	USB_DIR_OUT \| USB_TYPE_VENDOR \| USB_RECIP_DEVICE,
	83	0, reg, data, length);
	84
16d78bc2 PK	85	if (err >= 0 && err < length)
16d78bc2 PK	86	err = -EINVAL;
16d78bc2	87	return err;
d0374f4f PK	88	}
	89
	90	static int dm_write_reg(struct usbnet *dev, u8 reg, u8 value)
	91	{
1b9c3a1b	92	return usbnet_write_cmd(dev, DM_WRITE_REG,
24b1042c ML	93	USB_DIR_OUT \| USB_TYPE_VENDOR \| USB_RECIP_DEVICE,
24b1042c ML	94	value, reg, NULL, 0);
d0374f4f PK	95	}
d0374f4f PK	96
1b9c3a1b	97	static void dm_write_async(struct usbnet dev, u8 reg, u16 length, void data)
d0374f4f	98	{
24b1042c ML	99	usbnet_write_cmd_async(dev, DM_WRITE_REGS,
24b1042c ML	100	USB_DIR_OUT \| USB_TYPE_VENDOR \| USB_RECIP_DEVICE,
1b9c3a1b	101	0, reg, data, length);
ba734f34 PK	102	}
	103
	104	static void dm_write_reg_async(struct usbnet *dev, u8 reg, u8 value)
	105	{
1b9c3a1b TB	106	usbnet_write_cmd_async(dev, DM_WRITE_REG,
	107	USB_DIR_OUT \| USB_TYPE_VENDOR \| USB_RECIP_DEVICE,
	108	value, reg, NULL, 0);
d0374f4f PK	109	}
d0374f4f PK	110
eca1ad82	111	static int dm_read_shared_word(struct usbnet dev, int phy, u8 reg, __le16 value)
d0374f4f PK	112	{
	113	int ret, i;
	114
	115	mutex_lock(&dev->phy_mutex);
	116
	117	dm_write_reg(dev, DM_SHARED_ADDR, phy ? (reg \| 0x40) : reg);
	118	dm_write_reg(dev, DM_SHARED_CTRL, phy ? 0xc : 0x4);
	119
	120	for (i = 0; i < DM_TIMEOUT; i++) {
15c8bb12	121	u8 tmp = 0;
d0374f4f PK	122
	123	udelay(1);
	124	ret = dm_read_reg(dev, DM_SHARED_CTRL, &tmp);
	125	if (ret < 0)
	126	goto out;
	127
	128	/* ready */
	129	if ((tmp & 1) == 0)
	130	break;
	131	}
	132
	133	if (i == DM_TIMEOUT) {
60b86755	134	netdev_err(dev->net, "%s read timed out!\n", phy ? "phy" : "eeprom");
d0374f4f PK	135	ret = -EIO;
	136	goto out;
	137	}
	138
	139	dm_write_reg(dev, DM_SHARED_CTRL, 0x0);
	140	ret = dm_read(dev, DM_SHARED_DATA, 2, value);
	141
60b86755 JP	142	netdev_dbg(dev->net, "read shared %d 0x%02x returned 0x%04x, %d\n",
60b86755 JP	143	phy, reg, *value, ret);
d0374f4f PK	144
	145	out:
	146	mutex_unlock(&dev->phy_mutex);
	147	return ret;
	148	}
	149
eca1ad82	150	static int dm_write_shared_word(struct usbnet *dev, int phy, u8 reg, __le16 value)
d0374f4f PK	151	{
	152	int ret, i;
	153
	154	mutex_lock(&dev->phy_mutex);
	155
	156	ret = dm_write(dev, DM_SHARED_DATA, 2, &value);
	157	if (ret < 0)
	158	goto out;
	159
	160	dm_write_reg(dev, DM_SHARED_ADDR, phy ? (reg \| 0x40) : reg);
e9162ab1	161	dm_write_reg(dev, DM_SHARED_CTRL, phy ? 0x1a : 0x12);
d0374f4f PK	162
d0374f4f PK	163	for (i = 0; i < DM_TIMEOUT; i++) {
15c8bb12	164	u8 tmp = 0;
d0374f4f PK	165
	166	udelay(1);
	167	ret = dm_read_reg(dev, DM_SHARED_CTRL, &tmp);
	168	if (ret < 0)
	169	goto out;
	170
	171	/* ready */
	172	if ((tmp & 1) == 0)
	173	break;
	174	}
	175
	176	if (i == DM_TIMEOUT) {
60b86755	177	netdev_err(dev->net, "%s write timed out!\n", phy ? "phy" : "eeprom");
d0374f4f PK	178	ret = -EIO;
	179	goto out;
	180	}
	181
	182	dm_write_reg(dev, DM_SHARED_CTRL, 0x0);
	183
	184	out:
	185	mutex_unlock(&dev->phy_mutex);
	186	return ret;
	187	}
	188
	189	static int dm_read_eeprom_word(struct usbnet dev, u8 offset, void value)
	190	{
	191	return dm_read_shared_word(dev, 0, offset, value);
	192	}
	193
	194
	195
	196	static int dm9601_get_eeprom_len(struct net_device *dev)
	197	{
	198	return DM_EEPROM_LEN;
	199	}
	200
	201	static int dm9601_get_eeprom(struct net_device *net,
	202	struct ethtool_eeprom eeprom, u8 data)
	203	{
	204	struct usbnet *dev = netdev_priv(net);
eca1ad82	205	__le16 ebuf = (__le16 ) data;
d0374f4f PK	206	int i;
	207
	208	/* access is 16bit */
	209	if ((eeprom->offset % 2) \|\| (eeprom->len % 2))
	210	return -EINVAL;
	211
	212	for (i = 0; i < eeprom->len / 2; i++) {
	213	if (dm_read_eeprom_word(dev, eeprom->offset / 2 + i,
	214	&ebuf[i]) < 0)
	215	return -EINVAL;
	216	}
	217	return 0;
	218	}
	219
	220	static int dm9601_mdio_read(struct net_device *netdev, int phy_id, int loc)
	221	{
	222	struct usbnet *dev = netdev_priv(netdev);
	223
eca1ad82	224	__le16 res;
d0374f4f PK	225
d0374f4f PK	226	if (phy_id) {
60b86755	227	netdev_dbg(dev->net, "Only internal phy supported\n");
d0374f4f PK	228	return 0;
	229	}
	230
	231	dm_read_shared_word(dev, 1, loc, &res);
	232
60b86755 JP	233	netdev_dbg(dev->net,
	234	"dm9601_mdio_read() phy_id=0x%02x, loc=0x%02x, returns=0x%04x\n",
	235	phy_id, loc, le16_to_cpu(res));
d0374f4f PK	236
	237	return le16_to_cpu(res);
	238	}
	239
	240	static void dm9601_mdio_write(struct net_device *netdev, int phy_id, int loc,
	241	int val)
	242	{
	243	struct usbnet *dev = netdev_priv(netdev);
eca1ad82	244	__le16 res = cpu_to_le16(val);
d0374f4f PK	245
d0374f4f PK	246	if (phy_id) {
60b86755	247	netdev_dbg(dev->net, "Only internal phy supported\n");
d0374f4f PK	248	return;
	249	}
	250
60b86755 JP	251	netdev_dbg(dev->net, "dm9601_mdio_write() phy_id=0x%02x, loc=0x%02x, val=0x%04x\n",
60b86755 JP	252	phy_id, loc, val);
d0374f4f PK	253
	254	dm_write_shared_word(dev, 1, loc, res);
	255	}
	256
	257	static void dm9601_get_drvinfo(struct net_device *net,
	258	struct ethtool_drvinfo *info)
	259	{
	260	/* Inherit standard device info */
	261	usbnet_get_drvinfo(net, info);
	262	info->eedump_len = DM_EEPROM_LEN;
	263	}
	264
	265	static u32 dm9601_get_link(struct net_device *net)
	266	{
	267	struct usbnet *dev = netdev_priv(net);
	268
	269	return mii_link_ok(&dev->mii);
	270	}
	271
	272	static int dm9601_ioctl(struct net_device net, struct ifreq rq, int cmd)
	273	{
	274	struct usbnet *dev = netdev_priv(net);
	275
	276	return generic_mii_ioctl(&dev->mii, if_mii(rq), cmd, NULL);
	277	}
	278
0fc0b732	279	static const struct ethtool_ops dm9601_ethtool_ops = {
d0374f4f PK	280	.get_drvinfo = dm9601_get_drvinfo,
	281	.get_link = dm9601_get_link,
	282	.get_msglevel = usbnet_get_msglevel,
	283	.set_msglevel = usbnet_set_msglevel,
	284	.get_eeprom_len = dm9601_get_eeprom_len,
	285	.get_eeprom = dm9601_get_eeprom,
	286	.get_settings = usbnet_get_settings,
	287	.set_settings = usbnet_set_settings,
	288	.nway_reset = usbnet_nway_reset,
	289	};
	290
	291	static void dm9601_set_multicast(struct net_device *net)
	292	{
	293	struct usbnet *dev = netdev_priv(net);
	294	/* We use the 20 byte dev->data for our 8 byte filter buffer
	295	* to avoid allocating memory that is tricky to free later */
	296	u8 hashes = (u8 ) & dev->data;
33eddedb	297	u8 rx_ctl = 0x31;
d0374f4f PK	298
	299	memset(hashes, 0x00, DM_MCAST_SIZE);
	300	hashes[DM_MCAST_SIZE - 1] \|= 0x80; /* broadcast address */
	301
	302	if (net->flags & IFF_PROMISC) {
	303	rx_ctl \|= 0x02;
2cc04d27 JP	304	} else if (net->flags & IFF_ALLMULTI \|\|
2cc04d27 JP	305	netdev_mc_count(net) > DM_MAX_MCAST) {
f17c9815	306	rx_ctl \|= 0x08;
2cc04d27	307	} else if (!netdev_mc_empty(net)) {
22bedad3	308	struct netdev_hw_addr *ha;
d0374f4f	309
22bedad3 JP	310	netdev_for_each_mc_addr(ha, net) {
22bedad3 JP	311	u32 crc = ether_crc(ETH_ALEN, ha->addr) >> 26;
d0374f4f PK	312	hashes[crc >> 3] \|= 1 << (crc & 0x7);
	313	}
	314	}
	315
	316	dm_write_async(dev, DM_MCAST_ADDR, DM_MCAST_SIZE, hashes);
	317	dm_write_reg_async(dev, DM_RX_CTRL, rx_ctl);
	318	}
	319
4b9f8ec6 WF	320	static void __dm9601_set_mac_address(struct usbnet *dev)
	321	{
	322	dm_write_async(dev, DM_PHY_ADDR, ETH_ALEN, dev->net->dev_addr);
	323	}
	324
753dcfee PK	325	static int dm9601_set_mac_address(struct net_device net, void p)
	326	{
	327	struct sockaddr *addr = p;
	328	struct usbnet *dev = netdev_priv(net);
	329
f52deb0e WF	330	if (!is_valid_ether_addr(addr->sa_data)) {
	331	dev_err(&net->dev, "not setting invalid mac address %pM\n",
	332	addr->sa_data);
753dcfee	333	return -EINVAL;
f52deb0e	334	}
753dcfee PK	335
753dcfee PK	336	memcpy(net->dev_addr, addr->sa_data, net->addr_len);
4b9f8ec6	337	__dm9601_set_mac_address(dev);
753dcfee PK	338
	339	return 0;
	340	}
	341
fe85ff82 SH	342	static const struct net_device_ops dm9601_netdev_ops = {
	343	.ndo_open = usbnet_open,
	344	.ndo_stop = usbnet_stop,
	345	.ndo_start_xmit = usbnet_start_xmit,
	346	.ndo_tx_timeout = usbnet_tx_timeout,
	347	.ndo_change_mtu = usbnet_change_mtu,
	348	.ndo_validate_addr = eth_validate_addr,
	349	.ndo_do_ioctl = dm9601_ioctl,
afc4b13d	350	.ndo_set_rx_mode = dm9601_set_multicast,
fe85ff82 SH	351	.ndo_set_mac_address = dm9601_set_mac_address,
	352	};
	353
d0374f4f PK	354	static int dm9601_bind(struct usbnet dev, struct usb_interface intf)
	355	{
	356	int ret;
6642f91c	357	u8 mac[ETH_ALEN], id;
d0374f4f PK	358
	359	ret = usbnet_get_endpoints(dev, intf);
	360	if (ret)
	361	goto out;
	362
fe85ff82	363	dev->net->netdev_ops = &dm9601_netdev_ops;
d0374f4f PK	364	dev->net->ethtool_ops = &dm9601_ethtool_ops;
	365	dev->net->hard_header_len += DM_TX_OVERHEAD;
	366	dev->hard_mtu = dev->net->mtu + dev->net->hard_header_len;
1552c3d8 PK	367
	368	/* dm9620/21a require room for 4 byte padding, even in dm9601
	369	* mode, so we need +1 to be able to receive full size
	370	* ethernet frames.
	371	*/
	372	dev->rx_urb_size = dev->net->mtu + ETH_HLEN + DM_RX_OVERHEAD + 1;
d0374f4f PK	373
	374	dev->mii.dev = dev->net;
	375	dev->mii.mdio_read = dm9601_mdio_read;
	376	dev->mii.mdio_write = dm9601_mdio_write;
	377	dev->mii.phy_id_mask = 0x1f;
	378	dev->mii.reg_num_mask = 0x1f;
	379
	380	/* reset */
b8f59586	381	dm_write_reg(dev, DM_NET_CTRL, 1);
d0374f4f PK	382	udelay(20);
	383
	384	/* read MAC */
20f10aa0	385	if (dm_read(dev, DM_PHY_ADDR, ETH_ALEN, mac) < 0) {
d0374f4f PK	386	printk(KERN_ERR "Error reading MAC address\n");
	387	ret = -ENODEV;
	388	goto out;
	389	}
	390
20f10aa0 WF	391	/*
	392	* Overwrite the auto-generated address only with good ones.
	393	*/
	394	if (is_valid_ether_addr(mac))
	395	memcpy(dev->net->dev_addr, mac, ETH_ALEN);
f52deb0e WF	396	else {
	397	printk(KERN_WARNING
	398	"dm9601: No valid MAC address in EEPROM, using %pM\n",
	399	dev->net->dev_addr);
4b9f8ec6	400	__dm9601_set_mac_address(dev);
f52deb0e	401	}
20f10aa0	402
6642f91c PK	403	if (dm_read_reg(dev, DM_CHIP_ID, &id) < 0) {
	404	netdev_err(dev->net, "Error reading chip ID\n");
	405	ret = -ENODEV;
	406	goto out;
	407	}
	408
	409	/* put dm9620 devices in dm9601 mode */
	410	if (id == ID_DM9620) {
	411	u8 mode;
	412
	413	if (dm_read_reg(dev, DM_MODE_CTRL, &mode) < 0) {
	414	netdev_err(dev->net, "Error reading MODE_CTRL\n");
	415	ret = -ENODEV;
	416	goto out;
	417	}
	418	dm_write_reg(dev, DM_MODE_CTRL, mode & 0x7f);
	419	}
	420
d0374f4f PK	421	/* power up phy */
	422	dm_write_reg(dev, DM_GPR_CTRL, 1);
	423	dm_write_reg(dev, DM_GPR_DATA, 0);
	424
	425	/* receive broadcast packets */
	426	dm9601_set_multicast(dev->net);
	427
	428	dm9601_mdio_write(dev->net, dev->mii.phy_id, MII_BMCR, BMCR_RESET);
	429	dm9601_mdio_write(dev->net, dev->mii.phy_id, MII_ADVERTISE,
	430	ADVERTISE_ALL \| ADVERTISE_CSMA \| ADVERTISE_PAUSE_CAP);
	431	mii_nway_restart(&dev->mii);
	432
	433	out:
	434	return ret;
	435	}
	436
	437	static int dm9601_rx_fixup(struct usbnet dev, struct sk_buff skb)
	438	{
	439	u8 status;
	440	int len;
	441
	442	/* format:
61189c78 PK	443	b1: rx status
	444	b2: packet length (incl crc) low
	445	b3: packet length (incl crc) high
	446	b4..n-4: packet data
d0374f4f PK	447	bn-3..bn: ethernet crc
	448	*/
	449
	450	if (unlikely(skb->len < DM_RX_OVERHEAD)) {
	451	dev_err(&dev->udev->dev, "unexpected tiny rx frame\n");
	452	return 0;
	453	}
	454
	455	status = skb->data[0];
	456	len = (skb->data[1] \| (skb->data[2] << 8)) - 4;
	457
	458	if (unlikely(status & 0xbf)) {
9612101c HX	459	if (status & 0x01) dev->net->stats.rx_fifo_errors++;
	460	if (status & 0x02) dev->net->stats.rx_crc_errors++;
	461	if (status & 0x04) dev->net->stats.rx_frame_errors++;
	462	if (status & 0x20) dev->net->stats.rx_missed_errors++;
	463	if (status & 0x90) dev->net->stats.rx_length_errors++;
d0374f4f PK	464	return 0;
	465	}
	466
	467	skb_pull(skb, 3);
	468	skb_trim(skb, len);
	469
	470	return 1;
	471	}
	472
	473	static struct sk_buff dm9601_tx_fixup(struct usbnet dev, struct sk_buff *skb,
	474	gfp_t flags)
	475	{
5fd93067	476	int len, pad;
d0374f4f PK	477
d0374f4f PK	478	/* format:
61189c78 PK	479	b1: packet length low
61189c78 PK	480	b2: packet length high
d0374f4f PK	481	b3..n: packet data
	482	*/
	483
5fd93067 PK	484	len = skb->len + DM_TX_OVERHEAD;
	485
	486	/* workaround for dm962x errata with tx fifo getting out of
	487	* sync if a USB bulk transfer retry happens right after a
	488	* packet with odd / maxpacket length by adding up to 3 bytes
	489	* padding.
	490	*/
	491	while ((len & 1) \|\| !(len % dev->maxpacket))
	492	len++;
23de559b	493
5fd93067 PK	494	len -= DM_TX_OVERHEAD; /* hw header doesn't count as part of length */
	495	pad = len - skb->len;
	496
	497	if (skb_headroom(skb) < DM_TX_OVERHEAD \|\| skb_tailroom(skb) < pad) {
d0374f4f PK	498	struct sk_buff *skb2;
d0374f4f PK	499
5fd93067	500	skb2 = skb_copy_expand(skb, DM_TX_OVERHEAD, pad, flags);
d0374f4f PK	501	dev_kfree_skb_any(skb);
	502	skb = skb2;
	503	if (!skb)
	504	return NULL;
	505	}
	506
	507	__skb_push(skb, DM_TX_OVERHEAD);
	508
5fd93067 PK	509	if (pad) {
	510	memset(skb->data + skb->len, 0, pad);
	511	__skb_put(skb, pad);
	512	}
d0374f4f PK	513
	514	skb->data[0] = len;
	515	skb->data[1] = len >> 8;
	516
	517	return skb;
	518	}
	519
	520	static void dm9601_status(struct usbnet dev, struct urb urb)
	521	{
	522	int link;
	523	u8 *buf;
	524
	525	/* format:
	526	b0: net status
	527	b1: tx status 1
	528	b2: tx status 2
	529	b3: rx status
	530	b4: rx overflow
	531	b5: rx count
	532	b6: tx count
	533	b7: gpr
	534	*/
	535
	536	if (urb->actual_length < 8)
	537	return;
	538
	539	buf = urb->transfer_buffer;
	540
	541	link = !!(buf[0] & 0x40);
	542	if (netif_carrier_ok(dev->net) != link) {
c10b1710	543	usbnet_link_change(dev, link, 1);
60b86755	544	netdev_dbg(dev->net, "Link Status is: %d\n", link);
d0374f4f PK	545	}
	546	}
	547
	548	static int dm9601_link_reset(struct usbnet *dev)
	549	{
8ae6daca	550	struct ethtool_cmd ecmd = { .cmd = ETHTOOL_GSET };
d0374f4f PK	551
	552	mii_check_media(&dev->mii, 1, 1);
	553	mii_ethtool_gset(&dev->mii, &ecmd);
	554
8ae6daca DD	555	netdev_dbg(dev->net, "link_reset() speed: %u duplex: %d\n",
8ae6daca DD	556	ethtool_cmd_speed(&ecmd), ecmd.duplex);
d0374f4f PK	557
	558	return 0;
	559	}
	560
	561	static const struct driver_info dm9601_info = {
	562	.description = "Davicom DM9601 USB Ethernet",
37e8273c	563	.flags = FLAG_ETHER \| FLAG_LINK_INTR,
d0374f4f PK	564	.bind = dm9601_bind,
	565	.rx_fixup = dm9601_rx_fixup,
	566	.tx_fixup = dm9601_tx_fixup,
	567	.status = dm9601_status,
	568	.link_reset = dm9601_link_reset,
	569	.reset = dm9601_link_reset,
	570	};
	571
	572	static const struct usb_device_id products[] = {
6438ac26 YH	573	{
	574	USB_DEVICE(0x07aa, 0x9601), /* Corega FEther USB-TXC */
	575	.driver_info = (unsigned long)&dm9601_info,
	576	},
d0374f4f PK	577	{
	578	USB_DEVICE(0x0a46, 0x9601), /* Davicom USB-100 */
	579	.driver_info = (unsigned long)&dm9601_info,
	580	},
6dc477f3 JD	581	{
	582	USB_DEVICE(0x0a46, 0x6688), /* ZT6688 USB NIC */
	583	.driver_info = (unsigned long)&dm9601_info,
	584	},
	585	{
	586	USB_DEVICE(0x0a46, 0x0268), /* ShanTou ST268 USB NIC */
	587	.driver_info = (unsigned long)&dm9601_info,
	588	},
a06da754 PK	589	{
	590	USB_DEVICE(0x0a46, 0x8515), /* ADMtek ADM8515 USB NIC */
	591	.driver_info = (unsigned long)&dm9601_info,
	592	},
b47b4b22 PK	593	{
b47b4b22 PK	594	USB_DEVICE(0x0a47, 0x9601), /* Hirose USB-100 */
a1a69c8d PK	595	.driver_info = (unsigned long)&dm9601_info,
	596	},
	597	{
	598	USB_DEVICE(0x0fe6, 0x8101), /* DM9601 USB to Fast Ethernet Adapter */
b47b4b22 PK	599	.driver_info = (unsigned long)&dm9601_info,
b47b4b22 PK	600	},
67158ceb SH	601	{
	602	USB_DEVICE(0x0fe6, 0x9700), /* DM9601 USB to Fast Ethernet Adapter */
	603	.driver_info = (unsigned long)&dm9601_info,
	604	},
06b71b65 JK	605	{
	606	USB_DEVICE(0x0a46, 0x9000), /* DM9000E */
	607	.driver_info = (unsigned long)&dm9601_info,
	608	},
6642f91c PK	609	{
	610	USB_DEVICE(0x0a46, 0x9620), /* DM9620 USB to Fast Ethernet Adapter */
	611	.driver_info = (unsigned long)&dm9601_info,
	612	},
d0374f4f PK	613	{}, // END
	614	};
	615
	616	MODULE_DEVICE_TABLE(usb, products);
	617
	618	static struct usb_driver dm9601_driver = {
	619	.name = "dm9601",
	620	.id_table = products,
	621	.probe = usbnet_probe,
	622	.disconnect = usbnet_disconnect,
	623	.suspend = usbnet_suspend,
	624	.resume = usbnet_resume,
e1f12eb6	625	.disable_hub_initiated_lpm = 1,
d0374f4f PK	626	};
d0374f4f PK	627
d632eb1b	628	module_usb_driver(dm9601_driver);
d0374f4f PK	629
	630	MODULE_AUTHOR("Peter Korsgaard <jacmet@sunsite.dk>");
	631	MODULE_DESCRIPTION("Davicom DM9601 USB 1.1 ethernet devices");
	632	MODULE_LICENSE("GPL");