5 // Created by Nathan Oates on Sun Aug 01 2004.
6 // Copyright (c) 2004-7 Nathan Oates nathan@noates.com All rights reserved.
9 /* This file was modified by Kalle Olavi Niemitalo on 2007-10-18. */
11 // includes code based on uproar, license noted below:
13 // Copyright (c) 2001 Kasima Tharnpipitchai <me@kasima.org>
17 * This source code is free software; you can redistribute it and/or
18 * modify it under the terms of the GNU Public License as published
19 * by the Free Software Foundation; either version 2 of the License,
20 * or (at your option) any later version.
22 * This source code is distributed in the hope that it will be useful,
23 * but WITHOUT ANY WARRANTY; without even the implied warranty of
24 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
25 * Please refer to the GNU Public License for more details.
27 * You should have received a copy of the GNU Public License along with
28 * this source code; if not, write to:
29 * Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
32 /* Much of the code that initializes and closes the device is from Apple
33 * and is released under the license below.
37 * © Copyright 2001 Apple Computer, Inc. All rights reserved.
39 * IMPORTANT: This Apple software is supplied to you by Apple Computer, Inc. (“Apple”) in
40 * consideration of your agreement to the following terms, and your use, installation,
41 * modification or redistribution of this Apple software constitutes acceptance of these
42 * terms. If you do not agree with these terms, please do not use, install, modify or
43 * redistribute this Apple software.
45 * In consideration of your agreement to abide by the following terms, and subject to these
46 * terms, Apple grants you a personal, non exclusive license, under Apple’s copyrights in this
47 * original Apple software (the “Apple Software”), to use, reproduce, modify and redistribute
48 * the Apple Software, with or without modifications, in source and/or binary forms; provided
49 * that if you redistribute the Apple Software in its entirety and without modifications, you
50 * must retain this notice and the following text and disclaimers in all such redistributions
51 * of the Apple Software. Neither the name, trademarks, service marks or logos of Apple
52 * Computer, Inc. may be used to endorse or promote products derived from the Apple Software
53 * without specific prior written permission from Apple. Except as expressly stated in this
54 * notice, no other rights or licenses, express or implied, are granted by Apple herein,
55 * including but not limited to any patent rights that may be infringed by your derivative
56 * works or by other works in which the Apple Software may be incorporated.
58 * The Apple Software is provided by Apple on an "AS IS" basis. APPLE MAKES NO WARRANTIES,
59 * EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION THE IMPLIED WARRANTIES OF NON-
60 * INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, REGARDING THE APPLE
61 * SOFTWARE OR ITS USE AND OPERATION ALONE OR IN COMBINATION WITH YOUR PRODUCTS.
63 * IN NO EVENT SHALL APPLE BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL OR CONSEQUENTIAL
64 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
65 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) ARISING IN ANY WAY OUT OF THE USE,
66 * REPRODUCTION, MODIFICATION AND/OR DISTRIBUTION OF THE APPLE SOFTWARE, HOWEVER CAUSED AND
67 * WHETHER UNDER THEORY OF CONTRACT, TORT (INCLUDING NEGLIGENCE), STRICT LIABILITY OR
68 * OTHERWISE, EVEN IF APPLE HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
76 #include <mach/mach.h>
77 #include <IOKit/IOCFPlugIn.h>
78 #include <CoreFoundation/CFNumber.h>
80 #import "DataHandler.h"
81 #import "TFUSBController.h"
82 #import "TFUSBControllerCommunicationBlock.h"
83 #import "UIElements.h"
85 static void hexDump(UInt8 *buf, int len);
86 static int doSend(IOUSBDeviceInterface197 **dev,
87 IOUSBInterfaceInterface197 **intf, UInt8 *outBuf, UInt32 len, int type);
88 static int doRecv(IOUSBDeviceInterface197 **dev,
89 IOUSBInterfaceInterface197 **intf, UInt8 *inBuf, UInt32 dataLen, int type);
90 static int dealWithInterface(io_service_t usbInterfaceRef,
91 USBDeviceContext *device);
92 static int dealWithDevice(io_service_t usbDeviceRef, USBDeviceContext *device);
93 static int initDevice(USBDeviceContext *device);
97 static int kBlockSize;
98 static int connectedSpeed;
100 @interface TFUSBController (PrivateMethods)
103 - (NSData*) sendCommand:(NSData*) fullyPackagedCommand
104 toDevice:(USBDeviceContext*)device expectResponse:(BOOL) getResponse
105 careForReturn:(BOOL) careFactor;
107 // Protocol message sequences
108 - (id) getFileListForPath:(NSString*)path;
109 - (void) turnTurboOn:(BOOL) turnOn;
110 - (void) renameFile:(NSString*) oldName withName:(NSString*)newName atPath:(NSString*)currentPath;
111 - (void) makeFolder:(NSString*)newName atPath:(NSString*)currentPath;
112 - (void) checkUSB:(USBDeviceContext*)device;
115 - (UIElements*) uiElements;
116 - (void) updateProgress:(NSDictionary*) inDict;
117 - (NSString*) elapsedTime:(NSTimeInterval) totalSeconds;
120 - (BOOL) hasPriorityTransfer;
121 - (NSDictionary*) nextTransferAndQueue:(NSMutableArray**)queue;
122 - (void) removeTransfer:(NSDictionary*)transfer fromQueue:(NSMutableArray*)queue;
126 #define TopfieldVendorID 4571
130 #define TF5kProdID 4096
135 // ---------------------------------------------------------------------------
136 // Functions outside TFUSBController
137 // ---------------------------------------------------------------------------
140 hexDump(UInt8 *buf, int len)
142 int row, col, maxrows;
145 if (len % 16) maxrows++;
146 for (row=0; row< maxrows; row++) {
147 for (col=0; col<16; col++) {
148 if (!(col%2)) printf(" ");
149 printf("%02x", buf[row*16 + col] & 0xff);
152 for (col=0; col<16; col++) {
153 if ((buf[row*16 + col]>32) && (buf[row*16 + col]<126)) {
154 printf("%c", buf[row*16 + col]);
156 else { printf("."); }
163 doSend(IOUSBDeviceInterface197 **dev, IOUSBInterfaceInterface197 **intf,
164 UInt8 *outBuf, UInt32 len, int type)
170 printf(("sending:\n"));
171 hexDump(outBuf, len);
173 sendLen = ((len/kBlockSize))*kBlockSize;
174 if (len % kBlockSize)
175 sendLen += kBlockSize;
176 if ((sendLen % 0x200) == 0)
177 sendLen += kBlockSize;
179 err = (*intf)->WritePipeTO(intf, 1, outBuf, sendLen, 1000, 20000);
181 printf("write err: %08x\n", err);
188 doRecv(IOUSBDeviceInterface197 **dev, IOUSBInterfaceInterface197 **intf,
189 UInt8 *inBuf, UInt32 dataLen, int type)
194 if (dataLen > kMaxXferSize) return 1;
196 len = (dataLen/kBlockSize) * kBlockSize;
197 if (dataLen % kBlockSize)
200 err = (*intf)->ReadPipeTO(intf, 2, (void *)inBuf, &len, 1000, 20000);
202 printf("read err 2: %08x\n", err);
203 printf("resetting\n");
204 err = (*intf)->ClearPipeStallBothEnds(intf, 2);
209 printf(("receiving: \n"));
216 dealWithInterface(io_service_t usbInterfaceRef, USBDeviceContext *device)
219 IOCFPlugInInterface **iodev; // requires <IOKit/IOCFPlugIn.h>
220 IOUSBInterfaceInterface197 **intf;
221 IOUSBDeviceInterface197 **dev;
223 UInt8 numPipes, confNum, dSpeed;
226 err = IOCreatePlugInInterfaceForService(usbInterfaceRef, kIOUSBInterfaceUserClientTypeID, kIOCFPlugInInterfaceID, &iodev, &score);
229 printf("dealWithInterface: unable to create plugin. ret = %08x, iodev = %p\n", err, iodev);
230 return kUproarDeviceErr;
232 err = (*iodev)->QueryInterface(iodev, CFUUIDGetUUIDBytes(kIOUSBInterfaceInterfaceID), (LPVOID)&(device->intf));
233 (*iodev)->Release(iodev); // done with this
237 printf("dealWithInterface: unable to create a device interface. ret = %08x, intf = %p\n", err, intf);
238 return kUproarDeviceErr;
242 err = (*intf)->USBInterfaceOpen(intf);
245 printf("dealWithInterface: unable to open interface. ret = %08x\n", err);
246 return kUproarDeviceErr;
248 err = (*intf)->GetNumEndpoints(intf, &numPipes);
251 printf("dealWithInterface: unable to get number of endpoints. ret = %08x\n", err);
252 return kUproarDeviceErr;
255 printf("dealWithInterface: found %d pipes\n", numPipes);
257 err = (*intf)->GetConfigurationValue(intf, &confNum);
258 err = (*dev)->GetDeviceSpeed(dev, &dSpeed);
264 printf("confnum: %08x, dspeed: %08x, blockS:%i\n", confNum, dSpeed, kBlockSize);
265 connectedSpeed = dSpeed;
266 return kUproarSuccess;
271 dealWithDevice(io_service_t usbDeviceRef, USBDeviceContext *device)
274 IOCFPlugInInterface **iodev; // requires <IOKit/IOCFPlugIn.h>
275 IOUSBDeviceInterface197 **dev;
278 IOUSBConfigurationDescriptorPtr confDesc;
279 IOUSBFindInterfaceRequest interfaceRequest;
280 io_iterator_t iterator;
281 io_service_t usbInterfaceRef;
285 err = IOCreatePlugInInterfaceForService(usbDeviceRef, kIOUSBDeviceUserClientTypeID, kIOCFPlugInInterfaceID, &iodev, &score);
288 printf("dealWithDevice: unable to create plugin. ret = %08x, iodev = %p\n", err, iodev);
289 return kUproarDeviceErr;
291 err = (*iodev)->QueryInterface(iodev, CFUUIDGetUUIDBytes(kIOUSBDeviceInterfaceID), (LPVOID)&(device->dev));
292 (*iodev)->Release(iodev);
297 printf("dealWithDevice: unable to create a device interface. ret = %08x, dev = %p\n", err, dev);
298 return kUproarDeviceErr;
300 err = (*dev)->USBDeviceOpen(dev);
303 printf("dealWithDevice: unable to open device. ret = %08x\n", err);
304 return kUproarDeviceErr;
306 err = (*dev)->GetNumberOfConfigurations(dev, &numConf);
309 printf("dealWithDevice: unable to obtain the number of configurations. ret = %08x\n", err);
310 return kUproarDeviceErr;
312 printf("dealWithDevice: found %d configurations\n", numConf);
313 err = (*dev)->GetConfigurationDescriptorPtr(dev, 0, &confDesc); // get the first config desc (index 0)
316 printf("dealWithDevice:unable to get config descriptor for index 0\n");
317 return kUproarDeviceErr;
319 err = (*dev)->SetConfiguration(dev, confDesc->bConfigurationValue);
322 printf("dealWithDevice: unable to set the configuration\n");
323 return kUproarDeviceErr;
326 interfaceRequest.bInterfaceClass = kIOUSBFindInterfaceDontCare; // requested class
327 interfaceRequest.bInterfaceSubClass = kIOUSBFindInterfaceDontCare; // requested subclass
328 interfaceRequest.bInterfaceProtocol = kIOUSBFindInterfaceDontCare; // requested protocol
329 interfaceRequest.bAlternateSetting = kIOUSBFindInterfaceDontCare; // requested alt setting
331 err = (*dev)->CreateInterfaceIterator(dev, &interfaceRequest, &iterator);
334 printf("dealWithDevice: unable to create interface iterator\n");
335 return kUproarDeviceErr;
338 while (usbInterfaceRef = IOIteratorNext(iterator))
340 printf("found interface: %p\n", (void*)usbInterfaceRef);
341 err = dealWithInterface(usbInterfaceRef, device);
342 IOObjectRelease(usbInterfaceRef); // no longer need this reference
346 IOObjectRelease(iterator);
348 if ((!found) || (err))
349 return kUproarDeviceErr;
351 return kUproarSuccess;
355 initDevice(USBDeviceContext *device)
357 mach_port_t masterPort = 0;
359 CFMutableDictionaryRef matchingDictionary = 0; // requires <IOKit/IOKitLib.h>
360 short idVendor = TopfieldVendorID;
361 short idProduct = TF5kProdID;
362 CFNumberRef numberRef;
363 io_iterator_t iterator = 0;
364 io_service_t usbDeviceRef;
367 err = IOMasterPort(bootstrap_port, &masterPort);
371 printf("Anchortest: could not create master port, err = %08x\n", err);
374 matchingDictionary = IOServiceMatching(kIOUSBDeviceClassName); // requires <IOKit/usb/IOUSBLib.h>
375 if (!matchingDictionary)
377 printf("Anchortest: could not create matching dictionary\n");
380 numberRef = CFNumberCreate(kCFAllocatorDefault, kCFNumberShortType, &idVendor);
383 printf("Anchortest: could not create CFNumberRef for vendor\n");
386 CFDictionaryAddValue(matchingDictionary, CFSTR(kUSBVendorName), numberRef);
387 CFRelease(numberRef);
389 numberRef = CFNumberCreate(kCFAllocatorDefault, kCFNumberShortType, &idProduct);
392 printf("Anchortest: could not create CFNumberRef for product\n");
395 CFDictionaryAddValue(matchingDictionary, CFSTR(kUSBProductName), numberRef);
396 CFRelease(numberRef);
399 err = IOServiceGetMatchingServices(masterPort, matchingDictionary, &iterator);
400 matchingDictionary = 0; // this was consumed by the above call
402 while (usbDeviceRef = IOIteratorNext(iterator))
404 printf("Found device %p\n", (void*)usbDeviceRef);
405 err = dealWithDevice(usbDeviceRef, device);
406 IOObjectRelease(usbDeviceRef); // no longer need this reference
411 IOObjectRelease(iterator);
413 mach_port_deallocate(mach_task_self(), masterPort);
414 if ((!found) || (err))
415 return kUproarDeviceErr;
417 return kUproarSuccess;
420 // ---------------------------------------------------------------------------
421 // PrivateMethods: Low-level USB
422 // ---------------------------------------------------------------------------
424 @implementation TFUSBController (PrivateMethods)
426 - (NSData*) sendCommand:(NSData*) fullyPackagedCommand
427 toDevice:(USBDeviceContext*)device expectResponse:(BOOL) getResponse
428 careForReturn:(BOOL) careFactor{
430 int cmdLength = [fullyPackagedCommand length];
431 unsigned char outBuffer[cmdLength];
432 memset(outBuffer, 0, cmdLength);
433 // NSLog(@"send: %@", [fullyPackagedCommand description]);
434 [fullyPackagedCommand getBytes:outBuffer];
436 err = doSend(device->dev, device->intf, outBuffer, cmdLength, 2);
438 NSLog(@"sendError: %08x\n");
440 if (! getResponse) return nil;
442 int inLen = 0xFFFF; // i think this is biggest needed?
443 unsigned char inBuf[inLen];
444 memset(inBuf, 0, inLen);
445 err = doRecv(device->dev, device->intf, inBuf, inLen, 2);
447 NSLog(@"inError: %08x\n", err);
449 if (! careFactor) return nil;
450 NSMutableData* data = [NSMutableData dataWithBytes:inBuf length:inLen];
451 data = [self swap:data];
452 inLen = inBuf[1]*256 + inBuf[0]; // work out how long the response really is. NB data is flipped, but inBuf still isn't
453 return [data subdataWithRange:(NSRange) {0,inLen}];
456 // ---------------------------------------------------------------------------
457 // PrivateMethods: Protocol message sequences
458 // ---------------------------------------------------------------------------
460 - (id) getFileListForPath:(NSString*) path {
461 if (myContext == nil)
464 NSData* hddListCmd = [self prepareCmdHddDirWithPath:path];
465 if (hddListCmd == nil)
468 [self checkUSB:myContext]; // sends cancel and waits for response
469 int contiguousErrors = 0;
470 [[dh fileList] removeAllObjects];
471 NSData* response = [self sendCommand:hddListCmd toDevice:myContext
472 expectResponse:YES careForReturn:YES];
473 while (response != nil && contiguousErrors++ < 5) {
474 const UInt32 eCode = [self checkCommunicationBlock:response];
475 if (eCode != USB_OK) {
476 response = [self sendCommand:[self prepareFailWithECode:eCode]
477 toDevice:myContext expectResponse:YES careForReturn:YES];
478 } else switch ([self cmdFromCommunicationBlock:response]) {
480 // [statusField setStringValue:NSLocalizedString(@"LAST_ERROR", @"Error on last command.")];
481 [[dh fileList] removeAllObjects];
482 response = [self sendCommand:hddListCmd toDevice:myContext
483 expectResponse:YES careForReturn:YES];
486 contiguousErrors = 0;
488 // Swapping sometimes adds a byte of padding. The following uses
489 // only complete 144-byte structures and so ignores such padding.
490 for (i=0; 8+(i+1)*114 <= [response length]; i++) {
491 NSData* typeFile = [response subdataWithRange:(NSRange) {8+i*114,114}];
492 NSMutableDictionary* tfFile = [dh getTFFileFromSwappedHexData:typeFile];
493 if (![[tfFile objectForKey:@"name"] isEqualToString:@".."]) {
494 [dh convertRawDataToUseful:tfFile];
495 [[dh fileList] addObject:tfFile];
498 response = [self sendCommand:[self prepareSuccess]
499 toDevice:myContext expectResponse:YES careForReturn:YES];
501 case USB_DataHddDirEnd:
502 contiguousErrors = 0;
506 [self checkUSB:myContext]; // cancel whatever is going on
507 [[dh fileList] removeAllObjects];
508 response = [self sendCommand:hddListCmd toDevice:myContext
509 expectResponse:YES careForReturn:YES];
514 [tableView reloadData];
515 [[self uiElements] tableView:tableView didClickTableColumn:[[self uiElements]selectedColumn]];
516 [[self uiElements] tableView:tableView didClickTableColumn:[[self uiElements]selectedColumn]]; //twice so get the same sort as before
520 - (void) turnTurboOn:(BOOL) turnOn {
521 if (![[[self uiElements] isConnected] intValue]) return;
522 [self checkUSB:myContext];
523 NSData* turboCommand = [self prepareCmdTurboWithMode:(turnOn ? 1 : 0)];
524 [self sendCommand:turboCommand toDevice:myContext expectResponse:YES careForReturn:NO];
527 - (void) renameFile:(NSString*) oldName withName:(NSString*)newName atPath:(NSString*)currentPath {
528 NSLog(@"%@,%@,%@", oldName, newName, currentPath);
529 [self checkUSB:myContext];
530 NSString* oldFname = [self fnameForFile:oldName atPath:currentPath];
531 NSString* newFname = [self fnameForFile:newName atPath:currentPath];
532 NSData* fileRenCmd = [self prepareCmdHddRenameFromFname:oldFname toFname:newFname];
533 [self sendCommand:fileRenCmd toDevice:myContext expectResponse:YES careForReturn:NO];
536 - (void) makeFolder:(NSString*)newName atPath:(NSString*)currentPath {
537 [self checkUSB:myContext];
538 NSString* fname = [self fnameForFile:newName atPath:currentPath];
539 NSData* newFoldCmd = [self prepareCmdHddCreateDirWithFname:fname];
540 NSData* usbCancel = [self prepareCancel];
541 [self sendCommand:usbCancel toDevice:myContext expectResponse:YES careForReturn:NO];
542 [self sendCommand:newFoldCmd toDevice:myContext expectResponse:YES careForReturn:NO];
545 - (void) checkUSB:(USBDeviceContext*)device {
546 NSData* usbCancel = [self prepareCancel];
547 NSData* data = [self sendCommand:usbCancel toDevice:device expectResponse:YES careForReturn:YES];
548 const UInt32 rW_bigendian = EndianU32_NtoB(USB_Success);
550 NSData* responseWanted = [NSData dataWithBytes:&rW_bigendian length:4];
551 while ((data == nil || [data length] < 8) && i < 8) {
552 NSLog (@"incorrect response");
554 data = [self sendCommand:usbCancel toDevice:device expectResponse:YES careForReturn:YES];
557 // tell someone that no longer connected here??
560 NSData* responseToCheck = [data subdataWithRange:(NSRange) {4,4}];
561 if (![responseWanted isEqualToData:responseToCheck]) {
562 [self sendCommand:usbCancel toDevice:device expectResponse:YES careForReturn:NO]; // send reset again
566 // ---------------------------------------------------------------------------
567 // PrivateMethods: User interface
568 // ---------------------------------------------------------------------------
570 - (UIElements*) uiElements {
571 return [NSApp delegate];
574 -(void) updateProgress:(NSDictionary*) inDict {
575 NSAutoreleasePool *pool=[[NSAutoreleasePool alloc] init];
576 double offset = [[inDict objectForKey:@"offset"] doubleValue];
577 double size = [[inDict objectForKey:@"size"] doubleValue];
578 NSDate* startTime = [inDict objectForKey:@"startTime"];
579 [progressBar setDoubleValue:((double)offset/size*100)];
580 [progressBar displayIfNeeded];
581 [progressTime setStringValue:[self elapsedTime:[[NSDate date] timeIntervalSinceDate:startTime]]];
582 [progressTime displayIfNeeded];
586 - (NSString*) elapsedTime:(NSTimeInterval) totalSeconds {
589 char sp = 20; //padding
590 int hours = (totalSeconds / 3600); // returns number of whole hours fitted in totalSecs
593 int minutes = ((totalSeconds / 60) - hours*60); // Whole minutes
596 int seconds = ((long) totalSeconds % 60); // Here we can use modulo to get num secs NOT fitting in whole minutes (60 secs)
599 return [NSString stringWithFormat:@"%c%i:%c%i:%c%i", hp, hours, mp, minutes, sp, seconds];
602 // ---------------------------------------------------------------------------
604 // ---------------------------------------------------------------------------
606 - (BOOL) hasPriorityTransfer {
608 @synchronized (self) {
609 ret = ([priorityTransferQueue count] > 0);
614 - (NSDictionary*) nextTransferAndQueue:(NSMutableArray**)queueOut {
615 NSDictionary* transfer = nil;
616 NSMutableArray* queue = nil;
618 @synchronized (self) {
619 if ([priorityTransferQueue count] > 0) {
620 queue = priorityTransferQueue;
621 transfer = [queue objectAtIndex:0];
622 } else if ([transferQueue count] > 0) {
623 queue = transferQueue;
624 transfer = [queue objectAtIndex:0];
627 [[transfer retain] autorelease];
634 - (void) removeTransfer:(NSDictionary*)transfer
635 fromQueue:(NSMutableArray*)queue
637 @synchronized (self) {
638 [queue removeObjectIdenticalTo:transfer];
644 // ---------------------------------------------------------------------------
646 // ---------------------------------------------------------------------------
648 @implementation TFUSBController
650 - (void) closeDevice:(USBDeviceContext *)device
652 IOUSBInterfaceInterface197 **intf;
653 IOUSBDeviceInterface197 **dev;
659 err = (*intf)->USBInterfaceClose(intf);
662 printf("dealWithInterface: unable to close interface. ret = %08x\n", err);
664 err = (*intf)->Release(intf);
667 printf("dealWithInterface: unable to release interface. ret = %08x\n", err);
670 err = (*dev)->USBDeviceClose(dev);
673 printf("dealWithDevice: error closing device - %08x\n", err);
674 (*dev)->Release(dev);
676 err = (*dev)->Release(dev);
679 printf("dealWithDevice: error releasing device - %08x\n", err);
683 - (USBDeviceContext*) initializeUSB {
684 USBDeviceContext *device;
687 device = malloc(sizeof(USBDeviceContext));
688 err = initDevice(device);
690 printf("Could not connect to Topfield\n");
694 printf("Connected to Topfield\n\n");
699 // ---------------------------------------------------------------------------
700 // Protocol message sequences
701 // ---------------------------------------------------------------------------
703 - (int) getFile:(NSDictionary*)fileInfo forPath:(NSString*)currentPath
704 toSaveTo:(NSString*)savePath beginAtOffset:(unsigned long long) offset
705 withLooping:(BOOL)looping existingTime:(NSTimeInterval)existingTime {
706 // [progressBar setDoubleValue:0];
707 // [progressTime setDoubleValue:0];
708 NSString* nameOnToppy = [fileInfo objectForKey:@"name"];
709 [[[self uiElements] currentlyField] setStringValue:
710 [NSLocalizedString(@"DOWNLOADING", @"Downloading: ") stringByAppendingString:nameOnToppy]];
711 [[[self uiElements] connectLight] setImage:[NSImage imageNamed:@"blink.tiff"]];
712 [[[self uiElements] currentlyField] displayIfNeeded];
713 //construct file send request
714 NSNumber* fileSize = [fileInfo objectForKey:@"fileSize"];
716 //prepackage commands to send
717 NSData* fileSendCmd = [self prepareCmdHddFileSendWithDirection:USB_FileToHost
718 fname:[self fnameForFile:nameOnToppy atPath:currentPath]
720 NSData* usbSuccess = [self prepareSuccess];
721 NSData* usbCancel = [self prepareCancel];
726 [self turnTurboOn:YES];
728 [self checkUSB:myContext]; //turbo has a check itself
729 [self sendCommand:fileSendCmd toDevice:myContext expectResponse:YES careForReturn:NO];
731 NSDate* startTime = [NSDate date];
732 startTime = [startTime addTimeInterval:(0-existingTime)];
733 // send start request and get response
734 NSData *data = [self sendCommand:usbSuccess toDevice:myContext expectResponse:YES careForReturn:YES];
735 const UInt32 rW_bigendian = EndianU32_NtoB(USB_DataHddFileData);
736 NSData *responseWanted = [NSData dataWithBytes:&rW_bigendian length:4];
737 if ([data length] < 16) {
738 NSLog(@"Incorrect Data length");
741 NSData *responseToCheck = [data subdataWithRange:(NSRange) {4,4}];
742 if (![responseWanted isEqualToData:responseToCheck]) {
743 NSLog(@"Unexpected response from Toppy during download");
747 // clean up data and prepare path to save it
748 NSData* header = [data subdataWithRange:(NSRange) {4,4}]; //cmd data
749 NSData* finalData = [data subdataWithRange:(NSRange) {16,[data length]-16}];
751 // first initialize a file of the right name, as NSFileHandle requires an existing file to work on
753 [[NSData dataWithBytes:"\0" length:1] writeToFile:savePath atomically:NO]; // write 0x00 to initialize (overwritten later)
754 NSFileHandle* outFile = [NSFileHandle fileHandleForWritingAtPath:savePath];
755 [outFile seekToFileOffset:offset];
756 [outFile writeData:finalData];
757 if (looping) { // loop for multiple data sends (ie files > 64k)
759 if ([fileSize isGreaterThan:[NSNumber numberWithDouble:1048576]]) {
761 NSLog(@"large file detected - low GUI update rate");
764 const UInt32 test_bigendian = EndianU32_NtoB(USB_DataHddFileData);
765 double amountReceived = 0xfe00 + offset;
766 NSData* testData = [NSData dataWithBytes:&test_bigendian length:4];
767 while ([header isEqualToData:testData] && [[[self uiElements] isConnected] intValue]) {
768 if ([self hasPriorityTransfer]) {
769 [self addTransfer:[NSDictionary dictionaryWithObjectsAndKeys:
770 fileInfo,@"filename", currentPath,@"path", savePath,@"savePath",
771 [NSNumber numberWithUnsignedLongLong:amountReceived],@"offset",
772 @"download",@"transferType", [NSNumber numberWithBool:YES],@"looping",
773 [NSNumber numberWithInt:[[NSDate date] timeIntervalSinceDate:startTime]],@"existingTime",
775 atIndex:1]; // nb adding to index 1 as the current transfer lies at 0 and will be deleted soon
776 // send reset again just to make sure!
777 [self sendCommand:usbCancel toDevice:myContext expectResponse:YES careForReturn:NO];
779 //now add the right modification date to the file
780 [[NSFileManager defaultManager]
781 changeFileAttributes:[NSDictionary
782 dictionaryWithObject:[fileInfo objectForKey:@"date"]
783 forKey:@"NSFileModificationDate"]
785 [self turnTurboOn:NO];
789 NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];
790 data = [self sendCommand:usbSuccess toDevice:myContext expectResponse:YES careForReturn:YES];
791 amountReceived += 0xfe00;
792 if (timesAround < 8 || timesAround % updateRate == 0) {
793 [NSThread detachNewThreadSelector:@selector(updateProgress:) toTarget:self
794 withObject:[NSDictionary dictionaryWithObjectsAndKeys:
795 [NSNumber numberWithDouble:(double)amountReceived], @"offset",
796 fileSize, @"size", startTime, @"startTime", nil]];
798 if ([data length] > 16){ //there is something to read
799 header = [[data subdataWithRange:(NSRange) {4,4}] retain]; //cmd data
800 NSData* finalData = [data subdataWithRange:(NSRange) {16,[data length]-16}];
801 [outFile writeData:finalData];
802 [outFile synchronizeFile];
808 [self sendCommand:usbCancel toDevice:myContext expectResponse:YES careForReturn:NO]; // send reset again just to make sure!
810 //now add the right modification date to the file
811 [[NSFileManager defaultManager]
812 changeFileAttributes:[NSDictionary
813 dictionaryWithObject:[fileInfo objectForKey:@"date"]
814 forKey:@"NSFileModificationDate"]
816 [self turnTurboOn:NO];
817 if (looping) [[self uiElements] finishTransfer];
821 - (void) uploadFile:(NSString*) fileToUpload ofSize:(long long) size
822 fromPath:(NSString*)curPath withAttributes:(NSData*) typeFile
823 atOffset:(unsigned long long)offset existingTime:(NSTimeInterval)existingTime {
824 NSLog(@"upload: %@,%@,%qu", fileToUpload, curPath, offset);
825 USBDeviceContext* dev = myContext;
826 // prepare Send command
827 NSMutableArray* array = [NSMutableArray arrayWithArray:[fileToUpload componentsSeparatedByString:@"/"]];
828 NSMutableString* fname = [NSMutableString stringWithString:[array lastObject]];
829 char dir = USB_FileToDevice;
830 NSMutableData* build = [NSMutableData dataWithBytes:&dir length:1];
831 short int nsize = [fname length]+[curPath length]+2;// one for slash, one for padding 0x00
832 const UInt16 nsize_bigendian = EndianU16_NtoB(nsize);
833 [build appendData:[NSData dataWithBytes:&nsize_bigendian length:2]];
834 NSData* d = [curPath dataUsingEncoding:NSISOLatin1StringEncoding];
835 [build appendData:d];
836 dir = 0x5c; // 0x5c = "/"
837 [build appendData:[NSData dataWithBytes:&dir length:1]];
838 [build appendData:[fname dataUsingEncoding:NSISOLatin1StringEncoding]];// may need to pad to 95...
839 if ([fname length] < 95)
840 [build increaseLengthBy:95-[fname length]];
842 [build appendData:[NSData dataWithBytes:&dir length:1]];
843 UInt64 offset_bigendian = EndianU64_NtoB(offset);
844 [build appendData:[NSData dataWithBytes:&offset_bigendian length:8]];
846 // prepackage commands to send
847 NSData* fileSendCmd = [self prepareCommand:USB_CmdHddFileSend withData:build];
848 NSData* fileStartCmd = [self prepareCommand:USB_DataHddFileStart withData:typeFile];
849 NSData* fileEndCmd = [self prepareDataHddFileEnd];
852 NSDate* startTime = [NSDate date];
853 startTime = [startTime addTimeInterval:(0-existingTime)];
856 [self turnTurboOn:YES];
859 // now the proper commands
860 NSData *data = [self sendCommand:fileSendCmd toDevice:dev expectResponse:YES careForReturn:YES];
861 data = [self sendCommand:fileStartCmd toDevice:dev expectResponse:YES careForReturn:YES];
862 const UInt32 rW_bigendian = EndianU32_NtoB(USB_Success);
863 NSData* responseWanted = [NSData dataWithBytes:&rW_bigendian length:4];
864 NSData* responseToCheck = nil;
866 NSFileHandle* fileHandle = [NSFileHandle fileHandleForReadingAtPath:fileToUpload];
867 [fileHandle seekToFileOffset:offset];
869 if ([self hasPriorityTransfer]) {
870 //break out and create a new transfer to continue it
871 NSLog(@"pausing upload");
872 [self addTransfer:[NSDictionary dictionaryWithObjectsAndKeys:
873 fileToUpload,@"filename",
874 [NSNumber numberWithUnsignedLongLong:size],@"fileSize",
875 curPath,@"path",typeFile,@"attributes",@"upload",@"transferType",
876 [NSNumber numberWithUnsignedLongLong:offset],@"offset",
877 [NSNumber numberWithInt:[[NSDate date] timeIntervalSinceDate:startTime]],@"existingTime",
879 atIndex:1]; //nb use index 1 as current transfer is at 0 and will be deleted
880 [self turnTurboOn:NO];
883 NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];
884 offset_bigendian = EndianU64_NtoB(offset);
885 NSMutableData* fileData = [NSMutableData dataWithBytes:&offset_bigendian length:8];
886 [fileData appendData:[fileHandle readDataOfLength:rate]];
888 NSData* fileDataCmd = [self prepareCommand:USB_DataHddFileData withData:fileData];
889 data = [self sendCommand:fileDataCmd toDevice:dev expectResponse:YES careForReturn:YES];
890 if ([data length] >= 8)
891 responseToCheck = [data subdataWithRange:(NSRange) {4,4}];
892 else responseToCheck = nil;
893 if (responseToCheck == nil || ![responseWanted isEqualToData:responseToCheck])
895 [NSThread detachNewThreadSelector:@selector(updateProgress:) toTarget:self
896 withObject:[NSDictionary dictionaryWithObjectsAndKeys:
897 [NSNumber numberWithDouble:(double)offset], @"offset",
898 [NSNumber numberWithDouble:(double)size], @"size",
899 startTime, @"startTime", nil]];
902 } while (offset < size && [[[self uiElements] isConnected] intValue]);
903 if ([[[self uiElements] isConnected] intValue])
904 data = [self sendCommand:fileEndCmd toDevice:dev expectResponse:YES careForReturn:YES];
905 [fileHandle closeFile];
906 [[self uiElements] goToPath:[[self uiElements]currentPath]];
907 [[self uiElements] tableView:tableView didClickTableColumn:[[self uiElements]selectedColumn]];
908 [[self uiElements] tableView:tableView didClickTableColumn:[[self uiElements]selectedColumn]]; //twice so get the same sort as before
909 [self turnTurboOn:NO];
910 [[self uiElements] finishTransfer];
913 - (void) deleteFile:(NSDictionary*)fileInfo fromPath:(NSString*)currentPath {
914 [self checkUSB:myContext];
915 NSString* fname = [self fnameForFile:[fileInfo objectForKey:@"name"]
917 NSData* fileDelCmd = [self prepareCmdHddDelWithFname:fname];
918 [self sendCommand:fileDelCmd toDevice:myContext expectResponse:YES careForReturn:NO];
921 // ---------------------------------------------------------------------------
923 // ---------------------------------------------------------------------------
925 - (void) addPriorityTransfer:(id)newTransfer {
926 @synchronized (self) {
927 [priorityTransferQueue addObject:newTransfer];
928 NSLog(@"%i,p:%i-%@",[transferQueue count],[priorityTransferQueue count],[newTransfer objectForKey:@"transferType"]);
932 - (void) addTransfer:(id)newTransfer atIndex:(int)front { //-1 for at end
933 @synchronized (self) {
934 if (front>=0) [transferQueue insertObject:newTransfer atIndex:front];
935 else [transferQueue addObject:newTransfer];
936 NSLog(@"%i,p:%i",[transferQueue count],[priorityTransferQueue count]);
940 - (void) clearQueues {
941 @synchronized (self) {
942 [priorityTransferQueue removeAllObjects];
943 [transferQueue removeAllObjects];
944 [pausedQueue removeAllObjects];
948 - (BOOL) hasCurrentTransfer {
950 @synchronized (self) {
951 ret = ([transferQueue count] > 0);
956 - (id) currentTransferInfo {
958 @synchronized (self) {
959 if ([transferQueue count] > 0) {
960 transfer = [transferQueue objectAtIndex:0];
961 // Make a copy of the object so that it can be safely manipulated
962 // in a different thread from the original.
963 transfer = [[transfer copy] autorelease];
969 - (id) firstPausedTransferInfo {
971 @synchronized (self) {
972 if ([pausedQueue count] > 0) {
973 transfer = [pausedQueue objectAtIndex:0];
974 // Make a copy of the object so that it can be safely manipulated
975 // in a different thread from the original.
976 transfer = [[transfer copy] autorelease];
982 - (void) transfer:(id)sender {
983 while ([[[self uiElements] isConnected] intValue]) {
984 NSAutoreleasePool *pool=[[NSAutoreleasePool alloc] init];
985 NSMutableArray* queue = nil;
986 NSDictionary* currentTransfer = [self nextTransferAndQueue:&queue];
987 if (currentTransfer != nil) {
988 NSString* transferType = [currentTransfer objectForKey:@"transferType"];
989 if ([transferType isEqualToString:@"fileList"]) {
990 [self getFileListForPath:[currentTransfer objectForKey:@"path"]];
992 else if ([transferType isEqualToString:@"turbo"]) {
993 // [self turnTurboOn:[[currentTransfer objectForKey:@"turboOn"] boolValue]];
995 else if ([transferType isEqualToString:@"rename"]) {
996 [self renameFile:[currentTransfer objectForKey:@"oldName"]
997 withName:[currentTransfer objectForKey:@"newName"]
998 atPath:[currentTransfer objectForKey:@"path"]];
1000 else if ([transferType isEqualToString:@"newFolder"]) {
1001 [self makeFolder:[currentTransfer objectForKey:@"newName"] atPath:[currentTransfer objectForKey:@"path"]];
1003 else if ([transferType isEqualToString:@"delete"]) {
1004 [self deleteFile:[currentTransfer objectForKey:@"file"] fromPath:[currentTransfer objectForKey:@"path"]];
1006 else if ([transferType isEqualToString:@"pause"]) {
1007 @synchronized (self) {
1008 if ([transferQueue count] != 0) {
1009 NSArray* toPause = [transferQueue filteredArrayUsingPredicate:
1010 [NSPredicate predicateWithFormat:@"(filename = %@)",
1011 [currentTransfer objectForKey:@"filename"]]];
1012 if ([toPause count] > 1) NSLog(@"multiple pauses?");
1014 [pausedQueue addObjectsFromArray:toPause];
1015 [transferQueue removeObjectsInArray:toPause];
1020 else if ([transferType isEqualToString:@"resume"]) {
1021 @synchronized (self) {
1022 if ([pausedQueue count] != 0) {
1023 NSArray* toResume = [pausedQueue filteredArrayUsingPredicate:
1024 [NSPredicate predicateWithFormat:@"(filename = %@)",
1025 [currentTransfer objectForKey:@"filename"]]];
1026 if ([toResume count] > 1) NSLog(@"multiple resumes?");
1028 [transferQueue addObjectsFromArray:toResume];
1029 [pausedQueue removeObjectsInArray:toResume];
1034 else if ([transferType isEqualToString:@"download"]) {
1035 [self getFile:[currentTransfer objectForKey:@"filename"]
1036 forPath:[currentTransfer objectForKey:@"path"]
1037 toSaveTo:[currentTransfer objectForKey:@"savePath"]
1038 beginAtOffset:[[currentTransfer objectForKey:@"offset"] unsignedLongLongValue]
1039 withLooping:[[currentTransfer objectForKey:@"looping"] boolValue]
1040 existingTime:[[currentTransfer objectForKey:@"existingTime"] intValue]];
1042 else if ([transferType isEqualToString:@"upload"]) {
1043 [self uploadFile:[currentTransfer objectForKey:@"filename"]
1044 ofSize:[[currentTransfer objectForKey:@"fileSize"] unsignedLongLongValue]
1045 fromPath:[currentTransfer objectForKey:@"path"]
1046 withAttributes:[currentTransfer objectForKey:@"attributes"]
1047 atOffset:[[currentTransfer objectForKey:@"offset"] unsignedLongLongValue]
1048 existingTime:[[currentTransfer objectForKey:@"existingTime"] intValue]];
1051 NSLog(@"Unrecognized transfer type: %@", transferType);
1053 [self removeTransfer:currentTransfer fromQueue:queue];
1060 // ---------------------------------------------------------------------------
1062 // ---------------------------------------------------------------------------
1064 -(void) setProgressBar:(NSProgressIndicator*)bar time:(NSTextField*)timeField turbo:(NSButton*)turbo{
1066 progressTime = timeField;
1070 - (void) setDH:(id)newDH tableView:(id)tv {
1075 // ---------------------------------------------------------------------------
1077 // ---------------------------------------------------------------------------
1080 if (self = [super init]) {
1083 transferQueue = [[NSMutableArray arrayWithCapacity:1] retain];
1084 pausedQueue = [[NSMutableArray arrayWithCapacity:1] retain];
1085 priorityTransferQueue = [[NSMutableArray arrayWithCapacity:1] retain];
1091 return connectedSpeed;
1094 -(void) setDebug:(int)mode {
1096 NSLog(@"Debug level: %i", debug);
1099 -(void) setRate:(int) newRate {
1101 NSLog(@"New rate set: %i", rate);