more changes to TX test code
[goodfet] / client / goodfet.maxusbmass
index 66c2e81..0bda107 100755 (executable)
@@ -11,9 +11,30 @@ import time;
 
 from GoodFETMAXUSB import *;
 
+
+# This constant is kinda complicated and very ugly.  The idea is that
+# if we take too long in any given transaction, the host will abort.
+# How many blocks we can send depends upon timeouts on both sides,
+# with (at least in Linux) the behavior that aborting early causes the
+# disk to reset with only warning and no real errors.  Somewhere
+# there's a way to provide this constant to the host, in which case
+# stalling and waiting for a reset will no longer be necessary.
+
+MAXBLOCKSPERTRANSFER=128
+
+def zeros(length):
+    """Returns a list of zeroes of the specified length."""
+    l=range(0,length);
+    for foo in l:
+        l[foo]=0;
+    return l;
+
 class GoodFETMAXUSBMass(GoodFETMAXUSBDevice):
     """This emulates a USB Mass Storage device."""
     
+    #Too much data to watch everything.
+    usbverbose=False;
+
     def getSectorData(self,lba):
         """Overload this to return data from a given 512-byte sector."""
         print "You forgot to overload getSectorData().  Returning something neighborly.";
@@ -54,9 +75,14 @@ class GoodFETMAXUSBMass(GoodFETMAXUSBDevice):
         return sector;
     def putSectorData(self,lba,block):
         """Overload this to write data to a given 512-byte sector."""
-        
+        print "You forgot to overload putSectorData().  Ignoring sector write.";
         return;
     
+    def getSectorCount(self):
+        """Returns the number of viable Logical Block Addresses."""
+        print "You forgot to overload getSectorCount().  Guessing 0x200.";
+        return 0x200;
+    
     def massinit(self):
         """Initialize a USB Mass Storage device."""
         self.usb_disconnect();
@@ -66,8 +92,9 @@ class GoodFETMAXUSBMass(GoodFETMAXUSBDevice):
         
     def massrun(self):
         """Main loop of the USB Mass Storage emulator."""
-        print "Starting a Mass Storage device.  This doesn't work yet.";
+        print "Starting a Mass Storage device.";
         while 1:
+            sys.stdout.flush();
             self.service_irqs();
     def do_SETUP(self):
         """Handle USB Enumeration"""
@@ -218,7 +245,6 @@ class GoodFETMAXUSBMass(GoodFETMAXUSBDevice):
         
     def do_OUT1(self):
         """Handle an OUT1 output event."""
-        print "Got an output event, printing the result.";
         l=self.rreg(rEP1OUTBC);
         frame=self.readbytes(rEP1OUTFIFO,l);
         self.handleCBW(frame);
@@ -247,8 +273,9 @@ class GoodFETMAXUSBMass(GoodFETMAXUSBDevice):
         
     def handleCB(self,cb,cblen,dtlen,dtdir):
         """Handles a command block, then replies with a CSW."""
-        print "\nGot command block 0x%02x, requesting 0x%02x bytes" % (
-            ord(cb[0]), dtlen);
+        if self.usbverbose:
+            print "Got command block, type 0x%02x requesting 0x%02x bytes" % (
+                ord(cb[0]), dtlen);
         verb=ord(cb[0]);
         status=00; #good, set to 1 for bad.
         if verb==0x00: # Test Unit Ready
@@ -268,7 +295,7 @@ class GoodFETMAXUSBMass(GoodFETMAXUSBDevice):
             #print "Responding to CB inquiry.";
             response=[
                 0x00, # 00 for Direct, 1F for "no floppy"
-                0x80, # make 0x80 for removable media
+                0x80, # make 0x80 for removable media, 0x00 for fixed
                 0x00, # Version
                 0x01, # Response Data Format
                 0x1f, #Additional length.
@@ -281,6 +308,8 @@ class GoodFETMAXUSBMass(GoodFETMAXUSBDevice):
                 ord('0'),ord('.'),ord('0'),ord('1')]
             #print "Sending %i byte reply to %i byte query." % (
             #        len(response),dtlen);
+            while len(response)<dtlen:
+                response=response+[0];
             #while not(self.rreg(rEPIRQ)&bmIN3BAVIRQ):
             #    #Wait for the packet to complete before sending the next.
             #    print "Waiting to complete inquiry."
