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