[Core] Refactor OLED to allow easy addition of other types (#13454)

* add docs

* core changes

* update keyboards to new OLED

* updated users to new OLED

* update layouts to new OLED

* fixup docs

* drashna's suggestion

* fix up docs

* new keyboards with oled

* core split changes

* remaining keyboard files

* Fix The Helix keyboards oled options

* reflect develop

Co-authored-by: Drashna Jaelre <drashna@live.com>
Co-authored-by: mtei <2170248+mtei@users.noreply.github.com>

10 files changed, 23 insertions, 19 deletions

diff --git a/keyboards/nullbitsco/nibble/keymaps/oled/keymap.c b/keyboards/nullbitsco/nibble/keymaps/oled/keymap.c
index c9988848d5..0e0a152ec1 100644
--- a/keyboards/nullbitsco/nibble/keymaps/oled/keymap.c
+++ b/keyboards/nullbitsco/nibble/keymaps/oled/keymap.c
@@ -41,7 +41,7 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
     ),
 };
 
-#ifdef OLED_DRIVER_ENABLE
+#ifdef OLED_ENABLE
 oled_rotation_t oled_init_user(oled_rotation_t rotation) { return OLED_ROTATION_180; }
 
 static void render_logo(void) {
diff --git a/keyboards/nullbitsco/nibble/keymaps/oled/rules.mk b/keyboards/nullbitsco/nibble/keymaps/oled/rules.mk
index 48a51b2250..d34d066ded 100644
--- a/keyboards/nullbitsco/nibble/keymaps/oled/rules.mk
+++ b/keyboards/nullbitsco/nibble/keymaps/oled/rules.mk
@@ -1 +1,2 @@
-OLED_DRIVER_ENABLE = yes
\ No newline at end of file
+OLED_ENABLE = yes
+OLED_DRIVER = SSD1306
diff --git a/keyboards/nullbitsco/nibble/keymaps/oled_bongocat/animation_frames.h b/keyboards/nullbitsco/nibble/keymaps/oled_bongocat/animation_frames.h
index bef80febea..ac1e8dee32 100644
--- a/keyboards/nullbitsco/nibble/keymaps/oled_bongocat/animation_frames.h
+++ b/keyboards/nullbitsco/nibble/keymaps/oled_bongocat/animation_frames.h
@@ -14,7 +14,7 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 #pragma once
-#ifdef OLED_DRIVER_ENABLE
+#ifdef OLED_ENABLE
 
 // Enable OLED bitmpa compression selectively.
 #define USE_OLED_BITMAP_COMPRESSION
@@ -401,4 +401,4 @@ static const char PROGMEM tap_frames[NUM_TAP_FRAMES][NUM_OLED_BYTES] = {
     },
   };
 #endif //USE_BITMAP_COMPRESSION
-#endif //OLED_DRIVER_ENABLE
\ No newline at end of file
+#endif //OLED_ENABLE
diff --git a/keyboards/nullbitsco/nibble/keymaps/oled_bongocat/keymap.c b/keyboards/nullbitsco/nibble/keymaps/oled_bongocat/keymap.c
index d9365f54bf..5c4e31ab6b 100644
--- a/keyboards/nullbitsco/nibble/keymaps/oled_bongocat/keymap.c
+++ b/keyboards/nullbitsco/nibble/keymaps/oled_bongocat/keymap.c
@@ -86,7 +86,7 @@ bool encoder_update_user(uint8_t index, bool clockwise) {
     return true;
 }
 
-#ifdef OLED_DRIVER_ENABLE
+#ifdef OLED_ENABLE
 #define IDLE_FRAME_DURATION 200 // Idle animation iteration rate in ms
 
 oled_rotation_t oled_init_user(oled_rotation_t rotation) { return OLED_ROTATION_270; }
