flash.c 30.5 KB
Newer Older
oharboe's avatar
oharboe committed
1
2
3
4
/***************************************************************************
 *   Copyright (C) 2005 by Dominic Rath                                    *
 *   Dominic.Rath@gmx.de                                                   *
 *                                                                         *
5
 *   Copyright (C) 2007,2008 yvind Harboe                                 *
6
7
 *   oyvind.harboe@zylin.com                                               *
 *                                                                         *
8
9
10
 *   Copyright (C) 2008 by Spencer Oliver                                  *
 *   spen@spen-soft.co.uk                                                  *
 *                                                                         *
oharboe's avatar
oharboe committed
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif

#include "flash.h"
#include "command.h"
#include "target.h"
#include "time_support.h"
#include "fileio.h"
#include "image.h"
#include "log.h"
oharboe's avatar
   
oharboe committed
37
38
39
40
#include "armv4_5.h"
#include "algorithm.h"
#include "binarybuffer.h"
#include "armv7m.h"
oharboe's avatar
oharboe committed
41
42
43
44
45
46
47
48
49
50

#include <string.h>
#include <unistd.h>
#include <stdlib.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <errno.h>
#include <inttypes.h>

/* command handlers */
mifi's avatar
mifi committed
51
52
53
54
55
56
57
58
59
60
61
static int handle_flash_bank_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
static int handle_flash_info_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
static int handle_flash_probe_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
static int handle_flash_erase_check_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
static int handle_flash_erase_address_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
static int handle_flash_protect_check_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
static int handle_flash_erase_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
static int handle_flash_write_bank_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
static int handle_flash_write_image_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
static int handle_flash_fill_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
static int handle_flash_protect_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
oharboe's avatar
oharboe committed
62
63
64
65
66
67

/* flash drivers
 */
extern flash_driver_t lpc2000_flash;
extern flash_driver_t cfi_flash;
extern flash_driver_t at91sam7_flash;
68
extern flash_driver_t at91sam7_old_flash;
oharboe's avatar
oharboe committed
69
70
extern flash_driver_t str7x_flash;
extern flash_driver_t str9x_flash;
71
extern flash_driver_t aduc702x_flash;
oharboe's avatar
oharboe committed
72
73
74
75
extern flash_driver_t stellaris_flash;
extern flash_driver_t str9xpec_flash;
extern flash_driver_t stm32x_flash;
extern flash_driver_t tms470_flash;
ntfreak's avatar
ntfreak committed
76
extern flash_driver_t ecosflash_flash;
77
extern flash_driver_t lpc288x_flash;
oharboe's avatar
oharboe committed
78
extern flash_driver_t ocl_flash;
79
extern flash_driver_t pic32mx_flash;
80
extern flash_driver_t avr_flash;
oharboe's avatar
oharboe committed
81

82
flash_driver_t *flash_drivers[] = {
83
84
85
86
87
88
89
90
91
92
93
94
95
96
	&lpc2000_flash,
	&cfi_flash,
	&at91sam7_flash,
	&at91sam7_old_flash,
	&str7x_flash,
	&str9x_flash,
	&aduc702x_flash,
	&stellaris_flash,
	&str9xpec_flash,
	&stm32x_flash,
	&tms470_flash,
	&ecosflash_flash,
	&lpc288x_flash,
	&ocl_flash,
97
	&pic32mx_flash,
98
	&avr_flash,
99
	NULL,
oharboe's avatar
oharboe committed
100
101
102
103
};

flash_bank_t *flash_banks;
static 	command_t *flash_cmd;
104

oharboe's avatar
oharboe committed
105
106
107
/* wafer thin wrapper for invoking the flash driver */
static int flash_driver_write(struct flash_bank_s *bank, u8 *buffer, u32 offset, u32 count)
{
108
109
110
	int retval;

	retval=bank->driver->write(bank, buffer, offset, count);
oharboe's avatar
oharboe committed
111
112
	if (retval!=ERROR_OK)
	{
113
		LOG_ERROR("error writing to flash at address 0x%08x at offset 0x%8.8x (%d)", bank->base, offset, retval);
oharboe's avatar
oharboe committed
114
	}
115

oharboe's avatar
oharboe committed
116
117
118
119
120
	return retval;
}

static int flash_driver_erase(struct flash_bank_s *bank, int first, int last)
{
121
122
123
	int retval;

	retval=bank->driver->erase(bank, first, last);
oharboe's avatar
oharboe committed
124
125
	if (retval!=ERROR_OK)
	{
126
		LOG_ERROR("failed erasing sectors %d to %d (%d)", first, last, retval);
oharboe's avatar
oharboe committed
127
	}
128

oharboe's avatar
oharboe committed
129
130
131
132
133
134
	return retval;
}

int flash_driver_protect(struct flash_bank_s *bank, int set, int first, int last)
{
	int retval;
135
136

	retval=bank->driver->protect(bank, set, first, last);
oharboe's avatar
oharboe committed
137
138
	if (retval!=ERROR_OK)
	{
139
		LOG_ERROR("failed setting protection for areas %d to %d (%d)", first, last, retval);
oharboe's avatar
oharboe committed
140
	}
141

oharboe's avatar
oharboe committed
142
143
144
145
146
147
	return retval;
}

int flash_register_commands(struct command_context_s *cmd_ctx)
{
	flash_cmd = register_command(cmd_ctx, NULL, "flash", NULL, COMMAND_ANY, NULL);
ntfreak's avatar
ntfreak committed
148

ntfreak's avatar
ntfreak committed
149
	register_command(cmd_ctx, flash_cmd, "bank", handle_flash_bank_command, COMMAND_CONFIG, "flash bank <driver> <base> <size> <chip_width> <bus_width> <target> [driver_options ...]");
oharboe's avatar
oharboe committed
150
151
152
	return ERROR_OK;
}

