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