aduc702x.c 14.4 KB
Newer Older
1
2
3
/***************************************************************************
 *   Copyright (C) 2008 by Kevin McGuire                                   *
 *   Copyright (C) 2008 by Marcel Wijlaars                                 *
4
 *   Copyright (C) 2009 by Michael Ashton                                  *
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
 *                                                                         *
 *   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

Zachary T Welch's avatar
Zachary T Welch committed
26
#include "imp.h"
27
#include <helper/binarybuffer.h>
28
#include <helper/time_support.h>
29
#include <target/algorithm.h>
30
#include <target/arm.h>
31
32


33
static int aduc702x_build_sector_list(struct flash_bank *bank);
Zachary T Welch's avatar
Zachary T Welch committed
34
35
static int aduc702x_check_flash_completion(struct target* target, unsigned int timeout_ms);
static int aduc702x_set_write_enable(struct target *target, int enable);
36
37
38
39
40
41
42
43
44
45
46

#define ADUC702x_FLASH				0xfffff800
#define ADUC702x_FLASH_FEESTA		(0*4)
#define ADUC702x_FLASH_FEEMOD		(1*4)
#define ADUC702x_FLASH_FEECON		(2*4)
#define ADUC702x_FLASH_FEEDAT		(3*4)
#define ADUC702x_FLASH_FEEADR		(4*4)
#define ADUC702x_FLASH_FEESIGN		(5*4)
#define ADUC702x_FLASH_FEEPRO		(6*4)
#define ADUC702x_FLASH_FEEHIDE		(7*4)

47
struct aduc702x_flash_bank {
48
	struct working_area *write_algorithm;
49
};
50

51
52
/* flash bank aduc702x 0 0 0 0 <target#>
 * The ADC7019-28 devices all have the same flash layout */
53
FLASH_BANK_COMMAND_HANDLER(aduc702x_flash_bank_command)
54
{
55
	struct aduc702x_flash_bank *nbank;
56

57
	nbank = malloc(sizeof(struct aduc702x_flash_bank));
58

59
60
        bank->base = 0x80000;
        bank->size = 0xF800; // top 4k not accessible
61
	bank->driver_priv = nbank;
62
63
64
65
66
67

        aduc702x_build_sector_list(bank);

        return ERROR_OK;
}

68
static int aduc702x_build_sector_list(struct flash_bank *bank)
69
{
70
	//aduc7026_struct flash_bank *aduc7026_info = bank->driver_priv;
71

72
        int i = 0;
73
        uint32_t offset = 0;
74

75
76
        // sector size is 512
        bank->num_sectors = bank->size / 512;
77
        bank->sectors = malloc(sizeof(struct flash_sector) * bank->num_sectors);
78
79
80
81
82
83
84
85
86
        for (i = 0; i < bank->num_sectors; ++i)
        {
                bank->sectors[i].offset = offset;
                bank->sectors[i].size = 512;
                offset += bank->sectors[i].size;
                bank->sectors[i].is_erased = -1;
                bank->sectors[i].is_protected = 0;
        }

87
88
89
	return ERROR_OK;
}

90
static int aduc702x_protect_check(struct flash_bank *bank)
91
92
93
94
95
{
	printf("aduc702x_protect_check not implemented yet.\n");
	return ERROR_OK;
}

