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/netdevice.h>
67 #include <linux/debugfs.h>
68 #include <linux/mmc/sdio_ids.h>
69 #include <linux/mmc/sdio.h>
70 #include <linux/mmc/sdio_func.h>
77 static void iwm_sdio_isr_worker(struct work_struct *work)
79 struct iwm_sdio_priv *hw;
81 struct iwm_rx_info *rx_info;
84 unsigned long rx_size;
86 hw = container_of(work, struct iwm_sdio_priv, isr_worker);
89 while (!skb_queue_empty(&iwm->rx_list)) {
90 skb = skb_dequeue(&iwm->rx_list);
91 rx_info = skb_to_rx_info(skb);
92 rx_size = rx_info->rx_size;
95 IWM_HEXDUMP(iwm, DBG, SDIO, "RX: ", rx_buf, rx_size);
96 if (iwm_rx_handle(iwm, rx_buf, rx_size) < 0)
97 IWM_WARN(iwm, "RX error\n");
103 static void iwm_sdio_isr(struct sdio_func *func)
105 struct iwm_priv *iwm;
106 struct iwm_sdio_priv *hw;
107 struct iwm_rx_info *rx_info;
109 unsigned long buf_size, read_size;
113 hw = sdio_get_drvdata(func);
116 buf_size = hw->blk_size;
118 /* We're checking the status */
119 val = sdio_readb(func, IWM_SDIO_INTR_STATUS_ADDR, &ret);
120 if (val == 0 || ret < 0) {
121 IWM_ERR(iwm, "Wrong INTR_STATUS\n");
125 /* See if we have free buffers */
126 if (skb_queue_len(&iwm->rx_list) > IWM_RX_LIST_SIZE) {
127 IWM_ERR(iwm, "No buffer for more Rx frames\n");
131 /* We first read the transaction size */
132 read_size = sdio_readb(func, IWM_SDIO_INTR_GET_SIZE_ADDR + 1, &ret);
133 read_size = read_size << 8;
136 IWM_ERR(iwm, "Couldn't read the xfer size\n");
140 /* We need to clear the INT register */
141 sdio_writeb(func, 1, IWM_SDIO_INTR_CLEAR_ADDR, &ret);
143 IWM_ERR(iwm, "Couldn't clear the INT register\n");
147 while (buf_size < read_size)
150 skb = dev_alloc_skb(buf_size);
152 IWM_ERR(iwm, "Couldn't alloc RX skb\n");
155 rx_info = skb_to_rx_info(skb);
156 rx_info->rx_size = read_size;
157 rx_info->rx_buf_size = buf_size;
159 /* Now we can read the actual buffer */
160 ret = sdio_memcpy_fromio(func, skb_put(skb, read_size),
161 IWM_SDIO_DATA_ADDR, read_size);
163 /* The skb is put on a driver's specific Rx SKB list */
164 skb_queue_tail(&iwm->rx_list, skb);
166 /* We can now schedule the actual worker */
167 queue_work(hw->isr_wq, &hw->isr_worker);
170 static void iwm_sdio_rx_free(struct iwm_sdio_priv *hw)
172 struct iwm_priv *iwm = hw_to_iwm(hw);
174 flush_workqueue(hw->isr_wq);
176 skb_queue_purge(&iwm->rx_list);
180 static int if_sdio_enable(struct iwm_priv *iwm)
182 struct iwm_sdio_priv *hw = iwm_to_if_sdio(iwm);
185 sdio_claim_host(hw->func);
187 ret = sdio_enable_func(hw->func);
189 IWM_ERR(iwm, "Couldn't enable the device: is TOP driver "
190 "loaded and functional?\n");
196 ret = sdio_claim_irq(hw->func, iwm_sdio_isr);
198 IWM_ERR(iwm, "Failed to claim irq: %d\n", ret);
202 sdio_writeb(hw->func, 1, IWM_SDIO_INTR_ENABLE_ADDR, &ret);
204 IWM_ERR(iwm, "Couldn't enable INTR: %d\n", ret);
208 sdio_release_host(hw->func);
210 IWM_DBG_SDIO(iwm, INFO, "IWM SDIO enable\n");
215 sdio_release_irq(hw->func);
217 sdio_release_host(hw->func);
222 static int if_sdio_disable(struct iwm_priv *iwm)
224 struct iwm_sdio_priv *hw = iwm_to_if_sdio(iwm);
227 sdio_claim_host(hw->func);
228 sdio_writeb(hw->func, 0, IWM_SDIO_INTR_ENABLE_ADDR, &ret);
230 IWM_WARN(iwm, "Couldn't disable INTR: %d\n", ret);
232 sdio_release_irq(hw->func);
233 sdio_disable_func(hw->func);
234 sdio_release_host(hw->func);
236 iwm_sdio_rx_free(hw);
240 IWM_DBG_SDIO(iwm, INFO, "IWM SDIO disable\n");
245 static int if_sdio_send_chunk(struct iwm_priv *iwm, u8 *buf, int count)
247 struct iwm_sdio_priv *hw = iwm_to_if_sdio(iwm);
248 int aligned_count = ALIGN(count, hw->blk_size);
251 if ((unsigned long)buf & 0x3) {
252 IWM_ERR(iwm, "buf <%p> is not dword aligned\n", buf);
253 /* TODO: Is this a hardware limitation? use get_unligned */
257 sdio_claim_host(hw->func);
258 ret = sdio_memcpy_toio(hw->func, IWM_SDIO_DATA_ADDR, buf,
260 sdio_release_host(hw->func);
266 static int iwm_debugfs_sdio_open(struct inode *inode, struct file *filp)
268 filp->private_data = inode->i_private;
272 static ssize_t iwm_debugfs_sdio_read(struct file *filp, char __user *buffer,
273 size_t count, loff_t *ppos)
275 struct iwm_priv *iwm = filp->private_data;
276 struct iwm_sdio_priv *hw = iwm_to_if_sdio(iwm);
279 int buf_len = 4096, ret;
284 if (count < sizeof(buf))
287 buf = kzalloc(buf_len, GFP_KERNEL);
291 sdio_claim_host(hw->func);
293 cccr = sdio_f0_readb(hw->func, SDIO_CCCR_IOEx, &ret);
295 IWM_ERR(iwm, "Could not read SDIO_CCCR_IOEx\n");
298 len += snprintf(buf + len, buf_len - len, "CCCR_IOEx: 0x%x\n", cccr);
300 cccr = sdio_f0_readb(hw->func, SDIO_CCCR_IORx, &ret);
302 IWM_ERR(iwm, "Could not read SDIO_CCCR_IORx\n");
305 len += snprintf(buf + len, buf_len - len, "CCCR_IORx: 0x%x\n", cccr);
308 cccr = sdio_f0_readb(hw->func, SDIO_CCCR_IENx, &ret);
310 IWM_ERR(iwm, "Could not read SDIO_CCCR_IENx\n");
313 len += snprintf(buf + len, buf_len - len, "CCCR_IENx: 0x%x\n", cccr);
316 cccr = sdio_f0_readb(hw->func, SDIO_CCCR_INTx, &ret);
318 IWM_ERR(iwm, "Could not read SDIO_CCCR_INTx\n");
321 len += snprintf(buf + len, buf_len - len, "CCCR_INTx: 0x%x\n", cccr);
324 cccr = sdio_f0_readb(hw->func, SDIO_CCCR_ABORT, &ret);
326 IWM_ERR(iwm, "Could not read SDIO_CCCR_ABORTx\n");
329 len += snprintf(buf + len, buf_len - len, "CCCR_ABORT: 0x%x\n", cccr);
331 cccr = sdio_f0_readb(hw->func, SDIO_CCCR_IF, &ret);
333 IWM_ERR(iwm, "Could not read SDIO_CCCR_IF\n");
336 len += snprintf(buf + len, buf_len - len, "CCCR_IF: 0x%x\n", cccr);
339 cccr = sdio_f0_readb(hw->func, SDIO_CCCR_CAPS, &ret);
341 IWM_ERR(iwm, "Could not read SDIO_CCCR_CAPS\n");
344 len += snprintf(buf + len, buf_len - len, "CCCR_CAPS: 0x%x\n", cccr);
346 cccr = sdio_f0_readb(hw->func, SDIO_CCCR_CIS, &ret);
348 IWM_ERR(iwm, "Could not read SDIO_CCCR_CIS\n");
351 len += snprintf(buf + len, buf_len - len, "CCCR_CIS: 0x%x\n", cccr);
353 ret = simple_read_from_buffer(buffer, len, ppos, buf, buf_len);
355 sdio_release_host(hw->func);
362 static const struct file_operations iwm_debugfs_sdio_fops = {
363 .owner = THIS_MODULE,
364 .open = iwm_debugfs_sdio_open,
365 .read = iwm_debugfs_sdio_read,
368 static int if_sdio_debugfs_init(struct iwm_priv *iwm, struct dentry *parent_dir)
371 struct iwm_sdio_priv *hw = iwm_to_if_sdio(iwm);
373 hw->cccr_dentry = debugfs_create_file("cccr", 0200,
375 &iwm_debugfs_sdio_fops);
376 result = PTR_ERR(hw->cccr_dentry);
377 if (IS_ERR(hw->cccr_dentry) && (result != -ENODEV)) {
378 IWM_ERR(iwm, "Couldn't create CCCR entry: %d\n", result);
385 static void if_sdio_debugfs_exit(struct iwm_priv *iwm)
387 struct iwm_sdio_priv *hw = iwm_to_if_sdio(iwm);
389 debugfs_remove(hw->cccr_dentry);
392 static struct iwm_if_ops if_sdio_ops = {
393 .enable = if_sdio_enable,
394 .disable = if_sdio_disable,
395 .send_chunk = if_sdio_send_chunk,
396 .debugfs_init = if_sdio_debugfs_init,
397 .debugfs_exit = if_sdio_debugfs_exit,
398 .umac_name = "iwmc3200wifi-umac-sdio.bin",
399 .calib_lmac_name = "iwmc3200wifi-calib-sdio.bin",
400 .lmac_name = "iwmc3200wifi-lmac-sdio.bin",
403 static int iwm_sdio_probe(struct sdio_func *func,
404 const struct sdio_device_id *id)
406 struct iwm_priv *iwm;
407 struct iwm_sdio_priv *hw;
408 struct device *dev = &func->dev;
411 /* check if TOP has already initialized the card */
412 sdio_claim_host(func);
413 ret = sdio_enable_func(func);
415 dev_err(dev, "wait for TOP to enable the device\n");
416 sdio_release_host(func);
420 ret = sdio_set_block_size(func, IWM_SDIO_BLK_SIZE);
422 sdio_disable_func(func);
423 sdio_release_host(func);
426 dev_err(dev, "Failed to set block size: %d\n", ret);
430 iwm = iwm_if_alloc(sizeof(struct iwm_sdio_priv), dev, &if_sdio_ops);
432 dev_err(dev, "allocate SDIO interface failed\n");
436 hw = iwm_private(iwm);
439 ret = iwm_debugfs_init(iwm);
441 IWM_ERR(iwm, "Debugfs registration failed\n");
445 sdio_set_drvdata(func, hw);
448 hw->blk_size = IWM_SDIO_BLK_SIZE;
450 hw->isr_wq = create_singlethread_workqueue(KBUILD_MODNAME "_sdio");
456 INIT_WORK(&hw->isr_worker, iwm_sdio_isr_worker);
458 ret = iwm_if_add(iwm);
460 dev_err(dev, "add SDIO interface failed\n");
464 dev_info(dev, "IWM SDIO probe\n");
469 destroy_workqueue(hw->isr_wq);
471 iwm_debugfs_exit(iwm);
477 static void iwm_sdio_remove(struct sdio_func *func)
479 struct iwm_sdio_priv *hw = sdio_get_drvdata(func);
480 struct iwm_priv *iwm = hw_to_iwm(hw);
481 struct device *dev = &func->dev;
484 destroy_workqueue(hw->isr_wq);
485 iwm_debugfs_exit(iwm);
488 sdio_set_drvdata(func, NULL);
490 dev_info(dev, "IWM SDIO remove\n");
495 static const struct sdio_device_id iwm_sdio_ids[] = {
497 { SDIO_DEVICE(SDIO_VENDOR_ID_INTEL, 0x1403) },
499 { SDIO_DEVICE(SDIO_VENDOR_ID_INTEL, 0x1408) },
500 { /* end: all zeroes */ },
502 MODULE_DEVICE_TABLE(sdio, iwm_sdio_ids);
504 static struct sdio_driver iwm_sdio_driver = {
506 .id_table = iwm_sdio_ids,
507 .probe = iwm_sdio_probe,
508 .remove = iwm_sdio_remove,
511 static int __init iwm_sdio_init_module(void)
513 return sdio_register_driver(&iwm_sdio_driver);
516 static void __exit iwm_sdio_exit_module(void)
518 sdio_unregister_driver(&iwm_sdio_driver);
521 module_init(iwm_sdio_init_module);
522 module_exit(iwm_sdio_exit_module);
524 MODULE_LICENSE("GPL");
525 MODULE_AUTHOR(IWM_COPYRIGHT " " IWM_AUTHOR);