xref: /openbmc/linux/drivers/net/wireless/ath/ath9k/pci.c (revision baa7eb025ab14f3cba2e35c0a8648f9c9f01d24f)
1 /*
2  * Copyright (c) 2008-2009 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 "unplesant" 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_wiphy *aphy;
130 	struct ath_softc *sc;
131 	struct ieee80211_hw *hw;
132 	u8 csz;
133 	u16 subsysid;
134 	u32 val;
135 	int ret = 0;
136 	char hw_name[64];
137 
138 	if (pci_enable_device(pdev))
139 		return -EIO;
140 
141 	ret =  pci_set_dma_mask(pdev, DMA_BIT_MASK(32));
142 	if (ret) {
143 		printk(KERN_ERR "ath9k: 32-bit DMA not available\n");
144 		goto err_dma;
145 	}
146 
147 	ret = pci_set_consistent_dma_mask(pdev, DMA_BIT_MASK(32));
148 	if (ret) {
149 		printk(KERN_ERR "ath9k: 32-bit DMA consistent "
150 			"DMA enable failed\n");
151 		goto err_dma;
152 	}
153 
154 	/*
155 	 * Cache line size is used to size and align various
156 	 * structures used to communicate with the hardware.
157 	 */
158 	pci_read_config_byte(pdev, PCI_CACHE_LINE_SIZE, &csz);
159 	if (csz == 0) {
160 		/*
161 		 * Linux 2.4.18 (at least) writes the cache line size
162 		 * register as a 16-bit wide register which is wrong.
163 		 * We must have this setup properly for rx buffer
164 		 * DMA to work so force a reasonable value here if it
165 		 * comes up zero.
166 		 */
167 		csz = L1_CACHE_BYTES / sizeof(u32);
168 		pci_write_config_byte(pdev, PCI_CACHE_LINE_SIZE, csz);
169 	}
170 	/*
171 	 * The default setting of latency timer yields poor results,
172 	 * set it to the value used by other systems. It may be worth
173 	 * tweaking this setting more.
174 	 */
175 	pci_write_config_byte(pdev, PCI_LATENCY_TIMER, 0xa8);
176 
177 	pci_set_master(pdev);
178 
179 	/*
180 	 * Disable the RETRY_TIMEOUT register (0x41) to keep
181 	 * PCI Tx retries from interfering with C3 CPU state.
182 	 */
183 	pci_read_config_dword(pdev, 0x40, &val);
184 	if ((val & 0x0000ff00) != 0)
185 		pci_write_config_dword(pdev, 0x40, val & 0xffff00ff);
186 
187 	ret = pci_request_region(pdev, 0, "ath9k");
188 	if (ret) {
189 		dev_err(&pdev->dev, "PCI memory region reserve error\n");
190 		ret = -ENODEV;
191 		goto err_region;
192 	}
193 
194 	mem = pci_iomap(pdev, 0, 0);
195 	if (!mem) {
196 		printk(KERN_ERR "PCI memory map error\n") ;
197 		ret = -EIO;
198 		goto err_iomap;
199 	}
200 
201 	hw = ieee80211_alloc_hw(sizeof(struct ath_wiphy) +
202 				sizeof(struct ath_softc), &ath9k_ops);
203 	if (!hw) {
204 		dev_err(&pdev->dev, "No memory for ieee80211_hw\n");
205 		ret = -ENOMEM;
206 		goto err_alloc_hw;
207 	}
208 
209 	SET_IEEE80211_DEV(hw, &pdev->dev);
210 	pci_set_drvdata(pdev, hw);
211 
212 	aphy = hw->priv;
213 	sc = (struct ath_softc *) (aphy + 1);
214 	aphy->sc = sc;
215 	aphy->hw = hw;
216 	sc->pri_wiphy = aphy;
217 	sc->hw = hw;
218 	sc->dev = &pdev->dev;
219 	sc->mem = mem;
220 
221 	/* Will be cleared in ath9k_start() */
222 	sc->sc_flags |= SC_OP_INVALID;
223 
224 	ret = request_irq(pdev->irq, ath_isr, IRQF_SHARED, "ath9k", sc);
225 	if (ret) {
226 		dev_err(&pdev->dev, "request_irq failed\n");
227 		goto err_irq;
228 	}
229 
230 	sc->irq = pdev->irq;
231 
232 	pci_read_config_word(pdev, PCI_SUBSYSTEM_ID, &subsysid);
233 	ret = ath9k_init_device(id->device, sc, subsysid, &ath_pci_bus_ops);
234 	if (ret) {
235 		dev_err(&pdev->dev, "Failed to initialize device\n");
236 		goto err_init;
237 	}
238 
239 	ath9k_hw_name(sc->sc_ah, hw_name, sizeof(hw_name));
240 	wiphy_info(hw->wiphy, "%s mem=0x%lx, irq=%d\n",
241 		   hw_name, (unsigned long)mem, pdev->irq);
242 
243 	return 0;
244 
245 err_init:
246 	free_irq(sc->irq, sc);
247 err_irq:
248 	ieee80211_free_hw(hw);
249 err_alloc_hw:
250 	pci_iounmap(pdev, mem);
251 err_iomap:
252 	pci_release_region(pdev, 0);
253 err_region:
254 	/* Nothing */
255 err_dma:
256 	pci_disable_device(pdev);
257 	return ret;
258 }
259 
260 static void ath_pci_remove(struct pci_dev *pdev)
261 {
262 	struct ieee80211_hw *hw = pci_get_drvdata(pdev);
263 	struct ath_wiphy *aphy = hw->priv;
264 	struct ath_softc *sc = aphy->sc;
265 	void __iomem *mem = sc->mem;
266 
267 	if (!is_ath9k_unloaded)
268 		sc->sc_ah->ah_flags |= AH_UNPLUGGED;
269 	ath9k_deinit_device(sc);
270 	free_irq(sc->irq, sc);
271 	ieee80211_free_hw(sc->hw);
272 
273 	pci_iounmap(pdev, mem);
274 	pci_disable_device(pdev);
275 	pci_release_region(pdev, 0);
276 }
277 
278 #ifdef CONFIG_PM
279 
280 static int ath_pci_suspend(struct device *device)
281 {
282 	struct pci_dev *pdev = to_pci_dev(device);
283 	struct ieee80211_hw *hw = pci_get_drvdata(pdev);
284 	struct ath_wiphy *aphy = hw->priv;
285 	struct ath_softc *sc = aphy->sc;
286 
287 	ath9k_hw_set_gpio(sc->sc_ah, sc->sc_ah->led_pin, 1);
288 
289 	return 0;
290 }
291 
292 static int ath_pci_resume(struct device *device)
293 {
294 	struct pci_dev *pdev = to_pci_dev(device);
295 	struct ieee80211_hw *hw = pci_get_drvdata(pdev);
296 	struct ath_wiphy *aphy = hw->priv;
297 	struct ath_softc *sc = aphy->sc;
298 	u32 val;
299 
300 	/*
301 	 * Suspend/Resume resets the PCI configuration space, so we have to
302 	 * re-disable the RETRY_TIMEOUT register (0x41) to keep
303 	 * PCI Tx retries from interfering with C3 CPU state
304 	 */
305 	pci_read_config_dword(pdev, 0x40, &val);
306 	if ((val & 0x0000ff00) != 0)
307 		pci_write_config_dword(pdev, 0x40, val & 0xffff00ff);
308 
309 	/* Enable LED */
310 	ath9k_hw_cfg_output(sc->sc_ah, sc->sc_ah->led_pin,
311 			    AR_GPIO_OUTPUT_MUX_AS_OUTPUT);
312 	ath9k_hw_set_gpio(sc->sc_ah, sc->sc_ah->led_pin, 1);
313 
314 	  /*
315 	   * Reset key cache to sane defaults (all entries cleared) instead of
316 	   * semi-random values after suspend/resume.
317 	   */
318 	ath9k_ps_wakeup(sc);
319 	ath9k_init_crypto(sc);
320 	ath9k_ps_restore(sc);
321 
322 	sc->ps_idle = true;
323 	ath9k_set_wiphy_idle(aphy, true);
324 	ath_radio_disable(sc, hw);
325 
326 	return 0;
327 }
328 
329 static const struct dev_pm_ops ath9k_pm_ops = {
330 	.suspend = ath_pci_suspend,
331 	.resume = ath_pci_resume,
332 	.freeze = ath_pci_suspend,
333 	.thaw = ath_pci_resume,
334 	.poweroff = ath_pci_suspend,
335 	.restore = ath_pci_resume,
336 };
337 
338 #define ATH9K_PM_OPS	(&ath9k_pm_ops)
339 
340 #else /* !CONFIG_PM */
341 
342 #define ATH9K_PM_OPS	NULL
343 
344 #endif /* !CONFIG_PM */
345 
346 
347 MODULE_DEVICE_TABLE(pci, ath_pci_id_table);
348 
349 static struct pci_driver ath_pci_driver = {
350 	.name       = "ath9k",
351 	.id_table   = ath_pci_id_table,
352 	.probe      = ath_pci_probe,
353 	.remove     = ath_pci_remove,
354 	.driver.pm  = ATH9K_PM_OPS,
355 };
356 
357 int ath_pci_init(void)
358 {
359 	return pci_register_driver(&ath_pci_driver);
360 }
361 
362 void ath_pci_exit(void)
363 {
364 	pci_unregister_driver(&ath_pci_driver);
365 }
366