]> git.zerfleddert.de Git - proxmark3-svn/blob - bootrom/bootrom.c
CHG: `lf em` - refactored @marshmellow42 's em paritycheck.
[proxmark3-svn] / bootrom / bootrom.c
1 //-----------------------------------------------------------------------------
2 // This code is licensed to you under the terms of the GNU GPL, version 2 or,
3 // at your option, any later version. See the LICENSE.txt file for the text of
4 // the license.
5 //-----------------------------------------------------------------------------
6 // Main code for the bootloader
7 //-----------------------------------------------------------------------------
8
9 #include <proxmark3.h>
10 #include "usb_cdc.h"
11 #include "cmd.h"
12
13 void DbpString(char *str) {
14 byte_t len = 0;
15 while (str[len] != 0x00)
16 ++len;
17
18 cmd_send(CMD_DEBUG_PRINT_STRING,len,0,0,(byte_t*)str,len);
19 }
20
21 struct common_area common_area __attribute__((section(".commonarea")));
22 unsigned int start_addr, end_addr, bootrom_unlocked;
23 extern char _bootrom_start, _bootrom_end, _flash_start, _flash_end;
24
25 static void ConfigClocks(void)
26 {
27 // we are using a 16 MHz crystal as the basis for everything
28 // slow clock runs at 32Khz typical regardless of crystal
29
30 // enable system clock and USB clock
31 AT91C_BASE_PMC->PMC_SCER = AT91C_PMC_PCK | AT91C_PMC_UDP;
32
33 // enable the clock to the following peripherals
34 AT91C_BASE_PMC->PMC_PCER =
35 (1<<AT91C_ID_PIOA) |
36 (1<<AT91C_ID_ADC) |
37 (1<<AT91C_ID_SPI) |
38 (1<<AT91C_ID_SSC) |
39 (1<<AT91C_ID_PWMC) |
40 (1<<AT91C_ID_UDP);
41
42 // worst case scenario, with MAINCK = 16Mhz xtal, startup delay is 1.4ms
43 // if SLCK slow clock runs at its worst case (max) frequency of 42khz
44 // max startup delay = (1.4ms*42k)/8 = 7.356 so round up to 8
45
46 // enable main oscillator and set startup delay
47 AT91C_BASE_PMC->PMC_MOR =
48 AT91C_CKGR_MOSCEN |
49 PMC_MAIN_OSC_STARTUP_DELAY(8);
50
51 // wait for main oscillator to stabilize
52 while ( !(AT91C_BASE_PMC->PMC_SR & AT91C_PMC_MOSCS) ) {};
53
54 // PLL output clock frequency in range 80 - 160 MHz needs CKGR_PLL = 00
55 // PLL output clock frequency in range 150 - 180 MHz needs CKGR_PLL = 10
56 // PLL output is MAINCK * multiplier / divisor = 16Mhz * 12 / 2 = 96Mhz
57 AT91C_BASE_PMC->PMC_PLLR =
58 PMC_PLL_DIVISOR(2) |
59 PMC_PLL_COUNT_BEFORE_LOCK(0x50) |
60 PMC_PLL_FREQUENCY_RANGE(0) |
61 PMC_PLL_MULTIPLIER(12) |
62 PMC_PLL_USB_DIVISOR(1);
63
64 // wait for PLL to lock
65 while ( !(AT91C_BASE_PMC->PMC_SR & AT91C_PMC_LOCK) ) {};
66
67 // we want a master clock (MCK) to be PLL clock / 2 = 96Mhz / 2 = 48Mhz
68 // datasheet recommends that this register is programmed in two operations
69 // when changing to PLL, program the prescaler first then the source
70 AT91C_BASE_PMC->PMC_MCKR = AT91C_PMC_PRES_CLK_2;
71
72 // wait for main clock ready signal
73 while ( !(AT91C_BASE_PMC->PMC_SR & AT91C_PMC_MCKRDY) ) {};
74
75 // set the source to PLL
76 AT91C_BASE_PMC->PMC_MCKR = AT91C_PMC_PRES_CLK_2 | AT91C_PMC_CSS_PLL_CLK;
77
78 // wait for main clock ready signal
79 while ( !(AT91C_BASE_PMC->PMC_SR & AT91C_PMC_MCKRDY) ) {};
80 }
81
82 static void Fatal(void) {
83 for(;;);
84 }
85
86 void UsbPacketReceived(uint8_t *packet, int len) {
87 int i, dont_ack=0;
88 UsbCommand* c = (UsbCommand *)packet;
89 volatile uint32_t *p;
90
91 if(len != sizeof(UsbCommand)) Fatal();
92
93 uint32_t arg0 = (uint32_t)c->arg[0];
94
95 switch(c->cmd) {
96 case CMD_DEVICE_INFO: {
97 dont_ack = 1;
98 arg0 = DEVICE_INFO_FLAG_BOOTROM_PRESENT | DEVICE_INFO_FLAG_CURRENT_MODE_BOOTROM |
99 DEVICE_INFO_FLAG_UNDERSTANDS_START_FLASH;
100 if(common_area.flags.osimage_present)
101 arg0 |= DEVICE_INFO_FLAG_OSIMAGE_PRESENT;
102
103 cmd_send(CMD_DEVICE_INFO,arg0,1,2,0,0);
104 } break;
105
106 case CMD_SETUP_WRITE: {
107 /* The temporary write buffer of the embedded flash controller is mapped to the
108 * whole memory region, only the last 8 bits are decoded.
109 */
110 p = (volatile uint32_t *)&_flash_start;
111 for(i = 0; i < 12; i++)
112 p[i+arg0] = c->d.asDwords[i];
113 } break;
114
115 case CMD_FINISH_WRITE: {
116 uint32_t* flash_mem = (uint32_t*)(&_flash_start);
117 for ( int j=0; j<2; j++) {
118 for(i = 0+(64*j); i < 64+(64*j); i++) {
119 flash_mem[i] = c->d.asDwords[i];
120 }
121
122 uint32_t flash_address = arg0 + (0x100*j);
123
124 /* Check that the address that we are supposed to write to is within our allowed region */
125 if( ((flash_address+AT91C_IFLASH_PAGE_SIZE-1) >= end_addr) || (flash_address < start_addr) ) {
126 /* Disallow write */
127 dont_ack = 1;
128 cmd_send(CMD_NACK,0,0,0,0,0);
129 } else {
130 uint32_t page_n = (flash_address - ((uint32_t)flash_mem)) / AT91C_IFLASH_PAGE_SIZE;
131 /* Translate address to flash page and do flash, update here for the 512k part */
132 AT91C_BASE_EFC0->EFC_FCR = MC_FLASH_COMMAND_KEY |
133 MC_FLASH_COMMAND_PAGEN(page_n) |
134 AT91C_MC_FCMD_START_PROG;
135 }
136
137 // Wait until flashing of page finishes
138 uint32_t sr;
139 while(!((sr = AT91C_BASE_EFC0->EFC_FSR) & AT91C_MC_FRDY));
140 if(sr & (AT91C_MC_LOCKE | AT91C_MC_PROGE)) {
141 dont_ack = 1;
142 cmd_send(CMD_NACK,sr,0,0,0,0);
143 }
144 }
145 } break;
146
147 case CMD_HARDWARE_RESET: {
148 usb_disable();
149 AT91C_BASE_RSTC->RSTC_RCR = RST_CONTROL_KEY | AT91C_RSTC_PROCRST;
150 } break;
151
152 case CMD_START_FLASH: {
153 if(c->arg[2] == START_FLASH_MAGIC)
154 bootrom_unlocked = 1;
155 else
156 bootrom_unlocked = 0;
157
158 int prot_start = (int)&_bootrom_start;
159 int prot_end = (int)&_bootrom_end;
160 int allow_start = (int)&_flash_start;
161 int allow_end = (int)&_flash_end;
162 int cmd_start = c->arg[0];
163 int cmd_end = c->arg[1];
164
165 /* Only allow command if the bootrom is unlocked, or the parameters are outside of the protected
166 * bootrom area. In any case they must be within the flash area.
167 */
168 if( (bootrom_unlocked || ((cmd_start >= prot_end) || (cmd_end < prot_start))) &&
169 (cmd_start >= allow_start) &&
170 (cmd_end <= allow_end) ) {
171 start_addr = cmd_start;
172 end_addr = cmd_end;
173 } else {
174 start_addr = end_addr = 0;
175 dont_ack = 1;
176 cmd_send(CMD_NACK,0,0,0,0,0);
177 }
178 } break;
179
180 default: {
181 Fatal();
182 } break;
183 }
184
185 if(!dont_ack)
186 cmd_send(CMD_ACK,arg0,0,0,0,0);
187 }
188
189 static void flash_mode(int externally_entered)
190 {
191 start_addr = 0;
192 end_addr = 0;
193 bootrom_unlocked = 0;
194 byte_t rx[sizeof(UsbCommand)];
195 size_t rx_len;
196
197 usb_enable();
198 for (volatile size_t i=0; i<0x100000; i++) {};
199
200 for(;;) {
201 WDT_HIT();
202
203 if (usb_poll()) {
204 rx_len = usb_read(rx,sizeof(UsbCommand));
205 if (rx_len)
206 UsbPacketReceived(rx,rx_len);
207 }
208
209 if(!externally_entered && !BUTTON_PRESS()) {
210 /* Perform a reset to leave flash mode */
211 usb_disable();
212 LED_B_ON();
213 AT91C_BASE_RSTC->RSTC_RCR = RST_CONTROL_KEY | AT91C_RSTC_PROCRST;
214 for(;;)
215 ;
216 }
217 if(externally_entered && BUTTON_PRESS()) {
218 /* Let the user's button press override the automatic leave */
219 externally_entered = 0;
220 }
221 }
222 }
223
224 extern uint32_t _osimage_entry;
225 void BootROM(void)
226 {
227 //------------
228 // First set up all the I/O pins; GPIOs configured directly, other ones
229 // just need to be assigned to the appropriate peripheral.
230
231 // Kill all the pullups, especially the one on USB D+; leave them for
232 // the unused pins, though.
233 AT91C_BASE_PIOA->PIO_PPUDR =
234 GPIO_USB_PU |
235 GPIO_LED_A |
236 GPIO_LED_B |
237 GPIO_LED_C |
238 GPIO_LED_D |
239 GPIO_FPGA_DIN |
240 GPIO_FPGA_DOUT |
241 GPIO_FPGA_CCLK |
242 GPIO_FPGA_NINIT |
243 GPIO_FPGA_NPROGRAM |
244 GPIO_FPGA_DONE |
245 GPIO_MUXSEL_HIPKD |
246 GPIO_MUXSEL_HIRAW |
247 GPIO_MUXSEL_LOPKD |
248 GPIO_MUXSEL_LORAW |
249 GPIO_RELAY |
250 GPIO_NVDD_ON;
251 // (and add GPIO_FPGA_ON)
252 // These pins are outputs
253 AT91C_BASE_PIOA->PIO_OER =
254 GPIO_LED_A |
255 GPIO_LED_B |
256 GPIO_LED_C |
257 GPIO_LED_D |
258 GPIO_RELAY |
259 GPIO_NVDD_ON;
260 // PIO controls the following pins
261 AT91C_BASE_PIOA->PIO_PER =
262 GPIO_USB_PU |
263 GPIO_LED_A |
264 GPIO_LED_B |
265 GPIO_LED_C |
266 GPIO_LED_D;
267
268 // USB_D_PLUS_PULLUP_OFF();
269 usb_disable();
270 LED_D_OFF();
271 LED_C_ON();
272 LED_B_OFF();
273 LED_A_OFF();
274
275 AT91C_BASE_EFC0->EFC_FMR =
276 AT91C_MC_FWS_1FWS |
277 MC_FLASH_MODE_MASTER_CLK_IN_MHZ(48);
278 #ifdef HAS_512_FLASH
279 AT91C_BASE_EFC1->EFC_FMR =
280 AT91C_MC_FWS_1FWS |
281 MC_FLASH_MODE_MASTER_CLK_IN_MHZ(48);
282 #endif
283 // Initialize all system clocks
284 ConfigClocks();
285
286 LED_A_ON();
287
288 int common_area_present = 0;
289 switch(AT91C_BASE_RSTC->RSTC_RSR & AT91C_RSTC_RSTTYP) {
290 case AT91C_RSTC_RSTTYP_WATCHDOG:
291 case AT91C_RSTC_RSTTYP_SOFTWARE:
292 case AT91C_RSTC_RSTTYP_USER:
293 /* In these cases the common_area in RAM should be ok, retain it if it's there */
294 if(common_area.magic == COMMON_AREA_MAGIC && common_area.version == 1) {
295 common_area_present = 1;
296 }
297 break;
298 default: /* Otherwise, initialize it from scratch */
299 break;
300 }
301
302 if(!common_area_present){
303 /* Common area not ok, initialize it */
304 int i;
305 /* Makeshift memset, no need to drag util.c into this */
306 for(i=0; i<sizeof(common_area); i++)
307 ((char*)&common_area)[i] = 0;
308
309 common_area.magic = COMMON_AREA_MAGIC;
310 common_area.version = 1;
311 common_area.flags.bootrom_present = 1;
312 }
313
314 common_area.flags.bootrom_present = 1;
315 if(common_area.command == COMMON_AREA_COMMAND_ENTER_FLASH_MODE) {
316 common_area.command = COMMON_AREA_COMMAND_NONE;
317 flash_mode(1);
318 } else if(BUTTON_PRESS()) {
319 flash_mode(0);
320 } else if(_osimage_entry == 0xffffffffU) {
321 flash_mode(1);
322 } else {
323 // jump to Flash address of the osimage entry point (LSBit set for thumb mode)
324 __asm("bx %0\n" : : "r" ( ((int)&_osimage_entry) | 0x1 ) );
325 }
326 }
Impressum, Datenschutz