OpenCores
URL https://opencores.org/ocsvn/neorv32/neorv32/trunk

Subversion Repositories neorv32

[/] [neorv32/] [trunk/] [sw/] [bootloader/] [bootloader.c] - Blame information for rev 47

Go to most recent revision | Details | Compare with Previous | View Log

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

powered by: WebSVN 2.1.0

© copyright 1999-2024 OpenCores.org, equivalent to Oliscience, all rights reserved. OpenCores®, registered trademark.