@@ -173,7 +173,7 @@ void oled_task_user(void) {
 
 // Animate tap
 bool process_record_user(uint16_t keycode, keyrecord_t *record) {
-    #ifdef OLED_DRIVER_ENABLE
+    #ifdef OLED_ENABLE
     // Check if non-mod
     if ((keycode >= KC_A && keycode <= KC_0) || (keycode >= KC_TAB && keycode <= KC_SLASH)) {
         if (record->event.pressed) {
@@ -192,7 +192,7 @@ bool process_record_user(uint16_t keycode, keyrecord_t *record) {
         case PROG:
           if (record->event.pressed) {
             rgblight_disable_noeeprom();
-            #ifdef OLED_DRIVER_ENABLE
+            #ifdef OLED_ENABLE
             oled_off();
             #endif
             bootloader_jump();
diff --git a/keyboards/nullbitsco/nibble/keymaps/oled_bongocat/rules.mk b/keyboards/nullbitsco/nibble/keymaps/oled_bongocat/rules.mk
index c7ffad546e..db6a98385a 100644
--- a/keyboards/nullbitsco/nibble/keymaps/oled_bongocat/rules.mk
+++ b/keyboards/nullbitsco/nibble/keymaps/oled_bongocat/rules.mk
@@ -1,3 +1,4 @@
-OLED_DRIVER_ENABLE = yes
+OLED_ENABLE = yes
+OLED_DRIVER = SSD1306
 WPM_ENABLE = yes
-VIA_ENABLE = yes
\ No newline at end of file
+VIA_ENABLE = yes
diff --git a/keyboards/nullbitsco/nibble/keymaps/oled_status/config.h b/keyboards/nullbitsco/nibble/keymaps/oled_status/config.h
index bdb970ff55..603bde6867 100644
--- a/keyboards/nullbitsco/nibble/keymaps/oled_status/config.h
+++ b/keyboards/nullbitsco/nibble/keymaps/oled_status/config.h
@@ -16,6 +16,6 @@
 #pragma once
 
 // Referenced custom font
-#ifdef OLED_DRIVER_ENABLE
+#ifdef OLED_ENABLE
 #    define OLED_FONT_H "keyboards/nullbitsco/nibble/keymaps/oled_status/glcdfont.c"
 #endif
diff --git a/keyboards/nullbitsco/nibble/keymaps/oled_status/keymap.c b/keyboards/nullbitsco/nibble/keymaps/oled_status/keymap.c
index b3da173957..161eeedc3a 100644
--- a/keyboards/nullbitsco/nibble/keymaps/oled_status/keymap.c
+++ b/keyboards/nullbitsco/nibble/keymaps/oled_status/keymap.c
@@ -15,7 +15,7 @@
  */
 #include QMK_KEYBOARD_H
 
-#ifdef OLED_DRIVER_ENABLE
+#ifdef OLED_ENABLE
 #    include "oled_display.h"
 #endif
 
@@ -44,7 +44,7 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
 };
 // clang-format on
 
-#ifdef OLED_DRIVER_ENABLE
+#ifdef OLED_ENABLE
 oled_rotation_t oled_init_user(oled_rotation_t rotation) {
     oled_timer = timer_read32();
     set_oled_mode(OLED_MODE_IDLE);
@@ -66,7 +66,7 @@ bool process_record_user(uint16_t keycode, keyrecord_t *record) {
     switch (keycode) {
         case RGB_TOG:
             if (record->event.pressed) {
-#ifdef OLED_DRIVER_ENABLE
+#ifdef OLED_ENABLE
                 process_record_keymap_oled(keycode);
 #endif
             }
@@ -82,12 +82,12 @@ bool process_record_user(uint16_t keycode, keyrecord_t *record) {
 bool encoder_update_user(uint8_t index, bool clockwise) {
     if (clockwise) {
         tap_code(KC_VOLU);
-#ifdef OLED_DRIVER_ENABLE
+#ifdef OLED_ENABLE
         process_record_encoder_oled(KC_VOLU);
 #endif
     } else {
         tap_code(KC_VOLD);
-#ifdef OLED_DRIVER_ENABLE
+#ifdef OLED_ENABLE
         process_record_encoder_oled(KC_VOLD);
 #endif
     }
diff --git a/keyboards/nullbitsco/nibble/keymaps/oled_status/rules.mk b/keyboards/nullbitsco/nibble/keymaps/oled_status/rules.mk
index 51c47cff89..0e39ada47b 100644
--- a/keyboards/nullbitsco/nibble/keymaps/oled_status/rules.mk
+++ b/keyboards/nullbitsco/nibble/keymaps/oled_status/rules.mk
@@ -1,7 +1,8 @@
-OLED_DRIVER_ENABLE = yes
+OLED_ENABLE = yes
+OLED_DRIVER = SSD1306
 WPM_ENABLE = yes
 VIA_ENABLE = yes
 
-ifeq ($(strip $(OLED_DRIVER_ENABLE)), yes)
+ifeq ($(strip $(OLED_ENABLE)), yes)
 	SRC += oled_display.c
 endif
diff --git a/keyboards/nullbitsco/scramble/keymaps/oled/keymap.c b/keyboards/nullbitsco/scramble/keymaps/oled/keymap.c
index 2081872ac2..41356631af 100644
--- a/keyboards/nullbitsco/scramble/keymaps/oled/keymap.c
+++ b/keyboards/nullbitsco/scramble/keymaps/oled/keymap.c
@@ -28,7 +28,7 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
 
 };
 
-#ifdef OLED_DRIVER_ENABLE
+#ifdef OLED_ENABLE
 static void render_logo(void) {
     static const char PROGMEM nullbits_logo[] = {
         0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
diff --git a/keyboards/nullbitsco/scramble/keymaps/oled/rules.mk b/keyboards/nullbitsco/scramble/keymaps/oled/rules.mk
index c582662134..d34d066ded 100644
--- a/keyboards/nullbitsco/scramble/keymaps/oled/rules.mk
+++ b/keyboards/nullbitsco/scramble/keymaps/oled/rules.mk
@@ -1 +1,2 @@
-OLED_DRIVER_ENABLE = yes
+OLED_ENABLE = yes
+OLED_DRIVER = SSD1306