blob: 760fe9362b6d96f4ca1bb43e3cf25ac1e262a00c [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/* Driver for SanDisk SDDR-09 SmartMedia reader
2 *
3 * $Id: sddr09.c,v 1.24 2002/04/22 03:39:43 mdharm Exp $
4 * (c) 2000, 2001 Robert Baruch (autophile@starband.net)
5 * (c) 2002 Andries Brouwer (aeb@cwi.nl)
6 * Developed with the assistance of:
7 * (c) 2002 Alan Stern <stern@rowland.org>
8 *
9 * The SanDisk SDDR-09 SmartMedia reader uses the Shuttle EUSB-01 chip.
10 * This chip is a programmable USB controller. In the SDDR-09, it has
11 * been programmed to obey a certain limited set of SCSI commands.
12 * This driver translates the "real" SCSI commands to the SDDR-09 SCSI
13 * commands.
14 *
15 * This program is free software; you can redistribute it and/or modify it
16 * under the terms of the GNU General Public License as published by the
17 * Free Software Foundation; either version 2, or (at your option) any
18 * later version.
19 *
20 * This program is distributed in the hope that it will be useful, but
21 * WITHOUT ANY WARRANTY; without even the implied warranty of
22 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
23 * General Public License for more details.
24 *
25 * You should have received a copy of the GNU General Public License along
26 * with this program; if not, write to the Free Software Foundation, Inc.,
27 * 675 Mass Ave, Cambridge, MA 02139, USA.
28 */
29
30/*
31 * Known vendor commands: 12 bytes, first byte is opcode
32 *
33 * E7: read scatter gather
34 * E8: read
35 * E9: write
36 * EA: erase
37 * EB: reset
38 * EC: read status
39 * ED: read ID
40 * EE: write CIS (?)
41 * EF: compute checksum (?)
42 */
43
44#include <linux/sched.h>
45#include <linux/errno.h>
46#include <linux/slab.h>
47
48#include <scsi/scsi.h>
49#include <scsi/scsi_cmnd.h>
50
51#include "usb.h"
52#include "transport.h"
53#include "protocol.h"
54#include "debug.h"
55#include "sddr09.h"
56
57
58#define short_pack(lsb,msb) ( ((u16)(lsb)) | ( ((u16)(msb))<<8 ) )
59#define LSB_of(s) ((s)&0xFF)
60#define MSB_of(s) ((s)>>8)
61
62/* #define US_DEBUGP printk */
63
64/*
65 * First some stuff that does not belong here:
66 * data on SmartMedia and other cards, completely
67 * unrelated to this driver.
68 * Similar stuff occurs in <linux/mtd/nand_ids.h>.
69 */
70
71struct nand_flash_dev {
72 int model_id;
73 int chipshift; /* 1<<cs bytes total capacity */
74 char pageshift; /* 1<<ps bytes in a page */
75 char blockshift; /* 1<<bs pages in an erase block */
76 char zoneshift; /* 1<<zs blocks in a zone */
77 /* # of logical blocks is 125/128 of this */
78 char pageadrlen; /* length of an address in bytes - 1 */
79};
80
81/*
82 * NAND Flash Manufacturer ID Codes
83 */
84#define NAND_MFR_AMD 0x01
85#define NAND_MFR_NATSEMI 0x8f
86#define NAND_MFR_TOSHIBA 0x98
87#define NAND_MFR_SAMSUNG 0xec
88
89static inline char *nand_flash_manufacturer(int manuf_id) {
90 switch(manuf_id) {
91 case NAND_MFR_AMD:
92 return "AMD";
93 case NAND_MFR_NATSEMI:
94 return "NATSEMI";
95 case NAND_MFR_TOSHIBA:
96 return "Toshiba";
97 case NAND_MFR_SAMSUNG:
98 return "Samsung";
99 default:
100 return "unknown";
101 }
102}
103
104/*
105 * It looks like it is unnecessary to attach manufacturer to the
106 * remaining data: SSFDC prescribes manufacturer-independent id codes.
107 *
108 * 256 MB NAND flash has a 5-byte ID with 2nd byte 0xaa, 0xba, 0xca or 0xda.
109 */
110
111static struct nand_flash_dev nand_flash_ids[] = {
112 /* NAND flash */
113 { 0x6e, 20, 8, 4, 8, 2}, /* 1 MB */
114 { 0xe8, 20, 8, 4, 8, 2}, /* 1 MB */
115 { 0xec, 20, 8, 4, 8, 2}, /* 1 MB */
116 { 0x64, 21, 8, 4, 9, 2}, /* 2 MB */
117 { 0xea, 21, 8, 4, 9, 2}, /* 2 MB */
118 { 0x6b, 22, 9, 4, 9, 2}, /* 4 MB */
119 { 0xe3, 22, 9, 4, 9, 2}, /* 4 MB */
120 { 0xe5, 22, 9, 4, 9, 2}, /* 4 MB */
121 { 0xe6, 23, 9, 4, 10, 2}, /* 8 MB */
122 { 0x73, 24, 9, 5, 10, 2}, /* 16 MB */
123 { 0x75, 25, 9, 5, 10, 2}, /* 32 MB */
124 { 0x76, 26, 9, 5, 10, 3}, /* 64 MB */
125 { 0x79, 27, 9, 5, 10, 3}, /* 128 MB */
126
127 /* MASK ROM */
128 { 0x5d, 21, 9, 4, 8, 2}, /* 2 MB */
129 { 0xd5, 22, 9, 4, 9, 2}, /* 4 MB */
130 { 0xd6, 23, 9, 4, 10, 2}, /* 8 MB */
131 { 0x57, 24, 9, 4, 11, 2}, /* 16 MB */
132 { 0x58, 25, 9, 4, 12, 2}, /* 32 MB */
133 { 0,}
134};
135
136#define SIZE(a) (sizeof(a)/sizeof((a)[0]))
137
138static struct nand_flash_dev *
139nand_find_id(unsigned char id) {
140 int i;
141
142 for (i = 0; i < SIZE(nand_flash_ids); i++)
143 if (nand_flash_ids[i].model_id == id)
144 return &(nand_flash_ids[i]);
145 return NULL;
146}
147
148/*
149 * ECC computation.
150 */
151static unsigned char parity[256];
152static unsigned char ecc2[256];
153
154static void nand_init_ecc(void) {
155 int i, j, a;
156
157 parity[0] = 0;
158 for (i = 1; i < 256; i++)
159 parity[i] = (parity[i&(i-1)] ^ 1);
160
161 for (i = 0; i < 256; i++) {
162 a = 0;
163 for (j = 0; j < 8; j++) {
164 if (i & (1<<j)) {
165 if ((j & 1) == 0)
166 a ^= 0x04;
167 if ((j & 2) == 0)
168 a ^= 0x10;
169 if ((j & 4) == 0)
170 a ^= 0x40;
171 }
172 }
173 ecc2[i] = ~(a ^ (a<<1) ^ (parity[i] ? 0xa8 : 0));
174 }
175}
176
177/* compute 3-byte ecc on 256 bytes */
178static void nand_compute_ecc(unsigned char *data, unsigned char *ecc) {
179 int i, j, a;
180 unsigned char par, bit, bits[8];
181
182 par = 0;
183 for (j = 0; j < 8; j++)
184 bits[j] = 0;
185
186 /* collect 16 checksum bits */
187 for (i = 0; i < 256; i++) {
188 par ^= data[i];
189 bit = parity[data[i]];
190 for (j = 0; j < 8; j++)
191 if ((i & (1<<j)) == 0)
192 bits[j] ^= bit;
193 }
194
195 /* put 4+4+4 = 12 bits in the ecc */
196 a = (bits[3] << 6) + (bits[2] << 4) + (bits[1] << 2) + bits[0];
197 ecc[0] = ~(a ^ (a<<1) ^ (parity[par] ? 0xaa : 0));
198
199 a = (bits[7] << 6) + (bits[6] << 4) + (bits[5] << 2) + bits[4];
200 ecc[1] = ~(a ^ (a<<1) ^ (parity[par] ? 0xaa : 0));
201
202 ecc[2] = ecc2[par];
203}
204
205static int nand_compare_ecc(unsigned char *data, unsigned char *ecc) {
206 return (data[0] == ecc[0] && data[1] == ecc[1] && data[2] == ecc[2]);
207}
208
209static void nand_store_ecc(unsigned char *data, unsigned char *ecc) {
210 memcpy(data, ecc, 3);
211}
212
213/*
214 * The actual driver starts here.
215 */
216
Matthew Dharmf5b8cb92005-12-04 21:57:51 -0800217struct sddr09_card_info {
218 unsigned long capacity; /* Size of card in bytes */
219 int pagesize; /* Size of page in bytes */
220 int pageshift; /* log2 of pagesize */
221 int blocksize; /* Size of block in pages */
222 int blockshift; /* log2 of blocksize */
223 int blockmask; /* 2^blockshift - 1 */
224 int *lba_to_pba; /* logical to physical map */
225 int *pba_to_lba; /* physical to logical map */
226 int lbact; /* number of available pages */
227 int flags;
228#define SDDR09_WP 1 /* write protected */
229};
230
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231/*
232 * On my 16MB card, control blocks have size 64 (16 real control bytes,
233 * and 48 junk bytes). In reality of course the card uses 16 control bytes,
234 * so the reader makes up the remaining 48. Don't know whether these numbers
235 * depend on the card. For now a constant.
236 */
237#define CONTROL_SHIFT 6
238
239/*
240 * On my Combo CF/SM reader, the SM reader has LUN 1.
241 * (and things fail with LUN 0).
242 * It seems LUN is irrelevant for others.
243 */
244#define LUN 1
245#define LUNBITS (LUN << 5)
246
247/*
248 * LBA and PBA are unsigned ints. Special values.
249 */
250#define UNDEF 0xffffffff
251#define SPARE 0xfffffffe
252#define UNUSABLE 0xfffffffd
253
Arjan van de Ven4c4c9432005-11-29 09:43:42 +0100254static const int erase_bad_lba_entries = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255
256/* send vendor interface command (0x41) */
257/* called for requests 0, 1, 8 */
258static int
259sddr09_send_command(struct us_data *us,
260 unsigned char request,
261 unsigned char direction,
262 unsigned char *xfer_data,
263 unsigned int xfer_len) {
264 unsigned int pipe;
265 unsigned char requesttype = (0x41 | direction);
266 int rc;
267
268 // Get the receive or send control pipe number
269
270 if (direction == USB_DIR_IN)
271 pipe = us->recv_ctrl_pipe;
272 else
273 pipe = us->send_ctrl_pipe;
274
275 rc = usb_stor_ctrl_transfer(us, pipe, request, requesttype,
276 0, 0, xfer_data, xfer_len);
Matthew Dharm0dc08a32005-12-04 21:58:52 -0800277 switch (rc) {
278 case USB_STOR_XFER_GOOD: return 0;
279 case USB_STOR_XFER_STALLED: return -EPIPE;
280 default: return -EIO;
281 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700282}
283
284static int
285sddr09_send_scsi_command(struct us_data *us,
286 unsigned char *command,
287 unsigned int command_len) {
288 return sddr09_send_command(us, 0, USB_DIR_OUT, command, command_len);
289}
290
291#if 0
292/*
293 * Test Unit Ready Command: 12 bytes.
294 * byte 0: opcode: 00
295 */
296static int
297sddr09_test_unit_ready(struct us_data *us) {
298 unsigned char *command = us->iobuf;
299 int result;
300
301 memset(command, 0, 6);
302 command[1] = LUNBITS;
303
304 result = sddr09_send_scsi_command(us, command, 6);
305
306 US_DEBUGP("sddr09_test_unit_ready returns %d\n", result);
307
308 return result;
309}
310#endif
311
312/*
313 * Request Sense Command: 12 bytes.
314 * byte 0: opcode: 03
315 * byte 4: data length
316 */
317static int
318sddr09_request_sense(struct us_data *us, unsigned char *sensebuf, int buflen) {
319 unsigned char *command = us->iobuf;
320 int result;
321
322 memset(command, 0, 12);
323 command[0] = 0x03;
324 command[1] = LUNBITS;
325 command[4] = buflen;
326
327 result = sddr09_send_scsi_command(us, command, 12);
Matthew Dharm0dc08a32005-12-04 21:58:52 -0800328 if (result)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700329 return result;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700330
331 result = usb_stor_bulk_transfer_buf(us, us->recv_bulk_pipe,
332 sensebuf, buflen, NULL);
Matthew Dharm0dc08a32005-12-04 21:58:52 -0800333 return (result == USB_STOR_XFER_GOOD ? 0 : -EIO);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700334}
335
336/*
337 * Read Command: 12 bytes.
338 * byte 0: opcode: E8
339 * byte 1: last two bits: 00: read data, 01: read blockwise control,
340 * 10: read both, 11: read pagewise control.
341 * It turns out we need values 20, 21, 22, 23 here (LUN 1).
342 * bytes 2-5: address (interpretation depends on byte 1, see below)
343 * bytes 10-11: count (idem)
344 *
345 * A page has 512 data bytes and 64 control bytes (16 control and 48 junk).
346 * A read data command gets data in 512-byte pages.
347 * A read control command gets control in 64-byte chunks.
348 * A read both command gets data+control in 576-byte chunks.
349 *
350 * Blocks are groups of 32 pages, and read blockwise control jumps to the
351 * next block, while read pagewise control jumps to the next page after
352 * reading a group of 64 control bytes.
353 * [Here 512 = 1<<pageshift, 32 = 1<<blockshift, 64 is constant?]
354 *
355 * (1 MB and 2 MB cards are a bit different, but I have only a 16 MB card.)
356 */
357
358static int
359sddr09_readX(struct us_data *us, int x, unsigned long fromaddress,
360 int nr_of_pages, int bulklen, unsigned char *buf,
361 int use_sg) {
362
363 unsigned char *command = us->iobuf;
364 int result;
365
366 command[0] = 0xE8;
367 command[1] = LUNBITS | x;
368 command[2] = MSB_of(fromaddress>>16);
369 command[3] = LSB_of(fromaddress>>16);
370 command[4] = MSB_of(fromaddress & 0xFFFF);
371 command[5] = LSB_of(fromaddress & 0xFFFF);
372 command[6] = 0;
373 command[7] = 0;
374 command[8] = 0;
375 command[9] = 0;
376 command[10] = MSB_of(nr_of_pages);
377 command[11] = LSB_of(nr_of_pages);
378
379 result = sddr09_send_scsi_command(us, command, 12);
380
Matthew Dharm0dc08a32005-12-04 21:58:52 -0800381 if (result) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700382 US_DEBUGP("Result for send_control in sddr09_read2%d %d\n",
383 x, result);
384 return result;
385 }
386
387 result = usb_stor_bulk_transfer_sg(us, us->recv_bulk_pipe,
388 buf, bulklen, use_sg, NULL);
389
390 if (result != USB_STOR_XFER_GOOD) {
391 US_DEBUGP("Result for bulk_transfer in sddr09_read2%d %d\n",
392 x, result);
Matthew Dharm0dc08a32005-12-04 21:58:52 -0800393 return -EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394 }
Matthew Dharm0dc08a32005-12-04 21:58:52 -0800395 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396}
397
398/*
399 * Read Data
400 *
401 * fromaddress counts data shorts:
402 * increasing it by 256 shifts the bytestream by 512 bytes;
403 * the last 8 bits are ignored.
404 *
405 * nr_of_pages counts pages of size (1 << pageshift).
406 */
407static int
408sddr09_read20(struct us_data *us, unsigned long fromaddress,
409 int nr_of_pages, int pageshift, unsigned char *buf, int use_sg) {
410 int bulklen = nr_of_pages << pageshift;
411
412 /* The last 8 bits of fromaddress are ignored. */
413 return sddr09_readX(us, 0, fromaddress, nr_of_pages, bulklen,
414 buf, use_sg);
415}
416
417/*
418 * Read Blockwise Control
419 *
420 * fromaddress gives the starting position (as in read data;
421 * the last 8 bits are ignored); increasing it by 32*256 shifts
422 * the output stream by 64 bytes.
423 *
424 * count counts control groups of size (1 << controlshift).
425 * For me, controlshift = 6. Is this constant?
426 *
427 * After getting one control group, jump to the next block
428 * (fromaddress += 8192).
429 */
430static int
431sddr09_read21(struct us_data *us, unsigned long fromaddress,
432 int count, int controlshift, unsigned char *buf, int use_sg) {
433
434 int bulklen = (count << controlshift);
435 return sddr09_readX(us, 1, fromaddress, count, bulklen,
436 buf, use_sg);
437}
438
439/*
440 * Read both Data and Control
441 *
442 * fromaddress counts data shorts, ignoring control:
443 * increasing it by 256 shifts the bytestream by 576 = 512+64 bytes;
444 * the last 8 bits are ignored.
445 *
446 * nr_of_pages counts pages of size (1 << pageshift) + (1 << controlshift).
447 */
448static int
449sddr09_read22(struct us_data *us, unsigned long fromaddress,
450 int nr_of_pages, int pageshift, unsigned char *buf, int use_sg) {
451
452 int bulklen = (nr_of_pages << pageshift) + (nr_of_pages << CONTROL_SHIFT);
453 US_DEBUGP("sddr09_read22: reading %d pages, %d bytes\n",
454 nr_of_pages, bulklen);
455 return sddr09_readX(us, 2, fromaddress, nr_of_pages, bulklen,
456 buf, use_sg);
457}
458
459#if 0
460/*
461 * Read Pagewise Control
462 *
463 * fromaddress gives the starting position (as in read data;
464 * the last 8 bits are ignored); increasing it by 256 shifts
465 * the output stream by 64 bytes.
466 *
467 * count counts control groups of size (1 << controlshift).
468 * For me, controlshift = 6. Is this constant?
469 *
470 * After getting one control group, jump to the next page
471 * (fromaddress += 256).
472 */
473static int
474sddr09_read23(struct us_data *us, unsigned long fromaddress,
475 int count, int controlshift, unsigned char *buf, int use_sg) {
476
477 int bulklen = (count << controlshift);
478 return sddr09_readX(us, 3, fromaddress, count, bulklen,
479 buf, use_sg);
480}
481#endif
482
483/*
484 * Erase Command: 12 bytes.
485 * byte 0: opcode: EA
486 * bytes 6-9: erase address (big-endian, counting shorts, sector aligned).
487 *
488 * Always precisely one block is erased; bytes 2-5 and 10-11 are ignored.
489 * The byte address being erased is 2*Eaddress.
490 * The CIS cannot be erased.
491 */
492static int
493sddr09_erase(struct us_data *us, unsigned long Eaddress) {
494 unsigned char *command = us->iobuf;
495 int result;
496
497 US_DEBUGP("sddr09_erase: erase address %lu\n", Eaddress);
498
499 memset(command, 0, 12);
500 command[0] = 0xEA;
501 command[1] = LUNBITS;
502 command[6] = MSB_of(Eaddress>>16);
503 command[7] = LSB_of(Eaddress>>16);
504 command[8] = MSB_of(Eaddress & 0xFFFF);
505 command[9] = LSB_of(Eaddress & 0xFFFF);
506
507 result = sddr09_send_scsi_command(us, command, 12);
508
Matthew Dharm0dc08a32005-12-04 21:58:52 -0800509 if (result)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700510 US_DEBUGP("Result for send_control in sddr09_erase %d\n",
511 result);
512
513 return result;
514}
515
516/*
517 * Write CIS Command: 12 bytes.
518 * byte 0: opcode: EE
519 * bytes 2-5: write address in shorts
520 * bytes 10-11: sector count
521 *
522 * This writes at the indicated address. Don't know how it differs
523 * from E9. Maybe it does not erase? However, it will also write to
524 * the CIS.
525 *
526 * When two such commands on the same page follow each other directly,
527 * the second one is not done.
528 */
529
530/*
531 * Write Command: 12 bytes.
532 * byte 0: opcode: E9
533 * bytes 2-5: write address (big-endian, counting shorts, sector aligned).
534 * bytes 6-9: erase address (big-endian, counting shorts, sector aligned).
535 * bytes 10-11: sector count (big-endian, in 512-byte sectors).
536 *
537 * If write address equals erase address, the erase is done first,
538 * otherwise the write is done first. When erase address equals zero
539 * no erase is done?
540 */
541static int
542sddr09_writeX(struct us_data *us,
543 unsigned long Waddress, unsigned long Eaddress,
544 int nr_of_pages, int bulklen, unsigned char *buf, int use_sg) {
545
546 unsigned char *command = us->iobuf;
547 int result;
548
549 command[0] = 0xE9;
550 command[1] = LUNBITS;
551
552 command[2] = MSB_of(Waddress>>16);
553 command[3] = LSB_of(Waddress>>16);
554 command[4] = MSB_of(Waddress & 0xFFFF);
555 command[5] = LSB_of(Waddress & 0xFFFF);
556
557 command[6] = MSB_of(Eaddress>>16);
558 command[7] = LSB_of(Eaddress>>16);
559 command[8] = MSB_of(Eaddress & 0xFFFF);
560 command[9] = LSB_of(Eaddress & 0xFFFF);
561
562 command[10] = MSB_of(nr_of_pages);
563 command[11] = LSB_of(nr_of_pages);
564
565 result = sddr09_send_scsi_command(us, command, 12);
566
Matthew Dharm0dc08a32005-12-04 21:58:52 -0800567 if (result) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700568 US_DEBUGP("Result for send_control in sddr09_writeX %d\n",
569 result);
570 return result;
571 }
572
573 result = usb_stor_bulk_transfer_sg(us, us->send_bulk_pipe,
574 buf, bulklen, use_sg, NULL);
575
576 if (result != USB_STOR_XFER_GOOD) {
577 US_DEBUGP("Result for bulk_transfer in sddr09_writeX %d\n",
578 result);
Matthew Dharm0dc08a32005-12-04 21:58:52 -0800579 return -EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700580 }
Matthew Dharm0dc08a32005-12-04 21:58:52 -0800581 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700582}
583
584/* erase address, write same address */
585static int
586sddr09_write_inplace(struct us_data *us, unsigned long address,
587 int nr_of_pages, int pageshift, unsigned char *buf,
588 int use_sg) {
589 int bulklen = (nr_of_pages << pageshift) + (nr_of_pages << CONTROL_SHIFT);
590 return sddr09_writeX(us, address, address, nr_of_pages, bulklen,
591 buf, use_sg);
592}
593
594#if 0
595/*
596 * Read Scatter Gather Command: 3+4n bytes.
597 * byte 0: opcode E7
598 * byte 2: n
599 * bytes 4i-1,4i,4i+1: page address
600 * byte 4i+2: page count
601 * (i=1..n)
602 *
603 * This reads several pages from the card to a single memory buffer.
604 * The last two bits of byte 1 have the same meaning as for E8.
605 */
606static int
607sddr09_read_sg_test_only(struct us_data *us) {
608 unsigned char *command = us->iobuf;
609 int result, bulklen, nsg, ct;
610 unsigned char *buf;
611 unsigned long address;
612
613 nsg = bulklen = 0;
614 command[0] = 0xE7;
615 command[1] = LUNBITS;
616 command[2] = 0;
617 address = 040000; ct = 1;
618 nsg++;
619 bulklen += (ct << 9);
620 command[4*nsg+2] = ct;
621 command[4*nsg+1] = ((address >> 9) & 0xFF);
622 command[4*nsg+0] = ((address >> 17) & 0xFF);
623 command[4*nsg-1] = ((address >> 25) & 0xFF);
624
625 address = 0340000; ct = 1;
626 nsg++;
627 bulklen += (ct << 9);
628 command[4*nsg+2] = ct;
629 command[4*nsg+1] = ((address >> 9) & 0xFF);
630 command[4*nsg+0] = ((address >> 17) & 0xFF);
631 command[4*nsg-1] = ((address >> 25) & 0xFF);
632
633 address = 01000000; ct = 2;
634 nsg++;
635 bulklen += (ct << 9);
636 command[4*nsg+2] = ct;
637 command[4*nsg+1] = ((address >> 9) & 0xFF);
638 command[4*nsg+0] = ((address >> 17) & 0xFF);
639 command[4*nsg-1] = ((address >> 25) & 0xFF);
640
641 command[2] = nsg;
642
643 result = sddr09_send_scsi_command(us, command, 4*nsg+3);
644
Matthew Dharm0dc08a32005-12-04 21:58:52 -0800645 if (result) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700646 US_DEBUGP("Result for send_control in sddr09_read_sg %d\n",
647 result);
648 return result;
649 }
650
651 buf = (unsigned char *) kmalloc(bulklen, GFP_NOIO);
652 if (!buf)
Matthew Dharm0dc08a32005-12-04 21:58:52 -0800653 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700654
655 result = usb_stor_bulk_transfer_buf(us, us->recv_bulk_pipe,
656 buf, bulklen, NULL);
657 kfree(buf);
658 if (result != USB_STOR_XFER_GOOD) {
659 US_DEBUGP("Result for bulk_transfer in sddr09_read_sg %d\n",
660 result);
Matthew Dharm0dc08a32005-12-04 21:58:52 -0800661 return -EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700662 }
663
Matthew Dharm0dc08a32005-12-04 21:58:52 -0800664 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700665}
666#endif
667
668/*
669 * Read Status Command: 12 bytes.
670 * byte 0: opcode: EC
671 *
672 * Returns 64 bytes, all zero except for the first.
673 * bit 0: 1: Error
674 * bit 5: 1: Suspended
675 * bit 6: 1: Ready
676 * bit 7: 1: Not write-protected
677 */
678
679static int
680sddr09_read_status(struct us_data *us, unsigned char *status) {
681
682 unsigned char *command = us->iobuf;
683 unsigned char *data = us->iobuf;
684 int result;
685
686 US_DEBUGP("Reading status...\n");
687
688 memset(command, 0, 12);
689 command[0] = 0xEC;
690 command[1] = LUNBITS;
691
692 result = sddr09_send_scsi_command(us, command, 12);
Matthew Dharm0dc08a32005-12-04 21:58:52 -0800693 if (result)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700694 return result;
695
696 result = usb_stor_bulk_transfer_buf(us, us->recv_bulk_pipe,
697 data, 64, NULL);
698 *status = data[0];
Matthew Dharm0dc08a32005-12-04 21:58:52 -0800699 return (result == USB_STOR_XFER_GOOD ? 0 : -EIO);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700700}
701
702static int
703sddr09_read_data(struct us_data *us,
704 unsigned long address,
705 unsigned int sectors) {
706
707 struct sddr09_card_info *info = (struct sddr09_card_info *) us->extra;
708 unsigned char *buffer;
709 unsigned int lba, maxlba, pba;
710 unsigned int page, pages;
711 unsigned int len, index, offset;
712 int result;
713
714 // Since we only read in one block at a time, we have to create
715 // a bounce buffer and move the data a piece at a time between the
716 // bounce buffer and the actual transfer buffer.
717
718 len = min(sectors, (unsigned int) info->blocksize) * info->pagesize;
719 buffer = kmalloc(len, GFP_NOIO);
720 if (buffer == NULL) {
721 printk("sddr09_read_data: Out of memory\n");
Matthew Dharm0dc08a32005-12-04 21:58:52 -0800722 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700723 }
724
725 // Figure out the initial LBA and page
726 lba = address >> info->blockshift;
727 page = (address & info->blockmask);
728 maxlba = info->capacity >> (info->pageshift + info->blockshift);
729
730 // This could be made much more efficient by checking for
731 // contiguous LBA's. Another exercise left to the student.
732
Matthew Dharm0dc08a32005-12-04 21:58:52 -0800733 result = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700734 index = offset = 0;
735
736 while (sectors > 0) {
737
738 /* Find number of pages we can read in this block */
739 pages = min(sectors, info->blocksize - page);
740 len = pages << info->pageshift;
741
742 /* Not overflowing capacity? */
743 if (lba >= maxlba) {
744 US_DEBUGP("Error: Requested lba %u exceeds "
745 "maximum %u\n", lba, maxlba);
Matthew Dharm0dc08a32005-12-04 21:58:52 -0800746 result = -EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700747 break;
748 }
749
750 /* Find where this lba lives on disk */
751 pba = info->lba_to_pba[lba];
752
753 if (pba == UNDEF) { /* this lba was never written */
754
755 US_DEBUGP("Read %d zero pages (LBA %d) page %d\n",
756 pages, lba, page);
757
758 /* This is not really an error. It just means
759 that the block has never been written.
Matthew Dharm0dc08a32005-12-04 21:58:52 -0800760 Instead of returning an error
Linus Torvalds1da177e2005-04-16 15:20:36 -0700761 it is better to return all zero data. */
762
763 memset(buffer, 0, len);
764
765 } else {
766 US_DEBUGP("Read %d pages, from PBA %d"
767 " (LBA %d) page %d\n",
768 pages, pba, lba, page);
769
770 address = ((pba << info->blockshift) + page) <<
771 info->pageshift;
772
773 result = sddr09_read20(us, address>>1,
774 pages, info->pageshift, buffer, 0);
Matthew Dharm0dc08a32005-12-04 21:58:52 -0800775 if (result)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700776 break;
777 }
778
779 // Store the data in the transfer buffer
780 usb_stor_access_xfer_buf(buffer, len, us->srb,
781 &index, &offset, TO_XFER_BUF);
782
783 page = 0;
784 lba++;
785 sectors -= pages;
786 }
787
788 kfree(buffer);
789 return result;
790}
791
792static unsigned int
793sddr09_find_unused_pba(struct sddr09_card_info *info, unsigned int lba) {
794 static unsigned int lastpba = 1;
795 int zonestart, end, i;
796
797 zonestart = (lba/1000) << 10;
798 end = info->capacity >> (info->blockshift + info->pageshift);
799 end -= zonestart;
800 if (end > 1024)
801 end = 1024;
802
803 for (i = lastpba+1; i < end; i++) {
804 if (info->pba_to_lba[zonestart+i] == UNDEF) {
805 lastpba = i;
806 return zonestart+i;
807 }
808 }
809 for (i = 0; i <= lastpba; i++) {
810 if (info->pba_to_lba[zonestart+i] == UNDEF) {
811 lastpba = i;
812 return zonestart+i;
813 }
814 }
815 return 0;
816}
817
818static int
819sddr09_write_lba(struct us_data *us, unsigned int lba,
820 unsigned int page, unsigned int pages,
821 unsigned char *ptr, unsigned char *blockbuffer) {
822
823 struct sddr09_card_info *info = (struct sddr09_card_info *) us->extra;
824 unsigned long address;
825 unsigned int pba, lbap;
826 unsigned int pagelen;
827 unsigned char *bptr, *cptr, *xptr;
828 unsigned char ecc[3];
829 int i, result, isnew;
830
831 lbap = ((lba % 1000) << 1) | 0x1000;
832 if (parity[MSB_of(lbap) ^ LSB_of(lbap)])
833 lbap ^= 1;
834 pba = info->lba_to_pba[lba];
835 isnew = 0;
836
837 if (pba == UNDEF) {
838 pba = sddr09_find_unused_pba(info, lba);
839 if (!pba) {
840 printk("sddr09_write_lba: Out of unused blocks\n");
Matthew Dharm0dc08a32005-12-04 21:58:52 -0800841 return -ENOSPC;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700842 }
843 info->pba_to_lba[pba] = lba;
844 info->lba_to_pba[lba] = pba;
845 isnew = 1;
846 }
847
848 if (pba == 1) {
849 /* Maybe it is impossible to write to PBA 1.
850 Fake success, but don't do anything. */
851 printk("sddr09: avoid writing to pba 1\n");
Matthew Dharm0dc08a32005-12-04 21:58:52 -0800852 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700853 }
854
855 pagelen = (1 << info->pageshift) + (1 << CONTROL_SHIFT);
856
857 /* read old contents */
858 address = (pba << (info->pageshift + info->blockshift));
859 result = sddr09_read22(us, address>>1, info->blocksize,
860 info->pageshift, blockbuffer, 0);
Matthew Dharm0dc08a32005-12-04 21:58:52 -0800861 if (result)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700862 return result;
863
864 /* check old contents and fill lba */
865 for (i = 0; i < info->blocksize; i++) {
866 bptr = blockbuffer + i*pagelen;
867 cptr = bptr + info->pagesize;
868 nand_compute_ecc(bptr, ecc);
869 if (!nand_compare_ecc(cptr+13, ecc)) {
870 US_DEBUGP("Warning: bad ecc in page %d- of pba %d\n",
871 i, pba);
872 nand_store_ecc(cptr+13, ecc);
873 }
874 nand_compute_ecc(bptr+(info->pagesize / 2), ecc);
875 if (!nand_compare_ecc(cptr+8, ecc)) {
876 US_DEBUGP("Warning: bad ecc in page %d+ of pba %d\n",
877 i, pba);
878 nand_store_ecc(cptr+8, ecc);
879 }
880 cptr[6] = cptr[11] = MSB_of(lbap);
881 cptr[7] = cptr[12] = LSB_of(lbap);
882 }
883
884 /* copy in new stuff and compute ECC */
885 xptr = ptr;
886 for (i = page; i < page+pages; i++) {
887 bptr = blockbuffer + i*pagelen;
888 cptr = bptr + info->pagesize;
889 memcpy(bptr, xptr, info->pagesize);
890 xptr += info->pagesize;
891 nand_compute_ecc(bptr, ecc);
892 nand_store_ecc(cptr+13, ecc);
893 nand_compute_ecc(bptr+(info->pagesize / 2), ecc);
894 nand_store_ecc(cptr+8, ecc);
895 }
896
897 US_DEBUGP("Rewrite PBA %d (LBA %d)\n", pba, lba);
898
899 result = sddr09_write_inplace(us, address>>1, info->blocksize,
900 info->pageshift, blockbuffer, 0);
901
902 US_DEBUGP("sddr09_write_inplace returns %d\n", result);
903
904#if 0
905 {
906 unsigned char status = 0;
907 int result2 = sddr09_read_status(us, &status);
Matthew Dharm0dc08a32005-12-04 21:58:52 -0800908 if (result2)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700909 US_DEBUGP("sddr09_write_inplace: cannot read status\n");
910 else if (status != 0xc0)
911 US_DEBUGP("sddr09_write_inplace: status after write: 0x%x\n",
912 status);
913 }
914#endif
915
916#if 0
917 {
918 int result2 = sddr09_test_unit_ready(us);
919 }
920#endif
921
922 return result;
923}
924
925static int
926sddr09_write_data(struct us_data *us,
927 unsigned long address,
928 unsigned int sectors) {
929
930 struct sddr09_card_info *info = (struct sddr09_card_info *) us->extra;
931 unsigned int lba, page, pages;
932 unsigned int pagelen, blocklen;
933 unsigned char *blockbuffer;
934 unsigned char *buffer;
935 unsigned int len, index, offset;
936 int result;
937
938 // blockbuffer is used for reading in the old data, overwriting
939 // with the new data, and performing ECC calculations
940
941 /* TODO: instead of doing kmalloc/kfree for each write,
942 add a bufferpointer to the info structure */
943
944 pagelen = (1 << info->pageshift) + (1 << CONTROL_SHIFT);
945 blocklen = (pagelen << info->blockshift);
946 blockbuffer = kmalloc(blocklen, GFP_NOIO);
947 if (!blockbuffer) {
948 printk("sddr09_write_data: Out of memory\n");
Matthew Dharm0dc08a32005-12-04 21:58:52 -0800949 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700950 }
951
952 // Since we don't write the user data directly to the device,
953 // we have to create a bounce buffer and move the data a piece
954 // at a time between the bounce buffer and the actual transfer buffer.
955
956 len = min(sectors, (unsigned int) info->blocksize) * info->pagesize;
957 buffer = kmalloc(len, GFP_NOIO);
958 if (buffer == NULL) {
959 printk("sddr09_write_data: Out of memory\n");
960 kfree(blockbuffer);
Matthew Dharm0dc08a32005-12-04 21:58:52 -0800961 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700962 }
963
964 // Figure out the initial LBA and page
965 lba = address >> info->blockshift;
966 page = (address & info->blockmask);
967
Matthew Dharm0dc08a32005-12-04 21:58:52 -0800968 result = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700969 index = offset = 0;
970
971 while (sectors > 0) {
972
973 // Write as many sectors as possible in this block
974
975 pages = min(sectors, info->blocksize - page);
976 len = (pages << info->pageshift);
977
978 // Get the data from the transfer buffer
979 usb_stor_access_xfer_buf(buffer, len, us->srb,
980 &index, &offset, FROM_XFER_BUF);
981
982 result = sddr09_write_lba(us, lba, page, pages,
983 buffer, blockbuffer);
Matthew Dharm0dc08a32005-12-04 21:58:52 -0800984 if (result)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700985 break;
986
987 page = 0;
988 lba++;
989 sectors -= pages;
990 }
991
992 kfree(buffer);
993 kfree(blockbuffer);
994
995 return result;
996}
997
998static int
999sddr09_read_control(struct us_data *us,
1000 unsigned long address,
1001 unsigned int blocks,
1002 unsigned char *content,
1003 int use_sg) {
1004
1005 US_DEBUGP("Read control address %lu, blocks %d\n",
1006 address, blocks);
1007
1008 return sddr09_read21(us, address, blocks,
1009 CONTROL_SHIFT, content, use_sg);
1010}
1011
1012/*
1013 * Read Device ID Command: 12 bytes.
1014 * byte 0: opcode: ED
1015 *
1016 * Returns 2 bytes: Manufacturer ID and Device ID.
1017 * On more recent cards 3 bytes: the third byte is an option code A5
1018 * signifying that the secret command to read an 128-bit ID is available.
1019 * On still more recent cards 4 bytes: the fourth byte C0 means that
1020 * a second read ID cmd is available.
1021 */
1022static int
1023sddr09_read_deviceID(struct us_data *us, unsigned char *deviceID) {
1024 unsigned char *command = us->iobuf;
1025 unsigned char *content = us->iobuf;
1026 int result, i;
1027
1028 memset(command, 0, 12);
1029 command[0] = 0xED;
1030 command[1] = LUNBITS;
1031
1032 result = sddr09_send_scsi_command(us, command, 12);
Matthew Dharm0dc08a32005-12-04 21:58:52 -08001033 if (result)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001034 return result;
1035
1036 result = usb_stor_bulk_transfer_buf(us, us->recv_bulk_pipe,
1037 content, 64, NULL);
1038
1039 for (i = 0; i < 4; i++)
1040 deviceID[i] = content[i];
1041
Matthew Dharm0dc08a32005-12-04 21:58:52 -08001042 return (result == USB_STOR_XFER_GOOD ? 0 : -EIO);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001043}
1044
1045static int
1046sddr09_get_wp(struct us_data *us, struct sddr09_card_info *info) {
1047 int result;
1048 unsigned char status;
1049
1050 result = sddr09_read_status(us, &status);
Matthew Dharm0dc08a32005-12-04 21:58:52 -08001051 if (result) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001052 US_DEBUGP("sddr09_get_wp: read_status fails\n");
1053 return result;
1054 }
1055 US_DEBUGP("sddr09_get_wp: status 0x%02X", status);
1056 if ((status & 0x80) == 0) {
1057 info->flags |= SDDR09_WP; /* write protected */
1058 US_DEBUGP(" WP");
1059 }
1060 if (status & 0x40)
1061 US_DEBUGP(" Ready");
1062 if (status & LUNBITS)
1063 US_DEBUGP(" Suspended");
1064 if (status & 0x1)
1065 US_DEBUGP(" Error");
1066 US_DEBUGP("\n");
Matthew Dharm0dc08a32005-12-04 21:58:52 -08001067 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001068}
1069
1070#if 0
1071/*
1072 * Reset Command: 12 bytes.
1073 * byte 0: opcode: EB
1074 */
1075static int
1076sddr09_reset(struct us_data *us) {
1077
1078 unsigned char *command = us->iobuf;
1079
1080 memset(command, 0, 12);
1081 command[0] = 0xEB;
1082 command[1] = LUNBITS;
1083
1084 return sddr09_send_scsi_command(us, command, 12);
1085}
1086#endif
1087
1088static struct nand_flash_dev *
1089sddr09_get_cardinfo(struct us_data *us, unsigned char flags) {
1090 struct nand_flash_dev *cardinfo;
1091 unsigned char deviceID[4];
1092 char blurbtxt[256];
1093 int result;
1094
1095 US_DEBUGP("Reading capacity...\n");
1096
1097 result = sddr09_read_deviceID(us, deviceID);
1098
Matthew Dharm0dc08a32005-12-04 21:58:52 -08001099 if (result) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001100 US_DEBUGP("Result of read_deviceID is %d\n", result);
1101 printk("sddr09: could not read card info\n");
1102 return NULL;
1103 }
1104
1105 sprintf(blurbtxt, "sddr09: Found Flash card, ID = %02X %02X %02X %02X",
1106 deviceID[0], deviceID[1], deviceID[2], deviceID[3]);
1107
1108 /* Byte 0 is the manufacturer */
1109 sprintf(blurbtxt + strlen(blurbtxt),
1110 ": Manuf. %s",
1111 nand_flash_manufacturer(deviceID[0]));
1112
1113 /* Byte 1 is the device type */
1114 cardinfo = nand_find_id(deviceID[1]);
1115 if (cardinfo) {
1116 /* MB or MiB? It is neither. A 16 MB card has
1117 17301504 raw bytes, of which 16384000 are
1118 usable for user data. */
1119 sprintf(blurbtxt + strlen(blurbtxt),
1120 ", %d MB", 1<<(cardinfo->chipshift - 20));
1121 } else {
1122 sprintf(blurbtxt + strlen(blurbtxt),
1123 ", type unrecognized");
1124 }
1125
1126 /* Byte 2 is code to signal availability of 128-bit ID */
1127 if (deviceID[2] == 0xa5) {
1128 sprintf(blurbtxt + strlen(blurbtxt),
1129 ", 128-bit ID");
1130 }
1131
1132 /* Byte 3 announces the availability of another read ID command */
1133 if (deviceID[3] == 0xc0) {
1134 sprintf(blurbtxt + strlen(blurbtxt),
1135 ", extra cmd");
1136 }
1137
1138 if (flags & SDDR09_WP)
1139 sprintf(blurbtxt + strlen(blurbtxt),
1140 ", WP");
1141
1142 printk("%s\n", blurbtxt);
1143
1144 return cardinfo;
1145}
1146
1147static int
1148sddr09_read_map(struct us_data *us) {
1149
1150 struct sddr09_card_info *info = (struct sddr09_card_info *) us->extra;
1151 int numblocks, alloc_len, alloc_blocks;
1152 int i, j, result;
1153 unsigned char *buffer, *buffer_end, *ptr;
1154 unsigned int lba, lbact;
1155
1156 if (!info->capacity)
1157 return -1;
1158
1159 // size of a block is 1 << (blockshift + pageshift) bytes
1160 // divide into the total capacity to get the number of blocks
1161
1162 numblocks = info->capacity >> (info->blockshift + info->pageshift);
1163
1164 // read 64 bytes for every block (actually 1 << CONTROL_SHIFT)
1165 // but only use a 64 KB buffer
1166 // buffer size used must be a multiple of (1 << CONTROL_SHIFT)
1167#define SDDR09_READ_MAP_BUFSZ 65536
1168
1169 alloc_blocks = min(numblocks, SDDR09_READ_MAP_BUFSZ >> CONTROL_SHIFT);
1170 alloc_len = (alloc_blocks << CONTROL_SHIFT);
1171 buffer = kmalloc(alloc_len, GFP_NOIO);
1172 if (buffer == NULL) {
1173 printk("sddr09_read_map: out of memory\n");
1174 result = -1;
1175 goto done;
1176 }
1177 buffer_end = buffer + alloc_len;
1178
1179#undef SDDR09_READ_MAP_BUFSZ
1180
1181 kfree(info->lba_to_pba);
1182 kfree(info->pba_to_lba);
1183 info->lba_to_pba = kmalloc(numblocks*sizeof(int), GFP_NOIO);
1184 info->pba_to_lba = kmalloc(numblocks*sizeof(int), GFP_NOIO);
1185
1186 if (info->lba_to_pba == NULL || info->pba_to_lba == NULL) {
1187 printk("sddr09_read_map: out of memory\n");
1188 result = -1;
1189 goto done;
1190 }
1191
1192 for (i = 0; i < numblocks; i++)
1193 info->lba_to_pba[i] = info->pba_to_lba[i] = UNDEF;
1194
1195 /*
1196 * Define lba-pba translation table
1197 */
1198
1199 ptr = buffer_end;
1200 for (i = 0; i < numblocks; i++) {
1201 ptr += (1 << CONTROL_SHIFT);
1202 if (ptr >= buffer_end) {
1203 unsigned long address;
1204
1205 address = i << (info->pageshift + info->blockshift);
1206 result = sddr09_read_control(
1207 us, address>>1,
1208 min(alloc_blocks, numblocks - i),
1209 buffer, 0);
Matthew Dharm0dc08a32005-12-04 21:58:52 -08001210 if (result) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001211 result = -1;
1212 goto done;
1213 }
1214 ptr = buffer;
1215 }
1216
1217 if (i == 0 || i == 1) {
1218 info->pba_to_lba[i] = UNUSABLE;
1219 continue;
1220 }
1221
1222 /* special PBAs have control field 0^16 */
1223 for (j = 0; j < 16; j++)
1224 if (ptr[j] != 0)
1225 goto nonz;
1226 info->pba_to_lba[i] = UNUSABLE;
1227 printk("sddr09: PBA %d has no logical mapping\n", i);
1228 continue;
1229
1230 nonz:
1231 /* unwritten PBAs have control field FF^16 */
1232 for (j = 0; j < 16; j++)
1233 if (ptr[j] != 0xff)
1234 goto nonff;
1235 continue;
1236
1237 nonff:
1238 /* normal PBAs start with six FFs */
1239 if (j < 6) {
1240 printk("sddr09: PBA %d has no logical mapping: "
1241 "reserved area = %02X%02X%02X%02X "
1242 "data status %02X block status %02X\n",
1243 i, ptr[0], ptr[1], ptr[2], ptr[3],
1244 ptr[4], ptr[5]);
1245 info->pba_to_lba[i] = UNUSABLE;
1246 continue;
1247 }
1248
1249 if ((ptr[6] >> 4) != 0x01) {
1250 printk("sddr09: PBA %d has invalid address field "
1251 "%02X%02X/%02X%02X\n",
1252 i, ptr[6], ptr[7], ptr[11], ptr[12]);
1253 info->pba_to_lba[i] = UNUSABLE;
1254 continue;
1255 }
1256
1257 /* check even parity */
1258 if (parity[ptr[6] ^ ptr[7]]) {
1259 printk("sddr09: Bad parity in LBA for block %d"
1260 " (%02X %02X)\n", i, ptr[6], ptr[7]);
1261 info->pba_to_lba[i] = UNUSABLE;
1262 continue;
1263 }
1264
1265 lba = short_pack(ptr[7], ptr[6]);
1266 lba = (lba & 0x07FF) >> 1;
1267
1268 /*
1269 * Every 1024 physical blocks ("zone"), the LBA numbers
1270 * go back to zero, but are within a higher block of LBA's.
1271 * Also, there is a maximum of 1000 LBA's per zone.
1272 * In other words, in PBA 1024-2047 you will find LBA 0-999
1273 * which are really LBA 1000-1999. This allows for 24 bad
1274 * or special physical blocks per zone.
1275 */
1276
1277 if (lba >= 1000) {
1278 printk("sddr09: Bad low LBA %d for block %d\n",
1279 lba, i);
1280 goto possibly_erase;
1281 }
1282
1283 lba += 1000*(i/0x400);
1284
1285 if (info->lba_to_pba[lba] != UNDEF) {
1286 printk("sddr09: LBA %d seen for PBA %d and %d\n",
1287 lba, info->lba_to_pba[lba], i);
1288 goto possibly_erase;
1289 }
1290
1291 info->pba_to_lba[i] = lba;
1292 info->lba_to_pba[lba] = i;
1293 continue;
1294
1295 possibly_erase:
1296 if (erase_bad_lba_entries) {
1297 unsigned long address;
1298
1299 address = (i << (info->pageshift + info->blockshift));
1300 sddr09_erase(us, address>>1);
1301 info->pba_to_lba[i] = UNDEF;
1302 } else
1303 info->pba_to_lba[i] = UNUSABLE;
1304 }
1305
1306 /*
1307 * Approximate capacity. This is not entirely correct yet,
1308 * since a zone with less than 1000 usable pages leads to
1309 * missing LBAs. Especially if it is the last zone, some
1310 * LBAs can be past capacity.
1311 */
1312 lbact = 0;
1313 for (i = 0; i < numblocks; i += 1024) {
1314 int ct = 0;
1315
1316 for (j = 0; j < 1024 && i+j < numblocks; j++) {
1317 if (info->pba_to_lba[i+j] != UNUSABLE) {
1318 if (ct >= 1000)
1319 info->pba_to_lba[i+j] = SPARE;
1320 else
1321 ct++;
1322 }
1323 }
1324 lbact += ct;
1325 }
1326 info->lbact = lbact;
1327 US_DEBUGP("Found %d LBA's\n", lbact);
1328 result = 0;
1329
1330 done:
1331 if (result != 0) {
1332 kfree(info->lba_to_pba);
1333 kfree(info->pba_to_lba);
1334 info->lba_to_pba = NULL;
1335 info->pba_to_lba = NULL;
1336 }
1337 kfree(buffer);
1338 return result;
1339}
1340
1341static void
1342sddr09_card_info_destructor(void *extra) {
1343 struct sddr09_card_info *info = (struct sddr09_card_info *)extra;
1344
1345 if (!info)
1346 return;
1347
1348 kfree(info->lba_to_pba);
1349 kfree(info->pba_to_lba);
1350}
1351
Matthew Dharmf5b8cb92005-12-04 21:57:51 -08001352static int
1353sddr09_common_init(struct us_data *us) {
1354 int result;
1355
1356 /* set the configuration -- STALL is an acceptable response here */
1357 if (us->pusb_dev->actconfig->desc.bConfigurationValue != 1) {
1358 US_DEBUGP("active config #%d != 1 ??\n", us->pusb_dev
1359 ->actconfig->desc.bConfigurationValue);
1360 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001361 }
Matthew Dharmf5b8cb92005-12-04 21:57:51 -08001362
1363 result = usb_reset_configuration(us->pusb_dev);
1364 US_DEBUGP("Result of usb_reset_configuration is %d\n", result);
1365 if (result == -EPIPE) {
1366 US_DEBUGP("-- stall on control interface\n");
1367 } else if (result != 0) {
1368 /* it's not a stall, but another error -- time to bail */
1369 US_DEBUGP("-- Unknown error. Rejecting device\n");
1370 return -EINVAL;
1371 }
1372
1373 us->extra = kzalloc(sizeof(struct sddr09_card_info), GFP_NOIO);
1374 if (!us->extra)
1375 return -ENOMEM;
1376 us->extra_destructor = sddr09_card_info_destructor;
1377
1378 nand_init_ecc();
1379 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001380}
1381
Matthew Dharmf5b8cb92005-12-04 21:57:51 -08001382
Linus Torvalds1da177e2005-04-16 15:20:36 -07001383/*
1384 * This is needed at a very early stage. If this is not listed in the
1385 * unusual devices list but called from here then LUN 0 of the combo reader
1386 * is not recognized. But I do not know what precisely these calls do.
1387 */
1388int
Matthew Dharmf5b8cb92005-12-04 21:57:51 -08001389usb_stor_sddr09_dpcm_init(struct us_data *us) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001390 int result;
1391 unsigned char *data = us->iobuf;
1392
Matthew Dharmf5b8cb92005-12-04 21:57:51 -08001393 result = sddr09_common_init(us);
1394 if (result)
1395 return result;
1396
Linus Torvalds1da177e2005-04-16 15:20:36 -07001397 result = sddr09_send_command(us, 0x01, USB_DIR_IN, data, 2);
Matthew Dharm0dc08a32005-12-04 21:58:52 -08001398 if (result) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001399 US_DEBUGP("sddr09_init: send_command fails\n");
1400 return result;
1401 }
1402
1403 US_DEBUGP("SDDR09init: %02X %02X\n", data[0], data[1]);
1404 // get 07 02
1405
1406 result = sddr09_send_command(us, 0x08, USB_DIR_IN, data, 2);
Matthew Dharm0dc08a32005-12-04 21:58:52 -08001407 if (result) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001408 US_DEBUGP("sddr09_init: 2nd send_command fails\n");
1409 return result;
1410 }
1411
1412 US_DEBUGP("SDDR09init: %02X %02X\n", data[0], data[1]);
1413 // get 07 00
1414
1415 result = sddr09_request_sense(us, data, 18);
Matthew Dharm0dc08a32005-12-04 21:58:52 -08001416 if (result == 0 && data[2] != 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001417 int j;
1418 for (j=0; j<18; j++)
1419 printk(" %02X", data[j]);
1420 printk("\n");
1421 // get 70 00 00 00 00 00 00 * 00 00 00 00 00 00
1422 // 70: current command
1423 // sense key 0, sense code 0, extd sense code 0
1424 // additional transfer length * = sizeof(data) - 7
1425 // Or: 70 00 06 00 00 00 00 0b 00 00 00 00 28 00 00 00 00 00
1426 // sense key 06, sense code 28: unit attention,
1427 // not ready to ready transition
1428 }
1429
1430 // test unit ready
1431
Matthew Dharmf5b8cb92005-12-04 21:57:51 -08001432 return 0; /* not result */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001433}
1434
1435/*
1436 * Transport for the Sandisk SDDR-09
1437 */
1438int sddr09_transport(struct scsi_cmnd *srb, struct us_data *us)
1439{
1440 static unsigned char sensekey = 0, sensecode = 0;
1441 static unsigned char havefakesense = 0;
1442 int result, i;
1443 unsigned char *ptr = us->iobuf;
1444 unsigned long capacity;
1445 unsigned int page, pages;
1446
1447 struct sddr09_card_info *info;
1448
1449 static unsigned char inquiry_response[8] = {
1450 0x00, 0x80, 0x00, 0x02, 0x1F, 0x00, 0x00, 0x00
1451 };
1452
1453 /* note: no block descriptor support */
1454 static unsigned char mode_page_01[19] = {
1455 0x00, 0x0F, 0x00, 0x0, 0x0, 0x0, 0x00,
1456 0x01, 0x0A,
1457 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00
1458 };
1459
1460 info = (struct sddr09_card_info *)us->extra;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001461
1462 if (srb->cmnd[0] == REQUEST_SENSE && havefakesense) {
1463 /* for a faked command, we have to follow with a faked sense */
1464 memset(ptr, 0, 18);
1465 ptr[0] = 0x70;
1466 ptr[2] = sensekey;
1467 ptr[7] = 11;
1468 ptr[12] = sensecode;
1469 usb_stor_set_xfer_buf(ptr, 18, srb);
1470 sensekey = sensecode = havefakesense = 0;
1471 return USB_STOR_TRANSPORT_GOOD;
1472 }
1473
1474 havefakesense = 1;
1475
1476 /* Dummy up a response for INQUIRY since SDDR09 doesn't
1477 respond to INQUIRY commands */
1478
1479 if (srb->cmnd[0] == INQUIRY) {
1480 memcpy(ptr, inquiry_response, 8);
1481 fill_inquiry_response(us, ptr, 36);
1482 return USB_STOR_TRANSPORT_GOOD;
1483 }
1484
1485 if (srb->cmnd[0] == READ_CAPACITY) {
1486 struct nand_flash_dev *cardinfo;
1487
1488 sddr09_get_wp(us, info); /* read WP bit */
1489
1490 cardinfo = sddr09_get_cardinfo(us, info->flags);
1491 if (!cardinfo) {
1492 /* probably no media */
1493 init_error:
1494 sensekey = 0x02; /* not ready */
1495 sensecode = 0x3a; /* medium not present */
1496 return USB_STOR_TRANSPORT_FAILED;
1497 }
1498
1499 info->capacity = (1 << cardinfo->chipshift);
1500 info->pageshift = cardinfo->pageshift;
1501 info->pagesize = (1 << info->pageshift);
1502 info->blockshift = cardinfo->blockshift;
1503 info->blocksize = (1 << info->blockshift);
1504 info->blockmask = info->blocksize - 1;
1505
1506 // map initialization, must follow get_cardinfo()
1507 if (sddr09_read_map(us)) {
1508 /* probably out of memory */
1509 goto init_error;
1510 }
1511
1512 // Report capacity
1513
1514 capacity = (info->lbact << info->blockshift) - 1;
1515
1516 ((__be32 *) ptr)[0] = cpu_to_be32(capacity);
1517
1518 // Report page size
1519
1520 ((__be32 *) ptr)[1] = cpu_to_be32(info->pagesize);
1521 usb_stor_set_xfer_buf(ptr, 8, srb);
1522
1523 return USB_STOR_TRANSPORT_GOOD;
1524 }
1525
1526 if (srb->cmnd[0] == MODE_SENSE_10) {
1527 int modepage = (srb->cmnd[2] & 0x3F);
1528
1529 /* They ask for the Read/Write error recovery page,
1530 or for all pages. */
1531 /* %% We should check DBD %% */
1532 if (modepage == 0x01 || modepage == 0x3F) {
1533 US_DEBUGP("SDDR09: Dummy up request for "
1534 "mode page 0x%x\n", modepage);
1535
1536 memcpy(ptr, mode_page_01, sizeof(mode_page_01));
1537 ((__be16*)ptr)[0] = cpu_to_be16(sizeof(mode_page_01) - 2);
1538 ptr[3] = (info->flags & SDDR09_WP) ? 0x80 : 0;
1539 usb_stor_set_xfer_buf(ptr, sizeof(mode_page_01), srb);
1540 return USB_STOR_TRANSPORT_GOOD;
1541 }
1542
1543 sensekey = 0x05; /* illegal request */
1544 sensecode = 0x24; /* invalid field in CDB */
1545 return USB_STOR_TRANSPORT_FAILED;
1546 }
1547
1548 if (srb->cmnd[0] == ALLOW_MEDIUM_REMOVAL)
1549 return USB_STOR_TRANSPORT_GOOD;
1550
1551 havefakesense = 0;
1552
1553 if (srb->cmnd[0] == READ_10) {
1554
1555 page = short_pack(srb->cmnd[3], srb->cmnd[2]);
1556 page <<= 16;
1557 page |= short_pack(srb->cmnd[5], srb->cmnd[4]);
1558 pages = short_pack(srb->cmnd[8], srb->cmnd[7]);
1559
1560 US_DEBUGP("READ_10: read page %d pagect %d\n",
1561 page, pages);
1562
Matthew Dharm0dc08a32005-12-04 21:58:52 -08001563 result = sddr09_read_data(us, page, pages);
1564 return (result == 0 ? USB_STOR_TRANSPORT_GOOD :
1565 USB_STOR_TRANSPORT_ERROR);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001566 }
1567
1568 if (srb->cmnd[0] == WRITE_10) {
1569
1570 page = short_pack(srb->cmnd[3], srb->cmnd[2]);
1571 page <<= 16;
1572 page |= short_pack(srb->cmnd[5], srb->cmnd[4]);
1573 pages = short_pack(srb->cmnd[8], srb->cmnd[7]);
1574
1575 US_DEBUGP("WRITE_10: write page %d pagect %d\n",
1576 page, pages);
1577
Matthew Dharm0dc08a32005-12-04 21:58:52 -08001578 result = sddr09_write_data(us, page, pages);
1579 return (result == 0 ? USB_STOR_TRANSPORT_GOOD :
1580 USB_STOR_TRANSPORT_ERROR);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001581 }
1582
1583 /* catch-all for all other commands, except
1584 * pass TEST_UNIT_READY and REQUEST_SENSE through
1585 */
1586 if (srb->cmnd[0] != TEST_UNIT_READY &&
1587 srb->cmnd[0] != REQUEST_SENSE) {
1588 sensekey = 0x05; /* illegal request */
1589 sensecode = 0x20; /* invalid command */
1590 havefakesense = 1;
1591 return USB_STOR_TRANSPORT_FAILED;
1592 }
1593
1594 for (; srb->cmd_len<12; srb->cmd_len++)
1595 srb->cmnd[srb->cmd_len] = 0;
1596
1597 srb->cmnd[1] = LUNBITS;
1598
1599 ptr[0] = 0;
1600 for (i=0; i<12; i++)
1601 sprintf(ptr+strlen(ptr), "%02X ", srb->cmnd[i]);
1602
1603 US_DEBUGP("SDDR09: Send control for command %s\n", ptr);
1604
1605 result = sddr09_send_scsi_command(us, srb->cmnd, 12);
Matthew Dharm0dc08a32005-12-04 21:58:52 -08001606 if (result) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001607 US_DEBUGP("sddr09_transport: sddr09_send_scsi_command "
1608 "returns %d\n", result);
Matthew Dharm0dc08a32005-12-04 21:58:52 -08001609 return USB_STOR_TRANSPORT_ERROR;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001610 }
1611
1612 if (srb->request_bufflen == 0)
1613 return USB_STOR_TRANSPORT_GOOD;
1614
1615 if (srb->sc_data_direction == DMA_TO_DEVICE ||
1616 srb->sc_data_direction == DMA_FROM_DEVICE) {
1617 unsigned int pipe = (srb->sc_data_direction == DMA_TO_DEVICE)
1618 ? us->send_bulk_pipe : us->recv_bulk_pipe;
1619
1620 US_DEBUGP("SDDR09: %s %d bytes\n",
1621 (srb->sc_data_direction == DMA_TO_DEVICE) ?
1622 "sending" : "receiving",
1623 srb->request_bufflen);
1624
1625 result = usb_stor_bulk_transfer_sg(us, pipe,
1626 srb->request_buffer,
1627 srb->request_bufflen,
1628 srb->use_sg, &srb->resid);
1629
1630 return (result == USB_STOR_XFER_GOOD ?
1631 USB_STOR_TRANSPORT_GOOD : USB_STOR_TRANSPORT_ERROR);
1632 }
1633
1634 return USB_STOR_TRANSPORT_GOOD;
1635}
1636
Matthew Dharmf5b8cb92005-12-04 21:57:51 -08001637/*
1638 * Initialization routine for the sddr09 subdriver
1639 */
1640int
1641usb_stor_sddr09_init(struct us_data *us) {
1642 return sddr09_common_init(us);
1643}