@@ -298,18 +327,26 @@ class GoodFETMAXUSBMass(GoodFETMAXUSBDevice):
         elif verb==0x1e: #Prevent/Allow Removal
             # Give a good status to pretend we understand.
             status=0x00;
-        elif verb==0x1A: #Mode Sense (6)
+        elif verb==0x1A or verb==0x5A: #Mode Sense (6 or 10)
             # I should probably send six bytes here.
-            response=[0x12,0,0,0, 0,0,0,0x1C];
-            self.writebytes(rEP3INFIFO,
-                            response);
-            self.wregAS(rEP3INBC,
-                        len(response));
+            page=ord(cb[2])&0x3F;
+            print "Mode Sense (6) requesting %i byte Page Code %02x" % (
+                dtlen,page);
+            #This is completely wrong.
+            response=[0x07,0,0,0, 0,0,0,0x1C];
+            # response=[0x37,0x00,0x00,0x08,0x00,0x00,0x00,0x00, 0x00,0x00,0x02,0x00,0x01,0x0a,0x80,0x00,
+            #           0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00, 0x08,0x12,0x04,0x00,0x00,0x00,0x00,0x00,
+            #           0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00, 0x00,0x00,0x00,0x00,0x0a,0x0a,0x02,0x00,
+            #           0x00,0x00,0x00,0x00,0xff,0xff,0x00,0x1e];
+            if page!=0x3f:
+                print "Unknown page, returning empty page.";
+                response=[0x07,0,0,0, 0,0,0,0];
+            self.fifo_ep3in_tx(response);
         elif verb==0x23: #Read Format Capacity
             response=[
-                0x00, 0,0x00,0x08, #Capacity list length.
-                0,0x00,x10,0x00,   # Number of sectors, implying 10MB.
-                0x01,0x00,            #reserved/desciptor code.
+                0x00, 0,0x00,0x08,    # Capacity list length.
+                0,0x00,0x10,0x00,     # Number of sectors, implying 10MB.  Should come from image.
+                0x01,0x00,            # reserved/desciptor code.
                 0x02,0x00             # 512 bytes/sector.  Why is this twice?
                 ];
             self.writebytes(rEP3INFIFO,
@@ -317,8 +354,10 @@ class GoodFETMAXUSBMass(GoodFETMAXUSBDevice):
             self.wregAS(rEP3INBC,
                         len(response));
         elif verb==0x25: #Read Capacity
+            lastlba=self.getSectorCount();
             response=[
-                0x00, 0,0x0f,0xFF, # Last LBA; might have endianness backward.
+                #0x00, 0, 0x0f, 0xFF, # Last LBA
+                (lastlba>>24)&0xFF, (lastlba>>16)&0xFF, (lastlba>>8)&0xFF, lastlba&0xFF, # Last LBA
                 0x00,0x00,0x02,0x00   # Block length of 512 bytes.
                 ];
             self.writebytes(rEP3INFIFO,
@@ -335,27 +374,40 @@ class GoodFETMAXUSBMass(GoodFETMAXUSBDevice):
                 );
             count=dtlen/512;
             print "Fetching %i blocks starting at  LBA %i." % (count,baselba);
+            if count>MAXBLOCKSPERTRANSFER:
+                count=0;
+                #status=1; #Fail if we're asked to read more than 32 blocks.
+                #Now we need to stall EP3.  It's not acceptable to just forget to transmit.
+                self.wreg(rEPSTALLS,0x10);
+                return;
             for i in range(0,count):
-                data=self.getSectorData(baselba+count);
-                for j in range(0,8):
-                    print "Sending block fragment %i,%i" % (i,j);
-                    #Transmit each 64-byte block fragment, then wait for next.
-                    while not(self.rreg(rEPIRQ)&bmIN3BAVIRQ): pass;
-                    response=data[j*64:j*64+64];
-                    self.writebytes(rEP3INFIFO,
-                                    response);
-                    self.wregAS(rEP3INBC,
-                                64);
+                data=self.getSectorData(baselba+i);
+                self.fifo_ep3in_tx(data);
+                
+                # for j in range(0,8):
+                #     #print "Sending block fragment %i,%i" % (i,j);
+                #     #Transmit each 64-byte block fragment, then wait for next.
+                #     while not(self.rreg(rEPIRQ)&bmIN3BAVIRQ): pass;
+                #     response=data[j*64:j*64+64];
+                #     self.writebytes(rEP3INFIFO,
+                #                     response);
+                #     self.wregAS(rEP3INBC,
+                #                 64);
             #sys.exit();
         elif verb==0x2A: #WRITE SECTOR
             print "Haven't implemented WRITE SECTOR.";
-            sys.exit();
+            #sys.exit();
+        elif verb==0x1B: #EJECT/RETRACT DISK
+            print "Haven't implemented SCSI Start Stop Unit Command (1B)";
+            print "https://en.wikipedia.org/wiki/SCSI_Start_Stop_Unit_Command";
+            #sys.exit();
         else:
             print "ERROR: Unknown SCSI command block verb %02x." % verb;
-            status=1; #Command Failed
+            status=0x02; #Command Failed
             if dtlen>0:
-                print "Perhaps I should send %i bytes of dummy data here." % dtlen;
-            sys.exit(1);
+                print "Sending %i bytes of dummy data here." % dtlen;
+                self.fifo_ep3in_tx(zeros(dtlen));
+            #sys.exit(1);
         cbw=self.lastCBW;
         
         #Now we need to send the CSW.
@@ -374,10 +426,74 @@ class GoodFETMAXUSBMass(GoodFETMAXUSBDevice):
         
         
         return;
+
+class GoodFETMAXUSBMassFile(GoodFETMAXUSBMass):
+    """This emulates a USB Mass Storage Device, providing a file as
+    its image.  Writes are not yet supported, and this is very slow.
+    Performance hacks will come after the code stabilizes."""
+    
+    datafile=None;
+    datafilelen=None;
+    def openImage(self,filename):
+        """Opens an image for use.  Call this *before* massinit()."""
+        self.datafile=open(filename,"rb");
+        print "Opened an image with %i blocks." % self.getSectorCount();
+    def putSectorData(self,lba,block):
+        """Writes a 512-byte sector to the lba address."""
+        print "Writes aren't yet supported.";
+        return;
+    
+    def getSectorData(self,lba):
+        """Returns data from a 512-byte sector."""
+        toret="";
+        
+        #Seek to the appropraite block.
+        #print "Seeking to position %i"% (lba*512)
+        self.datafile.seek(lba*512,0);
+        pos=self.datafile.tell();
+        if pos!=lba*512:
+            print "SEEK ERROR: Seeked to %i (lba=%i), but now I'm at %i (lba=%i)" % (
+                lba*512,lba,
+                pos,pos/512);
+            #sys.exit();
+        
+        #Dump the data out, assuming no blocking and filling with nonsense.
+        toret=self.datafile.read(512);
+        if len(toret)<512:
+            print "Holy hell, I only have %i bytes of 512." % len(toret);
+        
+        toretbytes=range(0,len(toret));
+        for b in range(0,len(toret)): toretbytes[b]=ord(toret[b]);
+        return toretbytes;
+        
+    def getSectorCount(self):
+        """Returns the number of viable Logical Block Addresses."""
+        
+        # Python must have a better way to read a file length, but for
+        # now we just read the whole damned thing and then throw it
+        # away.  With present performance, we can't read anything
+        # large enough for this to be a problem.
+        if self.datafilelen==None:
+            self.datafile.seek(0);
+            self.datafilelen=len(self.datafile.read());
+        if self.datafilelen%512!=0:
+            print "ERROR: Image does not have an integer number of blocks!"
+            print "%i \% 512 == %i" % (self.datafilelen,
+                                       self.datafilelen%512);
+            sys.exit();
+        return self.datafilelen/512-1;
+
+if(len(sys.argv)==1):
+    print "Usage: %s disk.img\n" % sys.argv[0];
+    sys.exit();
+
+
 #Initialize FET and set baud rate
-client=GoodFETMAXUSBMass();
+client=GoodFETMAXUSBMassFile();
 client.serInit()
 
+client.openImage(sys.argv[1]);
+
 client.MAXUSBsetup();
 client.massinit();