arm64/sve: Document that __SVE_VQ_MAX is much larger than needed
authorMark Brown <broonie@kernel.org>
Fri, 9 Feb 2024 16:53:36 +0000 (16:53 +0000)
committerCatalin Marinas <catalin.marinas@arm.com>
Thu, 22 Feb 2024 19:32:47 +0000 (19:32 +0000)
commit21eb468e9fc11692952c42f86a44d07f94803d4f
tree2605d7ceb033f3375ad2800ca51de833704771a5
parent58a0484eaf5ec1e94e530c1074abf852354eca8c
arm64/sve: Document that __SVE_VQ_MAX is much larger than needed

__SVE_VQ_MAX is defined without comment as 512 but the actual
architectural maximum is 16, a substantial difference which might not
be obvious to readers especially given the several different units used
for specifying vector sizes in various contexts and the fact that it's
often used via macros.  In an effort to minimise surprises for users who
might assume the value is the architectural maximum and use it to do
things like size allocations add a comment noting the difference, and
add a note for SVE_VQ_MAX to aid discoverability.

Signed-off-by: Mark Brown <broonie@kernel.org>
Acked-by: Dave Martin <Dave.Martin@arm.com>
Link: https://lore.kernel.org/r/20240209-arm64-sve-vl-max-comment-v2-1-111b283469ee@kernel.org
Signed-off-by: Catalin Marinas <catalin.marinas@arm.com>
arch/arm64/include/uapi/asm/sve_context.h