-
Notifications
You must be signed in to change notification settings - Fork 22
Updated constants to use 0.5.0's DEF
#11
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
Let me know if I should update the revision number, I wasn't sure what constituted a new version because it seems like not every PR bumps it. |
Changes that affect how it's used bump the revision number; given that this breaks backwards compat, this should be a major bump. |
Also updated the Nintendo logo macro. Bumped major version to 4.0 This breaks compatibility with RGBDS versions prior to 0.5.0. Bumped major revision to 4.0 3 -> 03, updated rev check macro
This should be complete now. All constants use |
If we are breaking compatibility, we might also want to talke a small look at the STAT interrupt. The pandocs consistenty call this the STAT interrupt, but hardware inc calls is LCDC interrupt at some places. |
It's only Are there any other changes that should be made? |
Should these two bit constants have the "1"s removed? It looks like they were accidentally copied from the flags. |
Maybe we could keep the |
Redefining flags names should not be considered so lightly. Changing that IE flag to STAT would have a wide-ranging impact. My vote is to keep it to what the big N labels it "LCDC", as this interrupt signal comes from the LCD Controller, to avoid any confusion. |
On one hand, this is why I advocated for keeping the old constant around for compatibility's sake; on the other hand, the name is confusing, even it can make sense in hindsight by squinting a little, so renaming would be an improvement. Either "LCD interrupt" or "STAT interrupt" is fine, but "LCDC interrupt" has confused plenty of people as to how to control the interrupt via LCDC, which you can't. Nintendo's official names can and have been problematic, so I personally don't think we should always follow them. Consistency with other documents, primarily the Pan Docs, is imo primordial. |
I've left IEF_LCDC at the bottom of the file for compatibility.
|
It should be possible to |
I added the version check to the top of the file, right above the check revision macro. |
DEF HARDWARE_INC SET 1 | ||
|
||
rev_Check_hardware_inc : MACRO | ||
IF __RGBDS_MAJOR__ == 0 && __RGBDS_MINOR__ < 5 |
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.
This check needs to be above the DEF
line if we want to avoid a fatal syntax error.
Moved IEF_LCDC within the include guard
Moved version check above the include guard. Move include guard comment back to the include guard
Given that no further opposition has emerged, and that @DuoDreamer's compatibiltiy concern has been taken care of (in addition to an explicit version requirement), unless any objection arises, I'll merge this tomorrow morning. |
All good. 👍 |
Also updated the Nintendo logo macro. Bumped major version to 4.0, since this breaks compatibility with RGBDS versions prior to 0.5.0. 3 -> 03, updated rev check macro * Deprecate `IEF_LCDC` in favor of `IEF_STAT` * Adde check for outdated RGBDS versions * Update include guard to use `EQU`
Also updated the Nintendo logo macro.