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 /* Determine what the maximum LUN supported is */
 296 static int rts51x_get_max_lun(struct us_data *us)
 297 {
 298         int result;
 299
 300         /* issue the command */
 301         us->iobuf[0] = 0;
 302         result = usb_stor_control_msg(us, us->recv_ctrl_pipe,
 303                                       US_BULK_GET_MAX_LUN,
 304                                       USB_DIR_IN | USB_TYPE_CLASS |
 305                                       USB_RECIP_INTERFACE,
 306                                       0, us->ifnum, us->iobuf, 1, 10 * HZ);
 307
 308         US_DEBUGP("GetMaxLUN command result is %d, data is %d\n",
 309                   result, us->iobuf[0]);
 310
 311         /* if we have a successful request, return the result */
 312         if (result > 0)
 313                 return us->iobuf[0];
 314
 315         return 0;
 316 }
 317
 318 static int rts51x_read_mem(struct us_data *us, u16 addr, u8 *data, u16 len)
 319 {
 320         int retval;
 321         u8 cmnd[12] = { 0 };
 322
 323         US_DEBUGP("%s, addr = 0x%x, len = %d\n", __func__, addr, len);
 324
 325         cmnd[0] = 0xF0;
 326         cmnd[1] = 0x0D;
 327         cmnd[2] = (u8) (addr >> 8);
 328         cmnd[3] = (u8) addr;
 329         cmnd[4] = (u8) (len >> 8);
 330         cmnd[5] = (u8) len;
 331
 332         retval = rts51x_bulk_transport(us, 0, cmnd, 12,
 333                                        data, len, DMA_FROM_DEVICE, NULL);
 334         if (retval != USB_STOR_TRANSPORT_GOOD)
 335                 return -EIO;
 336
 337         return 0;
 338 }
 339
 340 static int rts51x_write_mem(struct us_data *us, u16 addr, u8 *data, u16 len)
 341 {
 342         int retval;
 343         u8 cmnd[12] = { 0 };
 344
 345         US_DEBUGP("%s, addr = 0x%x, len = %d\n", __func__, addr, len);
 346
 347         cmnd[0] = 0xF0;
 348         cmnd[1] = 0x0E;
 349         cmnd[2] = (u8) (addr >> 8);
 350         cmnd[3] = (u8) addr;
 351         cmnd[4] = (u8) (len >> 8);
 352         cmnd[5] = (u8) len;
 353
 354         retval = rts51x_bulk_transport(us, 0, cmnd, 12,
 355                                        data, len, DMA_TO_DEVICE, NULL);
 356         if (retval != USB_STOR_TRANSPORT_GOOD)
 357                 return -EIO;
 358
 359         return 0;
 360 }
 361
 362 static int rts51x_read_status(struct us_data *us,
 363                               u8 lun, u8 *status, int len, int *actlen)
 364 {
 365         int retval;
 366         u8 cmnd[12] = { 0 };
 367
 368         US_DEBUGP("%s, lun = %d\n", __func__, lun);
 369
 370         cmnd[0] = 0xF0;
 371         cmnd[1] = 0x09;
 372
 373         retval = rts51x_bulk_transport(us, lun, cmnd, 12,
 374                                        status, len, DMA_FROM_DEVICE, actlen);
 375         if (retval != USB_STOR_TRANSPORT_GOOD)
 376                 return -EIO;
 377
 378         return 0;
 379 }
 380
 381 static int rts51x_check_status(struct us_data *us, u8 lun)
 382 {
 383         struct rts51x_chip *chip = (struct rts51x_chip *)(us->extra);
 384         int retval;
 385         u8 buf[16];
 386
 387         retval = rts51x_read_status(us, lun, buf, 16, &(chip->status_len));
 388         if (retval < 0)
 389                 return -EIO;
 390
 391         US_DEBUGP("chip->status_len = %d\n", chip->status_len);
 392
 393         chip->status[lun].vid = ((u16) buf[0] << 8) | buf[1];
 394         chip->status[lun].pid = ((u16) buf[2] << 8) | buf[3];
 395         chip->status[lun].cur_lun = buf[4];
 396         chip->status[lun].card_type = buf[5];
 397         chip->status[lun].total_lun = buf[6];
 398         chip->status[lun].fw_ver = ((u16) buf[7] << 8) | buf[8];
 399         chip->status[lun].phy_exist = buf[9];
 400         chip->status[lun].multi_flag = buf[10];
 401         chip->status[lun].multi_card = buf[11];
 402         chip->status[lun].log_exist = buf[12];
 403         if (chip->status_len == 16) {
 404                 chip->status[lun].detailed_type.detailed_type1 = buf[13];
 405                 chip->status[lun].function[0] = buf[14];
 406                 chip->status[lun].function[1] = buf[15];
 407         }
 408
 409         return 0;
 410 }
 411
 412 static int enable_oscillator(struct us_data *us)
 413 {
 414         int retval;
 415         u8 value;
 416
 417         retval = rts51x_read_mem(us, 0xFE77, &value, 1);
 418         if (retval < 0)
 419                 return -EIO;
 420
 421         value |= 0x04;
 422         retval = rts51x_write_mem(us, 0xFE77, &value, 1);
 423         if (retval < 0)
 424                 return -EIO;
 425
 426         retval = rts51x_read_mem(us, 0xFE77, &value, 1);
 427         if (retval < 0)
 428                 return -EIO;
 429
 430         if (!(value & 0x04))
 431                 return -EIO;
 432
 433         return 0;
 434 }
 435
 436 static int do_config_autodelink(struct us_data *us, int enable, int force)
 437 {
 438         int retval;
 439         u8 value;
 440
 441         retval = rts51x_read_mem(us, 0xFE47, &value, 1);
 442         if (retval < 0)
 443                 return -EIO;
 444
 445         if (enable) {
 446                 if (force)
 447                         value |= 0x03;
 448                 else
 449                         value |= 0x01;
 450         } else {
 451                 value &= ~0x03;
 452         }
 453
 454         US_DEBUGP("In %s,set 0xfe47 to 0x%x\n", __func__, value);
 455
 456         retval = rts51x_write_mem(us, 0xFE47, &value, 1);
 457         if (retval < 0)
 458                 return -EIO;
 459
 460         return 0;
 461 }
 462
 463 static int config_autodelink_after_power_on(struct us_data *us)
 464 {
 465         struct rts51x_chip *chip = (struct rts51x_chip *)(us->extra);
 466         int retval;
 467         u8 value;
 468
 469         US_DEBUGP("%s: <---\n", __func__);
 470
 471         if (!CHK_AUTO_DELINK(chip))
 472                 return 0;
 473
 474         retval = rts51x_read_mem(us, 0xFE47, &value, 1);
 475         if (retval < 0)
 476                 return -EIO;
 477
 478         if (auto_delink_en) {
 479                 CLR_BIT(value, 0);
 480                 CLR_BIT(value, 1);
 481                 SET_BIT(value, 2);
 482
 483                 if (CHECK_ID(chip, 0x0138, 0x3882))
 484                         CLR_BIT(value, 2);
 485
 486                 SET_BIT(value, 7);
 487
 488                 retval = rts51x_write_mem(us, 0xFE47, &value, 1);
 489                 if (retval < 0)
 490                         return -EIO;
 491
 492                 retval = enable_oscillator(us);
 493                 if (retval == 0)
 494                         (void)do_config_autodelink(us, 1, 0);
 495         } else {
 496                 /* Autodelink controlled by firmware */
 497
 498                 SET_BIT(value, 2);
 499
 500                 if (CHECK_ID(chip, 0x0138, 0x3882))
 501                         CLR_BIT(value, 2);
 502
 503                 if (CHECK_ID(chip, 0x0159, 0x5889) ||
 504                     CHECK_ID(chip, 0x0138, 0x3880)) {
 505                         CLR_BIT(value, 0);
 506                         CLR_BIT(value, 7);
 507                 }
 508
 509                 retval = rts51x_write_mem(us, 0xFE47, &value, 1);
 510                 if (retval < 0)
 511                         return -EIO;
 512
 513                 if (CHECK_ID(chip, 0x0159, 0x5888)) {
 514                         value = 0xFF;
 515                         retval = rts51x_write_mem(us, 0xFE79, &value, 1);
 516                         if (retval < 0)
 517                                 return -EIO;
 518
 519                         value = 0x01;
 520                         retval = rts51x_write_mem(us, 0x48, &value, 1);
 521                         if (retval < 0)
 522                                 return -EIO;
 523                 }
 524         }
 525
 526         US_DEBUGP("%s: --->\n", __func__);
 527
 528         return 0;
 529 }
 530
 531 static int config_autodelink_before_power_down(struct us_data *us)
 532 {
 533         struct rts51x_chip *chip = (struct rts51x_chip *)(us->extra);
 534         int retval;
 535         u8 value;
 536
 537         US_DEBUGP("%s: <---\n", __func__);
 538
 539         if (!CHK_AUTO_DELINK(chip))
 540                 return 0;
 541
 542         if (auto_delink_en) {
 543                 retval = rts51x_read_mem(us, 0xFE77, &value, 1);
 544                 if (retval < 0)
 545                         return -EIO;
 546
 547                 SET_BIT(value, 2);
 548                 retval = rts51x_write_mem(us, 0xFE77, &value, 1);
 549                 if (retval < 0)
 550                         return -EIO;
 551
 552                 if (CHECK_ID(chip, 0x0159, 0x5888)) {
 553                         value = 0x01;
 554                         retval = rts51x_write_mem(us, 0x48, &value, 1);
 555                         if (retval < 0)
 556                                 return -EIO;
 557                 }
 558
 559                 retval = rts51x_read_mem(us, 0xFE47, &value, 1);
 560                 if (retval < 0)
 561                         return -EIO;
 562
 563                 SET_BIT(value, 0);
 564                 if (CHECK_ID(chip, 0x0138, 0x3882))
 565                         SET_BIT(value, 2);
 566                 retval = rts51x_write_mem(us, 0xFE77, &value, 1);
 567                 if (retval < 0)
 568                         return -EIO;
 569         } else {
 570                 if (CHECK_ID(chip, 0x0159, 0x5889) ||
 571                     CHECK_ID(chip, 0x0138, 0x3880) ||
 572                     CHECK_ID(chip, 0x0138, 0x3882)) {
 573                         retval = rts51x_read_mem(us, 0xFE47, &value, 1);
 574                         if (retval < 0)
 575                                 return -EIO;
 576
 577                         if (CHECK_ID(chip, 0x0159, 0x5889) ||
 578                             CHECK_ID(chip, 0x0138, 0x3880)) {
 579                                 SET_BIT(value, 0);
 580                                 SET_BIT(value, 7);
 581                         }
 582
 583                         if (CHECK_ID(chip, 0x0138, 0x3882))
 584                                 SET_BIT(value, 2);
 585
 586                         retval = rts51x_write_mem(us, 0xFE47, &value, 1);
 587                         if (retval < 0)
 588                                 return -EIO;
 589                 }
 590
 591                 if (CHECK_ID(chip, 0x0159, 0x5888)) {
 592                         value = 0x01;
 593                         retval = rts51x_write_mem(us, 0x48, &value, 1);
 594                         if (retval < 0)
 595                                 return -EIO;
 596                 }
 597         }
 598
 599         US_DEBUGP("%s: --->\n", __func__);
 600
 601         return 0;
 602 }
 603
 604 static void fw5895_init(struct us_data *us)
 605 {
 606         struct rts51x_chip *chip = (struct rts51x_chip *)(us->extra);
 607         int retval;
 608         u8 val;
 609
 610         US_DEBUGP("%s: <---\n", __func__);
 611
 612         if ((PRODUCT_ID(chip) != 0x0158) || (FW_VERSION(chip) != 0x5895)) {
 613                 US_DEBUGP("Not the specified device, return immediately!\n");
 614         } else {
 615                 retval = rts51x_read_mem(us, 0xFD6F, &val, 1);
 616                 if (retval == STATUS_SUCCESS && (val & 0x1F) == 0) {
 617                         val = 0x1F;
 618                         retval = rts51x_write_mem(us, 0xFD70, &val, 1);
 619                         if (retval != STATUS_SUCCESS)
 620                                 US_DEBUGP("Write memory fail\n");
 621                 } else {
 622                         US_DEBUGP("Read memory fail, OR (val & 0x1F) != 0\n");
 623                 }
 624         }
 625
 626         US_DEBUGP("%s: --->\n", __func__);
 627 }
 628
 629 #ifdef CONFIG_REALTEK_AUTOPM
 630 static void fw5895_set_mmc_wp(struct us_data *us)
 631 {
 632         struct rts51x_chip *chip = (struct rts51x_chip *)(us->extra);
 633         int retval;
 634         u8 buf[13];
 635
 636         US_DEBUGP("%s: <---\n", __func__);
 637
 638         if ((PRODUCT_ID(chip) != 0x0158) || (FW_VERSION(chip) != 0x5895)) {
 639                 US_DEBUGP("Not the specified device, return immediately!\n");
 640         } else {
 641                 retval = rts51x_read_mem(us, 0xFD6F, buf, 1);
 642                 if (retval == STATUS_SUCCESS && (buf[0] & 0x24) == 0x24) {
 643                         /* SD Exist and SD WP */
 644                         retval = rts51x_read_mem(us, 0xD04E, buf, 1);
 645                         if (retval == STATUS_SUCCESS) {
 646                                 buf[0] |= 0x04;
 647                                 retval = rts51x_write_mem(us, 0xFD70, buf, 1);
 648                                 if (retval != STATUS_SUCCESS)
 649                                         US_DEBUGP("Write memory fail\n");
 650                         } else {
 651                                 US_DEBUGP("Read memory fail\n");
 652                         }
 653                 } else {
 654                         US_DEBUGP("Read memory fail, OR (buf[0]&0x24)!=0x24\n");
 655                 }
 656         }
 657
 658         US_DEBUGP("%s: --->\n", __func__);
 659 }
 660
 661 static void rts51x_modi_suspend_timer(struct rts51x_chip *chip)
 662 {
 663         US_DEBUGP("%s: <---, state:%d\n", __func__, rts51x_get_stat(chip));
 664
 665         chip->timer_expires = jiffies + msecs_to_jiffies(1000*ss_delay);
 666         mod_timer(&chip->rts51x_suspend_timer, chip->timer_expires);
 667
 668         US_DEBUGP("%s: --->\n", __func__);
 669 }
 670
 671 static void rts51x_suspend_timer_fn(unsigned long data)
 672 {
 673         struct rts51x_chip *chip = (struct rts51x_chip *)data;
 674         struct us_data *us = chip->us;
 675
 676         US_DEBUGP("%s: <---\n", __func__);
 677
 678         switch (rts51x_get_stat(chip)) {
 679         case RTS51X_STAT_INIT:
 680         case RTS51X_STAT_RUN:
 681                 rts51x_modi_suspend_timer(chip);
 682                 break;
 683         case RTS51X_STAT_IDLE:
 684         case RTS51X_STAT_SS:
 685                 US_DEBUGP("%s: RTS51X_STAT_SS, intf->pm_usage_cnt:%d,"
 686                         "power.usage:%d\n", __func__,
 687                         atomic_read(&us->pusb_intf->pm_usage_cnt),
 688                         atomic_read(&us->pusb_intf->dev.power.usage_count));
 689
 690                 if (atomic_read(&us->pusb_intf->pm_usage_cnt) > 0) {
 691                         US_DEBUGP("%s: Ready to enter SS state.\n",
 692                                   __func__);
 693                         rts51x_set_stat(chip, RTS51X_STAT_SS);
 694                         /* ignore mass storage interface's children */
 695                         pm_suspend_ignore_children(&us->pusb_intf->dev, true);
 696                         usb_autopm_put_interface(us->pusb_intf);
 697                         US_DEBUGP("%s: RTS51X_STAT_SS 01,"
 698                                 "intf->pm_usage_cnt:%d, power.usage:%d\n",
 699                                 __func__,
 700                                 atomic_read(&us->pusb_intf->pm_usage_cnt),
 701                                 atomic_read(
 702                                         &us->pusb_intf->dev.power.usage_count));
 703                 }
 704                 break;
 705         default:
 706                 US_DEBUGP("%s: Unknonwn state !!!\n", __func__);
 707                 break;
 708         }
 709
 710         US_DEBUGP("%s: --->\n", __func__);
 711 }
 712
 713 static inline int working_scsi(struct scsi_cmnd *srb)
 714 {
 715         if ((srb->cmnd[0] == TEST_UNIT_READY) ||
 716             (srb->cmnd[0] == ALLOW_MEDIUM_REMOVAL)) {
 717                 return 0;
 718         }
 719
 720         return 1;
 721 }
 722
 723 void rts51x_invoke_transport(struct scsi_cmnd *srb, struct us_data *us)
 724 {
 725         struct rts51x_chip *chip = (struct rts51x_chip *)(us->extra);
 726         static int card_first_show = 1;
 727         static u8 media_not_present[] = { 0x70, 0, 0x02, 0, 0, 0, 0,
 728                 10, 0, 0, 0, 0, 0x3A, 0, 0, 0, 0, 0
 729         };
 730         static u8 invalid_cmd_field[] = { 0x70, 0, 0x05, 0, 0, 0, 0,
 731                 10, 0, 0, 0, 0, 0x24, 0, 0, 0, 0, 0
 732         };
 733         int ret;
 734
 735         US_DEBUGP("%s: <---\n", __func__);
 736
 737         if (working_scsi(srb)) {
 738                 US_DEBUGP("%s: working scsi, intf->pm_usage_cnt:%d,"
 739                         "power.usage:%d\n", __func__,
 740                         atomic_read(&us->pusb_intf->pm_usage_cnt),
 741                         atomic_read(&us->pusb_intf->dev.power.usage_count));
 742
 743                 if (atomic_read(&us->pusb_intf->pm_usage_cnt) <= 0) {
 744                         ret = usb_autopm_get_interface(us->pusb_intf);
 745                         US_DEBUGP("%s: working scsi, ret=%d\n", __func__, ret);
 746                 }
 747                 if (rts51x_get_stat(chip) != RTS51X_STAT_RUN)
 748                         rts51x_set_stat(chip, RTS51X_STAT_RUN);
 749                 chip->proto_handler_backup(srb, us);
 750         } else {
 751                 if (rts51x_get_stat(chip) == RTS51X_STAT_SS) {
 752                         US_DEBUGP("%s: NOT working scsi\n", __func__);
 753                         if ((srb->cmnd[0] == TEST_UNIT_READY) &&
 754                             (chip->pwr_state == US_SUSPEND)) {
 755                                 if (TST_LUN_READY(chip, srb->device->lun)) {
 756                                         srb->result = SAM_STAT_GOOD;
 757                                 } else {
 758                                         srb->result = SAM_STAT_CHECK_CONDITION;
 759                                         memcpy(srb->sense_buffer,
 760                                                media_not_present,
 761                                                US_SENSE_SIZE);
 762                                 }
 763                                 US_DEBUGP("%s: TEST_UNIT_READY--->\n",
 764                                           __func__);
 765                                 goto out;
 766                         }
 767                         if (srb->cmnd[0] == ALLOW_MEDIUM_REMOVAL) {
 768                                 int prevent = srb->cmnd[4] & 0x1;
 769                                 if (prevent) {
 770                                         srb->result = SAM_STAT_CHECK_CONDITION;
 771                                         memcpy(srb->sense_buffer,
 772                                                invalid_cmd_field,
 773                                                US_SENSE_SIZE);
 774                                 } else {
 775                                         srb->result = SAM_STAT_GOOD;
 776                                 }
 777                                 US_DEBUGP("%s: ALLOW_MEDIUM_REMOVAL--->\n",
 778                                           __func__);
 779                                 goto out;
 780                         }
 781                 } else {
 782                         US_DEBUGP("%s: NOT working scsi, not SS\n", __func__);
 783                         chip->proto_handler_backup(srb, us);
 784                         /* Check wether card is plugged in */
 785                         if (srb->cmnd[0] == TEST_UNIT_READY) {
 786                                 if (srb->result == SAM_STAT_GOOD) {
 787                                         SET_LUN_READY(chip, srb->device->lun);
 788                                         if (card_first_show) {
 789                                                 card_first_show = 0;
 790                                                 fw5895_set_mmc_wp(us);
 791                                         }
 792                                 } else {
 793                                         CLR_LUN_READY(chip, srb->device->lun);
 794                                         card_first_show = 1;
 795                                 }
 796                         }
 797                         if (rts51x_get_stat(chip) != RTS51X_STAT_IDLE)
 798                                 rts51x_set_stat(chip, RTS51X_STAT_IDLE);
 799                 }
 800         }
 801 out:
 802         US_DEBUGP("%s: state:%d\n", __func__, rts51x_get_stat(chip));
 803         if (rts51x_get_stat(chip) == RTS51X_STAT_RUN)
 804                 rts51x_modi_suspend_timer(chip);
 805
 806         US_DEBUGP("%s: --->\n", __func__);
 807 }
 808
 809 static int realtek_cr_autosuspend_setup(struct us_data *us)
 810 {
 811         struct rts51x_chip *chip;
 812         struct rts51x_status *status = NULL;
 813         u8 buf[16];
 814         int retval;
 815
 816         chip = (struct rts51x_chip *)us->extra;
 817         chip->support_auto_delink = 0;
 818         chip->pwr_state = US_RESUME;
 819         chip->lun_ready = 0;
 820         rts51x_set_stat(chip, RTS51X_STAT_INIT);
 821
 822         retval = rts51x_read_status(us, 0, buf, 16, &(chip->status_len));
 823         if (retval != STATUS_SUCCESS) {
 824                 US_DEBUGP("Read status fail\n");
 825                 return -EIO;
 826         }
 827         status = chip->status;
 828         status->vid = ((u16) buf[0] << 8) | buf[1];
 829         status->pid = ((u16) buf[2] << 8) | buf[3];
 830         status->cur_lun = buf[4];
 831         status->card_type = buf[5];
 832         status->total_lun = buf[6];
 833         status->fw_ver = ((u16) buf[7] << 8) | buf[8];
 834         status->phy_exist = buf[9];
 835         status->multi_flag = buf[10];
 836         status->multi_card = buf[11];
 837         status->log_exist = buf[12];
 838         if (chip->status_len == 16) {
 839                 status->detailed_type.detailed_type1 = buf[13];
 840                 status->function[0] = buf[14];
 841                 status->function[1] = buf[15];
 842         }
 843
 844         /* back up the proto_handler in us->extra */
 845         chip = (struct rts51x_chip *)(us->extra);
 846         chip->proto_handler_backup = us->proto_handler;
 847         /* Set the autosuspend_delay to 0 */
 848         pm_runtime_set_autosuspend_delay(&us->pusb_dev->dev, 0);
 849         /* override us->proto_handler setted in get_protocol() */
 850         us->proto_handler = rts51x_invoke_transport;
 851
 852         chip->timer_expires = 0;
 853         setup_timer(&chip->rts51x_suspend_timer, rts51x_suspend_timer_fn,
 854                         (unsigned long)chip);
 855         fw5895_init(us);
 856
 857         /* enable autosuspend funciton of the usb device */
 858         usb_enable_autosuspend(us->pusb_dev);
 859
 860         return 0;
 861 }
 862 #endif
 863
 864 static void realtek_cr_destructor(void *extra)
 865 {
 866         struct rts51x_chip *chip = (struct rts51x_chip *)extra;
 867
 868         US_DEBUGP("%s: <---\n", __func__);
 869
 870         if (!chip)
 871                 return;
 872 #ifdef CONFIG_REALTEK_AUTOPM
 873         if (ss_en) {
 874                 del_timer(&chip->rts51x_suspend_timer);
 875                 chip->timer_expires = 0;
 876         }
 877 #endif
 878         kfree(chip->status);
 879 }
 880
 881 #ifdef CONFIG_PM
 882 int realtek_cr_suspend(struct usb_interface *iface, pm_message_t message)
 883 {
 884         struct us_data *us = usb_get_intfdata(iface);
 885
 886         US_DEBUGP("%s: <---\n", __func__);
 887
 888         /* wait until no command is running */
 889         mutex_lock(&us->dev_mutex);
 890
 891         config_autodelink_before_power_down(us);
 892
 893         mutex_unlock(&us->dev_mutex);
 894
 895         US_DEBUGP("%s: --->\n", __func__);
 896
 897         return 0;
 898 }
 899
 900 static int realtek_cr_resume(struct usb_interface *iface)
 901 {
 902         struct us_data *us = usb_get_intfdata(iface);
 903
 904         US_DEBUGP("%s: <---\n", __func__);
 905
 906         fw5895_init(us);
 907         config_autodelink_after_power_on(us);
 908
 909         US_DEBUGP("%s: --->\n", __func__);
 910
 911         return 0;
 912 }
 913 #else
 914 #define realtek_cr_suspend      NULL
 915 #define realtek_cr_resume       NULL
 916 #endif
 917
 918 static int init_realtek_cr(struct us_data *us)
 919 {
 920         struct rts51x_chip *chip;
 921         int size, i, retval;
 922
 923         chip = kzalloc(sizeof(struct rts51x_chip), GFP_KERNEL);
 924         if (!chip)
 925                 return -ENOMEM;
 926
 927         us->extra = chip;
 928         us->extra_destructor = realtek_cr_destructor;
 929         us->max_lun = chip->max_lun = rts51x_get_max_lun(us);
 930
 931         US_DEBUGP("chip->max_lun = %d\n", chip->max_lun);
 932
 933         size = (chip->max_lun + 1) * sizeof(struct rts51x_status);
 934         chip->status = kzalloc(size, GFP_KERNEL);
 935         if (!chip->status)
 936                 goto INIT_FAIL;
 937
 938         for (i = 0; i <= (int)(chip->max_lun); i++) {
 939                 retval = rts51x_check_status(us, (u8) i);
 940                 if (retval < 0)
 941                         goto INIT_FAIL;
 942         }
 943
 944         if (CHECK_FW_VER(chip, 0x5888) || CHECK_FW_VER(chip, 0x5889) ||
 945             CHECK_FW_VER(chip, 0x5901))
 946                 SET_AUTO_DELINK(chip);
 947         if (STATUS_LEN(chip) == 16) {
 948                 if (SUPPORT_AUTO_DELINK(chip))
 949                         SET_AUTO_DELINK(chip);
 950         }
 951 #ifdef CONFIG_REALTEK_AUTOPM
 952         if (ss_en) {
 953                 chip->us = us;
 954                 realtek_cr_autosuspend_setup(us);
 955         }
 956 #endif
 957
 958         US_DEBUGP("chip->flag = 0x%x\n", chip->flag);
 959
 960         (void)config_autodelink_after_power_on(us);
 961
 962         return 0;
 963
 964 INIT_FAIL:
 965         if (us->extra) {
 966                 kfree(chip->status);
 967                 kfree(us->extra);
 968                 us->extra = NULL;
 969         }
 970
 971         return -EIO;
 972 }
 973
 974 static int realtek_cr_probe(struct usb_interface *intf,
 975                             const struct usb_device_id *id)
 976 {
 977         struct us_data *us;
 978         int result;
 979
 980         US_DEBUGP("Probe Realtek Card Reader!\n");
 981
 982         result = usb_stor_probe1(&us, intf, id,
 983                                  (id - realtek_cr_ids) +
 984                                  realtek_cr_unusual_dev_list);
 985         if (result)
 986                 return result;
 987
 988         result = usb_stor_probe2(us);
 989
 990         return result;
 991 }
 992
 993 static struct usb_driver realtek_cr_driver = {
 994         .name = "ums-realtek",
 995         .probe = realtek_cr_probe,
 996         .disconnect = usb_stor_disconnect,
 997         /* .suspend =      usb_stor_suspend, */
 998         /* .resume =       usb_stor_resume, */
 999         .reset_resume = usb_stor_reset_resume,
1000         .suspend = realtek_cr_suspend,
1001         .resume = realtek_cr_resume,
1002         .pre_reset = usb_stor_pre_reset,
1003         .post_reset = usb_stor_post_reset,
1004         .id_table = realtek_cr_ids,
1005         .soft_unbind = 1,
1006         .supports_autosuspend = 1,
1007 };
1008
1009 static int __init realtek_cr_init(void)
1010 {
1011         return usb_register(&realtek_cr_driver);
1012 }
1013
1014 static void __exit realtek_cr_exit(void)
1015 {
1016         usb_deregister(&realtek_cr_driver);
1017 }
1018
1019 module_init(realtek_cr_init);
1020 module_exit(realtek_cr_exit);