| Miguel Osorio | 40caa9e | 2021-05-27 21:45:20 -0700 | [diff] [blame] | 1 | --- |
| 2 | title: "OpenTitan Software Build Instructions" |
| 3 | --- |
| Miguel Young de la Sota | d258b33 | 2019-10-29 14:05:23 -0500 | [diff] [blame] | 4 | |
| Timothy Trippel | aa87069 | 2022-06-09 16:38:23 -0700 | [diff] [blame] | 5 | All OpenTitan software is built with [Bazel](https://bazel.build/). |
| Miguel Young de la Sota | 8ff30b8 | 2019-11-25 12:58:34 -0600 | [diff] [blame] | 6 | |
| Timothy Trippel | aa87069 | 2022-06-09 16:38:23 -0700 | [diff] [blame] | 7 | For example, to build and run the OpenTitan UART smoke test located in `sw/device/tests/` for Verilator, run |
| Miguel Osorio | 40caa9e | 2021-05-27 21:45:20 -0700 | [diff] [blame] | 8 | |
| Miguel Young de la Sota | 8ff30b8 | 2019-11-25 12:58:34 -0600 | [diff] [blame] | 9 | ```console |
| Timothy Trippel | aa87069 | 2022-06-09 16:38:23 -0700 | [diff] [blame] | 10 | cd "$REPO_TOP" |
| 11 | bazel test --test_output=streamed //sw/device/tests:uart_smoketest_sim_verilator |
| Miguel Young de la Sota | d258b33 | 2019-10-29 14:05:23 -0500 | [diff] [blame] | 12 | ``` |
| Miguel Young de la Sota | 8ff30b8 | 2019-11-25 12:58:34 -0600 | [diff] [blame] | 13 | |
| Timothy Trippel | aa87069 | 2022-06-09 16:38:23 -0700 | [diff] [blame] | 14 | The resulting binaries will be located under `bazel-out/`. For more information, check out [the Building Software guide]({{< relref "doc/getting_started/build_sw" >}}). |
