* NES: Add support for various tilemap layout (mirroring) configurations
- Introduce platform configuration, mainly to define tilemap layout NES_TILEMAP_[F|H|V|S] in platform_cfg.s
+ Add NES_TILEMAP_S|H|V|F setting for tilemap layout, and hard-code to NES_TILEMAP_S for now
+ Add NES_LOMEM setting to enable current default of using part of stack instead of BSS for attribute shadow buffer
+ Edit Makefile to copy platform_cfg.s (if it exists) to platform directory after build
- Updates to attribute shadow buffer and dirty bits:
+ Add NUM_NT define for number of nametables used by a layout, and AT_SHADOW_WIDTH/_HEIGHT to denote the variable dimensions
+ Add convenience defines NT_2W / NT_2H to quickly test whether tilemap layout is two screens wide / high
+ Define _attribute_shadow and _attribute_row/_column_dirty in terms of NUM_NT
+ Update flush_attributes to support all layouts
+ Update get_bkg_xy_addr / set_bkg_tile_xy to support all layouts
+ Update set_bkg_attribute_xy[_nes16x16] to support all layouts
+ Update set_bkg_attributes[_nes16x16] to support all layouts, and correctly wrap to next AT in both directions
+ Update set_bkg_submap_attributes[_nes16x16] to support all layouts
+ Update set_bkg_submap to support all layouts, and contain common inner subroutine .set_bkg_common
+ Replace set_bkg_tiles with simpler implementation calling .set_bkg_common, and correctly wraps to next NT in both directions
+ Add set_bkg_based_tiles / set_bkg_based_submap implementations using the new common subroutine
- Updates to C include files:
+ Define DEVICE_SCREEN_BUFFER_WIDTH/_HEIGHT based on NES_TILEMAP_ setting, doubling high-level size of WIDTH / HEIGHT conditionally
+ Add typedefs scroll_x_t / scroll_y_t as uint8_t or uint16_t based on NES_TILEMAP_ setting
+ Make move_bkg use scroll_x/y_t typedefs, set 9th scroll bit in shadow_PPUCTRL where needed, and compensate for 239->0 y wrapping
- Updates to examples:
+ Update large_map example to use platform-agnostic settings for scroll wrapping and offset
+ Update rle_map to use a uint16_t for scroll position, to support NES_TILEMAP_H and NES_TILEMAP_F settings
- Move TIM ISR emulation to dedicated function .tim_emulation and dedicated file timer_isr.s
- Make TIM ISR emulation save entirety of ALL_REGTEMPS_BEGIN to ALL_REGTEMPS_END
- Improve emulation to allow average TIM rate to be faster compared to vblank rate
- Add support for consistent average TIM rate on PAL, for a less system-dependent timer
- Add support for different base dividers defined by GB-like TAC_REG variable
- Add defines values for "vblank parity mode" to global.s and nes.h
- Update crt0 init code to set TMA_REG to vblank parity mode correctly for PAL/Dendy
- Update documentation, describing the improved GB TIM emulation and vblank parity mode
- Update cross-platform IRQ example to better showcase the emulation
* NES: Make sure TIM ISR handlers are thread-safe
- Backup and restore REGTEMP area when calling TIM ISR in vblank
- Update irq example to use #pragma nooverlay for tim handler
- Add warning and explanation about having to use #pragma for TIM handlers in NES section of docs
- Add @anchor to docs, and a code example for #pragma nooverlay
- Update irq.c with `#pragma nooverlay` only being applied if NINTENDO_NES is defined
- Add more detailed comment of `#pragma nooverlay` in irq.c
- Add reference to docs in gb.h
- Add similar reference to nes.h
NES: Align coordinates and scanline counting in LCD ISR implementation with GB, add SCX / SCY / LYC defines
- Change definition of _lcd_scanline to be -1 less than current, aligning with GB LYC register
- Change definition of _bkg_scroll_y to match GB's SCY, being relative to current scanline
- Refactor do_hblank_writes, delay_fractional and delay_to_scanline subroutines in crt0
- Add "#define LYC_REG" and "#define LY_REG" as aliases of _lcd_scanline
- Add #defines for SCX and SCY to alias _bkg_scroll_x / _bkg_scroll_y shadow variables
- Change text scroller example to use LYC_REG / SCX / SCY instead of _lcd_scanline / move_bkg, remove redundant #ifdefs
- Add subtle shake in y direction to text scroller example, to check that GB / NES coordinates match
- Update "From Game Boy to NES" section's descriptions of LCD handlers
- Update "Migrating to new GBDK versions" with a short description of bkg_scroll_y changing from absolute to relative Y coordinates for 4.4.0
- Add add_TIM / remove_TIM functions to nes.h
- Refactor implementation in lcd.s to support add_TIM / remove_TIM
- Add TMA_REG / TIMA_REG / TAC_REG vars to emulate GB hardware timer register
- Add call to TIM function at end of NMI handler in crt0.s, and make it use TMA_REG / TIMA_REG vars
- Add implementation for set_interrupts in lcd.s, replacing JMP instruction with RTS when disabled
- Enable NES target in examples/cross-platform/irq and replace delay(1000) call with 60 vsyncs
- Update examples/cross-platform/scroller and examples/cross-platform/irq to use set_interrupts
- Update documentation to describe use-cases and limitations of TIM handler
* Copy gbdk-lib/include/gb/bcd.h to gbdk-lib/include/nes/bcd.h
* Add bcd asm implementation in libc/asm/mos6502/bcd.s
* Update bcd.h to accept NES target
* Update examples/cross-platform/bcd to build for nes
* Refactor .delay_to_lcd_scanline to not use Y register. Remove outdated comments.
* Move .jmp_to_LCD_isr call to vsync routine, and have it copy shadow PPU register values to a buffer
* Add MAX_LCD_ISR_CALLS define to limit the deferred PPU register write buffer size
* Add .do_lcd_ppu_reg_writes for writing buffer aligned to hblank, and calls to .delay_to_lcd_scanline
* Make .do_lcd_ppu_reg_write restore Y-scroll for start-of-frame after every update, to mitigate glitches in lag frames
* Have LCD at scanline#0 be treated as a special-case, where VBL shadow values are replaced without adding to the buffer
* Re-introduce variable to skip NMI as __crt0_disableNMI, and set it in vsync during buffer building
Update text_scroller example:
* Fix NES-version of code to do multiple splits like the other platforms do
* Fill nametable with '*' to make splits more visible
* TODO: Find out why fill_bkg_rect isn't working on GB
* Name change for consistency with other platforms: _system_bits -> _SYSTEM
* Add _SYSTEM extern to msx.h and sms.h
* Make all platforms have SYSTEM_60HZ and 0x00 and SYSTEM_50HZ as 0x01
* Make _SYSTEM have uint8_t type instead of UBYTE
* Add new zeropage variable _system_bits to indicate NTSC/PAL/Dendy system
* Modify init code to detect NTSC/PAL/Dendy via cycle counting, storing result in _system_bits
* Modify fake-LCD-ISR delays in NMI handler to accommodate PAL timings
Cross-platform:
* Change existing SYSTEM_NTSC / SYSTEM_PAL defines in sms.h to SYSTEM_60HZ / SYSTEM_50HZ, and copy them to gb.h / nes.h / msx.h
* Add new cross-platform function get_system for all ports, to query whether running on a 60Hz or 50Hz system
* Add minimal cross-platform display_system example to exercise get_system
* Update gbdk_build_and_package.yml and gbdk_build_examples.yml to use gbdk-4.2.0-Next SDCC build
* Update nes.h to declare all gbdk functions with the new __no_overlay_locals function attribute
* Introduce new dedicated 16-byte overlay segment GBDKOVR, and make all assembly functions use this instead of OSEG
* Update LCC file targets.c to reserve space for both OSEG and GBDKOVR
* Reverse order of bits in joypad byte and bitmasks for buttons, to conform to more common order in nesdev
* Bump MAX_JOYPADS definition in joypad_ex.s from 2 to 4
* Add label read_joypad_no_strobe, to avoid repeated strobing when reading multiple controllers
* Update joypad_ex function to call read_joypad_no_strobe repeatedly for as many controllers as initialized in joypads_t struct
* Update set_bkg_palette and set_sprite_palette in gbdk-lib/include/gb/cgb.h
* Update set_bkg_palette and set_sprite_palette in gbdk-lib/include/nes/nes.h
* Update gbdk-lib/include/gb/gb.h to forward set_bkg_native_data / set_sprite_native_data to set_bkg_data / set_sprite_data functions
* Update gbdk-lib/include/sms/sms.h to forward set_bkg_native_data / set_sprite_data to set_bkg_4bpp_data / set_sprite_4bpp_data
* Add implementation for set_bkg_native_data / set_sprite_native_data in gbdk-lib/libc/targets/mos6502/nes/set_native_data.s
* Update gbdk-lib/include/nes/nes.h to include function declarations for set_bkg_native_data / set_sprite_native_data
* Update gbdk-lib/inlcude/nes/nes.h to implement set_native_tile_data in terms of set_bkg_native_data / set_sprite_native_data
* Update gbdk-lib/inlcude/nes/nes.h to implement set_tile_data in terms of set_bkg_data / set_sprite_data
* Remove old (/broken for indirect mode) code for set_tile_data / set_native_tile_data from set_data.s / set_native_data.s
* Update png2asset to include NES among the supported PackModes
* Update examples/cross-platform/logo .meta file to specify NES PackFormat for NES build
* Update examples/cross-platform/large_map Makefile to specify NES PackFormat for NES build
* Add dedicated NES function set_bkg_attribute_xy_nes16x16 for setting an individual (shadow) attribute in gbdk-lib/libc/targets/mos6502/nes/set_attribute.s
* Add inline adapter NES function set_bkg_attribute_xy, which calls set_bkg_attribute_xy_nes16x16
* Change NES functionality to call _flush_shadow_attributes from wait_vbl_done
* Remove calls to _flush_shadow_attributes in set_bkg_attributes and set_bkg_submap_attributes
* Add dedicated SMS/GG function set_attribute_xy in gbdk-lib/libc/targets/z80/set_tile.s
* Add inline adapter GBC function set_bkg_attribute_xy in gbdk-lib/include/gb/gb.h
* Add implementation for add_VBL / add_LCD and remove_VBL / remove_LCD in libc/targets/mos6502/nes/lcd.s, supporting just 1 handler to conserve memory
* Make wait_vbl_done call VBL handler, so it occurs before vblank
* Add variable _lcd_scanline, and make default vblank NMI call LCD handler after running a delay loop for this many scanlines
* Update docs to specify the limitations of the nes implementation
* Enable examples/cross-platform/scroller for nes target
* Change incorrect DEVICE_SCREEN_MAP_ENTRY_SIZE value of 2 to 1 in gbdk-lib/include/nes/hardware.h
Changes to gbdk-lib/include library headers:
* Make NONBANKED / BANKED macros in asm/mos6502/types.h expand to respective keywords instead of being no-ops
* Remove force-zero-bank version of INCBIN macros in gbdk/incbin.h in favour of regular version
* Make BANK / BANKREF macros in nes/nes.h use appropriate implementation instead of stubs
* Add SWITCH_ROM_UNROM macro, and make SWITCH_ROM use it in place of SWITCH_ROM_DUMMY in nes.h
* Add stubbed no-op versions for SWITCH_RAM / ENABLE_RAM / DISABLE_RAM in nes.h, to support cross-platform tests
changes to gbdk-support tools:
* Remove CODEFIXED segment at 0xE000 in lcc/targets.c, relying only on _CODE at 0xC000
* Make ld command use -a nes, to use virtual address translation from sdld_virtual_address_translation.patch
* Update bankpack to support "nes" as option (uses GB platform)
* Update makebin to perform NES specific bank fix (rotates ROM by one bank, putting first bank as last)
* Update png2asset to initialize bank to -1 and write #pragma bank for banks = 0, to remove assumption on bank 0 being the fixed bank
Changes to gbdk-lib/libc implementations:
* Add implementation of to_far_ptr and call__banked in targets/mos6502/far_ptr.s
* Add UNROM bank switching macros in targets/mos6502/nes/mapper_macros.s, and __swith_prg0 function in targets/mos6502/nes/mapper.s
* Add banked call support routine ___sdcc_bcall in targets/mos6502/nes/sdcc_bcall.s
* Add code to initialize switchable bank to 0 at reset in crt0
Depends on sdcc_mos6502_underscored_areas.patch, sdcc_mos6502_bank_support.patch and sdld_virtual_address_translation.patch applied to SDCC
- more details for for new metasprite functions
- GB: more details for BGP/OBP0/OBP1
- Remove some trailing spaces in metasprite headers
- Re-add Obsolete keyword to pre-deprecated functions
- Entries for release notes, migration notes
- Add note about initializing SRAM
- Add CGB section to Supported Consoles with overview, api links and list of examples (@anchor using_cgb_features)
- Initial note 4.2 migration and release notes
- API doc improvements
* Change x / y parameters of move_metasprite* function definitions from uint8 to int16
* Update move_metasprite* to do 16-bit math, and reject hardware sprites outside screen
* Move flip[x/y] move_metasprite* functions into separate files for independent linking
* Move .move_metasprite_prologue / _epilogue functions into new file metasprites_common.s
* Add definitions for ATTRIBUTE_WIDTH/_HEIGHT and ATTRIBUTE_PACKED_WIDTH/_HEIGHT to global.s
* Add subroutine set_bkg_submap_attributes_nes16x16 in gbdk-lib/libc/targets/mos6502/nes/set_tile_submap_attributes.s
* Add wrapper function set_bkg_submap_attributes working in 8x8 tile coordinate system for compatibility
* Update Makefile for lib
* Move _flush_shadow_attributes subroutine to its own file flush_attributes.s
* Add bitfield _attribute_column_dirty, and add handling of dirtied columns to _flush_attributes
* Update cross-platform/logo/src/main.c to use 8x8 coordinate system for NES
png2asset:
* Fix bug in PackMapAttributes where height was always being set to width
* Refactor BuildPalettesAndAttributes palette search into its own function FindOrCreateSubPalette
* Change BuildPalettesAndAttributes to force subPalIndex to 0 instead of causing segfault when there's too many colors for an attribute region
* Add new function AlignMapAttributes to ensure map is properly aligned for set_bkg_submap
* Change #define MAP_ATTRIBUTES_WIDTH/HEIGHT to use new 8x8 coordinate system
* Introduce global __current_base_prop and apply as offset in move_metasprite_* asm implementation
* Update move_metasprite_* functions in metasprites.h to set __current_base_prop global
* Update printing of METASPR_ITEM in png2asset to extract X/Y flip and palette number, print them as symbolic names S_FLIPX, S_FLIPY and S_PAL(...)
* (...and adjust output formatting to one METASPR_ITEM per line, for better readability)
* Add #define for S_PAL to gb.h, nes.h, msx.h and sms.h
* Remove "TODO:" comments from gbdk-lib/libc/targets/mos6502/nes/metasprites.s
