summary refs log tree commit diff
path: root/quantum/backlight
diff options
context:
space:
mode:
authorQMK Bot <hello@qmk.fm>2022-02-12 10:29:31 -0800
committerGitHub <noreply@github.com>2022-02-12 18:29:31 +0000
commit63646e8906e062d1c1de3925cba70c4e3426a855 (patch)
tree4e91648b77b838e1125cf86331d7e84bde6d07a9 /quantum/backlight
parentafcdd7079c774dec2aa4b7f2d08adf8b7310919b (diff)
Format code according to conventions (#16322)
Diffstat (limited to 'quantum/backlight')
-rw-r--r--quantum/backlight/backlight.c54
-rw-r--r--quantum/backlight/backlight.h2
-rw-r--r--quantum/backlight/backlight_avr.c50
-rw-r--r--quantum/backlight/backlight_chibios.c16
-rw-r--r--quantum/backlight/backlight_driver_common.c8
-rw-r--r--quantum/backlight/backlight_software.c12
-rw-r--r--quantum/backlight/backlight_timer.c32
7 files changed, 117 insertions, 57 deletions
diff --git a/quantum/backlight/backlight.c b/quantum/backlight/backlight.c
index dfb98419e6..52ec086bb0 100644
--- a/quantum/backlight/backlight.c
+++ b/quantum/backlight/backlight.c
@@ -95,10 +95,10 @@ void backlight_toggle(void) {
  * FIXME: needs doc
  */
 void backlight_enable(void) {
-    if (backlight_config.enable) return;  // do nothing if backlight is already on
+    if (backlight_config.enable) return; // do nothing if backlight is already on
 
     backlight_config.enable = true;
-    if (backlight_config.raw == 1)  // enabled but level == 0
+    if (backlight_config.raw == 1) // enabled but level == 0
         backlight_config.level = 1;
     eeconfig_update_backlight(backlight_config.raw);
     dprintf("backlight enable\n");
@@ -110,7 +110,7 @@ void backlight_enable(void) {
  * FIXME: needs doc
  */
 void backlight_disable(void) {
-    if (!backlight_config.enable) return;  // do nothing if backlight is already off
+    if (!backlight_config.enable) return; // do nothing if backlight is already off
 
     backlight_config.enable = false;
     eeconfig_update_backlight(backlight_config.raw);
@@ -122,7 +122,9 @@ void backlight_disable(void) {
  *
  * FIXME: needs doc
  */
-bool is_backlight_enabled(void) { return backlight_config.enable; }
+bool is_backlight_enabled(void) {
+    return backlight_config.enable;
+}
 
 /** \brief Backlight step through levels
  *
@@ -158,11 +160,17 @@ void backlight_level(uint8_t level) {
     eeconfig_update_backlight(backlight_config.raw);
 }
 
-uint8_t eeconfig_read_backlight(void) { return eeprom_read_byte(EECONFIG_BACKLIGHT); }
+uint8_t eeconfig_read_backlight(void) {
+    return eeprom_read_byte(EECONFIG_BACKLIGHT);
+}
 
-void eeconfig_update_backlight(uint8_t val) { eeprom_update_byte(EECONFIG_BACKLIGHT, val); }
+void eeconfig_update_backlight(uint8_t val) {
+    eeprom_update_byte(EECONFIG_BACKLIGHT, val);
+}
 
-void eeconfig_update_backlight_current(void) { eeconfig_update_backlight(backlight_config.raw); }
+void eeconfig_update_backlight_current(void) {
+    eeconfig_update_backlight(backlight_config.raw);
+}
 
 void eeconfig_update_backlight_default(void) {
     backlight_config.enable = 1;
@@ -179,7 +187,9 @@ void eeconfig_update_backlight_default(void) {
  *
  * FIXME: needs doc
  */
-uint8_t get_backlight_level(void) { return backlight_config.level; }
+uint8_t get_backlight_level(void) {
+    return backlight_config.level;
+}
 
 #ifdef BACKLIGHT_BREATHING
 /** \brief Backlight breathing toggle
@@ -200,7 +210,7 @@ void backlight_toggle_breathing(void) {
  * FIXME: needs doc
  */
 void backlight_enable_breathing(void) {
-    if (backlight_config.breathing) return;  // do nothing if breathing is already on
+    if (backlight_config.breathing) return; // do nothing if breathing is already on
 
     backlight_config.breathing = true;
     eeconfig_update_backlight(backlight_config.raw);
@@ -213,7 +223,7 @@ void backlight_enable_breathing(void) {
  * FIXME: needs doc
  */
 void backlight_disable_breathing(void) {
-    if (!backlight_config.breathing) return;  // do nothing if breathing is already off
+    if (!backlight_config.breathing) return; // do nothing if breathing is already off
 
     backlight_config.breathing = false;
     eeconfig_update_backlight(backlight_config.raw);
@@ -225,18 +235,30 @@ void backlight_disable_breathing(void) {
  *
  * FIXME: needs doc
  */
-bool is_backlight_breathing(void) { return backlight_config.breathing; }
+bool is_backlight_breathing(void) {
+    return backlight_config.breathing;
+}
 
 // following are marked as weak purely for backwards compatibility
-__attribute__((weak)) void breathing_period_set(uint8_t value) { breathing_period = value ? value : 1; }
+__attribute__((weak)) void breathing_period_set(uint8_t value) {
+    breathing_period = value ? value : 1;
+}
 
-__attribute__((weak)) uint8_t get_breathing_period(void) { return breathing_period; }
+__attribute__((weak)) uint8_t get_breathing_period(void) {
+    return breathing_period;
+}
 
-__attribute__((weak)) void breathing_period_default(void) { breathing_period_set(BREATHING_PERIOD); }
+__attribute__((weak)) void breathing_period_default(void) {
+    breathing_period_set(BREATHING_PERIOD);
+}
 
-__attribute__((weak)) void breathing_period_inc(void) { breathing_period_set(breathing_period + 1); }
+__attribute__((weak)) void breathing_period_inc(void) {
+    breathing_period_set(breathing_period + 1);
+}
 
-__attribute__((weak)) void breathing_period_dec(void) { breathing_period_set(breathing_period - 1); }
+__attribute__((weak)) void breathing_period_dec(void) {
+    breathing_period_set(breathing_period - 1);
+}
 
 __attribute__((weak)) void breathing_toggle(void) {
     if (is_breathing())
diff --git a/quantum/backlight/backlight.h b/quantum/backlight/backlight.h
index c30c70fd62..ff9c8de420 100644
--- a/quantum/backlight/backlight.h
+++ b/quantum/backlight/backlight.h
@@ -39,7 +39,7 @@ typedef union {
     struct {
         bool    enable : 1;
         bool    breathing : 1;
-        uint8_t reserved : 1;  // Reserved for possible future backlight modes
+        uint8_t reserved : 1; // Reserved for possible future backlight modes
         uint8_t level : 5;
     };
 } backlight_config_t;
diff --git a/quantum/backlight/backlight_avr.c b/quantum/backlight/backlight_avr.c
index 9c972ae02e..f3a0252270 100644
--- a/quantum/backlight/backlight_avr.c
+++ b/quantum/backlight/backlight_avr.c
@@ -136,7 +136,7 @@
 #    define TCCRxB TCCR1B
 #    define TIMERx_COMPA_vect TIMER1_COMPA_vect
 #    define TIMERx_OVF_vect TIMER1_OVF_vect
-#    if defined(__AVR_ATmega32A__)  // This MCU has only one TIMSK register
+#    if defined(__AVR_ATmega32A__) // This MCU has only one TIMSK register
 #        define TIMSKx TIMSK
 #    else
 #        define TIMSKx TIMSK1
@@ -166,7 +166,7 @@ error("Please set 'BACKLIGHT_DRIVER = custom' within rules.mk")
 error("Please set 'BACKLIGHT_DRIVER = software' within rules.mk")
 #endif
 
-#ifndef BACKLIGHT_PWM_TIMER  // pwm through software
+#ifndef BACKLIGHT_PWM_TIMER // pwm through software
 
 static inline void enable_pwm(void) {
 #    if BACKLIGHT_ON_STATE == 1
@@ -203,7 +203,9 @@ static inline void disable_pwm(void) {
 // or F_CPU/BACKLIGHT_CUSTOM_RESOLUTION if used.
 
 // Triggered when the counter reaches the OCRx value
-ISR(TIMERx_COMPA_vect) { backlight_pins_off(); }
+ISR(TIMERx_COMPA_vect) {
+    backlight_pins_off();
+}
 
 // Triggered when the counter reaches the TOP value
 // this one triggers at F_CPU/ICRx = 16MHz/65536 =~ 244 Hz
@@ -232,15 +234,15 @@ ISR(TIMERx_OVF_vect) {
 
 // See http://jared.geek.nz/2013/feb/linear-led-pwm
 static uint16_t cie_lightness(uint16_t v) {
-    if (v <= (uint32_t)ICRx / 12)  // If the value is less than or equal to ~8% of max
+    if (v <= (uint32_t)ICRx / 12) // If the value is less than or equal to ~8% of max
     {
-        return v / 9;  // Same as dividing by 900%
+        return v / 9; // Same as dividing by 900%
     } else {
         // In the next two lines values are bit-shifted. This is to avoid loosing decimals in integer math.
-        uint32_t y   = (((uint32_t)v + (uint32_t)ICRx / 6) << 5) / ((uint32_t)ICRx / 6 + ICRx);  // If above 8%, add ~16% of max, and normalize with (max + ~16% max)
-        uint32_t out = (y * y * y * ICRx) >> 15;                                                 // Cube it and undo the bit-shifting. (which is now three times as much due to the cubing)
+        uint32_t y   = (((uint32_t)v + (uint32_t)ICRx / 6) << 5) / ((uint32_t)ICRx / 6 + ICRx); // If above 8%, add ~16% of max, and normalize with (max + ~16% max)
+        uint32_t out = (y * y * y * ICRx) >> 15;                                                // Cube it and undo the bit-shifting. (which is now three times as much due to the cubing)
 
-        if (out > ICRx)  // Avoid overflows
+        if (out > ICRx) // Avoid overflows
         {
             out = ICRx;
         }
@@ -249,10 +251,14 @@ static uint16_t cie_lightness(uint16_t v) {
 }
 
 // rescale the supplied backlight value to be in terms of the value limit	// range for val is [0..ICRx]. PWM pin is high while the timer count is below val.
-static uint32_t rescale_limit_val(uint32_t val) { return (val * (BACKLIGHT_LIMIT_VAL + 1)) / 256; }
+static uint32_t rescale_limit_val(uint32_t val) {
+    return (val * (BACKLIGHT_LIMIT_VAL + 1)) / 256;
+}
 
 // range for val is [0..ICRx]. PWM pin is high while the timer count is below val.
-static inline void set_pwm(uint16_t val) { OCRxx = val; }
+static inline void set_pwm(uint16_t val) {
+    OCRxx = val;
+}
 
 void backlight_set(uint8_t level) {
     if (level > BACKLIGHT_LEVELS) level = BACKLIGHT_LEVELS;
@@ -303,7 +309,9 @@ static uint16_t breathing_freq_scale_factor = 2;
 #    ifdef BACKLIGHT_PWM_TIMER
 static bool breathing = false;
 
-bool is_breathing(void) { return breathing; }
+bool is_breathing(void) {
+    return breathing;
+}
 
 #        define breathing_interrupt_enable() \
             do {                             \
@@ -315,7 +323,9 @@ bool is_breathing(void) { return breathing; }
             } while (0)
 #    else
 
-bool is_breathing(void) { return !!(TIMSKx & _BV(TOIEx)); }
+bool is_breathing(void) {
+    return !!(TIMSKx & _BV(TOIEx));
+}
 
 #        define breathing_interrupt_enable() \
             do {                             \
@@ -370,7 +380,9 @@ void breathing_self_disable(void) {
 static const uint8_t breathing_table[BREATHING_STEPS] PROGMEM = {0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 2, 3, 4, 5, 6, 8, 10, 12, 15, 17, 20, 24, 28, 32, 36, 41, 46, 51, 57, 63, 70, 76, 83, 91, 98, 106, 113, 121, 129, 138, 146, 154, 162, 170, 178, 185, 193, 200, 207, 213, 220, 225, 231, 235, 240, 244, 247, 250, 252, 253, 254, 255, 254, 253, 252, 250, 247, 244, 240, 235, 231, 225, 220, 213, 207, 200, 193, 185, 178, 170, 162, 154, 146, 138, 129, 121, 113, 106, 98, 91, 83, 76, 70, 63, 57, 51, 46, 41, 36, 32, 28, 24, 20, 17, 15, 12, 10, 8, 6, 5, 4, 3, 2, 1, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0};
 
 // Use this before the cie_lightness function.
-static inline uint16_t scale_backlight(uint16_t v) { return v / BACKLIGHT_LEVELS * get_backlight_level(); }
+static inline uint16_t scale_backlight(uint16_t v) {
+    return v / BACKLIGHT_LEVELS * get_backlight_level();
+}
 
 #    ifdef BACKLIGHT_PWM_TIMER
 void breathing_task(void)
@@ -403,7 +415,7 @@ ISR(TIMERx_OVF_vect)
     set_pwm(cie_lightness(rescale_limit_val(scale_backlight((uint16_t)pgm_read_byte(&breathing_table[index]) * ICRx / 255))));
 }
 
-#endif  // BACKLIGHT_BREATHING
+#endif // BACKLIGHT_BREATHING
 
 void backlight_init_ports(void) {
     // Setup backlight pin as output and output to on state.
@@ -415,10 +427,10 @@ void backlight_init_ports(void) {
 
 #ifdef BACKLIGHT_PWM_TIMER
     // TimerX setup, Fast PWM mode count to TOP set in ICRx
-    TCCRxA = _BV(WGM11);  // = 0b00000010;
+    TCCRxA = _BV(WGM11); // = 0b00000010;
     // clock select clk/1
-    TCCRxB = _BV(WGM13) | _BV(WGM12) | _BV(CS10);  // = 0b00011001;
-#else                                              // hardware PWM
+    TCCRxB = _BV(WGM13) | _BV(WGM12) | _BV(CS10); // = 0b00011001;
+#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.)
@@ -430,8 +442,8 @@ void backlight_init_ports(void) {
     "In fast PWM mode, the compare units allow generation of PWM waveforms on the OCnx pins. Setting the COMnx1:0 bits to two will produce a non-inverted PWM [..]."
     "In fast PWM mode the counter is incremented until the counter value matches either one of the fixed values 0x00FF, 0x01FF, or 0x03FF (WGMn3:0 = 5, 6, or 7), the value in ICRn (WGMn3:0 = 14), or the value in OCRnA (WGMn3:0 = 15)."
     */
-    TCCRxA = _BV(COMxx1) | _BV(WGM11);             // = 0b00001010;
-    TCCRxB = _BV(WGM13) | _BV(WGM12) | _BV(CS10);  // = 0b00011001;
+    TCCRxA = _BV(COMxx1) | _BV(WGM11);            // = 0b00001010;
+    TCCRxB = _BV(WGM13) | _BV(WGM12) | _BV(CS10); // = 0b00011001;
 #endif
 
 #ifdef BACKLIGHT_CUSTOM_RESOLUTION
diff --git a/quantum/backlight/backlight_chibios.c b/quantum/backlight/backlight_chibios.c
index 7c6edd10d6..e8f9e70f78 100644
--- a/quantum/backlight/backlight_chibios.c
+++ b/quantum/backlight/backlight_chibios.c
@@ -53,14 +53,14 @@ static PWMConfig pwmCFG = {0xFFFF, /* PWM clock frequency  */
 
 // See http://jared.geek.nz/2013/feb/linear-led-pwm
 static uint16_t cie_lightness(uint16_t v) {
-    if (v <= 5243)     // if below 8% of max
-        return v / 9;  // same as dividing by 900%
+    if (v <= 5243)    // if below 8% of max
+        return v / 9; // same as dividing by 900%
     else {
-        uint32_t y = (((uint32_t)v + 10486) << 8) / (10486 + 0xFFFFUL);  // add 16% of max and compare
+        uint32_t y = (((uint32_t)v + 10486) << 8) / (10486 + 0xFFFFUL); // add 16% of max and compare
         // to get a useful result with integer division, we shift left in the expression above
         // and revert what we've done again after squaring.
         y = y * y * y >> 8;
-        if (y > 0xFFFFUL)  // prevent overflow
+        if (y > 0xFFFFUL) // prevent overflow
             return 0xFFFFU;
         else
             return (uint16_t)y;
@@ -117,7 +117,9 @@ static const uint8_t breathing_table[BREATHING_STEPS] = {0, 0, 0, 0, 0, 0, 0, 0,
 
 void breathing_callback(PWMDriver *pwmp);
 
-bool is_breathing(void) { return pwmCFG.callback != NULL; }
+bool is_breathing(void) {
+    return pwmCFG.callback != NULL;
+}
 
 void breathing_enable(void) {
     pwmCFG.callback = breathing_callback;
@@ -133,7 +135,9 @@ void breathing_disable(void) {
 }
 
 // Use this before the cie_lightness function.
-static inline uint16_t scale_backlight(uint16_t v) { return v / BACKLIGHT_LEVELS * get_backlight_level(); }
+static inline uint16_t scale_backlight(uint16_t v) {
+    return v / BACKLIGHT_LEVELS * get_backlight_level();
+}
 
 void breathing_callback(PWMDriver *pwmp) {
     uint8_t  breathing_period = get_breathing_period();
diff --git a/quantum/backlight/backlight_driver_common.c b/quantum/backlight/backlight_driver_common.c
index 270a43c67e..e4c2e90b5f 100644
--- a/quantum/backlight/backlight_driver_common.c
+++ b/quantum/backlight/backlight_driver_common.c
@@ -44,6 +44,10 @@ void backlight_pins_init(void) {
     FOR_EACH_LED(setPinOutput(backlight_pin); backlight_off(backlight_pin);)
 }
 
-void backlight_pins_on(void) { FOR_EACH_LED(backlight_on(backlight_pin);) }
+void backlight_pins_on(void) {
+    FOR_EACH_LED(backlight_on(backlight_pin);)
+}
 
-void backlight_pins_off(void) { FOR_EACH_LED(backlight_off(backlight_pin);) }
+void backlight_pins_off(void) {
+    FOR_EACH_LED(backlight_off(backlight_pin);)
+}
diff --git a/quantum/backlight/backlight_software.c b/quantum/backlight/backlight_software.c
index 709304f559..3d412cab52 100644
--- a/quantum/backlight/backlight_software.c
+++ b/quantum/backlight/backlight_software.c
@@ -30,11 +30,17 @@ static const uint16_t backlight_duty_table[] = {
 
 // clang-format on
 
-static uint8_t scale_backlight(uint8_t v) { return v * (backlight_duty_table_size - 1) / BACKLIGHT_LEVELS; }
+static uint8_t scale_backlight(uint8_t v) {
+    return v * (backlight_duty_table_size - 1) / BACKLIGHT_LEVELS;
+}
 
-void backlight_init_ports(void) { backlight_pins_init(); }
+void backlight_init_ports(void) {
+    backlight_pins_init();
+}
 
-void backlight_set(uint8_t level) { s_duty_pattern = backlight_duty_table[scale_backlight(level)]; }
+void backlight_set(uint8_t level) {
+    s_duty_pattern = backlight_duty_table[scale_backlight(level)];
+}
 
 void backlight_task(void) {
     static uint8_t backlight_tick = 0;
diff --git a/quantum/backlight/backlight_timer.c b/quantum/backlight/backlight_timer.c
index c32c35c154..82fb6a6a83 100644
--- a/quantum/backlight/backlight_timer.c
+++ b/quantum/backlight/backlight_timer.c
@@ -14,14 +14,14 @@ static uint16_t backlight_timer_get_duty(void);
 
 // See http://jared.geek.nz/2013/feb/linear-led-pwm
 static uint16_t cie_lightness(uint16_t v) {
-    if (v <= 5243)     // if below 8% of max
-        return v / 9;  // same as dividing by 900%
+    if (v <= 5243)    // if below 8% of max
+        return v / 9; // same as dividing by 900%
     else {
-        uint32_t y = (((uint32_t)v + 10486) << 8) / (10486 + 0xFFFFUL);  // add 16% of max and compare
+        uint32_t y = (((uint32_t)v + 10486) << 8) / (10486 + 0xFFFFUL); // add 16% of max and compare
         // to get a useful result with integer division, we shift left in the expression above
         // and revert what we've done again after squaring.
         y = y * y * y >> 8;
-        if (y > 0xFFFFUL)  // prevent overflow
+        if (y > 0xFFFFUL) // prevent overflow
             return 0xFFFFU;
         else
             return (uint16_t)y;
@@ -61,7 +61,9 @@ static void backlight_timer_top(void) {
     }
 }
 
-static void backlight_timer_cmp(void) { backlight_pins_off(); }
+static void backlight_timer_cmp(void) {
+    backlight_pins_off();
+}
 
 void backlight_task(void) {}
 
@@ -77,7 +79,9 @@ static uint16_t breathing_counter = 0;
 static const uint8_t breathing_table[BREATHING_STEPS] = {0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 2, 3, 4, 5, 6, 8, 10, 12, 15, 17, 20, 24, 28, 32, 36, 41, 46, 51, 57, 63, 70, 76, 83, 91, 98, 106, 113, 121, 129, 138, 146, 154, 162, 170, 178, 185, 193, 200, 207, 213, 220, 225, 231, 235, 240, 244, 247, 250, 252, 253, 254, 255, 254, 253, 252, 250, 247, 244, 240, 235, 231, 225, 220, 213, 207, 200, 193, 185, 178, 170, 162, 154, 146, 138, 129, 121, 113, 106, 98, 91, 83, 76, 70, 63, 57, 51, 46, 41, 36, 32, 28, 24, 20, 17, 15, 12, 10, 8, 6, 5, 4, 3, 2, 1, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0};
 
 // Use this before the cie_lightness function.
-static inline uint16_t scale_backlight(uint16_t v) { return v / BACKLIGHT_LEVELS * get_backlight_level(); }
+static inline uint16_t scale_backlight(uint16_t v) {
+    return v / BACKLIGHT_LEVELS * get_backlight_level();
+}
 
 void breathing_task(void) {
     uint8_t  breathing_period = get_breathing_period();
@@ -91,13 +95,17 @@ void breathing_task(void) {
     backlight_timer_set_duty(cie_lightness(scale_backlight((uint16_t)breathing_table[index] * 256)));
 }
 
-bool is_breathing(void) { return breathing; }
+bool is_breathing(void) {
+    return breathing;
+}
 
 void breathing_enable(void) {
     breathing_counter = 0;
     breathing         = true;
 }
-void breathing_disable(void) { breathing = false; }
+void breathing_disable(void) {
+    breathing = false;
+}
 
 void breathing_pulse(void) {
     backlight_set(is_backlight_enabled() ? 0 : BACKLIGHT_LEVELS);
@@ -140,8 +148,12 @@ static void timerCallback(void) {
     }
 }
 
-static void     backlight_timer_set_duty(uint16_t duty) { s_duty = duty; }
-static uint16_t backlight_timer_get_duty(void) { return s_duty; }
+static void backlight_timer_set_duty(uint16_t duty) {
+    s_duty = duty;
+}
+static uint16_t backlight_timer_get_duty(void) {
+    return s_duty;
+}
 
 // ChibiOS - Map GPT timer onto Software PWM
 static void gptTimerCallback(GPTDriver *gptp) {