docs:getting_started: Update with doc. Change-Id: I7c2ccd881ef1df913a9607c99a1b062330847b47
diff --git a/GettingStarted.md b/GettingStarted.md index 989dc5d..a9714ae 100644 --- a/GettingStarted.md +++ b/GettingStarted.md
@@ -37,7 +37,7 @@ current release branch. ```bash -repo init -u https://spacebeaker.googlesource.com/shodan/manifest -g default,internal +repo init -u https://spacebeaker.googlesource.com/shodan/manifest -g default,internal --no-use-superproject repo sync -j$(nproc) ``` @@ -154,7 +154,8 @@ ### kata/ -Operating system software for the SMC; including seL4 kernel & CAmkES framework, and custom CAmkES components that support Shodan (or maybe KataOS) applications. +Operating system software for the SMC; including seL4 kernel & CAmkES framework, +and custom CAmkES components that support Shodan (or maybe KataOS) applications. ### manifest/ @@ -178,7 +179,9 @@ #### multihart_boot_rom -Bootstrap for System Management Controller, Security Core, and Vector Core. This is the first software to run after reset; it does low-level hardware setup and starts TockOs (SC) and seL4 (SMC). +Bootstrap for System Management Controller, Security Core, and Vector Core. This +is the first software to run after reset; it does low-level hardware setup and +starts TockOs (SC) and seL4 (SMC). #### pigweed @@ -194,7 +197,8 @@ #### vec_iree -Springbok IREE application. It builds IREE runtime applications for ML models using IREE libraries and Spingbok BSP. +Springbok IREE application. It builds IREE runtime applications for ML models +using IREE libraries and Spingbok BSP. ### toolchain/ @@ -232,7 +236,9 @@ ## Running The Full Shodan System Simulation -The simulator used for Shodan is [Renode](https://renode.io/). The configuration for the Shodan system is `sim/config/shodan_all.repl`, while and starting script is in `sim/config/shodan_all.resc` +The simulator used for Shodan is [Renode](https://renode.io/). The configuration +for the Shodan system is `sim/config/shodan_all.repl`, while and starting script +is in `sim/config/shodan_all.resc` To run the full system simulation, build the default target: @@ -240,14 +246,18 @@ m ``` -After all the artifacts are bulit, the Renode simulation session automatically starts, and you should see the secured core and SMC booted +After all the artifacts are bulit, the Renode simulation session automatically +starts, and you should see the secured core and SMC booted ```bash -19:14:43.6741 [INFO] uart0: OpenTitan initialisation complete. Entering main loop -19:14:43.9188 [INFO] uart3: Booting all finished, dropped to user space -19:14:48.8965 [INFO] uart3: kata_allocator::init: start_addr 0x1c8858 size 16384 -19:14:48.9079 [INFO] uart3: kata_debug_console::run -19:14:48.9137 [INFO] uart3: kata_shell::DebugConsole::repl() +10:40:14.6784 [INFO] uart1: [output] init_kernel() +10:40:14.6807 [INFO] uart1: [output] Init local IRQ +10:40:14.6831 [INFO] uart1: [output] Bootstrapping kernel +10:40:14.6842 [INFO] uart1: [output] Initialing PLIC... +10:40:14.7028 [INFO] uart0: [output] OpenTitan initialisation complete. Entering main loop +10:40:14.7066 [INFO] uart0: [output] Woo Tock! +10:40:14.7346 [INFO] uart0: [output] Hello Tock World +10:40:15.8820 [INFO] uart1: [output] Booting all finished, dropped to user space ``` At this point, you should be able to connect to the SMC debug console. @@ -294,16 +304,16 @@ You can launch the ML workload execution by communicating through the debug console ```bash -KATA_PROMPT> test_mlexecute +KATA> test_mlexecute ``` and you should see ```bash -19:31:01.0841 [INFO] uart3: KATA_PROMPT> test_mlexecute -19:31:01.1057 [WARNING] cpu2: The debug mode now has no effect - connect a debugger, and switch to stepping mode. -19:31:01.2934 [INFO] cpu2: simprint: "INFO |simple_vec_mul finished successfully", 0 (0x0) -19:31:01.2945 [INFO] cpu2: simprint: "main returned: ", 0 (0x0) +10:41:18.3869 [INFO] uart1: [output] KATA> test_mlexecute +... +10:41:18.5931 [INFO] cpu2: simprint: "INFO |simple_vec_mul finished successfully", 0 (0x0) +10:41:18.5941 [INFO] cpu2: simprint: "main returned: ", 0 (0x0) ``` ## More Information