arm64: Add sysreg header generation scripting
The arm64 kernel requires some metadata for each system register it may
need to access. Currently we have:
* A SYS_<regname> definition which sorresponds to a sys_reg() macro.
This is used both to look up a sysreg by encoding (e.g. in KVM), and
also to generate code to access a sysreg where the assembler is
unaware of the specific sysreg encoding.
Where assemblers support the S3_<op1>_C<crn>_C<crm>_<op2> syntax for
system registers, we could use this rather than manually assembling
the instructions. However, we don't have consistent definitions for
these and we currently still need to handle toolchains that lack this
feature.
* A set of <regname>_<fieldname>_SHIFT and <regname>_<fieldname>_MASK
definitions, which can be used to extract fields from the register, or
to construct a register from a set of fields.
These do not follow the convention used by <linux/bitfield.h>, and the
masks are not shifted into place, preventing their use in FIELD_PREP()
and FIELD_GET(). We require the SHIFT definitions for inline assembly
(and WIDTH definitions would be helpful for UBFX/SBFX), so we cannot
only define a shifted MASK. Defining a SHIFT, WIDTH, shifted MASK and
unshifted MASK is tedious and error-prone and life is much easier when
they can be relied up to exist when writing code.
* A set of <regname>_<fieldname>_<valname> definitions for each
enumerated value a field may hold. These are used when identifying the
presence of features.
Atop of this, other code has to build up metadata at runtime (e.g. the
sets of RES0/RES1 bits in a register).
This patch adds scripting so that we can have an easier-to-manage
canonical representation of this metadata, from which we can generate
all the definitions necessary for various use-cases, e.g.
| #define REG_ID_AA64ISAR0_EL1 S3_0_C0_C6_0
| #define SYS_ID_AA64ISAR0_EL1 sys_reg(3, 0, 0, 6, 0)
| #define SYS_ID_AA64ISAR0_EL1_Op0 3
| #define SYS_ID_AA64ISAR0_EL1_Op1 0
| #define SYS_ID_AA64ISAR0_EL1_CRn 0
| #define SYS_ID_AA64ISAR0_EL1_CRm 6
| #define SYS_ID_AA64ISAR0_EL1_Op2 0
| #define ID_AA64ISAR0_EL1_RNDR GENMASK(63, 60)
| #define ID_AA64ISAR0_EL1_RNDR_MASK GENMASK(63, 60)
| #define ID_AA64ISAR0_EL1_RNDR_SHIFT 60
| #define ID_AA64ISAR0_EL1_RNDR_WIDTH 4
| #define ID_AA64ISAR0_EL1_RNDR_NI UL(0b0000)
| #define ID_AA64ISAR0_EL1_RNDR_IMP UL(0b0001)
The script requires that all bits in the register be specified and that
there be no overlapping fields. This helps the script spot errors in the
input but means that the few registers which change layout at runtime
depending on things like virtualisation settings will need some manual
handling. No actual register conversions are done here but a header for
the register data with some documention of the format is provided.
For cases where multiple registers share a layout (eg, when identical
controls are provided at multiple ELs) the register fields can be
defined once and referenced from the actual registers, currently we do
not generate actual defines for the individual registers.
At the moment this is only intended to express metadata from the
architecture, and does not handle policy imposed by the kernel, such as
values exposed to userspace or VMs. In future this could be extended to
express such information.
This script was mostly written by Mark Rutland but has been extended by
Mark Brown to improve validation of input and better integrate with the
kernel.
Signed-off-by: Mark Rutland <mark.rutland@arm.com>
Co-Developed-by: Mark Brown <broonie@kernel.org>
Signed-off-by: Mark Brown <broonie@kernel.org>
Link: https://lore.kernel.org/r/20220503170233.507788-9-broonie@kernel.org
Signed-off-by: Catalin Marinas <catalin.marinas@arm.com>
2022-05-04 01:02:29 +08:00
|
|
|
# SPDX-License-Identifier: GPL-2.0-only
|
|
|
|
|
#
|
|
|
|
|
# System register metadata
|
|
|
|
|
|
|
|
|
|
# Each System register is described by a Sysreg block:
|
|
|
|
|
|
|
|
|
|
# Sysreg <name> <op0> <op1> <crn> <crm> <op2>
|
|
|
|
|
# <field>
|
|
|
|
|
# ...
|
|
|
|
|
# EndSysreg
|
|
|
|
|
|
|
|
|
|
# Within a Sysreg block, each field can be described as one of:
|
|
|
|
|
|
|
|
|
|
# Res0 <msb>[:<lsb>]
|
|
|
|
|
|
|
|
|
|
# Res1 <msb>[:<lsb>]
|
|
|
|
|
|
|
|
|
|
# Field <msb>[:<lsb>] <name>
|
|
|
|
|
|
|
|
|
|
# Enum <msb>[:<lsb>] <name>
|
|
|
|
|
# <enumval> <enumname>
|
|
|
|
|
# ...
|
|
|
|
|
# EndEnum
|
|
|
|
|
|
|
|
|
|
# Alternatively if multiple registers share the same layout then
|
|
|
|
|
# a SysregFields block can be used to describe the shared layout
|
|
|
|
|
|
|
|
|
|
# SysregFields <fieldsname>
|
|
|
|
|
# <field>
|
|
|
|
|
# ...
|
|
|
|
|
# EndSysregFields
|
|
|
|
|
|
|
|
|
|
# and referenced from within the Sysreg:
|
|
|
|
|
|
|
|
|
|
# Sysreg <name> <op0> <op1> <crn> <crm> <op2>
|
|
|
|
|
# Fields <fieldsname>
|
|
|
|
|
# EndSysreg
|
|
|
|
|
|
|
|
|
|
# For ID registers we adopt a few conventions for translating the
|
|
|
|
|
# language in the ARM into defines:
|
|
|
|
|
#
|
|
|
|
|
# NI - Not implemented
|
|
|
|
|
# IMP - Implemented
|
|
|
|
|
#
|
|
|
|
|
# In general it is recommended that new enumeration items be named for the
|
|
|
|
|
# feature that introduces them (eg, FEAT_LS64_ACCDATA introduces enumeration
|
|
|
|
|
# item ACCDATA) though it may be more taseful to do something else.
|
|
|
|
|
|
2022-05-04 01:02:31 +08:00
|
|
|
Sysreg ID_AA64ISAR0_EL1 3 0 0 6 0
|
|
|
|
|
Enum 63:60 RNDR
|
|
|
|
|
0b0000 NI
|
|
|
|
|
0b0001 IMP
|
|
|
|
|
EndEnum
|
|
|
|
|
Enum 59:56 TLB
|
|
|
|
|
0b0000 NI
|
|
|
|
|
0b0001 OS
|
|
|
|
|
0b0010 RANGE
|
|
|
|
|
EndEnum
|
|
|
|
|
Enum 55:52 TS
|
|
|
|
|
0b0000 NI
|
|
|
|
|
0b0001 FLAGM
|
|
|
|
|
0b0010 FLAGM2
|
|
|
|
|
EndEnum
|
|
|
|
|
Enum 51:48 FHM
|
|
|
|
|
0b0000 NI
|
|
|
|
|
0b0001 IMP
|
|
|
|
|
EndEnum
|
|
|
|
|
Enum 47:44 DP
|
|
|
|
|
0b0000 NI
|
|
|
|
|
0b0001 IMP
|
|
|
|
|
EndEnum
|
|
|
|
|
Enum 43:40 SM4
|
|
|
|
|
0b0000 NI
|
|
|
|
|
0b0001 IMP
|
|
|
|
|
EndEnum
|
|
|
|
|
Enum 39:36 SM3
|
|
|
|
|
0b0000 NI
|
|
|
|
|
0b0001 IMP
|
|
|
|
|
EndEnum
|
|
|
|
|
Enum 35:32 SHA3
|
|
|
|
|
0b0000 NI
|
|
|
|
|
0b0001 IMP
|
|
|
|
|
EndEnum
|
|
|
|
|
Enum 31:28 RDM
|
|
|
|
|
0b0000 NI
|
|
|
|
|
0b0001 IMP
|
|
|
|
|
EndEnum
|
|
|
|
|
Enum 27:24 TME
|
|
|
|
|
0b0000 NI
|
|
|
|
|
0b0001 IMP
|
|
|
|
|
EndEnum
|
|
|
|
|
Enum 23:20 ATOMIC
|
|
|
|
|
0b0000 NI
|
|
|
|
|
0b0010 IMP
|
|
|
|
|
EndEnum
|
|
|
|
|
Enum 19:16 CRC32
|
|
|
|
|
0b0000 NI
|
|
|
|
|
0b0001 IMP
|
|
|
|
|
EndEnum
|
|
|
|
|
Enum 15:12 SHA2
|
|
|
|
|
0b0000 NI
|
|
|
|
|
0b0001 SHA256
|
|
|
|
|
0b0010 SHA512
|
|
|
|
|
EndEnum
|
|
|
|
|
Enum 11:8 SHA1
|
|
|
|
|
0b0000 NI
|
|
|
|
|
0b0001 IMP
|
|
|
|
|
EndEnum
|
|
|
|
|
Enum 7:4 AES
|
|
|
|
|
0b0000 NI
|
|
|
|
|
0b0001 AES
|
|
|
|
|
0b0010 PMULL
|
|
|
|
|
EndEnum
|
|
|
|
|
Res0 3:0
|
|
|
|
|
EndSysreg
|
2022-05-04 01:02:32 +08:00
|
|
|
|
2022-05-04 01:02:33 +08:00
|
|
|
Sysreg SCTLR_EL1 3 0 1 0 0
|
|
|
|
|
Field 63 TIDCP
|
|
|
|
|
Field 62 SPINMASK
|
|
|
|
|
Field 61 NMI
|
|
|
|
|
Field 60 EnTP2
|
|
|
|
|
Res0 59:58
|
|
|
|
|
Field 57 EPAN
|
|
|
|
|
Field 56 EnALS
|
|
|
|
|
Field 55 EnAS0
|
|
|
|
|
Field 54 EnASR
|
|
|
|
|
Field 53 TME
|
|
|
|
|
Field 52 TME0
|
|
|
|
|
Field 51 TMT
|
|
|
|
|
Field 50 TMT0
|
|
|
|
|
Field 49:46 TWEDEL
|
|
|
|
|
Field 45 TWEDEn
|
|
|
|
|
Field 44 DSSBS
|
|
|
|
|
Field 43 ATA
|
|
|
|
|
Field 42 ATA0
|
|
|
|
|
Enum 41:40 TCF
|
|
|
|
|
0b00 NONE
|
|
|
|
|
0b01 SYNC
|
|
|
|
|
0b10 ASYNC
|
|
|
|
|
0b11 ASYMM
|
|
|
|
|
EndEnum
|
|
|
|
|
Enum 39:38 TCF0
|
|
|
|
|
0b00 NONE
|
|
|
|
|
0b01 SYNC
|
|
|
|
|
0b10 ASYNC
|
|
|
|
|
0b11 ASYMM
|
|
|
|
|
EndEnum
|
|
|
|
|
Field 37 ITFSB
|
|
|
|
|
Field 36 BT1
|
|
|
|
|
Field 35 BT0
|
|
|
|
|
Res0 34
|
|
|
|
|
Field 33 MSCEn
|
|
|
|
|
Field 32 CMOW
|
|
|
|
|
Field 31 EnIA
|
|
|
|
|
Field 30 EnIB
|
|
|
|
|
Field 29 LSMAOE
|
|
|
|
|
Field 28 nTLSMD
|
|
|
|
|
Field 27 EnDA
|
|
|
|
|
Field 26 UCI
|
|
|
|
|
Field 25 EE
|
|
|
|
|
Field 24 E0E
|
|
|
|
|
Field 23 SPAN
|
|
|
|
|
Field 22 EIS
|
|
|
|
|
Field 21 IESB
|
|
|
|
|
Field 20 TSCXT
|
|
|
|
|
Field 19 WXN
|
|
|
|
|
Field 18 nTWE
|
|
|
|
|
Res0 17
|
|
|
|
|
Field 16 nTWI
|
|
|
|
|
Field 15 UCT
|
|
|
|
|
Field 14 DZE
|
|
|
|
|
Field 13 EnDB
|
|
|
|
|
Field 12 I
|
|
|
|
|
Field 11 EOS
|
|
|
|
|
Field 10 EnRCTX
|
|
|
|
|
Field 9 UMA
|
|
|
|
|
Field 8 SED
|
|
|
|
|
Field 7 ITD
|
|
|
|
|
Field 6 nAA
|
|
|
|
|
Field 5 CP15BEN
|
|
|
|
|
Field 4 SA0
|
|
|
|
|
Field 3 SA
|
|
|
|
|
Field 2 C
|
|
|
|
|
Field 1 A
|
|
|
|
|
Field 0 M
|
|
|
|
|
EndSysreg
|
|
|
|
|
|
2022-05-11 00:12:03 +08:00
|
|
|
SysregFields SMCR_ELx
|
|
|
|
|
Res0 63:32
|
|
|
|
|
Field 31 FA64
|
|
|
|
|
Res0 30:9
|
|
|
|
|
Raz 8:4
|
|
|
|
|
Field 3:0 LEN
|
|
|
|
|
EndSysregFields
|
|
|
|
|
|
|
|
|
|
Sysreg SMCR_EL1 3 0 1 2 6
|
|
|
|
|
Fields SMCR_ELx
|
|
|
|
|
EndSysreg
|
|
|
|
|
|
|
|
|
|
Sysreg SMCR_EL2 3 4 1 2 6
|
|
|
|
|
Fields SMCR_ELx
|
|
|
|
|
EndSysreg
|
|
|
|
|
|
|
|
|
|
Sysreg SMCR_EL12 3 5 1 2 6
|
|
|
|
|
Fields SMCR_ELx
|
|
|
|
|
EndSysreg
|
|
|
|
|
|
2022-05-04 01:02:32 +08:00
|
|
|
SysregFields TTBRx_EL1
|
|
|
|
|
Field 63:48 ASID
|
|
|
|
|
Field 47:1 BADDR
|
|
|
|
|
Field 0 CnP
|
|
|
|
|
EndSysregFields
|
|
|
|
|
|
|
|
|
|
Sysreg TTBR0_EL1 3 0 2 0 0
|
|
|
|
|
Fields TTBRx_EL1
|
|
|
|
|
EndSysreg
|
|
|
|
|
|
|
|
|
|
Sysreg TTBR1_EL1 3 0 2 0 1
|
|
|
|
|
Fields TTBRx_EL1
|
|
|
|
|
EndSysreg
|