Skip to content

Latest commit

 

History

History
298 lines (210 loc) · 20.8 KB

README.md

File metadata and controls

298 lines (210 loc) · 20.8 KB
Raw

Multi-Region Mod for any SNES

Free your SNES

(picture shows last prototype PCB installed on a SNS-CPU-RGB-01)

Acknowledgement and Licensing

This PCB, its idea and design, is a confluence of multiple projects. All credits and rights are going to their respective creators:

  • SuperCIC-lock by Ikari_01 Copyright (c) 2010 by Maximilian Rehkopf under GNU GPLv2 Source: sd2snes homepage
  • uIGR by Ikari_01 and borti4938 Copyright (c) 2010 by Maximilian Rehkopf under GNU GPLv2, and modifications copyright (c) 2015 by Peter Bartmann under GNU GPLv2 Source: sd2snes homepage, this repository
  • Region Patch built in SNES by Ikari_01 (initial idea and detection using SuperCIC-lock) and borti4938 (schematic refinement and CPLD implementation) Initial idea (c) 2012 ikari_01, CPLD implementation as used here covered in DeJitter license Source: sd2snes homepage
  • DeJitter by marqs85 Copyright (c) 2017-2018 Markus Hiienkari under MIT and modifications and additions copyright (c) 2019 Peter Bartmann under MIT Source: Original GitHub Repository, this repository
  • DFO by micro Copyright / created 2015 by Jakob Schäfer without licensing (but given to retro community) Source: mirror in this repository, with minor adaptations and with several original sources noted in the Source.md file
  • PCB design by borti4938 Copyright (c) 2019 by Peter Bartmann under GNU GPLv3

Features and Functions

In short
  • SuperCIC: lockout chip replacement 50Hz/60Hz switch cabability
  • uIGR: controller input sniffing to perform certain actions like reset or 60Hz and 50Hz switch up on certain combinations
  • Region Patch: overrides region protection based on picture processing status reads
  • DeJitter: removes jitter on sync for NTSC mode
  • DFO: dual frequency oscillator, here used to switch between base clocks for 50Hz, 60Hz video-modes
SuperCIC

Hold down the reset button in order to swipe through 50Hz (green LED), 60Hz (red LED) or Auto-Region (yellow LED).

With the sd2snes you are able to pair the SuperCIC with the flash card. Then you'll be able to switch between 60Hz and 50Hz mode. However, you need to have the uIGR, which is master for the region setting, in SuperCIC pass through mode. Some more information is given below.

uIGR

The uIGR sniffs the controller inputs directly at the controller port. Therefor it is able to detect certain button combinations. All button combinations are collected in an overview PDF, which is available in German and English. Here are the most important ones:

  • Region forcing:
    • 60Hz: L + R + Select + A
    • 50Hz: L + R + Select + Y
    • Auto: L + R + Select + B
    • S-CIC pass through: L + R + Select + D-pad left OR L + R + Select + D-pad right
  • Reset:
    • simple reset: L + R + Select + Start
    • double reset (back to main menu of sd2snes): L + R + Select + X
Region Patch

Overwrites region if game request register $213F, where bit 4 represents the region. Region patching can be disabled (see uIGR PDFs). You also have to consider switching off the region patch if using non-original cartridges or flash cards (sd2snes with Pairmode with SuperCIC is not a problem).

DeJitter

In NTSC mode the SNES outputs a shorter scanline in non-visible area. This might be an issue for certain TVs if you use pure analog to digital conversion without frame buffer like the OSSC does. DeJitter 'removes' this shorter line by pausing the clock for a few cycles.

As drawback this mechanic varies output timing a bit, however the inaccuracy is neglectable when comparing it to clock variations throughout different consoles.

At the moment, DeJitter is enabled by default and can only be disabled by setting jumper SJ31.

DFO

Short for dual frequency oscillator. Actually in combination with the CPLD this allows to switch between three output clocks plus two color carrier clocks. If modding board is correctly installed, there is nothing special to consider here.

PCB Description

Solder Pads

