1 /***************************************************************************
2 * Copyright (C) 2009 by *
3 * Rolf Meeser <rolfm_9dq@yahoo.de> *
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. *
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. *
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 ***************************************************************************/
29 #include "binarybuffer.h"
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 */
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 */
48 #define EXPECTED_CHIPID 0x209CE02B /* Chip ID of all LPC2900 devices */
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 */
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 */
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 */
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)
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)
107 #define FPTR_EN_T (1 << 15)
109 #define FTCTR_FS_BYPASS_R (1 << 29)
110 #define FTCTR_FS_BYPASS_W (1 << 28)
112 #define FMSSTOP_MISR_START (1 << 17)
114 #define EEMSSTOP_STRTBIST (1 << 31)
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)
130 * Private data for \c lpc2900 flash driver.
132 typedef struct lpc2900_flash_bank_s
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.
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".
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.
154 uint32_t clk_sys_fmc;
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.
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!
169 uint32_t max_ram_block;
171 } lpc2900_flash_bank_t;
174 static uint32_t lpc2900_wait_status(flash_bank_t *bank, uint32_t mask, int timeout);
175 static void lpc2900_setup(struct flash_bank_s *bank);
176 static uint32_t lpc2900_is_ready(struct flash_bank_s *bank);
177 static uint32_t lpc2900_read_security_status(struct flash_bank_s *bank);
178 static uint32_t lpc2900_run_bist128(struct flash_bank_s *bank,
179 uint32_t addr_from, uint32_t addr_to,
180 uint32_t (*signature)[4] );
181 static uint32_t lpc2900_address2sector(struct flash_bank_s *bank, uint32_t offset);
182 static uint32_t lpc2900_calc_tr( uint32_t clock, uint32_t time );
185 /*********************** Helper functions **************************/
189 * Wait for an event in mask to occur in INT_STATUS.
191 * Return when an event occurs, or after a timeout.
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
197 static uint32_t lpc2900_wait_status( flash_bank_t *bank,
202 target_t *target = bank->target;
209 target_read_u32(target, INT_STATUS, &int_status);
211 while( ((int_status & mask) == 0) && (timeout != 0) );
215 LOG_DEBUG("Timeout!");
216 return ERROR_FLASH_OPERATION_FAILED;
225 * Set up the flash for erase/program operations.
227 * Enable the flash, and set the correct CRA clock of 66 kHz.
229 * @param bank Pointer to the flash bank descriptor
231 static void lpc2900_setup( struct flash_bank_s *bank )
234 lpc2900_flash_bank_t *lpc2900_info = bank->driver_priv;
237 /* Power up the flash block */
238 target_write_u32( bank->target, FCTR, FCTR_FS_WEB | FCTR_FS_CS );
241 fcra = (lpc2900_info->clk_sys_fmc / (3 * 66000)) - 1;
242 target_write_u32( bank->target, FCRA, fcra );
248 * Check if device is ready.
250 * Check if device is ready for flash operation:
251 * Must have been successfully probed.
254 static uint32_t lpc2900_is_ready( struct flash_bank_s *bank )
256 lpc2900_flash_bank_t *lpc2900_info = bank->driver_priv;
258 if( lpc2900_info->chipid != EXPECTED_CHIPID )
260 return ERROR_FLASH_BANK_NOT_PROBED;
263 if( bank->target->state != TARGET_HALTED )
265 LOG_ERROR( "Target not halted" );
266 return ERROR_TARGET_NOT_HALTED;
274 * Read the status of sector security from the index sector.
276 * @param bank Pointer to the flash bank descriptor
278 static uint32_t lpc2900_read_security_status( struct flash_bank_s *bank )
281 if( (status = lpc2900_is_ready( bank )) != ERROR_OK )
286 target_t *target = bank->target;
288 /* Enable ISS access */
289 target_write_u32(target, FCTR, FCTR_FS_CS | FCTR_FS_WEB | FCTR_FS_ISS);
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);
296 /* Disable ISS access */
297 target_write_u32(target, FCTR, FCTR_FS_CS | FCTR_FS_WEB);
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.
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!
310 for( sector = 0; sector < bank->num_sectors; sector++ )
312 /* Convert logical sector number to physical sector number */
317 else if( sector <= 7 )
326 bank->sectors[sector].is_protected = -1;
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) )
334 bank->sectors[sector].is_protected = 1;
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) )
343 bank->sectors[sector].is_protected = 0;
352 * Use BIST to calculate a 128-bit hash value over a range of flash.
354 * @param bank Pointer to the flash bank descriptor
359 static uint32_t lpc2900_run_bist128(struct flash_bank_s *bank,
362 uint32_t (*signature)[4] )
364 target_t *target = bank->target;
366 /* Clear END_OF_MISR interrupt status */
367 target_write_u32( target, INT_CLR_STATUS, INTSRC_END_OF_MISR );
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 );
374 /* Poll for end of operation. Calculate a reasonable timeout. */
375 if( lpc2900_wait_status( bank, INTSRC_END_OF_MISR, 1000 ) != ERROR_OK )
377 return ERROR_FLASH_OPERATION_FAILED;
380 /* Return the signature */
381 target_read_memory( target, FMSW0, 4, 4, (uint8_t *)signature );
388 * Return sector number for given address.
390 * Return the (logical) sector number for a given relative address.
391 * No sanity check is done. It assumed that the address is valid.
393 * @param bank Pointer to the flash bank descriptor
394 * @param offset Offset address relative to bank start
396 static uint32_t lpc2900_address2sector( struct flash_bank_s *bank,
399 uint32_t address = bank->base + offset;
402 /* Run through all sectors of this bank */
404 for( sector = 0; sector < bank->num_sectors; sector++ )
406 /* Return immediately if address is within the current sector */
407 if( address < (bank->sectors[sector].offset + bank->sectors[sector].size) )
413 /* We should never come here. If we do, return an arbitrary sector number. */
421 * Write one page to the index sector.
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)
427 static int lpc2900_write_index_page( struct flash_bank_s *bank,
429 uint8_t (*page)[FLASH_PAGE_SIZE] )
431 /* Only pages 4...7 are user writable */
432 if ((pagenum < 4) || (pagenum > 7))
434 LOG_ERROR("Refuse to burn index sector page %d", pagenum);
435 return ERROR_COMMAND_ARGUMENT_INVALID;
438 /* Get target, and check if it's halted */
439 target_t *target = bank->target;
440 if( target->state != TARGET_HALTED )
442 LOG_ERROR( "Target not halted" );
443 return ERROR_TARGET_NOT_HALTED;
447 lpc2900_flash_bank_t *lpc2900_info = bank->driver_priv;
449 /* Enable flash block and set the correct CRA clock of 66 kHz */
450 lpc2900_setup( bank );
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 );
458 /* Set latch load mode */
459 target_write_u32( target, FCTR,
460 FCTR_FS_ISS | FCTR_FS_WEB | FCTR_FS_WRE | FCTR_FS_CS );
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 )
467 LOG_ERROR("Index sector write failed @ page %d", pagenum);
468 target_write_u32( target, FCTR, FCTR_FS_CS | FCTR_FS_WEB );
470 return ERROR_FLASH_OPERATION_FAILED;
473 /* Clear END_OF_BURN interrupt status */
474 target_write_u32( target, INT_CLR_STATUS, INTSRC_END_OF_BURN );
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 ));
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 );
486 /* Wait for the end of the write operation. If it's not over after one
487 * second, something went dreadfully wrong... :-(
489 if (lpc2900_wait_status(bank, INTSRC_END_OF_BURN, 1000) != ERROR_OK)
491 LOG_ERROR("Index sector write failed @ page %d", pagenum);
492 target_write_u32(target, FCTR, FCTR_FS_CS | FCTR_FS_WEB);
494 return ERROR_FLASH_OPERATION_FAILED;
497 target_write_u32( target, FCTR, FCTR_FS_CS | FCTR_FS_WEB );
505 * Calculate FPTR.TR register value for desired program/erase time.
507 * @param clock System clock in Hz
508 * @param time Program/erase time in µs
510 static uint32_t lpc2900_calc_tr( uint32_t clock, uint32_t time )
512 /* ((time[µs]/1e6) * f[Hz]) + 511
513 * FPTR.TR = -------------------------------
519 uint32_t tr_val = (uint32_t)((((time / 1e6) * clock) + 511.0) / 512.0);
525 /*********************** Private flash commands **************************/
529 * Command to determine the signature of the whole flash.
531 * Uses the Built-In-Self-Test (BIST) to generate a 128-bit hash value
532 * of the flash content.
534 COMMAND_HANDLER(lpc2900_handle_signature_command)
537 uint32_t signature[4];
542 LOG_WARNING( "Too few arguments. Call: lpc2900 signature <bank#>" );
543 return ERROR_FLASH_BANK_INVALID;
547 int retval = flash_command_get_bank_by_num(cmd_ctx, args[0], &bank);
548 if (ERROR_OK != retval)
551 if( bank->target->state != TARGET_HALTED )
553 LOG_ERROR( "Target not halted" );
554 return ERROR_TARGET_NOT_HALTED;
557 /* Run BIST over whole flash range */
558 if( (status = lpc2900_run_bist128( bank,
560 bank->base + (bank->size - 1),
567 command_print( cmd_ctx, "signature: 0x%8.8" PRIx32
571 signature[3], signature[2], signature[1], signature[0] );
579 * Store customer info in file.
581 * Read customer info from index sector, and store that block of data into
582 * a disk file. The format is binary.
584 COMMAND_HANDLER(lpc2900_handle_read_custom_command)
588 return ERROR_COMMAND_SYNTAX_ERROR;
592 int retval = flash_command_get_bank_by_num(cmd_ctx, args[0], &bank);
593 if (ERROR_OK != retval)
596 lpc2900_flash_bank_t *lpc2900_info = bank->driver_priv;
597 lpc2900_info->risky = 0;
599 /* Get target, and check if it's halted */
600 target_t *target = bank->target;
601 if( target->state != TARGET_HALTED )
603 LOG_ERROR( "Target not halted" );
604 return ERROR_TARGET_NOT_HALTED;
607 /* Storage for customer info. Read in two parts */
608 uint32_t customer[ ISS_CUSTOMER_NWORDS1 + ISS_CUSTOMER_NWORDS2 ];
610 /* Enable access to index sector */
611 target_write_u32( target, FCTR, FCTR_FS_CS | FCTR_FS_WEB | FCTR_FS_ISS );
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] );
621 /* Deactivate access to index sector */
622 target_write_u32( target, FCTR, FCTR_FS_CS | FCTR_FS_WEB );
624 /* Try and open the file */
626 const char *filename = args[1];
627 int ret = fileio_open( &fileio, filename, FILEIO_WRITE, FILEIO_BINARY );
628 if( ret != ERROR_OK )
630 LOG_WARNING( "Could not open file %s", filename );
635 ret = fileio_write( &fileio, sizeof(customer),
636 (const uint8_t *)customer, &nwritten );
637 if( ret != ERROR_OK )
639 LOG_ERROR( "Write operation to file %s failed", filename );
640 fileio_close( &fileio );
644 fileio_close( &fileio );
653 * Enter password to enable potentially dangerous options.
655 COMMAND_HANDLER(lpc2900_handle_password_command)
659 return ERROR_COMMAND_SYNTAX_ERROR;
663 int retval = flash_command_get_bank_by_num(cmd_ctx, args[0], &bank);
664 if (ERROR_OK != retval)
667 lpc2900_flash_bank_t *lpc2900_info = bank->driver_priv;
669 #define ISS_PASSWORD "I_know_what_I_am_doing"
671 lpc2900_info->risky = !strcmp( args[1], ISS_PASSWORD );
673 if( !lpc2900_info->risky )
675 command_print(cmd_ctx, "Wrong password (use '%s')", ISS_PASSWORD);
676 return ERROR_COMMAND_ARGUMENT_INVALID;
679 command_print(cmd_ctx,
680 "Potentially dangerous operation allowed in next command!");
688 * Write customer info from file to the index sector.
690 COMMAND_HANDLER(lpc2900_handle_write_custom_command)
694 return ERROR_COMMAND_SYNTAX_ERROR;
698 int retval = flash_command_get_bank_by_num(cmd_ctx, args[0], &bank);
699 if (ERROR_OK != retval)
702 lpc2900_flash_bank_t *lpc2900_info = bank->driver_priv;
704 /* Check if command execution is allowed. */
705 if( !lpc2900_info->risky )
707 command_print( cmd_ctx, "Command execution not allowed!" );
708 return ERROR_COMMAND_ARGUMENT_INVALID;
710 lpc2900_info->risky = 0;
712 /* Get target, and check if it's halted */
713 target_t *target = bank->target;
714 if (target->state != TARGET_HALTED)
716 LOG_ERROR("Target not halted");
717 return ERROR_TARGET_NOT_HALTED;
720 /* The image will always start at offset 0 */
722 image.base_address_set = 1;
723 image.base_address = 0;
724 image.start_address_set = 0;
726 const char *filename = args[1];
727 const char *type = (argc >= 3) ? args[2] : NULL;
728 retval = image_open(&image, filename, type);
729 if (retval != ERROR_OK)
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 )
738 LOG_ERROR("Only one section allowed in image file.");
739 return ERROR_COMMAND_SYNTAX_ERROR;
741 if( (image.sections[0].base_address != 0) ||
742 (image.sections[0].size != ISS_CUSTOMER_SIZE) )
744 LOG_ERROR("Incorrect image file size. Expected %d, "
746 ISS_CUSTOMER_SIZE, image.sections[0].size);
747 return ERROR_COMMAND_SYNTAX_ERROR;
750 /* Well boys, I reckon this is it... */
752 /* Customer info is split into two blocks in pages 4 and 5. */
753 uint8_t page[FLASH_PAGE_SIZE];
756 uint32_t offset = ISS_CUSTOMER_START1 % FLASH_PAGE_SIZE;
757 memset( page, 0xff, FLASH_PAGE_SIZE );
759 retval = image_read_section( &image, 0, 0,
760 ISS_CUSTOMER_SIZE1, &page[offset], &size_read);
761 if( retval != ERROR_OK )
763 LOG_ERROR("couldn't read from file '%s'", filename);
767 if( (retval = lpc2900_write_index_page( bank, 4, &page )) != ERROR_OK )
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 )
780 LOG_ERROR("couldn't read from file '%s'", filename);
784 if( (retval = lpc2900_write_index_page( bank, 5, &page )) != ERROR_OK )
798 * Activate 'sector security' for a range of sectors.
800 COMMAND_HANDLER(lpc2900_handle_secure_sector_command)
804 return ERROR_COMMAND_SYNTAX_ERROR;
807 /* Get the bank descriptor */
809 int retval = flash_command_get_bank_by_num(cmd_ctx, args[0], &bank);
810 if (ERROR_OK != retval)
813 lpc2900_flash_bank_t *lpc2900_info = bank->driver_priv;
815 /* Check if command execution is allowed. */
816 if( !lpc2900_info->risky )
818 command_print( cmd_ctx, "Command execution not allowed! "
819 "(use 'password' command first)");
820 return ERROR_COMMAND_ARGUMENT_INVALID;
822 lpc2900_info->risky = 0;
824 /* Read sector range, and do a sanity check. */
826 COMMAND_PARSE_NUMBER(int, args[1], first);
827 COMMAND_PARSE_NUMBER(int, args[2], last);
828 if( (first >= bank->num_sectors) ||
829 (last >= bank->num_sectors) ||
832 command_print( cmd_ctx, "Illegal sector range" );
833 return ERROR_COMMAND_ARGUMENT_INVALID;
836 uint8_t page[FLASH_PAGE_SIZE];
839 /* Sectors in page 6 */
840 if( (first <= 4) || (last >= 8) )
842 memset( &page, 0xff, FLASH_PAGE_SIZE );
843 for( sector = first; sector <= last; sector++ )
847 memset( &page[0xB0 + 16*sector], 0, 16 );
849 else if( sector >= 8 )
851 memset( &page[0x00 + 16*(sector - 8)], 0, 16 );
855 if( (retval = lpc2900_write_index_page( bank, 6, &page )) != ERROR_OK )
857 LOG_ERROR("failed to update index sector page 6");
862 /* Sectors in page 7 */
863 if( (first <= 7) && (last >= 5) )
865 memset( &page, 0xff, FLASH_PAGE_SIZE );
866 for( sector = first; sector <= last; sector++ )
868 if( (sector >= 5) && (sector <= 7) )
870 memset( &page[0x00 + 16*(sector - 5)], 0, 16 );
874 if( (retval = lpc2900_write_index_page( bank, 7, &page )) != ERROR_OK )
876 LOG_ERROR("failed to update index sector page 7");
881 command_print( cmd_ctx,
882 "Sectors security will become effective after next power cycle");
884 /* Update the sector security status */
885 if ( lpc2900_read_security_status(bank) != ERROR_OK )
887 LOG_ERROR( "Cannot determine sector security status" );
888 return ERROR_FLASH_OPERATION_FAILED;
897 * Activate JTAG protection.
899 COMMAND_HANDLER(lpc2900_handle_secure_jtag_command)
903 return ERROR_COMMAND_SYNTAX_ERROR;
906 /* Get the bank descriptor */
908 int retval = flash_command_get_bank_by_num(cmd_ctx, args[0], &bank);
909 if (ERROR_OK != retval)
912 lpc2900_flash_bank_t *lpc2900_info = bank->driver_priv;
914 /* Check if command execution is allowed. */
915 if( !lpc2900_info->risky )
917 command_print( cmd_ctx, "Command execution not allowed! "
918 "(use 'password' command first)");
919 return ERROR_COMMAND_ARGUMENT_INVALID;
921 lpc2900_info->risky = 0;
924 uint8_t page[FLASH_PAGE_SIZE];
925 memset( &page, 0xff, FLASH_PAGE_SIZE );
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;
934 /* Write to page 5 */
935 if( (retval = lpc2900_write_index_page( bank, 5, &page ))
938 LOG_ERROR("failed to update index sector page 5");
942 LOG_INFO("JTAG security set. Good bye!");
949 /*********************** Flash interface functions **************************/
953 * Register private command handlers.
955 static int lpc2900_register_commands(struct command_context_s *cmd_ctx)
957 command_t *lpc2900_cmd = register_command(cmd_ctx, NULL, "lpc2900",
958 NULL, COMMAND_ANY, NULL);
964 lpc2900_handle_signature_command,
967 "print device signature of flash bank");
973 lpc2900_handle_read_custom_command,
975 "<bank> <filename> | "
976 "read customer information from index sector to file");
982 lpc2900_handle_password_command,
984 "<bank> <password> | "
985 "enter password to enable 'dangerous' options");
991 lpc2900_handle_write_custom_command,
993 "<bank> <filename> [<type>] | "
994 "write customer info from file to index sector");
1000 lpc2900_handle_secure_sector_command,
1002 "<bank> <first> <last> | "
1003 "activate sector security for a range of sectors");
1009 lpc2900_handle_secure_jtag_command,
1012 "activate JTAG security");
1018 /// Evaluate flash bank command.
1019 static int lpc2900_flash_bank_command(struct command_context_s *cmd_ctx,
1020 char *cmd, char **args, int argc,
1021 struct flash_bank_s *bank)
1023 lpc2900_flash_bank_t *lpc2900_info;
1027 LOG_WARNING("incomplete flash_bank LPC2900 configuration");
1028 return ERROR_FLASH_BANK_INVALID;
1031 lpc2900_info = malloc(sizeof(lpc2900_flash_bank_t));
1032 bank->driver_priv = lpc2900_info;
1035 * Reject it if we can't meet the requirements for program time
1036 * (if clock too slow), or for erase time (clock too fast).
1038 uint32_t clk_sys_fmc;
1039 COMMAND_PARSE_NUMBER(u32, args[6], clk_sys_fmc);
1040 lpc2900_info->clk_sys_fmc = clk_sys_fmc * 1000;
1042 uint32_t clock_limit;
1043 /* Check program time limit */
1044 clock_limit = 512000000l / FLASH_PROGRAM_TIME;
1045 if (lpc2900_info->clk_sys_fmc < clock_limit)
1047 LOG_WARNING("flash clock must be at least %" PRIu32 " kHz",
1048 (clock_limit / 1000));
1049 return ERROR_FLASH_BANK_INVALID;
1052 /* Check erase time limit */
1053 clock_limit = (uint32_t)((32767.0 * 512.0 * 1e6) / FLASH_ERASE_TIME);
1054 if (lpc2900_info->clk_sys_fmc > clock_limit)
1056 LOG_WARNING("flash clock must be a maximum of %" PRIu32" kHz",
1057 (clock_limit / 1000));
1058 return ERROR_FLASH_BANK_INVALID;
1061 /* Chip ID will be obtained by probing the device later */
1062 lpc2900_info->chipid = 0;
1071 * @param bank Pointer to the flash bank descriptor
1072 * @param first First sector to be erased
1073 * @param last Last sector (including) to be erased
1075 static int lpc2900_erase(struct flash_bank_s *bank, int first, int last)
1079 int last_unsecured_sector;
1080 target_t *target = bank->target;
1081 lpc2900_flash_bank_t *lpc2900_info = bank->driver_priv;
1084 status = lpc2900_is_ready(bank);
1085 if (status != ERROR_OK)
1090 /* Sanity check on sector range */
1091 if ((first < 0) || (last < first) || (last >= bank->num_sectors))
1093 LOG_INFO("Bad sector range");
1094 return ERROR_FLASH_SECTOR_INVALID;
1097 /* Update the info about secured sectors */
1098 lpc2900_read_security_status( bank );
1100 /* The selected sector range might include secured sectors. An attempt
1101 * to erase such a sector will cause the erase to fail also for unsecured
1102 * sectors. It is necessary to determine the last unsecured sector now,
1103 * because we have to treat the last relevant sector in the list in
1106 last_unsecured_sector = -1;
1107 for (sector = first; sector <= last; sector++)
1109 if ( !bank->sectors[sector].is_protected )
1111 last_unsecured_sector = sector;
1115 /* Exit now, in case of the rare constellation where all sectors in range
1116 * are secured. This is regarded a success, since erasing/programming of
1117 * secured sectors shall be handled transparently.
1119 if ( last_unsecured_sector == -1 )
1124 /* Enable flash block and set the correct CRA clock of 66 kHz */
1125 lpc2900_setup(bank);
1127 /* Clear END_OF_ERASE interrupt status */
1128 target_write_u32(target, INT_CLR_STATUS, INTSRC_END_OF_ERASE);
1130 /* Set the program/erase timer to FLASH_ERASE_TIME */
1131 target_write_u32(target, FPTR,
1132 FPTR_EN_T | lpc2900_calc_tr( lpc2900_info->clk_sys_fmc,
1133 FLASH_ERASE_TIME ));
1135 /* Sectors are marked for erasure, then erased all together */
1136 for (sector = first; sector <= last_unsecured_sector; sector++)
1138 /* Only mark sectors that aren't secured. Any attempt to erase a group
1139 * of sectors will fail if any single one of them is secured!
1141 if ( !bank->sectors[sector].is_protected )
1143 /* Unprotect the sector */
1144 target_write_u32(target, bank->sectors[sector].offset, 0);
1145 target_write_u32(target, FCTR,
1146 FCTR_FS_LOADREQ | FCTR_FS_WPB |
1147 FCTR_FS_WEB | FCTR_FS_WRE | FCTR_FS_CS);
1149 /* Mark the sector for erasure. The last sector in the list
1150 triggers the erasure. */
1151 target_write_u32(target, bank->sectors[sector].offset, 0);
1152 if ( sector == last_unsecured_sector )
1154 target_write_u32(target, FCTR,
1155 FCTR_FS_PROGREQ | FCTR_FS_WPB | FCTR_FS_CS);
1159 target_write_u32(target, FCTR,
1160 FCTR_FS_LOADREQ | FCTR_FS_WPB |
1161 FCTR_FS_WEB | FCTR_FS_CS);
1166 /* Wait for the end of the erase operation. If it's not over after two seconds,
1167 * something went dreadfully wrong... :-(
1169 if( lpc2900_wait_status(bank, INTSRC_END_OF_ERASE, 2000) != ERROR_OK )
1171 return ERROR_FLASH_OPERATION_FAILED;
1174 /* Normal flash operating mode */
1175 target_write_u32(target, FCTR, FCTR_FS_CS | FCTR_FS_WEB);
1182 static int lpc2900_protect(struct flash_bank_s *bank, int set, int first, int last)
1184 /* This command is not supported.
1185 * "Protection" in LPC2900 terms is handled transparently. Sectors will
1186 * automatically be unprotected as needed.
1187 * Instead we use the concept of sector security. A secured sector is shown
1188 * as "protected" in OpenOCD. Sector security is a permanent feature, and
1189 * cannot be disabled once activated.
1197 * Write data to flash.
1199 * @param bank Pointer to the flash bank descriptor
1200 * @param buffer Buffer with data
1201 * @param offset Start address (relative to bank start)
1202 * @param count Number of bytes to be programmed
1204 static int lpc2900_write(struct flash_bank_s *bank, uint8_t *buffer,
1205 uint32_t offset, uint32_t count)
1207 uint8_t page[FLASH_PAGE_SIZE];
1210 target_t *target = bank->target;
1211 lpc2900_flash_bank_t *lpc2900_info = bank->driver_priv;
1215 static const uint32_t write_target_code[] = {
1216 /* Set auto latch mode: FCTR=CS|WRE|WEB */
1217 0xe3a0a007, /* loop mov r10, #0x007 */
1218 0xe583a000, /* str r10,[r3,#0] */
1220 /* Load complete page into latches */
1221 0xe3a06020, /* mov r6,#(512/16) */
1222 0xe8b00f00, /* next ldmia r0!,{r8-r11} */
1223 0xe8a10f00, /* stmia r1!,{r8-r11} */
1224 0xe2566001, /* subs r6,#1 */
1225 0x1afffffb, /* bne next */
1227 /* Clear END_OF_BURN interrupt status */
1228 0xe3a0a002, /* mov r10,#(1 << 1) */
1229 0xe583afe8, /* str r10,[r3,#0xfe8] */
1231 /* Set the erase time to FLASH_PROGRAM_TIME */
1232 0xe5834008, /* str r4,[r3,#8] */
1234 /* Trigger flash write
1235 FCTR = CS | WRE | WPB | PROGREQ */
1236 0xe3a0a083, /* mov r10,#0x83 */
1237 0xe38aaa01, /* orr r10,#0x1000 */
1238 0xe583a000, /* str r10,[r3,#0] */
1240 /* Wait for end of burn */
1241 0xe593afe0, /* wait ldr r10,[r3,#0xfe0] */
1242 0xe21aa002, /* ands r10,#(1 << 1) */
1243 0x0afffffc, /* beq wait */
1246 0xe2522001, /* subs r2,#1 */
1247 0x1affffed, /* bne loop */
1249 0xeafffffe /* done b done */
1253 status = lpc2900_is_ready(bank);
1254 if (status != ERROR_OK)
1259 /* Enable flash block and set the correct CRA clock of 66 kHz */
1260 lpc2900_setup(bank);
1262 /* Update the info about secured sectors */
1263 lpc2900_read_security_status( bank );
1265 /* Unprotect all involved sectors */
1266 for (sector = 0; sector < bank->num_sectors; sector++)
1268 /* Start address in or before this sector? */
1269 /* End address in or behind this sector? */
1270 if ( ((bank->base + offset) <
1271 (bank->sectors[sector].offset + bank->sectors[sector].size)) &&
1272 ((bank->base + (offset + count - 1)) >= bank->sectors[sector].offset) )
1274 /* This sector is involved and needs to be unprotected.
1275 * Don't do it for secured sectors.
1277 if ( !bank->sectors[sector].is_protected )
1279 target_write_u32(target, bank->sectors[sector].offset, 0);
1280 target_write_u32(target, FCTR,
1281 FCTR_FS_LOADREQ | FCTR_FS_WPB |
1282 FCTR_FS_WEB | FCTR_FS_WRE | FCTR_FS_CS);
1287 /* Set the program/erase time to FLASH_PROGRAM_TIME */
1288 uint32_t prog_time = FPTR_EN_T | lpc2900_calc_tr( lpc2900_info->clk_sys_fmc,
1289 FLASH_PROGRAM_TIME );
1291 /* If there is a working area of reasonable size, use it to program via
1292 a target algorithm. If not, fall back to host programming. */
1294 /* We need some room for target code. */
1295 uint32_t target_code_size = sizeof(write_target_code);
1297 /* Try working area allocation. Start with a large buffer, and try with
1298 reduced size if that fails. */
1299 working_area_t *warea;
1300 uint32_t buffer_size = lpc2900_info->max_ram_block - 1 * KiB;
1301 while( (retval = target_alloc_working_area(target,
1302 buffer_size + target_code_size,
1303 &warea)) != ERROR_OK )
1305 /* Try a smaller buffer now, and stop if it's too small. */
1306 buffer_size -= 1 * KiB;
1307 if (buffer_size < 2 * KiB)
1309 LOG_INFO( "no (large enough) working area"
1310 ", falling back to host mode" );
1318 reg_param_t reg_params[5];
1319 armv4_5_algorithm_t armv4_5_info;
1321 /* We can use target mode. Download the algorithm. */
1322 retval = target_write_buffer( target,
1323 (warea->address)+buffer_size,
1325 (uint8_t *)write_target_code);
1326 if (retval != ERROR_OK)
1328 LOG_ERROR("Unable to write block write code to target");
1329 target_free_all_working_areas(target);
1330 return ERROR_FLASH_OPERATION_FAILED;
1333 init_reg_param(®_params[0], "r0", 32, PARAM_OUT);
1334 init_reg_param(®_params[1], "r1", 32, PARAM_OUT);
1335 init_reg_param(®_params[2], "r2", 32, PARAM_OUT);
1336 init_reg_param(®_params[3], "r3", 32, PARAM_OUT);
1337 init_reg_param(®_params[4], "r4", 32, PARAM_OUT);
1339 /* Write to flash in large blocks */
1340 while ( count != 0 )
1342 uint32_t this_npages;
1343 uint8_t *this_buffer;
1344 int start_sector = lpc2900_address2sector( bank, offset );
1346 /* First page / last page / rest */
1347 if( offset % FLASH_PAGE_SIZE )
1349 /* Block doesn't start on page boundary.
1350 Burn first partial page separately. */
1351 memset( &page, 0xff, sizeof(page) );
1352 memcpy( &page[offset % FLASH_PAGE_SIZE],
1354 FLASH_PAGE_SIZE - (offset % FLASH_PAGE_SIZE) );
1356 this_buffer = &page[0];
1357 count = count + (offset % FLASH_PAGE_SIZE);
1358 offset = offset - (offset % FLASH_PAGE_SIZE);
1360 else if( count < FLASH_PAGE_SIZE )
1362 /* Download last incomplete page separately. */
1363 memset( &page, 0xff, sizeof(page) );
1364 memcpy( &page, buffer, count );
1366 this_buffer = &page[0];
1367 count = FLASH_PAGE_SIZE;
1371 /* Download as many full pages as possible */
1372 this_npages = (count < buffer_size) ?
1373 count / FLASH_PAGE_SIZE :
1374 buffer_size / FLASH_PAGE_SIZE;
1375 this_buffer = buffer;
1377 /* Make sure we stop at the next secured sector */
1378 int sector = start_sector + 1;
1379 while( sector < bank->num_sectors )
1382 if( bank->sectors[sector].is_protected )
1384 /* Is that next sector within the current block? */
1385 if( (bank->sectors[sector].offset - bank->base) <
1386 (offset + (this_npages * FLASH_PAGE_SIZE)) )
1388 /* Yes! Split the block */
1390 (bank->sectors[sector].offset - bank->base - offset)
1400 /* Skip the current sector if it is secured */
1401 if (bank->sectors[start_sector].is_protected)
1403 LOG_DEBUG("Skip secured sector %d",
1406 /* Stop if this is the last sector */
1407 if (start_sector == bank->num_sectors - 1)
1413 uint32_t nskip = bank->sectors[start_sector].size -
1414 (offset % bank->sectors[start_sector].size);
1417 count = (count >= nskip) ? (count - nskip) : 0;
1421 /* Execute buffer download */
1422 if ((retval = target_write_buffer(target,
1424 this_npages * FLASH_PAGE_SIZE,
1425 this_buffer)) != ERROR_OK)
1427 LOG_ERROR("Unable to write data to target");
1428 target_free_all_working_areas(target);
1429 return ERROR_FLASH_OPERATION_FAILED;
1432 /* Prepare registers */
1433 buf_set_u32(reg_params[0].value, 0, 32, warea->address);
1434 buf_set_u32(reg_params[1].value, 0, 32, offset);
1435 buf_set_u32(reg_params[2].value, 0, 32, this_npages);
1436 buf_set_u32(reg_params[3].value, 0, 32, FCTR);
1437 buf_set_u32(reg_params[4].value, 0, 32, FPTR_EN_T | prog_time);
1439 /* Execute algorithm, assume breakpoint for last instruction */
1440 armv4_5_info.common_magic = ARMV4_5_COMMON_MAGIC;
1441 armv4_5_info.core_mode = ARMV4_5_MODE_SVC;
1442 armv4_5_info.core_state = ARMV4_5_STATE_ARM;
1444 retval = target_run_algorithm(target, 0, NULL, 5, reg_params,
1445 (warea->address) + buffer_size,
1446 (warea->address) + buffer_size + target_code_size - 4,
1447 10000, /* 10s should be enough for max. 16 KiB of data */
1450 if (retval != ERROR_OK)
1452 LOG_ERROR("Execution of flash algorithm failed.");
1453 target_free_all_working_areas(target);
1454 retval = ERROR_FLASH_OPERATION_FAILED;
1458 count -= this_npages * FLASH_PAGE_SIZE;
1459 buffer += this_npages * FLASH_PAGE_SIZE;
1460 offset += this_npages * FLASH_PAGE_SIZE;
1463 /* Free all resources */
1464 destroy_reg_param(®_params[0]);
1465 destroy_reg_param(®_params[1]);
1466 destroy_reg_param(®_params[2]);
1467 destroy_reg_param(®_params[3]);
1468 destroy_reg_param(®_params[4]);
1469 target_free_all_working_areas(target);
1473 /* Write to flash memory page-wise */
1474 while ( count != 0 )
1476 /* How many bytes do we copy this time? */
1477 num_bytes = (count >= FLASH_PAGE_SIZE) ?
1478 FLASH_PAGE_SIZE - (offset % FLASH_PAGE_SIZE) :
1481 /* Don't do anything with it if the page is in a secured sector. */
1482 if ( !bank->sectors[lpc2900_address2sector(bank, offset)].is_protected )
1484 /* Set latch load mode */
1485 target_write_u32(target, FCTR,
1486 FCTR_FS_CS | FCTR_FS_WRE | FCTR_FS_WEB);
1488 /* Always clear the buffer (a little overhead, but who cares) */
1489 memset(page, 0xFF, FLASH_PAGE_SIZE);
1491 /* Copy them to the buffer */
1492 memcpy( &page[offset % FLASH_PAGE_SIZE],
1493 &buffer[offset % FLASH_PAGE_SIZE],
1496 /* Write whole page to flash data latches */
1497 if (target_write_memory(
1499 bank->base + (offset - (offset % FLASH_PAGE_SIZE)),
1500 4, FLASH_PAGE_SIZE / 4, page) != ERROR_OK)
1502 LOG_ERROR("Write failed @ 0x%8.8" PRIx32, offset);
1503 target_write_u32(target, FCTR, FCTR_FS_CS | FCTR_FS_WEB);
1505 return ERROR_FLASH_OPERATION_FAILED;
1508 /* Clear END_OF_BURN interrupt status */
1509 target_write_u32(target, INT_CLR_STATUS, INTSRC_END_OF_BURN);
1511 /* Set the programming time */
1512 target_write_u32(target, FPTR, FPTR_EN_T | prog_time);
1514 /* Trigger flash write */
1515 target_write_u32(target, FCTR,
1516 FCTR_FS_CS | FCTR_FS_WRE | FCTR_FS_WPB | FCTR_FS_PROGREQ);
1518 /* Wait for the end of the write operation. If it's not over
1519 * after one second, something went dreadfully wrong... :-(
1521 if (lpc2900_wait_status(bank, INTSRC_END_OF_BURN, 1000) != ERROR_OK)
1523 LOG_ERROR("Write failed @ 0x%8.8" PRIx32, offset);
1524 target_write_u32(target, FCTR, FCTR_FS_CS | FCTR_FS_WEB);
1526 return ERROR_FLASH_OPERATION_FAILED;
1530 /* Update pointers and counters */
1531 offset += num_bytes;
1532 buffer += num_bytes;
1539 /* Normal flash operating mode */
1540 target_write_u32(target, FCTR, FCTR_FS_CS | FCTR_FS_WEB);
1547 * Try and identify the device.
1549 * Determine type number and its memory layout.
1551 * @param bank Pointer to the flash bank descriptor
1553 static int lpc2900_probe(struct flash_bank_s *bank)
1555 lpc2900_flash_bank_t *lpc2900_info = bank->driver_priv;
1556 target_t *target = bank->target;
1561 if (target->state != TARGET_HALTED)
1563 LOG_ERROR("Target not halted");
1564 return ERROR_TARGET_NOT_HALTED;
1567 /* We want to do this only once. Check if we already have a valid CHIPID,
1568 * because then we will have already successfully probed the device.
1570 if (lpc2900_info->chipid == EXPECTED_CHIPID)
1575 /* Probing starts with reading the CHIPID register. We will continue only
1576 * if this identifies as an LPC2900 device.
1578 target_read_u32(target, CHIPID, &lpc2900_info->chipid);
1580 if (lpc2900_info->chipid != EXPECTED_CHIPID)
1582 LOG_WARNING("Device is not an LPC29xx");
1583 return ERROR_FLASH_OPERATION_FAILED;
1586 /* It's an LPC29xx device. Now read the feature register FEAT0...FEAT3. */
1587 uint32_t feat0, feat1, feat2, feat3;
1588 target_read_u32(target, FEAT0, &feat0);
1589 target_read_u32(target, FEAT1, &feat1);
1590 target_read_u32(target, FEAT2, &feat2);
1591 target_read_u32(target, FEAT3, &feat3);
1594 bank->base = 0x20000000;
1596 /* Determine flash layout from FEAT2 register */
1597 uint32_t num_64k_sectors = (feat2 >> 16) & 0xFF;
1598 uint32_t num_8k_sectors = (feat2 >> 0) & 0xFF;
1599 bank->num_sectors = num_64k_sectors + num_8k_sectors;
1600 bank->size = KiB * (64 * num_64k_sectors + 8 * num_8k_sectors);
1602 /* Determine maximum contiguous RAM block */
1603 lpc2900_info->max_ram_block = 16 * KiB;
1604 if( (feat1 & 0x30) == 0x30 )
1606 lpc2900_info->max_ram_block = 32 * KiB;
1607 if( (feat1 & 0x0C) == 0x0C )
1609 lpc2900_info->max_ram_block = 48 * KiB;
1613 /* Determine package code and ITCM size */
1614 uint32_t package_code = feat0 & 0x0F;
1615 uint32_t itcm_code = (feat1 >> 16) & 0x1F;
1617 /* Determine the exact type number. */
1619 if ( (package_code == 4) && (itcm_code == 5) )
1621 /* Old LPC2917 or LPC2919 (non-/01 devices) */
1622 lpc2900_info->target_name = (bank->size == 768*KiB) ? "LPC2919" : "LPC2917";
1626 if ( package_code == 2 )
1628 /* 100-pin package */
1629 if ( bank->size == 128*KiB )
1631 lpc2900_info->target_name = "LPC2921";
1633 else if ( bank->size == 256*KiB )
1635 lpc2900_info->target_name = "LPC2923";
1637 else if ( bank->size == 512*KiB )
1639 lpc2900_info->target_name = "LPC2925";
1646 else if ( package_code == 4 )
1648 /* 144-pin package */
1649 if ( (bank->size == 512*KiB) && (feat3 == 0xFFFFFCF0) )
1651 lpc2900_info->target_name = "LPC2917/01";
1653 else if ( (bank->size == 512*KiB) && (feat3 == 0xFFFFFFF1) )
1655 lpc2900_info->target_name = "LPC2927";
1657 else if ( (bank->size == 768*KiB) && (feat3 == 0xFFFFFCF8) )
1659 lpc2900_info->target_name = "LPC2919/01";
1661 else if ( (bank->size == 768*KiB) && (feat3 == 0xFFFFFFF9) )
1663 lpc2900_info->target_name = "LPC2929";
1670 else if ( package_code == 5 )
1672 /* 208-pin package */
1673 lpc2900_info->target_name = (bank->size == 0) ? "LPC2930" : "LPC2939";
1683 LOG_WARNING("Unknown LPC29xx derivative");
1684 return ERROR_FLASH_OPERATION_FAILED;
1687 /* Show detected device */
1688 LOG_INFO("Flash bank %d"
1689 ": Device %s, %" PRIu32
1690 " KiB in %d sectors",
1692 lpc2900_info->target_name, bank->size / KiB,
1695 /* Flashless devices cannot be handled */
1696 if ( bank->num_sectors == 0 )
1698 LOG_WARNING("Flashless device cannot be handled");
1699 return ERROR_FLASH_OPERATION_FAILED;
1703 * These are logical sector numbers. When doing real flash operations,
1704 * the logical flash number are translated into the physical flash numbers
1707 bank->sectors = malloc(sizeof(flash_sector_t) * bank->num_sectors);
1710 for (i = 0; i < bank->num_sectors; i++)
1712 bank->sectors[i].offset = offset;
1713 bank->sectors[i].is_erased = -1;
1714 bank->sectors[i].is_protected = -1;
1718 bank->sectors[i].size = 8 * KiB;
1722 bank->sectors[i].size = 64 * KiB;
1726 /* We shouldn't come here. But there might be a new part out there
1727 * that has more than 19 sectors. Politely ask for a fix then.
1729 bank->sectors[i].size = 0;
1730 LOG_ERROR("Never heard about sector %d", i);
1733 offset += bank->sectors[i].size;
1736 /* Read sector security status */
1737 if ( lpc2900_read_security_status(bank) != ERROR_OK )
1739 LOG_ERROR("Cannot determine sector security status");
1740 return ERROR_FLASH_OPERATION_FAILED;
1748 * Run a blank check for each sector.
1750 * For speed reasons, the device isn't read word by word.
1751 * A hash value is calculated by the hardware ("BIST") for each sector.
1752 * This value is then compared against the known hash of an empty sector.
1754 * @param bank Pointer to the flash bank descriptor
1756 static int lpc2900_erase_check(struct flash_bank_s *bank)
1758 uint32_t status = lpc2900_is_ready(bank);
1759 if (status != ERROR_OK)
1761 LOG_INFO("Processor not halted/not probed");
1765 /* Use the BIST (Built-In Selft Test) to generate a signature of each flash
1766 * sector. Compare against the expected signature of an empty sector.
1769 for ( sector = 0; sector < bank->num_sectors; sector++ )
1771 uint32_t signature[4];
1772 if ( (status = lpc2900_run_bist128( bank,
1773 bank->sectors[sector].offset,
1774 bank->sectors[sector].offset +
1775 (bank->sectors[sector].size - 1),
1776 &signature)) != ERROR_OK )
1781 /* The expected signatures for an empty sector are different
1782 * for 8 KiB and 64 KiB sectors.
1784 if ( bank->sectors[sector].size == 8*KiB )
1786 bank->sectors[sector].is_erased =
1787 (signature[3] == 0x01ABAAAA) &&
1788 (signature[2] == 0xAAAAAAAA) &&
1789 (signature[1] == 0xAAAAAAAA) &&
1790 (signature[0] == 0xAAA00AAA);
1792 if ( bank->sectors[sector].size == 64*KiB )
1794 bank->sectors[sector].is_erased =
1795 (signature[3] == 0x11801222) &&
1796 (signature[2] == 0xB88844FF) &&
1797 (signature[1] == 0x11A22008) &&
1798 (signature[0] == 0x2B1BFE44);
1807 * Get protection (sector security) status.
1809 * Determine the status of "sector security" for each sector.
1810 * A secured sector is one that can never be erased/programmed again.
1812 * @param bank Pointer to the flash bank descriptor
1814 static int lpc2900_protect_check(struct flash_bank_s *bank)
1816 return lpc2900_read_security_status(bank);
1821 * Print info about the driver (not the device).
1823 * @param bank Pointer to the flash bank descriptor
1824 * @param buf Buffer to take the string
1825 * @param buf_size Maximum number of characters that the buffer can take
1827 static int lpc2900_info(struct flash_bank_s *bank, char *buf, int buf_size)
1829 snprintf(buf, buf_size, "lpc2900 flash driver");
1835 flash_driver_t lpc2900_flash =
1838 .register_commands = lpc2900_register_commands,
1839 .flash_bank_command = lpc2900_flash_bank_command,
1840 .erase = lpc2900_erase,
1841 .protect = lpc2900_protect,
1842 .write = lpc2900_write,
1843 .probe = lpc2900_probe,
1844 .auto_probe = lpc2900_probe,
1845 .erase_check = lpc2900_erase_check,
1846 .protect_check = lpc2900_protect_check,
1847 .info = lpc2900_info