#include <stdbool.h> #include <avr/sleep.h> #include <avr/wdt.h> #include <avr/interrupt.h> #include "matrix.h" #include "action.h" #include "suspend.h" #include "timer.h" #include "led.h" #include "host.h" #ifdef PROTOCOL_LUFA # include "lufa.h" #endif #ifdef PROTOCOL_VUSB # include "vusb.h" #endif #ifdef BACKLIGHT_ENABLE # include "backlight.h" #endif #ifdef AUDIO_ENABLE # include "audio.h" #endif /* AUDIO_ENABLE */ #if defined(RGBLIGHT_SLEEP) && defined(RGBLIGHT_ENABLE) # include "rgblight.h" #endif #ifdef LED_MATRIX_ENABLE # include "led_matrix.h" #endif #ifdef RGB_MATRIX_ENABLE # include "rgb_matrix.h" #endif /** \brief Suspend idle * * FIXME: needs doc */ void suspend_idle(uint8_t time) { cli(); set_sleep_mode(SLEEP_MODE_IDLE); sleep_enable(); sei(); sleep_cpu(); 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(); } #if !defined(NO_SUSPEND_POWER_DOWN) && defined(WDT_vect) // clang-format off #define wdt_intr_enable(value) \ __asm__ __volatile__ ( \ "in __tmp_reg__,__SREG__" "\n\t" \ "cli" "\n\t" \ "wdr" "\n\t" \ "sts %0,%1" "\n\t" \ "out __SREG__,__tmp_reg__" "\n\t" \ "sts %0,%2" "\n\t" \ : /* no outputs */ \ : "M" (_SFR_MEM_ADDR(_WD_CONTROL_REG)), \ "r" (_BV(_WD_CHANGE_BIT) | _BV(WDE)), \ "r" ((uint8_t) ((value & 0x08 ? _WD_PS3_MASK : 0x00) | _BV(WDIE) | (value & 0x07))) \ : "r0" \ ) // clang-format on /** \brief Power down MCU with watchdog timer * * wdto: watchdog timer timeout defined in <avr/wdt.h> * WDTO_15MS * WDTO_30MS * WDTO_60MS * WDTO_120MS * WDTO_250MS * WDTO_500MS * WDTO_1S * WDTO_2S * WDTO_4S * WDTO_8S */ static uint8_t wdt_timeout = 0; /** \brief Power down * * FIXME: needs doc */ static void power_down(uint8_t wdto) { wdt_timeout = wdto; // Watchdog Interrupt Mode wdt_intr_enable(wdto); // TODO: more power saving // See PicoPower application note // - I/O port input with pullup // - prescale clock // - BOD disable // - Power Reduction Register PRR set_sleep_mode(SLEEP_MODE_PWR_DOWN); sleep_enable(); sei(); sleep_cpu(); sleep_disable(); // Disable watchdog after sleep wdt_disable(); } #endif /** \brief Suspend power down * * FIXME: needs doc */ void suspend_power_down(void) { #ifdef PROTOCOL_LUFA if (USB_DeviceState == DEVICE_STATE_Configured) return; #endif #ifdef PROTOCOL_VUSB if (!vusb_suspended) return; #endif suspend_power_down_kb(); #ifndef NO_SUSPEND_POWER_DOWN // Turn off backlight # ifdef BACKLIGHT_ENABLE backlight_set(0); # endif // 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); // Turn off audio # ifdef AUDIO_ENABLE stop_all_notes(); # endif // Turn off underglow # if defined(RGBLIGHT_SLEEP) && defined(RGBLIGHT_ENABLE) rgblight_suspend(); # endif # if defined(LED_MATRIX_ENABLE) led_matrix_set_suspend_state(true); # endif # if defined(RGB_MATRIX_ENABLE) rgb_matrix_set_suspend_state(true); # endif // Enter sleep state if possible (ie, the MCU has a watchdog timeout interrupt) # if defined(WDT_vect) power_down(WDTO_15MS); # endif #endif } __attribute__((weak)) void matrix_power_up(void) {} __attribute__((weak)) void matrix_power_down(void) {} bool suspend_wakeup_condition(void) { matrix_power_up(); matrix_scan(); matrix_power_down(); for (uint8_t r = 0; r < MATRIX_ROWS; r++) { if (matrix_get_row(r)) return true; } return false; } /** \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(); // Turn on backlight #ifdef BACKLIGHT_ENABLE backlight_init(); #endif // Restore LED indicators led_set(host_keyboard_leds()); // Wake up underglow #if defined(RGBLIGHT_SLEEP) && defined(RGBLIGHT_ENABLE) rgblight_wakeup(); #endif #if defined(LED_MATRIX_ENABLE) led_matrix_set_suspend_state(false); #endif #if defined(RGB_MATRIX_ENABLE) rgb_matrix_set_suspend_state(false); #endif suspend_wakeup_init_kb(); } #if !defined(NO_SUSPEND_POWER_DOWN) && defined(WDT_vect) /* watchdog timeout */ ISR(WDT_vect) { // compensate timer for sleep switch (wdt_timeout) { case WDTO_15MS: timer_count += 15 + 2; // WDTO_15MS + 2(from observation) break; default:; } } #endif