2 * Intel Wireless Multicomm 3200 WiFi driver
4 * Copyright (C) 2009 Intel Corporation. All rights reserved.
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
10 * * Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * * Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in
14 * the documentation and/or other materials provided with the
16 * * Neither the name of Intel Corporation nor the names of its
17 * contributors may be used to endorse or promote products derived
18 * from this software without specific prior written permission.
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 * Intel Corporation <ilw@linux.intel.com>
34 * Samuel Ortiz <samuel.ortiz@intel.com>
35 * Zhu Yi <yi.zhu@intel.com>
40 * This is the SDIO bus specific hooks for iwm.
41 * It also is the module's entry point.
43 * Interesting code paths:
44 * iwm_sdio_probe() (Called by an SDIO bus scan)
45 * -> iwm_if_alloc() (netdev.c)
46 * -> iwm_wdev_alloc() (cfg80211.c, allocates and register our wiphy)
49 * -> alloc_netdev_mq()
50 * -> register_netdev()
53 * -> iwm_if_free() (netdev.c)
54 * -> unregister_netdev()
55 * -> iwm_wdev_free() (cfg80211.c)
56 * -> wiphy_unregister()
59 * iwm_sdio_isr() (called in process context from the SDIO core code)
60 * -> queue_work(.., isr_worker)
61 * -- [async] --> iwm_sdio_isr_worker()
65 #include <linux/kernel.h>
66 #include <linux/slab.h>
67 #include <linux/netdevice.h>
68 #include <linux/debugfs.h>
69 #include <linux/mmc/sdio_ids.h>
70 #include <linux/mmc/sdio.h>
71 #include <linux/mmc/sdio_func.h>
78 static void iwm_sdio_isr_worker(struct work_struct *work)
80 struct iwm_sdio_priv *hw;
82 struct iwm_rx_info *rx_info;
85 unsigned long rx_size;
87 hw = container_of(work, struct iwm_sdio_priv, isr_worker);
90 while (!skb_queue_empty(&iwm->rx_list)) {
91 skb = skb_dequeue(&iwm->rx_list);
92 rx_info = skb_to_rx_info(skb);
93 rx_size = rx_info->rx_size;
96 IWM_HEXDUMP(iwm, DBG, SDIO, "RX: ", rx_buf, rx_size);
97 if (iwm_rx_handle(iwm, rx_buf, rx_size) < 0)
98 IWM_WARN(iwm, "RX error\n");
104 static void iwm_sdio_isr(struct sdio_func *func)
106 struct iwm_priv *iwm;
107 struct iwm_sdio_priv *hw;
108 struct iwm_rx_info *rx_info;
110 unsigned long buf_size, read_size;
114 hw = sdio_get_drvdata(func);
117 buf_size = hw->blk_size;
119 /* We're checking the status */
120 val = sdio_readb(func, IWM_SDIO_INTR_STATUS_ADDR, &ret);
121 if (val == 0 || ret < 0) {
122 IWM_ERR(iwm, "Wrong INTR_STATUS\n");
126 /* See if we have free buffers */
127 if (skb_queue_len(&iwm->rx_list) > IWM_RX_LIST_SIZE) {
128 IWM_ERR(iwm, "No buffer for more Rx frames\n");
132 /* We first read the transaction size */
133 read_size = sdio_readb(func, IWM_SDIO_INTR_GET_SIZE_ADDR + 1, &ret);
134 read_size = read_size << 8;
137 IWM_ERR(iwm, "Couldn't read the xfer size\n");
141 /* We need to clear the INT register */
142 sdio_writeb(func, 1, IWM_SDIO_INTR_CLEAR_ADDR, &ret);
144 IWM_ERR(iwm, "Couldn't clear the INT register\n");
148 while (buf_size < read_size)
151 skb = dev_alloc_skb(buf_size);
153 IWM_ERR(iwm, "Couldn't alloc RX skb\n");
156 rx_info = skb_to_rx_info(skb);
157 rx_info->rx_size = read_size;
158 rx_info->rx_buf_size = buf_size;
160 /* Now we can read the actual buffer */
161 ret = sdio_memcpy_fromio(func, skb_put(skb, read_size),
162 IWM_SDIO_DATA_ADDR, read_size);
164 /* The skb is put on a driver's specific Rx SKB list */
165 skb_queue_tail(&iwm->rx_list, skb);
167 /* We can now schedule the actual worker */
168 queue_work(hw->isr_wq, &hw->isr_worker);
171 static void iwm_sdio_rx_free(struct iwm_sdio_priv *hw)
173 struct iwm_priv *iwm = hw_to_iwm(hw);
175 flush_workqueue(hw->isr_wq);
177 skb_queue_purge(&iwm->rx_list);
181 static int if_sdio_enable(struct iwm_priv *iwm)
183 struct iwm_sdio_priv *hw = iwm_to_if_sdio(iwm);
186 sdio_claim_host(hw->func);
188 ret = sdio_enable_func(hw->func);
190 IWM_ERR(iwm, "Couldn't enable the device: is TOP driver "
191 "loaded and functional?\n");
197 ret = sdio_claim_irq(hw->func, iwm_sdio_isr);
199 IWM_ERR(iwm, "Failed to claim irq: %d\n", ret);
203 sdio_writeb(hw->func, 1, IWM_SDIO_INTR_ENABLE_ADDR, &ret);
205 IWM_ERR(iwm, "Couldn't enable INTR: %d\n", ret);
209 sdio_release_host(hw->func);
211 IWM_DBG_SDIO(iwm, INFO, "IWM SDIO enable\n");
216 sdio_release_irq(hw->func);
218 sdio_release_host(hw->func);
223 static int if_sdio_disable(struct iwm_priv *iwm)
225 struct iwm_sdio_priv *hw = iwm_to_if_sdio(iwm);
228 sdio_claim_host(hw->func);
229 sdio_writeb(hw->func, 0, IWM_SDIO_INTR_ENABLE_ADDR, &ret);
231 IWM_WARN(iwm, "Couldn't disable INTR: %d\n", ret);
233 sdio_release_irq(hw->func);
234 sdio_disable_func(hw->func);
235 sdio_release_host(hw->func);
237 iwm_sdio_rx_free(hw);
241 IWM_DBG_SDIO(iwm, INFO, "IWM SDIO disable\n");
246 static int if_sdio_send_chunk(struct iwm_priv *iwm, u8 *buf, int count)
248 struct iwm_sdio_priv *hw = iwm_to_if_sdio(iwm);
249 int aligned_count = ALIGN(count, hw->blk_size);
252 if ((unsigned long)buf & 0x3) {
253 IWM_ERR(iwm, "buf <%p> is not dword aligned\n", buf);
254 /* TODO: Is this a hardware limitation? use get_unligned */
258 sdio_claim_host(hw->func);
259 ret = sdio_memcpy_toio(hw->func, IWM_SDIO_DATA_ADDR, buf,
261 sdio_release_host(hw->func);
267 static int iwm_debugfs_sdio_open(struct inode *inode, struct file *filp)
269 filp->private_data = inode->i_private;
273 static ssize_t iwm_debugfs_sdio_read(struct file *filp, char __user *buffer,
274 size_t count, loff_t *ppos)
276 struct iwm_priv *iwm = filp->private_data;
277 struct iwm_sdio_priv *hw = iwm_to_if_sdio(iwm);
280 int buf_len = 4096, ret;
285 if (count < sizeof(buf))
288 buf = kzalloc(buf_len, GFP_KERNEL);
292 sdio_claim_host(hw->func);
294 cccr = sdio_f0_readb(hw->func, SDIO_CCCR_IOEx, &ret);
296 IWM_ERR(iwm, "Could not read SDIO_CCCR_IOEx\n");
299 len += snprintf(buf + len, buf_len - len, "CCCR_IOEx: 0x%x\n", cccr);
301 cccr = sdio_f0_readb(hw->func, SDIO_CCCR_IORx, &ret);
303 IWM_ERR(iwm, "Could not read SDIO_CCCR_IORx\n");
306 len += snprintf(buf + len, buf_len - len, "CCCR_IORx: 0x%x\n", cccr);
309 cccr = sdio_f0_readb(hw->func, SDIO_CCCR_IENx, &ret);
311 IWM_ERR(iwm, "Could not read SDIO_CCCR_IENx\n");
314 len += snprintf(buf + len, buf_len - len, "CCCR_IENx: 0x%x\n", cccr);
317 cccr = sdio_f0_readb(hw->func, SDIO_CCCR_INTx, &ret);
319 IWM_ERR(iwm, "Could not read SDIO_CCCR_INTx\n");
322 len += snprintf(buf + len, buf_len - len, "CCCR_INTx: 0x%x\n", cccr);
325 cccr = sdio_f0_readb(hw->func, SDIO_CCCR_ABORT, &ret);
327 IWM_ERR(iwm, "Could not read SDIO_CCCR_ABORTx\n");
330 len += snprintf(buf + len, buf_len - len, "CCCR_ABORT: 0x%x\n", cccr);
332 cccr = sdio_f0_readb(hw->func, SDIO_CCCR_IF, &ret);
334 IWM_ERR(iwm, "Could not read SDIO_CCCR_IF\n");
337 len += snprintf(buf + len, buf_len - len, "CCCR_IF: 0x%x\n", cccr);
340 cccr = sdio_f0_readb(hw->func, SDIO_CCCR_CAPS, &ret);
342 IWM_ERR(iwm, "Could not read SDIO_CCCR_CAPS\n");
345 len += snprintf(buf + len, buf_len - len, "CCCR_CAPS: 0x%x\n", cccr);
347 cccr = sdio_f0_readb(hw->func, SDIO_CCCR_CIS, &ret);
349 IWM_ERR(iwm, "Could not read SDIO_CCCR_CIS\n");
352 len += snprintf(buf + len, buf_len - len, "CCCR_CIS: 0x%x\n", cccr);
354 ret = simple_read_from_buffer(buffer, len, ppos, buf, buf_len);
356 sdio_release_host(hw->func);
363 static const struct file_operations iwm_debugfs_sdio_fops = {
364 .owner = THIS_MODULE,
365 .open = iwm_debugfs_sdio_open,
366 .read = iwm_debugfs_sdio_read,
367 .llseek = default_llseek,
370 static void if_sdio_debugfs_init(struct iwm_priv *iwm, struct dentry *parent_dir)
372 struct iwm_sdio_priv *hw = iwm_to_if_sdio(iwm);
374 hw->cccr_dentry = debugfs_create_file("cccr", 0200,
376 &iwm_debugfs_sdio_fops);
379 static void if_sdio_debugfs_exit(struct iwm_priv *iwm)
381 struct iwm_sdio_priv *hw = iwm_to_if_sdio(iwm);
383 debugfs_remove(hw->cccr_dentry);
386 static struct iwm_if_ops if_sdio_ops = {
387 .enable = if_sdio_enable,
388 .disable = if_sdio_disable,
389 .send_chunk = if_sdio_send_chunk,
390 .debugfs_init = if_sdio_debugfs_init,
391 .debugfs_exit = if_sdio_debugfs_exit,
392 .umac_name = "iwmc3200wifi-umac-sdio.bin",
393 .calib_lmac_name = "iwmc3200wifi-calib-sdio.bin",
394 .lmac_name = "iwmc3200wifi-lmac-sdio.bin",
396 MODULE_FIRMWARE("iwmc3200wifi-umac-sdio.bin");
397 MODULE_FIRMWARE("iwmc3200wifi-calib-sdio.bin");
398 MODULE_FIRMWARE("iwmc3200wifi-lmac-sdio.bin");
400 static int iwm_sdio_probe(struct sdio_func *func,
401 const struct sdio_device_id *id)
403 struct iwm_priv *iwm;
404 struct iwm_sdio_priv *hw;
405 struct device *dev = &func->dev;
408 /* check if TOP has already initialized the card */
409 sdio_claim_host(func);
410 ret = sdio_enable_func(func);
412 dev_err(dev, "wait for TOP to enable the device\n");
413 sdio_release_host(func);
417 ret = sdio_set_block_size(func, IWM_SDIO_BLK_SIZE);
419 sdio_disable_func(func);
420 sdio_release_host(func);
423 dev_err(dev, "Failed to set block size: %d\n", ret);
427 iwm = iwm_if_alloc(sizeof(struct iwm_sdio_priv), dev, &if_sdio_ops);
429 dev_err(dev, "allocate SDIO interface failed\n");
433 hw = iwm_private(iwm);
436 iwm_debugfs_init(iwm);
438 sdio_set_drvdata(func, hw);
441 hw->blk_size = IWM_SDIO_BLK_SIZE;
443 hw->isr_wq = create_singlethread_workqueue(KBUILD_MODNAME "_sdio");
449 INIT_WORK(&hw->isr_worker, iwm_sdio_isr_worker);
451 ret = iwm_if_add(iwm);
453 dev_err(dev, "add SDIO interface failed\n");
457 dev_info(dev, "IWM SDIO probe\n");
462 destroy_workqueue(hw->isr_wq);
464 iwm_debugfs_exit(iwm);
469 static void iwm_sdio_remove(struct sdio_func *func)
471 struct iwm_sdio_priv *hw = sdio_get_drvdata(func);
472 struct iwm_priv *iwm = hw_to_iwm(hw);
473 struct device *dev = &func->dev;
476 destroy_workqueue(hw->isr_wq);
477 iwm_debugfs_exit(iwm);
480 sdio_set_drvdata(func, NULL);
482 dev_info(dev, "IWM SDIO remove\n");
485 static const struct sdio_device_id iwm_sdio_ids[] = {
487 { SDIO_DEVICE(SDIO_VENDOR_ID_INTEL, 0x1403) },
489 { SDIO_DEVICE(SDIO_VENDOR_ID_INTEL, 0x1408) },
490 { /* end: all zeroes */ },
492 MODULE_DEVICE_TABLE(sdio, iwm_sdio_ids);
494 static struct sdio_driver iwm_sdio_driver = {
496 .id_table = iwm_sdio_ids,
497 .probe = iwm_sdio_probe,
498 .remove = iwm_sdio_remove,
501 static int __init iwm_sdio_init_module(void)
503 return sdio_register_driver(&iwm_sdio_driver);
506 static void __exit iwm_sdio_exit_module(void)
508 sdio_unregister_driver(&iwm_sdio_driver);
511 module_init(iwm_sdio_init_module);
512 module_exit(iwm_sdio_exit_module);
514 MODULE_LICENSE("GPL");
515 MODULE_AUTHOR(IWM_COPYRIGHT " " IWM_AUTHOR);