SPI client refactoring and block read/write functions.
[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                   0xC22014: "MX25L8005",
41                   0xC22013: "MX25L4005",
42                   0x204011: "M45PE10"
43                   };
44     JEDECsizes={0x14: 0x100000,
45                 0x13: 0x080000,
46                 0x12: 0x040000,
47                 0x11: 0x020000}
48     JEDECsize=0;
49
50     def SPIjedec(self):
51         """Grab an SPI Flash ROM's JEDEC bytes."""
52         data=[0x9f, 0, 0, 0];
53         data=self.SPItrans(data);
54         #print "Manufacturer: %02x\nType: %02x\nCapacity: %02x" % (ord(data[1]),ord(data[2]),ord(data[3]));
55         self.JEDECmanufacturer=ord(data[1]);
56         self.JEDECtype=ord(data[2]);
57         self.JEDECcapacity=ord(data[3]);
58         self.JEDECsize=self.JEDECsizes.get(self.JEDECcapacity);
59         if self.JEDECsize==None:
60             self.JEDECsize=0;
61         self.JEDECdevice=(ord(data[1])<<16)+(ord(data[2])<<8)+ord(data[3]);
62         return data;
63     def SPIpeek(self,adr):
64         """Grab a byte from an SPI Flash ROM."""
65         data=[0x03,
66               (adr&0xFF0000)>>16,
67               (adr&0xFF00)>>8,
68               adr&0xFF,
69               0];
70         self.SPItrans(data);
71         return ord(self.data[4]);
72     def SPIpeekblock(self,adr,blocks=1):
73         """Grab a few block from an SPI Flash ROM.  Block size is unknown"""
74         data=[(adr&0xFF0000)>>16,
75               (adr&0xFF00)>>8,
76               adr&0xFF,
77               blocks];
78         
79         self.writecmd(0x01,0x02,4,data,blocks);
80         return self.data;
81     
82     def SPIpokebyte(self,adr,val):
83         self.SPIpokebytes(adr,[val]);
84     def SPIpokebytes(self,adr,data):
85         #self.SPIwriteenable();
86         adranddata=[(adr&0xFF0000)>>16,
87               (adr&0xFF00)>>8,
88               adr&0xFF
89               ]+data;
90         self.writecmd(0x01,0x03,
91                       len(adranddata),adranddata);
92         
93     def SPIchiperase(self):
94         """Mass erase an SPI Flash ROM."""
95         self.writecmd(0x01,0x81,0,[]);
96     def SPIwriteenable(self):
97         """SPI Flash Write Enable"""
98         data=[0x06];
99         self.SPItrans(data);
100         
101     def SPIjedecmanstr(self):
102         """Grab the JEDEC manufacturer string.  Call after SPIjedec()."""
103         man=self.JEDECmanufacturers.get(self.JEDECmanufacturer)
104         if man==0:
105             man="UNKNOWN";
106         return man;
107     
108     def SPIjedecstr(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         device=self.JEDECdevices.get(self.JEDECdevice);
114         if device==0:
115             device="???"
116         return "%s %s" % (man,device);
117