3b787d549ed537532df652f28ba68c123de09886
[goodfet] / client / GoodFETCCSPI.py
1 #!/usr/bin/env python
2 # GoodFET Chipcon RF Radio Client
3
4 # (C) 2009, 2012 Travis Goodspeed <travis at radiantmachines.com>
5 #
6 # This code is being rewritten and refactored.  You've been warned!
7
8 import sys, time, string, cStringIO, struct, glob, os;
9
10 from GoodFET import GoodFET;
11
12 class GoodFETCCSPI(GoodFET):
13     CCSPIAPP=0x51;
14     CCversions={0x233d: "CC2420",
15                 }
16     def setup(self):
17         """Move the FET into the CCSPI application."""
18         self.writecmd(self.CCSPIAPP,0x10,0,self.data); #CCSPI/SETUP
19         
20         #Set up the radio for ZigBee
21         self.strobe(0x01);       #SXOSCON
22         self.strobe(0x02);       #SCAL
23         self.poke(0x11, 0x0AC2 & (~0x0800)); #MDMCTRL0, promiscuous
24         self.poke(0x12, 0x0500); #MDMCTRL1
25         self.poke(0x1C, 0x007F); #IOCFG0
26         self.poke(0x19, 0x01C4); #SECCTRL0, disabling crypto
27         #self.poke(0x19, 0x0204); #SECCTRL0, as seen elsewhere.
28         #self.RF_setsync();
29         
30     def ident(self):
31         return self.peek(0x1E); #MANFIDL
32     def identstr(self):
33         manfidl=self.peek(0x1E);
34         #manfidh=self.peek(0x1f);
35         try:
36             return "%s" % (self.CCversions[manfidl]); 
37         except:
38             return "Unknown0x%04x" % manfidl;
39     def trans8(self,byte):
40         """Read and write 8 bits by CCSPI."""
41         data=self.CCSPItrans([byte]);
42         return ord(data[0]);
43     
44     def trans(self,data):
45         """Exchange data by CCSPI."""
46         self.data=data;
47         self.writecmd(self.CCSPIAPP,0x00,len(data),data);
48         return self.data;
49     def strobe(self,reg=0x00):
50         """Strobes a strobe register, returning the status."""
51         data=[reg];
52         self.trans(data);
53         return ord(self.data[0]);
54     def CC_RFST_IDLE(self):
55         """Switch the radio to idle mode, clearing overflows and errors."""
56         self.strobe(0x06); #SRXOFF
57     def CC_RFST_TX(self):
58         """Switch the radio to TX mode."""
59         self.strobe(0x04);  #0x05 for CCA
60     def CC_RFST_RX(self):
61         """Switch the radio to RX mode."""
62         self.strobe(0x03); #RX ON
63     def CC_RFST_CAL(self):
64         """Calibrate strobe the radio."""
65         self.strobe(0x02); #RX Calibrate
66     def CC_RFST(self,state=0x00):
67         self.strobe(state);
68         return;
69     def peek(self,reg,bytes=2):
70         """Read a CCSPI Register.  For long regs, result is flipped."""
71         
72         #Reg is ORed with 0x40 by the GoodFET.
73         data=[reg,0,0];
74         
75         #Automatically calibrate the len.
76         bytes=2;
77         
78         self.writecmd(self.CCSPIAPP,0x02,len(data),data);
79         toret=(
80             ord(self.data[2])+
81             (ord(self.data[1])<<8)
82             );
83         return toret;
84     def poke(self,reg,val,bytes=2):
85         """Write a CCSPI Register."""
86         data=[reg,(val>>8)&0xFF,val&0xFF];
87         self.writecmd(self.CCSPIAPP,0x03,len(data),data);
88         if self.peek(reg,bytes)!=val and reg!=0x18:
89             print "Warning, failed to set r%02x=0x%04x, got %02x." %(
90                 reg,
91                 val,
92                 self.peek(reg,bytes));
93             return False;
94         return True;
95     
96     def status(self):
97         """Read the status byte."""
98         statusbits={0x80: "?",
99                     0x40: "XOSC16M_STABLE",
100                     0x20: "TX_UNDERFLOW",
101                     0x10: "ENC_BUSY",
102                     0x08: "TX_ACTIVE",
103                     0x04: "LOCK",
104                     0x02: "RSSI_VALID",
105                     0x01: "?"};
106         status=self.strobe(0x00);
107         i=1;
108         str="";
109         while i<0x100:
110             if status&i:
111                str="%s %s" % (statusbits[i],str);
112             i*=2;
113         return str;
114     
115     #Radio stuff begins here.
116     def RF_setenc(self,code="802.15.4"):
117         """Set the encoding type."""
118         return;
119     def RF_getenc(self):
120         """Get the encoding type."""
121         return "802.15.4";
122     def RF_getrate(self):
123         return 0;
124     def RF_setrate(self,rate=0):
125         return 0;
126     def RF_getsync(self):
127         return self.peek(0x14);
128     def RF_setsync(self,sync=0xa70F):
129         """Set the SYNC preamble.
130         Use 0xA70F for 0xA7."""
131         self.poke(0x14,sync);
132         return;
133     
134     def RF_setkey(self,key):
135         """Sets the first key for encryption to the given argument."""
136         print "ERROR: Forgot to set the key.";
137         
138         return;
139     def RF_setfreq(self,frequency):
140         """Set the frequency in Hz."""
141         mhz=frequency/1000000;
142         #fsctrl=0x8000; #
143         fsctrl=self.peek(0x18)&(~0x3FF);
144         fsctrl=fsctrl+int(mhz-2048)
145         self.poke(0x18,fsctrl);
146         #self.CC_RFST_IDLE();
147         self.strobe(0x02);#SCAL
148         time.sleep(0.01);
149         self.strobe(0x03);#SRXON
150     def RF_getfreq(self):
151         """Get the frequency in Hz."""
152         fsctrl=self.peek(0x18);
153         mhz=2048+(fsctrl&0x3ff)
154         return mhz*1000000;
155     def RF_setchan(self,channel):
156         """Set the ZigBee/802.15.4 channel number."""
157         if channel < 11 or channel > 26:
158             print "Only 802.15.4 channels 11 to 26 are currently supported.";
159         else:
160             self.RF_setfreq( ( (channel-11)*5 + 2405 ) * 1000000 );
161     def RF_getsmac(self):
162         """Return the source MAC address."""
163         return 0xdeadbeef;
164     def RF_setsmac(self,mac):
165         """Set the source MAC address."""
166         return 0xdeadbeef;
167     def RF_gettmac(self):
168         """Return the target MAC address."""
169         return 0xdeadbeef;
170     def RF_settmac(self,mac):
171         """Set the target MAC address."""
172         return 0xdeadbeef;
173     def RF_getrssi(self):
174         """Returns the received signal strength, with a weird offset."""
175         rssival=self.peek(0x13)&0xFF; #raw RSSI register
176         return rssival^0x80;
177     lastpacket=range(0,0xff);
178     def RF_rxpacket(self):
179         """Get a packet from the radio.  Returns None if none is
180         waiting."""
181         
182         data="\0";
183         self.data=data;
184         self.writecmd(self.CCSPIAPP,0x80,len(data),data);
185         buffer=self.data;
186         
187         self.lastpacket=buffer;
188         if(len(buffer)==0):
189             return None;
190         
191         return buffer;
192     def RF_rxpacketdec(self):
193         """Get and decrypt a packet from the radio.  Returns None if
194         none is waiting."""
195         
196         data="\0";
197         self.data=data;
198         self.writecmd(self.CCSPIAPP,0x90,len(data),data);
199         buffer=self.data;
200         
201         self.lastpacket=buffer;
202         if(len(buffer)==0):
203             return None;
204         
205         return buffer;
206
207     def RF_txpacket(self,packet):
208         """Send a packet through the radio."""
209         self.writecmd(self.CCSPIAPP,0x81,len(packet),packet);
210         #time.sleep(1);
211         #self.strobe(0x09);
212         return;
213     
214     def RF_reflexjam(self,duration=0):
215         """Place the device into reflexive jamming mode."""
216         data = [duration&0xff,
217                 (duration>>8)&0xff];
218         self.writecmd(self.CCSPIAPP,0xA0,len(data),data);
219         return;
220
221     def RF_reflexjam_autoack(self):
222         """Place the device into reflexive jamming mode
223            and that also sends a forged ACK if needed."""
224         data = "";
225         self.writecmd(self.CCSPIAPP,0xA1,len(data),data);
226         print "Got:", data, "and", self.data
227         return;
228
229     def RF_modulated_spectrum(self):
230         """Hold a carrier wave on the present frequency."""
231         # print "Don't know how to hold a carrier.";
232         # 33.1 p.55:
233         #  reset chip
234         #  SXOSCON
235         #  set MDMCTRL1.TX_MODE to 3   0x12  3:2 
236         #  STXON                            0x04
237
238         mdmctrl1=self.peek(0x12);
239         #print "mdmctrl1 was %04x" % mdmctrl1;
240         mdmctrl1=mdmctrl1|0x00c0;  #MDMCTRL1.TX_MODE = 3
241         self.poke(0x12, mdmctrl1); #MDMCTRL1
242
243         mdmctrl1=self.peek(0x12);
244         #print "mdmctrl1 is %04x" % mdmctrl1;
245
246         # http://e2e.ti.com/support/low_power_rf/f/155/t/15914.aspx?PageIndex=2
247         #   suggests this
248         self.strobe(0x02);         #STXCAL
249         #print "STXCAL status: %s" % self.status()
250
251         # is this necessary?
252         self.strobe(0x09);         #SFLUSHTX
253         #print "SFLUSHTX status: %s" % self.status()
254
255         self.strobe(0x04);         #STXON
256         #print "STXON status: %s" % self.status()
257
258     def RF_carrier(self):
259         """Hold a carrier wave on the present frequency."""
260         # print "Don't know how to hold a carrier.";
261         # 33.1 p.54:
262         #  reset chip
263         #  SXOSCON
264         #  set MDMCTRL1.TX_MODE to 2 or 3   0x12  3:2 
265         #  set DACTST to 0x1800             0x2E
266         #  STXON                            0x04
267
268         mdmctrl1=self.peek(0x12);
269         #print "mdmctrl1 was %04x" % mdmctrl1;
270         mdmctrl1=mdmctrl1|0x0080; 
271         mdmctrl1=mdmctrl1&0x0080;  #MDMCTRL1.TX_MODE = 2
272         self.poke(0x12, mdmctrl1); #MDMCTRL1
273
274         mdmctrl1=self.peek(0x12);
275         #print "mdmctrl1 is %04x" % mdmctrl1;
276
277         self.poke(0x2E, 0x1800);   #DACTST
278         dactst=self.peek(0x2E);
279         #print "dactst is %04x" % dactst;
280
281         # see above for why this is here
282         self.strobe(0x02);         #STXCAL
283         #print "STXCAL status: %s" % self.status()
284         self.strobe(0x09);         #SFLUSHTX
285         #print "SFLUSHTX status: %s" % self.status()
286
287         self.strobe(0x04);         #STXON
288         #print "STXON status: %s" % self.status()
289
290     def RF_promiscuity(self,promiscuous=1):
291         mdmctrl0=self.peek(0x11);
292         if promiscuous>0:
293             mdmctrl0=mdmctrl0&(~0x800);
294         else:
295             mdmctrl0=mdmctrl0|0x800;
296         self.poke(0x11,mdmctrl0);
297         return;
298     def RF_autocrc(self,autocrc=1):
299         mdmctrl0=self.peek(0x11);
300         if autocrc==0:
301             mdmctrl0=mdmctrl0&(~0x0020);
302         else:
303             mdmctrl0=mdmctrl0|0x0020;
304         self.poke(0x11,mdmctrl0);
305         return;
306     def RF_autoack(self,autoack=1):
307         mdmctrl0=self.peek(0x11);
308         if autoack==0:
309             mdmctrl0=mdmctrl0&(~0x0010);
310         else:
311             mdmctrl0=mdmctrl0|0x0010;
312         self.poke(0x11,mdmctrl0);
313         return;
314     packetlen=16;
315     def RF_setpacketlen(self,len=16):
316         """Set the number of bytes in the expected payload."""
317         #self.poke(0x11,len);
318         self.packetlen=len;
319     def RF_getpacketlen(self):
320         """Set the number of bytes in the expected payload."""
321         #len=self.peek(0x11);
322         self.packetlen=len;
323         return len;
324     maclen=5;
325     def RF_getmaclen(self):
326         """Get the number of bytes in the MAC address."""
327         choices=[0, 3, 4, 5];
328         choice=self.peek(0x03)&3;
329         self.maclen=choices[choice];
330         return self.maclen;
331     def RF_setmaclen(self,len):
332         """Set the number of bytes in the MAC address."""
333         choices=["illegal", "illegal", "illegal", 
334                  1, 2, 3];
335         choice=choices[len];
336         self.poke(0x03,choice);
337         self.maclen=len;
338     def printpacket(self,packet,prefix="#"):
339         s="";
340         i=0;
341         for foo in packet:
342             s="%s %02x" % (s,ord(foo));
343         print "%s%s" % (prefix,s);
344         
345     def printdissect(self,packet):
346         try:
347             from scapy.all import Dot15d4
348         except ImportError:
349             print "To use packet disection, Scapy must be installed and have the Dot15d4 extension present."
350             print "try: hg clone http://hg.secdev.org/scapy-com";
351             print "     sudo ./setup.py install";
352         self.printpacket(packet);
353         try:
354             scapyd = Dot15d4(packet[1:]);
355             scapyd.show();
356         except:
357             pass;