Linux Audio

Check our new training course

Loading...
v6.8
   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
  35MODULE_DESCRIPTION("Driver for Realtek USB Card Reader");
  36MODULE_AUTHOR("wwang <wei_wang@realsil.com.cn>");
  37MODULE_LICENSE("GPL");
  38MODULE_IMPORT_NS(USB_STORAGE);
  39
  40static int auto_delink_en = 1;
  41module_param(auto_delink_en, int, S_IRUGO | S_IWUSR);
  42MODULE_PARM_DESC(auto_delink_en, "auto delink mode (0=firmware, 1=software [default])");
  43
  44#ifdef CONFIG_REALTEK_AUTOPM
  45static int ss_en = 1;
  46module_param(ss_en, int, S_IRUGO | S_IWUSR);
  47MODULE_PARM_DESC(ss_en, "enable selective suspend");
  48
  49static int ss_delay = 50;
  50module_param(ss_delay, int, S_IRUGO | S_IWUSR);
  51MODULE_PARM_DESC(ss_delay,
  52		 "seconds to delay before entering selective suspend");
  53
  54enum 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
  73struct 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
  91struct 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
 158static 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
 171static const struct usb_device_id realtek_cr_ids[] = {
 172#	include "unusual_realtek.h"
 173	{}			/* Terminating entry */
 174};
 175
 176MODULE_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
 194static struct us_unusual_dev realtek_cr_unusual_dev_list[] = {
 195#	include "unusual_realtek.h"
 196	{}			/* Terminating entry */
 197};
 198
 199#undef UNUSUAL_DEV
 200
 201static 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, us->send_bulk_pipe,
 226					    bcb, 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, 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, us->recv_bulk_pipe,
 244					    bcs, US_BULK_CS_WRAP_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, "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
 291static 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, us->send_bulk_pipe,
 315				bcb, 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, 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(us->pusb_dev, us->recv_bulk_pipe, bcs,
 333			US_BULK_CS_WRAP_LEN, &cswlen, 250);
 334	return result;
 335}
 336
 337/* Determine what the maximum LUN supported is */
 338static 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, us->recv_ctrl_pipe,
 345				      US_BULK_GET_MAX_LUN,
 346				      USB_DIR_IN | USB_TYPE_CLASS |
 347				      USB_RECIP_INTERFACE,
 348				      0, us->ifnum, us->iobuf, 1, 10 * HZ);
 349
 350	usb_stor_dbg(us, "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
 360static 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(len, GFP_NOIO);
 367	if (buf == NULL)
 368		return -ENOMEM;
 369
 370	usb_stor_dbg(us, "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, 0, cmnd, 12,
 380				       buf, len, DMA_FROM_DEVICE, NULL);
 381	if (retval != USB_STOR_TRANSPORT_GOOD) {
 382		kfree(buf);
 383		return -EIO;
 384	}
 385
 386	memcpy(data, buf, len);
 387	kfree(buf);
 388	return 0;
 389}
 390
 391static 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(data, len, GFP_NOIO);
 398	if (buf == NULL)
 399		return USB_STOR_TRANSPORT_ERROR;
 400
 401	usb_stor_dbg(us, "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, 0, cmnd, 12,
 411				       buf, len, DMA_TO_DEVICE, NULL);
 412	kfree(buf);
 413	if (retval != USB_STOR_TRANSPORT_GOOD)
 414		return -EIO;
 415
 416	return 0;
 417}
 418
 419static 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(len, GFP_NOIO);
 427	if (buf == NULL)
 428		return USB_STOR_TRANSPORT_ERROR;
 429
 430	usb_stor_dbg(us, "lun = %d\n", lun);
 431
 432	cmnd[0] = 0xF0;
 433	cmnd[1] = 0x09;
 434
 435	retval = rts51x_bulk_transport(us, lun, cmnd, 12,
 436				       buf, len, DMA_FROM_DEVICE, actlen);
 437	if (retval != USB_STOR_TRANSPORT_GOOD) {
 438		kfree(buf);
 439		return -EIO;
 440	}
 441
 442	memcpy(status, buf, len);
 443	kfree(buf);
 444	return 0;
 445}
 446
 447static 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, buf, 16, &(chip->status_len));
 454	if (retval != STATUS_SUCCESS)
 455		return -EIO;
 456
 457	usb_stor_dbg(us, "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
 478static int enable_oscillator(struct us_data *us)
 479{
 480	int retval;
 481	u8 value;
 482
 483	retval = rts51x_read_mem(us, 0xFE77, &value, 1);
 484	if (retval < 0)
 485		return -EIO;
 486
 487	value |= 0x04;
 488	retval = rts51x_write_mem(us, 0xFE77, &value, 1);
 489	if (retval < 0)
 490		return -EIO;
 491
 492	retval = rts51x_read_mem(us, 0xFE77, &value, 1);
 493	if (retval < 0)
 494		return -EIO;
 495
 496	if (!(value & 0x04))
 497		return -EIO;
 498
 499	return 0;
 500}
 501
 502static 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, "addr = 0xfe47, len = %d\n", len);
 509
 510	buf = kmemdup(data, 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, 0, cmnd, 12, buf, len, DMA_TO_DEVICE, NULL);
 522	kfree(buf);
 523	if (retval != USB_STOR_TRANSPORT_GOOD) {
 524		return -EIO;
 525	}
 526
 527	return 0;
 528}
 529
 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	usb_stor_dbg(us, "set 0xfe47 to 0x%x\n", value);
 549
 550	/* retval = rts51x_write_mem(us, 0xFE47, &value, 1); */
 551	retval = __do_config_autodelink(us, &value, 1);
 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
 564	if (!CHK_AUTO_DELINK(chip))
 565		return 0;
 566
 567	retval = rts51x_read_mem(us, 0xFE47, &value, 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, &value, 1);
 583		if (retval < 0)
 584			return -EIO;
 585
 586		retval = enable_oscillator(us);
 587		if (retval == 0)
 588			(void)do_config_autodelink(us, 1, 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, &value, 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, 0xFE79, &value, 1);
 611			if (retval < 0)
 612				return -EIO;
 613
 614			value = 0x01;
 615			retval = rts51x_write_mem(us, 0x48, &value, 1);
 616			if (retval < 0)
 617				return -EIO;
 618		}
 619	}
 620
 621	return 0;
 622}
 623
 624#ifdef CONFIG_PM
 625static 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, 0xFE77, &value, 1);
 636		if (retval < 0)
 637			return -EIO;
 638
 639		SET_BIT(value, 2);
 640		retval = rts51x_write_mem(us, 0xFE77, &value, 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, 0x48, &value, 1);
 647			if (retval < 0)
 648				return -EIO;
 649		}
 650
 651		retval = rts51x_read_mem(us, 0xFE47, &value, 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, 0xFE77, &value, 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, 0xFE47, &value, 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, &value, 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, 0x48, &value, 1);
 687			if (retval < 0)
 688				return -EIO;
 689		}
 690	}
 691
 692	return 0;
 693}
 694
 695static 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, "Not the specified device, return immediately!\n");
 703	} else {
 704		retval = rts51x_read_mem(us, 0xFD6F, &val, 1);
 705		if (retval == STATUS_SUCCESS && (val & 0x1F) == 0) {
 706			val = 0x1F;
 707			retval = rts51x_write_mem(us, 0xFD70, &val, 1);
 708			if (retval != STATUS_SUCCESS)
 709				usb_stor_dbg(us, "Write memory fail\n");
 710		} else {
 711			usb_stor_dbg(us, "Read memory fail, OR (val & 0x1F) != 0\n");
 712		}
 713	}
 714}
 715#endif
 716
 717#ifdef CONFIG_REALTEK_AUTOPM
 718static 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, "Not the specified device, return immediately!\n");
 726	} else {
 727		retval = rts51x_read_mem(us, 0xFD6F, buf, 1);
 728		if (retval == STATUS_SUCCESS && (buf[0] & 0x24) == 0x24) {
 729			/* SD Exist and SD WP */
 730			retval = rts51x_read_mem(us, 0xD04E, buf, 1);
 731			if (retval == STATUS_SUCCESS) {
 732				buf[0] |= 0x04;
 733				retval = rts51x_write_mem(us, 0xFD70, buf, 1);
 734				if (retval != STATUS_SUCCESS)
 735					usb_stor_dbg(us, "Write memory fail\n");
 736			} else {
 737				usb_stor_dbg(us, "Read memory fail\n");
 738			}
 739		} else {
 740			usb_stor_dbg(us, "Read memory fail, OR (buf[0]&0x24)!=0x24\n");
 741		}
 742	}
 743}
 744
 745static void rts51x_modi_suspend_timer(struct rts51x_chip *chip)
 746{
 747	struct us_data *us = chip->us;
 748
 749	usb_stor_dbg(us, "state:%d\n", rts51x_get_stat(chip));
 750
 751	chip->timer_expires = jiffies + msecs_to_jiffies(1000*ss_delay);
 752	mod_timer(&chip->rts51x_suspend_timer, chip->timer_expires);
 753}
 754
 755static 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, "RTS51X_STAT_SS, power.usage:%d\n",
 
 768			     atomic_read(&us->pusb_intf->dev.power.usage_count));
 769
 770		if (atomic_read(&us->pusb_intf->dev.power.usage_count) > 0) {
 771			usb_stor_dbg(us, "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(&us->pusb_intf->dev, true);
 775			usb_autopm_put_interface_async(us->pusb_intf);
 776			usb_stor_dbg(us, "RTS51X_STAT_SS 01, power.usage:%d\n",
 
 777				     atomic_read(&us->pusb_intf->dev.power.usage_count));
 778		}
 779		break;
 780	default:
 781		usb_stor_dbg(us, "Unknown state !!!\n");
 782		break;
 783	}
 784}
 785
 786static 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
 796static 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, "working scsi, power.usage:%d\n",
 
 810			     atomic_read(&us->pusb_intf->dev.power.usage_count));
 811
 812		if (atomic_read(&us->pusb_intf->dev.power.usage_count) <= 0) {
 813			ret = usb_autopm_get_interface(us->pusb_intf);
 814			usb_stor_dbg(us, "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, "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, "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, "ALLOW_MEDIUM_REMOVAL\n");
 846				goto out;
 847			}
 848		} else {
 849			usb_stor_dbg(us, "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	}
 868out:
 869	usb_stor_dbg(us, "state:%d\n", rts51x_get_stat(chip));
 870	if (rts51x_get_stat(chip) == RTS51X_STAT_RUN)
 871		rts51x_modi_suspend_timer(chip);
 872}
 873
 874static 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, 0, buf, 16, &(chip->status_len));
 888	if (retval != STATUS_SUCCESS) {
 889		usb_stor_dbg(us, "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(&us->pusb_dev->dev, 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(us->pusb_dev);
 923
 924	return 0;
 925}
 926#endif
 927
 928static void realtek_cr_destructor(void *extra)
 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(&chip->rts51x_suspend_timer);
 938		chip->timer_expires = 0;
 939	}
 940#endif
 941	kfree(chip->status);
 942}
 943
 944#ifdef CONFIG_PM
 945static int realtek_cr_suspend(struct usb_interface *iface, pm_message_t message)
 946{
 947	struct us_data *us = usb_get_intfdata(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(&us->dev_mutex);
 955
 956	return 0;
 957}
 958
 959static int realtek_cr_resume(struct usb_interface *iface)
 960{
 961	struct us_data *us = usb_get_intfdata(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
 973static int init_realtek_cr(struct us_data *us)
 974{
 975	struct rts51x_chip *chip;
 976	int size, i, retval;
 977
 978	chip = kzalloc(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, "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, (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, "chip->flag = 0x%x\n", chip->flag);
1016
1017	(void)config_autodelink_after_power_on(us);
1018
1019	return 0;
1020
1021INIT_FAIL:
1022	if (us->extra) {
1023		kfree(chip->status);
1024		kfree(us->extra);
1025		us->extra = NULL;
1026	}
1027
1028	return -EIO;
1029}
1030
1031static struct scsi_host_template realtek_cr_host_template;
1032
1033static 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(&us, intf, id,
1042				 (id - realtek_cr_ids) +
1043				 realtek_cr_unusual_dev_list,
1044				 &realtek_cr_host_template);
1045	if (result)
1046		return result;
1047
1048	result = usb_stor_probe2(us);
1049
1050	return result;
1051}
1052
1053static 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
1070module_usb_stor_driver(realtek_cr_driver, realtek_cr_host_template, DRV_NAME);
v4.10.11
 
   1/*
   2 * Driver for Realtek RTS51xx USB card reader
   3 *
   4 * Copyright(c) 2009 Realtek Semiconductor Corp. All rights reserved.
   5 *
   6 * This program is free software; you can redistribute it and/or modify it
   7 * under the terms of the GNU General Public License as published by the
   8 * Free Software Foundation; either version 2, or (at your option) any
   9 * later version.
  10 *
  11 * This program is distributed in the hope that it will be useful, but
  12 * WITHOUT ANY WARRANTY; without even the implied warranty of
  13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 * General Public License for more details.
  15 *
  16 * You should have received a copy of the GNU General Public License along
  17 * with this program; if not, see <http://www.gnu.org/licenses/>.
  18 *
  19 * Author:
  20 *   wwang (wei_wang@realsil.com.cn)
  21 *   No. 450, Shenhu Road, Suzhou Industry Park, Suzhou, China
  22 */
  23
  24#include <linux/module.h>
  25#include <linux/blkdev.h>
  26#include <linux/kthread.h>
  27#include <linux/sched.h>
  28#include <linux/kernel.h>
  29
  30#include <scsi/scsi.h>
  31#include <scsi/scsi_cmnd.h>
  32#include <scsi/scsi_device.h>
  33#include <linux/cdrom.h>
  34
  35#include <linux/usb.h>
  36#include <linux/slab.h>
  37#include <linux/usb_usual.h>
  38
  39#include "usb.h"
  40#include "transport.h"
  41#include "protocol.h"
  42#include "debug.h"
  43#include "scsiglue.h"
  44
  45#define DRV_NAME "ums-realtek"
  46
  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
  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
  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 {
 104	u16 vendor_id;
 105	u16 product_id;
 106	char max_lun;
 107
 108	struct rts51x_status *status;
 109	int status_len;
 110
 111	u32 flag;
 112	struct us_data *us;
 113
 114#ifdef CONFIG_REALTEK_AUTOPM
 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
 122	/* used to back up the protocol chosen in probe1 phase */
 123	proto_cmnd proto_handler_backup;
 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
 143#define VENDOR_ID(chip)			((chip)->status[0].vid)
 144#define PRODUCT_ID(chip)		((chip)->status[0].pid)
 145#define FW_VERSION(chip)		((chip)->status[0].fw_ver)
 146#define STATUS_LEN(chip)		((chip)->status_len)
 147
 148#define STATUS_SUCCESS		0
 149#define STATUS_FAIL		1
 150
 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
 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), \
 180	.driver_info = (flags) \
 181}
 182
 183static const struct usb_device_id realtek_cr_ids[] = {
 184#	include "unusual_realtek.h"
 185	{}			/* Terminating entry */
 186};
 187
 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"
 208	{}			/* Terminating entry */
 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{
 217	struct bulk_cb_wrap *bcb = (struct bulk_cb_wrap *)us->iobuf;
 218	struct bulk_cs_wrap *bcs = (struct bulk_cs_wrap *)us->iobuf;
 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);
 227	bcb->Flags = (dir == DMA_FROM_DEVICE) ? US_BULK_FLAG_IN : 0;
 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,
 238					    bcb, cbwlen, NULL);
 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) ?
 247		    us->recv_bulk_pipe : us->send_bulk_pipe;
 248		result = usb_stor_bulk_transfer_buf(us, pipe,
 249						    buf, buf_len, NULL);
 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,
 256					    bcs, US_BULK_CS_WRAP_LEN, &cswlen);
 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)) {
 262		usb_stor_dbg(us, "Signature mismatch: got %08X, expecting %08X\n",
 263			     le32_to_cpu(bcs->Signature), US_BULK_CS_SIGN);
 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
 271	/*
 272	 * try to compute the actual residue, based on how much data
 273	 * was really transferred and what the device tells us
 274	 */
 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:
 292		/*
 293		 * phase error -- note that a transport reset will be
 294		 * invoked by the invoke_transport() function
 295		 */
 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
 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);
 316	bcb->Flags = (dir == DMA_FROM_DEVICE) ? US_BULK_FLAG_IN : 0;
 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
 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,
 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);
 361
 362	usb_stor_dbg(us, "GetMaxLUN command result is %d, data is %d\n",
 363		     result, us->iobuf[0]);
 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;
 375	u8 cmnd[12] = { 0 };
 376	u8 *buf;
 377
 378	buf = kmalloc(len, GFP_NOIO);
 379	if (buf == NULL)
 380		return USB_STOR_TRANSPORT_ERROR;
 381
 382	usb_stor_dbg(us, "addr = 0x%x, len = %d\n", addr, len);
 383
 384	cmnd[0] = 0xF0;
 385	cmnd[1] = 0x0D;
 386	cmnd[2] = (u8) (addr >> 8);
 387	cmnd[3] = (u8) addr;
 388	cmnd[4] = (u8) (len >> 8);
 389	cmnd[5] = (u8) len;
 390
 391	retval = rts51x_bulk_transport(us, 0, cmnd, 12,
 392				       buf, len, DMA_FROM_DEVICE, NULL);
 393	if (retval != USB_STOR_TRANSPORT_GOOD) {
 394		kfree(buf);
 395		return -EIO;
 396	}
 397
 398	memcpy(data, buf, len);
 399	kfree(buf);
 400	return 0;
 401}
 402
 403static int rts51x_write_mem(struct us_data *us, u16 addr, u8 *data, u16 len)
 404{
 405	int retval;
 406	u8 cmnd[12] = { 0 };
 407	u8 *buf;
 408
 409	buf = kmemdup(data, len, GFP_NOIO);
 410	if (buf == NULL)
 411		return USB_STOR_TRANSPORT_ERROR;
 412
 413	usb_stor_dbg(us, "addr = 0x%x, len = %d\n", addr, len);
 414
 415	cmnd[0] = 0xF0;
 416	cmnd[1] = 0x0E;
 417	cmnd[2] = (u8) (addr >> 8);
 418	cmnd[3] = (u8) addr;
 419	cmnd[4] = (u8) (len >> 8);
 420	cmnd[5] = (u8) len;
 421
 422	retval = rts51x_bulk_transport(us, 0, cmnd, 12,
 423				       buf, len, DMA_TO_DEVICE, NULL);
 424	kfree(buf);
 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;
 435	u8 cmnd[12] = { 0 };
 436	u8 *buf;
 437
 438	buf = kmalloc(len, GFP_NOIO);
 439	if (buf == NULL)
 440		return USB_STOR_TRANSPORT_ERROR;
 441
 442	usb_stor_dbg(us, "lun = %d\n", lun);
 443
 444	cmnd[0] = 0xF0;
 445	cmnd[1] = 0x09;
 446
 447	retval = rts51x_bulk_transport(us, lun, cmnd, 12,
 448				       buf, len, DMA_FROM_DEVICE, actlen);
 449	if (retval != USB_STOR_TRANSPORT_GOOD) {
 450		kfree(buf);
 451		return -EIO;
 452	}
 453
 454	memcpy(status, buf, len);
 455	kfree(buf);
 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));
 466	if (retval != STATUS_SUCCESS)
 467		return -EIO;
 468
 469	usb_stor_dbg(us, "chip->status_len = %d\n", chip->status_len);
 470
 471	chip->status[lun].vid = ((u16) buf[0] << 8) | buf[1];
 472	chip->status[lun].pid = ((u16) buf[2] << 8) | buf[3];
 473	chip->status[lun].cur_lun = buf[4];
 474	chip->status[lun].card_type = buf[5];
 475	chip->status[lun].total_lun = buf[6];
 476	chip->status[lun].fw_ver = ((u16) buf[7] << 8) | buf[8];
 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
 514static int __do_config_autodelink(struct us_data *us, u8 *data, u16 len)
 515{
 516	int retval;
 517	u8 cmnd[12] = {0};
 518	u8 *buf;
 519
 520	usb_stor_dbg(us, "addr = 0xfe47, len = %d\n", len);
 521
 522	buf = kmemdup(data, len, GFP_NOIO);
 523	if (!buf)
 524		return USB_STOR_TRANSPORT_ERROR;
 525
 526	cmnd[0] = 0xF0;
 527	cmnd[1] = 0x0E;
 528	cmnd[2] = 0xfe;
 529	cmnd[3] = 0x47;
 530	cmnd[4] = (u8)(len >> 8);
 531	cmnd[5] = (u8)len;
 532
 533	retval = rts51x_bulk_transport_special(us, 0, cmnd, 12, buf, len, DMA_TO_DEVICE, NULL);
 534	kfree(buf);
 535	if (retval != USB_STOR_TRANSPORT_GOOD) {
 536		return -EIO;
 537	}
 538
 539	return 0;
 540}
 541
 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
 560	usb_stor_dbg(us, "set 0xfe47 to 0x%x\n", value);
 561
 562	/* retval = rts51x_write_mem(us, 0xFE47, &value, 1); */
 563	retval = __do_config_autodelink(us, &value, 1);
 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
 593		/* retval = rts51x_write_mem(us, 0xFE47, &value, 1); */
 594		retval = __do_config_autodelink(us, &value, 1);
 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) ||
 610		    CHECK_ID(chip, 0x0138, 0x3880)) {
 611			CLR_BIT(value, 0);
 612			CLR_BIT(value, 7);
 613		}
 614
 615		/* retval = rts51x_write_mem(us, 0xFE47, &value, 1); */
 616		retval = __do_config_autodelink(us, &value, 1);
 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
 636#ifdef CONFIG_PM
 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) ||
 675		    CHECK_ID(chip, 0x0138, 0x3880) ||
 676		    CHECK_ID(chip, 0x0138, 0x3882)) {
 677			retval = rts51x_read_mem(us, 0xFE47, &value, 1);
 678			if (retval < 0)
 679				return -EIO;
 680
 681			if (CHECK_ID(chip, 0x0159, 0x5889) ||
 682			    CHECK_ID(chip, 0x0138, 0x3880)) {
 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
 690			/* retval = rts51x_write_mem(us, 0xFE47, &value, 1); */
 691			retval = __do_config_autodelink(us, &value, 1);
 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
 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
 713	if ((PRODUCT_ID(chip) != 0x0158) || (FW_VERSION(chip) != 0x5895)) {
 714		usb_stor_dbg(us, "Not the specified device, return immediately!\n");
 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)
 721				usb_stor_dbg(us, "Write memory fail\n");
 722		} else {
 723			usb_stor_dbg(us, "Read memory fail, OR (val & 0x1F) != 0\n");
 724		}
 725	}
 726}
 727#endif
 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
 736	if ((PRODUCT_ID(chip) != 0x0158) || (FW_VERSION(chip) != 0x5895)) {
 737		usb_stor_dbg(us, "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					usb_stor_dbg(us, "Write memory fail\n");
 748			} else {
 749				usb_stor_dbg(us, "Read memory fail\n");
 750			}
 751		} else {
 752			usb_stor_dbg(us, "Read memory fail, OR (buf[0]&0x24)!=0x24\n");
 753		}
 754	}
 755}
 756
 757static void rts51x_modi_suspend_timer(struct rts51x_chip *chip)
 758{
 759	struct us_data *us = chip->us;
 760
 761	usb_stor_dbg(us, "state:%d\n", 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
 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
 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:
 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));
 782
 783		if (atomic_read(&us->pusb_intf->pm_usage_cnt) > 0) {
 784			usb_stor_dbg(us, "Ready to enter SS state\n");
 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);
 788			usb_autopm_put_interface_async(us->pusb_intf);
 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));
 792		}
 793		break;
 794	default:
 795		usb_stor_dbg(us, "Unknown state !!!\n");
 796		break;
 797	}
 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
 810static void rts51x_invoke_transport(struct scsi_cmnd *srb, struct us_data *us)
 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
 822	if (working_scsi(srb)) {
 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));
 826
 827		if (atomic_read(&us->pusb_intf->pm_usage_cnt) <= 0) {
 828			ret = usb_autopm_get_interface(us->pusb_intf);
 829			usb_stor_dbg(us, "working scsi, ret=%d\n", ret);
 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) {
 836			usb_stor_dbg(us, "NOT working scsi\n");
 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				}
 847				usb_stor_dbg(us, "TEST_UNIT_READY\n");
 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				}
 860				usb_stor_dbg(us, "ALLOW_MEDIUM_REMOVAL\n");
 861				goto out;
 862			}
 863		} else {
 864			usb_stor_dbg(us, "NOT working scsi, not SS\n");
 865			chip->proto_handler_backup(srb, us);
 866			/* Check whether card is plugged in */
 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:
 884	usb_stor_dbg(us, "state:%d\n", rts51x_get_stat(chip));
 885	if (rts51x_get_stat(chip) == RTS51X_STAT_RUN)
 886		rts51x_modi_suspend_timer(chip);
 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) {
 904		usb_stor_dbg(us, "Read status fail\n");
 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
 937	/* enable autosuspend function of the usb device */
 938	usb_enable_autosuspend(us->pusb_dev);
 939
 940	return 0;
 941}
 942#endif
 943
 944static void realtek_cr_destructor(void *extra)
 945{
 946	struct rts51x_chip *chip = extra;
 947
 948	if (!chip)
 949		return;
 950
 951#ifdef CONFIG_REALTEK_AUTOPM
 952	if (ss_en) {
 953		del_timer(&chip->rts51x_suspend_timer);
 954		chip->timer_expires = 0;
 955	}
 956#endif
 957	kfree(chip->status);
 958}
 959
 960#ifdef CONFIG_PM
 961static int realtek_cr_suspend(struct usb_interface *iface, pm_message_t message)
 962{
 963	struct us_data *us = usb_get_intfdata(iface);
 964
 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
 972	return 0;
 973}
 974
 975static int realtek_cr_resume(struct usb_interface *iface)
 976{
 977	struct us_data *us = usb_get_intfdata(iface);
 978
 979	fw5895_init(us);
 980	config_autodelink_after_power_on(us);
 981
 982	return 0;
 983}
 984#else
 985#define realtek_cr_suspend	NULL
 986#define realtek_cr_resume	NULL
 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;
