2 * Copyright (c) 2012 GCT Semiconductor, Inc. All rights reserved.
4 * This software is licensed under the terms of the GNU General Public
5 * License version 2, as published by the Free Software Foundation, and
6 * may be copied, distributed, and modified under those terms.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
14 #include <linux/module.h>
15 #include <linux/init.h>
16 #include <linux/kernel.h>
18 #include <linux/mmc/core.h>
19 #include <linux/mmc/card.h>
20 #include <linux/mmc/sdio_func.h>
21 #include <linux/mmc/sdio_ids.h>
24 #include "gdm_wimax.h"
25 #include "sdio_boot.h"
28 #define TYPE_A_HEADER_SIZE 4
29 #define TYPE_A_LOOKAHEAD_SIZE 16
31 #define MAX_NR_RX_BUF 4
33 #define SDU_TX_BUF_SIZE 2048
34 #define TX_BUF_SIZE 2048
35 #define TX_CHUNK_SIZE (2048 - TYPE_A_HEADER_SIZE)
36 #define RX_BUF_SIZE (25*1024)
39 #define TX_INTERVAL (1000000/TX_HZ)
41 static struct sdio_tx *alloc_tx_struct(struct tx_cxt *tx)
43 struct sdio_tx *t = kzalloc(sizeof(*t), GFP_ATOMIC);
48 t->buf = kmalloc(TX_BUF_SIZE, GFP_ATOMIC);
59 static void free_tx_struct(struct sdio_tx *t)
67 static struct sdio_rx *alloc_rx_struct(struct rx_cxt *rx)
69 struct sdio_rx *r = kzalloc(sizeof(*r), GFP_ATOMIC);
77 static void free_rx_struct(struct sdio_rx *r)
82 /* Before this function is called, spin lock should be locked. */
83 static struct sdio_tx *get_tx_struct(struct tx_cxt *tx, int *no_spc)
87 if (list_empty(&tx->free_list))
90 t = list_entry(tx->free_list.prev, struct sdio_tx, list);
93 *no_spc = list_empty(&tx->free_list) ? 1 : 0;
98 /* Before this function is called, spin lock should be locked. */
99 static void put_tx_struct(struct tx_cxt *tx, struct sdio_tx *t)
101 list_add_tail(&t->list, &tx->free_list);
104 /* Before this function is called, spin lock should be locked. */
105 static struct sdio_rx *get_rx_struct(struct rx_cxt *rx)
109 if (list_empty(&rx->free_list))
112 r = list_entry(rx->free_list.prev, struct sdio_rx, list);
118 /* Before this function is called, spin lock should be locked. */
119 static void put_rx_struct(struct rx_cxt *rx, struct sdio_rx *r)
121 list_add_tail(&r->list, &rx->free_list);
124 static void release_sdio(struct sdiowm_dev *sdev)
126 struct tx_cxt *tx = &sdev->tx;
127 struct rx_cxt *rx = &sdev->rx;
128 struct sdio_tx *t, *t_next;
129 struct sdio_rx *r, *r_next;
133 list_for_each_entry_safe(t, t_next, &tx->free_list, list) {
138 list_for_each_entry_safe(t, t_next, &tx->sdu_list, list) {
143 list_for_each_entry_safe(t, t_next, &tx->hci_list, list) {
150 list_for_each_entry_safe(r, r_next, &rx->free_list, list) {
155 list_for_each_entry_safe(r, r_next, &rx->req_list, list) {
161 static int init_sdio(struct sdiowm_dev *sdev)
164 struct tx_cxt *tx = &sdev->tx;
165 struct rx_cxt *rx = &sdev->rx;
169 INIT_LIST_HEAD(&tx->free_list);
170 INIT_LIST_HEAD(&tx->sdu_list);
171 INIT_LIST_HEAD(&tx->hci_list);
173 spin_lock_init(&tx->lock);
175 tx->sdu_buf = kmalloc(SDU_TX_BUF_SIZE, GFP_KERNEL);
179 for (i = 0; i < MAX_NR_SDU_BUF; i++) {
180 t = alloc_tx_struct(tx);
185 list_add(&t->list, &tx->free_list);
188 INIT_LIST_HEAD(&rx->free_list);
189 INIT_LIST_HEAD(&rx->req_list);
191 spin_lock_init(&rx->lock);
193 for (i = 0; i < MAX_NR_RX_BUF; i++) {
194 r = alloc_rx_struct(rx);
199 list_add(&r->list, &rx->free_list);
202 rx->rx_buf = kmalloc(RX_BUF_SIZE, GFP_KERNEL);
213 static void send_sdio_pkt(struct sdio_func *func, u8 *data, int len)
215 int n, blocks, ret, remain;
217 sdio_claim_host(func);
219 blocks = len / func->cur_blksize;
220 n = blocks * func->cur_blksize;
222 ret = sdio_memcpy_toio(func, 0, data, n);
224 if (ret != -ENOMEDIUM)
226 "gdmwms: error: ret = %d\n", ret);
232 remain = (remain + 3) & ~3;
235 ret = sdio_memcpy_toio(func, 0, data + n, remain);
237 if (ret != -ENOMEDIUM)
239 "gdmwms: error: ret = %d\n", ret);
245 sdio_release_host(func);
248 static void send_sdu(struct sdio_func *func, struct tx_cxt *tx)
250 struct list_head *l, *next;
253 int pos, len, i, estlen, aggr_num = 0, aggr_len;
257 spin_lock_irqsave(&tx->lock, flags);
259 pos = TYPE_A_HEADER_SIZE + HCI_HEADER_SIZE;
260 list_for_each_entry(t, &tx->sdu_list, list) {
261 estlen = ((t->len + 3) & ~3) + 4;
262 if ((pos + estlen) > SDU_TX_BUF_SIZE)
266 memcpy(tx->sdu_buf + pos, t->buf, t->len);
267 memset(tx->sdu_buf + pos + t->len, 0, estlen - t->len);
272 hci = (struct hci_s *)(tx->sdu_buf + TYPE_A_HEADER_SIZE);
273 hci->cmd_evt = cpu_to_be16(WIMAX_TX_SDU_AGGR);
274 hci->length = cpu_to_be16(aggr_len - TYPE_A_HEADER_SIZE -
277 spin_unlock_irqrestore(&tx->lock, flags);
279 dev_dbg(&func->dev, "sdio_send: %*ph\n", aggr_len - TYPE_A_HEADER_SIZE,
280 tx->sdu_buf + TYPE_A_HEADER_SIZE);
282 for (pos = TYPE_A_HEADER_SIZE; pos < aggr_len; pos += TX_CHUNK_SIZE) {
283 len = aggr_len - pos;
284 len = len > TX_CHUNK_SIZE ? TX_CHUNK_SIZE : len;
285 buf = tx->sdu_buf + pos - TYPE_A_HEADER_SIZE;
288 buf[1] = (len >> 8) & 0xff;
289 buf[2] = (len >> 16) & 0xff;
290 buf[3] = (pos + len) >= aggr_len ? 0 : 1;
291 send_sdio_pkt(func, buf, len + TYPE_A_HEADER_SIZE);
294 spin_lock_irqsave(&tx->lock, flags);
296 for (l = tx->sdu_list.next, i = 0; i < aggr_num; i++, l = next) {
298 t = list_entry(l, struct sdio_tx, list);
300 t->callback(t->cb_data);
303 put_tx_struct(t->tx_cxt, t);
306 do_gettimeofday(&tx->sdu_stamp);
307 spin_unlock_irqrestore(&tx->lock, flags);
310 static void send_hci(struct sdio_func *func, struct tx_cxt *tx,
315 dev_dbg(&func->dev, "sdio_send: %*ph\n", t->len - TYPE_A_HEADER_SIZE,
316 t->buf + TYPE_A_HEADER_SIZE);
318 send_sdio_pkt(func, t->buf, t->len);
320 spin_lock_irqsave(&tx->lock, flags);
322 t->callback(t->cb_data);
324 spin_unlock_irqrestore(&tx->lock, flags);
327 static void do_tx(struct work_struct *work)
329 struct sdiowm_dev *sdev = container_of(work, struct sdiowm_dev, ws);
330 struct sdio_func *func = sdev->func;
331 struct tx_cxt *tx = &sdev->tx;
332 struct sdio_tx *t = NULL;
333 struct timeval now, *before;
338 spin_lock_irqsave(&tx->lock, flags);
340 spin_unlock_irqrestore(&tx->lock, flags);
344 if (!list_empty(&tx->hci_list)) {
345 t = list_entry(tx->hci_list.next, struct sdio_tx, list);
348 } else if (!tx->stop_sdu_tx && !list_empty(&tx->sdu_list)) {
349 do_gettimeofday(&now);
350 before = &tx->sdu_stamp;
352 diff = (now.tv_sec - before->tv_sec) * 1000000 +
353 (now.tv_usec - before->tv_usec);
354 if (diff >= 0 && diff < TX_INTERVAL) {
355 schedule_work(&sdev->ws);
356 spin_unlock_irqrestore(&tx->lock, flags);
363 spin_unlock_irqrestore(&tx->lock, flags);
369 spin_unlock_irqrestore(&tx->lock, flags);
374 send_hci(func, tx, t);
377 static int gdm_sdio_send(void *priv_dev, void *data, int len,
378 void (*cb)(void *data), void *cb_data)
380 struct sdiowm_dev *sdev = priv_dev;
381 struct tx_cxt *tx = &sdev->tx;
388 if (len > TX_BUF_SIZE - TYPE_A_HEADER_SIZE)
391 spin_lock_irqsave(&tx->lock, flags);
393 cmd_evt = (pkt[0] << 8) | pkt[1];
394 if (cmd_evt == WIMAX_TX_SDU) {
395 t = get_tx_struct(tx, &no_spc);
397 /* This case must not happen. */
398 spin_unlock_irqrestore(&tx->lock, flags);
401 list_add_tail(&t->list, &tx->sdu_list);
403 memcpy(t->buf, data, len);
407 t->cb_data = cb_data;
409 t = alloc_tx_struct(tx);
411 spin_unlock_irqrestore(&tx->lock, flags);
414 list_add_tail(&t->list, &tx->hci_list);
416 t->buf[0] = len & 0xff;
417 t->buf[1] = (len >> 8) & 0xff;
418 t->buf[2] = (len >> 16) & 0xff;
420 memcpy(t->buf + TYPE_A_HEADER_SIZE, data, len);
422 t->len = len + TYPE_A_HEADER_SIZE;
424 t->cb_data = cb_data;
428 schedule_work(&sdev->ws);
430 spin_unlock_irqrestore(&tx->lock, flags);
438 /* Handle the HCI, WIMAX_SDU_TX_FLOW. */
439 static int control_sdu_tx_flow(struct sdiowm_dev *sdev, u8 *hci_data, int len)
441 struct tx_cxt *tx = &sdev->tx;
445 spin_lock_irqsave(&tx->lock, flags);
447 cmd_evt = (hci_data[0] << 8) | (hci_data[1]);
448 if (cmd_evt != WIMAX_SDU_TX_FLOW)
451 if (hci_data[4] == 0) {
452 dev_dbg(&sdev->func->dev, "WIMAX ==> STOP SDU TX\n");
454 } else if (hci_data[4] == 1) {
455 dev_dbg(&sdev->func->dev, "WIMAX ==> START SDU TX\n");
458 schedule_work(&sdev->ws);
459 /* If free buffer for sdu tx doesn't exist, then tx queue
460 * should not be woken. For this reason, don't pass the command,
463 if (list_empty(&tx->free_list))
468 spin_unlock_irqrestore(&tx->lock, flags);
472 static void gdm_sdio_irq(struct sdio_func *func)
474 struct phy_dev *phy_dev = sdio_get_drvdata(func);
475 struct sdiowm_dev *sdev = phy_dev->priv_dev;
476 struct tx_cxt *tx = &sdev->tx;
477 struct rx_cxt *rx = &sdev->rx;
480 u8 val, hdr[TYPE_A_LOOKAHEAD_SIZE], *buf;
484 /* Check interrupt */
485 val = sdio_readb(func, 0x13, &ret);
487 sdio_writeb(func, 0x01, 0x13, &ret); /* clear interrupt */
491 ret = sdio_memcpy_fromio(func, hdr, 0x0, TYPE_A_LOOKAHEAD_SIZE);
494 "Cannot read from function %d\n", func->num);
498 len = (hdr[2] << 16) | (hdr[1] << 8) | hdr[0];
499 if (len > (RX_BUF_SIZE - TYPE_A_HEADER_SIZE)) {
500 dev_err(&func->dev, "Too big Type-A size: %d\n", len);
504 if (hdr[3] == 1) { /* Ack */
505 u32 *ack_seq = (u32 *)&hdr[4];
507 spin_lock_irqsave(&tx->lock, flags);
510 if (!list_empty(&tx->sdu_list) || !list_empty(&tx->hci_list))
511 schedule_work(&sdev->ws);
512 spin_unlock_irqrestore(&tx->lock, flags);
513 dev_dbg(&func->dev, "Ack... %0x\n", ntohl(*ack_seq));
517 memcpy(rx->rx_buf, hdr + TYPE_A_HEADER_SIZE,
518 TYPE_A_LOOKAHEAD_SIZE - TYPE_A_HEADER_SIZE);
520 buf = rx->rx_buf + TYPE_A_LOOKAHEAD_SIZE - TYPE_A_HEADER_SIZE;
521 remain = len - TYPE_A_LOOKAHEAD_SIZE + TYPE_A_HEADER_SIZE;
525 blocks = remain / func->cur_blksize;
528 n = blocks * func->cur_blksize;
529 ret = sdio_memcpy_fromio(func, buf, 0x0, n);
532 "Cannot read from function %d\n", func->num);
540 ret = sdio_memcpy_fromio(func, buf, 0x0, remain);
543 "Cannot read from function %d\n", func->num);
549 dev_dbg(&func->dev, "sdio_receive: %*ph\n", len, rx->rx_buf);
551 len = control_sdu_tx_flow(sdev, rx->rx_buf, len);
553 spin_lock_irqsave(&rx->lock, flags);
555 if (!list_empty(&rx->req_list)) {
556 r = list_entry(rx->req_list.next, struct sdio_rx, list);
557 spin_unlock_irqrestore(&rx->lock, flags);
559 r->callback(r->cb_data, rx->rx_buf, len);
560 spin_lock_irqsave(&rx->lock, flags);
562 put_rx_struct(rx, r);
565 spin_unlock_irqrestore(&rx->lock, flags);
568 sdio_writeb(func, 0x00, 0x10, &ret); /* PCRRT */
569 if (!phy_dev->netdev)
570 register_wimax_device(phy_dev, &func->dev);
573 static int gdm_sdio_receive(void *priv_dev,
574 void (*cb)(void *cb_data, void *data, int len),
577 struct sdiowm_dev *sdev = priv_dev;
578 struct rx_cxt *rx = &sdev->rx;
582 spin_lock_irqsave(&rx->lock, flags);
583 r = get_rx_struct(rx);
585 spin_unlock_irqrestore(&rx->lock, flags);
590 r->cb_data = cb_data;
592 list_add_tail(&r->list, &rx->req_list);
593 spin_unlock_irqrestore(&rx->lock, flags);
598 static int sdio_wimax_probe(struct sdio_func *func,
599 const struct sdio_device_id *id)
602 struct phy_dev *phy_dev = NULL;
603 struct sdiowm_dev *sdev = NULL;
605 dev_info(&func->dev, "Found GDM SDIO VID = 0x%04x PID = 0x%04x...\n",
606 func->vendor, func->device);
607 dev_info(&func->dev, "GCT WiMax driver version %s\n", DRIVER_VERSION);
609 sdio_claim_host(func);
610 sdio_enable_func(func);
611 sdio_claim_irq(func, gdm_sdio_irq);
613 ret = sdio_boot(func);
617 phy_dev = kzalloc(sizeof(*phy_dev), GFP_KERNEL);
622 sdev = kzalloc(sizeof(*sdev), GFP_KERNEL);
628 phy_dev->priv_dev = (void *)sdev;
629 phy_dev->send_func = gdm_sdio_send;
630 phy_dev->rcv_func = gdm_sdio_receive;
632 ret = init_sdio(sdev);
638 sdio_writeb(func, 1, 0x14, &ret); /* Enable interrupt */
639 sdio_release_host(func);
641 INIT_WORK(&sdev->ws, do_tx);
643 sdio_set_drvdata(func, phy_dev);
653 static void sdio_wimax_remove(struct sdio_func *func)
655 struct phy_dev *phy_dev = sdio_get_drvdata(func);
656 struct sdiowm_dev *sdev = phy_dev->priv_dev;
658 cancel_work_sync(&sdev->ws);
660 unregister_wimax_device(phy_dev);
661 sdio_claim_host(func);
662 sdio_release_irq(func);
663 sdio_disable_func(func);
664 sdio_release_host(func);
671 static const struct sdio_device_id sdio_wimax_ids[] = {
672 { SDIO_DEVICE(0x0296, 0x5347) },
676 MODULE_DEVICE_TABLE(sdio, sdio_wimax_ids);
678 static struct sdio_driver sdio_wimax_driver = {
679 .probe = sdio_wimax_probe,
680 .remove = sdio_wimax_remove,
681 .name = "sdio_wimax",
682 .id_table = sdio_wimax_ids,
685 static int __init sdio_gdm_wimax_init(void)
687 return sdio_register_driver(&sdio_wimax_driver);
690 static void __exit sdio_gdm_wimax_exit(void)
692 sdio_unregister_driver(&sdio_wimax_driver);
695 module_init(sdio_gdm_wimax_init);
696 module_exit(sdio_gdm_wimax_exit);
698 MODULE_VERSION(DRIVER_VERSION);
699 MODULE_DESCRIPTION("GCT WiMax SDIO Device Driver");
700 MODULE_AUTHOR("Ethan Park");
701 MODULE_LICENSE("GPL");