[mirror_ubuntu-artful-kernel.git] / drivers / net / ethernet / atheros / atlx / atlx.c

/* atlx.c -- common functions for Attansic network drivers
 *
 * Copyright(c) 2005 - 2006 Attansic Corporation. All rights reserved.
 * Copyright(c) 2006 - 2007 Chris Snook <csnook@redhat.com>
 * Copyright(c) 2006 - 2008 Jay Cliburn <jcliburn@gmail.com>
 * Copyright(c) 2007 Atheros Corporation. All rights reserved.
 *
 * Derived from Intel e1000 driver
 * Copyright(c) 1999 - 2005 Intel Corporation. All rights reserved.
 *
 * 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 of the License, 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.
 */

/* Including this file like a header is a temporary hack, I promise. -- CHS */
#ifndef ATLX_C
#define ATLX_C

#include <linux/device.h>
#include <linux/errno.h>
#include <linux/etherdevice.h>
#include <linux/if.h>
#include <linux/netdevice.h>
#include <linux/socket.h>
#include <linux/sockios.h>
#include <linux/spinlock.h>
#include <linux/string.h>
#include <linux/types.h>
#include <linux/workqueue.h>

#include "atlx.h"

static s32 atlx_read_phy_reg(struct atl1_hw *hw, u16 reg_addr, u16 *phy_data);
static u32 atlx_hash_mc_addr(struct atl1_hw *hw, u8 *mc_addr);
static void atlx_set_mac_addr(struct atl1_hw *hw);

static struct atlx_spi_flash_dev flash_table[] = {
/*	MFR_NAME  WRSR  READ  PRGM  WREN  WRDI  RDSR  RDID  SEC_ERS CHIP_ERS */
	{"Atmel", 0x00, 0x03, 0x02, 0x06, 0x04, 0x05, 0x15, 0x52,   0x62},
	{"SST",   0x01, 0x03, 0x02, 0x06, 0x04, 0x05, 0x90, 0x20,   0x60},
	{"ST",    0x01, 0x03, 0x02, 0x06, 0x04, 0x05, 0xAB, 0xD8,   0xC7},
};

static int atlx_ioctl(struct net_device *netdev, struct ifreq *ifr, int cmd)
{
	switch (cmd) {
	case SIOCGMIIPHY:
	case SIOCGMIIREG:
	case SIOCSMIIREG:
		return atlx_mii_ioctl(netdev, ifr, cmd);
	default:
		return -EOPNOTSUPP;
	}
}

/*
 * atlx_set_mac - Change the Ethernet Address of the NIC
 * @netdev: network interface device structure
 * @p: pointer to an address structure
 *
 * Returns 0 on success, negative on failure
 */
static int atlx_set_mac(struct net_device *netdev, void *p)
{
	struct atlx_adapter *adapter = netdev_priv(netdev);
	struct sockaddr *addr = p;

	if (netif_running(netdev))
		return -EBUSY;

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

	memcpy(netdev->dev_addr, addr->sa_data, netdev->addr_len);
	memcpy(adapter->hw.mac_addr, addr->sa_data, netdev->addr_len);

	atlx_set_mac_addr(&adapter->hw);
	return 0;
}

static void atlx_check_for_link(struct atlx_adapter *adapter)
{
	struct net_device *netdev = adapter->netdev;
	u16 phy_data = 0;

	spin_lock(&adapter->lock);
	adapter->phy_timer_pending = false;
	atlx_read_phy_reg(&adapter->hw, MII_BMSR, &phy_data);
	atlx_read_phy_reg(&adapter->hw, MII_BMSR, &phy_data);
	spin_unlock(&adapter->lock);

	/* notify upper layer link down ASAP */
	if (!(phy_data & BMSR_LSTATUS)) {
		/* Link Down */
		if (netif_carrier_ok(netdev)) {
			/* old link state: Up */
			dev_info(&adapter->pdev->dev, "%s link is down\n",
				netdev->name);
			adapter->link_speed = SPEED_0;
			netif_carrier_off(netdev);
		}
	}
	schedule_work(&adapter->link_chg_task);
}

/*
 * atlx_set_multi - Multicast and Promiscuous mode set
 * @netdev: network interface device structure
 *
 * The set_multi entry point is called whenever the multicast address
 * list or the network interface flags are updated.  This routine is
 * responsible for configuring the hardware for proper multicast,
 * promiscuous mode, and all-multi behavior.
 */
