user-guide.md 50 KB
Newer Older
1
2
3
4
5
ARM Trusted Firmware User Guide
===============================

Contents :

6
7
8
9
10
11
12
1.  [Introduction](#1--introduction)
2.  [Host machine requirements](#2--host-machine-requirements)
3.  [Tools](#3--tools)
4.  [Building the Trusted Firmware](#4--building-the-trusted-firmware)
5.  [Obtaining the normal world software](#5--obtaining-the-normal-world-software)
6.  [Preparing the images to run on FVP](#6--preparing-the-images-to-run-on-fvp)
7.  [Running the software on FVP](#7--running-the-software-on-fvp)
13
8.  [Running the software on Juno](#8--running-the-software-on-juno)
14
15
16
17


1.  Introduction
----------------
18
This document describes how to build ARM Trusted Firmware and run it with a
19
20
21
22
tested set of other software components using defined configurations on the Juno
ARM development platform and ARM Fixed Virtual Platform (FVP) models. It is
possible to use other software components, configurations and platforms but that
is outside the scope of this document.
23

24
This document should be used in conjunction with the [Firmware Design].
25
26


27
28
2.  Host machine requirements
-----------------------------
29

30
The minimum recommended machine specification for building the software and
31
32
33
running the FVP models is a dual-core processor running at 2GHz with 12GB of
RAM.  For best performance, use a machine with a quad-core processor running at
2.6GHz with 16GB of RAM.
34

35
The software has been tested on Ubuntu 12.04.04 (64-bit).  Packages used
36
37
for building the software were installed from that distribution unless
otherwise specified.
38
39


40
41
3.  Tools
---------
42
43
44

The following tools are required to use the ARM Trusted Firmware:

45
*   `git` package to obtain source code.
46

47
*   `build-essential`, `uuid-dev` and `iasl` packages for building UEFI and the
48
    Firmware Image Package (FIP) tool.
49

50
51
52
53
*   `bc` and `ncurses-dev` packages for building Linux.

*   `device-tree-compiler` package for building the Flattened Device Tree (FDT)
    source files (`.dts` files) provided with this software.
54
55
56

*   Baremetal GNU GCC tools. Verified packages can be downloaded from [Linaro]
    [Linaro Toolchain]. The rest of this document assumes that the
57
    `gcc-linaro-aarch64-none-elf-4.9-2014.07_linux.tar.xz` tools are used.
58

59
60
        wget http://releases.linaro.org/14.07/components/toolchain/binaries/gcc-linaro-aarch64-none-elf-4.9-2014.07_linux.tar.xz
        tar -xf gcc-linaro-aarch64-none-elf-4.9-2014.07_linux.tar.xz
61

62
63
64
*   `libssl-dev` package to build the certificate generation tool when support
    for Trusted Board Boot is needed.

65
*   (Optional) For debugging, ARM [Development Studio 5 (DS-5)][DS-5] v5.21.
66
67


68
69
4.  Building the Trusted Firmware
---------------------------------
70

71
To build the Trusted Firmware images, follow these steps:
72

73
1.  Clone the ARM Trusted Firmware repository from GitHub:
74
75
76
77
78
79
80

        git clone https://github.com/ARM-software/arm-trusted-firmware.git

2.  Change to the trusted firmware directory:

        cd arm-trusted-firmware

81
3.  Set the compiler path, specify a Non-trusted Firmware image (BL3-3) and
82
    a valid platform, and then build:
83

84
85
        CROSS_COMPILE=<path-to-aarch64-gcc>/bin/aarch64-none-elf- \
        BL33=<path-to>/<bl33_image>                               \
86
        make PLAT=<platform> all fip
87

88
89
90
91
92
93
94
95
96
97
    If `PLAT` is not specified, `fvp` is assumed by default. See the "Summary of
    build options" for more information on available build options.

    The BL3-3 image corresponds to the software that is executed after switching
    to the non-secure world. UEFI can be used as the BL3-3 image. Refer to the
    "Obtaining the normal world software" section below.

    The TSP (Test Secure Payload), corresponding to the BL3-2 image, is not
    compiled in by default. Refer to the "Building the Test Secure Payload"
    section below.
98

99
    By default this produces a release version of the build. To produce a debug
100
    version instead, refer to the "Debugging options" section below.
101

102
103
104
105
    The build process creates products in a `build` directory tree, building
    the objects and binaries for each boot loader stage in separate
    sub-directories.  The following boot loader binary files are created from
    the corresponding ELF files:
106

107
108
109
    *   `build/<platform>/<build-type>/bl1.bin`
    *   `build/<platform>/<build-type>/bl2.bin`
    *   `build/<platform>/<build-type>/bl31.bin`
110

111
    where `<platform>` is the name of the chosen platform and `<build-type>` is
112
113
114
    either `debug` or `release`. A Firmare Image Package (FIP) will be created
    as part of the build. It contains all boot loader images except for
    `bl1.bin`.
115

116
    *   `build/<platform>/<build-type>/fip.bin`
117

118
119
    For more information on FIPs, see the "Firmware Image Package" section in
    the [Firmware Design].
120

121
122
4.  (Optional) Some platforms may require a BL3-0 image to boot. This image can
    be included in the FIP when building the Trusted Firmware by specifying the
123
    `BL30` build option:
124
125
126
127
128
129

        BL30=<path-to>/<bl30_image>

5.  Output binary files `bl1.bin` and `fip.bin` are both required to boot the
    system. How these files are used is platform specific. Refer to the
    platform documentation on how to use the firmware images.
130

131
6.  (Optional) Build products for a specific build variant can be removed using:
132

133
        make DEBUG=<D> PLAT=<platform> clean
134
135
136
137
138
139

    ... where `<D>` is `0` or `1`, as specified when building.

    The build tree can be removed completely using:

        make realclean
140

141
142
143
144
145
146
147
148
149
150
7.  (Optional) Path to binary for certain BL stages (BL2, BL3-1 and BL3-2) can be
    provided by specifying the BLx=<path-to>/<blx_image> where BLx is the BL stage.
    This will bypass the build of the BL component from source, but will include
    the specified binary in the final FIP image. Please note that BL3-2 will be
    included in the build, only if the `SPD` build option is specified.

    For example, specifying BL2=<path-to>/<bl2_image> in the build option, will
    skip compilation of BL2 source in trusted firmware, but include the BL2
    binary specified in the final FIP image.

151
152
153
154
155
156
157
158
159
### Summary of build options

ARM Trusted Firmware build system supports the following build options. Unless
mentioned otherwise, these options are expected to be specified at the build
command line and are not to be modified in any component makefiles. Note that
the build system doesn't track dependency for build options. Therefore, if any
of the build options are changed from a previous build, a clean build must be
performed.

160
161
#### Common build options

162
163
*   `BL30`: Path to BL3-0 image in the host file system. This image is optional.
    If a BL3-0 image is present then this option must be passed for the `fip`
164
    target.
165

166
167
168
169
170
171
172
173
174
175
176
177
178
179
*   `BL33`: Path to BL3-3 image in the host file system. This is mandatory for
    `fip` target in case the BL2 from ARM Trusted Firmware is used.

*   `BL2`: This is an optional build option which specifies the path to BL2
    image for the `fip` target. In this case, the BL2 in the ARM Trusted
    Firmware will not be built.

*   `BL31`:  This is an optional build option which specifies the path to
    BL3-1 image for the `fip` target. In this case, the BL3-1 in the ARM
    Trusted Firmware will not be built.

*   `BL32`:  This is an optional build option which specifies the path to
    BL3-2 image for the `fip` target. In this case, the BL3-2 in the ARM
    Trusted Firmware will not be built.
180

181
182
183
*   `FIP_NAME`: This is an optional build option which specifies the FIP
    filename for the `fip` target. Default is `fip.bin`.

184
185
*   `CROSS_COMPILE`: Prefix to toolchain binaries. Please refer to examples in
    this document for usage.
186
187

*   `DEBUG`: Chooses between a debug and release build. It can take either 0
188
    (release) or 1 (debug) as values. 0 is the default.
189

190
191
192
193
194
195
196
197
198
199
200
201
202
*   `LOG_LEVEL`: Chooses the log level, which controls the amount of console log
    output compiled into the build. This should be one of the following:

        0  (LOG_LEVEL_NONE)
        10 (LOG_LEVEL_NOTICE)
        20 (LOG_LEVEL_ERROR)
        30 (LOG_LEVEL_WARNING)
        40 (LOG_LEVEL_INFO)
        50 (LOG_LEVEL_VERBOSE)

    All log output up to and including the log level is compiled into the build.
    The default value is 40 in debug builds and 20 in release builds.

203
204
*   `NS_TIMER_SWITCH`: Enable save and restore for non-secure timer register
    contents upon world switch. It can take either 0 (don't save and restore) or
205
206
    1 (do save and restore). 0 is the default. An SPD may set this to 1 if it
    wants the timer registers to be saved and restored.
207

208
*   `PLAT`: Choose a platform to build ARM Trusted Firmware for. The chosen
209
210
    platform name must be subdirectory of any depth under `plat/`, and must
    contain a platform makefile named `platform.mk`.
211
212
213

*   `SPD`: Choose a Secure Payload Dispatcher component to be built into the
    Trusted Firmware. The value should be the path to the directory containing
214
215
    the SPD source, relative to `services/spd/`; the directory is expected to
    contain a makefile called `<spd-value>.mk`.
216
217

*   `V`: Verbose build. If assigned anything other than 0, the build commands
218
    are printed. Default is 0.
219

220
221
*   `ARM_GIC_ARCH`: Choice of ARM GIC architecture version used by the ARM GIC
    driver for implementing the platform GIC API. This API is used
222
    by the interrupt management framework. Default is 2 (that is, version 2.0).
223

224
225
226
227
*   `ARM_CCI_PRODUCT_ID`: Choice of ARM CCI product used by the platform. This
    is used to determine the number of valid slave interfaces available in the
    ARM CCI driver. Default is 400 (that is, CCI-400).

228
229
230
231
232
*   `IMF_READ_INTERRUPT_ID`: Boolean flag used by the interrupt management
    framework to enable passing of the interrupt id to its handler. The id is
    read using a platform GIC API. `INTR_ID_UNAVAILABLE` is passed instead if
    this option set to 0. Default is 0.

233
*   `RESET_TO_BL31`: Enable BL3-1 entrypoint as the CPU reset vector instead
234
235
236
237
    of the BL1 entrypoint. It can take the value 0 (CPU reset to BL1
    entrypoint) or 1 (CPU reset to BL3-1 entrypoint).
    The default value is 0.

238
239
240
241
*   `CRASH_REPORTING`: A non-zero value enables a console dump of processor
    register state when an unexpected exception occurs during execution of
    BL3-1. This option defaults to the value of `DEBUG` - i.e. by default
    this is only enabled for a debug build of the firmware.
242

243
244
*   `ASM_ASSERTION`: This flag determines whether the assertion checks within
    assembly source files are enabled or not. This option defaults to the
245
    value of `DEBUG` - that is, by default this is only enabled for a debug
246
247
    build of the firmware.

248
*   `TSP_INIT_ASYNC`: Choose BL3-2 initialization method as asynchronous or
249
250
    synchronous, (see "Initializing a BL3-2 Image" section in [Firmware
    Design]). It can take the value 0 (BL3-2 is initialized using
251
252
253
    synchronous method) or 1 (BL3-2 is initialized using asynchronous method).
    Default is 0.

254
255
256
257
258
259
*   `USE_COHERENT_MEM`: This flag determines whether to include the coherent
    memory region in the BL memory map or not (see "Use of Coherent memory in
    Trusted Firmware" section in [Firmware Design]). It can take the value 1
    (Coherent memory region is included) or 0 (Coherent memory region is
    excluded). Default is 1.

260
261
262
263
264
*   `TSPD_ROUTE_IRQ_TO_EL3`: A non zero value enables the routing model
    for non-secure interrupts in which they are routed to EL3 (TSPD). The
    default model (when the value is 0) is to route non-secure interrupts
    to S-EL1 (TSP).

265
266
267
*   `TRUSTED_BOARD_BOOT`: Boolean flag to include support for the Trusted Board
    Boot feature. When set to '1', BL1 and BL2 images include support to load
    and verify the certificates and images in a FIP. The default value is '0'.
268
269
    Generation and inclusion of certificates in the FIP depends upon the value
    of the `GENERATE_COT` option.
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291

*   `GENERATE_COT`: Boolean flag used to build and execute the `cert_create`
    tool to create certificates as per the Chain of Trust described in
    [Trusted Board Boot].  The build system then calls the `fip_create` tool to
    include the certificates in the FIP. Default value is '0'.

    Specify `TRUSTED_BOARD_BOOT=1` and `GENERATE_COT=1` to include support for
    the Trusted Board Boot Sequence in the BL1 and BL2 images and the FIP.

    Note that if `TRUSTED_BOARD_BOOT=0` and `GENERATE_COT=1`, the BL1 and BL2
    images will not include support for Trusted Board Boot. The FIP will still
    include the key and content certificates. This FIP can be used to verify the
    Chain of Trust on the host machine through other mechanisms.

    Note that if `TRUSTED_BOARD_BOOT=1` and `GENERATE_COT=0`, the BL1 and BL2
    images will include support for Trusted Board Boot, but the FIP will not
    include the key and content certificates, causing a boot failure.

*   `CREATE_KEYS`: This option is used when `GENERATE_COT=1`. It tells the
    certificate generation tool to create new keys in case no valid keys are
    present or specified. Allowed options are '0' or '1'. Default is '1'.

292
293
294
295
296
297
298
*   `SAVE_KEYS`: This option is used when `GENERATE_COT=1`. It tells the
    certificate generation tool to save the keys used to establish the Chain of
    Trust. Allowed options are '0' or '1'. Default is '0' (do not save).

    Note: This option depends on 'CREATE_KEYS' to be enabled. If the keys
    already exist in disk, they will be overwritten without further notice.

299
*   `ROT_KEY`: This option is used when `GENERATE_COT=1`. It specifies the
300
301
    file that contains the ROT private key in PEM format. If `SAVE_KEYS=1`, this
    file name will be used to save the key.
302
303
304

*   `TRUSTED_WORLD_KEY`: This option is used when `GENERATE_COT=1`. It
    specifies the file that contains the Trusted World private key in PEM
305
    format. If `SAVE_KEYS=1`, this file name will be used to save the key.
306
307
308

*   `NON_TRUSTED_WORLD_KEY`: This option is used when `GENERATE_COT=1`. It
    specifies the file that contains the Non-Trusted World private key in PEM
309
    format. If `SAVE_KEYS=1`, this file name will be used to save the key.
310
311

*   `BL30_KEY`: This option is used when `GENERATE_COT=1`. It specifies the
312
313
    file that contains the BL3-0 private key in PEM format. If `SAVE_KEYS=1`,
    this file name will be used to save the key.
314
315

*   `BL31_KEY`: This option is used when `GENERATE_COT=1`. It specifies the
316
317
    file that contains the BL3-1 private key in PEM format. If `SAVE_KEYS=1`,
    this file name will be used to save the key.
318
319

*   `BL32_KEY`: This option is used when `GENERATE_COT=1`. It specifies the
320
321
    file that contains the BL3-2 private key in PEM format. If `SAVE_KEYS=1`,
    this file name will be used to save the key.
322
323

*   `BL33_KEY`: This option is used when `GENERATE_COT=1`. It specifies the
324
325
    file that contains the BL3-3 private key in PEM format. If `SAVE_KEYS=1`,
    this file name will be used to save the key.
326

327
328
329
330
*   `PROGRAMMABLE_RESET_ADDRESS`: This option indicates whether the reset
    vector address can be programmed or is fixed on the platform. It can take
    either 0 (fixed) or 1 (programmable). Default is 0.

331
#### ARM development platform specific build options
332

333
*   `ARM_TSP_RAM_LOCATION`: location of the TSP binary. Options:
334
    -   `tsram` : Trusted SRAM (default option)
335
    -   `tdram` : Trusted DRAM (if available)
336
    -   `dram`  : Secure region in DRAM (configured by the TrustZone controller)
337

338
339
For a better understanding of these options, the ARM development platform memory
map is explained in the [Firmware Design].
340

341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
*   `ARM_ROTPK_LOCATION`: used when `TRUSTED_BOARD_BOOT=1`. It specifies the
    location of the ROTPK hash returned by the function `plat_get_rotpk_info()`
    for ARM platforms. Depending on the selected option, the proper private key
    must be specified using the `ROT_KEY` option when building the Trusted
    Firmware. This private key will be used by the certificate generation tool
    to sign the BL2 and Trusted Key certificates. Available options for
    `ARM_ROTPK_LOCATION` are:

    -   `regs` : return the ROTPK hash stored in the Trusted root-key storage
        registers. The private key corresponding to this ROTPK hash is not
        currently available.
    -   `devel_rsa` : return a development public key hash embedded in the BL1
        and BL2 binaries. This hash has been obtained from the RSA public key
        `arm_rotpk_rsa.der`, located in `plat/arm/board/common/rotpk`. To use
        this option, `arm_rotprivk_rsa.pem` must be specified as `ROT_KEY` when
        creating the certificates.

358
359
360
361
362
363
364
365
366
#### ARM CSS platform specific build options

*   `CSS_DETECT_PRE_1_7_0_SCP`: Boolean flag to detect SCP version
    incompatibility. Version 1.7.0 of the SCP firmware made a non-backwards
    compatible change to the MTL protocol, used for AP/SCP communication.
    Trusted Firmware no longer supports earlier SCP versions. If this option is
    set to 1 then Trusted Firmware will detect if an earlier version is in use.
    Default is 1.

367

368
369
370
371
372
373
374
375
376
377
378
379
380
381
### Creating a Firmware Image Package

FIPs are automatically created as part of the build instructions described in
the previous section. It is also possible to independently build the FIP
creation tool and FIPs if required. To do this, follow these steps:

Build the tool:

    make -C tools/fip_create

It is recommended to remove the build artifacts before rebuilding:

    make -C tools/fip_create clean

382
Create a Firmware package that contains existing BL2 and BL3-1 images:
383
384
385
386

    # fip_create --help to print usage information
    # fip_create <fip_name> <images to add> [--dump to show result]
    ./tools/fip_create/fip_create fip.bin --dump \
387
       --bl2 build/<platform>/debug/bl2.bin --bl31 build/<platform>/debug/bl31.bin
388
389
390
391

     Firmware Image Package ToC:
    ---------------------------
    - Trusted Boot Firmware BL2: offset=0x88, size=0x81E8
392
      file: 'build/<platform>/debug/bl2.bin'
393
    - EL3 Runtime Firmware BL3-1: offset=0x8270, size=0xC218
394
      file: 'build/<platform>/debug/bl31.bin'
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
    ---------------------------
    Creating "fip.bin"

View the contents of an existing Firmware package:

    ./tools/fip_create/fip_create fip.bin --dump

     Firmware Image Package ToC:
    ---------------------------
    - Trusted Boot Firmware BL2: offset=0x88, size=0x81E8
    - EL3 Runtime Firmware BL3-1: offset=0x8270, size=0xC218
    ---------------------------

Existing package entries can be individially updated:

    # Change the BL2 from Debug to Release version
    ./tools/fip_create/fip_create fip.bin --dump \
412
      --bl2 build/<platform>/release/bl2.bin
413
414
415
416

    Firmware Image Package ToC:
    ---------------------------
    - Trusted Boot Firmware BL2: offset=0x88, size=0x7240
417
      file: 'build/<platform>/release/bl2.bin'
418
419
420
421
422
423
    - EL3 Runtime Firmware BL3-1: offset=0x72C8, size=0xC218
    ---------------------------
    Updating "fip.bin"


### Debugging options
424
425
426

To compile a debug version and make the build more verbose use

427
428
    CROSS_COMPILE=<path-to-aarch64-gcc>/bin/aarch64-none-elf- \
    BL33=<path-to>/<bl33_image>                               \
429
    make PLAT=<platform> DEBUG=1 V=1 all fip
430
431
432
433
434
435
436
437
438
439
440

AArch64 GCC uses DWARF version 4 debugging symbols by default. Some tools (for
example DS-5) might not support this and may need an older version of DWARF
symbols to be emitted by GCC. This can be achieved by using the
`-gdwarf-<version>` flag, with the version being set to 2 or 3. Setting the
version to 2 is recommended for DS-5 versions older than 5.16.

When debugging logic problems it might also be useful to disable all compiler
optimizations by using `-O0`.

NOTE: Using `-O0` could cause output images to be larger and base addresses
441
442
might need to be recalculated (see the **Memory layout on ARM development
platforms** section in the [Firmware Design]).
443
444
445

Extra debug options can be passed to the build system by setting `CFLAGS`:

446
447
    CFLAGS='-O0 -gdwarf-2'                                    \
    CROSS_COMPILE=<path-to-aarch64-gcc>/bin/aarch64-none-elf- \
448
    BL33=<path-to>/<bl33_image>                               \
449
    make PLAT=<platform> DEBUG=1 V=1 all fip
450
451


452
453
454
455
456
457
458
459
460
461
462
463
### Building the Test Secure Payload

The TSP is coupled with a companion runtime service in the BL3-1 firmware,
called the TSPD. Therefore, if you intend to use the TSP, the BL3-1 image
must be recompiled as well. For more information on SPs and SPDs, see the
"Secure-EL1 Payloads and Dispatchers" section in the [Firmware Design].

First clean the Trusted Firmware build directory to get rid of any previous
BL3-1 binary. Then to build the TSP image and include it into the FIP use:

    CROSS_COMPILE=<path-to-aarch64-gcc>/bin/aarch64-none-elf- \
    BL33=<path-to>/<bl33_image>                               \
464
    make PLAT=<platform> SPD=tspd all fip
465
466
467

An additional boot loader binary file is created in the `build` directory:

468
*   `build/<platform>/<build-type>/bl32.bin`
469

470
471
472
The FIP will now contain the additional BL3-2 image. Here is an example
output from an FVP build in release mode including BL3-2 and using
FVP_AARCH64_EFI.fd as BL3-3 image:
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487

    Firmware Image Package ToC:
    ---------------------------
    - Trusted Boot Firmware BL2: offset=0xD8, size=0x6000
      file: './build/fvp/release/bl2.bin'
    - EL3 Runtime Firmware BL3-1: offset=0x60D8, size=0x9000
      file: './build/fvp/release/bl31.bin'
    - Secure Payload BL3-2 (Trusted OS): offset=0xF0D8, size=0x3000
      file: './build/fvp/release/bl32.bin'
    - Non-Trusted Firmware BL3-3: offset=0x120D8, size=0x280000
      file: '../FVP_AARCH64_EFI.fd'
    ---------------------------
    Creating "build/fvp/release/fip.bin"


488
489
490
491
492
### Building the Certificate Generation Tool

The `cert_create` tool can be built separately through the following commands:

    $ cd tools/cert_create
493
    $ make PLAT=<platform> [DEBUG=1] [V=1]
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509

`DEBUG=1` builds the tool in debug mode. `V=1` makes the build process more
verbose. The following command should be used to obtain help about the tool:

    $ ./cert_create -h

The `cert_create` tool is automatically built with the `fip` target when
`GENERATE_COT=1`.


### Building a FIP image with support for Trusted Board Boot

The Trusted Board Boot feature is described in [Trusted Board Boot]. The
following steps should be followed to build a FIP image with support for this
feature.

510
511
512
1.  Fulfill the dependencies of the `mbedtls` cryptographic and image parser
    modules by checking out the tag `mbedtls-1.3.11` from the
    [mbedTLS Repository].
513

514
515
516
517
    The `drivers/auth/mbedtls/mbedtls_*.mk` files contain the list of mbedTLS
    source files the modules depend upon.
    `include/drivers/auth/mbedtls/mbedtls_config.h` contains the configuration
    options required to build the mbedTLS sources.
518

519
520
    Note that the mbedTLS library is licensed under the GNU GPL version 2
    or later license. Using mbedTLS source code will affect the licensing of
521
522
523
524
525
    Trusted Firmware binaries that are built using this library.

2.  Ensure that the following command line variables are set while invoking
    `make` to build Trusted Firmware:

526
    *   `MBEDTLS_DIR=<path of the directory containing mbedTLS sources>`
527
528
529
    *   `TRUSTED_BOARD_BOOT=1`
    *   `GENERATE_COT=1`

530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
    In the case of ARM platforms, the location of the ROTPK hash must also be
    specified at build time. Two locations are currently supported (see
    `ARM_ROTPK_LOCATION` build option):

    *   `ARM_ROTPK_LOCATION=regs`: the ROTPK hash is obtained from the Trusted
        root-key storage registers present in the platform. On Juno, this
        registers are read-only. On FVP Base and Cortex models, the registers
        are read-only, but the value can be specified using the command line
        option `bp.trusted_key_storage.public_key` when launching the model.
        On both Juno and FVP models, the default value corresponds to an
        ECDSA-SECP256R1 public key hash, whose private part is not currently
        available.

    *   `ARM_ROTPK_LOCATION=devel_rsa`: use the ROTPK hash that is hardcoded
        in the ARM platform port. The private/public RSA key pair may be
        found in `plat/arm/board/common/rotpk`.

    Example of command line using RSA development keys:

        CROSS_COMPILE=<path-to-aarch64-gcc>/bin/aarch64-none-elf-       \
        BL33=<path-to>/<bl33_image>                                     \
        MBEDTLS_DIR=<path of the directory containing mbedTLS sources>  \
        make PLAT=<platform> TRUSTED_BOARD_BOOT=1 GENERATE_COT=1        \
        ARM_ROTPK_LOCATION=devel_rsa                                    \
        ROT_KEY=plat/arm/board/common/rotpk/arm_rotprivk_rsa.pem        \
        all fip

    The result of this build will be the bl1.bin and the fip.bin binaries, with
    the difference that the FIP will include the certificates corresponding to
    the Chain of Trust described in the TBBR-client document. These certificates
    can also be found in the output build directory.

562

563
### Checking source code style
564
565
566

When making changes to the source for submission to the project, the source
must be in compliance with the Linux style guide, and to assist with this check
567
568
the project Makefile contains two targets, which both utilise the
`checkpatch.pl` script that ships with the Linux source tree.
569

570
571
572
To check the entire source tree, you must first download a copy of
`checkpatch.pl` (or the full Linux source), set the `CHECKPATCH` environment
variable to point to the script and build the target checkcodebase:
573

574
    make CHECKPATCH=<path-to-linux>/linux/scripts/checkpatch.pl checkcodebase
575
576
577
578

To just check the style on the files that differ between your local branch and
the remote master, use:

579
    make CHECKPATCH=<path-to-linux>/linux/scripts/checkpatch.pl checkpatch
580
581

If you wish to check your patch against something other than the remote master,
582
583
set the `BASE_COMMIT` variable to your desired branch. By default, `BASE_COMMIT`
is set to `origin/master`.
584
585


586
587
5.  Obtaining the normal world software
---------------------------------------
588

589
### Obtaining EDK2
590

591
592
593
Potentially any kind of non-trusted firmware may be used with the ARM Trusted
Firmware but the software has only been tested with the EFI Development Kit 2
(EDK2) open source implementation of the UEFI specification.
594

595
To build the software to be compatible with the Foundation and Base FVPs, or the
596
Juno platform, follow these steps:
597

598
1.  Clone the [EDK2 source code][EDK2] from GitHub:
599

600
        git clone -n https://github.com/tianocore/edk2.git
601

602
603
604
605
606
    Not all required features are available in the EDK2 mainline yet. These can
    be obtained from the ARM-software EDK2 repository instead:

        cd edk2
        git remote add -f --tags arm-software https://github.com/ARM-software/edk2.git
607
        git checkout --detach v3.0
608

609
2.  Copy build config templates to local workspace
610

611
        # in edk2/
612
        . edksetup.sh
613

614
3.  Build the EDK2 host tools
615

616
617
        make -C BaseTools clean
        make -C BaseTools
618

619
4.  Build the EDK2 software
620

621
622
623
624
625
626
627
628
629
630
631
632
    1.  Build for FVP

            GCC49_AARCH64_PREFIX=<absolute-path-to-aarch64-gcc>/bin/aarch64-none-elf- \
            make -f ArmPlatformPkg/Scripts/Makefile EDK2_ARCH=AARCH64 \
            EDK2_DSC=ArmPlatformPkg/ArmVExpressPkg/ArmVExpress-FVP-AArch64.dsc \
            EDK2_TOOLCHAIN=GCC49 EDK2_BUILD=RELEASE \
            EDK2_MACROS="-n 6 -D ARM_FOUNDATION_FVP=1"

        The EDK2 binary for use with the ARM Trusted Firmware can then be found
        here:

             Build/ArmVExpress-FVP-AArch64/RELEASE_GCC49/FV/FVP_AARCH64_EFI.fd
633

634
    2.  Build for Juno
635

636
637
638
            GCC49_AARCH64_PREFIX=<absolute-path-to-aarch64-gcc>/bin/aarch64-none-elf- \
            make -f ArmPlatformPkg/ArmJunoPkg/Makefile EDK2_ARCH=AARCH64 \
            EDK2_TOOLCHAIN=GCC49 EDK2_BUILD=RELEASE
639

640
641
        The EDK2 binary for use with the ARM Trusted Firmware can then be found
        here:
642

643
644
645
646
647
648
649
650
651
652
            Build/ArmJuno/RELEASE_GCC49/FV/BL33_AP_UEFI.fd

    The EDK2 binary should be specified as `BL33` in in the `make` command line
    when building the Trusted Firmware. See the "Building the Trusted Firmware"
    section above.

5.  (Optional) To build EDK2 in debug mode, remove `EDK2_BUILD=RELEASE` from the
    command line.

6.  (Optional) To boot Linux using a VirtioBlock file-system, the command line
653
654
    passed from EDK2 to the Linux kernel must be modified as described in the
    "Obtaining a root file-system" section below.
655

656
7.  (Optional) If legacy GICv2 locations are used, the EDK2 platform description
657
658
    must be updated. This is required as EDK2 does not support probing for the
    GIC location. To do this, first clean the EDK2 build directory.
659

660
661
662
        make -f ArmPlatformPkg/Scripts/Makefile EDK2_ARCH=AARCH64          \
        EDK2_DSC=ArmPlatformPkg/ArmVExpressPkg/ArmVExpress-FVP-AArch64.dsc \
        EDK2_TOOLCHAIN=ARMGCC clean
663

664
    Then rebuild EDK2 as described in step 3, using the following flag:
665

666
667
668
669
        -D ARM_FVP_LEGACY_GICV2_LOCATION=1

    Finally rebuild the Trusted Firmware to generate a new FIP using the
    instructions in the "Building the Trusted Firmware" section.
670

671

672
### Obtaining a Linux kernel
673

674
675
Preparing a Linux kernel for use on the FVPs can be done as follows
(GICv2 support only):
676
677
678
679
680

1.  Clone Linux:

        git clone git://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git

681
    Not all required features are available in the kernel mainline yet. These
682
    can be obtained from the ARM-software Linux repository instead:
683
684

        cd linux
685
        git remote add -f --tags arm-software https://github.com/ARM-software/linux.git
686
        git checkout --detach 1.6-Juno
687
688
689
690
691
692
693

2.  Build with the Linaro GCC tools.

        # in linux/
        make mrproper
        make ARCH=arm64 defconfig

694
695
        CROSS_COMPILE=<path-to-aarch64-gcc>/bin/aarch64-none-elf- \
        make -j6 ARCH=arm64
696

697
698
699
700
701
The compiled Linux image will now be found at `arch/arm64/boot/Image`.


6.  Preparing the images to run on FVP
--------------------------------------
702

703
### Obtaining the Flattened Device Trees
704
705

Depending on the FVP configuration and Linux configuration used, different
706
FDT files are required. FDTs for the Foundation and Base FVPs can be found in
707
the Trusted Firmware source directory under `fdts/`. The Foundation FVP has a
708
subset of the Base FVP components. For example, the Foundation FVP lacks CLCD
709
and MMC support, and has only one CPU cluster.
710
711
712
713

*   `fvp-base-gicv2-psci.dtb`

    (Default) For use with both AEMv8 and Cortex-A57-A53 Base FVPs with
714
    Base memory map configuration.
715
716
717

*   `fvp-base-gicv2legacy-psci.dtb`

718
    For use with AEMv8 Base FVP with legacy VE GIC memory map configuration.
719
720
721

*   `fvp-base-gicv3-psci.dtb`

722
723
    For use with both AEMv8 and Cortex-A57-A53 Base FVPs with Base memory map
    configuration and Linux GICv3 support.
724

725
726
727
728
729
730
731
732
733
734
735
736
737
738
*   `fvp-foundation-gicv2-psci.dtb`

    (Default) For use with Foundation FVP with Base memory map configuration.

*   `fvp-foundation-gicv2legacy-psci.dtb`

    For use with Foundation FVP with legacy VE GIC memory map configuration.

*   `fvp-foundation-gicv3-psci.dtb`

    For use with Foundation FVP with Base memory map configuration and Linux
    GICv3 support.


739
Copy the chosen FDT blob as `fdt.dtb` to the directory from which the FVP
740
is launched. Alternatively a symbolic link may be used.
741

742
743
744
745
746
### Preparing the kernel image

Copy the kernel image file `arch/arm64/boot/Image` to the directory from which
the FVP is launched. Alternatively a symbolic link may be used.

747
### Obtaining a root file-system
748
749
750
751
752

To prepare a Linaro LAMP based Open Embedded file-system, the following
instructions can be used as a guide. The file-system can be provided to Linux
via VirtioBlock or as a RAM-disk. Both methods are described below.

753
#### Prepare VirtioBlock
754
755
756
757
758

To prepare a VirtioBlock file-system, do the following:

1.  Download and unpack the disk image.

759
    NOTE: The unpacked disk image grows to 3 GiB in size.
760

761
762
        wget http://releases.linaro.org/15.03/members/arm/openembedded/aarch64/vexpress64-openembedded_lamp-armv8-gcc-4.9_20150324-715.img.gz
        gunzip vexpress64-openembedded_lamp-armv8-gcc-4.9_20150324-715.img.gz
763
764
765
766
767
768
769
770
771

2.  Make sure the Linux kernel has Virtio support enabled using
    `make ARCH=arm64 menuconfig`.

        Device Drivers  ---> Virtio drivers  ---> <*> Platform bus driver for memory mapped virtio devices
        Device Drivers  ---> [*] Block devices  --->  <*> Virtio block driver
        File systems    ---> <*> The Extended 4 (ext4) filesystem

    If some of these configurations are missing, enable them, save the kernel
772
773
    configuration, then rebuild the kernel image using the instructions
    provided in the section "Obtaining a Linux kernel".
774
775
776
777
778

3.  Change the Kernel command line to include `root=/dev/vda2`. This can either
    be done in the EDK2 boot menu or in the platform file. Editing the platform
    file and rebuilding EDK2 will make the change persist. To do this:

779
    1.  In EDK2, edit the following file:
780
781
782
783
784
785
786
787
788
789
790
791
792
793

            ArmPlatformPkg/ArmVExpressPkg/ArmVExpress-FVP-AArch64.dsc

    2.  Add `root=/dev/vda2` to:

            gArmPlatformTokenSpaceGuid.PcdDefaultBootArgument|"<Other default options>"

    3.  Remove the entry:

            gArmPlatformTokenSpaceGuid.PcdDefaultBootInitrdPath|""

    4.  Rebuild EDK2 (see "Obtaining UEFI" section above).

4.  The file-system image file should be provided to the model environment by
794
    passing it the correct command line option. In the FVPs the following
795
    option should be provided in addition to the ones described in the
796
    "Running the software on FVP" section below.
797
798
799
800

    NOTE: A symbolic link to this file cannot be used with the FVP; the path
    to the real file must be provided.

801
    On the Base FVPs:
802

803
        -C bp.virtioblockdevice.image_path="<path-to>/<file-system-image>"
804

805
    On the Foundation FVP:
806

807
        --block-device="<path-to>/<file-system-image>"
808

809
810
811
5.  Ensure that the FVP doesn't output any error messages. If the following
    error message is displayed:

812
        ERROR: BlockDevice: Failed to open "<path-to>/<file-system-image>"!
813
814
815
816
817

    then make sure the path to the file-system image in the model parameter is
    correct and that read permission is correctly set on the file-system image
    file.

818
#### Prepare RAM-disk
819

820
To prepare a RAM-disk root file-system, do the following:
821
822
823

1.  Download the file-system image:

824
        wget http://releases.linaro.org/15.03/members/arm/openembedded/aarch64/linaro-image-lamp-genericarmv8-20150323-747.rootfs.tar.gz
825
826
827
828
829
830

2.  Modify the Linaro image:

        # Prepare for use as RAM-disk. Normally use MMC, NFS or VirtioBlock.
        # Be careful, otherwise you could damage your host file-system.
        mkdir tmp; cd tmp
831
        sudo sh -c "zcat ../linaro-image-lamp-genericarmv8-20150323-747.rootfs.tar.gz | cpio -id"
832
833
834
835
836
837
        sudo ln -s sbin/init .
        sudo sh -c "echo 'devtmpfs /dev devtmpfs mode=0755,nosuid 0 0' >> etc/fstab"
        sudo sh -c "find . | cpio --quiet -H newc -o | gzip -3 -n > ../filesystem.cpio.gz"
        cd ..

3.  Copy the resultant `filesystem.cpio.gz` to the directory where the FVP is
838
    launched from. Alternatively a symbolic link may be used.
839
840


841
842
7.  Running the software on FVP
-------------------------------
843

844
This version of the ARM Trusted Firmware has been tested on the following ARM
845
846
FVPs (64-bit versions only).

847
848
849
850
851
*   `Foundation_Platform` (Version 9.1, Build 9.1.33)
*   `FVP_Base_AEMv8A-AEMv8A` (Version 6.2, Build 0.8.6202)
*   `FVP_Base_Cortex-A57x4-A53x4` (Version 6.2, Build 0.8.6202)
*   `FVP_Base_Cortex-A57x1-A53x1` (Version 6.2, Build 0.8.6202)
*   `FVP_Base_Cortex-A57x2-A53x4` (Version 6.2, Build 0.8.6202)
852
853
854

NOTE: The build numbers quoted above are those reported by launching the FVP
with the `--version` parameter.
855
856
857

NOTE: The software will not work on Version 1.0 of the Foundation FVP.
The commands below would report an `unhandled argument` error in this case.
858

859
860
NOTE: The Foundation FVP does not provide a debugger interface.

861
862
863
864
Please refer to the FVP documentation for a detailed description of the model
parameter options. A brief description of the important ones that affect the
ARM Trusted Firmware and normal world software behavior is provided below.

865
866
867
The Foundation FVP is a cut down version of the AArch64 Base FVP. It can be
downloaded for free from [ARM's website][ARM FVP website].

868
869

### Running on the Foundation FVP with reset to BL1 entrypoint
870

871
The following `Foundation_Platform` parameters should be used to boot Linux with
872
873
874
875
876
4 CPUs using the ARM Trusted Firmware.

NOTE: Using the `--block-device` parameter is not necessary if a Linux RAM-disk
file-system is used (see the "Obtaining a File-system" section above).

877
878
879
880
NOTE: The `--data="<path to FIP binary>"@0x8000000` parameter is used to load a
Firmware Image Package at the start of NOR FLASH0 (see the "Building the
Trusted Firmware" section above).

881
    <path-to>/Foundation_Platform             \
882
    --cores=4                                 \
883
    --secure-memory                           \
884
885
    --visualization                           \
    --gicv3                                   \
886
887
888
    --data="<path-to>/<bl1-binary>"@0x0       \
    --data="<path-to>/<FIP-binary>"@0x8000000 \
    --block-device="<path-to>/<file-system-image>"
889

890
891
The default use-case for the Foundation FVP is to enable the GICv3 device in
the model but use the GICv2 FDT, in order for Linux to drive the GIC in GICv2
892
893
894
895
896
emulation mode.

The memory mapped addresses `0x0` and `0x8000000` correspond to the start of
trusted ROM and NOR FLASH0 respectively.

897
### Notes regarding Base FVP configuration options
898

899
900
Please refer to these notes in the subsequent "Running on the Base FVP"
sections.
901

902
903
904
1.  The `-C bp.flashloader0.fname` parameter is used to load a Firmware Image
    Package at the start of NOR FLASH0 (see the "Building the Trusted Firmware"
    section above).
905

906
907
908
2.  Using `cache_state_modelled=1` makes booting very slow. The software will
    still work (and run much faster) without this option but this will hide any
    cache maintenance defects in the software.
909

910
911
912
3.  Using the `-C bp.virtioblockdevice.image_path` parameter is not necessary
    if a Linux RAM-disk file-system is used (see the "Obtaining a root
    file-system" section above).
913

914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
4.  Setting the `-C bp.secure_memory` parameter to `1` is only supported on
    Base FVP versions 5.4 and newer. Setting this parameter to `0` is also
    supported. The `-C bp.tzc_400.diagnostics=1` parameter is optional. It
    instructs the FVP to provide some helpful information if a secure memory
    violation occurs.

5.  This and the following notes only apply when the firmware is built with
    the `RESET_TO_BL31` option.

    The `--data="<path-to><bl31|bl32|bl33-binary>"@<base-address-of-binary>`
    parameter is used to load bootloader images into Base FVP memory (see the
    "Building the Trusted Firmware" section above). The base addresses used
    should match the image base addresses in `platform_def.h` used while linking
    the images. The BL3-2 image is only needed if BL3-1 has been built to expect
    a Secure-EL1 Payload.

6.  The `-C cluster<X>.cpu<Y>.RVBAR=@<base-address-of-bl31>` parameter, where
    X and Y are the cluster and CPU numbers respectively, is used to set the
    reset vector for each core.

7.  Changing the default value of `FVP_SHARED_DATA_LOCATION` will also require
    changing the value of
    `--data="<path-to><bl31-binary>"@<base-address-of-bl31>` and
    `-C cluster<X>.cpu<X>.RVBAR=@<base-address-of-bl31>`, to the new value of
    `BL31_BASE` in `platform_def.h`.

8.  Changing the default value of `FVP_TSP_RAM_LOCATION` will also require
    changing the value of
    `--data="<path-to><bl32-binary>"@<base-address-of-bl32>` to the new value of
    `BL32_BASE` in `platform_def.h`.
944

945
946
947
948
949
950
951
952

### Running on the AEMv8 Base FVP with reset to BL1 entrypoint

Please read "Notes regarding Base FVP configuration options" section above for
information about some of the options to run the software.

The following `FVP_Base_AEMv8A-AEMv8A` parameters should be used to boot Linux
with 8 CPUs using the ARM Trusted Firmware.
953

954
955
    <path-to>/FVP_Base_AEMv8A-AEMv8A                       \
    -C pctl.startup=0.0.0.0                                \
956
957
    -C bp.secure_memory=1                                  \
    -C bp.tzc_400.diagnostics=1                            \
958
959
960
961
962
963
    -C cluster0.NUM_CORES=4                                \
    -C cluster1.NUM_CORES=4                                \
    -C cache_state_modelled=1                              \
    -C bp.secureflashloader.fname="<path-to>/<bl1-binary>" \
    -C bp.flashloader0.fname="<path-to>/<FIP-binary>"      \
    -C bp.virtioblockdevice.image_path="<path-to>/<file-system-image>"
964

965
966
967
968
### Running on the Cortex-A57-A53 Base FVP with reset to BL1 entrypoint

Please read "Notes regarding Base FVP configuration options" section above for
information about some of the options to run the software.
969
970
971
972

The following `FVP_Base_Cortex-A57x4-A53x4` model parameters should be used to
boot Linux with 8 CPUs using the ARM Trusted Firmware.

973
974
    <path-to>/FVP_Base_Cortex-A57x4-A53x4                  \
    -C pctl.startup=0.0.0.0                                \
975
976
    -C bp.secure_memory=1                                  \
    -C bp.tzc_400.diagnostics=1                            \
977
978
979
980
    -C cache_state_modelled=1                              \
    -C bp.secureflashloader.fname="<path-to>/<bl1-binary>" \
    -C bp.flashloader0.fname="<path-to>/<FIP-binary>"      \
    -C bp.virtioblockdevice.image_path="<path-to>/<file-system-image>"
981

982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
### Running on the AEMv8 Base FVP with reset to BL3-1 entrypoint

Please read "Notes regarding Base FVP configuration options" section above for
information about some of the options to run the software.

The following `FVP_Base_AEMv8A-AEMv8A` parameters should be used to boot Linux
with 8 CPUs using the ARM Trusted Firmware.

    <path-to>/FVP_Base_AEMv8A-AEMv8A                             \
    -C pctl.startup=0.0.0.0                                      \
    -C bp.secure_memory=1                                        \
    -C bp.tzc_400.diagnostics=1                                  \
    -C cluster0.NUM_CORES=4                                      \
    -C cluster1.NUM_CORES=4                                      \
    -C cache_state_modelled=1                                    \
997
998
999
1000
1001
1002
1003
1004
1005
1006
    -C cluster0.cpu0.RVBAR=0x04023000                            \
    -C cluster0.cpu1.RVBAR=0x04023000                            \
    -C cluster0.cpu2.RVBAR=0x04023000                            \
    -C cluster0.cpu3.RVBAR=0x04023000                            \
    -C cluster1.cpu0.RVBAR=0x04023000                            \
    -C cluster1.cpu1.RVBAR=0x04023000                            \
    -C cluster1.cpu2.RVBAR=0x04023000                            \
    -C cluster1.cpu3.RVBAR=0x04023000                            \
    --data cluster0.cpu0="<path-to>/<bl31-binary>"@0x04023000    \
    --data cluster0.cpu0="<path-to>/<bl32-binary>"@0x04001000    \
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
    --data cluster0.cpu0="<path-to>/<bl33-binary>"@0x88000000    \
    -C bp.virtioblockdevice.image_path="<path-to>/<file-system-image>"

### Running on the Cortex-A57-A53 Base FVP with reset to BL3-1 entrypoint

Please read "Notes regarding Base FVP configuration options" section above for
information about some of the options to run the software.

The following `FVP_Base_Cortex-A57x4-A53x4` model parameters should be used to
boot Linux with 8 CPUs using the ARM Trusted Firmware.

    <path-to>/FVP_Base_Cortex-A57x4-A53x4                        \
    -C pctl.startup=0.0.0.0                                      \
    -C bp.secure_memory=1                                        \
    -C bp.tzc_400.diagnostics=1                                  \
    -C cache_state_modelled=1                                    \
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
    -C cluster0.cpu0.RVBARADDR=0x04023000                        \
    -C cluster0.cpu1.RVBARADDR=0x04023000                        \
    -C cluster0.cpu2.RVBARADDR=0x04023000                        \
    -C cluster0.cpu3.RVBARADDR=0x04023000                        \
    -C cluster1.cpu0.RVBARADDR=0x04023000                        \
    -C cluster1.cpu1.RVBARADDR=0x04023000                        \
    -C cluster1.cpu2.RVBARADDR=0x04023000                        \
    -C cluster1.cpu3.RVBARADDR=0x04023000                        \
    --data cluster0.cpu0="<path-to>/<bl31-binary>"@0x04023000    \
    --data cluster0.cpu0="<path-to>/<bl32-binary>"@0x04001000    \
1033
1034
1035
    --data cluster0.cpu0="<path-to>/<bl33-binary>"@0x88000000    \
    -C bp.virtioblockdevice.image_path="<path-to>/<file-system-image>"

1036
1037
1038
### Configuring the GICv2 memory map

The Base FVP models support GICv2 with the default model parameters at the
1039
1040
following addresses. The Foundation FVP also supports these addresses when
configured for GICv3 in GICv2 emulation mode.
1041
1042
1043
1044
1045
1046

    GICv2 Distributor Interface     0x2f000000
    GICv2 CPU Interface             0x2c000000
    GICv2 Virtual CPU Interface     0x2c010000
    GICv2 Hypervisor Interface      0x2c02f000

1047
The AEMv8 Base FVP can be configured to support GICv2 at addresses
1048
1049
corresponding to the legacy (Versatile Express) memory map as follows. These are
the default addresses when using the Foundation FVP in GICv2 mode.
1050
1051
1052
1053
1054
1055

    GICv2 Distributor Interface     0x2c001000
    GICv2 CPU Interface             0x2c002000
    GICv2 Virtual CPU Interface     0x2c004000
    GICv2 Hypervisor Interface      0x2c006000

1056
1057
1058
The choice of memory map is reflected in the build variant field (bits[15:12])
in the `SYS_ID` register (Offset `0x0`) in the Versatile Express System
registers memory map (`0x1c010000`).
1059
1060
1061

*   `SYS_ID.Build[15:12]`

1062
    `0x1` corresponds to the presence of the Base GIC memory map. This is the
1063
    default value on the Base FVPs.
1064
1065
1066

*   `SYS_ID.Build[15:12]`

1067
1068
1069
1070
    `0x0` corresponds to the presence of the Legacy VE GIC memory map. This is
    the default value on the Foundation FVP.

This register can be configured as described in the following sections.
1071

1072
NOTE: If the legacy VE GIC memory map is used, then the corresponding FDT and
1073
BL3-3 images should be used.
1074

1075
1076
#### Configuring AEMv8 Foundation FVP GIC for legacy VE memory map

1077
1078
The following parameters configure the Foundation FVP to use GICv2 with the
legacy VE memory map:
1079

1080
    <path-to>/Foundation_Platform             \
1081
    --cores=4                                 \
1082
    --secure-memory                           \
1083
1084
1085
1086
1087
    --visualization                           \
    --no-gicv3                                \
    --data="<path-to>/<bl1-binary>"@0x0       \
    --data="<path-to>/<FIP-binary>"@0x8000000 \
    --block-device="<path-to>/<file-system-image>"
1088
1089
1090

Explicit configuration of the `SYS_ID` register is not required.

1091
#### Configuring AEMv8 Base FVP GIC for legacy VE memory map
1092

1093
The following parameters configure the AEMv8 Base FVP to use GICv2 with the
1094
1095
legacy VE memory map. They must added to the parameters described in the
"Running on the AEMv8 Base FVP" section above:
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109

    -C cluster0.gic.GICD-offset=0x1000                  \
    -C cluster0.gic.GICC-offset=0x2000                  \
    -C cluster0.gic.GICH-offset=0x4000                  \
    -C cluster0.gic.GICH-other-CPU-offset=0x5000        \
    -C cluster0.gic.GICV-offset=0x6000                  \
    -C cluster0.gic.PERIPH-size=0x8000                  \
    -C cluster1.gic.GICD-offset=0x1000                  \
    -C cluster1.gic.GICC-offset=0x2000                  \
    -C cluster1.gic.GICH-offset=0x4000                  \
    -C cluster1.gic.GICH-other-CPU-offset=0x5000        \
    -C cluster1.gic.GICV-offset=0x6000                  \
    -C cluster1.gic.PERIPH-size=0x8000                  \
    -C gic_distributor.GICD-alias=0x2c001000            \
1110
    -C gicv3.gicv2-only=1                               \
1111
    -C bp.variant=0x0
1112

1113
1114
1115
The `bp.variant` parameter corresponds to the build variant field of the
`SYS_ID` register.  Setting this to `0x0` allows the ARM Trusted Firmware to
detect the legacy VE memory map while configuring the GIC.
1116
1117


1118
1119
8.  Running the software on Juno
--------------------------------
1120
1121
1122

### Preparing Trusted Firmware images

1123
1124
1125
1126
1127
1128
To execute the versions of software components on Juno referred to in this
document, the latest [Juno Board Recovery Image] must be installed. If you
have an earlier version installed or are unsure which version is installed,
follow the recovery image update instructions in the [Juno Software Guide]
on the [ARM Connected Community] website.

1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
Note that you must use the board recovery image provided in the Juno R1 Initial
Alpha release, even for Juno R0. This is because the Trusted Firmware now
supports the new [SCPI v1.0 final protocol][Juno SCP Protocols v1.0]
exclusively, which is not compatible with the SCP firmware provided in the
latest Juno R0 release. Although the Juno R1 Initial Alpha release is generally
not recommended for use with Juno R0 boards, it is suitable for Trusted Firmware
development.

The Juno platform requires a BL0 and a BL3-0 image to boot up. The BL0 image
contains the ROM firmware that runs on the SCP (System Control Processor),
whereas the BL3-0 image contains the SCP Runtime firmware. Both images are
embedded within the [Juno Board Recovery Image] but they can also be downloaded
directly: [Juno SCP ROM Firmware] and [Juno SCP Runtime Firmware].
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152

Rebuild the Trusted Firmware specifying the BL3-0 image. Refer to the section
"Building the Trusted Firmware". Alternatively, the FIP image can be updated
manually with the BL3-0 image:

    fip_create --dump --bl30 <path-to>/<bl30-binary> <path-to>/<FIP-binary>

### Obtaining the Flattened Device Tree

Juno's device tree blob is built along with the kernel. It is located in:

1153
    <path-to-linux>/arch/arm64/boot/dts/arm/juno.dtb
1154

1155
### Other Juno software information
1156

1157
Please refer to the [Juno Software Guide] to:
1158

1159
1160
1161
*   Deploy a root filesystem
*   Install and run the Juno binaries on the board
*   Obtain any other Juno software information
1162
1163


1164
1165
- - - - - - - - - - - - - - - - - - - - - - - - - -

1166
_Copyright (c) 2013-2015, ARM Limited and Contributors. All rights reserved._
1167
1168


1169
[Firmware Design]:  ./firmware-design.md
1170

1171
1172
1173
[ARM FVP website]:             http://www.arm.com/fvp
[ARM Connected Community]:     http://community.arm.com
[Juno Software Guide]:         http://community.arm.com/docs/DOC-8396
1174
1175
1176
1177
[Juno Board Recovery Image]:   http://community.arm.com/servlet/JiveServlet/download/10177-1-18236/board_recovery_image_0.11.3.zip
[Juno SCP ROM Firmware]:       http://community.arm.com/servlet/JiveServlet/download/10177-1-18187/bl0.bin.zip
[Juno SCP Runtime Firmware]:   http://community.arm.com/servlet/JiveServlet/download/10177-1-18193/bl30.bin.zip
[Juno SCP Protocols v1.0]:     http://community.arm.com/servlet/JiveServlet/download/8401-40-18262/DUI0922A_scp_message_interface.pdf
1178
1179
1180
[Linaro Toolchain]:            http://releases.linaro.org/14.07/components/toolchain/binaries/
[EDK2]:                        http://github.com/tianocore/edk2
[DS-5]:                        http://www.arm.com/products/tools/software-tools/ds-5/index.php
1181
[mbedTLS Repository]:          https://github.com/ARMmbed/mbedtls.git
1182
[Trusted Board Boot]:          trusted-board-boot.md