1 /* Driver for Lexar "Jumpshot" Compact Flash reader
3 * $Id: jumpshot.c,v 1.7 2002/02/25 00:40:13 mdharm Exp $
5 * jumpshot driver v0.1:
9 * Current development and maintenance by:
10 * (c) 2000 Jimmie Mayfield (mayfield+usb@sackheads.org)
12 * Many thanks to Robert Baruch for the SanDisk SmartMedia reader driver
13 * which I used as a template for this driver.
15 * Some bugfixes and scatter-gather code by Gregory P. Smith
16 * (greg-usb@electricrain.com)
18 * Fix for media change by Joerg Schneider (js@joergschneider.com)
20 * Developed with the assistance of:
22 * (C) 2002 Alan Stern <stern@rowland.org>
24 * This program is free software; you can redistribute it and/or modify it
25 * under the terms of the GNU General Public License as published by the
26 * Free Software Foundation; either version 2, or (at your option) any
29 * This program is distributed in the hope that it will be useful, but
30 * WITHOUT ANY WARRANTY; without even the implied warranty of
31 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
32 * General Public License for more details.
34 * You should have received a copy of the GNU General Public License along
35 * with this program; if not, write to the Free Software Foundation, Inc.,
36 * 675 Mass Ave, Cambridge, MA 02139, USA.
40 * This driver attempts to support the Lexar Jumpshot USB CompactFlash
41 * reader. Like many other USB CompactFlash readers, the Jumpshot contains
44 * This driver supports reading and writing. If you're truly paranoid,
45 * however, you can force the driver into a write-protected state by setting
46 * the WP enable bits in jumpshot_handle_mode_sense. See the comments
50 #include <linux/sched.h>
51 #include <linux/errno.h>
52 #include <linux/slab.h>
54 #include <scsi/scsi.h>
55 #include <scsi/scsi_cmnd.h>
58 #include "transport.h"
64 static inline int jumpshot_bulk_read(struct us_data *us,
69 return USB_STOR_XFER_GOOD;
71 US_DEBUGP("jumpshot_bulk_read: len = %d\n", len);
72 return usb_stor_bulk_transfer_buf(us, us->recv_bulk_pipe,
77 static inline int jumpshot_bulk_write(struct us_data *us,
82 return USB_STOR_XFER_GOOD;
84 US_DEBUGP("jumpshot_bulk_write: len = %d\n", len);
85 return usb_stor_bulk_transfer_buf(us, us->send_bulk_pipe,
90 static int jumpshot_get_status(struct us_data *us)
95 return USB_STOR_TRANSPORT_ERROR;
98 rc = usb_stor_ctrl_transfer(us, us->recv_ctrl_pipe,
99 0, 0xA0, 0, 7, us->iobuf, 1);
101 if (rc != USB_STOR_XFER_GOOD)
102 return USB_STOR_TRANSPORT_ERROR;
104 if (us->iobuf[0] != 0x50) {
105 US_DEBUGP("jumpshot_get_status: 0x%2x\n",
107 return USB_STOR_TRANSPORT_ERROR;
110 return USB_STOR_TRANSPORT_GOOD;
113 static int jumpshot_read_data(struct us_data *us,
114 struct jumpshot_info *info,
118 unsigned char *command = us->iobuf;
119 unsigned char *buffer;
120 unsigned char thistime;
121 unsigned int totallen, alloclen;
123 unsigned int sg_idx = 0, sg_offset = 0;
125 // we're working in LBA mode. according to the ATA spec,
126 // we can support up to 28-bit addressing. I don't know if Jumpshot
127 // supports beyond 24-bit addressing. It's kind of hard to test
128 // since it requires > 8GB CF card.
130 if (sector > 0x0FFFFFFF)
131 return USB_STOR_TRANSPORT_ERROR;
133 totallen = sectors * info->ssize;
135 // Since we don't read more than 64 KB at a time, we have to create
136 // a bounce buffer and move the data a piece at a time between the
137 // bounce buffer and the actual transfer buffer.
139 alloclen = min(totallen, 65536u);
140 buffer = kmalloc(alloclen, GFP_NOIO);
142 return USB_STOR_TRANSPORT_ERROR;
145 // loop, never allocate or transfer more than 64k at once
146 // (min(128k, 255*info->ssize) is the real limit)
147 len = min(totallen, alloclen);
148 thistime = (len / info->ssize) & 0xff;
151 command[1] = thistime;
152 command[2] = sector & 0xFF;
153 command[3] = (sector >> 8) & 0xFF;
154 command[4] = (sector >> 16) & 0xFF;
156 command[5] = 0xE0 | ((sector >> 24) & 0x0F);
159 // send the setup + command
160 result = usb_stor_ctrl_transfer(us, us->send_ctrl_pipe,
161 0, 0x20, 0, 1, command, 7);
162 if (result != USB_STOR_XFER_GOOD)
166 result = jumpshot_bulk_read(us, buffer, len);
167 if (result != USB_STOR_XFER_GOOD)
170 US_DEBUGP("jumpshot_read_data: %d bytes\n", len);
172 // Store the data in the transfer buffer
173 usb_stor_access_xfer_buf(buffer, len, us->srb,
174 &sg_idx, &sg_offset, TO_XFER_BUF);
178 } while (totallen > 0);
181 return USB_STOR_TRANSPORT_GOOD;
185 return USB_STOR_TRANSPORT_ERROR;
189 static int jumpshot_write_data(struct us_data *us,
190 struct jumpshot_info *info,
194 unsigned char *command = us->iobuf;
195 unsigned char *buffer;
196 unsigned char thistime;
197 unsigned int totallen, alloclen;
198 int len, result, waitcount;
199 unsigned int sg_idx = 0, sg_offset = 0;
201 // we're working in LBA mode. according to the ATA spec,
202 // we can support up to 28-bit addressing. I don't know if Jumpshot
203 // supports beyond 24-bit addressing. It's kind of hard to test
204 // since it requires > 8GB CF card.
206 if (sector > 0x0FFFFFFF)
207 return USB_STOR_TRANSPORT_ERROR;
209 totallen = sectors * info->ssize;
211 // Since we don't write more than 64 KB at a time, we have to create
212 // a bounce buffer and move the data a piece at a time between the
213 // bounce buffer and the actual transfer buffer.
215 alloclen = min(totallen, 65536u);
216 buffer = kmalloc(alloclen, GFP_NOIO);
218 return USB_STOR_TRANSPORT_ERROR;
221 // loop, never allocate or transfer more than 64k at once
222 // (min(128k, 255*info->ssize) is the real limit)
224 len = min(totallen, alloclen);
225 thistime = (len / info->ssize) & 0xff;
227 // Get the data from the transfer buffer
228 usb_stor_access_xfer_buf(buffer, len, us->srb,
229 &sg_idx, &sg_offset, FROM_XFER_BUF);
232 command[1] = thistime;
233 command[2] = sector & 0xFF;
234 command[3] = (sector >> 8) & 0xFF;
235 command[4] = (sector >> 16) & 0xFF;
237 command[5] = 0xE0 | ((sector >> 24) & 0x0F);
240 // send the setup + command
241 result = usb_stor_ctrl_transfer(us, us->send_ctrl_pipe,
242 0, 0x20, 0, 1, command, 7);
243 if (result != USB_STOR_XFER_GOOD)
247 result = jumpshot_bulk_write(us, buffer, len);
248 if (result != USB_STOR_XFER_GOOD)
251 // read the result. apparently the bulk write can complete
252 // before the jumpshot drive is finished writing. so we loop
253 // here until we get a good return code
256 result = jumpshot_get_status(us);
257 if (result != USB_STOR_TRANSPORT_GOOD) {
258 // I have not experimented to find the smallest value.
262 } while ((result != USB_STOR_TRANSPORT_GOOD) && (waitcount < 10));
264 if (result != USB_STOR_TRANSPORT_GOOD)
265 US_DEBUGP("jumpshot_write_data: Gah! Waitcount = 10. Bad write!?\n");
269 } while (totallen > 0);
276 return USB_STOR_TRANSPORT_ERROR;
279 static int jumpshot_id_device(struct us_data *us,
280 struct jumpshot_info *info)
282 unsigned char *command = us->iobuf;
283 unsigned char *reply;
287 return USB_STOR_TRANSPORT_ERROR;
291 reply = kmalloc(512, GFP_NOIO);
293 return USB_STOR_TRANSPORT_ERROR;
296 rc = usb_stor_ctrl_transfer(us, us->send_ctrl_pipe,
297 0, 0x20, 0, 6, command, 2);
299 if (rc != USB_STOR_XFER_GOOD) {
300 US_DEBUGP("jumpshot_id_device: Gah! "
301 "send_control for read_capacity failed\n");
302 rc = USB_STOR_TRANSPORT_ERROR;
307 rc = jumpshot_bulk_read(us, reply, 512);
308 if (rc != USB_STOR_XFER_GOOD) {
309 rc = USB_STOR_TRANSPORT_ERROR;
313 info->sectors = ((u32)(reply[117]) << 24) |
314 ((u32)(reply[116]) << 16) |
315 ((u32)(reply[115]) << 8) |
316 ((u32)(reply[114]) );
318 rc = USB_STOR_TRANSPORT_GOOD;
325 static int jumpshot_handle_mode_sense(struct us_data *us,
326 struct scsi_cmnd * srb,
329 static unsigned char rw_err_page[12] = {
330 0x1, 0xA, 0x21, 1, 0, 0, 0, 0, 1, 0, 0, 0
332 static unsigned char cache_page[12] = {
333 0x8, 0xA, 0x1, 0, 0, 0, 0, 0, 0, 0, 0, 0
335 static unsigned char rbac_page[12] = {
336 0x1B, 0xA, 0, 0x81, 0, 0, 0, 0, 0, 0, 0, 0
338 static unsigned char timer_page[8] = {
339 0x1C, 0x6, 0, 0, 0, 0
341 unsigned char pc, page_code;
343 struct jumpshot_info *info = (struct jumpshot_info *) (us->extra);
344 unsigned char *ptr = us->iobuf;
346 pc = srb->cmnd[2] >> 6;
347 page_code = srb->cmnd[2] & 0x3F;
351 US_DEBUGP("jumpshot_handle_mode_sense: Current values\n");
354 US_DEBUGP("jumpshot_handle_mode_sense: Changeable values\n");
357 US_DEBUGP("jumpshot_handle_mode_sense: Default values\n");
360 US_DEBUGP("jumpshot_handle_mode_sense: Saves values\n");
366 ptr[2] = 0x00; // WP enable: 0x80
369 ptr[3] = 0x00; // WP enable: 0x80
375 // vendor-specific mode
376 info->sense_key = 0x05;
377 info->sense_asc = 0x24;
378 info->sense_ascq = 0x00;
379 return USB_STOR_TRANSPORT_FAILED;
382 memcpy(ptr + i, rw_err_page, sizeof(rw_err_page));
383 i += sizeof(rw_err_page);
387 memcpy(ptr + i, cache_page, sizeof(cache_page));
388 i += sizeof(cache_page);
392 memcpy(ptr + i, rbac_page, sizeof(rbac_page));
393 i += sizeof(rbac_page);
397 memcpy(ptr + i, timer_page, sizeof(timer_page));
398 i += sizeof(timer_page);
402 memcpy(ptr + i, timer_page, sizeof(timer_page));
403 i += sizeof(timer_page);
404 memcpy(ptr + i, rbac_page, sizeof(rbac_page));
405 i += sizeof(rbac_page);
406 memcpy(ptr + i, cache_page, sizeof(cache_page));
407 i += sizeof(cache_page);
408 memcpy(ptr + i, rw_err_page, sizeof(rw_err_page));
409 i += sizeof(rw_err_page);
416 ((__be16 *) ptr)[0] = cpu_to_be16(i - 2);
417 usb_stor_set_xfer_buf(ptr, i, srb);
419 return USB_STOR_TRANSPORT_GOOD;
423 static void jumpshot_info_destructor(void *extra)
425 // this routine is a placeholder...
426 // currently, we don't allocate any extra blocks so we're okay
431 // Transport for the Lexar 'Jumpshot'
433 int jumpshot_transport(struct scsi_cmnd * srb, struct us_data *us)
435 struct jumpshot_info *info;
437 unsigned long block, blocks;
438 unsigned char *ptr = us->iobuf;
439 static unsigned char inquiry_response[8] = {
440 0x00, 0x80, 0x00, 0x01, 0x1F, 0x00, 0x00, 0x00
444 us->extra = kmalloc(sizeof(struct jumpshot_info), GFP_NOIO);
446 US_DEBUGP("jumpshot_transport: Gah! Can't allocate storage for jumpshot info struct!\n");
447 return USB_STOR_TRANSPORT_ERROR;
449 memset(us->extra, 0, sizeof(struct jumpshot_info));
450 us->extra_destructor = jumpshot_info_destructor;
453 info = (struct jumpshot_info *) (us->extra);
455 if (srb->cmnd[0] == INQUIRY) {
456 US_DEBUGP("jumpshot_transport: INQUIRY. Returning bogus response.\n");
457 memcpy(ptr, inquiry_response, sizeof(inquiry_response));
458 fill_inquiry_response(us, ptr, 36);
459 return USB_STOR_TRANSPORT_GOOD;
462 if (srb->cmnd[0] == READ_CAPACITY) {
463 info->ssize = 0x200; // hard coded 512 byte sectors as per ATA spec
465 rc = jumpshot_get_status(us);
466 if (rc != USB_STOR_TRANSPORT_GOOD)
469 rc = jumpshot_id_device(us, info);
470 if (rc != USB_STOR_TRANSPORT_GOOD)
473 US_DEBUGP("jumpshot_transport: READ_CAPACITY: %ld sectors, %ld bytes per sector\n",
474 info->sectors, info->ssize);
478 ((__be32 *) ptr)[0] = cpu_to_be32(info->sectors - 1);
479 ((__be32 *) ptr)[1] = cpu_to_be32(info->ssize);
480 usb_stor_set_xfer_buf(ptr, 8, srb);
482 return USB_STOR_TRANSPORT_GOOD;
485 if (srb->cmnd[0] == MODE_SELECT_10) {
486 US_DEBUGP("jumpshot_transport: Gah! MODE_SELECT_10.\n");
487 return USB_STOR_TRANSPORT_ERROR;
490 if (srb->cmnd[0] == READ_10) {
491 block = ((u32)(srb->cmnd[2]) << 24) | ((u32)(srb->cmnd[3]) << 16) |
492 ((u32)(srb->cmnd[4]) << 8) | ((u32)(srb->cmnd[5]));
494 blocks = ((u32)(srb->cmnd[7]) << 8) | ((u32)(srb->cmnd[8]));
496 US_DEBUGP("jumpshot_transport: READ_10: read block 0x%04lx count %ld\n", block, blocks);
497 return jumpshot_read_data(us, info, block, blocks);
500 if (srb->cmnd[0] == READ_12) {
501 // I don't think we'll ever see a READ_12 but support it anyway...
503 block = ((u32)(srb->cmnd[2]) << 24) | ((u32)(srb->cmnd[3]) << 16) |
504 ((u32)(srb->cmnd[4]) << 8) | ((u32)(srb->cmnd[5]));
506 blocks = ((u32)(srb->cmnd[6]) << 24) | ((u32)(srb->cmnd[7]) << 16) |
507 ((u32)(srb->cmnd[8]) << 8) | ((u32)(srb->cmnd[9]));
509 US_DEBUGP("jumpshot_transport: READ_12: read block 0x%04lx count %ld\n", block, blocks);
510 return jumpshot_read_data(us, info, block, blocks);
513 if (srb->cmnd[0] == WRITE_10) {
514 block = ((u32)(srb->cmnd[2]) << 24) | ((u32)(srb->cmnd[3]) << 16) |
515 ((u32)(srb->cmnd[4]) << 8) | ((u32)(srb->cmnd[5]));
517 blocks = ((u32)(srb->cmnd[7]) << 8) | ((u32)(srb->cmnd[8]));
519 US_DEBUGP("jumpshot_transport: WRITE_10: write block 0x%04lx count %ld\n", block, blocks);
520 return jumpshot_write_data(us, info, block, blocks);
523 if (srb->cmnd[0] == WRITE_12) {
524 // I don't think we'll ever see a WRITE_12 but support it anyway...
526 block = ((u32)(srb->cmnd[2]) << 24) | ((u32)(srb->cmnd[3]) << 16) |
527 ((u32)(srb->cmnd[4]) << 8) | ((u32)(srb->cmnd[5]));
529 blocks = ((u32)(srb->cmnd[6]) << 24) | ((u32)(srb->cmnd[7]) << 16) |
530 ((u32)(srb->cmnd[8]) << 8) | ((u32)(srb->cmnd[9]));
532 US_DEBUGP("jumpshot_transport: WRITE_12: write block 0x%04lx count %ld\n", block, blocks);
533 return jumpshot_write_data(us, info, block, blocks);
537 if (srb->cmnd[0] == TEST_UNIT_READY) {
538 US_DEBUGP("jumpshot_transport: TEST_UNIT_READY.\n");
539 return jumpshot_get_status(us);
542 if (srb->cmnd[0] == REQUEST_SENSE) {
543 US_DEBUGP("jumpshot_transport: REQUEST_SENSE.\n");
547 ptr[2] = info->sense_key;
549 ptr[12] = info->sense_asc;
550 ptr[13] = info->sense_ascq;
551 usb_stor_set_xfer_buf(ptr, 18, srb);
553 return USB_STOR_TRANSPORT_GOOD;
556 if (srb->cmnd[0] == MODE_SENSE) {
557 US_DEBUGP("jumpshot_transport: MODE_SENSE_6 detected\n");
558 return jumpshot_handle_mode_sense(us, srb, 1);
561 if (srb->cmnd[0] == MODE_SENSE_10) {
562 US_DEBUGP("jumpshot_transport: MODE_SENSE_10 detected\n");
563 return jumpshot_handle_mode_sense(us, srb, 0);
566 if (srb->cmnd[0] == ALLOW_MEDIUM_REMOVAL) {
567 // sure. whatever. not like we can stop the user from popping
568 // the media out of the device (no locking doors, etc)
570 return USB_STOR_TRANSPORT_GOOD;
573 if (srb->cmnd[0] == START_STOP) {
574 /* this is used by sd.c'check_scsidisk_media_change to detect
576 US_DEBUGP("jumpshot_transport: START_STOP.\n");
577 /* the first jumpshot_id_device after a media change returns
578 an error (determined experimentally) */
579 rc = jumpshot_id_device(us, info);
580 if (rc == USB_STOR_TRANSPORT_GOOD) {
581 info->sense_key = NO_SENSE;
582 srb->result = SUCCESS;
584 info->sense_key = UNIT_ATTENTION;
585 srb->result = SAM_STAT_CHECK_CONDITION;
590 US_DEBUGP("jumpshot_transport: Gah! Unknown command: %d (0x%x)\n",
591 srb->cmnd[0], srb->cmnd[0]);
592 info->sense_key = 0x05;
593 info->sense_asc = 0x20;
594 info->sense_ascq = 0x00;
595 return USB_STOR_TRANSPORT_FAILED;