-
-
Notifications
You must be signed in to change notification settings - Fork 125
Add STAT phrasing to clarify and emphasize the interrupt they are associated with #280
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
…sociated with Also helps to slightly disambiguate the STAT Vblank Interrupt from the regular Vblank Interrupt
ISSOtm
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I fully agree in principle, but I think a different wording should be used.
As I read this, I understand "Oh, there are several types of STAT interrupts", but that's not really what it is. Thus, I suggest talking about "interrupt source"s; don't we have a paragraph explaining those, esp. in relation to e.g. STAT int blocking?
|
"interrupt source" seems like a good clarification. Would this be ok, or does the description become too long? The STAT Interrupt section alludes to there being multiple sources, but doesn't enumerate them. The phrasing there is also somewhat vague- It might be better to use separate terminology for "interrupt sources" vs "uses", whereas currently "reasons" seems like it's being used for both meanings. For example: BTW, since "STAT interrupt blocking" seems to be a commonly(?) used term, it might also be useful to mention it explicitly in the Warning section which describes the behavior. (if my understanding of what you are referring to is right) |
LGTM.
Again, LGTM. I would make "the STAT register ($FF41)" be a link to the section, and would also link to DeadCScroll for the last sentence, as it is designed to be a clear example of this kind of effect.
Right. -As mentioned in the description of the STAT register, the PPU cycles through the different modes in a fixed order. If we set the STAT bits in a way that they would interrupt the CPU at two consecutive modes, then the second interrupt will not trigger. So for example, if we enable the interrupts for Mode 0 and Mode 1, the Mode 1 interrupt will not trigger.
+As mentioned in the description of the STAT register, the PPU cycles through the different modes in a fixed order. If we set the STAT bits in a way that they would interrupt the CPU at two consecutive modes, then the second interrupt will not trigger. So for example, if we enable the interrupts for Mode 0 and Mode 1, the Mode 1 interrupt will not trigger. This phenomenon is known as "STAT blocking". |
|
I think that's all updated now. The link rendering on gbdev.io appears to be different than markdown link rendering on github, so I think I've got the STAT register link working I'm not 100% sure. (I haven't looked into whatever is used to build/render the web output) |
Our CI script checks for that. It normally runs automatically on each push, but since this is your first time contributing to this repo, a security feature requires maintainers to manually start it. |
Correct, CI is running on pushes to this branch, so @bbbbbr you can check the results on the "Checks" tab on this PR. |
Also helps to slightly disambiguate the STAT Vblank Interrupt from the regular Vblank Interrupt