Allow the size of the stack used by many of the standard demo/test tasks to be overri...

[freertos] / FreeRTOS / Demo / RISC-V-Qemu-sifive_e-FreedomStudio / main.c

diff --git a/FreeRTOS/Demo/RISC-V-Qemu-sifive_e-FreedomStudio/main.c b/FreeRTOS/Demo/RISC-V-Qemu-sifive_e-FreedomStudio/main.c
index ec5fd76245c68d0af7ec17ac82cf93d24bd6e421..6bfdefb05eb1d91cd9dd475cdb58d3897f9557b4 100644 (file)
--- a/FreeRTOS/Demo/RISC-V-Qemu-sifive_e-FreedomStudio/main.c
+++ b/FreeRTOS/Demo/RISC-V-Qemu-sifive_e-FreedomStudio/main.c
@@ -44,6 +44,31 @@
  * THE http://www.FreeRTOS.org WEB SITE FOR FULL INFORMATION ON USING THIS DEMO\r
  * APPLICATION, AND ITS ASSOCIATE FreeRTOS ARCHITECTURE PORT!\r
  *\r
+ *\r
+ * NOTE 1:\r
+ *\r
+ * This project has only been tested in the QEMU emulation of the HiFive board\r
+ * from SiFive.\r
+ *\r
+ * Start QEMU using the following command line:\r
+ *\r
+ * [your_path_1]\qemu-system-riscv32 -kernel [your_path_2]\FreeRTOS\Demo\RISC-V-Qemu-sifive_e-FreedomStudio\Debug\RTOSDemo.elf -S -s -machine sifive_e\r
+ *\r
+ * Where [your_path_1] must be replaced with the correct path to your QEMU\r
+ * installation and the elf file generated by this project respectively.\r
+ *\r
+ *\r
+ * NOTE 2:\r
+ *\r
+ * Start GDB using the following command line (this can be entered in the\r
+ * Eclipse Debug Launch Configuration dialogue):\r
+ *\r
+ * riscv64-unknown-elf-gdb.exe -iex "set mem inaccessible-by-default off" -iex "set arch riscv:rv32" -iex "set riscv use_compressed_breakpoint off"\r
+ *\r
+ *\r
+ * Note 3:\r
+ *\r
+ * Status information is sent to the QEMU serial console.\r
  */\r
 \r
 /* Set mainCREATE_SIMPLE_BLINKY_DEMO_ONLY to one to run the simple blinky demo,\r
@@ -98,7 +123,6 @@ void vApplicationMallocFailedHook( void )
        to query the size of free heap space that remains (although it does not\r
        provide information on how the remaining heap might be fragmented). */\r
        taskDISABLE_INTERRUPTS();\r
-//     __asm volatile( "ebreak" );\r
        for( ;; );\r
 }\r
 /*-----------------------------------------------------------*/\r
@@ -126,7 +150,6 @@ void vApplicationStackOverflowHook( TaskHandle_t pxTask, char *pcTaskName )
        configCHECK_FOR_STACK_OVERFLOW is defined to 1 or 2.  This hook\r
        function is called if a stack overflow is detected. */\r
        taskDISABLE_INTERRUPTS();\r
-//     __asm volatile( "ebreak" );\r
        for( ;; );\r
 }\r
 /*-----------------------------------------------------------*/\r
@@ -148,7 +171,6 @@ void vAssertCalled( void )
 volatile uint32_t ulSetTo1ToExitFunction = 0;\r
 \r
        taskDISABLE_INTERRUPTS();\r
-//     __asm volatile( "ebreak" );\r
        while( ulSetTo1ToExitFunction != 1 )\r
        {\r
                __asm volatile( "NOP" );\r