Refactoring, beginning AVR application.
[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   //while(spiflash_status()&0x01);//minor performance impact
127   
128   //Are these necessary?
129   //spiflash_setstatus(0x02);
130   //spiflash_wrten();
131   
132   CLRSS; //Drop !SS to begin transaction.
133   spitrans8(0x02); //Poke command.
134   
135   //Send address
136   spitrans8((adr&0xFF0000)>>16);
137   spitrans8((adr&0xFF00)>>8);
138   spitrans8(adr&0xFF);
139
140   for(i=0;i<len;i++)
141     spitrans8(buf[i]);
142   SETSS;  //Raise !SS to end transaction.
143   
144   while(spiflash_status()&0x01);//minor performance impact
145   return;
146 }
147
148
149 //! Write many blocks to the SPI Flash.
150 void spiflash_pokeblocks(unsigned long adr,
151                          unsigned char *buf,
152                          unsigned int len){
153   long off=0;//offset of this block
154   int blen;//length of this block
155   SETSS;
156   spiflash_setstatus(0x02);
157   spiflash_wrten();
158   
159   while(off<len){
160     //calculate block length
161     blen=(len-off>0x100?0x100:len-off);
162     //write the block
163     spiflash_pokeblock(adr+off,
164                        buf+off,
165                        blen);
166     //add offset
167     off+=blen;
168   }
169 }
170
171
172
173 //! Peek some blocks.
174 void spiflash_peek(unsigned char app,
175                    unsigned char verb,
176                    unsigned long len){
177   unsigned int i;
178   P5OUT&=~SS; //Drop !SS to begin transaction.
179   spitrans8(0x03);//Flash Read Command
180   len=3;//write 3 byte pointer
181   for(i=0;i<len;i++)
182     spitrans8(cmddata[i]);
183   
184   //Send reply header
185   len=0x1000;
186   txhead(app,verb,len);
187   
188   while(len--)
189     serial_tx(spitrans8(0));
190   
191   P5OUT|=SS;  //Raise !SS to end transaction.
192 }
193
194 //! Handles a monitor command.
195 void spihandle(unsigned char app,
196                unsigned char verb,
197                unsigned long len){
198   unsigned long i;
199   
200   //Raise !SS to end transaction, just in case we forgot.
201   P5OUT|=SS;
202   spisetup();
203   
204   switch(verb){
205     //PEEK and POKE might come later.
206   case READ:
207   case WRITE:
208     P5OUT&=~SS; //Drop !SS to begin transaction.
209     for(i=0;i<len;i++)
210       cmddata[i]=spitrans8(cmddata[i]);
211     P5OUT|=SS;  //Raise !SS to end transaction.
212     txdata(app,verb,len);
213     break;
214
215
216   case SPI_JEDEC://Grab 3-byte JEDEC ID.
217     P5OUT&=~SS; //Drop !SS to begin transaction.
218     spitrans8(0x9f);
219     len=3;  //Length is variable in some chips, 3 minimum.
220     for(i=0;i<len;i++)
221       cmddata[i]=spitrans8(cmddata[i]);
222     txdata(app,verb,len);
223     P5OUT|=SS;  //Raise !SS to end transaction.
224     break;
225
226
227   case PEEK://Grab 128 bytes from an SPI Flash ROM
228     spiflash_peek(app,verb,len);
229     break;
230
231
232   case POKE://Poke up bytes from an SPI Flash ROM.
233     spiflash_pokeblocks(cmddatalong[0],//adr
234                         cmddata+4,//buf
235                         len-4);//len    
236     
237     txdata(app,verb,len);
238     break;
239
240
241   case SPI_ERASE://Erase the SPI Flash ROM.
242     spiflash_wrten();
243     P5OUT&=~SS; //Drop !SS to begin transaction.
244     spitrans8(0xC7);//Chip Erase
245     P5OUT|=SS;  //Raise !SS to end transaction.
246     
247     
248     while(spiflash_status()&0x01)//while busy
249       P1OUT^=1;
250     P1OUT&=~1;
251     
252     txdata(app,verb,0);
253     break;
254
255   case SETUP:
256     spisetup();
257     txdata(app,verb,0);
258     break;
259   }
260   
261 }