1000	us->max_lun = chip->max_lun = rts51x_get_max_lun(us);
1001	chip->us = us;
1002
1003	usb_stor_dbg(us, "chip->max_lun = %d\n", chip->max_lun);
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++) {
1011		retval = rts51x_check_status(us, (u8) i);
1012		if (retval < 0)
1013			goto INIT_FAIL;
1014	}
1015
1016	if (CHECK_FW_VER(chip, 0x5888) || CHECK_FW_VER(chip, 0x5889) ||
1017	    CHECK_FW_VER(chip, 0x5901))
1018		SET_AUTO_DELINK(chip);
1019	if (STATUS_LEN(chip) == 16) {
1020		if (SUPPORT_AUTO_DELINK(chip))
1021			SET_AUTO_DELINK(chip);
 
 
 
 
1022	}
1023#ifdef CONFIG_REALTEK_AUTOPM
1024	if (ss_en)
1025		realtek_cr_autosuspend_setup(us);
1026#endif
1027
1028	usb_stor_dbg(us, "chip->flag = 0x%x\n", chip->flag);
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
1044static struct scsi_host_template realtek_cr_host_template;
1045
1046static int realtek_cr_probe(struct usb_interface *intf,
1047			    const struct usb_device_id *id)
1048{
1049	struct us_data *us;
1050	int result;
1051
1052	dev_dbg(&intf->dev, "Probe Realtek Card Reader!\n");
1053
1054	result = usb_stor_probe1(&us, intf, id,
1055				 (id - realtek_cr_ids) +
1056				 realtek_cr_unusual_dev_list,
1057				 &realtek_cr_host_template);
1058	if (result)
1059		return result;
1060
1061	result = usb_stor_probe2(us);
1062
1063	return result;
1064}
1065
1066static struct usb_driver realtek_cr_driver = {
1067	.name = DRV_NAME,
1068	.probe = realtek_cr_probe,
1069	.disconnect = usb_stor_disconnect,
1070	/* .suspend =      usb_stor_suspend, */
1071	/* .resume =       usb_stor_resume, */
1072	.reset_resume = usb_stor_reset_resume,
1073	.suspend = realtek_cr_suspend,
1074	.resume = realtek_cr_resume,
1075	.pre_reset = usb_stor_pre_reset,
1076	.post_reset = usb_stor_post_reset,
1077	.id_table = realtek_cr_ids,
1078	.soft_unbind = 1,
1079	.supports_autosuspend = 1,
1080	.no_dynamic_id = 1,
1081};
1082
1083module_usb_stor_driver(realtek_cr_driver, realtek_cr_host_template, DRV_NAME);