96
static int aduc702x_erase(struct flash_bank *bank, int first, int last)
97
{
98
        //int res;
99
100
	int x;
	int count;
101
	//uint32_t v;
Zachary T Welch's avatar
Zachary T Welch committed
102
	struct target *target = bank->target;
103

104
105
        aduc702x_set_write_enable(target, 1);

106
	/* mass erase */
107
	if (((first | last) == 0) || ((first == 0) && (last >= bank->num_sectors))) {
Eric Wetzel's avatar
Eric Wetzel committed
108
		LOG_DEBUG("performing mass erase.");
109
110
111
112
113
		target_write_u16(target, ADUC702x_FLASH + ADUC702x_FLASH_FEEDAT, 0x3cff);
		target_write_u16(target, ADUC702x_FLASH + ADUC702x_FLASH_FEEADR, 0xffc3);
		target_write_u8(target, ADUC702x_FLASH + ADUC702x_FLASH_FEECON, 0x06);

                if (aduc702x_check_flash_completion(target, 3500) != ERROR_OK)
114
		{
115
			LOG_ERROR("mass erase failed");
116
117
                        aduc702x_set_write_enable(target, 0);
			return ERROR_FLASH_OPERATION_FAILED;
118
		}
119

Eric Wetzel's avatar
Eric Wetzel committed
120
		LOG_DEBUG("mass erase successful.");
121
		return ERROR_OK;
122
123
124
125
126
127
128
129
130
131
132
133
134
	} else {
                unsigned long adr;

                count = last - first + 1;
                for (x = 0; x < count; ++x)
                {
                        adr = bank->base + ((first + x) * 512);

                        target_write_u16(target, ADUC702x_FLASH + ADUC702x_FLASH_FEEADR, adr);
                        target_write_u8(target, ADUC702x_FLASH + ADUC702x_FLASH_FEECON, 0x05);

                        if (aduc702x_check_flash_completion(target, 50) != ERROR_OK)
                        {
135
                                LOG_ERROR("failed to erase sector at address 0x%08lX", adr);
136
137
138
139
                                aduc702x_set_write_enable(target, 0);
                                return ERROR_FLASH_SECTOR_NOT_ERASED;
                        }

Eric Wetzel's avatar
Eric Wetzel committed
140
                        LOG_DEBUG("erased sector at address 0x%08lX", adr);
141
142
143
144
                }
        }

        aduc702x_set_write_enable(target, 0);
145
146
147
148

	return ERROR_OK;
}

149
static int aduc702x_protect(struct flash_bank *bank, int set, int first, int last)
150
151
152
153
154
{
	printf("aduc702x_protect not implemented yet.\n");
	return ERROR_FLASH_OPERATION_FAILED;
}

155
156
157
158
159
/* If this fn returns ERROR_TARGET_RESOURCE_NOT_AVAILABLE, then the caller can fall
 * back to another mechanism that does not require onboard RAM
 *
 * Caller should not check for other return values specifically
 */