static void atlx_set_multi(struct net_device *netdev)
{
	struct atlx_adapter *adapter = netdev_priv(netdev);
	struct atlx_hw *hw = &adapter->hw;
	struct netdev_hw_addr *ha;
	u32 rctl;
	u32 hash_value;

	/* Check for Promiscuous and All Multicast modes */
	rctl = ioread32(hw->hw_addr + REG_MAC_CTRL);
	if (netdev->flags & IFF_PROMISC)
		rctl |= MAC_CTRL_PROMIS_EN;
	else if (netdev->flags & IFF_ALLMULTI) {
		rctl |= MAC_CTRL_MC_ALL_EN;
		rctl &= ~MAC_CTRL_PROMIS_EN;
	} else
		rctl &= ~(MAC_CTRL_PROMIS_EN | MAC_CTRL_MC_ALL_EN);

	iowrite32(rctl, hw->hw_addr + REG_MAC_CTRL);

	/* clear the old settings from the multicast hash table */
	iowrite32(0, hw->hw_addr + REG_RX_HASH_TABLE);
	iowrite32(0, (hw->hw_addr + REG_RX_HASH_TABLE) + (1 << 2));

	/* compute mc addresses' hash value ,and put it into hash table */
	netdev_for_each_mc_addr(ha, netdev) {
		hash_value = atlx_hash_mc_addr(hw, ha->addr);
		atlx_hash_set(hw, hash_value);
	}
}

/*
 * atlx_irq_enable - Enable default interrupt generation settings
 * @adapter: board private structure
 */
static void atlx_irq_enable(struct atlx_adapter *adapter)
{
	iowrite32(IMR_NORMAL_MASK, adapter->hw.hw_addr + REG_IMR);
	ioread32(adapter->hw.hw_addr + REG_IMR);
}

/*
 * atlx_irq_disable - Mask off interrupt generation on the NIC
 * @adapter: board private structure
 */
static void atlx_irq_disable(struct atlx_adapter *adapter)
{
	iowrite32(0, adapter->hw.hw_addr + REG_IMR);
	ioread32(adapter->hw.hw_addr + REG_IMR);
	synchronize_irq(adapter->pdev->irq);
}

static void atlx_clear_phy_int(struct atlx_adapter *adapter)
{
	u16 phy_data;
	unsigned long flags;

	spin_lock_irqsave(&adapter->lock, flags);
	atlx_read_phy_reg(&adapter->hw, 19, &phy_data);
	spin_unlock_irqrestore(&adapter->lock, flags);
}

/*
 * atlx_tx_timeout - Respond to a Tx Hang
 * @netdev: network interface device structure
 */
static void atlx_tx_timeout(struct net_device *netdev)
{
	struct atlx_adapter *adapter = netdev_priv(netdev);
	/* Do the reset outside of interrupt context */
	schedule_work(&adapter->tx_timeout_task);
}

/*
 * atlx_link_chg_task - deal with link change event Out of interrupt context
 */
static void atlx_link_chg_task(struct work_struct *work)
{
	struct atlx_adapter *adapter;
	unsigned long flags;

	adapter = container_of(work, struct atlx_adapter, link_chg_task);

	spin_lock_irqsave(&adapter->lock, flags);
	atlx_check_link(adapter);
	spin_unlock_irqrestore(&adapter->lock, flags);
}

static void __atlx_vlan_mode(netdev_features_t features, u32 *ctrl)
{
	if (features & NETIF_F_HW_VLAN_RX) {
		/* enable VLAN tag insert/strip */
		*ctrl |= MAC_CTRL_RMV_VLAN;
	} else {
		/* disable VLAN tag insert/strip */
		*ctrl &= ~MAC_CTRL_RMV_VLAN;
	}
}

static void atlx_vlan_mode(struct net_device *netdev,
	netdev_features_t features)
{
	struct atlx_adapter *adapter = netdev_priv(netdev);
	unsigned long flags;
	u32 ctrl;

	spin_lock_irqsave(&adapter->lock, flags);
	/* atlx_irq_disable(adapter); FIXME: confirm/remove */
	ctrl = ioread32(adapter->hw.hw_addr + REG_MAC_CTRL);
	__atlx_vlan_mode(features, &ctrl);
	iowrite32(ctrl, adapter->hw.hw_addr + REG_MAC_CTRL);
	/* atlx_irq_enable(adapter); FIXME */
	spin_unlock_irqrestore(&adapter->lock, flags);
}

