xref: /rk3399_ARM-atf/docs/design/cpu-specific-build-macros.rst (revision 95fe195d53c8f6e83f3b88594ac4bc5952f4634e)
140d553cfSPaul BeesleyArm CPU Specific Build Macros
240d553cfSPaul Beesley=============================
340d553cfSPaul Beesley
440d553cfSPaul BeesleyThis document describes the various build options present in the CPU specific
540d553cfSPaul Beesleyoperations framework to enable errata workarounds and to enable optimizations
640d553cfSPaul Beesleyfor a specific CPU on a platform.
740d553cfSPaul Beesley
840d553cfSPaul BeesleySecurity Vulnerability Workarounds
940d553cfSPaul Beesley----------------------------------
1040d553cfSPaul Beesley
1140d553cfSPaul BeesleyTF-A exports a series of build flags which control which security
1240d553cfSPaul Beesleyvulnerability workarounds should be applied at runtime.
1340d553cfSPaul Beesley
1440d553cfSPaul Beesley-  ``WORKAROUND_CVE_2017_5715``: Enables the security workaround for
1540d553cfSPaul Beesley   `CVE-2017-5715`_. This flag can be set to 0 by the platform if none
1640d553cfSPaul Beesley   of the PEs in the system need the workaround. Setting this flag to 0 provides
1740d553cfSPaul Beesley   no performance benefit for non-affected platforms, it just helps to comply
1840d553cfSPaul Beesley   with the recommendation in the spec regarding workaround discovery.
1940d553cfSPaul Beesley   Defaults to 1.
2040d553cfSPaul Beesley
2140d553cfSPaul Beesley-  ``WORKAROUND_CVE_2018_3639``: Enables the security workaround for
2240d553cfSPaul Beesley   `CVE-2018-3639`_. Defaults to 1. The TF-A project recommends to keep
2340d553cfSPaul Beesley   the default value of 1 even on platforms that are unaffected by
2440d553cfSPaul Beesley   CVE-2018-3639, in order to comply with the recommendation in the spec
2540d553cfSPaul Beesley   regarding workaround discovery.
2640d553cfSPaul Beesley
2740d553cfSPaul Beesley-  ``DYNAMIC_WORKAROUND_CVE_2018_3639``: Enables dynamic mitigation for
2840d553cfSPaul Beesley   `CVE-2018-3639`_. This build option should be set to 1 if the target
2940d553cfSPaul Beesley   platform contains at least 1 CPU that requires dynamic mitigation.
3040d553cfSPaul Beesley   Defaults to 0.
3140d553cfSPaul Beesley
3234760951SPaul Beesley.. _arm_cpu_macros_errata_workarounds:
3334760951SPaul Beesley
3440d553cfSPaul BeesleyCPU Errata Workarounds
3540d553cfSPaul Beesley----------------------
3640d553cfSPaul Beesley
3740d553cfSPaul BeesleyTF-A exports a series of build flags which control the errata workarounds that
3840d553cfSPaul Beesleyare applied to each CPU by the reset handler. The errata details can be found
3940d553cfSPaul Beesleyin the CPU specific errata documents published by Arm:
4040d553cfSPaul Beesley
4140d553cfSPaul Beesley-  `Cortex-A53 MPCore Software Developers Errata Notice`_
4240d553cfSPaul Beesley-  `Cortex-A57 MPCore Software Developers Errata Notice`_
4340d553cfSPaul Beesley-  `Cortex-A72 MPCore Software Developers Errata Notice`_
4440d553cfSPaul Beesley
4540d553cfSPaul BeesleyThe errata workarounds are implemented for a particular revision or a set of
4640d553cfSPaul Beesleyprocessor revisions. This is checked by the reset handler at runtime. Each
4740d553cfSPaul Beesleyerrata workaround is identified by its ``ID`` as specified in the processor's
4840d553cfSPaul Beesleyerrata notice document. The format of the define used to enable/disable the
4940d553cfSPaul Beesleyerrata workaround is ``ERRATA_<Processor name>_<ID>``, where the ``Processor name``
5040d553cfSPaul Beesleyis for example ``A57`` for the ``Cortex_A57`` CPU.
5140d553cfSPaul Beesley
5234760951SPaul BeesleyRefer to :ref:`firmware_design_cpu_errata_reporting` for information on how to
5334760951SPaul Beesleywrite errata workaround functions.
5440d553cfSPaul Beesley
5540d553cfSPaul BeesleyAll workarounds are disabled by default. The platform is responsible for
5640d553cfSPaul Beesleyenabling these workarounds according to its requirement by defining the
5740d553cfSPaul Beesleyerrata workaround build flags in the platform specific makefile. In case
5840d553cfSPaul Beesleythese workarounds are enabled for the wrong CPU revision then the errata
5940d553cfSPaul Beesleyworkaround is not applied. In the DEBUG build, this is indicated by
6040d553cfSPaul Beesleyprinting a warning to the crash console.
6140d553cfSPaul Beesley
6240d553cfSPaul BeesleyIn the current implementation, a platform which has more than 1 variant
6340d553cfSPaul Beesleywith different revisions of a processor has no runtime mechanism available
6440d553cfSPaul Beesleyfor it to specify which errata workarounds should be enabled or not.
6540d553cfSPaul Beesley
6640d553cfSPaul BeesleyThe value of the build flags is 0 by default, that is, disabled. A value of 1
6740d553cfSPaul Beesleywill enable it.
6840d553cfSPaul Beesley
6940d553cfSPaul BeesleyFor Cortex-A9, the following errata build flags are defined :
7040d553cfSPaul Beesley
7140d553cfSPaul Beesley-  ``ERRATA_A9_794073``: This applies errata 794073 workaround to Cortex-A9
7240d553cfSPaul Beesley   CPU. This needs to be enabled for all revisions of the CPU.
7340d553cfSPaul Beesley
7440d553cfSPaul BeesleyFor Cortex-A15, the following errata build flags are defined :
7540d553cfSPaul Beesley
7640d553cfSPaul Beesley-  ``ERRATA_A15_816470``: This applies errata 816470 workaround to Cortex-A15
7740d553cfSPaul Beesley   CPU. This needs to be enabled only for revision >= r3p0 of the CPU.
7840d553cfSPaul Beesley
7940d553cfSPaul Beesley-  ``ERRATA_A15_827671``: This applies errata 827671 workaround to Cortex-A15
8040d553cfSPaul Beesley   CPU. This needs to be enabled only for revision >= r3p0 of the CPU.
8140d553cfSPaul Beesley
8240d553cfSPaul BeesleyFor Cortex-A17, the following errata build flags are defined :
8340d553cfSPaul Beesley
8440d553cfSPaul Beesley-  ``ERRATA_A17_852421``: This applies errata 852421 workaround to Cortex-A17
8540d553cfSPaul Beesley   CPU. This needs to be enabled only for revision <= r1p2 of the CPU.
8640d553cfSPaul Beesley
8740d553cfSPaul Beesley-  ``ERRATA_A17_852423``: This applies errata 852423 workaround to Cortex-A17
8840d553cfSPaul Beesley   CPU. This needs to be enabled only for revision <= r1p2 of the CPU.
8940d553cfSPaul Beesley
9040d553cfSPaul BeesleyFor Cortex-A35, the following errata build flags are defined :
9140d553cfSPaul Beesley
9240d553cfSPaul Beesley-  ``ERRATA_A35_855472``: This applies errata 855472 workaround to Cortex-A35
9340d553cfSPaul Beesley   CPUs. This needs to be enabled only for revision r0p0 of Cortex-A35.
9440d553cfSPaul Beesley
9540d553cfSPaul BeesleyFor Cortex-A53, the following errata build flags are defined :
9640d553cfSPaul Beesley
9740d553cfSPaul Beesley-  ``ERRATA_A53_819472``: This applies errata 819472 workaround to all
9840d553cfSPaul Beesley   CPUs. This needs to be enabled only for revision <= r0p1 of Cortex-A53.
9940d553cfSPaul Beesley
10040d553cfSPaul Beesley-  ``ERRATA_A53_824069``: This applies errata 824069 workaround to all
10140d553cfSPaul Beesley   CPUs. This needs to be enabled only for revision <= r0p2 of Cortex-A53.
10240d553cfSPaul Beesley
10340d553cfSPaul Beesley-  ``ERRATA_A53_826319``: This applies errata 826319 workaround to Cortex-A53
10440d553cfSPaul Beesley   CPU. This needs to be enabled only for revision <= r0p2 of the CPU.
10540d553cfSPaul Beesley
10640d553cfSPaul Beesley-  ``ERRATA_A53_827319``: This applies errata 827319 workaround to all
10740d553cfSPaul Beesley   CPUs. This needs to be enabled only for revision <= r0p2 of Cortex-A53.
10840d553cfSPaul Beesley
10940d553cfSPaul Beesley-  ``ERRATA_A53_835769``: This applies erratum 835769 workaround at compile and
11040d553cfSPaul Beesley   link time to Cortex-A53 CPU. This needs to be enabled for some variants of
11140d553cfSPaul Beesley   revision <= r0p4. This workaround can lead the linker to create ``*.stub``
11240d553cfSPaul Beesley   sections.
11340d553cfSPaul Beesley
11440d553cfSPaul Beesley-  ``ERRATA_A53_836870``: This applies errata 836870 workaround to Cortex-A53
11540d553cfSPaul Beesley   CPU. This needs to be enabled only for revision <= r0p3 of the CPU. From
11640d553cfSPaul Beesley   r0p4 and onwards, this errata is enabled by default in hardware.
11740d553cfSPaul Beesley
11840d553cfSPaul Beesley-  ``ERRATA_A53_843419``: This applies erratum 843419 workaround at link time
11940d553cfSPaul Beesley   to Cortex-A53 CPU.  This needs to be enabled for some variants of revision
12040d553cfSPaul Beesley   <= r0p4. This workaround can lead the linker to emit ``*.stub`` sections
12140d553cfSPaul Beesley   which are 4kB aligned.
12240d553cfSPaul Beesley
12340d553cfSPaul Beesley-  ``ERRATA_A53_855873``: This applies errata 855873 workaround to Cortex-A53
12440d553cfSPaul Beesley   CPUs. Though the erratum is present in every revision of the CPU,
12540d553cfSPaul Beesley   this workaround is only applied to CPUs from r0p3 onwards, which feature
12640d553cfSPaul Beesley   a chicken bit in CPUACTLR_EL1 to enable a hardware workaround.
12740d553cfSPaul Beesley   Earlier revisions of the CPU have other errata which require the same
12840d553cfSPaul Beesley   workaround in software, so they should be covered anyway.
12940d553cfSPaul Beesley
130e008a29aSManish V Badarkhe-  ``ERRATA_A53_1530924``: This applies errata 1530924 workaround to all
131e008a29aSManish V Badarkhe   revisions of Cortex-A53 CPU.
132e008a29aSManish V Badarkhe
13340d553cfSPaul BeesleyFor Cortex-A55, the following errata build flags are defined :
13440d553cfSPaul Beesley
13540d553cfSPaul Beesley-  ``ERRATA_A55_768277``: This applies errata 768277 workaround to Cortex-A55
13640d553cfSPaul Beesley   CPU. This needs to be enabled only for revision r0p0 of the CPU.
13740d553cfSPaul Beesley
13840d553cfSPaul Beesley-  ``ERRATA_A55_778703``: This applies errata 778703 workaround to Cortex-A55
13940d553cfSPaul Beesley   CPU. This needs to be enabled only for revision r0p0 of the CPU.
14040d553cfSPaul Beesley
14140d553cfSPaul Beesley-  ``ERRATA_A55_798797``: This applies errata 798797 workaround to Cortex-A55
14240d553cfSPaul Beesley   CPU. This needs to be enabled only for revision r0p0 of the CPU.
14340d553cfSPaul Beesley
14440d553cfSPaul Beesley-  ``ERRATA_A55_846532``: This applies errata 846532 workaround to Cortex-A55
14540d553cfSPaul Beesley   CPU. This needs to be enabled only for revision <= r0p1 of the CPU.
14640d553cfSPaul Beesley
14740d553cfSPaul Beesley-  ``ERRATA_A55_903758``: This applies errata 903758 workaround to Cortex-A55
14840d553cfSPaul Beesley   CPU. This needs to be enabled only for revision <= r0p1 of the CPU.
14940d553cfSPaul Beesley
1509af07df0SAmbroise Vincent-  ``ERRATA_A55_1221012``: This applies errata 1221012 workaround to Cortex-A55
1519af07df0SAmbroise Vincent   CPU. This needs to be enabled only for revision <= r1p0 of the CPU.
1529af07df0SAmbroise Vincent
153e008a29aSManish V Badarkhe-  ``ERRATA_A55_1530923``: This applies errata 1530923 workaround to all
154e008a29aSManish V Badarkhe   revisions of Cortex-A55 CPU.
155e008a29aSManish V Badarkhe
15640d553cfSPaul BeesleyFor Cortex-A57, the following errata build flags are defined :
15740d553cfSPaul Beesley
15840d553cfSPaul Beesley-  ``ERRATA_A57_806969``: This applies errata 806969 workaround to Cortex-A57
15940d553cfSPaul Beesley   CPU. This needs to be enabled only for revision r0p0 of the CPU.
16040d553cfSPaul Beesley
16140d553cfSPaul Beesley-  ``ERRATA_A57_813419``: This applies errata 813419 workaround to Cortex-A57
16240d553cfSPaul Beesley   CPU. This needs to be enabled only for revision r0p0 of the CPU.
16340d553cfSPaul Beesley
16440d553cfSPaul Beesley-  ``ERRATA_A57_813420``: This applies errata 813420 workaround to Cortex-A57
16540d553cfSPaul Beesley   CPU. This needs to be enabled only for revision r0p0 of the CPU.
16640d553cfSPaul Beesley
16740d553cfSPaul Beesley-  ``ERRATA_A57_814670``: This applies errata 814670 workaround to Cortex-A57
16840d553cfSPaul Beesley   CPU. This needs to be enabled only for revision r0p0 of the CPU.
16940d553cfSPaul Beesley
17040d553cfSPaul Beesley-  ``ERRATA_A57_817169``: This applies errata 817169 workaround to Cortex-A57
17140d553cfSPaul Beesley   CPU. This needs to be enabled only for revision <= r0p1 of the CPU.
17240d553cfSPaul Beesley
17340d553cfSPaul Beesley-  ``ERRATA_A57_826974``: This applies errata 826974 workaround to Cortex-A57
17440d553cfSPaul Beesley   CPU. This needs to be enabled only for revision <= r1p1 of the CPU.
17540d553cfSPaul Beesley
17640d553cfSPaul Beesley-  ``ERRATA_A57_826977``: This applies errata 826977 workaround to Cortex-A57
17740d553cfSPaul Beesley   CPU. This needs to be enabled only for revision <= r1p1 of the CPU.
17840d553cfSPaul Beesley
17940d553cfSPaul Beesley-  ``ERRATA_A57_828024``: This applies errata 828024 workaround to Cortex-A57
18040d553cfSPaul Beesley   CPU. This needs to be enabled only for revision <= r1p1 of the CPU.
18140d553cfSPaul Beesley
18240d553cfSPaul Beesley-  ``ERRATA_A57_829520``: This applies errata 829520 workaround to Cortex-A57
18340d553cfSPaul Beesley   CPU. This needs to be enabled only for revision <= r1p2 of the CPU.
18440d553cfSPaul Beesley
18540d553cfSPaul Beesley-  ``ERRATA_A57_833471``: This applies errata 833471 workaround to Cortex-A57
18640d553cfSPaul Beesley   CPU. This needs to be enabled only for revision <= r1p2 of the CPU.
18740d553cfSPaul Beesley
18840d553cfSPaul Beesley-  ``ERRATA_A57_859972``: This applies errata 859972 workaround to Cortex-A57
18940d553cfSPaul Beesley   CPU. This needs to be enabled only for revision <= r1p3 of the CPU.
19040d553cfSPaul Beesley
191e008a29aSManish V Badarkhe-  ``ERRATA_A57_1319537``: This applies errata 1319537 workaround to all
192e008a29aSManish V Badarkhe   revisions of Cortex-A57 CPU.
19340d553cfSPaul Beesley
19440d553cfSPaul BeesleyFor Cortex-A72, the following errata build flags are defined :
19540d553cfSPaul Beesley
19640d553cfSPaul Beesley-  ``ERRATA_A72_859971``: This applies errata 859971 workaround to Cortex-A72
19740d553cfSPaul Beesley   CPU. This needs to be enabled only for revision <= r0p3 of the CPU.
19840d553cfSPaul Beesley
199e008a29aSManish V Badarkhe-  ``ERRATA_A72_1319367``: This applies errata 1319367 workaround to all
200e008a29aSManish V Badarkhe   revisions of Cortex-A72 CPU.
201e008a29aSManish V Badarkhe
20240d553cfSPaul BeesleyFor Cortex-A73, the following errata build flags are defined :
20340d553cfSPaul Beesley
20440d553cfSPaul Beesley-  ``ERRATA_A73_852427``: This applies errata 852427 workaround to Cortex-A73
20540d553cfSPaul Beesley   CPU. This needs to be enabled only for revision r0p0 of the CPU.
20640d553cfSPaul Beesley
20740d553cfSPaul Beesley-  ``ERRATA_A73_855423``: This applies errata 855423 workaround to Cortex-A73
20840d553cfSPaul Beesley   CPU. This needs to be enabled only for revision <= r0p1 of the CPU.
20940d553cfSPaul Beesley
21040d553cfSPaul BeesleyFor Cortex-A75, the following errata build flags are defined :
21140d553cfSPaul Beesley
21240d553cfSPaul Beesley-  ``ERRATA_A75_764081``: This applies errata 764081 workaround to Cortex-A75
21340d553cfSPaul Beesley   CPU. This needs to be enabled only for revision r0p0 of the CPU.
21440d553cfSPaul Beesley
21540d553cfSPaul Beesley-  ``ERRATA_A75_790748``: This applies errata 790748 workaround to Cortex-A75
21640d553cfSPaul Beesley    CPU. This needs to be enabled only for revision r0p0 of the CPU.
21740d553cfSPaul Beesley
21840d553cfSPaul BeesleyFor Cortex-A76, the following errata build flags are defined :
21940d553cfSPaul Beesley
22040d553cfSPaul Beesley-  ``ERRATA_A76_1073348``: This applies errata 1073348 workaround to Cortex-A76
22140d553cfSPaul Beesley   CPU. This needs to be enabled only for revision <= r1p0 of the CPU.
22240d553cfSPaul Beesley
22340d553cfSPaul Beesley-  ``ERRATA_A76_1130799``: This applies errata 1130799 workaround to Cortex-A76
22440d553cfSPaul Beesley   CPU. This needs to be enabled only for revision <= r2p0 of the CPU.
22540d553cfSPaul Beesley
22640d553cfSPaul Beesley-  ``ERRATA_A76_1220197``: This applies errata 1220197 workaround to Cortex-A76
22740d553cfSPaul Beesley   CPU. This needs to be enabled only for revision <= r2p0 of the CPU.
22840d553cfSPaul Beesley
22940d553cfSPaul Beesley-  ``ERRATA_A76_1257314``: This applies errata 1257314 workaround to Cortex-A76
23040d553cfSPaul Beesley   CPU. This needs to be enabled only for revision <= r3p0 of the CPU.
23140d553cfSPaul Beesley
23240d553cfSPaul Beesley-  ``ERRATA_A76_1262606``: This applies errata 1262606 workaround to Cortex-A76
23340d553cfSPaul Beesley   CPU. This needs to be enabled only for revision <= r3p0 of the CPU.
23440d553cfSPaul Beesley
23540d553cfSPaul Beesley-  ``ERRATA_A76_1262888``: This applies errata 1262888 workaround to Cortex-A76
23640d553cfSPaul Beesley   CPU. This needs to be enabled only for revision <= r3p0 of the CPU.
23740d553cfSPaul Beesley
23840d553cfSPaul Beesley-  ``ERRATA_A76_1275112``: This applies errata 1275112 workaround to Cortex-A76
23940d553cfSPaul Beesley   CPU. This needs to be enabled only for revision <= r3p0 of the CPU.
24040d553cfSPaul Beesley
241d7b08e69Sjohpow01-  ``ERRATA_A76_1791580``: This applies errata 1791580 workaround to Cortex-A76
242d7b08e69Sjohpow01   CPU. This needs to be enabled only for revision <= r4p0 of the CPU.
243d7b08e69Sjohpow01
244e008a29aSManish V Badarkhe-  ``ERRATA_A76_1165522``: This applies errata 1165522 workaround to all
245e008a29aSManish V Badarkhe   revisions of Cortex-A76 CPU. This errata is fixed in r3p0 but due to
246e008a29aSManish V Badarkhe   limitation of errata framework this errata is applied to all revisions
247e008a29aSManish V Badarkhe   of Cortex-A76 CPU.
248e008a29aSManish V Badarkhe
24955ff05f3Sjohpow01-  ``ERRATA_A76_1868343``: This applies errata 1868343 workaround to Cortex-A76
25055ff05f3Sjohpow01   CPU. This needs to be enabled only for revision <= r4p0 of the CPU.
25155ff05f3Sjohpow01
2523f0d8369Sjohpow01-  ``ERRATA_A76_1946160``: This applies errata 1946160 workaround to Cortex-A76
2533f0d8369Sjohpow01   CPU. This needs to be enabled only for revisions r3p0 - r4p1 of the CPU.
2543f0d8369Sjohpow01
25562bbfe82Sjohpow01For Cortex-A77, the following errata build flags are defined :
25662bbfe82Sjohpow01
257aa3efe3dSlaurenw-arm-  ``ERRATA_A77_1508412``: This applies errata 1508412 workaround to Cortex-A77
258aa3efe3dSlaurenw-arm   CPU. This needs to be enabled only for revision <= r1p0 of the CPU.
259aa3efe3dSlaurenw-arm
26035c75377Sjohpow01-  ``ERRATA_A77_1925769``: This applies errata 1925769 workaround to Cortex-A77
26135c75377Sjohpow01   CPU. This needs to be enabled only for revision <= r1p1 of the CPU.
26235c75377Sjohpow01
263a492edc4Slaurenw-arm-  ``ERRATA_A77_1946167``: This applies errata 1946167 workaround to Cortex-A77
264a492edc4Slaurenw-arm   CPU. This needs to be enabled only for revision <= r1p1 of the CPU.
265a492edc4Slaurenw-arm
2663f0bec7cSjohpow01-  ``ERRATA_A77_1791578``: This applies errata 1791578 workaround to Cortex-A77
2673f0bec7cSjohpow01   CPU. This needs to be enabled for r0p0, r1p0, and r1p1, it is still open.
2683f0bec7cSjohpow01
2693f35709cSJimmy BrissonFor Cortex-A78, the following errata build flags are defined :
27083e95524SMadhukar Pappireddy
2713f35709cSJimmy Brisson-  ``ERRATA_A78_1688305``: This applies errata 1688305 workaround to Cortex-A78
2723f35709cSJimmy Brisson   CPU. This needs to be enabled only for revision r0p0 - r1p0 of the CPU.
27383e95524SMadhukar Pappireddy
274e26c59d2Sjohpow01-  ``ERRATA_A78_1941498``: This applies errata 1941498 workaround to Cortex-A78
275e26c59d2Sjohpow01   CPU. This needs to be enabled for revisions r0p0, r1p0, and r1p1 of the CPU.
276e26c59d2Sjohpow01
2773a2710dcSjohpow01-  ``ERRATA_A78_1951500``: This applies errata 1951500 workaround to Cortex-A78
2783a2710dcSjohpow01   CPU. This needs to be enabled for revisions r1p0 and r1p1, r0p0 has the same
2793a2710dcSjohpow01   issue but there is no workaround for that revision.
2803a2710dcSjohpow01
2811a691455Sjohpow01-  ``ERRATA_A78_1821534``: This applies errata 1821534 workaround to Cortex-A78
2821a691455Sjohpow01   CPU. This needs to be enabled for revisions r0p0 and r1p0.
2831a691455Sjohpow01
28400bee997Snayanpatel-arm-  ``ERRATA_A78_1952683``: This applies errata 1952683 workaround to Cortex-A78
28500bee997Snayanpatel-arm   CPU. This needs to be enabled for revision r0p0, it is fixed in r1p0.
28600bee997Snayanpatel-arm
2878913047aSVarun WadekarFor Cortex-A78 AE, the following errata build flags are defined :
2888913047aSVarun Wadekar
28947d6f5ffSVarun Wadekar- ``ERRATA_A78_AE_1941500`` : This applies errata 1941500 workaround to Cortex-A78
29047d6f5ffSVarun Wadekar   AE CPU. This needs to be enabled for revisions r0p0 and r0p1. This erratum is
29147d6f5ffSVarun Wadekar   still open.
29247d6f5ffSVarun Wadekar
2938913047aSVarun Wadekar- ``ERRATA_A78_AE_1951502`` : This applies errata 1951502 workaround to Cortex-A78
2948913047aSVarun Wadekar  AE CPU. This needs to be enabled for revisions r0p0 and r0p1. This erratum is
2958913047aSVarun Wadekar  still open.
2968913047aSVarun Wadekar
297a601afe1Slauwal01For Neoverse N1, the following errata build flags are defined :
298a601afe1Slauwal01
299a601afe1Slauwal01-  ``ERRATA_N1_1073348``: This applies errata 1073348 workaround to Neoverse-N1
300a601afe1Slauwal01   CPU. This needs to be enabled only for revision r0p0 and r1p0 of the CPU.
301a601afe1Slauwal01
302e34606f2Slauwal01-  ``ERRATA_N1_1130799``: This applies errata 1130799 workaround to Neoverse-N1
303e34606f2Slauwal01   CPU. This needs to be enabled only for revision <= r2p0 of the CPU.
304e34606f2Slauwal01
3052017ab24Slauwal01-  ``ERRATA_N1_1165347``: This applies errata 1165347 workaround to Neoverse-N1
3062017ab24Slauwal01   CPU. This needs to be enabled only for revision <= r2p0 of the CPU.
3072017ab24Slauwal01
308ef5fa7d4Slauwal01-  ``ERRATA_N1_1207823``: This applies errata 1207823 workaround to Neoverse-N1
309ef5fa7d4Slauwal01   CPU. This needs to be enabled only for revision <= r2p0 of the CPU.
310ef5fa7d4Slauwal01
3119eceb020Slauwal01-  ``ERRATA_N1_1220197``: This applies errata 1220197 workaround to Neoverse-N1
3129eceb020Slauwal01   CPU. This needs to be enabled only for revision <= r2p0 of the CPU.
3139eceb020Slauwal01
314335b3c79Slauwal01-  ``ERRATA_N1_1257314``: This applies errata 1257314 workaround to Neoverse-N1
315335b3c79Slauwal01   CPU. This needs to be enabled only for revision <= r3p0 of the CPU.
316335b3c79Slauwal01
317411f4959Slauwal01-  ``ERRATA_N1_1262606``: This applies errata 1262606 workaround to Neoverse-N1
318411f4959Slauwal01   CPU. This needs to be enabled only for revision <= r3p0 of the CPU.
319411f4959Slauwal01
32011c48370Slauwal01-  ``ERRATA_N1_1262888``: This applies errata 1262888 workaround to Neoverse-N1
32111c48370Slauwal01   CPU. This needs to be enabled only for revision <= r3p0 of the CPU.
32211c48370Slauwal01
3234d8801feSlauwal01-  ``ERRATA_N1_1275112``: This applies errata 1275112 workaround to Neoverse-N1
3244d8801feSlauwal01   CPU. This needs to be enabled only for revision <= r3p0 of the CPU.
3254d8801feSlauwal01
3265f5d0763SAndre Przywara-  ``ERRATA_N1_1315703``: This applies errata 1315703 workaround to Neoverse-N1
3275f5d0763SAndre Przywara   CPU. This needs to be enabled only for revision <= r3p0 of the CPU.
3285f5d0763SAndre Przywara
32980942622Slaurenw-arm-  ``ERRATA_N1_1542419``: This applies errata 1542419 workaround to Neoverse-N1
33080942622Slaurenw-arm   CPU. This needs to be enabled only for revisions r3p0 - r4p0 of the CPU.
33180942622Slaurenw-arm
33261f0ffc4Sjohpow01-  ``ERRATA_N1_1868343``: This applies errata 1868343 workaround to Neoverse-N1
33361f0ffc4Sjohpow01   CPU. This needs to be enabled only for revision <= r4p0 of the CPU.
33461f0ffc4Sjohpow01
335263ee781Sjohpow01-  ``ERRATA_N1_1946160``: This applies errata 1946160 workaround to Neoverse-N1
336263ee781Sjohpow01   CPU. This needs to be enabled for revisions r3p0, r3p1, r4p0, and r4p1, for
337263ee781Sjohpow01   revisions r0p0, r1p0, and r2p0 there is no workaround.
338263ee781Sjohpow01
3399380f754Snayanpatel-armFor Neoverse N2, the following errata build flags are defined :
3409380f754Snayanpatel-arm
3419380f754Snayanpatel-arm-  ``ERRATA_N2_2002655``: This applies errata 2002655 workaround to Neoverse-N2
3429380f754Snayanpatel-arm   CPU. This needs to be enabled for revision r0p0 of the CPU, it is still open.
3439380f754Snayanpatel-arm
34433e3e925Sjohpow01For Neoverse V1, the following errata build flags are defined :
34533e3e925Sjohpow01
3464789cf66Slaurenw-arm-  ``ERRATA_V1_1774420``: This applies errata 1774420 workaround to Neoverse-V1
3474789cf66Slaurenw-arm   CPU. This needs to be enabled only for revisions r0p0 and r1p0, it is fixed
3484789cf66Slaurenw-arm   in r1p1.
3494789cf66Slaurenw-arm
35033e3e925Sjohpow01-  ``ERRATA_V1_1791573``: This applies errata 1791573 workaround to Neoverse-V1
35133e3e925Sjohpow01   CPU. This needs to be enabled only for revisions r0p0 and r1p0, it is fixed
35233e3e925Sjohpow01   in r1p1.
35333e3e925Sjohpow01
354143b1965Slaurenw-arm-  ``ERRATA_V1_1852267``: This applies errata 1852267 workaround to Neoverse-V1
355143b1965Slaurenw-arm   CPU. This needs to be enabled only for revisions r0p0 and r1p0, it is fixed
356143b1965Slaurenw-arm   in r1p1.
357143b1965Slaurenw-arm
358741dd04cSlaurenw-arm-  ``ERRATA_V1_1925756``: This applies errata 1925756 workaround to Neoverse-V1
359741dd04cSlaurenw-arm   CPU. This needs to be enabled for r0p0, r1p0, and r1p1, it is still open.
360741dd04cSlaurenw-arm
361182ce101Sjohpow01-  ``ERRATA_V1_1940577``: This applies errata 1940577 workaround to Neoverse-V1
362182ce101Sjohpow01   CPU. This needs to be enabled only for revision r1p0 and r1p1 of the
363182ce101Sjohpow01   CPU.
364182ce101Sjohpow01
3651a8804c3Sjohpow01-  ``ERRATA_V1_1966096``: This applies errata 1966096 workaround to Neoverse-V1
3661a8804c3Sjohpow01   CPU. This needs to be enabled for revisions r1p0 and r1p1 of the CPU, the
3671a8804c3Sjohpow01   issue is present in r0p0 as well but there is no workaround for that
3681a8804c3Sjohpow01   revision.  It is still open.
3691a8804c3Sjohpow01
370100d4029Sjohpow01-  ``ERRATA_V1_2139242``: This applies errata 2139242 workaround to Neoverse-V1
371100d4029Sjohpow01   CPU. This needs to be enabled for revisions r0p0, r1p0, and r1p1 of the
372100d4029Sjohpow01   CPU.  It is still open.
373100d4029Sjohpow01
374fbcf54aeSnayanpatel-armFor Cortex-A710, the following errata build flags are defined :
375fbcf54aeSnayanpatel-arm
376fbcf54aeSnayanpatel-arm-  ``ERRATA_A710_1987031``: This applies errata 1987031 workaround to
377fbcf54aeSnayanpatel-arm   Cortex-A710 CPU. This needs to be enabled only for revisions r0p0, r1p0 and
378fbcf54aeSnayanpatel-arm   r2p0 of the CPU. It is still open.
379fbcf54aeSnayanpatel-arm
380a64bcc2bSnayanpatel-arm-  ``ERRATA_A710_2081180``: This applies errata 2081180 workaround to
381a64bcc2bSnayanpatel-arm   Cortex-A710 CPU. This needs to be enabled only for revisions r0p0, r1p0 and
382a64bcc2bSnayanpatel-arm   r2p0 of the CPU. It is still open.
383a64bcc2bSnayanpatel-arm
384213afde9SBipin Ravi-  ``ERRATA_A710_2055002``: This applies errata 2055002 workaround to
385213afde9SBipin Ravi   Cortex-A710 CPU. This needs to be enabled for revisions r1p0, r2p0 of the CPU
386213afde9SBipin Ravi   and is still open.
387213afde9SBipin Ravi
388afc2ed63SBipin Ravi-  ``ERRATA_A710_2017096``: This applies errata 2017096 workaround to
389afc2ed63SBipin Ravi   Cortex-A710 CPU. This needs to be enabled for revisions r0p0, r1p0 and r2p0
390afc2ed63SBipin Ravi   of the CPU and is still open.
391afc2ed63SBipin Ravi
392*95fe195dSnayanpatel-arm-  ``ERRATA_A710_2083908``: This applies errata 2083908 workaround to
393*95fe195dSnayanpatel-arm   Cortex-A710 CPU. This needs to be enabled for revision r2p0 of the CPU and
394*95fe195dSnayanpatel-arm   is still open.
395*95fe195dSnayanpatel-arm
39665e04f27SBipin RaviFor Neoverse N2, the following errata build flags are defined :
39765e04f27SBipin Ravi
39865e04f27SBipin Ravi-  ``ERRATA_N2_2067956``: This applies errata 2067956 workaround to Neoverse-N2
39965e04f27SBipin Ravi   CPU. This needs to be enabled for revision r0p0 of the CPU and is still open.
40065e04f27SBipin Ravi
4014618b2bfSBipin Ravi-  ``ERRATA_N2_2025414``: This applies errata 2025414 workaround to Neoverse-N2
4024618b2bfSBipin Ravi   CPU. This needs to be enabled for revision r0p0 of the CPU and is still open.
4034618b2bfSBipin Ravi
4047cfae932SBipin Ravi-  ``ERRATA_N2_2189731``: This applies errata 2189731 workaround to Neoverse-N2
4051cafb08dSBipin Ravi   CPU. This needs to be enabled for revision r0p0 of the CPU and is still open.
4061cafb08dSBipin Ravi
4071cafb08dSBipin Ravi-  ``ERRATA_N2_2138956``: This applies errata 2138956 workaround to Neoverse-N2
4081cafb08dSBipin Ravi   CPU. This needs to be enabled for revision r0p0 of the CPU and is still open.
4097cfae932SBipin Ravi
41040d553cfSPaul BeesleyDSU Errata Workarounds
41140d553cfSPaul Beesley----------------------
41240d553cfSPaul Beesley
41340d553cfSPaul BeesleySimilar to CPU errata, TF-A also implements workarounds for DSU (DynamIQ
41440d553cfSPaul BeesleyShared Unit) errata. The DSU errata details can be found in the respective Arm
41540d553cfSPaul Beesleydocumentation:
41640d553cfSPaul Beesley
41740d553cfSPaul Beesley- `Arm DSU Software Developers Errata Notice`_.
41840d553cfSPaul Beesley
41940d553cfSPaul BeesleyEach erratum is identified by an ``ID``, as defined in the DSU errata notice
42040d553cfSPaul Beesleydocument. Thus, the build flags which enable/disable the errata workarounds
42140d553cfSPaul Beesleyhave the format ``ERRATA_DSU_<ID>``. The implementation and application logic
42240d553cfSPaul Beesleyof DSU errata workarounds are similar to `CPU errata workarounds`_.
42340d553cfSPaul Beesley
42440d553cfSPaul BeesleyFor DSU errata, the following build flags are defined:
42540d553cfSPaul Beesley
42640d553cfSPaul Beesley-  ``ERRATA_DSU_798953``: This applies errata 798953 workaround for the
42740d553cfSPaul Beesley   affected DSU configurations. This errata applies only for those DSUs that
42840d553cfSPaul Beesley   revision is r0p0 (on r0p1 it is fixed). However, please note that this
42940d553cfSPaul Beesley   workaround results in increased DSU power consumption on idle.
43040d553cfSPaul Beesley
43140d553cfSPaul Beesley-  ``ERRATA_DSU_936184``: This applies errata 936184 workaround for the
43240d553cfSPaul Beesley   affected DSU configurations. This errata applies only for those DSUs that
43340d553cfSPaul Beesley   contain the ACP interface **and** the DSU revision is older than r2p0 (on
43440d553cfSPaul Beesley   r2p0 it is fixed). However, please note that this workaround results in
43540d553cfSPaul Beesley   increased DSU power consumption on idle.
43640d553cfSPaul Beesley
43740d553cfSPaul BeesleyCPU Specific optimizations
43840d553cfSPaul Beesley--------------------------
43940d553cfSPaul Beesley
44040d553cfSPaul BeesleyThis section describes some of the optimizations allowed by the CPU micro
44140d553cfSPaul Beesleyarchitecture that can be enabled by the platform as desired.
44240d553cfSPaul Beesley
44340d553cfSPaul Beesley-  ``SKIP_A57_L1_FLUSH_PWR_DWN``: This flag enables an optimization in the
44440d553cfSPaul Beesley   Cortex-A57 cluster power down sequence by not flushing the Level 1 data
44540d553cfSPaul Beesley   cache. The L1 data cache and the L2 unified cache are inclusive. A flush
44640d553cfSPaul Beesley   of the L2 by set/way flushes any dirty lines from the L1 as well. This
44740d553cfSPaul Beesley   is a known safe deviation from the Cortex-A57 TRM defined power down
44840d553cfSPaul Beesley   sequence. Each Cortex-A57 based platform must make its own decision on
44940d553cfSPaul Beesley   whether to use the optimization.
45040d553cfSPaul Beesley
45140d553cfSPaul Beesley-  ``A53_DISABLE_NON_TEMPORAL_HINT``: This flag disables the cache non-temporal
45240d553cfSPaul Beesley   hint. The LDNP/STNP instructions as implemented on Cortex-A53 do not behave
45340d553cfSPaul Beesley   in a way most programmers expect, and will most probably result in a
45440d553cfSPaul Beesley   significant speed degradation to any code that employs them. The Armv8-A
45540d553cfSPaul Beesley   architecture (see Arm DDI 0487A.h, section D3.4.3) allows cores to ignore
45640d553cfSPaul Beesley   the non-temporal hint and treat LDNP/STNP as LDP/STP instead. Enabling this
45740d553cfSPaul Beesley   flag enforces this behaviour. This needs to be enabled only for revisions
45840d553cfSPaul Beesley   <= r0p3 of the CPU and is enabled by default.
45940d553cfSPaul Beesley
46040d553cfSPaul Beesley-  ``A57_DISABLE_NON_TEMPORAL_HINT``: This flag has the same behaviour as
46140d553cfSPaul Beesley   ``A53_DISABLE_NON_TEMPORAL_HINT`` but for Cortex-A57. This needs to be
46240d553cfSPaul Beesley   enabled only for revisions <= r1p2 of the CPU and is enabled by default,
46340d553cfSPaul Beesley   as recommended in section "4.7 Non-Temporal Loads/Stores" of the
46440d553cfSPaul Beesley   `Cortex-A57 Software Optimization Guide`_.
46540d553cfSPaul Beesley
466cd0ea184SVarun Wadekar- ''A57_ENABLE_NON_CACHEABLE_LOAD_FWD'': This flag enables non-cacheable
467cd0ea184SVarun Wadekar   streaming enhancement feature for Cortex-A57 CPUs. Platforms can set
468cd0ea184SVarun Wadekar   this bit only if their memory system meets the requirement that cache
469cd0ea184SVarun Wadekar   line fill requests from the Cortex-A57 processor are atomic. Each
470cd0ea184SVarun Wadekar   Cortex-A57 based platform must make its own decision on whether to use
471cd0ea184SVarun Wadekar   the optimization. This flag is disabled by default.
472cd0ea184SVarun Wadekar
47325bbbd2dSJavier Almansa Sobrino-  ``NEOVERSE_Nx_EXTERNAL_LLC``: This flag indicates that an external last
474f2d6b4eeSManish Pandey   level cache(LLC) is present in the system, and that the DataSource field
475f2d6b4eeSManish Pandey   on the master CHI interface indicates when data is returned from the LLC.
476f2d6b4eeSManish Pandey   This is used to control how the LL_CACHE* PMU events count.
47725bbbd2dSJavier Almansa Sobrino   Default value is 0 (Disabled).
478f2d6b4eeSManish Pandey
47940d553cfSPaul Beesley--------------
48040d553cfSPaul Beesley
481a492edc4Slaurenw-arm*Copyright (c) 2014-2021, Arm Limited and Contributors. All rights reserved.*
48240d553cfSPaul Beesley
48340d553cfSPaul Beesley.. _CVE-2017-5715: http://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2017-5715
48440d553cfSPaul Beesley.. _CVE-2018-3639: http://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2018-3639
48540d553cfSPaul Beesley.. _Cortex-A53 MPCore Software Developers Errata Notice: http://infocenter.arm.com/help/topic/com.arm.doc.epm048406/index.html
48640d553cfSPaul Beesley.. _Cortex-A57 MPCore Software Developers Errata Notice: http://infocenter.arm.com/help/topic/com.arm.doc.epm049219/index.html
48740d553cfSPaul Beesley.. _Cortex-A72 MPCore Software Developers Errata Notice: http://infocenter.arm.com/help/topic/com.arm.doc.epm012079/index.html
48840d553cfSPaul Beesley.. _Cortex-A57 Software Optimization Guide: http://infocenter.arm.com/help/topic/com.arm.doc.uan0015b/Cortex_A57_Software_Optimization_Guide_external.pdf
48940d553cfSPaul Beesley.. _Arm DSU Software Developers Errata Notice: http://infocenter.arm.com/help/topic/com.arm.doc.epm138168/index.html
490