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"
46 MODULE_DESCRIPTION("Driver for Alauda-based card readers");
47 MODULE_AUTHOR("Daniel Drake <dsd@gentoo.org>");
48 MODULE_LICENSE("GPL");
53 #define ALAUDA_STATUS_ERROR 0x01
54 #define ALAUDA_STATUS_READY 0x40
57 * Control opcodes (for request field)
59 #define ALAUDA_GET_XD_MEDIA_STATUS 0x08
60 #define ALAUDA_GET_SM_MEDIA_STATUS 0x98
61 #define ALAUDA_ACK_XD_MEDIA_CHANGE 0x0a
62 #define ALAUDA_ACK_SM_MEDIA_CHANGE 0x9a
63 #define ALAUDA_GET_XD_MEDIA_SIG 0x86
64 #define ALAUDA_GET_SM_MEDIA_SIG 0x96
67 * Bulk command identity (byte 0)
69 #define ALAUDA_BULK_CMD 0x40
72 * Bulk opcodes (byte 1)
74 #define ALAUDA_BULK_GET_REDU_DATA 0x85
75 #define ALAUDA_BULK_READ_BLOCK 0x94
76 #define ALAUDA_BULK_ERASE_BLOCK 0xa3
77 #define ALAUDA_BULK_WRITE_BLOCK 0xb4
78 #define ALAUDA_BULK_GET_STATUS2 0xb7
79 #define ALAUDA_BULK_RESET_MEDIA 0xe0
82 * Port to operate on (byte 8)
84 #define ALAUDA_PORT_XD 0x00
85 #define ALAUDA_PORT_SM 0x01
88 * LBA and PBA are unsigned ints. Special values.
92 #define UNUSABLE 0xfffd
94 struct alauda_media_info
{
95 unsigned long capacity
; /* total media size in bytes */
96 unsigned int pagesize
; /* page size in bytes */
97 unsigned int blocksize
; /* number of pages per block */
98 unsigned int uzonesize
; /* number of usable blocks per zone */
99 unsigned int zonesize
; /* number of blocks per zone */
100 unsigned int blockmask
; /* mask to get page from address */
102 unsigned char pageshift
;
103 unsigned char blockshift
;
104 unsigned char zoneshift
;
106 u16
**lba_to_pba
; /* logical to physical block map */
107 u16
**pba_to_lba
; /* physical to logical block map */
111 struct alauda_media_info port
[2];
112 int wr_ep
; /* endpoint to write data out of */
114 unsigned char sense_key
;
115 unsigned long sense_asc
; /* additional sense code */
116 unsigned long sense_ascq
; /* additional sense code qualifier */
119 #define short_pack(lsb,msb) ( ((u16)(lsb)) | ( ((u16)(msb))<<8 ) )
120 #define LSB_of(s) ((s)&0xFF)
121 #define MSB_of(s) ((s)>>8)
123 #define MEDIA_PORT(us) us->srb->device->lun
124 #define MEDIA_INFO(us) ((struct alauda_info *)us->extra)->port[MEDIA_PORT(us)]
126 #define PBA_LO(pba) ((pba & 0xF) << 5)
127 #define PBA_HI(pba) (pba >> 3)
128 #define PBA_ZONE(pba) (pba >> 11)
130 static int init_alauda(struct us_data
*us
);
134 * The table of devices
136 #define UNUSUAL_DEV(id_vendor, id_product, bcdDeviceMin, bcdDeviceMax, \
137 vendorName, productName, useProtocol, useTransport, \
138 initFunction, flags) \
139 { USB_DEVICE_VER(id_vendor, id_product, bcdDeviceMin, bcdDeviceMax), \
140 .driver_info = (flags) }
142 static struct usb_device_id alauda_usb_ids
[] = {
143 # include "unusual_alauda.h"
144 { } /* Terminating entry */
146 MODULE_DEVICE_TABLE(usb
, alauda_usb_ids
);
153 #define UNUSUAL_DEV(idVendor, idProduct, bcdDeviceMin, bcdDeviceMax, \
154 vendor_name, product_name, use_protocol, use_transport, \
155 init_function, Flags) \
157 .vendorName = vendor_name, \
158 .productName = product_name, \
159 .useProtocol = use_protocol, \
160 .useTransport = use_transport, \
161 .initFunction = init_function, \
164 static struct us_unusual_dev alauda_unusual_dev_list
[] = {
165 # include "unusual_alauda.h"
166 { } /* Terminating entry */
176 struct alauda_card_info
{
177 unsigned char id
; /* id byte */
178 unsigned char chipshift
; /* 1<<cs bytes total capacity */
179 unsigned char pageshift
; /* 1<<ps bytes in a page */
180 unsigned char blockshift
; /* 1<<bs pages per block */
181 unsigned char zoneshift
; /* 1<<zs blocks per zone */
184 static struct alauda_card_info alauda_card_ids
[] = {
186 { 0x6e, 20, 8, 4, 8}, /* 1 MB */
187 { 0xe8, 20, 8, 4, 8}, /* 1 MB */
188 { 0xec, 20, 8, 4, 8}, /* 1 MB */
189 { 0x64, 21, 8, 4, 9}, /* 2 MB */
190 { 0xea, 21, 8, 4, 9}, /* 2 MB */
191 { 0x6b, 22, 9, 4, 9}, /* 4 MB */
192 { 0xe3, 22, 9, 4, 9}, /* 4 MB */
193 { 0xe5, 22, 9, 4, 9}, /* 4 MB */
194 { 0xe6, 23, 9, 4, 10}, /* 8 MB */
195 { 0x73, 24, 9, 5, 10}, /* 16 MB */
196 { 0x75, 25, 9, 5, 10}, /* 32 MB */
197 { 0x76, 26, 9, 5, 10}, /* 64 MB */
198 { 0x79, 27, 9, 5, 10}, /* 128 MB */
199 { 0x71, 28, 9, 5, 10}, /* 256 MB */
202 { 0x5d, 21, 9, 4, 8}, /* 2 MB */
203 { 0xd5, 22, 9, 4, 9}, /* 4 MB */
204 { 0xd6, 23, 9, 4, 10}, /* 8 MB */
205 { 0x57, 24, 9, 4, 11}, /* 16 MB */
206 { 0x58, 25, 9, 4, 12}, /* 32 MB */
210 static struct alauda_card_info
*alauda_card_find_id(unsigned char id
) {
213 for (i
= 0; alauda_card_ids
[i
].id
!= 0; i
++)
214 if (alauda_card_ids
[i
].id
== id
)
215 return &(alauda_card_ids
[i
]);
223 static unsigned char parity
[256];
224 static unsigned char ecc2
[256];
226 static void nand_init_ecc(void) {
230 for (i
= 1; i
< 256; i
++)
231 parity
[i
] = (parity
[i
&(i
-1)] ^ 1);
233 for (i
= 0; i
< 256; i
++) {
235 for (j
= 0; j
< 8; j
++) {
245 ecc2
[i
] = ~(a
^ (a
<<1) ^ (parity
[i
] ? 0xa8 : 0));
249 /* compute 3-byte ecc on 256 bytes */
250 static void nand_compute_ecc(unsigned char *data
, unsigned char *ecc
) {
252 unsigned char par
= 0, bit
, bits
[8] = {0};
254 /* collect 16 checksum bits */
255 for (i
= 0; i
< 256; i
++) {
257 bit
= parity
[data
[i
]];
258 for (j
= 0; j
< 8; j
++)
259 if ((i
& (1<<j
)) == 0)
263 /* put 4+4+4 = 12 bits in the ecc */
264 a
= (bits
[3] << 6) + (bits
[2] << 4) + (bits
[1] << 2) + bits
[0];
265 ecc
[0] = ~(a
^ (a
<<1) ^ (parity
[par
] ? 0xaa : 0));
267 a
= (bits
[7] << 6) + (bits
[6] << 4) + (bits
[5] << 2) + bits
[4];
268 ecc
[1] = ~(a
^ (a
<<1) ^ (parity
[par
] ? 0xaa : 0));
273 static int nand_compare_ecc(unsigned char *data
, unsigned char *ecc
) {
274 return (data
[0] == ecc
[0] && data
[1] == ecc
[1] && data
[2] == ecc
[2]);
277 static void nand_store_ecc(unsigned char *data
, unsigned char *ecc
) {
278 memcpy(data
, ecc
, 3);
286 * Forget our PBA <---> LBA mappings for a particular port
288 static void alauda_free_maps (struct alauda_media_info
*media_info
)
290 unsigned int shift
= media_info
->zoneshift
291 + media_info
->blockshift
+ media_info
->pageshift
;
292 unsigned int num_zones
= media_info
->capacity
>> shift
;
295 if (media_info
->lba_to_pba
!= NULL
)
296 for (i
= 0; i
< num_zones
; i
++) {
297 kfree(media_info
->lba_to_pba
[i
]);
298 media_info
->lba_to_pba
[i
] = NULL
;
301 if (media_info
->pba_to_lba
!= NULL
)
302 for (i
= 0; i
< num_zones
; i
++) {
303 kfree(media_info
->pba_to_lba
[i
]);
304 media_info
->pba_to_lba
[i
] = NULL
;
309 * Returns 2 bytes of status data
310 * The first byte describes media status, and second byte describes door status
312 static int alauda_get_media_status(struct us_data
*us
, unsigned char *data
)
315 unsigned char command
;
317 if (MEDIA_PORT(us
) == ALAUDA_PORT_XD
)
318 command
= ALAUDA_GET_XD_MEDIA_STATUS
;
320 command
= ALAUDA_GET_SM_MEDIA_STATUS
;
322 rc
= usb_stor_ctrl_transfer(us
, us
->recv_ctrl_pipe
,
323 command
, 0xc0, 0, 1, data
, 2);
325 usb_stor_dbg(us
, "Media status %02X %02X\n", data
[0], data
[1]);
331 * Clears the "media was changed" bit so that we know when it changes again
334 static int alauda_ack_media(struct us_data
*us
)
336 unsigned char command
;
338 if (MEDIA_PORT(us
) == ALAUDA_PORT_XD
)
339 command
= ALAUDA_ACK_XD_MEDIA_CHANGE
;
341 command
= ALAUDA_ACK_SM_MEDIA_CHANGE
;
343 return usb_stor_ctrl_transfer(us
, us
->send_ctrl_pipe
,
344 command
, 0x40, 0, 1, NULL
, 0);
348 * Retrieves a 4-byte media signature, which indicates manufacturer, capacity,
349 * and some other details.
351 static int alauda_get_media_signature(struct us_data
*us
, unsigned char *data
)
353 unsigned char command
;
355 if (MEDIA_PORT(us
) == ALAUDA_PORT_XD
)
356 command
= ALAUDA_GET_XD_MEDIA_SIG
;
358 command
= ALAUDA_GET_SM_MEDIA_SIG
;
360 return usb_stor_ctrl_transfer(us
, us
->recv_ctrl_pipe
,
361 command
, 0xc0, 0, 0, data
, 4);
365 * Resets the media status (but not the whole device?)
367 static int alauda_reset_media(struct us_data
*us
)
369 unsigned char *command
= us
->iobuf
;
371 memset(command
, 0, 9);
372 command
[0] = ALAUDA_BULK_CMD
;
373 command
[1] = ALAUDA_BULK_RESET_MEDIA
;
374 command
[8] = MEDIA_PORT(us
);
376 return usb_stor_bulk_transfer_buf(us
, us
->send_bulk_pipe
,
381 * Examines the media and deduces capacity, etc.
383 static int alauda_init_media(struct us_data
*us
)
385 unsigned char *data
= us
->iobuf
;
387 struct alauda_card_info
*media_info
;
388 unsigned int num_zones
;
393 if (alauda_get_media_status(us
, data
) != USB_STOR_XFER_GOOD
)
394 return USB_STOR_TRANSPORT_ERROR
;
400 usb_stor_dbg(us
, "We are ready for action!\n");
402 if (alauda_ack_media(us
) != USB_STOR_XFER_GOOD
)
403 return USB_STOR_TRANSPORT_ERROR
;
407 if (alauda_get_media_status(us
, data
) != USB_STOR_XFER_GOOD
)
408 return USB_STOR_TRANSPORT_ERROR
;
410 if (data
[0] != 0x14) {
411 usb_stor_dbg(us
, "Media not ready after ack\n");
412 return USB_STOR_TRANSPORT_ERROR
;
415 if (alauda_get_media_signature(us
, data
) != USB_STOR_XFER_GOOD
)
416 return USB_STOR_TRANSPORT_ERROR
;
418 usb_stor_dbg(us
, "Media signature: %4ph\n", data
);
419 media_info
= alauda_card_find_id(data
[1]);
420 if (media_info
== NULL
) {
421 pr_warn("alauda_init_media: Unrecognised media signature: %4ph\n",
423 return USB_STOR_TRANSPORT_ERROR
;
426 MEDIA_INFO(us
).capacity
= 1 << media_info
->chipshift
;
427 usb_stor_dbg(us
, "Found media with capacity: %ldMB\n",
428 MEDIA_INFO(us
).capacity
>> 20);
430 MEDIA_INFO(us
).pageshift
= media_info
->pageshift
;
431 MEDIA_INFO(us
).blockshift
= media_info
->blockshift
;
432 MEDIA_INFO(us
).zoneshift
= media_info
->zoneshift
;
434 MEDIA_INFO(us
).pagesize
= 1 << media_info
->pageshift
;
435 MEDIA_INFO(us
).blocksize
= 1 << media_info
->blockshift
;
436 MEDIA_INFO(us
).zonesize
= 1 << media_info
->zoneshift
;
438 MEDIA_INFO(us
).uzonesize
= ((1 << media_info
->zoneshift
) / 128) * 125;
439 MEDIA_INFO(us
).blockmask
= MEDIA_INFO(us
).blocksize
- 1;
441 num_zones
= MEDIA_INFO(us
).capacity
>> (MEDIA_INFO(us
).zoneshift
442 + MEDIA_INFO(us
).blockshift
+ MEDIA_INFO(us
).pageshift
);
443 MEDIA_INFO(us
).pba_to_lba
= kcalloc(num_zones
, sizeof(u16
*), GFP_NOIO
);
444 MEDIA_INFO(us
).lba_to_pba
= kcalloc(num_zones
, sizeof(u16
*), GFP_NOIO
);
446 if (alauda_reset_media(us
) != USB_STOR_XFER_GOOD
)
447 return USB_STOR_TRANSPORT_ERROR
;
449 return USB_STOR_TRANSPORT_GOOD
;
453 * Examines the media status and does the right thing when the media has gone,
454 * appeared, or changed.
456 static int alauda_check_media(struct us_data
*us
)
458 struct alauda_info
*info
= (struct alauda_info
*) us
->extra
;
459 unsigned char status
[2];
462 rc
= alauda_get_media_status(us
, status
);
464 /* Check for no media or door open */
465 if ((status
[0] & 0x80) || ((status
[0] & 0x1F) == 0x10)
466 || ((status
[1] & 0x01) == 0)) {
467 usb_stor_dbg(us
, "No media, or door open\n");
468 alauda_free_maps(&MEDIA_INFO(us
));
469 info
->sense_key
= 0x02;
470 info
->sense_asc
= 0x3A;
471 info
->sense_ascq
= 0x00;
472 return USB_STOR_TRANSPORT_FAILED
;
475 /* Check for media change */
476 if (status
[0] & 0x08) {
477 usb_stor_dbg(us
, "Media change detected\n");
478 alauda_free_maps(&MEDIA_INFO(us
));
479 alauda_init_media(us
);
481 info
->sense_key
= UNIT_ATTENTION
;
482 info
->sense_asc
= 0x28;
483 info
->sense_ascq
= 0x00;
484 return USB_STOR_TRANSPORT_FAILED
;
487 return USB_STOR_TRANSPORT_GOOD
;
491 * Checks the status from the 2nd status register
492 * Returns 3 bytes of status data, only the first is known
494 static int alauda_check_status2(struct us_data
*us
)
497 unsigned char command
[] = {
498 ALAUDA_BULK_CMD
, ALAUDA_BULK_GET_STATUS2
,
499 0, 0, 0, 0, 3, 0, MEDIA_PORT(us
)
501 unsigned char data
[3];
503 rc
= usb_stor_bulk_transfer_buf(us
, us
->send_bulk_pipe
,
505 if (rc
!= USB_STOR_XFER_GOOD
)
508 rc
= usb_stor_bulk_transfer_buf(us
, us
->recv_bulk_pipe
,
510 if (rc
!= USB_STOR_XFER_GOOD
)
513 usb_stor_dbg(us
, "%3ph\n", data
);
514 if (data
[0] & ALAUDA_STATUS_ERROR
)
515 return USB_STOR_XFER_ERROR
;
517 return USB_STOR_XFER_GOOD
;
521 * Gets the redundancy data for the first page of a PBA
524 static int alauda_get_redu_data(struct us_data
*us
, u16 pba
, unsigned char *data
)
527 unsigned char command
[] = {
528 ALAUDA_BULK_CMD
, ALAUDA_BULK_GET_REDU_DATA
,
529 PBA_HI(pba
), PBA_ZONE(pba
), 0, PBA_LO(pba
), 0, 0, MEDIA_PORT(us
)
532 rc
= usb_stor_bulk_transfer_buf(us
, us
->send_bulk_pipe
,
534 if (rc
!= USB_STOR_XFER_GOOD
)
537 return usb_stor_bulk_transfer_buf(us
, us
->recv_bulk_pipe
,
542 * Finds the first unused PBA in a zone
543 * Returns the absolute PBA of an unused PBA, or 0 if none found.
545 static u16
alauda_find_unused_pba(struct alauda_media_info
*info
,
548 u16
*pba_to_lba
= info
->pba_to_lba
[zone
];
551 for (i
= 0; i
< info
->zonesize
; i
++)
552 if (pba_to_lba
[i
] == UNDEF
)
553 return (zone
<< info
->zoneshift
) + i
;
559 * Reads the redundancy data for all PBA's in a zone
560 * Produces lba <--> pba mappings
562 static int alauda_read_map(struct us_data
*us
, unsigned int zone
)
564 unsigned char *data
= us
->iobuf
;
567 unsigned int zonesize
= MEDIA_INFO(us
).zonesize
;
568 unsigned int uzonesize
= MEDIA_INFO(us
).uzonesize
;
569 unsigned int lba_offset
, lba_real
, blocknum
;
570 unsigned int zone_base_lba
= zone
* uzonesize
;
571 unsigned int zone_base_pba
= zone
* zonesize
;
572 u16
*lba_to_pba
= kcalloc(zonesize
, sizeof(u16
), GFP_NOIO
);
573 u16
*pba_to_lba
= kcalloc(zonesize
, sizeof(u16
), GFP_NOIO
);
574 if (lba_to_pba
== NULL
|| pba_to_lba
== NULL
) {
575 result
= USB_STOR_TRANSPORT_ERROR
;
579 usb_stor_dbg(us
, "Mapping blocks for zone %d\n", zone
);
581 /* 1024 PBA's per zone */
582 for (i
= 0; i
< zonesize
; i
++)
583 lba_to_pba
[i
] = pba_to_lba
[i
] = UNDEF
;
585 for (i
= 0; i
< zonesize
; i
++) {
586 blocknum
= zone_base_pba
+ i
;
588 result
= alauda_get_redu_data(us
, blocknum
, data
);
589 if (result
!= USB_STOR_XFER_GOOD
) {
590 result
= USB_STOR_TRANSPORT_ERROR
;
594 /* special PBAs have control field 0^16 */
595 for (j
= 0; j
< 16; j
++)
598 pba_to_lba
[i
] = UNUSABLE
;
599 usb_stor_dbg(us
, "PBA %d has no logical mapping\n", blocknum
);
603 /* unwritten PBAs have control field FF^16 */
604 for (j
= 0; j
< 16; j
++)
610 /* normal PBAs start with six FFs */
612 usb_stor_dbg(us
, "PBA %d has no logical mapping: reserved area = %02X%02X%02X%02X data status %02X block status %02X\n",
614 data
[0], data
[1], data
[2], data
[3],
616 pba_to_lba
[i
] = UNUSABLE
;
620 if ((data
[6] >> 4) != 0x01) {
621 usb_stor_dbg(us
, "PBA %d has invalid address field %02X%02X/%02X%02X\n",
622 blocknum
, data
[6], data
[7],
624 pba_to_lba
[i
] = UNUSABLE
;
628 /* check even parity */
629 if (parity
[data
[6] ^ data
[7]]) {
631 "alauda_read_map: Bad parity in LBA for block %d"
632 " (%02X %02X)\n", i
, data
[6], data
[7]);
633 pba_to_lba
[i
] = UNUSABLE
;
637 lba_offset
= short_pack(data
[7], data
[6]);
638 lba_offset
= (lba_offset
& 0x07FF) >> 1;
639 lba_real
= lba_offset
+ zone_base_lba
;
642 * Every 1024 physical blocks ("zone"), the LBA numbers
643 * go back to zero, but are within a higher block of LBA's.
644 * Also, there is a maximum of 1000 LBA's per zone.
645 * In other words, in PBA 1024-2047 you will find LBA 0-999
646 * which are really LBA 1000-1999. This allows for 24 bad
647 * or special physical blocks per zone.
650 if (lba_offset
>= uzonesize
) {
652 "alauda_read_map: Bad low LBA %d for block %d\n",
657 if (lba_to_pba
[lba_offset
] != UNDEF
) {
660 "LBA %d seen for PBA %d and %d\n",
661 lba_real
, lba_to_pba
[lba_offset
], blocknum
);
665 pba_to_lba
[i
] = lba_real
;
666 lba_to_pba
[lba_offset
] = blocknum
;
670 MEDIA_INFO(us
).lba_to_pba
[zone
] = lba_to_pba
;
671 MEDIA_INFO(us
).pba_to_lba
[zone
] = pba_to_lba
;
683 * Checks to see whether we have already mapped a certain zone
684 * If we haven't, the map is generated
686 static void alauda_ensure_map_for_zone(struct us_data
*us
, unsigned int zone
)
688 if (MEDIA_INFO(us
).lba_to_pba
[zone
] == NULL
689 || MEDIA_INFO(us
).pba_to_lba
[zone
] == NULL
)
690 alauda_read_map(us
, zone
);
694 * Erases an entire block
696 static int alauda_erase_block(struct us_data
*us
, u16 pba
)
699 unsigned char command
[] = {
700 ALAUDA_BULK_CMD
, ALAUDA_BULK_ERASE_BLOCK
, PBA_HI(pba
),
701 PBA_ZONE(pba
), 0, PBA_LO(pba
), 0x02, 0, MEDIA_PORT(us
)
703 unsigned char buf
[2];
705 usb_stor_dbg(us
, "Erasing PBA %d\n", pba
);
707 rc
= usb_stor_bulk_transfer_buf(us
, us
->send_bulk_pipe
,
709 if (rc
!= USB_STOR_XFER_GOOD
)
712 rc
= usb_stor_bulk_transfer_buf(us
, us
->recv_bulk_pipe
,
714 if (rc
!= USB_STOR_XFER_GOOD
)
717 usb_stor_dbg(us
, "Erase result: %02X %02X\n", buf
[0], buf
[1]);
722 * Reads data from a certain offset page inside a PBA, including interleaved
723 * redundancy data. Returns (pagesize+64)*pages bytes in data.
725 static int alauda_read_block_raw(struct us_data
*us
, u16 pba
,
726 unsigned int page
, unsigned int pages
, unsigned char *data
)
729 unsigned char command
[] = {
730 ALAUDA_BULK_CMD
, ALAUDA_BULK_READ_BLOCK
, PBA_HI(pba
),
731 PBA_ZONE(pba
), 0, PBA_LO(pba
) + page
, pages
, 0, MEDIA_PORT(us
)
734 usb_stor_dbg(us
, "pba %d page %d count %d\n", pba
, page
, pages
);
736 rc
= usb_stor_bulk_transfer_buf(us
, us
->send_bulk_pipe
,
738 if (rc
!= USB_STOR_XFER_GOOD
)
741 return usb_stor_bulk_transfer_buf(us
, us
->recv_bulk_pipe
,
742 data
, (MEDIA_INFO(us
).pagesize
+ 64) * pages
, NULL
);
746 * Reads data from a certain offset page inside a PBA, excluding redundancy
747 * data. Returns pagesize*pages bytes in data. Note that data must be big enough
748 * to hold (pagesize+64)*pages bytes of data, but you can ignore those 'extra'
749 * trailing bytes outside this function.
751 static int alauda_read_block(struct us_data
*us
, u16 pba
,
752 unsigned int page
, unsigned int pages
, unsigned char *data
)
755 unsigned int pagesize
= MEDIA_INFO(us
).pagesize
;
757 rc
= alauda_read_block_raw(us
, pba
, page
, pages
, data
);
758 if (rc
!= USB_STOR_XFER_GOOD
)
761 /* Cut out the redundancy data */
762 for (i
= 0; i
< pages
; i
++) {
763 int dest_offset
= i
* pagesize
;
764 int src_offset
= i
* (pagesize
+ 64);
765 memmove(data
+ dest_offset
, data
+ src_offset
, pagesize
);
772 * Writes an entire block of data and checks status after write.
773 * Redundancy data must be already included in data. Data should be
774 * (pagesize+64)*blocksize bytes in length.
776 static int alauda_write_block(struct us_data
*us
, u16 pba
, unsigned char *data
)
779 struct alauda_info
*info
= (struct alauda_info
*) us
->extra
;
780 unsigned char command
[] = {
781 ALAUDA_BULK_CMD
, ALAUDA_BULK_WRITE_BLOCK
, PBA_HI(pba
),
782 PBA_ZONE(pba
), 0, PBA_LO(pba
), 32, 0, MEDIA_PORT(us
)
785 usb_stor_dbg(us
, "pba %d\n", pba
);
787 rc
= usb_stor_bulk_transfer_buf(us
, us
->send_bulk_pipe
,
789 if (rc
!= USB_STOR_XFER_GOOD
)
792 rc
= usb_stor_bulk_transfer_buf(us
, info
->wr_ep
, data
,
793 (MEDIA_INFO(us
).pagesize
+ 64) * MEDIA_INFO(us
).blocksize
,
795 if (rc
!= USB_STOR_XFER_GOOD
)
798 return alauda_check_status2(us
);
802 * Write some data to a specific LBA.
804 static int alauda_write_lba(struct us_data
*us
, u16 lba
,
805 unsigned int page
, unsigned int pages
,
806 unsigned char *ptr
, unsigned char *blockbuffer
)
808 u16 pba
, lbap
, new_pba
;
809 unsigned char *bptr
, *cptr
, *xptr
;
810 unsigned char ecc
[3];
812 unsigned int uzonesize
= MEDIA_INFO(us
).uzonesize
;
813 unsigned int zonesize
= MEDIA_INFO(us
).zonesize
;
814 unsigned int pagesize
= MEDIA_INFO(us
).pagesize
;
815 unsigned int blocksize
= MEDIA_INFO(us
).blocksize
;
816 unsigned int lba_offset
= lba
% uzonesize
;
817 unsigned int new_pba_offset
;
818 unsigned int zone
= lba
/ uzonesize
;
820 alauda_ensure_map_for_zone(us
, zone
);
822 pba
= MEDIA_INFO(us
).lba_to_pba
[zone
][lba_offset
];
824 /* Maybe it is impossible to write to PBA 1.
825 Fake success, but don't do anything. */
827 "alauda_write_lba: avoid writing to pba 1\n");
828 return USB_STOR_TRANSPORT_GOOD
;
831 new_pba
= alauda_find_unused_pba(&MEDIA_INFO(us
), zone
);
834 "alauda_write_lba: Out of unused blocks\n");
835 return USB_STOR_TRANSPORT_ERROR
;
838 /* read old contents */
840 result
= alauda_read_block_raw(us
, pba
, 0,
841 blocksize
, blockbuffer
);
842 if (result
!= USB_STOR_XFER_GOOD
)
845 memset(blockbuffer
, 0, blocksize
* (pagesize
+ 64));
848 lbap
= (lba_offset
<< 1) | 0x1000;
849 if (parity
[MSB_of(lbap
) ^ LSB_of(lbap
)])
852 /* check old contents and fill lba */
853 for (i
= 0; i
< blocksize
; i
++) {
854 bptr
= blockbuffer
+ (i
* (pagesize
+ 64));
855 cptr
= bptr
+ pagesize
;
856 nand_compute_ecc(bptr
, ecc
);
857 if (!nand_compare_ecc(cptr
+13, ecc
)) {
858 usb_stor_dbg(us
, "Warning: bad ecc in page %d- of pba %d\n",
860 nand_store_ecc(cptr
+13, ecc
);
862 nand_compute_ecc(bptr
+ (pagesize
/ 2), ecc
);
863 if (!nand_compare_ecc(cptr
+8, ecc
)) {
864 usb_stor_dbg(us
, "Warning: bad ecc in page %d+ of pba %d\n",
866 nand_store_ecc(cptr
+8, ecc
);
868 cptr
[6] = cptr
[11] = MSB_of(lbap
);
869 cptr
[7] = cptr
[12] = LSB_of(lbap
);
872 /* copy in new stuff and compute ECC */
874 for (i
= page
; i
< page
+pages
; i
++) {
875 bptr
= blockbuffer
+ (i
* (pagesize
+ 64));
876 cptr
= bptr
+ pagesize
;
877 memcpy(bptr
, xptr
, pagesize
);
879 nand_compute_ecc(bptr
, ecc
);
880 nand_store_ecc(cptr
+13, ecc
);
881 nand_compute_ecc(bptr
+ (pagesize
/ 2), ecc
);
882 nand_store_ecc(cptr
+8, ecc
);
885 result
= alauda_write_block(us
, new_pba
, blockbuffer
);
886 if (result
!= USB_STOR_XFER_GOOD
)
889 new_pba_offset
= new_pba
- (zone
* zonesize
);
890 MEDIA_INFO(us
).pba_to_lba
[zone
][new_pba_offset
] = lba
;
891 MEDIA_INFO(us
).lba_to_pba
[zone
][lba_offset
] = new_pba
;
892 usb_stor_dbg(us
, "Remapped LBA %d to PBA %d\n", lba
, new_pba
);
895 unsigned int pba_offset
= pba
- (zone
* zonesize
);
896 result
= alauda_erase_block(us
, pba
);
897 if (result
!= USB_STOR_XFER_GOOD
)
899 MEDIA_INFO(us
).pba_to_lba
[zone
][pba_offset
] = UNDEF
;
902 return USB_STOR_TRANSPORT_GOOD
;
906 * Read data from a specific sector address
908 static int alauda_read_data(struct us_data
*us
, unsigned long address
,
909 unsigned int sectors
)
911 unsigned char *buffer
;
913 unsigned int page
, len
, offset
;
914 unsigned int blockshift
= MEDIA_INFO(us
).blockshift
;
915 unsigned int pageshift
= MEDIA_INFO(us
).pageshift
;
916 unsigned int blocksize
= MEDIA_INFO(us
).blocksize
;
917 unsigned int pagesize
= MEDIA_INFO(us
).pagesize
;
918 unsigned int uzonesize
= MEDIA_INFO(us
).uzonesize
;
919 struct scatterlist
*sg
;
923 * Since we only read in one block at a time, we have to create
924 * a bounce buffer and move the data a piece at a time between the
925 * bounce buffer and the actual transfer buffer.
926 * We make this buffer big enough to hold temporary redundancy data,
927 * which we use when reading the data blocks.
930 len
= min(sectors
, blocksize
) * (pagesize
+ 64);
931 buffer
= kmalloc(len
, GFP_NOIO
);
932 if (buffer
== NULL
) {
933 printk(KERN_WARNING
"alauda_read_data: Out of memory\n");
934 return USB_STOR_TRANSPORT_ERROR
;
937 /* Figure out the initial LBA and page */
938 lba
= address
>> blockshift
;
939 page
= (address
& MEDIA_INFO(us
).blockmask
);
940 max_lba
= MEDIA_INFO(us
).capacity
>> (blockshift
+ pageshift
);
942 result
= USB_STOR_TRANSPORT_GOOD
;
946 while (sectors
> 0) {
947 unsigned int zone
= lba
/ uzonesize
; /* integer division */
948 unsigned int lba_offset
= lba
- (zone
* uzonesize
);
951 alauda_ensure_map_for_zone(us
, zone
);
953 /* Not overflowing capacity? */
954 if (lba
>= max_lba
) {
955 usb_stor_dbg(us
, "Error: Requested lba %u exceeds maximum %u\n",
957 result
= USB_STOR_TRANSPORT_ERROR
;
961 /* Find number of pages we can read in this block */
962 pages
= min(sectors
, blocksize
- page
);
963 len
= pages
<< pageshift
;
965 /* Find where this lba lives on disk */
966 pba
= MEDIA_INFO(us
).lba_to_pba
[zone
][lba_offset
];
968 if (pba
== UNDEF
) { /* this lba was never written */
969 usb_stor_dbg(us
, "Read %d zero pages (LBA %d) page %d\n",
972 /* This is not really an error. It just means
973 that the block has never been written.
974 Instead of returning USB_STOR_TRANSPORT_ERROR
975 it is better to return all zero data. */
977 memset(buffer
, 0, len
);
979 usb_stor_dbg(us
, "Read %d pages, from PBA %d (LBA %d) page %d\n",
980 pages
, pba
, lba
, page
);
982 result
= alauda_read_block(us
, pba
, page
, pages
, buffer
);
983 if (result
!= USB_STOR_TRANSPORT_GOOD
)
987 /* Store the data in the transfer buffer */
988 usb_stor_access_xfer_buf(buffer
, len
, us
->srb
,
989 &sg
, &offset
, TO_XFER_BUF
);
1001 * Write data to a specific sector address
1003 static int alauda_write_data(struct us_data
*us
, unsigned long address
,
1004 unsigned int sectors
)
1006 unsigned char *buffer
, *blockbuffer
;
1007 unsigned int page
, len
, offset
;
1008 unsigned int blockshift
= MEDIA_INFO(us
).blockshift
;
1009 unsigned int pageshift
= MEDIA_INFO(us
).pageshift
;
1010 unsigned int blocksize
= MEDIA_INFO(us
).blocksize
;
1011 unsigned int pagesize
= MEDIA_INFO(us
).pagesize
;
1012 struct scatterlist
*sg
;
1017 * Since we don't write the user data directly to the device,
1018 * we have to create a bounce buffer and move the data a piece
1019 * at a time between the bounce buffer and the actual transfer buffer.
1022 len
= min(sectors
, blocksize
) * pagesize
;
1023 buffer
= kmalloc(len
, GFP_NOIO
);
1024 if (buffer
== NULL
) {
1025 printk(KERN_WARNING
"alauda_write_data: Out of memory\n");
1026 return USB_STOR_TRANSPORT_ERROR
;
1030 * We also need a temporary block buffer, where we read in the old data,
1031 * overwrite parts with the new data, and manipulate the redundancy data
1033 blockbuffer
= kmalloc((pagesize
+ 64) * blocksize
, GFP_NOIO
);
1034 if (blockbuffer
== NULL
) {
1035 printk(KERN_WARNING
"alauda_write_data: Out of memory\n");
1037 return USB_STOR_TRANSPORT_ERROR
;
1040 /* Figure out the initial LBA and page */
1041 lba
= address
>> blockshift
;
1042 page
= (address
& MEDIA_INFO(us
).blockmask
);
1043 max_lba
= MEDIA_INFO(us
).capacity
>> (pageshift
+ blockshift
);
1045 result
= USB_STOR_TRANSPORT_GOOD
;
1049 while (sectors
> 0) {
1050 /* Write as many sectors as possible in this block */
1051 unsigned int pages
= min(sectors
, blocksize
- page
);
1052 len
= pages
<< pageshift
;
1054 /* Not overflowing capacity? */
1055 if (lba
>= max_lba
) {
1056 usb_stor_dbg(us
, "Requested lba %u exceeds maximum %u\n",
1058 result
= USB_STOR_TRANSPORT_ERROR
;
1062 /* Get the data from the transfer buffer */
1063 usb_stor_access_xfer_buf(buffer
, len
, us
->srb
,
1064 &sg
, &offset
, FROM_XFER_BUF
);
1066 result
= alauda_write_lba(us
, lba
, page
, pages
, buffer
,
1068 if (result
!= USB_STOR_TRANSPORT_GOOD
)
1082 * Our interface with the rest of the world
1085 static void alauda_info_destructor(void *extra
)
1087 struct alauda_info
*info
= (struct alauda_info
*) extra
;
1093 for (port
= 0; port
< 2; port
++) {
1094 struct alauda_media_info
*media_info
= &info
->port
[port
];
1096 alauda_free_maps(media_info
);
1097 kfree(media_info
->lba_to_pba
);
1098 kfree(media_info
->pba_to_lba
);
1103 * Initialize alauda_info struct and find the data-write endpoint
1105 static int init_alauda(struct us_data
*us
)
1107 struct alauda_info
*info
;
1108 struct usb_host_interface
*altsetting
= us
->pusb_intf
->cur_altsetting
;
1111 us
->extra
= kzalloc(sizeof(struct alauda_info
), GFP_NOIO
);
1113 return USB_STOR_TRANSPORT_ERROR
;
1115 info
= (struct alauda_info
*) us
->extra
;
1116 us
->extra_destructor
= alauda_info_destructor
;
1118 info
->wr_ep
= usb_sndbulkpipe(us
->pusb_dev
,
1119 altsetting
->endpoint
[0].desc
.bEndpointAddress
1120 & USB_ENDPOINT_NUMBER_MASK
);
1122 return USB_STOR_TRANSPORT_GOOD
;
1125 static int alauda_transport(struct scsi_cmnd
*srb
, struct us_data
*us
)
1128 struct alauda_info
*info
= (struct alauda_info
*) us
->extra
;
1129 unsigned char *ptr
= us
->iobuf
;
1130 static unsigned char inquiry_response
[36] = {
1131 0x00, 0x80, 0x00, 0x01, 0x1F, 0x00, 0x00, 0x00
1134 if (srb
->cmnd
[0] == INQUIRY
) {
1135 usb_stor_dbg(us
, "INQUIRY - Returning bogus response\n");
1136 memcpy(ptr
, inquiry_response
, sizeof(inquiry_response
));
1137 fill_inquiry_response(us
, ptr
, 36);
1138 return USB_STOR_TRANSPORT_GOOD
;
1141 if (srb
->cmnd
[0] == TEST_UNIT_READY
) {
1142 usb_stor_dbg(us
, "TEST_UNIT_READY\n");
1143 return alauda_check_media(us
);
1146 if (srb
->cmnd
[0] == READ_CAPACITY
) {
1147 unsigned int num_zones
;
1148 unsigned long capacity
;
1150 rc
= alauda_check_media(us
);
1151 if (rc
!= USB_STOR_TRANSPORT_GOOD
)
1154 num_zones
= MEDIA_INFO(us
).capacity
>> (MEDIA_INFO(us
).zoneshift
1155 + MEDIA_INFO(us
).blockshift
+ MEDIA_INFO(us
).pageshift
);
1157 capacity
= num_zones
* MEDIA_INFO(us
).uzonesize
1158 * MEDIA_INFO(us
).blocksize
;
1160 /* Report capacity and page size */
1161 ((__be32
*) ptr
)[0] = cpu_to_be32(capacity
- 1);
1162 ((__be32
*) ptr
)[1] = cpu_to_be32(512);
1164 usb_stor_set_xfer_buf(ptr
, 8, srb
);
1165 return USB_STOR_TRANSPORT_GOOD
;
1168 if (srb
->cmnd
[0] == READ_10
) {
1169 unsigned int page
, pages
;
1171 rc
= alauda_check_media(us
);
1172 if (rc
!= USB_STOR_TRANSPORT_GOOD
)
1175 page
= short_pack(srb
->cmnd
[3], srb
->cmnd
[2]);
1177 page
|= short_pack(srb
->cmnd
[5], srb
->cmnd
[4]);
1178 pages
= short_pack(srb
->cmnd
[8], srb
->cmnd
[7]);
1180 usb_stor_dbg(us
, "READ_10: page %d pagect %d\n", page
, pages
);
1182 return alauda_read_data(us
, page
, pages
);
1185 if (srb
->cmnd
[0] == WRITE_10
) {
1186 unsigned int page
, pages
;
1188 rc
= alauda_check_media(us
);
1189 if (rc
!= USB_STOR_TRANSPORT_GOOD
)
1192 page
= short_pack(srb
->cmnd
[3], srb
->cmnd
[2]);
1194 page
|= short_pack(srb
->cmnd
[5], srb
->cmnd
[4]);
1195 pages
= short_pack(srb
->cmnd
[8], srb
->cmnd
[7]);
1197 usb_stor_dbg(us
, "WRITE_10: page %d pagect %d\n", page
, pages
);
1199 return alauda_write_data(us
, page
, pages
);
1202 if (srb
->cmnd
[0] == REQUEST_SENSE
) {
1203 usb_stor_dbg(us
, "REQUEST_SENSE\n");
1207 ptr
[2] = info
->sense_key
;
1209 ptr
[12] = info
->sense_asc
;
1210 ptr
[13] = info
->sense_ascq
;
1211 usb_stor_set_xfer_buf(ptr
, 18, srb
);
1213 return USB_STOR_TRANSPORT_GOOD
;
1216 if (srb
->cmnd
[0] == ALLOW_MEDIUM_REMOVAL
) {
1217 /* sure. whatever. not like we can stop the user from popping
1218 the media out of the device (no locking doors, etc) */
1219 return USB_STOR_TRANSPORT_GOOD
;
1222 usb_stor_dbg(us
, "Gah! Unknown command: %d (0x%x)\n",
1223 srb
->cmnd
[0], srb
->cmnd
[0]);
1224 info
->sense_key
= 0x05;
1225 info
->sense_asc
= 0x20;
1226 info
->sense_ascq
= 0x00;
1227 return USB_STOR_TRANSPORT_FAILED
;
1230 static int alauda_probe(struct usb_interface
*intf
,
1231 const struct usb_device_id
*id
)
1236 result
= usb_stor_probe1(&us
, intf
, id
,
1237 (id
- alauda_usb_ids
) + alauda_unusual_dev_list
);
1241 us
->transport_name
= "Alauda Control/Bulk";
1242 us
->transport
= alauda_transport
;
1243 us
->transport_reset
= usb_stor_Bulk_reset
;
1246 result
= usb_stor_probe2(us
);
1250 static struct usb_driver alauda_driver
= {
1251 .name
= "ums-alauda",
1252 .probe
= alauda_probe
,
1253 .disconnect
= usb_stor_disconnect
,
1254 .suspend
= usb_stor_suspend
,
1255 .resume
= usb_stor_resume
,
1256 .reset_resume
= usb_stor_reset_resume
,
1257 .pre_reset
= usb_stor_pre_reset
,
1258 .post_reset
= usb_stor_post_reset
,
1259 .id_table
= alauda_usb_ids
,
1264 module_usb_driver(alauda_driver
);