drivers/usb/storage/realtek_cr.c

   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 = kmalloc(len, GFP_NOIO);
 402         if (buf == NULL)
 403                 return USB_STOR_TRANSPORT_ERROR;
 404         memcpy(buf, data, len);
 405
 406         US_DEBUGP("%s, addr = 0x%x, len = %d\n", __func__, 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         US_DEBUGP("%s, lun = %d\n", __func__, 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 < 0)
 460                 return -EIO;
 461
 462         US_DEBUGP("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         u16 addr = 0xFE47;
 511         u8 cmnd[12] = {0};
 512         u8 *buf;
 513
 514         US_DEBUGP("%s, addr = 0x%x, len = %d\n", __FUNCTION__, addr, len);
 515
 516         buf = kmemdup(data, len, GFP_NOIO);
 517         if (!buf)
 518                 return USB_STOR_TRANSPORT_ERROR;
 519
 520         cmnd[0] = 0xF0;
 521         cmnd[1] = 0x0E;
 522         cmnd[2] = (u8)(addr >> 8);
 523         cmnd[3] = (u8)addr;
 524         cmnd[4] = (u8)(len >> 8);
 525         cmnd[5] = (u8)len;
 526
 527         retval = rts51x_bulk_transport_special(us, 0, cmnd, 12, buf, len, DMA_TO_DEVICE, NULL);
 528         kfree(buf);
 529         if (retval != USB_STOR_TRANSPORT_GOOD) {
 530                 return -EIO;
 531         }
 532
 533         return 0;
 534 }
 535
 536 static int do_config_autodelink(struct us_data *us, int enable, int force)
 537 {
 538         int retval;
 539         u8 value;
 540
 541         retval = rts51x_read_mem(us, 0xFE47, &value, 1);
 542         if (retval < 0)
 543                 return -EIO;
 544
 545         if (enable) {
 546                 if (force)
 547                         value |= 0x03;
 548                 else
 549                         value |= 0x01;
 550         } else {
 551                 value &= ~0x03;
 552         }
 553
 554         US_DEBUGP("In %s,set 0xfe47 to 0x%x\n", __func__, value);
 555
 556         /* retval = rts51x_write_mem(us, 0xFE47, &value, 1); */
 557         retval = __do_config_autodelink(us, &value, 1);
 558         if (retval < 0)
 559                 return -EIO;
 560
 561         return 0;
 562 }
 563
 564 static int config_autodelink_after_power_on(struct us_data *us)
 565 {
 566         struct rts51x_chip *chip = (struct rts51x_chip *)(us->extra);
 567         int retval;
 568         u8 value;
 569
 570         US_DEBUGP("%s: <---\n", __func__);
 571
 572         if (!CHK_AUTO_DELINK(chip))
 573                 return 0;
 574
 575         retval = rts51x_read_mem(us, 0xFE47, &value, 1);
 576         if (retval < 0)
 577                 return -EIO;
 578
 579         if (auto_delink_en) {
 580                 CLR_BIT(value, 0);
 581                 CLR_BIT(value, 1);
 582                 SET_BIT(value, 2);
 583
 584                 if (CHECK_ID(chip, 0x0138, 0x3882))
 585                         CLR_BIT(value, 2);
 586
 587                 SET_BIT(value, 7);
 588
 589                 /* retval = rts51x_write_mem(us, 0xFE47, &value, 1); */
 590                 retval = __do_config_autodelink(us, &value, 1);
 591                 if (retval < 0)
 592                         return -EIO;
 593
 594                 retval = enable_oscillator(us);
 595                 if (retval == 0)
 596                         (void)do_config_autodelink(us, 1, 0);
 597         } else {
 598                 /* Autodelink controlled by firmware */
 599
 600                 SET_BIT(value, 2);
 601
 602                 if (CHECK_ID(chip, 0x0138, 0x3882))
 603                         CLR_BIT(value, 2);
 604
 605                 if (CHECK_ID(chip, 0x0159, 0x5889) ||
 606                     CHECK_ID(chip, 0x0138, 0x3880)) {
 607                         CLR_BIT(value, 0);
 608                         CLR_BIT(value, 7);
 609                 }
 610
 611                 /* retval = rts51x_write_mem(us, 0xFE47, &value, 1); */
 612                 retval = __do_config_autodelink(us, &value, 1);
 613                 if (retval < 0)
 614                         return -EIO;
 615
 616                 if (CHECK_ID(chip, 0x0159, 0x5888)) {
 617                         value = 0xFF;
 618                         retval = rts51x_write_mem(us, 0xFE79, &value, 1);
 619                         if (retval < 0)
 620                                 return -EIO;
 621
 622                         value = 0x01;
 623                         retval = rts51x_write_mem(us, 0x48, &value, 1);
 624                         if (retval < 0)
 625                                 return -EIO;
 626                 }
 627         }
 628
 629         US_DEBUGP("%s: --->\n", __func__);
 630
 631         return 0;
 632 }
 633
 634 static int config_autodelink_before_power_down(struct us_data *us)
 635 {
 636         struct rts51x_chip *chip = (struct rts51x_chip *)(us->extra);
 637         int retval;
 638         u8 value;
 639
 640         US_DEBUGP("%s: <---\n", __func__);
 641
 642         if (!CHK_AUTO_DELINK(chip))
 643                 return 0;
 644
 645         if (auto_delink_en) {
 646                 retval = rts51x_read_mem(us, 0xFE77, &value, 1);
 647                 if (retval < 0)
 648                         return -EIO;
 649
 650                 SET_BIT(value, 2);
 651                 retval = rts51x_write_mem(us, 0xFE77, &value, 1);
 652                 if (retval < 0)
 653                         return -EIO;
 654
 655                 if (CHECK_ID(chip, 0x0159, 0x5888)) {
 656                         value = 0x01;
 657                         retval = rts51x_write_mem(us, 0x48, &value, 1);
 658                         if (retval < 0)
 659                                 return -EIO;
 660                 }
 661
 662                 retval = rts51x_read_mem(us, 0xFE47, &value, 1);
 663                 if (retval < 0)
 664                         return -EIO;
 665
 666                 SET_BIT(value, 0);
 667                 if (CHECK_ID(chip, 0x0138, 0x3882))
 668                         SET_BIT(value, 2);
 669                 retval = rts51x_write_mem(us, 0xFE77, &value, 1);
 670                 if (retval < 0)
 671                         return -EIO;
 672         } else {
 673                 if (CHECK_ID(chip, 0x0159, 0x5889) ||
 674                     CHECK_ID(chip, 0x0138, 0x3880) ||
 675                     CHECK_ID(chip, 0x0138, 0x3882)) {
 676                         retval = rts51x_read_mem(us, 0xFE47, &value, 1);
 677                         if (retval < 0)
 678                                 return -EIO;
 679
 680                         if (CHECK_ID(chip, 0x0159, 0x5889) ||
 681                             CHECK_ID(chip, 0x0138, 0x3880)) {
 682                                 SET_BIT(value, 0);
 683                                 SET_BIT(value, 7);
 684                         }
 685
 686                         if (CHECK_ID(chip, 0x0138, 0x3882))
 687                                 SET_BIT(value, 2);
 688
 689                         /* retval = rts51x_write_mem(us, 0xFE47, &value, 1); */
 690                         retval = __do_config_autodelink(us, &value, 1);
 691                         if (retval < 0)
 692                                 return -EIO;
 693                 }
 694
 695                 if (CHECK_ID(chip, 0x0159, 0x5888)) {
 696                         value = 0x01;
 697                         retval = rts51x_write_mem(us, 0x48, &value, 1);
 698                         if (retval < 0)
 699                                 return -EIO;
 700                 }
 701         }
 702
 703         US_DEBUGP("%s: --->\n", __func__);
 704
 705         return 0;
 706 }
 707
 708 static void fw5895_init(struct us_data *us)
 709 {
 710         struct rts51x_chip *chip = (struct rts51x_chip *)(us->extra);
 711         int retval;
 712         u8 val;
 713
 714         US_DEBUGP("%s: <---\n", __func__);
 715
 716         if ((PRODUCT_ID(chip) != 0x0158) || (FW_VERSION(chip) != 0x5895)) {
 717                 US_DEBUGP("Not the specified device, return immediately!\n");
 718         } else {
 719                 retval = rts51x_read_mem(us, 0xFD6F, &val, 1);
 720                 if (retval == STATUS_SUCCESS && (val & 0x1F) == 0) {
 721                         val = 0x1F;
 722                         retval = rts51x_write_mem(us, 0xFD70, &val, 1);
 723                         if (retval != STATUS_SUCCESS)
 724                                 US_DEBUGP("Write memory fail\n");
 725                 } else {
 726                         US_DEBUGP("Read memory fail, OR (val & 0x1F) != 0\n");
 727                 }
 728         }
 729
 730         US_DEBUGP("%s: --->\n", __func__);
 731 }
 732
 733 #ifdef CONFIG_REALTEK_AUTOPM
 734 static void fw5895_set_mmc_wp(struct us_data *us)
 735 {
 736         struct rts51x_chip *chip = (struct rts51x_chip *)(us->extra);
 737         int retval;
 738         u8 buf[13];
 739
 740         US_DEBUGP("%s: <---\n", __func__);
 741
 742         if ((PRODUCT_ID(chip) != 0x0158) || (FW_VERSION(chip) != 0x5895)) {
 743                 US_DEBUGP("Not the specified device, return immediately!\n");
 744         } else {
 745                 retval = rts51x_read_mem(us, 0xFD6F, buf, 1);
 746                 if (retval == STATUS_SUCCESS && (buf[0] & 0x24) == 0x24) {
 747                         /* SD Exist and SD WP */
 748                         retval = rts51x_read_mem(us, 0xD04E, buf, 1);
 749                         if (retval == STATUS_SUCCESS) {
 750                                 buf[0] |= 0x04;
 751                                 retval = rts51x_write_mem(us, 0xFD70, buf, 1);
 752                                 if (retval != STATUS_SUCCESS)
 753                                         US_DEBUGP("Write memory fail\n");
 754                         } else {
 755                                 US_DEBUGP("Read memory fail\n");
 756                         }
 757                 } else {
 758                         US_DEBUGP("Read memory fail, OR (buf[0]&0x24)!=0x24\n");
 759                 }
 760         }
 761
 762         US_DEBUGP("%s: --->\n", __func__);
 763 }
 764
 765 static void rts51x_modi_suspend_timer(struct rts51x_chip *chip)
 766 {
 767         US_DEBUGP("%s: <---, state:%d\n", __func__, rts51x_get_stat(chip));
 768
 769         chip->timer_expires = jiffies + msecs_to_jiffies(1000*ss_delay);
 770         mod_timer(&chip->rts51x_suspend_timer, chip->timer_expires);
 771
 772         US_DEBUGP("%s: --->\n", __func__);
 773 }
 774
 775 static void rts51x_suspend_timer_fn(unsigned long data)
 776 {
 777         struct rts51x_chip *chip = (struct rts51x_chip *)data;
 778         struct us_data *us = chip->us;
 779
 780         US_DEBUGP("%s: <---\n", __func__);
 781
 782         switch (rts51x_get_stat(chip)) {
 783         case RTS51X_STAT_INIT:
 784         case RTS51X_STAT_RUN:
 785                 rts51x_modi_suspend_timer(chip);
 786                 break;
 787         case RTS51X_STAT_IDLE:
 788         case RTS51X_STAT_SS:
 789                 US_DEBUGP("%s: RTS51X_STAT_SS, intf->pm_usage_cnt:%d,"
 790                         "power.usage:%d\n", __func__,
 791                         atomic_read(&us->pusb_intf->pm_usage_cnt),
 792                         atomic_read(&us->pusb_intf->dev.power.usage_count));
 793
 794                 if (atomic_read(&us->pusb_intf->pm_usage_cnt) > 0) {
 795                         US_DEBUGP("%s: Ready to enter SS state.\n",
 796                                   __func__);
 797                         rts51x_set_stat(chip, RTS51X_STAT_SS);
 798                         /* ignore mass storage interface's children */
 799                         pm_suspend_ignore_children(&us->pusb_intf->dev, true);
 800                         usb_autopm_put_interface_async(us->pusb_intf);
 801                         US_DEBUGP("%s: RTS51X_STAT_SS 01,"
 802                                 "intf->pm_usage_cnt:%d, power.usage:%d\n",
 803                                 __func__,
 804                                 atomic_read(&us->pusb_intf->pm_usage_cnt),
 805                                 atomic_read(
 806                                         &us->pusb_intf->dev.power.usage_count));
 807                 }
 808                 break;
 809         default:
 810                 US_DEBUGP("%s: Unknonwn state !!!\n", __func__);
 811                 break;
 812         }
 813
 814         US_DEBUGP("%s: --->\n", __func__);
 815 }
 816
 817 static inline int working_scsi(struct scsi_cmnd *srb)
 818 {
 819         if ((srb->cmnd[0] == TEST_UNIT_READY) ||
 820             (srb->cmnd[0] == ALLOW_MEDIUM_REMOVAL)) {
 821                 return 0;
 822         }
 823
 824         return 1;
 825 }
 826
 827 void rts51x_invoke_transport(struct scsi_cmnd *srb, struct us_data *us)
 828 {
 829         struct rts51x_chip *chip = (struct rts51x_chip *)(us->extra);
 830         static int card_first_show = 1;
 831         static u8 media_not_present[] = { 0x70, 0, 0x02, 0, 0, 0, 0,
 832                 10, 0, 0, 0, 0, 0x3A, 0, 0, 0, 0, 0
 833         };
 834         static u8 invalid_cmd_field[] = { 0x70, 0, 0x05, 0, 0, 0, 0,
 835                 10, 0, 0, 0, 0, 0x24, 0, 0, 0, 0, 0
 836         };
 837         int ret;
 838
 839         US_DEBUGP("%s: <---\n", __func__);
 840
 841         if (working_scsi(srb)) {
 842                 US_DEBUGP("%s: working scsi, intf->pm_usage_cnt:%d,"
 843                         "power.usage:%d\n", __func__,
 844                         atomic_read(&us->pusb_intf->pm_usage_cnt),
 845                         atomic_read(&us->pusb_intf->dev.power.usage_count));
 846
 847                 if (atomic_read(&us->pusb_intf->pm_usage_cnt) <= 0) {
 848                         ret = usb_autopm_get_interface(us->pusb_intf);
 849                         US_DEBUGP("%s: working scsi, ret=%d\n", __func__, ret);
 850                 }
 851                 if (rts51x_get_stat(chip) != RTS51X_STAT_RUN)
 852                         rts51x_set_stat(chip, RTS51X_STAT_RUN);
 853                 chip->proto_handler_backup(srb, us);
 854         } else {
 855                 if (rts51x_get_stat(chip) == RTS51X_STAT_SS) {
 856                         US_DEBUGP("%s: NOT working scsi\n", __func__);
 857                         if ((srb->cmnd[0] == TEST_UNIT_READY) &&
 858                             (chip->pwr_state == US_SUSPEND)) {
 859                                 if (TST_LUN_READY(chip, srb->device->lun)) {
 860                                         srb->result = SAM_STAT_GOOD;
 861                                 } else {
 862                                         srb->result = SAM_STAT_CHECK_CONDITION;
 863                                         memcpy(srb->sense_buffer,
 864                                                media_not_present,
 865                                                US_SENSE_SIZE);
 866                                 }
 867                                 US_DEBUGP("%s: TEST_UNIT_READY--->\n",
 868                                           __func__);
 869                                 goto out;
 870                         }
 871                         if (srb->cmnd[0] == ALLOW_MEDIUM_REMOVAL) {
 872                                 int prevent = srb->cmnd[4] & 0x1;
 873                                 if (prevent) {
 874                                         srb->result = SAM_STAT_CHECK_CONDITION;
 875                                         memcpy(srb->sense_buffer,
 876                                                invalid_cmd_field,
 877                                                US_SENSE_SIZE);
 878                                 } else {
 879                                         srb->result = SAM_STAT_GOOD;
 880                                 }
 881                                 US_DEBUGP("%s: ALLOW_MEDIUM_REMOVAL--->\n",
 882                                           __func__);
 883                                 goto out;
 884                         }
 885                 } else {
 886                         US_DEBUGP("%s: NOT working scsi, not SS\n", __func__);
 887                         chip->proto_handler_backup(srb, us);
 888                         /* Check wether card is plugged in */
 889                         if (srb->cmnd[0] == TEST_UNIT_READY) {
 890                                 if (srb->result == SAM_STAT_GOOD) {
 891                                         SET_LUN_READY(chip, srb->device->lun);
 892                                         if (card_first_show) {
 893                                                 card_first_show = 0;
 894                                                 fw5895_set_mmc_wp(us);
 895                                         }
 896                                 } else {
 897                                         CLR_LUN_READY(chip, srb->device->lun);
 898                                         card_first_show = 1;
 899                                 }
 900                         }
 901                         if (rts51x_get_stat(chip) != RTS51X_STAT_IDLE)
 902                                 rts51x_set_stat(chip, RTS51X_STAT_IDLE);
 903                 }
 904         }
 905 out:
 906         US_DEBUGP("%s: state:%d\n", __func__, rts51x_get_stat(chip));
 907         if (rts51x_get_stat(chip) == RTS51X_STAT_RUN)
 908                 rts51x_modi_suspend_timer(chip);
 909
 910         US_DEBUGP("%s: --->\n", __func__);
 911 }
 912
 913 static int realtek_cr_autosuspend_setup(struct us_data *us)
 914 {
 915         struct rts51x_chip *chip;
 916         struct rts51x_status *status = NULL;
 917         u8 buf[16];
 918         int retval;
 919
 920         chip = (struct rts51x_chip *)us->extra;
 921         chip->support_auto_delink = 0;
 922         chip->pwr_state = US_RESUME;
 923         chip->lun_ready = 0;
 924         rts51x_set_stat(chip, RTS51X_STAT_INIT);
 925
 926         retval = rts51x_read_status(us, 0, buf, 16, &(chip->status_len));
 927         if (retval != STATUS_SUCCESS) {
 928                 US_DEBUGP("Read status fail\n");
 929                 return -EIO;
 930         }
 931         status = chip->status;
 932         status->vid = ((u16) buf[0] << 8) | buf[1];
 933         status->pid = ((u16) buf[2] << 8) | buf[3];
 934         status->cur_lun = buf[4];
 935         status->card_type = buf[5];
 936         status->total_lun = buf[6];
 937         status->fw_ver = ((u16) buf[7] << 8) | buf[8];
 938         status->phy_exist = buf[9];
 939         status->multi_flag = buf[10];
 940         status->multi_card = buf[11];
 941         status->log_exist = buf[12];
 942         if (chip->status_len == 16) {
 943                 status->detailed_type.detailed_type1 = buf[13];
 944                 status->function[0] = buf[14];
 945                 status->function[1] = buf[15];
 946         }
 947
 948         /* back up the proto_handler in us->extra */
 949         chip = (struct rts51x_chip *)(us->extra);
 950         chip->proto_handler_backup = us->proto_handler;
 951         /* Set the autosuspend_delay to 0 */
 952         pm_runtime_set_autosuspend_delay(&us->pusb_dev->dev, 0);
 953         /* override us->proto_handler setted in get_protocol() */
 954         us->proto_handler = rts51x_invoke_transport;
 955
 956         chip->timer_expires = 0;
 957         setup_timer(&chip->rts51x_suspend_timer, rts51x_suspend_timer_fn,
 958                         (unsigned long)chip);
 959         fw5895_init(us);
 960
 961         /* enable autosuspend funciton of the usb device */
 962         usb_enable_autosuspend(us->pusb_dev);
 963
 964         return 0;
 965 }
 966 #endif
 967
 968 static void realtek_cr_destructor(void *extra)
 969 {
 970         struct rts51x_chip *chip = (struct rts51x_chip *)extra;
 971
 972         US_DEBUGP("%s: <---\n", __func__);
 973
 974         if (!chip)
 975                 return;
 976 #ifdef CONFIG_REALTEK_AUTOPM
 977         if (ss_en) {
 978                 del_timer(&chip->rts51x_suspend_timer);
 979                 chip->timer_expires = 0;
 980         }
 981 #endif
 982         kfree(chip->status);
 983 }
 984
 985 #ifdef CONFIG_PM
 986 int realtek_cr_suspend(struct usb_interface *iface, pm_message_t message)
 987 {
 988         struct us_data *us = usb_get_intfdata(iface);
 989
 990         US_DEBUGP("%s: <---\n", __func__);
 991
 992         /* wait until no command is running */
 993         mutex_lock(&us->dev_mutex);
 994
 995         config_autodelink_before_power_down(us);
 996
 997         mutex_unlock(&us->dev_mutex);
 998
 999         US_DEBUGP("%s: --->\n", __func__);
1000
1001         return 0;
1002 }
1003
1004 static int realtek_cr_resume(struct usb_interface *iface)
1005 {
1006         struct us_data *us = usb_get_intfdata(iface);
1007
1008         US_DEBUGP("%s: <---\n", __func__);
1009
1010         fw5895_init(us);
1011         config_autodelink_after_power_on(us);
1012
1013         US_DEBUGP("%s: --->\n", __func__);
1014
1015         return 0;
1016 }
1017 #else
1018 #define realtek_cr_suspend      NULL
1019 #define realtek_cr_resume       NULL
1020 #endif
1021
1022 static int init_realtek_cr(struct us_data *us)
1023 {
1024         struct rts51x_chip *chip;
1025         int size, i, retval;
1026
1027         chip = kzalloc(sizeof(struct rts51x_chip), GFP_KERNEL);
1028         if (!chip)
1029                 return -ENOMEM;
1030
1031         us->extra = chip;
1032         us->extra_destructor = realtek_cr_destructor;
1033         us->max_lun = chip->max_lun = rts51x_get_max_lun(us);
1034
1035         US_DEBUGP("chip->max_lun = %d\n", chip->max_lun);
1036
1037         size = (chip->max_lun + 1) * sizeof(struct rts51x_status);
1038         chip->status = kzalloc(size, GFP_KERNEL);
1039         if (!chip->status)
1040                 goto INIT_FAIL;
1041
1042         for (i = 0; i <= (int)(chip->max_lun); i++) {
1043                 retval = rts51x_check_status(us, (u8) i);
1044                 if (retval < 0)
1045                         goto INIT_FAIL;
1046         }
1047
1048         if (CHECK_FW_VER(chip, 0x5888) || CHECK_FW_VER(chip, 0x5889) ||
1049             CHECK_FW_VER(chip, 0x5901))
1050                 SET_AUTO_DELINK(chip);
1051         if (STATUS_LEN(chip) == 16) {
1052                 if (SUPPORT_AUTO_DELINK(chip))
1053                         SET_AUTO_DELINK(chip);
1054         }
1055 #ifdef CONFIG_REALTEK_AUTOPM
1056         if (ss_en) {
1057                 chip->us = us;
1058                 realtek_cr_autosuspend_setup(us);
1059         }
1060 #endif
1061
1062         US_DEBUGP("chip->flag = 0x%x\n", chip->flag);
1063
1064         (void)config_autodelink_after_power_on(us);
1065
1066         return 0;
1067
1068 INIT_FAIL:
1069         if (us->extra) {
1070                 kfree(chip->status);
1071                 kfree(us->extra);
1072                 us->extra = NULL;
1073         }
1074
1075         return -EIO;
1076 }
1077
1078 static int realtek_cr_probe(struct usb_interface *intf,
1079                             const struct usb_device_id *id)
1080 {
1081         struct us_data *us;
1082         int result;
1083
1084         US_DEBUGP("Probe Realtek Card Reader!\n");
1085
1086         result = usb_stor_probe1(&us, intf, id,
1087                                  (id - realtek_cr_ids) +
1088                                  realtek_cr_unusual_dev_list);
1089         if (result)
1090                 return result;
1091
1092         result = usb_stor_probe2(us);
1093
1094         return result;
1095 }
1096
1097 static struct usb_driver realtek_cr_driver = {
1098         .name = "ums-realtek",
1099         .probe = realtek_cr_probe,
1100         .disconnect = usb_stor_disconnect,
1101         /* .suspend =      usb_stor_suspend, */
1102         /* .resume =       usb_stor_resume, */
1103         .reset_resume = usb_stor_reset_resume,
1104         .suspend = realtek_cr_suspend,
1105         .resume = realtek_cr_resume,
1106         .pre_reset = usb_stor_pre_reset,
1107         .post_reset = usb_stor_post_reset,
1108         .id_table = realtek_cr_ids,
1109         .soft_unbind = 1,
1110         .supports_autosuspend = 1,
1111 };
1112
1113 static int __init realtek_cr_init(void)
1114 {
1115         return usb_register(&realtek_cr_driver);
1116 }
1117
1118 static void __exit realtek_cr_exit(void)
1119 {
1120         usb_deregister(&realtek_cr_driver);
1121 }
1122
1123 module_init(realtek_cr_init);
1124 module_exit(realtek_cr_exit);