2 * Copyright (c) 2004-2008 Reyk Floeter <reyk@openbsd.org>
3 * Copyright (c) 2006-2008 Nick Kossifidis <mickflemm@gmail.com>
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.
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.
19 /*************************************\
20 * Attach/Detach Functions and helpers *
21 \*************************************/
23 #include <linux/pci.h>
30 * ath5k_hw_post - Power On Self Test helper function
32 * @ah: The &struct ath5k_hw
34 static int ath5k_hw_post(struct ath5k_hw *ah)
37 static const u32 static_pattern[4] = {
38 0x55555555, 0xaaaaaaaa,
39 0x66666666, 0x99999999
41 static const u16 regs[2] = { AR5K_STA_ID0, AR5K_PHY(8) };
48 for (c = 0; c < 2; c++) {
52 /* Save previous value */
53 init_val = ath5k_hw_reg_read(ah, cur_reg);
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);
60 if (cur_val != var_pattern) {
61 ATH5K_ERR(ah->ah_sc, "POST Failed !!!\n");
65 /* Found on ndiswrapper dumps */
66 var_pattern = 0x0039080f;
67 ath5k_hw_reg_write(ah, var_pattern, cur_reg);
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);
75 if (cur_val != var_pattern) {
76 ATH5K_ERR(ah->ah_sc, "POST Failed !!!\n");
80 /* Found on ndiswrapper dumps */
81 var_pattern = 0x003b080f;
82 ath5k_hw_reg_write(ah, var_pattern, cur_reg);
85 /* Restore previous value */
86 ath5k_hw_reg_write(ah, init_val, cur_reg);
95 * ath5k_hw_attach - Check if hw is supported and init the needed structs
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
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
105 struct ath5k_hw *ath5k_hw_attach(struct ath5k_softc *sc, u8 mac_version)
108 struct pci_dev *pdev = sc->pdev;
109 struct ath5k_eeprom_info *ee;
113 /*If we passed the test malloc a ath5k_hw struct*/
114 ah = kzalloc(sizeof(struct ath5k_hw), GFP_KERNEL);
117 ATH5K_ERR(sc, "out of memory\n");
122 ah->ah_iobase = sc->iobase;
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;
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;
139 * Set the mac version based on the pci id
141 ah->ah_version = mac_version;
143 /*Fill the ath5k_hw struct with the needed functions*/
144 ret = ath5k_hw_init_desc_functions(ah);
148 /* Bring device out of sleep and reset it's units */
149 ret = ath5k_hw_nic_wakeup(ah, 0, true);
153 /* Get MAC, PHY and RADIO revisions */
154 srev = ath5k_hw_reg_read(ah, AR5K_SREV);
155 ah->ah_mac_srev = srev;
156 ah->ah_mac_version = AR5K_REG_MS(srev, AR5K_SREV_VER);
157 ah->ah_mac_revision = AR5K_REG_MS(srev, AR5K_SREV_REV);
158 ah->ah_phy_revision = ath5k_hw_reg_read(ah, AR5K_PHY_CHIP_ID) &
160 ah->ah_radio_5ghz_revision = ath5k_hw_radio_revision(ah,
162 ah->ah_phy = AR5K_PHY(0);
164 /* Try to identify radio chip based on it's srev */
165 switch (ah->ah_radio_5ghz_revision & 0xf0) {
166 case AR5K_SREV_RAD_5111:
167 ah->ah_radio = AR5K_RF5111;
168 ah->ah_single_chip = false;
169 ah->ah_radio_2ghz_revision = ath5k_hw_radio_revision(ah,
172 case AR5K_SREV_RAD_5112:
173 case AR5K_SREV_RAD_2112:
174 ah->ah_radio = AR5K_RF5112;
175 ah->ah_single_chip = false;
176 ah->ah_radio_2ghz_revision = ath5k_hw_radio_revision(ah,
179 case AR5K_SREV_RAD_2413:
180 ah->ah_radio = AR5K_RF2413;
181 ah->ah_single_chip = true;
183 case AR5K_SREV_RAD_5413:
184 ah->ah_radio = AR5K_RF5413;
185 ah->ah_single_chip = true;
187 case AR5K_SREV_RAD_2316:
188 ah->ah_radio = AR5K_RF2316;
189 ah->ah_single_chip = true;
191 case AR5K_SREV_RAD_2317:
192 ah->ah_radio = AR5K_RF2317;
193 ah->ah_single_chip = true;
195 case AR5K_SREV_RAD_5424:
196 if (ah->ah_mac_version == AR5K_SREV_AR2425 ||
197 ah->ah_mac_version == AR5K_SREV_AR2417){
198 ah->ah_radio = AR5K_RF2425;
199 ah->ah_single_chip = true;
201 ah->ah_radio = AR5K_RF5413;
202 ah->ah_single_chip = true;
206 /* Identify radio based on mac/phy srev */
207 if (ah->ah_version == AR5K_AR5210) {
208 ah->ah_radio = AR5K_RF5110;
209 ah->ah_single_chip = false;
210 } else if (ah->ah_version == AR5K_AR5211) {
211 ah->ah_radio = AR5K_RF5111;
212 ah->ah_single_chip = false;
213 ah->ah_radio_2ghz_revision = ath5k_hw_radio_revision(ah,
215 } else if (ah->ah_mac_version == (AR5K_SREV_AR2425 >> 4) ||
216 ah->ah_mac_version == (AR5K_SREV_AR2417 >> 4) ||
217 ah->ah_phy_revision == AR5K_SREV_PHY_2425) {
218 ah->ah_radio = AR5K_RF2425;
219 ah->ah_single_chip = true;
220 ah->ah_radio_5ghz_revision = AR5K_SREV_RAD_2425;
221 } else if (srev == AR5K_SREV_AR5213A &&
222 ah->ah_phy_revision == AR5K_SREV_PHY_5212B) {
223 ah->ah_radio = AR5K_RF5112;
224 ah->ah_single_chip = false;
225 ah->ah_radio_5ghz_revision = AR5K_SREV_RAD_5112B;
226 } else if (ah->ah_mac_version == (AR5K_SREV_AR2415 >> 4)) {
227 ah->ah_radio = AR5K_RF2316;
228 ah->ah_single_chip = true;
229 ah->ah_radio_5ghz_revision = AR5K_SREV_RAD_2316;
230 } else if (ah->ah_mac_version == (AR5K_SREV_AR5414 >> 4) ||
231 ah->ah_phy_revision == AR5K_SREV_PHY_5413) {
232 ah->ah_radio = AR5K_RF5413;
233 ah->ah_single_chip = true;
234 ah->ah_radio_5ghz_revision = AR5K_SREV_RAD_5413;
235 } else if (ah->ah_mac_version == (AR5K_SREV_AR2414 >> 4) ||
236 ah->ah_phy_revision == AR5K_SREV_PHY_2413) {
237 ah->ah_radio = AR5K_RF2413;
238 ah->ah_single_chip = true;
239 ah->ah_radio_5ghz_revision = AR5K_SREV_RAD_2413;
241 ATH5K_ERR(sc, "Couldn't identify radio revision.\n");
248 /* Return on unsuported chips (unsupported eeprom etc) */
249 if ((srev >= AR5K_SREV_AR5416) &&
250 (srev < AR5K_SREV_AR2425)) {
251 ATH5K_ERR(sc, "Device not yet supported.\n");
259 ret = ath5k_hw_post(ah);
263 /* Enable pci core retry fix on Hainan (5213A) and later chips */
264 if (srev >= AR5K_SREV_AR5213A)
265 AR5K_REG_ENABLE_BITS(ah, AR5K_PCICFG, AR5K_PCICFG_RETRY_FIX);
268 * Get card capabilities, calibration values etc
271 ret = ath5k_eeprom_init(ah);
273 ATH5K_ERR(sc, "unable to init EEPROM\n");
278 * Write PCI-E power save settings
280 if ((ah->ah_version == AR5K_AR5212) && (pdev->is_pcie)) {
281 struct ath5k_eeprom_info *ee = &ah->ah_capabilities.cap_eeprom;
283 ath5k_hw_reg_write(ah, 0x9248fc00, AR5K_PCIE_SERDES);
284 ath5k_hw_reg_write(ah, 0x24924924, AR5K_PCIE_SERDES);
286 /* Shut off RX when elecidle is asserted */
287 ath5k_hw_reg_write(ah, 0x28000039, AR5K_PCIE_SERDES);
288 ath5k_hw_reg_write(ah, 0x53160824, AR5K_PCIE_SERDES);
290 /* If serdes programing is enabled, increase PCI-E
291 * tx power for systems with long trace from host
292 * to minicard connector. */
294 ath5k_hw_reg_write(ah, 0xe5980579, AR5K_PCIE_SERDES);
296 ath5k_hw_reg_write(ah, 0xf6800579, AR5K_PCIE_SERDES);
298 /* Shut off PLL and CLKREQ active in L1 */
299 ath5k_hw_reg_write(ah, 0x001defff, AR5K_PCIE_SERDES);
301 /* Preserve other settings */
302 ath5k_hw_reg_write(ah, 0x1aaabe40, AR5K_PCIE_SERDES);
303 ath5k_hw_reg_write(ah, 0xbe105554, AR5K_PCIE_SERDES);
304 ath5k_hw_reg_write(ah, 0x000e3007, AR5K_PCIE_SERDES);
306 /* Reset SERDES to load new settings */
307 ath5k_hw_reg_write(ah, 0x00000000, AR5K_PCIE_SERDES_RESET);
311 /* Get misc capabilities */
312 ret = ath5k_hw_set_capabilities(ah);
314 ATH5K_ERR(sc, "unable to get device capabilities: 0x%04x\n",
319 /* Crypto settings */
320 ee = &ah->ah_capabilities.cap_eeprom;
321 ah->ah_aes_support = srev >= AR5K_SREV_AR5212_V4 &&
322 (ee->ee_version >= AR5K_EEPROM_VERSION_5_0 &&
323 !AR5K_EEPROM_AES_DIS(ee->ee_misc5));
325 if (srev >= AR5K_SREV_AR2414) {
326 ah->ah_combined_mic = true;
327 AR5K_REG_ENABLE_BITS(ah, AR5K_MISC_MODE,
328 AR5K_MISC_MODE_COMBINED_MIC);
331 /* MAC address is cleared until add_interface */
332 ath5k_hw_set_lladdr(ah, (u8[ETH_ALEN]){});
334 /* Set BSSID to bcast address: ff:ff:ff:ff:ff:ff for now */
335 memset(ah->ah_bssid, 0xff, ETH_ALEN);
336 ath5k_hw_set_associd(ah, ah->ah_bssid, 0);
337 ath5k_hw_set_opmode(ah);
339 ath5k_hw_rfgain_opt_init(ah);
341 /* turn on HW LEDs */
342 ath5k_hw_set_ledstate(ah, AR5K_LED_INIT);
352 * ath5k_hw_detach - Free the ath5k_hw struct
354 * @ah: The &struct ath5k_hw
356 void ath5k_hw_detach(struct ath5k_hw *ah)
358 ATH5K_TRACE(ah->ah_sc);
360 __set_bit(ATH_STAT_INVALID, ah->ah_sc->status);
362 if (ah->ah_rf_banks != NULL)
363 kfree(ah->ah_rf_banks);
365 ath5k_eeprom_detach(ah);
367 /* assume interrupts are down */