docs: add missing software_irq KIPC docs
#1965
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
I [recently discovered][1] that the `software_irq` KIPC call is missing reference documentation. In fact, the KIPC documentation doesn't even mention it (in contrast to other KIPC calls that have no documentation but are still listed in the reference). Instead, the reference documentation currently incorrectly states that `find_faulted_task` is KIPC number 8, when it's actually KIPC 9 and `software_irq` is number 8. Not adding this KIPC to the docs was an oversight on my part in PR #1661 --- my bad, sorry! This commit adds documentation for the `software_irq` KIPC to the reference. [1]: #1961 (comment)
|
Ugh, the Windows CI job is yet again failing due to a tiny binary size difference that's totally unrelated to this change... 🙃 |
mkeeter
reviewed
Jan 15, 2025
doc/kipc.adoc
Outdated
|
|
||
| This interface is primarily intended for testing interrupt handling, and can | ||
| only be called by a task running as the supervisor. When this KIPC is called, | ||
| an actual machine interrupt is triggered and dispatched by the kernel to the |
There was a problem hiding this comment.
I would split this up to make it more obvious that the KIPC only triggers the interrupt, something like
When this KIPC is called, an actual machine interrupt is triggered for the relevant hardware interrupt source. The kernel then responds to the interrupt using its normal interrupt-handling infrastructure, which dispatches a notification to the subscribed task.
There was a problem hiding this comment.
Thanks, I agree that's nicer.
mkeeter
approved these changes
Jan 15, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I recently discovered that the
software_irqKIPC call is missingreference documentation. In fact, the KIPC documentation doesn't even
mention it (in contrast to other KIPC calls that have no documentation
but are still listed in the reference). Instead, the reference
documentation currently incorrectly states that
find_faulted_taskisKIPC number 8, when it's actually KIPC 9 and
software_irqis number 8.Not adding this KIPC to the docs was an oversight on my part in PR #1661
--- my bad, sorry!
This commit adds documentation for the
software_irqKIPC to thereference.