1 /* Special Initializers for certain USB Mass Storage devices
2  *
3  * Current development and maintenance by:
4  *   (c) 1999, 2000 Matthew Dharm (mdharm-usb@one-eyed-alien.net)
5  *
6  * This driver is based on the 'USB Mass Storage Class' document. This
7  * describes in detail the protocol used to communicate with such
8  * devices.  Clearly, the designers had SCSI and ATAPI commands in
9  * mind when they created this document.  The commands are all very
10  * similar to commands in the SCSI-II and ATAPI specifications.
11  *
12  * It is important to note that in a number of cases this class
13  * exhibits class-specific exemptions from the USB specification.
14  * Notably the usage of NAK, STALL and ACK differs from the norm, in
15  * that they are used to communicate wait, failed and OK on commands.
16  *
17  * Also, for certain devices, the interrupt endpoint is used to convey
18  * status of a command.
19  *
20  * Please see http://www.one-eyed-alien.net/~mdharm/linux-usb for more
21  * information about this driver.
22  *
23  * This program is free software; you can redistribute it and/or modify it
24  * under the terms of the GNU General Public License as published by the
25  * Free Software Foundation; either version 2, or (at your option) any
26  * later version.
27  *
28  * This program is distributed in the hope that it will be useful, but
29  * WITHOUT ANY WARRANTY; without even the implied warranty of
30  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
31  * General Public License for more details.
32  *
33  * You should have received a copy of the GNU General Public License along
34  * with this program; if not, write to the Free Software Foundation, Inc.,
35  * 675 Mass Ave, Cambridge, MA 02139, USA.
36  */
37 
38 #include <linux/errno.h>
39 
40 #include "usb.h"
41 #include "initializers.h"
42 #include "debug.h"
43 #include "transport.h"
44 
45 /* This places the Shuttle/SCM USB<->SCSI bridge devices in multi-target
46  * mode */
47 int usb_stor_euscsi_init(struct us_data *us)
48 {
49 	int result;
50 
51 	US_DEBUGP("Attempting to init eUSCSI bridge...\n");
52 	us->iobuf[0] = 0x1;
53 	result = usb_stor_control_msg(us, us->send_ctrl_pipe,
54 			0x0C, USB_RECIP_INTERFACE | USB_TYPE_VENDOR,
55 			0x01, 0x0, us->iobuf, 0x1, 5000);
56 	US_DEBUGP("-- result is %d\n", result);
57 
58 	return 0;
59 }
60 
61 /* This function is required to activate all four slots on the UCR-61S2B
62  * flash reader */
63 int usb_stor_ucr61s2b_init(struct us_data *us)
64 {
65 	struct bulk_cb_wrap *bcb = (struct bulk_cb_wrap*) us->iobuf;
66 	struct bulk_cs_wrap *bcs = (struct bulk_cs_wrap*) us->iobuf;
67 	int res;
68 	unsigned int partial;
69 	static char init_string[] = "\xec\x0a\x06\x00$PCCHIPS";
70 
71 	US_DEBUGP("Sending UCR-61S2B initialization packet...\n");
72 
73 	bcb->Signature = cpu_to_le32(US_BULK_CB_SIGN);
74 	bcb->Tag = 0;
75 	bcb->DataTransferLength = cpu_to_le32(0);
76 	bcb->Flags = bcb->Lun = 0;
77 	bcb->Length = sizeof(init_string) - 1;
78 	memset(bcb->CDB, 0, sizeof(bcb->CDB));
79 	memcpy(bcb->CDB, init_string, sizeof(init_string) - 1);
80 
81 	res = usb_stor_bulk_transfer_buf(us, us->send_bulk_pipe, bcb,
82 			US_BULK_CB_WRAP_LEN, &partial);
83 	if (res)
84 		return -EIO;
85 
86 	US_DEBUGP("Getting status packet...\n");
87 	res = usb_stor_bulk_transfer_buf(us, us->recv_bulk_pipe, bcs,
88 			US_BULK_CS_WRAP_LEN, &partial);
89 	if (res)
90 		return -EIO;
91 
92 	return 0;
93 }
94 
95 /* This places the HUAWEI usb dongles in multi-port mode */
96 static int usb_stor_huawei_feature_init(struct us_data *us)
97 {
98 	int result;
99 
100 	result = usb_stor_control_msg(us, us->send_ctrl_pipe,
101 				      USB_REQ_SET_FEATURE,
102 				      USB_TYPE_STANDARD | USB_RECIP_DEVICE,
103 				      0x01, 0x0, NULL, 0x0, 1000);
104 	US_DEBUGP("Huawei mode set result is %d\n", result);
105 	return 0;
106 }
107 
108 /*
109  * It will send a scsi switch command called rewind' to huawei dongle.
110  * When the dongle receives this command at the first time,
111  * it will reboot immediately. After rebooted, it will ignore this command.
112  * So it is  unnecessary to read its response.
113  */
114 static int usb_stor_huawei_scsi_init(struct us_data *us)
115 {
116 	int result = 0;
117 	int act_len = 0;
118 	struct bulk_cb_wrap *bcbw = (struct bulk_cb_wrap *) us->iobuf;
119 	char rewind_cmd[] = {0x11, 0x06, 0x20, 0x00, 0x00, 0x01, 0x01, 0x00,
120 			0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00};
121 
122 	bcbw->Signature = cpu_to_le32(US_BULK_CB_SIGN);
123 	bcbw->Tag = 0;
124 	bcbw->DataTransferLength = 0;
125 	bcbw->Flags = bcbw->Lun = 0;
126 	bcbw->Length = sizeof(rewind_cmd);
127 	memset(bcbw->CDB, 0, sizeof(bcbw->CDB));
128 	memcpy(bcbw->CDB, rewind_cmd, sizeof(rewind_cmd));
129 
130 	result = usb_stor_bulk_transfer_buf(us, us->send_bulk_pipe, bcbw,
131 					US_BULK_CB_WRAP_LEN, &act_len);
132 	US_DEBUGP("transfer actual length=%d, result=%d\n", act_len, result);
133 	return result;
134 }
135 
136 /*
137  * It tries to find the supported Huawei USB dongles.
138  * In Huawei, they assign the following product IDs
139  * for all of their mobile broadband dongles,
140  * including the new dongles in the future.
141  * So if the product ID is not included in this list,
142  * it means it is not Huawei's mobile broadband dongles.
143  */
144 static int usb_stor_huawei_dongles_pid(struct us_data *us)
145 {
146 	struct usb_interface_descriptor *idesc;
147 	int idProduct;
148 
149 	idesc = &us->pusb_intf->cur_altsetting->desc;
150 	idProduct = us->pusb_dev->descriptor.idProduct;
151 	/* The first port is CDROM,
152 	 * means the dongle in the single port mode,
153 	 * and a switch command is required to be sent. */
154 	if (idesc && idesc->bInterfaceNumber == 0) {
155 		if ((idProduct == 0x1001)
156 			|| (idProduct == 0x1003)
157 			|| (idProduct == 0x1004)
158 			|| (idProduct >= 0x1401 && idProduct <= 0x1500)
159 			|| (idProduct >= 0x1505 && idProduct <= 0x1600)
160 			|| (idProduct >= 0x1c02 && idProduct <= 0x2202)) {
161 			return 1;
162 		}
163 	}
164 	return 0;
165 }
166 
167 int usb_stor_huawei_init(struct us_data *us)
168 {
169 	int result = 0;
170 
171 	if (usb_stor_huawei_dongles_pid(us)) {
172 		if (us->pusb_dev->descriptor.idProduct >= 0x1446)
173 			result = usb_stor_huawei_scsi_init(us);
174 		else
175 			result = usb_stor_huawei_feature_init(us);
176 	}
177 	return result;
178 }
179