A major refactor of the GoodFET firmware build system and apps to give better
[goodfet] / firmware / goodfet.c
1 /*! \file goodfet.c
2   \author Travis Goodspeed
3   \brief Main module.
4   
5   This is the main module of the GoodFET, which calls the initialization
6   routines and delegates commands to the various applications.
7 */
8
9
10 #include "platform.h"
11 #include "command.h"
12 #include "apps.h"
13 #include "glitch.h"
14
15 #define RESET 0x80      // not a real app -- causes firmware to reset
16 #define DEBUGAPP 0xFF
17
18 //! Initialize registers and all that jazz.
19 void init()
20 {
21 #ifdef DAC12IR
22         int i;
23 #endif
24
25         WDTCTL = WDTPW + WDTHOLD;                                       // Stop watchdog timer
26
27         //LED out and on.
28         PLEDDIR |= PLEDPIN;
29         PLEDOUT &= ~PLEDPIN;
30
31
32         /* P5.0 out and low; this is chosen for the PIC app (in which P5.0
33          is !MCLR) to ensure that an attached PIC chip, if present, is
34          immediately driven to reset state. A brief explanation of why this
35          is important follows.
36
37         At least dsPIC33F and PIC24H --and very likely other 16-bit PIC
38         families-- draw a large amount of current when running, especially
39         when using a fast clock: from 60 mA up to approx. 90 mA.  If the
40         PIC target begins to run before the client can request a new ICSP
41         session, which requires much less current (e.g., less than 2 mA),
42         then the MSP430 chip on the GoodFET will fail to start and the FTDI
43         may have trouble communicating with the client. The latter likely
44         relates to the FTDI on-chip 3V3 regulator being specified up to
45         only 50 mA. */
46
47
48         //P5REN &= ~BIT0; //DO NOT UNCOMMENT.  Breaks GF1x support.
49
50         //This will have to be cut soon.        Use pulling resistors instead.
51         /*
52         P5DIR |= BIT0;
53         P5OUT &= ~BIT0;
54         */
55
56         //Setup clocks, unique to each '430.
57         msp430_init_dco();
58         msp430_init_uart();
59
60         //DAC should be at full voltage if it exists.
61 #ifdef DAC12IR
62         //glitchvoltages(0xfff,0xfff);
63         ADC12CTL0 = REF2_5V + REFON;                                    // Internal 2.5V ref on
64         for(i=0;i!=0xFFFF;i++) asm("nop");
65         DAC12_0CTL = DAC12IR + DAC12AMP_5 + DAC12ENC; // Int ref gain 1
66         DAC12_0DAT = 0xFFF; //Max voltage 0xfff
67         DAC12_1CTL = DAC12IR + DAC12AMP_5 + DAC12ENC; // Int ref gain 1
68         DAC12_1DAT = 0x000; //Min voltage 0x000
69 #endif
70
71         /** FIXME
72           
73           This part is really ugly.  GSEL (P5.7) must be high to select
74           normal voltage, but a lot of applications light to swing it low
75           to be a nuissance.  To get around this, we assume that anyone
76           with a glitching FET will also have a DAC, then we set that DAC
77           to a high voltage.
78           
79           At some point, each target must be sanitized to show that it
80           doesn't clear P5OUT or P5DIR.
81         */
82         P5DIR|=BIT7; P5OUT=BIT7; //Normal Supply
83         //P5DIR&=~BIT7; //Glitch Supply
84
85         //Enable Interrupts.
86         //eint();
87 }
88
89
90 //! Handle a command.
91 void handle(uint8_t const app,
92                         uint8_t const verb,
93                         uint32_t const len)
94 {
95         int i;
96
97         //debugstr("GoodFET");
98         PLEDOUT&=~PLEDPIN;
99
100         // find the app and call the handle fn
101         for(i = 0; i < num_apps; i++)
102         {
103                 if(apps[i]->app == app)
104                 {
105                         // call the app's handle fn
106                         (*(apps[i]->handle))(app, verb, len);
107
108                         // exit early
109                         return;
110                 }
111         }
112
113         // if we get here, then the desired app is not copiled in 
114         // this firmware
115         debugstr("App missing.");
116         debughex(app);
117         txdata(app, NOK, 0);
118 }
119
120
121 //! Main loop.
122 int main(void)
123 {
124         volatile unsigned int i;
125         unsigned char app, verb;
126         unsigned long len;
127         // MSP reboot count for reset input & reboot function located at 0xFFFE
128         volatile unsigned int reset_count = 0;
129         void (*reboot_function)(void) = (void *) 0xFFFE;
130
131         init();
132   
133         txstring(MONITOR,OK,"http://goodfet.sf.net/");
134   
135         //Command loop.  There's no end!
136         while(1)
137         {
138                 //Magic 3
139                 app = serial_rx();
140
141                 // If the app is the reset byte (0x80) increment and loop
142                 if (app == RESET)
143                 {
144                         reset_count++;
145
146                         if (reset_count > 4) 
147                         {
148                                 // We could trigger the WDT with either:
149                                 // WDTCTL = 0;
150                                 // or
151                                 // WDTCTL = WDTPW + WDTCNTCL + WDTSSEL + 0x00;
152                                 // but instead we'll jump to our reboot function pointer
153                                 (*reboot_function)();
154                         }
155
156                         continue;
157                 } 
158                 else 
159                 {
160                         reset_count = 0;
161                 }
162
163                 verb = serial_rx();
164                 //len=serial_rx();
165                 len = rxword();
166
167                 //Read data, looking for buffer overflow.y
168                 if(len <= CMDDATALEN)
169                 {
170                         for(i = 0; i < len; i++)
171                         {
172                                 cmddata[i] = serial_rx();
173                         }
174
175                         handle(app,verb,len);
176                 }
177                 else
178                 {
179                         //Listen to the blaberring.
180                         for(i = 0; i < len; i++)
181                                 serial_rx();
182
183                         //Reply with an error.
184                         debugstr("Buffer length exceeded.");
185                         txdata(MONITOR,NOK,0);
186                 }
187         }
188 }
189