153
static int jim_flash_banks(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
oharboe's avatar
oharboe committed
154
{
155
	flash_bank_t *p;
oharboe's avatar
oharboe committed
156

oharboe's avatar
oharboe committed
157
158
159
160
161
162
163
164
165
	if (argc != 1) {
		Jim_WrongNumArgs(interp, 1, argv, "no arguments to flash_banks command");
		return JIM_ERR;
	}

	Jim_Obj *list=Jim_NewListObj(interp, NULL, 0);
	for (p = flash_banks; p; p = p->next)
	{
		Jim_Obj *elem=Jim_NewListObj(interp, NULL, 0);
oharboe's avatar
oharboe committed
166

167
		Jim_ListAppendElement(interp, elem, Jim_NewStringObj(interp, "name", -1));
oharboe's avatar
oharboe committed
168
		Jim_ListAppendElement(interp, elem, Jim_NewStringObj(interp, p->driver->name, -1));
169
		Jim_ListAppendElement(interp, elem, Jim_NewStringObj(interp, "base", -1));
oharboe's avatar
oharboe committed
170
		Jim_ListAppendElement(interp, elem, Jim_NewIntObj(interp, p->base));
171
		Jim_ListAppendElement(interp, elem, Jim_NewStringObj(interp, "size", -1));
oharboe's avatar
oharboe committed
172
		Jim_ListAppendElement(interp, elem, Jim_NewIntObj(interp, p->size));
173
		Jim_ListAppendElement(interp, elem, Jim_NewStringObj(interp, "bus_width", -1));
oharboe's avatar
oharboe committed
174
		Jim_ListAppendElement(interp, elem, Jim_NewIntObj(interp, p->bus_width));
175
		Jim_ListAppendElement(interp, elem, Jim_NewStringObj(interp, "chip_width", -1));
oharboe's avatar
oharboe committed
176
		Jim_ListAppendElement(interp, elem, Jim_NewIntObj(interp, p->chip_width));
oharboe's avatar
oharboe committed
177

178
		Jim_ListAppendElement(interp, list, elem);
oharboe's avatar
oharboe committed
179
180
181
182
183
184
185
	}

	Jim_SetResult(interp, list);

	return JIM_OK;
}

oharboe's avatar
oharboe committed
186
187
int flash_init_drivers(struct command_context_s *cmd_ctx)
{
188
189
	register_jim(cmd_ctx, "ocd_flash_banks", jim_flash_banks, "return information about the flash banks");

oharboe's avatar
oharboe committed
190
191
192
193
194
195
196
197
198
199
200
201
202
203
	if (flash_banks)
	{
		register_command(cmd_ctx, flash_cmd, "info", handle_flash_info_command, COMMAND_EXEC,
						 "print info about flash bank <num>");
		register_command(cmd_ctx, flash_cmd, "probe", handle_flash_probe_command, COMMAND_EXEC,
						 "identify flash bank <num>");
		register_command(cmd_ctx, flash_cmd, "erase_check", handle_flash_erase_check_command, COMMAND_EXEC,
						 "check erase state of sectors in flash bank <num>");
		register_command(cmd_ctx, flash_cmd, "protect_check", handle_flash_protect_check_command, COMMAND_EXEC,
						 "check protection state of sectors in flash bank <num>");
		register_command(cmd_ctx, flash_cmd, "erase_sector", handle_flash_erase_command, COMMAND_EXEC,
						 "erase sectors at <bank> <first> <last>");
		register_command(cmd_ctx, flash_cmd, "erase_address", handle_flash_erase_address_command, COMMAND_EXEC,
						 "erase address range <address> <length>");
oharboe's avatar
   
oharboe committed
204
205

		register_command(cmd_ctx, flash_cmd, "fillw", handle_flash_fill_command, COMMAND_EXEC,
oharboe's avatar
oharboe committed
206
						 "fill with pattern (no autoerase) <address> <word_pattern> <count>");
oharboe's avatar
   
oharboe committed
207
208
209
210
211
		register_command(cmd_ctx, flash_cmd, "fillh", handle_flash_fill_command, COMMAND_EXEC,
						 "fill with pattern <address> <halfword_pattern> <count>");
		register_command(cmd_ctx, flash_cmd, "fillb", handle_flash_fill_command, COMMAND_EXEC,
						 "fill with pattern <address> <byte_pattern> <count>");

oharboe's avatar
oharboe committed
212
213
214
		register_command(cmd_ctx, flash_cmd, "write_bank", handle_flash_write_bank_command, COMMAND_EXEC,
						 "write binary data to <bank> <file> <offset>");
		register_command(cmd_ctx, flash_cmd, "write_image", handle_flash_write_image_command, COMMAND_EXEC,
215
						 "write_image [erase] <file> [offset] [type]");
oharboe's avatar
oharboe committed
216
217
218
		register_command(cmd_ctx, flash_cmd, "protect", handle_flash_protect_command, COMMAND_EXEC,
						 "set protection of sectors at <bank> <first> <last> <on|off>");
	}
ntfreak's avatar
ntfreak committed
219

oharboe's avatar
oharboe committed
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
	return ERROR_OK;
}

flash_bank_t *get_flash_bank_by_num_noprobe(int num)
{
	flash_bank_t *p;
	int i = 0;

	for (p = flash_banks; p; p = p->next)
	{
		if (i++ == num)
		{
			return p;
		}
	}
235
	LOG_ERROR("flash bank %d does not exist", num);
oharboe's avatar
oharboe committed
236
237
238
	return NULL;
}

oharboe's avatar
oharboe committed
239
int flash_get_bank_count(void)
oharboe's avatar
oharboe committed
240
241
242
243
244
245
246
247
248
249
{
	flash_bank_t *p;
	int i = 0;
	for (p = flash_banks; p; p = p->next)
	{
		i++;
	}
	return i;
}

oharboe's avatar
oharboe committed
250
251
252
253
flash_bank_t *get_flash_bank_by_num(int num)
{
	flash_bank_t *p = get_flash_bank_by_num_noprobe(num);
	int retval;
ntfreak's avatar
ntfreak committed
254

oharboe's avatar
oharboe committed
255
256
	if (p == NULL)
		return NULL;
ntfreak's avatar
ntfreak committed
257

oharboe's avatar
oharboe committed
258
	retval = p->driver->auto_probe(p);
ntfreak's avatar
ntfreak committed
259

oharboe's avatar
oharboe committed
260
261
	if (retval != ERROR_OK)
	{
262
		LOG_ERROR("auto_probe failed %d\n", retval);
oharboe's avatar
oharboe committed
263
264
265
266
267
		return NULL;
	}
	return p;
}

mifi's avatar
mifi committed
268
static int handle_flash_bank_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
oharboe's avatar
oharboe committed
269
{
oharboe's avatar
oharboe committed
270
	int retval;
oharboe's avatar
oharboe committed
271
272
273
	int i;
	int found = 0;
	target_t *target;
ntfreak's avatar
ntfreak committed
274

oharboe's avatar
oharboe committed
275
276
277
278
	if (argc < 6)
	{
		return ERROR_COMMAND_SYNTAX_ERROR;
	}
ntfreak's avatar
ntfreak committed
279

oharboe's avatar
oharboe committed
280
281
	if ((target = get_target_by_num(strtoul(args[5], NULL, 0))) == NULL)
	{
282
		LOG_ERROR("target %lu not defined", strtoul(args[5], NULL, 0));
oharboe's avatar
oharboe committed
283
		return ERROR_FAIL;
oharboe's avatar
oharboe committed
284
	}
ntfreak's avatar
ntfreak committed
285

oharboe's avatar
oharboe committed
286
287
288
289
290
	for (i = 0; flash_drivers[i]; i++)
	{
		if (strcmp(args[0], flash_drivers[i]->name) == 0)
		{
			flash_bank_t *p, *c;
ntfreak's avatar
ntfreak committed
291

oharboe's avatar
oharboe committed
292
293
294
			/* register flash specific commands */
			if (flash_drivers[i]->register_commands(cmd_ctx) != ERROR_OK)
			{
295
				LOG_ERROR("couldn't register '%s' commands", args[0]);
oharboe's avatar
oharboe committed
296
				return ERROR_FAIL;
oharboe's avatar
oharboe committed
297
			}
ntfreak's avatar
ntfreak committed
298

oharboe's avatar
oharboe committed
299
300
301
302
303
304
305
306
307
308
309
			c = malloc(sizeof(flash_bank_t));
			c->target = target;
			c->driver = flash_drivers[i];
			c->driver_priv = NULL;
			c->base = strtoul(args[1], NULL, 0);
			c->size = strtoul(args[2], NULL, 0);
			c->chip_width = strtoul(args[3], NULL, 0);
			c->bus_width = strtoul(args[4], NULL, 0);
			c->num_sectors = 0;
			c->sectors = NULL;
			c->next = NULL;
ntfreak's avatar
ntfreak committed
310

oharboe's avatar
oharboe committed
311
			if ((retval=flash_drivers[i]->flash_bank_command(cmd_ctx, cmd, args, argc, c)) != ERROR_OK)
oharboe's avatar
oharboe committed
312
			{
313
				LOG_ERROR("'%s' driver rejected flash bank at 0x%8.8x", args[0], c->base);
oharboe's avatar
oharboe committed
314
				free(c);
oharboe's avatar
oharboe committed
315
				return retval;
oharboe's avatar
oharboe committed
316
			}
ntfreak's avatar
ntfreak committed
317

oharboe's avatar
oharboe committed
318
319
320
			/* put flash bank in linked list */
			if (flash_banks)
			{
321
				int	bank_num = 0;
oharboe's avatar
oharboe committed
322
				/* find last flash bank */
323
				for (p = flash_banks; p && p->next; p = p->next) bank_num++;
oharboe's avatar
oharboe committed
324
325
				if (p)
					p->next = c;
326
				c->bank_number = bank_num + 1;
oharboe's avatar
oharboe committed
327
328
329
330
			}
			else
			{
				flash_banks = c;
331
				c->bank_number = 0;
oharboe's avatar
oharboe committed
332
			}
ntfreak's avatar
ntfreak committed
333

oharboe's avatar
oharboe committed
334
335
336
			found = 1;
		}
	}
ntfreak's avatar
ntfreak committed
337

oharboe's avatar
oharboe committed
338
339
340
	/* no matching flash driver found */
	if (!found)
	{
341
		LOG_ERROR("flash driver '%s' not found", args[0]);
oharboe's avatar
oharboe committed
342
		return ERROR_FAIL;
oharboe's avatar
oharboe committed
343
	}
ntfreak's avatar
ntfreak committed
344

oharboe's avatar
oharboe committed
345
346
347
	return ERROR_OK;
}

mifi's avatar
mifi committed
348
static int handle_flash_info_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
oharboe's avatar
oharboe committed
349
350
{
	flash_bank_t *p;
351
	u32 i = 0;
oharboe's avatar
oharboe committed
352
	int j = 0;
353
	int retval;
ntfreak's avatar
ntfreak committed
354

oharboe's avatar
oharboe committed
355
356
357
358
	if (argc != 1)
	{
		return ERROR_COMMAND_SYNTAX_ERROR;
	}
ntfreak's avatar
ntfreak committed
359

oharboe's avatar
oharboe committed
360
361
362
363
364
	for (p = flash_banks; p; p = p->next, i++)
	{
		if (i == strtoul(args[0], NULL, 0))
		{
			char buf[1024];
ntfreak's avatar
ntfreak committed
365

oharboe's avatar
oharboe committed
366
			/* attempt auto probe */
367
368
			if ((retval = p->driver->auto_probe(p)) != ERROR_OK)
				return retval;
ntfreak's avatar
ntfreak committed
369

oharboe's avatar
oharboe committed
370
371
372
373
			command_print(cmd_ctx, "#%i: %s at 0x%8.8x, size 0x%8.8x, buswidth %i, chipwidth %i",
						i, p->driver->name, p->base, p->size, p->bus_width, p->chip_width);
			for (j = 0; j < p->num_sectors; j++)
			{
oharboe's avatar
   
oharboe committed
374
				char *protect_state;
ntfreak's avatar
ntfreak committed
375

oharboe's avatar
oharboe committed
376
377
378
379
380
381
382
				if (p->sectors[j].is_protected == 0)
					protect_state = "not protected";
				else if (p->sectors[j].is_protected == 1)
					protect_state = "protected";
				else
					protect_state = "protection state unknown";

383
				command_print(cmd_ctx, "\t#%3i: 0x%8.8x (0x%x %ikB) %s",
oharboe's avatar
oharboe committed
384
							j, p->sectors[j].offset, p->sectors[j].size, p->sectors[j].size>>10,
oharboe's avatar
   
oharboe committed
385
							protect_state);
oharboe's avatar
oharboe committed
386
			}
ntfreak's avatar
ntfreak committed
387

388
389
			*buf = '\0'; /* initialize buffer, otherwise it migh contain garbage if driver function fails */
			retval = p->driver->info(p, buf, sizeof(buf));
oharboe's avatar
oharboe committed
390
			command_print(cmd_ctx, "%s", buf);
391
			if (retval != ERROR_OK)
392
				LOG_ERROR("error retrieving flash info (%d)", retval);
oharboe's avatar
oharboe committed
393
394
		}
	}
ntfreak's avatar
ntfreak committed
395

oharboe's avatar
oharboe committed
396
397
398
	return ERROR_OK;
}

mifi's avatar
mifi committed
399
static int handle_flash_probe_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
oharboe's avatar
oharboe committed
400
401
402
{
	flash_bank_t *p;
	int retval;
ntfreak's avatar
ntfreak committed
403

oharboe's avatar
oharboe committed
404
405
406
407
	if (argc != 1)
	{
		return ERROR_COMMAND_SYNTAX_ERROR;
	}
ntfreak's avatar
ntfreak committed
408

oharboe's avatar
oharboe committed
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
	p = get_flash_bank_by_num_noprobe(strtoul(args[0], NULL, 0));
	if (p)
	{
		if ((retval = p->driver->probe(p)) == ERROR_OK)
		{
			command_print(cmd_ctx, "flash '%s' found at 0x%8.8x", p->driver->name, p->base);
		}
		else if (retval == ERROR_FLASH_BANK_INVALID)
		{
			command_print(cmd_ctx, "probing failed for flash bank '#%s' at 0x%8.8x",
						  args[0], p->base);
		}
		else
		{
			command_print(cmd_ctx, "unknown error when probing flash bank '#%s' at 0x%8.8x",
						  args[0], p->base);
		}
	}
	else
	{
		command_print(cmd_ctx, "flash bank '#%s' is out of bounds", args[0]);
	}
ntfreak's avatar
ntfreak committed
431

oharboe's avatar
oharboe committed
432
433
434
	return ERROR_OK;
}

mifi's avatar
mifi committed
435
static int handle_flash_erase_check_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
oharboe's avatar
oharboe committed
436
437
438
{
	flash_bank_t *p;
	int retval;
ntfreak's avatar
ntfreak committed
439

oharboe's avatar
oharboe committed
440
441
442
443
	if (argc != 1)
	{
		return ERROR_COMMAND_SYNTAX_ERROR;
	}
ntfreak's avatar
ntfreak committed
444

oharboe's avatar
oharboe committed
445
446
447
	p = get_flash_bank_by_num(strtoul(args[0], NULL, 0));
	if (p)
	{
oharboe's avatar
   
oharboe committed
448
		int j;
oharboe's avatar
oharboe committed
449
450
451
452
453
454
455
456
457
		if ((retval = p->driver->erase_check(p)) == ERROR_OK)
		{
			command_print(cmd_ctx, "successfully checked erase state", p->driver->name, p->base);
		}
		else
		{
			command_print(cmd_ctx, "unknown error when checking erase state of flash bank #%s at 0x%8.8x",
				args[0], p->base);
		}
oharboe's avatar
oharboe committed
458

oharboe's avatar
   
oharboe committed
459
460
461
462
463
464
465
466
467
468
469
		for (j = 0; j < p->num_sectors; j++)
		{
			char *erase_state;

			if (p->sectors[j].is_erased == 0)
				erase_state = "not erased";
			else if (p->sectors[j].is_erased == 1)
				erase_state = "erased";
			else
				erase_state = "erase state unknown";

470
			command_print(cmd_ctx, "\t#%3i: 0x%8.8x (0x%x %ikB) %s",
oharboe's avatar
   
oharboe committed
471
472
473
						j, p->sectors[j].offset, p->sectors[j].size, p->sectors[j].size>>10,
						erase_state);
		}
oharboe's avatar
oharboe committed
474
	}
ntfreak's avatar
ntfreak committed
475

oharboe's avatar
oharboe committed
476
477
478
	return ERROR_OK;
}

mifi's avatar
mifi committed
479
static int handle_flash_erase_address_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
oharboe's avatar
oharboe committed
480
481
482
483
484
485
486
{
	flash_bank_t *p;
	int retval;
	int address;
	int length;
	duration_t duration;
	char *duration_text;
ntfreak's avatar
ntfreak committed
487

oharboe's avatar
oharboe committed
488
489
490
491
492
493
	target_t *target = get_current_target(cmd_ctx);

	if (argc != 2)
	{
		return ERROR_COMMAND_SYNTAX_ERROR;
	}
ntfreak's avatar
ntfreak committed
494

oharboe's avatar
oharboe committed
495
496
497
498
499
500
501
502
503
504
505
	address = strtoul(args[0], NULL, 0);
	length = strtoul(args[1], NULL, 0);
	if (length <= 0)
	{
		command_print(cmd_ctx, "Length must be >0");
		return ERROR_COMMAND_SYNTAX_ERROR;
	}

	p = get_flash_bank_by_addr(target, address);
	if (p == NULL)
	{
oharboe's avatar
oharboe committed
506
		return ERROR_FAIL;
oharboe's avatar
oharboe committed
507
	}
ntfreak's avatar
ntfreak committed
508

oharboe's avatar
oharboe committed
509
510
	/* We can't know if we did a resume + halt, in which case we no longer know the erased state */
	flash_set_dirty();
ntfreak's avatar
ntfreak committed
511

oharboe's avatar
oharboe committed
512
	duration_start_measure(&duration);
ntfreak's avatar
ntfreak committed
513

oharboe's avatar
oharboe committed
514
515
	if ((retval = flash_erase_address_range(target, address, length)) == ERROR_OK)
	{
516
517
518
519
		if ((retval = duration_stop_measure(&duration, &duration_text)) != ERROR_OK)
		{
			return retval;
		}
oharboe's avatar
oharboe committed
520
521
522
		command_print(cmd_ctx, "erased address 0x%8.8x length %i in %s", address, length, duration_text);
		free(duration_text);
	}
ntfreak's avatar
ntfreak committed
523

oharboe's avatar
oharboe committed
524
525
526
	return retval;
}

mifi's avatar
mifi committed
527
static int handle_flash_protect_check_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
oharboe's avatar
oharboe committed
528
529
530
{
	flash_bank_t *p;
	int retval;
ntfreak's avatar
ntfreak committed
531

oharboe's avatar
oharboe committed
532
533
534
535
	if (argc != 1)
	{
		return ERROR_COMMAND_SYNTAX_ERROR;
	}
ntfreak's avatar
ntfreak committed
536

oharboe's avatar
oharboe committed
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
	p = get_flash_bank_by_num(strtoul(args[0], NULL, 0));
	if (p)
	{
		if ((retval = p->driver->protect_check(p)) == ERROR_OK)
		{
			command_print(cmd_ctx, "successfully checked protect state");
		}
		else if (retval == ERROR_FLASH_OPERATION_FAILED)
		{
			command_print(cmd_ctx, "checking protection state failed (possibly unsupported) by flash #%s at 0x%8.8x", args[0], p->base);
		}
		else
		{
			command_print(cmd_ctx, "unknown error when checking protection state of flash bank '#%s' at 0x%8.8x", args[0], p->base);
		}
	}
	else
	{
		return ERROR_COMMAND_SYNTAX_ERROR;
	}
ntfreak's avatar
ntfreak committed
557

oharboe's avatar
oharboe committed
558
559
560
	return ERROR_OK;
}

mifi's avatar
mifi committed
561
static int handle_flash_erase_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
oharboe's avatar
oharboe committed
562
563
564
565
566
567
568
569
570
{
	if (argc > 2)
	{
		int first = strtoul(args[1], NULL, 0);
		int last = strtoul(args[2], NULL, 0);
		int retval;
		flash_bank_t *p = get_flash_bank_by_num(strtoul(args[0], NULL, 0));
		duration_t duration;
		char *duration_text;
ntfreak's avatar
ntfreak committed
571

oharboe's avatar
oharboe committed
572
		duration_start_measure(&duration);
ntfreak's avatar
ntfreak committed
573

oharboe's avatar
oharboe committed
574
575
576
577
		if (!p)
		{
			return ERROR_COMMAND_SYNTAX_ERROR;
		}
ntfreak's avatar
ntfreak committed
578

oharboe's avatar
oharboe committed
579
580
		if ((retval = flash_driver_erase(p, first, last)) == ERROR_OK)
		{
581
582
583
584
			if ((retval = duration_stop_measure(&duration, &duration_text)) != ERROR_OK)
			{
				return retval;
			}
ntfreak's avatar
ntfreak committed
585

oharboe's avatar
oharboe committed
586
587
588
589
590
591
592
593
594
595
596
597
			command_print(cmd_ctx, "erased sectors %i through %i on flash bank %i in %s", first, last, strtoul(args[0], 0, 0), duration_text);
			free(duration_text);
		}
	}
	else
	{
		return ERROR_COMMAND_SYNTAX_ERROR;
	}

	return ERROR_OK;
}

mifi's avatar
mifi committed
598
static int handle_flash_protect_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
oharboe's avatar
oharboe committed
599
600
601
602
603
604
605
606
607
608
609
610
611
{
	if (argc > 3)
	{
		int first = strtoul(args[1], NULL, 0);
		int last = strtoul(args[2], NULL, 0);
		int set;
		int retval;
		flash_bank_t *p = get_flash_bank_by_num(strtoul(args[0], NULL, 0));
		if (!p)
		{
			command_print(cmd_ctx, "flash bank '#%s' is out of bounds", args[0]);
			return ERROR_OK;
		}
ntfreak's avatar
ntfreak committed
612

oharboe's avatar
oharboe committed
613
614
615
616
617
618
619
620
		if (strcmp(args[3], "on") == 0)
			set = 1;
		else if (strcmp(args[3], "off") == 0)
			set = 0;
		else
		{
			return ERROR_COMMAND_SYNTAX_ERROR;
		}
ntfreak's avatar
ntfreak committed
621

oharboe's avatar
oharboe committed
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
		retval = flash_driver_protect(p, set, first, last);
		if (retval == ERROR_OK)
		{
			command_print(cmd_ctx, "%s protection for sectors %i through %i on flash bank %i", (set) ? "set" : "cleared", first, last, strtoul(args[0], 0, 0));
		}
	}
	else
	{
		return ERROR_COMMAND_SYNTAX_ERROR;

	}

	return ERROR_OK;
}

mifi's avatar
mifi committed
637
static int handle_flash_write_image_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
oharboe's avatar
oharboe committed
638
639
{
	target_t *target = get_current_target(cmd_ctx);
ntfreak's avatar
ntfreak committed
640

oharboe's avatar
oharboe committed
641
642
	image_t image;
	u32 written;
ntfreak's avatar
ntfreak committed
643

oharboe's avatar
oharboe committed
644
645
	duration_t duration;
	char *duration_text;
ntfreak's avatar
ntfreak committed
646

647
	int retval, retvaltemp;
oharboe's avatar
oharboe committed
648
649
650
651
652

	if (argc < 1)
	{
		return ERROR_COMMAND_SYNTAX_ERROR;
	}
oharboe's avatar
oharboe committed
653

654
655
	/* flash auto-erase is disabled by default*/
	int auto_erase = 0;
oharboe's avatar
oharboe committed
656

ntfreak's avatar
ntfreak committed
657
	if (strcmp(args[0], "erase")==0)
658
659
660
661
662
663
	{
		auto_erase = 1;
		args++;
		argc--;
		command_print(cmd_ctx, "auto erase enabled");
	}
oharboe's avatar
oharboe committed
664

665
666
667
668
	if (argc < 1)
	{
		return ERROR_COMMAND_SYNTAX_ERROR;
	}
oharboe's avatar
oharboe committed
669

oharboe's avatar
oharboe committed
670
671
	if (!target)
	{
672
		LOG_ERROR("no target selected");
673
		return ERROR_FAIL;
oharboe's avatar
oharboe committed
674
	}
ntfreak's avatar
ntfreak committed
675

oharboe's avatar
oharboe committed
676
	duration_start_measure(&duration);
ntfreak's avatar
ntfreak committed
677

oharboe's avatar
oharboe committed
678
679
680
681
682
683
684
685
686
687
	if (argc >= 2)
	{
		image.base_address_set = 1;
		image.base_address = strtoul(args[1], NULL, 0);
	}
	else
	{
		image.base_address_set = 0;
		image.base_address = 0x0;
	}
ntfreak's avatar
ntfreak committed
688

oharboe's avatar
oharboe committed
689
690
691
692
693
694
695
	image.start_address_set = 0;

	retval = image_open(&image, args[0], (argc == 3) ? args[2] : NULL);
	if (retval != ERROR_OK)
	{
		return retval;
	}
ntfreak's avatar
ntfreak committed
696

oharboe's avatar
oharboe committed
697
698
699
700
701
702
	retval = flash_write(target, &image, &written, auto_erase);
	if (retval != ERROR_OK)
	{
		image_close(&image);
		return retval;
	}
ntfreak's avatar
ntfreak committed
703

704
705
706
707
708
	if ((retvaltemp = duration_stop_measure(&duration, &duration_text)) != ERROR_OK)
	{
		image_close(&image);
		return retvaltemp;
	}
oharboe's avatar
oharboe committed
709
710
	if (retval == ERROR_OK)
	{
711
712
713
		command_print(cmd_ctx, "wrote %u byte from file %s in %s (%f kb/s)",
				written, args[0], duration_text,
				(float)written / 1024.0 / ((float)duration.duration.tv_sec + ((float)duration.duration.tv_usec / 1000000.0)));
oharboe's avatar
oharboe committed
714
715
716
717
	}
	free(duration_text);

	image_close(&image);
ntfreak's avatar
ntfreak committed
718

oharboe's avatar
oharboe committed
719
720
721
	return retval;
}

mifi's avatar
mifi committed
722
static int handle_flash_fill_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
oharboe's avatar
   
oharboe committed
723
{
724
	int err = ERROR_OK, retval;
oharboe's avatar
   
oharboe committed
725
726
727
728
729
	u32 address;
	u32 pattern;
	u32 count;
	u8 chunk[1024];
	u32 wrote = 0;
730
	u32 cur_size = 0;
731
	u32 chunk_count;
oharboe's avatar
   
oharboe committed
732
733
734
735
	char *duration_text;
	duration_t duration;
	target_t *target = get_current_target(cmd_ctx);
	u32 i;
736
	u32 wordsize;
oharboe's avatar
oharboe committed
737

oharboe's avatar
   
oharboe committed
738
739
740
741
	if (argc != 3)
	{
		return ERROR_COMMAND_SYNTAX_ERROR;
	}
oharboe's avatar
oharboe committed
742

oharboe's avatar
   
oharboe committed
743
744
745
	address	= strtoul(args[0], NULL, 0);
	pattern	= strtoul(args[1], NULL, 0);
	count 	= strtoul(args[2], NULL, 0);
oharboe's avatar
oharboe committed
746

oharboe's avatar
   
oharboe committed
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
	if(count == 0)
		return ERROR_OK;

	switch(cmd[4])
	{
	case 'w':
		wordsize=4;
		break;
	case 'h':
		wordsize=2;
		break;
	case 'b':
		wordsize=1;
		break;
	default:
		return ERROR_COMMAND_SYNTAX_ERROR;
	}
oharboe's avatar
oharboe committed
764

oharboe's avatar
   
oharboe committed
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
	chunk_count = MIN(count, (1024 / wordsize));
	switch(wordsize)
	{
	case 4:
		for(i = 0; i < chunk_count; i++)
		{
			target_buffer_set_u32(target, chunk + i * wordsize, pattern);
		}
		break;
	case 2:
		for(i = 0; i < chunk_count; i++)
		{
			target_buffer_set_u16(target, chunk + i * wordsize, pattern);
		}
		break;
	case 1:
		memset(chunk, pattern, chunk_count);
		break;
	default:
		LOG_ERROR("BUG: can't happen");
		exit(-1);
	}
oharboe's avatar
oharboe committed
787

oharboe's avatar
   
oharboe committed
788
789
	duration_start_measure(&duration);

790
	for (wrote=0; wrote<(count*wordsize); wrote += cur_size)
oharboe's avatar
   
oharboe committed
791
	{
792
		cur_size = MIN( (count*wordsize - wrote), sizeof(chunk) );
oharboe's avatar
oharboe committed
793
794
795
		flash_bank_t *bank;
		bank = get_flash_bank_by_addr(target, address);
		if(bank == NULL)
oharboe's avatar
oharboe committed
796
		{
oharboe's avatar
oharboe committed
797
			return ERROR_FAIL;
oharboe's avatar
   
oharboe committed
798
		}
oharboe's avatar
oharboe committed
799
		err = flash_driver_write(bank, chunk, address - bank->base + wrote, cur_size);
oharboe's avatar
oharboe committed
800
		if (err!=ERROR_OK)
oharboe's avatar
oharboe committed
801
			return err;
oharboe's avatar
   
oharboe committed
802
	}
oharboe's avatar
oharboe committed
803

804
805
806
807
808
	if ((retval = duration_stop_measure(&duration, &duration_text)) != ERROR_OK)
	{
		return retval;
	}

oharboe's avatar
   
oharboe committed
809
810
811
812
813
814
815
816
817
818
819
820
821
	if(err == ERROR_OK)
	{
		float speed;
		speed=wrote / 1024.0;
		speed/=((float)duration.duration.tv_sec + ((float)duration.duration.tv_usec / 1000000.0));
		command_print(cmd_ctx, "wrote %d bytes to 0x%8.8x in %s (%f kb/s)",
			count*wordsize, address, duration_text,
			speed);
	}
	free(duration_text);
	return ERROR_OK;
}

mifi's avatar
mifi committed
822
static int handle_flash_write_bank_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
oharboe's avatar
oharboe committed
823
824
825
826
827
828
{
	u32 offset;
	u8 *buffer;
	u32 buf_cnt;

	fileio_t fileio;
ntfreak's avatar
ntfreak committed
829

oharboe's avatar
oharboe committed
830
831
	duration_t duration;
	char *duration_text;
ntfreak's avatar
ntfreak committed
832

833
	int retval, retvaltemp;
oharboe's avatar
oharboe committed
834
835
836
837
838
839
	flash_bank_t *p;

	if (argc != 3)
	{
		return ERROR_COMMAND_SYNTAX_ERROR;
	}
ntfreak's avatar
ntfreak committed
840

oharboe's avatar
oharboe committed
841
	duration_start_measure(&duration);
ntfreak's avatar
ntfreak committed
842

oharboe's avatar
oharboe committed
843
844
845
846
847
848
849
	offset = strtoul(args[2], NULL, 0);
	p = get_flash_bank_by_num(strtoul(args[0], NULL, 0));
	if (!p)
	{
		command_print(cmd_ctx, "flash bank '#%s' is out of bounds", args[0]);
		return ERROR_OK;
	}
ntfreak's avatar
ntfreak committed
850

oharboe's avatar
oharboe committed
851
852
853
854
	if (fileio_open(&fileio, args[1], FILEIO_READ, FILEIO_BINARY) != ERROR_OK)
	{
		return ERROR_OK;
	}
ntfreak's avatar
ntfreak committed
855

oharboe's avatar
oharboe committed
856
857
858
	buffer = malloc(fileio.size);
	if (fileio_read(&fileio, fileio.size, buffer, &buf_cnt) != ERROR_OK)
	{
859
860
		free(buffer);
		fileio_close(&fileio);
oharboe's avatar
oharboe committed
861
862
		return ERROR_OK;
	}
ntfreak's avatar
ntfreak committed
863

oharboe's avatar
oharboe committed
864
	retval = flash_driver_write(p, buffer, offset, buf_cnt);
ntfreak's avatar
ntfreak committed
865

oharboe's avatar
oharboe committed
866
	free(buffer);
867
	buffer = NULL;
ntfreak's avatar
ntfreak committed
868

869
870
871
872
873
	if ((retvaltemp = duration_stop_measure(&duration, &duration_text)) != ERROR_OK)
	{
		fileio_close(&fileio);
		return retvaltemp;
	}
874
	if (retval==ERROR_OK)
oharboe's avatar
oharboe committed
875
876
877
878
879
880
881
882
	{
	command_print(cmd_ctx, "wrote  %"PRIi64" byte from file %s to flash bank %i at offset 0x%8.8x in %s (%f kb/s)",
		fileio.size, args[1], strtoul(args[0], NULL, 0), offset, duration_text,
		(float)fileio.size / 1024.0 / ((float)duration.duration.tv_sec + ((float)duration.duration.tv_usec / 1000000.0)));
	}
	free(duration_text);

	fileio_close(&fileio);
ntfreak's avatar
ntfreak committed
883

oharboe's avatar
oharboe committed
884
885
886
887
888
889
890
	return retval;
}

void flash_set_dirty(void)
{
	flash_bank_t *c;
	int i;
ntfreak's avatar
ntfreak committed
891

oharboe's avatar
oharboe committed
892
893
894
895
896
	/* set all flash to require erasing */
	for (c = flash_banks; c; c = c->next)
	{
		for (i = 0; i < c->num_sectors; i++)
		{
ntfreak's avatar
ntfreak committed
897
			c->sectors[i].is_erased = 0;
oharboe's avatar
oharboe committed
898
899
900
901
902
903
904
905
906
907
908
909
910
911
		}
	}
}

/* lookup flash bank by address */
flash_bank_t *get_flash_bank_by_addr(target_t *target, u32 addr)
{
	flash_bank_t *c;

	/* cycle through bank list */
	for (c = flash_banks; c; c = c->next)
	{
		int retval;
		retval = c->driver->auto_probe(c);
ntfreak's avatar
ntfreak committed
912

oharboe's avatar
oharboe committed
913
914
		if (retval != ERROR_OK)
		{
915
			LOG_ERROR("auto_probe failed %d\n", retval);
oharboe's avatar
oharboe committed
916
917
918
			return NULL;
		}
		/* check whether address belongs to this flash bank */
919
		if ((addr >= c->base) && (addr <= c->base + (c->size - 1)) && target == c->target)
oharboe's avatar
oharboe committed
920
921
			return c;
	}
922
	LOG_ERROR("No flash at address 0x%08x\n", addr);
oharboe's avatar
oharboe committed
923
924
925
926
927
928
929
930
931
932
	return NULL;
}

/* erase given flash region, selects proper bank according to target and address */
int flash_erase_address_range(target_t *target, u32 addr, u32 length)
{
	flash_bank_t *c;
	int first = -1;
	int last = -1;
	int i;
ntfreak's avatar
ntfreak committed
933

oharboe's avatar
oharboe committed
934
935
936
937
	if ((c = get_flash_bank_by_addr(target, addr)) == NULL)
		return ERROR_FLASH_DST_OUT_OF_BANK; /* no corresponding bank found */

	if (c->size == 0 || c->num_sectors == 0)
938
939
	{
		LOG_ERROR("Bank is invalid");
oharboe's avatar
oharboe committed
940
		return ERROR_FLASH_BANK_INVALID;
941
	}
ntfreak's avatar
ntfreak committed
942

oharboe's avatar
oharboe committed
943
944
945
946
947
	if (length == 0)
	{
		/* special case, erase whole bank when length is zero */
		if (addr != c->base)
			return ERROR_FLASH_DST_BREAKS_ALIGNMENT;
ntfreak's avatar
ntfreak committed
948

oharboe's avatar
oharboe committed
949
950
951
952
		return flash_driver_erase(c, 0, c->num_sectors - 1);
	}

	/* check whether it fits */
953
	if (addr + length - 1 > c->base + c->size - 1)
oharboe's avatar
oharboe committed
954
		return ERROR_FLASH_DST_BREAKS_ALIGNMENT;
ntfreak's avatar
ntfreak committed
955

oharboe's avatar
oharboe committed
956
	addr -= c->base;
ntfreak's avatar
ntfreak committed
957

oharboe's avatar
oharboe committed
958
	for (i = 0; i < c->num_sectors; i++)
ntfreak's avatar
ntfreak committed
959
	{
oharboe's avatar
oharboe committed
960
961
962
963
964
965
966
967
		/* check whether sector overlaps with the given range and is not yet erased */
		if (addr < c->sectors[i].offset + c->sectors[i].size && addr + length > c->sectors[i].offset && c->sectors[i].is_erased != 1) {
			/* if first is not set yet then this is the first sector */
			if (first == -1)
				first = i;
			last = i; /* and it is the last one so far in any case */
		}
	}
ntfreak's avatar
ntfreak committed
968

oharboe's avatar
oharboe committed
969
970
	if( first == -1 || last == -1 )
		return ERROR_OK;
ntfreak's avatar
ntfreak committed
971

oharboe's avatar
oharboe committed
972
973
974
975
976
977
	return flash_driver_erase(c, first, last);
}

/* write (optional verify) an image to flash memory of the given target */
int flash_write(target_t *target, image_t *image, u32 *written, int erase)
{
978
	int retval=ERROR_OK;
oharboe's avatar
oharboe committed
979
980
981
982

	int section;
	u32 section_offset;
	flash_bank_t *c;
983
	int *padding;
oharboe's avatar
oharboe committed
984

oharboe's avatar
oharboe committed
985
986
987
988
989
	section = 0;
	section_offset = 0;

	if (written)
		*written = 0;
ntfreak's avatar
ntfreak committed
990

oharboe's avatar
oharboe committed
991
992
993
994
	if (erase)
	{
		/* assume all sectors need erasing - stops any problems
		 * when flash_write is called multiple times */
ntfreak's avatar
ntfreak committed
995

oharboe's avatar
oharboe committed
996
997
		flash_set_dirty();
	}
oharboe's avatar
oharboe committed
998

999
1000
	/* allocate padding array */
	padding = malloc(image->num_sections * sizeof(padding));
For faster browsing, not all history is shown. View entire blame