blob: 54b7baccc944cfbf81335b9049e62d66f92d7861 [file] [log] [blame]
Dan Handley4def07d2018-03-01 18:44:00 +00001Arm CPU Specific Build Macros
Douglas Raillard6f625742017-06-28 15:23:03 +01002=============================
3
Douglas Raillard6f625742017-06-28 15:23:03 +01004This document describes the various build options present in the CPU specific
5operations framework to enable errata workarounds and to enable optimizations
6for a specific CPU on a platform.
7
Dimitris Papastamosf62ad322017-11-30 14:53:53 +00008Security Vulnerability Workarounds
9----------------------------------
10
Dan Handley4def07d2018-03-01 18:44:00 +000011TF-A exports a series of build flags which control which security
12vulnerability workarounds should be applied at runtime.
Dimitris Papastamosf62ad322017-11-30 14:53:53 +000013
14- ``WORKAROUND_CVE_2017_5715``: Enables the security workaround for
Dimitris Papastamos59dc4ef2018-03-28 12:06:40 +010015 `CVE-2017-5715`_. This flag can be set to 0 by the platform if none
16 of the PEs in the system need the workaround. Setting this flag to 0 provides
17 no performance benefit for non-affected platforms, it just helps to comply
18 with the recommendation in the spec regarding workaround discovery.
19 Defaults to 1.
Dimitris Papastamosf62ad322017-11-30 14:53:53 +000020
Dimitris Papastamosb8a25bb2018-04-05 14:38:26 +010021- ``WORKAROUND_CVE_2018_3639``: Enables the security workaround for
22 `CVE-2018-3639`_. Defaults to 1. The TF-A project recommends to keep
23 the default value of 1 even on platforms that are unaffected by
24 CVE-2018-3639, in order to comply with the recommendation in the spec
25 regarding workaround discovery.
26
Dimitris Papastamosfe007b22018-05-16 11:36:14 +010027- ``DYNAMIC_WORKAROUND_CVE_2018_3639``: Enables dynamic mitigation for
28 `CVE-2018-3639`_. This build option should be set to 1 if the target
29 platform contains at least 1 CPU that requires dynamic mitigation.
30 Defaults to 0.
31
Paul Beesley34760952019-04-12 14:19:42 +010032.. _arm_cpu_macros_errata_workarounds:
33
Douglas Raillard6f625742017-06-28 15:23:03 +010034CPU Errata Workarounds
35----------------------
36
Dan Handley4def07d2018-03-01 18:44:00 +000037TF-A exports a series of build flags which control the errata workarounds that
38are applied to each CPU by the reset handler. The errata details can be found
39in the CPU specific errata documents published by Arm:
Douglas Raillard6f625742017-06-28 15:23:03 +010040
41- `Cortex-A53 MPCore Software Developers Errata Notice`_
42- `Cortex-A57 MPCore Software Developers Errata Notice`_
Eleanor Bonnici6de9b332017-08-02 18:33:41 +010043- `Cortex-A72 MPCore Software Developers Errata Notice`_
Douglas Raillard6f625742017-06-28 15:23:03 +010044
45The errata workarounds are implemented for a particular revision or a set of
46processor revisions. This is checked by the reset handler at runtime. Each
47errata workaround is identified by its ``ID`` as specified in the processor's
48errata notice document. The format of the define used to enable/disable the
49errata workaround is ``ERRATA_<Processor name>_<ID>``, where the ``Processor name``
50is for example ``A57`` for the ``Cortex_A57`` CPU.
51
Paul Beesley34760952019-04-12 14:19:42 +010052Refer to :ref:`firmware_design_cpu_errata_reporting` for information on how to
53write errata workaround functions.
Douglas Raillard6f625742017-06-28 15:23:03 +010054
55All workarounds are disabled by default. The platform is responsible for
56enabling these workarounds according to its requirement by defining the
57errata workaround build flags in the platform specific makefile. In case
58these workarounds are enabled for the wrong CPU revision then the errata
59workaround is not applied. In the DEBUG build, this is indicated by
60printing a warning to the crash console.
61
62In the current implementation, a platform which has more than 1 variant
63with different revisions of a processor has no runtime mechanism available
64for it to specify which errata workarounds should be enabled or not.
65
John Tsichritzis8a677182018-07-23 09:11:59 +010066The value of the build flags is 0 by default, that is, disabled. A value of 1
67will enable it.
Douglas Raillard6f625742017-06-28 15:23:03 +010068
Joel Huttondd4cf2c2019-04-10 12:52:52 +010069For Cortex-A9, the following errata build flags are defined :
70
Louis Mayencourtb4e9ab92019-04-18 12:11:25 +010071- ``ERRATA_A9_794073``: This applies errata 794073 workaround to Cortex-A9
Joel Huttondd4cf2c2019-04-10 12:52:52 +010072 CPU. This needs to be enabled for all revisions of the CPU.
73
Ambroise Vincent75a1ada2019-03-04 16:56:26 +000074For Cortex-A15, the following errata build flags are defined :
75
76- ``ERRATA_A15_816470``: This applies errata 816470 workaround to Cortex-A15
77 CPU. This needs to be enabled only for revision >= r3p0 of the CPU.
78
Ambroise Vincent5f2c6902019-03-05 09:54:21 +000079- ``ERRATA_A15_827671``: This applies errata 827671 workaround to Cortex-A15
80 CPU. This needs to be enabled only for revision >= r3p0 of the CPU.
81
Ambroise Vincent0b64c192019-02-28 16:23:53 +000082For Cortex-A17, the following errata build flags are defined :
83
84- ``ERRATA_A17_852421``: This applies errata 852421 workaround to Cortex-A17
85 CPU. This needs to be enabled only for revision <= r1p2 of the CPU.
86
Ambroise Vincentbe10dcd2019-03-04 13:20:56 +000087- ``ERRATA_A17_852423``: This applies errata 852423 workaround to Cortex-A17
88 CPU. This needs to be enabled only for revision <= r1p2 of the CPU.
89
Louis Mayencourtcba71b72019-04-05 16:25:25 +010090For Cortex-A35, the following errata build flags are defined :
91
92- ``ERRATA_A35_855472``: This applies errata 855472 workaround to Cortex-A35
93 CPUs. This needs to be enabled only for revision r0p0 of Cortex-A35.
94
John Tsichritzis8a677182018-07-23 09:11:59 +010095For Cortex-A53, the following errata build flags are defined :
Douglas Raillard6f625742017-06-28 15:23:03 +010096
Ambroise Vincentbd393702019-02-21 14:16:24 +000097- ``ERRATA_A53_819472``: This applies errata 819472 workaround to all
98 CPUs. This needs to be enabled only for revision <= r0p1 of Cortex-A53.
99
100- ``ERRATA_A53_824069``: This applies errata 824069 workaround to all
101 CPUs. This needs to be enabled only for revision <= r0p2 of Cortex-A53.
102
Douglas Raillard6f625742017-06-28 15:23:03 +0100103- ``ERRATA_A53_826319``: This applies errata 826319 workaround to Cortex-A53
104 CPU. This needs to be enabled only for revision <= r0p2 of the CPU.
105
Ambroise Vincentbd393702019-02-21 14:16:24 +0000106- ``ERRATA_A53_827319``: This applies errata 827319 workaround to all
107 CPUs. This needs to be enabled only for revision <= r0p2 of Cortex-A53.
108
Douglas Raillardca6b1cb2017-07-17 14:14:52 +0100109- ``ERRATA_A53_835769``: This applies erratum 835769 workaround at compile and
110 link time to Cortex-A53 CPU. This needs to be enabled for some variants of
111 revision <= r0p4. This workaround can lead the linker to create ``*.stub``
112 sections.
113
Douglas Raillard6f625742017-06-28 15:23:03 +0100114- ``ERRATA_A53_836870``: This applies errata 836870 workaround to Cortex-A53
115 CPU. This needs to be enabled only for revision <= r0p3 of the CPU. From
116 r0p4 and onwards, this errata is enabled by default in hardware.
117
Douglas Raillardca6b1cb2017-07-17 14:14:52 +0100118- ``ERRATA_A53_843419``: This applies erratum 843419 workaround at link time
119 to Cortex-A53 CPU. This needs to be enabled for some variants of revision
120 <= r0p4. This workaround can lead the linker to emit ``*.stub`` sections
121 which are 4kB aligned.
122
Douglas Raillard6f625742017-06-28 15:23:03 +0100123- ``ERRATA_A53_855873``: This applies errata 855873 workaround to Cortex-A53
124 CPUs. Though the erratum is present in every revision of the CPU,
125 this workaround is only applied to CPUs from r0p3 onwards, which feature
Sandrine Bailleuxf3cacad2019-02-08 15:26:36 +0100126 a chicken bit in CPUACTLR_EL1 to enable a hardware workaround.
Douglas Raillard6f625742017-06-28 15:23:03 +0100127 Earlier revisions of the CPU have other errata which require the same
128 workaround in software, so they should be covered anyway.
129
Manish V Badarkhee008a292020-07-31 08:38:49 +0100130- ``ERRATA_A53_1530924``: This applies errata 1530924 workaround to all
131 revisions of Cortex-A53 CPU.
132
Ambroise Vincent1afeee92019-02-21 16:20:43 +0000133For Cortex-A55, the following errata build flags are defined :
134
135- ``ERRATA_A55_768277``: This applies errata 768277 workaround to Cortex-A55
136 CPU. This needs to be enabled only for revision r0p0 of the CPU.
137
Ambroise Vincenta6cc6612019-02-21 16:25:37 +0000138- ``ERRATA_A55_778703``: This applies errata 778703 workaround to Cortex-A55
139 CPU. This needs to be enabled only for revision r0p0 of the CPU.
140
Ambroise Vincent6ab87d22019-02-21 16:27:34 +0000141- ``ERRATA_A55_798797``: This applies errata 798797 workaround to Cortex-A55
142 CPU. This needs to be enabled only for revision r0p0 of the CPU.
143
Ambroise Vincent6e789732019-02-21 16:29:16 +0000144- ``ERRATA_A55_846532``: This applies errata 846532 workaround to Cortex-A55
145 CPU. This needs to be enabled only for revision <= r0p1 of the CPU.
146
Ambroise Vincent47949f32019-02-21 16:29:50 +0000147- ``ERRATA_A55_903758``: This applies errata 903758 workaround to Cortex-A55
148 CPU. This needs to be enabled only for revision <= r0p1 of the CPU.
149
Ambroise Vincent9af07df2019-05-28 09:52:48 +0100150- ``ERRATA_A55_1221012``: This applies errata 1221012 workaround to Cortex-A55
151 CPU. This needs to be enabled only for revision <= r1p0 of the CPU.
152
Manish V Badarkhee008a292020-07-31 08:38:49 +0100153- ``ERRATA_A55_1530923``: This applies errata 1530923 workaround to all
154 revisions of Cortex-A55 CPU.
155
John Tsichritzis8a677182018-07-23 09:11:59 +0100156For Cortex-A57, the following errata build flags are defined :
Douglas Raillard6f625742017-06-28 15:23:03 +0100157
158- ``ERRATA_A57_806969``: This applies errata 806969 workaround to Cortex-A57
159 CPU. This needs to be enabled only for revision r0p0 of the CPU.
160
161- ``ERRATA_A57_813419``: This applies errata 813419 workaround to Cortex-A57
162 CPU. This needs to be enabled only for revision r0p0 of the CPU.
163
164- ``ERRATA_A57_813420``: This applies errata 813420 workaround to Cortex-A57
165 CPU. This needs to be enabled only for revision r0p0 of the CPU.
166
Ambroise Vincent0f6fbbd2019-02-21 16:35:07 +0000167- ``ERRATA_A57_814670``: This applies errata 814670 workaround to Cortex-A57
168 CPU. This needs to be enabled only for revision r0p0 of the CPU.
169
Ambroise Vincent5bd2c242019-02-21 16:35:49 +0000170- ``ERRATA_A57_817169``: This applies errata 817169 workaround to Cortex-A57
171 CPU. This needs to be enabled only for revision <= r0p1 of the CPU.
172
Douglas Raillard6f625742017-06-28 15:23:03 +0100173- ``ERRATA_A57_826974``: This applies errata 826974 workaround to Cortex-A57
174 CPU. This needs to be enabled only for revision <= r1p1 of the CPU.
175
176- ``ERRATA_A57_826977``: This applies errata 826977 workaround to Cortex-A57
177 CPU. This needs to be enabled only for revision <= r1p1 of the CPU.
178
179- ``ERRATA_A57_828024``: This applies errata 828024 workaround to Cortex-A57
180 CPU. This needs to be enabled only for revision <= r1p1 of the CPU.
181
182- ``ERRATA_A57_829520``: This applies errata 829520 workaround to Cortex-A57
183 CPU. This needs to be enabled only for revision <= r1p2 of the CPU.
184
185- ``ERRATA_A57_833471``: This applies errata 833471 workaround to Cortex-A57
186 CPU. This needs to be enabled only for revision <= r1p2 of the CPU.
187
Eleanor Bonnici45b52c22017-08-02 16:35:04 +0100188- ``ERRATA_A57_859972``: This applies errata 859972 workaround to Cortex-A57
189 CPU. This needs to be enabled only for revision <= r1p3 of the CPU.
190
Manish V Badarkhee008a292020-07-31 08:38:49 +0100191- ``ERRATA_A57_1319537``: This applies errata 1319537 workaround to all
192 revisions of Cortex-A57 CPU.
Eleanor Bonnici6de9b332017-08-02 18:33:41 +0100193
John Tsichritzis8a677182018-07-23 09:11:59 +0100194For Cortex-A72, the following errata build flags are defined :
Eleanor Bonnici6de9b332017-08-02 18:33:41 +0100195
196- ``ERRATA_A72_859971``: This applies errata 859971 workaround to Cortex-A72
197 CPU. This needs to be enabled only for revision <= r0p3 of the CPU.
198
Manish V Badarkhee008a292020-07-31 08:38:49 +0100199- ``ERRATA_A72_1319367``: This applies errata 1319367 workaround to all
200 revisions of Cortex-A72 CPU.
201
Louis Mayencourte6cab152019-02-21 16:38:16 +0000202For Cortex-A73, the following errata build flags are defined :
203
Louis Mayencourt25278ea2019-02-27 14:24:16 +0000204- ``ERRATA_A73_852427``: This applies errata 852427 workaround to Cortex-A73
205 CPU. This needs to be enabled only for revision r0p0 of the CPU.
206
Louis Mayencourte6cab152019-02-21 16:38:16 +0000207- ``ERRATA_A73_855423``: This applies errata 855423 workaround to Cortex-A73
208 CPU. This needs to be enabled only for revision <= r0p1 of the CPU.
209
Louis Mayencourt5f5d1ed2019-02-20 12:11:41 +0000210For Cortex-A75, the following errata build flags are defined :
211
212- ``ERRATA_A75_764081``: This applies errata 764081 workaround to Cortex-A75
213 CPU. This needs to be enabled only for revision r0p0 of the CPU.
214
Louis Mayencourt98551592019-02-25 14:57:57 +0000215- ``ERRATA_A75_790748``: This applies errata 790748 workaround to Cortex-A75
216 CPU. This needs to be enabled only for revision r0p0 of the CPU.
217
Louis Mayencourt508d7112019-02-21 17:35:07 +0000218For Cortex-A76, the following errata build flags are defined :
219
Louis Mayencourt5c6aa012019-02-25 15:17:44 +0000220- ``ERRATA_A76_1073348``: This applies errata 1073348 workaround to Cortex-A76
221 CPU. This needs to be enabled only for revision <= r1p0 of the CPU.
222
Louis Mayencourt508d7112019-02-21 17:35:07 +0000223- ``ERRATA_A76_1130799``: This applies errata 1130799 workaround to Cortex-A76
224 CPU. This needs to be enabled only for revision <= r2p0 of the CPU.
225
Louis Mayencourt5cc8c7b2019-02-25 11:37:38 +0000226- ``ERRATA_A76_1220197``: This applies errata 1220197 workaround to Cortex-A76
227 CPU. This needs to be enabled only for revision <= r2p0 of the CPU.
228
Soby Mathewe6e1d0a2019-05-01 09:43:18 +0100229- ``ERRATA_A76_1257314``: This applies errata 1257314 workaround to Cortex-A76
230 CPU. This needs to be enabled only for revision <= r3p0 of the CPU.
231
232- ``ERRATA_A76_1262606``: This applies errata 1262606 workaround to Cortex-A76
233 CPU. This needs to be enabled only for revision <= r3p0 of the CPU.
234
235- ``ERRATA_A76_1262888``: This applies errata 1262888 workaround to Cortex-A76
236 CPU. This needs to be enabled only for revision <= r3p0 of the CPU.
237
238- ``ERRATA_A76_1275112``: This applies errata 1275112 workaround to Cortex-A76
239 CPU. This needs to be enabled only for revision <= r3p0 of the CPU.
240
johpow01d7b08e62020-05-29 14:17:38 -0500241- ``ERRATA_A76_1791580``: This applies errata 1791580 workaround to Cortex-A76
242 CPU. This needs to be enabled only for revision <= r4p0 of the CPU.
243
Manish V Badarkhee008a292020-07-31 08:38:49 +0100244- ``ERRATA_A76_1165522``: This applies errata 1165522 workaround to all
245 revisions of Cortex-A76 CPU. This errata is fixed in r3p0 but due to
246 limitation of errata framework this errata is applied to all revisions
247 of Cortex-A76 CPU.
248
johpow0155ff05f2020-09-29 17:19:09 -0500249- ``ERRATA_A76_1868343``: This applies errata 1868343 workaround to Cortex-A76
250 CPU. This needs to be enabled only for revision <= r4p0 of the CPU.
251
johpow013f0d8362020-12-15 19:02:18 -0600252- ``ERRATA_A76_1946160``: This applies errata 1946160 workaround to Cortex-A76
253 CPU. This needs to be enabled only for revisions r3p0 - r4p1 of the CPU.
254
johpow0162bbfe82020-06-03 15:23:31 -0500255For Cortex-A77, the following errata build flags are defined :
256
laurenw-armaa3efe32020-07-14 14:18:34 -0500257- ``ERRATA_A77_1508412``: This applies errata 1508412 workaround to Cortex-A77
258 CPU. This needs to be enabled only for revision <= r1p0 of the CPU.
259
johpow0135c75372020-09-10 13:39:26 -0500260- ``ERRATA_A77_1925769``: This applies errata 1925769 workaround to Cortex-A77
261 CPU. This needs to be enabled only for revision <= r1p1 of the CPU.
262
laurenw-arma492edc42021-03-23 13:09:35 -0500263- ``ERRATA_A77_1946167``: This applies errata 1946167 workaround to Cortex-A77
264 CPU. This needs to be enabled only for revision <= r1p1 of the CPU.
265
johpow013f0bec72021-05-03 13:37:13 -0500266- ``ERRATA_A77_1791578``: This applies errata 1791578 workaround to Cortex-A77
267 CPU. This needs to be enabled for r0p0, r1p0, and r1p1, it is still open.
268
Jimmy Brisson3f357092020-06-01 10:18:22 -0500269For Cortex-A78, the following errata build flags are defined :
Madhukar Pappireddy83e95522019-12-18 15:56:27 -0600270
Jimmy Brisson3f357092020-06-01 10:18:22 -0500271- ``ERRATA_A78_1688305``: This applies errata 1688305 workaround to Cortex-A78
272 CPU. This needs to be enabled only for revision r0p0 - r1p0 of the CPU.
Madhukar Pappireddy83e95522019-12-18 15:56:27 -0600273
johpow01e26c59d2020-10-06 17:55:25 -0500274- ``ERRATA_A78_1941498``: This applies errata 1941498 workaround to Cortex-A78
275 CPU. This needs to be enabled for revisions r0p0, r1p0, and r1p1 of the CPU.
276
johpow013a2710d2020-10-07 15:08:01 -0500277- ``ERRATA_A78_1951500``: This applies errata 1951500 workaround to Cortex-A78
278 CPU. This needs to be enabled for revisions r1p0 and r1p1, r0p0 has the same
279 issue but there is no workaround for that revision.
280
johpow011a691452021-04-30 18:08:52 -0500281- ``ERRATA_A78_1821534``: This applies errata 1821534 workaround to Cortex-A78
282 CPU. This needs to be enabled for revisions r0p0 and r1p0.
283
nayanpatel-arm00bee992021-08-11 13:33:00 -0700284- ``ERRATA_A78_1952683``: This applies errata 1952683 workaround to Cortex-A78
285 CPU. This needs to be enabled for revision r0p0, it is fixed in r1p0.
286
nayanpatel-armb36fe212021-09-28 17:31:50 -0700287- ``ERRATA_A78_2132060``: This applies errata 2132060 workaround to Cortex-A78
288 CPU. This needs to be enabled for revisions r0p0, r1p0, r1p1, and r1p2. It
289 is still open.
290
johpow011ea91902021-09-02 17:53:30 -0500291- ``ERRATA_A78_2242635``: This applies errata 2242635 workaround to Cortex-A78
292 CPU. This needs to be enabled for revisions r1p0, r1p1, and r1p2. The issue
293 is present in r0p0 but there is no workaround. It is still open.
294
Varun Wadekar89130472021-07-27 00:39:40 -0700295For Cortex-A78 AE, the following errata build flags are defined :
296
Varun Wadekar47d6f5f2021-07-27 02:32:29 -0700297- ``ERRATA_A78_AE_1941500`` : This applies errata 1941500 workaround to Cortex-A78
298 AE CPU. This needs to be enabled for revisions r0p0 and r0p1. This erratum is
299 still open.
300
Varun Wadekar89130472021-07-27 00:39:40 -0700301- ``ERRATA_A78_AE_1951502`` : This applies errata 1951502 workaround to Cortex-A78
302 AE CPU. This needs to be enabled for revisions r0p0 and r0p1. This erratum is
303 still open.
304
lauwal01a601afe2019-06-24 11:23:50 -0500305For Neoverse N1, the following errata build flags are defined :
306
307- ``ERRATA_N1_1073348``: This applies errata 1073348 workaround to Neoverse-N1
308 CPU. This needs to be enabled only for revision r0p0 and r1p0 of the CPU.
309
lauwal01e34606f2019-06-24 11:28:34 -0500310- ``ERRATA_N1_1130799``: This applies errata 1130799 workaround to Neoverse-N1
311 CPU. This needs to be enabled only for revision <= r2p0 of the CPU.
312
lauwal012017ab22019-06-24 11:32:40 -0500313- ``ERRATA_N1_1165347``: This applies errata 1165347 workaround to Neoverse-N1
314 CPU. This needs to be enabled only for revision <= r2p0 of the CPU.
315
lauwal01ef5fa7d2019-06-24 11:35:37 -0500316- ``ERRATA_N1_1207823``: This applies errata 1207823 workaround to Neoverse-N1
317 CPU. This needs to be enabled only for revision <= r2p0 of the CPU.
318
lauwal019eceb022019-06-24 11:38:53 -0500319- ``ERRATA_N1_1220197``: This applies errata 1220197 workaround to Neoverse-N1
320 CPU. This needs to be enabled only for revision <= r2p0 of the CPU.
321
lauwal01335b3c72019-06-24 11:42:02 -0500322- ``ERRATA_N1_1257314``: This applies errata 1257314 workaround to Neoverse-N1
323 CPU. This needs to be enabled only for revision <= r3p0 of the CPU.
324
lauwal01411f4952019-06-24 11:44:58 -0500325- ``ERRATA_N1_1262606``: This applies errata 1262606 workaround to Neoverse-N1
326 CPU. This needs to be enabled only for revision <= r3p0 of the CPU.
327
lauwal0111c48372019-06-24 11:47:30 -0500328- ``ERRATA_N1_1262888``: This applies errata 1262888 workaround to Neoverse-N1
329 CPU. This needs to be enabled only for revision <= r3p0 of the CPU.
330
lauwal014d8801f2019-06-24 11:49:01 -0500331- ``ERRATA_N1_1275112``: This applies errata 1275112 workaround to Neoverse-N1
332 CPU. This needs to be enabled only for revision <= r3p0 of the CPU.
333
Andre Przywara5f5d0762019-05-20 14:57:06 +0100334- ``ERRATA_N1_1315703``: This applies errata 1315703 workaround to Neoverse-N1
335 CPU. This needs to be enabled only for revision <= r3p0 of the CPU.
336
laurenw-arm80942622019-08-20 15:51:24 -0500337- ``ERRATA_N1_1542419``: This applies errata 1542419 workaround to Neoverse-N1
338 CPU. This needs to be enabled only for revisions r3p0 - r4p0 of the CPU.
339
johpow0161f0ffc2020-08-05 12:27:12 -0500340- ``ERRATA_N1_1868343``: This applies errata 1868343 workaround to Neoverse-N1
341 CPU. This needs to be enabled only for revision <= r4p0 of the CPU.
342
johpow01263ee782020-10-07 14:33:15 -0500343- ``ERRATA_N1_1946160``: This applies errata 1946160 workaround to Neoverse-N1
344 CPU. This needs to be enabled for revisions r3p0, r3p1, r4p0, and r4p1, for
345 revisions r0p0, r1p0, and r2p0 there is no workaround.
346
johpow0133e3e922021-05-03 15:33:39 -0500347For Neoverse V1, the following errata build flags are defined :
348
laurenw-arm4789cf62021-08-02 13:22:32 -0500349- ``ERRATA_V1_1774420``: This applies errata 1774420 workaround to Neoverse-V1
350 CPU. This needs to be enabled only for revisions r0p0 and r1p0, it is fixed
351 in r1p1.
352
johpow0133e3e922021-05-03 15:33:39 -0500353- ``ERRATA_V1_1791573``: This applies errata 1791573 workaround to Neoverse-V1
354 CPU. This needs to be enabled only for revisions r0p0 and r1p0, it is fixed
355 in r1p1.
356
laurenw-arm143b1962021-08-02 14:40:08 -0500357- ``ERRATA_V1_1852267``: This applies errata 1852267 workaround to Neoverse-V1
358 CPU. This needs to be enabled only for revisions r0p0 and r1p0, it is fixed
359 in r1p1.
360
laurenw-arm741dd042021-08-02 15:00:15 -0500361- ``ERRATA_V1_1925756``: This applies errata 1925756 workaround to Neoverse-V1
362 CPU. This needs to be enabled for r0p0, r1p0, and r1p1, it is still open.
363
johpow01182ce102020-10-07 16:38:37 -0500364- ``ERRATA_V1_1940577``: This applies errata 1940577 workaround to Neoverse-V1
365 CPU. This needs to be enabled only for revision r1p0 and r1p1 of the
366 CPU.
367
johpow011a8804c2021-08-02 18:59:08 -0500368- ``ERRATA_V1_1966096``: This applies errata 1966096 workaround to Neoverse-V1
369 CPU. This needs to be enabled for revisions r1p0 and r1p1 of the CPU, the
370 issue is present in r0p0 as well but there is no workaround for that
371 revision. It is still open.
372
johpow01100d4022021-08-03 14:35:20 -0500373- ``ERRATA_V1_2139242``: This applies errata 2139242 workaround to Neoverse-V1
374 CPU. This needs to be enabled for revisions r0p0, r1p0, and r1p1 of the
375 CPU. It is still open.
376
nayanpatel-arm8e140272021-09-28 13:41:03 -0700377- ``ERRATA_V1_2108267``: This applies errata 2108267 workaround to Neoverse-V1
378 CPU. This needs to be enabled for revisions r0p0, r1p0, and r1p1 of the CPU.
379 It is still open.
380
johpow014c8fe6b2021-09-02 18:29:17 -0500381- ``ERRATA_V1_2216392``: This applies errata 2216392 workaround to Neoverse-V1
382 CPU. This needs to be enabled for revisions r1p0 and r1p1 of the CPU, the
383 issue is present in r0p0 as well but there is no workaround for that
384 revision. It is still open.
385
nayanpatel-armfbcf54a2021-08-06 16:39:48 -0700386For Cortex-A710, the following errata build flags are defined :
387
388- ``ERRATA_A710_1987031``: This applies errata 1987031 workaround to
389 Cortex-A710 CPU. This needs to be enabled only for revisions r0p0, r1p0 and
390 r2p0 of the CPU. It is still open.
391
nayanpatel-arma64bcc22021-08-25 17:35:15 -0700392- ``ERRATA_A710_2081180``: This applies errata 2081180 workaround to
393 Cortex-A710 CPU. This needs to be enabled only for revisions r0p0, r1p0 and
394 r2p0 of the CPU. It is still open.
395
Bipin Ravi213afde2021-03-31 16:45:40 -0500396- ``ERRATA_A710_2055002``: This applies errata 2055002 workaround to
397 Cortex-A710 CPU. This needs to be enabled for revisions r1p0, r2p0 of the CPU
398 and is still open.
399
Bipin Raviafc2ed62021-03-31 18:45:55 -0500400- ``ERRATA_A710_2017096``: This applies errata 2017096 workaround to
401 Cortex-A710 CPU. This needs to be enabled for revisions r0p0, r1p0 and r2p0
402 of the CPU and is still open.
403
nayanpatel-arm95fe1952021-09-16 15:27:53 -0700404- ``ERRATA_A710_2083908``: This applies errata 2083908 workaround to
405 Cortex-A710 CPU. This needs to be enabled for revision r2p0 of the CPU and
406 is still open.
407
nayanpatel-arm744bdbf2021-09-22 12:35:03 -0700408- ``ERRATA_A710_2058056``: This applies errata 2058056 workaround to
409 Cortex-A710 CPU. This needs to be enabled for revisions r0p0, r1p0 and r2p0
410 of the CPU and is still open.
411
Bipin Ravi65e04f22021-03-30 16:08:32 -0500412For Neoverse N2, the following errata build flags are defined :
413
nayanpatel-arm5819e232021-10-06 15:31:24 -0700414- ``ERRATA_N2_2002655``: This applies errata 2002655 workaround to Neoverse-N2
415 CPU. This needs to be enabled for revision r0p0 of the CPU, it is still open.
416
Bipin Ravi65e04f22021-03-30 16:08:32 -0500417- ``ERRATA_N2_2067956``: This applies errata 2067956 workaround to Neoverse-N2
418 CPU. This needs to be enabled for revision r0p0 of the CPU and is still open.
419
Bipin Ravi4618b2b2021-03-31 10:10:27 -0500420- ``ERRATA_N2_2025414``: This applies errata 2025414 workaround to Neoverse-N2
421 CPU. This needs to be enabled for revision r0p0 of the CPU and is still open.
422
Bipin Ravi7cfae932021-08-30 13:02:51 -0500423- ``ERRATA_N2_2189731``: This applies errata 2189731 workaround to Neoverse-N2
Bipin Ravi1cafb082021-09-01 01:36:43 -0500424 CPU. This needs to be enabled for revision r0p0 of the CPU and is still open.
425
426- ``ERRATA_N2_2138956``: This applies errata 2138956 workaround to Neoverse-N2
427 CPU. This needs to be enabled for revision r0p0 of the CPU and is still open.
Bipin Ravi7cfae932021-08-30 13:02:51 -0500428
nayanpatel-armef8f0c52021-09-28 09:46:45 -0700429- ``ERRATA_N2_2138953``: This applies errata 2138953 workaround to Neoverse-N2
430 CPU. This needs to be enabled for revision r0p0 of the CPU and is still open.
431
nayanpatel-arm5819e232021-10-06 15:31:24 -0700432- ``ERRATA_N2_2242415``: This applies errata 2242415 workaround to Neoverse-N2
433 CPU. This needs to be enabled for revision r0p0 of the CPU and is still open.
434
nayanpatel-armc9481852021-10-20 18:28:58 -0700435- ``ERRATA_N2_2138958``: This applies errata 2138958 workaround to Neoverse-N2
436 CPU. This needs to be enabled for revision r0p0 of the CPU and is still open.
437
nayanpatel-arm603806d2021-10-07 17:59:33 -0700438- ``ERRATA_N2_2242400``: This applies errata 2242400 workaround to Neoverse-N2
439 CPU. This needs to be enabled for revision r0p0 of the CPU and is still open.
440
nayanpatel-arm0d2d9992021-10-20 17:30:46 -0700441- ``ERRATA_N2_2280757``: This applies errata 2280757 workaround to Neoverse-N2
442 CPU. This needs to be enabled for revision r0p0 of the CPU and is still open.
443
johpow011db6cd62021-12-01 17:40:39 -0600444For Cortex-X2, the following errata build flags are defined :
445
johpow0134ee76d2021-12-02 13:25:50 -0600446- ``ERRATA_X2_2002765``: This applies errata 2002765 workaround to Cortex-X2
447 CPU. This needs to be enabled for revisions r0p0, r1p0, and r2p0 of the CPU,
448 it is still open.
449
johpow01e16045d2021-12-03 11:27:33 -0600450- ``ERRATA_X2_2058056``: This applies errata 2058056 workaround to Cortex-X2
451 CPU. This needs to be enabled for revisions r0p0, r1p0, and r2p0 of the CPU,
452 it is still open.
453
johpow011db6cd62021-12-01 17:40:39 -0600454- ``ERRATA_X2_2083908``: This applies errata 2083908 workaround to Cortex-X2
455 CPU. This needs to be enabled for revision r2p0 of the CPU, it is still open.
456
Bipin Ravie7ca4432022-01-20 00:01:04 -0600457- ``ERRATA_X2_2017096``: This applies errata 2017096 workaround to
458 Cortex-X2 CPU. This needs to be enabled only for revisions r0p0, r1p0 and
459 r2p0 of the CPU, it is fixed in r2p1.
460
Bipin Ravic060b532022-01-20 00:42:05 -0600461- ``ERRATA_X2_2081180``: This applies errata 2081180 workaround to
462 Cortex-X2 CPU. This needs to be enabled only for revisions r0p0, r1p0 and
463 r2p0 of the CPU, it is fixed in r2p1.
464
John Tsichritzis8a677182018-07-23 09:11:59 +0100465DSU Errata Workarounds
466----------------------
467
468Similar to CPU errata, TF-A also implements workarounds for DSU (DynamIQ
469Shared Unit) errata. The DSU errata details can be found in the respective Arm
470documentation:
471
472- `Arm DSU Software Developers Errata Notice`_.
473
474Each erratum is identified by an ``ID``, as defined in the DSU errata notice
475document. Thus, the build flags which enable/disable the errata workarounds
476have the format ``ERRATA_DSU_<ID>``. The implementation and application logic
477of DSU errata workarounds are similar to `CPU errata workarounds`_.
478
479For DSU errata, the following build flags are defined:
480
Louis Mayencourt0e985d72019-04-09 16:29:01 +0100481- ``ERRATA_DSU_798953``: This applies errata 798953 workaround for the
482 affected DSU configurations. This errata applies only for those DSUs that
483 revision is r0p0 (on r0p1 it is fixed). However, please note that this
484 workaround results in increased DSU power consumption on idle.
485
John Tsichritzis8a677182018-07-23 09:11:59 +0100486- ``ERRATA_DSU_936184``: This applies errata 936184 workaround for the
487 affected DSU configurations. This errata applies only for those DSUs that
488 contain the ACP interface **and** the DSU revision is older than r2p0 (on
489 r2p0 it is fixed). However, please note that this workaround results in
490 increased DSU power consumption on idle.
491
Douglas Raillard6f625742017-06-28 15:23:03 +0100492CPU Specific optimizations
493--------------------------
494
495This section describes some of the optimizations allowed by the CPU micro
496architecture that can be enabled by the platform as desired.
497
498- ``SKIP_A57_L1_FLUSH_PWR_DWN``: This flag enables an optimization in the
499 Cortex-A57 cluster power down sequence by not flushing the Level 1 data
500 cache. The L1 data cache and the L2 unified cache are inclusive. A flush
501 of the L2 by set/way flushes any dirty lines from the L1 as well. This
502 is a known safe deviation from the Cortex-A57 TRM defined power down
503 sequence. Each Cortex-A57 based platform must make its own decision on
504 whether to use the optimization.
505
506- ``A53_DISABLE_NON_TEMPORAL_HINT``: This flag disables the cache non-temporal
507 hint. The LDNP/STNP instructions as implemented on Cortex-A53 do not behave
508 in a way most programmers expect, and will most probably result in a
Dan Handley4def07d2018-03-01 18:44:00 +0000509 significant speed degradation to any code that employs them. The Armv8-A
510 architecture (see Arm DDI 0487A.h, section D3.4.3) allows cores to ignore
Douglas Raillard6f625742017-06-28 15:23:03 +0100511 the non-temporal hint and treat LDNP/STNP as LDP/STP instead. Enabling this
512 flag enforces this behaviour. This needs to be enabled only for revisions
513 <= r0p3 of the CPU and is enabled by default.
514
515- ``A57_DISABLE_NON_TEMPORAL_HINT``: This flag has the same behaviour as
516 ``A53_DISABLE_NON_TEMPORAL_HINT`` but for Cortex-A57. This needs to be
517 enabled only for revisions <= r1p2 of the CPU and is enabled by default,
518 as recommended in section "4.7 Non-Temporal Loads/Stores" of the
519 `Cortex-A57 Software Optimization Guide`_.
520
Varun Wadekarcd0ea182018-06-12 16:49:12 -0700521- ''A57_ENABLE_NON_CACHEABLE_LOAD_FWD'': This flag enables non-cacheable
522 streaming enhancement feature for Cortex-A57 CPUs. Platforms can set
523 this bit only if their memory system meets the requirement that cache
524 line fill requests from the Cortex-A57 processor are atomic. Each
525 Cortex-A57 based platform must make its own decision on whether to use
526 the optimization. This flag is disabled by default.
527
Javier Almansa Sobrino25bbbd22020-10-23 13:22:07 +0100528- ``NEOVERSE_Nx_EXTERNAL_LLC``: This flag indicates that an external last
Manish Pandeyf2d6b4e2020-01-24 11:54:44 +0000529 level cache(LLC) is present in the system, and that the DataSource field
530 on the master CHI interface indicates when data is returned from the LLC.
531 This is used to control how the LL_CACHE* PMU events count.
Javier Almansa Sobrino25bbbd22020-10-23 13:22:07 +0100532 Default value is 0 (Disabled).
Manish Pandeyf2d6b4e2020-01-24 11:54:44 +0000533
Douglas Raillard6f625742017-06-28 15:23:03 +0100534--------------
535
laurenw-arma492edc42021-03-23 13:09:35 -0500536*Copyright (c) 2014-2021, Arm Limited and Contributors. All rights reserved.*
Douglas Raillard6f625742017-06-28 15:23:03 +0100537
John Tsichritzisaf45d642018-09-04 10:56:53 +0100538.. _CVE-2017-5715: http://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2017-5715
539.. _CVE-2018-3639: http://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2018-3639
Paul Beesleydd4e9a72019-02-08 16:43:05 +0000540.. _Cortex-A53 MPCore Software Developers Errata Notice: http://infocenter.arm.com/help/topic/com.arm.doc.epm048406/index.html
541.. _Cortex-A57 MPCore Software Developers Errata Notice: http://infocenter.arm.com/help/topic/com.arm.doc.epm049219/index.html
Eleanor Bonnici6de9b332017-08-02 18:33:41 +0100542.. _Cortex-A72 MPCore Software Developers Errata Notice: http://infocenter.arm.com/help/topic/com.arm.doc.epm012079/index.html
Douglas Raillard6f625742017-06-28 15:23:03 +0100543.. _Cortex-A57 Software Optimization Guide: http://infocenter.arm.com/help/topic/com.arm.doc.uan0015b/Cortex_A57_Software_Optimization_Guide_external.pdf
Sandrine Bailleuxf3cacad2019-02-08 15:26:36 +0100544.. _Arm DSU Software Developers Errata Notice: http://infocenter.arm.com/help/topic/com.arm.doc.epm138168/index.html