Linux Audio

Check our new training course

Yocto / OpenEmbedded training

Feb 10-13, 2025
Register
Loading...
Note: File does not exist in v4.6.
  1===========================
  2ARM64 CPU Feature Registers
  3===========================
  4
  5Author: Suzuki K Poulose <suzuki.poulose@arm.com>
  6
  7
  8This file describes the ABI for exporting the AArch64 CPU ID/feature
  9registers to userspace. The availability of this ABI is advertised
 10via the HWCAP_CPUID in HWCAPs.
 11
 121. Motivation
 13-------------
 14
 15The ARM architecture defines a set of feature registers, which describe
 16the capabilities of the CPU/system. Access to these system registers is
 17restricted from EL0 and there is no reliable way for an application to
 18extract this information to make better decisions at runtime. There is
 19limited information available to the application via HWCAPs, however
 20there are some issues with their usage.
 21
 22 a) Any change to the HWCAPs requires an update to userspace (e.g libc)
 23    to detect the new changes, which can take a long time to appear in
 24    distributions. Exposing the registers allows applications to get the
 25    information without requiring updates to the toolchains.
 26
 27 b) Access to HWCAPs is sometimes limited (e.g prior to libc, or
 28    when ld is initialised at startup time).
 29
 30 c) HWCAPs cannot represent non-boolean information effectively. The
 31    architecture defines a canonical format for representing features
 32    in the ID registers; this is well defined and is capable of
 33    representing all valid architecture variations.
 34
 35
 362. Requirements
 37---------------
 38
 39 a) Safety:
 40
 41    Applications should be able to use the information provided by the
 42    infrastructure to run safely across the system. This has greater
 43    implications on a system with heterogeneous CPUs.
 44    The infrastructure exports a value that is safe across all the
 45    available CPU on the system.
 46
 47    e.g, If at least one CPU doesn't implement CRC32 instructions, while
 48    others do, we should report that the CRC32 is not implemented.
 49    Otherwise an application could crash when scheduled on the CPU
 50    which doesn't support CRC32.
 51
 52 b) Security:
 53
 54    Applications should only be able to receive information that is
 55    relevant to the normal operation in userspace. Hence, some of the
 56    fields are masked out(i.e, made invisible) and their values are set to
 57    indicate the feature is 'not supported'. See Section 4 for the list
 58    of visible features. Also, the kernel may manipulate the fields
 59    based on what it supports. e.g, If FP is not supported by the
 60    kernel, the values could indicate that the FP is not available
 61    (even when the CPU provides it).
 62
 63 c) Implementation Defined Features
 64
 65    The infrastructure doesn't expose any register which is
 66    IMPLEMENTATION DEFINED as per ARMv8-A Architecture.
 67
 68 d) CPU Identification:
 69
 70    MIDR_EL1 is exposed to help identify the processor. On a
 71    heterogeneous system, this could be racy (just like getcpu()). The
 72    process could be migrated to another CPU by the time it uses the
 73    register value, unless the CPU affinity is set. Hence, there is no
 74    guarantee that the value reflects the processor that it is
 75    currently executing on. The REVIDR is not exposed due to this
 76    constraint, as REVIDR makes sense only in conjunction with the
 77    MIDR. Alternately, MIDR_EL1 and REVIDR_EL1 are exposed via sysfs
 78    at::
 79
 80	/sys/devices/system/cpu/cpu$ID/regs/identification/
 81	                                              \- midr
 82	                                              \- revidr
 83
 843. Implementation
 85--------------------
 86
 87The infrastructure is built on the emulation of the 'MRS' instruction.
 88Accessing a restricted system register from an application generates an
 89exception and ends up in SIGILL being delivered to the process.
 90The infrastructure hooks into the exception handler and emulates the
 91operation if the source belongs to the supported system register space.
 92
 93The infrastructure emulates only the following system register space::
 94
 95	Op0=3, Op1=0, CRn=0, CRm=0,2,3,4,5,6,7
 96
 97(See Table C5-6 'System instruction encodings for non-Debug System
 98register accesses' in ARMv8 ARM DDI 0487A.h, for the list of
 99registers).
