Merge pull request #29 from sadekbaroudi/fp/vik_complete_module_suppo…

…rt_ximega_test

better generic vik support to handle all modules in one go

keyboards/fingerpunch/FP_LIBRARY_SUPPORT.md

@@ -61,6 +61,7 @@ For an example, see `keyboards/fingerpunch/ximi/config.h`, which uses the `FP_ST
 #define FP_STARTUP_LIGHT_EXT HALF_NOTE(_E6), HALF_NOTE(_F6), HALF_NOTE(_C6), WHOLE_NOTE(_A5), WHOLE_DOT_NOTE(_F5), WHOLE_DOT_NOTE(_D5), WHOLE_DOT_NOTE(_G5), WHOLE_DOT_NOTE(_C5),
 #define FP_STARTUP_DARK  HALF_DOT_NOTE(_B5), QUARTER_NOTE(_B5), HALF_NOTE(_E6), HALF_NOTE(_REST), QUARTER_NOTE(_C6), QUARTER_NOTE(_REST), QUARTER_NOTE(_G5), QUARTER_NOTE(_E5), QUARTER_NOTE(_F5), QUARTER_NOTE(_GS5), QUARTER_NOTE(_G5), QUARTER_NOTE(_F5), WHOLE_NOTE(_G5),
 #define FP_MARIO QUARTER_NOTE(_E5), QUARTER_NOTE(_E5), QUARTER_NOTE(_REST), QUARTER_NOTE(_E5), QUARTER_NOTE(_REST), QUARTER_NOTE(_C5), QUARTER_NOTE(_E5), QUARTER_NOTE(_REST), QUARTER_NOTE(_G5), HALF_DOT_NOTE(_REST), QUARTER_NOTE(_G4),
+#define FP_STARTUP_XIMEGA WHOLE_NOTE(_FS5), QUARTER_NOTE(_A5), HALF_DOT_NOTE(_B5), WHOLE_NOTE(_D6), QUARTER_NOTE(_REST), HALF_DOT_NOTE(_B5), HALF_DOT_NOTE(_FS5), HALF_DOT_NOTE(_D5), HALF_DOT_NOTE(_E5), HALF_NOTE(_REST), HALF_DOT_NOTE(_D5), HALF_DOT_NOTE(_B4),
 ```
 
 ### Shared RGB effects

keyboards/fingerpunch/README.md

@@ -84,6 +84,7 @@ Note: if you are using a userspace, and you have custom keycodes, you will need
     || defined(KEYBOARD_fingerpunch_sweeeeep) \
     || defined(KEYBOARD_fingerpunch_vulpes_minora) \
     || defined(KEYBOARD_fingerpunch_vulpes_majora_v1) \
+    || defined(KEYBOARD_fingerpunch_ximega) \
     || defined(KEYBOARD_fingerpunch_ximi)
 #    define PLACEHOLDER_SAFE_RANGE FP_SAFE_RANGE
 #else
@@ -334,7 +335,7 @@ When using a fingerpunch board, the get_haptic_enabled_key is completely overrid
 * NO_HAPTIC_PUNCTUATION
 * etc...
 
-See https://github.com/qmk/qmk_firmware/blob/master/docs/feature_haptic_feedback.md#haptic-key-exclusion for details
+See https://github.com/qmk/qmk_firmware/blob/master/docs/features/haptic_feedback.md#haptic-key-exclusion for details
 
 If you'd like to override this, you'll need to create a function as follows:
 `bool get_haptic_enabled_key_user(uint16_t keycode, keyrecord_t *record)`
@@ -364,15 +365,45 @@ Note that the ctrl-X audio responses will use control as the modifier, so it won
 
 | Setting                                 | Description                                                                     | Default                         |
 | --------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------- |
