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