| Olivier Deprez | 5ed0bee | 2023-06-08 10:55:05 +0200 | [diff] [blame] | 1 | Building |
| J-Alves | 241c66c | 2023-10-19 13:59:29 +0100 | [diff] [blame] | 2 | ======== |
| Olivier Deprez | 5ed0bee | 2023-06-08 10:55:05 +0200 | [diff] [blame] | 3 | |
| J-Alves | 241c66c | 2023-10-19 13:59:29 +0100 | [diff] [blame] | 4 | This page assumes the :ref:`Prerequisites` have been followed to install all project dependencies. |
| Olivier Deprez | 5ed0bee | 2023-06-08 10:55:05 +0200 | [diff] [blame] | 5 | |
| J-Alves | 241c66c | 2023-10-19 13:59:29 +0100 | [diff] [blame] | 6 | Hafnium |
| 7 | ^^^^^^^ |
| Olivier Deprez | 5ed0bee | 2023-06-08 10:55:05 +0200 | [diff] [blame] | 8 | |
| 9 | By default, the Hafnium SPMC is built with clang for a few target platforms along |
| 10 | with tests. From Hafnium top level directory, simply type: |
| 11 | |
| 12 | .. code:: shell |
| 13 | |
| 14 | make |
| 15 | |
| 16 | The resulting FVP image is located in |
| 17 | `out/reference/secure_aem_v8a_fvp_vhe_clang/hafnium.bin`. |
| 18 | |
| 19 | The presence of assertions in the final build can be set using the `ENABLE_ASSERTIONS` |
| 20 | make variable, by default this is set to `true`, meaning asserts are included in the build. |
| 21 | |
| 22 | .. code:: shell |
| 23 | |
| 24 | make ENABLE_ASSERTIONS=<true|false> |
| 25 | |
| 26 | Each project in the `project` directory specifies a root configurations of the |
| 27 | build. Adding a project is the preferred way to extend support to new platforms. |
| 28 | The target project that is built is selected by the `PROJECT` make variable, the |
| 29 | default project is 'reference'. |
| 30 | |
| 31 | .. code:: shell |
| 32 | |
| 33 | make PROJECT=<project_name> |
| 34 | |
| 35 | If you wish to change the value of the make variables you may need to first use: |
| 36 | |
| 37 | .. code:: shell |
| 38 | |
| 39 | make clobber |
| 40 | |
| 41 | So the `args.gn` file will be regenerated with the new values. |
| 42 | |
| J-Alves | 241c66c | 2023-10-19 13:59:29 +0100 | [diff] [blame] | 43 | Hafnium Documentation |
| 44 | ^^^^^^^^^^^^^^^^^^^^^ |
| 45 | |
| 46 | If you have already sourced a virtual environment, Poetry will respect this and |
| 47 | install dependencies there. |
| 48 | |
| 49 | .. code:: shell |
| 50 | |
| 51 | poetry run make doc |
| 52 | |
| Olivier Deprez | 5ed0bee | 2023-06-08 10:55:05 +0200 | [diff] [blame] | 53 | -------------- |
| 54 | |
| 55 | *Copyright (c) 2023, Arm Limited. All rights reserved.* |