1/* Driver for Freecom USB/IDE adaptor 2 * 3 * Freecom v0.1: 4 * 5 * First release 6 * 7 * Current development and maintenance by: 8 * (C) 2000 David Brown <usb-storage@davidb.org> 9 * 10 * This program is free software; you can redistribute it and/or modify it 11 * under the terms of the GNU General Public License as published by the 12 * Free Software Foundation; either version 2, or (at your option) any 13 * later version. 14 * 15 * This program is distributed in the hope that it will be useful, but 16 * WITHOUT ANY WARRANTY; without even the implied warranty of 17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 18 * General Public License for more details. 19 * 20 * You should have received a copy of the GNU General Public License along 21 * with this program; if not, write to the Free Software Foundation, Inc., 22 * 675 Mass Ave, Cambridge, MA 02139, USA. 23 * 24 * This driver was developed with information provided in FREECOM's USB 25 * Programmers Reference Guide. For further information contact Freecom 26 * (http://www.freecom.de/) 27 */ 28 29#include <linux/module.h> 30#include <scsi/scsi.h> 31#include <scsi/scsi_cmnd.h> 32 33#include "usb.h" 34#include "transport.h" 35#include "protocol.h" 36#include "debug.h" 37 38MODULE_DESCRIPTION("Driver for Freecom USB/IDE adaptor"); 39MODULE_AUTHOR("David Brown <usb-storage@davidb.org>"); 40MODULE_LICENSE("GPL"); 41 42#ifdef CONFIG_USB_STORAGE_DEBUG 43static void pdump (void *, int); 44#endif 45 46/* Bits of HD_STATUS */ 47#define ERR_STAT 0x01 48#define DRQ_STAT 0x08 49 50/* All of the outgoing packets are 64 bytes long. */ 51struct freecom_cb_wrap { 52 u8 Type; /* Command type. */ 53 u8 Timeout; /* Timeout in seconds. */ 54 u8 Atapi[12]; /* An ATAPI packet. */ 55 u8 Filler[50]; /* Padding Data. */ 56}; 57 58struct freecom_xfer_wrap { 59 u8 Type; /* Command type. */ 60 u8 Timeout; /* Timeout in seconds. */ 61 __le32 Count; /* Number of bytes to transfer. */ 62 u8 Pad[58]; 63} __attribute__ ((packed)); 64 65struct freecom_ide_out { 66 u8 Type; /* Type + IDE register. */ 67 u8 Pad; 68 __le16 Value; /* Value to write. */ 69 u8 Pad2[60]; 70}; 71 72struct freecom_ide_in { 73 u8 Type; /* Type | IDE register. */ 74 u8 Pad[63]; 75}; 76 77struct freecom_status { 78 u8 Status; 79 u8 Reason; 80 __le16 Count; 81 u8 Pad[60]; 82}; 83 84/* Freecom stuffs the interrupt status in the INDEX_STAT bit of the ide 85 * register. */ 86#define FCM_INT_STATUS 0x02 /* INDEX_STAT */ 87#define FCM_STATUS_BUSY 0x80 88 89/* These are the packet types. The low bit indicates that this command 90 * should wait for an interrupt. */ 91#define FCM_PACKET_ATAPI 0x21 92#define FCM_PACKET_STATUS 0x20 93 94/* Receive data from the IDE interface. The ATAPI packet has already 95 * waited, so the data should be immediately available. */ 96#define FCM_PACKET_INPUT 0x81 97 98/* Send data to the IDE interface. */ 99#define FCM_PACKET_OUTPUT 0x01 100 101/* Write a value to an ide register. Or the ide register to write after 102 * munging the address a bit. */ 103#define FCM_PACKET_IDE_WRITE 0x40 104#define FCM_PACKET_IDE_READ 0xC0 105 106/* All packets (except for status) are 64 bytes long. */ 107#define FCM_PACKET_LENGTH 64 108#define FCM_STATUS_PACKET_LENGTH 4 109 110static int init_freecom(struct us_data *us); 111 112 113/* 114 * The table of devices 115 */ 116#define UNUSUAL_DEV(id_vendor, id_product, bcdDeviceMin, bcdDeviceMax, \ 117 vendorName, productName, useProtocol, useTransport, \ 118 initFunction, flags) \ 119{ USB_DEVICE_VER(id_vendor, id_product, bcdDeviceMin, bcdDeviceMax), \ 120 .driver_info = (flags)|(USB_US_TYPE_STOR<<24) } 121 122struct usb_device_id freecom_usb_ids[] = { 123# include "unusual_freecom.h" 124 { } /* Terminating entry */ 125}; 126MODULE_DEVICE_TABLE(usb, freecom_usb_ids); 127 128#undef UNUSUAL_DEV 129 130/* 131 * The flags table 132 */ 133#define UNUSUAL_DEV(idVendor, idProduct, bcdDeviceMin, bcdDeviceMax, \ 134 vendor_name, product_name, use_protocol, use_transport, \ 135 init_function, Flags) \ 136{ \ 137 .vendorName = vendor_name, \ 138 .productName = product_name, \ 139 .useProtocol = use_protocol, \ 140 .useTransport = use_transport, \ 141 .initFunction = init_function, \ 142} 143 144static struct us_unusual_dev freecom_unusual_dev_list[] = { 145# include "unusual_freecom.h" 146 { } /* Terminating entry */ 147}; 148 149#undef UNUSUAL_DEV 150 151static int 152freecom_readdata (struct scsi_cmnd *srb, struct us_data *us, 153 unsigned int ipipe, unsigned int opipe, int count) 154{ 155 struct freecom_xfer_wrap *fxfr = 156 (struct freecom_xfer_wrap *) us->iobuf; 157 int result; 158 159 fxfr->Type = FCM_PACKET_INPUT | 0x00; 160 fxfr->Timeout = 0; /* Short timeout for debugging. */ 161 fxfr->Count = cpu_to_le32 (count); 162 memset (fxfr->Pad, 0, sizeof (fxfr->Pad)); 163 164 US_DEBUGP("Read data Freecom! (c=%d)\n", count); 165 166 /* Issue the transfer command. */ 167 result = usb_stor_bulk_transfer_buf (us, opipe, fxfr, 168 FCM_PACKET_LENGTH, NULL); 169 if (result != USB_STOR_XFER_GOOD) { 170 US_DEBUGP ("Freecom readdata transport error\n"); 171 return USB_STOR_TRANSPORT_ERROR; 172 } 173 174 /* Now transfer all of our blocks. */ 175 US_DEBUGP("Start of read\n"); 176 result = usb_stor_bulk_srb(us, ipipe, srb); 177 US_DEBUGP("freecom_readdata done!\n"); 178 179 if (result > USB_STOR_XFER_SHORT) 180 return USB_STOR_TRANSPORT_ERROR; 181 return USB_STOR_TRANSPORT_GOOD; 182} 183 184static int 185freecom_writedata (struct scsi_cmnd *srb, struct us_data *us, 186 int unsigned ipipe, unsigned int opipe, int count) 187{ 188 struct freecom_xfer_wrap *fxfr = 189 (struct freecom_xfer_wrap *) us->iobuf; 190 int result; 191 192 fxfr->Type = FCM_PACKET_OUTPUT | 0x00; 193 fxfr->Timeout = 0; /* Short timeout for debugging. */ 194 fxfr->Count = cpu_to_le32 (count); 195 memset (fxfr->Pad, 0, sizeof (fxfr->Pad)); 196 197 US_DEBUGP("Write data Freecom! (c=%d)\n", count); 198 199 /* Issue the transfer command. */ 200 result = usb_stor_bulk_transfer_buf (us, opipe, fxfr, 201 FCM_PACKET_LENGTH, NULL); 202 if (result != USB_STOR_XFER_GOOD) { 203 US_DEBUGP ("Freecom writedata transport error\n"); 204 return USB_STOR_TRANSPORT_ERROR; 205 } 206 207 /* Now transfer all of our blocks. */ 208 US_DEBUGP("Start of write\n"); 209 result = usb_stor_bulk_srb(us, opipe, srb); 210 211 US_DEBUGP("freecom_writedata done!\n"); 212 if (result > USB_STOR_XFER_SHORT) 213 return USB_STOR_TRANSPORT_ERROR; 214 return USB_STOR_TRANSPORT_GOOD; 215} 216 217/* 218 * Transport for the Freecom USB/IDE adaptor. 219 * 220 */ 221static int freecom_transport(struct scsi_cmnd *srb, struct us_data *us) 222{ 223 struct freecom_cb_wrap *fcb; 224 struct freecom_status *fst; 225 unsigned int ipipe, opipe; /* We need both pipes. */ 226 int result; 227 unsigned int partial; 228 int length; 229 230 fcb = (struct freecom_cb_wrap *) us->iobuf; 231 fst = (struct freecom_status *) us->iobuf; 232 233 US_DEBUGP("Freecom TRANSPORT STARTED\n"); 234 235 /* Get handles for both transports. */ 236 opipe = us->send_bulk_pipe; 237 ipipe = us->recv_bulk_pipe; 238 239 /* The ATAPI Command always goes out first. */ 240 fcb->Type = FCM_PACKET_ATAPI | 0x00; 241 fcb->Timeout = 0; 242 memcpy (fcb->Atapi, srb->cmnd, 12); 243 memset (fcb->Filler, 0, sizeof (fcb->Filler)); 244 245 US_DEBUG(pdump (srb->cmnd, 12)); 246 247 /* Send it out. */ 248 result = usb_stor_bulk_transfer_buf (us, opipe, fcb, 249 FCM_PACKET_LENGTH, NULL); 250 251 /* The Freecom device will only fail if there is something wrong in 252 * USB land. It returns the status in its own registers, which 253 * come back in the bulk pipe. */ 254 if (result != USB_STOR_XFER_GOOD) { 255 US_DEBUGP ("freecom transport error\n"); 256 return USB_STOR_TRANSPORT_ERROR; 257 } 258 259 /* There are times we can optimize out this status read, but it 260 * doesn't hurt us to always do it now. */ 261 result = usb_stor_bulk_transfer_buf (us, ipipe, fst, 262 FCM_STATUS_PACKET_LENGTH, &partial); 263 US_DEBUGP("foo Status result %d %u\n", result, partial); 264 if (result != USB_STOR_XFER_GOOD) 265 return USB_STOR_TRANSPORT_ERROR; 266 267 US_DEBUG(pdump ((void *) fst, partial)); 268 269 /* The firmware will time-out commands after 20 seconds. Some commands 270 * can legitimately take longer than this, so we use a different 271 * command that only waits for the interrupt and then sends status, 272 * without having to send a new ATAPI command to the device. 273 * 274 * NOTE: There is some indication that a data transfer after a timeout 275 * may not work, but that is a condition that should never happen. 276 */ 277 while (fst->Status & FCM_STATUS_BUSY) { 278 US_DEBUGP("20 second USB/ATAPI bridge TIMEOUT occurred!\n"); 279 US_DEBUGP("fst->Status is %x\n", fst->Status); 280 281 /* Get the status again */ 282 fcb->Type = FCM_PACKET_STATUS; 283 fcb->Timeout = 0; 284 memset (fcb->Atapi, 0, sizeof(fcb->Atapi)); 285 memset (fcb->Filler, 0, sizeof (fcb->Filler)); 286 287 /* Send it out. */ 288 result = usb_stor_bulk_transfer_buf (us, opipe, fcb, 289 FCM_PACKET_LENGTH, NULL); 290 291 /* The Freecom device will only fail if there is something 292 * wrong in USB land. It returns the status in its own 293 * registers, which come back in the bulk pipe. 294 */ 295 if (result != USB_STOR_XFER_GOOD) { 296 US_DEBUGP ("freecom transport error\n"); 297 return USB_STOR_TRANSPORT_ERROR; 298 } 299 300 /* get the data */ 301 result = usb_stor_bulk_transfer_buf (us, ipipe, fst, 302 FCM_STATUS_PACKET_LENGTH, &partial); 303 304 US_DEBUGP("bar Status result %d %u\n", result, partial); 305 if (result != USB_STOR_XFER_GOOD) 306 return USB_STOR_TRANSPORT_ERROR; 307 308 US_DEBUG(pdump ((void *) fst, partial)); 309 } 310 311 if (partial != 4) 312 return USB_STOR_TRANSPORT_ERROR; 313 if ((fst->Status & 1) != 0) { 314 US_DEBUGP("operation failed\n"); 315 return USB_STOR_TRANSPORT_FAILED; 316 } 317 318 /* The device might not have as much data available as we 319 * requested. If you ask for more than the device has, this reads 320 * and such will hang. */ 321 US_DEBUGP("Device indicates that it has %d bytes available\n", 322 le16_to_cpu (fst->Count)); 323 US_DEBUGP("SCSI requested %d\n", scsi_bufflen(srb)); 324 325 /* Find the length we desire to read. */ 326 switch (srb->cmnd[0]) { 327 case INQUIRY: 328 case REQUEST_SENSE: /* 16 or 18 bytes? spec says 18, lots of devices only have 16 */ 329 case MODE_SENSE: 330 case MODE_SENSE_10: 331 length = le16_to_cpu(fst->Count); 332 break; 333 default: 334 length = scsi_bufflen(srb); 335 } 336 337 /* verify that this amount is legal */ 338 if (length > scsi_bufflen(srb)) { 339 length = scsi_bufflen(srb); 340 US_DEBUGP("Truncating request to match buffer length: %d\n", length); 341 } 342 343 /* What we do now depends on what direction the data is supposed to 344 * move in. */ 345 346 switch (us->srb->sc_data_direction) { 347 case DMA_FROM_DEVICE: 348 /* catch bogus "read 0 length" case */ 349 if (!length) 350 break; 351 /* Make sure that the status indicates that the device 352 * wants data as well. */ 353 if ((fst->Status & DRQ_STAT) == 0 || (fst->Reason & 3) != 2) { 354 US_DEBUGP("SCSI wants data, drive doesn't have any\n"); 355 return USB_STOR_TRANSPORT_FAILED; 356 } 357 result = freecom_readdata (srb, us, ipipe, opipe, length); 358 if (result != USB_STOR_TRANSPORT_GOOD) 359 return result; 360 361 US_DEBUGP("FCM: Waiting for status\n"); 362 result = usb_stor_bulk_transfer_buf (us, ipipe, fst, 363 FCM_PACKET_LENGTH, &partial); 364 US_DEBUG(pdump ((void *) fst, partial)); 365 366 if (partial != 4 || result > USB_STOR_XFER_SHORT) 367 return USB_STOR_TRANSPORT_ERROR; 368 if ((fst->Status & ERR_STAT) != 0) { 369 US_DEBUGP("operation failed\n"); 370 return USB_STOR_TRANSPORT_FAILED; 371 } 372 if ((fst->Reason & 3) != 3) { 373 US_DEBUGP("Drive seems still hungry\n"); 374 return USB_STOR_TRANSPORT_FAILED; 375 } 376 US_DEBUGP("Transfer happy\n"); 377 break; 378 379 case DMA_TO_DEVICE: 380 /* catch bogus "write 0 length" case */ 381 if (!length) 382 break; 383 /* Make sure the status indicates that the device wants to 384 * send us data. */ 385 /* !!IMPLEMENT!! */ 386 result = freecom_writedata (srb, us, ipipe, opipe, length); 387 if (result != USB_STOR_TRANSPORT_GOOD) 388 return result; 389 390 US_DEBUGP("FCM: Waiting for status\n"); 391 result = usb_stor_bulk_transfer_buf (us, ipipe, fst, 392 FCM_PACKET_LENGTH, &partial); 393 394 if (partial != 4 || result > USB_STOR_XFER_SHORT) 395 return USB_STOR_TRANSPORT_ERROR; 396 if ((fst->Status & ERR_STAT) != 0) { 397 US_DEBUGP("operation failed\n"); 398 return USB_STOR_TRANSPORT_FAILED; 399 } 400 if ((fst->Reason & 3) != 3) { 401 US_DEBUGP("Drive seems still hungry\n"); 402 return USB_STOR_TRANSPORT_FAILED; 403 } 404 405 US_DEBUGP("Transfer happy\n"); 406 break; 407 408 409 case DMA_NONE: 410 /* Easy, do nothing. */ 411 break; 412 413 default: 414 /* should never hit here -- filtered in usb.c */ 415 US_DEBUGP ("freecom unimplemented direction: %d\n", 416 us->srb->sc_data_direction); 417 /* Return fail, SCSI seems to handle this better. */ 418 return USB_STOR_TRANSPORT_FAILED; 419 break; 420 } 421 422 return USB_STOR_TRANSPORT_GOOD; 423} 424 425static int init_freecom(struct us_data *us) 426{ 427 int result; 428 char *buffer = us->iobuf; 429 430 /* The DMA-mapped I/O buffer is 64 bytes long, just right for 431 * all our packets. No need to allocate any extra buffer space. 432 */ 433 434 result = usb_stor_control_msg(us, us->recv_ctrl_pipe, 435 0x4c, 0xc0, 0x4346, 0x0, buffer, 0x20, 3*HZ); 436 buffer[32] = '\0'; 437 US_DEBUGP("String returned from FC init is: %s\n", buffer); 438 439 /* Special thanks to the people at Freecom for providing me with 440 * this "magic sequence", which they use in their Windows and MacOS 441 * drivers to make sure that all the attached perhiperals are 442 * properly reset. 443 */ 444 445 /* send reset */ 446 result = usb_stor_control_msg(us, us->send_ctrl_pipe, 447 0x4d, 0x40, 0x24d8, 0x0, NULL, 0x0, 3*HZ); 448 US_DEBUGP("result from activate reset is %d\n", result); 449 450 /* wait 250ms */ 451 mdelay(250); 452 453 /* clear reset */ 454 result = usb_stor_control_msg(us, us->send_ctrl_pipe, 455 0x4d, 0x40, 0x24f8, 0x0, NULL, 0x0, 3*HZ); 456 US_DEBUGP("result from clear reset is %d\n", result); 457 458 /* wait 3 seconds */ 459 mdelay(3 * 1000); 460 461 return USB_STOR_TRANSPORT_GOOD; 462} 463 464static int usb_stor_freecom_reset(struct us_data *us) 465{ 466 printk (KERN_CRIT "freecom reset called\n"); 467 468 /* We don't really have this feature. */ 469 return FAILED; 470} 471 472#ifdef CONFIG_USB_STORAGE_DEBUG 473static void pdump (void *ibuffer, int length) 474{ 475 static char line[80]; 476 int offset = 0; 477 unsigned char *buffer = (unsigned char *) ibuffer; 478 int i, j; 479 int from, base; 480 481 offset = 0; 482 for (i = 0; i < length; i++) { 483 if ((i & 15) == 0) { 484 if (i > 0) { 485 offset += sprintf (line+offset, " - "); 486 for (j = i - 16; j < i; j++) { 487 if (buffer[j] >= 32 && buffer[j] <= 126) 488 line[offset++] = buffer[j]; 489 else 490 line[offset++] = '.'; 491 } 492 line[offset] = 0; 493 US_DEBUGP("%s\n", line); 494 offset = 0; 495 } 496 offset += sprintf (line+offset, "%08x:", i); 497 } else if ((i & 7) == 0) { 498 offset += sprintf (line+offset, " -"); 499 } 500 offset += sprintf (line+offset, " %02x", buffer[i] & 0xff); 501 } 502 503 /* Add the last "chunk" of data. */ 504 from = (length - 1) % 16; 505 base = ((length - 1) / 16) * 16; 506 507 for (i = from + 1; i < 16; i++) 508 offset += sprintf (line+offset, " "); 509 if (from < 8) 510 offset += sprintf (line+offset, " "); 511 offset += sprintf (line+offset, " - "); 512 513 for (i = 0; i <= from; i++) { 514 if (buffer[base+i] >= 32 && buffer[base+i] <= 126) 515 line[offset++] = buffer[base+i]; 516 else 517 line[offset++] = '.'; 518 } 519 line[offset] = 0; 520 US_DEBUGP("%s\n", line); 521 offset = 0; 522} 523#endif 524 525static int freecom_probe(struct usb_interface *intf, 526 const struct usb_device_id *id) 527{ 528 struct us_data *us; 529 int result; 530 531 result = usb_stor_probe1(&us, intf, id, 532 (id - freecom_usb_ids) + freecom_unusual_dev_list); 533 if (result) 534 return result; 535 536 us->transport_name = "Freecom"; 537 us->transport = freecom_transport; 538 us->transport_reset = usb_stor_freecom_reset; 539 us->max_lun = 0; 540 541 result = usb_stor_probe2(us); 542 return result; 543} 544 545static struct usb_driver freecom_driver = { 546 .name = "ums-freecom", 547 .probe = freecom_probe, 548 .disconnect = usb_stor_disconnect, 549 .suspend = usb_stor_suspend, 550 .resume = usb_stor_resume, 551 .reset_resume = usb_stor_reset_resume, 552 .pre_reset = usb_stor_pre_reset, 553 .post_reset = usb_stor_post_reset, 554 .id_table = freecom_usb_ids, 555 .soft_unbind = 1, 556}; 557 558static int __init freecom_init(void) 559{ 560 return usb_register(&freecom_driver); 561} 562 563static void __exit freecom_exit(void) 564{ 565 usb_deregister(&freecom_driver); 566} 567 568module_init(freecom_init); 569module_exit(freecom_exit); 570