Added Analogizer, VRC7 and PAL ROM support

README.md

@@ -1,10 +1,10 @@
-# NES for Analogue Pocket
+# NES for Analogue Pocket with Analogizer Support
 
 Ported from the core originally developed by [Ludvig Strigeus](https://github.com/strigeus/fpganes) and heavily developed by [@sorgelig](https://github.com/sorgelig), [@greyrogue](https://github.com/greyrogue), [@Kitrinx](https://github.com/Kitrinx), [@paulb-nl](https://github.com/paulb-nl), and many more. Core icon by [spiritualized1997](https://github.com/spiritualized1997). Latest upstream available at https://github.com/MiSTer-devel/NES_MiSTer
 
 Please report any issues encountered to this repo. Most likely any problems are a result of my port, not the original core. Issues will be upstreamed as necessary.
 
-## Installation
+## Installation (see also Analogizer settings section)
 
 ### Easy mode
 
@@ -17,25 +17,25 @@ To install the core, copy the `Assets`, `Cores`, and `Platform` folders over to
 
 ROMs should be placed in `/Assets/nes/common`
 
-PAL ROMs should boot, but there will be timing and sound issues as the core currently doesn't properly support PAL (proper support coming soon). I highly recommend you do not play PAL games, and instead use NTSC games (if they exist) at this time.
+PAL ROMs are supported with proper timing and sound pitch. The NES ROM headers should be at least iNES2.0 version to correctly identify the ROM region. NES ROMs with legacy header or marked as MultiSystem will be
+booted as NTSC.
 
 ## Features
 
 ### Dock Support
 
-Core supports four players/controllers via the Analogue Dock. To enable four player mode, turn on `Use Multitap` setting.
+Core supports four players/controllers via the Analogue Dock. To enable four player mode, turn on `Use Multitap` setting. This is also required to enable to use the Analogizer SNAC PCEngine Multitap.
 
 ### Mappers
 
-This core has pairity with the MiSTer core's mapper support. [See the full breakdown here](https://github.com/MiSTer-devel/NES_MiSTer#supported-mappers). Please note that the VRC7 expansion audio chip is not supported in this core (but is in MiSTer) due to space constraints.
+This core has pairity with the MiSTer core's mapper support. [See the full breakdown here](https://github.com/MiSTer-devel/NES_MiSTer#supported-mappers).
 
 ### Save States/Sleep + Wake
 
 Known as "Memories" on the Pocket, this core supports the creation and loading of save states for most mappers. See the full list in the [Mappers section](#mappers). By extension, the core supports Sleep + Wake functionality on the Pocket. In games with supported mappers, tapping the power button while playing will suspend the game, ready to be resumed when powering the Pocket back on.
 
-### Saves
-
-Supports saves for most games and mappers. Saving on the NES is rather complicated due to the different scenarios for different mappers, so it's possible some less common mappers do not save correctly on this core. Please report all such issues to this repo.
+### Save States/Sleep + Wake and Saves
+Are supported.
 
 ### Controller Turbo
 
@@ -69,17 +69,144 @@ You can load external palettes as well. This palette is stored at `Assets/nes/ag
 
 For testing, or to temporarily load a new palette, you can choose the `Load Custom Palette` option (make sure to choose `Core Settings/Palette/Custom`). This palette selection is temporary, and will be reset when quitting and reopening the core.
 
+### Analogizer Options
+
+* `Enable Analogizer`- Enables/Disables the Analogizer adapter globall. When it is disabled, bypass the specific settings for Analogizer, this settings makes the SNAC adapter settings be ignored, using Pocket's default inputs, also forces the video output to be forwarded towards Pocket screen.
+* 
 ### Video Options
 
 There are several options provided for tweaking the displayed video:
-
+* `Video Dejitter` - Intended for use with Analogizer video output with a CRT screen to mimick the real behaviour of the NES. Disable it for use with the Pocket screen, the Dock output or Video Scalers as the OSSC.
 * `Hide Overscan` - Hides the top and bottom 8 pixels of the video, which would normally be masked by the CRT. Adjusts the aspect ratio to correspond with this modification. This option does nothing in PAL mode
 * `Edge Masking` - Masks the sides of the screen in black, depending on the chosen option. The auto setting automatically masks the left side when certain conditions are met.
 * `Square Pixels` - The internal resolution of the NES is a 8:7 pixel aspect ratio (wide pixels), which roughly corresponds to what users would see on 4:3 display aspect ratio CRTs. Some games are designed to be displayed at 8:7 PAR (the core's default), and others at 1:1 PAR (square pixels). The `Square Pixels` option is provided to switch to a 1:1 pixel aspect ratio.
 * `Extra Sprites` - Allows an extra 8 sprites to be displayed per line (up to 16 from the original 8). Will decrease flickering in some games
 
 ### Lightguns
 
-Core supports virtual lightguns by enabling the "Use Zapper" setting. The crosshair can be controlled with the D-Pad or left joystick, using the A button to fire. D-Pad aim sensitivity can be adjusted with the "D-Pad Aim Speed" setting.
+Core supports virtual lightguns by enabling the `Use Zapper > Emulated Zapper (Stick)` setting. The crosshair can be controlled with the D-Pad or left joystick, using the A button to fire. D-Pad aim sensitivity can be adjusted with the "D-Pad Aim Speed" setting. In addition, the Analogizer core version supports directly connecting the Zapper gun using a SNAC NES adapter  by enabling the `Use Zapper > SNAC Zapper` setting
 
 **NOTE:** Joystick support for aiming only appears to work when a controller is paired over Bluetooth and not connected to the Analogue Dock directly by USB.
+
+### Analogizer settings
+
+This Analogizer core use a configuration file to select Analogizer adapter options, not based on the Pocket's menu system. It is necessary to use [Pupdate](https://github.com/mattpannella/pupdate) release >= 4.3.1 or run an external [utility](https://github.com/RndMnkIII/AnalogizerConfigurator) to generate such a file. Once generated, you must copy the `analogizer.bin` file to the `/Assets/analogizer/common` folder on the Pocket SD card. If this folder does not exist, you must create it or if you have already extracted the Amiga core distribution file it will be created. Pupdate does all actions automatically after running this tool. Inside Pupdate navigate to: `Pocket Setup>Analogizer Config>Standard Analogizer Config`, choose Analogizer settings and exit to save to file.
+
+For the PAL/NTSC/Dendy ROM detection the Chip32 loader reads the NES game ROM header previously to load the core to decode the system type, this needs a iNES2.0 ROM header. If the ROM that are you using is of an older header type or not `analogizer.bin` file is detected the core will boot into NTSC mode. 
+
+The Loader uses the regional settings from `analogizer.bin`file to determine the mode the ROM is loaded/NES hardware runs. 
+The settings are:
+ 1) Auto>NTSC:     Try to autodetect the regional setting from the ROM header. If the ROM is `Multi-System` uses the NTSC mode.
+ 2) Auto>PAL:      Try to autodetect the regional setting from the ROM header. If the ROM is `Multi-System` uses the PAL mode.
+ 3) Auto>Another:  Try to autodetect the regional setting from the ROM header. If the ROM is `Multi-System` uses the Dendy mode.
+ 4) Force NTSC:    The ROM uses the NTSC mode. 
+ 5) Force PAL:     The ROM uses the PAL mode. 
+ 6) Force Another: The ROM uses the Dendy mode. 
+
+Tested NES SNAC adapters working with the Zapper lightgun:
+* https://ultimatemister.com/product/ultimate-snac-mini-hdmi/
+* Blue212 based design (uses two board, a common board and console specific connector board).  https://manuferhi.com/p/snac-adapter-for-mister with the [two port NES](https://www.etsy.com/de-en/listing/1556489601/mister-fpga-snac-adapter-nes-2p) connector or [one port](https://www.etsy.com/de-en/listing/1781156747/mister-snac-adapter-nes-vertical). Any SNAC adapter based on Blue212 design will be work.
+
+Recomended settings inside Pupdate (PocketSetup>Analogizer Config>Standard Analogizer Config) for use the NES Zapper lightgun with a NES SNAC adapter:
+```
+SNAC Controller:     NES - Nintendo Entertainment System gamepad
+SNAC Assigments:     SNAC P1,P2 -> Pocket P1,P2                 
+```
+
+Recomended settings with NES Core Pocket menu  for use the NES Zapper lightgun with a NES SNAC adapter:
+```
+Use Zapper > SNAC Zapper
+```
+
+Connect the Zapper to the second port of the NES SNAC adapter (if you have the two ports version) or to the first port (if you have the one port version).
+
+For use with PSX Analog stick emulating the reticle lightgun. Use this settings inside Pupdate (PocketSetup>Analogizer Config>Standard Analogizer Config):
+```
+SNAC Controller:     PSX (Analog PAD) - PlayStation 1/2 analog gamepad
+SNAC Assigments:     SNAC P1,P2 -> Pocket P1,P2                       
+```
+
+Recomended settings with NES Core Pocket menu  for use the NES Zapper lightgun with a NES SNAC adapter:
+```
+Use Zapper > Emulated Zapper (Stick)
+```
+
+Use the PSX game controller connected to the first port of th PSX SNAC adapter.
+
+Analogizer support added by RndMnkIII. See more in the Analogizer main repository: [Analogizer](https://github.com/RndMnkIII/Analogizer)
+
+Adapted to Analogizer by [@RndMnkIII](https://github.com/RndMnkIII) based on **agg23** NES for Analogue Pocket:
+https://github.com/agg23/openfpga-NES
+
+The core can output RGBS, RGsB, YPbPr, Y/C and SVGA scandoubler (50% scanlines) video signals.
+| Video output | Status | SOG Switch(Only R2,R3 Analogizer) |
+| :----------- | :----: | :-------------------------------: |     
+| RGBS         |  ✅    |     Off                           |
+| RGsB         |  ✅    |     On                            |
+| YPbPr        |  ✅🔹  |     On                            |
+| Y/C NTSC     |  ✅    |     Off                           |
+| Y/C PAL      |  ✅    |     Off                           |
+| Scandoubler  |  ✅    |     Off                           |
+
+🔹 Tested with Sony PVM-9044D
+
+| :SNAC game controller:  | Analogizer A/B config Switch | Status |
+| :---------------------- | :--------------------------- | :----: |
+| DB15                    | A                            |  ✅    |
+| NES/Zapper              | A                            |  ✅    |
+| SNES                    | A                            |  ✅    |
+| PCENGINE                | A                            |  ✅    |
+| PCE MULTITAP            | A                            |  ✅    |
+| PSX DS/DS2 Digital DPAD | B                            |  ✅    |
+| PSX DS/DS2 Analog  DPAD | B                            |  ✅    |
+
+The Analogizer interface allow to mix game inputs from compatible SNAC gamepads supported by Analogizer (DB15 Neogeo, NES, SNES, PCEngine, PSX) with Analogue Pocket built-in controls or from Dock USB or wireless supported controllers (Analogue support).
+
+All Analogizer adapter versions (v1, v2 and v3) has a side slide switch labeled as 'A B' that must be configured based on the used SNAC game controller.
+For example for use it with PSX Dual Shock or Dual Shock 2 native gamepad you must position the switch lever on the B side position. For the remaining
+game controllers you must switch the lever on the A side position. 
+Be careful when handling this switch. Use something with a thin, flat tip such as a precision screwdriver with a 2.0mm flat blade for example. Place the tip on the switch lever and press gently until it slides into the desired position:
+
+```
+     ---
+   B|O  |A  A/B switch on position B
+     ---   
+     ---
+   B|  O|A  A/B switch on position A
+     ---
+``` 
+
+* **Analogizer** is responsible for generating the correct encoded Y/C signals from RGB and outputs to R,G pins of VGA port. Also redirects the CSync to VGA HSync pin.
+The required external Y/C adapter that connects to VGA port is responsible for output Svideo o composite video signal using his internal electronics. Oficially
+only the Mike Simone Y/C adapters (active) designs will be supported by Analogizer and will be the ones to use.
+However, depending on the type of screen you have, passive Y/C adapters could work with different degrees of success.
+
+Support native PCEngine/TurboGrafx-16 2btn, 6 btn gamepads and 5 player multitap using SNAC adapter
+and PC Engine cable harness (specific for Analogizer). Many thanks to [Mike Simone](https://github.com/MikeS11/MiSTerFPGA_YC_Encoder) for his great Y/C Encoder project.
+
+You will need to connect an active VGA to Y/C adapter to the VGA port (the 5V power is provided by VGA pin 9). I'll recomend one of these (active):
+* [MiSTerAddons - Active Y/C Adapter](https://misteraddons.com/collections/parts/products/yc-active-encoder-board/)
+* [MikeS11 Active VGA to Composite / S-Video](https://ultimatemister.com/product/mikes11-active-composite-svideo/)
+* [Active VGA->Composite/S-Video adapter](https://antoniovillena.com/product/mikes1-vga-composite-adapter/)
+
+Using another type of Y/C adapter not tested to be used with Analogizer will not receive official support.
+
+### Build & Install instructions (Windows):
+
+1) Install Quartus 21.1 (x64)
+2) Add to the system or user Path: <Quartus 21.1 Install Path>\quartus\bin64
+   clone the project files: git clone <repository-URL>
+3) Open a PowerShell terminal to project folder openfpga-NES
+
+4) Generate the four bitstreams files running the scripts: 
+   .\build.ps1 NTSC_SET1
+   .\build.ps1 NTSC_SET2
+   .\build.ps1 PAL_SET1
+   .\build.ps1 PAL_SET2
+
+   The generated *.rev bitstream files are stored in the 'core_bitstreams' folder
+6) Copy the contents from 'pkg\pocket' folder to the root of Pocket SD Card.
+5) Copy the bitstream files from 'core_bitstreams' to the Core folder 'Cores\agg23.NES' in the Pocket SD Card.
+
+
+

analogizer/analogizer.qip

@@ -0,0 +1,14 @@
+set_global_assignment -name VERILOG_FILE [file join $::quartus(qip_path) openFPGA_Pocket_Analogizer.v]
+set_global_assignment -name VERILOG_FILE [file join $::quartus(qip_path) vga_out_sw.v]
+set_global_assignment -name SYSTEMVERILOG_FILE [file join $::quartus(qip_path) openFPGA_Pocket_Analogizer_SNAC.sv]
+set_global_assignment -name VERILOG_FILE [file join $::quartus(qip_path) clock_divider_fract.v]
+set_global_assignment -name VERILOG_FILE [file join $::quartus(qip_path) serlatch_gc.v]
+set_global_assignment -name VERILOG_FILE [file join $::quartus(qip_path) pcengine_gc.v]
+set_global_assignment -name VERILOG_FILE [file join $::quartus(qip_path) pcengine_game_controller_multitap.v]
+set_global_assignment -name SYSTEMVERILOG_FILE [file join $::quartus(qip_path) yc_out.sv]
+set_global_assignment -name VERILOG_FILE [file join $::quartus(qip_path) scandoubler.v]
+set_global_assignment -name VERILOG_FILE [file join $::quartus(qip_path) scandoubler_2.v]
+set_global_assignment -name VERILOG_FILE [file join $::quartus(qip_path) scanlines_analogizer.v]
+set_global_assignment -name SYSTEMVERILOG_FILE [file join $::quartus(qip_path) hq2x.sv]
+set_global_assignment -name VERILOG_FILE [file join $::quartus(qip_path) dualshock_controller.v]
+set_global_assignment -name SYSTEMVERILOG_FILE [file join $::quartus(qip_path) analogizer_psx.sv]