Merge tag 'ceph-for-4.13-rc8' of git://github.com/ceph/ceph-client
[linux/fpc-iii.git] / drivers / usb / storage / jumpshot.c
blob011e5270690a86e396fa8bf627e6022bfcbaa75f
1 /*
2 * Driver for Lexar "Jumpshot" Compact Flash reader
4 * jumpshot driver v0.1:
6 * First release
8 * Current development and maintenance by:
9 * (c) 2000 Jimmie Mayfield (mayfield+usb@sackheads.org)
11 * Many thanks to Robert Baruch for the SanDisk SmartMedia reader driver
12 * which I used as a template for this driver.
14 * Some bugfixes and scatter-gather code by Gregory P. Smith
15 * (greg-usb@electricrain.com)
17 * Fix for media change by Joerg Schneider (js@joergschneider.com)
19 * Developed with the assistance of:
21 * (C) 2002 Alan Stern <stern@rowland.org>
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.
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.
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.
39 * This driver attempts to support the Lexar Jumpshot USB CompactFlash
40 * reader. Like many other USB CompactFlash readers, the Jumpshot contains
41 * a USB-to-ATA chip.
43 * This driver supports reading and writing. If you're truly paranoid,
44 * however, you can force the driver into a write-protected state by setting
45 * the WP enable bits in jumpshot_handle_mode_sense. See the comments
46 * in that routine.
49 #include <linux/errno.h>
50 #include <linux/module.h>
51 #include <linux/slab.h>
53 #include <scsi/scsi.h>
54 #include <scsi/scsi_cmnd.h>
56 #include "usb.h"
57 #include "transport.h"
58 #include "protocol.h"
59 #include "debug.h"
60 #include "scsiglue.h"
62 #define DRV_NAME "ums-jumpshot"
64 MODULE_DESCRIPTION("Driver for Lexar \"Jumpshot\" Compact Flash reader");
65 MODULE_AUTHOR("Jimmie Mayfield <mayfield+usb@sackheads.org>");
66 MODULE_LICENSE("GPL");
69 * The table of devices
71 #define UNUSUAL_DEV(id_vendor, id_product, bcdDeviceMin, bcdDeviceMax, \
72 vendorName, productName, useProtocol, useTransport, \
73 initFunction, flags) \
74 { USB_DEVICE_VER(id_vendor, id_product, bcdDeviceMin, bcdDeviceMax), \
75 .driver_info = (flags) }
77 static struct usb_device_id jumpshot_usb_ids[] = {
78 # include "unusual_jumpshot.h"
79 { } /* Terminating entry */
81 MODULE_DEVICE_TABLE(usb, jumpshot_usb_ids);
83 #undef UNUSUAL_DEV
86 * The flags table
88 #define UNUSUAL_DEV(idVendor, idProduct, bcdDeviceMin, bcdDeviceMax, \
89 vendor_name, product_name, use_protocol, use_transport, \
90 init_function, Flags) \
91 { \
92 .vendorName = vendor_name, \
93 .productName = product_name, \
94 .useProtocol = use_protocol, \
95 .useTransport = use_transport, \
96 .initFunction = init_function, \
99 static struct us_unusual_dev jumpshot_unusual_dev_list[] = {
100 # include "unusual_jumpshot.h"
101 { } /* Terminating entry */
104 #undef UNUSUAL_DEV
107 struct jumpshot_info {
108 unsigned long sectors; /* total sector count */
109 unsigned long ssize; /* sector size in bytes */
111 /* the following aren't used yet */
112 unsigned char sense_key;
113 unsigned long sense_asc; /* additional sense code */
114 unsigned long sense_ascq; /* additional sense code qualifier */
117 static inline int jumpshot_bulk_read(struct us_data *us,
118 unsigned char *data,
119 unsigned int len)
121 if (len == 0)
122 return USB_STOR_XFER_GOOD;
124 usb_stor_dbg(us, "len = %d\n", len);
125 return usb_stor_bulk_transfer_buf(us, us->recv_bulk_pipe,
126 data, len, NULL);
130 static inline int jumpshot_bulk_write(struct us_data *us,
131 unsigned char *data,
132 unsigned int len)
134 if (len == 0)
135 return USB_STOR_XFER_GOOD;
137 usb_stor_dbg(us, "len = %d\n", len);
138 return usb_stor_bulk_transfer_buf(us, us->send_bulk_pipe,
139 data, len, NULL);
143 static int jumpshot_get_status(struct us_data *us)
145 int rc;
147 if (!us)
148 return USB_STOR_TRANSPORT_ERROR;
150 // send the setup
151 rc = usb_stor_ctrl_transfer(us, us->recv_ctrl_pipe,
152 0, 0xA0, 0, 7, us->iobuf, 1);
154 if (rc != USB_STOR_XFER_GOOD)
155 return USB_STOR_TRANSPORT_ERROR;
157 if (us->iobuf[0] != 0x50) {
158 usb_stor_dbg(us, "0x%2x\n", us->iobuf[0]);
159 return USB_STOR_TRANSPORT_ERROR;
162 return USB_STOR_TRANSPORT_GOOD;
165 static int jumpshot_read_data(struct us_data *us,
166 struct jumpshot_info *info,
167 u32 sector,
168 u32 sectors)
170 unsigned char *command = us->iobuf;
171 unsigned char *buffer;
172 unsigned char thistime;
173 unsigned int totallen, alloclen;
174 int len, result;
175 unsigned int sg_offset = 0;
176 struct scatterlist *sg = NULL;
178 // we're working in LBA mode. according to the ATA spec,
179 // we can support up to 28-bit addressing. I don't know if Jumpshot
180 // supports beyond 24-bit addressing. It's kind of hard to test
181 // since it requires > 8GB CF card.
183 if (sector > 0x0FFFFFFF)
184 return USB_STOR_TRANSPORT_ERROR;
186 totallen = sectors * info->ssize;
188 // Since we don't read more than 64 KB at a time, we have to create
189 // a bounce buffer and move the data a piece at a time between the
190 // bounce buffer and the actual transfer buffer.
192 alloclen = min(totallen, 65536u);
193 buffer = kmalloc(alloclen, GFP_NOIO);
194 if (buffer == NULL)
195 return USB_STOR_TRANSPORT_ERROR;
197 do {
198 // loop, never allocate or transfer more than 64k at once
199 // (min(128k, 255*info->ssize) is the real limit)
200 len = min(totallen, alloclen);
201 thistime = (len / info->ssize) & 0xff;
203 command[0] = 0;
204 command[1] = thistime;
205 command[2] = sector & 0xFF;
206 command[3] = (sector >> 8) & 0xFF;
207 command[4] = (sector >> 16) & 0xFF;
209 command[5] = 0xE0 | ((sector >> 24) & 0x0F);
210 command[6] = 0x20;
212 // send the setup + command
213 result = usb_stor_ctrl_transfer(us, us->send_ctrl_pipe,
214 0, 0x20, 0, 1, command, 7);
215 if (result != USB_STOR_XFER_GOOD)
216 goto leave;
218 // read the result
219 result = jumpshot_bulk_read(us, buffer, len);
220 if (result != USB_STOR_XFER_GOOD)
221 goto leave;
223 usb_stor_dbg(us, "%d bytes\n", len);
225 // Store the data in the transfer buffer
226 usb_stor_access_xfer_buf(buffer, len, us->srb,
227 &sg, &sg_offset, TO_XFER_BUF);
229 sector += thistime;
230 totallen -= len;
231 } while (totallen > 0);
233 kfree(buffer);
234 return USB_STOR_TRANSPORT_GOOD;
236 leave:
237 kfree(buffer);
238 return USB_STOR_TRANSPORT_ERROR;
242 static int jumpshot_write_data(struct us_data *us,
243 struct jumpshot_info *info,
244 u32 sector,
245 u32 sectors)
247 unsigned char *command = us->iobuf;
248 unsigned char *buffer;
249 unsigned char thistime;
250 unsigned int totallen, alloclen;
251 int len, result, waitcount;
252 unsigned int sg_offset = 0;
253 struct scatterlist *sg = NULL;
255 // we're working in LBA mode. according to the ATA spec,
256 // we can support up to 28-bit addressing. I don't know if Jumpshot
257 // supports beyond 24-bit addressing. It's kind of hard to test
258 // since it requires > 8GB CF card.
260 if (sector > 0x0FFFFFFF)
261 return USB_STOR_TRANSPORT_ERROR;
263 totallen = sectors * info->ssize;
265 // Since we don't write more than 64 KB at a time, we have to create
266 // a bounce buffer and move the data a piece at a time between the
267 // bounce buffer and the actual transfer buffer.
269 alloclen = min(totallen, 65536u);
270 buffer = kmalloc(alloclen, GFP_NOIO);
271 if (buffer == NULL)
272 return USB_STOR_TRANSPORT_ERROR;
274 do {
275 // loop, never allocate or transfer more than 64k at once
276 // (min(128k, 255*info->ssize) is the real limit)
278 len = min(totallen, alloclen);
279 thistime = (len / info->ssize) & 0xff;
281 // Get the data from the transfer buffer
282 usb_stor_access_xfer_buf(buffer, len, us->srb,
283 &sg, &sg_offset, FROM_XFER_BUF);
285 command[0] = 0;
286 command[1] = thistime;
287 command[2] = sector & 0xFF;
288 command[3] = (sector >> 8) & 0xFF;
289 command[4] = (sector >> 16) & 0xFF;
291 command[5] = 0xE0 | ((sector >> 24) & 0x0F);
292 command[6] = 0x30;
294 // send the setup + command
295 result = usb_stor_ctrl_transfer(us, us->send_ctrl_pipe,
296 0, 0x20, 0, 1, command, 7);
297 if (result != USB_STOR_XFER_GOOD)
298 goto leave;
300 // send the data
301 result = jumpshot_bulk_write(us, buffer, len);
302 if (result != USB_STOR_XFER_GOOD)
303 goto leave;
305 // read the result. apparently the bulk write can complete
306 // before the jumpshot drive is finished writing. so we loop
307 // here until we get a good return code
308 waitcount = 0;
309 do {
310 result = jumpshot_get_status(us);
311 if (result != USB_STOR_TRANSPORT_GOOD) {
312 // I have not experimented to find the smallest value.
314 msleep(50);
316 } while ((result != USB_STOR_TRANSPORT_GOOD) && (waitcount < 10));
318 if (result != USB_STOR_TRANSPORT_GOOD)
319 usb_stor_dbg(us, "Gah! Waitcount = 10. Bad write!?\n");
321 sector += thistime;
322 totallen -= len;
323 } while (totallen > 0);
325 kfree(buffer);
326 return result;
328 leave:
329 kfree(buffer);
330 return USB_STOR_TRANSPORT_ERROR;
333 static int jumpshot_id_device(struct us_data *us,
334 struct jumpshot_info *info)
336 unsigned char *command = us->iobuf;
337 unsigned char *reply;
338 int rc;
340 if (!info)
341 return USB_STOR_TRANSPORT_ERROR;
343 command[0] = 0xE0;
344 command[1] = 0xEC;
345 reply = kmalloc(512, GFP_NOIO);
346 if (!reply)
347 return USB_STOR_TRANSPORT_ERROR;
349 // send the setup
350 rc = usb_stor_ctrl_transfer(us, us->send_ctrl_pipe,
351 0, 0x20, 0, 6, command, 2);
353 if (rc != USB_STOR_XFER_GOOD) {
354 usb_stor_dbg(us, "Gah! send_control for read_capacity failed\n");
355 rc = USB_STOR_TRANSPORT_ERROR;
356 goto leave;
359 // read the reply
360 rc = jumpshot_bulk_read(us, reply, 512);
361 if (rc != USB_STOR_XFER_GOOD) {
362 rc = USB_STOR_TRANSPORT_ERROR;
363 goto leave;
366 info->sectors = ((u32)(reply[117]) << 24) |
367 ((u32)(reply[116]) << 16) |
368 ((u32)(reply[115]) << 8) |
369 ((u32)(reply[114]) );
371 rc = USB_STOR_TRANSPORT_GOOD;
373 leave:
374 kfree(reply);
375 return rc;
378 static int jumpshot_handle_mode_sense(struct us_data *us,
379 struct scsi_cmnd * srb,
380 int sense_6)
382 static unsigned char rw_err_page[12] = {
383 0x1, 0xA, 0x21, 1, 0, 0, 0, 0, 1, 0, 0, 0
385 static unsigned char cache_page[12] = {
386 0x8, 0xA, 0x1, 0, 0, 0, 0, 0, 0, 0, 0, 0
388 static unsigned char rbac_page[12] = {
389 0x1B, 0xA, 0, 0x81, 0, 0, 0, 0, 0, 0, 0, 0
391 static unsigned char timer_page[8] = {
392 0x1C, 0x6, 0, 0, 0, 0
394 unsigned char pc, page_code;
395 unsigned int i = 0;
396 struct jumpshot_info *info = (struct jumpshot_info *) (us->extra);
397 unsigned char *ptr = us->iobuf;
399 pc = srb->cmnd[2] >> 6;
400 page_code = srb->cmnd[2] & 0x3F;
402 switch (pc) {
403 case 0x0:
404 usb_stor_dbg(us, "Current values\n");
405 break;
406 case 0x1:
407 usb_stor_dbg(us, "Changeable values\n");
408 break;
409 case 0x2:
410 usb_stor_dbg(us, "Default values\n");
411 break;
412 case 0x3:
413 usb_stor_dbg(us, "Saves values\n");
414 break;
417 memset(ptr, 0, 8);
418 if (sense_6) {
419 ptr[2] = 0x00; // WP enable: 0x80
420 i = 4;
421 } else {
422 ptr[3] = 0x00; // WP enable: 0x80
423 i = 8;
426 switch (page_code) {
427 case 0x0:
428 // vendor-specific mode
429 info->sense_key = 0x05;
430 info->sense_asc = 0x24;
431 info->sense_ascq = 0x00;
432 return USB_STOR_TRANSPORT_FAILED;
434 case 0x1:
435 memcpy(ptr + i, rw_err_page, sizeof(rw_err_page));
436 i += sizeof(rw_err_page);
437 break;
439 case 0x8:
440 memcpy(ptr + i, cache_page, sizeof(cache_page));
441 i += sizeof(cache_page);
442 break;
444 case 0x1B:
445 memcpy(ptr + i, rbac_page, sizeof(rbac_page));
446 i += sizeof(rbac_page);
447 break;
449 case 0x1C:
450 memcpy(ptr + i, timer_page, sizeof(timer_page));
451 i += sizeof(timer_page);
452 break;
454 case 0x3F:
455 memcpy(ptr + i, timer_page, sizeof(timer_page));
456 i += sizeof(timer_page);
457 memcpy(ptr + i, rbac_page, sizeof(rbac_page));
458 i += sizeof(rbac_page);
459 memcpy(ptr + i, cache_page, sizeof(cache_page));
460 i += sizeof(cache_page);
461 memcpy(ptr + i, rw_err_page, sizeof(rw_err_page));
462 i += sizeof(rw_err_page);
463 break;
466 if (sense_6)
467 ptr[0] = i - 1;
468 else
469 ((__be16 *) ptr)[0] = cpu_to_be16(i - 2);
470 usb_stor_set_xfer_buf(ptr, i, srb);
472 return USB_STOR_TRANSPORT_GOOD;
476 static void jumpshot_info_destructor(void *extra)
478 // this routine is a placeholder...
479 // currently, we don't allocate any extra blocks so we're okay
484 // Transport for the Lexar 'Jumpshot'
486 static int jumpshot_transport(struct scsi_cmnd *srb, struct us_data *us)
488 struct jumpshot_info *info;
489 int rc;
490 unsigned long block, blocks;
491 unsigned char *ptr = us->iobuf;
492 static unsigned char inquiry_response[8] = {
493 0x00, 0x80, 0x00, 0x01, 0x1F, 0x00, 0x00, 0x00
496 if (!us->extra) {
497 us->extra = kzalloc(sizeof(struct jumpshot_info), GFP_NOIO);
498 if (!us->extra)
499 return USB_STOR_TRANSPORT_ERROR;
501 us->extra_destructor = jumpshot_info_destructor;
504 info = (struct jumpshot_info *) (us->extra);
506 if (srb->cmnd[0] == INQUIRY) {
507 usb_stor_dbg(us, "INQUIRY - Returning bogus response\n");
508 memcpy(ptr, inquiry_response, sizeof(inquiry_response));
509 fill_inquiry_response(us, ptr, 36);
510 return USB_STOR_TRANSPORT_GOOD;
513 if (srb->cmnd[0] == READ_CAPACITY) {
514 info->ssize = 0x200; // hard coded 512 byte sectors as per ATA spec
516 rc = jumpshot_get_status(us);
517 if (rc != USB_STOR_TRANSPORT_GOOD)
518 return rc;
520 rc = jumpshot_id_device(us, info);
521 if (rc != USB_STOR_TRANSPORT_GOOD)
522 return rc;
524 usb_stor_dbg(us, "READ_CAPACITY: %ld sectors, %ld bytes per sector\n",
525 info->sectors, info->ssize);
527 // build the reply
529 ((__be32 *) ptr)[0] = cpu_to_be32(info->sectors - 1);
530 ((__be32 *) ptr)[1] = cpu_to_be32(info->ssize);
531 usb_stor_set_xfer_buf(ptr, 8, srb);
533 return USB_STOR_TRANSPORT_GOOD;
536 if (srb->cmnd[0] == MODE_SELECT_10) {
537 usb_stor_dbg(us, "Gah! MODE_SELECT_10\n");
538 return USB_STOR_TRANSPORT_ERROR;
541 if (srb->cmnd[0] == READ_10) {
542 block = ((u32)(srb->cmnd[2]) << 24) | ((u32)(srb->cmnd[3]) << 16) |
543 ((u32)(srb->cmnd[4]) << 8) | ((u32)(srb->cmnd[5]));
545 blocks = ((u32)(srb->cmnd[7]) << 8) | ((u32)(srb->cmnd[8]));
547 usb_stor_dbg(us, "READ_10: read block 0x%04lx count %ld\n",
548 block, blocks);
549 return jumpshot_read_data(us, info, block, blocks);
552 if (srb->cmnd[0] == READ_12) {
553 // I don't think we'll ever see a READ_12 but support it anyway...
555 block = ((u32)(srb->cmnd[2]) << 24) | ((u32)(srb->cmnd[3]) << 16) |
556 ((u32)(srb->cmnd[4]) << 8) | ((u32)(srb->cmnd[5]));
558 blocks = ((u32)(srb->cmnd[6]) << 24) | ((u32)(srb->cmnd[7]) << 16) |
559 ((u32)(srb->cmnd[8]) << 8) | ((u32)(srb->cmnd[9]));
561 usb_stor_dbg(us, "READ_12: read block 0x%04lx count %ld\n",
562 block, blocks);
563 return jumpshot_read_data(us, info, block, blocks);
566 if (srb->cmnd[0] == WRITE_10) {
567 block = ((u32)(srb->cmnd[2]) << 24) | ((u32)(srb->cmnd[3]) << 16) |
568 ((u32)(srb->cmnd[4]) << 8) | ((u32)(srb->cmnd[5]));
570 blocks = ((u32)(srb->cmnd[7]) << 8) | ((u32)(srb->cmnd[8]));
572 usb_stor_dbg(us, "WRITE_10: write block 0x%04lx count %ld\n",
573 block, blocks);
574 return jumpshot_write_data(us, info, block, blocks);
577 if (srb->cmnd[0] == WRITE_12) {
578 // I don't think we'll ever see a WRITE_12 but support it anyway...
580 block = ((u32)(srb->cmnd[2]) << 24) | ((u32)(srb->cmnd[3]) << 16) |
581 ((u32)(srb->cmnd[4]) << 8) | ((u32)(srb->cmnd[5]));
583 blocks = ((u32)(srb->cmnd[6]) << 24) | ((u32)(srb->cmnd[7]) << 16) |
584 ((u32)(srb->cmnd[8]) << 8) | ((u32)(srb->cmnd[9]));
586 usb_stor_dbg(us, "WRITE_12: write block 0x%04lx count %ld\n",
587 block, blocks);
588 return jumpshot_write_data(us, info, block, blocks);
592 if (srb->cmnd[0] == TEST_UNIT_READY) {
593 usb_stor_dbg(us, "TEST_UNIT_READY\n");
594 return jumpshot_get_status(us);
597 if (srb->cmnd[0] == REQUEST_SENSE) {
598 usb_stor_dbg(us, "REQUEST_SENSE\n");
600 memset(ptr, 0, 18);
601 ptr[0] = 0xF0;
602 ptr[2] = info->sense_key;
603 ptr[7] = 11;
604 ptr[12] = info->sense_asc;
605 ptr[13] = info->sense_ascq;
606 usb_stor_set_xfer_buf(ptr, 18, srb);
608 return USB_STOR_TRANSPORT_GOOD;
611 if (srb->cmnd[0] == MODE_SENSE) {
612 usb_stor_dbg(us, "MODE_SENSE_6 detected\n");
613 return jumpshot_handle_mode_sense(us, srb, 1);
616 if (srb->cmnd[0] == MODE_SENSE_10) {
617 usb_stor_dbg(us, "MODE_SENSE_10 detected\n");
618 return jumpshot_handle_mode_sense(us, srb, 0);
621 if (srb->cmnd[0] == ALLOW_MEDIUM_REMOVAL) {
623 * sure. whatever. not like we can stop the user from popping
624 * the media out of the device (no locking doors, etc)
626 return USB_STOR_TRANSPORT_GOOD;
629 if (srb->cmnd[0] == START_STOP) {
631 * this is used by sd.c'check_scsidisk_media_change to detect
632 * media change
634 usb_stor_dbg(us, "START_STOP\n");
636 * the first jumpshot_id_device after a media change returns
637 * an error (determined experimentally)
639 rc = jumpshot_id_device(us, info);
640 if (rc == USB_STOR_TRANSPORT_GOOD) {
641 info->sense_key = NO_SENSE;
642 srb->result = SUCCESS;
643 } else {
644 info->sense_key = UNIT_ATTENTION;
645 srb->result = SAM_STAT_CHECK_CONDITION;
647 return rc;
650 usb_stor_dbg(us, "Gah! Unknown command: %d (0x%x)\n",
651 srb->cmnd[0], srb->cmnd[0]);
652 info->sense_key = 0x05;
653 info->sense_asc = 0x20;
654 info->sense_ascq = 0x00;
655 return USB_STOR_TRANSPORT_FAILED;
658 static struct scsi_host_template jumpshot_host_template;
660 static int jumpshot_probe(struct usb_interface *intf,
661 const struct usb_device_id *id)
663 struct us_data *us;
664 int result;
666 result = usb_stor_probe1(&us, intf, id,
667 (id - jumpshot_usb_ids) + jumpshot_unusual_dev_list,
668 &jumpshot_host_template);
669 if (result)
670 return result;
672 us->transport_name = "Lexar Jumpshot Control/Bulk";
673 us->transport = jumpshot_transport;
674 us->transport_reset = usb_stor_Bulk_reset;
675 us->max_lun = 1;
677 result = usb_stor_probe2(us);
678 return result;
681 static struct usb_driver jumpshot_driver = {
682 .name = DRV_NAME,
683 .probe = jumpshot_probe,
684 .disconnect = usb_stor_disconnect,
685 .suspend = usb_stor_suspend,
686 .resume = usb_stor_resume,
687 .reset_resume = usb_stor_reset_resume,
688 .pre_reset = usb_stor_pre_reset,
689 .post_reset = usb_stor_post_reset,
690 .id_table = jumpshot_usb_ids,
691 .soft_unbind = 1,
692 .no_dynamic_id = 1,
695 module_usb_stor_driver(jumpshot_driver, jumpshot_host_template, DRV_NAME);