Code Review / openocd.git / blob
? search:
summary | shortlog | log | commit | commitdiff | review | tree
history | raw | HEAD
update files to correct FSF address
[openocd.git] / src / flash / nor / aduc702x.c
1 /***************************************************************************
2 * Copyright (C) 2008 by Kevin McGuire *
3 * Copyright (C) 2008 by Marcel Wijlaars *
4 * Copyright (C) 2009 by Michael Ashton *
5 * *
6 * This program is free software; you can redistribute it and/or modify *
7 * it under the terms of the GNU General Public License as published by *
8 * the Free Software Foundation; either version 2 of the License, or *
9 * (at your option) any later version. *
10 * *
11 * This program is distributed in the hope that it will be useful, *
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
14 * GNU General Public License for more details. *
15 * *
16 * You should have received a copy of the GNU General Public License *
17 * along with this program; if not, write to the *
18 * Free Software Foundation, Inc., *
19 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. *
20 ***************************************************************************/
21
22 #ifdef HAVE_CONFIG_H
23 #include "config.h"
24 #endif
25
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 static int aduc702x_build_sector_list(struct flash_bank *bank);
33 static int aduc702x_check_flash_completion(struct target *target, unsigned int timeout_ms);
34 static int aduc702x_set_write_enable(struct target *target, int enable);
35
36 #define ADUC702x_FLASH 0xfffff800
37 #define ADUC702x_FLASH_FEESTA (0*4)
38 #define ADUC702x_FLASH_FEEMOD (1*4)
39 #define ADUC702x_FLASH_FEECON (2*4)
40 #define ADUC702x_FLASH_FEEDAT (3*4)
41 #define ADUC702x_FLASH_FEEADR (4*4)
42 #define ADUC702x_FLASH_FEESIGN (5*4)
43 #define ADUC702x_FLASH_FEEPRO (6*4)
44 #define ADUC702x_FLASH_FEEHIDE (7*4)
45
46 /* flash bank aduc702x 0 0 0 0 <target#>
47 * The ADC7019-28 devices all have the same flash layout */
48 FLASH_BANK_COMMAND_HANDLER(aduc702x_flash_bank_command)
49 {
50 bank->base = 0x80000;
51 bank->size = 0xF800; /* top 4k not accessible */
52
53 aduc702x_build_sector_list(bank);
54
55 return ERROR_OK;
56 }
57
58 static int aduc702x_build_sector_list(struct flash_bank *bank)
59 {
60 /* aduc7026_struct flash_bank *aduc7026_info = bank->driver_priv; */
61
62 int i = 0;
63 uint32_t offset = 0;
64
65 /* sector size is 512 */
66 bank->num_sectors = bank->size / 512;
67 bank->sectors = malloc(sizeof(struct flash_sector) * bank->num_sectors);
68 for (i = 0; i < bank->num_sectors; ++i) {
69 bank->sectors[i].offset = offset;
70 bank->sectors[i].size = 512;
71 offset += bank->sectors[i].size;
72 bank->sectors[i].is_erased = -1;
73 bank->sectors[i].is_protected = 0;
74 }
75
76 return ERROR_OK;
77 }
78
79 static int aduc702x_protect_check(struct flash_bank *bank)
80 {
81 printf("aduc702x_protect_check not implemented yet.\n");
82 return ERROR_OK;
83 }
84
85 static int aduc702x_erase(struct flash_bank *bank, int first, int last)
86 {
87 /* int res; */
88 int x;
89 int count;
90 /* uint32_t v; */
91 struct target *target = bank->target;
92
93 aduc702x_set_write_enable(target, 1);
94
95 /* mass erase */
96 if (((first | last) == 0) || ((first == 0) && (last >= bank->num_sectors))) {
97 LOG_DEBUG("performing mass erase.");
98 target_write_u16(target, ADUC702x_FLASH + ADUC702x_FLASH_FEEDAT, 0x3cff);
99 target_write_u16(target, ADUC702x_FLASH + ADUC702x_FLASH_FEEADR, 0xffc3);
100 target_write_u8(target, ADUC702x_FLASH + ADUC702x_FLASH_FEECON, 0x06);
101
102 if (aduc702x_check_flash_completion(target, 3500) != ERROR_OK) {
103 LOG_ERROR("mass erase failed");
104 aduc702x_set_write_enable(target, 0);
105 return ERROR_FLASH_OPERATION_FAILED;
106 }
107
108 LOG_DEBUG("mass erase successful.");
109 return ERROR_OK;
110 } else {
111 unsigned long adr;
112
113 count = last - first + 1;
114 for (x = 0; x < count; ++x) {
115 adr = bank->base + ((first + x) * 512);
116
117 target_write_u16(target, ADUC702x_FLASH + ADUC702x_FLASH_FEEADR, adr);
118 target_write_u8(target, ADUC702x_FLASH + ADUC702x_FLASH_FEECON, 0x05);
119
120 if (aduc702x_check_flash_completion(target, 50) != ERROR_OK) {
121 LOG_ERROR("failed to erase sector at address 0x%08lX", adr);
122 aduc702x_set_write_enable(target, 0);
123 return ERROR_FLASH_SECTOR_NOT_ERASED;
124 }
125
126 LOG_DEBUG("erased sector at address 0x%08lX", adr);
127 }
128 }
129
130 aduc702x_set_write_enable(target, 0);
131
132 return ERROR_OK;
133 }
134
135 static int aduc702x_protect(struct flash_bank *bank, int set, int first, int last)
136 {
137 printf("aduc702x_protect not implemented yet.\n");
138 return ERROR_FLASH_OPERATION_FAILED;
139 }
140
141 /* If this fn returns ERROR_TARGET_RESOURCE_NOT_AVAILABLE, then the caller can fall
142 * back to another mechanism that does not require onboard RAM
143 *
144 * Caller should not check for other return values specifically
145 */
146 static int aduc702x_write_block(struct flash_bank *bank,
147 uint8_t *buffer,
148 uint32_t offset,
149 uint32_t count)
150 {
151 struct target *target = bank->target;
152 uint32_t buffer_size = 7000;
153 struct working_area *write_algorithm;
154 struct working_area *source;
155 uint32_t address = bank->base + offset;
156 struct reg_param reg_params[6];
157 struct arm_algorithm arm_algo;
158 int retval = ERROR_OK;
159
160 if (((count%2) != 0) || ((offset%2) != 0)) {
161 LOG_ERROR("write block must be multiple of two bytes in offset & length");
162 return ERROR_FAIL;
163 }
164
165 /* parameters:
166
167 r0 - address of source data (absolute)
168 r1 - number of halfwords to be copied
169 r2 - start address in flash (offset from beginning of flash memory)
170 r3 - exit code
171 r4 - base address of flash controller (0xFFFFF800)
172
173 registers:
174
175 r5 - scratch
176 r6 - set to 2, used to write flash command
177
178 */
179 static const uint32_t aduc702x_flash_write_code[] = {
180 /* <_start>: */
181 0xe3a05008, /* mov r5, #8 ; 0x8 */
182 0xe5845004, /* str r5, [r4, #4] */
183 0xe3a06002, /* mov r6, #2 ; 0x2 */
184 /* <next>: */
185 0xe1c421b0, /* strh r2, [r4, #16] */
186 0xe0d050b2, /* ldrh r5, [r0], #2 */
187 0xe1c450bc, /* strh r5, [r4, #12] */
188 0xe5c46008, /* strb r6, [r4, #8] */
189 /* <wait_complete>: */
190 0xe1d430b0, /* ldrh r3, [r4] */
191 0xe3130004, /* tst r3, #4 ; 0x4 */
192 0x1afffffc, /* bne 1001c <wait_complete> */
193 0xe2822002, /* add r2, r2, #2 ; 0x2 */
194 0xe2511001, /* subs r1, r1, #1 ; 0x1 */
195 0x0a000001, /* beq 1003c <done> */
196 0xe3130001, /* tst r3, #1 ; 0x1 */
197 0x1afffff3, /* bne 1000c <next> */
198 /* <done>: */
199 0xeafffffe /* b 1003c <done> */
200 };
201
202 /* flash write code */
203 if (target_alloc_working_area(target, sizeof(aduc702x_flash_write_code),
204 &write_algorithm) != ERROR_OK) {
205 LOG_WARNING("no working area available, can't do block memory writes");
206 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
207 }
208
209 retval = target_write_buffer(target, write_algorithm->address,
210 sizeof(aduc702x_flash_write_code), (uint8_t *)aduc702x_flash_write_code);
211 if (retval != ERROR_OK)
212 return retval;
213
214 /* memory buffer */
215 while (target_alloc_working_area_try(target, buffer_size, &source) != ERROR_OK) {
216 buffer_size /= 2;
217 if (buffer_size <= 256) {
218 /* we already allocated the writing code, but failed to get a buffer,
219 *free the algorithm */
220 target_free_working_area(target, write_algorithm);
221
222 LOG_WARNING("no large enough working area available, can't do block memory writes");
223 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
224 }
225 }
226
227 arm_algo.common_magic = ARM_COMMON_MAGIC;
228 arm_algo.core_mode = ARM_MODE_SVC;
229 arm_algo.core_state = ARM_STATE_ARM;
230
231 init_reg_param(&reg_params[0], "r0", 32, PARAM_OUT);
232 init_reg_param(&reg_params[1], "r1", 32, PARAM_OUT);
233 init_reg_param(&reg_params[2], "r2", 32, PARAM_OUT);
234 init_reg_param(&reg_params[3], "r3", 32, PARAM_IN);
235 init_reg_param(&reg_params[4], "r4", 32, PARAM_OUT);
236
237 while (count > 0) {
238 uint32_t thisrun_count = (count > buffer_size) ? buffer_size : count;
239
240 retval = target_write_buffer(target, source->address, thisrun_count, buffer);
241 if (retval != ERROR_OK)
242 break;
243
244 buf_set_u32(reg_params[0].value, 0, 32, source->address);
245 buf_set_u32(reg_params[1].value, 0, 32, thisrun_count/2);
246 buf_set_u32(reg_params[2].value, 0, 32, address);
247 buf_set_u32(reg_params[4].value, 0, 32, 0xFFFFF800);
248
249 retval = target_run_algorithm(target, 0, NULL, 5,
250 reg_params, write_algorithm->address,
251 write_algorithm->address +
252 sizeof(aduc702x_flash_write_code) - 4,
253 10000, &arm_algo);
254 if (retval != ERROR_OK) {
255 LOG_ERROR("error executing aduc702x flash write algorithm");
256 break;
257 }
258
259 if ((buf_get_u32(reg_params[3].value, 0, 32) & 1) != 1) {
260 /* FIX!!!! what does this mean??? replace w/sensible error message */
261 LOG_ERROR("aduc702x detected error writing flash");
262 retval = ERROR_FAIL;
263 break;
264 }
265
266 buffer += thisrun_count;
267 address += thisrun_count;
268 count -= thisrun_count;
269 }
270
271 target_free_working_area(target, source);
272 target_free_working_area(target, write_algorithm);
273
274 destroy_reg_param(&reg_params[0]);
275 destroy_reg_param(&reg_params[1]);
276 destroy_reg_param(&reg_params[2]);
277 destroy_reg_param(&reg_params[3]);
278 destroy_reg_param(&reg_params[4]);
279
280 return retval;
281 }
282
283 /* All-JTAG, single-access method. Very slow. Used only if there is no
284 * working area available. */
285 static int aduc702x_write_single(struct flash_bank *bank,
286 uint8_t *buffer,
287 uint32_t offset,
288 uint32_t count)
289 {
290 uint32_t x;
291 uint8_t b;
292 struct target *target = bank->target;
293
294 aduc702x_set_write_enable(target, 1);
295
296 for (x = 0; x < count; x += 2) {
297 /* FEEADR = address */
298 target_write_u16(target, ADUC702x_FLASH + ADUC702x_FLASH_FEEADR, offset + x);
299
300 /* set up data */
301 if ((x + 1) == count) {
302 /* last byte */
303 target_read_u8(target, offset + x + 1, &b);
304 } else
305 b = buffer[x + 1];
306
307 target_write_u16(target, ADUC702x_FLASH + ADUC702x_FLASH_FEEDAT, buffer[x] | (b << 8));
308
309 /* do single-write command */
310 target_write_u8(target, ADUC702x_FLASH + ADUC702x_FLASH_FEECON, 0x02);
311
312 if (aduc702x_check_flash_completion(target, 1) != ERROR_OK) {
313 LOG_ERROR("single write failed for address 0x%08lX",
314 (unsigned long)(offset + x));
315 aduc702x_set_write_enable(target, 0);
316 return ERROR_FLASH_OPERATION_FAILED;
317 }
318
319 }
320 LOG_DEBUG("wrote %d bytes at address 0x%08lX", (int)count, (unsigned long)(offset + x));
321
322 aduc702x_set_write_enable(target, 0);
323
324 return ERROR_OK;
325 }
326
327 static int aduc702x_write(struct flash_bank *bank, uint8_t *buffer, uint32_t offset, uint32_t count)
328 {
329 int retval;
330
331 /* try using a block write */
332 retval = aduc702x_write_block(bank, buffer, offset, count);
333 if (retval != ERROR_OK) {
334 if (retval == ERROR_TARGET_RESOURCE_NOT_AVAILABLE) {
335 /* if block write failed (no sufficient working area),
336 * use normal (slow) JTAG method */
337 LOG_WARNING("couldn't use block writes, falling back to single memory accesses");
338
339 retval = aduc702x_write_single(bank, buffer, offset, count);
340 if (retval != ERROR_OK) {
341 LOG_ERROR("slow write failed");
342 return ERROR_FLASH_OPERATION_FAILED;
343 }
344 }
345 }
346
347 return retval;
348 }
349
350 static int aduc702x_probe(struct flash_bank *bank)
351 {
352 return ERROR_OK;
353 }
354
355 static int aduc702x_info(struct flash_bank *bank, char *buf, int buf_size)
356 {
357 snprintf(buf, buf_size, "aduc702x flash driver info");
358 return ERROR_OK;
359 }
360
361 /* sets FEEMOD bit 3
362 * enable = 1 enables writes & erases, 0 disables them */
363 static int aduc702x_set_write_enable(struct target *target, int enable)
364 {
365 /* don't bother to preserve int enable bit here */
366 target_write_u16(target, ADUC702x_FLASH + ADUC702x_FLASH_FEEMOD, enable ? 8 : 0);
367
368 return ERROR_OK;
369 }
370
371 /* wait up to timeout_ms for controller to not be busy,
372 * then check whether the command passed or failed.
373 *
374 * this function sleeps 1ms between checks (after the first one),
375 * so in some cases may slow things down without a usleep after the first read */
376 static int aduc702x_check_flash_completion(struct target *target, unsigned int timeout_ms)
377 {
378 uint8_t v = 4;
379
380 long long endtime = timeval_ms() + timeout_ms;
381 while (1) {
382 target_read_u8(target, ADUC702x_FLASH + ADUC702x_FLASH_FEESTA, &v);
383 if ((v & 4) == 0)
384 break;
385 alive_sleep(1);
386 if (timeval_ms() >= endtime)
387 break;
388 }
389
390 if (v & 2)
391 return ERROR_FAIL;
392 /* if a command is ignored, both the success and fail bits may be 0 */
393 else if ((v & 3) == 0)
394 return ERROR_FAIL;
395 else
396 return ERROR_OK;
397 }
398
399 struct flash_driver aduc702x_flash = {
400 .name = "aduc702x",
401 .flash_bank_command = aduc702x_flash_bank_command,
402 .erase = aduc702x_erase,
403 .protect = aduc702x_protect,
404 .write = aduc702x_write,
405 .read = default_flash_read,
406 .probe = aduc702x_probe,
407 .auto_probe = aduc702x_probe,
408 .erase_check = default_flash_blank_check,
409 .protect_check = aduc702x_protect_check,
410 .info = aduc702x_info
411 };
Open On-Chip Debugger

Linking to existing account procedure

If you already have an account and want to add another login method you MUST first sign in with your existing account and then change URL to read https://review.openocd.org/login/?link to get to this page again but this time it'll work for linking. Thank you.

SSH host keys fingerprints

1024 SHA256:YKx8b7u5ZWdcbp7/4AeXNaqElP49m6QrwfXaqQGJAOk gerrit-code-review@openocd.zylin.com (DSA)
384 SHA256:jHIbSQa4REvwCFG4cq5LBlBLxmxSqelQPem/EXIrxjk gerrit-code-review@openocd.org (ECDSA)
521 SHA256:UAOPYkU9Fjtcao0Ul/Rrlnj/OsQvt+pgdYSZ4jOYdgs gerrit-code-review@openocd.org (ECDSA)
256 SHA256:A13M5QlnozFOvTllybRZH6vm7iSt0XLxbA48yfc2yfY gerrit-code-review@openocd.org (ECDSA)
256 SHA256:spYMBqEYoAOtK7yZBrcwE8ZpYt6b68Cfh9yEVetvbXg gerrit-code-review@openocd.org (ED25519)
+--[ED25519 256]--+
|=..              |
|+o..   .         |
|*.o   . .        |
|+B . . .         |
|Bo. = o S        |
|Oo.+ + =         |
|oB=.* = . o      |
| =+=.+   + E     |
|. .=o   . o      |
+----[SHA256]-----+
2048 SHA256:0Onrb7/PHjpo6iVZ7xQX2riKN83FJ3KGU0TvI0TaFG4 gerrit-code-review@openocd.zylin.com (RSA)