Fixed python client buffering issues, minor changes to SPI app.
[goodfet] / client / GoodFETSPI.py
1 #!/usr/bin/env python
2 # GoodFET SPI and SPIFlash Client Library
3
4 # (C) 2009 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, serial, os;
9
10 from GoodFET import GoodFET;
11
12 class GoodFETSPI(GoodFET):
13     def SPIsetup(self):
14         """Move the FET into the SPI application."""
15         self.writecmd(0x01,0x10,0,self.data); #SPI/SETUP
16         
17     def SPItrans8(self,byte):
18         """Read and write 8 bits by SPI."""
19         data=self.SPItrans([byte]);
20         return ord(data[0]);
21     
22     def SPItrans(self,data):
23         """Exchange data by SPI."""
24         self.data=data;
25         self.writecmd(0x01,0x00,len(data),data);
26         return self.data;
27
28 class GoodFETSPIFlash(GoodFETSPI):
29     JEDECmanufacturers={0xFF: "MISSING",
30                         0xEF: "Winbond",
31                         0xC2: "MXIC",
32                         0x20: "Numonyx/ST",
33                         0x1F: "Atmel"
34                         };
35
36     JEDECdevices={0xFFFFFF: "MISSING",
37                   0xEF3015: "W25X16L",
38                   0xEF3014: "W25X80L",
39                   0xEF3013: "W25X40L",
40                   0xEF3012: "W25X20L",
41                   0xEF3011: "W25X10L",
42                   0xC22017: "MX25L6405D",
43                   0xC22016: "MX25L3205D",
44                   0xC22015: "MX25L1605D",
45                   0xC22014: "MX25L8005",
46                   0xC22013: "MX25L4005",
47                   0x204011: "M45PE10"
48                   };
49     
50     JEDECsizes={0x17: 0x800000,
51                 0x16: 0x400000,
52                 0x15: 0x200000,
53                 0x14: 0x100000,
54                 0x13: 0x080000,
55                 0x12: 0x040000,
56                 0x11: 0x020000
57                 };
58     
59     JEDECsize=0;
60
61     def SPIjedec(self):
62         """Grab an SPI Flash ROM's JEDEC bytes."""
63         data=[0x9f, 0, 0, 0];
64         data=self.SPItrans(data);
65         
66         self.JEDECmanufacturer=ord(data[1]);
67         self.JEDECtype=ord(data[2]);
68         self.JEDECcapacity=ord(data[3]);
69         self.JEDECsize=self.JEDECsizes.get(self.JEDECcapacity);
70         if self.JEDECsize==None:
71             self.JEDECsize=0;
72         self.JEDECdevice=(ord(data[1])<<16)+(ord(data[2])<<8)+ord(data[3]);
73         return data;
74     def SPIpeek(self,adr):
75         """Grab a byte from an SPI Flash ROM."""
76         data=[0x03,
77               (adr&0xFF0000)>>16,
78               (adr&0xFF00)>>8,
79               adr&0xFF,
80               0];
81         self.SPItrans(data);
82         return ord(self.data[4]);
83     def SPIpeekblock(self,adr):
84         """Grab a few block from an SPI Flash ROM.  Block size is unknown"""
85         data=[(adr&0xFF0000)>>16,
86               (adr&0xFF00)>>8,
87               adr&0xFF];
88         
89         self.writecmd(0x01,0x02,3,data);
90         return self.data;
91     
92     def SPIpokebyte(self,adr,val):
93         self.SPIpokebytes(adr,[val]);
94     def SPIpokebytes(self,adr,data):
95         #Used to be 24 bits, BE, not 32 bits, LE.
96         adranddata=[adr&0xFF,
97                     (adr&0xFF00)>>8,
98                     (adr&0xFF0000)>>16,
99                     0, #MSB
100                     ]+data;
101         #print "%06x: poking %i bytes" % (adr,len(data));
102         self.writecmd(0x01,0x03,
103                       len(adranddata),adranddata);
104         
105     def SPIchiperase(self):
106         """Mass erase an SPI Flash ROM."""
107         self.writecmd(0x01,0x81);
108     def SPIwriteenable(self):
109         """SPI Flash Write Enable"""
110         data=[0x06];
111         self.SPItrans(data);
112         
113     def SPIjedecmanstr(self):
114         """Grab the JEDEC manufacturer string.  Call after SPIjedec()."""
115         man=self.JEDECmanufacturers.get(self.JEDECmanufacturer)
116         if man==0:
117             man="UNKNOWN";
118         return man;
119     
120     def SPIjedecstr(self):
121         """Grab the JEDEC manufacturer string.  Call after SPIjedec()."""
122         man=self.JEDECmanufacturers.get(self.JEDECmanufacturer);
123         if man==0:
124             man="UNKNOWN";
125         device=self.JEDECdevices.get(self.JEDECdevice);
126         if device==0:
127             device="???"
128         return "%s %s" % (man,device);
129