3 #GoodFET SPI Flash Client
11 from GoodFETNRF import GoodFETNRF;
12 from intelhex import IntelHex;
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",
19 "RX_PW_P0","RX_PW_P1","RX_PW_P2","RX_PW_P3","RX_PW_P4","RX_PW_P5",
21 "?","?","?","DYNPD","FEATURE","AGC_CONFIG","?","?",
22 "?","?","?","?","?","?","?","?"];
24 def printpacket(packet):
29 if i>client.packetlen: break;
30 s="%s %02x" % (s,ord(foo));
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();
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];
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];
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];
59 print "%s sniffskybrake\n\tSniffs skybrake. [broken?]" % sys.argv[0];
60 print "%s sniffmskb\n\tSniffs MS KB. [broken?]" % sys.argv[0];
63 print "%s hosttp\n\tHosts Turning Point Clicker traffic." % sys.argv[0];
65 print "%s carrier [freq]\n\tHolds a carrier on [freq] Hz." % sys.argv[0];
68 #Initialize FET and set baud rate
74 if(sys.argv[1]=="info"):
77 if(sys.argv[1]=="test"):
78 print "Old registers:"
81 # Set PWR_UP=1 and PRIM_RX=0 in CONFIG.
83 #Delay of 1.5ms by round-trip.
88 for foo in [250*10**3,
91 client.RF_setrate(foo);
92 if(client.RF_getrate()!=foo):
93 print "ERROR Rate %i not supported. Got %i instead." % (foo,
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:"
104 if(sys.argv[1]=="carrier"):
106 client.RF_setfreq(eval(sys.argv[2]));
109 print "\nHolding a carrier wave.";
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]);
119 if(sys.argv[1]=="peek"):
122 start=int(sys.argv[2],16);
125 stop=int(sys.argv[3],16);
126 print "Peeking from %02x to %02x." % (start,stop);
128 print "%02x: %010x" % (start,client.peek(start));
130 if(sys.argv[1]=="poke"):
134 start=int(sys.argv[2],16);
136 val=int(sys.argv[3],16);
137 print "Poking %02x to become %010x." % (start,val);
139 client.poke(start,val);
140 print "Poked to %04x" % client.peek(start);
142 if(sys.argv[1]=="sniffob"):
143 #Reversal of transmitter code from nRF_CMD.c of OpenBeacon
144 #TODO remove all poke() calls.
146 client.poke(0x00,0x00); #Stop nRF
147 client.poke(0x01,0x00); #Disable Shockburst
148 client.poke(0x02,0x01); #Set RX Pipe 0
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
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);
161 #Set packet length of 16.
162 client.RF_setpacketlen(16);
164 #Power radio, prime for RX, one-byte checksum.
165 client.poke(0x00,0x70|0x03|0x08); #0x08 for one byte, 0x04 for two.
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.
174 packet=client.RF_rxpacket();
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):
183 #Which bits can be set?
186 #Which bits can be clear?
188 zeroes=client.peek(r);
189 regbits[r]=(ones & (~zeroes));
190 for r in range(0,0x30):
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.
197 client.poke(0x00,0x00); #Stop nRF
198 client.poke(0x01,0x00); #Disable Shockburst
199 client.poke(0x02,0x01); #Set RX Pipe 0
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
205 #OpenBeacon defines these in little endian as follows.
206 client.RF_setmaclen(2); # SETUP_AW for shortest
208 #It's better to have a known fragment, when one is available.
209 #client.RF_setsmac(0x00AA);
210 #client.RF_setsmac(0x0055);
212 #Should end in 55 or AA depending upon the packet.
215 tail=int(sys.argv[2],16);
217 print "Please specify a tail of 0xAA or 0x55.";
219 client.RF_setsmac(tail);
222 client.RF_setpacketlen(32);
224 #Power radio, prime for RX, no checksum
225 client.poke(0x00,0x70|0x03); #0x08 for checksum, 0x04 for two.
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.
234 packet=client.RF_rxpacket();
239 """This guesses addresses by searching through packets."""
243 #Limits on search space, because you usually know what you're looking for.
247 def init(self,goodfet,
248 rate=True,chan=True,sync=True):
249 """Initializes a link to the GoodFET for autotuning."""
255 def packetaddr(self,packet):
256 """Returns a loaded packet address, including channel and rate."""
258 sync=self.client.RF_getsmac()&0xFF;
263 mac="%s%02x" % (mac,ord(packet[i]));
264 ch=self.client.peek(0x05);
265 rate=self.client.peek(0x06);
266 return "%02x,%s,%02x,%02x" % (
268 def validmac(self,packet):
269 sync=self.client.RF_getsmac()&0xFF;
270 if (ord(packet[0])&0x80)^(sync&0x80):
271 #print "%02x%02x invalid entry." % (sync,ord(packet[0]));
275 def handle(self,packet):
276 """Handles a packet."""
277 #printpacket(packet);
278 if not self.validmac(packet):
279 #print "Dropped packet:";
280 #printpacket(packet);
282 addr=self.packetaddr(packet);
284 #Increment the address count.
287 count=self.addresses[addr];
290 self.addresses[addr]=count+1;
291 rate=count*1.0/len(self.addresses);
292 if self.addresses[addr]>1 or rate>0.01:
293 print "'%s' looks valid\t%i\t%0.5f" % (
298 """Tunes to another channel or preamble looking for the next packet."""
299 count=self.tunecount;
300 self.tunecount=count+1;
302 #Swap the SYNC value most often.
307 self.client.RF_setsmac(sync);
314 #This swaps between 1Mbps and 2Mbps.
315 #TODO add support for 256kbps, if anyone uses it.
318 #print "Setting rate to 0x%02x" % rate;
321 self.client.poke(0x06,rate);
325 self.client.poke(0x05,
327 print "Tuned to %i MHz" % (
328 self.client.RF_getfreq()
330 #Grab two packets to clear buffers.
331 #Should retune only after a few packets to reduce this delay.
332 packet=client.RF_rxpacket();
333 packet=client.RF_rxpacket();
337 if(sys.argv[1]=="autotune"):
338 #Reversal of transmitter code from nRF_CMD.c of OpenBeacon
339 #TODO remove all poke() calls.
341 guesser.init(client,rate=False,sync=False,chan=True);
343 client.poke(0x00,0x00); #Stop nRF
344 client.poke(0x01,0x00); #Disable Shockburst
345 client.poke(0x02,0x01); #Set RX Pipe 0
347 #client.RF_setfreq(2481 * 10**6);
348 #client.poke(0x06,0x09); #2MBps, -18dBm in RF_SETUP
349 client.poke(0x07,0x78); #Reset status register
351 #OpenBeacon defines these in little endian as follows.
352 client.RF_setmaclen(2); # SETUP_AW for shortest
354 #This is determined by the MAC, which we don't yet know.
355 #AutoTuner() takes care of finding it.
356 #client.RF_setsmac(0x00AA);
357 #client.RF_setsmac(0x0055);
360 client.RF_setpacketlen(32);
362 #Power radio, prime for RX, no checksum
363 client.poke(0x00,0x70|0x03); #0x08 for checksum, 0x04 for two.
365 print "Autotuning as %010x on %i MHz" % (client.RF_getsmac(),
366 client.RF_getfreq()/10**6);
367 print "sync,mac,r5,r6";
368 #Now we're ready to get packets.
370 #Full second on each packet.
371 start=time.mktime(time.localtime());
372 while (time.mktime(time.localtime())-start) < 5:
375 packet=client.RF_rxpacket();
376 guesser.handle(packet);
381 if(sys.argv[1]=="sniffmskb"):
383 #TODO remove all poke() calls.
385 client.poke(0x00,0x00); #Stop nRF
386 client.poke(0x01,0x00); #Disable Shockburst
387 client.poke(0x02,0x01); #Set RX Pipe 0
389 client.poke(0x06,0x09); #2MBps, -18dBm in RF_SETUP
390 client.poke(0x07,0x78); #Reset status register
392 #This is the address of a specific keyboard.
393 #Other keyboards will be different.
396 client.RF_setmaclen(2);
398 #Known pairs. The channel and the low address bytes must match.
399 #client.RF_setfreq((2400+0x13) * 10**6);
400 #client.RF_setsmac(0x0c00a3598cd);
402 client.RF_setfreq((2400+0x15) * 10**6);
403 client.RF_setsmac( 0x0c10446facd);
405 #Mac packet length, illegally 0-length address field.
406 client.RF_setpacketlen(32);
408 #Power radio, prime for RX, no checksum
409 client.poke(0x00,0x70|0x03); #0x08 for checksum, 0x04 for two.
411 print "Listening as %010x on %i MHz" % (client.RF_getsmac(),
412 client.RF_getfreq()/10**6);
413 #Now we're ready to get packets.
418 packet=client.RF_rxpacket();
424 if(sys.argv[1]=="sniffskybrake"):
425 #Reversal of transmitter code from nRF_CMD.c of OpenBeacon
426 #TODO remove all poke() calls.
428 client.poke(0x00,0x00); #Stop nRF
429 client.poke(0x01,0x00); #Disable Shockburst
430 client.poke(0x02,0x01); #Set RX Pipe 0
432 client.RF_setfreq(2439 * 10**6);
433 client.poke(0x06,0x00); #1MBps
434 client.poke(0x07,0x78); #Reset status register
436 #OpenBeacon defines these in little endian as follows.
437 client.RF_setmaclen(2); # SETUP_AW for 3-byte addresses.
438 #0x01, 0x02, 0x03, 0x02, 0x01
440 client.RF_setsmac(0x070700d2c4); #reversed
442 #client.RF_setsmac(0xd2c4);
443 #client.RF_setsmac(0);
445 #Mac packet length, illegally 0-length address field.
446 client.RF_setpacketlen(32);
448 #Power radio, prime for RX, one-byte checksum.
449 client.poke(0x00,0x70|0x03); #0x08 for one byte, 0x04 for two.
451 print "Listening as %010x on %i MHz" % (client.RF_getsmac(),
452 client.RF_getfreq()/10**6);
453 print "%i byte mac match." % client.RF_getmaclen();
454 #Now we're ready to get packets.
459 packet=client.RF_rxpacket();
463 if(sys.argv[1]=="sniffsf"):
464 #Reversal of transmitter code from nRF_CMD.c of OpenBeacon
465 #TODO remove all poke() calls.
467 client.poke(0x00,0x00); #Stop nRF
468 client.poke(0x01,0x00); #Disable Shockburst
469 client.poke(0x02,0x01); #Set RX Pipe 0
471 client.RF_setfreq(2402 * 10**6);
472 client.poke(0x06,0x07); #1Mbps
473 client.poke(0x07,0x78); #Reset status register
475 #OpenBeacon defines these in little endian as follows.
476 client.RF_setmaclen(5); # SETUP_AW for 5-byte addresses.
477 client.RF_setsmac(0xe7e7e7e7e7);
478 client.RF_settmac(0xe7e7e7e7e7);
480 #Set packet length of 16.
481 client.RF_setpacketlen(4);
483 #Power radio, prime for RX, one-byte checksum.
484 client.poke(0x00,0x70|0x03|0x08); #0x08 for one byte, 0x04 for two.
486 print "Listening as %010x on %i MHz" % (client.RF_getsmac(),
487 client.RF_getfreq()/10**6);
488 #Now we're ready to get packets.
493 packet=client.RF_rxpacket();
497 if(sys.argv[1]=="snifftp"):
498 client.poke(0x00,0x00); #Stop nRF
499 client.poke(0x01,0x00); #Disable Shockburst
500 client.poke(0x02,0x01); #Set RX Pipe 0
502 client.RF_setfreq((2400+0x29) * 10**6);
503 client.poke(0x06,0x00); #1Mbps
504 client.poke(0x07,0x78); #Reset status register
506 client.RF_setmaclen(3); # SETUP_AW for 3-byte addresses.
507 client.RF_setsmac(0x123456);
508 client.RF_setpacketlen(4);
510 #Power radio, prime for RX, two-byte checksum.
511 client.poke(0x00,0x70|0x03|0x04|0x08);
513 print "Listening as %010x on %i MHz" % (client.RF_getsmac(),
514 client.RF_getfreq()/10**6);
515 #Now we're ready to get packets.
520 packet=client.RF_rxpacket();
524 if(sys.argv[1]=="hosttp"):
525 client.poke(0x00,0x00); #Stop nRF
526 client.poke(0x01,0x00); #Disable Shockburst
527 client.poke(0x02,0x01); #Set RX Pipe 0
531 client.RF_setfreq((2400+chan) * 10**6);
532 client.poke(0x06,0x00); #1Mbps
533 client.poke(0x07,0x78); #Reset status register
535 client.RF_setmaclen(3); # SETUP_AW for 3-byte addresses.
536 client.RF_setsmac(0x123456);
537 client.RF_setpacketlen(4);
539 #Power radio, prime for RX, two-byte checksum.
540 client.poke(0x00,0x70|0x03|0x04|0x08);
542 print "Listening as %010x on %i MHz" % (client.RF_getsmac(),
543 client.RF_getfreq()/10**6);
544 #Now we're ready to get packets.
548 packet=client.RF_rxpacket();
549 mac=((ord(packet[0])<<16)+
553 print "%c from %06x" % (key,mac);
556 if(sys.argv[1]=="sniff"):
557 #client.poke(0x00,0x00); #Stop nRF
558 client.poke(0x07,0x78); #Reset status register
560 #Power radio, prime for RX, checksum.
561 client.poke(0x00,0x70|0x03|0x08);
563 print "Listening as %010x on %i MHz" % (client.RF_getsmac(),
564 client.RF_getfreq()/10**6);
565 #Now we're ready to get packets.
571 packet=client.RF_rxpacket();
574 if(sys.argv[1]=="explore"):
575 #client.poke(0x00,0x00); #Stop nRF
576 client.poke(0x07,0x78); #Reset status register
578 #Power radio, prime for RX, no checksum.
579 client.poke(0x00,0x70|0x03);
581 #Set packet length of 32.
582 #Without checksums, extra data will mix in.
583 client.RF_setpacketlen(32);
584 client.RF_setmaclen(3); # shortest address length
586 #Now we're ready to get packets.
587 for smac in [0x0102030201, 0]:
588 client.RF_setsmac(smac);
589 for chan in range(0,0x80):
590 client.RF_setfreq((2400+chan) * 10**6);
592 packet=client.RF_rxpacket();
594 print "Listening as %010x on %i MHz" % (client.RF_getsmac(),
595 client.RF_getfreq()/10**6);