static void atlx_restore_vlan(struct atlx_adapter *adapter)
{
	atlx_vlan_mode(adapter->netdev, adapter->netdev->features);
}

static netdev_features_t atlx_fix_features(struct net_device *netdev,
	netdev_features_t features)
{
	/*
	 * Since there is no support for separate rx/tx vlan accel
	 * enable/disable make sure tx flag is always in same state as rx.
	 */
	if (features & NETIF_F_HW_VLAN_RX)
		features |= NETIF_F_HW_VLAN_TX;
	else
		features &= ~NETIF_F_HW_VLAN_TX;

	return features;
}

static int atlx_set_features(struct net_device *netdev,
	netdev_features_t features)
{
	netdev_features_t changed = netdev->features ^ features;

	if (changed & NETIF_F_HW_VLAN_RX)
		atlx_vlan_mode(netdev, features);

	return 0;
}

#endif /* ATLX_C */
Commit	Line	Data
305282ba JC	1	/* atlx.c -- common functions for Attansic network drivers
	2	*
	3	* Copyright(c) 2005 - 2006 Attansic Corporation. All rights reserved.
	4	* Copyright(c) 2006 - 2007 Chris Snook <csnook@redhat.com>
e8f720fd	5	* Copyright(c) 2006 - 2008 Jay Cliburn <jcliburn@gmail.com>
305282ba JC	6	* Copyright(c) 2007 Atheros Corporation. All rights reserved.
	7	*
	8	* Derived from Intel e1000 driver
	9	* Copyright(c) 1999 - 2005 Intel Corporation. All rights reserved.
	10	*
	11	* This program is free software; you can redistribute it and/or modify it
	12	* under the terms of the GNU General Public License as published by the Free
	13	* Software Foundation; either version 2 of the License, or (at your option)
	14	* any later version.
	15	*
	16	* This program is distributed in the hope that it will be useful, but WITHOUT
	17	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
	18	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
	19	* more details.
	20	*
	21	* You should have received a copy of the GNU General Public License along with
	22	* this program; if not, write to the Free Software Foundation, Inc., 59
	23	* Temple Place - Suite 330, Boston, MA 02111-1307, USA.
	24	*/
	25
	26	/* Including this file like a header is a temporary hack, I promise. -- CHS */
	27	#ifndef ATLX_C
	28	#define ATLX_C
	29
	30	#include <linux/device.h>
	31	#include <linux/errno.h>
	32	#include <linux/etherdevice.h>
	33	#include <linux/if.h>
	34	#include <linux/netdevice.h>
	35	#include <linux/socket.h>
	36	#include <linux/sockios.h>
	37	#include <linux/spinlock.h>
	38	#include <linux/string.h>
	39	#include <linux/types.h>
	40	#include <linux/workqueue.h>
	41
	42	#include "atlx.h"
	43
ff2d8d6c	44	static s32 atlx_read_phy_reg(struct atl1_hw hw, u16 reg_addr, u16 phy_data);
	45	static u32 atlx_hash_mc_addr(struct atl1_hw hw, u8 mc_addr);
	46	static void atlx_set_mac_addr(struct atl1_hw *hw);
	47
