044aea2e17b98af05f83a981a010ceca6789eddd
[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         self.JEDECmanufacturer=ord(data[1]);
66         self.JEDECtype=ord(data[2]);
67         self.JEDECcapacity=ord(data[3]);
68         self.JEDECsize=self.JEDECsizes.get(self.JEDECcapacity);
69         if self.JEDECsize==None:
70             self.JEDECsize=0;
71         self.JEDECdevice=(ord(data[1])<<16)+(ord(data[2])<<8)+ord(data[3]);
72         return data;
73     def SPIpeek(self,adr):
74         """Grab a byte from an SPI Flash ROM."""
75         data=[0x03,
76               (adr&0xFF0000)>>16,
77               (adr&0xFF00)>>8,
78               adr&0xFF,
79               0];
80         self.SPItrans(data);
81         return ord(self.data[4]);
82     def SPIpeekblock(self,adr):
83         """Grab a few block from an SPI Flash ROM.  Block size is unknown"""
84         data=[(adr&0xFF0000)>>16,
85               (adr&0xFF00)>>8,
86               adr&0xFF];
87         
88         self.writecmd(0x01,0x02,3,data);
89         return self.data;
90     
91     def SPIpokebyte(self,adr,val):
92         self.SPIpokebytes(adr,[val]);
93     def SPIpokebytes(self,adr,data):
94         #self.SPIwriteenable();
95         adranddata=[(adr&0xFF0000)>>16,
96               (adr&0xFF00)>>8,
97               adr&0xFF
98               ]+data;
99         self.writecmd(0x01,0x03,
100                       len(adranddata),adranddata);
101         
102     def SPIchiperase(self):
103         """Mass erase an SPI Flash ROM."""
104         self.writecmd(0x01,0x81);
105     def SPIwriteenable(self):
106         """SPI Flash Write Enable"""
107         data=[0x06];
108         self.SPItrans(data);
109         
110     def SPIjedecmanstr(self):
111         """Grab the JEDEC manufacturer string.  Call after SPIjedec()."""
112         man=self.JEDECmanufacturers.get(self.JEDECmanufacturer)
113         if man==0:
114             man="UNKNOWN";
115         return man;
116     
117     def SPIjedecstr(self):
118         """Grab the JEDEC manufacturer string.  Call after SPIjedec()."""
119         man=self.JEDECmanufacturers.get(self.JEDECmanufacturer);
120         if man==0:
121             man="UNKNOWN";
122         device=self.JEDECdevices.get(self.JEDECdevice);
123         if device==0:
124             device="???"
125         return "%s %s" % (man,device);
126