arm64/sysreg: Allow enumerations to be declared as signed or unsigned

Many of our enumerations follow a standard scheme where the values can be
treated as signed however there are some where the value must be treated
as signed and others that are simple enumerations where there is no clear
ordering to the values. Provide new field types SignedEnum and
UnsignedEnum which allows the signedness to be specified in the sysreg
definition and emit a REG_FIELD_SIGNED define for these which is a
boolean corresponding to our current FTR_UNSIGNED and FTR_SIGNED macros.

Existing Enums will need to be converted, since these do not have a
define generated anyone wishing to use the sign of one of these will
need to explicitly annotate that field so nothing should start going
wrong by default.

Acked-by: Mark Rutland <mark.rutland@arm.com>
Signed-off-by: Mark Brown <broonie@kernel.org>
Link: https://lore.kernel.org/r/20221207-arm64-sysreg-helpers-v4-1-25b6b3fb9d18@kernel.org
Signed-off-by: Catalin Marinas <catalin.marinas@arm.com>

diff --git a/arch/arm64/tools/gen-sysreg.awk b/arch/arm64/tools/gen-sysreg.awk
index c350164a395502484aff2c029aa4ff03e778bd23..7f27d66a17e1d0451e52c70018107f426bee180f 100755 (executable)
--- a/arch/arm64/tools/gen-sysreg.awk
+++ b/arch/arm64/tools/gen-sysreg.awk
@@ -44,6 +44,11 @@ function define_field(reg, field, msb, lsb) {
        define(reg "_" field "_WIDTH", msb - lsb + 1)
 }
 
+# Print a field _SIGNED definition for a field
+function define_field_sign(reg, field, sign) {
+       define(reg "_" field "_SIGNED", sign)
+}
+
 # Parse a "<msb>[:<lsb>]" string into the global variables @msb and @lsb
 function parse_bitdef(reg, field, bitdef, _bits)
 {
@@ -233,6 +238,30 @@ END {
        next
 }
 
+/^SignedEnum/ {
+       change_block("Enum<", "Sysreg", "Enum")
+       expect_fields(3)
+       field = $3
+       parse_bitdef(reg, field, $2)
+
+       define_field(reg, field, msb, lsb)
+       define_field_sign(reg, field, "true")
+
+       next
+}
+
+/^UnsignedEnum/ {
+       change_block("Enum<", "Sysreg", "Enum")
+       expect_fields(3)
+       field = $3
+       parse_bitdef(reg, field, $2)
+
+       define_field(reg, field, msb, lsb)
+       define_field_sign(reg, field, "false")
+
+       next
+}
+
 /^Enum/ {
        change_block("Enum", "Sysreg", "Enum")
        expect_fields(3)