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