160
static int aduc702x_write_block(struct flash_bank *bank, uint8_t *buffer, uint32_t offset, uint32_t count)
161
{
162
	struct aduc702x_flash_bank *aduc702x_info = bank->driver_priv;
Zachary T Welch's avatar
Zachary T Welch committed
163
	struct target *target = bank->target;
164
	uint32_t buffer_size = 7000;
165
	struct working_area *source;
166
	uint32_t address = bank->base + offset;
167
	struct reg_param reg_params[6];
168
	struct arm_algorithm armv4_5_info;
169
	int retval = ERROR_OK;
170

171
172
173
174
175
176
	if (((count%2)!=0)||((offset%2)!=0))
	{
		LOG_ERROR("write block must be multiple of two bytes in offset & length");
		return ERROR_FAIL;
	}

177
178
179
180
181
182
183
184
185
186
187
188
189
190
        /* parameters:

        r0 - address of source data (absolute)
        r1 - number of halfwords to be copied
        r2 - start address in flash (offset from beginning of flash memory)
        r3 - exit code
        r4 - base address of flash controller (0xFFFFF800)

        registers:

        r5 - scratch
        r6 - set to 2, used to write flash command

        */
191
        static const uint32_t aduc702x_flash_write_code[] = {
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
        //<_start>:
                0xe3a05008,	// mov	r5, #8	; 0x8
                0xe5845004,	// str	r5, [r4, #4]
                0xe3a06002,	// mov	r6, #2	; 0x2
        //<next>:
                0xe1c421b0,	// strh	r2, [r4, #16]
                0xe0d050b2,	// ldrh	r5, [r0], #2
                0xe1c450bc,	// strh	r5, [r4, #12]
                0xe5c46008,	// strb	r6, [r4, #8]
        //<wait_complete>:
                0xe1d430b0,	// ldrh	r3, [r4]
                0xe3130004,	// tst	r3, #4	; 0x4
                0x1afffffc,	// bne	1001c <wait_complete>
                0xe2822002,	// add	r2, r2, #2	; 0x2
                0xe2511001,	// subs	r1, r1, #1	; 0x1
                0x0a000001,	// beq	1003c <done>
                0xe3130001,	// tst	r3, #1	; 0x1
                0x1afffff3,	// bne	1000c <next>
        //<done>:
                0xeafffffe 	// b	1003c <done>
	};
213

214
215
216
	/* flash write code */
	if (target_alloc_working_area(target, sizeof(aduc702x_flash_write_code),
                &aduc702x_info->write_algorithm) != ERROR_OK)
217
	{
218
219
220
		LOG_WARNING("no working area available, can't do block memory writes");
		return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
	};
221

222
	retval=target_write_buffer(target, aduc702x_info->write_algorithm->address,
223
                sizeof(aduc702x_flash_write_code), (uint8_t*)aduc702x_flash_write_code);
224
225
226
227
	if (retval!=ERROR_OK)
	{
		return retval;
	}
228
229

	/* memory buffer */
Øyvind Harboe's avatar
Øyvind Harboe committed
230
	while (target_alloc_working_area_try(target, buffer_size, &source) != ERROR_OK)
231
232
233
234
235
236
237
	{
		buffer_size /= 2;
		if (buffer_size <= 256)
		{
			/* if we already allocated the writing code, but failed to get a buffer, free the algorithm */
			if (aduc702x_info->write_algorithm)
				target_free_working_area(target, aduc702x_info->write_algorithm);
238

239
240
			LOG_WARNING("no large enough working area available, can't do block memory writes");
			return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
241
		}
242
	}
243

244
	armv4_5_info.common_magic = ARM_COMMON_MAGIC;
245
	armv4_5_info.core_mode = ARM_MODE_SVC;
246
	armv4_5_info.core_state = ARM_STATE_ARM;
247

248
249
250
251
252
	init_reg_param(&reg_params[0], "r0", 32, PARAM_OUT);
	init_reg_param(&reg_params[1], "r1", 32, PARAM_OUT);
	init_reg_param(&reg_params[2], "r2", 32, PARAM_OUT);
	init_reg_param(&reg_params[3], "r3", 32, PARAM_IN);
	init_reg_param(&reg_params[4], "r4", 32, PARAM_OUT);
253

254
255
	while (count > 0)
	{
256
		uint32_t thisrun_count = (count > buffer_size) ? buffer_size : count;
257

258
259
260
261
262
		retval=target_write_buffer(target, source->address, thisrun_count, buffer);
		if (retval!=ERROR_OK)
		{
			break;
		}
263
264

		buf_set_u32(reg_params[0].value, 0, 32, source->address);
265
		buf_set_u32(reg_params[1].value, 0, 32, thisrun_count/2);
266
267
268
		buf_set_u32(reg_params[2].value, 0, 32, address);
		buf_set_u32(reg_params[4].value, 0, 32, 0xFFFFF800);

269
270
271
		if ((retval = target_run_algorithm(target, 0, NULL, 5,
                        reg_params, aduc702x_info->write_algorithm->address,
                        aduc702x_info->write_algorithm->address + sizeof(aduc702x_flash_write_code) - 4,
272
                        10000, &armv4_5_info)) != ERROR_OK)
273
		{
274
275
276
			LOG_ERROR("error executing aduc702x flash write algorithm");
			break;
		}
277

278
279
280
281
282
		if ((buf_get_u32(reg_params[3].value, 0, 32) & 1) != 1)
		{
			/* FIX!!!! what does this mean??? replace w/sensible error message */
			LOG_ERROR("aduc702x detected error writing flash");
			retval = ERROR_FAIL;
283
284
285
			break;
		}

286
287
		buffer += thisrun_count;
		address += thisrun_count;
288
289
290
291
292
		count -= thisrun_count;
	}

	target_free_working_area(target, source);
	target_free_working_area(target, aduc702x_info->write_algorithm);
293

294
295
296
297
298
	destroy_reg_param(&reg_params[0]);
	destroy_reg_param(&reg_params[1]);
	destroy_reg_param(&reg_params[2]);
	destroy_reg_param(&reg_params[3]);
	destroy_reg_param(&reg_params[4]);
299

300
301
302
	return retval;
}

303
/* All-JTAG, single-access method.  Very slow.  Used only if there is no
304
 * working area available. */
