1 // SPDX-License-Identifier: GPL-2.0-only 2 /* Driver for Realtek USB card reader 3 * 4 * Copyright(c) 2009-2013 Realtek Semiconductor Corp. All rights reserved. 5 * 6 * Author: 7 * Roger Tseng <rogerable@realtek.com> 8 */ 9 #include <linux/module.h> 10 #include <linux/slab.h> 11 #include <linux/mutex.h> 12 #include <linux/usb.h> 13 #include <linux/platform_device.h> 14 #include <linux/mfd/core.h> 15 #include <linux/rtsx_usb.h> 16 17 static int polling_pipe = 1; 18 module_param(polling_pipe, int, S_IRUGO | S_IWUSR); 19 MODULE_PARM_DESC(polling_pipe, "polling pipe (0: ctl, 1: bulk)"); 20 21 static const struct mfd_cell rtsx_usb_cells[] = { 22 [RTSX_USB_SD_CARD] = { 23 .name = DRV_NAME_RTSX_USB_SDMMC, 24 .pdata_size = 0, 25 }, 26 [RTSX_USB_MS_CARD] = { 27 .name = DRV_NAME_RTSX_USB_MS, 28 .pdata_size = 0, 29 }, 30 }; 31 32 static void rtsx_usb_sg_timed_out(struct timer_list *t) 33 { 34 struct rtsx_ucr *ucr = timer_container_of(ucr, t, sg_timer); 35 36 dev_dbg(&ucr->pusb_intf->dev, "%s: sg transfer timed out", __func__); 37 usb_sg_cancel(&ucr->current_sg); 38 } 39 40 static int rtsx_usb_bulk_transfer_sglist(struct rtsx_ucr *ucr, 41 unsigned int pipe, struct scatterlist *sg, int num_sg, 42 unsigned int length, unsigned int *act_len, int timeout) 43 { 44 int ret; 45 46 dev_dbg(&ucr->pusb_intf->dev, "%s: xfer %u bytes, %d entries\n", 47 __func__, length, num_sg); 48 ret = usb_sg_init(&ucr->current_sg, ucr->pusb_dev, pipe, 0, 49 sg, num_sg, length, GFP_NOIO); 50 if (ret) 51 return ret; 52 53 ucr->sg_timer.expires = jiffies + msecs_to_jiffies(timeout); 54 add_timer(&ucr->sg_timer); 55 usb_sg_wait(&ucr->current_sg); 56 if (!timer_delete_sync(&ucr->sg_timer)) 57 ret = -ETIMEDOUT; 58 else 59 ret = ucr->current_sg.status; 60 61 if (act_len) 62 *act_len = ucr->current_sg.bytes; 63 64 return ret; 65 } 66 67 int rtsx_usb_transfer_data(struct rtsx_ucr *ucr, unsigned int pipe, 68 void *buf, unsigned int len, int num_sg, 69 unsigned int *act_len, int timeout) 70 { 71 if (timeout < 600) 72 timeout = 600; 73 74 if (num_sg) 75 return rtsx_usb_bulk_transfer_sglist(ucr, pipe, 76 (struct scatterlist *)buf, num_sg, len, act_len, 77 timeout); 78 else 79 return usb_bulk_msg(ucr->pusb_dev, pipe, buf, len, act_len, 80 timeout); 81 } 82 EXPORT_SYMBOL_GPL(rtsx_usb_transfer_data); 83 84 static inline void rtsx_usb_seq_cmd_hdr(struct rtsx_ucr *ucr, 85 u16 addr, u16 len, u8 seq_type) 86 { 87 rtsx_usb_cmd_hdr_tag(ucr); 88 89 ucr->cmd_buf[PACKET_TYPE] = seq_type; 90 ucr->cmd_buf[5] = (u8)(len >> 8); 91 ucr->cmd_buf[6] = (u8)len; 92 ucr->cmd_buf[8] = (u8)(addr >> 8); 93 ucr->cmd_buf[9] = (u8)addr; 94 95 if (seq_type == SEQ_WRITE) 96 ucr->cmd_buf[STAGE_FLAG] = 0; 97 else 98 ucr->cmd_buf[STAGE_FLAG] = STAGE_R; 99 } 100 101 static int rtsx_usb_seq_write_register(struct rtsx_ucr *ucr, 102 u16 addr, u16 len, u8 *data) 103 { 104 u16 cmd_len = ALIGN(SEQ_WRITE_DATA_OFFSET + len, 4); 105 106 if (!data) 107 return -EINVAL; 108 109 if (cmd_len > IOBUF_SIZE) 110 return -EINVAL; 111 112 rtsx_usb_seq_cmd_hdr(ucr, addr, len, SEQ_WRITE); 113 memcpy(ucr->cmd_buf + SEQ_WRITE_DATA_OFFSET, data, len); 114 115 return rtsx_usb_transfer_data(ucr, 116 usb_sndbulkpipe(ucr->pusb_dev, EP_BULK_OUT), 117 ucr->cmd_buf, cmd_len, 0, NULL, 100); 118 } 119 120 static int rtsx_usb_seq_read_register(struct rtsx_ucr *ucr, 121 u16 addr, u16 len, u8 *data) 122 { 123 int i, ret; 124 u16 rsp_len = round_down(len, 4); 125 u16 res_len = len - rsp_len; 126 127 if (!data) 128 return -EINVAL; 129 130 /* 4-byte aligned part */ 131 if (rsp_len) { 132 rtsx_usb_seq_cmd_hdr(ucr, addr, len, SEQ_READ); 133 ret = rtsx_usb_transfer_data(ucr, 134 usb_sndbulkpipe(ucr->pusb_dev, EP_BULK_OUT), 135 ucr->cmd_buf, 12, 0, NULL, 100); 136 if (ret) 137 return ret; 138 139 ret = rtsx_usb_transfer_data(ucr, 140 usb_rcvbulkpipe(ucr->pusb_dev, EP_BULK_IN), 141 data, rsp_len, 0, NULL, 100); 142 if (ret) 143 return ret; 144 } 145 146 /* unaligned part */ 147 for (i = 0; i < res_len; i++) { 148 ret = rtsx_usb_read_register(ucr, addr + rsp_len + i, 149 data + rsp_len + i); 150 if (ret) 151 return ret; 152 } 153 154 return 0; 155 } 156 157 int rtsx_usb_read_ppbuf(struct rtsx_ucr *ucr, u8 *buf, int buf_len) 158 { 159 return rtsx_usb_seq_read_register(ucr, PPBUF_BASE2, (u16)buf_len, buf); 160 } 161 EXPORT_SYMBOL_GPL(rtsx_usb_read_ppbuf); 162 163 int rtsx_usb_write_ppbuf(struct rtsx_ucr *ucr, u8 *buf, int buf_len) 164 { 165 return rtsx_usb_seq_write_register(ucr, PPBUF_BASE2, (u16)buf_len, buf); 166 } 167 EXPORT_SYMBOL_GPL(rtsx_usb_write_ppbuf); 168 169 int rtsx_usb_ep0_write_register(struct rtsx_ucr *ucr, u16 addr, 170 u8 mask, u8 data) 171 { 172 u16 value, index; 173 174 addr |= EP0_WRITE_REG_CMD << EP0_OP_SHIFT; 175 value = swab16(addr); 176 index = mask | data << 8; 177 178 return usb_control_msg(ucr->pusb_dev, 179 usb_sndctrlpipe(ucr->pusb_dev, 0), RTSX_USB_REQ_REG_OP, 180 USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_DEVICE, 181 value, index, NULL, 0, 100); 182 } 183 EXPORT_SYMBOL_GPL(rtsx_usb_ep0_write_register); 184 185 int rtsx_usb_ep0_read_register(struct rtsx_ucr *ucr, u16 addr, u8 *data) 186 { 187 u16 value; 188 u8 *buf; 189 int ret; 190 191 if (!data) 192 return -EINVAL; 193 194 buf = kzalloc(sizeof(u8), GFP_KERNEL); 195 if (!buf) 196 return -ENOMEM; 197 198 addr |= EP0_READ_REG_CMD << EP0_OP_SHIFT; 199 value = swab16(addr); 200 201 ret = usb_control_msg(ucr->pusb_dev, 202 usb_rcvctrlpipe(ucr->pusb_dev, 0), RTSX_USB_REQ_REG_OP, 203 USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_DEVICE, 204 value, 0, buf, 1, 100); 205 *data = *buf; 206 207 kfree(buf); 208 return ret; 209 } 210 EXPORT_SYMBOL_GPL(rtsx_usb_ep0_read_register); 211 212 void rtsx_usb_add_cmd(struct rtsx_ucr *ucr, u8 cmd_type, u16 reg_addr, 213 u8 mask, u8 data) 214 { 215 int i; 216 217 if (ucr->cmd_idx < (IOBUF_SIZE - CMD_OFFSET) / 4) { 218 i = CMD_OFFSET + ucr->cmd_idx * 4; 219 220 ucr->cmd_buf[i++] = ((cmd_type & 0x03) << 6) | 221 (u8)((reg_addr >> 8) & 0x3F); 222 ucr->cmd_buf[i++] = (u8)reg_addr; 223 ucr->cmd_buf[i++] = mask; 224 ucr->cmd_buf[i++] = data; 225 226 ucr->cmd_idx++; 227 } 228 } 229 EXPORT_SYMBOL_GPL(rtsx_usb_add_cmd); 230 231 int rtsx_usb_send_cmd(struct rtsx_ucr *ucr, u8 flag, int timeout) 232 { 233 int ret; 234 235 ucr->cmd_buf[CNT_H] = (u8)(ucr->cmd_idx >> 8); 236 ucr->cmd_buf[CNT_L] = (u8)(ucr->cmd_idx); 237 ucr->cmd_buf[STAGE_FLAG] = flag; 238 239 ret = rtsx_usb_transfer_data(ucr, 240 usb_sndbulkpipe(ucr->pusb_dev, EP_BULK_OUT), 241 ucr->cmd_buf, ucr->cmd_idx * 4 + CMD_OFFSET, 242 0, NULL, timeout); 243 if (ret) { 244 rtsx_usb_clear_fsm_err(ucr); 245 return ret; 246 } 247 248 return 0; 249 } 250 EXPORT_SYMBOL_GPL(rtsx_usb_send_cmd); 251 252 int rtsx_usb_get_rsp(struct rtsx_ucr *ucr, int rsp_len, int timeout) 253 { 254 if (rsp_len <= 0) 255 return -EINVAL; 256 257 rsp_len = ALIGN(rsp_len, 4); 258 259 return rtsx_usb_transfer_data(ucr, 260 usb_rcvbulkpipe(ucr->pusb_dev, EP_BULK_IN), 261 ucr->rsp_buf, rsp_len, 0, NULL, timeout); 262 } 263 EXPORT_SYMBOL_GPL(rtsx_usb_get_rsp); 264 265 static int rtsx_usb_get_status_with_bulk(struct rtsx_ucr *ucr, u16 *status) 266 { 267 int ret; 268 269 rtsx_usb_init_cmd(ucr); 270 rtsx_usb_add_cmd(ucr, READ_REG_CMD, CARD_EXIST, 0x00, 0x00); 271 rtsx_usb_add_cmd(ucr, READ_REG_CMD, OCPSTAT, 0x00, 0x00); 272 ret = rtsx_usb_send_cmd(ucr, MODE_CR, 100); 273 if (ret) 274 return ret; 275 276 ret = rtsx_usb_get_rsp(ucr, 2, 100); 277 if (ret) 278 return ret; 279 280 *status = ((ucr->rsp_buf[0] >> 2) & 0x0f) | 281 ((ucr->rsp_buf[1] & 0x03) << 4); 282 283 return 0; 284 } 285 286 int rtsx_usb_get_card_status(struct rtsx_ucr *ucr, u16 *status) 287 { 288 int ret; 289 u16 *buf; 290 291 if (!status) 292 return -EINVAL; 293 294 if (polling_pipe == 0) { 295 buf = kzalloc(sizeof(u16), GFP_KERNEL); 296 if (!buf) 297 return -ENOMEM; 298 299 ret = usb_control_msg(ucr->pusb_dev, 300 usb_rcvctrlpipe(ucr->pusb_dev, 0), 301 RTSX_USB_REQ_POLL, 302 USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_DEVICE, 303 0, 0, buf, 2, 100); 304 *status = *buf; 305 306 kfree(buf); 307 } else { 308 ret = rtsx_usb_get_status_with_bulk(ucr, status); 309 } 310 311 /* usb_control_msg may return positive when success */ 312 if (ret < 0) 313 return ret; 314 315 ucr->card_status_cache = *status; 316 ucr->card_status_valid = true; 317 318 return 0; 319 } 320 EXPORT_SYMBOL_GPL(rtsx_usb_get_card_status); 321 322 static int rtsx_usb_write_phy_register(struct rtsx_ucr *ucr, u8 addr, u8 val) 323 { 324 dev_dbg(&ucr->pusb_intf->dev, "Write 0x%x to phy register 0x%x\n", 325 val, addr); 326 327 rtsx_usb_init_cmd(ucr); 328 329 rtsx_usb_add_cmd(ucr, WRITE_REG_CMD, HS_VSTAIN, 0xFF, val); 330 rtsx_usb_add_cmd(ucr, WRITE_REG_CMD, HS_VCONTROL, 0xFF, addr & 0x0F); 331 rtsx_usb_add_cmd(ucr, WRITE_REG_CMD, HS_VLOADM, 0xFF, 0x00); 332 rtsx_usb_add_cmd(ucr, WRITE_REG_CMD, HS_VLOADM, 0xFF, 0x00); 333 rtsx_usb_add_cmd(ucr, WRITE_REG_CMD, HS_VLOADM, 0xFF, 0x01); 334 rtsx_usb_add_cmd(ucr, WRITE_REG_CMD, HS_VCONTROL, 335 0xFF, (addr >> 4) & 0x0F); 336 rtsx_usb_add_cmd(ucr, WRITE_REG_CMD, HS_VLOADM, 0xFF, 0x00); 337 rtsx_usb_add_cmd(ucr, WRITE_REG_CMD, HS_VLOADM, 0xFF, 0x00); 338 rtsx_usb_add_cmd(ucr, WRITE_REG_CMD, HS_VLOADM, 0xFF, 0x01); 339 340 return rtsx_usb_send_cmd(ucr, MODE_C, 100); 341 } 342 343 int rtsx_usb_write_register(struct rtsx_ucr *ucr, u16 addr, u8 mask, u8 data) 344 { 345 rtsx_usb_init_cmd(ucr); 346 rtsx_usb_add_cmd(ucr, WRITE_REG_CMD, addr, mask, data); 347 return rtsx_usb_send_cmd(ucr, MODE_C, 100); 348 } 349 EXPORT_SYMBOL_GPL(rtsx_usb_write_register); 350 351 int rtsx_usb_read_register(struct rtsx_ucr *ucr, u16 addr, u8 *data) 352 { 353 int ret; 354 355 if (data != NULL) 356 *data = 0; 357 358 rtsx_usb_init_cmd(ucr); 359 rtsx_usb_add_cmd(ucr, READ_REG_CMD, addr, 0, 0); 360 ret = rtsx_usb_send_cmd(ucr, MODE_CR, 100); 361 if (ret) 362 return ret; 363 364 ret = rtsx_usb_get_rsp(ucr, 1, 100); 365 if (ret) 366 return ret; 367 368 if (data != NULL) 369 *data = ucr->rsp_buf[0]; 370 371 return 0; 372 } 373 EXPORT_SYMBOL_GPL(rtsx_usb_read_register); 374 375 static inline u8 double_ssc_depth(u8 depth) 376 { 377 return (depth > 1) ? (depth - 1) : depth; 378 } 379 380 static u8 revise_ssc_depth(u8 ssc_depth, u8 div) 381 { 382 if (div > CLK_DIV_1) { 383 if (ssc_depth > div - 1) 384 ssc_depth -= (div - 1); 385 else 386 ssc_depth = SSC_DEPTH_2M; 387 } 388 389 return ssc_depth; 390 } 391 392 int rtsx_usb_switch_clock(struct rtsx_ucr *ucr, unsigned int card_clock, 393 u8 ssc_depth, bool initial_mode, bool double_clk, bool vpclk) 394 { 395 int ret; 396 u8 n, clk_divider, mcu_cnt, div; 397 398 if (!card_clock) { 399 ucr->cur_clk = 0; 400 return 0; 401 } 402 403 if (initial_mode) { 404 /* We use 250k(around) here, in initial stage */ 405 clk_divider = SD_CLK_DIVIDE_128; 406 card_clock = 30000000; 407 } else { 408 clk_divider = SD_CLK_DIVIDE_0; 409 } 410 411 ret = rtsx_usb_write_register(ucr, SD_CFG1, 412 SD_CLK_DIVIDE_MASK, clk_divider); 413 if (ret < 0) 414 return ret; 415 416 card_clock /= 1000000; 417 dev_dbg(&ucr->pusb_intf->dev, 418 "Switch card clock to %dMHz\n", card_clock); 419 420 if (!initial_mode && double_clk) 421 card_clock *= 2; 422 dev_dbg(&ucr->pusb_intf->dev, 423 "Internal SSC clock: %dMHz (cur_clk = %d)\n", 424 card_clock, ucr->cur_clk); 425 426 if (card_clock == ucr->cur_clk) 427 return 0; 428 429 /* Converting clock value into internal settings: n and div */ 430 n = card_clock - 2; 431 if ((card_clock <= 2) || (n > MAX_DIV_N)) 432 return -EINVAL; 433 434 mcu_cnt = 60/card_clock + 3; 435 if (mcu_cnt > 15) 436 mcu_cnt = 15; 437 438 /* Make sure that the SSC clock div_n is not less than MIN_DIV_N */ 439 440 div = CLK_DIV_1; 441 while (n < MIN_DIV_N && div < CLK_DIV_4) { 442 n = (n + 2) * 2 - 2; 443 div++; 444 } 445 dev_dbg(&ucr->pusb_intf->dev, "n = %d, div = %d\n", n, div); 446 447 if (double_clk) 448 ssc_depth = double_ssc_depth(ssc_depth); 449 450 ssc_depth = revise_ssc_depth(ssc_depth, div); 451 dev_dbg(&ucr->pusb_intf->dev, "ssc_depth = %d\n", ssc_depth); 452 453 rtsx_usb_init_cmd(ucr); 454 rtsx_usb_add_cmd(ucr, WRITE_REG_CMD, CLK_DIV, CLK_CHANGE, CLK_CHANGE); 455 rtsx_usb_add_cmd(ucr, WRITE_REG_CMD, CLK_DIV, 456 0x3F, (div << 4) | mcu_cnt); 457 rtsx_usb_add_cmd(ucr, WRITE_REG_CMD, SSC_CTL1, SSC_RSTB, 0); 458 rtsx_usb_add_cmd(ucr, WRITE_REG_CMD, SSC_CTL2, 459 SSC_DEPTH_MASK, ssc_depth); 460 rtsx_usb_add_cmd(ucr, WRITE_REG_CMD, SSC_DIV_N_0, 0xFF, n); 461 rtsx_usb_add_cmd(ucr, WRITE_REG_CMD, SSC_CTL1, SSC_RSTB, SSC_RSTB); 462 if (vpclk) { 463 rtsx_usb_add_cmd(ucr, WRITE_REG_CMD, SD_VPCLK0_CTL, 464 PHASE_NOT_RESET, 0); 465 rtsx_usb_add_cmd(ucr, WRITE_REG_CMD, SD_VPCLK0_CTL, 466 PHASE_NOT_RESET, PHASE_NOT_RESET); 467 } 468 469 ret = rtsx_usb_send_cmd(ucr, MODE_C, 2000); 470 if (ret < 0) 471 return ret; 472 473 ret = rtsx_usb_write_register(ucr, SSC_CTL1, 0xff, 474 SSC_RSTB | SSC_8X_EN | SSC_SEL_4M); 475 if (ret < 0) 476 return ret; 477 478 /* Wait SSC clock stable */ 479 usleep_range(100, 1000); 480 481 ret = rtsx_usb_write_register(ucr, CLK_DIV, CLK_CHANGE, 0); 482 if (ret < 0) 483 return ret; 484 485 ucr->cur_clk = card_clock; 486 487 return 0; 488 } 489 EXPORT_SYMBOL_GPL(rtsx_usb_switch_clock); 490 491 int rtsx_usb_card_exclusive_check(struct rtsx_ucr *ucr, int card) 492 { 493 int ret; 494 u16 val; 495 u16 cd_mask[] = { 496 [RTSX_USB_SD_CARD] = (CD_MASK & ~SD_CD), 497 [RTSX_USB_MS_CARD] = (CD_MASK & ~MS_CD) 498 }; 499 500 ret = rtsx_usb_get_card_status(ucr, &val); 501 /* 502 * If get status fails, return 0 (ok) for the exclusive check 503 * and let the flow fail at somewhere else. 504 */ 505 if (ret) 506 return 0; 507 508 if (val & cd_mask[card]) 509 return -EIO; 510 511 return 0; 512 } 513 EXPORT_SYMBOL_GPL(rtsx_usb_card_exclusive_check); 514 515 static int rtsx_usb_reset_chip(struct rtsx_ucr *ucr) 516 { 517 int ret; 518 u8 val; 519 520 rtsx_usb_init_cmd(ucr); 521 522 if (CHECK_PKG(ucr, LQFP48)) { 523 rtsx_usb_add_cmd(ucr, WRITE_REG_CMD, CARD_PWR_CTL, 524 LDO3318_PWR_MASK, LDO_SUSPEND); 525 rtsx_usb_add_cmd(ucr, WRITE_REG_CMD, CARD_PWR_CTL, 526 FORCE_LDO_POWERB, FORCE_LDO_POWERB); 527 rtsx_usb_add_cmd(ucr, WRITE_REG_CMD, CARD_PULL_CTL1, 528 0x30, 0x10); 529 rtsx_usb_add_cmd(ucr, WRITE_REG_CMD, CARD_PULL_CTL5, 530 0x03, 0x01); 531 rtsx_usb_add_cmd(ucr, WRITE_REG_CMD, CARD_PULL_CTL6, 532 0x0C, 0x04); 533 } 534 535 rtsx_usb_add_cmd(ucr, WRITE_REG_CMD, SYS_DUMMY0, NYET_MSAK, NYET_EN); 536 rtsx_usb_add_cmd(ucr, WRITE_REG_CMD, CD_DEGLITCH_WIDTH, 0xFF, 0x08); 537 rtsx_usb_add_cmd(ucr, WRITE_REG_CMD, 538 CD_DEGLITCH_EN, XD_CD_DEGLITCH_EN, 0x0); 539 rtsx_usb_add_cmd(ucr, WRITE_REG_CMD, SD30_DRIVE_SEL, 540 SD30_DRIVE_MASK, DRIVER_TYPE_D); 541 rtsx_usb_add_cmd(ucr, WRITE_REG_CMD, 542 CARD_DRIVE_SEL, SD20_DRIVE_MASK, 0x0); 543 rtsx_usb_add_cmd(ucr, WRITE_REG_CMD, LDO_POWER_CFG, 0xE0, 0x0); 544 545 if (ucr->is_rts5179) 546 rtsx_usb_add_cmd(ucr, WRITE_REG_CMD, 547 CARD_PULL_CTL5, 0x03, 0x01); 548 549 rtsx_usb_add_cmd(ucr, WRITE_REG_CMD, CARD_DMA1_CTL, 550 EXTEND_DMA1_ASYNC_SIGNAL, EXTEND_DMA1_ASYNC_SIGNAL); 551 rtsx_usb_add_cmd(ucr, WRITE_REG_CMD, CARD_INT_PEND, 552 XD_INT | MS_INT | SD_INT, 553 XD_INT | MS_INT | SD_INT); 554 555 ret = rtsx_usb_send_cmd(ucr, MODE_C, 100); 556 if (ret) 557 return ret; 558 /* config OCP */ 559 rtsx_usb_write_register(ucr, OCPCTL, MS_OCP_DETECT_EN, MS_OCP_DETECT_EN); 560 rtsx_usb_write_register(ucr, OCPPARA1, 0xF0, 0x50); 561 rtsx_usb_write_register(ucr, OCPPARA2, 0x7, 0x3); 562 563 /* config non-crystal mode */ 564 rtsx_usb_read_register(ucr, CFG_MODE, &val); 565 if ((val & XTAL_FREE) || ((val & CLK_MODE_MASK) == CLK_MODE_NON_XTAL)) { 566 ret = rtsx_usb_write_phy_register(ucr, 0xC2, 0x7C); 567 if (ret) 568 return ret; 569 } 570 571 return 0; 572 } 573 574 static int rtsx_usb_init_chip(struct rtsx_ucr *ucr) 575 { 576 int ret; 577 u8 val; 578 579 rtsx_usb_clear_fsm_err(ucr); 580 581 /* power on SSC */ 582 ret = rtsx_usb_write_register(ucr, 583 FPDCTL, SSC_POWER_MASK, SSC_POWER_ON); 584 if (ret) 585 return ret; 586 587 usleep_range(100, 1000); 588 ret = rtsx_usb_write_register(ucr, CLK_DIV, CLK_CHANGE, 0x00); 589 if (ret) 590 return ret; 591 592 /* determine IC version */ 593 ret = rtsx_usb_read_register(ucr, HW_VERSION, &val); 594 if (ret) 595 return ret; 596 597 ucr->ic_version = val & HW_VER_MASK; 598 599 /* determine package */ 600 ret = rtsx_usb_read_register(ucr, CARD_SHARE_MODE, &val); 601 if (ret) 602 return ret; 603 604 if (val & CARD_SHARE_LQFP_SEL) { 605 ucr->package = LQFP48; 606 dev_dbg(&ucr->pusb_intf->dev, "Package: LQFP48\n"); 607 } else { 608 ucr->package = QFN24; 609 dev_dbg(&ucr->pusb_intf->dev, "Package: QFN24\n"); 610 } 611 612 /* determine IC variations */ 613 rtsx_usb_read_register(ucr, CFG_MODE_1, &val); 614 if (val & RTS5179) { 615 ucr->is_rts5179 = true; 616 dev_dbg(&ucr->pusb_intf->dev, "Device is rts5179\n"); 617 } else { 618 ucr->is_rts5179 = false; 619 } 620 621 return rtsx_usb_reset_chip(ucr); 622 } 623 624 static int rtsx_usb_probe(struct usb_interface *intf, 625 const struct usb_device_id *id) 626 { 627 struct usb_device *usb_dev = interface_to_usbdev(intf); 628 struct rtsx_ucr *ucr; 629 u16 status; 630 int ret; 631 632 dev_dbg(&intf->dev, 633 ": Realtek USB Card Reader found at bus %03d address %03d\n", 634 usb_dev->bus->busnum, usb_dev->devnum); 635 636 ucr = devm_kzalloc(&intf->dev, sizeof(*ucr), GFP_KERNEL); 637 if (!ucr) 638 return -ENOMEM; 639 640 ucr->pusb_dev = usb_dev; 641 642 ucr->cmd_buf = kmalloc(IOBUF_SIZE, GFP_KERNEL); 643 if (!ucr->cmd_buf) 644 return -ENOMEM; 645 646 ucr->rsp_buf = kmalloc(IOBUF_SIZE, GFP_KERNEL); 647 if (!ucr->rsp_buf) { 648 ret = -ENOMEM; 649 goto out_free_cmd_buf; 650 } 651 652 usb_set_intfdata(intf, ucr); 653 654 ucr->vendor_id = id->idVendor; 655 ucr->product_id = id->idProduct; 656 657 mutex_init(&ucr->dev_mutex); 658 659 ucr->pusb_intf = intf; 660 661 /* initialize */ 662 ret = rtsx_usb_init_chip(ucr); 663 if (ret) 664 goto out_init_fail; 665 666 /* Prime cached status for runtime autosuspend decisions. */ 667 rtsx_usb_get_card_status(ucr, &status); 668 669 /* initialize USB SG transfer timer */ 670 timer_setup(&ucr->sg_timer, rtsx_usb_sg_timed_out, 0); 671 672 ret = mfd_add_hotplug_devices(&intf->dev, rtsx_usb_cells, 673 ARRAY_SIZE(rtsx_usb_cells)); 674 if (ret) 675 goto out_init_fail; 676 677 #ifdef CONFIG_PM 678 intf->needs_remote_wakeup = 1; 679 usb_enable_autosuspend(usb_dev); 680 #endif 681 682 return 0; 683 684 out_init_fail: 685 usb_set_intfdata(ucr->pusb_intf, NULL); 686 kfree(ucr->rsp_buf); 687 ucr->rsp_buf = NULL; 688 out_free_cmd_buf: 689 kfree(ucr->cmd_buf); 690 ucr->cmd_buf = NULL; 691 return ret; 692 } 693 694 static void rtsx_usb_disconnect(struct usb_interface *intf) 695 { 696 struct rtsx_ucr *ucr = (struct rtsx_ucr *)usb_get_intfdata(intf); 697 698 dev_dbg(&intf->dev, "%s called\n", __func__); 699 700 mfd_remove_devices(&intf->dev); 701 702 usb_set_intfdata(ucr->pusb_intf, NULL); 703 704 kfree(ucr->cmd_buf); 705 ucr->cmd_buf = NULL; 706 707 kfree(ucr->rsp_buf); 708 ucr->rsp_buf = NULL; 709 } 710 711 #ifdef CONFIG_PM 712 static int rtsx_usb_resume_child(struct device *dev, void *data) 713 { 714 pm_request_resume(dev); 715 return 0; 716 } 717 718 static int rtsx_usb_suspend(struct usb_interface *intf, pm_message_t message) 719 { 720 struct rtsx_ucr *ucr = 721 (struct rtsx_ucr *)usb_get_intfdata(intf); 722 u16 val = 0; 723 bool valid = false; 724 725 dev_dbg(&intf->dev, "%s called with pm message 0x%04x\n", 726 __func__, message.event); 727 728 if (PMSG_IS_AUTO(message)) { 729 if (mutex_trylock(&ucr->dev_mutex)) { 730 valid = ucr->card_status_valid; 731 if (valid) 732 val = ucr->card_status_cache; 733 mutex_unlock(&ucr->dev_mutex); 734 735 /* 736 * Do not issue USB commands from runtime autosuspend. 737 * Raw SD_CD is not authoritative on tray-based readers, 738 * while a real SD card is protected by the SD/MMC child 739 * runtime-PM reference once the card is powered. Keep 740 * the historical Memory Stick autosuspend deferral when 741 * the cached status says MS media is present. 742 */ 743 if (valid && (val & MS_CD)) { 744 device_for_each_child(&intf->dev, NULL, rtsx_usb_resume_child); 745 return -EAGAIN; 746 } 747 } else { 748 /* There is an ongoing operation*/ 749 return -EAGAIN; 750 } 751 } 752 753 return 0; 754 } 755 756 static int rtsx_usb_resume(struct usb_interface *intf) 757 { 758 device_for_each_child(&intf->dev, NULL, rtsx_usb_resume_child); 759 return 0; 760 } 761 762 static int rtsx_usb_reset_resume(struct usb_interface *intf) 763 { 764 struct rtsx_ucr *ucr = 765 (struct rtsx_ucr *)usb_get_intfdata(intf); 766 767 rtsx_usb_reset_chip(ucr); 768 device_for_each_child(&intf->dev, NULL, rtsx_usb_resume_child); 769 return 0; 770 } 771 772 #else /* CONFIG_PM */ 773 774 #define rtsx_usb_suspend NULL 775 #define rtsx_usb_resume NULL 776 #define rtsx_usb_reset_resume NULL 777 778 #endif /* CONFIG_PM */ 779 780 781 static int rtsx_usb_pre_reset(struct usb_interface *intf) 782 { 783 struct rtsx_ucr *ucr = (struct rtsx_ucr *)usb_get_intfdata(intf); 784 785 mutex_lock(&ucr->dev_mutex); 786 return 0; 787 } 788 789 static int rtsx_usb_post_reset(struct usb_interface *intf) 790 { 791 struct rtsx_ucr *ucr = (struct rtsx_ucr *)usb_get_intfdata(intf); 792 793 mutex_unlock(&ucr->dev_mutex); 794 return 0; 795 } 796 797 static const struct usb_device_id rtsx_usb_usb_ids[] = { 798 { USB_DEVICE(0x0BDA, 0x0129) }, 799 { USB_DEVICE(0x0BDA, 0x0139) }, 800 { USB_DEVICE(0x0BDA, 0x0140) }, 801 { } 802 }; 803 MODULE_DEVICE_TABLE(usb, rtsx_usb_usb_ids); 804 805 static struct usb_driver rtsx_usb_driver = { 806 .name = DRV_NAME_RTSX_USB, 807 .probe = rtsx_usb_probe, 808 .disconnect = rtsx_usb_disconnect, 809 .suspend = rtsx_usb_suspend, 810 .resume = rtsx_usb_resume, 811 .reset_resume = rtsx_usb_reset_resume, 812 .pre_reset = rtsx_usb_pre_reset, 813 .post_reset = rtsx_usb_post_reset, 814 .id_table = rtsx_usb_usb_ids, 815 .supports_autosuspend = 1, 816 .soft_unbind = 1, 817 }; 818 819 module_usb_driver(rtsx_usb_driver); 820 821 MODULE_LICENSE("GPL v2"); 822 MODULE_AUTHOR("Roger Tseng <rogerable@realtek.com>"); 823 MODULE_DESCRIPTION("Realtek USB Card Reader Driver"); 824