1 /* Realtek PCI-Express Memstick Card Interface driver
3 * Copyright(c) 2009-2013 Realtek Semiconductor Corp. All rights reserved.
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License as published by the
7 * Free Software Foundation; either version 2, or (at your option) any
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, see <http://www.gnu.org/licenses/>.
19 * Wei WANG <wei_wang@realsil.com.cn>
22 #include <linux/module.h>
23 #include <linux/highmem.h>
24 #include <linux/delay.h>
25 #include <linux/platform_device.h>
26 #include <linux/memstick.h>
27 #include <linux/mfd/rtsx_pci.h>
28 #include <asm/unaligned.h>
30 struct realtek_pci_ms
{
31 struct platform_device
*pdev
;
33 struct memstick_host
*msh
;
34 struct memstick_request
*req
;
36 struct mutex host_mutex
;
37 struct work_struct handle_req
;
45 static inline struct device
*ms_dev(struct realtek_pci_ms
*host
)
47 return &(host
->pdev
->dev
);
50 static inline void ms_clear_error(struct realtek_pci_ms
*host
)
52 rtsx_pci_write_register(host
->pcr
, CARD_STOP
,
53 MS_STOP
| MS_CLR_ERR
, MS_STOP
| MS_CLR_ERR
);
58 static void ms_print_debug_regs(struct realtek_pci_ms
*host
)
60 struct rtsx_pcr
*pcr
= host
->pcr
;
64 /* Print MS host internal registers */
65 rtsx_pci_init_cmd(pcr
);
66 for (i
= 0xFD40; i
<= 0xFD44; i
++)
67 rtsx_pci_add_cmd(pcr
, READ_REG_CMD
, i
, 0, 0);
68 for (i
= 0xFD52; i
<= 0xFD69; i
++)
69 rtsx_pci_add_cmd(pcr
, READ_REG_CMD
, i
, 0, 0);
70 rtsx_pci_send_cmd(pcr
, 100);
72 ptr
= rtsx_pci_get_cmd_data(pcr
);
73 for (i
= 0xFD40; i
<= 0xFD44; i
++)
74 dev_dbg(ms_dev(host
), "0x%04X: 0x%02x\n", i
, *(ptr
++));
75 for (i
= 0xFD52; i
<= 0xFD69; i
++)
76 dev_dbg(ms_dev(host
), "0x%04X: 0x%02x\n", i
, *(ptr
++));
81 #define ms_print_debug_regs(host)
85 static int ms_power_on(struct realtek_pci_ms
*host
)
87 struct rtsx_pcr
*pcr
= host
->pcr
;
90 rtsx_pci_init_cmd(pcr
);
91 rtsx_pci_add_cmd(pcr
, WRITE_REG_CMD
, CARD_SELECT
, 0x07, MS_MOD_SEL
);
92 rtsx_pci_add_cmd(pcr
, WRITE_REG_CMD
, CARD_SHARE_MODE
,
93 CARD_SHARE_MASK
, CARD_SHARE_48_MS
);
94 rtsx_pci_add_cmd(pcr
, WRITE_REG_CMD
, CARD_CLK_EN
,
95 MS_CLK_EN
, MS_CLK_EN
);
96 err
= rtsx_pci_send_cmd(pcr
, 100);
100 err
= rtsx_pci_card_pull_ctl_enable(pcr
, RTSX_MS_CARD
);
104 err
= rtsx_pci_card_power_on(pcr
, RTSX_MS_CARD
);
108 /* Wait ms power stable */
111 err
= rtsx_pci_write_register(pcr
, CARD_OE
,
112 MS_OUTPUT_EN
, MS_OUTPUT_EN
);
119 static int ms_power_off(struct realtek_pci_ms
*host
)
121 struct rtsx_pcr
*pcr
= host
->pcr
;
124 rtsx_pci_init_cmd(pcr
);
126 rtsx_pci_add_cmd(pcr
, WRITE_REG_CMD
, CARD_CLK_EN
, MS_CLK_EN
, 0);
127 rtsx_pci_add_cmd(pcr
, WRITE_REG_CMD
, CARD_OE
, MS_OUTPUT_EN
, 0);
129 err
= rtsx_pci_send_cmd(pcr
, 100);
133 err
= rtsx_pci_card_power_off(pcr
, RTSX_MS_CARD
);
137 return rtsx_pci_card_pull_ctl_disable(pcr
, RTSX_MS_CARD
);
140 static int ms_transfer_data(struct realtek_pci_ms
*host
, unsigned char data_dir
,
141 u8 tpc
, u8 cfg
, struct scatterlist
*sg
)
143 struct rtsx_pcr
*pcr
= host
->pcr
;
145 unsigned int length
= sg
->length
;
146 u16 sec_cnt
= (u16
)(length
/ 512);
147 u8 val
, trans_mode
, dma_dir
;
148 struct memstick_dev
*card
= host
->msh
->card
;
149 bool pro_card
= card
->id
.type
== MEMSTICK_TYPE_PRO
;
151 dev_dbg(ms_dev(host
), "%s: tpc = 0x%02x, data_dir = %s, length = %d\n",
152 __func__
, tpc
, (data_dir
== READ
) ? "READ" : "WRITE",
155 if (data_dir
== READ
) {
156 dma_dir
= DMA_DIR_FROM_CARD
;
157 trans_mode
= pro_card
? MS_TM_AUTO_READ
: MS_TM_NORMAL_READ
;
159 dma_dir
= DMA_DIR_TO_CARD
;
160 trans_mode
= pro_card
? MS_TM_AUTO_WRITE
: MS_TM_NORMAL_WRITE
;
163 rtsx_pci_init_cmd(pcr
);
165 rtsx_pci_add_cmd(pcr
, WRITE_REG_CMD
, MS_TPC
, 0xFF, tpc
);
167 rtsx_pci_add_cmd(pcr
, WRITE_REG_CMD
, MS_SECTOR_CNT_H
,
168 0xFF, (u8
)(sec_cnt
>> 8));
169 rtsx_pci_add_cmd(pcr
, WRITE_REG_CMD
, MS_SECTOR_CNT_L
,
172 rtsx_pci_add_cmd(pcr
, WRITE_REG_CMD
, MS_TRANS_CFG
, 0xFF, cfg
);
174 rtsx_pci_add_cmd(pcr
, WRITE_REG_CMD
, IRQSTAT0
,
175 DMA_DONE_INT
, DMA_DONE_INT
);
176 rtsx_pci_add_cmd(pcr
, WRITE_REG_CMD
, DMATC3
, 0xFF, (u8
)(length
>> 24));
177 rtsx_pci_add_cmd(pcr
, WRITE_REG_CMD
, DMATC2
, 0xFF, (u8
)(length
>> 16));
178 rtsx_pci_add_cmd(pcr
, WRITE_REG_CMD
, DMATC1
, 0xFF, (u8
)(length
>> 8));
179 rtsx_pci_add_cmd(pcr
, WRITE_REG_CMD
, DMATC0
, 0xFF, (u8
)length
);
180 rtsx_pci_add_cmd(pcr
, WRITE_REG_CMD
, DMACTL
,
181 0x03 | DMA_PACK_SIZE_MASK
, dma_dir
| DMA_EN
| DMA_512
);
182 rtsx_pci_add_cmd(pcr
, WRITE_REG_CMD
, CARD_DATA_SOURCE
,
185 rtsx_pci_add_cmd(pcr
, WRITE_REG_CMD
, MS_TRANSFER
,
186 0xFF, MS_TRANSFER_START
| trans_mode
);
187 rtsx_pci_add_cmd(pcr
, CHECK_REG_CMD
, MS_TRANSFER
,
188 MS_TRANSFER_END
, MS_TRANSFER_END
);
190 rtsx_pci_send_cmd_no_wait(pcr
);
192 err
= rtsx_pci_transfer_data(pcr
, sg
, 1, data_dir
== READ
, 10000);
194 ms_clear_error(host
);
198 rtsx_pci_read_register(pcr
, MS_TRANS_CFG
, &val
);
200 if (val
& (MS_INT_CMDNK
| MS_INT_ERR
|
201 MS_CRC16_ERR
| MS_RDY_TIMEOUT
))
204 if (val
& (MS_CRC16_ERR
| MS_RDY_TIMEOUT
))
211 static int ms_write_bytes(struct realtek_pci_ms
*host
, u8 tpc
,
212 u8 cfg
, u8 cnt
, u8
*data
, u8
*int_reg
)
214 struct rtsx_pcr
*pcr
= host
->pcr
;
217 dev_dbg(ms_dev(host
), "%s: tpc = 0x%02x\n", __func__
, tpc
);
222 rtsx_pci_init_cmd(pcr
);
224 for (i
= 0; i
< cnt
; i
++)
225 rtsx_pci_add_cmd(pcr
, WRITE_REG_CMD
,
226 PPBUF_BASE2
+ i
, 0xFF, data
[i
]);
228 rtsx_pci_add_cmd(pcr
, WRITE_REG_CMD
,
229 PPBUF_BASE2
+ i
, 0xFF, 0xFF);
231 rtsx_pci_add_cmd(pcr
, WRITE_REG_CMD
, MS_TPC
, 0xFF, tpc
);
232 rtsx_pci_add_cmd(pcr
, WRITE_REG_CMD
, MS_BYTE_CNT
, 0xFF, cnt
);
233 rtsx_pci_add_cmd(pcr
, WRITE_REG_CMD
, MS_TRANS_CFG
, 0xFF, cfg
);
234 rtsx_pci_add_cmd(pcr
, WRITE_REG_CMD
, CARD_DATA_SOURCE
,
235 0x01, PINGPONG_BUFFER
);
237 rtsx_pci_add_cmd(pcr
, WRITE_REG_CMD
, MS_TRANSFER
,
238 0xFF, MS_TRANSFER_START
| MS_TM_WRITE_BYTES
);
239 rtsx_pci_add_cmd(pcr
, CHECK_REG_CMD
, MS_TRANSFER
,
240 MS_TRANSFER_END
, MS_TRANSFER_END
);
242 rtsx_pci_add_cmd(pcr
, READ_REG_CMD
, MS_TRANS_CFG
, 0, 0);
244 err
= rtsx_pci_send_cmd(pcr
, 5000);
248 rtsx_pci_read_register(pcr
, MS_TRANS_CFG
, &val
);
249 dev_dbg(ms_dev(host
), "MS_TRANS_CFG: 0x%02x\n", val
);
252 *int_reg
= val
& 0x0F;
254 ms_print_debug_regs(host
);
256 ms_clear_error(host
);
259 if (val
& MS_CRC16_ERR
)
263 if (val
& (MS_INT_ERR
| MS_INT_CMDNK
))
272 u8
*ptr
= rtsx_pci_get_cmd_data(pcr
) + 1;
273 *int_reg
= *ptr
& 0x0F;
279 static int ms_read_bytes(struct realtek_pci_ms
*host
, u8 tpc
,
280 u8 cfg
, u8 cnt
, u8
*data
, u8
*int_reg
)
282 struct rtsx_pcr
*pcr
= host
->pcr
;
286 dev_dbg(ms_dev(host
), "%s: tpc = 0x%02x\n", __func__
, tpc
);
291 rtsx_pci_init_cmd(pcr
);
293 rtsx_pci_add_cmd(pcr
, WRITE_REG_CMD
, MS_TPC
, 0xFF, tpc
);
294 rtsx_pci_add_cmd(pcr
, WRITE_REG_CMD
, MS_BYTE_CNT
, 0xFF, cnt
);
295 rtsx_pci_add_cmd(pcr
, WRITE_REG_CMD
, MS_TRANS_CFG
, 0xFF, cfg
);
296 rtsx_pci_add_cmd(pcr
, WRITE_REG_CMD
, CARD_DATA_SOURCE
,
297 0x01, PINGPONG_BUFFER
);
299 rtsx_pci_add_cmd(pcr
, WRITE_REG_CMD
, MS_TRANSFER
,
300 0xFF, MS_TRANSFER_START
| MS_TM_READ_BYTES
);
301 rtsx_pci_add_cmd(pcr
, CHECK_REG_CMD
, MS_TRANSFER
,
302 MS_TRANSFER_END
, MS_TRANSFER_END
);
303 for (i
= 0; i
< cnt
- 1; i
++)
304 rtsx_pci_add_cmd(pcr
, READ_REG_CMD
, PPBUF_BASE2
+ i
, 0, 0);
306 rtsx_pci_add_cmd(pcr
, READ_REG_CMD
, PPBUF_BASE2
+ cnt
, 0, 0);
308 rtsx_pci_add_cmd(pcr
, READ_REG_CMD
,
309 PPBUF_BASE2
+ cnt
- 1, 0, 0);
311 rtsx_pci_add_cmd(pcr
, READ_REG_CMD
, MS_TRANS_CFG
, 0, 0);
313 err
= rtsx_pci_send_cmd(pcr
, 5000);
317 rtsx_pci_read_register(pcr
, MS_TRANS_CFG
, &val
);
318 dev_dbg(ms_dev(host
), "MS_TRANS_CFG: 0x%02x\n", val
);
321 *int_reg
= val
& 0x0F;
323 ms_print_debug_regs(host
);
325 ms_clear_error(host
);
328 if (val
& MS_CRC16_ERR
)
332 if (val
& (MS_INT_ERR
| MS_INT_CMDNK
))
340 ptr
= rtsx_pci_get_cmd_data(pcr
) + 1;
341 for (i
= 0; i
< cnt
; i
++)
345 *int_reg
= *ptr
& 0x0F;
350 static int rtsx_pci_ms_issue_cmd(struct realtek_pci_ms
*host
)
352 struct memstick_request
*req
= host
->req
;
356 dev_dbg(ms_dev(host
), "%s\n", __func__
);
358 if (req
->need_card_int
) {
359 if (host
->ifmode
!= MEMSTICK_SERIAL
)
363 if (req
->long_data
) {
364 err
= ms_transfer_data(host
, req
->data_dir
,
365 req
->tpc
, cfg
, &(req
->sg
));
367 if (req
->data_dir
== READ
) {
368 err
= ms_read_bytes(host
, req
->tpc
, cfg
,
369 req
->data_len
, req
->data
, &int_reg
);
371 err
= ms_write_bytes(host
, req
->tpc
, cfg
,
372 req
->data_len
, req
->data
, &int_reg
);
378 if (req
->need_card_int
&& (host
->ifmode
== MEMSTICK_SERIAL
)) {
379 err
= ms_read_bytes(host
, MS_TPC_GET_INT
,
380 NO_WAIT_INT
, 1, &int_reg
, NULL
);
385 if (req
->need_card_int
) {
386 dev_dbg(ms_dev(host
), "int_reg: 0x%02x\n", int_reg
);
388 if (int_reg
& MS_INT_CMDNK
)
389 req
->int_reg
|= MEMSTICK_INT_CMDNAK
;
390 if (int_reg
& MS_INT_BREQ
)
391 req
->int_reg
|= MEMSTICK_INT_BREQ
;
392 if (int_reg
& MS_INT_ERR
)
393 req
->int_reg
|= MEMSTICK_INT_ERR
;
394 if (int_reg
& MS_INT_CED
)
395 req
->int_reg
|= MEMSTICK_INT_CED
;
401 static void rtsx_pci_ms_handle_req(struct work_struct
*work
)
403 struct realtek_pci_ms
*host
= container_of(work
,
404 struct realtek_pci_ms
, handle_req
);
405 struct rtsx_pcr
*pcr
= host
->pcr
;
406 struct memstick_host
*msh
= host
->msh
;
409 mutex_lock(&pcr
->pcr_mutex
);
411 rtsx_pci_start_run(pcr
);
413 rtsx_pci_switch_clock(host
->pcr
, host
->clock
, host
->ssc_depth
,
415 rtsx_pci_write_register(pcr
, CARD_SELECT
, 0x07, MS_MOD_SEL
);
416 rtsx_pci_write_register(pcr
, CARD_SHARE_MODE
,
417 CARD_SHARE_MASK
, CARD_SHARE_48_MS
);
421 rc
= memstick_next_req(msh
, &host
->req
);
422 dev_dbg(ms_dev(host
), "next req %d\n", rc
);
425 host
->req
->error
= rtsx_pci_ms_issue_cmd(host
);
429 mutex_unlock(&pcr
->pcr_mutex
);
432 static void rtsx_pci_ms_request(struct memstick_host
*msh
)
434 struct realtek_pci_ms
*host
= memstick_priv(msh
);
436 dev_dbg(ms_dev(host
), "--> %s\n", __func__
);
438 if (rtsx_pci_card_exclusive_check(host
->pcr
, RTSX_MS_CARD
))
441 schedule_work(&host
->handle_req
);
444 static int rtsx_pci_ms_set_param(struct memstick_host
*msh
,
445 enum memstick_param param
, int value
)
447 struct realtek_pci_ms
*host
= memstick_priv(msh
);
448 struct rtsx_pcr
*pcr
= host
->pcr
;
449 unsigned int clock
= 0;
453 dev_dbg(ms_dev(host
), "%s: param = %d, value = %d\n",
454 __func__
, param
, value
);
456 err
= rtsx_pci_card_exclusive_check(host
->pcr
, RTSX_MS_CARD
);
462 if (value
== MEMSTICK_POWER_ON
)
463 err
= ms_power_on(host
);
464 else if (value
== MEMSTICK_POWER_OFF
)
465 err
= ms_power_off(host
);
470 case MEMSTICK_INTERFACE
:
471 if (value
== MEMSTICK_SERIAL
) {
473 ssc_depth
= RTSX_SSC_DEPTH_500K
;
475 err
= rtsx_pci_write_register(pcr
, MS_CFG
, 0x58,
476 MS_BUS_WIDTH_1
| PUSH_TIME_DEFAULT
);
479 } else if (value
== MEMSTICK_PAR4
) {
481 ssc_depth
= RTSX_SSC_DEPTH_1M
;
483 err
= rtsx_pci_write_register(pcr
, MS_CFG
,
484 0x58, MS_BUS_WIDTH_4
| PUSH_TIME_ODD
);
491 err
= rtsx_pci_switch_clock(pcr
, clock
,
492 ssc_depth
, false, true, false);
496 host
->ssc_depth
= ssc_depth
;
498 host
->ifmode
= value
;
507 static int rtsx_pci_ms_suspend(struct platform_device
*pdev
, pm_message_t state
)
509 struct realtek_pci_ms
*host
= platform_get_drvdata(pdev
);
510 struct memstick_host
*msh
= host
->msh
;
512 dev_dbg(ms_dev(host
), "--> %s\n", __func__
);
514 memstick_suspend_host(msh
);
518 static int rtsx_pci_ms_resume(struct platform_device
*pdev
)
520 struct realtek_pci_ms
*host
= platform_get_drvdata(pdev
);
521 struct memstick_host
*msh
= host
->msh
;
523 dev_dbg(ms_dev(host
), "--> %s\n", __func__
);
525 memstick_resume_host(msh
);
529 #else /* CONFIG_PM */
531 #define rtsx_pci_ms_suspend NULL
532 #define rtsx_pci_ms_resume NULL
534 #endif /* CONFIG_PM */
536 static void rtsx_pci_ms_card_event(struct platform_device
*pdev
)
538 struct realtek_pci_ms
*host
= platform_get_drvdata(pdev
);
540 memstick_detect_change(host
->msh
);
543 static int rtsx_pci_ms_drv_probe(struct platform_device
*pdev
)
545 struct memstick_host
*msh
;
546 struct realtek_pci_ms
*host
;
547 struct rtsx_pcr
*pcr
;
548 struct pcr_handle
*handle
= pdev
->dev
.platform_data
;
558 dev_dbg(&(pdev
->dev
),
559 ": Realtek PCI-E Memstick controller found\n");
561 msh
= memstick_alloc_host(sizeof(*host
), &pdev
->dev
);
565 host
= memstick_priv(msh
);
569 platform_set_drvdata(pdev
, host
);
570 pcr
->slots
[RTSX_MS_CARD
].p_dev
= pdev
;
571 pcr
->slots
[RTSX_MS_CARD
].card_event
= rtsx_pci_ms_card_event
;
573 mutex_init(&host
->host_mutex
);
575 INIT_WORK(&host
->handle_req
, rtsx_pci_ms_handle_req
);
576 msh
->request
= rtsx_pci_ms_request
;
577 msh
->set_param
= rtsx_pci_ms_set_param
;
578 msh
->caps
= MEMSTICK_CAP_PAR4
;
580 rc
= memstick_add_host(msh
);
582 memstick_free_host(msh
);
589 static int rtsx_pci_ms_drv_remove(struct platform_device
*pdev
)
591 struct realtek_pci_ms
*host
= platform_get_drvdata(pdev
);
592 struct rtsx_pcr
*pcr
;
593 struct memstick_host
*msh
;
600 pcr
->slots
[RTSX_MS_CARD
].p_dev
= NULL
;
601 pcr
->slots
[RTSX_MS_CARD
].card_event
= NULL
;
604 cancel_work_sync(&host
->handle_req
);
606 mutex_lock(&host
->host_mutex
);
608 dev_dbg(&(pdev
->dev
),
609 "%s: Controller removed during transfer\n",
610 dev_name(&msh
->dev
));
612 rtsx_pci_complete_unfinished_transfer(pcr
);
614 host
->req
->error
= -ENOMEDIUM
;
616 rc
= memstick_next_req(msh
, &host
->req
);
618 host
->req
->error
= -ENOMEDIUM
;
621 mutex_unlock(&host
->host_mutex
);
623 memstick_remove_host(msh
);
624 memstick_free_host(msh
);
626 dev_dbg(&(pdev
->dev
),
627 ": Realtek PCI-E Memstick controller has been removed\n");
632 static struct platform_device_id rtsx_pci_ms_ids
[] = {
634 .name
= DRV_NAME_RTSX_PCI_MS
,
639 MODULE_DEVICE_TABLE(platform
, rtsx_pci_ms_ids
);
641 static struct platform_driver rtsx_pci_ms_driver
= {
642 .probe
= rtsx_pci_ms_drv_probe
,
643 .remove
= rtsx_pci_ms_drv_remove
,
644 .id_table
= rtsx_pci_ms_ids
,
645 .suspend
= rtsx_pci_ms_suspend
,
646 .resume
= rtsx_pci_ms_resume
,
648 .name
= DRV_NAME_RTSX_PCI_MS
,
651 module_platform_driver(rtsx_pci_ms_driver
);
653 MODULE_LICENSE("GPL");
654 MODULE_AUTHOR("Wei WANG <wei_wang@realsil.com.cn>");
655 MODULE_DESCRIPTION("Realtek PCI-E Memstick Card Host Driver");