1 /* Driver for Realtek PCI-Express card reader
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/pci.h>
23 #include <linux/module.h>
24 #include <linux/slab.h>
25 #include <linux/dma-mapping.h>
26 #include <linux/highmem.h>
27 #include <linux/interrupt.h>
28 #include <linux/delay.h>
29 #include <linux/idr.h>
30 #include <linux/platform_device.h>
31 #include <linux/mfd/core.h>
32 #include <linux/mfd/rtsx_pci.h>
33 #include <asm/unaligned.h>
37 static bool msi_en = true;
38 module_param(msi_en, bool, S_IRUGO | S_IWUSR);
39 MODULE_PARM_DESC(msi_en, "Enable MSI");
41 static DEFINE_IDR(rtsx_pci_idr);
42 static DEFINE_SPINLOCK(rtsx_pci_lock);
44 static struct mfd_cell rtsx_pcr_cells[] = {
46 .name = DRV_NAME_RTSX_PCI_SDMMC,
49 .name = DRV_NAME_RTSX_PCI_MS,
53 static const struct pci_device_id rtsx_pci_ids[] = {
54 { PCI_DEVICE(0x10EC, 0x5209), PCI_CLASS_OTHERS << 16, 0xFF0000 },
55 { PCI_DEVICE(0x10EC, 0x5229), PCI_CLASS_OTHERS << 16, 0xFF0000 },
56 { PCI_DEVICE(0x10EC, 0x5289), PCI_CLASS_OTHERS << 16, 0xFF0000 },
57 { PCI_DEVICE(0x10EC, 0x5227), PCI_CLASS_OTHERS << 16, 0xFF0000 },
58 { PCI_DEVICE(0x10EC, 0x522A), PCI_CLASS_OTHERS << 16, 0xFF0000 },
59 { PCI_DEVICE(0x10EC, 0x5249), PCI_CLASS_OTHERS << 16, 0xFF0000 },
60 { PCI_DEVICE(0x10EC, 0x5287), PCI_CLASS_OTHERS << 16, 0xFF0000 },
61 { PCI_DEVICE(0x10EC, 0x5286), PCI_CLASS_OTHERS << 16, 0xFF0000 },
62 { PCI_DEVICE(0x10EC, 0x524A), PCI_CLASS_OTHERS << 16, 0xFF0000 },
63 { PCI_DEVICE(0x10EC, 0x525A), PCI_CLASS_OTHERS << 16, 0xFF0000 },
67 MODULE_DEVICE_TABLE(pci, rtsx_pci_ids);
69 static inline void rtsx_pci_enable_aspm(struct rtsx_pcr *pcr)
71 rtsx_pci_update_cfg_byte(pcr, pcr->pcie_cap + PCI_EXP_LNKCTL,
75 static inline void rtsx_pci_disable_aspm(struct rtsx_pcr *pcr)
77 rtsx_pci_update_cfg_byte(pcr, pcr->pcie_cap + PCI_EXP_LNKCTL,
81 void rtsx_pci_start_run(struct rtsx_pcr *pcr)
83 /* If pci device removed, don't queue idle work any more */
87 if (pcr->state != PDEV_STAT_RUN) {
88 pcr->state = PDEV_STAT_RUN;
89 if (pcr->ops->enable_auto_blink)
90 pcr->ops->enable_auto_blink(pcr);
93 rtsx_pci_disable_aspm(pcr);
96 mod_delayed_work(system_wq, &pcr->idle_work, msecs_to_jiffies(200));
98 EXPORT_SYMBOL_GPL(rtsx_pci_start_run);
100 int rtsx_pci_write_register(struct rtsx_pcr *pcr, u16 addr, u8 mask, u8 data)
103 u32 val = HAIMR_WRITE_START;
105 val |= (u32)(addr & 0x3FFF) << 16;
106 val |= (u32)mask << 8;
109 rtsx_pci_writel(pcr, RTSX_HAIMR, val);
111 for (i = 0; i < MAX_RW_REG_CNT; i++) {
112 val = rtsx_pci_readl(pcr, RTSX_HAIMR);
113 if ((val & HAIMR_TRANS_END) == 0) {
122 EXPORT_SYMBOL_GPL(rtsx_pci_write_register);
124 int rtsx_pci_read_register(struct rtsx_pcr *pcr, u16 addr, u8 *data)
126 u32 val = HAIMR_READ_START;
129 val |= (u32)(addr & 0x3FFF) << 16;
130 rtsx_pci_writel(pcr, RTSX_HAIMR, val);
132 for (i = 0; i < MAX_RW_REG_CNT; i++) {
133 val = rtsx_pci_readl(pcr, RTSX_HAIMR);
134 if ((val & HAIMR_TRANS_END) == 0)
138 if (i >= MAX_RW_REG_CNT)
142 *data = (u8)(val & 0xFF);
146 EXPORT_SYMBOL_GPL(rtsx_pci_read_register);
148 int __rtsx_pci_write_phy_register(struct rtsx_pcr *pcr, u8 addr, u16 val)
150 int err, i, finished = 0;
153 rtsx_pci_init_cmd(pcr);
155 rtsx_pci_add_cmd(pcr, WRITE_REG_CMD, PHYDATA0, 0xFF, (u8)val);
156 rtsx_pci_add_cmd(pcr, WRITE_REG_CMD, PHYDATA1, 0xFF, (u8)(val >> 8));
157 rtsx_pci_add_cmd(pcr, WRITE_REG_CMD, PHYADDR, 0xFF, addr);
158 rtsx_pci_add_cmd(pcr, WRITE_REG_CMD, PHYRWCTL, 0xFF, 0x81);
160 err = rtsx_pci_send_cmd(pcr, 100);
164 for (i = 0; i < 100000; i++) {
165 err = rtsx_pci_read_register(pcr, PHYRWCTL, &tmp);
181 int rtsx_pci_write_phy_register(struct rtsx_pcr *pcr, u8 addr, u16 val)
183 if (pcr->ops->write_phy)
184 return pcr->ops->write_phy(pcr, addr, val);
186 return __rtsx_pci_write_phy_register(pcr, addr, val);
188 EXPORT_SYMBOL_GPL(rtsx_pci_write_phy_register);
190 int __rtsx_pci_read_phy_register(struct rtsx_pcr *pcr, u8 addr, u16 *val)
192 int err, i, finished = 0;
196 rtsx_pci_init_cmd(pcr);
198 rtsx_pci_add_cmd(pcr, WRITE_REG_CMD, PHYADDR, 0xFF, addr);
199 rtsx_pci_add_cmd(pcr, WRITE_REG_CMD, PHYRWCTL, 0xFF, 0x80);
201 err = rtsx_pci_send_cmd(pcr, 100);
205 for (i = 0; i < 100000; i++) {
206 err = rtsx_pci_read_register(pcr, PHYRWCTL, &tmp);
219 rtsx_pci_init_cmd(pcr);
221 rtsx_pci_add_cmd(pcr, READ_REG_CMD, PHYDATA0, 0, 0);
222 rtsx_pci_add_cmd(pcr, READ_REG_CMD, PHYDATA1, 0, 0);
224 err = rtsx_pci_send_cmd(pcr, 100);
228 ptr = rtsx_pci_get_cmd_data(pcr);
229 data = ((u16)ptr[1] << 8) | ptr[0];
237 int rtsx_pci_read_phy_register(struct rtsx_pcr *pcr, u8 addr, u16 *val)
239 if (pcr->ops->read_phy)
240 return pcr->ops->read_phy(pcr, addr, val);
242 return __rtsx_pci_read_phy_register(pcr, addr, val);
244 EXPORT_SYMBOL_GPL(rtsx_pci_read_phy_register);
246 void rtsx_pci_stop_cmd(struct rtsx_pcr *pcr)
248 rtsx_pci_writel(pcr, RTSX_HCBCTLR, STOP_CMD);
249 rtsx_pci_writel(pcr, RTSX_HDBCTLR, STOP_DMA);
251 rtsx_pci_write_register(pcr, DMACTL, 0x80, 0x80);
252 rtsx_pci_write_register(pcr, RBCTL, 0x80, 0x80);
254 EXPORT_SYMBOL_GPL(rtsx_pci_stop_cmd);
256 void rtsx_pci_add_cmd(struct rtsx_pcr *pcr,
257 u8 cmd_type, u16 reg_addr, u8 mask, u8 data)
261 u32 *ptr = (u32 *)(pcr->host_cmds_ptr);
263 val |= (u32)(cmd_type & 0x03) << 30;
264 val |= (u32)(reg_addr & 0x3FFF) << 16;
265 val |= (u32)mask << 8;
268 spin_lock_irqsave(&pcr->lock, flags);
270 if (pcr->ci < (HOST_CMDS_BUF_LEN / 4)) {
271 put_unaligned_le32(val, ptr);
275 spin_unlock_irqrestore(&pcr->lock, flags);
277 EXPORT_SYMBOL_GPL(rtsx_pci_add_cmd);
279 void rtsx_pci_send_cmd_no_wait(struct rtsx_pcr *pcr)
283 rtsx_pci_writel(pcr, RTSX_HCBAR, pcr->host_cmds_addr);
285 val |= (u32)(pcr->ci * 4) & 0x00FFFFFF;
286 /* Hardware Auto Response */
288 rtsx_pci_writel(pcr, RTSX_HCBCTLR, val);
290 EXPORT_SYMBOL_GPL(rtsx_pci_send_cmd_no_wait);
292 int rtsx_pci_send_cmd(struct rtsx_pcr *pcr, int timeout)
294 struct completion trans_done;
300 spin_lock_irqsave(&pcr->lock, flags);
302 /* set up data structures for the wakeup system */
303 pcr->done = &trans_done;
304 pcr->trans_result = TRANS_NOT_READY;
305 init_completion(&trans_done);
307 rtsx_pci_writel(pcr, RTSX_HCBAR, pcr->host_cmds_addr);
309 val |= (u32)(pcr->ci * 4) & 0x00FFFFFF;
310 /* Hardware Auto Response */
312 rtsx_pci_writel(pcr, RTSX_HCBCTLR, val);
314 spin_unlock_irqrestore(&pcr->lock, flags);
316 /* Wait for TRANS_OK_INT */
317 timeleft = wait_for_completion_interruptible_timeout(
318 &trans_done, msecs_to_jiffies(timeout));
320 pcr_dbg(pcr, "Timeout (%s %d)\n", __func__, __LINE__);
322 goto finish_send_cmd;
325 spin_lock_irqsave(&pcr->lock, flags);
326 if (pcr->trans_result == TRANS_RESULT_FAIL)
328 else if (pcr->trans_result == TRANS_RESULT_OK)
330 else if (pcr->trans_result == TRANS_NO_DEVICE)
332 spin_unlock_irqrestore(&pcr->lock, flags);
335 spin_lock_irqsave(&pcr->lock, flags);
337 spin_unlock_irqrestore(&pcr->lock, flags);
339 if ((err < 0) && (err != -ENODEV))
340 rtsx_pci_stop_cmd(pcr);
343 complete(pcr->finish_me);
347 EXPORT_SYMBOL_GPL(rtsx_pci_send_cmd);
349 static void rtsx_pci_add_sg_tbl(struct rtsx_pcr *pcr,
350 dma_addr_t addr, unsigned int len, int end)
352 u64 *ptr = (u64 *)(pcr->host_sg_tbl_ptr) + pcr->sgi;
354 u8 option = SG_VALID | SG_TRANS_DATA;
356 pcr_dbg(pcr, "DMA addr: 0x%x, Len: 0x%x\n", (unsigned int)addr, len);
360 val = ((u64)addr << 32) | ((u64)len << 12) | option;
362 put_unaligned_le64(val, ptr);
366 int rtsx_pci_transfer_data(struct rtsx_pcr *pcr, struct scatterlist *sglist,
367 int num_sg, bool read, int timeout)
371 pcr_dbg(pcr, "--> %s: num_sg = %d\n", __func__, num_sg);
372 count = rtsx_pci_dma_map_sg(pcr, sglist, num_sg, read);
375 pcr_dbg(pcr, "DMA mapping count: %d\n", count);
377 err = rtsx_pci_dma_transfer(pcr, sglist, count, read, timeout);
379 rtsx_pci_dma_unmap_sg(pcr, sglist, num_sg, read);
383 EXPORT_SYMBOL_GPL(rtsx_pci_transfer_data);
385 int rtsx_pci_dma_map_sg(struct rtsx_pcr *pcr, struct scatterlist *sglist,
386 int num_sg, bool read)
388 enum dma_data_direction dir = read ? DMA_FROM_DEVICE : DMA_TO_DEVICE;
393 if ((sglist == NULL) || (num_sg <= 0))
396 return dma_map_sg(&(pcr->pci->dev), sglist, num_sg, dir);
398 EXPORT_SYMBOL_GPL(rtsx_pci_dma_map_sg);
400 void rtsx_pci_dma_unmap_sg(struct rtsx_pcr *pcr, struct scatterlist *sglist,
401 int num_sg, bool read)
403 enum dma_data_direction dir = read ? DMA_FROM_DEVICE : DMA_TO_DEVICE;
405 dma_unmap_sg(&(pcr->pci->dev), sglist, num_sg, dir);
407 EXPORT_SYMBOL_GPL(rtsx_pci_dma_unmap_sg);
409 int rtsx_pci_dma_transfer(struct rtsx_pcr *pcr, struct scatterlist *sglist,
410 int count, bool read, int timeout)
412 struct completion trans_done;
413 struct scatterlist *sg;
420 u8 dir = read ? DEVICE_TO_HOST : HOST_TO_DEVICE;
425 if ((sglist == NULL) || (count < 1))
428 val = ((u32)(dir & 0x01) << 29) | TRIG_DMA | ADMA_MODE;
430 for_each_sg(sglist, sg, count, i) {
431 addr = sg_dma_address(sg);
432 len = sg_dma_len(sg);
433 rtsx_pci_add_sg_tbl(pcr, addr, len, i == count - 1);
436 spin_lock_irqsave(&pcr->lock, flags);
438 pcr->done = &trans_done;
439 pcr->trans_result = TRANS_NOT_READY;
440 init_completion(&trans_done);
441 rtsx_pci_writel(pcr, RTSX_HDBAR, pcr->host_sg_tbl_addr);
442 rtsx_pci_writel(pcr, RTSX_HDBCTLR, val);
444 spin_unlock_irqrestore(&pcr->lock, flags);
446 timeleft = wait_for_completion_interruptible_timeout(
447 &trans_done, msecs_to_jiffies(timeout));
449 pcr_dbg(pcr, "Timeout (%s %d)\n", __func__, __LINE__);
454 spin_lock_irqsave(&pcr->lock, flags);
455 if (pcr->trans_result == TRANS_RESULT_FAIL)
457 else if (pcr->trans_result == TRANS_NO_DEVICE)
459 spin_unlock_irqrestore(&pcr->lock, flags);
462 spin_lock_irqsave(&pcr->lock, flags);
464 spin_unlock_irqrestore(&pcr->lock, flags);
466 if ((err < 0) && (err != -ENODEV))
467 rtsx_pci_stop_cmd(pcr);
470 complete(pcr->finish_me);
474 EXPORT_SYMBOL_GPL(rtsx_pci_dma_transfer);
476 int rtsx_pci_read_ppbuf(struct rtsx_pcr *pcr, u8 *buf, int buf_len)
488 for (i = 0; i < buf_len / 256; i++) {
489 rtsx_pci_init_cmd(pcr);
491 for (j = 0; j < 256; j++)
492 rtsx_pci_add_cmd(pcr, READ_REG_CMD, reg++, 0, 0);
494 err = rtsx_pci_send_cmd(pcr, 250);
498 memcpy(ptr, rtsx_pci_get_cmd_data(pcr), 256);
503 rtsx_pci_init_cmd(pcr);
505 for (j = 0; j < buf_len % 256; j++)
506 rtsx_pci_add_cmd(pcr, READ_REG_CMD, reg++, 0, 0);
508 err = rtsx_pci_send_cmd(pcr, 250);
513 memcpy(ptr, rtsx_pci_get_cmd_data(pcr), buf_len % 256);
517 EXPORT_SYMBOL_GPL(rtsx_pci_read_ppbuf);
519 int rtsx_pci_write_ppbuf(struct rtsx_pcr *pcr, u8 *buf, int buf_len)
531 for (i = 0; i < buf_len / 256; i++) {
532 rtsx_pci_init_cmd(pcr);
534 for (j = 0; j < 256; j++) {
535 rtsx_pci_add_cmd(pcr, WRITE_REG_CMD,
540 err = rtsx_pci_send_cmd(pcr, 250);
546 rtsx_pci_init_cmd(pcr);
548 for (j = 0; j < buf_len % 256; j++) {
549 rtsx_pci_add_cmd(pcr, WRITE_REG_CMD,
554 err = rtsx_pci_send_cmd(pcr, 250);
561 EXPORT_SYMBOL_GPL(rtsx_pci_write_ppbuf);
563 static int rtsx_pci_set_pull_ctl(struct rtsx_pcr *pcr, const u32 *tbl)
567 rtsx_pci_init_cmd(pcr);
569 while (*tbl & 0xFFFF0000) {
570 rtsx_pci_add_cmd(pcr, WRITE_REG_CMD,
571 (u16)(*tbl >> 16), 0xFF, (u8)(*tbl));
575 return rtsx_pci_send_cmd(pcr, 100);
578 int rtsx_pci_card_pull_ctl_enable(struct rtsx_pcr *pcr, int card)
582 if (card == RTSX_SD_CARD)
583 tbl = pcr->sd_pull_ctl_enable_tbl;
584 else if (card == RTSX_MS_CARD)
585 tbl = pcr->ms_pull_ctl_enable_tbl;
589 return rtsx_pci_set_pull_ctl(pcr, tbl);
591 EXPORT_SYMBOL_GPL(rtsx_pci_card_pull_ctl_enable);
593 int rtsx_pci_card_pull_ctl_disable(struct rtsx_pcr *pcr, int card)
597 if (card == RTSX_SD_CARD)
598 tbl = pcr->sd_pull_ctl_disable_tbl;
599 else if (card == RTSX_MS_CARD)
600 tbl = pcr->ms_pull_ctl_disable_tbl;
605 return rtsx_pci_set_pull_ctl(pcr, tbl);
607 EXPORT_SYMBOL_GPL(rtsx_pci_card_pull_ctl_disable);
609 static void rtsx_pci_enable_bus_int(struct rtsx_pcr *pcr)
611 pcr->bier = TRANS_OK_INT_EN | TRANS_FAIL_INT_EN | SD_INT_EN;
613 if (pcr->num_slots > 1)
614 pcr->bier |= MS_INT_EN;
616 /* Enable Bus Interrupt */
617 rtsx_pci_writel(pcr, RTSX_BIER, pcr->bier);
619 pcr_dbg(pcr, "RTSX_BIER: 0x%08x\n", pcr->bier);
622 static inline u8 double_ssc_depth(u8 depth)
624 return ((depth > 1) ? (depth - 1) : depth);
627 static u8 revise_ssc_depth(u8 ssc_depth, u8 div)
629 if (div > CLK_DIV_1) {
630 if (ssc_depth > (div - 1))
631 ssc_depth -= (div - 1);
633 ssc_depth = SSC_DEPTH_4M;
639 int rtsx_pci_switch_clock(struct rtsx_pcr *pcr, unsigned int card_clock,
640 u8 ssc_depth, bool initial_mode, bool double_clk, bool vpclk)
643 u8 n, clk_divider, mcu_cnt, div;
645 [RTSX_SSC_DEPTH_4M] = SSC_DEPTH_4M,
646 [RTSX_SSC_DEPTH_2M] = SSC_DEPTH_2M,
647 [RTSX_SSC_DEPTH_1M] = SSC_DEPTH_1M,
648 [RTSX_SSC_DEPTH_500K] = SSC_DEPTH_500K,
649 [RTSX_SSC_DEPTH_250K] = SSC_DEPTH_250K,
653 /* We use 250k(around) here, in initial stage */
654 clk_divider = SD_CLK_DIVIDE_128;
655 card_clock = 30000000;
657 clk_divider = SD_CLK_DIVIDE_0;
659 err = rtsx_pci_write_register(pcr, SD_CFG1,
660 SD_CLK_DIVIDE_MASK, clk_divider);
664 card_clock /= 1000000;
665 pcr_dbg(pcr, "Switch card clock to %dMHz\n", card_clock);
668 if (!initial_mode && double_clk)
669 clk = card_clock * 2;
670 pcr_dbg(pcr, "Internal SSC clock: %dMHz (cur_clock = %d)\n",
671 clk, pcr->cur_clock);
673 if (clk == pcr->cur_clock)
676 if (pcr->ops->conv_clk_and_div_n)
677 n = (u8)pcr->ops->conv_clk_and_div_n(clk, CLK_TO_DIV_N);
680 if ((clk <= 2) || (n > MAX_DIV_N_PCR))
683 mcu_cnt = (u8)(125/clk + 3);
687 /* Make sure that the SSC clock div_n is not less than MIN_DIV_N_PCR */
689 while ((n < MIN_DIV_N_PCR) && (div < CLK_DIV_8)) {
690 if (pcr->ops->conv_clk_and_div_n) {
691 int dbl_clk = pcr->ops->conv_clk_and_div_n(n,
693 n = (u8)pcr->ops->conv_clk_and_div_n(dbl_clk,
700 pcr_dbg(pcr, "n = %d, div = %d\n", n, div);
702 ssc_depth = depth[ssc_depth];
704 ssc_depth = double_ssc_depth(ssc_depth);
706 ssc_depth = revise_ssc_depth(ssc_depth, div);
707 pcr_dbg(pcr, "ssc_depth = %d\n", ssc_depth);
709 rtsx_pci_init_cmd(pcr);
710 rtsx_pci_add_cmd(pcr, WRITE_REG_CMD, CLK_CTL,
711 CLK_LOW_FREQ, CLK_LOW_FREQ);
712 rtsx_pci_add_cmd(pcr, WRITE_REG_CMD, CLK_DIV,
713 0xFF, (div << 4) | mcu_cnt);
714 rtsx_pci_add_cmd(pcr, WRITE_REG_CMD, SSC_CTL1, SSC_RSTB, 0);
715 rtsx_pci_add_cmd(pcr, WRITE_REG_CMD, SSC_CTL2,
716 SSC_DEPTH_MASK, ssc_depth);
717 rtsx_pci_add_cmd(pcr, WRITE_REG_CMD, SSC_DIV_N_0, 0xFF, n);
718 rtsx_pci_add_cmd(pcr, WRITE_REG_CMD, SSC_CTL1, SSC_RSTB, SSC_RSTB);
720 rtsx_pci_add_cmd(pcr, WRITE_REG_CMD, SD_VPCLK0_CTL,
722 rtsx_pci_add_cmd(pcr, WRITE_REG_CMD, SD_VPCLK0_CTL,
723 PHASE_NOT_RESET, PHASE_NOT_RESET);
726 err = rtsx_pci_send_cmd(pcr, 2000);
730 /* Wait SSC clock stable */
732 err = rtsx_pci_write_register(pcr, CLK_CTL, CLK_LOW_FREQ, 0);
736 pcr->cur_clock = clk;
739 EXPORT_SYMBOL_GPL(rtsx_pci_switch_clock);
741 int rtsx_pci_card_power_on(struct rtsx_pcr *pcr, int card)
743 if (pcr->ops->card_power_on)
744 return pcr->ops->card_power_on(pcr, card);
748 EXPORT_SYMBOL_GPL(rtsx_pci_card_power_on);
750 int rtsx_pci_card_power_off(struct rtsx_pcr *pcr, int card)
752 if (pcr->ops->card_power_off)
753 return pcr->ops->card_power_off(pcr, card);
757 EXPORT_SYMBOL_GPL(rtsx_pci_card_power_off);
759 int rtsx_pci_card_exclusive_check(struct rtsx_pcr *pcr, int card)
761 unsigned int cd_mask[] = {
762 [RTSX_SD_CARD] = SD_EXIST,
763 [RTSX_MS_CARD] = MS_EXIST
766 if (!(pcr->flags & PCR_MS_PMOS)) {
767 /* When using single PMOS, accessing card is not permitted
768 * if the existing card is not the designated one.
770 if (pcr->card_exist & (~cd_mask[card]))
776 EXPORT_SYMBOL_GPL(rtsx_pci_card_exclusive_check);
778 int rtsx_pci_switch_output_voltage(struct rtsx_pcr *pcr, u8 voltage)
780 if (pcr->ops->switch_output_voltage)
781 return pcr->ops->switch_output_voltage(pcr, voltage);
785 EXPORT_SYMBOL_GPL(rtsx_pci_switch_output_voltage);
787 unsigned int rtsx_pci_card_exist(struct rtsx_pcr *pcr)
791 val = rtsx_pci_readl(pcr, RTSX_BIPR);
792 if (pcr->ops->cd_deglitch)
793 val = pcr->ops->cd_deglitch(pcr);
797 EXPORT_SYMBOL_GPL(rtsx_pci_card_exist);
799 void rtsx_pci_complete_unfinished_transfer(struct rtsx_pcr *pcr)
801 struct completion finish;
803 pcr->finish_me = &finish;
804 init_completion(&finish);
809 if (!pcr->remove_pci)
810 rtsx_pci_stop_cmd(pcr);
812 wait_for_completion_interruptible_timeout(&finish,
813 msecs_to_jiffies(2));
814 pcr->finish_me = NULL;
816 EXPORT_SYMBOL_GPL(rtsx_pci_complete_unfinished_transfer);
818 static void rtsx_pci_card_detect(struct work_struct *work)
820 struct delayed_work *dwork;
821 struct rtsx_pcr *pcr;
823 unsigned int card_detect = 0, card_inserted, card_removed;
826 dwork = to_delayed_work(work);
827 pcr = container_of(dwork, struct rtsx_pcr, carddet_work);
829 pcr_dbg(pcr, "--> %s\n", __func__);
831 mutex_lock(&pcr->pcr_mutex);
832 spin_lock_irqsave(&pcr->lock, flags);
834 irq_status = rtsx_pci_readl(pcr, RTSX_BIPR);
835 pcr_dbg(pcr, "irq_status: 0x%08x\n", irq_status);
837 irq_status &= CARD_EXIST;
838 card_inserted = pcr->card_inserted & irq_status;
839 card_removed = pcr->card_removed;
840 pcr->card_inserted = 0;
841 pcr->card_removed = 0;
843 spin_unlock_irqrestore(&pcr->lock, flags);
845 if (card_inserted || card_removed) {
846 pcr_dbg(pcr, "card_inserted: 0x%x, card_removed: 0x%x\n",
847 card_inserted, card_removed);
849 if (pcr->ops->cd_deglitch)
850 card_inserted = pcr->ops->cd_deglitch(pcr);
852 card_detect = card_inserted | card_removed;
854 pcr->card_exist |= card_inserted;
855 pcr->card_exist &= ~card_removed;
858 mutex_unlock(&pcr->pcr_mutex);
860 if ((card_detect & SD_EXIST) && pcr->slots[RTSX_SD_CARD].card_event)
861 pcr->slots[RTSX_SD_CARD].card_event(
862 pcr->slots[RTSX_SD_CARD].p_dev);
863 if ((card_detect & MS_EXIST) && pcr->slots[RTSX_MS_CARD].card_event)
864 pcr->slots[RTSX_MS_CARD].card_event(
865 pcr->slots[RTSX_MS_CARD].p_dev);
868 static irqreturn_t rtsx_pci_isr(int irq, void *dev_id)
870 struct rtsx_pcr *pcr = dev_id;
876 spin_lock(&pcr->lock);
878 int_reg = rtsx_pci_readl(pcr, RTSX_BIPR);
879 /* Clear interrupt flag */
880 rtsx_pci_writel(pcr, RTSX_BIPR, int_reg);
881 if ((int_reg & pcr->bier) == 0) {
882 spin_unlock(&pcr->lock);
885 if (int_reg == 0xFFFFFFFF) {
886 spin_unlock(&pcr->lock);
890 int_reg &= (pcr->bier | 0x7FFFFF);
892 if (int_reg & SD_INT) {
893 if (int_reg & SD_EXIST) {
894 pcr->card_inserted |= SD_EXIST;
896 pcr->card_removed |= SD_EXIST;
897 pcr->card_inserted &= ~SD_EXIST;
901 if (int_reg & MS_INT) {
902 if (int_reg & MS_EXIST) {
903 pcr->card_inserted |= MS_EXIST;
905 pcr->card_removed |= MS_EXIST;
906 pcr->card_inserted &= ~MS_EXIST;
910 if (int_reg & (NEED_COMPLETE_INT | DELINK_INT)) {
911 if (int_reg & (TRANS_FAIL_INT | DELINK_INT)) {
912 pcr->trans_result = TRANS_RESULT_FAIL;
915 } else if (int_reg & TRANS_OK_INT) {
916 pcr->trans_result = TRANS_RESULT_OK;
922 if (pcr->card_inserted || pcr->card_removed)
923 schedule_delayed_work(&pcr->carddet_work,
924 msecs_to_jiffies(200));
926 spin_unlock(&pcr->lock);
930 static int rtsx_pci_acquire_irq(struct rtsx_pcr *pcr)
932 dev_info(&(pcr->pci->dev), "%s: pcr->msi_en = %d, pci->irq = %d\n",
933 __func__, pcr->msi_en, pcr->pci->irq);
935 if (request_irq(pcr->pci->irq, rtsx_pci_isr,
936 pcr->msi_en ? 0 : IRQF_SHARED,
937 DRV_NAME_RTSX_PCI, pcr)) {
938 dev_err(&(pcr->pci->dev),
939 "rtsx_sdmmc: unable to grab IRQ %d, disabling device\n",
944 pcr->irq = pcr->pci->irq;
945 pci_intx(pcr->pci, !pcr->msi_en);
950 static void rtsx_pci_idle_work(struct work_struct *work)
952 struct delayed_work *dwork = to_delayed_work(work);
953 struct rtsx_pcr *pcr = container_of(dwork, struct rtsx_pcr, idle_work);
955 pcr_dbg(pcr, "--> %s\n", __func__);
957 mutex_lock(&pcr->pcr_mutex);
959 pcr->state = PDEV_STAT_IDLE;
961 if (pcr->ops->disable_auto_blink)
962 pcr->ops->disable_auto_blink(pcr);
963 if (pcr->ops->turn_off_led)
964 pcr->ops->turn_off_led(pcr);
967 rtsx_pci_enable_aspm(pcr);
969 mutex_unlock(&pcr->pcr_mutex);
973 static void rtsx_pci_power_off(struct rtsx_pcr *pcr, u8 pm_state)
975 if (pcr->ops->turn_off_led)
976 pcr->ops->turn_off_led(pcr);
978 rtsx_pci_writel(pcr, RTSX_BIER, 0);
981 rtsx_pci_write_register(pcr, PETXCFG, 0x08, 0x08);
982 rtsx_pci_write_register(pcr, HOST_SLEEP_STATE, 0x03, pm_state);
984 if (pcr->ops->force_power_down)
985 pcr->ops->force_power_down(pcr, pm_state);
989 static int rtsx_pci_init_hw(struct rtsx_pcr *pcr)
993 pcr->pcie_cap = pci_find_capability(pcr->pci, PCI_CAP_ID_EXP);
994 rtsx_pci_writel(pcr, RTSX_HCBAR, pcr->host_cmds_addr);
996 rtsx_pci_enable_bus_int(pcr);
999 err = rtsx_pci_write_register(pcr, FPDCTL, SSC_POWER_DOWN, 0);
1003 /* Wait SSC power stable */
1006 rtsx_pci_disable_aspm(pcr);
1007 if (pcr->ops->optimize_phy) {
1008 err = pcr->ops->optimize_phy(pcr);
1013 rtsx_pci_init_cmd(pcr);
1015 /* Set mcu_cnt to 7 to ensure data can be sampled properly */
1016 rtsx_pci_add_cmd(pcr, WRITE_REG_CMD, CLK_DIV, 0x07, 0x07);
1018 rtsx_pci_add_cmd(pcr, WRITE_REG_CMD, HOST_SLEEP_STATE, 0x03, 0x00);
1019 /* Disable card clock */
1020 rtsx_pci_add_cmd(pcr, WRITE_REG_CMD, CARD_CLK_EN, 0x1E, 0);
1021 /* Reset delink mode */
1022 rtsx_pci_add_cmd(pcr, WRITE_REG_CMD, CHANGE_LINK_STATE, 0x0A, 0);
1023 /* Card driving select */
1024 rtsx_pci_add_cmd(pcr, WRITE_REG_CMD, CARD_DRIVE_SEL,
1025 0xFF, pcr->card_drive_sel);
1026 /* Enable SSC Clock */
1027 rtsx_pci_add_cmd(pcr, WRITE_REG_CMD, SSC_CTL1,
1028 0xFF, SSC_8X_EN | SSC_SEL_4M);
1029 rtsx_pci_add_cmd(pcr, WRITE_REG_CMD, SSC_CTL2, 0xFF, 0x12);
1030 /* Disable cd_pwr_save */
1031 rtsx_pci_add_cmd(pcr, WRITE_REG_CMD, CHANGE_LINK_STATE, 0x16, 0x10);
1032 /* Clear Link Ready Interrupt */
1033 rtsx_pci_add_cmd(pcr, WRITE_REG_CMD, IRQSTAT0,
1034 LINK_RDY_INT, LINK_RDY_INT);
1035 /* Enlarge the estimation window of PERST# glitch
1036 * to reduce the chance of invalid card interrupt
1038 rtsx_pci_add_cmd(pcr, WRITE_REG_CMD, PERST_GLITCH_WIDTH, 0xFF, 0x80);
1039 /* Update RC oscillator to 400k
1040 * bit[0] F_HIGH: for RC oscillator, Rst_value is 1'b1
1043 rtsx_pci_add_cmd(pcr, WRITE_REG_CMD, RCCTL, 0x01, 0x00);
1044 /* Set interrupt write clear
1045 * bit 1: U_elbi_if_rd_clr_en
1046 * 1: Enable ELBI interrupt[31:22] & [7:0] flag read clear
1047 * 0: ELBI interrupt flag[31:22] & [7:0] only can be write clear
1049 rtsx_pci_add_cmd(pcr, WRITE_REG_CMD, NFTS_TX_CTRL, 0x02, 0);
1051 err = rtsx_pci_send_cmd(pcr, 100);
1055 /* Enable clk_request_n to enable clock power management */
1056 rtsx_pci_write_config_byte(pcr, pcr->pcie_cap + PCI_EXP_LNKCTL + 1, 1);
1057 /* Enter L1 when host tx idle */
1058 rtsx_pci_write_config_byte(pcr, 0x70F, 0x5B);
1060 if (pcr->ops->extra_init_hw) {
1061 err = pcr->ops->extra_init_hw(pcr);
1066 /* No CD interrupt if probing driver with card inserted.
1067 * So we need to initialize pcr->card_exist here.
1069 if (pcr->ops->cd_deglitch)
1070 pcr->card_exist = pcr->ops->cd_deglitch(pcr);
1072 pcr->card_exist = rtsx_pci_readl(pcr, RTSX_BIPR) & CARD_EXIST;
1077 static int rtsx_pci_init_chip(struct rtsx_pcr *pcr)
1081 spin_lock_init(&pcr->lock);
1082 mutex_init(&pcr->pcr_mutex);
1084 switch (PCI_PID(pcr)) {
1087 rts5209_init_params(pcr);
1091 rts5229_init_params(pcr);
1095 rtl8411_init_params(pcr);
1099 rts5227_init_params(pcr);
1103 rts522a_init_params(pcr);
1107 rts5249_init_params(pcr);
1111 rts524a_init_params(pcr);
1115 rts525a_init_params(pcr);
1119 rtl8411b_init_params(pcr);
1123 rtl8402_init_params(pcr);
1127 pcr_dbg(pcr, "PID: 0x%04x, IC version: 0x%02x\n",
1128 PCI_PID(pcr), pcr->ic_version);
1130 pcr->slots = kcalloc(pcr->num_slots, sizeof(struct rtsx_slot),
1135 if (pcr->ops->fetch_vendor_settings)
1136 pcr->ops->fetch_vendor_settings(pcr);
1138 pcr_dbg(pcr, "pcr->aspm_en = 0x%x\n", pcr->aspm_en);
1139 pcr_dbg(pcr, "pcr->sd30_drive_sel_1v8 = 0x%x\n",
1140 pcr->sd30_drive_sel_1v8);
1141 pcr_dbg(pcr, "pcr->sd30_drive_sel_3v3 = 0x%x\n",
1142 pcr->sd30_drive_sel_3v3);
1143 pcr_dbg(pcr, "pcr->card_drive_sel = 0x%x\n",
1144 pcr->card_drive_sel);
1145 pcr_dbg(pcr, "pcr->flags = 0x%x\n", pcr->flags);
1147 pcr->state = PDEV_STAT_IDLE;
1148 err = rtsx_pci_init_hw(pcr);
1157 static int rtsx_pci_probe(struct pci_dev *pcidev,
1158 const struct pci_device_id *id)
1160 struct rtsx_pcr *pcr;
1161 struct pcr_handle *handle;
1163 int ret, i, bar = 0;
1165 dev_dbg(&(pcidev->dev),
1166 ": Realtek PCI-E Card Reader found at %s [%04x:%04x] (rev %x)\n",
1167 pci_name(pcidev), (int)pcidev->vendor, (int)pcidev->device,
1168 (int)pcidev->revision);
1170 ret = pci_set_dma_mask(pcidev, DMA_BIT_MASK(32));
1174 ret = pci_enable_device(pcidev);
1178 ret = pci_request_regions(pcidev, DRV_NAME_RTSX_PCI);
1182 pcr = kzalloc(sizeof(*pcr), GFP_KERNEL);
1188 handle = kzalloc(sizeof(*handle), GFP_KERNEL);
1195 idr_preload(GFP_KERNEL);
1196 spin_lock(&rtsx_pci_lock);
1197 ret = idr_alloc(&rtsx_pci_idr, pcr, 0, 0, GFP_NOWAIT);
1200 spin_unlock(&rtsx_pci_lock);
1206 dev_set_drvdata(&pcidev->dev, handle);
1208 if (CHK_PCI_PID(pcr, 0x525A))
1210 len = pci_resource_len(pcidev, bar);
1211 base = pci_resource_start(pcidev, bar);
1212 pcr->remap_addr = ioremap_nocache(base, len);
1213 if (!pcr->remap_addr) {
1218 pcr->rtsx_resv_buf = dma_alloc_coherent(&(pcidev->dev),
1219 RTSX_RESV_BUF_LEN, &(pcr->rtsx_resv_buf_addr),
1221 if (pcr->rtsx_resv_buf == NULL) {
1225 pcr->host_cmds_ptr = pcr->rtsx_resv_buf;
1226 pcr->host_cmds_addr = pcr->rtsx_resv_buf_addr;
1227 pcr->host_sg_tbl_ptr = pcr->rtsx_resv_buf + HOST_CMDS_BUF_LEN;
1228 pcr->host_sg_tbl_addr = pcr->rtsx_resv_buf_addr + HOST_CMDS_BUF_LEN;
1230 pcr->card_inserted = 0;
1231 pcr->card_removed = 0;
1232 INIT_DELAYED_WORK(&pcr->carddet_work, rtsx_pci_card_detect);
1233 INIT_DELAYED_WORK(&pcr->idle_work, rtsx_pci_idle_work);
1235 pcr->msi_en = msi_en;
1237 ret = pci_enable_msi(pcidev);
1239 pcr->msi_en = false;
1242 ret = rtsx_pci_acquire_irq(pcr);
1246 pci_set_master(pcidev);
1247 synchronize_irq(pcr->irq);
1249 ret = rtsx_pci_init_chip(pcr);
1253 for (i = 0; i < ARRAY_SIZE(rtsx_pcr_cells); i++) {
1254 rtsx_pcr_cells[i].platform_data = handle;
1255 rtsx_pcr_cells[i].pdata_size = sizeof(*handle);
1257 ret = mfd_add_devices(&pcidev->dev, pcr->id, rtsx_pcr_cells,
1258 ARRAY_SIZE(rtsx_pcr_cells), NULL, 0, NULL);
1262 schedule_delayed_work(&pcr->idle_work, msecs_to_jiffies(200));
1267 free_irq(pcr->irq, (void *)pcr);
1270 pci_disable_msi(pcr->pci);
1271 dma_free_coherent(&(pcr->pci->dev), RTSX_RESV_BUF_LEN,
1272 pcr->rtsx_resv_buf, pcr->rtsx_resv_buf_addr);
1274 iounmap(pcr->remap_addr);
1280 pci_release_regions(pcidev);
1282 pci_disable_device(pcidev);
1287 static void rtsx_pci_remove(struct pci_dev *pcidev)
1289 struct pcr_handle *handle = pci_get_drvdata(pcidev);
1290 struct rtsx_pcr *pcr = handle->pcr;
1292 pcr->remove_pci = true;
1294 /* Disable interrupts at the pcr level */
1295 spin_lock_irq(&pcr->lock);
1296 rtsx_pci_writel(pcr, RTSX_BIER, 0);
1298 spin_unlock_irq(&pcr->lock);
1300 cancel_delayed_work_sync(&pcr->carddet_work);
1301 cancel_delayed_work_sync(&pcr->idle_work);
1303 mfd_remove_devices(&pcidev->dev);
1305 dma_free_coherent(&(pcr->pci->dev), RTSX_RESV_BUF_LEN,
1306 pcr->rtsx_resv_buf, pcr->rtsx_resv_buf_addr);
1307 free_irq(pcr->irq, (void *)pcr);
1309 pci_disable_msi(pcr->pci);
1310 iounmap(pcr->remap_addr);
1312 pci_release_regions(pcidev);
1313 pci_disable_device(pcidev);
1315 spin_lock(&rtsx_pci_lock);
1316 idr_remove(&rtsx_pci_idr, pcr->id);
1317 spin_unlock(&rtsx_pci_lock);
1323 dev_dbg(&(pcidev->dev),
1324 ": Realtek PCI-E Card Reader at %s [%04x:%04x] has been removed\n",
1325 pci_name(pcidev), (int)pcidev->vendor, (int)pcidev->device);
1330 static int rtsx_pci_suspend(struct pci_dev *pcidev, pm_message_t state)
1332 struct pcr_handle *handle;
1333 struct rtsx_pcr *pcr;
1335 dev_dbg(&(pcidev->dev), "--> %s\n", __func__);
1337 handle = pci_get_drvdata(pcidev);
1340 cancel_delayed_work(&pcr->carddet_work);
1341 cancel_delayed_work(&pcr->idle_work);
1343 mutex_lock(&pcr->pcr_mutex);
1345 rtsx_pci_power_off(pcr, HOST_ENTER_S3);
1347 pci_save_state(pcidev);
1348 pci_enable_wake(pcidev, pci_choose_state(pcidev, state), 0);
1349 pci_disable_device(pcidev);
1350 pci_set_power_state(pcidev, pci_choose_state(pcidev, state));
1352 mutex_unlock(&pcr->pcr_mutex);
1356 static int rtsx_pci_resume(struct pci_dev *pcidev)
1358 struct pcr_handle *handle;
1359 struct rtsx_pcr *pcr;
1362 dev_dbg(&(pcidev->dev), "--> %s\n", __func__);
1364 handle = pci_get_drvdata(pcidev);
1367 mutex_lock(&pcr->pcr_mutex);
1369 pci_set_power_state(pcidev, PCI_D0);
1370 pci_restore_state(pcidev);
1371 ret = pci_enable_device(pcidev);
1374 pci_set_master(pcidev);
1376 ret = rtsx_pci_write_register(pcr, HOST_SLEEP_STATE, 0x03, 0x00);
1380 ret = rtsx_pci_init_hw(pcr);
1384 schedule_delayed_work(&pcr->idle_work, msecs_to_jiffies(200));
1387 mutex_unlock(&pcr->pcr_mutex);
1391 static void rtsx_pci_shutdown(struct pci_dev *pcidev)
1393 struct pcr_handle *handle;
1394 struct rtsx_pcr *pcr;
1396 dev_dbg(&(pcidev->dev), "--> %s\n", __func__);
1398 handle = pci_get_drvdata(pcidev);
1400 rtsx_pci_power_off(pcr, HOST_ENTER_S1);
1402 pci_disable_device(pcidev);
1405 #else /* CONFIG_PM */
1407 #define rtsx_pci_suspend NULL
1408 #define rtsx_pci_resume NULL
1409 #define rtsx_pci_shutdown NULL
1411 #endif /* CONFIG_PM */
1413 static struct pci_driver rtsx_pci_driver = {
1414 .name = DRV_NAME_RTSX_PCI,
1415 .id_table = rtsx_pci_ids,
1416 .probe = rtsx_pci_probe,
1417 .remove = rtsx_pci_remove,
1418 .suspend = rtsx_pci_suspend,
1419 .resume = rtsx_pci_resume,
1420 .shutdown = rtsx_pci_shutdown,
1422 module_pci_driver(rtsx_pci_driver);
1424 MODULE_LICENSE("GPL");
1425 MODULE_AUTHOR("Wei WANG <wei_wang@realsil.com.cn>");
1426 MODULE_DESCRIPTION("Realtek PCI-E Card Reader Driver");