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