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>
5  * Copyright(c) 2006 - 2008 Jay Cliburn <jcliburn@gmail.com>
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 
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 
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 	netdev->addr_assign_type &= ~NET_ADDR_RANDOM;
88 
89 	atlx_set_mac_addr(&adapter->hw);
90 	return 0;
91 }
92 
93 static void atlx_check_for_link(struct atlx_adapter *adapter)
94 {
95 	struct net_device *netdev = adapter->netdev;
96 	u16 phy_data = 0;
97 
98 	spin_lock(&adapter->lock);
99 	adapter->phy_timer_pending = false;
100 	atlx_read_phy_reg(&adapter->hw, MII_BMSR, &phy_data);
101 	atlx_read_phy_reg(&adapter->hw, MII_BMSR, &phy_data);
102 	spin_unlock(&adapter->lock);
103 
104 	/* notify upper layer link down ASAP */
105 	if (!(phy_data & BMSR_LSTATUS)) {
106 		/* Link Down */
107 		if (netif_carrier_ok(netdev)) {
108 			/* old link state: Up */
109 			dev_info(&adapter->pdev->dev, "%s link is down\n",
110 				netdev->name);
111 			adapter->link_speed = SPEED_0;
112 			netif_carrier_off(netdev);
113 		}
114 	}
115 	schedule_work(&adapter->link_chg_task);
116 }
117 
118 /**
119  * atlx_set_multi - Multicast and Promiscuous mode set
120  * @netdev: network interface device structure
121  *
122  * The set_multi entry point is called whenever the multicast address
123  * list or the network interface flags are updated.  This routine is
124  * responsible for configuring the hardware for proper multicast,
125  * promiscuous mode, and all-multi behavior.
126  */
127 static void atlx_set_multi(struct net_device *netdev)
128 {
129 	struct atlx_adapter *adapter = netdev_priv(netdev);
130 	struct atlx_hw *hw = &adapter->hw;
131 	struct netdev_hw_addr *ha;
132 	u32 rctl;
133 	u32 hash_value;
134 
135 	/* Check for Promiscuous and All Multicast modes */
136 	rctl = ioread32(hw->hw_addr + REG_MAC_CTRL);
137 	if (netdev->flags & IFF_PROMISC)
138 		rctl |= MAC_CTRL_PROMIS_EN;
139 	else if (netdev->flags & IFF_ALLMULTI) {
140 		rctl |= MAC_CTRL_MC_ALL_EN;
141 		rctl &= ~MAC_CTRL_PROMIS_EN;
142 	} else
143 		rctl &= ~(MAC_CTRL_PROMIS_EN | MAC_CTRL_MC_ALL_EN);
144 
145 	iowrite32(rctl, hw->hw_addr + REG_MAC_CTRL);
146 
147 	/* clear the old settings from the multicast hash table */
148 	iowrite32(0, hw->hw_addr + REG_RX_HASH_TABLE);
149 	iowrite32(0, (hw->hw_addr + REG_RX_HASH_TABLE) + (1 << 2));
150 
151 	/* compute mc addresses' hash value ,and put it into hash table */
152 	netdev_for_each_mc_addr(ha, netdev) {
153 		hash_value = atlx_hash_mc_addr(hw, ha->addr);
154 		atlx_hash_set(hw, hash_value);
155 	}
156 }
157 
158 static inline void atlx_imr_set(struct atlx_adapter *adapter,
159 				unsigned int imr)
160 {
161 	iowrite32(imr, adapter->hw.hw_addr + REG_IMR);
162 	ioread32(adapter->hw.hw_addr + REG_IMR);
163 }
164 
165 /**
166  * atlx_irq_enable - Enable default interrupt generation settings
167  * @adapter: board private structure
168  */
169 static void atlx_irq_enable(struct atlx_adapter *adapter)
170 {
171 	atlx_imr_set(adapter, IMR_NORMAL_MASK);
172 	adapter->int_enabled = true;
173 }
174 
175 /**
176  * atlx_irq_disable - Mask off interrupt generation on the NIC
177  * @adapter: board private structure
178  */
179 static void atlx_irq_disable(struct atlx_adapter *adapter)
180 {
181 	adapter->int_enabled = false;
182 	atlx_imr_set(adapter, 0);
183 	synchronize_irq(adapter->pdev->irq);
184 }
185 
186 static void atlx_clear_phy_int(struct atlx_adapter *adapter)
187 {
188 	u16 phy_data;
189 	unsigned long flags;
190 
191 	spin_lock_irqsave(&adapter->lock, flags);
192 	atlx_read_phy_reg(&adapter->hw, 19, &phy_data);
193 	spin_unlock_irqrestore(&adapter->lock, flags);
194 }
195 
196 /**
197  * atlx_tx_timeout - Respond to a Tx Hang
198  * @netdev: network interface device structure
199  */
200 static void atlx_tx_timeout(struct net_device *netdev)
201 {
202 	struct atlx_adapter *adapter = netdev_priv(netdev);
203 	/* Do the reset outside of interrupt context */
204 	schedule_work(&adapter->reset_dev_task);
205 }
206 
207 /*
208  * atlx_link_chg_task - deal with link change event Out of interrupt context
209  */
210 static void atlx_link_chg_task(struct work_struct *work)
211 {
212 	struct atlx_adapter *adapter;
213 	unsigned long flags;
214 
215 	adapter = container_of(work, struct atlx_adapter, link_chg_task);
216 
217 	spin_lock_irqsave(&adapter->lock, flags);
218 	atlx_check_link(adapter);
219 	spin_unlock_irqrestore(&adapter->lock, flags);
220 }
221 
222 static void __atlx_vlan_mode(netdev_features_t features, u32 *ctrl)
223 {
224 	if (features & NETIF_F_HW_VLAN_RX) {
225 		/* enable VLAN tag insert/strip */
226 		*ctrl |= MAC_CTRL_RMV_VLAN;
227 	} else {
228 		/* disable VLAN tag insert/strip */
229 		*ctrl &= ~MAC_CTRL_RMV_VLAN;
230 	}
231 }
232 
233 static void atlx_vlan_mode(struct net_device *netdev,
234 	netdev_features_t features)
235 {
236 	struct atlx_adapter *adapter = netdev_priv(netdev);
237 	unsigned long flags;
238 	u32 ctrl;
239 
240 	spin_lock_irqsave(&adapter->lock, flags);
241 	/* atlx_irq_disable(adapter); FIXME: confirm/remove */
242 	ctrl = ioread32(adapter->hw.hw_addr + REG_MAC_CTRL);
243 	__atlx_vlan_mode(features, &ctrl);
244 	iowrite32(ctrl, adapter->hw.hw_addr + REG_MAC_CTRL);
245 	/* atlx_irq_enable(adapter); FIXME */
246 	spin_unlock_irqrestore(&adapter->lock, flags);
247 }
248 
249 static void atlx_restore_vlan(struct atlx_adapter *adapter)
250 {
251 	atlx_vlan_mode(adapter->netdev, adapter->netdev->features);
252 }
253 
254 static netdev_features_t atlx_fix_features(struct net_device *netdev,
255 	netdev_features_t features)
256 {
257 	/*
258 	 * Since there is no support for separate rx/tx vlan accel
259 	 * enable/disable make sure tx flag is always in same state as rx.
260 	 */
261 	if (features & NETIF_F_HW_VLAN_RX)
262 		features |= NETIF_F_HW_VLAN_TX;
263 	else
264 		features &= ~NETIF_F_HW_VLAN_TX;
265 
266 	return features;
267 }
268 
269 static int atlx_set_features(struct net_device *netdev,
270 	netdev_features_t features)
271 {
272 	netdev_features_t changed = netdev->features ^ features;
273 
274 	if (changed & NETIF_F_HW_VLAN_RX)
275 		atlx_vlan_mode(netdev, features);
276 
277 	return 0;
278 }
279 
280 #endif /* ATLX_C */
281