305282ba JC	48	static struct atlx_spi_flash_dev flash_table[] = {
	49	/* MFR_NAME WRSR READ PRGM WREN WRDI RDSR RDID SEC_ERS CHIP_ERS */
	50	{"Atmel", 0x00, 0x03, 0x02, 0x06, 0x04, 0x05, 0x15, 0x52, 0x62},
	51	{"SST", 0x01, 0x03, 0x02, 0x06, 0x04, 0x05, 0x90, 0x20, 0x60},
	52	{"ST", 0x01, 0x03, 0x02, 0x06, 0x04, 0x05, 0xAB, 0xD8, 0xC7},
	53	};
	54
	55	static int atlx_ioctl(struct net_device netdev, struct ifreq ifr, int cmd)
	56	{
	57	switch (cmd) {
	58	case SIOCGMIIPHY:
	59	case SIOCGMIIREG:
	60	case SIOCSMIIREG:
	61	return atlx_mii_ioctl(netdev, ifr, cmd);
	62	default:
	63	return -EOPNOTSUPP;
	64	}
	65	}
	66
	67	/*
	68	* atlx_set_mac - Change the Ethernet Address of the NIC
	69	* @netdev: network interface device structure
	70	* @p: pointer to an address structure
	71	*
	72	* Returns 0 on success, negative on failure
	73	*/
	74	static int atlx_set_mac(struct net_device netdev, void p)
	75	{
	76	struct atlx_adapter *adapter = netdev_priv(netdev);
	77	struct sockaddr *addr = p;
	78
	79	if (netif_running(netdev))
	80	return -EBUSY;
	81
	82	if (!is_valid_ether_addr(addr->sa_data))
	83	return -EADDRNOTAVAIL;
	84
	85	memcpy(netdev->dev_addr, addr->sa_data, netdev->addr_len);
	86	memcpy(adapter->hw.mac_addr, addr->sa_data, netdev->addr_len);
	87
	88	atlx_set_mac_addr(&adapter->hw);
	89	return 0;
	90	}
	91
	92	static void atlx_check_for_link(struct atlx_adapter *adapter)
	93	{
	94	struct net_device *netdev = adapter->netdev;
	95	u16 phy_data = 0;
	96
	97	spin_lock(&adapter->lock);
	98	adapter->phy_timer_pending = false;
	99	atlx_read_phy_reg(&adapter->hw, MII_BMSR, &phy_data);
	100	atlx_read_phy_reg(&adapter->hw, MII_BMSR, &phy_data);
	101	spin_unlock(&adapter->lock);
	102
	103	/* notify upper layer link down ASAP */
	104	if (!(phy_data & BMSR_LSTATUS)) {
	105	/* Link Down */
	106	if (netif_carrier_ok(netdev)) {
	107	/* old link state: Up */
	108	dev_info(&adapter->pdev->dev, "%s link is down\n",
	109	netdev->name);
	110	adapter->link_speed = SPEED_0;
	111	netif_carrier_off(netdev);
305282ba JC	112	}
	113	}
	114	schedule_work(&adapter->link_chg_task);
	115	}
	116
	117	/*
	118	* atlx_set_multi - Multicast and Promiscuous mode set
	119	* @netdev: network interface device structure
	120	*
	121	* The set_multi entry point is called whenever the multicast address
	122	* list or the network interface flags are updated. This routine is
	123	* responsible for configuring the hardware for proper multicast,
	124	* promiscuous mode, and all-multi behavior.
	125	*/
	126	static void atlx_set_multi(struct net_device *netdev)
	127	{
	128	struct atlx_adapter *adapter = netdev_priv(netdev);
	129	struct atlx_hw *hw = &adapter->hw;
22bedad3	130	struct netdev_hw_addr *ha;
305282ba JC	131	u32 rctl;
	132	u32 hash_value;
	133
	134	/* Check for Promiscuous and All Multicast modes */
	135	rctl = ioread32(hw->hw_addr + REG_MAC_CTRL);
	136	if (netdev->flags & IFF_PROMISC)
	137	rctl \|= MAC_CTRL_PROMIS_EN;
	138	else if (netdev->flags & IFF_ALLMULTI) {
	139	rctl \|= MAC_CTRL_MC_ALL_EN;
	140	rctl &= ~MAC_CTRL_PROMIS_EN;
	141	} else
	142	rctl &= ~(MAC_CTRL_PROMIS_EN \| MAC_CTRL_MC_ALL_EN);
	143
	144	iowrite32(rctl, hw->hw_addr + REG_MAC_CTRL);
	145
	146	/* clear the old settings from the multicast hash table */
	147	iowrite32(0, hw->hw_addr + REG_RX_HASH_TABLE);
	148	iowrite32(0, (hw->hw_addr + REG_RX_HASH_TABLE) + (1 << 2));
	149
	150	/* compute mc addresses' hash value ,and put it into hash table */
22bedad3 JP	151	netdev_for_each_mc_addr(ha, netdev) {
22bedad3 JP	152	hash_value = atlx_hash_mc_addr(hw, ha->addr);
305282ba JC	153	atlx_hash_set(hw, hash_value);
	154	}
	155	}
	156
	157	/*
	158	* atlx_irq_enable - Enable default interrupt generation settings
	159	* @adapter: board private structure
	160	*/
	161	static void atlx_irq_enable(struct atlx_adapter *adapter)
	162	{
	163	iowrite32(IMR_NORMAL_MASK, adapter->hw.hw_addr + REG_IMR);
	164	ioread32(adapter->hw.hw_addr + REG_IMR);
	165	}
	166
	167	/*
	168	* atlx_irq_disable - Mask off interrupt generation on the NIC
	169	* @adapter: board private structure
	170	*/
	171	static void atlx_irq_disable(struct atlx_adapter *adapter)
	172	{
	173	iowrite32(0, adapter->hw.hw_addr + REG_IMR);
	174	ioread32(adapter->hw.hw_addr + REG_IMR);
	175	synchronize_irq(adapter->pdev->irq);
	176	}
	177
	178	static void atlx_clear_phy_int(struct atlx_adapter *adapter)
	179	{
	180	u16 phy_data;
	181	unsigned long flags;
	182
	183	spin_lock_irqsave(&adapter->lock, flags);
	184	atlx_read_phy_reg(&adapter->hw, 19, &phy_data);
	185	spin_unlock_irqrestore(&adapter->lock, flags);
	186	}
	187
