2 * Driver for Alauda-based card readers
4 * Current development and maintenance by:
5 * (c) 2005 Daniel Drake <dsd@gentoo.org>
7 * The 'Alauda' is a chip manufacturered by RATOC for OEM use.
9 * Alauda implements a vendor-specific command set to access two media reader
10 * ports (XD, SmartMedia). This driver converts SCSI commands to the commands
11 * which are accepted by these devices.
13 * The driver was developed through reverse-engineering, with the help of the
14 * sddr09 driver which has many similarities, and with some help from the
15 * (very old) vendor-supplied GPL sma03 driver.
17 * For protocol info, see http://alauda.sourceforge.net
19 * This program is free software; you can redistribute it and/or modify it
20 * under the terms of the GNU General Public License as published by the
21 * Free Software Foundation; either version 2, or (at your option) any
24 * This program is distributed in the hope that it will be useful, but
25 * WITHOUT ANY WARRANTY; without even the implied warranty of
26 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
27 * General Public License for more details.
29 * You should have received a copy of the GNU General Public License along
30 * with this program; if not, write to the Free Software Foundation, Inc.,
31 * 675 Mass Ave, Cambridge, MA 02139, USA.
34 #include <linux/module.h>
35 #include <linux/slab.h>
37 #include <scsi/scsi.h>
38 #include <scsi/scsi_cmnd.h>
39 #include <scsi/scsi_device.h>
42 #include "transport.h"
47 #define DRV_NAME "ums-alauda"
49 MODULE_DESCRIPTION("Driver for Alauda-based card readers");
50 MODULE_AUTHOR("Daniel Drake <dsd@gentoo.org>");
51 MODULE_LICENSE("GPL");
56 #define ALAUDA_STATUS_ERROR 0x01
57 #define ALAUDA_STATUS_READY 0x40
60 * Control opcodes (for request field)
62 #define ALAUDA_GET_XD_MEDIA_STATUS 0x08
63 #define ALAUDA_GET_SM_MEDIA_STATUS 0x98
64 #define ALAUDA_ACK_XD_MEDIA_CHANGE 0x0a
65 #define ALAUDA_ACK_SM_MEDIA_CHANGE 0x9a
66 #define ALAUDA_GET_XD_MEDIA_SIG 0x86
67 #define ALAUDA_GET_SM_MEDIA_SIG 0x96
70 * Bulk command identity (byte 0)
72 #define ALAUDA_BULK_CMD 0x40
75 * Bulk opcodes (byte 1)
77 #define ALAUDA_BULK_GET_REDU_DATA 0x85
78 #define ALAUDA_BULK_READ_BLOCK 0x94
79 #define ALAUDA_BULK_ERASE_BLOCK 0xa3
80 #define ALAUDA_BULK_WRITE_BLOCK 0xb4
81 #define ALAUDA_BULK_GET_STATUS2 0xb7
82 #define ALAUDA_BULK_RESET_MEDIA 0xe0
85 * Port to operate on (byte 8)
87 #define ALAUDA_PORT_XD 0x00
88 #define ALAUDA_PORT_SM 0x01
91 * LBA and PBA are unsigned ints. Special values.
95 #define UNUSABLE 0xfffd
97 struct alauda_media_info {
98 unsigned long capacity; /* total media size in bytes */
99 unsigned int pagesize; /* page size in bytes */
100 unsigned int blocksize; /* number of pages per block */
101 unsigned int uzonesize; /* number of usable blocks per zone */
102 unsigned int zonesize; /* number of blocks per zone */
103 unsigned int blockmask; /* mask to get page from address */
105 unsigned char pageshift;
106 unsigned char blockshift;
107 unsigned char zoneshift;
109 u16 **lba_to_pba; /* logical to physical block map */
110 u16 **pba_to_lba; /* physical to logical block map */
114 struct alauda_media_info port[2];
115 int wr_ep; /* endpoint to write data out of */
117 unsigned char sense_key;
118 unsigned long sense_asc; /* additional sense code */
119 unsigned long sense_ascq; /* additional sense code qualifier */
122 #define short_pack(lsb,msb) ( ((u16)(lsb)) | ( ((u16)(msb))<<8 ) )
123 #define LSB_of(s) ((s)&0xFF)
124 #define MSB_of(s) ((s)>>8)
126 #define MEDIA_PORT(us) us->srb->device->lun
127 #define MEDIA_INFO(us) ((struct alauda_info *)us->extra)->port[MEDIA_PORT(us)]
129 #define PBA_LO(pba) ((pba & 0xF) << 5)
130 #define PBA_HI(pba) (pba >> 3)
131 #define PBA_ZONE(pba) (pba >> 11)
133 static int init_alauda(struct us_data *us);
137 * The table of devices
139 #define UNUSUAL_DEV(id_vendor, id_product, bcdDeviceMin, bcdDeviceMax, \
140 vendorName, productName, useProtocol, useTransport, \
141 initFunction, flags) \
142 { USB_DEVICE_VER(id_vendor, id_product, bcdDeviceMin, bcdDeviceMax), \
143 .driver_info = (flags) }
145 static struct usb_device_id alauda_usb_ids[] = {
146 # include "unusual_alauda.h"
147 { } /* Terminating entry */
149 MODULE_DEVICE_TABLE(usb, alauda_usb_ids);
156 #define UNUSUAL_DEV(idVendor, idProduct, bcdDeviceMin, bcdDeviceMax, \
157 vendor_name, product_name, use_protocol, use_transport, \
158 init_function, Flags) \
160 .vendorName = vendor_name, \
161 .productName = product_name, \
162 .useProtocol = use_protocol, \
163 .useTransport = use_transport, \
164 .initFunction = init_function, \
167 static struct us_unusual_dev alauda_unusual_dev_list[] = {
168 # include "unusual_alauda.h"
169 { } /* Terminating entry */
179 struct alauda_card_info {
180 unsigned char id; /* id byte */
181 unsigned char chipshift; /* 1<<cs bytes total capacity */
182 unsigned char pageshift; /* 1<<ps bytes in a page */
183 unsigned char blockshift; /* 1<<bs pages per block */
184 unsigned char zoneshift; /* 1<<zs blocks per zone */
187 static struct alauda_card_info alauda_card_ids[] = {
189 { 0x6e, 20, 8, 4, 8}, /* 1 MB */
190 { 0xe8, 20, 8, 4, 8}, /* 1 MB */
191 { 0xec, 20, 8, 4, 8}, /* 1 MB */
192 { 0x64, 21, 8, 4, 9}, /* 2 MB */
193 { 0xea, 21, 8, 4, 9}, /* 2 MB */
194 { 0x6b, 22, 9, 4, 9}, /* 4 MB */
195 { 0xe3, 22, 9, 4, 9}, /* 4 MB */
196 { 0xe5, 22, 9, 4, 9}, /* 4 MB */
197 { 0xe6, 23, 9, 4, 10}, /* 8 MB */
198 { 0x73, 24, 9, 5, 10}, /* 16 MB */
199 { 0x75, 25, 9, 5, 10}, /* 32 MB */
200 { 0x76, 26, 9, 5, 10}, /* 64 MB */
201 { 0x79, 27, 9, 5, 10}, /* 128 MB */
202 { 0x71, 28, 9, 5, 10}, /* 256 MB */
205 { 0x5d, 21, 9, 4, 8}, /* 2 MB */
206 { 0xd5, 22, 9, 4, 9}, /* 4 MB */
207 { 0xd6, 23, 9, 4, 10}, /* 8 MB */
208 { 0x57, 24, 9, 4, 11}, /* 16 MB */
209 { 0x58, 25, 9, 4, 12}, /* 32 MB */
213 static struct alauda_card_info *alauda_card_find_id(unsigned char id)
217 for (i = 0; alauda_card_ids[i].id != 0; i++)
218 if (alauda_card_ids[i].id == id)
219 return &(alauda_card_ids[i]);
227 static unsigned char parity[256];
228 static unsigned char ecc2[256];
230 static void nand_init_ecc(void)
235 for (i = 1; i < 256; i++)
236 parity[i] = (parity[i&(i-1)] ^ 1);
238 for (i = 0; i < 256; i++) {
240 for (j = 0; j < 8; j++) {
250 ecc2[i] = ~(a ^ (a<<1) ^ (parity[i] ? 0xa8 : 0));
254 /* compute 3-byte ecc on 256 bytes */
255 static void nand_compute_ecc(unsigned char *data, unsigned char *ecc)
258 unsigned char par = 0, bit, bits[8] = {0};
260 /* collect 16 checksum bits */
261 for (i = 0; i < 256; i++) {
263 bit = parity[data[i]];
264 for (j = 0; j < 8; j++)
265 if ((i & (1<<j)) == 0)
269 /* put 4+4+4 = 12 bits in the ecc */
270 a = (bits[3] << 6) + (bits[2] << 4) + (bits[1] << 2) + bits[0];
271 ecc[0] = ~(a ^ (a<<1) ^ (parity[par] ? 0xaa : 0));
273 a = (bits[7] << 6) + (bits[6] << 4) + (bits[5] << 2) + bits[4];
274 ecc[1] = ~(a ^ (a<<1) ^ (parity[par] ? 0xaa : 0));
279 static int nand_compare_ecc(unsigned char *data, unsigned char *ecc)
281 return (data[0] == ecc[0] && data[1] == ecc[1] && data[2] == ecc[2]);
284 static void nand_store_ecc(unsigned char *data, unsigned char *ecc)
286 memcpy(data, ecc, 3);
294 * Forget our PBA <---> LBA mappings for a particular port
296 static void alauda_free_maps (struct alauda_media_info *media_info)
298 unsigned int shift = media_info->zoneshift
299 + media_info->blockshift + media_info->pageshift;
300 unsigned int num_zones = media_info->capacity >> shift;
303 if (media_info->lba_to_pba != NULL)
304 for (i = 0; i < num_zones; i++) {
305 kfree(media_info->lba_to_pba[i]);
306 media_info->lba_to_pba[i] = NULL;
309 if (media_info->pba_to_lba != NULL)
310 for (i = 0; i < num_zones; i++) {
311 kfree(media_info->pba_to_lba[i]);
312 media_info->pba_to_lba[i] = NULL;
317 * Returns 2 bytes of status data
318 * The first byte describes media status, and second byte describes door status
320 static int alauda_get_media_status(struct us_data *us, unsigned char *data)
323 unsigned char command;
325 if (MEDIA_PORT(us) == ALAUDA_PORT_XD)
326 command = ALAUDA_GET_XD_MEDIA_STATUS;
328 command = ALAUDA_GET_SM_MEDIA_STATUS;
330 rc = usb_stor_ctrl_transfer(us, us->recv_ctrl_pipe,
331 command, 0xc0, 0, 1, data, 2);
333 usb_stor_dbg(us, "Media status %02X %02X\n", data[0], data[1]);
339 * Clears the "media was changed" bit so that we know when it changes again
342 static int alauda_ack_media(struct us_data *us)
344 unsigned char command;
346 if (MEDIA_PORT(us) == ALAUDA_PORT_XD)
347 command = ALAUDA_ACK_XD_MEDIA_CHANGE;
349 command = ALAUDA_ACK_SM_MEDIA_CHANGE;
351 return usb_stor_ctrl_transfer(us, us->send_ctrl_pipe,
352 command, 0x40, 0, 1, NULL, 0);
356 * Retrieves a 4-byte media signature, which indicates manufacturer, capacity,
357 * and some other details.
359 static int alauda_get_media_signature(struct us_data *us, unsigned char *data)
361 unsigned char command;
363 if (MEDIA_PORT(us) == ALAUDA_PORT_XD)
364 command = ALAUDA_GET_XD_MEDIA_SIG;
366 command = ALAUDA_GET_SM_MEDIA_SIG;
368 return usb_stor_ctrl_transfer(us, us->recv_ctrl_pipe,
369 command, 0xc0, 0, 0, data, 4);
373 * Resets the media status (but not the whole device?)
375 static int alauda_reset_media(struct us_data *us)
377 unsigned char *command = us->iobuf;
379 memset(command, 0, 9);
380 command[0] = ALAUDA_BULK_CMD;
381 command[1] = ALAUDA_BULK_RESET_MEDIA;
382 command[8] = MEDIA_PORT(us);
384 return usb_stor_bulk_transfer_buf(us, us->send_bulk_pipe,
389 * Examines the media and deduces capacity, etc.
391 static int alauda_init_media(struct us_data *us)
393 unsigned char *data = us->iobuf;
395 struct alauda_card_info *media_info;
396 unsigned int num_zones;
401 if (alauda_get_media_status(us, data) != USB_STOR_XFER_GOOD)
402 return USB_STOR_TRANSPORT_ERROR;
408 usb_stor_dbg(us, "We are ready for action!\n");
410 if (alauda_ack_media(us) != USB_STOR_XFER_GOOD)
411 return USB_STOR_TRANSPORT_ERROR;
415 if (alauda_get_media_status(us, data) != USB_STOR_XFER_GOOD)
416 return USB_STOR_TRANSPORT_ERROR;
418 if (data[0] != 0x14) {
419 usb_stor_dbg(us, "Media not ready after ack\n");
420 return USB_STOR_TRANSPORT_ERROR;
423 if (alauda_get_media_signature(us, data) != USB_STOR_XFER_GOOD)
424 return USB_STOR_TRANSPORT_ERROR;
426 usb_stor_dbg(us, "Media signature: %4ph\n", data);
427 media_info = alauda_card_find_id(data[1]);
428 if (media_info == NULL) {
429 pr_warn("alauda_init_media: Unrecognised media signature: %4ph\n",
431 return USB_STOR_TRANSPORT_ERROR;
434 MEDIA_INFO(us).capacity = 1 << media_info->chipshift;
435 usb_stor_dbg(us, "Found media with capacity: %ldMB\n",
436 MEDIA_INFO(us).capacity >> 20);
438 MEDIA_INFO(us).pageshift = media_info->pageshift;
439 MEDIA_INFO(us).blockshift = media_info->blockshift;
440 MEDIA_INFO(us).zoneshift = media_info->zoneshift;
442 MEDIA_INFO(us).pagesize = 1 << media_info->pageshift;
443 MEDIA_INFO(us).blocksize = 1 << media_info->blockshift;
444 MEDIA_INFO(us).zonesize = 1 << media_info->zoneshift;
446 MEDIA_INFO(us).uzonesize = ((1 << media_info->zoneshift) / 128) * 125;
447 MEDIA_INFO(us).blockmask = MEDIA_INFO(us).blocksize - 1;
449 num_zones = MEDIA_INFO(us).capacity >> (MEDIA_INFO(us).zoneshift
450 + MEDIA_INFO(us).blockshift + MEDIA_INFO(us).pageshift);
451 MEDIA_INFO(us).pba_to_lba = kcalloc(num_zones, sizeof(u16*), GFP_NOIO);
452 MEDIA_INFO(us).lba_to_pba = kcalloc(num_zones, sizeof(u16*), GFP_NOIO);
453 if (MEDIA_INFO(us).pba_to_lba == NULL || MEDIA_INFO(us).lba_to_pba == NULL)
454 return USB_STOR_TRANSPORT_ERROR;
456 if (alauda_reset_media(us) != USB_STOR_XFER_GOOD)
457 return USB_STOR_TRANSPORT_ERROR;
459 return USB_STOR_TRANSPORT_GOOD;
463 * Examines the media status and does the right thing when the media has gone,
464 * appeared, or changed.
466 static int alauda_check_media(struct us_data *us)
468 struct alauda_info *info = (struct alauda_info *) us->extra;
469 unsigned char status[2];
472 rc = alauda_get_media_status(us, status);
474 /* Check for no media or door open */
475 if ((status[0] & 0x80) || ((status[0] & 0x1F) == 0x10)
476 || ((status[1] & 0x01) == 0)) {
477 usb_stor_dbg(us, "No media, or door open\n");
478 alauda_free_maps(&MEDIA_INFO(us));
479 info->sense_key = 0x02;
480 info->sense_asc = 0x3A;
481 info->sense_ascq = 0x00;
482 return USB_STOR_TRANSPORT_FAILED;
485 /* Check for media change */
486 if (status[0] & 0x08) {
487 usb_stor_dbg(us, "Media change detected\n");
488 alauda_free_maps(&MEDIA_INFO(us));
489 alauda_init_media(us);
491 info->sense_key = UNIT_ATTENTION;
492 info->sense_asc = 0x28;
493 info->sense_ascq = 0x00;
494 return USB_STOR_TRANSPORT_FAILED;
497 return USB_STOR_TRANSPORT_GOOD;
501 * Checks the status from the 2nd status register
502 * Returns 3 bytes of status data, only the first is known
504 static int alauda_check_status2(struct us_data *us)
507 unsigned char command[] = {
508 ALAUDA_BULK_CMD, ALAUDA_BULK_GET_STATUS2,
509 0, 0, 0, 0, 3, 0, MEDIA_PORT(us)
511 unsigned char data[3];
513 rc = usb_stor_bulk_transfer_buf(us, us->send_bulk_pipe,
515 if (rc != USB_STOR_XFER_GOOD)
518 rc = usb_stor_bulk_transfer_buf(us, us->recv_bulk_pipe,
520 if (rc != USB_STOR_XFER_GOOD)
523 usb_stor_dbg(us, "%3ph\n", data);
524 if (data[0] & ALAUDA_STATUS_ERROR)
525 return USB_STOR_XFER_ERROR;
527 return USB_STOR_XFER_GOOD;
531 * Gets the redundancy data for the first page of a PBA
534 static int alauda_get_redu_data(struct us_data *us, u16 pba, unsigned char *data)
537 unsigned char command[] = {
538 ALAUDA_BULK_CMD, ALAUDA_BULK_GET_REDU_DATA,
539 PBA_HI(pba), PBA_ZONE(pba), 0, PBA_LO(pba), 0, 0, MEDIA_PORT(us)
542 rc = usb_stor_bulk_transfer_buf(us, us->send_bulk_pipe,
544 if (rc != USB_STOR_XFER_GOOD)
547 return usb_stor_bulk_transfer_buf(us, us->recv_bulk_pipe,
552 * Finds the first unused PBA in a zone
553 * Returns the absolute PBA of an unused PBA, or 0 if none found.
555 static u16 alauda_find_unused_pba(struct alauda_media_info *info,
558 u16 *pba_to_lba = info->pba_to_lba[zone];
561 for (i = 0; i < info->zonesize; i++)
562 if (pba_to_lba[i] == UNDEF)
563 return (zone << info->zoneshift) + i;
569 * Reads the redundancy data for all PBA's in a zone
570 * Produces lba <--> pba mappings
572 static int alauda_read_map(struct us_data *us, unsigned int zone)
574 unsigned char *data = us->iobuf;
577 unsigned int zonesize = MEDIA_INFO(us).zonesize;
578 unsigned int uzonesize = MEDIA_INFO(us).uzonesize;
579 unsigned int lba_offset, lba_real, blocknum;
580 unsigned int zone_base_lba = zone * uzonesize;
581 unsigned int zone_base_pba = zone * zonesize;
582 u16 *lba_to_pba = kcalloc(zonesize, sizeof(u16), GFP_NOIO);
583 u16 *pba_to_lba = kcalloc(zonesize, sizeof(u16), GFP_NOIO);
584 if (lba_to_pba == NULL || pba_to_lba == NULL) {
585 result = USB_STOR_TRANSPORT_ERROR;
589 usb_stor_dbg(us, "Mapping blocks for zone %d\n", zone);
591 /* 1024 PBA's per zone */
592 for (i = 0; i < zonesize; i++)
593 lba_to_pba[i] = pba_to_lba[i] = UNDEF;
595 for (i = 0; i < zonesize; i++) {
596 blocknum = zone_base_pba + i;
598 result = alauda_get_redu_data(us, blocknum, data);
599 if (result != USB_STOR_XFER_GOOD) {
600 result = USB_STOR_TRANSPORT_ERROR;
604 /* special PBAs have control field 0^16 */
605 for (j = 0; j < 16; j++)
608 pba_to_lba[i] = UNUSABLE;
609 usb_stor_dbg(us, "PBA %d has no logical mapping\n", blocknum);
613 /* unwritten PBAs have control field FF^16 */
614 for (j = 0; j < 16; j++)
620 /* normal PBAs start with six FFs */
622 usb_stor_dbg(us, "PBA %d has no logical mapping: reserved area = %02X%02X%02X%02X data status %02X block status %02X\n",
624 data[0], data[1], data[2], data[3],
626 pba_to_lba[i] = UNUSABLE;
630 if ((data[6] >> 4) != 0x01) {
631 usb_stor_dbg(us, "PBA %d has invalid address field %02X%02X/%02X%02X\n",
632 blocknum, data[6], data[7],
634 pba_to_lba[i] = UNUSABLE;
638 /* check even parity */
639 if (parity[data[6] ^ data[7]]) {
641 "alauda_read_map: Bad parity in LBA for block %d"
642 " (%02X %02X)\n", i, data[6], data[7]);
643 pba_to_lba[i] = UNUSABLE;
647 lba_offset = short_pack(data[7], data[6]);
648 lba_offset = (lba_offset & 0x07FF) >> 1;
649 lba_real = lba_offset + zone_base_lba;
652 * Every 1024 physical blocks ("zone"), the LBA numbers
653 * go back to zero, but are within a higher block of LBA's.
654 * Also, there is a maximum of 1000 LBA's per zone.
655 * In other words, in PBA 1024-2047 you will find LBA 0-999
656 * which are really LBA 1000-1999. This allows for 24 bad
657 * or special physical blocks per zone.
660 if (lba_offset >= uzonesize) {
662 "alauda_read_map: Bad low LBA %d for block %d\n",
667 if (lba_to_pba[lba_offset] != UNDEF) {
670 "LBA %d seen for PBA %d and %d\n",
671 lba_real, lba_to_pba[lba_offset], blocknum);
675 pba_to_lba[i] = lba_real;
676 lba_to_pba[lba_offset] = blocknum;
680 MEDIA_INFO(us).lba_to_pba[zone] = lba_to_pba;
681 MEDIA_INFO(us).pba_to_lba[zone] = pba_to_lba;
693 * Checks to see whether we have already mapped a certain zone
694 * If we haven't, the map is generated
696 static void alauda_ensure_map_for_zone(struct us_data *us, unsigned int zone)
698 if (MEDIA_INFO(us).lba_to_pba[zone] == NULL
699 || MEDIA_INFO(us).pba_to_lba[zone] == NULL)
700 alauda_read_map(us, zone);
704 * Erases an entire block
706 static int alauda_erase_block(struct us_data *us, u16 pba)
709 unsigned char command[] = {
710 ALAUDA_BULK_CMD, ALAUDA_BULK_ERASE_BLOCK, PBA_HI(pba),
711 PBA_ZONE(pba), 0, PBA_LO(pba), 0x02, 0, MEDIA_PORT(us)
713 unsigned char buf[2];
715 usb_stor_dbg(us, "Erasing PBA %d\n", pba);
717 rc = usb_stor_bulk_transfer_buf(us, us->send_bulk_pipe,
719 if (rc != USB_STOR_XFER_GOOD)
722 rc = usb_stor_bulk_transfer_buf(us, us->recv_bulk_pipe,
724 if (rc != USB_STOR_XFER_GOOD)
727 usb_stor_dbg(us, "Erase result: %02X %02X\n", buf[0], buf[1]);
732 * Reads data from a certain offset page inside a PBA, including interleaved
733 * redundancy data. Returns (pagesize+64)*pages bytes in data.
735 static int alauda_read_block_raw(struct us_data *us, u16 pba,
736 unsigned int page, unsigned int pages, unsigned char *data)
739 unsigned char command[] = {
740 ALAUDA_BULK_CMD, ALAUDA_BULK_READ_BLOCK, PBA_HI(pba),
741 PBA_ZONE(pba), 0, PBA_LO(pba) + page, pages, 0, MEDIA_PORT(us)
744 usb_stor_dbg(us, "pba %d page %d count %d\n", pba, page, pages);
746 rc = usb_stor_bulk_transfer_buf(us, us->send_bulk_pipe,
748 if (rc != USB_STOR_XFER_GOOD)
751 return usb_stor_bulk_transfer_buf(us, us->recv_bulk_pipe,
752 data, (MEDIA_INFO(us).pagesize + 64) * pages, NULL);
756 * Reads data from a certain offset page inside a PBA, excluding redundancy
757 * data. Returns pagesize*pages bytes in data. Note that data must be big enough
758 * to hold (pagesize+64)*pages bytes of data, but you can ignore those 'extra'
759 * trailing bytes outside this function.
761 static int alauda_read_block(struct us_data *us, u16 pba,
762 unsigned int page, unsigned int pages, unsigned char *data)
765 unsigned int pagesize = MEDIA_INFO(us).pagesize;
767 rc = alauda_read_block_raw(us, pba, page, pages, data);
768 if (rc != USB_STOR_XFER_GOOD)
771 /* Cut out the redundancy data */
772 for (i = 0; i < pages; i++) {
773 int dest_offset = i * pagesize;
774 int src_offset = i * (pagesize + 64);
775 memmove(data + dest_offset, data + src_offset, pagesize);
782 * Writes an entire block of data and checks status after write.
783 * Redundancy data must be already included in data. Data should be
784 * (pagesize+64)*blocksize bytes in length.
786 static int alauda_write_block(struct us_data *us, u16 pba, unsigned char *data)
789 struct alauda_info *info = (struct alauda_info *) us->extra;
790 unsigned char command[] = {
791 ALAUDA_BULK_CMD, ALAUDA_BULK_WRITE_BLOCK, PBA_HI(pba),
792 PBA_ZONE(pba), 0, PBA_LO(pba), 32, 0, MEDIA_PORT(us)
795 usb_stor_dbg(us, "pba %d\n", pba);
797 rc = usb_stor_bulk_transfer_buf(us, us->send_bulk_pipe,
799 if (rc != USB_STOR_XFER_GOOD)
802 rc = usb_stor_bulk_transfer_buf(us, info->wr_ep, data,
803 (MEDIA_INFO(us).pagesize + 64) * MEDIA_INFO(us).blocksize,
805 if (rc != USB_STOR_XFER_GOOD)
808 return alauda_check_status2(us);
812 * Write some data to a specific LBA.
814 static int alauda_write_lba(struct us_data *us, u16 lba,
815 unsigned int page, unsigned int pages,
816 unsigned char *ptr, unsigned char *blockbuffer)
818 u16 pba, lbap, new_pba;
819 unsigned char *bptr, *cptr, *xptr;
820 unsigned char ecc[3];
822 unsigned int uzonesize = MEDIA_INFO(us).uzonesize;
823 unsigned int zonesize = MEDIA_INFO(us).zonesize;
824 unsigned int pagesize = MEDIA_INFO(us).pagesize;
825 unsigned int blocksize = MEDIA_INFO(us).blocksize;
826 unsigned int lba_offset = lba % uzonesize;
827 unsigned int new_pba_offset;
828 unsigned int zone = lba / uzonesize;
830 alauda_ensure_map_for_zone(us, zone);
832 pba = MEDIA_INFO(us).lba_to_pba[zone][lba_offset];
835 * Maybe it is impossible to write to PBA 1.
836 * Fake success, but don't do anything.
839 "alauda_write_lba: avoid writing to pba 1\n");
840 return USB_STOR_TRANSPORT_GOOD;
843 new_pba = alauda_find_unused_pba(&MEDIA_INFO(us), zone);
846 "alauda_write_lba: Out of unused blocks\n");
847 return USB_STOR_TRANSPORT_ERROR;
850 /* read old contents */
852 result = alauda_read_block_raw(us, pba, 0,
853 blocksize, blockbuffer);
854 if (result != USB_STOR_XFER_GOOD)
857 memset(blockbuffer, 0, blocksize * (pagesize + 64));
860 lbap = (lba_offset << 1) | 0x1000;
861 if (parity[MSB_of(lbap) ^ LSB_of(lbap)])
864 /* check old contents and fill lba */
865 for (i = 0; i < blocksize; i++) {
866 bptr = blockbuffer + (i * (pagesize + 64));
867 cptr = bptr + pagesize;
868 nand_compute_ecc(bptr, ecc);
869 if (!nand_compare_ecc(cptr+13, ecc)) {
870 usb_stor_dbg(us, "Warning: bad ecc in page %d- of pba %d\n",
872 nand_store_ecc(cptr+13, ecc);
874 nand_compute_ecc(bptr + (pagesize / 2), ecc);
875 if (!nand_compare_ecc(cptr+8, ecc)) {
876 usb_stor_dbg(us, "Warning: bad ecc in page %d+ of pba %d\n",
878 nand_store_ecc(cptr+8, ecc);
880 cptr[6] = cptr[11] = MSB_of(lbap);
881 cptr[7] = cptr[12] = LSB_of(lbap);
884 /* copy in new stuff and compute ECC */
886 for (i = page; i < page+pages; i++) {
887 bptr = blockbuffer + (i * (pagesize + 64));
888 cptr = bptr + pagesize;
889 memcpy(bptr, xptr, pagesize);
891 nand_compute_ecc(bptr, ecc);
892 nand_store_ecc(cptr+13, ecc);
893 nand_compute_ecc(bptr + (pagesize / 2), ecc);
894 nand_store_ecc(cptr+8, ecc);
897 result = alauda_write_block(us, new_pba, blockbuffer);
898 if (result != USB_STOR_XFER_GOOD)
901 new_pba_offset = new_pba - (zone * zonesize);
902 MEDIA_INFO(us).pba_to_lba[zone][new_pba_offset] = lba;
903 MEDIA_INFO(us).lba_to_pba[zone][lba_offset] = new_pba;
904 usb_stor_dbg(us, "Remapped LBA %d to PBA %d\n", lba, new_pba);
907 unsigned int pba_offset = pba - (zone * zonesize);
908 result = alauda_erase_block(us, pba);
909 if (result != USB_STOR_XFER_GOOD)
911 MEDIA_INFO(us).pba_to_lba[zone][pba_offset] = UNDEF;
914 return USB_STOR_TRANSPORT_GOOD;
918 * Read data from a specific sector address
920 static int alauda_read_data(struct us_data *us, unsigned long address,
921 unsigned int sectors)
923 unsigned char *buffer;
925 unsigned int page, len, offset;
926 unsigned int blockshift = MEDIA_INFO(us).blockshift;
927 unsigned int pageshift = MEDIA_INFO(us).pageshift;
928 unsigned int blocksize = MEDIA_INFO(us).blocksize;
929 unsigned int pagesize = MEDIA_INFO(us).pagesize;
930 unsigned int uzonesize = MEDIA_INFO(us).uzonesize;
931 struct scatterlist *sg;
935 * Since we only read in one block at a time, we have to create
936 * a bounce buffer and move the data a piece at a time between the
937 * bounce buffer and the actual transfer buffer.
938 * We make this buffer big enough to hold temporary redundancy data,
939 * which we use when reading the data blocks.
942 len = min(sectors, blocksize) * (pagesize + 64);
943 buffer = kmalloc(len, GFP_NOIO);
945 return USB_STOR_TRANSPORT_ERROR;
947 /* Figure out the initial LBA and page */
948 lba = address >> blockshift;
949 page = (address & MEDIA_INFO(us).blockmask);
950 max_lba = MEDIA_INFO(us).capacity >> (blockshift + pageshift);
952 result = USB_STOR_TRANSPORT_GOOD;
956 while (sectors > 0) {
957 unsigned int zone = lba / uzonesize; /* integer division */
958 unsigned int lba_offset = lba - (zone * uzonesize);
961 alauda_ensure_map_for_zone(us, zone);
963 /* Not overflowing capacity? */
964 if (lba >= max_lba) {
965 usb_stor_dbg(us, "Error: Requested lba %u exceeds maximum %u\n",
967 result = USB_STOR_TRANSPORT_ERROR;
971 /* Find number of pages we can read in this block */
972 pages = min(sectors, blocksize - page);
973 len = pages << pageshift;
975 /* Find where this lba lives on disk */
976 pba = MEDIA_INFO(us).lba_to_pba[zone][lba_offset];
978 if (pba == UNDEF) { /* this lba was never written */
979 usb_stor_dbg(us, "Read %d zero pages (LBA %d) page %d\n",
983 * This is not really an error. It just means
984 * that the block has never been written.
985 * Instead of returning USB_STOR_TRANSPORT_ERROR
986 * it is better to return all zero data.
989 memset(buffer, 0, len);
991 usb_stor_dbg(us, "Read %d pages, from PBA %d (LBA %d) page %d\n",
992 pages, pba, lba, page);
994 result = alauda_read_block(us, pba, page, pages, buffer);
995 if (result != USB_STOR_TRANSPORT_GOOD)
999 /* Store the data in the transfer buffer */
1000 usb_stor_access_xfer_buf(buffer, len, us->srb,
1001 &sg, &offset, TO_XFER_BUF);
1013 * Write data to a specific sector address
1015 static int alauda_write_data(struct us_data *us, unsigned long address,
1016 unsigned int sectors)
1018 unsigned char *buffer, *blockbuffer;
1019 unsigned int page, len, offset;
1020 unsigned int blockshift = MEDIA_INFO(us).blockshift;
1021 unsigned int pageshift = MEDIA_INFO(us).pageshift;
1022 unsigned int blocksize = MEDIA_INFO(us).blocksize;
1023 unsigned int pagesize = MEDIA_INFO(us).pagesize;
1024 struct scatterlist *sg;
1029 * Since we don't write the user data directly to the device,
1030 * we have to create a bounce buffer and move the data a piece
1031 * at a time between the bounce buffer and the actual transfer buffer.
1034 len = min(sectors, blocksize) * pagesize;
1035 buffer = kmalloc(len, GFP_NOIO);
1037 return USB_STOR_TRANSPORT_ERROR;
1040 * We also need a temporary block buffer, where we read in the old data,
1041 * overwrite parts with the new data, and manipulate the redundancy data
1043 blockbuffer = kmalloc((pagesize + 64) * blocksize, GFP_NOIO);
1046 return USB_STOR_TRANSPORT_ERROR;
1049 /* Figure out the initial LBA and page */
1050 lba = address >> blockshift;
1051 page = (address & MEDIA_INFO(us).blockmask);
1052 max_lba = MEDIA_INFO(us).capacity >> (pageshift + blockshift);
1054 result = USB_STOR_TRANSPORT_GOOD;
1058 while (sectors > 0) {
1059 /* Write as many sectors as possible in this block */
1060 unsigned int pages = min(sectors, blocksize - page);
1061 len = pages << pageshift;
1063 /* Not overflowing capacity? */
1064 if (lba >= max_lba) {
1065 usb_stor_dbg(us, "Requested lba %u exceeds maximum %u\n",
1067 result = USB_STOR_TRANSPORT_ERROR;
1071 /* Get the data from the transfer buffer */
1072 usb_stor_access_xfer_buf(buffer, len, us->srb,
1073 &sg, &offset, FROM_XFER_BUF);
1075 result = alauda_write_lba(us, lba, page, pages, buffer,
1077 if (result != USB_STOR_TRANSPORT_GOOD)
1091 * Our interface with the rest of the world
1094 static void alauda_info_destructor(void *extra)
1096 struct alauda_info *info = (struct alauda_info *) extra;
1102 for (port = 0; port < 2; port++) {
1103 struct alauda_media_info *media_info = &info->port[port];
1105 alauda_free_maps(media_info);
1106 kfree(media_info->lba_to_pba);
1107 kfree(media_info->pba_to_lba);
1112 * Initialize alauda_info struct and find the data-write endpoint
1114 static int init_alauda(struct us_data *us)
1116 struct alauda_info *info;
1117 struct usb_host_interface *altsetting = us->pusb_intf->cur_altsetting;
1120 us->extra = kzalloc(sizeof(struct alauda_info), GFP_NOIO);
1122 return USB_STOR_TRANSPORT_ERROR;
1124 info = (struct alauda_info *) us->extra;
1125 us->extra_destructor = alauda_info_destructor;
1127 info->wr_ep = usb_sndbulkpipe(us->pusb_dev,
1128 altsetting->endpoint[0].desc.bEndpointAddress
1129 & USB_ENDPOINT_NUMBER_MASK);
1131 return USB_STOR_TRANSPORT_GOOD;
1134 static int alauda_transport(struct scsi_cmnd *srb, struct us_data *us)
1137 struct alauda_info *info = (struct alauda_info *) us->extra;
1138 unsigned char *ptr = us->iobuf;
1139 static unsigned char inquiry_response[36] = {
1140 0x00, 0x80, 0x00, 0x01, 0x1F, 0x00, 0x00, 0x00
1143 if (srb->cmnd[0] == INQUIRY) {
1144 usb_stor_dbg(us, "INQUIRY - Returning bogus response\n");
1145 memcpy(ptr, inquiry_response, sizeof(inquiry_response));
1146 fill_inquiry_response(us, ptr, 36);
1147 return USB_STOR_TRANSPORT_GOOD;
1150 if (srb->cmnd[0] == TEST_UNIT_READY) {
1151 usb_stor_dbg(us, "TEST_UNIT_READY\n");
1152 return alauda_check_media(us);
1155 if (srb->cmnd[0] == READ_CAPACITY) {
1156 unsigned int num_zones;
1157 unsigned long capacity;
1159 rc = alauda_check_media(us);
1160 if (rc != USB_STOR_TRANSPORT_GOOD)
1163 num_zones = MEDIA_INFO(us).capacity >> (MEDIA_INFO(us).zoneshift
1164 + MEDIA_INFO(us).blockshift + MEDIA_INFO(us).pageshift);
1166 capacity = num_zones * MEDIA_INFO(us).uzonesize
1167 * MEDIA_INFO(us).blocksize;
1169 /* Report capacity and page size */
1170 ((__be32 *) ptr)[0] = cpu_to_be32(capacity - 1);
1171 ((__be32 *) ptr)[1] = cpu_to_be32(512);
1173 usb_stor_set_xfer_buf(ptr, 8, srb);
1174 return USB_STOR_TRANSPORT_GOOD;
1177 if (srb->cmnd[0] == READ_10) {
1178 unsigned int page, pages;
1180 rc = alauda_check_media(us);
1181 if (rc != USB_STOR_TRANSPORT_GOOD)
1184 page = short_pack(srb->cmnd[3], srb->cmnd[2]);
1186 page |= short_pack(srb->cmnd[5], srb->cmnd[4]);
1187 pages = short_pack(srb->cmnd[8], srb->cmnd[7]);
1189 usb_stor_dbg(us, "READ_10: page %d pagect %d\n", page, pages);
1191 return alauda_read_data(us, page, pages);
1194 if (srb->cmnd[0] == WRITE_10) {
1195 unsigned int page, pages;
1197 rc = alauda_check_media(us);
1198 if (rc != USB_STOR_TRANSPORT_GOOD)
1201 page = short_pack(srb->cmnd[3], srb->cmnd[2]);
1203 page |= short_pack(srb->cmnd[5], srb->cmnd[4]);
1204 pages = short_pack(srb->cmnd[8], srb->cmnd[7]);
1206 usb_stor_dbg(us, "WRITE_10: page %d pagect %d\n", page, pages);
1208 return alauda_write_data(us, page, pages);
1211 if (srb->cmnd[0] == REQUEST_SENSE) {
1212 usb_stor_dbg(us, "REQUEST_SENSE\n");
1216 ptr[2] = info->sense_key;
1218 ptr[12] = info->sense_asc;
1219 ptr[13] = info->sense_ascq;
1220 usb_stor_set_xfer_buf(ptr, 18, srb);
1222 return USB_STOR_TRANSPORT_GOOD;
1225 if (srb->cmnd[0] == ALLOW_MEDIUM_REMOVAL) {
1227 * sure. whatever. not like we can stop the user from popping
1228 * the media out of the device (no locking doors, etc)
1230 return USB_STOR_TRANSPORT_GOOD;
1233 usb_stor_dbg(us, "Gah! Unknown command: %d (0x%x)\n",
1234 srb->cmnd[0], srb->cmnd[0]);
1235 info->sense_key = 0x05;
1236 info->sense_asc = 0x20;
1237 info->sense_ascq = 0x00;
1238 return USB_STOR_TRANSPORT_FAILED;
1241 static struct scsi_host_template alauda_host_template;
1243 static int alauda_probe(struct usb_interface *intf,
1244 const struct usb_device_id *id)
1249 result = usb_stor_probe1(&us, intf, id,
1250 (id - alauda_usb_ids) + alauda_unusual_dev_list,
1251 &alauda_host_template);
1255 us->transport_name = "Alauda Control/Bulk";
1256 us->transport = alauda_transport;
1257 us->transport_reset = usb_stor_Bulk_reset;
1260 result = usb_stor_probe2(us);
1264 static struct usb_driver alauda_driver = {
1266 .probe = alauda_probe,
1267 .disconnect = usb_stor_disconnect,
1268 .suspend = usb_stor_suspend,
1269 .resume = usb_stor_resume,
1270 .reset_resume = usb_stor_reset_resume,
1271 .pre_reset = usb_stor_pre_reset,
1272 .post_reset = usb_stor_post_reset,
1273 .id_table = alauda_usb_ids,
1278 module_usb_stor_driver(alauda_driver, alauda_host_template, DRV_NAME);