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