drivers/net/wireless/ath/ath9k/pci.c

   1 /*
   2  * Copyright (c) 2008-2011 Atheros Communications Inc.
   3  *
   4  * Permission to use, copy, modify, and/or distribute this software for any
   5  * purpose with or without fee is hereby granted, provided that the above
   6  * copyright notice and this permission notice appear in all copies.
   7  *
   8  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
   9  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  10  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  11  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  12  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  13  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  14  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  15  */
  16
  17 #include <linux/nl80211.h>
  18 #include <linux/pci.h>
  19 #include <linux/ath9k_platform.h>
  20 #include "ath9k.h"
  21
  22 static DEFINE_PCI_DEVICE_TABLE(ath_pci_id_table) = {
  23         { PCI_VDEVICE(ATHEROS, 0x0023) }, /* PCI   */
  24         { PCI_VDEVICE(ATHEROS, 0x0024) }, /* PCI-E */
  25         { PCI_VDEVICE(ATHEROS, 0x0027) }, /* PCI   */
  26         { PCI_VDEVICE(ATHEROS, 0x0029) }, /* PCI   */
  27         { PCI_VDEVICE(ATHEROS, 0x002A) }, /* PCI-E */
  28         { PCI_VDEVICE(ATHEROS, 0x002B) }, /* PCI-E */
  29         { PCI_VDEVICE(ATHEROS, 0x002C) }, /* PCI-E 802.11n bonded out */
  30         { PCI_VDEVICE(ATHEROS, 0x002D) }, /* PCI   */
  31         { PCI_VDEVICE(ATHEROS, 0x002E) }, /* PCI-E */
  32         { PCI_VDEVICE(ATHEROS, 0x0030) }, /* PCI-E  AR9300 */
  33         { PCI_VDEVICE(ATHEROS, 0x0032) }, /* PCI-E  AR9485 */
  34         { 0 }
  35 };
  36
  37 /* return bus cachesize in 4B word units */
  38 static void ath_pci_read_cachesize(struct ath_common *common, int *csz)
  39 {
  40         struct ath_softc *sc = (struct ath_softc *) common->priv;
  41         u8 u8tmp;
  42
  43         pci_read_config_byte(to_pci_dev(sc->dev), PCI_CACHE_LINE_SIZE, &u8tmp);
  44         *csz = (int)u8tmp;
  45
  46         /*
  47          * This check was put in to avoid "unpleasant" consequences if
  48          * the bootrom has not fully initialized all PCI devices.
  49          * Sometimes the cache line size register is not set
  50          */
  51
  52         if (*csz == 0)
  53                 *csz = DEFAULT_CACHELINE >> 2;   /* Use the default size */
  54 }
  55
  56 static bool ath_pci_eeprom_read(struct ath_common *common, u32 off, u16 *data)
  57 {
  58         struct ath_softc *sc = (struct ath_softc *) common->priv;
  59         struct ath9k_platform_data *pdata = sc->dev->platform_data;
  60
  61         if (pdata) {
  62                 if (off >= (ARRAY_SIZE(pdata->eeprom_data))) {
  63                         ath_err(common,
  64                                 "%s: eeprom read failed, offset %08x is out of range\n",
  65                                 __func__, off);
  66                 }
  67
  68                 *data = pdata->eeprom_data[off];
  69         } else {
  70                 struct ath_hw *ah = (struct ath_hw *) common->ah;
  71
  72                 common->ops->read(ah, AR5416_EEPROM_OFFSET +
  73                                       (off << AR5416_EEPROM_S));
  74
  75                 if (!ath9k_hw_wait(ah,
  76                                    AR_EEPROM_STATUS_DATA,
  77                                    AR_EEPROM_STATUS_DATA_BUSY |
  78                                    AR_EEPROM_STATUS_DATA_PROT_ACCESS, 0,
  79                                    AH_WAIT_TIMEOUT)) {
  80                         return false;
  81                 }
  82
  83                 *data = MS(common->ops->read(ah, AR_EEPROM_STATUS_DATA),
  84                            AR_EEPROM_STATUS_DATA_VAL);
  85         }
  86
  87         return true;
  88 }
  89
  90 /*
  91  * Bluetooth coexistance requires disabling ASPM.
  92  */
  93 static void ath_pci_bt_coex_prep(struct ath_common *common)
  94 {
  95         struct ath_softc *sc = (struct ath_softc *) common->priv;
  96         struct pci_dev *pdev = to_pci_dev(sc->dev);
  97         u8 aspm;
  98
  99         if (!pci_is_pcie(pdev))
 100                 return;
 101
 102         pci_read_config_byte(pdev, ATH_PCIE_CAP_LINK_CTRL, &aspm);
 103         aspm &= ~(ATH_PCIE_CAP_LINK_L0S | ATH_PCIE_CAP_LINK_L1);
 104         pci_write_config_byte(pdev, ATH_PCIE_CAP_LINK_CTRL, aspm);
 105 }
 106
 107 static void ath_pci_extn_synch_enable(struct ath_common *common)
 108 {
 109         struct ath_softc *sc = (struct ath_softc *) common->priv;
 110         struct pci_dev *pdev = to_pci_dev(sc->dev);
 111         u8 lnkctl;
 112
 113         pci_read_config_byte(pdev, sc->sc_ah->caps.pcie_lcr_offset, &lnkctl);
 114         lnkctl |= PCI_EXP_LNKCTL_ES;
 115         pci_write_config_byte(pdev, sc->sc_ah->caps.pcie_lcr_offset, lnkctl);
 116 }
 117
 118 static const struct ath_bus_ops ath_pci_bus_ops = {
 119         .ath_bus_type = ATH_PCI,
 120         .read_cachesize = ath_pci_read_cachesize,
 121         .eeprom_read = ath_pci_eeprom_read,
 122         .bt_coex_prep = ath_pci_bt_coex_prep,
 123         .extn_synch_en = ath_pci_extn_synch_enable,
 124 };
 125
 126 static int ath_pci_probe(struct pci_dev *pdev, const struct pci_device_id *id)
 127 {
 128         void __iomem *mem;
 129         struct ath_softc *sc;
 130         struct ieee80211_hw *hw;
 131         u8 csz;
 132         u16 subsysid;
 133         u32 val;
 134         int ret = 0;
 135         char hw_name[64];
 136
 137         if (pci_enable_device(pdev))
 138                 return -EIO;
 139
 140         ret =  pci_set_dma_mask(pdev, DMA_BIT_MASK(32));
 141         if (ret) {
 142                 printk(KERN_ERR "ath9k: 32-bit DMA not available\n");
 143                 goto err_dma;
 144         }
 145
 146         ret = pci_set_consistent_dma_mask(pdev, DMA_BIT_MASK(32));
 147         if (ret) {
 148                 printk(KERN_ERR "ath9k: 32-bit DMA consistent "
 149                         "DMA enable failed\n");
 150                 goto err_dma;
 151         }
 152
 153         /*
 154          * Cache line size is used to size and align various
 155          * structures used to communicate with the hardware.
 156          */
 157         pci_read_config_byte(pdev, PCI_CACHE_LINE_SIZE, &csz);
 158         if (csz == 0) {
 159                 /*
 160                  * Linux 2.4.18 (at least) writes the cache line size
 161                  * register as a 16-bit wide register which is wrong.
 162                  * We must have this setup properly for rx buffer
 163                  * DMA to work so force a reasonable value here if it
 164                  * comes up zero.
 165                  */
 166                 csz = L1_CACHE_BYTES / sizeof(u32);
 167                 pci_write_config_byte(pdev, PCI_CACHE_LINE_SIZE, csz);
 168         }
 169         /*
 170          * The default setting of latency timer yields poor results,
 171          * set it to the value used by other systems. It may be worth
 172          * tweaking this setting more.
 173          */
 174         pci_write_config_byte(pdev, PCI_LATENCY_TIMER, 0xa8);
 175
 176         pci_set_master(pdev);
 177
 178         /*
 179          * Disable the RETRY_TIMEOUT register (0x41) to keep
 180          * PCI Tx retries from interfering with C3 CPU state.
 181          */
 182         pci_read_config_dword(pdev, 0x40, &val);
 183         if ((val & 0x0000ff00) != 0)
 184                 pci_write_config_dword(pdev, 0x40, val & 0xffff00ff);
 185
 186         ret = pci_request_region(pdev, 0, "ath9k");
 187         if (ret) {
 188                 dev_err(&pdev->dev, "PCI memory region reserve error\n");
 189                 ret = -ENODEV;
 190                 goto err_region;
 191         }
 192
 193         mem = pci_iomap(pdev, 0, 0);
 194         if (!mem) {
 195                 printk(KERN_ERR "PCI memory map error\n") ;
 196                 ret = -EIO;
 197                 goto err_iomap;
 198         }
 199
 200         hw = ieee80211_alloc_hw(sizeof(struct ath_softc), &ath9k_ops);
 201         if (!hw) {
 202                 dev_err(&pdev->dev, "No memory for ieee80211_hw\n");
 203                 ret = -ENOMEM;
 204                 goto err_alloc_hw;
 205         }
 206
 207         SET_IEEE80211_DEV(hw, &pdev->dev);
 208         pci_set_drvdata(pdev, hw);
 209
 210         sc = hw->priv;
 211         sc->hw = hw;
 212         sc->dev = &pdev->dev;
 213         sc->mem = mem;
 214
 215         /* Will be cleared in ath9k_start() */
 216         sc->sc_flags |= SC_OP_INVALID;
 217
 218         ret = request_irq(pdev->irq, ath_isr, IRQF_SHARED, "ath9k", sc);
 219         if (ret) {
 220                 dev_err(&pdev->dev, "request_irq failed\n");
 221                 goto err_irq;
 222         }
 223
 224         sc->irq = pdev->irq;
 225
 226         pci_read_config_word(pdev, PCI_SUBSYSTEM_ID, &subsysid);
 227         ret = ath9k_init_device(id->device, sc, subsysid, &ath_pci_bus_ops);
 228         if (ret) {
 229                 dev_err(&pdev->dev, "Failed to initialize device\n");
 230                 goto err_init;
 231         }
 232
 233         ath9k_hw_name(sc->sc_ah, hw_name, sizeof(hw_name));
 234         wiphy_info(hw->wiphy, "%s mem=0x%lx, irq=%d\n",
 235                    hw_name, (unsigned long)mem, pdev->irq);
 236
 237         return 0;
 238
 239 err_init:
 240         free_irq(sc->irq, sc);
 241 err_irq:
 242         ieee80211_free_hw(hw);
 243 err_alloc_hw:
 244         pci_iounmap(pdev, mem);
 245 err_iomap:
 246         pci_release_region(pdev, 0);
 247 err_region:
 248         /* Nothing */
 249 err_dma:
 250         pci_disable_device(pdev);
 251         return ret;
 252 }
 253
 254 static void ath_pci_remove(struct pci_dev *pdev)
 255 {
 256         struct ieee80211_hw *hw = pci_get_drvdata(pdev);
 257         struct ath_softc *sc = hw->priv;
 258         void __iomem *mem = sc->mem;
 259
 260         if (!is_ath9k_unloaded)
 261                 sc->sc_ah->ah_flags |= AH_UNPLUGGED;
 262         ath9k_deinit_device(sc);
 263         free_irq(sc->irq, sc);
 264         ieee80211_free_hw(sc->hw);
 265
 266         pci_iounmap(pdev, mem);
 267         pci_disable_device(pdev);
 268         pci_release_region(pdev, 0);
 269 }
 270
 271 #ifdef CONFIG_PM
 272
 273 static int ath_pci_suspend(struct device *device)
 274 {
 275         struct pci_dev *pdev = to_pci_dev(device);
 276         struct ieee80211_hw *hw = pci_get_drvdata(pdev);
 277         struct ath_softc *sc = hw->priv;
 278
 279         ath9k_hw_set_gpio(sc->sc_ah, sc->sc_ah->led_pin, 1);
 280
 281         /* The device has to be moved to FULLSLEEP forcibly.
 282          * Otherwise the chip never moved to full sleep,
 283          * when no interface is up.
 284          */
 285         ath9k_hw_setpower(sc->sc_ah, ATH9K_PM_FULL_SLEEP);
 286
 287         return 0;
 288 }
 289
 290 static int ath_pci_resume(struct device *device)
 291 {
 292         struct pci_dev *pdev = to_pci_dev(device);
 293         struct ieee80211_hw *hw = pci_get_drvdata(pdev);
 294         struct ath_softc *sc = hw->priv;
 295         u32 val;
 296
 297         /*
 298          * Suspend/Resume resets the PCI configuration space, so we have to
 299          * re-disable the RETRY_TIMEOUT register (0x41) to keep
 300          * PCI Tx retries from interfering with C3 CPU state
 301          */
 302         pci_read_config_dword(pdev, 0x40, &val);
 303         if ((val & 0x0000ff00) != 0)
 304                 pci_write_config_dword(pdev, 0x40, val & 0xffff00ff);
 305
 306         /* Enable LED */
 307         ath9k_hw_cfg_output(sc->sc_ah, sc->sc_ah->led_pin,
 308                             AR_GPIO_OUTPUT_MUX_AS_OUTPUT);
 309         ath9k_hw_set_gpio(sc->sc_ah, sc->sc_ah->led_pin, 1);
 310
 311           /*
 312            * Reset key cache to sane defaults (all entries cleared) instead of
 313            * semi-random values after suspend/resume.
 314            */
 315         ath9k_ps_wakeup(sc);
 316         ath9k_init_crypto(sc);
 317         ath9k_ps_restore(sc);
 318
 319         sc->ps_idle = true;
 320         ath_radio_disable(sc, hw);
 321
 322         return 0;
 323 }
 324
 325 static const struct dev_pm_ops ath9k_pm_ops = {
 326         .suspend = ath_pci_suspend,
 327         .resume = ath_pci_resume,
 328         .freeze = ath_pci_suspend,
 329         .thaw = ath_pci_resume,
 330         .poweroff = ath_pci_suspend,
 331         .restore = ath_pci_resume,
 332 };
 333
 334 #define ATH9K_PM_OPS    (&ath9k_pm_ops)
 335
 336 #else /* !CONFIG_PM */
 337
 338 #define ATH9K_PM_OPS    NULL
 339
 340 #endif /* !CONFIG_PM */
 341
 342
 343 MODULE_DEVICE_TABLE(pci, ath_pci_id_table);
 344
 345 static struct pci_driver ath_pci_driver = {
 346         .name       = "ath9k",
 347         .id_table   = ath_pci_id_table,
 348         .probe      = ath_pci_probe,
 349         .remove     = ath_pci_remove,
 350         .driver.pm  = ATH9K_PM_OPS,
 351 };
 352
 353 int ath_pci_init(void)
 354 {
 355         return pci_register_driver(&ath_pci_driver);
 356 }
 357
 358 void ath_pci_exit(void)
 359 {
 360         pci_unregister_driver(&ath_pci_driver);
 361 }