Beginnings of info flash support. It isn't very good.
[goodfet] / firmware / apps / spi / spi.c
1 /*! \file spi.c
2   \author Travis Goodspeed
3   \brief SPI Master
4 */
5
6 //Higher level left to client application.
7
8 #include "platform.h"
9 #include "command.h"
10
11 #include <signal.h>
12 #include <io.h>
13 #include <iomacros.h>
14
15 #include "spi.h"
16
17 //This could be more accurate.
18 //Does it ever need to be?
19 #define SPISPEED 0
20 #define SPIDELAY(x)
21 //delay(x)
22
23
24 //! Set up the pins for SPI mode.
25 void spisetup(){
26   P5OUT|=SS;
27   P5DIR|=MOSI+SCK+SS;
28   P5DIR&=~MISO;
29   
30   //Begin a new transaction.
31   P5OUT&=~SS; 
32   P5OUT|=SS;
33 }
34
35
36 //! Read and write an SPI byte.
37 unsigned char spitrans8(unsigned char byte){
38   register unsigned int bit;
39   //This function came from the SPI Wikipedia article.
40   //Minor alterations.
41   
42   for (bit = 0; bit < 8; bit++) {
43     /* write MOSI on trailing edge of previous clock */
44     if (byte & 0x80)
45       SETMOSI;
46     else
47       CLRMOSI;
48     byte <<= 1;
49  
50     SETCLK;
51   
52     /* read MISO on trailing edge */
53     byte |= READMISO;
54     CLRCLK;
55   }
56   
57   return byte;
58 }
59
60
61 //! Enable SPI writing
62 void spiflash_wrten(){
63   SETSS;
64   /*
65   P5OUT&=~SS; //Drop !SS to begin transaction.
66   spitrans8(0x04);//Write Disable
67   P5OUT|=SS;  //Raise !SS to end transaction.
68   */
69   P5OUT&=~SS; //Drop !SS to begin transaction.
70   spitrans8(0x06);//Write Enable
71   P5OUT|=SS;  //Raise !SS to end transaction.
72 }
73
74
75 //! Grab the SPI flash status byte.
76 unsigned char spiflash_status(){
77   unsigned char c;
78   P5OUT|=SS;  //Raise !SS to end transaction.
79   P5OUT&=~SS; //Drop !SS to begin transaction.
80   spitrans8(0x05);//GET STATUS
81   c=spitrans8(0xFF);
82   P5OUT|=SS;  //Raise !SS to end transaction.
83   return c;
84 }
85
86
87 //! Grab the SPI flash status byte.
88 void spiflash_setstatus(unsigned char c){
89   SETSS;
90   CLRSS; //Drop !SS to begin transaction.
91   spitrans8(0x01);//SET STATUS
92   spitrans8(c);
93   SETSS;  //Raise !SS to end transaction.
94   //return c;
95 }
96
97
98 //! Read a block to a buffer.
99 void spiflash_peekblock(unsigned long adr,
100                         unsigned char *buf,
101                         unsigned int len){
102   unsigned char i;
103   
104   SETSS;
105   CLRSS; //Drop !SS to begin transaction.
106   spitrans8(0x03);//Flash Read Command
107   
108   //Send address
109   spitrans8((adr&0xFF0000)>>16);
110   spitrans8((adr&0xFF00)>>8);
111   spitrans8(adr&0xFF);
112   
113   for(i=0;i<len;i++)
114     buf[i]=spitrans8(0);
115   SETSS;  //Raise !SS to end transaction.
116 }
117
118 //! Read a block to a buffer.
119 void spiflash_pokeblock(unsigned long adr,
120                         unsigned char *buf,
121                         unsigned int len){
122   unsigned int i;
123   
124   SETSS;
125   
126   //if(len!=0x100)
127   //  debugstr("Non-standard block size.");
128   
129   while(spiflash_status()&0x01);//minor performance impact
130   
131   spiflash_setstatus(0x02);
132   spiflash_wrten();
133   
134   //Are these necessary?
135   //spiflash_setstatus(0x02);
136   //spiflash_wrten();
137   
138   CLRSS; //Drop !SS to begin transaction.
139   spitrans8(0x02); //Poke command.
140   
141   //Send address
142   spitrans8((adr&0xFF0000)>>16);
143   spitrans8((adr&0xFF00)>>8);
144   spitrans8(adr&0xFF);
145
146   for(i=0;i<len;i++)
147     spitrans8(buf[i]);
148   SETSS;  //Raise !SS to end transaction.
149   
150   while(spiflash_status()&0x01);//minor performance impact
151   return;
152 }
153
154
155 //! Write many blocks to the SPI Flash.
156 void spiflash_pokeblocks(unsigned long adr,
157                          unsigned char *buf,
158                          unsigned int len){
159   long off=0;//offset of this block
160   int blen;//length of this block
161   SETSS;
162   
163   while(off<len){
164     //calculate block length
165     blen=(len-off>0x100?0x100:len-off);
166     //write the block
167     spiflash_pokeblock(adr+off,
168                        buf+off,
169                        blen);
170     //add offset
171     off+=blen;
172   }
173 }
174
175
176
177 //! Peek some blocks.
178 void spiflash_peek(unsigned char app,
179                    unsigned char verb,
180                    unsigned long len){
181   unsigned int i;
182   P5OUT&=~SS; //Drop !SS to begin transaction.
183   spitrans8(0x03);//Flash Read Command
184   len=3;//write 3 byte pointer
185   for(i=0;i<len;i++)
186     spitrans8(cmddata[i]);
187   
188   //Send reply header
189   len=0x1000;
190   txhead(app,verb,len);
191   
192   while(len--)
193     serial_tx(spitrans8(0));
194   
195   P5OUT|=SS;  //Raise !SS to end transaction.
196 }
197
198
199 //! Erase a sector.
200 void spiflash_erasesector(unsigned long adr){
201   //debugstr("Erasing a 4kB sector.");
202
203   //Write enable.
204   spiflash_wrten();
205
206   //Begin
207   CLRSS;
208
209   //Second command.
210   spitrans8(0x20);
211   //Send address
212   spitrans8((adr&0xFF0000)>>16);
213   spitrans8((adr&0xFF00)>>8);
214   spitrans8(adr&0xFF);
215
216   SETSS;
217   while(spiflash_status()&0x01);//while busy
218   //debugstr("Erased.");
219 }
220
221
222 //! Handles a monitor command.
223 void spihandle(unsigned char app,
224                unsigned char verb,
225                unsigned long len){
226   unsigned long i;
227   
228   //Raise !SS to end transaction, just in case we forgot.
229   P5OUT|=SS;
230   spisetup();
231   
232   switch(verb){
233     //PEEK and POKE might come later.
234   case READ:
235   case WRITE:
236     P5OUT&=~SS; //Drop !SS to begin transaction.
237     for(i=0;i<len;i++)
238       cmddata[i]=spitrans8(cmddata[i]);
239     P5OUT|=SS;  //Raise !SS to end transaction.
240     txdata(app,verb,len);
241     break;
242
243
244   case SPI_JEDEC://Grab 3-byte JEDEC ID.
245     P5OUT&=~SS; //Drop !SS to begin transaction.
246     spitrans8(0x9f);
247     len=3;  //Length is variable in some chips, 3 minimum.
248     for(i=0;i<len;i++)
249       cmddata[i]=spitrans8(cmddata[i]);
250     txdata(app,verb,len);
251     P5OUT|=SS;  //Raise !SS to end transaction.
252     break;
253
254
255   case PEEK://Grab 128 bytes from an SPI Flash ROM
256     spiflash_peek(app,verb,len);
257     break;
258
259
260   case POKE://Poke up bytes from an SPI Flash ROM.
261     spiflash_pokeblocks(cmddatalong[0],//adr
262                         cmddata+4,//buf
263                         len-4);//len    
264     
265     txdata(app,verb,0);
266     break;
267
268
269   case SPI_ERASE://Erase the SPI Flash ROM.
270     spiflash_wrten();
271     P5OUT&=~SS; //Drop !SS to begin transaction.
272     spitrans8(0xC7);//Chip Erase
273     P5OUT|=SS;  //Raise !SS to end transaction.
274     
275     
276     while(spiflash_status()&0x01)//while busy
277       P1OUT^=1;
278     P1OUT&=~1;
279     
280     txdata(app,verb,0);
281     break;
282
283   case SETUP:
284     spisetup();
285     txdata(app,verb,0);
286     break;
287   }
288   
289 }