ecos.c 12.9 KB
Newer Older
ntfreak's avatar
ntfreak committed
1
/***************************************************************************
2
 *   Copyright (C) 2007,2008 yvind Harboe                                 *
ntfreak's avatar
ntfreak committed
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
 *   oyvind.harboe@zylin.com                                               *
 *                                                                         *
 *   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"
25
26
#include "embeddedice.h"
#include "image.h"
ntfreak's avatar
ntfreak committed
27
28


mifi's avatar
mifi committed
29
30
31
32
static int ecosflash_register_commands(struct command_context_s *cmd_ctx);
static int ecosflash_flash_bank_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc, struct flash_bank_s *bank);
static int ecosflash_erase(struct flash_bank_s *bank, int first, int last);
static int ecosflash_protect(struct flash_bank_s *bank, int set, int first, int last);
33
static int ecosflash_write(struct flash_bank_s *bank, uint8_t *buffer, uint32_t offset, uint32_t count);
mifi's avatar
mifi committed
34
35
36
37
38
static int ecosflash_probe(struct flash_bank_s *bank);
static int ecosflash_protect_check(struct flash_bank_s *bank);
static int ecosflash_info(struct flash_bank_s *bank, char *buf, int buf_size);

#if 0
39
static uint32_t ecosflash_get_flash_status(flash_bank_t *bank);
mifi's avatar
mifi committed
40
static void ecosflash_set_flash_mode(flash_bank_t *bank,int mode);
41
static uint32_t ecosflash_wait_status_busy(flash_bank_t *bank, uint32_t waitbits, int timeout);
mifi's avatar
mifi committed
42
43
static int ecosflash_handle_gpnvm_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
#endif
ntfreak's avatar
ntfreak committed
44
45
46
47
48
49
50
51
52
53
54

flash_driver_t ecosflash_flash =
{
	.name = "ecosflash",
	.register_commands = ecosflash_register_commands,
	.flash_bank_command = ecosflash_flash_bank_command,
	.erase = ecosflash_erase,
	.protect = ecosflash_protect,
	.write = ecosflash_write,
	.probe = ecosflash_probe,
	.auto_probe = ecosflash_probe,
55
	.erase_check = default_flash_blank_check,
ntfreak's avatar
ntfreak committed
56
57
58
59
60
61
62
63
64
65
	.protect_check = ecosflash_protect_check,
	.info = ecosflash_info
};

typedef struct ecosflash_flash_bank_s
{
	struct target_s *target;
	working_area_t *write_algorithm;
	working_area_t *erase_check_algorithm;
	char *driverPath;
66
	uint32_t start_address;
ntfreak's avatar
ntfreak committed
67
68
69
70
71
72
73
74
} ecosflash_flash_bank_t;

static const int sectorSize=0x10000;

char *
flash_errmsg(int err);

#ifndef __ECOS
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
#define FLASH_ERR_OK              0x00  /* No error - operation complete */
#define FLASH_ERR_INVALID         0x01  /* Invalid FLASH address */
#define FLASH_ERR_ERASE           0x02  /* Error trying to erase */
#define FLASH_ERR_LOCK            0x03  /* Error trying to lock/unlock */
#define FLASH_ERR_PROGRAM         0x04  /* Error trying to program */
#define FLASH_ERR_PROTOCOL        0x05  /* Generic error */
#define FLASH_ERR_PROTECT         0x06  /* Device/region is write-protected */
#define FLASH_ERR_NOT_INIT        0x07  /* FLASH info not yet initialized */
#define FLASH_ERR_HWR             0x08  /* Hardware (configuration?) problem */
#define FLASH_ERR_ERASE_SUSPEND   0x09  /* Device is in erase suspend mode */
#define FLASH_ERR_PROGRAM_SUSPEND 0x0a  /* Device is in in program suspend mode */
#define FLASH_ERR_DRV_VERIFY      0x0b  /* Driver failed to verify data */
#define FLASH_ERR_DRV_TIMEOUT     0x0c  /* Driver timed out waiting for device */
#define FLASH_ERR_DRV_WRONG_PART  0x0d  /* Driver does not support device */
#define FLASH_ERR_LOW_VOLTAGE     0x0e  /* Not enough juice to complete job */
ntfreak's avatar
ntfreak committed
90
91
92
93

