1274 lines · 32.8 KB · C
RawDownload
// SPDX-License-Identifier: GPL-2.0+/* * Driver for Alauda-based card readers * * Current development and maintenance by: *   (c) 2005 Daniel Drake <dsd@gentoo.org> * * The 'Alauda' is a chip manufacturered by RATOC for OEM use. * * Alauda implements a vendor-specific command set to access two media reader * ports (XD, SmartMedia). This driver converts SCSI commands to the commands * which are accepted by these devices. * * The driver was developed through reverse-engineering, with the help of the * sddr09 driver which has many similarities, and with some help from the * (very old) vendor-supplied GPL sma03 driver. * * For protocol info, see http://alauda.sourceforge.net */ #include <linux/module.h>#include <linux/slab.h> #include <scsi/scsi.h>#include <scsi/scsi_cmnd.h>#include <scsi/scsi_device.h> #include "usb.h"#include "transport.h"#include "protocol.h"#include "debug.h"#include "scsiglue.h" #define DRV_NAME "ums-alauda" MODULE_DESCRIPTION("Driver for Alauda-based card readers");MODULE_AUTHOR("Daniel Drake <dsd@gentoo.org>");MODULE_LICENSE("GPL");MODULE_IMPORT_NS("USB_STORAGE"); /* * Status bytes */#define ALAUDA_STATUS_ERROR		0x01#define ALAUDA_STATUS_READY		0x40 /* * Control opcodes (for request field) */#define ALAUDA_GET_XD_MEDIA_STATUS	0x08#define ALAUDA_GET_SM_MEDIA_STATUS	0x98#define ALAUDA_ACK_XD_MEDIA_CHANGE	0x0a#define ALAUDA_ACK_SM_MEDIA_CHANGE	0x9a#define ALAUDA_GET_XD_MEDIA_SIG		0x86#define ALAUDA_GET_SM_MEDIA_SIG		0x96 /* * Bulk command identity (byte 0) */#define ALAUDA_BULK_CMD			0x40 /* * Bulk opcodes (byte 1) */#define ALAUDA_BULK_GET_REDU_DATA	0x85#define ALAUDA_BULK_READ_BLOCK		0x94#define ALAUDA_BULK_ERASE_BLOCK		0xa3#define ALAUDA_BULK_WRITE_BLOCK		0xb4#define ALAUDA_BULK_GET_STATUS2		0xb7#define ALAUDA_BULK_RESET_MEDIA		0xe0 /* * Port to operate on (byte 8) */#define ALAUDA_PORT_XD			0x00#define ALAUDA_PORT_SM			0x01 /* * LBA and PBA are unsigned ints. Special values. */#define UNDEF    0xffff#define SPARE    0xfffe#define UNUSABLE 0xfffd struct alauda_media_info {	unsigned long capacity;		/* total media size in bytes */	unsigned int pagesize;		/* page size in bytes */	unsigned int blocksize;		/* number of pages per block */	unsigned int uzonesize;		/* number of usable blocks per zone */	unsigned int zonesize;		/* number of blocks per zone */	unsigned int blockmask;		/* mask to get page from address */ 	unsigned char pageshift;	unsigned char blockshift;	unsigned char zoneshift; 	u16 **lba_to_pba;		/* logical to physical block map */	u16 **pba_to_lba;		/* physical to logical block map */}; struct alauda_info {	struct alauda_media_info port[2];	int wr_ep;			/* endpoint to write data out of */ 	unsigned char sense_key;	unsigned long sense_asc;	/* additional sense code */	unsigned long sense_ascq;	/* additional sense code qualifier */ 	bool media_initialized;}; #define short_pack(lsb,msb) ( ((u16)(lsb)) | ( ((u16)(msb))<<8 ) )#define LSB_of(s) ((s)&0xFF)#define MSB_of(s) ((s)>>8) #define MEDIA_PORT(us) us->srb->device->lun#define MEDIA_INFO(us) ((struct alauda_info *)us->extra)->port[MEDIA_PORT(us)] #define PBA_LO(pba) ((pba & 0xF) << 5)#define PBA_HI(pba) (pba >> 3)#define PBA_ZONE(pba) (pba >> 11) static int init_alauda(struct us_data *us);  /* * The table of devices */#define UNUSUAL_DEV(id_vendor, id_product, bcdDeviceMin, bcdDeviceMax, \		    vendorName, productName, useProtocol, useTransport, \		    initFunction, flags) \{ USB_DEVICE_VER(id_vendor, id_product, bcdDeviceMin, bcdDeviceMax), \  .driver_info = (flags) } static const struct usb_device_id alauda_usb_ids[] = {#	include "unusual_alauda.h"	{ }		/* Terminating entry */};MODULE_DEVICE_TABLE(usb, alauda_usb_ids); #undef UNUSUAL_DEV /* * The flags table */#define UNUSUAL_DEV(idVendor, idProduct, bcdDeviceMin, bcdDeviceMax, \		    vendor_name, product_name, use_protocol, use_transport, \		    init_function, Flags) \{ \	.vendorName = vendor_name,	\	.productName = product_name,	\	.useProtocol = use_protocol,	\	.useTransport = use_transport,	\	.initFunction = init_function,	\} static const struct us_unusual_dev alauda_unusual_dev_list[] = {#	include "unusual_alauda.h"	{ }		/* Terminating entry */}; #undef UNUSUAL_DEV  /* * Media handling */ struct alauda_card_info {	unsigned char id;		/* id byte */	unsigned char chipshift;	/* 1<<cs bytes total capacity */	unsigned char pageshift;	/* 1<<ps bytes in a page */	unsigned char blockshift;	/* 1<<bs pages per block */	unsigned char zoneshift;	/* 1<<zs blocks per zone */}; static const struct alauda_card_info alauda_card_ids[] = {	/* NAND flash */	{ 0x6e, 20, 8, 4, 8},	/* 1 MB */	{ 0xe8, 20, 8, 4, 8},	/* 1 MB */	{ 0xec, 20, 8, 4, 8},	/* 1 MB */	{ 0x64, 21, 8, 4, 9}, 	/* 2 MB */	{ 0xea, 21, 8, 4, 9},	/* 2 MB */	{ 0x6b, 22, 9, 4, 9},	/* 4 MB */	{ 0xe3, 22, 9, 4, 9},	/* 4 MB */	{ 0xe5, 22, 9, 4, 9},	/* 4 MB */	{ 0xe6, 23, 9, 4, 10},	/* 8 MB */	{ 0x73, 24, 9, 5, 10},	/* 16 MB */	{ 0x75, 25, 9, 5, 10},	/* 32 MB */	{ 0x76, 26, 9, 5, 10},	/* 64 MB */	{ 0x79, 27, 9, 5, 10},	/* 128 MB */	{ 0x71, 28, 9, 5, 10},	/* 256 MB */ 	/* MASK ROM */	{ 0x5d, 21, 9, 4, 8},	/* 2 MB */	{ 0xd5, 22, 9, 4, 9},	/* 4 MB */	{ 0xd6, 23, 9, 4, 10},	/* 8 MB */	{ 0x57, 24, 9, 4, 11},	/* 16 MB */	{ 0x58, 25, 9, 4, 12},	/* 32 MB */	{ 0,}}; static const struct alauda_card_info *alauda_card_find_id(unsigned char id){	int i; 	for (i = 0; alauda_card_ids[i].id != 0; i++)		if (alauda_card_ids[i].id == id)			return &(alauda_card_ids[i]);	return NULL;} /* * ECC computation. */ static unsigned char parity[256];static unsigned char ecc2[256]; static void nand_init_ecc(void){	int i, j, a; 	parity[0] = 0;	for (i = 1; i < 256; i++)		parity[i] = (parity[i&(i-1)] ^ 1); 	for (i = 0; i < 256; i++) {		a = 0;		for (j = 0; j < 8; j++) {			if (i & (1<<j)) {				if ((j & 1) == 0)					a ^= 0x04;				if ((j & 2) == 0)					a ^= 0x10;				if ((j & 4) == 0)					a ^= 0x40;			}		}		ecc2[i] = ~(a ^ (a<<1) ^ (parity[i] ? 0xa8 : 0));	}} /* compute 3-byte ecc on 256 bytes */static void nand_compute_ecc(unsigned char *data, unsigned char *ecc){	int i, j, a;	unsigned char par = 0, bit, bits[8] = {0}; 	/* collect 16 checksum bits */	for (i = 0; i < 256; i++) {		par ^= data[i];		bit = parity[data[i]];		for (j = 0; j < 8; j++)			if ((i & (1<<j)) == 0)				bits[j] ^= bit;	} 	/* put 4+4+4 = 12 bits in the ecc */	a = (bits[3] << 6) + (bits[2] << 4) + (bits[1] << 2) + bits[0];	ecc[0] = ~(a ^ (a<<1) ^ (parity[par] ? 0xaa : 0)); 	a = (bits[7] << 6) + (bits[6] << 4) + (bits[5] << 2) + bits[4];	ecc[1] = ~(a ^ (a<<1) ^ (parity[par] ? 0xaa : 0)); 	ecc[2] = ecc2[par];} static int nand_compare_ecc(unsigned char *data, unsigned char *ecc){	return (data[0] == ecc[0] && data[1] == ecc[1] && data[2] == ecc[2]);} static void nand_store_ecc(unsigned char *data, unsigned char *ecc){	memcpy(data, ecc, 3);} /* * Alauda driver */ /* * Forget our PBA <---> LBA mappings for a particular port */static void alauda_free_maps (struct alauda_media_info *media_info){	unsigned int shift = media_info->zoneshift		+ media_info->blockshift + media_info->pageshift;	unsigned int num_zones = media_info->capacity >> shift;	unsigned int i; 	if (media_info->lba_to_pba != NULL)		for (i = 0; i < num_zones; i++) {			kfree(media_info->lba_to_pba[i]);			media_info->lba_to_pba[i] = NULL;		} 	if (media_info->pba_to_lba != NULL)		for (i = 0; i < num_zones; i++) {			kfree(media_info->pba_to_lba[i]);			media_info->pba_to_lba[i] = NULL;		}} /* * Returns 2 bytes of status data * The first byte describes media status, and second byte describes door status */static int alauda_get_media_status(struct us_data *us, unsigned char *data){	int rc;	unsigned char command; 	if (MEDIA_PORT(us) == ALAUDA_PORT_XD)		command = ALAUDA_GET_XD_MEDIA_STATUS;	else		command = ALAUDA_GET_SM_MEDIA_STATUS; 	rc = usb_stor_ctrl_transfer(us, us->recv_ctrl_pipe,		command, 0xc0, 0, 1, data, 2); 	if (rc == USB_STOR_XFER_GOOD)		usb_stor_dbg(us, "Media status %02X %02X\n", data[0], data[1]); 	return rc;} /* * Clears the "media was changed" bit so that we know when it changes again * in the future. */static int alauda_ack_media(struct us_data *us){	unsigned char command; 	if (MEDIA_PORT(us) == ALAUDA_PORT_XD)		command = ALAUDA_ACK_XD_MEDIA_CHANGE;	else		command = ALAUDA_ACK_SM_MEDIA_CHANGE; 	return usb_stor_ctrl_transfer(us, us->send_ctrl_pipe,		command, 0x40, 0, 1, NULL, 0);} /* * Retrieves a 4-byte media signature, which indicates manufacturer, capacity, * and some other details. */static int alauda_get_media_signature(struct us_data *us, unsigned char *data){	unsigned char command; 	if (MEDIA_PORT(us) == ALAUDA_PORT_XD)		command = ALAUDA_GET_XD_MEDIA_SIG;	else		command = ALAUDA_GET_SM_MEDIA_SIG; 	return usb_stor_ctrl_transfer(us, us->recv_ctrl_pipe,		command, 0xc0, 0, 0, data, 4);} /* * Resets the media status (but not the whole device?) */static int alauda_reset_media(struct us_data *us){	unsigned char *command = us->iobuf; 	memset(command, 0, 9);	command[0] = ALAUDA_BULK_CMD;	command[1] = ALAUDA_BULK_RESET_MEDIA;	command[8] = MEDIA_PORT(us); 	return usb_stor_bulk_transfer_buf(us, us->send_bulk_pipe,		command, 9, NULL);} /* * Examines the media and deduces capacity, etc. */static int alauda_init_media(struct us_data *us){	unsigned char *data = us->iobuf;	int ready = 0;	const struct alauda_card_info *media_info;	unsigned int num_zones; 	while (ready == 0) {		msleep(20); 		if (alauda_get_media_status(us, data) != USB_STOR_XFER_GOOD)			return USB_STOR_TRANSPORT_ERROR; 		if (data[0] & 0x10)			ready = 1;	} 	usb_stor_dbg(us, "We are ready for action!\n"); 	if (alauda_ack_media(us) != USB_STOR_XFER_GOOD)		return USB_STOR_TRANSPORT_ERROR; 	msleep(10); 	if (alauda_get_media_status(us, data) != USB_STOR_XFER_GOOD)		return USB_STOR_TRANSPORT_ERROR; 	if (data[0] != 0x14) {		usb_stor_dbg(us, "Media not ready after ack\n");		return USB_STOR_TRANSPORT_ERROR;	} 	if (alauda_get_media_signature(us, data) != USB_STOR_XFER_GOOD)		return USB_STOR_TRANSPORT_ERROR; 	usb_stor_dbg(us, "Media signature: %4ph\n", data);	media_info = alauda_card_find_id(data[1]);	if (media_info == NULL) {		pr_warn("alauda_init_media: Unrecognised media signature: %4ph\n",			data);		return USB_STOR_TRANSPORT_ERROR;	} 	MEDIA_INFO(us).capacity = 1 << media_info->chipshift;	usb_stor_dbg(us, "Found media with capacity: %ldMB\n",		     MEDIA_INFO(us).capacity >> 20); 	MEDIA_INFO(us).pageshift = media_info->pageshift;	MEDIA_INFO(us).blockshift = media_info->blockshift;	MEDIA_INFO(us).zoneshift = media_info->zoneshift; 	MEDIA_INFO(us).pagesize = 1 << media_info->pageshift;	MEDIA_INFO(us).blocksize = 1 << media_info->blockshift;	MEDIA_INFO(us).zonesize = 1 << media_info->zoneshift; 	MEDIA_INFO(us).uzonesize = ((1 << media_info->zoneshift) / 128) * 125;	MEDIA_INFO(us).blockmask = MEDIA_INFO(us).blocksize - 1; 	num_zones = MEDIA_INFO(us).capacity >> (MEDIA_INFO(us).zoneshift		+ MEDIA_INFO(us).blockshift + MEDIA_INFO(us).pageshift);	MEDIA_INFO(us).pba_to_lba = kcalloc(num_zones, sizeof(u16*), GFP_NOIO);	MEDIA_INFO(us).lba_to_pba = kcalloc(num_zones, sizeof(u16*), GFP_NOIO);	if (MEDIA_INFO(us).pba_to_lba == NULL || MEDIA_INFO(us).lba_to_pba == NULL)		return USB_STOR_TRANSPORT_ERROR; 	if (alauda_reset_media(us) != USB_STOR_XFER_GOOD)		return USB_STOR_TRANSPORT_ERROR; 	return USB_STOR_TRANSPORT_GOOD;} /* * Examines the media status and does the right thing when the media has gone, * appeared, or changed. */static int alauda_check_media(struct us_data *us){	struct alauda_info *info = (struct alauda_info *) us->extra;	unsigned char *status = us->iobuf;	int rc; 	rc = alauda_get_media_status(us, status);	if (rc != USB_STOR_XFER_GOOD) {		status[0] = 0xF0;	/* Pretend there's no media */		status[1] = 0;	} 	/* Check for no media or door open */	if ((status[0] & 0x80) || ((status[0] & 0x1F) == 0x10)		|| ((status[1] & 0x01) == 0)) {		usb_stor_dbg(us, "No media, or door open\n");		alauda_free_maps(&MEDIA_INFO(us));		info->sense_key = 0x02;		info->sense_asc = 0x3A;		info->sense_ascq = 0x00;		return USB_STOR_TRANSPORT_FAILED;	} 	/* Check for media change */	if (status[0] & 0x08 || !info->media_initialized) {		usb_stor_dbg(us, "Media change detected\n");		alauda_free_maps(&MEDIA_INFO(us));		rc = alauda_init_media(us);		if (rc == USB_STOR_TRANSPORT_GOOD)			info->media_initialized = true;		info->sense_key = UNIT_ATTENTION;		info->sense_asc = 0x28;		info->sense_ascq = 0x00;		return USB_STOR_TRANSPORT_FAILED;	} 	return USB_STOR_TRANSPORT_GOOD;} /* * Checks the status from the 2nd status register * Returns 3 bytes of status data, only the first is known */static int alauda_check_status2(struct us_data *us)

Lines 1–500 of 1274.