drivers/usb/storage/realtek_cr.c

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