[PATCH] arm64/sme: Drop inaccurate documentation of streaming mode switches

Mark Brown posted 1 patch 2 months, 2 weeks ago
Documentation/arch/arm64/sme.rst | 14 ++------------
1 file changed, 2 insertions(+), 12 deletions(-)
[PATCH] arm64/sme: Drop inaccurate documentation of streaming mode switches
Posted by Mark Brown 2 months, 2 weeks ago
The SME ABI documentation contains an inaccurate description of the
architectural streaming mode entry/exit behaviour, just remove it since
this is better documented by the architecture or with the rest of the
documentation for the specific software interfaces concerned.

Signed-off-by: Mark Brown <broonie@kernel.org>
---
The rest of the documentation needs more thorough review, but it seems
wise to remove the incorrect statement to avoid confusion.
---
 Documentation/arch/arm64/sme.rst | 14 ++------------
 1 file changed, 2 insertions(+), 12 deletions(-)

diff --git a/Documentation/arch/arm64/sme.rst b/Documentation/arch/arm64/sme.rst
index 4cb38330e704..583f2ee9cb97 100644
--- a/Documentation/arch/arm64/sme.rst
+++ b/Documentation/arch/arm64/sme.rst
@@ -81,17 +81,7 @@ The ZA matrix is square with each side having as many bytes as a streaming
 mode SVE vector.
 
 
-3.  Sharing of streaming and non-streaming mode SVE state
----------------------------------------------------------
-
-It is implementation defined which if any parts of the SVE state are shared
-between streaming and non-streaming modes.  When switching between modes
-via software interfaces such as ptrace if no register content is provided as
-part of switching no state will be assumed to be shared and everything will
-be zeroed.
-
-
-4.  System call behaviour
+3.  System call behaviour
 -------------------------
 
 * On syscall PSTATE.ZA is preserved, if PSTATE.ZA==1 then the contents of the
@@ -112,7 +102,7 @@ be zeroed.
   exceptions for execve() described in section 6.
 
 
-5.  Signal handling
+4.  Signal handling
 -------------------
 
 * Signal handlers are invoked with PSTATE.SM=0, PSTATE.ZA=0, and TPIDR2_EL0=0.

---
base-commit: 86731a2a651e58953fc949573895f2fa6d456841
change-id: 20250722-arm64-sme-mode-switch-doc-8e132434b4ed

Best regards,
--  
Mark Brown <broonie@kernel.org>
Re: [PATCH] arm64/sme: Drop inaccurate documentation of streaming mode switches
Posted by Will Deacon 3 weeks, 6 days ago
On Wed, 23 Jul 2025 13:27:45 +0100, Mark Brown wrote:
> The SME ABI documentation contains an inaccurate description of the
> architectural streaming mode entry/exit behaviour, just remove it since
> this is better documented by the architecture or with the rest of the
> documentation for the specific software interfaces concerned.
> 
> 

Applied to arm64 (for-next/docs), thanks!

[1/1] arm64/sme: Drop inaccurate documentation of streaming mode switches
      https://git.kernel.org/arm64/c/3c0979c64481

Cheers,
-- 
Will

https://fixes.arm64.dev
https://next.arm64.dev
https://will.arm64.dev