1 /*
2 * Driver for Realtek RTS51xx USB card reader
3 *
4 * Copyright(c) 2009 Realtek Semiconductor Corp. All rights reserved.
5 *
6 * This program is free software; you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License as published by the
8 * Free Software Foundation; either version 2, or (at your option) any
9 * later version.
10 *
11 * This program is distributed in the hope that it will be useful, but
12 * WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License along
17 * with this program; if not, see <http://www.gnu.org/licenses/>.
18 *
19 * Author:
20 * wwang (wei_wang@realsil.com.cn)
21 * No. 450, Shenhu Road, Suzhou Industry Park, Suzhou, China
22 */
23
24 #include <linux/module.h>
25 #include <linux/blkdev.h>
26 #include <linux/kthread.h>
27 #include <linux/sched.h>
28 #include <linux/kernel.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 #include "scsiglue.h"
44
45 #define DRV_NAME "ums-realtek"
46
47 MODULE_DESCRIPTION("Driver for Realtek USB Card Reader");
48 MODULE_AUTHOR("wwang <wei_wang@realsil.com.cn>");
49 MODULE_LICENSE("GPL");
50
51 static int auto_delink_en = 1;
52 module_param(auto_delink_en, int, S_IRUGO | S_IWUSR);
53 MODULE_PARM_DESC(auto_delink_en, "auto delink mode (0=firmware, 1=software [default])");
54
55 #ifdef CONFIG_REALTEK_AUTOPM
56 static int ss_en = 1;
57 module_param(ss_en, int, S_IRUGO | S_IWUSR);
58 MODULE_PARM_DESC(ss_en, "enable selective suspend");
59
60 static int ss_delay = 50;
61 module_param(ss_delay, int, S_IRUGO | S_IWUSR);
62 MODULE_PARM_DESC(ss_delay,
63 "seconds to delay before entering selective suspend");
64
65 enum 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
84 struct 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
102 struct rts51x_chip {
103 u16 vendor_id;
104 u16 product_id;
105 char max_lun;
106
107 struct rts51x_status *status;
108 int status_len;
109
110 u32 flag;
111 struct us_data *us;
112
113 #ifdef CONFIG_REALTEK_AUTOPM
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
121 /* used to back up the protocol chosen in probe1 phase */
122 proto_cmnd proto_handler_backup;
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
142 #define VENDOR_ID(chip) ((chip)->status[0].vid)
143 #define PRODUCT_ID(chip) ((chip)->status[0].pid)
144 #define FW_VERSION(chip) ((chip)->status[0].fw_ver)
145 #define STATUS_LEN(chip) ((chip)->status_len)
146
147 #define STATUS_SUCCESS 0
148 #define STATUS_FAIL 1
149
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
169 static 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), \
179 .driver_info = (flags) \
180 }
181
182 static const struct usb_device_id realtek_cr_ids[] = {
183 # include "unusual_realtek.h"
184 {} /* Terminating entry */
185 };
186
187 MODULE_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
205 static struct us_unusual_dev realtek_cr_unusual_dev_list[] = {
206 # include "unusual_realtek.h"
207 {} /* Terminating entry */
208 };
209
210 #undef UNUSUAL_DEV
211
rts51x_bulk_transport(struct us_data * us,u8 lun,u8 * cmd,int cmd_len,u8 * buf,int buf_len,enum dma_data_direction dir,int * act_len)212 static 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 {
216 struct bulk_cb_wrap *bcb = (struct bulk_cb_wrap *)us->iobuf;
217 struct bulk_cs_wrap *bcs = (struct bulk_cs_wrap *)us->iobuf;
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);
226 bcb->Flags = (dir == DMA_FROM_DEVICE) ? US_BULK_FLAG_IN : 0;
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,
237 bcb, cbwlen, NULL);
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) ?
246 us->recv_bulk_pipe : us->send_bulk_pipe;
247 result = usb_stor_bulk_transfer_buf(us, pipe,
248 buf, buf_len, NULL);
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,
255 bcs, US_BULK_CS_WRAP_LEN, &cswlen);
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)) {
261 usb_stor_dbg(us, "Signature mismatch: got %08X, expecting %08X\n",
262 le32_to_cpu(bcs->Signature), US_BULK_CS_SIGN);
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 /*
271 * try to compute the actual residue, based on how much data
272 * was really transferred and what the device tells us
273 */
274 if (residue)
275 residue = residue < buf_len ? residue : buf_len;
276
277 if (act_len)
278 *act_len = buf_len - residue;
279
280 /* based on the status code, we report good or bad */
281 switch (bcs->Status) {
282 case US_BULK_STAT_OK:
283 /* command good -- note that data could be short */
284 return USB_STOR_TRANSPORT_GOOD;
285
286 case US_BULK_STAT_FAIL:
287 /* command failed */
288 return USB_STOR_TRANSPORT_FAILED;
289
290 case US_BULK_STAT_PHASE:
291 /*
292 * phase error -- note that a transport reset will be
293 * invoked by the invoke_transport() function
294 */
295 return USB_STOR_TRANSPORT_ERROR;
296 }
297
298 /* we should never get here, but if we do, we're in trouble */
299 return USB_STOR_TRANSPORT_ERROR;
300 }
301
rts51x_bulk_transport_special(struct us_data * us,u8 lun,u8 * cmd,int cmd_len,u8 * buf,int buf_len,enum dma_data_direction dir,int * act_len)302 static int rts51x_bulk_transport_special(struct us_data *us, u8 lun,
303 u8 *cmd, int cmd_len, u8 *buf, int buf_len,
304 enum dma_data_direction dir, int *act_len)
305 {
306 struct bulk_cb_wrap *bcb = (struct bulk_cb_wrap *) us->iobuf;
307 struct bulk_cs_wrap *bcs = (struct bulk_cs_wrap *) us->iobuf;
308 int result;
309 unsigned int cswlen;
310 unsigned int cbwlen = US_BULK_CB_WRAP_LEN;
311
312 /* set up the command wrapper */
313 bcb->Signature = cpu_to_le32(US_BULK_CB_SIGN);
314 bcb->DataTransferLength = cpu_to_le32(buf_len);
315 bcb->Flags = (dir == DMA_FROM_DEVICE) ? US_BULK_FLAG_IN : 0;
316 bcb->Tag = ++us->tag;
317 bcb->Lun = lun;
318 bcb->Length = cmd_len;
319
320 /* copy the command payload */
321 memset(bcb->CDB, 0, sizeof(bcb->CDB));
322 memcpy(bcb->CDB, cmd, bcb->Length);
323
324 /* send it to out endpoint */
325 result = usb_stor_bulk_transfer_buf(us, us->send_bulk_pipe,
326 bcb, cbwlen, NULL);
327 if (result != USB_STOR_XFER_GOOD)
328 return USB_STOR_TRANSPORT_ERROR;
329
330 /* DATA STAGE */
331 /* send/receive data payload, if there is any */
332
333 if (buf && buf_len) {
334 unsigned int pipe = (dir == DMA_FROM_DEVICE) ?
335 us->recv_bulk_pipe : us->send_bulk_pipe;
336 result = usb_stor_bulk_transfer_buf(us, pipe,
337 buf, buf_len, NULL);
338 if (result == USB_STOR_XFER_ERROR)
339 return USB_STOR_TRANSPORT_ERROR;
340 }
341
342 /* get CSW for device status */
343 result = usb_bulk_msg(us->pusb_dev, us->recv_bulk_pipe, bcs,
344 US_BULK_CS_WRAP_LEN, &cswlen, 250);
345 return result;
346 }
347
348 /* Determine what the maximum LUN supported is */
rts51x_get_max_lun(struct us_data * us)349 static int rts51x_get_max_lun(struct us_data *us)
350 {
351 int result;
352
353 /* issue the command */
354 us->iobuf[0] = 0;
355 result = usb_stor_control_msg(us, us->recv_ctrl_pipe,
356 US_BULK_GET_MAX_LUN,
357 USB_DIR_IN | USB_TYPE_CLASS |
358 USB_RECIP_INTERFACE,
359 0, us->ifnum, us->iobuf, 1, 10 * HZ);
360
361 usb_stor_dbg(us, "GetMaxLUN command result is %d, data is %d\n",
362 result, us->iobuf[0]);
363
364 /* if we have a successful request, return the result */
365 if (result > 0)
366 return us->iobuf[0];
367
368 return 0;
369 }
370
rts51x_read_mem(struct us_data * us,u16 addr,u8 * data,u16 len)371 static int rts51x_read_mem(struct us_data *us, u16 addr, u8 *data, u16 len)
372 {
373 int retval;
374 u8 cmnd[12] = { 0 };
375 u8 *buf;
376
377 buf = kmalloc(len, GFP_NOIO);
378 if (buf == NULL)
379 return USB_STOR_TRANSPORT_ERROR;
380
381 usb_stor_dbg(us, "addr = 0x%x, len = %d\n", addr, len);
382
383 cmnd[0] = 0xF0;
384 cmnd[1] = 0x0D;
385 cmnd[2] = (u8) (addr >> 8);
386 cmnd[3] = (u8) addr;
387 cmnd[4] = (u8) (len >> 8);
388 cmnd[5] = (u8) len;
389
390 retval = rts51x_bulk_transport(us, 0, cmnd, 12,
391 buf, len, DMA_FROM_DEVICE, NULL);
392 if (retval != USB_STOR_TRANSPORT_GOOD) {
393 kfree(buf);
394 return -EIO;
395 }
396
397 memcpy(data, buf, len);
398 kfree(buf);
399 return 0;
400 }
401
rts51x_write_mem(struct us_data * us,u16 addr,u8 * data,u16 len)402 static int rts51x_write_mem(struct us_data *us, u16 addr, u8 *data, u16 len)
403 {
404 int retval;
405 u8 cmnd[12] = { 0 };
406 u8 *buf;
407
408 buf = kmemdup(data, len, GFP_NOIO);
409 if (buf == NULL)
410 return USB_STOR_TRANSPORT_ERROR;
411
412 usb_stor_dbg(us, "addr = 0x%x, len = %d\n", addr, len);
413
414 cmnd[0] = 0xF0;
415 cmnd[1] = 0x0E;
416 cmnd[2] = (u8) (addr >> 8);
417 cmnd[3] = (u8) addr;
418 cmnd[4] = (u8) (len >> 8);
419 cmnd[5] = (u8) len;
420
421 retval = rts51x_bulk_transport(us, 0, cmnd, 12,
422 buf, len, DMA_TO_DEVICE, NULL);
423 kfree(buf);
424 if (retval != USB_STOR_TRANSPORT_GOOD)
425 return -EIO;
426
427 return 0;
428 }
429
rts51x_read_status(struct us_data * us,u8 lun,u8 * status,int len,int * actlen)430 static int rts51x_read_status(struct us_data *us,
431 u8 lun, u8 *status, int len, int *actlen)
432 {
433 int retval;
434 u8 cmnd[12] = { 0 };
435 u8 *buf;
436
437 buf = kmalloc(len, GFP_NOIO);
438 if (buf == NULL)
439 return USB_STOR_TRANSPORT_ERROR;
440
441 usb_stor_dbg(us, "lun = %d\n", lun);
442
443 cmnd[0] = 0xF0;
444 cmnd[1] = 0x09;
445
446 retval = rts51x_bulk_transport(us, lun, cmnd, 12,
447 buf, len, DMA_FROM_DEVICE, actlen);
448 if (retval != USB_STOR_TRANSPORT_GOOD) {
449 kfree(buf);
450 return -EIO;
451 }
452
453 memcpy(status, buf, len);
454 kfree(buf);
455 return 0;
456 }
457
rts51x_check_status(struct us_data * us,u8 lun)458 static int rts51x_check_status(struct us_data *us, u8 lun)
459 {
460 struct rts51x_chip *chip = (struct rts51x_chip *)(us->extra);
461 int retval;
462 u8 buf[16];
463
464 retval = rts51x_read_status(us, lun, buf, 16, &(chip->status_len));
465 if (retval != STATUS_SUCCESS)
466 return -EIO;
467
468 usb_stor_dbg(us, "chip->status_len = %d\n", chip->status_len);
469
470 chip->status[lun].vid = ((u16) buf[0] << 8) | buf[1];
471 chip->status[lun].pid = ((u16) buf[2] << 8) | buf[3];
472 chip->status[lun].cur_lun = buf[4];
473 chip->status[lun].card_type = buf[5];
474 chip->status[lun].total_lun = buf[6];
475 chip->status[lun].fw_ver = ((u16) buf[7] << 8) | buf[8];
476 chip->status[lun].phy_exist = buf[9];
477 chip->status[lun].multi_flag = buf[10];
478 chip->status[lun].multi_card = buf[11];
479 chip->status[lun].log_exist = buf[12];
480 if (chip->status_len == 16) {
481 chip->status[lun].detailed_type.detailed_type1 = buf[13];
482 chip->status[lun].function[0] = buf[14];
483 chip->status[lun].function[1] = buf[15];
484 }
485
486 return 0;
487 }
488
enable_oscillator(struct us_data * us)489 static int enable_oscillator(struct us_data *us)
490 {
491 int retval;
492 u8 value;
493
494 retval = rts51x_read_mem(us, 0xFE77, &value, 1);
495 if (retval < 0)
496 return -EIO;
497
498 value |= 0x04;
499 retval = rts51x_write_mem(us, 0xFE77, &value, 1);
500 if (retval < 0)
501 return -EIO;
502
503 retval = rts51x_read_mem(us, 0xFE77, &value, 1);
504 if (retval < 0)
505 return -EIO;
506
507 if (!(value & 0x04))
508 return -EIO;
509
510 return 0;
511 }
512
__do_config_autodelink(struct us_data * us,u8 * data,u16 len)513 static int __do_config_autodelink(struct us_data *us, u8 *data, u16 len)
514 {
515 int retval;
516 u8 cmnd[12] = {0};
517 u8 *buf;
518
519 usb_stor_dbg(us, "addr = 0xfe47, len = %d\n", len);
520
521 buf = kmemdup(data, len, GFP_NOIO);
522 if (!buf)
523 return USB_STOR_TRANSPORT_ERROR;
524
525 cmnd[0] = 0xF0;
526 cmnd[1] = 0x0E;
527 cmnd[2] = 0xfe;
528 cmnd[3] = 0x47;
529 cmnd[4] = (u8)(len >> 8);
530 cmnd[5] = (u8)len;
531
532 retval = rts51x_bulk_transport_special(us, 0, cmnd, 12, buf, len, DMA_TO_DEVICE, NULL);
533 kfree(buf);
534 if (retval != USB_STOR_TRANSPORT_GOOD) {
535 return -EIO;
536 }
537
538 return 0;
539 }
540
do_config_autodelink(struct us_data * us,int enable,int force)541 static int do_config_autodelink(struct us_data *us, int enable, int force)
542 {
543 int retval;
544 u8 value;
545
546 retval = rts51x_read_mem(us, 0xFE47, &value, 1);
547 if (retval < 0)
548 return -EIO;
549
550 if (enable) {
551 if (force)
552 value |= 0x03;
553 else
554 value |= 0x01;
555 } else {
556 value &= ~0x03;
557 }
558
559 usb_stor_dbg(us, "set 0xfe47 to 0x%x\n", value);
560
561 /* retval = rts51x_write_mem(us, 0xFE47, &value, 1); */
562 retval = __do_config_autodelink(us, &value, 1);
563 if (retval < 0)
564 return -EIO;
565
566 return 0;
567 }
568
config_autodelink_after_power_on(struct us_data * us)569 static int config_autodelink_after_power_on(struct us_data *us)
570 {
571 struct rts51x_chip *chip = (struct rts51x_chip *)(us->extra);
572 int retval;
573 u8 value;
574
575 if (!CHK_AUTO_DELINK(chip))
576 return 0;
577
578 retval = rts51x_read_mem(us, 0xFE47, &value, 1);
579 if (retval < 0)
580 return -EIO;
581
582 if (auto_delink_en) {
583 CLR_BIT(value, 0);
584 CLR_BIT(value, 1);
585 SET_BIT(value, 2);
586
587 if (CHECK_ID(chip, 0x0138, 0x3882))
588 CLR_BIT(value, 2);
589
590 SET_BIT(value, 7);
591
592 /* retval = rts51x_write_mem(us, 0xFE47, &value, 1); */
593 retval = __do_config_autodelink(us, &value, 1);
594 if (retval < 0)
595 return -EIO;
596
597 retval = enable_oscillator(us);
598 if (retval == 0)
599 (void)do_config_autodelink(us, 1, 0);
600 } else {
601 /* Autodelink controlled by firmware */
602
603 SET_BIT(value, 2);
604
605 if (CHECK_ID(chip, 0x0138, 0x3882))
606 CLR_BIT(value, 2);
607
608 if (CHECK_ID(chip, 0x0159, 0x5889) ||
609 CHECK_ID(chip, 0x0138, 0x3880)) {
610 CLR_BIT(value, 0);
611 CLR_BIT(value, 7);
612 }
613
614 /* retval = rts51x_write_mem(us, 0xFE47, &value, 1); */
615 retval = __do_config_autodelink(us, &value, 1);
616 if (retval < 0)
617 return -EIO;
618
619 if (CHECK_ID(chip, 0x0159, 0x5888)) {
620 value = 0xFF;
621 retval = rts51x_write_mem(us, 0xFE79, &value, 1);
622 if (retval < 0)
623 return -EIO;
624
625 value = 0x01;
626 retval = rts51x_write_mem(us, 0x48, &value, 1);
627 if (retval < 0)
628 return -EIO;
629 }
630 }
631
632 return 0;
633 }
634
635 #ifdef CONFIG_PM
config_autodelink_before_power_down(struct us_data * us)636 static int config_autodelink_before_power_down(struct us_data *us)
637 {
638 struct rts51x_chip *chip = (struct rts51x_chip *)(us->extra);
639 int retval;
640 u8 value;
641
642 if (!CHK_AUTO_DELINK(chip))
643 return 0;
644
645 if (auto_delink_en) {
646 retval = rts51x_read_mem(us, 0xFE77, &value, 1);
647 if (retval < 0)
648 return -EIO;
649
650 SET_BIT(value, 2);
651 retval = rts51x_write_mem(us, 0xFE77, &value, 1);
652 if (retval < 0)
653 return -EIO;
654
655 if (CHECK_ID(chip, 0x0159, 0x5888)) {
656 value = 0x01;
657 retval = rts51x_write_mem(us, 0x48, &value, 1);
658 if (retval < 0)
659 return -EIO;
660 }
661
662 retval = rts51x_read_mem(us, 0xFE47, &value, 1);
663 if (retval < 0)
664 return -EIO;
665
666 SET_BIT(value, 0);
667 if (CHECK_ID(chip, 0x0138, 0x3882))
668 SET_BIT(value, 2);
669 retval = rts51x_write_mem(us, 0xFE77, &value, 1);
670 if (retval < 0)
671 return -EIO;
672 } else {
673 if (CHECK_ID(chip, 0x0159, 0x5889) ||
674 CHECK_ID(chip, 0x0138, 0x3880) ||
675 CHECK_ID(chip, 0x0138, 0x3882)) {
676 retval = rts51x_read_mem(us, 0xFE47, &value, 1);
677 if (retval < 0)
678 return -EIO;
679
680 if (CHECK_ID(chip, 0x0159, 0x5889) ||
681 CHECK_ID(chip, 0x0138, 0x3880)) {
682 SET_BIT(value, 0);
683 SET_BIT(value, 7);
684 }
685
686 if (CHECK_ID(chip, 0x0138, 0x3882))
687 SET_BIT(value, 2);
688
689 /* retval = rts51x_write_mem(us, 0xFE47, &value, 1); */
690 retval = __do_config_autodelink(us, &value, 1);
691 if (retval < 0)
692 return -EIO;
693 }
694
695 if (CHECK_ID(chip, 0x0159, 0x5888)) {
696 value = 0x01;
697 retval = rts51x_write_mem(us, 0x48, &value, 1);
698 if (retval < 0)
699 return -EIO;
700 }
701 }
702
703 return 0;
704 }
705
fw5895_init(struct us_data * us)706 static void fw5895_init(struct us_data *us)
707 {
708 struct rts51x_chip *chip = (struct rts51x_chip *)(us->extra);
709 int retval;
710 u8 val;
711
712 if ((PRODUCT_ID(chip) != 0x0158) || (FW_VERSION(chip) != 0x5895)) {
713 usb_stor_dbg(us, "Not the specified device, return immediately!\n");
714 } else {
715 retval = rts51x_read_mem(us, 0xFD6F, &val, 1);
716 if (retval == STATUS_SUCCESS && (val & 0x1F) == 0) {
717 val = 0x1F;
718 retval = rts51x_write_mem(us, 0xFD70, &val, 1);
719 if (retval != STATUS_SUCCESS)
720 usb_stor_dbg(us, "Write memory fail\n");
721 } else {
722 usb_stor_dbg(us, "Read memory fail, OR (val & 0x1F) != 0\n");
723 }
724 }
725 }
726 #endif
727
728 #ifdef CONFIG_REALTEK_AUTOPM
fw5895_set_mmc_wp(struct us_data * us)729 static void fw5895_set_mmc_wp(struct us_data *us)
730 {
731 struct rts51x_chip *chip = (struct rts51x_chip *)(us->extra);
732 int retval;
733 u8 buf[13];
734
735 if ((PRODUCT_ID(chip) != 0x0158) || (FW_VERSION(chip) != 0x5895)) {
736 usb_stor_dbg(us, "Not the specified device, return immediately!\n");
737 } else {
738 retval = rts51x_read_mem(us, 0xFD6F, buf, 1);
739 if (retval == STATUS_SUCCESS && (buf[0] & 0x24) == 0x24) {
740 /* SD Exist and SD WP */
741 retval = rts51x_read_mem(us, 0xD04E, buf, 1);
742 if (retval == STATUS_SUCCESS) {
743 buf[0] |= 0x04;
744 retval = rts51x_write_mem(us, 0xFD70, buf, 1);
745 if (retval != STATUS_SUCCESS)
746 usb_stor_dbg(us, "Write memory fail\n");
747 } else {
748 usb_stor_dbg(us, "Read memory fail\n");
749 }
750 } else {
751 usb_stor_dbg(us, "Read memory fail, OR (buf[0]&0x24)!=0x24\n");
752 }
753 }
754 }
755
rts51x_modi_suspend_timer(struct rts51x_chip * chip)756 static void rts51x_modi_suspend_timer(struct rts51x_chip *chip)
757 {
758 struct us_data *us = chip->us;
759
760 usb_stor_dbg(us, "state:%d\n", rts51x_get_stat(chip));
761
762 chip->timer_expires = jiffies + msecs_to_jiffies(1000*ss_delay);
763 mod_timer(&chip->rts51x_suspend_timer, chip->timer_expires);
764 }
765
rts51x_suspend_timer_fn(unsigned long data)766 static void rts51x_suspend_timer_fn(unsigned long data)
767 {
768 struct rts51x_chip *chip = (struct rts51x_chip *)data;
769 struct us_data *us = chip->us;
770
771 switch (rts51x_get_stat(chip)) {
772 case RTS51X_STAT_INIT:
773 case RTS51X_STAT_RUN:
774 rts51x_modi_suspend_timer(chip);
775 break;
776 case RTS51X_STAT_IDLE:
777 case RTS51X_STAT_SS:
778 usb_stor_dbg(us, "RTS51X_STAT_SS, power.usage:%d\n",
779 atomic_read(&us->pusb_intf->dev.power.usage_count));
780
781 if (atomic_read(&us->pusb_intf->dev.power.usage_count) > 0) {
782 usb_stor_dbg(us, "Ready to enter SS state\n");
783 rts51x_set_stat(chip, RTS51X_STAT_SS);
784 /* ignore mass storage interface's children */
785 pm_suspend_ignore_children(&us->pusb_intf->dev, true);
786 usb_autopm_put_interface_async(us->pusb_intf);
787 usb_stor_dbg(us, "RTS51X_STAT_SS 01, power.usage:%d\n",
788 atomic_read(&us->pusb_intf->dev.power.usage_count));
789 }
790 break;
791 default:
792 usb_stor_dbg(us, "Unknown state !!!\n");
793 break;
794 }
795 }
796
working_scsi(struct scsi_cmnd * srb)797 static inline int working_scsi(struct scsi_cmnd *srb)
798 {
799 if ((srb->cmnd[0] == TEST_UNIT_READY) ||
800 (srb->cmnd[0] == ALLOW_MEDIUM_REMOVAL)) {
801 return 0;
802 }
803
804 return 1;
805 }
806
rts51x_invoke_transport(struct scsi_cmnd * srb,struct us_data * us)807 static void rts51x_invoke_transport(struct scsi_cmnd *srb, struct us_data *us)
808 {
809 struct rts51x_chip *chip = (struct rts51x_chip *)(us->extra);
810 static int card_first_show = 1;
811 static u8 media_not_present[] = { 0x70, 0, 0x02, 0, 0, 0, 0,
812 10, 0, 0, 0, 0, 0x3A, 0, 0, 0, 0, 0
813 };
814 static u8 invalid_cmd_field[] = { 0x70, 0, 0x05, 0, 0, 0, 0,
815 10, 0, 0, 0, 0, 0x24, 0, 0, 0, 0, 0
816 };
817 int ret;
818
819 if (working_scsi(srb)) {
820 usb_stor_dbg(us, "working scsi, power.usage:%d\n",
821 atomic_read(&us->pusb_intf->dev.power.usage_count));
822
823 if (atomic_read(&us->pusb_intf->dev.power.usage_count) <= 0) {
824 ret = usb_autopm_get_interface(us->pusb_intf);
825 usb_stor_dbg(us, "working scsi, ret=%d\n", ret);
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) {
832 usb_stor_dbg(us, "NOT working scsi\n");
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 }
843 usb_stor_dbg(us, "TEST_UNIT_READY\n");
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 }
856 usb_stor_dbg(us, "ALLOW_MEDIUM_REMOVAL\n");
857 goto out;
858 }
859 } else {
860 usb_stor_dbg(us, "NOT working scsi, not SS\n");
861 chip->proto_handler_backup(srb, us);
862 /* Check whether card is plugged in */
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 }
879 out:
880 usb_stor_dbg(us, "state:%d\n", rts51x_get_stat(chip));
881 if (rts51x_get_stat(chip) == RTS51X_STAT_RUN)
882 rts51x_modi_suspend_timer(chip);
883 }
884
realtek_cr_autosuspend_setup(struct us_data * us)885 static 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) {
900 usb_stor_dbg(us, "Read status fail\n");
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
933 /* enable autosuspend function of the usb device */
934 usb_enable_autosuspend(us->pusb_dev);
935
936 return 0;
937 }
938 #endif
939
realtek_cr_destructor(void * extra)940 static void realtek_cr_destructor(void *extra)
941 {
942 struct rts51x_chip *chip = extra;
943
944 if (!chip)
945 return;
946
947 #ifdef CONFIG_REALTEK_AUTOPM
948 if (ss_en) {
949 del_timer(&chip->rts51x_suspend_timer);
950 chip->timer_expires = 0;
951 }
952 #endif
953 kfree(chip->status);
954 }
955
956 #ifdef CONFIG_PM
realtek_cr_suspend(struct usb_interface * iface,pm_message_t message)957 static int realtek_cr_suspend(struct usb_interface *iface, pm_message_t message)
958 {
959 struct us_data *us = usb_get_intfdata(iface);
960
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
968 return 0;
969 }
970
realtek_cr_resume(struct usb_interface * iface)971 static int realtek_cr_resume(struct usb_interface *iface)
972 {
973 struct us_data *us = usb_get_intfdata(iface);
974
975 fw5895_init(us);
976 config_autodelink_after_power_on(us);
977
978 return 0;
979 }
980 #else
981 #define realtek_cr_suspend NULL
982 #define realtek_cr_resume NULL
983 #endif
984
init_realtek_cr(struct us_data * us)985 static 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;
996 us->max_lun = chip->max_lun = rts51x_get_max_lun(us);
997 chip->us = us;
998
999 usb_stor_dbg(us, "chip->max_lun = %d\n", chip->max_lun);
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++) {
1007 retval = rts51x_check_status(us, (u8) i);
1008 if (retval < 0)
1009 goto INIT_FAIL;
1010 }
1011
1012 if (CHECK_PID(chip, 0x0138) || CHECK_PID(chip, 0x0158) ||
1013 CHECK_PID(chip, 0x0159)) {
1014 if (CHECK_FW_VER(chip, 0x5888) || CHECK_FW_VER(chip, 0x5889) ||
1015 CHECK_FW_VER(chip, 0x5901))
1016 SET_AUTO_DELINK(chip);
1017 if (STATUS_LEN(chip) == 16) {
1018 if (SUPPORT_AUTO_DELINK(chip))
1019 SET_AUTO_DELINK(chip);
1020 }
1021 }
1022 #ifdef CONFIG_REALTEK_AUTOPM
1023 if (ss_en)
1024 realtek_cr_autosuspend_setup(us);
1025 #endif
1026
1027 usb_stor_dbg(us, "chip->flag = 0x%x\n", chip->flag);
1028
1029 (void)config_autodelink_after_power_on(us);
1030
1031 return 0;
1032
1033 INIT_FAIL:
1034 if (us->extra) {
1035 kfree(chip->status);
1036 kfree(us->extra);
1037 us->extra = NULL;
1038 }
1039
1040 return -EIO;
1041 }
1042
1043 static struct scsi_host_template realtek_cr_host_template;
1044
realtek_cr_probe(struct usb_interface * intf,const struct usb_device_id * id)1045 static int realtek_cr_probe(struct usb_interface *intf,
1046 const struct usb_device_id *id)
1047 {
1048 struct us_data *us;
1049 int result;
1050
1051 dev_dbg(&intf->dev, "Probe Realtek Card Reader!\n");
1052
1053 result = usb_stor_probe1(&us, intf, id,
1054 (id - realtek_cr_ids) +
1055 realtek_cr_unusual_dev_list,
1056 &realtek_cr_host_template);
1057 if (result)
1058 return result;
1059
1060 result = usb_stor_probe2(us);
1061
1062 return result;
1063 }
1064
1065 static struct usb_driver realtek_cr_driver = {
1066 .name = DRV_NAME,
1067 .probe = realtek_cr_probe,
1068 .disconnect = usb_stor_disconnect,
1069 /* .suspend = usb_stor_suspend, */
1070 /* .resume = usb_stor_resume, */
1071 .reset_resume = usb_stor_reset_resume,
1072 .suspend = realtek_cr_suspend,
1073 .resume = realtek_cr_resume,
1074 .pre_reset = usb_stor_pre_reset,
1075 .post_reset = usb_stor_post_reset,
1076 .id_table = realtek_cr_ids,
1077 .soft_unbind = 1,
1078 .supports_autosuspend = 1,
1079 .no_dynamic_id = 1,
1080 };
1081
1082 module_usb_stor_driver(realtek_cr_driver, realtek_cr_host_template, DRV_NAME);
1083