| 1 |
2 |
zero_gravi |
// #################################################################################################
|
| 2 |
|
|
// # << NEORV32 - Bootloader >> #
|
| 3 |
|
|
// # ********************************************************************************************* #
|
| 4 |
55 |
zero_gravi |
// # In order to run the bootloader on *any* CPU configuration, the bootloader should be compiled #
|
| 5 |
33 |
zero_gravi |
// # unsing the base ISA (rv32i/rv32e) only. #
|
| 6 |
2 |
zero_gravi |
// # ********************************************************************************************* #
|
| 7 |
|
|
// # Boot from (internal) instruction memory, UART or SPI Flash. #
|
| 8 |
|
|
// # #
|
| 9 |
50 |
zero_gravi |
// # The bootloader uses the primary UART (UART0) for user console interface. #
|
| 10 |
|
|
// # #
|
| 11 |
42 |
zero_gravi |
// # UART configuration: 8 data bits, NO parity bit, 1 stop bit, 19200 baud (19200-8N1) #
|
| 12 |
2 |
zero_gravi |
// # Boot Flash: 8-bit SPI, 24-bit addresses (like Micron N25Q032A) @ neorv32.spi_csn_o(0) #
|
| 13 |
33 |
zero_gravi |
// # neorv32.gpio_o(0) is used as high-active status LED (can be disabled via #STATUS_LED_EN). #
|
| 14 |
2 |
zero_gravi |
// # #
|
| 15 |
33 |
zero_gravi |
// # Auto boot sequence (can be disabled via #AUTOBOOT_EN) after timeout (via #AUTOBOOT_TIMEOUT): #
|
| 16 |
2 |
zero_gravi |
// # -> Try booting from SPI flash at spi_csn_o(0). #
|
| 17 |
33 |
zero_gravi |
// # -> Permanently light up status led and stall CPU if SPI flash booting attempt fails. #
|
| 18 |
2 |
zero_gravi |
// # ********************************************************************************************* #
|
| 19 |
|
|
// # BSD 3-Clause License #
|
| 20 |
|
|
// # #
|
| 21 |
55 |
zero_gravi |
// # Copyright (c) 2021, Stephan Nolting. All rights reserved. #
|
| 22 |
2 |
zero_gravi |
// # #
|
| 23 |
|
|
// # Redistribution and use in source and binary forms, with or without modification, are #
|
| 24 |
|
|
// # permitted provided that the following conditions are met: #
|
| 25 |
|
|
// # #
|
| 26 |
|
|
// # 1. Redistributions of source code must retain the above copyright notice, this list of #
|
| 27 |
|
|
// # conditions and the following disclaimer. #
|
| 28 |
|
|
// # #
|
| 29 |
|
|
// # 2. Redistributions in binary form must reproduce the above copyright notice, this list of #
|
| 30 |
|
|
// # conditions and the following disclaimer in the documentation and/or other materials #
|
| 31 |
|
|
// # provided with the distribution. #
|
| 32 |
|
|
// # #
|
| 33 |
|
|
// # 3. Neither the name of the copyright holder nor the names of its contributors may be used to #
|
| 34 |
|
|
// # endorse or promote products derived from this software without specific prior written #
|
| 35 |
|
|
// # permission. #
|
| 36 |
|
|
// # #
|
| 37 |
|
|
// # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS #
|
| 38 |
|
|
// # OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF #
|
| 39 |
|
|
// # MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE #
|
| 40 |
|
|
// # COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, #
|
| 41 |
|
|
// # EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE #
|
| 42 |
|
|
// # GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED #
|
| 43 |
|
|
// # AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING #
|
| 44 |
|
|
// # NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED #
|
| 45 |
|
|
// # OF THE POSSIBILITY OF SUCH DAMAGE. #
|
| 46 |
|
|
// # ********************************************************************************************* #
|
| 47 |
|
|
// # The NEORV32 Processor - https://github.com/stnolting/neorv32 (c) Stephan Nolting #
|
| 48 |
|
|
// #################################################################################################
|
| 49 |
|
|
|
| 50 |
|
|
|
| 51 |
|
|
/**********************************************************************//**
|
| 52 |
|
|
* @file bootloader.c
|
| 53 |
|
|
* @author Stephan Nolting
|
| 54 |
33 |
zero_gravi |
* @brief Default NEORV32 bootloader.
|
| 55 |
2 |
zero_gravi |
**************************************************************************/
|
| 56 |
|
|
|
| 57 |
|
|
// Libraries
|
| 58 |
|
|
#include <stdint.h>
|
| 59 |
|
|
#include <neorv32.h>
|
| 60 |
|
|
|
| 61 |
|
|
|
| 62 |
|
|
/**********************************************************************//**
|
| 63 |
|
|
* @name User configuration
|
| 64 |
|
|
**************************************************************************/
|
| 65 |
|
|
/**@{*/
|
| 66 |
|
|
/** UART BAUD rate */
|
| 67 |
|
|
#define BAUD_RATE (19200)
|
| 68 |
33 |
zero_gravi |
/** Enable auto-boot sequence if != 0 */
|
| 69 |
|
|
#define AUTOBOOT_EN (1)
|
| 70 |
2 |
zero_gravi |
/** Time until the auto-boot sequence starts (in seconds) */
|
| 71 |
56 |
zero_gravi |
#define AUTOBOOT_TIMEOUT (8)
|
| 72 |
22 |
zero_gravi |
/** Set to 0 to disable bootloader status LED */
|
| 73 |
|
|
#define STATUS_LED_EN (1)
|
| 74 |
56 |
zero_gravi |
/** Set to 1 to enable SPI direct boot (disables the entire user console!) */
|
| 75 |
|
|
#define SPI_DIRECT_BOOT_EN (0)
|
| 76 |
22 |
zero_gravi |
/** Bootloader status LED at GPIO output port */
|
| 77 |
2 |
zero_gravi |
#define STATUS_LED (0)
|
| 78 |
33 |
zero_gravi |
/** SPI flash boot image base address (warning! address might wrap-around!) */
|
| 79 |
11 |
zero_gravi |
#define SPI_FLASH_BOOT_ADR (0x00800000)
|
| 80 |
33 |
zero_gravi |
/** SPI flash chip select line at spi_csn_o */
|
| 81 |
2 |
zero_gravi |
#define SPI_FLASH_CS (0)
|
| 82 |
33 |
zero_gravi |
/** Default SPI flash clock prescaler */
|
| 83 |
2 |
zero_gravi |
#define SPI_FLASH_CLK_PRSC (CLK_PRSC_8)
|
| 84 |
33 |
zero_gravi |
/** SPI flash sector size in bytes (default = 64kb) */
|
| 85 |
2 |
zero_gravi |
#define SPI_FLASH_SECTOR_SIZE (64*1024)
|
| 86 |
34 |
zero_gravi |
/** ASCII char to start fast executable upload process (for use with automatic upload scripts) */
|
| 87 |
56 |
zero_gravi |
#define FAST_UPLOAD_CMD ('#')
|
| 88 |
2 |
zero_gravi |
/**@}*/
|
| 89 |
|
|
|
| 90 |
|
|
|
| 91 |
|
|
/**********************************************************************//**
|
| 92 |
|
|
Executable stream source select
|
| 93 |
|
|
**************************************************************************/
|
| 94 |
|
|
enum EXE_STREAM_SOURCE {
|
| 95 |
|
|
EXE_STREAM_UART = 0, /**< Get executable via UART */
|
| 96 |
|
|
EXE_STREAM_FLASH = 1 /**< Get executable via SPI flash */
|
| 97 |
|
|
};
|
| 98 |
|
|
|
| 99 |
|
|
|
| 100 |
|
|
/**********************************************************************//**
|
| 101 |
|
|
* Error codes
|
| 102 |
|
|
**************************************************************************/
|
| 103 |
|
|
enum ERROR_CODES {
|
| 104 |
|
|
ERROR_SIGNATURE = 0, /**< 0: Wrong signature in executable */
|
| 105 |
|
|
ERROR_SIZE = 1, /**< 1: Insufficient instruction memory capacity */
|
| 106 |
|
|
ERROR_CHECKSUM = 2, /**< 2: Checksum error in executable */
|
| 107 |
|
|
ERROR_FLASH = 3, /**< 3: SPI flash access error */
|
| 108 |
|
|
ERROR_ROM = 4, /**< 4: Instruction memory is marked as read-only */
|
| 109 |
|
|
ERROR_SYSTEM = 5 /**< 5: System exception */
|
| 110 |
|
|
};
|
| 111 |
|
|
|
| 112 |
|
|
|
| 113 |
|
|
/**********************************************************************//**
|
| 114 |
|
|
* SPI flash commands
|
| 115 |
|
|
**************************************************************************/
|
| 116 |
|
|
enum SPI_FLASH_CMD {
|
| 117 |
|
|
SPI_FLASH_CMD_PAGE_PROGRAM = 0x02, /**< Program page */
|
| 118 |
|
|
SPI_FLASH_CMD_READ = 0x03, /**< Read data */
|
| 119 |
|
|
SPI_FLASH_CMD_READ_STATUS = 0x05, /**< Get status register */
|
| 120 |
|
|
SPI_FLASH_CMD_WRITE_ENABLE = 0x06, /**< Allow write access */
|
| 121 |
|
|
SPI_FLASH_CMD_READ_ID = 0x9E, /**< Read manufacturer ID */
|
| 122 |
|
|
SPI_FLASH_CMD_SECTOR_ERASE = 0xD8 /**< Erase complete sector */
|
| 123 |
|
|
};
|
| 124 |
|
|
|
| 125 |
|
|
|
| 126 |
|
|
/**********************************************************************//**
|
| 127 |
|
|
* NEORV32 executable
|
| 128 |
|
|
**************************************************************************/
|
| 129 |
|
|
enum NEORV32_EXECUTABLE {
|
| 130 |
|
|
EXE_OFFSET_SIGNATURE = 0, /**< Offset in bytes from start to signature (32-bit) */
|
| 131 |
|
|
EXE_OFFSET_SIZE = 4, /**< Offset in bytes from start to size (32-bit) */
|
| 132 |
|
|
EXE_OFFSET_CHECKSUM = 8, /**< Offset in bytes from start to checksum (32-bit) */
|
| 133 |
|
|
EXE_OFFSET_DATA = 12, /**< Offset in bytes from start to data (32-bit) */
|
| 134 |
|
|
};
|
| 135 |
|
|
|
| 136 |
|
|
|
| 137 |
|
|
/**********************************************************************//**
|
| 138 |
|
|
* Valid executable identification signature.
|
| 139 |
|
|
**************************************************************************/
|
| 140 |
|
|
#define EXE_SIGNATURE 0x4788CAFE
|
| 141 |
|
|
|
| 142 |
|
|
|
| 143 |
|
|
/**********************************************************************//**
|
| 144 |
|
|
* String output helper macros.
|
| 145 |
|
|
**************************************************************************/
|
| 146 |
|
|
/**@{*/
|
| 147 |
|
|
/* Actual define-to-string helper */
|
| 148 |
|
|
#define xstr(a) str(a)
|
| 149 |
|
|
/* Internal helper macro */
|
| 150 |
|
|
#define str(a) #a
|
| 151 |
|
|
/**@}*/
|
| 152 |
|
|
|
| 153 |
|
|
|
| 154 |
22 |
zero_gravi |
/**********************************************************************//**
|
| 155 |
|
|
* This global variable keeps the size of the available executable in bytes.
|
| 156 |
|
|
* If =0 no executable is available (yet).
|
| 157 |
|
|
**************************************************************************/
|
| 158 |
47 |
zero_gravi |
volatile uint32_t exe_available = 0;
|
| 159 |
22 |
zero_gravi |
|
| 160 |
|
|
|
| 161 |
47 |
zero_gravi |
/**********************************************************************//**
|
| 162 |
|
|
* Only set during executable fetch (required for cpaturing STORE-BUS-TIMOUT exception).
|
| 163 |
|
|
**************************************************************************/
|
| 164 |
|
|
volatile uint32_t getting_exe = 0;
|
| 165 |
|
|
|
| 166 |
|
|
|
| 167 |
2 |
zero_gravi |
// Function prototypes
|
| 168 |
22 |
zero_gravi |
void __attribute__((__interrupt__)) bootloader_trap_handler(void);
|
| 169 |
34 |
zero_gravi |
void fast_upload(int src);
|
| 170 |
2 |
zero_gravi |
void print_help(void);
|
| 171 |
|
|
void start_app(void);
|
| 172 |
|
|
void get_exe(int src);
|
| 173 |
|
|
void save_exe(void);
|
| 174 |
|
|
uint32_t get_exe_word(int src, uint32_t addr);
|
| 175 |
|
|
void system_error(uint8_t err_code);
|
| 176 |
|
|
void print_hex_word(uint32_t num);
|
| 177 |
|
|
|
| 178 |
37 |
zero_gravi |
// SPI flash driver functions
|
| 179 |
2 |
zero_gravi |
uint8_t spi_flash_read_byte(uint32_t addr);
|
| 180 |
|
|
void spi_flash_write_byte(uint32_t addr, uint8_t wdata);
|
| 181 |
|
|
void spi_flash_write_word(uint32_t addr, uint32_t wdata);
|
| 182 |
|
|
void spi_flash_erase_sector(uint32_t addr);
|
| 183 |
|
|
uint8_t spi_flash_read_1st_id(void);
|
| 184 |
37 |
zero_gravi |
void spi_flash_write_wait(void);
|
| 185 |
4 |
zero_gravi |
void spi_flash_write_enable(void);
|
| 186 |
|
|
void spi_flash_write_addr(uint32_t addr);
|
| 187 |
2 |
zero_gravi |
|
| 188 |
|
|
|
| 189 |
|
|
/**********************************************************************//**
|
| 190 |
|
|
* Bootloader main.
|
| 191 |
|
|
**************************************************************************/
|
| 192 |
|
|
int main(void) {
|
| 193 |
|
|
|
| 194 |
56 |
zero_gravi |
// check ISA
|
| 195 |
|
|
#if defined __riscv_atomic || defined __riscv_a || __riscv_b || __riscv_compressed || defined __riscv_c || defined __riscv_mul || defined __riscv_m
|
| 196 |
|
|
#warning In order to allow the bootloader to run on *ANY* CPU configuration it should be compiled using the base ISA (rv32i/e) only.
|
| 197 |
39 |
zero_gravi |
#endif
|
| 198 |
|
|
|
| 199 |
47 |
zero_gravi |
exe_available = 0; // global variable for executable size; 0 means there is no exe available
|
| 200 |
|
|
getting_exe = 0; // we are not trying to get an executable yet
|
| 201 |
39 |
zero_gravi |
|
| 202 |
2 |
zero_gravi |
// ------------------------------------------------
|
| 203 |
39 |
zero_gravi |
// Minimal processor hardware initialization
|
| 204 |
|
|
// - all IO devices are reset and disabled by the crt0 code
|
| 205 |
|
|
// ------------------------------------------------
|
| 206 |
|
|
|
| 207 |
2 |
zero_gravi |
// get clock speed (in Hz)
|
| 208 |
12 |
zero_gravi |
uint32_t clock_speed = SYSINFO_CLK;
|
| 209 |
2 |
zero_gravi |
|
| 210 |
48 |
zero_gravi |
// init SPI for 8-bit, clock-mode 0
|
| 211 |
2 |
zero_gravi |
if (clock_speed < 40000000) {
|
| 212 |
48 |
zero_gravi |
neorv32_spi_setup(SPI_FLASH_CLK_PRSC, 0, 0);
|
| 213 |
2 |
zero_gravi |
}
|
| 214 |
|
|
else {
|
| 215 |
48 |
zero_gravi |
neorv32_spi_setup(CLK_PRSC_128, 0, 0);
|
| 216 |
2 |
zero_gravi |
}
|
| 217 |
|
|
|
| 218 |
56 |
zero_gravi |
#if (STATUS_LED_EN != 0)
|
| 219 |
39 |
zero_gravi |
// activate status LED, clear all others
|
| 220 |
|
|
neorv32_gpio_port_set(1 << STATUS_LED);
|
| 221 |
56 |
zero_gravi |
#endif
|
| 222 |
39 |
zero_gravi |
|
| 223 |
51 |
zero_gravi |
// init UART (no parity bit, no hardware flow control)
|
| 224 |
|
|
neorv32_uart_setup(BAUD_RATE, PARITY_NONE, FLOW_CONTROL_NONE);
|
| 225 |
2 |
zero_gravi |
|
| 226 |
|
|
// Configure machine system timer interrupt for ~2Hz
|
| 227 |
|
|
neorv32_mtime_set_timecmp(neorv32_mtime_get_time() + (clock_speed/4));
|
| 228 |
|
|
|
| 229 |
47 |
zero_gravi |
// confiure trap handler (bare-metal, no neorv32 rte available)
|
| 230 |
|
|
neorv32_cpu_csr_write(CSR_MTVEC, (uint32_t)(&bootloader_trap_handler));
|
| 231 |
|
|
|
| 232 |
|
|
// active timer IRQ
|
| 233 |
42 |
zero_gravi |
neorv32_cpu_csr_write(CSR_MIE, 1 << CSR_MIE_MTIE); // activate MTIME IRQ source
|
| 234 |
2 |
zero_gravi |
neorv32_cpu_eint(); // enable global interrupts
|
| 235 |
|
|
|
| 236 |
|
|
|
| 237 |
39 |
zero_gravi |
// ------------------------------------------------
|
| 238 |
|
|
// Fast boot mode: Direct SPI boot
|
| 239 |
|
|
// Bootloader will directly boot and execute image from SPI memory.
|
| 240 |
|
|
// No user UART console is available in this mode!
|
| 241 |
|
|
// ------------------------------------------------
|
| 242 |
56 |
zero_gravi |
#if (SPI_DIRECT_BOOT_EN != 0)
|
| 243 |
39 |
zero_gravi |
#warning Compiling bootloader in 'SPI direct boot mode'. Bootloader will directly boot from SPI memory. No user UART console will be available.
|
| 244 |
2 |
zero_gravi |
|
| 245 |
39 |
zero_gravi |
neorv32_uart_print("\nNEORV32 bootloader\nAccessing SPI flash at ");
|
| 246 |
|
|
print_hex_word((uint32_t)SPI_FLASH_BOOT_ADR);
|
| 247 |
|
|
neorv32_uart_print("\n");
|
| 248 |
2 |
zero_gravi |
|
| 249 |
39 |
zero_gravi |
get_exe(EXE_STREAM_FLASH);
|
| 250 |
|
|
neorv32_uart_print("\n");
|
| 251 |
|
|
start_app();
|
| 252 |
|
|
|
| 253 |
|
|
return 0;
|
| 254 |
|
|
#endif
|
| 255 |
|
|
|
| 256 |
|
|
|
| 257 |
2 |
zero_gravi |
// ------------------------------------------------
|
| 258 |
|
|
// Show bootloader intro and system info
|
| 259 |
|
|
// ------------------------------------------------
|
| 260 |
|
|
neorv32_uart_print("\n\n\n\n<< NEORV32 Bootloader >>\n\n"
|
| 261 |
|
|
"BLDV: "__DATE__"\nHWV: ");
|
| 262 |
37 |
zero_gravi |
print_hex_word(neorv32_cpu_csr_read(CSR_MIMPID));
|
| 263 |
2 |
zero_gravi |
neorv32_uart_print("\nCLK: ");
|
| 264 |
12 |
zero_gravi |
print_hex_word(SYSINFO_CLK);
|
| 265 |
55 |
zero_gravi |
neorv32_uart_print("\nUSER: ");
|
| 266 |
12 |
zero_gravi |
print_hex_word(SYSINFO_USER_CODE);
|
| 267 |
6 |
zero_gravi |
neorv32_uart_print("\nMISA: ");
|
| 268 |
2 |
zero_gravi |
print_hex_word(neorv32_cpu_csr_read(CSR_MISA));
|
| 269 |
55 |
zero_gravi |
neorv32_uart_print("\nZEXT: ");
|
| 270 |
|
|
print_hex_word(neorv32_cpu_csr_read(CSR_MZEXT));
|
| 271 |
27 |
zero_gravi |
neorv32_uart_print("\nPROC: ");
|
| 272 |
12 |
zero_gravi |
print_hex_word(SYSINFO_FEATURES);
|
| 273 |
2 |
zero_gravi |
neorv32_uart_print("\nIMEM: ");
|
| 274 |
23 |
zero_gravi |
print_hex_word(SYSINFO_IMEM_SIZE);
|
| 275 |
2 |
zero_gravi |
neorv32_uart_print(" bytes @ ");
|
| 276 |
12 |
zero_gravi |
print_hex_word(SYSINFO_ISPACE_BASE);
|
| 277 |
2 |
zero_gravi |
neorv32_uart_print("\nDMEM: ");
|
| 278 |
23 |
zero_gravi |
print_hex_word(SYSINFO_DMEM_SIZE);
|
| 279 |
2 |
zero_gravi |
neorv32_uart_print(" bytes @ ");
|
| 280 |
12 |
zero_gravi |
print_hex_word(SYSINFO_DSPACE_BASE);
|
| 281 |
2 |
zero_gravi |
|
| 282 |
|
|
|
| 283 |
|
|
// ------------------------------------------------
|
| 284 |
|
|
// Auto boot sequence
|
| 285 |
|
|
// ------------------------------------------------
|
| 286 |
24 |
zero_gravi |
#if (AUTOBOOT_EN != 0)
|
| 287 |
2 |
zero_gravi |
neorv32_uart_print("\n\nAutoboot in "xstr(AUTOBOOT_TIMEOUT)"s. Press key to abort.\n");
|
| 288 |
|
|
|
| 289 |
13 |
zero_gravi |
uint64_t timeout_time = neorv32_mtime_get_time() + (uint64_t)(AUTOBOOT_TIMEOUT * clock_speed);
|
| 290 |
|
|
|
| 291 |
50 |
zero_gravi |
while (neorv32_uart_char_received() == 0) { // wait for any key to be pressed
|
| 292 |
2 |
zero_gravi |
|
| 293 |
|
|
if (neorv32_mtime_get_time() >= timeout_time) { // timeout? start auto boot sequence
|
| 294 |
34 |
zero_gravi |
fast_upload(EXE_STREAM_FLASH); // try booting from flash
|
| 295 |
2 |
zero_gravi |
}
|
| 296 |
|
|
}
|
| 297 |
|
|
neorv32_uart_print("Aborted.\n\n");
|
| 298 |
34 |
zero_gravi |
|
| 299 |
|
|
// fast executable upload?
|
| 300 |
|
|
if (neorv32_uart_char_received_get() == FAST_UPLOAD_CMD) {
|
| 301 |
|
|
fast_upload(EXE_STREAM_UART);
|
| 302 |
|
|
}
|
| 303 |
24 |
zero_gravi |
#else
|
| 304 |
|
|
neorv32_uart_print("\n\n");
|
| 305 |
|
|
#endif
|
| 306 |
|
|
|
| 307 |
2 |
zero_gravi |
print_help();
|
| 308 |
|
|
|
| 309 |
|
|
|
| 310 |
|
|
// ------------------------------------------------
|
| 311 |
|
|
// Bootloader console
|
| 312 |
|
|
// ------------------------------------------------
|
| 313 |
|
|
while (1) {
|
| 314 |
|
|
|
| 315 |
|
|
neorv32_uart_print("\nCMD:> ");
|
| 316 |
|
|
char c = neorv32_uart_getc();
|
| 317 |
|
|
neorv32_uart_putc(c); // echo
|
| 318 |
|
|
neorv32_uart_print("\n");
|
| 319 |
|
|
|
| 320 |
34 |
zero_gravi |
if (c == FAST_UPLOAD_CMD) { // fast executable upload
|
| 321 |
|
|
fast_upload(EXE_STREAM_UART);
|
| 322 |
|
|
}
|
| 323 |
|
|
else if (c == 'r') { // restart bootloader
|
| 324 |
22 |
zero_gravi |
asm volatile ("li t0, %[input_i]; jr t0" : : [input_i] "i" (BOOTLOADER_BASE_ADDRESS)); // jump to beginning of boot ROM
|
| 325 |
2 |
zero_gravi |
}
|
| 326 |
|
|
else if (c == 'h') { // help menu
|
| 327 |
|
|
print_help();
|
| 328 |
|
|
}
|
| 329 |
|
|
else if (c == 'u') { // get executable via UART
|
| 330 |
|
|
get_exe(EXE_STREAM_UART);
|
| 331 |
|
|
}
|
| 332 |
24 |
zero_gravi |
else if (c == 's') { // program flash from memory (IMEM)
|
| 333 |
2 |
zero_gravi |
save_exe();
|
| 334 |
|
|
}
|
| 335 |
|
|
else if (c == 'l') { // get executable from flash
|
| 336 |
|
|
get_exe(EXE_STREAM_FLASH);
|
| 337 |
|
|
}
|
| 338 |
|
|
else if (c == 'e') { // start application program
|
| 339 |
|
|
start_app();
|
| 340 |
|
|
}
|
| 341 |
|
|
else { // unknown command
|
| 342 |
|
|
neorv32_uart_print("Invalid CMD");
|
| 343 |
|
|
}
|
| 344 |
|
|
}
|
| 345 |
|
|
|
| 346 |
12 |
zero_gravi |
return 0; // bootloader should never return
|
| 347 |
2 |
zero_gravi |
}
|
| 348 |
|
|
|
| 349 |
|
|
|
| 350 |
|
|
/**********************************************************************//**
|
| 351 |
34 |
zero_gravi |
* Get executable stream and execute it.
|
| 352 |
|
|
*
|
| 353 |
|
|
* @param src Source of executable stream data. See #EXE_STREAM_SOURCE.
|
| 354 |
|
|
**************************************************************************/
|
| 355 |
|
|
void fast_upload(int src) {
|
| 356 |
|
|
|
| 357 |
|
|
get_exe(src);
|
| 358 |
|
|
neorv32_uart_print("\n");
|
| 359 |
|
|
start_app();
|
| 360 |
|
|
while(1);
|
| 361 |
|
|
}
|
| 362 |
|
|
|
| 363 |
|
|
|
| 364 |
|
|
/**********************************************************************//**
|
| 365 |
2 |
zero_gravi |
* Print help menu.
|
| 366 |
|
|
**************************************************************************/
|
| 367 |
|
|
void print_help(void) {
|
| 368 |
|
|
|
| 369 |
|
|
neorv32_uart_print("Available CMDs:\n"
|
| 370 |
|
|
" h: Help\n"
|
| 371 |
|
|
" r: Restart\n"
|
| 372 |
|
|
" u: Upload\n"
|
| 373 |
|
|
" s: Store to flash\n"
|
| 374 |
|
|
" l: Load from flash\n"
|
| 375 |
|
|
" e: Execute");
|
| 376 |
|
|
}
|
| 377 |
|
|
|
| 378 |
|
|
|
| 379 |
|
|
/**********************************************************************//**
|
| 380 |
|
|
* Start application program at the beginning of instruction space.
|
| 381 |
|
|
**************************************************************************/
|
| 382 |
|
|
void start_app(void) {
|
| 383 |
|
|
|
| 384 |
4 |
zero_gravi |
// executable available?
|
| 385 |
22 |
zero_gravi |
if (exe_available == 0) {
|
| 386 |
4 |
zero_gravi |
neorv32_uart_print("No executable available.");
|
| 387 |
|
|
return;
|
| 388 |
|
|
}
|
| 389 |
|
|
|
| 390 |
39 |
zero_gravi |
// no need to shut down/reset the used peripherals
|
| 391 |
23 |
zero_gravi |
// no need to disable interrupt sources
|
| 392 |
39 |
zero_gravi |
// -> crt0 will do a clean CPU/processor reset/setup
|
| 393 |
2 |
zero_gravi |
|
| 394 |
23 |
zero_gravi |
// deactivate global IRQs
|
| 395 |
2 |
zero_gravi |
neorv32_cpu_dint();
|
| 396 |
|
|
|
| 397 |
|
|
neorv32_uart_print("Booting...\n\n");
|
| 398 |
|
|
|
| 399 |
|
|
// wait for UART to finish transmitting
|
| 400 |
50 |
zero_gravi |
while (neorv32_uart_tx_busy());
|
| 401 |
2 |
zero_gravi |
|
| 402 |
|
|
// start app at instruction space base address
|
| 403 |
14 |
zero_gravi |
register uint32_t app_base = SYSINFO_ISPACE_BASE;
|
| 404 |
|
|
asm volatile ("jalr zero, %0" : : "r" (app_base));
|
| 405 |
|
|
while (1);
|
| 406 |
2 |
zero_gravi |
}
|
| 407 |
|
|
|
| 408 |
|
|
|
| 409 |
|
|
/**********************************************************************//**
|
| 410 |
23 |
zero_gravi |
* Bootloader trap handler. Used for the MTIME tick and to capture any other traps.
|
| 411 |
47 |
zero_gravi |
* @warning Since we have no runtime environment, we have to use the interrupt attribute here. Here and only here!
|
| 412 |
2 |
zero_gravi |
**************************************************************************/
|
| 413 |
22 |
zero_gravi |
void __attribute__((__interrupt__)) bootloader_trap_handler(void) {
|
| 414 |
2 |
zero_gravi |
|
| 415 |
47 |
zero_gravi |
uint32_t cause = neorv32_cpu_csr_read(CSR_MCAUSE);
|
| 416 |
|
|
|
| 417 |
2 |
zero_gravi |
// make sure this was caused by MTIME IRQ
|
| 418 |
23 |
zero_gravi |
if (cause == TRAP_CODE_MTI) { // raw exception code for MTI
|
| 419 |
56 |
zero_gravi |
#if (STATUS_LED_EN != 0)
|
| 420 |
22 |
zero_gravi |
// toggle status LED
|
| 421 |
|
|
neorv32_gpio_pin_toggle(STATUS_LED);
|
| 422 |
56 |
zero_gravi |
#endif
|
| 423 |
2 |
zero_gravi |
// set time for next IRQ
|
| 424 |
12 |
zero_gravi |
neorv32_mtime_set_timecmp(neorv32_mtime_get_time() + (SYSINFO_CLK/4));
|
| 425 |
2 |
zero_gravi |
}
|
| 426 |
23 |
zero_gravi |
else {
|
| 427 |
47 |
zero_gravi |
// store bus access error during get_exe
|
| 428 |
|
|
// -> seems like executable is too large
|
| 429 |
|
|
if ((cause == TRAP_CODE_S_ACCESS) && (getting_exe)) {
|
| 430 |
|
|
system_error(ERROR_SIZE);
|
| 431 |
|
|
}
|
| 432 |
|
|
// unknown error
|
| 433 |
|
|
else {
|
| 434 |
56 |
zero_gravi |
neorv32_uart_print("\n\nEXCEPTION mcause=");
|
| 435 |
47 |
zero_gravi |
print_hex_word(cause);
|
| 436 |
56 |
zero_gravi |
neorv32_uart_print(" @ pc=");
|
| 437 |
47 |
zero_gravi |
print_hex_word(neorv32_cpu_csr_read(CSR_MEPC));
|
| 438 |
|
|
system_error(ERROR_SYSTEM);
|
| 439 |
|
|
}
|
| 440 |
23 |
zero_gravi |
}
|
| 441 |
2 |
zero_gravi |
}
|
| 442 |
|
|
|
| 443 |
|
|
|
| 444 |
|
|
/**********************************************************************//**
|
| 445 |
|
|
* Get executable stream.
|
| 446 |
|
|
*
|
| 447 |
|
|
* @param src Source of executable stream data. See #EXE_STREAM_SOURCE.
|
| 448 |
|
|
**************************************************************************/
|
| 449 |
|
|
void get_exe(int src) {
|
| 450 |
|
|
|
| 451 |
47 |
zero_gravi |
getting_exe = 1; // to inform trap handler we were trying to get an executable
|
| 452 |
|
|
|
| 453 |
35 |
zero_gravi |
// is MEM implemented and read-only?
|
| 454 |
|
|
if ((SYSINFO_FEATURES & (1 << SYSINFO_FEATURES_MEM_INT_IMEM_ROM)) &&
|
| 455 |
|
|
(SYSINFO_FEATURES & (1 << SYSINFO_FEATURES_MEM_INT_IMEM))) {
|
| 456 |
2 |
zero_gravi |
system_error(ERROR_ROM);
|
| 457 |
|
|
}
|
| 458 |
|
|
|
| 459 |
|
|
// flash image base address
|
| 460 |
|
|
uint32_t addr = SPI_FLASH_BOOT_ADR;
|
| 461 |
|
|
|
| 462 |
|
|
// get image from flash?
|
| 463 |
|
|
if (src == EXE_STREAM_UART) {
|
| 464 |
|
|
neorv32_uart_print("Awaiting neorv32_exe.bin... ");
|
| 465 |
|
|
}
|
| 466 |
|
|
else {
|
| 467 |
|
|
neorv32_uart_print("Loading... ");
|
| 468 |
|
|
|
| 469 |
57 |
zero_gravi |
// check if SPI is available at all
|
| 470 |
|
|
if (neorv32_spi_available() == 0) {
|
| 471 |
|
|
system_error(ERROR_FLASH);
|
| 472 |
|
|
}
|
| 473 |
|
|
|
| 474 |
2 |
zero_gravi |
// check if flash ready (or available at all)
|
| 475 |
|
|
if (spi_flash_read_1st_id() == 0x00) { // manufacturer ID
|
| 476 |
|
|
system_error(ERROR_FLASH);
|
| 477 |
|
|
}
|
| 478 |
|
|
}
|
| 479 |
|
|
|
| 480 |
|
|
// check if valid image
|
| 481 |
|
|
uint32_t signature = get_exe_word(src, addr + EXE_OFFSET_SIGNATURE);
|
| 482 |
|
|
if (signature != EXE_SIGNATURE) { // signature
|
| 483 |
|
|
system_error(ERROR_SIGNATURE);
|
| 484 |
|
|
}
|
| 485 |
|
|
|
| 486 |
|
|
// image size and checksum
|
| 487 |
|
|
uint32_t size = get_exe_word(src, addr + EXE_OFFSET_SIZE); // size in bytes
|
| 488 |
|
|
uint32_t check = get_exe_word(src, addr + EXE_OFFSET_CHECKSUM); // complement sum checksum
|
| 489 |
|
|
|
| 490 |
|
|
// transfer program data
|
| 491 |
12 |
zero_gravi |
uint32_t *pnt = (uint32_t*)SYSINFO_ISPACE_BASE;
|
| 492 |
2 |
zero_gravi |
uint32_t checksum = 0;
|
| 493 |
|
|
uint32_t d = 0, i = 0;
|
| 494 |
|
|
addr = addr + EXE_OFFSET_DATA;
|
| 495 |
|
|
while (i < (size/4)) { // in words
|
| 496 |
|
|
d = get_exe_word(src, addr);
|
| 497 |
|
|
checksum += d;
|
| 498 |
|
|
pnt[i++] = d;
|
| 499 |
|
|
addr += 4;
|
| 500 |
|
|
}
|
| 501 |
|
|
|
| 502 |
|
|
// error during transfer?
|
| 503 |
|
|
if ((checksum + check) != 0) {
|
| 504 |
|
|
system_error(ERROR_CHECKSUM);
|
| 505 |
|
|
}
|
| 506 |
|
|
else {
|
| 507 |
|
|
neorv32_uart_print("OK");
|
| 508 |
22 |
zero_gravi |
exe_available = size; // store exe size
|
| 509 |
2 |
zero_gravi |
}
|
| 510 |
47 |
zero_gravi |
|
| 511 |
|
|
getting_exe = 0; // to inform trap handler we are done getting an executable
|
| 512 |
2 |
zero_gravi |
}
|
| 513 |
|
|
|
| 514 |
|
|
|
| 515 |
|
|
/**********************************************************************//**
|
| 516 |
|
|
* Store content of instruction memory to SPI flash.
|
| 517 |
|
|
**************************************************************************/
|
| 518 |
|
|
void save_exe(void) {
|
| 519 |
|
|
|
| 520 |
|
|
// size of last uploaded executable
|
| 521 |
22 |
zero_gravi |
uint32_t size = exe_available;
|
| 522 |
2 |
zero_gravi |
|
| 523 |
|
|
if (size == 0) {
|
| 524 |
|
|
neorv32_uart_print("No executable available.");
|
| 525 |
|
|
return;
|
| 526 |
|
|
}
|
| 527 |
|
|
|
| 528 |
|
|
uint32_t addr = SPI_FLASH_BOOT_ADR;
|
| 529 |
|
|
|
| 530 |
|
|
// info and prompt
|
| 531 |
|
|
neorv32_uart_print("Write 0x");
|
| 532 |
|
|
print_hex_word(size);
|
| 533 |
|
|
neorv32_uart_print(" bytes to SPI flash @ 0x");
|
| 534 |
|
|
print_hex_word(addr);
|
| 535 |
|
|
neorv32_uart_print("? (y/n) ");
|
| 536 |
|
|
|
| 537 |
|
|
char c = neorv32_uart_getc();
|
| 538 |
|
|
neorv32_uart_putc(c);
|
| 539 |
|
|
if (c != 'y') {
|
| 540 |
|
|
return;
|
| 541 |
|
|
}
|
| 542 |
|
|
|
| 543 |
|
|
// check if flash ready (or available at all)
|
| 544 |
|
|
if (spi_flash_read_1st_id() == 0x00) { // manufacturer ID
|
| 545 |
|
|
system_error(ERROR_FLASH);
|
| 546 |
|
|
}
|
| 547 |
|
|
|
| 548 |
|
|
neorv32_uart_print("\nFlashing... ");
|
| 549 |
|
|
|
| 550 |
|
|
// clear memory before writing
|
| 551 |
|
|
uint32_t num_sectors = (size / SPI_FLASH_SECTOR_SIZE) + 1; // clear at least 1 sector
|
| 552 |
|
|
uint32_t sector = SPI_FLASH_BOOT_ADR;
|
| 553 |
|
|
while (num_sectors--) {
|
| 554 |
|
|
spi_flash_erase_sector(sector);
|
| 555 |
|
|
sector += SPI_FLASH_SECTOR_SIZE;
|
| 556 |
|
|
}
|
| 557 |
|
|
|
| 558 |
|
|
// write EXE signature
|
| 559 |
|
|
spi_flash_write_word(addr + EXE_OFFSET_SIGNATURE, EXE_SIGNATURE);
|
| 560 |
|
|
|
| 561 |
|
|
// write size
|
| 562 |
|
|
spi_flash_write_word(addr + EXE_OFFSET_SIZE, size);
|
| 563 |
|
|
|
| 564 |
|
|
// store data from instruction memory and update checksum
|
| 565 |
|
|
uint32_t checksum = 0;
|
| 566 |
12 |
zero_gravi |
uint32_t *pnt = (uint32_t*)SYSINFO_ISPACE_BASE;
|
| 567 |
2 |
zero_gravi |
addr = addr + EXE_OFFSET_DATA;
|
| 568 |
|
|
uint32_t i = 0;
|
| 569 |
|
|
while (i < (size/4)) { // in words
|
| 570 |
|
|
uint32_t d = (uint32_t)*pnt++;
|
| 571 |
|
|
checksum += d;
|
| 572 |
|
|
spi_flash_write_word(addr, d);
|
| 573 |
|
|
addr += 4;
|
| 574 |
|
|
i++;
|
| 575 |
|
|
}
|
| 576 |
|
|
|
| 577 |
|
|
// write checksum (sum complement)
|
| 578 |
|
|
checksum = (~checksum) + 1;
|
| 579 |
|
|
spi_flash_write_word(SPI_FLASH_BOOT_ADR + EXE_OFFSET_CHECKSUM, checksum);
|
| 580 |
|
|
|
| 581 |
|
|
neorv32_uart_print("OK");
|
| 582 |
|
|
}
|
| 583 |
|
|
|
| 584 |
|
|
|
| 585 |
|
|
/**********************************************************************//**
|
| 586 |
|
|
* Get word from executable stream
|
| 587 |
|
|
*
|
| 588 |
|
|
* @param src Source of executable stream data. See #EXE_STREAM_SOURCE.
|
| 589 |
|
|
* @param addr Address when accessing SPI flash.
|
| 590 |
|
|
* @return 32-bit data word from stream.
|
| 591 |
|
|
**************************************************************************/
|
| 592 |
|
|
uint32_t get_exe_word(int src, uint32_t addr) {
|
| 593 |
|
|
|
| 594 |
|
|
union {
|
| 595 |
|
|
uint32_t uint32;
|
| 596 |
|
|
uint8_t uint8[sizeof(uint32_t)];
|
| 597 |
|
|
} data;
|
| 598 |
|
|
|
| 599 |
|
|
uint32_t i;
|
| 600 |
|
|
for (i=0; i<4; i++) {
|
| 601 |
|
|
if (src == EXE_STREAM_UART) {
|
| 602 |
|
|
data.uint8[3-i] = (uint8_t)neorv32_uart_getc();
|
| 603 |
|
|
}
|
| 604 |
|
|
else {
|
| 605 |
|
|
data.uint8[3-i] = spi_flash_read_byte(addr + i);
|
| 606 |
|
|
}
|
| 607 |
|
|
}
|
| 608 |
|
|
|
| 609 |
|
|
return data.uint32;
|
| 610 |
|
|
}
|
| 611 |
|
|
|
| 612 |
|
|
|
| 613 |
|
|
/**********************************************************************//**
|
| 614 |
|
|
* Output system error ID and stall.
|
| 615 |
|
|
*
|
| 616 |
|
|
* @param[in] err_code Error code. See #ERROR_CODES.
|
| 617 |
|
|
**************************************************************************/
|
| 618 |
|
|
void system_error(uint8_t err_code) {
|
| 619 |
|
|
|
| 620 |
23 |
zero_gravi |
neorv32_uart_print("\a\nERROR_"); // output error code with annoying bell sound
|
| 621 |
22 |
zero_gravi |
neorv32_uart_putc('0' + ((char)err_code)); // FIXME err_code should/must be below 10
|
| 622 |
2 |
zero_gravi |
|
| 623 |
|
|
neorv32_cpu_dint(); // deactivate IRQs
|
| 624 |
22 |
zero_gravi |
if (STATUS_LED_EN == 1) {
|
| 625 |
|
|
neorv32_gpio_port_set(1 << STATUS_LED); // permanently light up status LED
|
| 626 |
|
|
}
|
| 627 |
2 |
zero_gravi |
|
| 628 |
|
|
while(1); // freeze
|
| 629 |
|
|
}
|
| 630 |
|
|
|
| 631 |
|
|
|
| 632 |
|
|
/**********************************************************************//**
|
| 633 |
|
|
* Print 32-bit number as 8-digit hexadecimal value (with "0x" suffix).
|
| 634 |
|
|
*
|
| 635 |
|
|
* @param[in] num Number to print as hexadecimal.
|
| 636 |
|
|
**************************************************************************/
|
| 637 |
|
|
void print_hex_word(uint32_t num) {
|
| 638 |
|
|
|
| 639 |
56 |
zero_gravi |
static const char hex_symbols[16] = "0123456789abcdef";
|
| 640 |
2 |
zero_gravi |
|
| 641 |
|
|
neorv32_uart_print("0x");
|
| 642 |
|
|
|
| 643 |
|
|
int i;
|
| 644 |
|
|
for (i=0; i<8; i++) {
|
| 645 |
|
|
uint32_t index = (num >> (28 - 4*i)) & 0xF;
|
| 646 |
|
|
neorv32_uart_putc(hex_symbols[index]);
|
| 647 |
|
|
}
|
| 648 |
|
|
}
|
| 649 |
|
|
|
| 650 |
|
|
|
| 651 |
|
|
|
| 652 |
|
|
// -------------------------------------------------------------------------------------
|
| 653 |
37 |
zero_gravi |
// SPI flash driver functions
|
| 654 |
2 |
zero_gravi |
// -------------------------------------------------------------------------------------
|
| 655 |
|
|
|
| 656 |
|
|
/**********************************************************************//**
|
| 657 |
|
|
* Read byte from SPI flash.
|
| 658 |
|
|
*
|
| 659 |
|
|
* @param[in] addr Flash read address.
|
| 660 |
|
|
* @return Read byte from SPI flash.
|
| 661 |
|
|
**************************************************************************/
|
| 662 |
|
|
uint8_t spi_flash_read_byte(uint32_t addr) {
|
| 663 |
|
|
|
| 664 |
|
|
neorv32_spi_cs_en(SPI_FLASH_CS);
|
| 665 |
|
|
|
| 666 |
|
|
neorv32_spi_trans(SPI_FLASH_CMD_READ);
|
| 667 |
4 |
zero_gravi |
spi_flash_write_addr(addr);
|
| 668 |
2 |
zero_gravi |
uint8_t rdata = (uint8_t)neorv32_spi_trans(0);
|
| 669 |
|
|
|
| 670 |
|
|
neorv32_spi_cs_dis(SPI_FLASH_CS);
|
| 671 |
|
|
|
| 672 |
|
|
return rdata;
|
| 673 |
|
|
}
|
| 674 |
|
|
|
| 675 |
|
|
|
| 676 |
|
|
/**********************************************************************//**
|
| 677 |
|
|
* Write byte to SPI flash.
|
| 678 |
|
|
*
|
| 679 |
|
|
* @param[in] addr SPI flash read address.
|
| 680 |
|
|
* @param[in] wdata SPI flash read data.
|
| 681 |
|
|
**************************************************************************/
|
| 682 |
|
|
void spi_flash_write_byte(uint32_t addr, uint8_t wdata) {
|
| 683 |
|
|
|
| 684 |
4 |
zero_gravi |
spi_flash_write_enable(); // allow write-access
|
| 685 |
2 |
zero_gravi |
|
| 686 |
|
|
neorv32_spi_cs_en(SPI_FLASH_CS);
|
| 687 |
|
|
|
| 688 |
|
|
neorv32_spi_trans(SPI_FLASH_CMD_PAGE_PROGRAM);
|
| 689 |
4 |
zero_gravi |
spi_flash_write_addr(addr);
|
| 690 |
2 |
zero_gravi |
neorv32_spi_trans(wdata);
|
| 691 |
|
|
|
| 692 |
|
|
neorv32_spi_cs_dis(SPI_FLASH_CS);
|
| 693 |
|
|
|
| 694 |
37 |
zero_gravi |
spi_flash_write_wait(); // wait for write operation to finish
|
| 695 |
2 |
zero_gravi |
}
|
| 696 |
|
|
|
| 697 |
|
|
|
| 698 |
|
|
/**********************************************************************//**
|
| 699 |
|
|
* Write word to SPI flash.
|
| 700 |
|
|
*
|
| 701 |
|
|
* @param addr SPI flash write address.
|
| 702 |
|
|
* @param wdata SPI flash write data.
|
| 703 |
|
|
**************************************************************************/
|
| 704 |
|
|
void spi_flash_write_word(uint32_t addr, uint32_t wdata) {
|
| 705 |
|
|
|
| 706 |
|
|
union {
|
| 707 |
|
|
uint32_t uint32;
|
| 708 |
|
|
uint8_t uint8[sizeof(uint32_t)];
|
| 709 |
|
|
} data;
|
| 710 |
|
|
|
| 711 |
|
|
data.uint32 = wdata;
|
| 712 |
|
|
|
| 713 |
39 |
zero_gravi |
int i;
|
| 714 |
2 |
zero_gravi |
for (i=0; i<4; i++) {
|
| 715 |
|
|
spi_flash_write_byte(addr + i, data.uint8[3-i]);
|
| 716 |
|
|
}
|
| 717 |
|
|
}
|
| 718 |
|
|
|
| 719 |
|
|
|
| 720 |
|
|
/**********************************************************************//**
|
| 721 |
|
|
* Erase sector (64kB) at base adress.
|
| 722 |
|
|
*
|
| 723 |
|
|
* @param[in] addr Base address of sector to erase.
|
| 724 |
|
|
**************************************************************************/
|
| 725 |
|
|
void spi_flash_erase_sector(uint32_t addr) {
|
| 726 |
|
|
|
| 727 |
4 |
zero_gravi |
spi_flash_write_enable(); // allow write-access
|
| 728 |
2 |
zero_gravi |
|
| 729 |
|
|
neorv32_spi_cs_en(SPI_FLASH_CS);
|
| 730 |
|
|
|
| 731 |
|
|
neorv32_spi_trans(SPI_FLASH_CMD_SECTOR_ERASE);
|
| 732 |
4 |
zero_gravi |
spi_flash_write_addr(addr);
|
| 733 |
2 |
zero_gravi |
|
| 734 |
|
|
neorv32_spi_cs_dis(SPI_FLASH_CS);
|
| 735 |
|
|
|
| 736 |
37 |
zero_gravi |
spi_flash_write_wait(); // wait for write operation to finish
|
| 737 |
2 |
zero_gravi |
}
|
| 738 |
|
|
|
| 739 |
|
|
|
| 740 |
|
|
/**********************************************************************//**
|
| 741 |
37 |
zero_gravi |
* Read first byte of ID (manufacturer ID), should be != 0x00.
|
| 742 |
2 |
zero_gravi |
*
|
| 743 |
37 |
zero_gravi |
* @note The first bit of the manufacturer ID is used to detect if a Flash is connected at all.
|
| 744 |
|
|
*
|
| 745 |
|
|
* @return First byte of ID.
|
| 746 |
2 |
zero_gravi |
**************************************************************************/
|
| 747 |
37 |
zero_gravi |
uint8_t spi_flash_read_1st_id(void) {
|
| 748 |
2 |
zero_gravi |
|
| 749 |
|
|
neorv32_spi_cs_en(SPI_FLASH_CS);
|
| 750 |
|
|
|
| 751 |
37 |
zero_gravi |
neorv32_spi_trans(SPI_FLASH_CMD_READ_ID);
|
| 752 |
|
|
uint8_t id = (uint8_t)neorv32_spi_trans(0);
|
| 753 |
2 |
zero_gravi |
|
| 754 |
|
|
neorv32_spi_cs_dis(SPI_FLASH_CS);
|
| 755 |
|
|
|
| 756 |
37 |
zero_gravi |
return id;
|
| 757 |
2 |
zero_gravi |
}
|
| 758 |
|
|
|
| 759 |
|
|
|
| 760 |
|
|
/**********************************************************************//**
|
| 761 |
37 |
zero_gravi |
* Wait for flash write operation to finisch.
|
| 762 |
2 |
zero_gravi |
**************************************************************************/
|
| 763 |
37 |
zero_gravi |
void spi_flash_write_wait(void) {
|
| 764 |
2 |
zero_gravi |
|
| 765 |
37 |
zero_gravi |
while(1) {
|
| 766 |
2 |
zero_gravi |
|
| 767 |
37 |
zero_gravi |
neorv32_spi_cs_en(SPI_FLASH_CS);
|
| 768 |
2 |
zero_gravi |
|
| 769 |
37 |
zero_gravi |
neorv32_spi_trans(SPI_FLASH_CMD_READ_STATUS);
|
| 770 |
|
|
uint8_t status = (uint8_t)neorv32_spi_trans(0);
|
| 771 |
2 |
zero_gravi |
|
| 772 |
37 |
zero_gravi |
neorv32_spi_cs_dis(SPI_FLASH_CS);
|
| 773 |
|
|
|
| 774 |
|
|
if ((status & 0x01) == 0) { // write in progress flag cleared?
|
| 775 |
|
|
break;
|
| 776 |
|
|
}
|
| 777 |
|
|
}
|
| 778 |
2 |
zero_gravi |
}
|
| 779 |
|
|
|
| 780 |
|
|
|
| 781 |
|
|
/**********************************************************************//**
|
| 782 |
4 |
zero_gravi |
* Enable flash write access.
|
| 783 |
2 |
zero_gravi |
**************************************************************************/
|
| 784 |
4 |
zero_gravi |
void spi_flash_write_enable(void) {
|
| 785 |
2 |
zero_gravi |
|
| 786 |
|
|
neorv32_spi_cs_en(SPI_FLASH_CS);
|
| 787 |
4 |
zero_gravi |
neorv32_spi_trans(SPI_FLASH_CMD_WRITE_ENABLE);
|
| 788 |
|
|
neorv32_spi_cs_dis(SPI_FLASH_CS);
|
| 789 |
|
|
}
|
| 790 |
2 |
zero_gravi |
|
| 791 |
|
|
|
| 792 |
4 |
zero_gravi |
/**********************************************************************//**
|
| 793 |
|
|
* Send address word to flash.
|
| 794 |
|
|
*
|
| 795 |
|
|
* @param[in] addr Address word.
|
| 796 |
|
|
**************************************************************************/
|
| 797 |
|
|
void spi_flash_write_addr(uint32_t addr) {
|
| 798 |
|
|
|
| 799 |
|
|
union {
|
| 800 |
|
|
uint32_t uint32;
|
| 801 |
|
|
uint8_t uint8[sizeof(uint32_t)];
|
| 802 |
|
|
} address;
|
| 803 |
|
|
|
| 804 |
|
|
address.uint32 = addr;
|
| 805 |
|
|
|
| 806 |
39 |
zero_gravi |
int i;
|
| 807 |
|
|
for (i=2; i>=0; i--) {
|
| 808 |
|
|
neorv32_spi_trans(address.uint8[i]);
|
| 809 |
|
|
}
|
| 810 |
2 |
zero_gravi |
}
|