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

Subversion Repositories neorv32

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

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

powered by: WebSVN 2.1.0

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