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