attach.c

Go to the documentation of this file.

/*------------------------------------------------------------------------------
 *-------------------------        ATH5K Driver          -----------------------
 *------------------------------------------------------------------------------
 *                                                           V1.0  08/02/2010
 *
 *
 *  Feb 2010 - Samuel Cabrero <samuelcabrero@gmail.com>
 *              Initial release
 *
 *  ----------------------------------------------------------------------------
 *  Copyright (C) 2000-2010, Universidad de Zaragoza, SPAIN
 *
 *  Autors:
 *              Samuel Cabrero        <samuelcabrero@gmail.com>
 *              Danilo Tardioli       <dantard@unizar.es>
 *              Jose Luis Villarroel  <jlvilla@unizar.es>
 *
 *  This is a simplified version of the original ath5k driver. It should work 
 *  with all Atheros 5xxx WLAN cards. The 802.11 layer have been removed so it
 *  just send and receive frames over the air, as if it were an Ethernet bus
 *  interface.
 *
 *  Please read ath5k_interface.h for instructions.
 *
 *  This program is distributed under the terms of GPL version 2 and 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.
 *
 *----------------------------------------------------------------------------*/

/*
 * Copyright (c) 2004-2008 Reyk Floeter <reyk@openbsd.org>
 * Copyright (c) 2006-2008 Nick Kossifidis <mickflemm@gmail.com>
 *
 * Permission to use, copy, modify, and distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 *
 */

/*************************************\
* Attach/Detach Functions and helpers *
\*************************************/

#include "ath5k_linux_layer.h"
#include "ath5k.h"
#include "reg.h"
#include "debug.h"
#include "base.h"

static int ath5k_hw_post(struct ath5k_hw *ah)
{

        static const u32 static_pattern[4] = {
                0x55555555,     0xaaaaaaaa,
                0x66666666,     0x99999999
        };
        static const u16 regs[2] = { AR5K_STA_ID0, AR5K_PHY(8) };
        int i, c;
        u16 cur_reg;
        u32 var_pattern;
        u32 init_val;
        u32 cur_val;

        for (c = 0; c < 2; c++) {

                cur_reg = regs[c];

                /* Save previous value */
                init_val = ath5k_hw_reg_read(ah, cur_reg);

                for (i = 0; i < 256; i++) {
                        var_pattern = i << 16 | i;
                        ath5k_hw_reg_write(ah, var_pattern, cur_reg);
                        cur_val = ath5k_hw_reg_read(ah, cur_reg);

                        if (cur_val != var_pattern) {
                                ATH5K_ERR(ah->ah_sc, "POST Failed !!!\n");
                                return -EAGAIN;
                        }

                        /* Found on ndiswrapper dumps */
                        var_pattern = 0x0039080f;
                        ath5k_hw_reg_write(ah, var_pattern, cur_reg);
                }

                for (i = 0; i < 4; i++) {
                        var_pattern = static_pattern[i];
                        ath5k_hw_reg_write(ah, var_pattern, cur_reg);
                        cur_val = ath5k_hw_reg_read(ah, cur_reg);

                        if (cur_val != var_pattern) {
                                ATH5K_ERR(ah->ah_sc, "POST Failed !!!\n");
                                return -EAGAIN;
                        }

                        /* Found on ndiswrapper dumps */
                        var_pattern = 0x003b080f;
                        ath5k_hw_reg_write(ah, var_pattern, cur_reg);
                }

                /* Restore previous value */
                ath5k_hw_reg_write(ah, init_val, cur_reg);

        }

        return 0;

}