-| `FP_AUDIO_MOUSE_BUTTONS`               | (Optional) Enable audio response for Mouse 1, 2, and 3                           | `undefined`                     |
-| `FP_AUDIO_CUT_COPY_PASTE`              | (Optional) Enable audio response for ctrl-x, ctrl-c, ctrl-v                      | `undefined`                     |
-| `FP_AUDIO_SAVE`                        | (Optional) Enable audio response for ctrl-s                                      | `undefined`                     |
-
-
-## Keymap
-
-If you are looking to use process_record_kb() or process_record
-
+| `FP_AUDIO_MOUSE_BUTTONS`                | (Optional) Enable audio response for Mouse 1, 2, and 3                          | `undefined`                     |
+| `FP_AUDIO_CUT_COPY_PASTE`               | (Optional) Enable audio response for ctrl-x, ctrl-c, ctrl-v                     | `undefined`                     |
+| `FP_AUDIO_SAVE`                         | (Optional) Enable audio response for ctrl-s                                     | `undefined`                     |
+
+## VIK
+
+VIK features are automatically integrated when a keyboard is properly configured using the fingerpunch VIK library. If you'd like to support these VIK features, please see the [FP_LIBRARY_SUPPORT](./FP_LIBRARY_SUPPORT.md) page
+
+All fingerpunch boards with a VIK connector support the features below. When compiling, you can add the flags below. Please note that the `*_RIGHT` features are for split boards only, and that pointing devices will require additional configuration to change orientation or invert the axis. See the [QMK documentation for pointing devices](https://github.com/qmk/qmk_firmware/blob/master/docs/features/pointing_device.md#common-configuration) if you need to change the pointing orientation.
+
+Important notes:
+* For split keyboards with **different** pointing devices (i.e. cirque on left, and trackball on right), you must build two separate firmwares, one for each half. You must specify `VIK_BUILD_LEFT=yes` as a parameter when compiling the left, and `VIK_BUILD_RIGHT=yes` when compiling the right. Then you need to flash each firmware on each respective half.
+* For split keyboards, the fingerpunch VIK logic will set `VIK_BUILD_LEFT` and `VIK_BUILD_RIGHT` so that you can check what the user configured. This can be checked with `#ifdef VIK_BUILD_LEFT` or `#ifdef VIK_BUILD_RIGHT`
+* All encoder functions in VIK modules do not support any click function of the encoder.
+* For all of the items below, please see the [VIK repository certifications](https://github.com/sadekbaroudi/vik?tab=readme-ov-file#known-list-of-vik-certifications) in the modules section for details on the hardware.
+
+| Rules.mk                                |  Split Use  | Description                                                                                                                                                                                         |
+| --------------------------------------- | ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `VIK_ENABLE=yes`                        |    Both     | Enables the VIK code, this should always be yes if the keyboard has a VIK connector that meets specifications                                                                                       |
+| `VIK_BUILD_LEFT=yes`                    |    Left     | **If and only if** you have different pointing devices on each half, you must specify this when compiling firmware for the left, and then flash that firmware on the left only                      |
+| `VIK_BUILD_RIGHT=yes`                   |    Right    | **If and only if** you have different pointing devices on each half, you must specify this when compiling firmware for the right, and then flash that firmware on the right only                    |
+| `VIK_HAPTIC=yes`                        |    Both     | Enables haptic feedback on both sides of the keyboard, requires `#define SPLIT_HAPTIC_ENABLE`                                                                                                       |
+| `VIK_ILI9341=yes`                       |    Left     | Enables ILI9341 display, see [qmk quantum painter](https://github.com/qmk/qmk_firmware/blob/master/docs/quantum_painter.md)                                                                         |
+| `VIK_PER56_CIRQUE_LEDS=yes`             |    Left     | Enables PER56 encoder and cirque trackpad, note that the keyboard firmware should enable RGB leds since the number of LEDs can vary, use `#ifdef VIK_PER56_CIRQUE_LEDS` to check if this is enabled |
+| `VIK_PER56_PMW3360_LEDS=yes`            |    Left     | Enables PER56 encoder and pmw3360, note that the keyboard firmware should enable RGB leds since the number of LEDs can vary, use `#ifdef VIK_PER56_PMW3360_LEDS` to check if this is enabled        |
+| `VIK_PMW3360=yes`                       |    Left     | Enables pmw3360, note that the keyboard firmware should set orientation, use `#ifdef VIK_PMW3360` to check if this is enabled                                                                       |
+| `VIK_WEACT_ST7735=yes`                  |    Left     | Enables WeAct ST7735 display, see [qmk quantum painter](https://github.com/qmk/qmk_firmware/blob/master/docs/quantum_painter.md)                                                                    |
+| `VIK_GC9A01=yes`                        |    Left     | Enables GC9A01 display, see [qmk quantum painter](https://github.com/qmk/qmk_firmware/blob/master/docs/quantum_painter.md)       .                                                                  |
+| `VIK_WAVESHARE_22224=yes`               |    Left     | Enables Waveshare 22224 display, see [qmk quantum painter](https://github.com/qmk/qmk_firmware/blob/master/docs/quantum_painter.md)                                                                 |
+| `VIK_AZOTEQ=yes`                        |    Left     | Enables azoteq trackpad, note that the keyboard firmware should set orientation and trackpade size, use `#ifdef VIK_AZOTEQ` to check if this is enabled                                             |
+| `VIK_EC11_EVQWGD001=yes`                |    Left     | Enables encoders in QMK. Because a keyboard can have existing encoders, the pin configuration must happen at the keyboard. Use `#ifdef VIK_EC11_EVQWGD001` to check if this is enabled.             |
+| `VIK_CIRQUE=yes`                        |    Left     | Enables cirque trackpad via SPI, note that the keyboard firmware should set orientation, use `#ifdef VIK_CIRQUE` to check if this is enabled                                                        |
+| `VIK_TRACKPOINT=yes`                    |    Left     | Enables PS/2 trackpoint. This does **not** support split pointing, so it must be on the master half                                                                                                 |
+| `VIK_CIRQUE_RIGHT=yes`                  |    Right    | Same as above, but equivalent for the right half of a split board. Do not set this if you aren't using a split keyboard. See section header above about determining which device is on which half.  |
+| `VIK_PER56_CIRQUE_LEDS_RIGHT=yes`       |    Right    | Same as above, but equivalent for the right half of a split board. Do not set this if you aren't using a split keyboard. See section header above about determining which device is on which half.  |
+| `VIK_PER56_PMW3360_LEDS_RIGHT=yes`      |    Right    | Same as above, but equivalent for the right half of a split board. Do not set this if you aren't using a split keyboard. See section header above about determining which device is on which half.  |
+| `VIK_PMW3360_RIGHT=yes`                 |    Right    | Same as above, but equivalent for the right half of a split board. Do not set this if you aren't using a split keyboard. See section header above about determining which device is on which half.  |
+| `VIK_AZOTEQ_RIGHT=yes`                  |    Right    | Same as above, but equivalent for the right half of a split board. Do not set this if you aren't using a split keyboard. See section header above about determining which device is on which half.  |
+| `VIK_EC11_EVQWGD001_RIGHT=yes`          |    Right    | Same as above, but equivalent for the right half of a split board. Do not set this if you aren't using a split keyboard.                                                                            |
 
 ## Debugging
 

keyboards/fingerpunch/arachnophobe/config.h

@@ -40,3 +40,5 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #define LOCKING_SUPPORT_ENABLE
 /* Locking resynchronize hack */
 #define LOCKING_RESYNC_ENABLE
+
+#include "keyboards/fingerpunch/src/config_post.h"

keyboards/fingerpunch/barobord/config.h

@@ -116,3 +116,4 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 /* Locking resynchronize hack */
 #define LOCKING_RESYNC_ENABLE
 
+#include "keyboards/fingerpunch/src/config_post.h"

keyboards/fingerpunch/barobord_byomcu/config.h

@@ -116,3 +116,4 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 /* Locking resynchronize hack */
 #define LOCKING_RESYNC_ENABLE
 
+#include "keyboards/fingerpunch/src/config_post.h"

keyboards/fingerpunch/bgkeeb/config.h

@@ -99,3 +99,5 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 //#define NO_ACTION_ONESHOT
 //#define NO_ACTION_MACRO
 //#define NO_ACTION_FUNCTION
+
+#include "keyboards/fingerpunch/src/config_post.h"

keyboards/fingerpunch/bigbarobord/config.h

@@ -121,3 +121,4 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 // If using encoder type 2, uncomment this
 // #define ENCODERS_B_REVERSE
 
+#include "keyboards/fingerpunch/src/config_post.h"

keyboards/fingerpunch/euclid36/config.h

@@ -79,3 +79,5 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #define LOCKING_SUPPORT_ENABLE
 /* Locking resynchronize hack */
 #define LOCKING_RESYNC_ENABLE
+
+#include "keyboards/fingerpunch/src/config_post.h"

keyboards/fingerpunch/ffkb/atmega/v1/config.h

@@ -139,3 +139,4 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 // If using encoder type 2, uncomment this
 // #define ENCODERS_B_REVERSE
 
+#include "keyboards/fingerpunch/src/config_post.h"

keyboards/fingerpunch/ffkb/byomcu/v1/config.h

@@ -63,3 +63,5 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
   #define I2C1_CLOCK_SPEED  400000
   #define I2C1_DUTY_CYCLE FAST_DUTY_CYCLE_2
 #endif
+
+#include "keyboards/fingerpunch/src/config_post.h"

keyboards/fingerpunch/ffkb/byomcu/v2/config.h

@@ -96,3 +96,5 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
     #define FP_HAPTIC_CUT_COPY_PASTE
     #define FP_HAPTIC_SAVE
 #endif
+
+#include "keyboards/fingerpunch/src/config_post.h"

keyboards/fingerpunch/ffkb/byomcu/v3/config.h

@@ -79,3 +79,4 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
   #define POINTING_DEVICE_INVERT_Y
 #endif
 
+#include "keyboards/fingerpunch/src/config_post.h"

keyboards/fingerpunch/ffkb/lite/v1/config.h

@@ -38,4 +38,6 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
     { D3, D2, B2, B6 }
 #define MATRIX_COL_PINS \
     { B4, E6, D7, C6, D4, B5, F4, F5, F6, F7, B1, B3 }
-#endif
+#endif
+
+#include "keyboards/fingerpunch/src/config_post.h"

keyboards/fingerpunch/ffkb/rp/v0/config.h

@@ -119,3 +119,5 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
     #define FP_HAPTIC_CUT_COPY_PASTE
     #define FP_HAPTIC_SAVE
 #endif
+
+#include "keyboards/fingerpunch/src/config_post.h"

keyboards/fingerpunch/fflx/config.h

@@ -85,3 +85,5 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #define LOCKING_SUPPORT_ENABLE
 /* Locking resynchronize hack */
 #define LOCKING_RESYNC_ENABLE
+
+#include "keyboards/fingerpunch/src/config_post.h"

keyboards/fingerpunch/fpm101/config.h

@@ -200,3 +200,4 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
   #define POINTING_DEVICE_INVERT_Y
 #endif
 
+#include "keyboards/fingerpunch/src/config_post.h"

keyboards/fingerpunch/kucheza/config.h

@@ -141,4 +141,4 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 //   #define POINTING_DEVICE_INVERT_Y
 // #endif
 
-#include "keyboards/fingerpunch/src/config_post.h"
+#include "keyboards/fingerpunch/src/config_post.h"

keyboards/fingerpunch/luakeeb/config.h

@@ -89,3 +89,5 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 //#define NO_ACTION_ONESHOT
 //#define NO_ACTION_MACRO
 //#define NO_ACTION_FUNCTION
+
+#include "keyboards/fingerpunch/src/config_post.h"

keyboards/fingerpunch/personal/baboon38/config.h

@@ -31,4 +31,6 @@
 
     // To dynamically control the backlight with BL_TOGG keycode
     #define BACKLIGHT_PIN GP24
-#endif
+#endif
+
+#include "keyboards/fingerpunch/src/config_post.h"

keyboards/fingerpunch/personal/badwings/config.h

@@ -27,3 +27,5 @@
   #define POINTING_DEVICE_TASK_THROTTLE_MS 5
   #define CIRQUE_PINNACLE_DIAMETER_MM 35
 #endif
+
+#include "keyboards/fingerpunch/src/config_post.h"

keyboards/fingerpunch/personal/badwings_v2/config.h

@@ -19,4 +19,4 @@
 #define CIRQUE_PINNACLE_DIAMETER_MM 35
 #define POINTING_DEVICE_ROTATION_90
 
-#include "keyboards/fingerpunch/src/config_post.h"
+#include "keyboards/fingerpunch/src/config_post.h"

keyboards/fingerpunch/personal/barghoot/config.h

@@ -91,3 +91,5 @@
 #define RGB_MATRIX_LED_COUNT 63
 
 #endif // defined(RGB_MATRIX_ENABLE)
+
+#include "keyboards/fingerpunch/src/config_post.h"

keyboards/fingerpunch/personal/euclid36proto/config.h

@@ -75,3 +75,5 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #define LOCKING_SUPPORT_ENABLE
 /* Locking resynchronize hack */
 #define LOCKING_RESYNC_ENABLE
+
+#include "keyboards/fingerpunch/src/config_post.h"

keyboards/fingerpunch/personal/klor/config.h

@@ -133,3 +133,5 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #    define F_LRA 150 // resonance freq
 #    define DRV_GREETING       alert_750ms
 #endif
+
+#include "keyboards/fingerpunch/src/config_post.h"

keyboards/fingerpunch/personal/ximi/config.h

@@ -213,3 +213,5 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
     defined(FP_TRACKBALL_RIGHT_ONLY)
         #define POINTING_DEVICE_INVERT_X_RIGHT
 #endif
+
+#include "keyboards/fingerpunch/src/config_post.h"

keyboards/fingerpunch/personal/ximihalf/config.h

@@ -168,3 +168,5 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
     #define POINTING_DEVICE_INVERT_Y // This inverts the Y on the left side only
 #endif
+
+#include "keyboards/fingerpunch/src/config_post.h"

keyboards/fingerpunch/personal/ximihalf_rp2040/config.h

@@ -166,3 +166,5 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
     // #define SPI_MOSI_PAL_MODE 5 // already defined in chibios
     // #define SPI_MISO_PAL_MODE 5 // already defined in chibios
 #endif
+
+#include "keyboards/fingerpunch/src/config_post.h"

keyboards/fingerpunch/personal/zazu/config.h

@@ -108,3 +108,5 @@
   #define ENABLE_RGB_MATRIX_SOLID_SPLASH
   #define ENABLE_RGB_MATRIX_SOLID_MULTISPLASH
 #endif
+
+#include "keyboards/fingerpunch/src/config_post.h"

keyboards/fingerpunch/pinkiesout/v1/config.h

@@ -97,3 +97,5 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #ifdef OLED_ENABLE
 #define OLED_DISPLAY_128X64
 #endif
+
+#include "keyboards/fingerpunch/src/config_post.h"

keyboards/fingerpunch/pinkiesout/v2/config.h

@@ -163,3 +163,5 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
   #define I2C1_CLOCK_SPEED  400000
   #define I2C1_DUTY_CYCLE FAST_DUTY_CYCLE_2
 #endif
+
+#include "keyboards/fingerpunch/src/config_post.h"

keyboards/fingerpunch/pinkiesout/v2_ext/config.h

@@ -163,3 +163,5 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
   #define I2C1_CLOCK_SPEED  400000
   #define I2C1_DUTY_CYCLE FAST_DUTY_CYCLE_2
 #endif
+
+#include "keyboards/fingerpunch/src/config_post.h"

keyboards/fingerpunch/rockon/v1/config.h

@@ -31,3 +31,5 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #ifdef OLED_ENABLE
 #define OLED_DISPLAY_128X64
 #endif
+
+#include "keyboards/fingerpunch/src/config_post.h"

keyboards/fingerpunch/rockon/v2/config.h

@@ -75,3 +75,5 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #ifdef OLED_ENABLE
 #define OLED_DISPLAY_128X64
 #endif
+
+#include "keyboards/fingerpunch/src/config_post.h"

keyboards/fingerpunch/rockon/v3/config.h

@@ -132,3 +132,4 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
   #define POINTING_DEVICE_INVERT_Y
 #endif
 
+#include "keyboards/fingerpunch/src/config_post.h"

keyboards/fingerpunch/rockon_bp/config.h

@@ -155,3 +155,5 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #ifdef OLED_ENABLE
 #define OLED_DISPLAY_128X64
 #endif
+
+#include "keyboards/fingerpunch/src/config_post.h"

keyboards/fingerpunch/src/config_post.h

@@ -1,3 +1,3 @@
 #ifdef VIK_ENABLE
-    #include "keyboards/fingerpunch/src/vik/config.h"
-#endif
+    #include "keyboards/fingerpunch/src/vik/config.vik.post.h"
+#endif

keyboards/fingerpunch/src/config_pre.h

@@ -4,3 +4,7 @@
 #ifdef POINTING_DEVICE_ENABLE
 #define PMW33XX_CPI 1000
 #endif
+
+#ifdef VIK_ENABLE
+    #include "keyboards/fingerpunch/src/vik/config.vik.pre.h"
+#endif