[Core] Change OLED task function to be boolean (qmk#14864)

* [Core] Add kb level callbacks to OLED driver * Update keyboards and keymaps * Update docs * Update userspace configs * Add fix for my keymap ... * update lefty
ptrxyz · Nov 6, 2021 · 3081c54 · 3081c54
1 parent 7af4d46
commit 3081c54
Show file tree

Hide file tree

Showing 272 changed files with 967 additions and 599 deletions.
diff --git a/docs/feature_oled_driver.md b/docs/feature_oled_driver.md
@@ -38,7 +38,7 @@ Then in your `keymap.c` file, implement the OLED task call. This example assumes
 
 ```c
 #ifdef OLED_ENABLE
-void oled_task_user(void) {
+bool oled_task_user(void) {
     // Host Keyboard Layer Status
     oled_write_P(PSTR("Layer: "), false);
 
@@ -62,6 +62,8 @@ void oled_task_user(void) {
     oled_write_P(led_state.num_lock ? PSTR("NUM ") : PSTR("    "), false);
     oled_write_P(led_state.caps_lock ? PSTR("CAP ") : PSTR("    "), false);
     oled_write_P(led_state.scroll_lock ? PSTR("SCR ") : PSTR("    "), false);
+
+    return false;
 }
 #endif
 ```
@@ -133,13 +135,14 @@ oled_rotation_t oled_init_user(oled_rotation_t rotation) {
     return rotation;
 }
 
-void oled_task_user(void) {
+bool oled_task_user(void) {
     if (is_keyboard_master()) {
         render_status();  // Renders the current keyboard state (layer, lock, caps, scroll, etc)
     } else {
         render_logo();  // Renders a static logo
         oled_scroll_left();  // Turns on scrolling
     }
+    return false;
 }
 #endif
 ```
@@ -242,6 +245,7 @@ bool oled_init(oled_rotation_t rotation);
 // Called at the start of oled_init, weak function overridable by the user
 // rotation - the value passed into oled_init
 // Return new oled_rotation_t if you want to override default rotation
+oled_rotation_t oled_init_kb(oled_rotation_t rotation);
 oled_rotation_t oled_init_user(oled_rotation_t rotation);
 
 // Clears the display buffer, resets cursor position to 0, and sets the buffer to dirty for rendering
@@ -333,7 +337,8 @@ uint8_t oled_get_brightness(void);
 void oled_task(void);
 
 // Called at the start of oled_task, weak function overridable by the user
-void oled_task_user(void);
+bool oled_task_kb(void);
+bool oled_task_user(void);
 
 // Set the specific 8 lines rows of the screen to scroll.
 // 0 is the default for start, and 7 for end, which is the entire

diff --git a/drivers/oled/oled_driver.h b/drivers/oled/oled_driver.h
@@ -190,6 +190,7 @@ bool oled_init(oled_rotation_t rotation);
 // Called at the start of oled_init, weak function overridable by the user
 // rotation - the value passed into oled_init
 // Return new oled_rotation_t if you want to override default rotation
+oled_rotation_t oled_init_kb(oled_rotation_t rotation);
 oled_rotation_t oled_init_user(oled_rotation_t rotation);
 
 // Clears the display buffer, resets cursor position to 0, and sets the buffer to dirty for rendering
@@ -285,7 +286,8 @@ uint8_t oled_get_brightness(void);
 void oled_task(void);
 
 // Called at the start of oled_task, weak function overridable by the user
-void oled_task_user(void);
+bool oled_task_kb(void);
+bool oled_task_user(void);
 
 // Set the specific 8 lines rows of the screen to scroll.
 // 0 is the default for start, and 7 for end, which is the entire

diff --git a/drivers/oled/ssd1306_sh1106.c b/drivers/oled/ssd1306_sh1106.c
@@ -167,7 +167,7 @@ bool oled_init(oled_rotation_t rotation) {
     }
 #endif
 
-    oled_rotation = oled_init_user(rotation);
+    oled_rotation = oled_init_user(oled_init_kb(rotation));
     if (!HAS_FLAGS(oled_rotation, OLED_ROTATION_90)) {
         oled_rotation_width = OLED_DISPLAY_WIDTH;
     } else {
@@ -232,6 +232,7 @@ bool oled_init(oled_rotation_t rotation) {
     return true;
 }
 
+__attribute__((weak)) oled_rotation_t oled_init_kb(oled_rotation_t rotation) { return rotation; }
 __attribute__((weak)) oled_rotation_t oled_init_user(oled_rotation_t rotation) { return rotation; }
 
 void oled_clear(void) {
@@ -741,11 +742,11 @@ void oled_task(void) {
     if (timer_elapsed(oled_update_timeout) >= OLED_UPDATE_INTERVAL) {
         oled_update_timeout = timer_read();
         oled_set_cursor(0, 0);
-        oled_task_user();
+        oled_task_kb();
     }
 #else
     oled_set_cursor(0, 0);
-    oled_task_user();
+    oled_task_kb();
 #endif
 
 #if OLED_SCROLL_TIMEOUT > 0
@@ -776,4 +777,5 @@ void oled_task(void) {
 #endif
 }
 
-__attribute__((weak)) void oled_task_user(void) {}
+__attribute__((weak)) bool oled_task_kb(void) { return oled_task_user(); }
+__attribute__((weak)) bool oled_task_user(void) { return true; }
diff --git a/keyboards/0xcb/1337/keymaps/conor/keymap.c b/keyboards/0xcb/1337/keymaps/conor/keymap.c
@@ -168,7 +168,7 @@ static void render_rgbled_status(bool) {
         oled_write_ln_P(PSTR("\n"), false);
     }
 }
-void oled_task_user(void) {
+bool oled_task_user(void) {
     static bool finished_timer = false;
     if (!finished_timer && (timer_elapsed(startup_timer) < 1000)) {
         render_logo();
@@ -181,5 +181,6 @@ void oled_task_user(void) {
         render_rgbled_status(true);
         render_logo_font();
     }
+    return false;
 }
 #endif
diff --git a/keyboards/0xcb/1337/keymaps/default/keymap.c b/keyboards/0xcb/1337/keymaps/default/keymap.c
@@ -159,7 +159,7 @@ static void render_rgbled_status(void) {
         oled_write_ln_P(PSTR("\n"), false);
     }
 }
-void oled_task_user(void) {
+bool oled_task_user(void) {
     static bool finished_timer = false;
     if (!finished_timer && (timer_elapsed(startup_timer) < 1000)) {
         render_logo();
@@ -172,5 +172,6 @@ void oled_task_user(void) {
         render_rgbled_status();
         render_logo_font();
     }
+    return false;
 }
 #endif
diff --git a/keyboards/0xcb/1337/keymaps/jakob/keymap.c b/keyboards/0xcb/1337/keymaps/jakob/keymap.c
@@ -168,7 +168,7 @@ static void render_rgbled_status(bool) {
         oled_write_ln_P(PSTR("\n"), false);
     }
 }
-void oled_task_user(void) {
+bool oled_task_user(void) {
     static bool finished_timer = false;
     if (!finished_timer && (timer_elapsed(startup_timer) < 1000)) {
         render_logo();
@@ -181,5 +181,6 @@ void oled_task_user(void) {
         render_rgbled_status(true);
         render_logo_font();
     }
+    return false;
 }
 #endif
diff --git a/keyboards/0xcb/1337/keymaps/via/keymap.c b/keyboards/0xcb/1337/keymaps/via/keymap.c
@@ -168,7 +168,7 @@ static void render_rgbled_status(void) {
         oled_write_ln_P(PSTR("\n"), false);
     }
 }
-void oled_task_user(void) {
+bool oled_task_user(void) {
     static bool finished_timer = false;
     if (!finished_timer && (timer_elapsed(startup_timer) < 1000)) {
         render_logo();
@@ -181,5 +181,6 @@ void oled_task_user(void) {
         render_rgbled_status();
         render_logo_font();
     }
+    return false;
 }
 #endif
diff --git a/keyboards/0xcb/static/keymaps/bongocat/keymap.c b/keyboards/0xcb/static/keymaps/bongocat/keymap.c
@@ -262,7 +262,7 @@ static void render_cat(void) {
     }
 }
 
-void oled_task_user(void) {
+bool oled_task_user(void) {
     static bool finished_timer = false;
     if (!finished_timer && (timer_elapsed(startup_timer) < 3000)) {
         render_logo();
@@ -286,6 +286,7 @@ void oled_task_user(void) {
             render_layer();
         }
     }
+    return false;
 }
 #endif
 

diff --git a/keyboards/0xcb/static/keymaps/default/keymap.c b/keyboards/0xcb/static/keymaps/default/keymap.c
@@ -175,7 +175,7 @@ static void render_layer(void) {
     oled_write_P(logo[3][2], false);
 }
 
-void oled_task_user(void) {
+bool oled_task_user(void) {
     static bool finished_timer = false;
     if (!finished_timer && (timer_elapsed(startup_timer) < 3000)) {
         render_logo();
@@ -186,5 +186,6 @@ void oled_task_user(void) {
         }
         render_layer();
     }
+    return false;
 }
 #endif
diff --git a/keyboards/0xcb/static/keymaps/via/keymap.c b/keyboards/0xcb/static/keymaps/via/keymap.c
@@ -175,7 +175,7 @@ static void render_layer(void) {
     oled_write_P(logo[3][2], false);
 }
 
-void oled_task_user(void) {
+bool oled_task_user(void) {
     static bool finished_timer = false;
     if (!finished_timer && (timer_elapsed(startup_timer) < 3000)) {
         render_logo();
@@ -186,6 +186,7 @@ void oled_task_user(void) {
         }
         render_layer();
     }
+    return false;
 }
 #endif
 

diff --git a/keyboards/10bleoledhub/keymaps/default/keymap.c b/keyboards/10bleoledhub/keymaps/default/keymap.c
@@ -55,7 +55,10 @@ static void render_logo(void) {
 }
 
 #ifdef OLED_ENABLE
-void oled_task_user(void) { render_logo(); }
+bool oled_task_user(void) {
+    render_logo();
+    return false;
+}
 #endif
 
 bool encoder_update_user(uint8_t index, bool clockwise) {

diff --git a/keyboards/10bleoledhub/keymaps/via/keymap.c b/keyboards/10bleoledhub/keymaps/via/keymap.c
@@ -55,7 +55,10 @@ static void render_logo(void) {
 }
 
 #ifdef OLED_ENABLE
-void oled_task_user(void) { render_logo(); }
+bool oled_task_user(void) {
+    render_logo();
+    return false;
+}
 #endif
 
 bool encoder_update_user(uint8_t index, bool clockwise) {

diff --git a/keyboards/aeboards/ext65/keymaps/default/keymap.c b/keyboards/aeboards/ext65/keymaps/default/keymap.c
@@ -89,10 +89,11 @@ void render_mod_status(uint8_t modifiers) {
     oled_write_ln(PSTR(" "), false);
 }
 
-void oled_task_user(void) {
+bool oled_task_user(void) {
     render_layer_state();
     render_keylock_status(host_keyboard_led_state());
     render_mod_status(get_mods()|get_oneshot_mods());
+    return false;
 }
 
 #endif
diff --git a/keyboards/aeboards/ext65/keymaps/via/keymap.c b/keyboards/aeboards/ext65/keymaps/via/keymap.c
@@ -89,10 +89,11 @@ void render_mod_status(uint8_t modifiers) {
     oled_write_ln(PSTR(" "), false);
 }
 
-void oled_task_user(void) {
+bool oled_task_user(void) {
     render_layer_state();
     render_keylock_status(host_keyboard_led_state());
     render_mod_status(get_mods()|get_oneshot_mods());
+    return false;
 }
 
 #endif
diff --git a/keyboards/aeboards/ext65/rev2/rev2.c b/keyboards/aeboards/ext65/rev2/rev2.c
@@ -9,7 +9,7 @@ void board_init(void) {
   SYSCFG->CFGR1 &= ~(SYSCFG_CFGR1_SPI2_DMA_RMP);
 }
 
-oled_rotation_t oled_init_user(oled_rotation_t rotation) {
+oled_rotation_t oled_init_kb(oled_rotation_t rotation) {
     return OLED_ROTATION_90;  // rotates the display 90 degrees
 }
 

diff --git a/keyboards/aleblazer/zodiark/keymaps/default/keymap.c b/keyboards/aleblazer/zodiark/keymaps/default/keymap.c
@@ -135,12 +135,13 @@ oled_rotation_t oled_init_user(oled_rotation_t rotation) {
     return rotation;
 }
 
-void oled_task_user(void) {
+bool oled_task_user(void) {
     if (is_keyboard_master()) {
         print_status_narrow();
     } else {
         render_logo();
     }
+    return false;
 }
 
 #endif

diff --git a/keyboards/aleblazer/zodiark/keymaps/slimoled/keymap.c b/keyboards/aleblazer/zodiark/keymaps/slimoled/keymap.c
@@ -138,12 +138,13 @@ oled_rotation_t oled_init_user(oled_rotation_t rotation) {
     return rotation;
 }
 
-void oled_task_user(void) {
+bool oled_task_user(void) {
     if (is_keyboard_master()) {
         print_status_narrow();
     } else {
         render_logo();
     }
+    return false;
 }
 
 #endif

diff --git a/keyboards/aleblazer/zodiark/keymaps/via/oled.c b/keyboards/aleblazer/zodiark/keymaps/via/oled.c
@@ -67,12 +67,13 @@ oled_rotation_t oled_init_user(oled_rotation_t rotation) {
     return rotation;
 }
 
-void oled_task_user(void) {
+bool oled_task_user(void) {
     if (is_keyboard_master()) {
         print_status_narrow();
     } else {
         render_logo();
     }
+    return false;
 }
 
 #endif
diff --git a/keyboards/anavi/macropad8/keymaps/default/keymap.c b/keyboards/anavi/macropad8/keymaps/default/keymap.c
@@ -22,7 +22,7 @@ oled_rotation_t oled_init_user(oled_rotation_t rotation) {
     return OLED_ROTATION_180;  // flips the display 180 degrees if offhand
 }
 
-void oled_task_user(void) {
+bool oled_task_user(void) {
   // Host Keyboard Layer Status
   oled_write_ln_P(PSTR("ANAVI Macro Pad 8"), false);
   oled_write_P(PSTR("Active layer: "), false);
@@ -57,5 +57,6 @@ void oled_task_user(void) {
   snprintf(rgbStatusLine2, sizeof(rgbStatusLine2), "h:%d s:%d v:%d", rgblight_get_hue(), rgblight_get_sat(), rgblight_get_val());
   oled_write_ln(rgbStatusLine2, false);
 #endif
+    return false;
 }
 #endif
diff --git a/keyboards/anavi/macropad8/keymaps/git/keymap.c b/keyboards/anavi/macropad8/keymaps/git/keymap.c
@@ -105,7 +105,7 @@ oled_rotation_t oled_init_user(oled_rotation_t rotation) {
     return OLED_ROTATION_180;  // flips the display 180 degrees if offhand
 }
 
-void oled_task_user(void) {
+bool oled_task_user(void) {
   // Host Keyboard Layer Status
   oled_write_ln_P(PSTR("ANAVI Macro Pad 8"), false);
   oled_write_P(PSTR("Active layer: "), false);
@@ -140,5 +140,6 @@ void oled_task_user(void) {
   snprintf(rgbStatusLine2, sizeof(rgbStatusLine2), "h:%d s:%d v:%d", rgblight_get_hue(), rgblight_get_sat(), rgblight_get_val());
   oled_write_ln(rgbStatusLine2, false);
 #endif
+    return false;
 }
 #endif
diff --git a/keyboards/anavi/macropad8/keymaps/kicad/keymap.c b/keyboards/anavi/macropad8/keymaps/kicad/keymap.c
@@ -75,7 +75,7 @@ oled_rotation_t oled_init_user(oled_rotation_t rotation) {
     return OLED_ROTATION_180;  // flips the display 180 degrees if offhand
 }
 
-void oled_task_user(void) {
+bool oled_task_user(void) {
   // Host Keyboard Layer Status
   oled_write_ln_P(PSTR("ANAVI Macro Pad 8"), false);
   oled_write_P(PSTR("Layer: "), false);
@@ -113,5 +113,6 @@ void oled_task_user(void) {
   snprintf(rgbStatusLine2, sizeof(rgbStatusLine2), "h:%d s:%d v:%d", rgblight_get_hue(), rgblight_get_sat(), rgblight_get_val());
   oled_write_ln(rgbStatusLine2, false);
 #endif
+    return false;
 }
 #endif
diff --git a/keyboards/anavi/macropad8/keymaps/kodi/keymap.c b/keyboards/anavi/macropad8/keymaps/kodi/keymap.c
@@ -41,7 +41,7 @@ oled_rotation_t oled_init_user(oled_rotation_t rotation) {
     return OLED_ROTATION_180;  // flips the display 180 degrees if offhand
 }
 
-void oled_task_user(void) {
+bool oled_task_user(void) {
   // Host Keyboard Layer Status
   oled_write_ln_P(PSTR("ANAVI Macro Pad 8"), false);
   oled_write_P(PSTR("Active layer: "), false);
@@ -76,5 +76,6 @@ void oled_task_user(void) {
   snprintf(rgbStatusLine2, sizeof(rgbStatusLine2), "h:%d s:%d v:%d", rgblight_get_hue(), rgblight_get_sat(), rgblight_get_val());
   oled_write_ln(rgbStatusLine2, false);
 #endif
+    return false;
 }
 #endif