Loading...
1// SPDX-License-Identifier: GPL-2.0-only
2/*
3 * TI FlashMedia driver
4 *
5 * Copyright (C) 2007 Alex Dubov <oakad@yahoo.com>
6 *
7 * Special thanks to Carlos Corbacho for providing various MemoryStick cards
8 * that made this driver possible.
9 */
10
11#include <linux/tifm.h>
12#include <linux/memstick.h>
13#include <linux/highmem.h>
14#include <linux/scatterlist.h>
15#include <linux/log2.h>
16#include <linux/module.h>
17#include <asm/io.h>
18
19#define DRIVER_NAME "tifm_ms"
20
21static bool no_dma;
22module_param(no_dma, bool, 0644);
23
24/*
25 * Some control bits of TIFM appear to conform to Sony's reference design,
26 * so I'm just assuming they all are.
27 */
28
29#define TIFM_MS_STAT_DRQ 0x04000
30#define TIFM_MS_STAT_MSINT 0x02000
31#define TIFM_MS_STAT_RDY 0x01000
32#define TIFM_MS_STAT_CRC 0x00200
33#define TIFM_MS_STAT_TOE 0x00100
34#define TIFM_MS_STAT_EMP 0x00020
35#define TIFM_MS_STAT_FUL 0x00010
36#define TIFM_MS_STAT_CED 0x00008
37#define TIFM_MS_STAT_ERR 0x00004
38#define TIFM_MS_STAT_BRQ 0x00002
39#define TIFM_MS_STAT_CNK 0x00001
40
41#define TIFM_MS_SYS_DMA 0x10000
42#define TIFM_MS_SYS_RESET 0x08000
43#define TIFM_MS_SYS_SRAC 0x04000
44#define TIFM_MS_SYS_INTEN 0x02000
45#define TIFM_MS_SYS_NOCRC 0x01000
46#define TIFM_MS_SYS_INTCLR 0x00800
47#define TIFM_MS_SYS_MSIEN 0x00400
48#define TIFM_MS_SYS_FCLR 0x00200
49#define TIFM_MS_SYS_FDIR 0x00100
50#define TIFM_MS_SYS_DAM 0x00080
51#define TIFM_MS_SYS_DRM 0x00040
52#define TIFM_MS_SYS_DRQSL 0x00020
53#define TIFM_MS_SYS_REI 0x00010
54#define TIFM_MS_SYS_REO 0x00008
55#define TIFM_MS_SYS_BSY_MASK 0x00007
56
57#define TIFM_MS_SYS_FIFO (TIFM_MS_SYS_INTEN | TIFM_MS_SYS_MSIEN \
58 | TIFM_MS_SYS_FCLR | TIFM_MS_SYS_BSY_MASK)
59
60/* Hardware flags */
61enum {
62 CMD_READY = 0x01,
63 FIFO_READY = 0x02,
64 CARD_INT = 0x04
65};
66
67struct tifm_ms {
68 struct tifm_dev *dev;
69 struct timer_list timer;
70 struct memstick_request *req;
71 struct tasklet_struct notify;
72 unsigned int mode_mask;
73 unsigned int block_pos;
74 unsigned long timeout_jiffies;
75 unsigned char eject:1,
76 use_dma:1;
77 unsigned char cmd_flags;
78 unsigned char io_pos;
79 unsigned int io_word;
80};
81
82static unsigned int tifm_ms_read_data(struct tifm_ms *host,
83 unsigned char *buf, unsigned int length)
84{
85 struct tifm_dev *sock = host->dev;
86 unsigned int off = 0;
87
88 while (host->io_pos && length) {
89 buf[off++] = host->io_word & 0xff;
90 host->io_word >>= 8;
91 length--;
92 host->io_pos--;
93 }
94
95 if (!length)
96 return off;
97
98 while (!(TIFM_MS_STAT_EMP & readl(sock->addr + SOCK_MS_STATUS))) {
99 if (length < 4)
100 break;
101 *(unsigned int *)(buf + off) = __raw_readl(sock->addr
102 + SOCK_MS_DATA);
103 length -= 4;
104 off += 4;
105 }
106
107 if (length
108 && !(TIFM_MS_STAT_EMP & readl(sock->addr + SOCK_MS_STATUS))) {
109 host->io_word = readl(sock->addr + SOCK_MS_DATA);
110 for (host->io_pos = 4; host->io_pos; --host->io_pos) {
111 buf[off++] = host->io_word & 0xff;
112 host->io_word >>= 8;
113 length--;
114 if (!length)
115 break;
116 }
117 }
118
119 return off;
120}
121
122static unsigned int tifm_ms_write_data(struct tifm_ms *host,
123 unsigned char *buf, unsigned int length)
124{
125 struct tifm_dev *sock = host->dev;
126 unsigned int off = 0;
127
128 if (host->io_pos) {
129 while (host->io_pos < 4 && length) {
130 host->io_word |= buf[off++] << (host->io_pos * 8);
131 host->io_pos++;
132 length--;
133 }
134 }
135
136 if (host->io_pos == 4
137 && !(TIFM_MS_STAT_FUL & readl(sock->addr + SOCK_MS_STATUS))) {
138 writel(TIFM_MS_SYS_FDIR | readl(sock->addr + SOCK_MS_SYSTEM),
139 sock->addr + SOCK_MS_SYSTEM);
140 writel(host->io_word, sock->addr + SOCK_MS_DATA);
141 host->io_pos = 0;
142 host->io_word = 0;
143 } else if (host->io_pos) {
144 return off;
145 }
146
147 if (!length)
148 return off;
149
150 while (!(TIFM_MS_STAT_FUL & readl(sock->addr + SOCK_MS_STATUS))) {
151 if (length < 4)
152 break;
153 writel(TIFM_MS_SYS_FDIR | readl(sock->addr + SOCK_MS_SYSTEM),
154 sock->addr + SOCK_MS_SYSTEM);
155 __raw_writel(*(unsigned int *)(buf + off),
156 sock->addr + SOCK_MS_DATA);
157 length -= 4;
158 off += 4;
159 }
160
161 switch (length) {
162 case 3:
163 host->io_word |= buf[off + 2] << 16;
164 host->io_pos++;
165 fallthrough;
166 case 2:
167 host->io_word |= buf[off + 1] << 8;
168 host->io_pos++;
169 fallthrough;
170 case 1:
171 host->io_word |= buf[off];
172 host->io_pos++;
173 }
174
175 off += host->io_pos;
176
177 return off;
178}
179
180static unsigned int tifm_ms_transfer_data(struct tifm_ms *host)
181{
182 struct tifm_dev *sock = host->dev;
183 unsigned int length;
184 unsigned int off;
185 unsigned int t_size, p_cnt;
186 unsigned char *buf;
187 struct page *pg;
188 unsigned long flags = 0;
189
190 if (host->req->long_data) {
191 length = host->req->sg.length - host->block_pos;
192 off = host->req->sg.offset + host->block_pos;
193 } else {
194 length = host->req->data_len - host->block_pos;
195 off = 0;
196 }
197 dev_dbg(&sock->dev, "fifo data transfer, %d, %d\n", length,
198 host->block_pos);
199
200 while (length) {
201 unsigned int p_off;
202
203 if (host->req->long_data) {
204 pg = nth_page(sg_page(&host->req->sg),
205 off >> PAGE_SHIFT);
206 p_off = offset_in_page(off);
207 p_cnt = PAGE_SIZE - p_off;
208 p_cnt = min(p_cnt, length);
209
210 local_irq_save(flags);
211 buf = kmap_atomic(pg) + p_off;
212 } else {
213 buf = host->req->data + host->block_pos;
214 p_cnt = host->req->data_len - host->block_pos;
215 }
216
217 t_size = host->req->data_dir == WRITE
218 ? tifm_ms_write_data(host, buf, p_cnt)
219 : tifm_ms_read_data(host, buf, p_cnt);
220
221 if (host->req->long_data) {
222 kunmap_atomic(buf - p_off);
223 local_irq_restore(flags);
224 }
225
226 if (!t_size)
227 break;
228 host->block_pos += t_size;
229 length -= t_size;
230 off += t_size;
231 }
232
233 dev_dbg(&sock->dev, "fifo data transfer, %d remaining\n", length);
234 if (!length && (host->req->data_dir == WRITE)) {
235 if (host->io_pos) {
236 writel(TIFM_MS_SYS_FDIR
237 | readl(sock->addr + SOCK_MS_SYSTEM),
238 sock->addr + SOCK_MS_SYSTEM);
239 writel(host->io_word, sock->addr + SOCK_MS_DATA);
240 }
241 writel(TIFM_MS_SYS_FDIR
242 | readl(sock->addr + SOCK_MS_SYSTEM),
243 sock->addr + SOCK_MS_SYSTEM);
244 writel(0, sock->addr + SOCK_MS_DATA);
245 } else {
246 readl(sock->addr + SOCK_MS_DATA);
247 }
248
249 return length;
250}
251
252static int tifm_ms_issue_cmd(struct tifm_ms *host)
253{
254 struct tifm_dev *sock = host->dev;
255 unsigned int data_len, cmd, sys_param;
256
257 host->cmd_flags = 0;
258 host->block_pos = 0;
259 host->io_pos = 0;
260 host->io_word = 0;
261 host->cmd_flags = 0;
262
263 host->use_dma = !no_dma;
264
265 if (host->req->long_data) {
266 data_len = host->req->sg.length;
267 if (!is_power_of_2(data_len))
268 host->use_dma = 0;
269 } else {
270 data_len = host->req->data_len;
271 host->use_dma = 0;
272 }
273
274 writel(TIFM_FIFO_INT_SETALL,
275 sock->addr + SOCK_DMA_FIFO_INT_ENABLE_CLEAR);
276 writel(TIFM_FIFO_ENABLE,
277 sock->addr + SOCK_FIFO_CONTROL);
278
279 if (host->use_dma) {
280 if (1 != tifm_map_sg(sock, &host->req->sg, 1,
281 host->req->data_dir == READ
282 ? DMA_FROM_DEVICE
283 : DMA_TO_DEVICE)) {
284 host->req->error = -ENOMEM;
285 return host->req->error;
286 }
287 data_len = sg_dma_len(&host->req->sg);
288
289 writel(ilog2(data_len) - 2,
290 sock->addr + SOCK_FIFO_PAGE_SIZE);
291 writel(TIFM_FIFO_INTMASK,
292 sock->addr + SOCK_DMA_FIFO_INT_ENABLE_SET);
293 sys_param = TIFM_DMA_EN | (1 << 8);
294 if (host->req->data_dir == WRITE)
295 sys_param |= TIFM_DMA_TX;
296
297 writel(TIFM_FIFO_INTMASK,
298 sock->addr + SOCK_DMA_FIFO_INT_ENABLE_SET);
299
300 writel(sg_dma_address(&host->req->sg),
301 sock->addr + SOCK_DMA_ADDRESS);
302 writel(sys_param, sock->addr + SOCK_DMA_CONTROL);
303 } else {
304 writel(host->mode_mask | TIFM_MS_SYS_FIFO,
305 sock->addr + SOCK_MS_SYSTEM);
306
307 writel(TIFM_FIFO_MORE,
308 sock->addr + SOCK_DMA_FIFO_INT_ENABLE_SET);
309 }
310
311 mod_timer(&host->timer, jiffies + host->timeout_jiffies);
312 writel(TIFM_CTRL_LED | readl(sock->addr + SOCK_CONTROL),
313 sock->addr + SOCK_CONTROL);
314 host->req->error = 0;
315
316 sys_param = readl(sock->addr + SOCK_MS_SYSTEM);
317 sys_param |= TIFM_MS_SYS_INTCLR;
318
319 if (host->use_dma)
320 sys_param |= TIFM_MS_SYS_DMA;
321 else
322 sys_param &= ~TIFM_MS_SYS_DMA;
323
324 writel(sys_param, sock->addr + SOCK_MS_SYSTEM);
325
326 cmd = (host->req->tpc & 0xf) << 12;
327 cmd |= data_len;
328 writel(cmd, sock->addr + SOCK_MS_COMMAND);
329
330 dev_dbg(&sock->dev, "executing TPC %x, %x\n", cmd, sys_param);
331 return 0;
332}
333
334static void tifm_ms_complete_cmd(struct tifm_ms *host)
335{
336 struct tifm_dev *sock = host->dev;
337 struct memstick_host *msh = tifm_get_drvdata(sock);
338 int rc;
339
340 del_timer(&host->timer);
341
342 host->req->int_reg = readl(sock->addr + SOCK_MS_STATUS) & 0xff;
343 host->req->int_reg = (host->req->int_reg & 1)
344 | ((host->req->int_reg << 4) & 0xe0);
345
346 writel(TIFM_FIFO_INT_SETALL,
347 sock->addr + SOCK_DMA_FIFO_INT_ENABLE_CLEAR);
348 writel(TIFM_DMA_RESET, sock->addr + SOCK_DMA_CONTROL);
349
350 if (host->use_dma) {
351 tifm_unmap_sg(sock, &host->req->sg, 1,
352 host->req->data_dir == READ
353 ? DMA_FROM_DEVICE
354 : DMA_TO_DEVICE);
355 }
356
357 writel((~TIFM_CTRL_LED) & readl(sock->addr + SOCK_CONTROL),
358 sock->addr + SOCK_CONTROL);
359
360 dev_dbg(&sock->dev, "TPC complete\n");
361 do {
362 rc = memstick_next_req(msh, &host->req);
363 } while (!rc && tifm_ms_issue_cmd(host));
364}
365
366static int tifm_ms_check_status(struct tifm_ms *host)
367{
368 if (!host->req->error) {
369 if (!(host->cmd_flags & CMD_READY))
370 return 1;
371 if (!(host->cmd_flags & FIFO_READY))
372 return 1;
373 if (host->req->need_card_int
374 && !(host->cmd_flags & CARD_INT))
375 return 1;
376 }
377 return 0;
378}
379
380/* Called from interrupt handler */
381static void tifm_ms_data_event(struct tifm_dev *sock)
382{
383 struct tifm_ms *host;
384 unsigned int fifo_status = 0, host_status = 0;
385 int rc = 1;
386
387 spin_lock(&sock->lock);
388 host = memstick_priv((struct memstick_host *)tifm_get_drvdata(sock));
389 fifo_status = readl(sock->addr + SOCK_DMA_FIFO_STATUS);
390 host_status = readl(sock->addr + SOCK_MS_STATUS);
391 dev_dbg(&sock->dev,
392 "data event: fifo_status %x, host_status %x, flags %x\n",
393 fifo_status, host_status, host->cmd_flags);
394
395 if (host->req) {
396 if (host->use_dma && (fifo_status & 1)) {
397 host->cmd_flags |= FIFO_READY;
398 rc = tifm_ms_check_status(host);
399 }
400 if (!host->use_dma && (fifo_status & TIFM_FIFO_MORE)) {
401 if (!tifm_ms_transfer_data(host)) {
402 host->cmd_flags |= FIFO_READY;
403 rc = tifm_ms_check_status(host);
404 }
405 }
406 }
407
408 writel(fifo_status, sock->addr + SOCK_DMA_FIFO_STATUS);
409 if (!rc)
410 tifm_ms_complete_cmd(host);
411
412 spin_unlock(&sock->lock);
413}
414
415
416/* Called from interrupt handler */
417static void tifm_ms_card_event(struct tifm_dev *sock)
418{
419 struct tifm_ms *host;
420 unsigned int host_status = 0;
421 int rc = 1;
422
423 spin_lock(&sock->lock);
424 host = memstick_priv((struct memstick_host *)tifm_get_drvdata(sock));
425 host_status = readl(sock->addr + SOCK_MS_STATUS);
426 dev_dbg(&sock->dev, "host event: host_status %x, flags %x\n",
427 host_status, host->cmd_flags);
428
429 if (host->req) {
430 if (host_status & TIFM_MS_STAT_TOE)
431 host->req->error = -ETIME;
432 else if (host_status & TIFM_MS_STAT_CRC)
433 host->req->error = -EILSEQ;
434
435 if (host_status & TIFM_MS_STAT_RDY)
436 host->cmd_flags |= CMD_READY;
437
438 if (host_status & TIFM_MS_STAT_MSINT)
439 host->cmd_flags |= CARD_INT;
440
441 rc = tifm_ms_check_status(host);
442
443 }
444
445 writel(TIFM_MS_SYS_INTCLR | readl(sock->addr + SOCK_MS_SYSTEM),
446 sock->addr + SOCK_MS_SYSTEM);
447
448 if (!rc)
449 tifm_ms_complete_cmd(host);
450
451 spin_unlock(&sock->lock);
452 return;
453}
454
455static void tifm_ms_req_tasklet(unsigned long data)
456{
457 struct memstick_host *msh = (struct memstick_host *)data;
458 struct tifm_ms *host = memstick_priv(msh);
459 struct tifm_dev *sock = host->dev;
460 unsigned long flags;
461 int rc;
462
463 spin_lock_irqsave(&sock->lock, flags);
464 if (!host->req) {
465 if (host->eject) {
466 do {
467 rc = memstick_next_req(msh, &host->req);
468 if (!rc)
469 host->req->error = -ETIME;
470 } while (!rc);
471 spin_unlock_irqrestore(&sock->lock, flags);
472 return;
473 }
474
475 do {
476 rc = memstick_next_req(msh, &host->req);
477 } while (!rc && tifm_ms_issue_cmd(host));
478 }
479 spin_unlock_irqrestore(&sock->lock, flags);
480}
481
482static void tifm_ms_dummy_submit(struct memstick_host *msh)
483{
484 return;
485}
486
487static void tifm_ms_submit_req(struct memstick_host *msh)
488{
489 struct tifm_ms *host = memstick_priv(msh);
490
491 tasklet_schedule(&host->notify);
492}
493
494static int tifm_ms_set_param(struct memstick_host *msh,
495 enum memstick_param param,
496 int value)
497{
498 struct tifm_ms *host = memstick_priv(msh);
499 struct tifm_dev *sock = host->dev;
500
501 switch (param) {
502 case MEMSTICK_POWER:
503 /* also affected by media detection mechanism */
504 if (value == MEMSTICK_POWER_ON) {
505 host->mode_mask = TIFM_MS_SYS_SRAC | TIFM_MS_SYS_REI;
506 writel(TIFM_MS_SYS_RESET, sock->addr + SOCK_MS_SYSTEM);
507 writel(TIFM_MS_SYS_FCLR | TIFM_MS_SYS_INTCLR,
508 sock->addr + SOCK_MS_SYSTEM);
509 writel(0xffffffff, sock->addr + SOCK_MS_STATUS);
510 } else if (value == MEMSTICK_POWER_OFF) {
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
515 return -EINVAL;
516 break;
517 case MEMSTICK_INTERFACE:
518 if (value == MEMSTICK_SERIAL) {
519 host->mode_mask = TIFM_MS_SYS_SRAC | TIFM_MS_SYS_REI;
520 writel((~TIFM_CTRL_FAST_CLK)
521 & readl(sock->addr + SOCK_CONTROL),
522 sock->addr + SOCK_CONTROL);
523 } else if (value == MEMSTICK_PAR4) {
524 host->mode_mask = 0;
525 writel(TIFM_CTRL_FAST_CLK
526 | readl(sock->addr + SOCK_CONTROL),
527 sock->addr + SOCK_CONTROL);
528 } else
529 return -EINVAL;
530 break;
531 }
532
533 return 0;
534}
535
536static void tifm_ms_abort(struct timer_list *t)
537{
538 struct tifm_ms *host = from_timer(host, t, timer);
539
540 dev_dbg(&host->dev->dev, "status %x\n",
541 readl(host->dev->addr + SOCK_MS_STATUS));
542 printk(KERN_ERR
543 "%s : card failed to respond for a long period of time "
544 "(%x, %x)\n",
545 dev_name(&host->dev->dev), host->req ? host->req->tpc : 0,
546 host->cmd_flags);
547
548 tifm_eject(host->dev);
549}
550
551static int tifm_ms_probe(struct tifm_dev *sock)
552{
553 struct memstick_host *msh;
554 struct tifm_ms *host;
555 int rc = -EIO;
556
557 if (!(TIFM_SOCK_STATE_OCCUPIED
558 & readl(sock->addr + SOCK_PRESENT_STATE))) {
559 printk(KERN_WARNING "%s : card gone, unexpectedly\n",
560 dev_name(&sock->dev));
561 return rc;
562 }
563
564 msh = memstick_alloc_host(sizeof(struct tifm_ms), &sock->dev);
565 if (!msh)
566 return -ENOMEM;
567
568 host = memstick_priv(msh);
569 tifm_set_drvdata(sock, msh);
570 host->dev = sock;
571 host->timeout_jiffies = msecs_to_jiffies(1000);
572
573 timer_setup(&host->timer, tifm_ms_abort, 0);
574 tasklet_init(&host->notify, tifm_ms_req_tasklet, (unsigned long)msh);
575
576 msh->request = tifm_ms_submit_req;
577 msh->set_param = tifm_ms_set_param;
578 sock->card_event = tifm_ms_card_event;
579 sock->data_event = tifm_ms_data_event;
580 if (tifm_has_ms_pif(sock))
581 msh->caps |= MEMSTICK_CAP_PAR4;
582
583 rc = memstick_add_host(msh);
584 if (!rc)
585 return 0;
586
587 memstick_free_host(msh);
588 return rc;
589}
590
591static void tifm_ms_remove(struct tifm_dev *sock)
592{
593 struct memstick_host *msh = tifm_get_drvdata(sock);
594 struct tifm_ms *host = memstick_priv(msh);
595 int rc = 0;
596 unsigned long flags;
597
598 msh->request = tifm_ms_dummy_submit;
599 tasklet_kill(&host->notify);
600 spin_lock_irqsave(&sock->lock, flags);
601 host->eject = 1;
602 if (host->req) {
603 del_timer(&host->timer);
604 writel(TIFM_FIFO_INT_SETALL,
605 sock->addr + SOCK_DMA_FIFO_INT_ENABLE_CLEAR);
606 writel(TIFM_DMA_RESET, sock->addr + SOCK_DMA_CONTROL);
607 if (host->use_dma)
608 tifm_unmap_sg(sock, &host->req->sg, 1,
609 host->req->data_dir == READ
610 ? DMA_TO_DEVICE
611 : DMA_FROM_DEVICE);
612 host->req->error = -ETIME;
613
614 do {
615 rc = memstick_next_req(msh, &host->req);
616 if (!rc)
617 host->req->error = -ETIME;
618 } while (!rc);
619 }
620 spin_unlock_irqrestore(&sock->lock, flags);
621
622 memstick_remove_host(msh);
623 memstick_free_host(msh);
624}
625
626#ifdef CONFIG_PM
627
628static int tifm_ms_suspend(struct tifm_dev *sock, pm_message_t state)
629{
630 struct memstick_host *msh = tifm_get_drvdata(sock);
631
632 memstick_suspend_host(msh);
633 return 0;
634}
635
636static int tifm_ms_resume(struct tifm_dev *sock)
637{
638 struct memstick_host *msh = tifm_get_drvdata(sock);
639
640 memstick_resume_host(msh);
641 return 0;
642}
643
644#else
645
646#define tifm_ms_suspend NULL
647#define tifm_ms_resume NULL
648
649#endif /* CONFIG_PM */
650
651static struct tifm_device_id tifm_ms_id_tbl[] = {
652 { TIFM_TYPE_MS }, { 0 }
653};
654
655static struct tifm_driver tifm_ms_driver = {
656 .driver = {
657 .name = DRIVER_NAME,
658 .owner = THIS_MODULE
659 },
660 .id_table = tifm_ms_id_tbl,
661 .probe = tifm_ms_probe,
662 .remove = tifm_ms_remove,
663 .suspend = tifm_ms_suspend,
664 .resume = tifm_ms_resume
665};
666
667static int __init tifm_ms_init(void)
668{
669 return tifm_register_driver(&tifm_ms_driver);
670}
671
672static void __exit tifm_ms_exit(void)
673{
674 tifm_unregister_driver(&tifm_ms_driver);
675}
676
677MODULE_AUTHOR("Alex Dubov");
678MODULE_DESCRIPTION("TI FlashMedia MemoryStick driver");
679MODULE_LICENSE("GPL");
680MODULE_DEVICE_TABLE(tifm, tifm_ms_id_tbl);
681
682module_init(tifm_ms_init);
683module_exit(tifm_ms_exit);
1/*
2 * TI FlashMedia driver
3 *
4 * Copyright (C) 2007 Alex Dubov <oakad@yahoo.com>
5 *
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.
9 *
10 * Special thanks to Carlos Corbacho for providing various MemoryStick cards
11 * that made this driver possible.
12 *
13 */
14
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>
20#include <asm/io.h>
21
22#define DRIVER_NAME "tifm_ms"
23
24static int no_dma;
25module_param(no_dma, bool, 0644);
26
27/*
28 * Some control bits of TIFM appear to conform to Sony's reference design,
29 * so I'm just assuming they all are.
30 */
31
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
43
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
59
60#define TIFM_MS_SYS_FIFO (TIFM_MS_SYS_INTEN | TIFM_MS_SYS_MSIEN \
61 | TIFM_MS_SYS_FCLR | TIFM_MS_SYS_BSY_MASK)
62
63/* Hardware flags */
64enum {
65 CMD_READY = 0x01,
66 FIFO_READY = 0x02,
67 CARD_INT = 0x04
68};
69
70struct tifm_ms {
71 struct tifm_dev *dev;
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,
79 use_dma:1;
80 unsigned char cmd_flags;
81 unsigned char io_pos;
82 unsigned int io_word;
83};
84
85static unsigned int tifm_ms_read_data(struct tifm_ms *host,
86 unsigned char *buf, unsigned int length)
87{
88 struct tifm_dev *sock = host->dev;
89 unsigned int off = 0;
90
91 while (host->io_pos && length) {
92 buf[off++] = host->io_word & 0xff;
93 host->io_word >>= 8;
94 length--;
95 host->io_pos--;
96 }
97
98 if (!length)
99 return off;
100
101 while (!(TIFM_MS_STAT_EMP & readl(sock->addr + SOCK_MS_STATUS))) {
102 if (length < 4)
103 break;
104 *(unsigned int *)(buf + off) = __raw_readl(sock->addr
105 + SOCK_MS_DATA);
106 length -= 4;
107 off += 4;
108 }
109
110 if (length
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;
115 host->io_word >>= 8;
116 length--;
117 if (!length)
118 break;
119 }
120 }
121
122 return off;
123}
124
125static unsigned int tifm_ms_write_data(struct tifm_ms *host,
126 unsigned char *buf, unsigned int length)
127{
128 struct tifm_dev *sock = host->dev;
129 unsigned int off = 0;
130
131 if (host->io_pos) {
132 while (host->io_pos < 4 && length) {
133 host->io_word |= buf[off++] << (host->io_pos * 8);
134 host->io_pos++;
135 length--;
136 }
137 }
138
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);
144 host->io_pos = 0;
145 host->io_word = 0;
146 } else if (host->io_pos) {
147 return off;
148 }
149
150 if (!length)
151 return off;
152
153 while (!(TIFM_MS_STAT_FUL & readl(sock->addr + SOCK_MS_STATUS))) {
154 if (length < 4)
155 break;
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);
160 length -= 4;
161 off += 4;
162 }
163
164 switch (length) {
165 case 3:
166 host->io_word |= buf[off + 2] << 16;
167 host->io_pos++;
168 case 2:
169 host->io_word |= buf[off + 1] << 8;
170 host->io_pos++;
171 case 1:
172 host->io_word |= buf[off];
173 host->io_pos++;
174 }
175
176 off += host->io_pos;
177
178 return off;
179}
180
181static unsigned int tifm_ms_transfer_data(struct tifm_ms *host)
182{
183 struct tifm_dev *sock = host->dev;
184 unsigned int length;
185 unsigned int off;
186 unsigned int t_size, p_cnt;
187 unsigned char *buf;
188 struct page *pg;
189 unsigned long flags = 0;
190
191 if (host->req->long_data) {
192 length = host->req->sg.length - host->block_pos;
193 off = host->req->sg.offset + host->block_pos;
194 } else {
195 length = host->req->data_len - host->block_pos;
196 off = 0;
197 }
198 dev_dbg(&sock->dev, "fifo data transfer, %d, %d\n", length,
199 host->block_pos);
200
201 while (length) {
202 unsigned int uninitialized_var(p_off);
203
204 if (host->req->long_data) {
205 pg = nth_page(sg_page(&host->req->sg),
206 off >> PAGE_SHIFT);
207 p_off = offset_in_page(off);
208 p_cnt = PAGE_SIZE - p_off;
209 p_cnt = min(p_cnt, length);
210
211 local_irq_save(flags);
212 buf = kmap_atomic(pg, KM_BIO_SRC_IRQ) + p_off;
213 } else {
214 buf = host->req->data + host->block_pos;
215 p_cnt = host->req->data_len - host->block_pos;
216 }
217
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);
221
222 if (host->req->long_data) {
223 kunmap_atomic(buf - p_off, KM_BIO_SRC_IRQ);
224 local_irq_restore(flags);
225 }
226
227 if (!t_size)
228 break;
229 host->block_pos += t_size;
230 length -= t_size;
231 off += t_size;
232 }
233
234 dev_dbg(&sock->dev, "fifo data transfer, %d remaining\n", length);
235 if (!length && (host->req->data_dir == WRITE)) {
236 if (host->io_pos) {
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);
241 }
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);
246 } else {
247 readl(sock->addr + SOCK_MS_DATA);
248 }
249
250 return length;
251}
252
253static int tifm_ms_issue_cmd(struct tifm_ms *host)
254{
255 struct tifm_dev *sock = host->dev;
256 unsigned char *data;
257 unsigned int data_len, cmd, sys_param;
258
259 host->cmd_flags = 0;
260 host->block_pos = 0;
261 host->io_pos = 0;
262 host->io_word = 0;
263 host->cmd_flags = 0;
264
265 data = host->req->data;
266
267 host->use_dma = !no_dma;
268
269 if (host->req->long_data) {
270 data_len = host->req->sg.length;
271 if (!is_power_of_2(data_len))
272 host->use_dma = 0;
273 } else {
274 data_len = host->req->data_len;
275 host->use_dma = 0;
276 }
277
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);
282
283 if (host->use_dma) {
284 if (1 != tifm_map_sg(sock, &host->req->sg, 1,
285 host->req->data_dir == READ
286 ? PCI_DMA_FROMDEVICE
287 : PCI_DMA_TODEVICE)) {
288 host->req->error = -ENOMEM;
289 return host->req->error;
290 }
291 data_len = sg_dma_len(&host->req->sg);
292
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;
300
301 writel(TIFM_FIFO_INTMASK,
302 sock->addr + SOCK_DMA_FIFO_INT_ENABLE_SET);
303
304 writel(sg_dma_address(&host->req->sg),
305 sock->addr + SOCK_DMA_ADDRESS);
306 writel(sys_param, sock->addr + SOCK_DMA_CONTROL);
307 } else {
308 writel(host->mode_mask | TIFM_MS_SYS_FIFO,
309 sock->addr + SOCK_MS_SYSTEM);
310
311 writel(TIFM_FIFO_MORE,
312 sock->addr + SOCK_DMA_FIFO_INT_ENABLE_SET);
313 }
314
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;
319
320 sys_param = readl(sock->addr + SOCK_MS_SYSTEM);
321 sys_param |= TIFM_MS_SYS_INTCLR;
322
323 if (host->use_dma)
324 sys_param |= TIFM_MS_SYS_DMA;
325 else
326 sys_param &= ~TIFM_MS_SYS_DMA;
327
328 writel(sys_param, sock->addr + SOCK_MS_SYSTEM);
329
330 cmd = (host->req->tpc & 0xf) << 12;
331 cmd |= data_len;
332 writel(cmd, sock->addr + SOCK_MS_COMMAND);
333
334 dev_dbg(&sock->dev, "executing TPC %x, %x\n", cmd, sys_param);
335 return 0;
336}
337
338static void tifm_ms_complete_cmd(struct tifm_ms *host)
339{
340 struct tifm_dev *sock = host->dev;
341 struct memstick_host *msh = tifm_get_drvdata(sock);
342 int rc;
343
344 del_timer(&host->timer);
345
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);
349
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);
353
354 if (host->use_dma) {
355 tifm_unmap_sg(sock, &host->req->sg, 1,
356 host->req->data_dir == READ
357 ? PCI_DMA_FROMDEVICE
358 : PCI_DMA_TODEVICE);
359 }
360
361 writel((~TIFM_CTRL_LED) & readl(sock->addr + SOCK_CONTROL),
362 sock->addr + SOCK_CONTROL);
363
364 dev_dbg(&sock->dev, "TPC complete\n");
365 do {
366 rc = memstick_next_req(msh, &host->req);
367 } while (!rc && tifm_ms_issue_cmd(host));
368}
369
370static int tifm_ms_check_status(struct tifm_ms *host)
371{
372 if (!host->req->error) {
373 if (!(host->cmd_flags & CMD_READY))
374 return 1;
375 if (!(host->cmd_flags & FIFO_READY))
376 return 1;
377 if (host->req->need_card_int
378 && !(host->cmd_flags & CARD_INT))
379 return 1;
380 }
381 return 0;
382}
383
384/* Called from interrupt handler */
385static void tifm_ms_data_event(struct tifm_dev *sock)
386{
387 struct tifm_ms *host;
388 unsigned int fifo_status = 0, host_status = 0;
389 int rc = 1;
390
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);
395 dev_dbg(&sock->dev,
396 "data event: fifo_status %x, host_status %x, flags %x\n",
397 fifo_status, host_status, host->cmd_flags);
398
399 if (host->req) {
400 if (host->use_dma && (fifo_status & 1)) {
401 host->cmd_flags |= FIFO_READY;
402 rc = tifm_ms_check_status(host);
403 }
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);
408 }
409 }
410 }
411
412 writel(fifo_status, sock->addr + SOCK_DMA_FIFO_STATUS);
413 if (!rc)
414 tifm_ms_complete_cmd(host);
415
416 spin_unlock(&sock->lock);
417}
418
419
420/* Called from interrupt handler */
421static void tifm_ms_card_event(struct tifm_dev *sock)
422{
423 struct tifm_ms *host;
424 unsigned int host_status = 0;
425 int rc = 1;
426
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);
432
433 if (host->req) {
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;
438
439 if (host_status & TIFM_MS_STAT_RDY)
440 host->cmd_flags |= CMD_READY;
441
442 if (host_status & TIFM_MS_STAT_MSINT)
443 host->cmd_flags |= CARD_INT;
444
445 rc = tifm_ms_check_status(host);
446
447 }
448
449 writel(TIFM_MS_SYS_INTCLR | readl(sock->addr + SOCK_MS_SYSTEM),
450 sock->addr + SOCK_MS_SYSTEM);
451
452 if (!rc)
453 tifm_ms_complete_cmd(host);
454
455 spin_unlock(&sock->lock);
456 return;
457}
458
459static void tifm_ms_req_tasklet(unsigned long data)
460{
461 struct memstick_host *msh = (struct memstick_host *)data;
462 struct tifm_ms *host = memstick_priv(msh);
463 struct tifm_dev *sock = host->dev;
464 unsigned long flags;
465 int rc;
466
467 spin_lock_irqsave(&sock->lock, flags);
468 if (!host->req) {
469 if (host->eject) {
470 do {
471 rc = memstick_next_req(msh, &host->req);
472 if (!rc)
473 host->req->error = -ETIME;
474 } while (!rc);
475 spin_unlock_irqrestore(&sock->lock, flags);
476 return;
477 }
478
479 do {
480 rc = memstick_next_req(msh, &host->req);
481 } while (!rc && tifm_ms_issue_cmd(host));
482 }
483 spin_unlock_irqrestore(&sock->lock, flags);
484}
485
486static void tifm_ms_dummy_submit(struct memstick_host *msh)
487{
488 return;
489}
490
491static void tifm_ms_submit_req(struct memstick_host *msh)
492{
493 struct tifm_ms *host = memstick_priv(msh);
494
495 tasklet_schedule(&host->notify);
496}
497
498static int tifm_ms_set_param(struct memstick_host *msh,
499 enum memstick_param param,
500 int value)
501{
502 struct tifm_ms *host = memstick_priv(msh);
503 struct tifm_dev *sock = host->dev;
504
505 switch (param) {
506 case MEMSTICK_POWER:
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);
518 } else
519 return -EINVAL;
520 break;
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) {
528 host->mode_mask = 0;
529 writel(TIFM_CTRL_FAST_CLK
530 | readl(sock->addr + SOCK_CONTROL),
531 sock->addr + SOCK_CONTROL);
532 } else
533 return -EINVAL;
534 break;
535 };
536
537 return 0;
538}
539
540static void tifm_ms_abort(unsigned long data)
541{
542 struct tifm_ms *host = (struct tifm_ms *)data;
543
544 dev_dbg(&host->dev->dev, "status %x\n",
545 readl(host->dev->addr + SOCK_MS_STATUS));
546 printk(KERN_ERR
547 "%s : card failed to respond for a long period of time "
548 "(%x, %x)\n",
549 dev_name(&host->dev->dev), host->req ? host->req->tpc : 0,
550 host->cmd_flags);
551
552 tifm_eject(host->dev);
553}
554
555static int tifm_ms_probe(struct tifm_dev *sock)
556{
557 struct memstick_host *msh;
558 struct tifm_ms *host;
559 int rc = -EIO;
560
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));
565 return rc;
566 }
567
568 msh = memstick_alloc_host(sizeof(struct tifm_ms), &sock->dev);
569 if (!msh)
570 return -ENOMEM;
571
572 host = memstick_priv(msh);
573 tifm_set_drvdata(sock, msh);
574 host->dev = sock;
575 host->timeout_jiffies = msecs_to_jiffies(1000);
576
577 setup_timer(&host->timer, tifm_ms_abort, (unsigned long)host);
578 tasklet_init(&host->notify, tifm_ms_req_tasklet, (unsigned long)msh);
579
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;
586
587 rc = memstick_add_host(msh);
588 if (!rc)
589 return 0;
590
591 memstick_free_host(msh);
592 return rc;
593}
594
595static void tifm_ms_remove(struct tifm_dev *sock)
596{
597 struct memstick_host *msh = tifm_get_drvdata(sock);
598 struct tifm_ms *host = memstick_priv(msh);
599 int rc = 0;
600 unsigned long flags;
601
602 msh->request = tifm_ms_dummy_submit;
603 tasklet_kill(&host->notify);
604 spin_lock_irqsave(&sock->lock, flags);
605 host->eject = 1;
606 if (host->req) {
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);
611 if (host->use_dma)
612 tifm_unmap_sg(sock, &host->req->sg, 1,
613 host->req->data_dir == READ
614 ? PCI_DMA_TODEVICE
615 : PCI_DMA_FROMDEVICE);
616 host->req->error = -ETIME;
617
618 do {
619 rc = memstick_next_req(msh, &host->req);
620 if (!rc)
621 host->req->error = -ETIME;
622 } while (!rc);
623 }
624 spin_unlock_irqrestore(&sock->lock, flags);
625
626 memstick_remove_host(msh);
627 memstick_free_host(msh);
628}
629
630#ifdef CONFIG_PM
631
632static int tifm_ms_suspend(struct tifm_dev *sock, pm_message_t state)
633{
634 struct memstick_host *msh = tifm_get_drvdata(sock);
635
636 memstick_suspend_host(msh);
637 return 0;
638}
639
640static int tifm_ms_resume(struct tifm_dev *sock)
641{
642 struct memstick_host *msh = tifm_get_drvdata(sock);
643
644 memstick_resume_host(msh);
645 return 0;
646}
647
648#else
649
650#define tifm_ms_suspend NULL
651#define tifm_ms_resume NULL
652
653#endif /* CONFIG_PM */
654
655static struct tifm_device_id tifm_ms_id_tbl[] = {
656 { TIFM_TYPE_MS }, { 0 }
657};
658
659static struct tifm_driver tifm_ms_driver = {
660 .driver = {
661 .name = DRIVER_NAME,
662 .owner = THIS_MODULE
663 },
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
669};
670
671static int __init tifm_ms_init(void)
672{
673 return tifm_register_driver(&tifm_ms_driver);
674}
675
676static void __exit tifm_ms_exit(void)
677{
678 tifm_unregister_driver(&tifm_ms_driver);
679}
680
681MODULE_AUTHOR("Alex Dubov");
682MODULE_DESCRIPTION("TI FlashMedia MemoryStick driver");
683MODULE_LICENSE("GPL");
684MODULE_DEVICE_TABLE(tifm, tifm_ms_id_tbl);
685
686module_init(tifm_ms_init);
687module_exit(tifm_ms_exit);