char *
flash_errmsg(int err)
{
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
	switch (err) {
	case FLASH_ERR_OK:
		return "No error - operation complete";
	case FLASH_ERR_ERASE_SUSPEND:
		return "Device is in erase suspend state";
	case FLASH_ERR_PROGRAM_SUSPEND:
		return "Device is in program suspend state";
	case FLASH_ERR_INVALID:
		return "Invalid FLASH address";
	case FLASH_ERR_ERASE:
		return "Error trying to erase";
	case FLASH_ERR_LOCK:
		return "Error trying to lock/unlock";
	case FLASH_ERR_PROGRAM:
		return "Error trying to program";
	case FLASH_ERR_PROTOCOL:
		return "Generic error";
	case FLASH_ERR_PROTECT:
		return "Device/region is write-protected";
	case FLASH_ERR_NOT_INIT:
		return "FLASH sub-system not initialized";
	case FLASH_ERR_DRV_VERIFY:
		return "Data verify failed after operation";
	case FLASH_ERR_DRV_TIMEOUT:
		return "Driver timed out waiting for device";
	case FLASH_ERR_DRV_WRONG_PART:
		return "Driver does not support device";
	case FLASH_ERR_LOW_VOLTAGE:
		return "Device reports low voltage";
	default:
		return "Unknown error";
	}
ntfreak's avatar
ntfreak committed
126
127
128
129
130
}
#endif

/* flash bank ecosflash <base> <size> <chip_width> <bus_width> <target#> <driverPath>
 */
mifi's avatar
mifi committed
131
static int ecosflash_flash_bank_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc, struct flash_bank_s *bank)
ntfreak's avatar
ntfreak committed
132
133
{
	ecosflash_flash_bank_t *info;
134

ntfreak's avatar
ntfreak committed
135
136
	if (argc < 7)
	{
137
		LOG_WARNING("incomplete flash_bank ecosflash configuration");
ntfreak's avatar
ntfreak committed
138
139
		return ERROR_FLASH_BANK_INVALID;
	}
140

ntfreak's avatar
ntfreak committed
141
	info = malloc(sizeof(ecosflash_flash_bank_t));
zwelch's avatar
zwelch committed
142
	if (info == NULL)
ntfreak's avatar
ntfreak committed
143
	{
144
		LOG_ERROR("no memory for flash bank info");
ntfreak's avatar
ntfreak committed
145
146
147
148
149
		exit(-1);
	}
	bank->driver_priv = info;
	info->driverPath=strdup(args[6]);

150
	/* eCos flash sector sizes are not exposed to OpenOCD, use 0x10000 as
151
152
153
	 * a way to improve impeadance matach between OpenOCD and eCos flash
	 * driver.
	 */
ntfreak's avatar
ntfreak committed
154
	int i = 0;
155
	uint32_t offset = 0;
ntfreak's avatar
ntfreak committed
156
157
158
159
160
161
162
163
164
165
	bank->num_sectors=bank->size/sectorSize;
	bank->sectors = malloc(sizeof(flash_sector_t) * bank->num_sectors);
	for (i = 0; i < bank->num_sectors; i++)
	{
		bank->sectors[i].offset = offset;
		bank->sectors[i].size = sectorSize;
		offset += bank->sectors[i].size;
		bank->sectors[i].is_erased = -1;
		bank->sectors[i].is_protected = 0;
	}
166

167
	info->target = get_target(args[5]);
ntfreak's avatar
ntfreak committed
168
169
	if (info->target == NULL)
	{
170
		LOG_ERROR("target '%s' not defined", args[5]);
171
		return ERROR_FAIL;
ntfreak's avatar
ntfreak committed
172
173
174
175
	}
	return ERROR_OK;
}