305282ba JC	188	/*
	189	* atlx_tx_timeout - Respond to a Tx Hang
	190	* @netdev: network interface device structure
	191	*/
	192	static void atlx_tx_timeout(struct net_device *netdev)
	193	{
	194	struct atlx_adapter *adapter = netdev_priv(netdev);
	195	/* Do the reset outside of interrupt context */
	196	schedule_work(&adapter->tx_timeout_task);
	197	}
	198
	199	/*
	200	* atlx_link_chg_task - deal with link change event Out of interrupt context
	201	*/
	202	static void atlx_link_chg_task(struct work_struct *work)
	203	{
	204	struct atlx_adapter *adapter;
	205	unsigned long flags;
	206
	207	adapter = container_of(work, struct atlx_adapter, link_chg_task);
	208
	209	spin_lock_irqsave(&adapter->lock, flags);
	210	atlx_check_link(adapter);
	211	spin_unlock_irqrestore(&adapter->lock, flags);
	212	}
	213
c8f44aff	214	static void __atlx_vlan_mode(netdev_features_t features, u32 *ctrl)
92491709 JP	215	{
	216	if (features & NETIF_F_HW_VLAN_RX) {
	217	/* enable VLAN tag insert/strip */
	218	*ctrl \|= MAC_CTRL_RMV_VLAN;
	219	} else {
	220	/* disable VLAN tag insert/strip */
	221	*ctrl &= ~MAC_CTRL_RMV_VLAN;
	222	}
	223	}
	224
c8f44aff MM	225	static void atlx_vlan_mode(struct net_device *netdev,
c8f44aff MM	226	netdev_features_t features)
305282ba JC	227	{
	228	struct atlx_adapter *adapter = netdev_priv(netdev);
	229	unsigned long flags;
	230	u32 ctrl;
	231
	232	spin_lock_irqsave(&adapter->lock, flags);
	233	/* atlx_irq_disable(adapter); FIXME: confirm/remove */
92491709 JP	234	ctrl = ioread32(adapter->hw.hw_addr + REG_MAC_CTRL);
	235	__atlx_vlan_mode(features, &ctrl);
	236	iowrite32(ctrl, adapter->hw.hw_addr + REG_MAC_CTRL);
305282ba JC	237	/* atlx_irq_enable(adapter); FIXME */
	238	spin_unlock_irqrestore(&adapter->lock, flags);
	239	}
	240
	241	static void atlx_restore_vlan(struct atlx_adapter *adapter)
	242	{
92491709 JP	243	atlx_vlan_mode(adapter->netdev, adapter->netdev->features);
	244	}
	245
c8f44aff MM	246	static netdev_features_t atlx_fix_features(struct net_device *netdev,
c8f44aff MM	247	netdev_features_t features)
92491709 JP	248	{
	249	/*
	250	* Since there is no support for separate rx/tx vlan accel
	251	* enable/disable make sure tx flag is always in same state as rx.
	252	*/
	253	if (features & NETIF_F_HW_VLAN_RX)
	254	features \|= NETIF_F_HW_VLAN_TX;
	255	else
	256	features &= ~NETIF_F_HW_VLAN_TX;
	257
	258	return features;
	259	}
	260
c8f44aff MM	261	static int atlx_set_features(struct net_device *netdev,
c8f44aff MM	262	netdev_features_t features)
92491709	263	{
c8f44aff	264	netdev_features_t changed = netdev->features ^ features;
92491709 JP	265
	266	if (changed & NETIF_F_HW_VLAN_RX)
	267	atlx_vlan_mode(netdev, features);
	268
	269	return 0;
305282ba JC	270	}
305282ba JC	271
305282ba	272	#endif /* ATLX_C */