git.rot13.org Git - goodfet/blob - client/GoodFETMAXUSB.py

   1 #!/usr/bin/env python
   2 # GoodFET Client Library for Maxim USB Chips.
   3 #
   4 # (C) 2012 Travis Goodspeed <travis at radiantmachines.com>
   5 #
   6 # This code is being rewritten and refactored.  You've been warned!
   7
   8
   9 import sys, time, string, cStringIO, struct, glob, os;
  10
  11 from GoodFET import GoodFET;
  12
  13 #Handy registers.
  14 rEP0FIFO=0
  15 rEP1OUTFIFO=1
  16 rEP2INFIFO=2
  17 rEP3INFIFO=3
  18 rSUDFIFO=4
  19 rEP0BC=5
  20 rEP1OUTBC=6
  21 rEP2INBC=7
  22 rEP3INBC=8
  23 rEPSTALLS=9
  24 rCLRTOGS=10
  25 rEPIRQ=11
  26 rEPIEN=12
  27 rUSBIRQ=13
  28 rUSBIEN=14
  29 rUSBCTL=15
  30 rCPUCTL=16
  31 rPINCTL=17
  32 rREVISION=18
  33 rFNADDR=19
  34 rIOPINS=20
  35 rIOPINS1=20  #Same as rIOPINS
  36 rIOPINS2=21
  37 rHIRQ=25
  38 rHIEN=26
  39 rMODE=27
  40 rPERADDR=28
  41 rHCTL=29
  42 rHXFR=30
  43 rHRSL=31
  44
  45 #Host mode registers.
  46 rRCVFIFO =1
  47 rSNDFIFO =2
  48 rRCVBC   =6
  49 rSNDBC   =7
  50 rHIRQ    =25
  51
  52
  53 # R11 EPIRQ register bits
  54 bmSUDAVIRQ =0x20
  55 bmIN3BAVIRQ =0x10
  56 bmIN2BAVIRQ =0x08
  57 bmOUT1DAVIRQ= 0x04
  58 bmOUT0DAVIRQ= 0x02
  59 bmIN0BAVIRQ =0x01
  60
  61 # R12 EPIEN register bits
  62 bmSUDAVIE   =0x20
  63 bmIN3BAVIE  =0x10
  64 bmIN2BAVIE  =0x08
  65 bmOUT1DAVIE =0x04
  66 bmOUT0DAVIE =0x02
  67 bmIN0BAVIE  =0x01
  68
  69
  70
  71
  72 # ************************
  73 # Standard USB Requests
  74 SR_GET_STATUS           =0x00   # Get Status
  75 SR_CLEAR_FEATURE        =0x01   # Clear Feature
  76 SR_RESERVED             =0x02   # Reserved
  77 SR_SET_FEATURE          =0x03   # Set Feature
  78 SR_SET_ADDRESS          =0x05   # Set Address
  79 SR_GET_DESCRIPTOR       =0x06   # Get Descriptor
  80 SR_SET_DESCRIPTOR       =0x07   # Set Descriptor
  81 SR_GET_CONFIGURATION    =0x08   # Get Configuration
  82 SR_SET_CONFIGURATION    =0x09   # Set Configuration
  83 SR_GET_INTERFACE        =0x0a   # Get Interface
  84 SR_SET_INTERFACE        =0x0b   # Set Interface
  85
  86 # Get Descriptor codes
  87 GD_DEVICE               =0x01   # Get device descriptor: Device
  88 GD_CONFIGURATION        =0x02   # Get device descriptor: Configuration
  89 GD_STRING               =0x03   # Get device descriptor: String
  90 GD_HID                  =0x21   # Get descriptor: HID
  91 GD_REPORT               =0x22   # Get descriptor: Report
  92
  93 # SETUP packet header offsets
  94 bmRequestType           =0
  95 bRequest                =1
  96 wValueL                 =2
  97 wValueH                 =3
  98 wIndexL                 =4
  99 wIndexH                 =5
 100 wLengthL                =6
 101 wLengthH                =7
 102
 103 # HID bRequest values
 104 GET_REPORT              =1
 105 GET_IDLE                =2
 106 GET_PROTOCOL            =3
 107 SET_REPORT              =9
 108 SET_IDLE                =0x0A
 109 SET_PROTOCOL            =0x0B
 110 INPUT_REPORT            =1
 111
 112 # PINCTL bits
 113 bmEP3INAK   =0x80
 114 bmEP2INAK   =0x40
 115 bmEP1INAK   =0x20
 116 bmFDUPSPI   =0x10
 117 bmINTLEVEL  =0x08
 118 bmPOSINT    =0x04
 119 bmGPXB      =0x02
 120 bmGPXA      =0x01
 121
 122 # rUSBCTL bits
 123 bmHOSCSTEN  =0x80
 124 bmVBGATE    =0x40
 125 bmCHIPRES   =0x20
 126 bmPWRDOWN   =0x10
 127 bmCONNECT   =0x08
 128 bmSIGRWU    =0x04
 129
 130 # USBIRQ bits
 131 bmURESDNIRQ =0x80
 132 bmVBUSIRQ   =0x40
 133 bmNOVBUSIRQ =0x20
 134 bmSUSPIRQ   =0x10
 135 bmURESIRQ   =0x08
 136 bmBUSACTIRQ =0x04
 137 bmRWUDNIRQ  =0x02
 138 bmOSCOKIRQ  =0x01
 139
 140 # MODE bits
 141 bmHOST          =0x01
 142 bmLOWSPEED      =0x02
 143 bmHUBPRE        =0x04
 144 bmSOFKAENAB     =0x08
 145 bmSEPIRQ        =0x10
 146 bmDELAYISO      =0x20
 147 bmDMPULLDN      =0x40
 148 bmDPPULLDN      =0x80
 149
 150 # PERADDR/HCTL bits
 151 bmBUSRST        =0x01
 152 bmFRMRST        =0x02
 153 bmSAMPLEBUS     =0x04
 154 bmSIGRSM        =0x08
 155 bmRCVTOG0       =0x10
 156 bmRCVTOG1       =0x20
 157 bmSNDTOG0       =0x40
 158 bmSNDTOG1       =0x80
 159
 160 # rHXFR bits
 161 # Host XFR token values for writing the HXFR register (R30).
 162 # OR this bit field with the endpoint number in bits 3:0
 163 tokSETUP  =0x10  # HS=0, ISO=0, OUTNIN=0, SETUP=1
 164 tokIN     =0x00  # HS=0, ISO=0, OUTNIN=0, SETUP=0
 165 tokOUT    =0x20  # HS=0, ISO=0, OUTNIN=1, SETUP=0
 166 tokINHS   =0x80  # HS=1, ISO=0, OUTNIN=0, SETUP=0
 167 tokOUTHS  =0xA0  # HS=1, ISO=0, OUTNIN=1, SETUP=0
 168 tokISOIN  =0x40  # HS=0, ISO=1, OUTNIN=0, SETUP=0
 169 tokISOOUT =0x60  # HS=0, ISO=1, OUTNIN=1, SETUP=0
 170
 171 # rRSL bits
 172 bmRCVTOGRD   =0x10
 173 bmSNDTOGRD   =0x20
 174 bmKSTATUS    =0x40
 175 bmJSTATUS    =0x80
 176 # Host error result codes, the 4 LSB's in the HRSL register.
 177 hrSUCCESS   =0x00
 178 hrBUSY      =0x01
 179 hrBADREQ    =0x02
 180 hrUNDEF     =0x03
 181 hrNAK       =0x04
 182 hrSTALL     =0x05
 183 hrTOGERR    =0x06
 184 hrWRONGPID  =0x07
 185 hrBADBC     =0x08
 186 hrPIDERR    =0x09
 187 hrPKTERR    =0x0A
 188 hrCRCERR    =0x0B
 189 hrKERR      =0x0C
 190 hrJERR      =0x0D
 191 hrTIMEOUT   =0x0E
 192 hrBABBLE    =0x0F
 193
 194 # HIRQ bits
 195 bmBUSEVENTIRQ   =0x01   # indicates BUS Reset Done or BUS Resume
 196 bmRWUIRQ        =0x02
 197 bmRCVDAVIRQ     =0x04
 198 bmSNDBAVIRQ     =0x08
 199 bmSUSDNIRQ      =0x10
 200 bmCONDETIRQ     =0x20
 201 bmFRAMEIRQ      =0x40
 202 bmHXFRDNIRQ     =0x80
 203
 204 class GoodFETMAXUSB(GoodFET):
 205     MAXUSBAPP=0x40;
 206
 207     def setup2str(self,SUD):
 208         """Converts the header of a setup packet to a string."""
 209         return "bmRequestType=0x%02x, bRequest=0x%02x, wValue=0x%04x, wIndex=0x%04x, wLength=0x%04x" % (
 210                 ord(SUD[0]), ord(SUD[1]),
 211                 ord(SUD[2])+(ord(SUD[3])<<8),
 212                 ord(SUD[4])+(ord(SUD[5])<<8),
 213                 ord(SUD[6])+(ord(SUD[7])<<8)
 214                 );
 215
 216     def MAXUSBsetup(self):
 217         """Move the FET into the MAXUSB application."""
 218         self.writecmd(self.MAXUSBAPP,0x10,0,self.data); #MAXUSB/SETUP
 219         print "Connected to MAX342x Rev. %x" % (self.rreg(rREVISION));
 220         self.wreg(rPINCTL,0x18); #Set duplex and negative INT level.
 221
 222     def MAXUSBtrans8(self,byte):
 223         """Read and write 8 bits by MAXUSB."""
 224         data=self.MAXUSBtrans([byte]);
 225         return ord(data[0]);
 226
 227     def MAXUSBtrans(self,data):
 228         """Exchange data by MAXUSB."""
 229         self.data=data;
 230         self.writecmd(self.MAXUSBAPP,0x00,len(data),data);
 231         return self.data;
 232
 233     def rreg(self,reg):
 234         """Peek 8 bits from a register."""
 235         data=[reg<<3,0];
 236         self.writecmd(self.MAXUSBAPP,0x00,len(data),data);
 237         return ord(self.data[1]);
 238     def rregAS(self,reg):
 239         """Peek 8 bits from a register, setting AS."""
 240         data=[(reg<<3)|1,0];
 241         self.writecmd(self.MAXUSBAPP,0x00,len(data),data);
 242         return ord(self.data[1]);
 243     def wreg(self,reg,value):
 244         """Poke 8 bits into a register."""
 245         data=[(reg<<3)|2,value];
 246         self.writecmd(self.MAXUSBAPP,0x00,len(data),data);
 247         return value;
 248     def wregAS(self,reg,value):
 249         """Poke 8 bits into a register, setting AS."""
 250         data=[(reg<<3)|3,value];
 251         self.writecmd(self.MAXUSBAPP,0x00,len(data),data);
 252         return value;
 253     def readbytes(self,reg,length):
 254         """Peek some bytes from a register."""
 255         data=[(reg<<3)]+range(0,length);
 256         self.writecmd(self.MAXUSBAPP,0x00,len(data),data);
 257         toret=self.data[1:len(self.data)];
 258         ashex="";
 259         for foo in toret:
 260             ashex=ashex+(" %02x"%ord(foo));
 261         print "GET %02x==%s" % (reg,ashex);
 262         return toret;
 263     def ctl_write_nd(self,request):
 264         """Control Write with no data stage.  Assumes PERADDR is set
 265         and the SUDFIFO contains the 8 setup bytes.  Returns with
 266         result code = HRSLT[3:0] (HRSL register).  If there is an
 267         error, the 4MSBits of the returned value indicate the stage 1
 268         or 2."""
 269
 270         # 1. Send the SETUP token and 8 setup bytes.
 271         # Should ACK immediately.
 272         self.writebytes(rSUDFIFO,request);
 273         resultcode=self.send_packet(tokSETUP,0); #SETUP packet to EP0.
 274         if resultcode: return resultcode;
 275
 276         # 2. No data stage, so the last operation is to send an IN
 277         # token to the peripheral as the STATUS (handhsake) stage of
 278         # this control transfer.  We should get NAK or the DATA1 PID.
 279         # When we get back to the DATA1 PID the 3421 automatically
 280         # sends the closing NAK.
 281         resultcode=self.send_packet(tokINHS,0); #Function takes care of retries.
 282         if resultcode: return resultcode;
 283
 284         return 0;
 285
 286
 287     def ctl_read(self,request):
 288         """Control read transfer, used in Host mode."""
 289         resultcode=0;
 290         bytes_to_read=request[6]+256*request[7];
 291
 292         ##SETUP packet
 293         self.writebytes(rSUDFIFO,request);     #Load the FIFO
 294         resultcode=self.send_packet(tokSETUP,0); #SETUP packet to EP0
 295         if resultcode:
 296             print "Failed to get ACK on SETUP request in ctl_read()."
 297             return resultcode;
 298
 299         self.wreg(rHCTL,bmRCVTOG1);              #FIRST data packet in CTL transfer uses DATA1 toggle.
 300         resultcode=self.IN_Transfer(0,bytes_to_read);
 301         if resultcode:
 302             print "Failed on IN Transfer in ctl_read()";
 303             return resultcode;
 304
 305         self.IN_nak_count=self.nak_count;
 306
 307         #The OUT status stage.
 308         resultcode=self.send_packet(tokOUTHS,0);
 309         if resultcode:
 310             print "Failed on OUT Status stage in ctl_read()";
 311             return resultcode;
 312
 313         return 0; #Success
 314
 315     xfrdata=[]; #Ugly variable used only by a few functions.  FIXME
 316     def IN_Transfer(self,endpoint,INbytes):
 317         """Does an IN transfer to an endpoint, used for Host mode."""
 318         xfrsize=INbytes;
 319         xfrlen=0;
 320         self.xfrdata=[];
 321
 322         while 1:
 323             resultcode=self.send_packet(tokIN,endpoint); #IN packet to EP. NAKS taken care of.
 324             if resultcode: return resultcode;
 325
 326             pktsize=self.rreg(rRCVBC); #Numer of RXed bytes.
 327
 328             #Very innefficient, move this to C if performance is needed.
 329             for j in range(0,pktsize):
 330                 self.xfrdata=self.xfrdata+[self.rreg(rRCVFIFO)];
 331             xfrsize=self.xfrdata[0];
 332             self.wreg(rHIRQ,bmRCVDAVIRQ); #Clear IRQ
 333             xfrlen=xfrlen+pktsize; #Add byte count to total transfer length.
 334
 335             print "%i / %i" % (xfrlen,xfrsize)
 336
 337             #Packet is complete if:
 338             # 1. The device sent a short packet, <maxPacketSize
 339             # 2. INbytes have been transfered.
 340             if (pktsize<self.maxPacketSize) or (xfrlen>=xfrsize):
 341                 self.last_transfer_size=xfrlen;
 342                 ashex="";
 343                 for foo in self.xfrdata:
 344                     ashex=ashex+(" %02x"%foo);
 345                 print "INPACKET EP%i==%s (0x%02x bytes remain)" % (endpoint,ashex,xfrsize);
 346                 return resultcode;
 347
 348     RETRY_LIMIT=3;
 349     NAK_LIMIT=300;
 350     def send_packet(self,token,endpoint):
 351         """Send a packet to an endpoint as the Host, taking care of NAKs.
 352         Don't use this for device code."""
 353         self.retry_count=0;
 354         self.nak_count=0;
 355
 356         #Repeat until NAK_LIMIT or RETRY_LIMIT is reached.
 357         while self.nak_count<self.NAK_LIMIT and self.retry_count<self.RETRY_LIMIT:
 358             self.wreg(rHXFR,(token|endpoint)); #launch the transfer
 359             while not (self.rreg(rHIRQ) & bmHXFRDNIRQ):
 360                 # wait for the completion IRQ
 361                 pass;
 362             self.wreg(rHIRQ,bmHXFRDNIRQ);           #Clear IRQ
 363             resultcode = (self.rreg(rHRSL) & 0x0F); # get the result
 364             if (resultcode==hrNAK):
 365                 self.nak_count=self.nak_count+1;
 366             elif (resultcode==hrTIMEOUT):
 367                 self.retry_count=self.retry_count+1;
 368             else:
 369                 #Success!
 370                 return resultcode;
 371         return resultcode;
 372
 373     def writebytes(self,reg,tosend):
 374         """Poke some bytes into a register."""
 375         data="";
 376         if type(tosend)==str:
 377             data=chr((reg<<3)|2)+tosend;
 378         else:
 379             data=[(reg<<3)|2]+tosend;
 380             ashex="";
 381             for foo in tosend:
 382                 ashex=ashex+(" %02x"%foo);
 383             print "PUT %02x:=%s" % (reg,ashex)
 384         self.writecmd(self.MAXUSBAPP,0x00,len(data),data);
 385     def usb_connect(self):
 386         """Connect the USB port."""
 387
 388         #disconnect D+ pullup if host turns off VBUS
 389         self.wreg(rUSBCTL,bmVBGATE|bmCONNECT);
 390     def usb_disconnect(self):
 391         """Disconnect the USB port."""
 392         self.wreg(rUSBCTL,bmVBGATE);
 393     def STALL_EP0(self,SUD=None):
 394         """Stall for an unknown SETUP event."""
 395         if SUD==None:
 396             print "Stalling EP0.";
 397         else:
 398             print "Stalling EPO for %s" % self.setup2str(SUD);
 399         self.wreg(rEPSTALLS,0x23); #All three stall bits.
 400     def SETBIT(self,reg,val):
 401         """Set a bit in a register."""
 402         self.wreg(reg,self.rreg(reg)|val);
 403     def vbus_on(self):
 404         """Turn on the target device."""
 405         self.wreg(rIOPINS2,(self.rreg(rIOPINS2)|0x08));
 406     def vbus_off(self):
 407         """Turn off the target device's power."""
 408         self.wreg(rIOPINS2,0x00);
 409     def reset_host(self):
 410         """Resets the chip into host mode."""
 411         self.wreg(rUSBCTL,bmCHIPRES); #Stop the oscillator.
 412         self.wreg(rUSBCTL,0x00);      #restart it.
 413         while self.rreg(rUSBIRQ)&bmOSCOKIRQ:
 414             #Hang until the PLL stabilizes.
 415             pass;
 416
 417 class GoodFETMAXUSBHost(GoodFETMAXUSB):
 418     """This is a class for implemented a minimal USB host.
 419     It's intended for fuzzing, rather than for daily use."""
 420     def hostinit(self):
 421         """Initialize the MAX3421 as a USB Host."""
 422         self.usb_connect();
 423         self.wreg(rPINCTL,(bmFDUPSPI|bmPOSINT));
 424         self.reset_host();
 425         self.vbus_off();
 426         time.sleep(0.2);
 427         self.vbus_on();
 428
 429         #self.hostrun();
 430     def hostrun(self):
 431         """Run as a minimal host and dump the config tables."""
 432         while 1:
 433             self.detect_device();
 434             time.sleep(0.2);
 435             self.enumerate_device();
 436             self.wait_for_disconnect();
 437     def detect_device(self):
 438         """Waits for a device to be inserted and then returns."""
 439         busstate=0;
 440
 441         #Activate host mode and turn on 15K pulldown resistors on D+ and D-.
 442         self.wreg(rMODE,(bmDPPULLDN|bmDMPULLDN|bmHOST));
 443         #Clear connection detect IRQ.
 444         self.wreg(rHIRQ,bmCONDETIRQ);
 445
 446         print "Waiting for a device connection.";
 447         while busstate==0:
 448             self.wreg(rHCTL,bmSAMPLEBUS); #Update JSTATUS and KSTATUS bits.
 449             busstate=self.rreg(rHRSL) & (bmJSTATUS|bmKSTATUS);
 450
 451         if busstate==bmJSTATUS:
 452             print "Detected Full-Speed Device.";
 453             self.wreg(rMODE,(bmDPPULLDN|bmDMPULLDN|bmHOST|bmSOFKAENAB));
 454         elif busstate==bmKSTATUS:
 455             print "Detected Low-Speed Device.";
 456             self.wreg(rMODE,(bmDPPULLDN|bmDMPULLDN|bmHOST|bmLOWSPEED|bmSOFKAENAB));
 457         else:
 458             print "Not sure whether this is Full-Speed or Low-Speed.  Please investigate.";
 459     def wait_for_disconnect(self):
 460         """Wait for a device to be disconnected."""
 461         print "Waiting for a device disconnect.";
 462
 463         self.wreg(rHIRQ,bmCONDETIRQ); #Clear disconnect IRQ
 464         while not (self.rreg(rHIRQ) & bmCONDETIRQ):
 465             #Wait for IRQ to change.
 466             pass;
 467
 468         #Turn off markers.
 469         self.wreg(rMODE,bmDPPULLDN|bmDMPULLDN|bmHOST);
 470         print "Device disconnected.";
 471         self.wreg(rIOPINS2,(self.rreg(rIOPINS2) & ~0x04)); #HL1_OFF
 472         self.wreg(rIOPINS1,(self.rreg(rIOPINS1) & ~0x02)); #HL4_OFF
 473
 474     def enumerate_device(self):
 475         """Enumerates a device on the present port."""
 476
 477         Set_Address_to_7 = [0x00,0x05,0x07,0x00,0x00,0x00,0x00,0x00];
 478         Get_Descriptor_Device = [0x80,0x06,0x00,0x01,0x00,0x00,0x00,0x00]; #len filled in
 479         Get_Descriptor_Config = [0x80,0x06,0x00,0x02,0x00,0x00,0x00,0x00];
 480
 481
 482         print "Issuing USB bus reset.";
 483         self.wreg(rHCTL,bmBUSRST);
 484         while self.rreg(rHCTL) & bmBUSRST:
 485             #Wait for reset to complete.
 486             pass;
 487
 488         time.sleep(0.2);
 489
 490         #Get the device descriptor.
 491         self.wreg(rPERADDR,0); #First request to address 0.
 492         self.maxPacketSize=8; #Only safe value for first check.
 493         Get_Descriptor_Device[6]=8; # wLengthL
 494         Get_Descriptor_Device[7]=0; # wLengthH
 495
 496         print "Fetching 8 bytes of Device Descriptor.";
 497         self.ctl_read(Get_Descriptor_Device); # Get device descriptor into self.xfrdata;
 498         self.maxPacketSize=self.xfrdata[7];
 499         print "EP0 maxPacketSize is %02i bytes." % self.maxPacketSize;
 500
 501         # Issue another USB bus reset
 502         print "Resetting the bus again."
 503         self.wreg(rHCTL,bmBUSRST);
 504         while self.rreg(rHCTL) & bmBUSRST:
 505             #Wait for reset to complete.
 506             pass;
 507         time.sleep(0.2);
 508
 509         # Set_Address to 7 (Note: this request goes to address 0, already set in PERADDR register).
 510         print "Setting address to 0x07";
 511         HR = self.ctl_write_nd(Set_Address_to_7);   # CTL-Write, no data stage
 512         #if(print_error(HR)) return;
 513
 514         time.sleep(0.002);           # Device gets 2 msec recovery time
 515         self.wreg(rPERADDR,7);       # now all transfers go to addr 7
 516
 517
 518         #Get the device descriptor at the assigned address.
 519         Get_Descriptor_Device[6]=0x12; #Fill in real descriptor length.
 520         print "Fetching Device Descriptor."
 521         self.ctl_read(Get_Descriptor_Device); #Result in self.xfrdata;
 522
 523         self.descriptor=self.xfrdata;
 524         self.VID        = self.xfrdata[8] + 256*self.xfrdata[9];
 525         self.PID        = self.xfrdata[10]+ 256*self.xfrdata[11];
 526         iMFG    = self.xfrdata[14];
 527         iPROD   = self.xfrdata[15];
 528         iSERIAL = self.xfrdata[16];
 529
 530         self.manufacturer=self.getDescriptorString(iMFG);
 531         self.product=self.getDescriptorString(iPROD);
 532         self.serial=self.getDescriptorString(iSERIAL);
 533
 534         self.printstrings();
 535
 536     def printstrings(self):
 537         print "Vendor  ID is %04x." % self.VID;
 538         print "Product ID is %04x." % self.PID;
 539         print "Manufacturer: %s" % self.manufacturer;
 540         print "Product:      %s" % self.product;
 541         print "Serial:       %s" % self.serial;
 542
 543     def getDescriptorString(self, index):
 544         """Grabs a string from the descriptor string table."""
 545         # Get_Descriptor-String template. Code fills in idx at str[2].
 546         Get_Descriptor_String = [0x80,0x06,index,0x03,0x00,0x00,0x40,0x00];
 547
 548         if index==0: return "MISSING STRING";
 549
 550         status=self.ctl_read(Get_Descriptor_String);
 551         if status: return None;
 552
 553         #Since we've got a string
 554         toret="";
 555         for c in self.xfrdata[2:len(self.xfrdata)]:
 556             if c>0: toret=toret+chr(c);
 557         return toret;
 558
 559 class GoodFETMAXUSBHID(GoodFETMAXUSB):
 560     """This is an example HID keyboard driver, loosely based on the
 561     MAX3420 examples."""
 562     def hidinit(self):
 563         """Initialize a USB HID device."""
 564         self.usb_disconnect();
 565         self.usb_connect();
 566
 567         self.hidrun();
 568
 569     def hidrun(self):
 570         """Main loop of the USB HID emulator."""
 571         print "Starting a HID device.  This won't return.";
 572         while 1:
 573             self.service_irqs();
 574     def do_SETUP(self):
 575         """Handle USB Enumeration"""
 576
 577         #Grab the SETUP packet from the buffer.
 578         SUD=self.readbytes(rSUDFIFO,8);
 579
 580         #Parse the SETUP packet
 581         print "Handling a setup packet of %s" % self.setup2str(SUD);
 582
 583         setuptype=(ord(SUD[bmRequestType])&0x60);
 584         if setuptype==0x00:
 585             self.std_request(SUD);
 586         elif setuptype==0x20:
 587             self.class_request(SUD);
 588         elif setuptype==0x40:
 589             self.vendor_request(SUD);
 590         else:
 591             print "Unknown request type 0x%02x." % ord(SUD[bmRequestType])
 592             self.STALL_EP0(SUD);
 593     def class_request(self,SUD):
 594         """Handle a class request."""
 595         print "Stalling a class request.";
 596         self.STALL_EP0(SUD);
 597     def vendor_request(self,SUD):
 598         print "Stalling a vendor request.";
 599         self.STALL_EP0(SUD);
 600     def std_request(self,SUD):
 601         """Handles a standard setup request."""
 602         setuptype=ord(SUD[bRequest]);
 603         if setuptype==SR_GET_DESCRIPTOR: self.send_descriptor(SUD);
 604         elif setuptype==SR_SET_FEATURE: self.feature(1);
 605         elif setuptype==SR_SET_CONFIGURATION: self.set_configuration(SUD);
 606         elif setuptype==SR_GET_STATUS: self.get_status(SUD);
 607         elif setuptype==SR_SET_ADDRESS: self.rregAS(rFNADDR);
 608         elif setuptype==SR_GET_INTERFACE: self.get_interface(SUD);
 609         else:
 610             print "Stalling Unknown standard setup request type %02x" % setuptype;
 611
 612             self.STALL_EP0(SUD);
 613
 614     def get_interface(self,SUD):
 615         """Handles a setup request for SR_GET_INTERFACE."""
 616         if ord(SUD[wIndexL]==0):
 617             self.wreg(rEP0FIFO,0);
 618             self.wregAS(rEP0BC,1);
 619         else:
 620             self.STALL_EP0(SUD);
 621
 622 #Device Descriptor
 623     DD=[0x12,                   # bLength = 18d
 624         0x01,                   # bDescriptorType = Device (1)
 625         0x00,0x01,              # bcdUSB(L/H) USB spec rev (BCD)
 626         0x00,0x00,0x00,         # bDeviceClass, bDeviceSubClass, bDeviceProtocol
 627         0x40,                   # bMaxPacketSize0 EP0 is 64 bytes
 628         0x6A,0x0B,              # idVendor(L/H)--Maxim is 0B6A
 629         0x46,0x53,              # idProduct(L/H)--5346
 630         0x34,0x12,              # bcdDevice--1234
 631         1,2,3,                  # iManufacturer, iProduct, iSerialNumber
 632         1];
 633 #Configuration Descriptor
 634     CD=[0x09,                   # bLength
 635         0x02,                   # bDescriptorType = Config
 636         0x22,0x00,              # wTotalLength(L/H) = 34 bytes
 637         0x01,                   # bNumInterfaces
 638         0x01,                   # bConfigValue
 639         0x00,                   # iConfiguration
 640         0xE0,                   # bmAttributes. b7=1 b6=self-powered b5=RWU supported
 641         0x01,                   # MaxPower is 2 ma
 642 # INTERFACE Descriptor
 643         0x09,                   # length = 9
 644         0x04,                   # type = IF
 645         0x00,                   # IF #0
 646         0x00,                   # bAlternate Setting
 647         0x01,                   # bNum Endpoints
 648         0x03,                   # bInterfaceClass = HID
 649         0x00,0x00,              # bInterfaceSubClass, bInterfaceProtocol
 650         0x00,                   # iInterface
 651 # HID Descriptor--It's at CD[18]
 652         0x09,                   # bLength
 653         0x21,                   # bDescriptorType = HID
 654         0x10,0x01,              # bcdHID(L/H) Rev 1.1
 655         0x00,                   # bCountryCode (none)
 656         0x01,                   # bNumDescriptors (one report descriptor)
 657         0x22,                   # bDescriptorType       (report)
 658         43,0,                   # CD[25]: wDescriptorLength(L/H) (report descriptor size is 43 bytes)
 659 # Endpoint Descriptor
 660         0x07,                   # bLength
 661         0x05,                   # bDescriptorType (Endpoint)
 662         0x83,                   # bEndpointAddress (EP3-IN)
 663         0x03,                   # bmAttributes  (interrupt)
 664         64,0,                   # wMaxPacketSize (64)
 665         10];
 666     strDesc=[
 667 # STRING descriptor 0--Language string
 668 "\x04\x03\x09\x04",
 669 # [
 670 #         0x04,                 # bLength
 671 #       0x03,                   # bDescriptorType = string
 672 #       0x09,0x04               # wLANGID(L/H) = English-United Sates
 673 # ],
 674 # STRING descriptor 1--Manufacturer ID
 675 "\x0c\x03M\x00a\x00x\x00i\x00m\x00",
 676 # [
 677 #         12,                   # bLength
 678 #       0x03,                   # bDescriptorType = string
 679 #       'M',0,'a',0,'x',0,'i',0,'m',0 # text in Unicode
 680 # ],
 681 # STRING descriptor 2 - Product ID
 682 "\x18\x03M\x00A\x00X\x003\x004\x002\x000\x00E\x00 \x00E\x00n\x00u\x00m\x00 \x00C\x00o\x00d\x00e\x00",
 683 # [     24,                     # bLength
 684 #       0x03,                   # bDescriptorType = string
 685 #       'M',0,'A',0,'X',0,'3',0,'4',0,'2',0,'0',0,'E',0,' ',0,
 686 #         'E',0,'n',0,'u',0,'m',0,' ',0,'C',0,'o',0,'d',0,'e',0
 687 # ],
 688
 689
 690 # STRING descriptor 3 - Serial Number ID
 691 "\x14\x03S\x00/\x00N\x00 \x003\x004\x002\x000\x00E\x00"
 692 # [       20,                   # bLength
 693 #       0x03,                   # bDescriptorType = string
 694 #       'S',0,
 695 #       '/',0,
 696 #       'N',0,
 697 #       ' ',0,
 698 #       '3',0,
 699 #       '4',0,
 700 #       '2',0,
 701 #       '0',0,
 702 #         'E',0,
 703 # ]
 704 ];
 705     RepD=[
 706         0x05,0x01,              # Usage Page (generic desktop)
 707         0x09,0x06,              # Usage (keyboard)
 708         0xA1,0x01,              # Collection
 709         0x05,0x07,              #   Usage Page 7 (keyboard/keypad)
 710         0x19,0xE0,              #   Usage Minimum = 224
 711         0x29,0xE7,              #   Usage Maximum = 231
 712         0x15,0x00,              #   Logical Minimum = 0
 713         0x25,0x01,              #   Logical Maximum = 1
 714         0x75,0x01,              #   Report Size = 1
 715         0x95,0x08,              #   Report Count = 8
 716         0x81,0x02,              #  Input(Data,Variable,Absolute)
 717         0x95,0x01,              #   Report Count = 1
 718         0x75,0x08,              #   Report Size = 8
 719         0x81,0x01,              #  Input(Constant)
 720         0x19,0x00,              #   Usage Minimum = 0
 721         0x29,0x65,              #   Usage Maximum = 101
 722         0x15,0x00,              #   Logical Minimum = 0,
 723         0x25,0x65,              #   Logical Maximum = 101
 724         0x75,0x08,              #   Report Size = 8
 725         0x95,0x01,              #   Report Count = 1
 726         0x81,0x00,              #  Input(Data,Variable,Array)
 727         0xC0]
 728     def send_descriptor(self,SUD):
 729         """Send the USB descriptors based upon the setup data."""
 730         desclen=0;
 731         reqlen=ord(SUD[wLengthL])+256*ord(SUD[wLengthH]); #16-bit length
 732         desctype=ord(SUD[wValueH]);
 733
 734         if desctype==GD_DEVICE:
 735             desclen=self.DD[0];
 736             ddata=self.DD;
 737         elif desctype==GD_CONFIGURATION:
 738             desclen=self.CD[2];
 739             ddata=self.CD;
 740         elif desctype==GD_STRING:
 741             desclen=self.strDesc[ord(SUD[wValueL])][0];
 742             ddata=self.strDesc[ord(SUD[wValueL])];
 743         elif desctype==GD_REPORT:
 744             desclen=self.CD[25];
 745             ddata=self.RepD;
 746
 747         #TODO Configuration, String, Hid, and Report
 748
 749         if desclen>0:
 750             sendlen=min(reqlen,desclen);
 751             self.writebytes(rEP0FIFO,ddata);
 752             self.wregAS(rEP0BC,sendlen);
 753         else:
 754             print "Stalling in send_descriptor() for lack of handler for %02x." % desctype;
 755             self.STALL_EP0(SUD);
 756     def set_configuration(self,SUD):
 757         """Set the configuration."""
 758         bmSUSPIE=0x10;
 759         configval=ord(SUD[wValueL]);
 760         if(configval>0):
 761             self.SETBIT(rUSBIEN,bmSUSPIE);
 762         self.rregAS(rFNADDR);
 763     def get_status(self,SUD):
 764         """Get the USB Setup Status."""
 765         testbyte=ord(SUD[bmRequestType])
 766
 767         #Toward Device
 768         if testbyte==0x80:
 769             self.wreg(rEP0FIFO,0x03); #Enable RWU and self-powered
 770             self.wreg(rEP0FIFO,0x00); #Second byte is always zero.
 771             self.wregAS(rEP0BC,2);    #Load byte count, arm transfer, and ack CTL.
 772         #Toward Interface
 773         elif testbyte==0x81:
 774             self.wreg(rEP0FIFO,0x00);
 775             self.wreg(rEP0FIFO,0x00); #Second byte is always zero.
 776             self.wregAS(rEP0BC,2);
 777         #Toward Endpoint
 778         elif testbyte==0x82:
 779             if(ord(SUD[wIndexL])==0x83):
 780                 self.wreg(rEP0FIFO,0x01); #Stall EP3
 781                 self.wreg(rEP0FIFO,0x00); #Second byte is always zero.
 782                 self.wregAS(rEP0BC,2);
 783             else:
 784                 self.STALL_EP0(SUD);
 785         else:
 786             self.STALL_EP0(SUD);
 787     def service_irqs(self):
 788         """Handle USB interrupt events."""
 789
 790         epirq=self.rreg(rEPIRQ);
 791         usbirq=self.rreg(rUSBIRQ);
 792
 793         #Are we being asked for setup data?
 794         if(epirq&bmSUDAVIRQ): #Setup Data Requested
 795             self.wreg(rEPIRQ,bmSUDAVIRQ); #Clear the bit
 796             self.do_SETUP();
 797         if(epirq&bmIN3BAVIRQ): #EN3-IN packet
 798             self.do_IN3();
 799
 800
 801     typephase=0;
 802     typestring="                      Python does USB HID!";
 803     typepos=0;
 804
 805     def asc2hid(self,ascii):
 806         """Translate ASCII to an USB keycode."""
 807         a=ascii;
 808         if a>='a' and a<='z':
 809             return ord(a)-ord('a')+4;
 810         elif a>='A' and a<='Z':
 811             return ord(a)-ord('A')+4;
 812         elif a==' ':
 813             return 0x2C; #space
 814         else:
 815             return 0; #key-up
 816     def type_IN3(self):
 817         """Type next letter in buffer."""
 818         if self.typepos>=len(self.typestring):
 819             self.typeletter(0);
 820         elif self.typephase==0:
 821             self.typephase=1;
 822             self.typeletter(0);
 823         else:
 824             typephase=0;
 825             self.typeletter(self.typestring[self.typepos]);
 826             self.typepos=self.typepos+1;
 827         return;
 828     def typeletter(self,key):
 829         """Type a letter on IN3.  Zero for keyup."""
 830         #if type(key)==str: key=ord(key);
 831         #Send a key-up.
 832         self.wreg(rEP3INFIFO,0);
 833         self.wreg(rEP3INFIFO,0);
 834         self.wreg(rEP3INFIFO,self.asc2hid(key));
 835         self.wreg(rEP3INBC,3);
 836     def do_IN3(self):
 837         """Handle IN3 event."""
 838         #Don't bother clearing interrupt flag, that's done by sending the reply.
 839         self.type_IN3();
 840