2e88a6f34aa507fc0c8205d1fa98841ed6d15e14
[goodfet] / 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 AddressGuesser():
239     """This guesses addresses by searching through packets."""
240     #packets=[];
241     addresses={};
242     def packetaddr(self,packet):
243         s="";
244         for i in range(0,5):
245             s="%s%02x" % (s,ord(packet[i]));
246         return s;
247     def handle(self,packet):
248         #printpacket(packet);
249         #self.packets.append(packet);
250         addr=self.packetaddr(packet);
251         
252         #Increment the address.
253         count=0;
254         try:
255             count=self.addresses[addr];
256         except:
257             pass;
258         self.addresses[addr]=count+1;
259         rate=count*1.0/len(self.addresses);
260         if self.addresses[addr]>1:
261             print "'%s' looks valid, %0.5f" % (
262                 addr,rate);
263         return;
264         
265 if(sys.argv[1]=="autotune"):
266     #Reversal of transmitter code from nRF_CMD.c of OpenBeacon
267     #TODO remove all poke() calls.
268     guesser=AddressGuesser();
269     
270     client.poke(0x00,0x00); #Stop nRF
271     client.poke(0x01,0x00); #Disable Shockburst
272     client.poke(0x02,0x01); #Set RX Pipe 0
273     
274     #client.RF_setfreq(2481 * 10**6);
275     #client.poke(0x06,0x09); #2MBps, -18dBm in RF_SETUP
276     client.poke(0x07,0x78); #Reset status register
277     
278     #OpenBeacon defines these in little endian as follows.
279     client.RF_setmaclen(2); # SETUP_AW for shortest
280     
281     #It's better to have a known fragment, when one is available.
282     #client.RF_setsmac(0x00AA);
283     #client.RF_setsmac(0x0055);
284     
285     #Should end in 55 or AA depending upon the packet.
286     tail=0x55
287     if(len(sys.argv)>2):
288         tail=int(sys.argv[2],16);
289     else:
290         print "Please specify a tail of 0xAA or 0x55.";
291         sys.exit(1);
292     client.RF_setsmac(tail);
293     
294     #Longest length.
295     client.RF_setpacketlen(32);
296     
297     #Power radio, prime for RX, no checksum
298     client.poke(0x00,0x70|0x03); #0x08 for checksum, 0x04 for two.
299     
300     print "Listening as %010x on %i MHz" % (client.RF_getsmac(),
301                                            client.RF_getfreq()/10**6);
302     #Now we're ready to get packets.
303     while 1:
304         packet=None;
305         while packet==None:
306             packet=client.RF_rxpacket();
307         guesser.handle(packet);
308         sys.stdout.flush();
309
310 if(sys.argv[1]=="sniffmskb"):
311     #MSWK 3000 v2.0
312     #TODO remove all poke() calls.
313     
314     client.poke(0x00,0x00); #Stop nRF
315     client.poke(0x01,0x00); #Disable Shockburst
316     client.poke(0x02,0x01); #Set RX Pipe 0
317     
318     client.poke(0x06,0x09); #2MBps, -18dBm in RF_SETUP
319     client.poke(0x07,0x78); #Reset status register
320     
321     #This is the address of a specific keyboard.
322     #Other keyboards will be different.
323     
324     
325     client.RF_setmaclen(2);
326     
327     #Known pairs.  The channel and the low address bytes must match.
328     #client.RF_setfreq((2400+0x13) * 10**6);
329     #client.RF_setsmac(0x0c00a3598cd);
330     
331     client.RF_setfreq((2400+0x15) * 10**6);
332     client.RF_setsmac( 0x0c10446facd);
333     
334     #Mac packet length, illegally 0-length address field.
335     client.RF_setpacketlen(32);
336     
337     #Power radio, prime for RX, no checksum
338     client.poke(0x00,0x70|0x03); #0x08 for checksum, 0x04 for two.
339     
340     print "Listening as %010x on %i MHz" % (client.RF_getsmac(),
341                                            client.RF_getfreq()/10**6);
342     #Now we're ready to get packets.
343     while 1:
344         packet=None;
345         while packet==None:
346             #time.sleep(0.1);
347             packet=client.RF_rxpacket();
348         printpacket(packet);
349         sys.stdout.flush();
350
351
352
353 if(sys.argv[1]=="sniffskybrake"):
354     #Reversal of transmitter code from nRF_CMD.c of OpenBeacon
355     #TODO remove all poke() calls.
356     
357     client.poke(0x00,0x00); #Stop nRF
358     client.poke(0x01,0x00); #Disable Shockburst
359     client.poke(0x02,0x01); #Set RX Pipe 0
360     
361     client.RF_setfreq(2439 * 10**6);
362     client.poke(0x06,0x00); #1MBps
363     client.poke(0x07,0x78); #Reset status register
364     
365     #OpenBeacon defines these in little endian as follows.
366     client.RF_setmaclen(2); # SETUP_AW for 3-byte addresses.
367     #0x01, 0x02, 0x03, 0x02, 0x01
368     
369     client.RF_setsmac(0x070700d2c4); #reversed
370     
371     #client.RF_setsmac(0xd2c4);
372     #client.RF_setsmac(0);
373     
374     #Mac packet length, illegally 0-length address field.
375     client.RF_setpacketlen(32);
376     
377     #Power radio, prime for RX, one-byte checksum.
378     client.poke(0x00,0x70|0x03); #0x08 for one byte, 0x04 for two.
379     
380     print "Listening as %010x on %i MHz" % (client.RF_getsmac(),
381                                            client.RF_getfreq()/10**6);
382     print "%i byte mac match." % client.RF_getmaclen();
383     #Now we're ready to get packets.
384     while 1:
385         packet=None;
386         while packet==None:
387             #time.sleep(0.1);
388             packet=client.RF_rxpacket();
389         printpacket(packet);
390         sys.stdout.flush();
391
392 if(sys.argv[1]=="sniffsf"):
393     #Reversal of transmitter code from nRF_CMD.c of OpenBeacon
394     #TODO remove all poke() calls.
395     
396     client.poke(0x00,0x00); #Stop nRF
397     client.poke(0x01,0x00); #Disable Shockburst
398     client.poke(0x02,0x01); #Set RX Pipe 0
399     
400     client.RF_setfreq(2402 * 10**6);
401     client.poke(0x06,0x07); #1Mbps
402     client.poke(0x07,0x78); #Reset status register
403     
404     #OpenBeacon defines these in little endian as follows.
405     client.RF_setmaclen(5); # SETUP_AW for 5-byte addresses.
406     client.RF_setsmac(0xe7e7e7e7e7);
407     client.RF_settmac(0xe7e7e7e7e7);
408     
409     #Set packet length of 16.
410     client.RF_setpacketlen(4);
411     
412     #Power radio, prime for RX, one-byte checksum.
413     client.poke(0x00,0x70|0x03|0x08); #0x08 for one byte, 0x04 for two.
414     
415     print "Listening as %010x on %i MHz" % (client.RF_getsmac(),
416                                            client.RF_getfreq()/10**6);
417     #Now we're ready to get packets.
418     while 1:
419         packet=None;
420         while packet==None:
421             #time.sleep(0.1);
422             packet=client.RF_rxpacket();
423         printpacket(packet);
424         sys.stdout.flush();
425
426 if(sys.argv[1]=="snifftp"):
427     client.poke(0x00,0x00); #Stop nRF
428     client.poke(0x01,0x00); #Disable Shockburst
429     client.poke(0x02,0x01); #Set RX Pipe 0
430     
431     client.RF_setfreq((2400+0x29) * 10**6);
432     client.poke(0x06,0x00); #1Mbps
433     client.poke(0x07,0x78); #Reset status register
434     
435     client.RF_setmaclen(3); # SETUP_AW for 3-byte addresses.
436     client.RF_setsmac(0x123456);
437     client.RF_setpacketlen(4);
438     
439     #Power radio, prime for RX, two-byte checksum.
440     client.poke(0x00,0x70|0x03|0x04|0x08);
441     
442     print "Listening as %010x on %i MHz" % (client.RF_getsmac(),
443                                            client.RF_getfreq()/10**6);
444     #Now we're ready to get packets.
445     while 1:
446         packet=None;
447         while packet==None:
448             #time.sleep(0.1);
449             packet=client.RF_rxpacket();
450         printpacket(packet);
451         sys.stdout.flush();
452
453 if(sys.argv[1]=="hosttp"):
454     client.poke(0x00,0x00); #Stop nRF
455     client.poke(0x01,0x00); #Disable Shockburst
456     client.poke(0x02,0x01); #Set RX Pipe 0
457     
458     chan=0x29;
459
460     client.RF_setfreq((2400+chan) * 10**6);
461     client.poke(0x06,0x00); #1Mbps
462     client.poke(0x07,0x78); #Reset status register
463     
464     client.RF_setmaclen(3); # SETUP_AW for 3-byte addresses.
465     client.RF_setsmac(0x123456);
466     client.RF_setpacketlen(4);
467     
468     #Power radio, prime for RX, two-byte checksum.
469     client.poke(0x00,0x70|0x03|0x04|0x08);
470     
471     print "Listening as %010x on %i MHz" % (client.RF_getsmac(),
472                                            client.RF_getfreq()/10**6);
473     #Now we're ready to get packets.
474     while 1:
475         packet=None;
476         while packet==None:
477             packet=client.RF_rxpacket();
478         mac=((ord(packet[0])<<16)+
479              (ord(packet[1])<<8)+
480              ord(packet[2]));
481         key=packet[3];
482         print "%c from %06x" % (key,mac);
483         sys.stdout.flush();
484
485 if(sys.argv[1]=="sniff"):
486     #client.poke(0x00,0x00); #Stop nRF
487     client.poke(0x07,0x78); #Reset status register
488     
489     #Power radio, prime for RX, checksum.
490     client.poke(0x00,0x70|0x03|0x08);
491     
492     print "Listening as %010x on %i MHz" % (client.RF_getsmac(),
493                                            client.RF_getfreq()/10**6);
494     #Now we're ready to get packets.
495     
496     while 1:
497         packet=None;
498         while packet==None:
499             #time.sleep(0.1);
500             packet=client.RF_rxpacket();
501         printpacket(packet);
502         sys.stdout.flush();
503 if(sys.argv[1]=="explore"):
504     #client.poke(0x00,0x00); #Stop nRF
505     client.poke(0x07,0x78); #Reset status register
506     
507     #Power radio, prime for RX, no checksum.
508     client.poke(0x00,0x70|0x03);
509     
510     #Set packet length of 32.
511     #Without checksums, extra data will mix in.
512     client.RF_setpacketlen(32);
513     client.RF_setmaclen(3); # shortest address length
514     
515     #Now we're ready to get packets.
516     for smac in [0x0102030201, 0]:
517         client.RF_setsmac(smac);
518         for chan in range(0,0x80):
519             client.RF_setfreq((2400+chan) * 10**6);
520             time.sleep(1);
521             packet=client.RF_rxpacket();
522             if packet!=None:
523                 print "Listening as %010x on %i MHz" % (client.RF_getsmac(),
524                                                         client.RF_getfreq()/10**6);
525                 printpacket(packet);
526                 sys.stdout.flush();