1 // SPDX-License-Identifier: GPL-2.0+ 2 /* 3 * Driver for Realtek RTS51xx USB card reader 4 * 5 * Copyright(c) 2009 Realtek Semiconductor Corp. All rights reserved. 6 * 7 * Author: 8 * wwang (wei_wang@realsil.com.cn) 9 * No. 450, Shenhu Road, Suzhou Industry Park, Suzhou, China 10 */ 11 12 #include <linux/module.h> 13 #include <linux/blkdev.h> 14 #include <linux/kthread.h> 15 #include <linux/sched.h> 16 #include <linux/kernel.h> 17 18 #include <scsi/scsi.h> 19 #include <scsi/scsi_cmnd.h> 20 #include <scsi/scsi_device.h> 21 #include <linux/cdrom.h> 22 23 #include <linux/usb.h> 24 #include <linux/slab.h> 25 #include <linux/usb_usual.h> 26 27 #include "usb.h" 28 #include "transport.h" 29 #include "protocol.h" 30 #include "debug.h" 31 #include "scsiglue.h" 32 33 #define DRV_NAME "ums-realtek" 34 35 MODULE_DESCRIPTION("Driver for Realtek USB Card Reader"); 36 MODULE_AUTHOR("wwang <wei_wang@realsil.com.cn>"); 37 MODULE_LICENSE("GPL"); 38 39 static int auto_delink_en = 1; 40 module_param(auto_delink_en, int, S_IRUGO | S_IWUSR); 41 MODULE_PARM_DESC(auto_delink_en, "enable auto delink"); 42 43 #ifdef CONFIG_REALTEK_AUTOPM 44 static int ss_en = 1; 45 module_param(ss_en, int, S_IRUGO | S_IWUSR); 46 MODULE_PARM_DESC(ss_en, "enable selective suspend"); 47 48 static int ss_delay = 50; 49 module_param(ss_delay, int, S_IRUGO | S_IWUSR); 50 MODULE_PARM_DESC(ss_delay, 51 "seconds to delay before entering selective suspend"); 52 53 enum RTS51X_STAT { 54 RTS51X_STAT_INIT, 55 RTS51X_STAT_IDLE, 56 RTS51X_STAT_RUN, 57 RTS51X_STAT_SS 58 }; 59 60 #define POLLING_INTERVAL 50 61 62 #define rts51x_set_stat(chip, stat) \ 63 ((chip)->state = (enum RTS51X_STAT)(stat)) 64 #define rts51x_get_stat(chip) ((chip)->state) 65 66 #define SET_LUN_READY(chip, lun) ((chip)->lun_ready |= ((u8)1 << (lun))) 67 #define CLR_LUN_READY(chip, lun) ((chip)->lun_ready &= ~((u8)1 << (lun))) 68 #define TST_LUN_READY(chip, lun) ((chip)->lun_ready & ((u8)1 << (lun))) 69 70 #endif 71 72 struct rts51x_status { 73 u16 vid; 74 u16 pid; 75 u8 cur_lun; 76 u8 card_type; 77 u8 total_lun; 78 u16 fw_ver; 79 u8 phy_exist; 80 u8 multi_flag; 81 u8 multi_card; 82 u8 log_exist; 83 union { 84 u8 detailed_type1; 85 u8 detailed_type2; 86 } detailed_type; 87 u8 function[2]; 88 }; 89 90 struct rts51x_chip { 91 u16 vendor_id; 92 u16 product_id; 93 char max_lun; 94 95 struct rts51x_status *status; 96 int status_len; 97 98 u32 flag; 99 struct us_data *us; 100 101 #ifdef CONFIG_REALTEK_AUTOPM 102 struct timer_list rts51x_suspend_timer; 103 unsigned long timer_expires; 104 int pwr_state; 105 u8 lun_ready; 106 enum RTS51X_STAT state; 107 int support_auto_delink; 108 #endif 109 /* used to back up the protocol chosen in probe1 phase */ 110 proto_cmnd proto_handler_backup; 111 }; 112 113 /* flag definition */ 114 #define FLIDX_AUTO_DELINK 0x01 115 116 #define SCSI_LUN(srb) ((srb)->device->lun) 117 118 /* Bit Operation */ 119 #define SET_BIT(data, idx) ((data) |= 1 << (idx)) 120 #define CLR_BIT(data, idx) ((data) &= ~(1 << (idx))) 121 #define CHK_BIT(data, idx) ((data) & (1 << (idx))) 122 123 #define SET_AUTO_DELINK(chip) ((chip)->flag |= FLIDX_AUTO_DELINK) 124 #define CLR_AUTO_DELINK(chip) ((chip)->flag &= ~FLIDX_AUTO_DELINK) 125 #define CHK_AUTO_DELINK(chip) ((chip)->flag & FLIDX_AUTO_DELINK) 126 127 #define RTS51X_GET_VID(chip) ((chip)->vendor_id) 128 #define RTS51X_GET_PID(chip) ((chip)->product_id) 129 130 #define VENDOR_ID(chip) ((chip)->status[0].vid) 131 #define PRODUCT_ID(chip) ((chip)->status[0].pid) 132 #define FW_VERSION(chip) ((chip)->status[0].fw_ver) 133 #define STATUS_LEN(chip) ((chip)->status_len) 134 135 #define STATUS_SUCCESS 0 136 #define STATUS_FAIL 1 137 138 /* Check card reader function */ 139 #define SUPPORT_DETAILED_TYPE1(chip) \ 140 CHK_BIT((chip)->status[0].function[0], 1) 141 #define SUPPORT_OT(chip) \ 142 CHK_BIT((chip)->status[0].function[0], 2) 143 #define SUPPORT_OC(chip) \ 144 CHK_BIT((chip)->status[0].function[0], 3) 145 #define SUPPORT_AUTO_DELINK(chip) \ 146 CHK_BIT((chip)->status[0].function[0], 4) 147 #define SUPPORT_SDIO(chip) \ 148 CHK_BIT((chip)->status[0].function[1], 0) 149 #define SUPPORT_DETAILED_TYPE2(chip) \ 150 CHK_BIT((chip)->status[0].function[1], 1) 151 152 #define CHECK_PID(chip, pid) (RTS51X_GET_PID(chip) == (pid)) 153 #define CHECK_FW_VER(chip, fw_ver) (FW_VERSION(chip) == (fw_ver)) 154 #define CHECK_ID(chip, pid, fw_ver) \ 155 (CHECK_PID((chip), (pid)) && CHECK_FW_VER((chip), (fw_ver))) 156 157 static int init_realtek_cr(struct us_data *us); 158 159 /* 160 * The table of devices 161 */ 162 #define UNUSUAL_DEV(id_vendor, id_product, bcdDeviceMin, bcdDeviceMax, \ 163 vendorName, productName, useProtocol, useTransport, \ 164 initFunction, flags) \ 165 {\ 166 USB_DEVICE_VER(id_vendor, id_product, bcdDeviceMin, bcdDeviceMax), \ 167 .driver_info = (flags) \ 168 } 169 170 static const struct usb_device_id realtek_cr_ids[] = { 171 # include "unusual_realtek.h" 172 {} /* Terminating entry */ 173 }; 174 175 MODULE_DEVICE_TABLE(usb, realtek_cr_ids); 176 177 #undef UNUSUAL_DEV 178 179 /* 180 * The flags table 181 */ 182 #define UNUSUAL_DEV(idVendor, idProduct, bcdDeviceMin, bcdDeviceMax, \ 183 vendor_name, product_name, use_protocol, use_transport, \ 184 init_function, Flags) \ 185 { \ 186 .vendorName = vendor_name, \ 187 .productName = product_name, \ 188 .useProtocol = use_protocol, \ 189 .useTransport = use_transport, \ 190 .initFunction = init_function, \ 191 } 192 193 static struct us_unusual_dev realtek_cr_unusual_dev_list[] = { 194 # include "unusual_realtek.h" 195 {} /* Terminating entry */ 196 }; 197 198 #undef UNUSUAL_DEV 199 200 static int rts51x_bulk_transport(struct us_data *us, u8 lun, 201 u8 *cmd, int cmd_len, u8 *buf, int buf_len, 202 enum dma_data_direction dir, int *act_len) 203 { 204 struct bulk_cb_wrap *bcb = (struct bulk_cb_wrap *)us->iobuf; 205 struct bulk_cs_wrap *bcs = (struct bulk_cs_wrap *)us->iobuf; 206 int result; 207 unsigned int residue; 208 unsigned int cswlen; 209 unsigned int cbwlen = US_BULK_CB_WRAP_LEN; 210 211 /* set up the command wrapper */ 212 bcb->Signature = cpu_to_le32(US_BULK_CB_SIGN); 213 bcb->DataTransferLength = cpu_to_le32(buf_len); 214 bcb->Flags = (dir == DMA_FROM_DEVICE) ? US_BULK_FLAG_IN : 0; 215 bcb->Tag = ++us->tag; 216 bcb->Lun = lun; 217 bcb->Length = cmd_len; 218 219 /* copy the command payload */ 220 memset(bcb->CDB, 0, sizeof(bcb->CDB)); 221 memcpy(bcb->CDB, cmd, bcb->Length); 222 223 /* send it to out endpoint */ 224 result = usb_stor_bulk_transfer_buf(us, us->send_bulk_pipe, 225 bcb, cbwlen, NULL); 226 if (result != USB_STOR_XFER_GOOD) 227 return USB_STOR_TRANSPORT_ERROR; 228 229 /* DATA STAGE */ 230 /* send/receive data payload, if there is any */ 231 232 if (buf && buf_len) { 233 unsigned int pipe = (dir == DMA_FROM_DEVICE) ? 234 us->recv_bulk_pipe : us->send_bulk_pipe; 235 result = usb_stor_bulk_transfer_buf(us, pipe, 236 buf, buf_len, NULL); 237 if (result == USB_STOR_XFER_ERROR) 238 return USB_STOR_TRANSPORT_ERROR; 239 } 240 241 /* get CSW for device status */ 242 result = usb_stor_bulk_transfer_buf(us, us->recv_bulk_pipe, 243 bcs, US_BULK_CS_WRAP_LEN, &cswlen); 244 if (result != USB_STOR_XFER_GOOD) 245 return USB_STOR_TRANSPORT_ERROR; 246 247 /* check bulk status */ 248 if (bcs->Signature != cpu_to_le32(US_BULK_CS_SIGN)) { 249 usb_stor_dbg(us, "Signature mismatch: got %08X, expecting %08X\n", 250 le32_to_cpu(bcs->Signature), US_BULK_CS_SIGN); 251 return USB_STOR_TRANSPORT_ERROR; 252 } 253 254 residue = bcs->Residue; 255 if (bcs->Tag != us->tag) 256 return USB_STOR_TRANSPORT_ERROR; 257 258 /* 259 * try to compute the actual residue, based on how much data 260 * was really transferred and what the device tells us 261 */ 262 if (residue) 263 residue = residue < buf_len ? residue : buf_len; 264 265 if (act_len) 266 *act_len = buf_len - residue; 267 268 /* based on the status code, we report good or bad */ 269 switch (bcs->Status) { 270 case US_BULK_STAT_OK: 271 /* command good -- note that data could be short */ 272 return USB_STOR_TRANSPORT_GOOD; 273 274 case US_BULK_STAT_FAIL: 275 /* command failed */ 276 return USB_STOR_TRANSPORT_FAILED; 277 278 case US_BULK_STAT_PHASE: 279 /* 280 * phase error -- note that a transport reset will be 281 * invoked by the invoke_transport() function 282 */ 283 return USB_STOR_TRANSPORT_ERROR; 284 } 285 286 /* we should never get here, but if we do, we're in trouble */ 287 return USB_STOR_TRANSPORT_ERROR; 288 } 289 290 static int rts51x_bulk_transport_special(struct us_data *us, u8 lun, 291 u8 *cmd, int cmd_len, u8 *buf, int buf_len, 292 enum dma_data_direction dir, int *act_len) 293 { 294 struct bulk_cb_wrap *bcb = (struct bulk_cb_wrap *) us->iobuf; 295 struct bulk_cs_wrap *bcs = (struct bulk_cs_wrap *) us->iobuf; 296 int result; 297 unsigned int cswlen; 298 unsigned int cbwlen = US_BULK_CB_WRAP_LEN; 299 300 /* set up the command wrapper */ 301 bcb->Signature = cpu_to_le32(US_BULK_CB_SIGN); 302 bcb->DataTransferLength = cpu_to_le32(buf_len); 303 bcb->Flags = (dir == DMA_FROM_DEVICE) ? US_BULK_FLAG_IN : 0; 304 bcb->Tag = ++us->tag; 305 bcb->Lun = lun; 306 bcb->Length = cmd_len; 307 308 /* copy the command payload */ 309 memset(bcb->CDB, 0, sizeof(bcb->CDB)); 310 memcpy(bcb->CDB, cmd, bcb->Length); 311 312 /* send it to out endpoint */ 313 result = usb_stor_bulk_transfer_buf(us, us->send_bulk_pipe, 314 bcb, cbwlen, NULL); 315 if (result != USB_STOR_XFER_GOOD) 316 return USB_STOR_TRANSPORT_ERROR; 317 318 /* DATA STAGE */ 319 /* send/receive data payload, if there is any */ 320 321 if (buf && buf_len) { 322 unsigned int pipe = (dir == DMA_FROM_DEVICE) ? 323 us->recv_bulk_pipe : us->send_bulk_pipe; 324 result = usb_stor_bulk_transfer_buf(us, pipe, 325 buf, buf_len, NULL); 326 if (result == USB_STOR_XFER_ERROR) 327 return USB_STOR_TRANSPORT_ERROR; 328 } 329 330 /* get CSW for device status */ 331 result = usb_bulk_msg(us->pusb_dev, us->recv_bulk_pipe, bcs, 332 US_BULK_CS_WRAP_LEN, &cswlen, 250); 333 return result; 334 } 335 336 /* Determine what the maximum LUN supported is */ 337 static int rts51x_get_max_lun(struct us_data *us) 338 { 339 int result; 340 341 /* issue the command */ 342 us->iobuf[0] = 0; 343 result = usb_stor_control_msg(us, us->recv_ctrl_pipe, 344 US_BULK_GET_MAX_LUN, 345 USB_DIR_IN | USB_TYPE_CLASS | 346 USB_RECIP_INTERFACE, 347 0, us->ifnum, us->iobuf, 1, 10 * HZ); 348 349 usb_stor_dbg(us, "GetMaxLUN command result is %d, data is %d\n", 350 result, us->iobuf[0]); 351 352 /* if we have a successful request, return the result */ 353 if (result > 0) 354 return us->iobuf[0]; 355 356 return 0; 357 } 358 359 static int rts51x_read_mem(struct us_data *us, u16 addr, u8 *data, u16 len) 360 { 361 int retval; 362 u8 cmnd[12] = { 0 }; 363 u8 *buf; 364 365 buf = kmalloc(len, GFP_NOIO); 366 if (buf == NULL) 367 return USB_STOR_TRANSPORT_ERROR; 368 369 usb_stor_dbg(us, "addr = 0x%x, len = %d\n", addr, len); 370 371 cmnd[0] = 0xF0; 372 cmnd[1] = 0x0D; 373 cmnd[2] = (u8) (addr >> 8); 374 cmnd[3] = (u8) addr; 375 cmnd[4] = (u8) (len >> 8); 376 cmnd[5] = (u8) len; 377 378 retval = rts51x_bulk_transport(us, 0, cmnd, 12, 379 buf, len, DMA_FROM_DEVICE, NULL); 380 if (retval != USB_STOR_TRANSPORT_GOOD) { 381 kfree(buf); 382 return -EIO; 383 } 384 385 memcpy(data, buf, len); 386 kfree(buf); 387 return 0; 388 } 389 390 static int rts51x_write_mem(struct us_data *us, u16 addr, u8 *data, u16 len) 391 { 392 int retval; 393 u8 cmnd[12] = { 0 }; 394 u8 *buf; 395 396 buf = kmemdup(data, len, GFP_NOIO); 397 if (buf == NULL) 398 return USB_STOR_TRANSPORT_ERROR; 399 400 usb_stor_dbg(us, "addr = 0x%x, len = %d\n", addr, len); 401 402 cmnd[0] = 0xF0; 403 cmnd[1] = 0x0E; 404 cmnd[2] = (u8) (addr >> 8); 405 cmnd[3] = (u8) addr; 406 cmnd[4] = (u8) (len >> 8); 407 cmnd[5] = (u8) len; 408 409 retval = rts51x_bulk_transport(us, 0, cmnd, 12, 410 buf, len, DMA_TO_DEVICE, NULL); 411 kfree(buf); 412 if (retval != USB_STOR_TRANSPORT_GOOD) 413 return -EIO; 414 415 return 0; 416 } 417 418 static int rts51x_read_status(struct us_data *us, 419 u8 lun, u8 *status, int len, int *actlen) 420 { 421 int retval; 422 u8 cmnd[12] = { 0 }; 423 u8 *buf; 424 425 buf = kmalloc(len, GFP_NOIO); 426 if (buf == NULL) 427 return USB_STOR_TRANSPORT_ERROR; 428 429 usb_stor_dbg(us, "lun = %d\n", lun); 430 431 cmnd[0] = 0xF0; 432 cmnd[1] = 0x09; 433 434 retval = rts51x_bulk_transport(us, lun, cmnd, 12, 435 buf, len, DMA_FROM_DEVICE, actlen); 436 if (retval != USB_STOR_TRANSPORT_GOOD) { 437 kfree(buf); 438 return -EIO; 439 } 440 441 memcpy(status, buf, len); 442 kfree(buf); 443 return 0; 444 } 445 446 static int rts51x_check_status(struct us_data *us, u8 lun) 447 { 448 struct rts51x_chip *chip = (struct rts51x_chip *)(us->extra); 449 int retval; 450 u8 buf[16]; 451 452 retval = rts51x_read_status(us, lun, buf, 16, &(chip->status_len)); 453 if (retval != STATUS_SUCCESS) 454 return -EIO; 455 456 usb_stor_dbg(us, "chip->status_len = %d\n", chip->status_len); 457 458 chip->status[lun].vid = ((u16) buf[0] << 8) | buf[1]; 459 chip->status[lun].pid = ((u16) buf[2] << 8) | buf[3]; 460 chip->status[lun].cur_lun = buf[4]; 461 chip->status[lun].card_type = buf[5]; 462 chip->status[lun].total_lun = buf[6]; 463 chip->status[lun].fw_ver = ((u16) buf[7] << 8) | buf[8]; 464 chip->status[lun].phy_exist = buf[9]; 465 chip->status[lun].multi_flag = buf[10]; 466 chip->status[lun].multi_card = buf[11]; 467 chip->status[lun].log_exist = buf[12]; 468 if (chip->status_len == 16) { 469 chip->status[lun].detailed_type.detailed_type1 = buf[13]; 470 chip->status[lun].function[0] = buf[14]; 471 chip->status[lun].function[1] = buf[15]; 472 } 473 474 return 0; 475 } 476 477 static int enable_oscillator(struct us_data *us) 478 { 479 int retval; 480 u8 value; 481 482 retval = rts51x_read_mem(us, 0xFE77, &value, 1); 483 if (retval < 0) 484 return -EIO; 485 486 value |= 0x04; 487 retval = rts51x_write_mem(us, 0xFE77, &value, 1); 488 if (retval < 0) 489 return -EIO; 490 491 retval = rts51x_read_mem(us, 0xFE77, &value, 1); 492 if (retval < 0) 493 return -EIO; 494 495 if (!(value & 0x04)) 496 return -EIO; 497 498 return 0; 499 } 500 501 static int __do_config_autodelink(struct us_data *us, u8 *data, u16 len) 502 { 503 int retval; 504 u8 cmnd[12] = {0}; 505 u8 *buf; 506 507 usb_stor_dbg(us, "addr = 0xfe47, len = %d\n", len); 508 509 buf = kmemdup(data, len, GFP_NOIO); 510 if (!buf) 511 return USB_STOR_TRANSPORT_ERROR; 512 513 cmnd[0] = 0xF0; 514 cmnd[1] = 0x0E; 515 cmnd[2] = 0xfe; 516 cmnd[3] = 0x47; 517 cmnd[4] = (u8)(len >> 8); 518 cmnd[5] = (u8)len; 519 520 retval = rts51x_bulk_transport_special(us, 0, cmnd, 12, buf, len, DMA_TO_DEVICE, NULL); 521 kfree(buf); 522 if (retval != USB_STOR_TRANSPORT_GOOD) { 523 return -EIO; 524 } 525 526 return 0; 527 } 528 529 static int do_config_autodelink(struct us_data *us, int enable, int force) 530 { 531 int retval; 532 u8 value; 533 534 retval = rts51x_read_mem(us, 0xFE47, &value, 1); 535 if (retval < 0) 536 return -EIO; 537 538 if (enable) { 539 if (force) 540 value |= 0x03; 541 else 542 value |= 0x01; 543 } else { 544 value &= ~0x03; 545 } 546 547 usb_stor_dbg(us, "set 0xfe47 to 0x%x\n", value); 548 549 /* retval = rts51x_write_mem(us, 0xFE47, &value, 1); */ 550 retval = __do_config_autodelink(us, &value, 1); 551 if (retval < 0) 552 return -EIO; 553 554 return 0; 555 } 556 557 static int config_autodelink_after_power_on(struct us_data *us) 558 { 559 struct rts51x_chip *chip = (struct rts51x_chip *)(us->extra); 560 int retval; 561 u8 value; 562 563 if (!CHK_AUTO_DELINK(chip)) 564 return 0; 565 566 retval = rts51x_read_mem(us, 0xFE47, &value, 1); 567 if (retval < 0) 568 return -EIO; 569 570 if (auto_delink_en) { 571 CLR_BIT(value, 0); 572 CLR_BIT(value, 1); 573 SET_BIT(value, 2); 574 575 if (CHECK_ID(chip, 0x0138, 0x3882)) 576 CLR_BIT(value, 2); 577 578 SET_BIT(value, 7); 579 580 /* retval = rts51x_write_mem(us, 0xFE47, &value, 1); */ 581 retval = __do_config_autodelink(us, &value, 1); 582 if (retval < 0) 583 return -EIO; 584 585 retval = enable_oscillator(us); 586 if (retval == 0) 587 (void)do_config_autodelink(us, 1, 0); 588 } else { 589 /* Autodelink controlled by firmware */ 590 591 SET_BIT(value, 2); 592 593 if (CHECK_ID(chip, 0x0138, 0x3882)) 594 CLR_BIT(value, 2); 595 596 if (CHECK_ID(chip, 0x0159, 0x5889) || 597 CHECK_ID(chip, 0x0138, 0x3880)) { 598 CLR_BIT(value, 0); 599 CLR_BIT(value, 7); 600 } 601 602 /* retval = rts51x_write_mem(us, 0xFE47, &value, 1); */ 603 retval = __do_config_autodelink(us, &value, 1); 604 if (retval < 0) 605 return -EIO; 606 607 if (CHECK_ID(chip, 0x0159, 0x5888)) { 608 value = 0xFF; 609 retval = rts51x_write_mem(us, 0xFE79, &value, 1); 610 if (retval < 0) 611 return -EIO; 612 613 value = 0x01; 614 retval = rts51x_write_mem(us, 0x48, &value, 1); 615 if (retval < 0) 616 return -EIO; 617 } 618 } 619 620 return 0; 621 } 622 623 #ifdef CONFIG_PM 624 static int config_autodelink_before_power_down(struct us_data *us) 625 { 626 struct rts51x_chip *chip = (struct rts51x_chip *)(us->extra); 627 int retval; 628 u8 value; 629 630 if (!CHK_AUTO_DELINK(chip)) 631 return 0; 632 633 if (auto_delink_en) { 634 retval = rts51x_read_mem(us, 0xFE77, &value, 1); 635 if (retval < 0) 636 return -EIO; 637 638 SET_BIT(value, 2); 639 retval = rts51x_write_mem(us, 0xFE77, &value, 1); 640 if (retval < 0) 641 return -EIO; 642 643 if (CHECK_ID(chip, 0x0159, 0x5888)) { 644 value = 0x01; 645 retval = rts51x_write_mem(us, 0x48, &value, 1); 646 if (retval < 0) 647 return -EIO; 648 } 649 650 retval = rts51x_read_mem(us, 0xFE47, &value, 1); 651 if (retval < 0) 652 return -EIO; 653 654 SET_BIT(value, 0); 655 if (CHECK_ID(chip, 0x0138, 0x3882)) 656 SET_BIT(value, 2); 657 retval = rts51x_write_mem(us, 0xFE77, &value, 1); 658 if (retval < 0) 659 return -EIO; 660 } else { 661 if (CHECK_ID(chip, 0x0159, 0x5889) || 662 CHECK_ID(chip, 0x0138, 0x3880) || 663 CHECK_ID(chip, 0x0138, 0x3882)) { 664 retval = rts51x_read_mem(us, 0xFE47, &value, 1); 665 if (retval < 0) 666 return -EIO; 667 668 if (CHECK_ID(chip, 0x0159, 0x5889) || 669 CHECK_ID(chip, 0x0138, 0x3880)) { 670 SET_BIT(value, 0); 671 SET_BIT(value, 7); 672 } 673 674 if (CHECK_ID(chip, 0x0138, 0x3882)) 675 SET_BIT(value, 2); 676 677 /* retval = rts51x_write_mem(us, 0xFE47, &value, 1); */ 678 retval = __do_config_autodelink(us, &value, 1); 679 if (retval < 0) 680 return -EIO; 681 } 682 683 if (CHECK_ID(chip, 0x0159, 0x5888)) { 684 value = 0x01; 685 retval = rts51x_write_mem(us, 0x48, &value, 1); 686 if (retval < 0) 687 return -EIO; 688 } 689 } 690 691 return 0; 692 } 693 694 static void fw5895_init(struct us_data *us) 695 { 696 struct rts51x_chip *chip = (struct rts51x_chip *)(us->extra); 697 int retval; 698 u8 val; 699 700 if ((PRODUCT_ID(chip) != 0x0158) || (FW_VERSION(chip) != 0x5895)) { 701 usb_stor_dbg(us, "Not the specified device, return immediately!\n"); 702 } else { 703 retval = rts51x_read_mem(us, 0xFD6F, &val, 1); 704 if (retval == STATUS_SUCCESS && (val & 0x1F) == 0) { 705 val = 0x1F; 706 retval = rts51x_write_mem(us, 0xFD70, &val, 1); 707 if (retval != STATUS_SUCCESS) 708 usb_stor_dbg(us, "Write memory fail\n"); 709 } else { 710 usb_stor_dbg(us, "Read memory fail, OR (val & 0x1F) != 0\n"); 711 } 712 } 713 } 714 #endif 715 716 #ifdef CONFIG_REALTEK_AUTOPM 717 static void fw5895_set_mmc_wp(struct us_data *us) 718 { 719 struct rts51x_chip *chip = (struct rts51x_chip *)(us->extra); 720 int retval; 721 u8 buf[13]; 722 723 if ((PRODUCT_ID(chip) != 0x0158) || (FW_VERSION(chip) != 0x5895)) { 724 usb_stor_dbg(us, "Not the specified device, return immediately!\n"); 725 } else { 726 retval = rts51x_read_mem(us, 0xFD6F, buf, 1); 727 if (retval == STATUS_SUCCESS && (buf[0] & 0x24) == 0x24) { 728 /* SD Exist and SD WP */ 729 retval = rts51x_read_mem(us, 0xD04E, buf, 1); 730 if (retval == STATUS_SUCCESS) { 731 buf[0] |= 0x04; 732 retval = rts51x_write_mem(us, 0xFD70, buf, 1); 733 if (retval != STATUS_SUCCESS) 734 usb_stor_dbg(us, "Write memory fail\n"); 735 } else { 736 usb_stor_dbg(us, "Read memory fail\n"); 737 } 738 } else { 739 usb_stor_dbg(us, "Read memory fail, OR (buf[0]&0x24)!=0x24\n"); 740 } 741 } 742 } 743 744 static void rts51x_modi_suspend_timer(struct rts51x_chip *chip) 745 { 746 struct us_data *us = chip->us; 747 748 usb_stor_dbg(us, "state:%d\n", rts51x_get_stat(chip)); 749 750 chip->timer_expires = jiffies + msecs_to_jiffies(1000*ss_delay); 751 mod_timer(&chip->rts51x_suspend_timer, chip->timer_expires); 752 } 753 754 static void rts51x_suspend_timer_fn(struct timer_list *t) 755 { 756 struct rts51x_chip *chip = from_timer(chip, t, rts51x_suspend_timer); 757 struct us_data *us = chip->us; 758 759 switch (rts51x_get_stat(chip)) { 760 case RTS51X_STAT_INIT: 761 case RTS51X_STAT_RUN: 762 rts51x_modi_suspend_timer(chip); 763 break; 764 case RTS51X_STAT_IDLE: 765 case RTS51X_STAT_SS: 766 usb_stor_dbg(us, "RTS51X_STAT_SS, power.usage:%d\n", 767 atomic_read(&us->pusb_intf->dev.power.usage_count)); 768 769 if (atomic_read(&us->pusb_intf->dev.power.usage_count) > 0) { 770 usb_stor_dbg(us, "Ready to enter SS state\n"); 771 rts51x_set_stat(chip, RTS51X_STAT_SS); 772 /* ignore mass storage interface's children */ 773 pm_suspend_ignore_children(&us->pusb_intf->dev, true); 774 usb_autopm_put_interface_async(us->pusb_intf); 775 usb_stor_dbg(us, "RTS51X_STAT_SS 01, power.usage:%d\n", 776 atomic_read(&us->pusb_intf->dev.power.usage_count)); 777 } 778 break; 779 default: 780 usb_stor_dbg(us, "Unknown state !!!\n"); 781 break; 782 } 783 } 784 785 static inline int working_scsi(struct scsi_cmnd *srb) 786 { 787 if ((srb->cmnd[0] == TEST_UNIT_READY) || 788 (srb->cmnd[0] == ALLOW_MEDIUM_REMOVAL)) { 789 return 0; 790 } 791 792 return 1; 793 } 794 795 static void rts51x_invoke_transport(struct scsi_cmnd *srb, struct us_data *us) 796 { 797 struct rts51x_chip *chip = (struct rts51x_chip *)(us->extra); 798 static int card_first_show = 1; 799 static u8 media_not_present[] = { 0x70, 0, 0x02, 0, 0, 0, 0, 800 10, 0, 0, 0, 0, 0x3A, 0, 0, 0, 0, 0 801 }; 802 static u8 invalid_cmd_field[] = { 0x70, 0, 0x05, 0, 0, 0, 0, 803 10, 0, 0, 0, 0, 0x24, 0, 0, 0, 0, 0 804 }; 805 int ret; 806 807 if (working_scsi(srb)) { 808 usb_stor_dbg(us, "working scsi, power.usage:%d\n", 809 atomic_read(&us->pusb_intf->dev.power.usage_count)); 810 811 if (atomic_read(&us->pusb_intf->dev.power.usage_count) <= 0) { 812 ret = usb_autopm_get_interface(us->pusb_intf); 813 usb_stor_dbg(us, "working scsi, ret=%d\n", ret); 814 } 815 if (rts51x_get_stat(chip) != RTS51X_STAT_RUN) 816 rts51x_set_stat(chip, RTS51X_STAT_RUN); 817 chip->proto_handler_backup(srb, us); 818 } else { 819 if (rts51x_get_stat(chip) == RTS51X_STAT_SS) { 820 usb_stor_dbg(us, "NOT working scsi\n"); 821 if ((srb->cmnd[0] == TEST_UNIT_READY) && 822 (chip->pwr_state == US_SUSPEND)) { 823 if (TST_LUN_READY(chip, srb->device->lun)) { 824 srb->result = SAM_STAT_GOOD; 825 } else { 826 srb->result = SAM_STAT_CHECK_CONDITION; 827 memcpy(srb->sense_buffer, 828 media_not_present, 829 US_SENSE_SIZE); 830 } 831 usb_stor_dbg(us, "TEST_UNIT_READY\n"); 832 goto out; 833 } 834 if (srb->cmnd[0] == ALLOW_MEDIUM_REMOVAL) { 835 int prevent = srb->cmnd[4] & 0x1; 836 if (prevent) { 837 srb->result = SAM_STAT_CHECK_CONDITION; 838 memcpy(srb->sense_buffer, 839 invalid_cmd_field, 840 US_SENSE_SIZE); 841 } else { 842 srb->result = SAM_STAT_GOOD; 843 } 844 usb_stor_dbg(us, "ALLOW_MEDIUM_REMOVAL\n"); 845 goto out; 846 } 847 } else { 848 usb_stor_dbg(us, "NOT working scsi, not SS\n"); 849 chip->proto_handler_backup(srb, us); 850 /* Check whether card is plugged in */ 851 if (srb->cmnd[0] == TEST_UNIT_READY) { 852 if (srb->result == SAM_STAT_GOOD) { 853 SET_LUN_READY(chip, srb->device->lun); 854 if (card_first_show) { 855 card_first_show = 0; 856 fw5895_set_mmc_wp(us); 857 } 858 } else { 859 CLR_LUN_READY(chip, srb->device->lun); 860 card_first_show = 1; 861 } 862 } 863 if (rts51x_get_stat(chip) != RTS51X_STAT_IDLE) 864 rts51x_set_stat(chip, RTS51X_STAT_IDLE); 865 } 866 } 867 out: 868 usb_stor_dbg(us, "state:%d\n", rts51x_get_stat(chip)); 869 if (rts51x_get_stat(chip) == RTS51X_STAT_RUN) 870 rts51x_modi_suspend_timer(chip); 871 } 872 873 static int realtek_cr_autosuspend_setup(struct us_data *us) 874 { 875 struct rts51x_chip *chip; 876 struct rts51x_status *status = NULL; 877 u8 buf[16]; 878 int retval; 879 880 chip = (struct rts51x_chip *)us->extra; 881 chip->support_auto_delink = 0; 882 chip->pwr_state = US_RESUME; 883 chip->lun_ready = 0; 884 rts51x_set_stat(chip, RTS51X_STAT_INIT); 885 886 retval = rts51x_read_status(us, 0, buf, 16, &(chip->status_len)); 887 if (retval != STATUS_SUCCESS) { 888 usb_stor_dbg(us, "Read status fail\n"); 889 return -EIO; 890 } 891 status = chip->status; 892 status->vid = ((u16) buf[0] << 8) | buf[1]; 893 status->pid = ((u16) buf[2] << 8) | buf[3]; 894 status->cur_lun = buf[4]; 895 status->card_type = buf[5]; 896 status->total_lun = buf[6]; 897 status->fw_ver = ((u16) buf[7] << 8) | buf[8]; 898 status->phy_exist = buf[9]; 899 status->multi_flag = buf[10]; 900 status->multi_card = buf[11]; 901 status->log_exist = buf[12]; 902 if (chip->status_len == 16) { 903 status->detailed_type.detailed_type1 = buf[13]; 904 status->function[0] = buf[14]; 905 status->function[1] = buf[15]; 906 } 907 908 /* back up the proto_handler in us->extra */ 909 chip = (struct rts51x_chip *)(us->extra); 910 chip->proto_handler_backup = us->proto_handler; 911 /* Set the autosuspend_delay to 0 */ 912 pm_runtime_set_autosuspend_delay(&us->pusb_dev->dev, 0); 913 /* override us->proto_handler setted in get_protocol() */ 914 us->proto_handler = rts51x_invoke_transport; 915 916 chip->timer_expires = 0; 917 timer_setup(&chip->rts51x_suspend_timer, rts51x_suspend_timer_fn, 0); 918 fw5895_init(us); 919 920 /* enable autosuspend function of the usb device */ 921 usb_enable_autosuspend(us->pusb_dev); 922 923 return 0; 924 } 925 #endif 926 927 static void realtek_cr_destructor(void *extra) 928 { 929 struct rts51x_chip *chip = extra; 930 931 if (!chip) 932 return; 933 934 #ifdef CONFIG_REALTEK_AUTOPM 935 if (ss_en) { 936 del_timer(&chip->rts51x_suspend_timer); 937 chip->timer_expires = 0; 938 } 939 #endif 940 kfree(chip->status); 941 } 942 943 #ifdef CONFIG_PM 944 static int realtek_cr_suspend(struct usb_interface *iface, pm_message_t message) 945 { 946 struct us_data *us = usb_get_intfdata(iface); 947 948 /* wait until no command is running */ 949 mutex_lock(&us->dev_mutex); 950 951 config_autodelink_before_power_down(us); 952 953 mutex_unlock(&us->dev_mutex); 954 955 return 0; 956 } 957 958 static int realtek_cr_resume(struct usb_interface *iface) 959 { 960 struct us_data *us = usb_get_intfdata(iface); 961 962 fw5895_init(us); 963 config_autodelink_after_power_on(us); 964 965 return 0; 966 } 967 #else 968 #define realtek_cr_suspend NULL 969 #define realtek_cr_resume NULL 970 #endif 971 972 static int init_realtek_cr(struct us_data *us) 973 { 974 struct rts51x_chip *chip; 975 int size, i, retval; 976 977 chip = kzalloc(sizeof(struct rts51x_chip), GFP_KERNEL); 978 if (!chip) 979 return -ENOMEM; 980 981 us->extra = chip; 982 us->extra_destructor = realtek_cr_destructor; 983 us->max_lun = chip->max_lun = rts51x_get_max_lun(us); 984 chip->us = us; 985 986 usb_stor_dbg(us, "chip->max_lun = %d\n", chip->max_lun); 987 988 size = (chip->max_lun + 1) * sizeof(struct rts51x_status); 989 chip->status = kzalloc(size, GFP_KERNEL); 990 if (!chip->status) 991 goto INIT_FAIL; 992 993 for (i = 0; i <= (int)(chip->max_lun); i++) { 994 retval = rts51x_check_status(us, (u8) i); 995 if (retval < 0) 996 goto INIT_FAIL; 997 } 998 999 if (CHECK_FW_VER(chip, 0x5888) || CHECK_FW_VER(chip, 0x5889) || 1000 CHECK_FW_VER(chip, 0x5901)) 1001 SET_AUTO_DELINK(chip); 1002 if (STATUS_LEN(chip) == 16) { 1003 if (SUPPORT_AUTO_DELINK(chip)) 1004 SET_AUTO_DELINK(chip); 1005 } 1006 #ifdef CONFIG_REALTEK_AUTOPM 1007 if (ss_en) 1008 realtek_cr_autosuspend_setup(us); 1009 #endif 1010 1011 usb_stor_dbg(us, "chip->flag = 0x%x\n", chip->flag); 1012 1013 (void)config_autodelink_after_power_on(us); 1014 1015 return 0; 1016 1017 INIT_FAIL: 1018 if (us->extra) { 1019 kfree(chip->status); 1020 kfree(us->extra); 1021 us->extra = NULL; 1022 } 1023 1024 return -EIO; 1025 } 1026 1027 static struct scsi_host_template realtek_cr_host_template; 1028 1029 static int realtek_cr_probe(struct usb_interface *intf, 1030 const struct usb_device_id *id) 1031 { 1032 struct us_data *us; 1033 int result; 1034 1035 dev_dbg(&intf->dev, "Probe Realtek Card Reader!\n"); 1036 1037 result = usb_stor_probe1(&us, intf, id, 1038 (id - realtek_cr_ids) + 1039 realtek_cr_unusual_dev_list, 1040 &realtek_cr_host_template); 1041 if (result) 1042 return result; 1043 1044 result = usb_stor_probe2(us); 1045 1046 return result; 1047 } 1048 1049 static struct usb_driver realtek_cr_driver = { 1050 .name = DRV_NAME, 1051 .probe = realtek_cr_probe, 1052 .disconnect = usb_stor_disconnect, 1053 /* .suspend = usb_stor_suspend, */ 1054 /* .resume = usb_stor_resume, */ 1055 .reset_resume = usb_stor_reset_resume, 1056 .suspend = realtek_cr_suspend, 1057 .resume = realtek_cr_resume, 1058 .pre_reset = usb_stor_pre_reset, 1059 .post_reset = usb_stor_post_reset, 1060 .id_table = realtek_cr_ids, 1061 .soft_unbind = 1, 1062 .supports_autosuspend = 1, 1063 .no_dynamic_id = 1, 1064 }; 1065 1066 module_usb_stor_driver(realtek_cr_driver, realtek_cr_host_template, DRV_NAME); 1067