Merge branch 'master' of master.kernel.org:/pub/scm/linux/kernel/git/davem/net-2.6
[linux-2.6] / drivers / net / wireless / ath5k / attach.c
1 /*
2  * Copyright (c) 2004-2008 Reyk Floeter <reyk@openbsd.org>
3  * Copyright (c) 2006-2008 Nick Kossifidis <mickflemm@gmail.com>
4  *
5  * Permission to use, copy, modify, and distribute this software for any
6  * purpose with or without fee is hereby granted, provided that the above
7  * copyright notice and this permission notice appear in all copies.
8  *
9  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16  *
17  */
18
19 /*************************************\
20 * Attach/Detach Functions and helpers *
21 \*************************************/
22
23 #include <linux/pci.h>
24 #include "ath5k.h"
25 #include "reg.h"
26 #include "debug.h"
27 #include "base.h"
28
29 /**
30  * ath5k_hw_post - Power On Self Test helper function
31  *
32  * @ah: The &struct ath5k_hw
33  */
34 static int ath5k_hw_post(struct ath5k_hw *ah)
35 {
36
37         int i, c;
38         u16 cur_reg;
39         u16 regs[2] = {AR5K_STA_ID0, AR5K_PHY(8)};
40         u32 var_pattern;
41         u32 static_pattern[4] = {
42                 0x55555555,     0xaaaaaaaa,
43                 0x66666666,     0x99999999
44         };
45         u32 init_val;
46         u32 cur_val;
47
48         for (c = 0; c < 2; c++) {
49
50                 cur_reg = regs[c];
51
52                 /* Save previous value */
53                 init_val = ath5k_hw_reg_read(ah, cur_reg);
54
55                 for (i = 0; i < 256; i++) {
56                         var_pattern = i << 16 | i;
57                         ath5k_hw_reg_write(ah, var_pattern, cur_reg);
58                         cur_val = ath5k_hw_reg_read(ah, cur_reg);
59
60                         if (cur_val != var_pattern) {
61                                 ATH5K_ERR(ah->ah_sc, "POST Failed !!!\n");
62                                 return -EAGAIN;
63                         }
64
65                         /* Found on ndiswrapper dumps */
66                         var_pattern = 0x0039080f;
67                         ath5k_hw_reg_write(ah, var_pattern, cur_reg);
68                 }
69
70                 for (i = 0; i < 4; i++) {
71                         var_pattern = static_pattern[i];
72                         ath5k_hw_reg_write(ah, var_pattern, cur_reg);
73                         cur_val = ath5k_hw_reg_read(ah, cur_reg);
74
75                         if (cur_val != var_pattern) {
76                                 ATH5K_ERR(ah->ah_sc, "POST Failed !!!\n");
77                                 return -EAGAIN;
78                         }
79
80                         /* Found on ndiswrapper dumps */
81                         var_pattern = 0x003b080f;
82                         ath5k_hw_reg_write(ah, var_pattern, cur_reg);
83                 }
84
85                 /* Restore previous value */
86                 ath5k_hw_reg_write(ah, init_val, cur_reg);
87
88         }
89
90         return 0;
91
92 }
93
94 /**
95  * ath5k_hw_attach - Check if hw is supported and init the needed structs
96  *
97  * @sc: The &struct ath5k_softc we got from the driver's attach function
98  * @mac_version: The mac version id (check out ath5k.h) based on pci id
99  *
100  * Check if the device is supported, perform a POST and initialize the needed
101  * structs. Returns -ENOMEM if we don't have memory for the needed structs,
102  * -ENODEV if the device is not supported or prints an error msg if something
103  * else went wrong.
104  */
105 struct ath5k_hw *ath5k_hw_attach(struct ath5k_softc *sc, u8 mac_version)
106 {
107         struct ath5k_hw *ah;
108         struct pci_dev *pdev = sc->pdev;
109         u8 mac[ETH_ALEN] = {};
110         int ret;
111         u32 srev;
112
113         /*If we passed the test malloc a ath5k_hw struct*/
114         ah = kzalloc(sizeof(struct ath5k_hw), GFP_KERNEL);
115         if (ah == NULL) {
116                 ret = -ENOMEM;
117                 ATH5K_ERR(sc, "out of memory\n");
118                 goto err;
119         }
120
121         ah->ah_sc = sc;
122         ah->ah_iobase = sc->iobase;
123
124         /*
125          * HW information
126          */
127         ah->ah_op_mode = NL80211_IFTYPE_STATION;
128         ah->ah_radar.r_enabled = AR5K_TUNE_RADAR_ALERT;
129         ah->ah_turbo = false;
130         ah->ah_txpower.txp_tpc = AR5K_TUNE_TPC_TXPOWER;
131         ah->ah_imr = 0;
132         ah->ah_atim_window = 0;
133         ah->ah_aifs = AR5K_TUNE_AIFS;
134         ah->ah_cw_min = AR5K_TUNE_CWMIN;
135         ah->ah_limit_tx_retries = AR5K_INIT_TX_RETRY;
136         ah->ah_software_retry = false;
137         ah->ah_ant_diversity = AR5K_TUNE_ANT_DIVERSITY;
138
139         /*
140          * Set the mac version based on the pci id
141          */
142         ah->ah_version = mac_version;
143
144         /*Fill the ath5k_hw struct with the needed functions*/
145         ret = ath5k_hw_init_desc_functions(ah);
146         if (ret)
147                 goto err_free;
148
149         /* Bring device out of sleep and reset it's units */
150         ret = ath5k_hw_nic_wakeup(ah, CHANNEL_B, true);
151         if (ret)
152                 goto err_free;
153
154         /* Get MAC, PHY and RADIO revisions */
155         srev = ath5k_hw_reg_read(ah, AR5K_SREV);
156         ah->ah_mac_srev = srev;
157         ah->ah_mac_version = AR5K_REG_MS(srev, AR5K_SREV_VER);
158         ah->ah_mac_revision = AR5K_REG_MS(srev, AR5K_SREV_REV);
159         ah->ah_phy_revision = ath5k_hw_reg_read(ah, AR5K_PHY_CHIP_ID) &
160                         0xffffffff;
161         ah->ah_radio_5ghz_revision = ath5k_hw_radio_revision(ah,
162                         CHANNEL_5GHZ);
163         ah->ah_phy = AR5K_PHY(0);
164
165         /* Try to identify radio chip based on it's srev */
166         switch (ah->ah_radio_5ghz_revision & 0xf0) {
167         case AR5K_SREV_RAD_5111:
168                 ah->ah_radio = AR5K_RF5111;
169                 ah->ah_single_chip = false;
170                 ah->ah_radio_2ghz_revision = ath5k_hw_radio_revision(ah,
171                                                         CHANNEL_2GHZ);
172                 break;
173         case AR5K_SREV_RAD_5112:
174         case AR5K_SREV_RAD_2112:
175                 ah->ah_radio = AR5K_RF5112;
176                 ah->ah_single_chip = false;
177                 ah->ah_radio_2ghz_revision = ath5k_hw_radio_revision(ah,
178                                                         CHANNEL_2GHZ);
179                 break;
180         case AR5K_SREV_RAD_2413:
181                 ah->ah_radio = AR5K_RF2413;
182                 ah->ah_single_chip = true;
183                 break;
184         case AR5K_SREV_RAD_5413:
185                 ah->ah_radio = AR5K_RF5413;
186                 ah->ah_single_chip = true;
187                 break;
188         case AR5K_SREV_RAD_2316:
189                 ah->ah_radio = AR5K_RF2316;
190                 ah->ah_single_chip = true;
191                 break;
192         case AR5K_SREV_RAD_2317:
193                 ah->ah_radio = AR5K_RF2317;
194                 ah->ah_single_chip = true;
195                 break;
196         case AR5K_SREV_RAD_5424:
197                 if (ah->ah_mac_version == AR5K_SREV_AR2425 ||
198                 ah->ah_mac_version == AR5K_SREV_AR2417){
199                         ah->ah_radio = AR5K_RF2425;
200                         ah->ah_single_chip = true;
201                 } else {
202                         ah->ah_radio = AR5K_RF5413;
203                         ah->ah_single_chip = true;
204                 }
205                 break;
206         default:
207                 /* Identify radio based on mac/phy srev */
208                 if (ah->ah_version == AR5K_AR5210) {
209                         ah->ah_radio = AR5K_RF5110;
210                         ah->ah_single_chip = false;
211                 } else if (ah->ah_version == AR5K_AR5211) {
212                         ah->ah_radio = AR5K_RF5111;
213                         ah->ah_single_chip = false;
214                         ah->ah_radio_2ghz_revision = ath5k_hw_radio_revision(ah,
215                                                                 CHANNEL_2GHZ);
216                 } else if (ah->ah_mac_version == (AR5K_SREV_AR2425 >> 4) ||
217                 ah->ah_mac_version == (AR5K_SREV_AR2417 >> 4) ||
218                 ah->ah_phy_revision == AR5K_SREV_PHY_2425) {
219                         ah->ah_radio = AR5K_RF2425;
220                         ah->ah_single_chip = true;
221                         ah->ah_radio_5ghz_revision = AR5K_SREV_RAD_2425;
222                 } else if (srev == AR5K_SREV_AR5213A &&
223                 ah->ah_phy_revision == AR5K_SREV_PHY_5212B) {
224                         ah->ah_radio = AR5K_RF5112;
225                         ah->ah_single_chip = false;
226                         ah->ah_radio_5ghz_revision = AR5K_SREV_RAD_5112B;
227                 } else if (ah->ah_mac_version == (AR5K_SREV_AR2415 >> 4)) {
228                         ah->ah_radio = AR5K_RF2316;
229                         ah->ah_single_chip = true;
230                         ah->ah_radio_5ghz_revision = AR5K_SREV_RAD_2316;
231                 } else if (ah->ah_mac_version == (AR5K_SREV_AR5414 >> 4) ||
232                 ah->ah_phy_revision == AR5K_SREV_PHY_5413) {
233                         ah->ah_radio = AR5K_RF5413;
234                         ah->ah_single_chip = true;
235                         ah->ah_radio_5ghz_revision = AR5K_SREV_RAD_5413;
236                 } else if (ah->ah_mac_version == (AR5K_SREV_AR2414 >> 4) ||
237                 ah->ah_phy_revision == AR5K_SREV_PHY_2413) {
238                         ah->ah_radio = AR5K_RF2413;
239                         ah->ah_single_chip = true;
240                         ah->ah_radio_5ghz_revision = AR5K_SREV_RAD_2413;
241                 } else {
242                         ATH5K_ERR(sc, "Couldn't identify radio revision.\n");
243                         ret = -ENODEV;
244                         goto err_free;
245                 }
246         }
247
248
249         /* Return on unsuported chips (unsupported eeprom etc) */
250         if ((srev >= AR5K_SREV_AR5416) &&
251         (srev < AR5K_SREV_AR2425)) {
252                 ATH5K_ERR(sc, "Device not yet supported.\n");
253                 ret = -ENODEV;
254                 goto err_free;
255         }
256
257         /*
258          * Write PCI-E power save settings
259          */
260         if ((ah->ah_version == AR5K_AR5212) && (pdev->is_pcie)) {
261                 ath5k_hw_reg_write(ah, 0x9248fc00, AR5K_PCIE_SERDES);
262                 ath5k_hw_reg_write(ah, 0x24924924, AR5K_PCIE_SERDES);
263                 /* Shut off RX when elecidle is asserted */
264                 ath5k_hw_reg_write(ah, 0x28000039, AR5K_PCIE_SERDES);
265                 ath5k_hw_reg_write(ah, 0x53160824, AR5K_PCIE_SERDES);
266                 /* TODO: EEPROM work */
267                 ath5k_hw_reg_write(ah, 0xe5980579, AR5K_PCIE_SERDES);
268                 /* Shut off PLL and CLKREQ active in L1 */
269                 ath5k_hw_reg_write(ah, 0x001defff, AR5K_PCIE_SERDES);
270                 /* Preserce other settings */
271                 ath5k_hw_reg_write(ah, 0x1aaabe40, AR5K_PCIE_SERDES);
272                 ath5k_hw_reg_write(ah, 0xbe105554, AR5K_PCIE_SERDES);
273                 ath5k_hw_reg_write(ah, 0x000e3007, AR5K_PCIE_SERDES);
274                 /* Reset SERDES to load new settings */
275                 ath5k_hw_reg_write(ah, 0x00000000, AR5K_PCIE_SERDES_RESET);
276                 mdelay(1);
277         }
278
279         /*
280          * POST
281          */
282         ret = ath5k_hw_post(ah);
283         if (ret)
284                 goto err_free;
285
286         /* Enable pci core retry fix on Hainan (5213A) and later chips */
287         if (srev >= AR5K_SREV_AR5213A)
288                 ath5k_hw_reg_write(ah, AR5K_PCICFG_RETRY_FIX, AR5K_PCICFG);
289
290         /*
291          * Get card capabilities, calibration values etc
292          * TODO: EEPROM work
293          */
294         ret = ath5k_eeprom_init(ah);
295         if (ret) {
296                 ATH5K_ERR(sc, "unable to init EEPROM\n");
297                 goto err_free;
298         }
299
300         /* Get misc capabilities */
301         ret = ath5k_hw_set_capabilities(ah);
302         if (ret) {
303                 ATH5K_ERR(sc, "unable to get device capabilities: 0x%04x\n",
304                         sc->pdev->device);
305                 goto err_free;
306         }
307
308         if (srev >= AR5K_SREV_AR2414) {
309                 ah->ah_combined_mic = true;
310                 AR5K_REG_ENABLE_BITS(ah, AR5K_MISC_MODE,
311                         AR5K_MISC_MODE_COMBINED_MIC);
312         }
313
314         /* MAC address is cleared until add_interface */
315         ath5k_hw_set_lladdr(ah, mac);
316
317         /* Set BSSID to bcast address: ff:ff:ff:ff:ff:ff for now */
318         memset(ah->ah_bssid, 0xff, ETH_ALEN);
319         ath5k_hw_set_associd(ah, ah->ah_bssid, 0);
320         ath5k_hw_set_opmode(ah);
321
322         ath5k_hw_rfgain_opt_init(ah);
323
324         return ah;
325 err_free:
326         kfree(ah);
327 err:
328         return ERR_PTR(ret);
329 }
330
331 /**
332  * ath5k_hw_detach - Free the ath5k_hw struct
333  *
334  * @ah: The &struct ath5k_hw
335  */
336 void ath5k_hw_detach(struct ath5k_hw *ah)
337 {
338         ATH5K_TRACE(ah->ah_sc);
339
340         __set_bit(ATH_STAT_INVALID, ah->ah_sc->status);
341
342         if (ah->ah_rf_banks != NULL)
343                 kfree(ah->ah_rf_banks);
344
345         /* assume interrupts are down */
346         kfree(ah);
347 }