100
101The following rules are applied to the value returned by the
102infrastructure:
103
104 a) The value of an 'IMPLEMENTATION DEFINED' field is set to 0.
105 b) The value of a reserved field is populated with the reserved
106    value as defined by the architecture.
107 c) The value of a 'visible' field holds the system wide safe value
108    for the particular feature (except for MIDR_EL1, see section 4).
109 d) All other fields (i.e, invisible fields) are set to indicate
110    the feature is missing (as defined by the architecture).
111
1124. List of registers with visible features
113-------------------------------------------
114
115  1) ID_AA64ISAR0_EL1 - Instruction Set Attribute Register 0
116
117     +------------------------------+---------+---------+
118     | Name                         |  bits   | visible |
119     +------------------------------+---------+---------+
120     | RNDR                         | [63-60] |    y    |
121     +------------------------------+---------+---------+
122     | TS                           | [55-52] |    y    |
123     +------------------------------+---------+---------+
124     | FHM                          | [51-48] |    y    |
125     +------------------------------+---------+---------+
126     | DP                           | [47-44] |    y    |
127     +------------------------------+---------+---------+
128     | SM4                          | [43-40] |    y    |
129     +------------------------------+---------+---------+
130     | SM3                          | [39-36] |    y    |
131     +------------------------------+---------+---------+
132     | SHA3                         | [35-32] |    y    |
133     +------------------------------+---------+---------+
134     | RDM                          | [31-28] |    y    |
135     +------------------------------+---------+---------+
136     | ATOMICS                      | [23-20] |    y    |
137     +------------------------------+---------+---------+
138     | CRC32                        | [19-16] |    y    |
139     +------------------------------+---------+---------+
140     | SHA2                         | [15-12] |    y    |
141     +------------------------------+---------+---------+
142     | SHA1                         | [11-8]  |    y    |
143     +------------------------------+---------+---------+
144     | AES                          | [7-4]   |    y    |
145     +------------------------------+---------+---------+
146
147
148  2) ID_AA64PFR0_EL1 - Processor Feature Register 0
149
150     +------------------------------+---------+---------+
151     | Name                         |  bits   | visible |
152     +------------------------------+---------+---------+
153     | DIT                          | [51-48] |    y    |
154     +------------------------------+---------+---------+
155     | MPAM                         | [43-40] |    n    |
156     +------------------------------+---------+---------+
157     | SVE                          | [35-32] |    y    |
158     +------------------------------+---------+---------+
159     | GIC                          | [27-24] |    n    |
160     +------------------------------+---------+---------+
161     | AdvSIMD                      | [23-20] |    y    |
162     +------------------------------+---------+---------+
163     | FP                           | [19-16] |    y    |
164     +------------------------------+---------+---------+
165     | EL3                          | [15-12] |    n    |
166     +------------------------------+---------+---------+
167     | EL2                          | [11-8]  |    n    |
168     +------------------------------+---------+---------+
169     | EL1                          | [7-4]   |    n    |
170     +------------------------------+---------+---------+
171     | EL0                          | [3-0]   |    n    |
172     +------------------------------+---------+---------+
173
174
175  3) ID_AA64PFR1_EL1 - Processor Feature Register 1
176
177     +------------------------------+---------+---------+
178     | Name                         |  bits   | visible |
179     +------------------------------+---------+---------+
180     | SME                          | [27-24] |    y    |
181     +------------------------------+---------+---------+
182     | MTE                          | [11-8]  |    y    |
183     +------------------------------+---------+---------+
184     | SSBS                         | [7-4]   |    y    |
185     +------------------------------+---------+---------+
186     | BT                           | [3-0]   |    y    |
187     +------------------------------+---------+---------+
188
189
190  4) MIDR_EL1 - Main ID Register
191
192     +------------------------------+---------+---------+
193     | Name                         |  bits   | visible |
194     +------------------------------+---------+---------+
195     | Implementer                  | [31-24] |    y    |
196     +------------------------------+---------+---------+
197     | Variant                      | [23-20] |    y    |
198     +------------------------------+---------+---------+
199     | Architecture                 | [19-16] |    y    |
200     +------------------------------+---------+---------+
201     | PartNum                      | [15-4]  |    y    |
202     +------------------------------+---------+---------+
203     | Revision                     | [3-0]   |    y    |
204     +------------------------------+---------+---------+
205
206   NOTE: The 'visible' fields of MIDR_EL1 will contain the value
207   as available on the CPU where it is fetched and is not a system
208   wide safe value.
209
210  5) ID_AA64ISAR1_EL1 - Instruction set attribute register 1
211
212     +------------------------------+---------+---------+
213     | Name                         |  bits   | visible |
214     +------------------------------+---------+---------+
215     | I8MM                         | [55-52] |    y    |
216     +------------------------------+---------+---------+
217     | DGH                          | [51-48] |    y    |
218     +------------------------------+---------+---------+
219     | BF16                         | [47-44] |    y    |
220     +------------------------------+---------+---------+
221     | SB                           | [39-36] |    y    |
222     +------------------------------+---------+---------+
223     | FRINTTS                      | [35-32] |    y    |
224     +------------------------------+---------+---------+
225     | GPI                          | [31-28] |    y    |
226     +------------------------------+---------+---------+
227     | GPA                          | [27-24] |    y    |
228     +------------------------------+---------+---------+
229     | LRCPC                        | [23-20] |    y    |
230     +------------------------------+---------+---------+
231     | FCMA                         | [19-16] |    y    |
232     +------------------------------+---------+---------+
233     | JSCVT                        | [15-12] |    y    |
234     +------------------------------+---------+---------+
235     | API                          | [11-8]  |    y    |
236     +------------------------------+---------+---------+
237     | APA                          | [7-4]   |    y    |
238     +------------------------------+---------+---------+
239     | DPB                          | [3-0]   |    y    |
240     +------------------------------+---------+---------+
241
242  6) ID_AA64MMFR0_EL1 - Memory model feature register 0
243
244     +------------------------------+---------+---------+
245     | Name                         |  bits   | visible |
246     +------------------------------+---------+---------+
247     | ECV                          | [63-60] |    y    |
248     +------------------------------+---------+---------+
249
250  7) ID_AA64MMFR2_EL1 - Memory model feature register 2
251
252     +------------------------------+---------+---------+
253     | Name                         |  bits   | visible |
254     +------------------------------+---------+---------+
255     | AT                           | [35-32] |    y    |
256     +------------------------------+---------+---------+
257
258  8) ID_AA64ZFR0_EL1 - SVE feature ID register 0
259
260     +------------------------------+---------+---------+
261     | Name                         |  bits   | visible |
262     +------------------------------+---------+---------+
263     | F64MM                        | [59-56] |    y    |
264     +------------------------------+---------+---------+
265     | F32MM                        | [55-52] |    y    |
266     +------------------------------+---------+---------+
267     | I8MM                         | [47-44] |    y    |
268     +------------------------------+---------+---------+
269     | SM4                          | [43-40] |    y    |
270     +------------------------------+---------+---------+
271     | SHA3                         | [35-32] |    y    |
272     +------------------------------+---------+---------+
273     | B16B16                       | [27-24] |    y    |
274     +------------------------------+---------+---------+
275     | BF16                         | [23-20] |    y    |
276     +------------------------------+---------+---------+
277     | BitPerm                      | [19-16] |    y    |
278     +------------------------------+---------+---------+
279     | AES                          | [7-4]   |    y    |
280     +------------------------------+---------+---------+
281     | SVEVer                       | [3-0]   |    y    |
282     +------------------------------+---------+---------+
283
284  8) ID_AA64MMFR1_EL1 - Memory model feature register 1
285
286     +------------------------------+---------+---------+
287     | Name                         |  bits   | visible |
288     +------------------------------+---------+---------+
289     | AFP                          | [47-44] |    y    |
290     +------------------------------+---------+---------+
291
292  9) ID_AA64ISAR2_EL1 - Instruction set attribute register 2
293
294     +------------------------------+---------+---------+
295     | Name                         |  bits   | visible |
296     +------------------------------+---------+---------+
297     | CSSC                         | [55-52] |    y    |
298     +------------------------------+---------+---------+
299     | RPRFM                        | [51-48] |    y    |
300     +------------------------------+---------+---------+
301     | BC                           | [23-20] |    y    |
302     +------------------------------+---------+---------+
303     | MOPS                         | [19-16] |    y    |
304     +------------------------------+---------+---------+
305     | APA3                         | [15-12] |    y    |
306     +------------------------------+---------+---------+
307     | GPA3                         | [11-8]  |    y    |
308     +------------------------------+---------+---------+
309     | RPRES                        | [7-4]   |    y    |
310     +------------------------------+---------+---------+
311     | WFXT                         | [3-0]   |    y    |
312     +------------------------------+---------+---------+
313
314  10) MVFR0_EL1 - AArch32 Media and VFP Feature Register 0
315
316     +------------------------------+---------+---------+
317     | Name                         |  bits   | visible |
318     +------------------------------+---------+---------+
319     | FPDP                         | [11-8]  |    y    |
320     +------------------------------+---------+---------+
321
322  11) MVFR1_EL1 - AArch32 Media and VFP Feature Register 1
323
324     +------------------------------+---------+---------+
325     | Name                         |  bits   | visible |
326     +------------------------------+---------+---------+
327     | SIMDFMAC                     | [31-28] |    y    |
328     +------------------------------+---------+---------+
329     | SIMDSP                       | [19-16] |    y    |
330     +------------------------------+---------+---------+
331     | SIMDInt                      | [15-12] |    y    |
332     +------------------------------+---------+---------+
333     | SIMDLS                       | [11-8]  |    y    |
334     +------------------------------+---------+---------+
335
336  12) ID_ISAR5_EL1 - AArch32 Instruction Set Attribute Register 5
337
338     +------------------------------+---------+---------+
339     | Name                         |  bits   | visible |
340     +------------------------------+---------+---------+
341     | CRC32                        | [19-16] |    y    |
342     +------------------------------+---------+---------+
343     | SHA2                         | [15-12] |    y    |
344     +------------------------------+---------+---------+
345     | SHA1                         | [11-8]  |    y    |
346     +------------------------------+---------+---------+
347     | AES                          | [7-4]   |    y    |
348     +------------------------------+---------+---------+
349
350
351Appendix I: Example
352-------------------
353
354::
355
356  /*
357   * Sample program to demonstrate the MRS emulation ABI.
358   *
359   * Copyright (C) 2015-2016, ARM Ltd
360   *
361   * Author: Suzuki K Poulose <suzuki.poulose@arm.com>
362   *
363   * This program is free software; you can redistribute it and/or modify
364   * it under the terms of the GNU General Public License version 2 as
365   * published by the Free Software Foundation.
366   *
367   * This program is distributed in the hope that it will be useful,
368   * but WITHOUT ANY WARRANTY; without even the implied warranty of
369   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
370   * GNU General Public License for more details.
371   * This program is free software; you can redistribute it and/or modify
372   * it under the terms of the GNU General Public License version 2 as
373   * published by the Free Software Foundation.
374   *
375   * This program is distributed in the hope that it will be useful,
376   * but WITHOUT ANY WARRANTY; without even the implied warranty of
377   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
378   * GNU General Public License for more details.
379   */
380
381  #include <asm/hwcap.h>
382  #include <stdio.h>
383  #include <sys/auxv.h>
384
385  #define get_cpu_ftr(id) ({					\
386		unsigned long __val;				\
387		asm("mrs %0, "#id : "=r" (__val));		\
388		printf("%-20s: 0x%016lx\n", #id, __val);	\
389	})
390
391  int main(void)
392  {
393
394	if (!(getauxval(AT_HWCAP) & HWCAP_CPUID)) {
395		fputs("CPUID registers unavailable\n", stderr);
396		return 1;
397	}
398
399	get_cpu_ftr(ID_AA64ISAR0_EL1);
400	get_cpu_ftr(ID_AA64ISAR1_EL1);
401	get_cpu_ftr(ID_AA64MMFR0_EL1);
402	get_cpu_ftr(ID_AA64MMFR1_EL1);
403	get_cpu_ftr(ID_AA64PFR0_EL1);
404	get_cpu_ftr(ID_AA64PFR1_EL1);
405	get_cpu_ftr(ID_AA64DFR0_EL1);
406	get_cpu_ftr(ID_AA64DFR1_EL1);
407
408	get_cpu_ftr(MIDR_EL1);
409	get_cpu_ftr(MPIDR_EL1);
410	get_cpu_ftr(REVIDR_EL1);
411
412  #if 0
413	/* Unexposed register access causes SIGILL */
414	get_cpu_ftr(ID_MMFR0_EL1);
415  #endif
416
417	return 0;
418  }