github-mirrors/neorv32
1
0
Fork 0
mirror of https://github.com/stnolting/neorv32.git synced 2025-04-25 06:37:35 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

[bootloader] add TWI programming option

Browse source
This commit is contained in:
stnolting 2025-03-28 22:29:20 +01:00
parent 3abdfc4b00
commit b60ef75778
2 changed files with 101 additions and 51 deletions
Download patch file Download diff file Expand all files Collapse all files

28
sw/bootloader/config.h
View file

@ -84,24 +84,24 @@
#define SPI_FLASH_CS 0 #define SPI_FLASH_CS 0
#endif #endif
// SPI flash clock prescaler // SPI flash clock prescaler, see #NEORV32_CLOCK_PRSC_enum
#ifndef SPI_FLASH_CLK_PRSC #ifndef SPI_FLASH_CLK_PRSC
#define SPI_FLASH_CLK_PRSC CLK_PRSC_64 // see #NEORV32_CLOCK_PRSC_enum #define SPI_FLASH_CLK_PRSC CLK_PRSC_64
#endif #endif
// SPI flash base address // SPI flash base address (hast to be aligned to the sector size)
#ifndef SPI_FLASH_BASE_ADDR #ifndef SPI_FLASH_BASE_ADDR
#define SPI_FLASH_BASE_ADDR 0x00400000U #define SPI_FLASH_BASE_ADDR 0x00400000U
#endif #endif
// SPI flash address width (number of bytes: 1,2,3,4) // SPI flash address bytes (1,2,3,4)
#ifndef SPI_FLASH_ADDR_BYTES #ifndef SPI_FLASH_ADDR_BYTES
#define SPI_FLASH_ADDR_BYTES 3 // default = 3 address bytes = 24-bit #define SPI_FLASH_ADDR_BYTES 3
#endif #endif
// SPI flash sector size in bytes // SPI flash sector size in bytes
#ifndef SPI_FLASH_SECTOR_SIZE #ifndef SPI_FLASH_SECTOR_SIZE
#define SPI_FLASH_SECTOR_SIZE 65536 // default = 64kB #define SPI_FLASH_SECTOR_SIZE 65536
#endif #endif
/********************************************************************** /**********************************************************************
@ -113,29 +113,29 @@
#define TWI_EN 0 #define TWI_EN 0
#endif #endif
// TWI clock prescaler // TWI clock prescaler, see #NEORV32_CLOCK_PRSC_enum
#ifndef TWI_CLK_PRSC #ifndef TWI_CLK_PRSC
#define TWI_CLK_PRSC CLK_PRSC_64 // see #NEORV32_CLOCK_PRSC_enum #define TWI_CLK_PRSC CLK_PRSC_1024
#endif #endif
// TWI clock divider // TWI clock divider
#ifndef TWI_CLK_DIV #ifndef TWI_CLK_DIV
#define TWI_CLK_DIV 3 #define TWI_CLK_DIV 1
#endif #endif
// TWI device ID // TWI device ID (write address; R/W cleared)
#ifndef TWI_DEVICE_ID #ifndef TWI_DEVICE_ID
#define TWI_DEVICE_ID 0x50 #define TWI_DEVICE_ID 0xA0
#endif #endif
// TWI flash base address // TWI flash base address (has to 4-byte aligned)
#ifndef TWI_FLASH_BASE_ADDR #ifndef TWI_FLASH_BASE_ADDR
#define TWI_FLASH_BASE_ADDR 0x00000000U #define TWI_FLASH_BASE_ADDR 0x00000000U
#endif #endif
// TWI flash address width (number of bytes: 1,2,3,4) // TWI flash address bytes (1,2,3,4)
#ifndef TWI_FLASH_ADDR_BYTES #ifndef TWI_FLASH_ADDR_BYTES
#define TWI_FLASH_ADDR_BYTES 3 // default = 3 address bytes = 24-bit #define TWI_FLASH_ADDR_BYTES 2
#endif #endif
#endif // CONFIG_H #endif // CONFIG_H

124
sw/bootloader/main.c
View file

@ -45,7 +45,7 @@ void start_app(void);
int load_exe(int src); int load_exe(int src);
void save_exe(int dst); void save_exe(int dst);
int get_exe_word(int src, uint32_t addr, uint32_t *rdata); int get_exe_word(int src, uint32_t addr, uint32_t *rdata);
void set_boot_addr(void); int put_exe_word(int dst, uint32_t addr, uint32_t wdata);
/**********************************************************************//** /**********************************************************************//**
@ -76,15 +76,19 @@ int main(void) {
// setup UART0 // setup UART0
#if (UART_EN != 0) #if (UART_EN != 0)
neorv32_uart0_setup(UART_BAUD, 0); if (neorv32_uart0_available()) {
neorv32_uart0_setup(UART_BAUD, 0);
#if (UART_HW_HANDSHAKE_EN != 0)
neorv32_uart0_rtscts_enable();
#endif #endif
#if (UART_EN != 0) && (UART_HW_HANDSHAKE_EN != 0) }
neorv32_uart0_rtscts_enable();
#endif #endif
// setup TWI // setup TWI
#if (TWI_EN != 0) #if (TWI_EN != 0)
neorv32_twi_setup(TWI_CLK_PRSC, TWI_CLK_DIV, 0); if (neorv32_uart0_available()) {
neorv32_twi_available();
}
#endif #endif
// Configure CLINT timer interrupt // Configure CLINT timer interrupt
@ -101,7 +105,8 @@ int main(void) {
// Splash screen // Splash screen
// ------------------------------------------------ // ------------------------------------------------
uart_puts("\n\nNEORV32 Bootloader\n\n" uart_puts("\033[2J" // clear screen
"\n\nNEORV32 Bootloader\n\n"
"BLDV: " "BLDV: "
__DATE__ __DATE__
"\nHWV: "); "\nHWV: ");
@ -194,6 +199,9 @@ skip_auto_boot:
} }
#endif #endif
#if (TWI_EN != 0) #if (TWI_EN != 0)
else if (cmd == 'w') { // copy memory to TWI flash
save_exe(EXE_STREAM_TWI);
}
else if (cmd == 't') { // copy executable from TWI flash else if (cmd == 't') { // copy executable from TWI flash
load_exe(EXE_STREAM_TWI); load_exe(EXE_STREAM_TWI);
} }
@ -240,6 +248,7 @@ void print_help(void) {
"l: Load from SPI flash\n" "l: Load from SPI flash\n"
#endif #endif
#if (TWI_EN != 0) #if (TWI_EN != 0)
"w: Store to TWI flash\n"
"t: Load from TWI flash\n" "t: Load from TWI flash\n"
#endif #endif
"e: Start executable\n" "e: Start executable\n"
@ -435,10 +444,8 @@ int load_exe(int src) {
**************************************************************************/ **************************************************************************/
void save_exe(int dst) { void save_exe(int dst) {
// only SPI programming is supported yet int rc = 0;
if (dst != EXE_STREAM_SPI) { uint32_t dst_addr = 0;
return;
}
// size of last uploaded executable // size of last uploaded executable
uint32_t size = exe_available; uint32_t size = exe_available;
@ -447,11 +454,20 @@ void save_exe(int dst) {
return; return;
} }
// info prompt // info prompt and flash address setup
uart_puts("Write "); uart_puts("Write ");
uart_puth(size); uart_puth(size);
uart_puts(" bytes to SPI flash @"); uart_puts(" bytes to ");
uart_puth((uint32_t)SPI_FLASH_BASE_ADDR); if (dst == EXE_STREAM_SPI) {
uart_puts("SPI");
dst_addr = (uint32_t)SPI_FLASH_BASE_ADDR;
}
else {
uart_puts("TWI "xstr(TWI_DEVICE_ID)"");
dst_addr = (uint32_t)TWI_FLASH_BASE_ADDR;
}
uart_puts(" flash @");
uart_puth(dst_addr);
uart_puts(" (y/n)?\n"); uart_puts(" (y/n)?\n");
if (uart_getc() != 'y') { if (uart_getc() != 'y') {
return; return;
@ -459,38 +475,50 @@ void save_exe(int dst) {
uart_puts("Flashing... "); uart_puts("Flashing... ");
// SPI and flash ok? // prepare SPI flash
if (spi_flash_check()) { if (dst == EXE_STREAM_SPI) {
uart_puts("ERROR_DEVICE\n"); if (spi_flash_check()) { // SPI and flash OK?
return; uart_puts("ERROR_DEVICE\n");
return;
}
// clear memory before writing
uint32_t num_sectors = (size / (SPI_FLASH_SECTOR_SIZE)) + 1; // clear at least 1 sector
uint32_t sector_base_addr = dst_addr;
while (num_sectors--) {
rc |= spi_flash_erase_sector(sector_base_addr);
sector_base_addr += SPI_FLASH_SECTOR_SIZE;
}
} }
// clear memory before writing // transfer executable
uint32_t num_sectors = (size / (SPI_FLASH_SECTOR_SIZE)) + 1; // clear at least 1 sector uint32_t checksum = 0, tmp = 0, i = 0;
uint32_t sector_base_addr = (uint32_t)SPI_FLASH_BASE_ADDR ; uint32_t pnt = (uint32_t)EXE_BASE_ADDR;
while (num_sectors--) { uint32_t addr = dst_addr + EXE_OFFSET_DATA;
spi_flash_erase_sector(sector_base_addr);
sector_base_addr += SPI_FLASH_SECTOR_SIZE;
}
// store data from memory and update checksum
uint32_t checksum = 0, i = 0;
uint32_t *pnt = (uint32_t*)EXE_BASE_ADDR;
uint32_t src_addr = (uint32_t)SPI_FLASH_BASE_ADDR + EXE_OFFSET_DATA;
while (i < size) { // in chunks of 4 bytes while (i < size) { // in chunks of 4 bytes
uint32_t d = (uint32_t)*pnt++; tmp = neorv32_cpu_load_unsigned_word(pnt);
checksum += d; pnt += 4;
spi_flash_write_word(src_addr, d); checksum += tmp;
src_addr += 4; if (put_exe_word(dst, addr, tmp)) {
rc |= 1;
break;
}
addr += 4;
i += 4; i += 4;
} }
// write header // write header
spi_flash_write_word(SPI_FLASH_BASE_ADDR + EXE_OFFSET_SIGNATURE, EXE_SIGNATURE); rc |= put_exe_word(dst, dst_addr + EXE_OFFSET_SIGNATURE, EXE_SIGNATURE);
spi_flash_write_word(SPI_FLASH_BASE_ADDR + EXE_OFFSET_SIZE, size); rc |= put_exe_word(dst, dst_addr + EXE_OFFSET_SIZE, size);
spi_flash_write_word(SPI_FLASH_BASE_ADDR + EXE_OFFSET_CHECKSUM, (~checksum)+1); rc |= put_exe_word(dst, dst_addr + EXE_OFFSET_CHECKSUM, (~checksum)+1);
uart_puts("OK\n"); // checks
if (rc) {
uart_puts("ERROR_DEVICE\n");
}
else {
uart_puts("OK\n");
}
} }
@ -517,3 +545,25 @@ int get_exe_word(int src, uint32_t addr, uint32_t *rdata) {
return 1; return 1;
} }
} }
/**********************************************************************//**
* Put word to executable stream.
*
* @param dst Source of executable stream data. See #EXE_STREAM_SOURCE_enum.
* @param addr Address when accessing SPI flash or TWI Device.
* @param[in] wdata Write data word (uint32_t).
* @return 0 if success, != 0 if error.
**************************************************************************/
int put_exe_word(int dst, uint32_t addr, uint32_t wdata) {
if (dst == EXE_STREAM_SPI) {
return spi_flash_write_word(addr, wdata);
}
else if (dst == EXE_STREAM_TWI) {
return twi_flash_write_word(addr, wdata);
}
else {
return 1;
}
}