change #include "binarybuffer.h" to <helper/binarybuffer.h>
[openocd.git] / src / flash / nor / lpc2900.c
1 /***************************************************************************
2 * Copyright (C) 2009 by *
3 * Rolf Meeser <rolfm_9dq@yahoo.de> *
4 * *
5 * This program is free software; you can redistribute it and/or modify *
6 * it under the terms of the GNU General Public License as published by *
7 * the Free Software Foundation; either version 2 of the License, or *
8 * (at your option) any later version. *
9 * *
10 * This program is distributed in the hope that it will be useful, *
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
13 * GNU General Public License for more details. *
14 * *
15 * You should have received a copy of the GNU General Public License *
16 * along with this program; if not, write to the *
17 * Free Software Foundation, Inc., *
18 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
19 ***************************************************************************/
20
21 #ifdef HAVE_CONFIG_H
22 #include "config.h"
23 #endif
24
25
26 #include "image.h"
27 #include "flash.h"
28 #include <helper/binarybuffer.h>
29 #include "armv4_5.h"
30 #include "algorithm.h"
31
32
33 /* 1024 bytes */
34 #define KiB 1024
35
36 /* Some flash constants */
37 #define FLASH_PAGE_SIZE 512 /* bytes */
38 #define FLASH_ERASE_TIME 100000 /* microseconds */
39 #define FLASH_PROGRAM_TIME 1000 /* microseconds */
40
41 /* Chip ID / Feature Registers */
42 #define CHIPID 0xE0000000 /* Chip ID */
43 #define FEAT0 0xE0000100 /* Chip feature 0 */
44 #define FEAT1 0xE0000104 /* Chip feature 1 */
45 #define FEAT2 0xE0000108 /* Chip feature 2 (contains flash size indicator) */
46 #define FEAT3 0xE000010C /* Chip feature 3 */
47
48 #define EXPECTED_CHIPID 0x209CE02B /* Chip ID of all LPC2900 devices */
49
50 /* Flash/EEPROM Control Registers */
51 #define FCTR 0x20200000 /* Flash control */
52 #define FPTR 0x20200008 /* Flash program-time */
53 #define FTCTR 0x2020000C /* Flash test control */
54 #define FBWST 0x20200010 /* Flash bridge wait-state */
55 #define FCRA 0x2020001C /* Flash clock divider */
56 #define FMSSTART 0x20200020 /* Flash Built-In Selft Test start address */
57 #define FMSSTOP 0x20200024 /* Flash Built-In Selft Test stop address */
58 #define FMS16 0x20200028 /* Flash 16-bit signature */
59 #define FMSW0 0x2020002C /* Flash 128-bit signature Word 0 */
60 #define FMSW1 0x20200030 /* Flash 128-bit signature Word 1 */
61 #define FMSW2 0x20200034 /* Flash 128-bit signature Word 2 */
62 #define FMSW3 0x20200038 /* Flash 128-bit signature Word 3 */
63
64 #define EECMD 0x20200080 /* EEPROM command */
65 #define EEADDR 0x20200084 /* EEPROM address */
66 #define EEWDATA 0x20200088 /* EEPROM write data */
67 #define EERDATA 0x2020008C /* EEPROM read data */
68 #define EEWSTATE 0x20200090 /* EEPROM wait state */
69 #define EECLKDIV 0x20200094 /* EEPROM clock divider */
70 #define EEPWRDWN 0x20200098 /* EEPROM power-down/start */
71 #define EEMSSTART 0x2020009C /* EEPROM BIST start address */
72 #define EEMSSTOP 0x202000A0 /* EEPROM BIST stop address */
73 #define EEMSSIG 0x202000A4 /* EEPROM 24-bit BIST signature */
74
75 #define INT_CLR_ENABLE 0x20200FD8 /* Flash/EEPROM interrupt clear enable */
76 #define INT_SET_ENABLE 0x20200FDC /* Flash/EEPROM interrupt set enable */
77 #define INT_STATUS 0x20200FE0 /* Flash/EEPROM interrupt status */
78 #define INT_ENABLE 0x20200FE4 /* Flash/EEPROM interrupt enable */
79 #define INT_CLR_STATUS 0x20200FE8 /* Flash/EEPROM interrupt clear status */
80 #define INT_SET_STATUS 0x20200FEC /* Flash/EEPROM interrupt set status */
81
82 /* Interrupt sources */
83 #define INTSRC_END_OF_PROG (1 << 28)
84 #define INTSRC_END_OF_BIST (1 << 27)
85 #define INTSRC_END_OF_RDWR (1 << 26)
86 #define INTSRC_END_OF_MISR (1 << 2)
87 #define INTSRC_END_OF_BURN (1 << 1)
88 #define INTSRC_END_OF_ERASE (1 << 0)
89
90
91 /* FCTR bits */
92 #define FCTR_FS_LOADREQ (1 << 15)
93 #define FCTR_FS_CACHECLR (1 << 14)
94 #define FCTR_FS_CACHEBYP (1 << 13)
95 #define FCTR_FS_PROGREQ (1 << 12)
96 #define FCTR_FS_RLS (1 << 11)
97 #define FCTR_FS_PDL (1 << 10)
98 #define FCTR_FS_PD (1 << 9)
99 #define FCTR_FS_WPB (1 << 7)
100 #define FCTR_FS_ISS (1 << 6)
101 #define FCTR_FS_RLD (1 << 5)
102 #define FCTR_FS_DCR (1 << 4)
103 #define FCTR_FS_WEB (1 << 2)
104 #define FCTR_FS_WRE (1 << 1)
105 #define FCTR_FS_CS (1 << 0)
106 /* FPTR bits */
107 #define FPTR_EN_T (1 << 15)
108 /* FTCTR bits */
109 #define FTCTR_FS_BYPASS_R (1 << 29)
110 #define FTCTR_FS_BYPASS_W (1 << 28)
111 /* FMSSTOP bits */
112 #define FMSSTOP_MISR_START (1 << 17)
113 /* EEMSSTOP bits */
114 #define EEMSSTOP_STRTBIST (1 << 31)
115
116 /* Index sector */
117 #define ISS_CUSTOMER_START1 (0x830)
118 #define ISS_CUSTOMER_END1 (0xA00)
119 #define ISS_CUSTOMER_SIZE1 (ISS_CUSTOMER_END1 - ISS_CUSTOMER_START1)
120 #define ISS_CUSTOMER_NWORDS1 (ISS_CUSTOMER_SIZE1 / 4)
121 #define ISS_CUSTOMER_START2 (0xA40)
122 #define ISS_CUSTOMER_END2 (0xC00)
123 #define ISS_CUSTOMER_SIZE2 (ISS_CUSTOMER_END2 - ISS_CUSTOMER_START2)
124 #define ISS_CUSTOMER_NWORDS2 (ISS_CUSTOMER_SIZE2 / 4)
125 #define ISS_CUSTOMER_SIZE (ISS_CUSTOMER_SIZE1 + ISS_CUSTOMER_SIZE2)
126
127
128
129 /**
130 * Private data for \c lpc2900 flash driver.
131 */
132 struct lpc2900_flash_bank
133 {
134 /**
135 * Holds the value read from CHIPID register.
136 * The driver will not load if the chipid doesn't match the expected
137 * value of 0x209CE02B of the LPC2900 family. A probe will only be done
138 * if the chipid does not yet contain the expected value.
139 */
140 uint32_t chipid;
141
142 /**
143 * String holding device name.
144 * This string is set by the probe function to the type number of the
145 * device. It takes the form "LPC29xx".
146 */
147 char * target_name;
148
149 /**
150 * System clock frequency.
151 * Holds the clock frequency in Hz, as passed by the configuration file
152 * to the <tt>flash bank</tt> command.
153 */
154 uint32_t clk_sys_fmc;
155
156 /**
157 * Flag to indicate that dangerous operations are possible.
158 * This flag can be set by passing the correct password to the
159 * <tt>lpc2900 password</tt> command. If set, other dangerous commands,
160 * which operate on the index sector, can be executed.
161 */
162 uint32_t risky;
163
164 /**
165 * Maximum contiguous block of internal SRAM (bytes).
166 * Autodetected by the driver. Not the total amount of SRAM, only the
167 * the largest \em contiguous block!
168 */
169 uint32_t max_ram_block;
170
171 };
172
173
174 static uint32_t lpc2900_wait_status(struct flash_bank *bank, uint32_t mask, int timeout);
175 static void lpc2900_setup(struct flash_bank *bank);
176 static uint32_t lpc2900_is_ready(struct flash_bank *bank);
177 static uint32_t lpc2900_read_security_status(struct flash_bank *bank);
178 static uint32_t lpc2900_run_bist128(struct flash_bank *bank,
179 uint32_t addr_from, uint32_t addr_to,
180 uint32_t (*signature)[4] );
181 static uint32_t lpc2900_address2sector(struct flash_bank *bank, uint32_t offset);
182 static uint32_t lpc2900_calc_tr( uint32_t clock, uint32_t time );
183
184
185 /*********************** Helper functions **************************/
186
187
188 /**
189 * Wait for an event in mask to occur in INT_STATUS.
190 *
191 * Return when an event occurs, or after a timeout.
192 *
193 * @param[in] bank Pointer to the flash bank descriptor
194 * @param[in] mask Mask to be used for INT_STATUS
195 * @param[in] timeout Timeout in ms
196 */
197 static uint32_t lpc2900_wait_status( struct flash_bank *bank,
198 uint32_t mask,
199 int timeout )
200 {
201 uint32_t int_status;
202 struct target *target = bank->target;
203
204
205 do
206 {
207 alive_sleep(1);
208 timeout--;
209 target_read_u32(target, INT_STATUS, &int_status);
210 }
211 while( ((int_status & mask) == 0) && (timeout != 0) );
212
213 if (timeout == 0)
214 {
215 LOG_DEBUG("Timeout!");
216 return ERROR_FLASH_OPERATION_FAILED;
217 }
218
219 return ERROR_OK;
220 }
221
222
223
224 /**
225 * Set up the flash for erase/program operations.
226 *
227 * Enable the flash, and set the correct CRA clock of 66 kHz.
228 *
229 * @param bank Pointer to the flash bank descriptor
230 */
231 static void lpc2900_setup( struct flash_bank *bank )
232 {
233 uint32_t fcra;
234 struct lpc2900_flash_bank *lpc2900_info = bank->driver_priv;
235
236
237 /* Power up the flash block */
238 target_write_u32( bank->target, FCTR, FCTR_FS_WEB | FCTR_FS_CS );
239
240
241 fcra = (lpc2900_info->clk_sys_fmc / (3 * 66000)) - 1;
242 target_write_u32( bank->target, FCRA, fcra );
243 }
244
245
246
247 /**
248 * Check if device is ready.
249 *
250 * Check if device is ready for flash operation:
251 * Must have been successfully probed.
252 * Must be halted.
253 */
254 static uint32_t lpc2900_is_ready( struct flash_bank *bank )
255 {
256 struct lpc2900_flash_bank *lpc2900_info = bank->driver_priv;
257
258 if( lpc2900_info->chipid != EXPECTED_CHIPID )
259 {
260 return ERROR_FLASH_BANK_NOT_PROBED;
261 }
262
263 if( bank->target->state != TARGET_HALTED )
264 {
265 LOG_ERROR( "Target not halted" );
266 return ERROR_TARGET_NOT_HALTED;
267 }
268
269 return ERROR_OK;
270 }
271
272
273 /**
274 * Read the status of sector security from the index sector.
275 *
276 * @param bank Pointer to the flash bank descriptor
277 */
278 static uint32_t lpc2900_read_security_status( struct flash_bank *bank )
279 {
280 uint32_t status;
281 if( (status = lpc2900_is_ready( bank )) != ERROR_OK )
282 {
283 return status;
284 }
285
286 struct target *target = bank->target;
287
288 /* Enable ISS access */
289 target_write_u32(target, FCTR, FCTR_FS_CS | FCTR_FS_WEB | FCTR_FS_ISS);
290
291 /* Read the relevant block of memory from the ISS sector */
292 uint32_t iss_secured_field[ 0x230/16 ][ 4 ];
293 target_read_memory(target, bank->base + 0xC00, 4, 0x230/4,
294 (uint8_t *)iss_secured_field);
295
296 /* Disable ISS access */
297 target_write_u32(target, FCTR, FCTR_FS_CS | FCTR_FS_WEB);
298
299 /* Check status of each sector. Note that the sector numbering in the LPC2900
300 * is different from the logical sector numbers used in OpenOCD!
301 * Refer to the user manual for details.
302 *
303 * All zeros (16x 0x00) are treated as a secured sector (is_protected = 1)
304 * All ones (16x 0xFF) are treated as a non-secured sector (is_protected = 0)
305 * Anything else is undefined (is_protected = -1). This is treated as
306 * a protected sector!
307 */
308 int sector;
309 int index;
310 for( sector = 0; sector < bank->num_sectors; sector++ )
311 {
312 /* Convert logical sector number to physical sector number */
313 if( sector <= 4 )
314 {
315 index = sector + 11;
316 }
317 else if( sector <= 7 )
318 {
319 index = sector + 27;
320 }
321 else
322 {
323 index = sector - 8;
324 }
325
326 bank->sectors[sector].is_protected = -1;
327
328 if (
329 (iss_secured_field[index][0] == 0x00000000) &&
330 (iss_secured_field[index][1] == 0x00000000) &&
331 (iss_secured_field[index][2] == 0x00000000) &&
332 (iss_secured_field[index][3] == 0x00000000) )
333 {
334 bank->sectors[sector].is_protected = 1;
335 }
336
337 if (
338 (iss_secured_field[index][0] == 0xFFFFFFFF) &&
339 (iss_secured_field[index][1] == 0xFFFFFFFF) &&
340 (iss_secured_field[index][2] == 0xFFFFFFFF) &&
341 (iss_secured_field[index][3] == 0xFFFFFFFF) )
342 {
343 bank->sectors[sector].is_protected = 0;
344 }
345 }
346
347 return ERROR_OK;
348 }
349
350
351 /**
352 * Use BIST to calculate a 128-bit hash value over a range of flash.
353 *
354 * @param bank Pointer to the flash bank descriptor
355 * @param addr_from
356 * @param addr_to
357 * @param signature
358 */
359 static uint32_t lpc2900_run_bist128(struct flash_bank *bank,
360 uint32_t addr_from,
361 uint32_t addr_to,
362 uint32_t (*signature)[4] )
363 {
364 struct target *target = bank->target;
365
366 /* Clear END_OF_MISR interrupt status */
367 target_write_u32( target, INT_CLR_STATUS, INTSRC_END_OF_MISR );
368
369 /* Start address */
370 target_write_u32( target, FMSSTART, addr_from >> 4);
371 /* End address, and issue start command */
372 target_write_u32( target, FMSSTOP, (addr_to >> 4) | FMSSTOP_MISR_START );
373
374 /* Poll for end of operation. Calculate a reasonable timeout. */
375 if( lpc2900_wait_status( bank, INTSRC_END_OF_MISR, 1000 ) != ERROR_OK )
376 {
377 return ERROR_FLASH_OPERATION_FAILED;
378 }
379
380 /* Return the signature */
381 target_read_memory( target, FMSW0, 4, 4, (uint8_t *)signature );
382
383 return ERROR_OK;
384 }
385
386
387 /**
388 * Return sector number for given address.
389 *
390 * Return the (logical) sector number for a given relative address.
391 * No sanity check is done. It assumed that the address is valid.
392 *
393 * @param bank Pointer to the flash bank descriptor
394 * @param offset Offset address relative to bank start
395 */
396 static uint32_t lpc2900_address2sector( struct flash_bank *bank,
397 uint32_t offset )
398 {
399 uint32_t address = bank->base + offset;
400
401
402 /* Run through all sectors of this bank */
403 int sector;
404 for( sector = 0; sector < bank->num_sectors; sector++ )
405 {
406 /* Return immediately if address is within the current sector */
407 if( address < (bank->sectors[sector].offset + bank->sectors[sector].size) )
408 {
409 return sector;
410 }
411 }
412
413 /* We should never come here. If we do, return an arbitrary sector number. */
414 return 0;
415 }
416
417
418
419
420 /**
421 * Write one page to the index sector.
422 *
423 * @param bank Pointer to the flash bank descriptor
424 * @param pagenum Page number (0...7)
425 * @param page Page array (FLASH_PAGE_SIZE bytes)
426 */
427 static int lpc2900_write_index_page( struct flash_bank *bank,
428 int pagenum,
429 uint8_t (*page)[FLASH_PAGE_SIZE] )
430 {
431 /* Only pages 4...7 are user writable */
432 if ((pagenum < 4) || (pagenum > 7))
433 {
434 LOG_ERROR("Refuse to burn index sector page %d", pagenum);
435 return ERROR_COMMAND_ARGUMENT_INVALID;
436 }
437
438 /* Get target, and check if it's halted */
439 struct target *target = bank->target;
440 if( target->state != TARGET_HALTED )
441 {
442 LOG_ERROR( "Target not halted" );
443 return ERROR_TARGET_NOT_HALTED;
444 }
445
446 /* Private info */
447 struct lpc2900_flash_bank *lpc2900_info = bank->driver_priv;
448
449 /* Enable flash block and set the correct CRA clock of 66 kHz */
450 lpc2900_setup( bank );
451
452 /* Un-protect the index sector */
453 target_write_u32( target, bank->base, 0 );
454 target_write_u32( target, FCTR,
455 FCTR_FS_LOADREQ | FCTR_FS_WPB | FCTR_FS_ISS |
456 FCTR_FS_WEB | FCTR_FS_WRE | FCTR_FS_CS );
457
458 /* Set latch load mode */
459 target_write_u32( target, FCTR,
460 FCTR_FS_ISS | FCTR_FS_WEB | FCTR_FS_WRE | FCTR_FS_CS );
461
462 /* Write whole page to flash data latches */
463 if( target_write_memory( target,
464 bank->base + pagenum * FLASH_PAGE_SIZE,
465 4, FLASH_PAGE_SIZE / 4, (uint8_t *)page) != ERROR_OK )
466 {
467 LOG_ERROR("Index sector write failed @ page %d", pagenum);
468 target_write_u32( target, FCTR, FCTR_FS_CS | FCTR_FS_WEB );
469
470 return ERROR_FLASH_OPERATION_FAILED;
471 }
472
473 /* Clear END_OF_BURN interrupt status */
474 target_write_u32( target, INT_CLR_STATUS, INTSRC_END_OF_BURN );
475
476 /* Set the program/erase time to FLASH_PROGRAM_TIME */
477 target_write_u32(target, FPTR,
478 FPTR_EN_T | lpc2900_calc_tr( lpc2900_info->clk_sys_fmc,
479 FLASH_PROGRAM_TIME ));
480
481 /* Trigger flash write */
482 target_write_u32( target, FCTR,
483 FCTR_FS_PROGREQ | FCTR_FS_ISS |
484 FCTR_FS_WPB | FCTR_FS_WRE | FCTR_FS_CS );
485
486 /* Wait for the end of the write operation. If it's not over after one
487 * second, something went dreadfully wrong... :-(
488 */
489 if (lpc2900_wait_status(bank, INTSRC_END_OF_BURN, 1000) != ERROR_OK)
490 {
491 LOG_ERROR("Index sector write failed @ page %d", pagenum);
492 target_write_u32(target, FCTR, FCTR_FS_CS | FCTR_FS_WEB);
493
494 return ERROR_FLASH_OPERATION_FAILED;
495 }
496
497 target_write_u32( target, FCTR, FCTR_FS_CS | FCTR_FS_WEB );
498
499 return ERROR_OK;
500 }
501
502
503
504 /**
505 * Calculate FPTR.TR register value for desired program/erase time.
506 *
507 * @param clock System clock in Hz
508 * @param time Program/erase time in µs
509 */
510 static uint32_t lpc2900_calc_tr( uint32_t clock, uint32_t time )
511 {
512 /* ((time[µs]/1e6) * f[Hz]) + 511
513 * FPTR.TR = -------------------------------
514 * 512
515 *
516 * The result is the
517 */
518
519 uint32_t tr_val = (uint32_t)((((time / 1e6) * clock) + 511.0) / 512.0);
520
521 return tr_val;
522 }
523
524
525 /*********************** Private flash commands **************************/
526
527
528 /**
529 * Command to determine the signature of the whole flash.
530 *
531 * Uses the Built-In-Self-Test (BIST) to generate a 128-bit hash value
532 * of the flash content.
533 */
534 COMMAND_HANDLER(lpc2900_handle_signature_command)
535 {
536 uint32_t status;
537 uint32_t signature[4];
538
539
540 if( CMD_ARGC < 1 )
541 {
542 LOG_WARNING( "Too few arguments. Call: lpc2900 signature <bank#>" );
543 return ERROR_FLASH_BANK_INVALID;
544 }
545
546 struct flash_bank *bank;
547 int retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &bank);
548 if (ERROR_OK != retval)
549 return retval;
550
551 if( bank->target->state != TARGET_HALTED )
552 {
553 LOG_ERROR( "Target not halted" );
554 return ERROR_TARGET_NOT_HALTED;
555 }
556
557 /* Run BIST over whole flash range */
558 if( (status = lpc2900_run_bist128( bank,
559 bank->base,
560 bank->base + (bank->size - 1),
561 &signature)
562 ) != ERROR_OK )
563 {
564 return status;
565 }
566
567 command_print( CMD_CTX, "signature: 0x%8.8" PRIx32
568 ":0x%8.8" PRIx32
569 ":0x%8.8" PRIx32
570 ":0x%8.8" PRIx32,
571 signature[3], signature[2], signature[1], signature[0] );
572
573 return ERROR_OK;
574 }
575
576
577
578 /**
579 * Store customer info in file.
580 *
581 * Read customer info from index sector, and store that block of data into
582 * a disk file. The format is binary.
583 */
584 COMMAND_HANDLER(lpc2900_handle_read_custom_command)
585 {
586 if( CMD_ARGC < 2 )
587 {
588 return ERROR_COMMAND_SYNTAX_ERROR;
589 }
590
591 struct flash_bank *bank;
592 int retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &bank);
593 if (ERROR_OK != retval)
594 return retval;
595
596 struct lpc2900_flash_bank *lpc2900_info = bank->driver_priv;
597 lpc2900_info->risky = 0;
598
599 /* Get target, and check if it's halted */
600 struct target *target = bank->target;
601 if( target->state != TARGET_HALTED )
602 {
603 LOG_ERROR( "Target not halted" );
604 return ERROR_TARGET_NOT_HALTED;
605 }
606
607 /* Storage for customer info. Read in two parts */
608 uint32_t customer[ ISS_CUSTOMER_NWORDS1 + ISS_CUSTOMER_NWORDS2 ];
609
610 /* Enable access to index sector */
611 target_write_u32( target, FCTR, FCTR_FS_CS | FCTR_FS_WEB | FCTR_FS_ISS );
612
613 /* Read two parts */
614 target_read_memory( target, bank->base+ISS_CUSTOMER_START1, 4,
615 ISS_CUSTOMER_NWORDS1,
616 (uint8_t *)&customer[0] );
617 target_read_memory( target, bank->base+ISS_CUSTOMER_START2, 4,
618 ISS_CUSTOMER_NWORDS2,
619 (uint8_t *)&customer[ISS_CUSTOMER_NWORDS1] );
620
621 /* Deactivate access to index sector */
622 target_write_u32( target, FCTR, FCTR_FS_CS | FCTR_FS_WEB );
623
624 /* Try and open the file */
625 struct fileio fileio;
626 const char *filename = CMD_ARGV[1];
627 int ret = fileio_open( &fileio, filename, FILEIO_WRITE, FILEIO_BINARY );
628 if( ret != ERROR_OK )
629 {
630 LOG_WARNING( "Could not open file %s", filename );
631 return ret;
632 }
633
634 size_t nwritten;
635 ret = fileio_write( &fileio, sizeof(customer),
636 (const uint8_t *)customer, &nwritten );
637 if( ret != ERROR_OK )
638 {
639 LOG_ERROR( "Write operation to file %s failed", filename );
640 fileio_close( &fileio );
641 return ret;
642 }
643
644 fileio_close( &fileio );
645
646 return ERROR_OK;
647 }
648
649
650
651
652 /**
653 * Enter password to enable potentially dangerous options.
654 */
655 COMMAND_HANDLER(lpc2900_handle_password_command)
656 {
657 if (CMD_ARGC < 2)
658 {
659 return ERROR_COMMAND_SYNTAX_ERROR;
660 }
661
662 struct flash_bank *bank;
663 int retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &bank);
664 if (ERROR_OK != retval)
665 return retval;
666
667 struct lpc2900_flash_bank *lpc2900_info = bank->driver_priv;
668
669 #define ISS_PASSWORD "I_know_what_I_am_doing"
670
671 lpc2900_info->risky = !strcmp( CMD_ARGV[1], ISS_PASSWORD );
672
673 if( !lpc2900_info->risky )
674 {
675 command_print(CMD_CTX, "Wrong password (use '%s')", ISS_PASSWORD);
676 return ERROR_COMMAND_ARGUMENT_INVALID;
677 }
678
679 command_print(CMD_CTX,
680 "Potentially dangerous operation allowed in next command!");
681
682 return ERROR_OK;
683 }
684
685
686
687 /**
688 * Write customer info from file to the index sector.
689 */
690 COMMAND_HANDLER(lpc2900_handle_write_custom_command)
691 {
692 if (CMD_ARGC < 2)
693 {
694 return ERROR_COMMAND_SYNTAX_ERROR;
695 }
696
697 struct flash_bank *bank;
698 int retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &bank);
699 if (ERROR_OK != retval)
700 return retval;
701
702 struct lpc2900_flash_bank *lpc2900_info = bank->driver_priv;
703
704 /* Check if command execution is allowed. */
705 if( !lpc2900_info->risky )
706 {
707 command_print( CMD_CTX, "Command execution not allowed!" );
708 return ERROR_COMMAND_ARGUMENT_INVALID;
709 }
710 lpc2900_info->risky = 0;
711
712 /* Get target, and check if it's halted */
713 struct target *target = bank->target;
714 if (target->state != TARGET_HALTED)
715 {
716 LOG_ERROR("Target not halted");
717 return ERROR_TARGET_NOT_HALTED;
718 }
719
720 /* The image will always start at offset 0 */
721 struct image image;
722 image.base_address_set = 1;
723 image.base_address = 0;
724 image.start_address_set = 0;
725
726 const char *filename = CMD_ARGV[1];
727 const char *type = (CMD_ARGC >= 3) ? CMD_ARGV[2] : NULL;
728 retval = image_open(&image, filename, type);
729 if (retval != ERROR_OK)
730 {
731 return retval;
732 }
733
734 /* Do a sanity check: The image must be exactly the size of the customer
735 programmable area. Any other size is rejected. */
736 if( image.num_sections != 1 )
737 {
738 LOG_ERROR("Only one section allowed in image file.");
739 return ERROR_COMMAND_SYNTAX_ERROR;
740 }
741 if( (image.sections[0].base_address != 0) ||
742 (image.sections[0].size != ISS_CUSTOMER_SIZE) )
743 {
744 LOG_ERROR("Incorrect image file size. Expected %d, "
745 "got %" PRIu32,
746 ISS_CUSTOMER_SIZE, image.sections[0].size);
747 return ERROR_COMMAND_SYNTAX_ERROR;
748 }
749
750 /* Well boys, I reckon this is it... */
751
752 /* Customer info is split into two blocks in pages 4 and 5. */
753 uint8_t page[FLASH_PAGE_SIZE];
754
755 /* Page 4 */
756 uint32_t offset = ISS_CUSTOMER_START1 % FLASH_PAGE_SIZE;
757 memset( page, 0xff, FLASH_PAGE_SIZE );
758 size_t size_read;
759 retval = image_read_section( &image, 0, 0,
760 ISS_CUSTOMER_SIZE1, &page[offset], &size_read);
761 if( retval != ERROR_OK )
762 {
763 LOG_ERROR("couldn't read from file '%s'", filename);
764 image_close(&image);
765 return retval;
766 }
767 if( (retval = lpc2900_write_index_page( bank, 4, &page )) != ERROR_OK )
768 {
769 image_close(&image);
770 return retval;
771 }
772
773 /* Page 5 */
774 offset = ISS_CUSTOMER_START2 % FLASH_PAGE_SIZE;
775 memset( page, 0xff, FLASH_PAGE_SIZE );
776 retval = image_read_section( &image, 0, ISS_CUSTOMER_SIZE1,
777 ISS_CUSTOMER_SIZE2, &page[offset], &size_read);
778 if( retval != ERROR_OK )
779 {
780 LOG_ERROR("couldn't read from file '%s'", filename);
781 image_close(&image);
782 return retval;
783 }
784 if( (retval = lpc2900_write_index_page( bank, 5, &page )) != ERROR_OK )
785 {
786 image_close(&image);
787 return retval;
788 }
789
790 image_close(&image);
791
792 return ERROR_OK;
793 }
794
795
796
797 /**
798 * Activate 'sector security' for a range of sectors.
799 */
800 COMMAND_HANDLER(lpc2900_handle_secure_sector_command)
801 {
802 if (CMD_ARGC < 3)
803 {
804 return ERROR_COMMAND_SYNTAX_ERROR;
805 }
806
807 /* Get the bank descriptor */
808 struct flash_bank *bank;
809 int retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &bank);
810 if (ERROR_OK != retval)
811 return retval;
812
813 struct lpc2900_flash_bank *lpc2900_info = bank->driver_priv;
814
815 /* Check if command execution is allowed. */
816 if( !lpc2900_info->risky )
817 {
818 command_print( CMD_CTX, "Command execution not allowed! "
819 "(use 'password' command first)");
820 return ERROR_COMMAND_ARGUMENT_INVALID;
821 }
822 lpc2900_info->risky = 0;
823
824 /* Read sector range, and do a sanity check. */
825 int first, last;
826 COMMAND_PARSE_NUMBER(int, CMD_ARGV[1], first);
827 COMMAND_PARSE_NUMBER(int, CMD_ARGV[2], last);
828 if( (first >= bank->num_sectors) ||
829 (last >= bank->num_sectors) ||
830 (first > last) )
831 {
832 command_print( CMD_CTX, "Illegal sector range" );
833 return ERROR_COMMAND_ARGUMENT_INVALID;
834 }
835
836 uint8_t page[FLASH_PAGE_SIZE];
837 int sector;
838
839 /* Sectors in page 6 */
840 if( (first <= 4) || (last >= 8) )
841 {
842 memset( &page, 0xff, FLASH_PAGE_SIZE );
843 for( sector = first; sector <= last; sector++ )
844 {
845 if( sector <= 4 )
846 {
847 memset( &page[0xB0 + 16*sector], 0, 16 );
848 }
849 else if( sector >= 8 )
850 {
851 memset( &page[0x00 + 16*(sector - 8)], 0, 16 );
852 }
853 }
854
855 if( (retval = lpc2900_write_index_page( bank, 6, &page )) != ERROR_OK )
856 {
857 LOG_ERROR("failed to update index sector page 6");
858 return retval;
859 }
860 }
861
862 /* Sectors in page 7 */
863 if( (first <= 7) && (last >= 5) )
864 {
865 memset( &page, 0xff, FLASH_PAGE_SIZE );
866 for( sector = first; sector <= last; sector++ )
867 {
868 if( (sector >= 5) && (sector <= 7) )
869 {
870 memset( &page[0x00 + 16*(sector - 5)], 0, 16 );
871 }
872 }
873
874 if( (retval = lpc2900_write_index_page( bank, 7, &page )) != ERROR_OK )
875 {
876 LOG_ERROR("failed to update index sector page 7");
877 return retval;
878 }
879 }
880
881 command_print( CMD_CTX,
882 "Sectors security will become effective after next power cycle");
883
884 /* Update the sector security status */
885 if ( lpc2900_read_security_status(bank) != ERROR_OK )
886 {
887 LOG_ERROR( "Cannot determine sector security status" );
888 return ERROR_FLASH_OPERATION_FAILED;
889 }
890
891 return ERROR_OK;
892 }
893
894
895
896 /**
897 * Activate JTAG protection.
898 */
899 COMMAND_HANDLER(lpc2900_handle_secure_jtag_command)
900 {
901 if (CMD_ARGC < 1)
902 {
903 return ERROR_COMMAND_SYNTAX_ERROR;
904 }
905
906 /* Get the bank descriptor */
907 struct flash_bank *bank;
908 int retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &bank);
909 if (ERROR_OK != retval)
910 return retval;
911
912 struct lpc2900_flash_bank *lpc2900_info = bank->driver_priv;
913
914 /* Check if command execution is allowed. */
915 if( !lpc2900_info->risky )
916 {
917 command_print( CMD_CTX, "Command execution not allowed! "
918 "(use 'password' command first)");
919 return ERROR_COMMAND_ARGUMENT_INVALID;
920 }
921 lpc2900_info->risky = 0;
922
923 /* Prepare page */
924 uint8_t page[FLASH_PAGE_SIZE];
925 memset( &page, 0xff, FLASH_PAGE_SIZE );
926
927
928 /* Insert "soft" protection word */
929 page[0x30 + 15] = 0x7F;
930 page[0x30 + 11] = 0x7F;
931 page[0x30 + 7] = 0x7F;
932 page[0x30 + 3] = 0x7F;
933
934 /* Write to page 5 */
935 if( (retval = lpc2900_write_index_page( bank, 5, &page ))
936 != ERROR_OK )
937 {
938 LOG_ERROR("failed to update index sector page 5");
939 return retval;
940 }
941
942 LOG_INFO("JTAG security set. Good bye!");
943
944 return ERROR_OK;
945 }
946
947
948
949 /*********************** Flash interface functions **************************/
950
951 static const struct command_registration lpc2900_exec_command_handlers[] = {
952 {
953 .name = "signature",
954 .handler = &lpc2900_handle_signature_command,
955 .mode = COMMAND_EXEC,
956 .usage = "<bank>",
957 .help = "print device signature of flash bank",
958 },
959 {
960 .name = "read_custom",
961 .handler = &lpc2900_handle_read_custom_command,
962 .mode = COMMAND_EXEC,
963 .usage = "<bank> <filename>",
964 .help = "read customer information from index sector to file",
965 },
966 {
967 .name = "password",
968 .handler = &lpc2900_handle_password_command,
969 .mode = COMMAND_EXEC,
970 .usage = "<bank> <password>",
971 .help = "enter password to enable 'dangerous' options",
972 },
973 {
974 .name = "write_custom",
975 .handler = &lpc2900_handle_write_custom_command,
976 .mode = COMMAND_EXEC,
977 .usage = "<bank> <filename> [<type>]",
978 .help = "write customer info from file to index sector",
979 },
980 {
981 .name = "secure_sector",
982 .handler = &lpc2900_handle_secure_sector_command,
983 .mode = COMMAND_EXEC,
984 .usage = "<bank> <first> <last>",
985 .help = "activate sector security for a range of sectors",
986 },
987 {
988 .name = "secure_jtag",
989 .handler = &lpc2900_handle_secure_jtag_command,
990 .mode = COMMAND_EXEC,
991 .usage = "<bank> <level>",
992 .help = "activate JTAG security",
993 },
994 COMMAND_REGISTRATION_DONE
995 };
996 static const struct command_registration lpc2900_command_handlers[] = {
997 {
998 .name = "lpc2900",
999 .mode = COMMAND_ANY,
1000 .help = "LPC2900 flash command group",
1001 .chain = lpc2900_exec_command_handlers,
1002 },
1003 COMMAND_REGISTRATION_DONE
1004 };
1005
1006 /// Evaluate flash bank command.
1007 FLASH_BANK_COMMAND_HANDLER(lpc2900_flash_bank_command)
1008 {
1009 struct lpc2900_flash_bank *lpc2900_info;
1010
1011 if (CMD_ARGC < 6)
1012 {
1013 LOG_WARNING("incomplete flash_bank LPC2900 configuration");
1014 return ERROR_FLASH_BANK_INVALID;
1015 }
1016
1017 lpc2900_info = malloc(sizeof(struct lpc2900_flash_bank));
1018 bank->driver_priv = lpc2900_info;
1019
1020 /* Get flash clock.
1021 * Reject it if we can't meet the requirements for program time
1022 * (if clock too slow), or for erase time (clock too fast).
1023 */
1024 uint32_t clk_sys_fmc;
1025 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[6], clk_sys_fmc);
1026 lpc2900_info->clk_sys_fmc = clk_sys_fmc * 1000;
1027
1028 uint32_t clock_limit;
1029 /* Check program time limit */
1030 clock_limit = 512000000l / FLASH_PROGRAM_TIME;
1031 if (lpc2900_info->clk_sys_fmc < clock_limit)
1032 {
1033 LOG_WARNING("flash clock must be at least %" PRIu32 " kHz",
1034 (clock_limit / 1000));
1035 return ERROR_FLASH_BANK_INVALID;
1036 }
1037
1038 /* Check erase time limit */
1039 clock_limit = (uint32_t)((32767.0 * 512.0 * 1e6) / FLASH_ERASE_TIME);
1040 if (lpc2900_info->clk_sys_fmc > clock_limit)
1041 {
1042 LOG_WARNING("flash clock must be a maximum of %" PRIu32" kHz",
1043 (clock_limit / 1000));
1044 return ERROR_FLASH_BANK_INVALID;
1045 }
1046
1047 /* Chip ID will be obtained by probing the device later */
1048 lpc2900_info->chipid = 0;
1049
1050 return ERROR_OK;
1051 }
1052
1053
1054 /**
1055 * Erase sector(s).
1056 *
1057 * @param bank Pointer to the flash bank descriptor
1058 * @param first First sector to be erased
1059 * @param last Last sector (including) to be erased
1060 */
1061 static int lpc2900_erase(struct flash_bank *bank, int first, int last)
1062 {
1063 uint32_t status;
1064 int sector;
1065 int last_unsecured_sector;
1066 struct target *target = bank->target;
1067 struct lpc2900_flash_bank *lpc2900_info = bank->driver_priv;
1068
1069
1070 status = lpc2900_is_ready(bank);
1071 if (status != ERROR_OK)
1072 {
1073 return status;
1074 }
1075
1076 /* Sanity check on sector range */
1077 if ((first < 0) || (last < first) || (last >= bank->num_sectors))
1078 {
1079 LOG_INFO("Bad sector range");
1080 return ERROR_FLASH_SECTOR_INVALID;
1081 }
1082
1083 /* Update the info about secured sectors */
1084 lpc2900_read_security_status( bank );
1085
1086 /* The selected sector range might include secured sectors. An attempt
1087 * to erase such a sector will cause the erase to fail also for unsecured
1088 * sectors. It is necessary to determine the last unsecured sector now,
1089 * because we have to treat the last relevant sector in the list in
1090 * a special way.
1091 */
1092 last_unsecured_sector = -1;
1093 for (sector = first; sector <= last; sector++)
1094 {
1095 if ( !bank->sectors[sector].is_protected )
1096 {
1097 last_unsecured_sector = sector;
1098 }
1099 }
1100
1101 /* Exit now, in case of the rare constellation where all sectors in range
1102 * are secured. This is regarded a success, since erasing/programming of
1103 * secured sectors shall be handled transparently.
1104 */
1105 if ( last_unsecured_sector == -1 )
1106 {
1107 return ERROR_OK;
1108 }
1109
1110 /* Enable flash block and set the correct CRA clock of 66 kHz */
1111 lpc2900_setup(bank);
1112
1113 /* Clear END_OF_ERASE interrupt status */
1114 target_write_u32(target, INT_CLR_STATUS, INTSRC_END_OF_ERASE);
1115
1116 /* Set the program/erase timer to FLASH_ERASE_TIME */
1117 target_write_u32(target, FPTR,
1118 FPTR_EN_T | lpc2900_calc_tr( lpc2900_info->clk_sys_fmc,
1119 FLASH_ERASE_TIME ));
1120
1121 /* Sectors are marked for erasure, then erased all together */
1122 for (sector = first; sector <= last_unsecured_sector; sector++)
1123 {
1124 /* Only mark sectors that aren't secured. Any attempt to erase a group
1125 * of sectors will fail if any single one of them is secured!
1126 */
1127 if ( !bank->sectors[sector].is_protected )
1128 {
1129 /* Unprotect the sector */
1130 target_write_u32(target, bank->sectors[sector].offset, 0);
1131 target_write_u32(target, FCTR,
1132 FCTR_FS_LOADREQ | FCTR_FS_WPB |
1133 FCTR_FS_WEB | FCTR_FS_WRE | FCTR_FS_CS);
1134
1135 /* Mark the sector for erasure. The last sector in the list
1136 triggers the erasure. */
1137 target_write_u32(target, bank->sectors[sector].offset, 0);
1138 if ( sector == last_unsecured_sector )
1139 {
1140 target_write_u32(target, FCTR,
1141 FCTR_FS_PROGREQ | FCTR_FS_WPB | FCTR_FS_CS);
1142 }
1143 else
1144 {
1145 target_write_u32(target, FCTR,
1146 FCTR_FS_LOADREQ | FCTR_FS_WPB |
1147 FCTR_FS_WEB | FCTR_FS_CS);
1148 }
1149 }
1150 }
1151
1152 /* Wait for the end of the erase operation. If it's not over after two seconds,
1153 * something went dreadfully wrong... :-(
1154 */
1155 if( lpc2900_wait_status(bank, INTSRC_END_OF_ERASE, 2000) != ERROR_OK )
1156 {
1157 return ERROR_FLASH_OPERATION_FAILED;
1158 }
1159
1160 /* Normal flash operating mode */
1161 target_write_u32(target, FCTR, FCTR_FS_CS | FCTR_FS_WEB);
1162
1163 return ERROR_OK;
1164 }
1165
1166
1167
1168 static int lpc2900_protect(struct flash_bank *bank, int set, int first, int last)
1169 {
1170 /* This command is not supported.
1171 * "Protection" in LPC2900 terms is handled transparently. Sectors will
1172 * automatically be unprotected as needed.
1173 * Instead we use the concept of sector security. A secured sector is shown
1174 * as "protected" in OpenOCD. Sector security is a permanent feature, and
1175 * cannot be disabled once activated.
1176 */
1177
1178 return ERROR_OK;
1179 }
1180
1181
1182 /**
1183 * Write data to flash.
1184 *
1185 * @param bank Pointer to the flash bank descriptor
1186 * @param buffer Buffer with data
1187 * @param offset Start address (relative to bank start)
1188 * @param count Number of bytes to be programmed
1189 */
1190 static int lpc2900_write(struct flash_bank *bank, uint8_t *buffer,
1191 uint32_t offset, uint32_t count)
1192 {
1193 uint8_t page[FLASH_PAGE_SIZE];
1194 uint32_t status;
1195 uint32_t num_bytes;
1196 struct target *target = bank->target;
1197 struct lpc2900_flash_bank *lpc2900_info = bank->driver_priv;
1198 int sector;
1199 int retval;
1200
1201 static const uint32_t write_target_code[] = {
1202 /* Set auto latch mode: FCTR=CS|WRE|WEB */
1203 0xe3a0a007, /* loop mov r10, #0x007 */
1204 0xe583a000, /* str r10,[r3,#0] */
1205
1206 /* Load complete page into latches */
1207 0xe3a06020, /* mov r6,#(512/16) */
1208 0xe8b00f00, /* next ldmia r0!,{r8-r11} */
1209 0xe8a10f00, /* stmia r1!,{r8-r11} */
1210 0xe2566001, /* subs r6,#1 */
1211 0x1afffffb, /* bne next */
1212
1213 /* Clear END_OF_BURN interrupt status */
1214 0xe3a0a002, /* mov r10,#(1 << 1) */
1215 0xe583afe8, /* str r10,[r3,#0xfe8] */
1216
1217 /* Set the erase time to FLASH_PROGRAM_TIME */
1218 0xe5834008, /* str r4,[r3,#8] */
1219
1220 /* Trigger flash write
1221 FCTR = CS | WRE | WPB | PROGREQ */
1222 0xe3a0a083, /* mov r10,#0x83 */
1223 0xe38aaa01, /* orr r10,#0x1000 */
1224 0xe583a000, /* str r10,[r3,#0] */
1225
1226 /* Wait for end of burn */
1227 0xe593afe0, /* wait ldr r10,[r3,#0xfe0] */
1228 0xe21aa002, /* ands r10,#(1 << 1) */
1229 0x0afffffc, /* beq wait */
1230
1231 /* End? */
1232 0xe2522001, /* subs r2,#1 */
1233 0x1affffed, /* bne loop */
1234
1235 0xeafffffe /* done b done */
1236 };
1237
1238
1239 status = lpc2900_is_ready(bank);
1240 if (status != ERROR_OK)
1241 {
1242 return status;
1243 }
1244
1245 /* Enable flash block and set the correct CRA clock of 66 kHz */
1246 lpc2900_setup(bank);
1247
1248 /* Update the info about secured sectors */
1249 lpc2900_read_security_status( bank );
1250
1251 /* Unprotect all involved sectors */
1252 for (sector = 0; sector < bank->num_sectors; sector++)
1253 {
1254 /* Start address in or before this sector? */
1255 /* End address in or behind this sector? */
1256 if ( ((bank->base + offset) <
1257 (bank->sectors[sector].offset + bank->sectors[sector].size)) &&
1258 ((bank->base + (offset + count - 1)) >= bank->sectors[sector].offset) )
1259 {
1260 /* This sector is involved and needs to be unprotected.
1261 * Don't do it for secured sectors.
1262 */
1263 if ( !bank->sectors[sector].is_protected )
1264 {
1265 target_write_u32(target, bank->sectors[sector].offset, 0);
1266 target_write_u32(target, FCTR,
1267 FCTR_FS_LOADREQ | FCTR_FS_WPB |
1268 FCTR_FS_WEB | FCTR_FS_WRE | FCTR_FS_CS);
1269 }
1270 }
1271 }
1272
1273 /* Set the program/erase time to FLASH_PROGRAM_TIME */
1274 uint32_t prog_time = FPTR_EN_T | lpc2900_calc_tr( lpc2900_info->clk_sys_fmc,
1275 FLASH_PROGRAM_TIME );
1276
1277 /* If there is a working area of reasonable size, use it to program via
1278 a target algorithm. If not, fall back to host programming. */
1279
1280 /* We need some room for target code. */
1281 uint32_t target_code_size = sizeof(write_target_code);
1282
1283 /* Try working area allocation. Start with a large buffer, and try with
1284 reduced size if that fails. */
1285 struct working_area *warea;
1286 uint32_t buffer_size = lpc2900_info->max_ram_block - 1 * KiB;
1287 while( (retval = target_alloc_working_area(target,
1288 buffer_size + target_code_size,
1289 &warea)) != ERROR_OK )
1290 {
1291 /* Try a smaller buffer now, and stop if it's too small. */
1292 buffer_size -= 1 * KiB;
1293 if (buffer_size < 2 * KiB)
1294 {
1295 LOG_INFO( "no (large enough) working area"
1296 ", falling back to host mode" );
1297 warea = NULL;
1298 break;
1299 }
1300 };
1301
1302 if( warea )
1303 {
1304 struct reg_param reg_params[5];
1305 struct armv4_5_algorithm armv4_5_info;
1306
1307 /* We can use target mode. Download the algorithm. */
1308 retval = target_write_buffer( target,
1309 (warea->address)+buffer_size,
1310 target_code_size,
1311 (uint8_t *)write_target_code);
1312 if (retval != ERROR_OK)
1313 {
1314 LOG_ERROR("Unable to write block write code to target");
1315 target_free_all_working_areas(target);
1316 return ERROR_FLASH_OPERATION_FAILED;
1317 }
1318
1319 init_reg_param(&reg_params[0], "r0", 32, PARAM_OUT);
1320 init_reg_param(&reg_params[1], "r1", 32, PARAM_OUT);
1321 init_reg_param(&reg_params[2], "r2", 32, PARAM_OUT);
1322 init_reg_param(&reg_params[3], "r3", 32, PARAM_OUT);
1323 init_reg_param(&reg_params[4], "r4", 32, PARAM_OUT);
1324
1325 /* Write to flash in large blocks */
1326 while ( count != 0 )
1327 {
1328 uint32_t this_npages;
1329 uint8_t *this_buffer;
1330 int start_sector = lpc2900_address2sector( bank, offset );
1331
1332 /* First page / last page / rest */
1333 if( offset % FLASH_PAGE_SIZE )
1334 {
1335 /* Block doesn't start on page boundary.
1336 Burn first partial page separately. */
1337 memset( &page, 0xff, sizeof(page) );
1338 memcpy( &page[offset % FLASH_PAGE_SIZE],
1339 buffer,
1340 FLASH_PAGE_SIZE - (offset % FLASH_PAGE_SIZE) );
1341 this_npages = 1;
1342 this_buffer = &page[0];
1343 count = count + (offset % FLASH_PAGE_SIZE);
1344 offset = offset - (offset % FLASH_PAGE_SIZE);
1345 }
1346 else if( count < FLASH_PAGE_SIZE )
1347 {
1348 /* Download last incomplete page separately. */
1349 memset( &page, 0xff, sizeof(page) );
1350 memcpy( &page, buffer, count );
1351 this_npages = 1;
1352 this_buffer = &page[0];
1353 count = FLASH_PAGE_SIZE;
1354 }
1355 else
1356 {
1357 /* Download as many full pages as possible */
1358 this_npages = (count < buffer_size) ?
1359 count / FLASH_PAGE_SIZE :
1360 buffer_size / FLASH_PAGE_SIZE;
1361 this_buffer = buffer;
1362
1363 /* Make sure we stop at the next secured sector */
1364 int sector = start_sector + 1;
1365 while( sector < bank->num_sectors )
1366 {
1367 /* Secured? */
1368 if( bank->sectors[sector].is_protected )
1369 {
1370 /* Is that next sector within the current block? */
1371 if( (bank->sectors[sector].offset - bank->base) <
1372 (offset + (this_npages * FLASH_PAGE_SIZE)) )
1373 {
1374 /* Yes! Split the block */
1375 this_npages =
1376 (bank->sectors[sector].offset - bank->base - offset)
1377 / FLASH_PAGE_SIZE;
1378 break;
1379 }
1380 }
1381
1382 sector++;
1383 }
1384 }
1385
1386 /* Skip the current sector if it is secured */
1387 if (bank->sectors[start_sector].is_protected)
1388 {
1389 LOG_DEBUG("Skip secured sector %d",
1390 start_sector);
1391
1392 /* Stop if this is the last sector */
1393 if (start_sector == bank->num_sectors - 1)
1394 {
1395 break;
1396 }
1397
1398 /* Skip */
1399 uint32_t nskip = bank->sectors[start_sector].size -
1400 (offset % bank->sectors[start_sector].size);
1401 offset += nskip;
1402 buffer += nskip;
1403 count = (count >= nskip) ? (count - nskip) : 0;
1404 continue;
1405 }
1406
1407 /* Execute buffer download */
1408 if ((retval = target_write_buffer(target,
1409 warea->address,
1410 this_npages * FLASH_PAGE_SIZE,
1411 this_buffer)) != ERROR_OK)
1412 {
1413 LOG_ERROR("Unable to write data to target");
1414 target_free_all_working_areas(target);
1415 return ERROR_FLASH_OPERATION_FAILED;
1416 }
1417
1418 /* Prepare registers */
1419 buf_set_u32(reg_params[0].value, 0, 32, warea->address);
1420 buf_set_u32(reg_params[1].value, 0, 32, offset);
1421 buf_set_u32(reg_params[2].value, 0, 32, this_npages);
1422 buf_set_u32(reg_params[3].value, 0, 32, FCTR);
1423 buf_set_u32(reg_params[4].value, 0, 32, FPTR_EN_T | prog_time);
1424
1425 /* Execute algorithm, assume breakpoint for last instruction */
1426 armv4_5_info.common_magic = ARMV4_5_COMMON_MAGIC;
1427 armv4_5_info.core_mode = ARMV4_5_MODE_SVC;
1428 armv4_5_info.core_state = ARMV4_5_STATE_ARM;
1429
1430 retval = target_run_algorithm(target, 0, NULL, 5, reg_params,
1431 (warea->address) + buffer_size,
1432 (warea->address) + buffer_size + target_code_size - 4,
1433 10000, /* 10s should be enough for max. 16 KiB of data */
1434 &armv4_5_info);
1435
1436 if (retval != ERROR_OK)
1437 {
1438 LOG_ERROR("Execution of flash algorithm failed.");
1439 target_free_all_working_areas(target);
1440 retval = ERROR_FLASH_OPERATION_FAILED;
1441 break;
1442 }
1443
1444 count -= this_npages * FLASH_PAGE_SIZE;
1445 buffer += this_npages * FLASH_PAGE_SIZE;
1446 offset += this_npages * FLASH_PAGE_SIZE;
1447 }
1448
1449 /* Free all resources */
1450 destroy_reg_param(&reg_params[0]);
1451 destroy_reg_param(&reg_params[1]);
1452 destroy_reg_param(&reg_params[2]);
1453 destroy_reg_param(&reg_params[3]);
1454 destroy_reg_param(&reg_params[4]);
1455 target_free_all_working_areas(target);
1456 }
1457 else
1458 {
1459 /* Write to flash memory page-wise */
1460 while ( count != 0 )
1461 {
1462 /* How many bytes do we copy this time? */
1463 num_bytes = (count >= FLASH_PAGE_SIZE) ?
1464 FLASH_PAGE_SIZE - (offset % FLASH_PAGE_SIZE) :
1465 count;
1466
1467 /* Don't do anything with it if the page is in a secured sector. */
1468 if ( !bank->sectors[lpc2900_address2sector(bank, offset)].is_protected )
1469 {
1470 /* Set latch load mode */
1471 target_write_u32(target, FCTR,
1472 FCTR_FS_CS | FCTR_FS_WRE | FCTR_FS_WEB);
1473
1474 /* Always clear the buffer (a little overhead, but who cares) */
1475 memset(page, 0xFF, FLASH_PAGE_SIZE);
1476
1477 /* Copy them to the buffer */
1478 memcpy( &page[offset % FLASH_PAGE_SIZE],
1479 &buffer[offset % FLASH_PAGE_SIZE],
1480 num_bytes );
1481
1482 /* Write whole page to flash data latches */
1483 if (target_write_memory(
1484 target,
1485 bank->base + (offset - (offset % FLASH_PAGE_SIZE)),
1486 4, FLASH_PAGE_SIZE / 4, page) != ERROR_OK)
1487 {
1488 LOG_ERROR("Write failed @ 0x%8.8" PRIx32, offset);
1489 target_write_u32(target, FCTR, FCTR_FS_CS | FCTR_FS_WEB);
1490
1491 return ERROR_FLASH_OPERATION_FAILED;
1492 }
1493
1494 /* Clear END_OF_BURN interrupt status */
1495 target_write_u32(target, INT_CLR_STATUS, INTSRC_END_OF_BURN);
1496
1497 /* Set the programming time */
1498 target_write_u32(target, FPTR, FPTR_EN_T | prog_time);
1499
1500 /* Trigger flash write */
1501 target_write_u32(target, FCTR,
1502 FCTR_FS_CS | FCTR_FS_WRE | FCTR_FS_WPB | FCTR_FS_PROGREQ);
1503
1504 /* Wait for the end of the write operation. If it's not over
1505 * after one second, something went dreadfully wrong... :-(
1506 */
1507 if (lpc2900_wait_status(bank, INTSRC_END_OF_BURN, 1000) != ERROR_OK)
1508 {
1509 LOG_ERROR("Write failed @ 0x%8.8" PRIx32, offset);
1510 target_write_u32(target, FCTR, FCTR_FS_CS | FCTR_FS_WEB);
1511
1512 return ERROR_FLASH_OPERATION_FAILED;
1513 }
1514 }
1515
1516 /* Update pointers and counters */
1517 offset += num_bytes;
1518 buffer += num_bytes;
1519 count -= num_bytes;
1520 }
1521
1522 retval = ERROR_OK;
1523 }
1524
1525 /* Normal flash operating mode */
1526 target_write_u32(target, FCTR, FCTR_FS_CS | FCTR_FS_WEB);
1527
1528 return retval;
1529 }
1530
1531
1532 /**
1533 * Try and identify the device.
1534 *
1535 * Determine type number and its memory layout.
1536 *
1537 * @param bank Pointer to the flash bank descriptor
1538 */
1539 static int lpc2900_probe(struct flash_bank *bank)
1540 {
1541 struct lpc2900_flash_bank *lpc2900_info = bank->driver_priv;
1542 struct target *target = bank->target;
1543 int i = 0;
1544 uint32_t offset;
1545
1546
1547 if (target->state != TARGET_HALTED)
1548 {
1549 LOG_ERROR("Target not halted");
1550 return ERROR_TARGET_NOT_HALTED;
1551 }
1552
1553 /* We want to do this only once. Check if we already have a valid CHIPID,
1554 * because then we will have already successfully probed the device.
1555 */
1556 if (lpc2900_info->chipid == EXPECTED_CHIPID)
1557 {
1558 return ERROR_OK;
1559 }
1560
1561 /* Probing starts with reading the CHIPID register. We will continue only
1562 * if this identifies as an LPC2900 device.
1563 */
1564 target_read_u32(target, CHIPID, &lpc2900_info->chipid);
1565
1566 if (lpc2900_info->chipid != EXPECTED_CHIPID)
1567 {
1568 LOG_WARNING("Device is not an LPC29xx");
1569 return ERROR_FLASH_OPERATION_FAILED;
1570 }
1571
1572 /* It's an LPC29xx device. Now read the feature register FEAT0...FEAT3. */
1573 uint32_t feat0, feat1, feat2, feat3;
1574 target_read_u32(target, FEAT0, &feat0);
1575 target_read_u32(target, FEAT1, &feat1);
1576 target_read_u32(target, FEAT2, &feat2);
1577 target_read_u32(target, FEAT3, &feat3);
1578
1579 /* Base address */
1580 bank->base = 0x20000000;
1581
1582 /* Determine flash layout from FEAT2 register */
1583 uint32_t num_64k_sectors = (feat2 >> 16) & 0xFF;
1584 uint32_t num_8k_sectors = (feat2 >> 0) & 0xFF;
1585 bank->num_sectors = num_64k_sectors + num_8k_sectors;
1586 bank->size = KiB * (64 * num_64k_sectors + 8 * num_8k_sectors);
1587
1588 /* Determine maximum contiguous RAM block */
1589 lpc2900_info->max_ram_block = 16 * KiB;
1590 if( (feat1 & 0x30) == 0x30 )
1591 {
1592 lpc2900_info->max_ram_block = 32 * KiB;
1593 if( (feat1 & 0x0C) == 0x0C )
1594 {
1595 lpc2900_info->max_ram_block = 48 * KiB;
1596 }
1597 }
1598
1599 /* Determine package code and ITCM size */
1600 uint32_t package_code = feat0 & 0x0F;
1601 uint32_t itcm_code = (feat1 >> 16) & 0x1F;
1602
1603 /* Determine the exact type number. */
1604 uint32_t found = 1;
1605 if ( (package_code == 4) && (itcm_code == 5) )
1606 {
1607 /* Old LPC2917 or LPC2919 (non-/01 devices) */
1608 lpc2900_info->target_name = (bank->size == 768*KiB) ? "LPC2919" : "LPC2917";
1609 }
1610 else
1611 {
1612 if ( package_code == 2 )
1613 {
1614 /* 100-pin package */
1615 if ( bank->size == 128*KiB )
1616 {
1617 lpc2900_info->target_name = "LPC2921";
1618 }
1619 else if ( bank->size == 256*KiB )
1620 {
1621 lpc2900_info->target_name = "LPC2923";
1622 }
1623 else if ( bank->size == 512*KiB )
1624 {
1625 lpc2900_info->target_name = "LPC2925";
1626 }
1627 else
1628 {
1629 found = 0;
1630 }
1631 }
1632 else if ( package_code == 4 )
1633 {
1634 /* 144-pin package */
1635 if ( (bank->size == 512*KiB) && (feat3 == 0xFFFFFCF0) )
1636 {
1637 lpc2900_info->target_name = "LPC2917/01";
1638 }
1639 else if ( (bank->size == 512*KiB) && (feat3 == 0xFFFFFFF1) )
1640 {
1641 lpc2900_info->target_name = "LPC2927";
1642 }
1643 else if ( (bank->size == 768*KiB) && (feat3 == 0xFFFFFCF8) )
1644 {
1645 lpc2900_info->target_name = "LPC2919/01";
1646 }
1647 else if ( (bank->size == 768*KiB) && (feat3 == 0xFFFFFFF9) )
1648 {
1649 lpc2900_info->target_name = "LPC2929";
1650 }
1651 else
1652 {
1653 found = 0;
1654 }
1655 }
1656 else if ( package_code == 5 )
1657 {
1658 /* 208-pin package */
1659 lpc2900_info->target_name = (bank->size == 0) ? "LPC2930" : "LPC2939";
1660 }
1661 else
1662 {
1663 found = 0;
1664 }
1665 }
1666
1667 if ( !found )
1668 {
1669 LOG_WARNING("Unknown LPC29xx derivative");
1670 return ERROR_FLASH_OPERATION_FAILED;
1671 }
1672
1673 /* Show detected device */
1674 LOG_INFO("Flash bank %d"
1675 ": Device %s, %" PRIu32
1676 " KiB in %d sectors",
1677 bank->bank_number,
1678 lpc2900_info->target_name, bank->size / KiB,
1679 bank->num_sectors);
1680
1681 /* Flashless devices cannot be handled */
1682 if ( bank->num_sectors == 0 )
1683 {
1684 LOG_WARNING("Flashless device cannot be handled");
1685 return ERROR_FLASH_OPERATION_FAILED;
1686 }
1687
1688 /* Sector layout.
1689 * These are logical sector numbers. When doing real flash operations,
1690 * the logical flash number are translated into the physical flash numbers
1691 * of the device.
1692 */
1693 bank->sectors = malloc(sizeof(struct flash_sector) * bank->num_sectors);
1694
1695 offset = 0;
1696 for (i = 0; i < bank->num_sectors; i++)
1697 {
1698 bank->sectors[i].offset = offset;
1699 bank->sectors[i].is_erased = -1;
1700 bank->sectors[i].is_protected = -1;
1701
1702 if ( i <= 7 )
1703 {
1704 bank->sectors[i].size = 8 * KiB;
1705 }
1706 else if ( i <= 18 )
1707 {
1708 bank->sectors[i].size = 64 * KiB;
1709 }
1710 else
1711 {
1712 /* We shouldn't come here. But there might be a new part out there
1713 * that has more than 19 sectors. Politely ask for a fix then.
1714 */
1715 bank->sectors[i].size = 0;
1716 LOG_ERROR("Never heard about sector %d", i);
1717 }
1718
1719 offset += bank->sectors[i].size;
1720 }
1721
1722 /* Read sector security status */
1723 if ( lpc2900_read_security_status(bank) != ERROR_OK )
1724 {
1725 LOG_ERROR("Cannot determine sector security status");
1726 return ERROR_FLASH_OPERATION_FAILED;
1727 }
1728
1729 return ERROR_OK;
1730 }
1731
1732
1733 /**
1734 * Run a blank check for each sector.
1735 *
1736 * For speed reasons, the device isn't read word by word.
1737 * A hash value is calculated by the hardware ("BIST") for each sector.
1738 * This value is then compared against the known hash of an empty sector.
1739 *
1740 * @param bank Pointer to the flash bank descriptor
1741 */
1742 static int lpc2900_erase_check(struct flash_bank *bank)
1743 {
1744 uint32_t status = lpc2900_is_ready(bank);
1745 if (status != ERROR_OK)
1746 {
1747 LOG_INFO("Processor not halted/not probed");
1748 return status;
1749 }
1750
1751 /* Use the BIST (Built-In Selft Test) to generate a signature of each flash
1752 * sector. Compare against the expected signature of an empty sector.
1753 */
1754 int sector;
1755 for ( sector = 0; sector < bank->num_sectors; sector++ )
1756 {
1757 uint32_t signature[4];
1758 if ( (status = lpc2900_run_bist128( bank,
1759 bank->sectors[sector].offset,
1760 bank->sectors[sector].offset +
1761 (bank->sectors[sector].size - 1),
1762 &signature)) != ERROR_OK )
1763 {
1764 return status;
1765 }
1766
1767 /* The expected signatures for an empty sector are different
1768 * for 8 KiB and 64 KiB sectors.
1769 */
1770 if ( bank->sectors[sector].size == 8*KiB )
1771 {
1772 bank->sectors[sector].is_erased =
1773 (signature[3] == 0x01ABAAAA) &&
1774 (signature[2] == 0xAAAAAAAA) &&
1775 (signature[1] == 0xAAAAAAAA) &&
1776 (signature[0] == 0xAAA00AAA);
1777 }
1778 if ( bank->sectors[sector].size == 64*KiB )
1779 {
1780 bank->sectors[sector].is_erased =
1781 (signature[3] == 0x11801222) &&
1782 (signature[2] == 0xB88844FF) &&
1783 (signature[1] == 0x11A22008) &&
1784 (signature[0] == 0x2B1BFE44);
1785 }
1786 }
1787
1788 return ERROR_OK;
1789 }
1790
1791
1792 /**
1793 * Get protection (sector security) status.
1794 *
1795 * Determine the status of "sector security" for each sector.
1796 * A secured sector is one that can never be erased/programmed again.
1797 *
1798 * @param bank Pointer to the flash bank descriptor
1799 */
1800 static int lpc2900_protect_check(struct flash_bank *bank)
1801 {
1802 return lpc2900_read_security_status(bank);
1803 }
1804
1805
1806 /**
1807 * Print info about the driver (not the device).
1808 *
1809 * @param bank Pointer to the flash bank descriptor
1810 * @param buf Buffer to take the string
1811 * @param buf_size Maximum number of characters that the buffer can take
1812 */
1813 static int lpc2900_info(struct flash_bank *bank, char *buf, int buf_size)
1814 {
1815 snprintf(buf, buf_size, "lpc2900 flash driver");
1816
1817 return ERROR_OK;
1818 }
1819
1820
1821 struct flash_driver lpc2900_flash =
1822 {
1823 .name = "lpc2900",
1824 .commands = lpc2900_command_handlers,
1825 .flash_bank_command = lpc2900_flash_bank_command,
1826 .erase = lpc2900_erase,
1827 .protect = lpc2900_protect,
1828 .write = lpc2900_write,
1829 .probe = lpc2900_probe,
1830 .auto_probe = lpc2900_probe,
1831 .erase_check = lpc2900_erase_check,
1832 .protect_check = lpc2900_protect_check,
1833 .info = lpc2900_info
1834 };

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)