int ath5k_hw_attach(struct ath5k_softc *sc)
{
        struct ath5k_hw *ah = sc->ah;
        struct ath5k_eeprom_info *ee;
        int ret;
        u32 srev;
        u8 mac[ETH_ALEN];

        /*
         * HW information
         */
        ah->ah_radar.r_enabled = AR5K_TUNE_RADAR_ALERT;
        ah->ah_turbo = false;
        ah->ah_txpower.txp_tpc = AR5K_TUNE_TPC_TXPOWER;
        ah->ah_imr = 0;
        ah->ah_atim_window = 0;
        ah->ah_aifs = AR5K_TUNE_AIFS;
        ah->ah_cw_min = AR5K_TUNE_CWMIN;
        ah->ah_limit_tx_retries = AR5K_INIT_TX_RETRY;
        ah->ah_software_retry = false;

        /*
         * Find the mac version
         */
        srev = ath5k_hw_reg_read(ah, AR5K_SREV);
        if (srev < AR5K_SREV_AR5311)
                ah->ah_version = AR5K_AR5210;
        else if (srev < AR5K_SREV_AR5212)
                ah->ah_version = AR5K_AR5211;
        else
                ah->ah_version = AR5K_AR5212;

        /*Fill the ath5k_hw struct with the needed functions*/
        ret = ath5k_hw_init_desc_functions(ah);
        if (ret)
                goto err_free;

        /* Bring device out of sleep and reset it's units */
        ret = ath5k_hw_nic_wakeup(ah, 0, true);
        if (ret)
                goto err_free;

        /* Get MAC, PHY and RADIO revisions */
        ah->ah_mac_srev = srev;
        ah->ah_mac_version = AR5K_REG_MS(srev, AR5K_SREV_VER);
        ah->ah_mac_revision = AR5K_REG_MS(srev, AR5K_SREV_REV);
        ah->ah_phy_revision = ath5k_hw_reg_read(ah, AR5K_PHY_CHIP_ID) &
                        0xffffffff;
        ah->ah_radio_5ghz_revision = ath5k_hw_radio_revision(ah,
                        CHANNEL_5GHZ);
        ah->ah_phy = AR5K_PHY(0);

        /* Try to identify radio chip based on it's srev */
        switch (ah->ah_radio_5ghz_revision & 0xf0) {
        case AR5K_SREV_RAD_5111:
                ah->ah_radio = AR5K_RF5111;
                ah->ah_single_chip = false;
                ah->ah_radio_2ghz_revision = ath5k_hw_radio_revision(ah,
                                                        CHANNEL_2GHZ);
                break;
        case AR5K_SREV_RAD_5112:
        case AR5K_SREV_RAD_2112:
                ah->ah_radio = AR5K_RF5112;
                ah->ah_single_chip = false;
                ah->ah_radio_2ghz_revision = ath5k_hw_radio_revision(ah,
                                                        CHANNEL_2GHZ);
                break;
        case AR5K_SREV_RAD_2413:
                ah->ah_radio = AR5K_RF2413;
                ah->ah_single_chip = true;
                break;
        case AR5K_SREV_RAD_5413:
                ah->ah_radio = AR5K_RF5413;
                ah->ah_single_chip = true;
                break;
        case AR5K_SREV_RAD_2316:
                ah->ah_radio = AR5K_RF2316;
                ah->ah_single_chip = true;
                break;
        case AR5K_SREV_RAD_2317:
                ah->ah_radio = AR5K_RF2317;
                ah->ah_single_chip = true;
                break;
        case AR5K_SREV_RAD_5424:
                if (ah->ah_mac_version == AR5K_SREV_AR2425 ||
                ah->ah_mac_version == AR5K_SREV_AR2417){
                        ah->ah_radio = AR5K_RF2425;
                        ah->ah_single_chip = true;
                } else {
                        ah->ah_radio = AR5K_RF5413;
                        ah->ah_single_chip = true;
                }
                break;
        default:
                /* Identify radio based on mac/phy srev */
                if (ah->ah_version == AR5K_AR5210) {
                        ah->ah_radio = AR5K_RF5110;
                        ah->ah_single_chip = false;
                } else if (ah->ah_version == AR5K_AR5211) {
                        ah->ah_radio = AR5K_RF5111;
                        ah->ah_single_chip = false;
                        ah->ah_radio_2ghz_revision = ath5k_hw_radio_revision(ah,
                                                                CHANNEL_2GHZ);
                } else if (ah->ah_mac_version == (AR5K_SREV_AR2425 >> 4) ||
                ah->ah_mac_version == (AR5K_SREV_AR2417 >> 4) ||
                ah->ah_phy_revision == AR5K_SREV_PHY_2425) {
                        ah->ah_radio = AR5K_RF2425;
                        ah->ah_single_chip = true;
                        ah->ah_radio_5ghz_revision = AR5K_SREV_RAD_2425;
                } else if (srev == AR5K_SREV_AR5213A &&
                ah->ah_phy_revision == AR5K_SREV_PHY_5212B) {
                        ah->ah_radio = AR5K_RF5112;
                        ah->ah_single_chip = false;
                        ah->ah_radio_5ghz_revision = AR5K_SREV_RAD_5112B;
                } else if (ah->ah_mac_version == (AR5K_SREV_AR2415 >> 4)) {
                        ah->ah_radio = AR5K_RF2316;
                        ah->ah_single_chip = true;
                        ah->ah_radio_5ghz_revision = AR5K_SREV_RAD_2316;
                } else if (ah->ah_mac_version == (AR5K_SREV_AR5414 >> 4) ||
                ah->ah_phy_revision == AR5K_SREV_PHY_5413) {
                        ah->ah_radio = AR5K_RF5413;
                        ah->ah_single_chip = true;
                        ah->ah_radio_5ghz_revision = AR5K_SREV_RAD_5413;
                } else if (ah->ah_mac_version == (AR5K_SREV_AR2414 >> 4) ||
                ah->ah_phy_revision == AR5K_SREV_PHY_2413) {
                        ah->ah_radio = AR5K_RF2413;
                        ah->ah_single_chip = true;
                        ah->ah_radio_5ghz_revision = AR5K_SREV_RAD_2413;
                } else {
                        ATH5K_ERR(sc, "Couldn't identify radio revision.\n");
                        ret = -ENODEV;
                        goto err_free;
                }
        }


        /* Return on unsuported chips (unsupported eeprom etc) */
        if ((srev >= AR5K_SREV_AR5416) &&
        (srev < AR5K_SREV_AR2425)) {
                ATH5K_ERR(sc, "Device not yet supported.\n");
                ret = -ENODEV;
                goto err_free;
        }

        /*
         * POST
         */
        ret = ath5k_hw_post(ah);
        if (ret)
                goto err_free;

        /* Enable pci core retry fix on Hainan (5213A) and later chips */
        if (srev >= AR5K_SREV_AR5213A)
                AR5K_REG_ENABLE_BITS(ah, AR5K_PCICFG, AR5K_PCICFG_RETRY_FIX);

        /*
         * Get card capabilities, calibration values etc
         * TODO: EEPROM work
         */
        ret = ath5k_eeprom_init(ah);
        if (ret) {
                ATH5K_ERR(sc, "unable to init EEPROM\n");
                goto err_free;
        }

        ee = &ah->ah_capabilities.cap_eeprom;

        /* Get misc capabilities */
        ret = ath5k_hw_set_capabilities(ah);
        if (ret) {
                ATH5K_ERR(sc, "unable to get device capabilities: 0x%04x\n",
                        sc->pdev->dev_id);
                goto err_free;
        }

        if (srev >= AR5K_SREV_AR2414) {
                ah->ah_combined_mic = true;
                AR5K_REG_ENABLE_BITS(ah, AR5K_MISC_MODE,
                        AR5K_MISC_MODE_COMBINED_MIC);
        }

        /* Get MAC address */
        ret = ath5k_eeprom_read_mac(ah, mac);
        if (ret) {
                ATH5K_ERR(sc, "unable to read address from EEPROM: 0x%04x\n",
                        sc->pdev->dev_id);
                goto err_free;
        }

        ath5k_hw_set_lladdr(ah, mac);

        /* Set BSSID to bcast address: ff:ff:ff:ff:ff:ff for now */
        memset(ah->ah_bssid, 0xff, ETH_ALEN);
        ath5k_hw_set_associd(ah, ah->ah_bssid, 0);
        ath5k_hw_set_opmode(ah);

        ath5k_hw_rfgain_opt_init(ah);

        return 0;
err_free:
        return ret;
}

void ath5k_hw_detach(struct ath5k_hw *ah)
{
        ATH5K_TRACE(ah->ah_sc);

        __set_bit(ATH_STAT_INVALID, ah->ah_sc->status);

        if (ah->ah_rf_banks != NULL)
                kfree(ah->ah_rf_banks);

        ath5k_eeprom_detach(ah);

        /* assume interrupts are down */
        kfree(ah);
}