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