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