x86/nmi: Improve <asm/nmi.h> documentation
authorSohil Mehta <sohil.mehta@intel.com>
Thu, 27 Mar 2025 23:46:27 +0000 (23:46 +0000)
committerIngo Molnar <mingo@kernel.org>
Tue, 1 Apr 2025 20:26:21 +0000 (22:26 +0200)
commit3b1292706305e5949d2aa739eb0ae009a9e6f824
treed014e8a15715de24636f9f99f08a709f3bf15705
parent59cddd397accfa92fc36c223e3d532b47fdab841
x86/nmi: Improve <asm/nmi.h> documentation

NMI handlers can be registered by various subsystems, including drivers.

However, the interface for registering and unregistering such handlers
is not clearly documented. In the future, the interface may need to be
extended to identify the source of the NMI.

Add documentation to make the current API more understandable and easier
to use.

Signed-off-by: Sohil Mehta <sohil.mehta@intel.com>
Signed-off-by: Ingo Molnar <mingo@kernel.org>
Acked-by: Peter Zijlstra (Intel) <peterz@infradead.org>
Reviewed-by: Nikolay Borisov <nik.borisov@suse.com>
Link: https://lore.kernel.org/r/20250327234629.3953536-8-sohil.mehta@intel.com
arch/x86/include/asm/nmi.h