mifi's avatar
mifi committed
176
static int loadDriver(ecosflash_flash_bank_t *info)
ntfreak's avatar
ntfreak committed
177
{
178
179
	uint32_t buf_cnt;
	uint32_t image_size;
180
181
	image_t image;

ntfreak's avatar
ntfreak committed
182
183
184
	image.base_address_set = 0;
	image.start_address_set = 0;
	target_t *target=info->target;
185
	int retval;
186

187
	if ((retval=image_open(&image, info->driverPath, NULL)) != ERROR_OK)
ntfreak's avatar
ntfreak committed
188
	{
189
		return retval;
ntfreak's avatar
ntfreak committed
190
	}
191

ntfreak's avatar
ntfreak committed
192
	info->start_address=image.start_address;
193

ntfreak's avatar
ntfreak committed
194
195
196
197
198
199
200
201
202
203
	image_size = 0x0;
	int i;
	for (i = 0; i < image.num_sections; i++)
	{
		void *buffer = malloc(image.sections[i].size);
		int retval;
		if ((retval = image_read_section(&image, i, 0x0, image.sections[i].size, buffer, &buf_cnt)) != ERROR_OK)
		{
			free(buffer);
			image_close(&image);
204
			return retval;
ntfreak's avatar
ntfreak committed
205
206
207
		}
		target_write_buffer(target, image.sections[i].base_address, buf_cnt, buffer);
		image_size += buf_cnt;
duane's avatar
duane committed
208
		LOG_DEBUG("%" PRIu32 " byte written at address 0x%8.8" PRIx32 "", buf_cnt, image.sections[i].base_address);
209

ntfreak's avatar
ntfreak committed
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
		free(buffer);
	}

	image_close(&image);

	return ERROR_OK;
}

static int const OFFSET_ERASE=0x0;
static int const OFFSET_ERASE_SIZE=0x8;
static int const OFFSET_FLASH=0xc;
static int const OFFSET_FLASH_SIZE=0x8;
static int const OFFSET_GET_WORKAREA=0x18;
static int const OFFSET_GET_WORKAREA_SIZE=0x4;

mifi's avatar
mifi committed
225
static int runCode(ecosflash_flash_bank_t *info,
226
227
		uint32_t codeStart, uint32_t codeStop, uint32_t r0, uint32_t r1, uint32_t r2,
		uint32_t *result,
228
		/* timeout in ms */
ntfreak's avatar
ntfreak committed
229
230
231
232
233
234
235
236
237
		int timeout)
{
	target_t *target=info->target;

	reg_param_t reg_params[3];
	armv4_5_algorithm_t armv4_5_info;
	armv4_5_info.common_magic = ARMV4_5_COMMON_MAGIC;
	armv4_5_info.core_mode = ARMV4_5_MODE_SVC;
	armv4_5_info.core_state = ARMV4_5_STATE_ARM;
238

ntfreak's avatar
ntfreak committed
239
240
241
	init_reg_param(&reg_params[0], "r0", 32, PARAM_IN_OUT);
	init_reg_param(&reg_params[1], "r1", 32, PARAM_OUT);
	init_reg_param(&reg_params[2], "r2", 32, PARAM_OUT);
242

ntfreak's avatar
ntfreak committed
243
244
245
	buf_set_u32(reg_params[0].value, 0, 32, r0);
	buf_set_u32(reg_params[1].value, 0, 32, r1);
	buf_set_u32(reg_params[2].value, 0, 32, r2);
246

ntfreak's avatar
ntfreak committed
247
	int retval;
zwelch's avatar
zwelch committed
248
	if ((retval = target_run_algorithm(target, 0, NULL, 3, reg_params,
ntfreak's avatar
ntfreak committed
249
			codeStart,
250
			codeStop, timeout,
ntfreak's avatar
ntfreak committed
251
252
			&armv4_5_info)) != ERROR_OK)
	{
253
		LOG_ERROR("error executing eCos flash algorithm");
ntfreak's avatar
ntfreak committed
254
255
		return retval;
	}
256

ntfreak's avatar
ntfreak committed
257
	*result=buf_get_u32(reg_params[0].value, 0, 32);
258

ntfreak's avatar
ntfreak committed
259
260
261
	destroy_reg_param(&reg_params[0]);
	destroy_reg_param(&reg_params[1]);
	destroy_reg_param(&reg_params[2]);
262

ntfreak's avatar
ntfreak committed
263
264
265
	return ERROR_OK;
}

