]> cvs.zerfleddert.de Git - proxmark3-svn/blame - client/flash.c
Remove remnant junk and TODO -> FIXME
[proxmark3-svn] / client / flash.c
CommitLineData
a553f267 1//-----------------------------------------------------------------------------
8fe1a992 2// Copyright (C) 2010 Hector Martin "marcan" <marcan@marcansoft.com>
3//
a553f267 4// This code is licensed to you under the terms of the GNU GPL, version 2 or,
5// at your option, any later version. See the LICENSE.txt file for the text of
6// the license.
7//-----------------------------------------------------------------------------
8fe1a992 8// ELF file flasher
a553f267 9//-----------------------------------------------------------------------------
10
6e4d4ee6 11#include <stdio.h>
6e4d4ee6 12#include <string.h>
83a9b236 13#include <stdlib.h>
4cd41f34 14#include "sleep.h"
15#include "proxusb.h"
6e4d4ee6 16#include "flash.h"
2cab856f 17#include "elf.h"
8fe1a992 18#include "proxendian.h"
6e4d4ee6 19
0ae6234a 20// FIXME: what the fuckity fuck
8fe1a992 21unsigned int current_command = CMD_UNKNOWN;
22
23#define FLASH_START 0x100000
24#define FLASH_SIZE (256*1024)
25#define FLASH_END (FLASH_START + FLASH_SIZE)
26#define BOOTLOADER_SIZE 0x2000
27#define BOOTLOADER_END (FLASH_START + BOOTLOADER_SIZE)
28
29#define BLOCK_SIZE 0x100
30
31static const uint8_t elf_ident[] = {
32 0x7f, 'E', 'L', 'F',
33 ELFCLASS32,
34 ELFDATA2LSB,
35 EV_CURRENT
36};
37
38// Turn PHDRs into flasher segments, checking for PHDR sanity and merging adjacent
39// unaligned segments if needed
40static int build_segs_from_phdrs(flash_file_t *ctx, FILE *fd, Elf32_Phdr *phdrs, int num_phdrs)
7fe9b0b7 41{
8fe1a992 42 Elf32_Phdr *phdr = phdrs;
43 flash_seg_t *seg;
44 uint32_t last_end = 0;
45
46 ctx->segments = malloc(sizeof(flash_seg_t) * num_phdrs);
47 if (!ctx->segments) {
48 fprintf(stderr, "Out of memory\n");
49 return -1;
50 }
51 ctx->num_segs = 0;
52 seg = ctx->segments;
53
54 fprintf(stderr, "Loading usable ELF segments:\n");
55 for (int i = 0; i < num_phdrs; i++) {
56 if (le32(phdr->p_type) != PT_LOAD) {
57 phdr++;
58 continue;
59 }
60 uint32_t vaddr = le32(phdr->p_vaddr);
61 uint32_t paddr = le32(phdr->p_paddr);
62 uint32_t filesz = le32(phdr->p_filesz);
63 uint32_t memsz = le32(phdr->p_memsz);
64 uint32_t offset = le32(phdr->p_offset);
65 uint32_t flags = le32(phdr->p_flags);
66 if (!filesz) {
67 phdr++;
68 continue;
69 }
70 fprintf(stderr, "%d: V 0x%08x P 0x%08x (0x%08x->0x%08x) [%c%c%c] @0x%x\n",
71 i, vaddr, paddr, filesz, memsz,
72 flags & PF_R ? 'R' : ' ',
73 flags & PF_W ? 'W' : ' ',
74 flags & PF_X ? 'X' : ' ',
75 offset);
76 if (filesz != memsz) {
77 fprintf(stderr, "Error: PHDR file size does not equal memory size\n"
78 "(DATA+BSS PHDRs do not make sense on ROM platforms!)\n");
79 return -1;
80 }
81 if (paddr < last_end) {
82 fprintf(stderr, "Error: PHDRs not sorted or overlap\n");
83 return -1;
84 }
85 if (paddr < FLASH_START || (paddr+filesz) > FLASH_END) {
86 fprintf(stderr, "Error: PHDR is not contained in Flash\n");
87 return -1;
88 }
89 if (vaddr >= FLASH_START && vaddr < FLASH_END && (flags & PF_W)) {
90 fprintf(stderr, "Error: Flash VMA segment is writable\n");
91 return -1;
92 }
93
94 uint8_t *data;
95 // make extra space if we need to move the data forward
96 data = malloc(filesz + BLOCK_SIZE);
97 if (!data) {
98 fprintf(stderr, "Out of memory\n");
99 return -1;
100 }
101 if (fseek(fd, offset, SEEK_SET) < 0 || fread(data, 1, filesz, fd) != filesz) {
102 fprintf(stderr, "Error while reading PHDR payload\n");
103 free(data);
104 return -1;
105 }
106
107 uint32_t block_offset = paddr & (BLOCK_SIZE-1);
108 if (block_offset) {
109 if (ctx->num_segs) {
110 flash_seg_t *prev_seg = seg - 1;
111 uint32_t this_end = paddr + filesz;
112 uint32_t this_firstblock = paddr & ~(BLOCK_SIZE-1);
113 uint32_t prev_lastblock = (last_end - 1) & ~(BLOCK_SIZE-1);
114
115 if (this_firstblock == prev_lastblock) {
116 uint32_t new_length = this_end - prev_seg->start;
117 uint32_t this_offset = paddr - prev_seg->start;
118 uint32_t hole = this_offset - prev_seg->length;
119 uint8_t *new_data = malloc(new_length);
120 if (!new_data) {
121 fprintf(stderr, "Out of memory\n");
122 free(data);
123 return -1;
124 }
125 memset(new_data, 0xff, new_length);
126 memcpy(new_data, prev_seg->data, prev_seg->length);
127 memcpy(new_data + this_offset, data, filesz);
128 fprintf(stderr, "Note: Extending previous segment from 0x%x to 0x%x bytes\n",
129 prev_seg->length, new_length);
130 if (hole)
131 fprintf(stderr, "Note: 0x%x-byte hole created\n", hole);
132 free(data);
133 free(prev_seg->data);
134 prev_seg->data = new_data;
135 prev_seg->length = new_length;
136 last_end = this_end;
137 phdr++;
138 continue;
139 }
140 }
141 fprintf(stderr, "Warning: segment does not begin on a block boundary, will pad\n");
142 memmove(data + block_offset, data, filesz);
143 memset(data, 0xFF, block_offset);
144 filesz += block_offset;
145 paddr -= block_offset;
146 }
147
148 seg->data = data;
149 seg->start = paddr;
150 seg->length = filesz;
151 seg++;
152 ctx->num_segs++;
153
154 last_end = paddr + filesz;
155 phdr++;
156 }
157 return 0;
6e4d4ee6 158}
159
8fe1a992 160// Sanity check segments and check for bootloader writes
161static int check_segs(flash_file_t *ctx, int can_write_bl) {
162 for (int i = 0; i < ctx->num_segs; i++) {
163 flash_seg_t *seg = &ctx->segments[i];
164
165 if (seg->start & (BLOCK_SIZE-1)) {
166 fprintf(stderr, "Error: Segment is not aligned\n");
167 return -1;
168 }
169 if (seg->start < FLASH_START) {
170 fprintf(stderr, "Error: Segment is outside of flash bounds\n");
171 return -1;
172 }
173 if (seg->start + seg->length > FLASH_END) {
174 fprintf(stderr, "Error: Segment is outside of flash bounds\n");
175 return -1;
176 }
177 if (!can_write_bl && seg->start < BOOTLOADER_END) {
178 fprintf(stderr, "Attempted to write bootloader but bootloader writes are not enabled\n");
179 return -1;
180 }
181 }
182 return 0;
183}
184
185// Load an ELF file and prepare it for flashing
186int flash_load(flash_file_t *ctx, const char *name, int can_write_bl)
187{
188 FILE *fd = NULL;
189 Elf32_Ehdr ehdr;
190 Elf32_Phdr *phdrs = NULL;
191 int num_phdrs;
192 int res;
193
194 fd = fopen(name, "rb");
195 if (!fd) {
196 fprintf(stderr, "Could not open file '%s': ", name);
197 perror(NULL);
198 goto fail;
199 }
200
201 fprintf(stderr, "Loading ELF file '%s'...\n", name);
202
203 if (fread(&ehdr, sizeof(ehdr), 1, fd) != 1) {
204 fprintf(stderr, "Error while reading ELF file header\n");
205 goto fail;
206 }
207 if (memcmp(ehdr.e_ident, elf_ident, sizeof(elf_ident))
208 || le32(ehdr.e_version) != 1)
209 {
210 fprintf(stderr, "Not an ELF file or wrong ELF type\n");
211 goto fail;
212 }
213 if (le16(ehdr.e_type) != ET_EXEC) {
214 fprintf(stderr, "ELF is not executable\n");
215 goto fail;
216 }
217 if (le16(ehdr.e_machine) != EM_ARM) {
218 fprintf(stderr, "Wrong ELF architecture\n");
219 goto fail;
220 }
221 if (!ehdr.e_phnum || !ehdr.e_phoff) {
222 fprintf(stderr, "ELF has no PHDRs\n");
223 goto fail;
224 }
225 if (le16(ehdr.e_phentsize) != sizeof(Elf32_Phdr)) {
226 // could be a structure padding issue...
227 fprintf(stderr, "Either the ELF file or this code is made of fail\n");
228 goto fail;
229 }
230 num_phdrs = le16(ehdr.e_phnum);
231
232 phdrs = malloc(le16(ehdr.e_phnum) * sizeof(Elf32_Phdr));
233 if (!phdrs) {
234 fprintf(stderr, "Out of memory\n");
235 goto fail;
236 }
237 if (fseek(fd, le32(ehdr.e_phoff), SEEK_SET) < 0) {
238 fprintf(stderr, "Error while reading ELF PHDRs\n");
239 goto fail;
240 }
241 if (fread(phdrs, sizeof(Elf32_Phdr), num_phdrs, fd) != num_phdrs) {
242 fprintf(stderr, "Error while reading ELF PHDRs\n");
243 goto fail;
244 }
245
246 res = build_segs_from_phdrs(ctx, fd, phdrs, num_phdrs);
247 if (res < 0)
248 goto fail;
249 res = check_segs(ctx, can_write_bl);
250 if (res < 0)
251 goto fail;
252
253 fclose(fd);
254 ctx->filename = name;
255 return 0;
256
257fail:
258 if (phdrs)
259 free(phdrs);
260 if (fd)
261 fclose(fd);
262 flash_free(ctx);
263 return -1;
264}
6e4d4ee6 265
8fe1a992 266// Get the state of the proxmark, backwards compatible
267static int get_proxmark_state(uint32_t *state)
6e4d4ee6 268{
8fe1a992 269 UsbCommand c;
270 c.cmd = CMD_DEVICE_INFO;
271 SendCommand(&c);
272
273 UsbCommand resp;
274 ReceiveCommand(&resp);
275
276 // Three outcomes:
277 // 1. The old bootrom code will ignore CMD_DEVICE_INFO, but respond with an ACK
278 // 2. The old os code will respond with CMD_DEBUG_PRINT_STRING and "unknown command"
279 // 3. The new bootrom and os codes will respond with CMD_DEVICE_INFO and flags
280
281 switch (resp.cmd) {
282 case CMD_ACK:
283 *state = DEVICE_INFO_FLAG_CURRENT_MODE_BOOTROM;
284 break;
285 case CMD_DEBUG_PRINT_STRING:
286 *state = DEVICE_INFO_FLAG_CURRENT_MODE_OS;
287 break;
288 case CMD_DEVICE_INFO:
289 *state = resp.arg[0];
290 break;
291 default:
292 fprintf(stderr, "Error: Couldn't get proxmark state, bad response type: 0x%04x\n", resp.cmd);
293 return -1;
294 break;
295 }
296
297 return 0;
6e4d4ee6 298}
299
8fe1a992 300// Enter the bootloader to be able to start flashing
301static int enter_bootloader(void)
6e4d4ee6 302{
8fe1a992 303 uint32_t state;
304
305 if (get_proxmark_state(&state) < 0)
306 return -1;
307
308 if (state & DEVICE_INFO_FLAG_CURRENT_MODE_BOOTROM) {
309 /* Already in flash state, we're done. */
310 return 0;
311 }
312
313 if (state & DEVICE_INFO_FLAG_CURRENT_MODE_OS) {
314 fprintf(stderr,"Entering bootloader...\n");
315 UsbCommand c;
316 memset(&c, 0, sizeof (c));
317
318 if ((state & DEVICE_INFO_FLAG_BOOTROM_PRESENT)
319 && (state & DEVICE_INFO_FLAG_OSIMAGE_PRESENT))
320 {
321 // New style handover: Send CMD_START_FLASH, which will reset the board
322 // and enter the bootrom on the next boot.
323 c.cmd = CMD_START_FLASH;
324 SendCommand(&c);
325 fprintf(stderr,"(Press and release the button only to abort)\n");
326 } else {
327 // Old style handover: Ask the user to press the button, then reset the board
328 c.cmd = CMD_HARDWARE_RESET;
329 SendCommand(&c);
330 fprintf(stderr,"Press and hold down button NOW if your bootloader requires it.\n");
331 }
332 fprintf(stderr,"Waiting for Proxmark to reappear on USB...");
333
334 CloseProxmark();
335 sleep(1);
336 while (!OpenProxmark(0)) {
337 sleep(1);
338 fprintf(stderr, ".");
339 }
340 fprintf(stderr," Found.\n");
341
342 return 0;
343 }
344
345 fprintf(stderr, "Error: Unknown Proxmark mode\n");
346 return -1;
6e4d4ee6 347}
348
8fe1a992 349static int wait_for_ack(void)
6e4d4ee6 350{
8fe1a992 351 UsbCommand ack;
352 ReceiveCommand(&ack);
353 if (ack.cmd != CMD_ACK) {
354 printf("Error: Unexpected reply 0x%04x (expected ACK)\n", ack.cmd);
355 return -1;
356 }
357 return 0;
6e4d4ee6 358}
359
8fe1a992 360// Go into flashing mode
361int flash_start_flashing(int enable_bl_writes)
6e4d4ee6 362{
8fe1a992 363 uint32_t state;
364
365 if (enter_bootloader() < 0)
366 return -1;
367
368 if (get_proxmark_state(&state) < 0)
369 return -1;
370
371 if (state & DEVICE_INFO_FLAG_UNDERSTANDS_START_FLASH) {
372 // This command is stupid. Why the heck does it care which area we're
373 // flashing, as long as it's not the bootloader area? The mind boggles.
374 UsbCommand c = {CMD_START_FLASH};
375
376 if (enable_bl_writes) {
377 c.arg[0] = FLASH_START;
378 c.arg[1] = FLASH_END;
379 c.arg[2] = START_FLASH_MAGIC;
380 } else {
381 c.arg[0] = BOOTLOADER_END;
382 c.arg[1] = FLASH_END;
383 c.arg[2] = 0;
384 }
385 SendCommand(&c);
386 return wait_for_ack();
387 } else {
388 fprintf(stderr, "Note: Your bootloader does not understand the new START_FLASH command\n");
389 fprintf(stderr, " It is recommended that you update your bootloader\n\n");
390 }
391
392 return 0;
6e4d4ee6 393}
394
8fe1a992 395static int write_block(uint32_t address, uint8_t *data, uint32_t length)
6e4d4ee6 396{
8fe1a992 397 uint8_t block_buf[BLOCK_SIZE];
398
399 memset(block_buf, 0xFF, BLOCK_SIZE);
400 memcpy(block_buf, data, length);
401
402 UsbCommand c = {CMD_SETUP_WRITE};
403 for (int i = 0; i < 240; i += 48) {
404 memcpy(c.d.asBytes, block_buf + i, 48);
405 c.arg[0] = i / 4;
406 SendCommand(&c);
407 if (wait_for_ack() < 0)
408 return -1;
409 }
410
411 c.cmd = CMD_FINISH_WRITE;
412 c.arg[0] = address;
413 memcpy(c.d.asBytes, block_buf+240, 16);
414 SendCommand(&c);
415 return wait_for_ack();
6e4d4ee6 416}
417
8fe1a992 418// Write a file's segments to Flash
419int flash_write(flash_file_t *ctx)
6e4d4ee6 420{
8fe1a992 421 fprintf(stderr, "Writing segments for file: %s\n", ctx->filename);
422 for (int i = 0; i < ctx->num_segs; i++) {
423 flash_seg_t *seg = &ctx->segments[i];
424
425 uint32_t length = seg->length;
426 uint32_t blocks = (length + BLOCK_SIZE - 1) / BLOCK_SIZE;
427 uint32_t end = seg->start + length;
428
429 fprintf(stderr, " 0x%08x..0x%08x [0x%x / %d blocks]",
430 seg->start, end - 1, length, blocks);
431
432 int block = 0;
433 uint8_t *data = seg->data;
434 uint32_t baddr = seg->start;
435
436 while (length) {
437 uint32_t block_size = length;
438 if (block_size > BLOCK_SIZE)
439 block_size = BLOCK_SIZE;
440
441 if (write_block(baddr, data, block_size) < 0) {
442 fprintf(stderr, " ERROR\n");
443 fprintf(stderr, "Error writing block %d of %d\n", block, blocks);
444 return -1;
445 }
446
447 data += block_size;
448 baddr += block_size;
449 length -= block_size;
450 block++;
451 fprintf(stderr, ".");
452 }
453 fprintf(stderr, " OK\n");
454 }
455 return 0;
6e4d4ee6 456}
457
8fe1a992 458// free a file context
459void flash_free(flash_file_t *ctx)
7fe9b0b7 460{
8fe1a992 461 if (!ctx)
462 return;
463 if (ctx->segments) {
464 for (int i = 0; i < ctx->num_segs; i++)
465 free(ctx->segments[i].data);
466 free(ctx->segments);
467 ctx->segments = NULL;
468 ctx->num_segs = 0;
469 }
470}
471
472// just reset the unit
473int flash_stop_flashing(void) {
474 UsbCommand c = {CMD_HARDWARE_RESET};
475 SendCommand(&c);
476 return 0;
6e4d4ee6 477}
Impressum, Datenschutz