git.rot13.org Git - goodfet/blob - client/goodfet.nrf

   1 #!/usr/bin/env python
   2
   3 #GoodFET SPI Flash Client
   4 #by Travis Goodspeed
   5
   6 import sys;
   7 import binascii;
   8 import array;
   9 import time;
  10
  11 from GoodFETNRF import GoodFETNRF;
  12 from intelhex import IntelHex;
  13
  14
  15 regnames=["CONFIG","EN_AA","EN_RXADDR","SETUP_AW","SETUP_RET",
  16           "RF_CH","RF_SETUP","STATUS","OBSERVE_TX","RPD",
  17           "RX_ADDR_P0","RX_ADDR_P1","RX_ADDR_P2","RX_ADDR_P3","RX_ADDR_P4","RX_ADDR_P5",
  18           "TX_ADDR",
  19           "RX_PW_P0","RX_PW_P1","RX_PW_P2","RX_PW_P3","RX_PW_P4","RX_PW_P5",
  20           "FIFO_STATUS","?",
  21           "?","?","?","DYNPD","FEATURE","AGC_CONFIG","?","?",
  22           "?","?","?","?","?","?","?","?"];
  23
  24 def printpacket(packet):
  25     s="";
  26     i=0;
  27     for foo in packet:
  28         i=i+1;
  29         if i>client.packetlen: break;
  30         s="%s %02x" % (s,ord(foo));
  31     print "%s" % s;
  32
  33 def printconfig():
  34     print "Encoding %s" % client.RF_getenc();
  35     print "Freq    %10i MHz" % (client.RF_getfreq()/10**6);
  36     print "Rate    %10i kbps" % (client.RF_getrate()/1000);
  37     print "PacketLen %02i bytes" % client.RF_getpacketlen();
  38     #print "MacLen    %2i bytes" % client.RF_getmaclen();
  39     print "SMAC  0x%010x" % client.RF_getsmac();
  40     print "TMAC  0x%010x" % client.RF_gettmac();
  41
  42
  43 if(len(sys.argv)==1):
  44     print "Usage: %s verb [objects]\n" % sys.argv[0];
  45     print "%s info" % sys.argv[0];
  46     print "%s test" % sys.argv[0];
  47     print "%s regs" % sys.argv[0];
  48     print "%s regbits" % sys.argv[0];
  49     print "%s pyregs" % sys.argv[0];
  50     print "";
  51     print "%s sniff\n\tSniffs packets by current config." % sys.argv[0];
  52     print "%s sniffob\n\tSniffs OpenBeacon traffic." % sys.argv[0];
  53     print "%s snifftp\n\tSniffs Turning Point Clicker traffic." % sys.argv[0];
  54     print "%s sniffsf\n\tSniffs SparkFun Dongle traffic." % sys.argv[0];
  55     print "";
  56     print "%s sniffprom [0xaa|0x55]\n\tSniffs promiscuously for a preamble of 0xAA or 0x55" % sys.argv[0];
  57     print "%s autotune\n\tSearches for a valid destination address." % sys.argv[0];
  58     print "";
  59     print "%s sniffskybrake\n\tSniffs skybrake. [broken?]" % sys.argv[0];
  60     print "%s sniffmskb\n\tSniffs MS KB. [broken?]" % sys.argv[0];
  61
  62
  63     print "%s hosttp\n\tHosts Turning Point Clicker traffic." % sys.argv[0];
  64
  65     print "%s carrier [freq]\n\tHolds a carrier on [freq] Hz." % sys.argv[0];
  66     sys.exit();
  67
  68 #Initialize FET and set baud rate
  69 client=GoodFETNRF();
  70 client.serInit()
  71
  72 client.NRFsetup();
  73
  74 if(sys.argv[1]=="info"):
  75     printconfig();
  76
  77 if(sys.argv[1]=="test"):
  78     print "Old registers:"
  79     printconfig();
  80
  81     # Set PWR_UP=1 and PRIM_RX=0 in CONFIG.
  82     client.poke(0x00,2);
  83     #Delay of 1.5ms by round-trip.
  84
  85     print "\n\n";
  86
  87     #Try all data rates
  88     for foo in [250*10**3,
  89                 1*10**6,
  90                 2*10**6]:
  91         client.RF_setrate(foo);
  92         if(client.RF_getrate()!=foo):
  93             print "ERROR Rate %i not supported.  Got %i instead." % (foo,
  94                                                                      client.RF_getrate());
  95
  96     print "\n\n";
  97     client.poke(0x0A,0xDEADBEEF,5);
  98     #print "SMAC set to %010x" % client.RF_getsmac();
  99     if client.RF_getsmac()!=0xdeadbeef:
 100         print "ERROR: Failed to set MAC address.";
 101     print "Final registers:"
 102     printconfig();
 103
 104 if(sys.argv[1]=="carrier"):
 105     if len(sys.argv)>2:
 106         client.RF_setfreq(eval(sys.argv[2]));
 107     client.RF_carrier();
 108     printconfig();
 109     print "\nHolding a carrier wave.";
 110     while(1):
 111         time.sleep(1);
 112 if(sys.argv[1]=="regs"):
 113     for r in range(0,0x20):
 114         print "r[0x%02x]=0x%010x //%16s " % (r,client.peek(r),regnames[r]);
 115 if(sys.argv[1]=="pyregs"):
 116     for r in range(0,0x20):
 117         print "client.set(0x%02x,0x%010x); #%16s " % (r,client.peek(r),regnames[r]);
 118
 119 if(sys.argv[1]=="peek"):
 120     start=0x0000;
 121     if(len(sys.argv)>2):
 122         start=int(sys.argv[2],16);
 123     stop=start;
 124     if(len(sys.argv)>3):
 125         stop=int(sys.argv[3],16);
 126     print "Peeking from %02x to %02x." % (start,stop);
 127     while start<=stop:
 128         print "%02x: %010x" % (start,client.peek(start));
 129         start=start+1;
 130 if(sys.argv[1]=="poke"):
 131     start=0x0000;
 132     val=0x00;
 133     if(len(sys.argv)>2):
 134         start=int(sys.argv[2],16);
 135     if(len(sys.argv)>3):
 136         val=int(sys.argv[3],16);
 137     print "Poking %02x to become %010x." % (start,val);
 138
 139     client.poke(start,val);
 140     print "Poked to %04x" % client.peek(start);
 141
 142 if(sys.argv[1]=="sniffob"):
 143     #Reversal of transmitter code from nRF_CMD.c of OpenBeacon
 144     #TODO remove all poke() calls.
 145
 146     client.poke(0x00,0x00); #Stop nRF
 147     client.poke(0x01,0x00); #Disable Shockburst
 148     client.poke(0x02,0x01); #Set RX Pipe 0
 149
 150     client.RF_setfreq(2481 * 10**6);
 151     client.poke(0x06,0x09); #2MBps, -18dBm in RF_SETUP
 152     client.poke(0x07,0x78); #Reset status register
 153
 154     #OpenBeacon defines these in little endian as follows.
 155     client.RF_setmaclen(5); # SETUP_AW for 5-byte addresses.
 156     #0x01, 0x02, 0x03, 0x02, 0x01
 157     client.RF_setsmac(0x0102030201);
 158     #'O', 'C', 'A', 'E', 'B'
 159     client.RF_settmac(0x424541434F);
 160
 161     #Set packet length of 16.
 162     client.RF_setpacketlen(16);
 163
 164     #Power radio, prime for RX, one-byte checksum.
 165     client.poke(0x00,0x70|0x03|0x08); #0x08 for one byte, 0x04 for two.
 166
 167     print "Listening as %010x on %i MHz" % (client.RF_getsmac(),
 168                                            client.RF_getfreq()/10**6);
 169     #Now we're ready to get packets.
 170     while 1:
 171         packet=None;
 172         while packet==None:
 173             #time.sleep(0.1);
 174             packet=client.RF_rxpacket();
 175         printpacket(packet);
 176         sys.stdout.flush();
 177
 178 if(sys.argv[1]=="regbits"):
 179     print "Scanning registers to determine which bits are valid."
 180     regbits=range(0,0x30);
 181     for r in range(0,0x30):
 182         old=client.peek(r);
 183         #Which bits can be set?
 184         client.poke(r,0xFF);
 185         ones=client.peek(r);
 186         #Which bits can be clear?
 187         client.poke(r,0x00);
 188         zeroes=client.peek(r);
 189         regbits[r]=(ones & (~zeroes));
 190     for r in range(0,0x30):
 191         if regbits[r]!=0:
 192             print "r[0x%02x] masked %02x // %s" % (r,regbits[r], regnames[r]);
 193 if(sys.argv[1]=="sniffprom"):
 194     #Reversal of transmitter code from nRF_CMD.c of OpenBeacon
 195     #TODO remove all poke() calls.
 196
 197     client.poke(0x00,0x00); #Stop nRF
 198     client.poke(0x01,0x00); #Disable Shockburst
 199     client.poke(0x02,0x01); #Set RX Pipe 0
 200
 201     #client.RF_setfreq(2481 * 10**6);
 202     #client.poke(0x06,0x09); #2MBps, -18dBm in RF_SETUP
 203     client.poke(0x07,0x78); #Reset status register
 204
 205     #OpenBeacon defines these in little endian as follows.
 206     client.RF_setmaclen(2); # SETUP_AW for shortest
 207
 208     #It's better to have a known fragment, when one is available.
 209     #client.RF_setsmac(0x00AA);
 210     #client.RF_setsmac(0x0055);
 211
 212     #Should end in 55 or AA depending upon the packet.
 213     tail=0x55
 214     if(len(sys.argv)>2):
 215         tail=int(sys.argv[2],16);
 216     else:
 217         print "Please specify a tail of 0xAA or 0x55.";
 218         sys.exit(1);
 219     client.RF_setsmac(tail);
 220
 221     #Longest length.
 222     client.RF_setpacketlen(32);
 223
 224     #Power radio, prime for RX, no checksum
 225     client.poke(0x00,0x70|0x03); #0x08 for checksum, 0x04 for two.
 226
 227     print "Listening as %010x on %i MHz" % (client.RF_getsmac(),
 228                                            client.RF_getfreq()/10**6);
 229     #Now we're ready to get packets.
 230     while 1:
 231         packet=None;
 232         while packet==None:
 233             #time.sleep(0.1);
 234             packet=client.RF_rxpacket();
 235         printpacket(packet);
 236         sys.stdout.flush();
 237
 238 class AutoTuner():
 239     """This guesses addresses by searching through packets."""
 240     addresses={};
 241     client=None;
 242
 243     #Limits on search space, because you usually know what you're looking for.
 244     rate=False;
 245     chan=False;
 246     sync=False;
 247     def init(self,goodfet,
 248              rate=True,chan=True,sync=True):
 249         """Initializes a link to the GoodFET for autotuning."""
 250         self.client=goodfet;
 251         self.rate=rate;
 252         self.chan=chan;
 253         self.sync=sync;
 254         return;
 255     def packetaddr(self,packet,justmac=False):
 256         """Returns a loaded packet address, including channel and rate."""
 257
 258         sync=self.client.RF_getsmac()&0xFF;
 259
 260         mac="";
 261         #MAC,RF_CH,RATE
 262         for i in range(0,5):
 263             mac="%s%02x" % (mac,ord(packet[i]));
 264         if justmac:
 265             return mac;
 266         ch=self.client.peek(0x05);
 267         rate=self.client.peek(0x06);
 268         return "%02x,%s,%02x,%02x" % (
 269             sync,mac,ch,rate);
 270     def validmac(self,packet):
 271         sync=self.client.RF_getsmac()&0xFF;
 272         mac=self.packetaddr(packet,justmac=True);
 273         if (ord(packet[0])&0x80)^(sync&0x80):
 274             #print "%02x%02x invalid entry." % (sync,ord(packet[0]));
 275             return False;
 276         if mac=='5555555555' or mac=='aaaaaaaaaa':
 277             return False;
 278         return True;
 279
 280     def handle(self,packet):
 281         """Handles a packet."""
 282         #printpacket(packet);
 283         if not self.validmac(packet):
 284             #print "Dropped packet:";
 285             #printpacket(packet);
 286             return;
 287         addr=self.packetaddr(packet);
 288
 289         #Increment the address count.
 290         count=0;
 291         try:
 292             count=self.addresses[addr];
 293         except:
 294             pass;
 295         self.addresses[addr]=count+1;
 296         rate=count*1.0/len(self.addresses);
 297         if self.addresses[addr]>1 or rate>0.01:
 298             print "'%s' looks valid\t%i\t%0.5f" % (
 299                 addr,count,rate);
 300         return;
 301     tunecount=0;
 302     def retune(self):
 303         """Tunes to another channel or preamble looking for the next packet."""
 304         count=self.tunecount;
 305         self.tunecount=count+1;
 306
 307         #Swap the SYNC value most often.
 308         if self.sync:
 309             sync=0xAA;
 310             if count&1:
 311                 sync=0x55;
 312             self.client.RF_setsmac(sync);
 313             count=(count>>1);
 314
 315         if self.rate:
 316             #Then the data rate.
 317             rate=0;
 318
 319             #This swaps between 1Mbps and 2Mbps.
 320             #TODO add support for 256kbps, if anyone uses it.
 321             if count&1:
 322                 rate=rate|0x08;
 323             #print "Setting rate to 0x%02x" % rate;
 324             if(rate==0x20):
 325                 rate=0x08;
 326             self.client.poke(0x06,rate);
 327             count=(count>>1);
 328
 329         if self.chan:
 330             self.client.poke(0x05,
 331                              (count+16)&0x7f);
 332             print "Tuned to %i MHz" % (
 333                 self.client.RF_getfreq()
 334                 /(10**6));
 335         #Grab two packets to clear buffers.
 336         #Should retune only after a few packets to reduce this delay.
 337         packet=client.RF_rxpacket();
 338         packet=client.RF_rxpacket();
 339         return;
 340
 341
 342 if(sys.argv[1]=="autotune"):
 343     #Reversal of transmitter code from nRF_CMD.c of OpenBeacon
 344     #TODO remove all poke() calls.
 345     guesser=AutoTuner();
 346     guesser.init(client,rate=True,sync=True,chan=True);
 347
 348     client.poke(0x00,0x00); #Stop nRF
 349     client.poke(0x01,0x00); #Disable Shockburst
 350     client.poke(0x02,0x01); #Set RX Pipe 0
 351
 352     #client.RF_setfreq(2481 * 10**6);
 353     client.poke(0x06,0x09); #2MBps, -18dBm in RF_SETUP
 354     client.poke(0x07,0x78); #Reset status register
 355
 356     #OpenBeacon defines these in little endian as follows.
 357     client.RF_setmaclen(2); # SETUP_AW for shortest
 358
 359     #This is determined by the MAC, which we don't yet know.
 360     #AutoTuner() takes care of finding it.
 361     #client.RF_setsmac(0x00AA);
 362     #client.RF_setsmac(0x0055);
 363
 364     #Longest length.
 365     client.RF_setpacketlen(32);
 366
 367     #Power radio, prime for RX, no checksum
 368     client.poke(0x00,0x70|0x03); #0x08 for checksum, 0x04 for two.
 369
 370     print "Autotuning as %010x on %i MHz" % (client.RF_getsmac(),
 371                                            client.RF_getfreq()/10**6);
 372     print "sync,mac,r5,r6";
 373     #Now we're ready to get packets.
 374     while 1:
 375         #Full second on each packet.
 376         start=time.mktime(time.localtime());
 377         while (time.mktime(time.localtime())-start) < 5:
 378             packet=None;
 379             while packet==None:
 380                 packet=client.RF_rxpacket();
 381             guesser.handle(packet);
 382         #print "Retuning."
 383         guesser.retune();
 384         sys.stdout.flush();
 385
 386 if(sys.argv[1]=="sniffmskb"):
 387     #MSWK 3000 v2.0
 388     #TODO remove all poke() calls.
 389
 390     client.poke(0x00,0x00); #Stop nRF
 391     client.poke(0x01,0x00); #Disable Shockburst
 392     client.poke(0x02,0x01); #Set RX Pipe 0
 393
 394     client.poke(0x06,0x09); #2MBps, -18dBm in RF_SETUP
 395     client.poke(0x07,0x78); #Reset status register
 396
 397     #This is the address of a specific keyboard.
 398     #Other keyboards will be different.
 399
 400
 401     client.RF_setmaclen(5);
 402
 403     #Known pairs.  The channel and the low address bytes must match.
 404     #client.RF_setfreq((2400+0x13) * 10**6);
 405     #client.RF_setsmac(0x0c00a3598cd);
 406
 407     client.RF_setfreq((2400+0x15) * 10**6);
 408     client.RF_setsmac( 0x0c10446facd);
 409
 410     #Mac packet length, illegally 0-length address field.
 411     client.RF_setpacketlen(32);
 412
 413     #Power radio, prime for RX, no checksum
 414     client.poke(0x00,0x70|0x03); #0x08 for checksum, 0x04 for two.
 415
 416     print "Listening as %010x on %i MHz" % (client.RF_getsmac(),
 417                                            client.RF_getfreq()/10**6);
 418     #Now we're ready to get packets.
 419     while 1:
 420         packet=None;
 421         while packet==None:
 422             #time.sleep(0.1);
 423             packet=client.RF_rxpacket();
 424         printpacket(packet);
 425         sys.stdout.flush();
 426
 427
 428
 429 if(sys.argv[1]=="sniffskybrake"):
 430     #Reversal of transmitter code from nRF_CMD.c of OpenBeacon
 431     #TODO remove all poke() calls.
 432
 433     client.poke(0x00,0x00); #Stop nRF
 434     client.poke(0x01,0x00); #Disable Shockburst
 435     client.poke(0x02,0x01); #Set RX Pipe 0
 436
 437     client.RF_setfreq(2439 * 10**6);
 438     client.poke(0x06,0x00); #1MBps
 439     client.poke(0x07,0x78); #Reset status register
 440
 441     #OpenBeacon defines these in little endian as follows.
 442     client.RF_setmaclen(2); # SETUP_AW for 3-byte addresses.
 443     #0x01, 0x02, 0x03, 0x02, 0x01
 444
 445     client.RF_setsmac(0x070700d2c4); #reversed
 446
 447     #client.RF_setsmac(0xd2c4);
 448     #client.RF_setsmac(0);
 449
 450     #Mac packet length, illegally 0-length address field.
 451     client.RF_setpacketlen(32);
 452
 453     #Power radio, prime for RX, one-byte checksum.
 454     client.poke(0x00,0x70|0x03); #0x08 for one byte, 0x04 for two.
 455
 456     print "Listening as %010x on %i MHz" % (client.RF_getsmac(),
 457                                            client.RF_getfreq()/10**6);
 458     print "%i byte mac match." % client.RF_getmaclen();
 459     #Now we're ready to get packets.
 460     while 1:
 461         packet=None;
 462         while packet==None:
 463             #time.sleep(0.1);
 464             packet=client.RF_rxpacket();
 465         printpacket(packet);
 466         sys.stdout.flush();
 467
 468 if(sys.argv[1]=="sniffsf"):
 469     #Reversal of transmitter code from nRF_CMD.c of OpenBeacon
 470     #TODO remove all poke() calls.
 471
 472     client.poke(0x00,0x00); #Stop nRF
 473     client.poke(0x01,0x00); #Disable Shockburst
 474     client.poke(0x02,0x01); #Set RX Pipe 0
 475
 476     client.RF_setfreq(2402 * 10**6);
 477     client.poke(0x06,0x07); #1Mbps
 478     client.poke(0x07,0x78); #Reset status register
 479
 480     #OpenBeacon defines these in little endian as follows.
 481     client.RF_setmaclen(5); # SETUP_AW for 5-byte addresses.
 482     client.RF_setsmac(0xe7e7e7e7e7);
 483     client.RF_settmac(0xe7e7e7e7e7);
 484
 485     #Set packet length of 16.
 486     client.RF_setpacketlen(4);
 487
 488     #Power radio, prime for RX, one-byte checksum.
 489     client.poke(0x00,0x70|0x03|0x08); #0x08 for one byte, 0x04 for two.
 490
 491     print "Listening as %010x on %i MHz" % (client.RF_getsmac(),
 492                                            client.RF_getfreq()/10**6);
 493     #Now we're ready to get packets.
 494     while 1:
 495         packet=None;
 496         while packet==None:
 497             #time.sleep(0.1);
 498             packet=client.RF_rxpacket();
 499         printpacket(packet);
 500         sys.stdout.flush();
 501
 502 if(sys.argv[1]=="snifftp"):
 503     client.poke(0x00,0x00); #Stop nRF
 504     client.poke(0x01,0x00); #Disable Shockburst
 505     client.poke(0x02,0x01); #Set RX Pipe 0
 506
 507     client.RF_setfreq((2400+0x29) * 10**6);
 508     client.poke(0x06,0x00); #1Mbps
 509     client.poke(0x07,0x78); #Reset status register
 510
 511     client.RF_setmaclen(3); # SETUP_AW for 3-byte addresses.
 512     client.RF_setsmac(0x123456);
 513     client.RF_setpacketlen(4);
 514
 515     #Power radio, prime for RX, two-byte checksum.
 516     client.poke(0x00,0x70|0x03|0x04|0x08);
 517
 518     print "Listening as %010x on %i MHz" % (client.RF_getsmac(),
 519                                            client.RF_getfreq()/10**6);
 520     #Now we're ready to get packets.
 521     while 1:
 522         packet=None;
 523         while packet==None:
 524             #time.sleep(0.1);
 525             packet=client.RF_rxpacket();
 526         printpacket(packet);
 527         sys.stdout.flush();
 528
 529 if(sys.argv[1]=="hosttp"):
 530     client.poke(0x00,0x00); #Stop nRF
 531     client.poke(0x01,0x00); #Disable Shockburst
 532     client.poke(0x02,0x01); #Set RX Pipe 0
 533
 534     chan=0x29;
 535
 536     client.RF_setfreq((2400+chan) * 10**6);
 537     client.poke(0x06,0x00); #1Mbps
 538     client.poke(0x07,0x78); #Reset status register
 539
 540     client.RF_setmaclen(3); # SETUP_AW for 3-byte addresses.
 541     client.RF_setsmac(0x123456);
 542     client.RF_setpacketlen(4);
 543
 544     #Power radio, prime for RX, two-byte checksum.
 545     client.poke(0x00,0x70|0x03|0x04|0x08);
 546
 547     print "Listening as %010x on %i MHz" % (client.RF_getsmac(),
 548                                            client.RF_getfreq()/10**6);
 549     #Now we're ready to get packets.
 550     while 1:
 551         packet=None;
 552         while packet==None:
 553             packet=client.RF_rxpacket();
 554         mac=((ord(packet[0])<<16)+
 555              (ord(packet[1])<<8)+
 556              ord(packet[2]));
 557         key=packet[3];
 558         print "%c from %06x" % (key,mac);
 559         sys.stdout.flush();
 560
 561 if(sys.argv[1]=="sniff"):
 562     #client.poke(0x00,0x00); #Stop nRF
 563     client.poke(0x07,0x78); #Reset status register
 564
 565     #Power radio, prime for RX, no checksum.
 566     client.poke(0x00,0x70|0x03);
 567     #Mac packet length.
 568     client.RF_setpacketlen(32);
 569     #Mac length, reduced
 570     client.RF_setmaclen(3); # SETUP_AW for shortest
 571
 572     print "Listening as %010x on %i MHz" % (client.RF_getsmac(),
 573                                            client.RF_getfreq()/10**6);
 574     #Now we're ready to get packets.
 575
 576     while 1:
 577         packet=None;
 578         while packet==None:
 579             #time.sleep(0.1);
 580             packet=client.RF_rxpacket();
 581         printpacket(packet);
 582         sys.stdout.flush();
 583 if(sys.argv[1]=="explore"):
 584     #client.poke(0x00,0x00); #Stop nRF
 585     client.poke(0x07,0x78); #Reset status register
 586
 587     #Power radio, prime for RX, no checksum.
 588     client.poke(0x00,0x70|0x03);
 589
 590     #Set packet length of 32.
 591     #Without checksums, extra data will mix in.
 592     client.RF_setpacketlen(32);
 593     client.RF_setmaclen(3); # shortest address length
 594
 595     #Now we're ready to get packets.
 596     for smac in [0x0102030201, 0]:
 597         client.RF_setsmac(smac);
 598         for chan in range(0,0x80):
 599             client.RF_setfreq((2400+chan) * 10**6);
 600             time.sleep(1);
 601             packet=client.RF_rxpacket();
 602             if packet!=None:
 603                 print "Listening as %010x on %i MHz" % (client.RF_getsmac(),
 604                                                         client.RF_getfreq()/10**6);
 605                 printpacket(packet);
 606                 sys.stdout.flush();