4 * Copyright (C) 2007 Alex Dubov <oakad@yahoo.com>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 as
8 * published by the Free Software Foundation.
10 * Special thanks to Carlos Corbacho for providing various MemoryStick cards
11 * that made this driver possible.
15 #include <linux/tifm.h>
16 #include <linux/memstick.h>
17 #include <linux/highmem.h>
18 #include <linux/scatterlist.h>
19 #include <linux/log2.h>
22 #define DRIVER_NAME "tifm_ms"
25 module_param(no_dma, bool, 0644);
28 * Some control bits of TIFM appear to conform to Sony's reference design,
29 * so I'm just assuming they all are.
32 #define TIFM_MS_STAT_DRQ 0x04000
33 #define TIFM_MS_STAT_MSINT 0x02000
34 #define TIFM_MS_STAT_RDY 0x01000
35 #define TIFM_MS_STAT_CRC 0x00200
36 #define TIFM_MS_STAT_TOE 0x00100
37 #define TIFM_MS_STAT_EMP 0x00020
38 #define TIFM_MS_STAT_FUL 0x00010
39 #define TIFM_MS_STAT_CED 0x00008
40 #define TIFM_MS_STAT_ERR 0x00004
41 #define TIFM_MS_STAT_BRQ 0x00002
42 #define TIFM_MS_STAT_CNK 0x00001
44 #define TIFM_MS_SYS_DMA 0x10000
45 #define TIFM_MS_SYS_RESET 0x08000
46 #define TIFM_MS_SYS_SRAC 0x04000
47 #define TIFM_MS_SYS_INTEN 0x02000
48 #define TIFM_MS_SYS_NOCRC 0x01000
49 #define TIFM_MS_SYS_INTCLR 0x00800
50 #define TIFM_MS_SYS_MSIEN 0x00400
51 #define TIFM_MS_SYS_FCLR 0x00200
52 #define TIFM_MS_SYS_FDIR 0x00100
53 #define TIFM_MS_SYS_DAM 0x00080
54 #define TIFM_MS_SYS_DRM 0x00040
55 #define TIFM_MS_SYS_DRQSL 0x00020
56 #define TIFM_MS_SYS_REI 0x00010
57 #define TIFM_MS_SYS_REO 0x00008
58 #define TIFM_MS_SYS_BSY_MASK 0x00007
60 #define TIFM_MS_SYS_FIFO (TIFM_MS_SYS_INTEN | TIFM_MS_SYS_MSIEN \
61 | TIFM_MS_SYS_FCLR | TIFM_MS_SYS_BSY_MASK)
72 struct timer_list timer;
73 struct memstick_request *req;
74 struct tasklet_struct notify;
75 unsigned int mode_mask;
76 unsigned int block_pos;
77 unsigned long timeout_jiffies;
78 unsigned char eject:1,
80 unsigned char cmd_flags;
85 static unsigned int tifm_ms_read_data(struct tifm_ms *host,
86 unsigned char *buf, unsigned int length)
88 struct tifm_dev *sock = host->dev;
91 while (host->io_pos && length) {
92 buf[off++] = host->io_word & 0xff;
101 while (!(TIFM_MS_STAT_EMP & readl(sock->addr + SOCK_MS_STATUS))) {
104 *(unsigned int *)(buf + off) = __raw_readl(sock->addr
111 && !(TIFM_MS_STAT_EMP & readl(sock->addr + SOCK_MS_STATUS))) {
112 host->io_word = readl(sock->addr + SOCK_MS_DATA);
113 for (host->io_pos = 4; host->io_pos; --host->io_pos) {
114 buf[off++] = host->io_word & 0xff;
125 static unsigned int tifm_ms_write_data(struct tifm_ms *host,
126 unsigned char *buf, unsigned int length)
128 struct tifm_dev *sock = host->dev;
129 unsigned int off = 0;
132 while (host->io_pos < 4 && length) {
133 host->io_word |= buf[off++] << (host->io_pos * 8);
139 if (host->io_pos == 4
140 && !(TIFM_MS_STAT_FUL & readl(sock->addr + SOCK_MS_STATUS))) {
141 writel(TIFM_MS_SYS_FDIR | readl(sock->addr + SOCK_MS_SYSTEM),
142 sock->addr + SOCK_MS_SYSTEM);
143 writel(host->io_word, sock->addr + SOCK_MS_DATA);
146 } else if (host->io_pos) {
153 while (!(TIFM_MS_STAT_FUL & readl(sock->addr + SOCK_MS_STATUS))) {
156 writel(TIFM_MS_SYS_FDIR | readl(sock->addr + SOCK_MS_SYSTEM),
157 sock->addr + SOCK_MS_SYSTEM);
158 __raw_writel(*(unsigned int *)(buf + off),
159 sock->addr + SOCK_MS_DATA);
166 host->io_word |= buf[off + 2] << 16;
169 host->io_word |= buf[off + 1] << 8;
172 host->io_word |= buf[off];
181 static unsigned int tifm_ms_transfer_data(struct tifm_ms *host)
183 struct tifm_dev *sock = host->dev;
186 unsigned int t_size, p_cnt;
189 unsigned long flags = 0;
191 if (host->req->long_data) {
192 length = host->req->sg.length - host->block_pos;
193 off = host->req->sg.offset + host->block_pos;
195 length = host->req->data_len - host->block_pos;
198 dev_dbg(&sock->dev, "fifo data transfer, %d, %d\n", length,
202 unsigned int uninitialized_var(p_off);
204 if (host->req->long_data) {
205 pg = nth_page(sg_page(&host->req->sg),
207 p_off = offset_in_page(off);
208 p_cnt = PAGE_SIZE - p_off;
209 p_cnt = min(p_cnt, length);
211 local_irq_save(flags);
212 buf = kmap_atomic(pg, KM_BIO_SRC_IRQ) + p_off;
214 buf = host->req->data + host->block_pos;
215 p_cnt = host->req->data_len - host->block_pos;
218 t_size = host->req->data_dir == WRITE
219 ? tifm_ms_write_data(host, buf, p_cnt)
220 : tifm_ms_read_data(host, buf, p_cnt);
222 if (host->req->long_data) {
223 kunmap_atomic(buf - p_off, KM_BIO_SRC_IRQ);
224 local_irq_restore(flags);
229 host->block_pos += t_size;
234 dev_dbg(&sock->dev, "fifo data transfer, %d remaining\n", length);
235 if (!length && (host->req->data_dir == WRITE)) {
237 writel(TIFM_MS_SYS_FDIR
238 | readl(sock->addr + SOCK_MS_SYSTEM),
239 sock->addr + SOCK_MS_SYSTEM);
240 writel(host->io_word, sock->addr + SOCK_MS_DATA);
242 writel(TIFM_MS_SYS_FDIR
243 | readl(sock->addr + SOCK_MS_SYSTEM),
244 sock->addr + SOCK_MS_SYSTEM);
245 writel(0, sock->addr + SOCK_MS_DATA);
247 readl(sock->addr + SOCK_MS_DATA);
253 static int tifm_ms_issue_cmd(struct tifm_ms *host)
255 struct tifm_dev *sock = host->dev;
257 unsigned int data_len, cmd, sys_param;
265 data = host->req->data;
267 host->use_dma = !no_dma;
269 if (host->req->long_data) {
270 data_len = host->req->sg.length;
271 if (!is_power_of_2(data_len))
274 data_len = host->req->data_len;
278 writel(TIFM_FIFO_INT_SETALL,
279 sock->addr + SOCK_DMA_FIFO_INT_ENABLE_CLEAR);
280 writel(TIFM_FIFO_ENABLE,
281 sock->addr + SOCK_FIFO_CONTROL);
284 if (1 != tifm_map_sg(sock, &host->req->sg, 1,
285 host->req->data_dir == READ
287 : PCI_DMA_TODEVICE)) {
288 host->req->error = -ENOMEM;
289 return host->req->error;
291 data_len = sg_dma_len(&host->req->sg);
293 writel(ilog2(data_len) - 2,
294 sock->addr + SOCK_FIFO_PAGE_SIZE);
295 writel(TIFM_FIFO_INTMASK,
296 sock->addr + SOCK_DMA_FIFO_INT_ENABLE_SET);
297 sys_param = TIFM_DMA_EN | (1 << 8);
298 if (host->req->data_dir == WRITE)
299 sys_param |= TIFM_DMA_TX;
301 writel(TIFM_FIFO_INTMASK,
302 sock->addr + SOCK_DMA_FIFO_INT_ENABLE_SET);
304 writel(sg_dma_address(&host->req->sg),
305 sock->addr + SOCK_DMA_ADDRESS);
306 writel(sys_param, sock->addr + SOCK_DMA_CONTROL);
308 writel(host->mode_mask | TIFM_MS_SYS_FIFO,
309 sock->addr + SOCK_MS_SYSTEM);
311 writel(TIFM_FIFO_MORE,
312 sock->addr + SOCK_DMA_FIFO_INT_ENABLE_SET);
315 mod_timer(&host->timer, jiffies + host->timeout_jiffies);
316 writel(TIFM_CTRL_LED | readl(sock->addr + SOCK_CONTROL),
317 sock->addr + SOCK_CONTROL);
318 host->req->error = 0;
320 sys_param = readl(sock->addr + SOCK_MS_SYSTEM);
321 sys_param |= TIFM_MS_SYS_INTCLR;
324 sys_param |= TIFM_MS_SYS_DMA;
326 sys_param &= ~TIFM_MS_SYS_DMA;
328 writel(sys_param, sock->addr + SOCK_MS_SYSTEM);
330 cmd = (host->req->tpc & 0xf) << 12;
332 writel(cmd, sock->addr + SOCK_MS_COMMAND);
334 dev_dbg(&sock->dev, "executing TPC %x, %x\n", cmd, sys_param);
338 static void tifm_ms_complete_cmd(struct tifm_ms *host)
340 struct tifm_dev *sock = host->dev;
341 struct memstick_host *msh = tifm_get_drvdata(sock);
344 del_timer(&host->timer);
346 host->req->int_reg = readl(sock->addr + SOCK_MS_STATUS) & 0xff;
347 host->req->int_reg = (host->req->int_reg & 1)
348 | ((host->req->int_reg << 4) & 0xe0);
350 writel(TIFM_FIFO_INT_SETALL,
351 sock->addr + SOCK_DMA_FIFO_INT_ENABLE_CLEAR);
352 writel(TIFM_DMA_RESET, sock->addr + SOCK_DMA_CONTROL);
355 tifm_unmap_sg(sock, &host->req->sg, 1,
356 host->req->data_dir == READ
361 writel((~TIFM_CTRL_LED) & readl(sock->addr + SOCK_CONTROL),
362 sock->addr + SOCK_CONTROL);
364 dev_dbg(&sock->dev, "TPC complete\n");
366 rc = memstick_next_req(msh, &host->req);
367 } while (!rc && tifm_ms_issue_cmd(host));
370 static int tifm_ms_check_status(struct tifm_ms *host)
372 if (!host->req->error) {
373 if (!(host->cmd_flags & CMD_READY))
375 if (!(host->cmd_flags & FIFO_READY))
377 if (host->req->need_card_int
378 && !(host->cmd_flags & CARD_INT))
384 /* Called from interrupt handler */
385 static void tifm_ms_data_event(struct tifm_dev *sock)
387 struct tifm_ms *host;
388 unsigned int fifo_status = 0, host_status = 0;
391 spin_lock(&sock->lock);
392 host = memstick_priv((struct memstick_host *)tifm_get_drvdata(sock));
393 fifo_status = readl(sock->addr + SOCK_DMA_FIFO_STATUS);
394 host_status = readl(sock->addr + SOCK_MS_STATUS);
396 "data event: fifo_status %x, host_status %x, flags %x\n",
397 fifo_status, host_status, host->cmd_flags);
400 if (host->use_dma && (fifo_status & 1)) {
401 host->cmd_flags |= FIFO_READY;
402 rc = tifm_ms_check_status(host);
404 if (!host->use_dma && (fifo_status & TIFM_FIFO_MORE)) {
405 if (!tifm_ms_transfer_data(host)) {
406 host->cmd_flags |= FIFO_READY;
407 rc = tifm_ms_check_status(host);
412 writel(fifo_status, sock->addr + SOCK_DMA_FIFO_STATUS);
414 tifm_ms_complete_cmd(host);
416 spin_unlock(&sock->lock);
420 /* Called from interrupt handler */
421 static void tifm_ms_card_event(struct tifm_dev *sock)
423 struct tifm_ms *host;
424 unsigned int host_status = 0;
427 spin_lock(&sock->lock);
428 host = memstick_priv((struct memstick_host *)tifm_get_drvdata(sock));
429 host_status = readl(sock->addr + SOCK_MS_STATUS);
430 dev_dbg(&sock->dev, "host event: host_status %x, flags %x\n",
431 host_status, host->cmd_flags);
434 if (host_status & TIFM_MS_STAT_TOE)
435 host->req->error = -ETIME;
436 else if (host_status & TIFM_MS_STAT_CRC)
437 host->req->error = -EILSEQ;
439 if (host_status & TIFM_MS_STAT_RDY)
440 host->cmd_flags |= CMD_READY;
442 if (host_status & TIFM_MS_STAT_MSINT)
443 host->cmd_flags |= CARD_INT;
445 rc = tifm_ms_check_status(host);
449 writel(TIFM_MS_SYS_INTCLR | readl(sock->addr + SOCK_MS_SYSTEM),
450 sock->addr + SOCK_MS_SYSTEM);
453 tifm_ms_complete_cmd(host);
455 spin_unlock(&sock->lock);
459 static void tifm_ms_req_tasklet(unsigned long data)
461 struct memstick_host *msh = (struct memstick_host *)data;
462 struct tifm_ms *host = memstick_priv(msh);
463 struct tifm_dev *sock = host->dev;
467 spin_lock_irqsave(&sock->lock, flags);
471 rc = memstick_next_req(msh, &host->req);
473 host->req->error = -ETIME;
475 spin_unlock_irqrestore(&sock->lock, flags);
480 rc = memstick_next_req(msh, &host->req);
481 } while (!rc && tifm_ms_issue_cmd(host));
483 spin_unlock_irqrestore(&sock->lock, flags);
486 static void tifm_ms_dummy_submit(struct memstick_host *msh)
491 static void tifm_ms_submit_req(struct memstick_host *msh)
493 struct tifm_ms *host = memstick_priv(msh);
495 tasklet_schedule(&host->notify);
498 static int tifm_ms_set_param(struct memstick_host *msh,
499 enum memstick_param param,
502 struct tifm_ms *host = memstick_priv(msh);
503 struct tifm_dev *sock = host->dev;
507 /* also affected by media detection mechanism */
508 if (value == MEMSTICK_POWER_ON) {
509 host->mode_mask = TIFM_MS_SYS_SRAC | TIFM_MS_SYS_REI;
510 writel(TIFM_MS_SYS_RESET, sock->addr + SOCK_MS_SYSTEM);
511 writel(TIFM_MS_SYS_FCLR | TIFM_MS_SYS_INTCLR,
512 sock->addr + SOCK_MS_SYSTEM);
513 writel(0xffffffff, sock->addr + SOCK_MS_STATUS);
514 } else if (value == MEMSTICK_POWER_OFF) {
515 writel(TIFM_MS_SYS_FCLR | TIFM_MS_SYS_INTCLR,
516 sock->addr + SOCK_MS_SYSTEM);
517 writel(0xffffffff, sock->addr + SOCK_MS_STATUS);
521 case MEMSTICK_INTERFACE:
522 if (value == MEMSTICK_SERIAL) {
523 host->mode_mask = TIFM_MS_SYS_SRAC | TIFM_MS_SYS_REI;
524 writel((~TIFM_CTRL_FAST_CLK)
525 & readl(sock->addr + SOCK_CONTROL),
526 sock->addr + SOCK_CONTROL);
527 } else if (value == MEMSTICK_PAR4) {
529 writel(TIFM_CTRL_FAST_CLK
530 | readl(sock->addr + SOCK_CONTROL),
531 sock->addr + SOCK_CONTROL);
540 static void tifm_ms_abort(unsigned long data)
542 struct tifm_ms *host = (struct tifm_ms *)data;
544 dev_dbg(&host->dev->dev, "status %x\n",
545 readl(host->dev->addr + SOCK_MS_STATUS));
547 "%s : card failed to respond for a long period of time "
549 dev_name(&host->dev->dev), host->req ? host->req->tpc : 0,
552 tifm_eject(host->dev);
555 static int tifm_ms_probe(struct tifm_dev *sock)
557 struct memstick_host *msh;
558 struct tifm_ms *host;
561 if (!(TIFM_SOCK_STATE_OCCUPIED
562 & readl(sock->addr + SOCK_PRESENT_STATE))) {
563 printk(KERN_WARNING "%s : card gone, unexpectedly\n",
564 dev_name(&sock->dev));
568 msh = memstick_alloc_host(sizeof(struct tifm_ms), &sock->dev);
572 host = memstick_priv(msh);
573 tifm_set_drvdata(sock, msh);
575 host->timeout_jiffies = msecs_to_jiffies(1000);
577 setup_timer(&host->timer, tifm_ms_abort, (unsigned long)host);
578 tasklet_init(&host->notify, tifm_ms_req_tasklet, (unsigned long)msh);
580 msh->request = tifm_ms_submit_req;
581 msh->set_param = tifm_ms_set_param;
582 sock->card_event = tifm_ms_card_event;
583 sock->data_event = tifm_ms_data_event;
584 if (tifm_has_ms_pif(sock))
585 msh->caps |= MEMSTICK_CAP_PAR4;
587 rc = memstick_add_host(msh);
591 memstick_free_host(msh);
595 static void tifm_ms_remove(struct tifm_dev *sock)
597 struct memstick_host *msh = tifm_get_drvdata(sock);
598 struct tifm_ms *host = memstick_priv(msh);
602 msh->request = tifm_ms_dummy_submit;
603 tasklet_kill(&host->notify);
604 spin_lock_irqsave(&sock->lock, flags);
607 del_timer(&host->timer);
608 writel(TIFM_FIFO_INT_SETALL,
609 sock->addr + SOCK_DMA_FIFO_INT_ENABLE_CLEAR);
610 writel(TIFM_DMA_RESET, sock->addr + SOCK_DMA_CONTROL);
612 tifm_unmap_sg(sock, &host->req->sg, 1,
613 host->req->data_dir == READ
615 : PCI_DMA_FROMDEVICE);
616 host->req->error = -ETIME;
619 rc = memstick_next_req(msh, &host->req);
621 host->req->error = -ETIME;
624 spin_unlock_irqrestore(&sock->lock, flags);
626 memstick_remove_host(msh);
627 memstick_free_host(msh);
632 static int tifm_ms_suspend(struct tifm_dev *sock, pm_message_t state)
634 struct memstick_host *msh = tifm_get_drvdata(sock);
636 memstick_suspend_host(msh);
640 static int tifm_ms_resume(struct tifm_dev *sock)
642 struct memstick_host *msh = tifm_get_drvdata(sock);
644 memstick_resume_host(msh);
650 #define tifm_ms_suspend NULL
651 #define tifm_ms_resume NULL
653 #endif /* CONFIG_PM */
655 static struct tifm_device_id tifm_ms_id_tbl[] = {
656 { TIFM_TYPE_MS }, { 0 }
659 static struct tifm_driver tifm_ms_driver = {
664 .id_table = tifm_ms_id_tbl,
665 .probe = tifm_ms_probe,
666 .remove = tifm_ms_remove,
667 .suspend = tifm_ms_suspend,
668 .resume = tifm_ms_resume
671 static int __init tifm_ms_init(void)
673 return tifm_register_driver(&tifm_ms_driver);
676 static void __exit tifm_ms_exit(void)
678 tifm_unregister_driver(&tifm_ms_driver);
681 MODULE_AUTHOR("Alex Dubov");
682 MODULE_DESCRIPTION("TI FlashMedia MemoryStick driver");
683 MODULE_LICENSE("GPL");
684 MODULE_DEVICE_TABLE(tifm, tifm_ms_id_tbl);
686 module_init(tifm_ms_init);
687 module_exit(tifm_ms_exit);