blob: 8bee341d222ffbc08ae56a2ca3fdc4fdf5f2357f [file] [log] [blame]
Jimmy Brissona48f5072020-04-02 15:19:16 -05001Optional modifications
2======================
3
4The following are helper functions implemented by the test framework that
5perform common platform-specific tasks. A platform may choose to override these
6definitions.
7
8Function : platform_get_stack()
9```````````````````````````````
10
11::
12
13 Argument : unsigned long
14 Return : unsigned long
15
16This function returns the base address of the memory stack that has been
17allocated for the CPU specified by MPIDR. The size of the stack allocated to
18each CPU is specified by the platform defined constant ``PLATFORM_STACK_SIZE``.
19
20Common implementation of this function is provided in
21``plat/common/aarch64/platform_mp_stack.S``.
22
23Function : tftf_platform_end()
24``````````````````````````````
25
26::
27
28 Argument : void
29 Return : void
30
31This function performs any operation required by the platform to properly finish
32the test session.
33
34The default implementation sends an EOT (End Of Transmission) character on the
35UART. This can be used to automatically shutdown the FVP models. When running on
36real hardware, the UART output may be parsed by an external tool looking for
37this character and rebooting the platform for example.
38
39Function : tftf_plat_reset()
40````````````````````````````
41
42::
43
44 Argument : void
45 Return : void
46
47This function resets the platform.
48
49The default implementation uses the ARM watchdog peripheral (`SP805`_) to
50generate a watchdog timeout interrupt. This interrupt remains deliberately
51unserviced, which eventually asserts the reset signal.
52
53--------------
54
55*Copyright (c) 2019, Arm Limited. All rights reserved.*
56
57.. _SP805: https://static.docs.arm.com/ddi0270/b/DDI0270.pdf