Prune out pure software pwm && custom driver && remove wrapping BACKLIGHT_PIN (#8041)
This commit is contained in:
		
							parent
							
								
									3dc061ac78
								
							
						
					
					
						commit
						88356c85c4
					
				
					 1 changed files with 239 additions and 282 deletions
				
			
		| 
						 | 
				
			
			@ -2,7 +2,9 @@
 | 
			
		|||
#include "backlight.h"
 | 
			
		||||
#include "debug.h"
 | 
			
		||||
 | 
			
		||||
#if defined(BACKLIGHT_ENABLE) && (defined(BACKLIGHT_PIN) || defined(BACKLIGHT_PINS))
 | 
			
		||||
#if !defined(BACKLIGHT_PIN) && !defined(BACKLIGHT_PINS)
 | 
			
		||||
#    error "Backlight pin/pins not defined. Please configure."
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
// This logic is a bit complex, we support 3 setups:
 | 
			
		||||
//
 | 
			
		||||
| 
						 | 
				
			
			@ -12,7 +14,7 @@
 | 
			
		|||
//      depends on the Audio setup (Audio wins over Backlight).
 | 
			
		||||
//   3. Full software PWM, driven by the matrix scan, if both timers are used by Audio.
 | 
			
		||||
 | 
			
		||||
#    if (defined(__AVR_AT90USB646__) || defined(__AVR_AT90USB647__) || defined(__AVR_AT90USB1286__) || defined(__AVR_AT90USB1287__) || defined(__AVR_ATmega16U4__) || defined(__AVR_ATmega32U4__)) && (BACKLIGHT_PIN == B5 || BACKLIGHT_PIN == B6 || BACKLIGHT_PIN == B7)
 | 
			
		||||
#if (defined(__AVR_AT90USB646__) || defined(__AVR_AT90USB647__) || defined(__AVR_AT90USB1286__) || defined(__AVR_AT90USB1287__) || defined(__AVR_ATmega16U4__) || defined(__AVR_ATmega32U4__)) && (BACKLIGHT_PIN == B5 || BACKLIGHT_PIN == B6 || BACKLIGHT_PIN == B7)
 | 
			
		||||
#    define HARDWARE_PWM
 | 
			
		||||
#    define ICRx ICR1
 | 
			
		||||
#    define TCCRxA TCCR1A
 | 
			
		||||
| 
						 | 
				
			
			@ -34,7 +36,7 @@
 | 
			
		|||
#        define COMxx1 COM1C1
 | 
			
		||||
#        define OCRxx OCR1C
 | 
			
		||||
#    endif
 | 
			
		||||
#    elif (defined(__AVR_AT90USB646__) || defined(__AVR_AT90USB647__) || defined(__AVR_AT90USB1286__) || defined(__AVR_AT90USB1287__) || defined(__AVR_ATmega16U4__) || defined(__AVR_ATmega32U4__)) && (BACKLIGHT_PIN == C4 || BACKLIGHT_PIN == C5 || BACKLIGHT_PIN == C6)
 | 
			
		||||
#elif (defined(__AVR_AT90USB646__) || defined(__AVR_AT90USB647__) || defined(__AVR_AT90USB1286__) || defined(__AVR_AT90USB1287__) || defined(__AVR_ATmega16U4__) || defined(__AVR_ATmega32U4__)) && (BACKLIGHT_PIN == C4 || BACKLIGHT_PIN == C5 || BACKLIGHT_PIN == C6)
 | 
			
		||||
#    define HARDWARE_PWM
 | 
			
		||||
#    define ICRx ICR3
 | 
			
		||||
#    define TCCRxA TCCR3A
 | 
			
		||||
| 
						 | 
				
			
			@ -64,7 +66,7 @@
 | 
			
		|||
#        define COMxx1 COM3A1
 | 
			
		||||
#        define OCRxx OCR3A
 | 
			
		||||
#    endif
 | 
			
		||||
#    elif (defined(__AVR_ATmega16U2__) || defined(__AVR_ATmega32U2__)) && (BACKLIGHT_PIN == B7 || BACKLIGHT_PIN == C5 || BACKLIGHT_PIN == C6)
 | 
			
		||||
#elif (defined(__AVR_ATmega16U2__) || defined(__AVR_ATmega32U2__)) && (BACKLIGHT_PIN == B7 || BACKLIGHT_PIN == C5 || BACKLIGHT_PIN == C6)
 | 
			
		||||
#    define HARDWARE_PWM
 | 
			
		||||
#    define ICRx ICR1
 | 
			
		||||
#    define TCCRxA TCCR1A
 | 
			
		||||
| 
						 | 
				
			
			@ -86,7 +88,7 @@
 | 
			
		|||
#        define COMxx1 COM1A1
 | 
			
		||||
#        define OCRxx OCR1A
 | 
			
		||||
#    endif
 | 
			
		||||
#    elif defined(__AVR_ATmega32A__) && (BACKLIGHT_PIN == D4 || BACKLIGHT_PIN == D5)
 | 
			
		||||
#elif defined(__AVR_ATmega32A__) && (BACKLIGHT_PIN == D4 || BACKLIGHT_PIN == D5)
 | 
			
		||||
#    define HARDWARE_PWM
 | 
			
		||||
#    define ICRx ICR1
 | 
			
		||||
#    define TCCRxA TCCR1A
 | 
			
		||||
| 
						 | 
				
			
			@ -104,7 +106,7 @@
 | 
			
		|||
#        define COMxx1 COM1A1
 | 
			
		||||
#        define OCRxx OCR1A
 | 
			
		||||
#    endif
 | 
			
		||||
#    elif defined(__AVR_ATmega328P__) && (BACKLIGHT_PIN == B1 || BACKLIGHT_PIN == B2)
 | 
			
		||||
#elif defined(__AVR_ATmega328P__) && (BACKLIGHT_PIN == B1 || BACKLIGHT_PIN == B2)
 | 
			
		||||
#    define HARDWARE_PWM
 | 
			
		||||
#    define ICRx ICR1
 | 
			
		||||
#    define TCCRxA TCCR1A
 | 
			
		||||
| 
						 | 
				
			
			@ -122,9 +124,7 @@
 | 
			
		|||
#        define COMxx1 COM1B1
 | 
			
		||||
#        define OCRxx OCR1B
 | 
			
		||||
#    endif
 | 
			
		||||
#    else
 | 
			
		||||
#        if !defined(BACKLIGHT_CUSTOM_DRIVER)
 | 
			
		||||
#            if !defined(B5_AUDIO) && !defined(B6_AUDIO) && !defined(B7_AUDIO)
 | 
			
		||||
#elif !defined(B5_AUDIO) && !defined(B6_AUDIO) && !defined(B7_AUDIO)
 | 
			
		||||
// Timer 1 is not in use by Audio feature, Backlight can use it
 | 
			
		||||
#    pragma message "Using hardware timer 1 with software PWM"
 | 
			
		||||
#    define HARDWARE_PWM
 | 
			
		||||
| 
						 | 
				
			
			@ -143,7 +143,7 @@
 | 
			
		|||
 | 
			
		||||
#    define OCIExA OCIE1A
 | 
			
		||||
#    define OCRxx OCR1A
 | 
			
		||||
#            elif !defined(C6_AUDIO) && !defined(C5_AUDIO) && !defined(C4_AUDIO)
 | 
			
		||||
#elif !defined(C6_AUDIO) && !defined(C5_AUDIO) && !defined(C4_AUDIO)
 | 
			
		||||
#    pragma message "Using hardware timer 3 with software PWM"
 | 
			
		||||
// Timer 3 is not in use by Audio feature, Backlight can use it
 | 
			
		||||
#    define HARDWARE_PWM
 | 
			
		||||
| 
						 | 
				
			
			@ -158,37 +158,33 @@
 | 
			
		|||
 | 
			
		||||
#    define OCIExA OCIE3A
 | 
			
		||||
#    define OCRxx OCR3A
 | 
			
		||||
#            else
 | 
			
		||||
#                pragma message "Audio in use - using pure software PWM"
 | 
			
		||||
#                define NO_HARDWARE_PWM
 | 
			
		||||
#            endif
 | 
			
		||||
#        else
 | 
			
		||||
#            pragma message "Custom driver defined - using pure software PWM"
 | 
			
		||||
#            define NO_HARDWARE_PWM
 | 
			
		||||
#        endif
 | 
			
		||||
#    endif
 | 
			
		||||
#elif defined(BACKLIGHT_CUSTOM_DRIVER)
 | 
			
		||||
error("Please set 'BACKLIGHT_DRIVER = custom' within rules.mk")
 | 
			
		||||
#else
 | 
			
		||||
error("Please set 'BACKLIGHT_DRIVER = software' within rules.mk")
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
#    ifndef BACKLIGHT_ON_STATE
 | 
			
		||||
#ifndef BACKLIGHT_ON_STATE
 | 
			
		||||
#    define BACKLIGHT_ON_STATE 1
 | 
			
		||||
#    endif
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
void backlight_on(pin_t backlight_pin) {
 | 
			
		||||
#    if BACKLIGHT_ON_STATE == 1
 | 
			
		||||
#if BACKLIGHT_ON_STATE == 1
 | 
			
		||||
    writePinHigh(backlight_pin);
 | 
			
		||||
#    else
 | 
			
		||||
#else
 | 
			
		||||
    writePinLow(backlight_pin);
 | 
			
		||||
#    endif
 | 
			
		||||
#endif
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
void backlight_off(pin_t backlight_pin) {
 | 
			
		||||
#    if BACKLIGHT_ON_STATE == 1
 | 
			
		||||
#if BACKLIGHT_ON_STATE == 1
 | 
			
		||||
    writePinLow(backlight_pin);
 | 
			
		||||
#    else
 | 
			
		||||
#else
 | 
			
		||||
    writePinHigh(backlight_pin);
 | 
			
		||||
#    endif
 | 
			
		||||
#endif
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
#    if defined(NO_HARDWARE_PWM) || defined(BACKLIGHT_PWM_TIMER)  // pwm through software
 | 
			
		||||
#ifdef BACKLIGHT_PWM_TIMER  // pwm through software
 | 
			
		||||
 | 
			
		||||
// we support multiple backlight pins
 | 
			
		||||
#    ifndef BACKLIGHT_LED_COUNT
 | 
			
		||||
| 
						 | 
				
			
			@ -210,7 +206,7 @@ void backlight_off(pin_t backlight_pin) {
 | 
			
		|||
 | 
			
		||||
static const pin_t backlight_pins[BACKLIGHT_LED_COUNT] = BACKLIGHT_PIN_INIT;
 | 
			
		||||
 | 
			
		||||
#    else  // full hardware PWM
 | 
			
		||||
#else  // full hardware PWM
 | 
			
		||||
 | 
			
		||||
static inline void enable_pwm(void) {
 | 
			
		||||
#    if BACKLIGHT_ON_STATE == 1
 | 
			
		||||
| 
						 | 
				
			
			@ -232,42 +228,9 @@ static inline void disable_pwm(void) {
 | 
			
		|||
static const pin_t backlight_pin = BACKLIGHT_PIN;
 | 
			
		||||
#    define FOR_EACH_LED(x) x
 | 
			
		||||
 | 
			
		||||
#    endif
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
#    ifdef NO_HARDWARE_PWM
 | 
			
		||||
void backlight_init_ports(void) {
 | 
			
		||||
    // Setup backlight pin as output and output to on state.
 | 
			
		||||
    FOR_EACH_LED(setPinOutput(backlight_pin); backlight_on(backlight_pin);)
 | 
			
		||||
 | 
			
		||||
#        ifdef BACKLIGHT_BREATHING
 | 
			
		||||
    if (is_backlight_breathing()) {
 | 
			
		||||
        breathing_enable();
 | 
			
		||||
    }
 | 
			
		||||
#        endif
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
uint8_t backlight_tick = 0;
 | 
			
		||||
 | 
			
		||||
#        ifndef BACKLIGHT_CUSTOM_DRIVER
 | 
			
		||||
void backlight_task(void) {
 | 
			
		||||
    if ((0xFFFF >> ((BACKLIGHT_LEVELS - get_backlight_level()) * ((BACKLIGHT_LEVELS + 1) / 2))) & (1 << backlight_tick)) {
 | 
			
		||||
        FOR_EACH_LED(backlight_on(backlight_pin);)
 | 
			
		||||
    } else {
 | 
			
		||||
        FOR_EACH_LED(backlight_off(backlight_pin);)
 | 
			
		||||
    }
 | 
			
		||||
    backlight_tick = (backlight_tick + 1) % 16;
 | 
			
		||||
}
 | 
			
		||||
#        endif
 | 
			
		||||
 | 
			
		||||
#        ifdef BACKLIGHT_BREATHING
 | 
			
		||||
#            ifndef BACKLIGHT_CUSTOM_DRIVER
 | 
			
		||||
#                error "Backlight breathing only available with hardware PWM. Please disable."
 | 
			
		||||
#            endif
 | 
			
		||||
#        endif
 | 
			
		||||
 | 
			
		||||
#    else  // hardware pwm through timer
 | 
			
		||||
 | 
			
		||||
#        ifdef BACKLIGHT_PWM_TIMER
 | 
			
		||||
#ifdef BACKLIGHT_PWM_TIMER
 | 
			
		||||
 | 
			
		||||
// The idea of software PWM assisted by hardware timers is the following
 | 
			
		||||
// we use the hardware timer in fast PWM mode like for hardware PWM, but
 | 
			
		||||
| 
						 | 
				
			
			@ -306,9 +269,9 @@ ISR(TIMERx_OVF_vect) {
 | 
			
		|||
    }
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
#        endif
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
#        define TIMER_TOP 0xFFFFU
 | 
			
		||||
#define TIMER_TOP 0xFFFFU
 | 
			
		||||
 | 
			
		||||
// See http://jared.geek.nz/2013/feb/linear-led-pwm
 | 
			
		||||
static uint16_t cie_lightness(uint16_t v) {
 | 
			
		||||
| 
						 | 
				
			
			@ -329,40 +292,38 @@ static uint16_t cie_lightness(uint16_t v) {
 | 
			
		|||
// range for val is [0..TIMER_TOP]. PWM pin is high while the timer count is below val.
 | 
			
		||||
static inline void set_pwm(uint16_t val) { OCRxx = val; }
 | 
			
		||||
 | 
			
		||||
#        ifndef BACKLIGHT_CUSTOM_DRIVER
 | 
			
		||||
void backlight_set(uint8_t level) {
 | 
			
		||||
    if (level > BACKLIGHT_LEVELS) level = BACKLIGHT_LEVELS;
 | 
			
		||||
 | 
			
		||||
    if (level == 0) {
 | 
			
		||||
#            ifdef BACKLIGHT_PWM_TIMER
 | 
			
		||||
#ifdef BACKLIGHT_PWM_TIMER
 | 
			
		||||
        if (OCRxx) {
 | 
			
		||||
            TIMSKx &= ~(_BV(OCIExA));
 | 
			
		||||
            TIMSKx &= ~(_BV(TOIEx));
 | 
			
		||||
        }
 | 
			
		||||
#            else
 | 
			
		||||
#else
 | 
			
		||||
        // Turn off PWM control on backlight pin
 | 
			
		||||
        disable_pwm();
 | 
			
		||||
#            endif
 | 
			
		||||
#endif
 | 
			
		||||
        FOR_EACH_LED(backlight_off(backlight_pin);)
 | 
			
		||||
    } else {
 | 
			
		||||
#            ifdef BACKLIGHT_PWM_TIMER
 | 
			
		||||
#ifdef BACKLIGHT_PWM_TIMER
 | 
			
		||||
        if (!OCRxx) {
 | 
			
		||||
            TIMSKx |= _BV(OCIExA);
 | 
			
		||||
            TIMSKx |= _BV(TOIEx);
 | 
			
		||||
        }
 | 
			
		||||
#            else
 | 
			
		||||
#else
 | 
			
		||||
        // Turn on PWM control of backlight pin
 | 
			
		||||
        enable_pwm();
 | 
			
		||||
#            endif
 | 
			
		||||
#endif
 | 
			
		||||
    }
 | 
			
		||||
    // Set the brightness
 | 
			
		||||
    set_pwm(cie_lightness(TIMER_TOP * (uint32_t)level / BACKLIGHT_LEVELS));
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
void backlight_task(void) {}
 | 
			
		||||
#        endif  // BACKLIGHT_CUSTOM_DRIVER
 | 
			
		||||
 | 
			
		||||
#        ifdef BACKLIGHT_BREATHING
 | 
			
		||||
#ifdef BACKLIGHT_BREATHING
 | 
			
		||||
 | 
			
		||||
#    define BREATHING_NO_HALT 0
 | 
			
		||||
#    define BREATHING_HALT_OFF 1
 | 
			
		||||
| 
						 | 
				
			
			@ -473,7 +434,7 @@ ISR(TIMERx_OVF_vect)
 | 
			
		|||
    set_pwm(cie_lightness(scale_backlight((uint16_t)pgm_read_byte(&breathing_table[index]) * 0x0101U)));
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
#        endif  // BACKLIGHT_BREATHING
 | 
			
		||||
#endif  // BACKLIGHT_BREATHING
 | 
			
		||||
 | 
			
		||||
void backlight_init_ports(void) {
 | 
			
		||||
    // Setup backlight pin as output and output to on state.
 | 
			
		||||
| 
						 | 
				
			
			@ -483,12 +444,12 @@ void backlight_init_ports(void) {
 | 
			
		|||
    // Go read the ATmega32u4 datasheet.
 | 
			
		||||
    // And this: http://blog.saikoled.com/post/43165849837/secret-konami-cheat-code-to-high-resolution-pwm-on
 | 
			
		||||
 | 
			
		||||
#        ifdef BACKLIGHT_PWM_TIMER
 | 
			
		||||
#ifdef BACKLIGHT_PWM_TIMER
 | 
			
		||||
    // TimerX setup, Fast PWM mode count to TOP set in ICRx
 | 
			
		||||
    TCCRxA = _BV(WGM11);  // = 0b00000010;
 | 
			
		||||
    // clock select clk/1
 | 
			
		||||
    TCCRxB = _BV(WGM13) | _BV(WGM12) | _BV(CS10);  // = 0b00011001;
 | 
			
		||||
#        else  // hardware PWM
 | 
			
		||||
#else                                              // hardware PWM
 | 
			
		||||
    // Pin PB7 = OCR1C (Timer 1, Channel C)
 | 
			
		||||
    // Compare Output Mode = Clear on compare match, Channel C = COM1C1=1 COM1C0=0
 | 
			
		||||
    // (i.e. start high, go low when counter matches.)
 | 
			
		||||
| 
						 | 
				
			
			@ -507,18 +468,14 @@ void backlight_init_ports(void) {
 | 
			
		|||
#    endif
 | 
			
		||||
 | 
			
		||||
    TCCRxB = _BV(WGM13) | _BV(WGM12) | _BV(CS10);
 | 
			
		||||
#        endif
 | 
			
		||||
#endif
 | 
			
		||||
    // Use full 16-bit resolution. Counter counts to ICR1 before reset to 0.
 | 
			
		||||
    ICRx = TIMER_TOP;
 | 
			
		||||
 | 
			
		||||
    backlight_init();
 | 
			
		||||
#        ifdef BACKLIGHT_BREATHING
 | 
			
		||||
#ifdef BACKLIGHT_BREATHING
 | 
			
		||||
    if (is_backlight_breathing()) {
 | 
			
		||||
        breathing_enable();
 | 
			
		||||
    }
 | 
			
		||||
#        endif
 | 
			
		||||
#endif
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
#    endif  // hardware backlight
 | 
			
		||||
 | 
			
		||||
#endif  // backlight
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue