MSKB and Skybrake support.
[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
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 snifftp\n\tSniffs SparkFun Dongle traffic." % sys.argv[0];
55     
56     print "%s sniffprom\n\tSniffs promiscuously." % sys.argv[0];
57     print "%s sniffskybrake\n\tSniffs skybrake. [broken?]" % sys.argv[0];
58     print "%s sniffmskb\n\tSniffs MS KB. [broken?]" % sys.argv[0];
59     
60     
61     print "%s hosttp\n\tHosts Turning Point Clicker traffic." % sys.argv[0];
62
63     print "%s carrier [freq]\n\tHolds a carrier on [freq] Hz." % sys.argv[0];
64     sys.exit();
65
66 #Initialize FET and set baud rate
67 client=GoodFETNRF();
68 client.serInit()
69
70 client.NRFsetup();
71
72 if(sys.argv[1]=="info"):
73     printconfig();
74
75 if(sys.argv[1]=="test"):
76     print "Old registers:"
77     printconfig();
78     
79     # Set PWR_UP=1 and PRIM_RX=0 in CONFIG.
80     client.poke(0x00,2);
81     #Delay of 1.5ms by round-trip.
82     
83     print "\n\n";
84     
85     #Try all data rates
86     for foo in [250*10**3,
87                 1*10**6,
88                 2*10**6]:
89         client.RF_setrate(foo);
90         if(client.RF_getrate()!=foo):
91             print "ERROR Rate %i not supported.  Got %i instead." % (foo,
92                                                                      client.RF_getrate());
93     
94     print "\n\n";
95     client.poke(0x0A,0xDEADBEEF,5);
96     #print "SMAC set to %010x" % client.RF_getsmac();
97     if client.RF_getsmac()!=0xdeadbeef:
98         print "ERROR: Failed to set MAC address.";
99     print "Final registers:"
100     printconfig();
101     
102 if(sys.argv[1]=="carrier"):
103     if len(sys.argv)>2:
104         client.RF_setfreq(eval(sys.argv[2]));
105     client.RF_carrier();
106     printconfig();
107     print "\nHolding a carrier wave.";
108     while(1):
109         time.sleep(1);
110 if(sys.argv[1]=="regs"):
111     for r in range(0,0x20):
112         print "r[0x%02x]=0x%010x //%16s " % (r,client.peek(r),regnames[r]);
113 if(sys.argv[1]=="pyregs"):
114     for r in range(0,0x20):
115         print "client.set(0x%02x,0x%010x); #%16s " % (r,client.peek(r),regnames[r]);
116
117 if(sys.argv[1]=="peek"):
118     start=0x0000;
119     if(len(sys.argv)>2):
120         start=int(sys.argv[2],16);
121     stop=start;
122     if(len(sys.argv)>3):
123         stop=int(sys.argv[3],16);
124     print "Peeking from %02x to %02x." % (start,stop);
125     while start<=stop:
126         print "%02x: %010x" % (start,client.peek(start));
127         start=start+1;
128 if(sys.argv[1]=="poke"):
129     start=0x0000;
130     val=0x00;
131     if(len(sys.argv)>2):
132         start=int(sys.argv[2],16);
133     if(len(sys.argv)>3):
134         val=int(sys.argv[3],16);
135     print "Poking %02x to become %010x." % (start,val);
136     
137     client.poke(start,val);
138     print "Poked to %04x" % client.peek(start);
139
140 if(sys.argv[1]=="sniffob"):
141     #Reversal of transmitter code from nRF_CMD.c of OpenBeacon
142     #TODO remove all poke() calls.
143     
144     client.poke(0x00,0x00); #Stop nRF
145     client.poke(0x01,0x00); #Disable Shockburst
146     client.poke(0x02,0x01); #Set RX Pipe 0
147     
148     client.RF_setfreq(2481 * 10**6);
149     client.poke(0x06,0x09); #2MBps, -18dBm in RF_SETUP
150     client.poke(0x07,0x78); #Reset status register
151     
152     #OpenBeacon defines these in little endian as follows.
153     client.RF_setmaclen(5); # SETUP_AW for 5-byte addresses.
154     #0x01, 0x02, 0x03, 0x02, 0x01
155     client.RF_setsmac(0x0102030201);
156     #'O', 'C', 'A', 'E', 'B'
157     client.RF_settmac(0x424541434F);
158     
159     #Set packet length of 16.
160     client.RF_setpacketlen(16);
161     
162     #Power radio, prime for RX, one-byte checksum.
163     client.poke(0x00,0x70|0x03|0x08); #0x08 for one byte, 0x04 for two.
164     
165     print "Listening as %010x on %i MHz" % (client.RF_getsmac(),
166                                            client.RF_getfreq()/10**6);
167     #Now we're ready to get packets.
168     while 1:
169         packet=None;
170         while packet==None:
171             #time.sleep(0.1);
172             packet=client.RF_rxpacket();
173         printpacket(packet);
174         sys.stdout.flush();
175
176 if(sys.argv[1]=="regbits"):
177     print "Scanning registers to determine which bits are valid."
178     regbits=range(0,0x30);
179     for r in range(0,0x30):
180         old=client.peek(r);
181         #Which bits can be set?
182         client.poke(r,0xFF);
183         ones=client.peek(r);
184         #Which bits can be clear?
185         client.poke(r,0x00);
186         zeroes=client.peek(r);
187         regbits[r]=(ones & (~zeroes));
188     for r in range(0,0x30):
189         if regbits[r]!=0:
190             print "r[0x%02x] masked %02x // %s" % (r,regbits[r], regnames[r]);
191 if(sys.argv[1]=="sniffprom"):
192     #Reversal of transmitter code from nRF_CMD.c of OpenBeacon
193     #TODO remove all poke() calls.
194     
195     client.poke(0x00,0x00); #Stop nRF
196     client.poke(0x01,0x00); #Disable Shockburst
197     client.poke(0x02,0x01); #Set RX Pipe 0
198     
199     client.RF_setfreq(2481 * 10**6);
200     client.poke(0x06,0x09); #2MBps, -18dBm in RF_SETUP
201     client.poke(0x07,0x78); #Reset status register
202     
203     #OpenBeacon defines these in little endian as follows.
204     client.RF_setmaclen(5); # SETUP_AW for 3-byte addresses.
205     #0x01, 0x02, 0x03, 0x02, 0x01
206     #client.RF_setsmac(0x0102030201);
207     #client.RF_setsmac(0x0000000201);
208     client.RF_setsmac(0x0102);
209     #'O', 'C', 'A', 'E', 'B'
210     #client.RF_settmac(0x424541434F);
211     
212     #Mac packet length, illegally 0-length address field.
213     client.RF_setpacketlen(32);
214     client.poke(0x03,0);
215     
216     #Power radio, prime for RX, one-byte checksum.
217     client.poke(0x00,0x70|0x03); #0x08 for one byte, 0x04 for two.
218     
219     print "Listening as %010x on %i MHz" % (client.RF_getsmac(),
220                                            client.RF_getfreq()/10**6);
221     #Now we're ready to get packets.
222     while 1:
223         packet=None;
224         while packet==None:
225             #time.sleep(0.1);
226             packet=client.RF_rxpacket();
227         printpacket(packet);
228         sys.stdout.flush();
229
230 if(sys.argv[1]=="sniffmskb"):
231     #MSWK 3000 v2.0
232     #TODO remove all poke() calls.
233     
234     client.poke(0x00,0x00); #Stop nRF
235     client.poke(0x01,0x00); #Disable Shockburst
236     client.poke(0x02,0x01); #Set RX Pipe 0
237     
238     client.poke(0x06,0x09); #2MBps, -18dBm in RF_SETUP
239     client.poke(0x07,0x78); #Reset status register
240     
241     #This is the address of a specific keyboard.
242     #Other keyboards will be different.
243     
244     
245     client.RF_setmaclen(2);
246     
247     #Known pairs.  The channel and the low address bytes must match.
248     #client.RF_setfreq((2400+0x13) * 10**6);
249     #client.RF_setsmac(0x0c00a3598cd);
250     
251     client.RF_setfreq((2400+0x15) * 10**6);
252     client.RF_setsmac( 0x0c10446facd);
253     
254     #Mac packet length, illegally 0-length address field.
255     client.RF_setpacketlen(32);
256     
257     #Power radio, prime for RX, no checksum
258     client.poke(0x00,0x70|0x03); #0x08 for checksum, 0x04 for two.
259     
260     print "Listening as %010x on %i MHz" % (client.RF_getsmac(),
261                                            client.RF_getfreq()/10**6);
262     #Now we're ready to get packets.
263     while 1:
264         packet=None;
265         while packet==None:
266             #time.sleep(0.1);
267             packet=client.RF_rxpacket();
268         printpacket(packet);
269         sys.stdout.flush();
270
271
272
273 if(sys.argv[1]=="sniffskybrake"):
274     #Reversal of transmitter code from nRF_CMD.c of OpenBeacon
275     #TODO remove all poke() calls.
276     
277     client.poke(0x00,0x00); #Stop nRF
278     client.poke(0x01,0x00); #Disable Shockburst
279     client.poke(0x02,0x01); #Set RX Pipe 0
280     
281     client.RF_setfreq(2439 * 10**6);
282     client.poke(0x06,0x00); #1MBps
283     client.poke(0x07,0x78); #Reset status register
284     
285     #OpenBeacon defines these in little endian as follows.
286     client.RF_setmaclen(2); # SETUP_AW for 3-byte addresses.
287     #0x01, 0x02, 0x03, 0x02, 0x01
288     
289     client.RF_setsmac(0x070700d2c4); #reversed
290     
291     #client.RF_setsmac(0xd2c4);
292     #client.RF_setsmac(0);
293     
294     #Mac packet length, illegally 0-length address field.
295     client.RF_setpacketlen(32);
296     
297     #Power radio, prime for RX, one-byte checksum.
298     client.poke(0x00,0x70|0x03); #0x08 for one byte, 0x04 for two.
299     
300     print "Listening as %010x on %i MHz" % (client.RF_getsmac(),
301                                            client.RF_getfreq()/10**6);
302     print "%i byte mac match." % client.RF_getmaclen();
303     #Now we're ready to get packets.
304     while 1:
305         packet=None;
306         while packet==None:
307             #time.sleep(0.1);
308             packet=client.RF_rxpacket();
309         printpacket(packet);
310         sys.stdout.flush();
311
312 if(sys.argv[1]=="sniffsf"):
313     #Reversal of transmitter code from nRF_CMD.c of OpenBeacon
314     #TODO remove all poke() calls.
315     
316     client.poke(0x00,0x00); #Stop nRF
317     client.poke(0x01,0x00); #Disable Shockburst
318     client.poke(0x02,0x01); #Set RX Pipe 0
319     
320     client.RF_setfreq(2402 * 10**6);
321     client.poke(0x06,0x07); #1Mbps
322     client.poke(0x07,0x78); #Reset status register
323     
324     #OpenBeacon defines these in little endian as follows.
325     client.RF_setmaclen(5); # SETUP_AW for 5-byte addresses.
326     #0x01, 0x02, 0x03, 0x02, 0x01
327     client.RF_setsmac(0xe7e7e7e7e7);
328     #'O', 'C', 'A', 'E', 'B'
329     client.RF_settmac(0xe7e7e7e7e7);
330     
331     #Set packet length of 16.
332     client.RF_setpacketlen(4);
333     
334     #Power radio, prime for RX, one-byte checksum.
335     client.poke(0x00,0x70|0x03|0x08); #0x08 for one byte, 0x04 for two.
336     
337     print "Listening as %010x on %i MHz" % (client.RF_getsmac(),
338                                            client.RF_getfreq()/10**6);
339     #Now we're ready to get packets.
340     while 1:
341         packet=None;
342         while packet==None:
343             #time.sleep(0.1);
344             packet=client.RF_rxpacket();
345         printpacket(packet);
346         sys.stdout.flush();
347
348 if(sys.argv[1]=="snifftp"):
349     client.poke(0x00,0x00); #Stop nRF
350     client.poke(0x01,0x00); #Disable Shockburst
351     client.poke(0x02,0x01); #Set RX Pipe 0
352     
353     client.RF_setfreq((2400+0x29) * 10**6);
354     client.poke(0x06,0x00); #1Mbps
355     client.poke(0x07,0x78); #Reset status register
356     
357     client.RF_setmaclen(3); # SETUP_AW for 3-byte addresses.
358     client.RF_setsmac(0x123456);
359     client.RF_setpacketlen(4);
360     
361     #Power radio, prime for RX, two-byte checksum.
362     client.poke(0x00,0x70|0x03|0x04|0x08);
363     
364     print "Listening as %010x on %i MHz" % (client.RF_getsmac(),
365                                            client.RF_getfreq()/10**6);
366     #Now we're ready to get packets.
367     while 1:
368         packet=None;
369         while packet==None:
370             #time.sleep(0.1);
371             packet=client.RF_rxpacket();
372         printpacket(packet);
373         sys.stdout.flush();
374
375 if(sys.argv[1]=="hosttp"):
376     client.poke(0x00,0x00); #Stop nRF
377     client.poke(0x01,0x00); #Disable Shockburst
378     client.poke(0x02,0x01); #Set RX Pipe 0
379     
380     chan=0x29;
381
382     client.RF_setfreq((2400+chan) * 10**6);
383     client.poke(0x06,0x00); #1Mbps
384     client.poke(0x07,0x78); #Reset status register
385     
386     client.RF_setmaclen(3); # SETUP_AW for 3-byte addresses.
387     client.RF_setsmac(0x123456);
388     client.RF_setpacketlen(4);
389     
390     #Power radio, prime for RX, two-byte checksum.
391     client.poke(0x00,0x70|0x03|0x04|0x08);
392     
393     print "Listening as %010x on %i MHz" % (client.RF_getsmac(),
394                                            client.RF_getfreq()/10**6);
395     #Now we're ready to get packets.
396     while 1:
397         packet=None;
398         while packet==None:
399             packet=client.RF_rxpacket();
400         mac=((ord(packet[0])<<16)+
401              (ord(packet[1])<<8)+
402              ord(packet[2]));
403         key=packet[3];
404         print "%c from %06x" % (key,mac);
405         sys.stdout.flush();
406
407 if(sys.argv[1]=="sniff"):
408     #client.poke(0x00,0x00); #Stop nRF
409     client.poke(0x07,0x78); #Reset status register
410     
411     #Power radio, prime for RX, checksum.
412     client.poke(0x00,0x70|0x03|0x08);
413     
414     print "Listening as %010x on %i MHz" % (client.RF_getsmac(),
415                                            client.RF_getfreq()/10**6);
416     #Now we're ready to get packets.
417     
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 if(sys.argv[1]=="explore"):
426     #client.poke(0x00,0x00); #Stop nRF
427     client.poke(0x07,0x78); #Reset status register
428     
429     #Power radio, prime for RX, no checksum.
430     client.poke(0x00,0x70|0x03);
431     
432     #Set packet length of 32.
433     #Without checksums, extra data will mix in.
434     client.RF_setpacketlen(32);
435     client.RF_setmaclen(3); # shortest address length
436     
437     #Now we're ready to get packets.
438     for smac in [0x0102030201, 0]:
439         client.RF_setsmac(smac);
440         for chan in range(0,0x80):
441             client.RF_setfreq((2400+chan) * 10**6);
442             time.sleep(1);
443             packet=client.RF_rxpacket();
444             if packet!=None:
445                 print "Listening as %010x on %i MHz" % (client.RF_getsmac(),
446                                                         client.RF_getfreq()/10**6);
447                 printpacket(packet);
448                 sys.stdout.flush();