[Keyboard] Add QMK configurator JSON for Alice PCB (#6397)

[qmk_firmware.git] / tmk_core / common / avr / suspend.c

diff --git a/tmk_core/common/avr/suspend.c b/tmk_core/common/avr/suspend.c
index 0c81e8361213af2221c93883801e649ea364a5a7..2259201b5d99cf37c6b9bf7630c731b3606cd40c 100644 (file)
--- a/tmk_core/common/avr/suspend.c
+++ b/tmk_core/common/avr/suspend.c
@@ -9,6 +9,8 @@
 #include "suspend.h"
 #include "timer.h"
 #include "led.h"
+#include "host.h"
+#include "rgblight_reconfig.h"
 
 #ifdef PROTOCOL_LUFA
        #include "lufa.h"
@@ -18,6 +20,12 @@
     #include "audio.h"
 #endif /* AUDIO_ENABLE */
 
+#if defined(RGBLIGHT_SLEEP) && defined(RGBLIGHT_ENABLE)
+  #include "rgblight.h"
+  extern rgblight_config_t rgblight_config;
+  static bool rgblight_enabled;
+  static bool is_suspended;
+#endif
 
 
 #define wdt_intr_enable(value)   \
@@ -37,8 +45,11 @@ __asm__ __volatile__ (  \
 )
 
 
-void suspend_idle(uint8_t time)
-{
+/** \brief Suspend idle
+ *
+ * FIXME: needs doc
+ */
+void suspend_idle(uint8_t time) {
     cli();
     set_sleep_mode(SLEEP_MODE_IDLE);
     sleep_enable();
@@ -47,8 +58,27 @@ void suspend_idle(uint8_t time)
     sleep_disable();
 }
 
+
+// TODO: This needs some cleanup
+
+/** \brief Run keyboard level Power down
+ *
+ * FIXME: needs doc
+ */
+__attribute__ ((weak))
+void suspend_power_down_user (void) { }
+/** \brief Run keyboard level Power down
+ *
+ * FIXME: needs doc
+ */
+__attribute__ ((weak))
+void suspend_power_down_kb(void) {
+  suspend_power_down_user();
+}
+
 #ifndef NO_SUSPEND_POWER_DOWN
-/* Power down MCU with watchdog timer
+/** \brief Power down MCU with watchdog timer
+ *
  * wdto: watchdog timer timeout defined in <avr/wdt.h>
  *          WDTO_15MS
  *          WDTO_30MS
@@ -63,27 +93,48 @@ void suspend_idle(uint8_t time)
  */
 static uint8_t wdt_timeout = 0;
 
-static void power_down(uint8_t wdto)
-{
+/** \brief Power down
+ *
+ * FIXME: needs doc
+ */
+static void power_down(uint8_t wdto) {
 #ifdef PROTOCOL_LUFA
-    if (USB_DeviceState == DEVICE_STATE_Configured) return;
+  if (USB_DeviceState == DEVICE_STATE_Configured) return;
 #endif
-    wdt_timeout = wdto;
+  wdt_timeout = wdto;
 
-    // Watchdog Interrupt Mode
-    wdt_intr_enable(wdto);
+  // Watchdog Interrupt Mode
+  wdt_intr_enable(wdto);
 
 #ifdef BACKLIGHT_ENABLE
-       backlight_set(0);
+  backlight_set(0);
 #endif
 
-       // Turn off LED indicators
-       led_set(0);
+  // Turn off LED indicators
+  uint8_t leds_off = 0;
+#if defined(BACKLIGHT_CAPS_LOCK) && defined(BACKLIGHT_ENABLE)
+  if (is_backlight_enabled()) {
+    // Don't try to turn off Caps Lock indicator as it is backlight and backlight is already off
+    leds_off |= (1<<USB_LED_CAPS_LOCK);
+  }
+#endif
+  led_set(leds_off);
 
-       #ifdef AUDIO_ENABLE
-        // This sometimes disables the start-up noise, so it's been disabled
-               // stop_all_notes();
-       #endif /* AUDIO_ENABLE */
+#ifdef AUDIO_ENABLE
+  // This sometimes disables the start-up noise, so it's been disabled
+  // stop_all_notes();
+#endif /* AUDIO_ENABLE */
+#if defined(RGBLIGHT_SLEEP) && defined(RGBLIGHT_ENABLE)
+#ifdef RGBLIGHT_ANIMATIONS
+  rgblight_timer_disable();
+#endif
+  if (!is_suspended) {
+    is_suspended = true;
+    rgblight_enabled = rgblight_config.enable;
+    rgblight_disable_noeeprom();
+  }
+#endif
+  suspend_power_down_kb();
 
     // TODO: more power saving
     // See PicoPower application note
@@ -102,8 +153,13 @@ static void power_down(uint8_t wdto)
 }
 #endif
 
-void suspend_power_down(void)
-{
+/** \brief Suspend power down
+ *
+ * FIXME: needs doc
+ */
+void suspend_power_down(void) {
+       suspend_power_down_kb();
+
 #ifndef NO_SUSPEND_POWER_DOWN
     power_down(WDTO_15MS);
 #endif
@@ -111,8 +167,7 @@ void suspend_power_down(void)
 
 __attribute__ ((weak)) void matrix_power_up(void) {}
 __attribute__ ((weak)) void matrix_power_down(void) {}
-bool suspend_wakeup_condition(void)
-{
+bool suspend_wakeup_condition(void) {
     matrix_power_up();
     matrix_scan();
     matrix_power_down();
@@ -122,21 +177,50 @@ bool suspend_wakeup_condition(void)
      return false;
 }
 
-// run immediately after wakeup
-void suspend_wakeup_init(void)
-{
+/** \brief run user level code immediately after wakeup
+ *
+ * FIXME: needs doc
+ */
+__attribute__ ((weak))
+void suspend_wakeup_init_user(void) { }
+
+/** \brief run keyboard level code immediately after wakeup
+ *
+ * FIXME: needs doc
+ */
+__attribute__ ((weak))
+void suspend_wakeup_init_kb(void) {
+  suspend_wakeup_init_user();
+}
+/** \brief run immediately after wakeup
+ *
+ * FIXME: needs doc
+ */
+void suspend_wakeup_init(void) {
     // clear keyboard state
     clear_keyboard();
 #ifdef BACKLIGHT_ENABLE
     backlight_init();
 #endif
        led_set(host_keyboard_leds());
+#if defined(RGBLIGHT_SLEEP) && defined(RGBLIGHT_ENABLE)
+  is_suspended = false;
+  if (rgblight_enabled) {
+    #ifdef BOOTLOADER_TEENSY
+      wait_ms(10);
+    #endif
+    rgblight_enable_noeeprom();
+  }
+#ifdef RGBLIGHT_ANIMATIONS
+  rgblight_timer_enable();
+#endif
+#endif
+    suspend_wakeup_init_kb();
 }
 
 #ifndef NO_SUSPEND_POWER_DOWN
 /* watchdog timeout */
-ISR(WDT_vect)
-{
+ISR(WDT_vect) {
     // compensate timer for sleep
     switch (wdt_timeout) {
         case WDTO_15MS: