Code Review / openocd.git / blob
? search:
summary | shortlog | log | commit | commitdiff | review | tree
history | raw | HEAD
flash/nor: improved API of flash_driver.info & fixed buffer overruns
[openocd.git] / src / flash / nor / cc26xx.c
1 /***************************************************************************
2 * Copyright (C) 2017 by Texas Instruments, Inc. *
3 * *
4 * This program is free software; you can redistribute it and/or modify *
5 * it under the terms of the GNU General Public License as published by *
6 * the Free Software Foundation; either version 2 of the License, or *
7 * (at your option) any later version. *
8 * *
9 * This program is distributed in the hope that it will be useful, *
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
12 * GNU General Public License for more details. *
13 * *
14 * You should have received a copy of the GNU General Public License *
15 * along with this program. If not, see <http://www.gnu.org/licenses/>. *
16 ***************************************************************************/
17
18 #ifdef HAVE_CONFIG_H
19 #include "config.h"
20 #endif
21
22 #include "imp.h"
23 #include "cc26xx.h"
24 #include <helper/binarybuffer.h>
25 #include <helper/time_support.h>
26 #include <target/algorithm.h>
27 #include <target/armv7m.h>
28 #include <target/image.h>
29
30 #define FLASH_TIMEOUT 8000
31
32 struct cc26xx_bank {
33 const char *family_name;
34 uint32_t icepick_id;
35 uint32_t user_id;
36 uint32_t device_type;
37 uint32_t sector_length;
38 bool probed;
39 struct working_area *working_area;
40 struct armv7m_algorithm armv7m_info;
41 const uint8_t *algo_code;
42 uint32_t algo_size;
43 uint32_t algo_working_size;
44 uint32_t buffer_addr[2];
45 uint32_t params_addr[2];
46 };
47
48 static int cc26xx_auto_probe(struct flash_bank *bank);
49
50 static uint32_t cc26xx_device_type(uint32_t icepick_id, uint32_t user_id)
51 {
52 uint32_t device_type = 0;
53
54 switch (icepick_id & ICEPICK_ID_MASK) {
55 case CC26X0_ICEPICK_ID:
56 device_type = CC26X0_TYPE;
57 break;
58 case CC26X1_ICEPICK_ID:
59 device_type = CC26X1_TYPE;
60 break;
61 case CC13X0_ICEPICK_ID:
62 device_type = CC13X0_TYPE;
63 break;
64 case CC13X2_CC26X2_ICEPICK_ID:
65 default:
66 if ((user_id & USER_ID_CC13_MASK) != 0)
67 device_type = CC13X2_TYPE;
68 else
69 device_type = CC26X2_TYPE;
70 break;
71 }
72
73 return device_type;
74 }
75
76 static uint32_t cc26xx_sector_length(uint32_t icepick_id)
77 {
78 uint32_t sector_length;
79
80 switch (icepick_id & ICEPICK_ID_MASK) {
81 case CC26X0_ICEPICK_ID:
82 case CC26X1_ICEPICK_ID:
83 case CC13X0_ICEPICK_ID:
84 /* Chameleon family device */
85 sector_length = CC26X0_SECTOR_LENGTH;
86 break;
87 case CC13X2_CC26X2_ICEPICK_ID:
88 default:
89 /* Agama family device */
90 sector_length = CC26X2_SECTOR_LENGTH;
91 break;
92 }
93
94 return sector_length;
95 }
96
97 static int cc26xx_wait_algo_done(struct flash_bank *bank, uint32_t params_addr)
98 {
99 struct target *target = bank->target;
100 struct cc26xx_bank *cc26xx_bank = bank->driver_priv;
101
102 uint32_t status_addr = params_addr + CC26XX_STATUS_OFFSET;
103 uint32_t status = CC26XX_BUFFER_FULL;
104 long long start_ms;
105 long long elapsed_ms;
106
107 int retval = ERROR_OK;
108
109 start_ms = timeval_ms();
110 while (CC26XX_BUFFER_FULL == status) {
111 retval = target_read_u32(target, status_addr, &status);
112 if (ERROR_OK != retval)
113 return retval;
114
115 elapsed_ms = timeval_ms() - start_ms;
116 if (elapsed_ms > 500)
117 keep_alive();
118 if (elapsed_ms > FLASH_TIMEOUT)
119 break;
120 };
121
122 if (CC26XX_BUFFER_EMPTY != status) {
123 LOG_ERROR("%s: Flash operation failed", cc26xx_bank->family_name);
124 return ERROR_FAIL;
125 }
126
127 return ERROR_OK;
128 }
129
130 static int cc26xx_init(struct flash_bank *bank)
131 {
132 struct target *target = bank->target;
133 struct cc26xx_bank *cc26xx_bank = bank->driver_priv;
134
135 int retval;
136
137 /* Make sure we've probed the flash to get the device and size */
138 retval = cc26xx_auto_probe(bank);
139 if (ERROR_OK != retval)
140 return retval;
141
142 /* Check for working area to use for flash helper algorithm */
143 if (NULL != cc26xx_bank->working_area)
144 target_free_working_area(target, cc26xx_bank->working_area);
145 retval = target_alloc_working_area(target, cc26xx_bank->algo_working_size,
146 &cc26xx_bank->working_area);
147 if (ERROR_OK != retval)
148 return retval;
149
150 /* Confirm the defined working address is the area we need to use */
151 if (CC26XX_ALGO_BASE_ADDRESS != cc26xx_bank->working_area->address)
152 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
153
154 /* Write flash helper algorithm into target memory */
155 retval = target_write_buffer(target, CC26XX_ALGO_BASE_ADDRESS,
156 cc26xx_bank->algo_size, cc26xx_bank->algo_code);
157 if (ERROR_OK != retval) {
158 LOG_ERROR("%s: Failed to load flash helper algorithm",
159 cc26xx_bank->family_name);
160 target_free_working_area(target, cc26xx_bank->working_area);
161 return retval;
162 }
163
164 /* Initialize the ARMv7 specific info to run the algorithm */
165 cc26xx_bank->armv7m_info.common_magic = ARMV7M_COMMON_MAGIC;
166 cc26xx_bank->armv7m_info.core_mode = ARM_MODE_THREAD;
167
168 /* Begin executing the flash helper algorithm */
169 retval = target_start_algorithm(target, 0, NULL, 0, NULL,
170 CC26XX_ALGO_BASE_ADDRESS, 0, &cc26xx_bank->armv7m_info);
171 if (ERROR_OK != retval) {
172 LOG_ERROR("%s: Failed to start flash helper algorithm",
173 cc26xx_bank->family_name);
174 target_free_working_area(target, cc26xx_bank->working_area);
175 return retval;
176 }
177
178 /*
179 * At this point, the algorithm is running on the target and
180 * ready to receive commands and data to flash the target
181 */
182
183 return retval;
184 }
185
186 static int cc26xx_quit(struct flash_bank *bank)
187 {
188 struct target *target = bank->target;
189 struct cc26xx_bank *cc26xx_bank = bank->driver_priv;
190
191 int retval;
192
193 /* Regardless of the algo's status, attempt to halt the target */
194 (void)target_halt(target);
195
196 /* Now confirm target halted and clean up from flash helper algorithm */
197 retval = target_wait_algorithm(target, 0, NULL, 0, NULL, 0, FLASH_TIMEOUT,
198 &cc26xx_bank->armv7m_info);
199
200 target_free_working_area(target, cc26xx_bank->working_area);
201 cc26xx_bank->working_area = NULL;
202
203 return retval;
204 }
205
206 static int cc26xx_mass_erase(struct flash_bank *bank)
207 {
208 struct target *target = bank->target;
209 struct cc26xx_bank *cc26xx_bank = bank->driver_priv;
210 struct cc26xx_algo_params algo_params;
211
212 int retval;
213
214 if (TARGET_HALTED != target->state) {
215 LOG_ERROR("Target not halted");
216 return ERROR_TARGET_NOT_HALTED;
217 }
218
219 retval = cc26xx_init(bank);
220 if (ERROR_OK != retval)
221 return retval;
222
223 /* Initialize algorithm parameters */
224 buf_set_u32(algo_params.address, 0, 32, 0);
225 buf_set_u32(algo_params.length, 0, 32, 4);
226 buf_set_u32(algo_params.command, 0, 32, CC26XX_CMD_ERASE_ALL);
227 buf_set_u32(algo_params.status, 0, 32, CC26XX_BUFFER_FULL);
228
229 /* Issue flash helper algorithm parameters for mass erase */
230 retval = target_write_buffer(target, cc26xx_bank->params_addr[0],
231 sizeof(algo_params), (uint8_t *)&algo_params);
232
233 /* Wait for command to complete */
234 if (ERROR_OK == retval)
235 retval = cc26xx_wait_algo_done(bank, cc26xx_bank->params_addr[0]);
236
237 /* Regardless of errors, try to close down algo */
238 (void)cc26xx_quit(bank);
239
240 return retval;
241 }
242
243 FLASH_BANK_COMMAND_HANDLER(cc26xx_flash_bank_command)
244 {
245 struct cc26xx_bank *cc26xx_bank;
246
247 if (CMD_ARGC < 6)
248 return ERROR_COMMAND_SYNTAX_ERROR;
249
250 cc26xx_bank = malloc(sizeof(struct cc26xx_bank));
251 if (NULL == cc26xx_bank)
252 return ERROR_FAIL;
253
254 /* Initialize private flash information */
255 memset((void *)cc26xx_bank, 0x00, sizeof(struct cc26xx_bank));
256 cc26xx_bank->family_name = "cc26xx";
257 cc26xx_bank->device_type = CC26XX_NO_TYPE;
258 cc26xx_bank->sector_length = 0x1000;
259
260 /* Finish initialization of bank */
261 bank->driver_priv = cc26xx_bank;
262 bank->next = NULL;
263
264 return ERROR_OK;
265 }
266
267 static int cc26xx_erase(struct flash_bank *bank, unsigned int first,
268 unsigned int last)
269 {
270 struct target *target = bank->target;
271 struct cc26xx_bank *cc26xx_bank = bank->driver_priv;
272 struct cc26xx_algo_params algo_params;
273
274 uint32_t address;
275 uint32_t length;
276 int retval;
277
278 if (TARGET_HALTED != target->state) {
279 LOG_ERROR("Target not halted");
280 return ERROR_TARGET_NOT_HALTED;
281 }
282
283 /* Do a mass erase if user requested all sectors of flash */
284 if ((first == 0) && (last == (bank->num_sectors - 1))) {
285 /* Request mass erase of flash */
286 return cc26xx_mass_erase(bank);
287 }
288
289 address = first * cc26xx_bank->sector_length;
290 length = (last - first + 1) * cc26xx_bank->sector_length;
291
292 retval = cc26xx_init(bank);
293 if (ERROR_OK != retval)
294 return retval;
295
296 /* Set up algorithm parameters for erase command */
297 buf_set_u32(algo_params.address, 0, 32, address);
298 buf_set_u32(algo_params.length, 0, 32, length);
299 buf_set_u32(algo_params.command, 0, 32, CC26XX_CMD_ERASE_SECTORS);
300 buf_set_u32(algo_params.status, 0, 32, CC26XX_BUFFER_FULL);
301
302 /* Issue flash helper algorithm parameters for erase */
303 retval = target_write_buffer(target, cc26xx_bank->params_addr[0],
304 sizeof(algo_params), (uint8_t *)&algo_params);
305
306 /* If no error, wait for erase to finish */
307 if (ERROR_OK == retval)
308 retval = cc26xx_wait_algo_done(bank, cc26xx_bank->params_addr[0]);
309
310 /* Regardless of errors, try to close down algo */
311 (void)cc26xx_quit(bank);
312
313 return retval;
314 }
315
316 static int cc26xx_write(struct flash_bank *bank, const uint8_t *buffer,
317 uint32_t offset, uint32_t count)
318 {
319 struct target *target = bank->target;
320 struct cc26xx_bank *cc26xx_bank = bank->driver_priv;
321 struct cc26xx_algo_params algo_params[2];
322 uint32_t size = 0;
323 long long start_ms;
324 long long elapsed_ms;
325 uint32_t address;
326
327 uint32_t index;
328 int retval;
329
330 if (TARGET_HALTED != target->state) {
331 LOG_ERROR("Target not halted");
332 return ERROR_TARGET_NOT_HALTED;
333 }
334
335 retval = cc26xx_init(bank);
336 if (ERROR_OK != retval)
337 return retval;
338
339 /* Initialize algorithm parameters to default values */
340 buf_set_u32(algo_params[0].command, 0, 32, CC26XX_CMD_PROGRAM);
341 buf_set_u32(algo_params[1].command, 0, 32, CC26XX_CMD_PROGRAM);
342
343 /* Write requested data, ping-ponging between two buffers */
344 index = 0;
345 start_ms = timeval_ms();
346 address = bank->base + offset;
347 while (count > 0) {
348
349 if (count > cc26xx_bank->sector_length)
350 size = cc26xx_bank->sector_length;
351 else
352 size = count;
353
354 /* Put next block of data to flash into buffer */
355 retval = target_write_buffer(target, cc26xx_bank->buffer_addr[index],
356 size, buffer);
357 if (ERROR_OK != retval) {
358 LOG_ERROR("Unable to write data to target memory");
359 break;
360 }
361
362 /* Update algo parameters for next block */
363 buf_set_u32(algo_params[index].address, 0, 32, address);
364 buf_set_u32(algo_params[index].length, 0, 32, size);
365 buf_set_u32(algo_params[index].status, 0, 32, CC26XX_BUFFER_FULL);
366
367 /* Issue flash helper algorithm parameters for block write */
368 retval = target_write_buffer(target, cc26xx_bank->params_addr[index],
369 sizeof(algo_params[index]), (uint8_t *)&algo_params[index]);
370 if (ERROR_OK != retval)
371 break;
372
373 /* Wait for next ping pong buffer to be ready */
374 index ^= 1;
375 retval = cc26xx_wait_algo_done(bank, cc26xx_bank->params_addr[index]);
376 if (ERROR_OK != retval)
377 break;
378
379 count -= size;
380 buffer += size;
381 address += size;
382
383 elapsed_ms = timeval_ms() - start_ms;
384 if (elapsed_ms > 500)
385 keep_alive();
386 }
387
388 /* If no error yet, wait for last buffer to finish */
389 if (ERROR_OK == retval) {
390 index ^= 1;
391 retval = cc26xx_wait_algo_done(bank, cc26xx_bank->params_addr[index]);
392 }
393
394 /* Regardless of errors, try to close down algo */
395 (void)cc26xx_quit(bank);
396
397 return retval;
398 }
399
400 static int cc26xx_probe(struct flash_bank *bank)
401 {
402 struct target *target = bank->target;
403 struct cc26xx_bank *cc26xx_bank = bank->driver_priv;
404
405 uint32_t sector_length;
406 uint32_t value;
407 int num_sectors;
408 int max_sectors;
409
410 int retval;
411
412 retval = target_read_u32(target, FCFG1_ICEPICK_ID, &value);
413 if (ERROR_OK != retval)
414 return retval;
415 cc26xx_bank->icepick_id = value;
416
417 retval = target_read_u32(target, FCFG1_USER_ID, &value);
418 if (ERROR_OK != retval)
419 return retval;
420 cc26xx_bank->user_id = value;
421
422 cc26xx_bank->device_type = cc26xx_device_type(cc26xx_bank->icepick_id,
423 cc26xx_bank->user_id);
424
425 sector_length = cc26xx_sector_length(cc26xx_bank->icepick_id);
426
427 /* Set up appropriate flash helper algorithm */
428 switch (cc26xx_bank->icepick_id & ICEPICK_ID_MASK) {
429 case CC26X0_ICEPICK_ID:
430 case CC26X1_ICEPICK_ID:
431 case CC13X0_ICEPICK_ID:
432 /* Chameleon family device */
433 cc26xx_bank->algo_code = cc26x0_algo;
434 cc26xx_bank->algo_size = sizeof(cc26x0_algo);
435 cc26xx_bank->algo_working_size = CC26X0_WORKING_SIZE;
436 cc26xx_bank->buffer_addr[0] = CC26X0_ALGO_BUFFER_0;
437 cc26xx_bank->buffer_addr[1] = CC26X0_ALGO_BUFFER_1;
438 cc26xx_bank->params_addr[0] = CC26X0_ALGO_PARAMS_0;
439 cc26xx_bank->params_addr[1] = CC26X0_ALGO_PARAMS_1;
440 max_sectors = CC26X0_MAX_SECTORS;
441 break;
442 case CC13X2_CC26X2_ICEPICK_ID:
443 default:
444 /* Agama family device */
445 cc26xx_bank->algo_code = cc26x2_algo;
446 cc26xx_bank->algo_size = sizeof(cc26x2_algo);
447 cc26xx_bank->algo_working_size = CC26X2_WORKING_SIZE;
448 cc26xx_bank->buffer_addr[0] = CC26X2_ALGO_BUFFER_0;
449 cc26xx_bank->buffer_addr[1] = CC26X2_ALGO_BUFFER_1;
450 cc26xx_bank->params_addr[0] = CC26X2_ALGO_PARAMS_0;
451 cc26xx_bank->params_addr[1] = CC26X2_ALGO_PARAMS_1;
452 max_sectors = CC26X2_MAX_SECTORS;
453 break;
454 }
455
456 retval = target_read_u32(target, CC26XX_FLASH_SIZE_INFO, &value);
457 if (ERROR_OK != retval)
458 return retval;
459 num_sectors = value & 0xff;
460 if (num_sectors > max_sectors)
461 num_sectors = max_sectors;
462
463 bank->sectors = malloc(sizeof(struct flash_sector) * num_sectors);
464 if (NULL == bank->sectors)
465 return ERROR_FAIL;
466
467 bank->base = CC26XX_FLASH_BASE_ADDR;
468 bank->num_sectors = num_sectors;
469 bank->size = num_sectors * sector_length;
470 bank->write_start_alignment = 0;
471 bank->write_end_alignment = 0;
472 cc26xx_bank->sector_length = sector_length;
473
474 for (int i = 0; i < num_sectors; i++) {
475 bank->sectors[i].offset = i * sector_length;
476 bank->sectors[i].size = sector_length;
477 bank->sectors[i].is_erased = -1;
478 bank->sectors[i].is_protected = 0;
479 }
480
481 /* We've successfully determined the stats on the flash bank */
482 cc26xx_bank->probed = true;
483
484 /* If we fall through to here, then all went well */
485
486 return ERROR_OK;
487 }
488
489 static int cc26xx_auto_probe(struct flash_bank *bank)
490 {
491 struct cc26xx_bank *cc26xx_bank = bank->driver_priv;
492
493 int retval = ERROR_OK;
494
495 if (!cc26xx_bank->probed)
496 retval = cc26xx_probe(bank);
497
498 return retval;
499 }
500
501 static int cc26xx_info(struct flash_bank *bank, struct command_invocation *cmd)
502 {
503 struct cc26xx_bank *cc26xx_bank = bank->driver_priv;
504 const char *device;
505
506 switch (cc26xx_bank->device_type) {
507 case CC26X0_TYPE:
508 device = "CC26x0";
509 break;
510 case CC26X1_TYPE:
511 device = "CC26x1";
512 break;
513 case CC13X0_TYPE:
514 device = "CC13x0";
515 break;
516 case CC13X2_TYPE:
517 device = "CC13x2";
518 break;
519 case CC26X2_TYPE:
520 device = "CC26x2";
521 break;
522 case CC26XX_NO_TYPE:
523 default:
524 device = "Unrecognized";
525 break;
526 }
527
528 command_print_sameline(cmd,
529 "%s device: ICEPick ID 0x%08" PRIx32 ", USER ID 0x%08" PRIx32 "\n",
530 device, cc26xx_bank->icepick_id, cc26xx_bank->user_id);
531
532 return ERROR_OK;
533 }
534
535 const struct flash_driver cc26xx_flash = {
536 .name = "cc26xx",
537 .flash_bank_command = cc26xx_flash_bank_command,
538 .erase = cc26xx_erase,
539 .write = cc26xx_write,
540 .read = default_flash_read,
541 .probe = cc26xx_probe,
542 .auto_probe = cc26xx_auto_probe,
543 .erase_check = default_flash_blank_check,
544 .info = cc26xx_info,
545 .free_driver_priv = default_flash_free_driver_priv,
546 };
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)