git: a2409f17377e - main - intr: Document how to get the interrupt frame

From: Warner Losh <imp_at_FreeBSD.org>
Date: Fri, 10 May 2024 21:44:58 UTC
The branch main has been updated by imp:

URL: https://cgit.FreeBSD.org/src/commit/?id=a2409f17377ebb5c6e3e522ae090a0845ee19aeb

commit a2409f17377ebb5c6e3e522ae090a0845ee19aeb
Author:     Warner Losh <imp@FreeBSD.org>
AuthorDate: 2024-05-10 21:41:36 +0000
Commit:     Warner Losh <imp@FreeBSD.org>
CommitDate: 2024-05-10 21:41:36 +0000

    intr: Document how to get the interrupt frame
    
    Document that the only way to get the interrupt thread is to use
    curthread->td_intr_frame, rather than the old-style of having a NULL
    pointer for the interrupt thread. As of 38c35248fe3b, support for that
    has been removed. I neglected to update that commit message with these
    details.
    
    Suggested by: mhorne
---
 sys/kern/kern_intr.c | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/sys/kern/kern_intr.c b/sys/kern/kern_intr.c
index 008f8d1242ca..7a57d964acd9 100644
--- a/sys/kern/kern_intr.c
+++ b/sys/kern/kern_intr.c
@@ -1346,7 +1346,10 @@ ithread_loop(void *arg)
  *
  * Input:
  * o ie:                        the event connected to this interrupt.
- * o frame:                     the current trap frame.
+--------------------------------------------------------------------------------
+ * o frame:                     the current trap frame. If the client interrupt
+ *				handler needs this frame, they should get it
+ *				via curthread->td_intr_frame.
  *
  * Return value:
  * o 0:                         everything ok.