305
static int aduc702x_write_single(struct flash_bank *bank, uint8_t *buffer, uint32_t offset, uint32_t count)
306
{
307
	uint32_t x;
308
        uint8_t b;
Zachary T Welch's avatar
Zachary T Welch committed
309
	struct target *target = bank->target;
310

311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
        aduc702x_set_write_enable(target, 1);

	for (x = 0; x < count; x += 2) {
                // FEEADR = address
		target_write_u16(target, ADUC702x_FLASH + ADUC702x_FLASH_FEEADR, offset + x);

                // set up data
		if ((x + 1) == count)
                {
                        // last byte
                        target_read_u8(target, offset + x + 1, &b);
                }
                else
                        b = buffer[x + 1];

                target_write_u16(target, ADUC702x_FLASH + ADUC702x_FLASH_FEEDAT, buffer[x] | (b << 8));

                // do single-write command
		target_write_u8(target, ADUC702x_FLASH + ADUC702x_FLASH_FEECON, 0x02);

                if (aduc702x_check_flash_completion(target, 1) != ERROR_OK)
                {
333
			LOG_ERROR("single write failed for address 0x%08lX", (unsigned long)(offset + x));
334
                        aduc702x_set_write_enable(target, 0);
335
336
			return ERROR_FLASH_OPERATION_FAILED;
		}
337

338
	}
Eric Wetzel's avatar
Eric Wetzel committed
339
        LOG_DEBUG("wrote %d bytes at address 0x%08lX", (int)count, (unsigned long)(offset + x));
340
341
342

        aduc702x_set_write_enable(target, 0);

343
344
345
	return ERROR_OK;
}

346
static int aduc702x_write(struct flash_bank *bank, uint8_t *buffer, uint32_t offset, uint32_t count)
347
348
349
350
351
352
353
354
355
{
	int retval;

        /* try using a block write */
        if ((retval = aduc702x_write_block(bank, buffer, offset, count)) != ERROR_OK)
        {
                if (retval == ERROR_TARGET_RESOURCE_NOT_AVAILABLE)
                {
                        /* if block write failed (no sufficient working area),
356
                         * use normal (slow) JTAG method */
357
358
359
360
361
                        LOG_WARNING("couldn't use block writes, falling back to single memory accesses");

                        if ((retval = aduc702x_write_single(bank, buffer, offset, count)) != ERROR_OK)
                        {
                                LOG_ERROR("slow write failed");
362
                                return ERROR_FLASH_OPERATION_FAILED;
363
364
365
366
                        }
                }
        }

367
        return retval;
368
369
}

370
static int aduc702x_probe(struct flash_bank *bank)
371
372
373
374
{
	return ERROR_OK;
}

375
static int aduc702x_info(struct flash_bank *bank, char *buf, int buf_size)
376
{
377
	snprintf(buf, buf_size, "aduc702x flash driver info");
378
379
	return ERROR_OK;
}
380
381
382

/* sets FEEMOD bit 3
 * enable = 1 enables writes & erases, 0 disables them */
Zachary T Welch's avatar
Zachary T Welch committed
383
static int aduc702x_set_write_enable(struct target *target, int enable)
384
385
386
387
388
389
390
391
392
393
394
395
{
        // don't bother to preserve int enable bit here
        target_write_u16(target, ADUC702x_FLASH + ADUC702x_FLASH_FEEMOD, enable ? 8 : 0);

        return ERROR_OK;
}

/* wait up to timeout_ms for controller to not be busy,
 * then check whether the command passed or failed.
 *
 * this function sleeps 1ms between checks (after the first one),
 * so in some cases may slow things down without a usleep after the first read */
Zachary T Welch's avatar
Zachary T Welch committed
396
static int aduc702x_check_flash_completion(struct target* target, unsigned int timeout_ms)
397
{
398
        uint8_t v = 4;
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413

        long long endtime = timeval_ms() + timeout_ms;
        while (1) {
                target_read_u8(target, ADUC702x_FLASH + ADUC702x_FLASH_FEESTA, &v);
                if ((v & 4) == 0) break;
                alive_sleep(1);
                if (timeval_ms() >= endtime) break;
        }

        if (v & 2) return ERROR_FAIL;
        // if a command is ignored, both the success and fail bits may be 0
        else if ((v & 3) == 0) return ERROR_FAIL;
        else return ERROR_OK;
}

414
struct flash_driver aduc702x_flash = {
David Brownell's avatar
David Brownell committed
415
416
417
418
419
	.name = "aduc702x",
	.flash_bank_command = aduc702x_flash_bank_command,
	.erase = aduc702x_erase,
	.protect = aduc702x_protect,
	.write = aduc702x_write,
420
	.read = default_flash_read,
David Brownell's avatar
David Brownell committed
421
422
423
424
425
426
	.probe = aduc702x_probe,
	.auto_probe = aduc702x_probe,
	.erase_check = default_flash_blank_check,
	.protect_check = aduc702x_protect_check,
	.info = aduc702x_info
};