Merge pull request #95 from fluxcorenz/FlatboxRev4-support

Flatbox Revision 4 support

configs/FlatboxRev4/BoardConfig.h

@@ -0,0 +1,183 @@
+/*
+ * SPDX-License-Identifier: MIT
+ * SPDX-FileCopyrightText: Copyright (c) 2021 Jason Skuby (mytechtoybox.com)
+ */
+
+#ifndef FLATBOX_REV4_CONFIG_H_
+#define FLATBOX_REV4_CONFIG_H_
+
+#include <GamepadEnums.h>
+
+
+// Mapping between Flatbox Rev4 switch number (as silkscreened) and GPIO pin
+
+#define FLATBOX_SW1_PIN    6
+#define FLATBOX_SW2_PIN    5
+#define FLATBOX_SW3_PIN    4
+#define FLATBOX_SW4_PIN    3
+#define FLATBOX_SW5_PIN    2
+#define FLATBOX_SW6_PIN    1
+#define FLATBOX_SW7_PIN    9  // LEFT
+#define FLATBOX_SW8_PIN    10 // DOWN
+#define FLATBOX_SW9_PIN    11 // RIGHT
+#define FLATBOX_SW10_PIN   18 // P1 / SQUARE
+#define FLATBOX_SW11_PIN   25 // P2 / TRIANGLE
+#define FLATBOX_SW12_PIN   27 // P3
+#define FLATBOX_SW13_PIN   29 // P4
+#define FLATBOX_SW14_PIN   19 // K1 / CROSS
+#define FLATBOX_SW15_PIN   24 // K2 / CIRCLE
+#define FLATBOX_SW16_PIN   26 // K3
+#define FLATBOX_SW17_PIN   28 // K4
+#define FLATBOX_SW18_PIN   16 // UP / THUMB
+
+
+// This is the main pin definition section.
+// This will let you specify which GPIO pin each button is assigned too.
+// You can set any of the main pins as `-1` to disable it.
+// The Turbo pin and LS + RS slider pins can also be set to `-1` to disable that functionality.
+// Please note that only when `PIN_BUTTON_TURBO` is set to `-1` will the `T##` be removed from a connected display.
+// Please note that only when `PIN_SLIDER_LS` and  `PIN_SLIDER_RS` are set to `-1` will the button combo shortcut for DP/LS/RS work.
+// The buttons are listed in GP2040 configuration, beside each the listed order is *GP2040 / Xinput / Switch / PS3 / Directinput / Arcade*
+
+#define PIN_DPAD_UP     FLATBOX_SW18_PIN         // DOWN
+#define PIN_DPAD_DOWN   FLATBOX_SW8_PIN          // UP
+#define PIN_DPAD_RIGHT  FLATBOX_SW9_PIN          // RIGHT
+#define PIN_DPAD_LEFT   FLATBOX_SW7_PIN          // LEFT
+#define PIN_BUTTON_B1   FLATBOX_SW14_PIN         // B1 / A / B / Cross / 2 / K1
+#define PIN_BUTTON_B2   FLATBOX_SW15_PIN         // B2 / B / A / Circle / 3 / K2
+#define PIN_BUTTON_R2   FLATBOX_SW16_PIN         // R2 / RT / ZR / R2 / 8 / K3
+#define PIN_BUTTON_L2   FLATBOX_SW17_PIN         // L2 / LT / ZL / L2 / 7 / K4
+#define PIN_BUTTON_B3   FLATBOX_SW10_PIN         // B3 / X / Y / Square / 1 / P1
+#define PIN_BUTTON_B4   FLATBOX_SW11_PIN         // B4 / Y / X / Triangle / 4 / P2
+#define PIN_BUTTON_R1   FLATBOX_SW12_PIN         // R1 / RB / R / R1 / 6 / P3
+#define PIN_BUTTON_L1   FLATBOX_SW13_PIN         // L1 / LB / L / L1 / 5 / P4
+#define PIN_BUTTON_S1   FLATBOX_SW2_PIN          // S1 / Back / Minus / Select / 9 / Coin
+#define PIN_BUTTON_S2   FLATBOX_SW1_PIN          // S2 / Start / Plus / Start / 10 / Start
+#define PIN_BUTTON_L3   FLATBOX_SW5_PIN          // L3 / LS / LS / L3 / 11 / LS
+#define PIN_BUTTON_R3   FLATBOX_SW6_PIN          // R3 / RS / RS / R3 / 12 / RS
+#define PIN_BUTTON_A1   FLATBOX_SW3_PIN          // A1 / Guide / Home / ~ / 13 / ~
+#define PIN_BUTTON_A2   FLATBOX_SW4_PIN          // A2 / ~ / Capture / ~ / 14 / ~
+#define PIN_BUTTON_TURBO -1         // Turbo
+#define PIN_SLIDER_LS    -1         // Left Stick Slider
+#define PIN_SLIDER_RS    -1         // Right Stick Slider
+
+
+// This is the SOCD section.
+// SOCD stands for `simultaneous opposing cardinal directions`.
+// There are three options for `DEFAULT_SOCD_MODE` currently:
+// 1 - `SOCD_MODE_NEUTRAL` - This is a neutral SOCD.  EG. when you press `up` + `down` no input will be registered.
+// 2 - `SOCD_MODE_UP_PRIORITY` - This is up priority SOCD.  EG. when you press `up` + `down` `up` will be registered.
+// 3 - `SOCD_MODE_SECOND_INPUT_PRIORITY` - This is last priority SOCD.  EG. when you press and hold `up` then press `down` `down` will be registered.
+
+#define DEFAULT_SOCD_MODE SOCD_MODE_NEUTRAL
+
+
+// This is the LEDs section.
+// The default `TURBO_LED_PIN` pin is set to `15` ( it is recommended to run through 3V3(OUT) with a resistor)
+// The Turbo LED will flash at a speed consistant with the set speed of the Turbo when a Turbo button is active.
+// It is recommended to disable the `TURBO_LED_PIN` by setting it to `-1` if you are sensitive of flashing lights.
+// The default `BOARD_LEDS_PIN` pin is set to `28`.
+// The board LED pin will allow you to connect addressible RGB LEDs on the Pico.
+// Addressible RGB LEDs should be connected to the `VBUS` pin (#40), an avalible ground pin and the defined `BOARD_LEDS_PIN`.
+// Special note - You should only ever use addressible RGB LEDs that are rated for 5v operation on the Pico.
+// The defualt `LED_BRIGHTNESS_MAXIMUM` value is `50`.
+// This will change how bright the LEDs are with `0` being off and `100` being full brightness.
+// The minimum `LED_BRIGHTNESS_MAXIMUM` value is `0`.
+// The maximum `LED_BRIGHTNESS_MAXIMUM` value is `100`.
+// The defualt `LED_BRIGHTNESS_STEPS` value is `5`.
+// This will change how many brightness steps there are when increasing or decreasing the brightness of the LEDs via the onboard shortcut.
+// It is recommend to keep this value at `5` or `10`.
+// The defualt `LED_FORMAT` is `LED_FORMAT_GRB`.
+// You can also choose the `LED_FORMAT` of `LED_FORMAT_RGB` if your addressible RGB LEDs are not working as intended.
+// The defualt `LEDS_PER_PIXEL` is set to `1`.
+// This will change how many addressible RGB LEDs there are per button.
+// The default LEDS_[BUTTON] is an order and has nothing to do with what GPIO pin something is connected to.
+// Unless you are planning on running custom animations I would recommmend you leave this as is.
+
+#define TURBO_LED_PIN -1
+#define BOARD_LEDS_PIN -1
+
+
+// This is the Player LED section.
+// In this section you can specify if Player LEDs will be active, and, if active, which pins will be used for them.
+// The defualt is `PLED_TYPE_NONE` which will turn the Player LEDs off.
+// The default pin for each Player LED is `-1` which disables it.
+// To enable a `PLED#_PIN`, replace the `-1` with the GPIO pin number that is desired.
+// There are three options for `PLED_TYPE` currently:
+// 1 - `PLED_TYPE_NONE` - This will disable the Player LEDs
+// 2 - `PLED_TYPE_PWM` - This will enable the Player LEDs ( it is recommended to run through 3V3(OUT) with a resistor)
+// 3 - `PLED_TYPE_RGB` - This will enable the Player LEDs as addressible RGB LEDs (please not that this has not been implemented yet)
+
+#define PLED_TYPE PLED_TYPE_NONE
+#define PLED1_PIN -1
+#define PLED2_PIN -1
+#define PLED3_PIN -1
+#define PLED4_PIN -1
+
+
+// This is the Analog section.
+// In this section you can specify if Analog is enabled, and, if endabled, which pins will be used for it.
+// The default for `ANALOG_ADC_VRX` and `ANALOG_ADC_VRY` is `-1` which disables them.
+// To enable a `ANALOG_ADC_VRX` and `ANALOG_ADC_VRY`, replace the `-1` with the GPIO pin numbers that are desired.
+
+#define ANALOG_ADC_VRX -1
+#define ANALOG_ADC_VRY -1
+
+
+// This is the I2C Display section (commonly known as the OLED display section).
+// In this section you can specify if a display as been enabled, which pins are assined to it, the block address and speed.
+// The default for `HAS_I2C_DISPLAY` is `1` which enables it.
+// To disable the display you can change `HAS_I2C_DISPLAY` to `0`.
+// The default `I2C_SDA_PIN` is `0`.
+// The defualt `I2C_SCL_PIN` is `1`.
+// The defualt `I2C_BLOCK` is `12c0`.
+// If you change the `I2C_SDA_PIN` and `I2C_SCL_PIN` pin mapping, you may need to change the `I2C_BLOCK` as well.
+// The defualt `I2C_SPEED` is `400000`.
+// This should be more than fast enough for most displays.
+// Some smaller displays (like 0.96" and 1.31") can go up to `800000` or even `1000000`.
+// The default `DISPLAY_FLIP` is `0`.
+// This can be changed to `1` to have the dispaly output flipped.
+// The default `DISPLAY_INVERY` is `0`.
+// This can be changed to `1` to have the color on the display inverted.
+
+#define HAS_I2C_DISPLAY 0
+
+
+// The default `SPLASH_MODE` is `NOSPLASH`.
+// There are four options for `SPLASH_MODE` currently:
+// 1 - `STATICSPLASH` - This will display the static splash image
+// 2 - `CLOSEIN` - This will display the static splash image as a top and bottom coming together animation
+// 3 - `CLOSEINCUSTOM` - This will display the custom splash image as a top and bottom coming together animation
+// 4 - `NOSPLASH` - This will not display a splash screen on boot
+// Special note - All of the splash screen images can be changed via `include/bitmaps.h`
+
+#define SPLASH_MODE NOSPLASH
+
+
+// The default `BUTTON_LAYOUT` is `BUTTON_LAYOUT_STICK` which will show an arcade stick on the left hand side of the display.
+// There are seven options for `BUTTON_LAYOUT` currently:
+// 1 - BUTTON_LAYOUT_STICK - This is a basic joystick layout
+// 2 - BUTTON_LAYOUT_STICKLESS - This is a basic stickless (all button) layout
+// 3 - BUTTON_LAYOUT_BUTTONS_ANGLED - This a WASD button layout that is angled
+// 4 - BUTTON_LAYOUT_BUTTONS_BASIC - This a WASD button layout that is straight
+// 5 - BUTTON_LAYOUT_KEYBOARD_ANGLED - This is a WASD keyboard layout that is angled
+// 6 - BUTTON_LAYOUT_KEYBOARDA - This is a WASD keyboard layout that is straight
+// 7 - BUTTON_LAYOUT_DANCEPADA - This is a dance pad layout (must be used with `BUTTON_LAYOUT_DANCEPADB` in `BUTTON_LAYOUT_RIGHT`)
+// The default `BUTTON_LAYOUT_RIGHT` is `BUTTON_LAYOUT_NOIR8` which will show eight buttons on the right hand side of the display.
+// There are eleven options for `BUTTON_LAYOUT_RIGHT` currently:
+// 1 - BUTTON_LAYOUT_ARCADE - This is a standard 8 button arcade layout
+// 2 - BUTTON_LAYOUT_STICKLESSB - This is a basic stickless (all button) layout
+// 3 - BUTTON_LAYOUT_BUTTONS_ANGLEDB - This is a standard 8 button arcade layout that is angled
+// 4 - BUTTON_LAYOUT_VEWLIX - This is the standard 8 button Vewlix layout
+// 5 - BUTTON_LAYOUT_VEWLIX7 - This is the standard 7 button Vewlix layout
+// 6 - BUTTON_LAYOUT_CAPCOM - This is the standard 8 button Capcom layout
+// 7 - BUTTON_LAYOUT_CAPCOM6 - This is the stndard 6 button Capcom layout
+// 8 - BUTTON_LAYOUT_SEGA2P - This is the standard 8 button Sega2P layout
+// 9 - BUTTON_LAYOUT_NOIR8 - This is the standard 8 button Noir layout
+// 10 - BUTTON_LAYOUT_KEYBOARDB - This is a WASD keyboard layout that is straight
+// 11 - BUTTON_LAYOUT_DANCEPADB - This is a dance pad layout (must be used with `BUTTON_LAYOUT_DANCEPADA` in `BUTTON_LAYOUT`)
+
+#define BUTTON_LAYOUT BUTTON_LAYOUT_STICKLESS
+#define BUTTON_LAYOUT_RIGHT BUTTON_LAYOUT_STICKLESS
+
+#endif

configs/FlatboxRev4/Readme.md

@@ -0,0 +1,5 @@
+# GP2040 Configuration for Flatbox Rev 4
+
+![Flatbox](assets/Flatbox-rev2b-finished-product.jpg)
+
+Configuration for the [Flatbox Rev 4](https://github.com/jfedor2/flatbox/tree/master/hardware-rev4), one of the excellent revisions of the [Flatbox](https://github.com/jfedor2/flatbox) design by [jfedor2](https://github.com/jfedor2) powered by an RP2040 MCU.

configs/FlatboxRev4/env.ini

@@ -0,0 +1,5 @@
+[env:flatbox-rev-4]
+upload_port = .pio/build/flatbox-rev-4/
+build_flags =
+	${env.build_flags}
+	-I configs/FlatboxRev4/