266
static int eCosBoard_erase(ecosflash_flash_bank_t *info, uint32_t address, uint32_t len)
ntfreak's avatar
ntfreak committed
267
268
{
	int retval;
269
	int timeout = (len / 20480 + 1) * 1000; /*asume 20 KB/s*/
ntfreak's avatar
ntfreak committed
270
271

	retval=loadDriver(info);
zwelch's avatar
zwelch committed
272
	if (retval != ERROR_OK)
ntfreak's avatar
ntfreak committed
273
		return retval;
274

275
	uint32_t flashErr;
276
	retval=runCode(info,
ntfreak's avatar
ntfreak committed
277
278
279
280
281
282
283
284
			info->start_address+OFFSET_ERASE,
			info->start_address+OFFSET_ERASE+OFFSET_ERASE_SIZE,
			address,
			len,
			0,
			&flashErr,
			timeout
			);
zwelch's avatar
zwelch committed
285
	if (retval != ERROR_OK)
ntfreak's avatar
ntfreak committed
286
		return retval;
287

ntfreak's avatar
ntfreak committed
288
289
	if (flashErr != 0x0)
	{
duane's avatar
duane committed
290
		LOG_ERROR("Flash erase failed with %d (%s)\n", (int)flashErr, flash_errmsg(flashErr));
291
		return ERROR_FAIL;
ntfreak's avatar
ntfreak committed
292
293
294
295
296
	}

	return ERROR_OK;
}

297
static int eCosBoard_flash(ecosflash_flash_bank_t *info, void *data, uint32_t address, uint32_t len)
ntfreak's avatar
ntfreak committed
298
299
300
301
302
{
	target_t *target=info->target;
	const int chunk=8192;
	int retval=ERROR_OK;
	int timeout = (chunk / 20480 + 1) * 1000; /*asume 20 KB/s + 1 second*/
303

ntfreak's avatar
ntfreak committed
304
	retval=loadDriver(info);
zwelch's avatar
zwelch committed
305
	if (retval != ERROR_OK)
ntfreak's avatar
ntfreak committed
306
		return retval;
307

308
	uint32_t buffer;
309
	retval=runCode(info,
ntfreak's avatar
ntfreak committed
310
311
312
313
314
315
316
			info->start_address+OFFSET_GET_WORKAREA,
			info->start_address+OFFSET_GET_WORKAREA+OFFSET_GET_WORKAREA_SIZE,
			0,
			0,
			0,
			&buffer,
			1000);
zwelch's avatar
zwelch committed
317
	if (retval != ERROR_OK)
ntfreak's avatar
ntfreak committed
318
		return retval;
319
320


321
	uint32_t i;
zwelch's avatar
zwelch committed
322
	for (i=0; i<len; i += chunk)
323
	{
ntfreak's avatar
ntfreak committed
324
325
326
327
328
		int t=len-i;
		if (t>chunk)
		{
			t=chunk;
		}
329

ntfreak's avatar
ntfreak committed
330
		int retval;
331
		retval=target_write_buffer(target, buffer, t, ((uint8_t *)data)+i);
332
333
334
		if (retval != ERROR_OK)
			return retval;

335
		uint32_t flashErr;
336
337
338
339
340
341
342
343
344
345
		retval=runCode(info,
				info->start_address+OFFSET_FLASH,
				info->start_address+OFFSET_FLASH+OFFSET_FLASH_SIZE,
				buffer,
				address+i,
				t,
				&flashErr,
				timeout);
		if (retval != ERROR_OK)
			return retval;
ntfreak's avatar
ntfreak committed
346
347
348

		if (flashErr != 0x0)
		{
duane's avatar
duane committed
349
			LOG_ERROR("Flash prog failed with %d (%s)\n", (int)flashErr, flash_errmsg(flashErr));
350
			return ERROR_FAIL;
ntfreak's avatar
ntfreak committed
351
		}
352
	}
ntfreak's avatar
ntfreak committed
353
354
355
	return ERROR_OK;
}

mifi's avatar
mifi committed
356
static int ecosflash_probe(struct flash_bank_s *bank)
ntfreak's avatar
ntfreak committed
357
358
359
360
{
	return ERROR_OK;
}

mifi's avatar
mifi committed
361
static int ecosflash_register_commands(struct command_context_s *cmd_ctx)
ntfreak's avatar
ntfreak committed
362
363
{
	register_command(cmd_ctx, NULL, "ecosflash", NULL, COMMAND_ANY, NULL);
364

ntfreak's avatar
ntfreak committed
365
366
367
	return ERROR_OK;
}