These are just general descriptions of the in- and outputs. Please refer to the installation instructions for each specific mainboard version (if exists) for suitable connections.

  • /Rst.o: (output (2x)) Low-active reset output. This has to be connected with CIC-lock pad 10 / S-APU pin 100. Connect either pad.
  • Rst.i: (input) High-active reset input. This pad has to be connected with the CIC-lock pad 8 (reset button).
  • LED.Re: (output) LED driver for replacement LED; usually red. Output is active on 60Hz and auto video mode and off on 50Hz (or vice versa if SJ21 is set (common anode LED))
  • LED.Gr: (output) LED driver for replacement LED; usually green. Output is active on 50Hz and auto video mode and off on 60Hz (or vice versa if SJ21 is set (common anode LED))
  • Ctrl.port.10: (input) Input for controller 1 sniffing (data latch signal). Port refers to flat cable connector of the whole controller panel, i.e. pin is equivalent for controller connector pin 3.
  • Ctrl.port.8: (input) Input for controller 1 sniffing (data clock signal). Port refers to flat cable connector of the whole controller panel, i.e. pin is equivalent for controller connector pin 2.
  • Ctrl.port.6: (input) Input for controller 1 sniffing (serial data signal). Port refers to flat cable connector of the whole controller panel, i.e. pin is equivalent for controller connector pin 4.
  • Vmode: (output) Output sets the PPU video mode at S-PPU1 pin 24 and S-PPU2 pin 30 or at the S-CPUN pin 111. Output is active on 50Hz mode and inactive on 60Hz mode.
  • /Vmode: (output (2x)) Output sets the video encoding at the video encoder, which is pin 19 of the S-ENC and pin 9 of the S-RGB. Connect just on of the pads!
  • Clk.CIC: (input) Input for the SuperCIC-lock clock, which comes from CIC pad 7.
  • MClk.o: (output) Output for the (de-jittered) master clock of the SNES. This is approx. 21.477MHz in NTSC mode and appr. 17.734MHz (1Chip-SNES, SJ32 not set) or appr. 21.281MHz (non-1Chip, SJ32 set) in PAL mode. Please refer to the general installation note to see whether and how to connect this pad properly.
  • CClk.o: (output) Output of the color carrier, which is appr. 3.380MHz in NTSC mode and appr. 4.433MHz in PAL mode. Please refer to the general installation note to see whether and how to connect this pad properly.
  • /CS.i: (input (2x since SMR20190813) Input of the 'original' (non-de-jittered) composite sync. This comes from pin 100 S-PPU2 or pin 151 S-CPUN.
  • /CS.o buf: (output) Buffered (de-jittered) composite sync output. This is meant to be connected directly to the multiout pin 3. Note: The PAL SNES has 12V connected to this pin, which has to be removed.
  • /CS.o raw: (output (2x)) Raw output of the CPLD, which has 3.3V high and 0V low level. Connect it to the video encode, which is pin 8 of the S-ENC or pin 7 of the S-RGB (both chips allows 2.0V for input high, so 3.3V high is sufficient.)

Jumper

  • SJ11: alternative clock for the SuperCIC; close this jumper if you don't connect the Clk.CIC pad in order to use the clock meant for the CIC-key
  • SJ21: close this jumper if you use a LED with a common anode. Otherwise leave this jumper untouched
  • SJ31: closing this jumper permanently disables the de-jitter function. This solder jumper is a bit larger to give the installer the option to connect a slide switch here (speed-runner discussions).
    • There is also an issue opened in marqs85 DeJitter repository reported by BambooShadow, which states that composite video and s-video becomes flickery. This is probably related to the S-RGB encoder chip on SNS-CPU-RGB-01 and later models (PAL: SNSP-CPU-1CHIP-01 and later). In any case, you can disable DeJitter if this is also an issue for you.
    • I personally recommend to turn DeJitter off. Turn DeJitter only on if you use simple line doublers like the OSSC and if you have any issue on getting a proper picture.
  • SJ32: short this jumper if the board is installed in a non-1Chip-SNES (SNES Jr. / SNES2 are also 1Chip-SNES)
  • SJ61: distributes clock output to cartridge slot pin 1. This jumper must not be closed in 1Chip-SNES. Side note: if SJ32 is open, SJ61 has to open, too.
  • SJ63: (since SMR20200323) decides which color carrier is forwarded to output. This jumper has two option; you must not close both jumpers!
    • SJ63.1: (marked with a dot) outputs color carrier derived from non-dejittered clock.
      Use this if you have a problem with discoloring on composite video or S-Video (issue thread at shmups)
      Btw: this is default for all earlier version of the modding board flashed with the current firmware. If you need the other color carrier, just go back to a previous version.
    • SJ63.2: outputs color carrier derived from dejittered clock.
      (I personally need to use this clock as my TV does not like the color carrier from non-dejittered clock)
    • Again: You must not close both jumpers!
  • SJ93: (since SMR20200323) controls sync level of buffered csync output. Sync level:
    • opened: appr. 1.87V @ 75ohm termination i.e. needs a resistor inside the sync wire further attanuating the signal. Designed to work for cables with 470 ohm resistor inside resulting in appr. 450mV @ 75ohm termination
    • closed: appr. 300mV @ 75ohm termination suitable for pass through wired cables at sync, works with standard TV / scaler setup

Firmware

U1, U2, U3 and U5 need a firmware flashed to the chip. U1 and U2 have to be programmed prior to assembly whereas the PCB provides ICSP headers for the other ones.

Use a PICKit, TL866CS or similar programmer.

  • U3: ATMEL CPLDs: ATF1502ASV or ATF1504ASV(L) CPLD with clock switch, region patch and de-jitter firmware. Pre-build firmware only supports SMR20190813 (and later) modding boards.

Use an OpenOCD compatible JTAG programmer. I tested the workflow with an Adafruit FT232H Breakout Board, yet you can use any other JTAG programmer that supports 3.3V IO signal levels.

  1. Create an openocd.conf that matches your JTAG programmer. A configuration files for FT2232-based and FT2232H programmers are found in the firmware folder. They use following standard pinout for data signals:
  • ADBUS0 -> TCK
  • ADBUS1 -> TDI
  • ADBUS2 -> TDO
  • ADBUS3 -> TMS
  1. Connect the JTAG programmer the modding board, except for Vref! Power the board via 5V during programming. This can be done by using the DFO programmer connected with V_target set to 5V (or 3.3V) if the modding board is not installed yet (other power solutions are possible, but please use the 5V power supply rail to not harm the DC converters. Or you can simply switch on the SNES for programming. Of course, the CPLD can be also flashed prior to assembly if you have a proper adapter at hand.
  2. Initialize the JTAG connection:
openocd -f openocd-ft2232h.conf

OpenOCD should detect the JTAG chain without any errors. If you have any, just double-check if everything is well connected and the CPLD is powered.

  1. When successful, open another terminal to interact with openocd and program the chip:
telnet localhost 4444
> svf <full_path_to_svf_file>

Wait for the program to be finished.

Use an Altera USB Blaster (or clone) for flashing the firmware.

After assembly, the modding board has to be powered for flashing the firmware. This can be done by using the DFO programmer connected with V_target set to 5V (or 3.3V) if the modding board is not installed yet (other power solutions are possible, but please use the 5V power supply rail to not harm the DC converters. Or you can simply switch on the SNES for programming. Of course, the CPLD can be also flashed prior to assembly if you have a proper adapter at hand.

Use the DFO programmer to flash the PLL. The DFO readme describes how to properly perform the flashing. I alternatively wrote a program for Arduino boards to flash the CDCE913 with the I2C interface of the Arduino. I tested the code with an Arduino Nano and Arduino Nano Every.

Installation Notes

Manufacturing the PCB

You can choose any manufacturer which you prefer. All files for manufacturing including the design files are provided in subfolder pcb/gerber/pcb/. As the PCB is designed in EAGLE (current version 7.4.2), gerbers are exported in the actual format. However, some services have problem while automatically analyze those like OSHPark or JCLPCB. Please try the older format in pcb/gerber/pcb.eagle_legacy_export/.

IMPORTANT Please use a substrate thickness of 0.8mm in order to make installation easier.

Assembly

Sourcing the Parts

For sourcing the parts, please be referred to the Bill Of Materials

Soldering

The PCB is designed with having hand soldering in mind. Most complicated footprints are probably the 44TQFP package of the CPLD or the 14TSSOP of the CDCE913.

However, if you plan to use a stencil, you can use the stencil gerber file. All SMDs are placed in top layer.

IMPORTANT SuperCIC (PIC16F630-I/SL) and uIGR (PIC16F684-I/SL) need firmware flashed prior to soldering as mentioned later in this document.

Installation

This is not a complete installation manual. It's moreover a general overview on 'HowTo'. Installation manuals are provided in the subfolder installation once ready. I cannot test every single mainboard revision (there are too many out there), so the installation folder will grow from time to time once I see a proper report of an installation or I did an installation on a specific mainboard version on my own.

Preparation of SNES
General Steps
  • remove original CIC-lock (or at least lift pins 1, 2, 10 and 11)
  • remove LED from front panel (large SNES only)
Specific Steps for 1Chip-SNES
  • lift pin 111 from S-CPUN
  • remove X1
  • lift pin 9 from S-RGB (or cut encoding mode jumper at bottom side of SNES mainboard (NTSC board revisions))
Specific Steps for Non-1Chip-SNES
  • lift pin 24 of S-PPU1 and pin 30 of S-PPU2
  • disconnect Master-Clock
    • SNSP-CPU-01/02: lift pin 4 of the S-CLK or remove R73 (0ohm jumper)
    • different methods for NTSC mainboards
  • lift CSYNC input pin of the video encoder
    • pin 8 of S-ENC
    • pin 7 of S-RGB
  • if you want to switch color carrier:
    • PAL: lift pin 5 of the S-CLK
    • NTSC: lift pin 3 of the S-PPU2
    • SNES with S-ENC: lift pin 19 (or cut encoding mode jumper at bottom side of SNES mainboard (NTSC board revisions))
    • SNES with S-RGB: lift pin 9 (or cut encoding mode jumper at bottom side of SNES mainboard (NTSC board revisions))
Installation of PCB
General Steps
  • Solder PCB in place under the cartridge slot. Be aware of the orientation (pin marking must match)
  • put the replacement dual LED where the original was (use a small piece of hot glue if needed)...
    ... or in SNES2 / Jr. think of a good place where the replacement LED can be if you want to use it...
    ... and connect the common pole to either Ground or Vcc (common cathod or anode, respectively)
  • connect pads Rst.o, Rst.i, LED.Re, LED.Gr, Ctrl.port.10-6, Vmode, /CS.i, /CS.o (raw) according to their description
  • either connect Clk.CIC pad (preferable) or close jumper SJ11
  • close jumper SJ21 if you use a LED with common anode
Specific Step for 1Chip-SNES
  • connect MCLK.o to X1 (the side which is connected to S-CPUN pin 9)
  • connect /Vmode to S-RGB pin 9
  • (color carrier is switched by S-CPUN so there is no need to connect CClk.o)
Specific Step for Non-1Chip-SNES
  • close SJ32 and SJ61
  • if you plan to switch color carrier:
    • connect CClk.o to either pad 3 of S-PPU2 (NTSC) or to pad 5 of S-CLK (PAL)
    • connect /Vmode to S-ENC pin 19 / S-RGB pin 9

Using a Modded SNES with Flashcards

In general, using flashcards like the sd2snes, SuperEverdrive and PowerPak together with the region patching activated is not a good idea. I try to explain why!

First of all, one has to understand how a region patch works. In the S-PPU2 register $213F bit 4 shows whether the SNES is running in NTSC-mode or in PAL-mode (set up using S-PPU2 pin 30 or S-CPUN pin 111). Many games are checking this register on start-up (or during the gameplay) and check the value on bit 4. NTSC-games expect a '0' whereas PAL-games a '1'. If the bit does not return the required value, the game ends with 'This gamepak is not designed for your SFC/SNES' or similar. A region patch observes the address bus B and recognizes a request of $213F. Then the patch forces on the data bus bit 4 GND or Vcc by simply 'beating'/'overdriving' the output of the S-PPU2.

An important point is how the region patch 'knows' which value has to be written. On this modding PCB the SuperCIC-lock outputs the value on pin 3. The bit is determined using the CIC-key found on the cartridge. And this is the point where flash-cards become 'critical' for the region patch. As the SuperCIC-lock only checks the region of the cartridge using the CIC-key, the SuperCIC-lock CANNOT know which region the loaded ROM is. The overwritten value on bit 4 during a $213F request might be incorrect! As flashcards have there own region patching (at least the sd2snes; I don't own a SuperEverdrive or PowerPak) you can simply switch off the region patch of the modding PCB (using Sel+L+R+Dw; LED-code: red-off-red).

A very last remark to the sd2snes:

As the SuperCIC-lock is part of the sd2snes project, there is another solution: the so-called 'Pairmode'. The pairmode is available with the firmware v0.1.7 preview 4 or later. In the Pairmode the SuperCIC-lock goes into a pairmode-loop with the sd2snes. In this loop, forced region, LED status and the ROM region is constantly updated.

To change the forced region (and thus the LED-state) using the sd2snes (via the config.yml or the option GUI -> SuperCIC Settings), the uIGR has to be in the SuperCIC-mode (using Sel+L+R+Le / Sel+L+R+Ri) as the uIGR is master and the SuperCIC-lock slave regarding the region set to the SNES. As the ROM region is updated constantly, the region patch on the modding PCB can be left on. I recommend to switch the sd2snes-own region patch off in this case (via the config.yml or the option GUI -> In-game Settings).