JEDEC ID support up to 64MBit, MXIC device IDs for the same.
[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                         };
34
35     JEDECdevices={0xFFFFFF: "MISSING",
36                   0xEF3014: "W25X80L",
37                   0xEF3013: "W25X40L",
38                   0xEF3012: "W25X20L",
39                   0xEF3011: "W25X10L",
40                   0xC22017: "MX25L6405D",
41                   0xC22016: "MX25L3205D",
42                   0xC22015: "MX25L1605D",
43                   0xC22014: "MX25L8005",
44                   0xC22013: "MX25L4005",
45                   0x204011: "M45PE10"
46                   };
47     
48     JEDECsizes={0x16: 0x800000,
49                 0x16: 0x400000,
50                 0x15: 0x200000,
51                 0x14: 0x100000,
52                 0x13: 0x080000,
53                 0x12: 0x040000,
54                 0x11: 0x020000}
55     JEDECsize=0;
56
57     def SPIjedec(self):
58         """Grab an SPI Flash ROM's JEDEC bytes."""
59         data=[0x9f, 0, 0, 0];
60         data=self.SPItrans(data);
61         #print "Manufacturer: %02x\nType: %02x\nCapacity: %02x" % (ord(data[1]),ord(data[2]),ord(data[3]));
62         self.JEDECmanufacturer=ord(data[1]);
63         self.JEDECtype=ord(data[2]);
64         self.JEDECcapacity=ord(data[3]);
65         self.JEDECsize=self.JEDECsizes.get(self.JEDECcapacity);
66         if self.JEDECsize==None:
67             self.JEDECsize=0;
68         self.JEDECdevice=(ord(data[1])<<16)+(ord(data[2])<<8)+ord(data[3]);
69         return data;
70     def SPIpeek(self,adr):
71         """Grab a byte from an SPI Flash ROM."""
72         data=[0x03,
73               (adr&0xFF0000)>>16,
74               (adr&0xFF00)>>8,
75               adr&0xFF,
76               0];
77         self.SPItrans(data);
78         return ord(self.data[4]);
79     def SPIpeekblock(self,adr,blocks=1):
80         """Grab a few block from an SPI Flash ROM.  Block size is unknown"""
81         data=[(adr&0xFF0000)>>16,
82               (adr&0xFF00)>>8,
83               adr&0xFF,
84               blocks];
85         
86         self.writecmd(0x01,0x02,4,data,blocks);
87         return self.data;
88     
89     def SPIpokebyte(self,adr,val):
90         self.SPIpokebytes(adr,[val]);
91     def SPIpokebytes(self,adr,data):
92         #self.SPIwriteenable();
93         adranddata=[(adr&0xFF0000)>>16,
94               (adr&0xFF00)>>8,
95               adr&0xFF
96               ]+data;
97         self.writecmd(0x01,0x03,
98                       len(adranddata),adranddata);
99         
100     def SPIchiperase(self):
101         """Mass erase an SPI Flash ROM."""
102         self.writecmd(0x01,0x81,0,[]);
103     def SPIwriteenable(self):
104         """SPI Flash Write Enable"""
105         data=[0x06];
106         self.SPItrans(data);
107         
108     def SPIjedecmanstr(self):
109         """Grab the JEDEC manufacturer string.  Call after SPIjedec()."""
110         man=self.JEDECmanufacturers.get(self.JEDECmanufacturer)
111         if man==0:
112             man="UNKNOWN";
113         return man;
114     
115     def SPIjedecstr(self):
116         """Grab the JEDEC manufacturer string.  Call after SPIjedec()."""
117         man=self.JEDECmanufacturers.get(self.JEDECmanufacturer);
118         if man==0:
119             man="UNKNOWN";
120         device=self.JEDECdevices.get(self.JEDECdevice);
121         if device==0:
122             device="???"
123         return "%s %s" % (man,device);
124