368
#if 0
369
static void command(flash_bank_t *bank, uint8_t cmd, uint8_t *cmd_buf)
ntfreak's avatar
ntfreak committed
370
371
372
{
	ecosflash_flash_bank_t *info = bank->driver_priv;
	int i;
373

ntfreak's avatar
ntfreak committed
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
	if (info->target->endianness == TARGET_LITTLE_ENDIAN)
	{
		for (i = bank->bus_width; i > 0; i--)
		{
			*cmd_buf++ = (i & (bank->chip_width - 1)) ? 0x0 : cmd;
		}
	}
	else
	{
		for (i = 1; i <= bank->bus_width; i++)
		{
			*cmd_buf++ = (i & (bank->chip_width - 1)) ? 0x0 : cmd;
		}
	}
}
389
#endif
ntfreak's avatar
ntfreak committed
390

mifi's avatar
mifi committed
391
#if 0
392
static uint32_t ecosflash_address(struct flash_bank_s *bank, uint32_t address)
ntfreak's avatar
ntfreak committed
393
{
394
	uint32_t retval = 0;
zwelch's avatar
zwelch committed
395
	switch (bank->bus_width)
ntfreak's avatar
ntfreak committed
396
397
398
399
400
401
402
403
	{
		case 4:
			retval = address & 0xfffffffc;
		case 2:
			retval = address & 0xfffffffe;
		case 1:
			retval = address;
	}
404

ntfreak's avatar
ntfreak committed
405
	return retval + bank->base;
406
}
mifi's avatar
mifi committed
407
#endif
ntfreak's avatar
ntfreak committed
408

mifi's avatar
mifi committed
409
static int ecosflash_erase(struct flash_bank_s *bank, int first, int last)
ntfreak's avatar
ntfreak committed
410
411
412
{
	struct flash_bank_s *c=bank;
	ecosflash_flash_bank_t *info = bank->driver_priv;
413
	return eCosBoard_erase(info, c->base+first*sectorSize, sectorSize*(last-first+1));
ntfreak's avatar
ntfreak committed
414
415
}

mifi's avatar
mifi committed
416
static int ecosflash_protect(struct flash_bank_s *bank, int set, int first, int last)
ntfreak's avatar
ntfreak committed
417
418
419
420
{
	return ERROR_OK;
}

421
static int ecosflash_write(struct flash_bank_s *bank, uint8_t *buffer, uint32_t offset, uint32_t count)
ntfreak's avatar
ntfreak committed
422
423
424
425
426
427
{
	ecosflash_flash_bank_t *info = bank->driver_priv;
	struct flash_bank_s *c=bank;
	return eCosBoard_flash(info, buffer, c->base+offset, count);
}

mifi's avatar
mifi committed
428
static int ecosflash_protect_check(struct flash_bank_s *bank)
ntfreak's avatar
ntfreak committed
429
430
431
432
{
	return ERROR_OK;
}

mifi's avatar
mifi committed
433
static int ecosflash_info(struct flash_bank_s *bank, char *buf, int buf_size)
ntfreak's avatar
ntfreak committed
434
435
436
437
438
439
{
	ecosflash_flash_bank_t *info = bank->driver_priv;
	snprintf(buf, buf_size, "eCos flash driver: %s", info->driverPath);
	return ERROR_OK;
}

mifi's avatar
mifi committed
440
#if 0
441
static uint32_t ecosflash_get_flash_status(flash_bank_t *bank)
ntfreak's avatar
ntfreak committed
442
443
444
445
{
	return ERROR_OK;
}

mifi's avatar
mifi committed
446
static void ecosflash_set_flash_mode(flash_bank_t *bank,int mode)
ntfreak's avatar
ntfreak committed
447
{
448

ntfreak's avatar
ntfreak committed
449
450
}

451
static uint32_t ecosflash_wait_status_busy(flash_bank_t *bank, uint32_t waitbits, int timeout)
ntfreak's avatar
ntfreak committed
452
453
454
455
{
	return ERROR_OK;
}

mifi's avatar
mifi committed
456
static int ecosflash_handle_gpnvm_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
ntfreak's avatar
ntfreak committed
457
458
459
{
	return ERROR_OK;
}
mifi's avatar
mifi committed
460
#endif