Skip to content

Commit fa042b0

Browse files
tore-espressiftore-espressif
committed
Carve out backlight control to separate component
1 parent 678779c commit fa042b0

File tree

6 files changed

+228
-109
lines changed

6 files changed

+228
-109
lines changed

‎CMakeLists.txt

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,7 @@ if(ESP_PLATFORM)
33
file(GLOB SOURCES *.c)
44
set(LVGL_INCLUDE_DIRS . lvgl_tft)
55
list(APPEND SOURCES "lvgl_tft/disp_driver.c")
6-
7-
#@todo add SimleInclude macro here
6+
list(APPEND SOURCES "lvgl_tft/esp_lcd_backlight.c")
87

98
# Include only the source file of the selected
109
# display controller.
@@ -79,11 +78,6 @@ if(CONFIG_LV_TOUCH_CONTROLLER)
7978
endif()
8079
endif()
8180

82-
# Add backlight control to compilation only if it is selected in menuconfig
83-
if(CONFIG_LV_ENABLE_BACKLIGHT_CONTROL)
84-
list(APPEND SOURCES "lvgl_tft/esp_lcd_backlight.c")
85-
endif()
86-
8781
if(CONFIG_LV_I2C)
8882
list(APPEND SOURCES "lvgl_i2c/i2c_manager.c")
8983
endif()

‎lvgl_tft/Kconfig

Lines changed: 69 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -910,51 +910,6 @@ menu "LVGL TFT Display controller"
910910
help
911911
Configure the display Busy pin here.
912912

913-
config LV_ENABLE_BACKLIGHT_CONTROL
914-
bool "Enable control of the display backlight by using an GPIO." if \
915-
( LV_PREDEFINED_DISPLAY_NONE && ! ( LV_TFT_DISPLAY_CONTROLLER_SH1107 || LV_TFT_DISPLAY_CONTROLLER_SSD1306 ) ) \
916-
|| LV_PREDEFINED_DISPLAY_RPI_MPI3501
917-
default y if LV_PREDEFINED_DISPLAY_M5STACK
918-
default n if LV_PREDEFINED_DISPLAY_M5CORE2
919-
default y if LV_PREDEFINED_DISPLAY_WROVER4
920-
default y if LV_PREDEFINED_DISPLAY_ERTFT0356
921-
default y if LV_PREDEFINED_DISPLAY_TTGO
922-
default y if LV_PREDEFINED_DISPLAY_TTGO_CAMERA_PLUS
923-
default y if LV_PREDEFINED_DISPLAY_WT32_SC01
924-
help
925-
Enable controlling the display backlight using an GPIO
926-
927-
config LV_BACKLIGHT_ACTIVE_LVL
928-
bool "Is backlight turn on with a HIGH (1) logic level?"
929-
depends on LV_ENABLE_BACKLIGHT_CONTROL
930-
default y if LV_PREDEFINED_DISPLAY_M5STACK
931-
default y if LV_PREDEFINED_DISPLAY_ERTFT0356
932-
default y if LV_PREDEFINED_DISPLAY_TTGO
933-
default y if LV_PREDEFINED_DISPLAY_TTGO_CAMERA_PLUS
934-
default y if LV_PREDEFINED_DISPLAY_WT32_SC01
935-
help
936-
Some backlights are turned on with a high signal, others held low.
937-
If enabled, a value of 1 will be sent to the display to enable the backlight,
938-
otherwise a 0 will be expected to enable it.
939-
940-
config LV_DISP_PIN_BCKL
941-
int "GPIO for Backlight Control"
942-
depends on LV_ENABLE_BACKLIGHT_CONTROL
943-
default 23 if LV_PREDEFINED_PINS_38V1
944-
default 26 if LV_PREDEFINED_PINS_38V4
945-
default 32 if LV_PREDEFINED_DISPLAY_M5STACK
946-
default 5 if LV_PREDEFINED_DISPLAY_WROVER4
947-
default 2 if LV_PREDEFINED_DISPLAY_ADA_FEATHERWING
948-
default 27 if LV_PREDEFINED_DISPLAY_ERTFT0356
949-
default 0 if LV_PREDEFINED_PINS_TKOALA
950-
default 4 if LV_PREDEFINED_DISPLAY_TTGO
951-
default 2 if LV_PREDEFINED_DISPLAY_TTGO_CAMERA_PLUS
952-
default 23 if LV_PREDEFINED_DISPLAY_WT32_SC01
953-
default 27
954-
955-
help
956-
Configure the display BCLK (LED) pin here.
957-
958913
endmenu
959914

960915
choice
@@ -965,19 +920,86 @@ menu "LVGL TFT Display controller"
965920
config LV_I2C_DISPLAY_PORT_0
966921
bool
967922
prompt "I2C port 0"
968-
help
923+
help
969924
I2C is shared peripheral managed by I2C Manager. In order to configure I2C Manager (pinout, etc.) see menu
970925
Component config->I2C Port Settings.
971926

972927
config LV_I2C_DISPLAY_PORT_1
973928
bool
974929
prompt "I2C port 1"
975-
help
930+
help
976931
I2C is shared peripheral managed by I2C Manager. In order to configure I2C Manager (pinout, etc.) see menu
977932
Component config->I2C Port Settings.
978933

979934
endchoice
980935

936+
choice
937+
prompt "Backlight Control" if \
938+
(! ( LV_TFT_DISPLAY_CONTROLLER_SH1107 || LV_TFT_DISPLAY_CONTROLLER_SSD1306 ) )
939+
default LV_DISP_BACKLIGHT_SWITCH if LV_PREDEFINED_DISPLAY_M5STACK
940+
default LV_DISP_BACKLIGHT_OFF if LV_PREDEFINED_DISPLAY_M5CORE2
941+
default LV_DISP_BACKLIGHT_SWITCH if LV_PREDEFINED_DISPLAY_WROVER4
942+
default LV_DISP_BACKLIGHT_SWITCH if LV_PREDEFINED_DISPLAY_ERTFT0356
943+
default LV_DISP_BACKLIGHT_SWITCH if LV_PREDEFINED_DISPLAY_TTGO
944+
default LV_DISP_BACKLIGHT_SWITCH if LV_PREDEFINED_DISPLAY_TTGO_CAMERA_PLUS
945+
default LV_DISP_BACKLIGHT_SWITCH if LV_PREDEFINED_DISPLAY_WT32_SC01
946+
default LV_DISP_BACKLIGHT_OFF
947+
948+
config LV_DISP_BACKLIGHT_OFF
949+
bool
950+
prompt "Not Used"
951+
help
952+
Display backlight is not controlled by this driver, must be hardwired in hardware.
953+
954+
config LV_DISP_BACKLIGHT_SWITCH
955+
bool
956+
prompt "Switch control"
957+
help
958+
Display backlight can be switched on or off.
959+
960+
config LV_DISP_BACKLIGHT_PWM
961+
bool
962+
prompt "PWM control"
963+
help
964+
Display backlight is controlled by pulse-width modulation, allowing brightness settings.
965+
966+
endchoice
967+
968+
config LV_BACKLIGHT_ACTIVE_LVL
969+
bool "Is backlight turn on with a HIGH (1) logic level?" if \
970+
( LV_PREDEFINED_DISPLAY_NONE && ! ( LV_TFT_DISPLAY_CONTROLLER_SH1107 || LV_TFT_DISPLAY_CONTROLLER_SSD1306 ) ) \
971+
|| LV_PREDEFINED_DISPLAY_RPI_MPI3501
972+
depends on !LV_DISP_BACKLIGHT_OFF
973+
default y if LV_PREDEFINED_DISPLAY_M5STACK
974+
default y if LV_PREDEFINED_DISPLAY_ERTFT0356
975+
default y if LV_PREDEFINED_DISPLAY_TTGO
976+
default y if LV_PREDEFINED_DISPLAY_TTGO_CAMERA_PLUS
977+
default y if LV_PREDEFINED_DISPLAY_WT32_SC01
978+
help
979+
Some backlights are turned on with a high signal, others held low.
980+
If enabled, a value of 1 will be sent to the display to enable the backlight,
981+
otherwise a 0 will be expected to enable it.
982+
983+
config LV_DISP_PIN_BCKL
984+
int "GPIO for Backlight Control" if \
985+
( LV_PREDEFINED_DISPLAY_NONE && ! ( LV_TFT_DISPLAY_CONTROLLER_SH1107 || LV_TFT_DISPLAY_CONTROLLER_SSD1306 ) ) \
986+
|| LV_PREDEFINED_DISPLAY_RPI_MPI3501
987+
depends on !LV_DISP_BACKLIGHT_OFF
988+
default 23 if LV_PREDEFINED_PINS_38V1
989+
default 26 if LV_PREDEFINED_PINS_38V4
990+
default 32 if LV_PREDEFINED_DISPLAY_M5STACK
991+
default 5 if LV_PREDEFINED_DISPLAY_WROVER4
992+
default 2 if LV_PREDEFINED_DISPLAY_ADA_FEATHERWING
993+
default 27 if LV_PREDEFINED_DISPLAY_ERTFT0356
994+
default 0 if LV_PREDEFINED_PINS_TKOALA
995+
default 4 if LV_PREDEFINED_DISPLAY_TTGO
996+
default 2 if LV_PREDEFINED_DISPLAY_TTGO_CAMERA_PLUS
997+
default 23 if LV_PREDEFINED_DISPLAY_WT32_SC01
998+
default 27
999+
1000+
help
1001+
Configure the display BCLK (LED) pin here.
1002+
9811003
config LV_I2C
9821004
bool
9831005
default y if LV_I2C_DISPLAY

‎lvgl_tft/disp_driver.c

Lines changed: 31 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,10 @@
44

55
#include "disp_driver.h"
66
#include "disp_spi.h"
7+
#include "esp_lcd_backlight.h"
8+
#include "sdkconfig.h"
79

8-
void disp_driver_init(void)
10+
void *disp_driver_init(void)
911
{
1012
#if defined CONFIG_LV_TFT_DISPLAY_CONTROLLER_ILI9341
1113
ili9341_init();
@@ -42,6 +44,34 @@ void disp_driver_init(void)
4244
#elif defined CONFIG_LV_TFT_DISPLAY_CONTROLLER_ILI9163C
4345
ili9163c_init();
4446
#endif
47+
48+
// We still use menuconfig for these settings
49+
// It will be set up during runtime in the future
50+
#ifndef CONFIG_LV_DISP_BACKLIGHT_OFF
51+
const disp_backlight_config_t bckl_config = {
52+
.gpio_num = CONFIG_LV_DISP_PIN_BCKL,
53+
#if defined CONFIG_LV_DISP_BACKLIGHT_PWM
54+
.pwm_control = true,
55+
#else
56+
.pwm_control = false,
57+
#endif
58+
#if defined CONFIG_LV_BACKLIGHT_ACTIVE_LVL
59+
.output_invert = false, // Backlight on high
60+
#else
61+
.output_invert = true, // Backlight on low
62+
#endif
63+
.timer_idx = 0,
64+
.channel_idx = 0 // @todo this prevents us from having two PWM controlled displays
65+
};
66+
const disp_backlight_config_t *bckl_config_p = &bckl_config;
67+
#else
68+
const disp_backlight_config_t *bckl_config_p = NULL;
69+
#endif
70+
71+
disp_backlight_h bckl_handle = disp_backlight_new(bckl_config_p);
72+
disp_backlight_set(bckl_handle, 100);
73+
74+
return bckl_handle;
4575
}
4676

4777
void disp_driver_flush(lv_disp_drv_t * drv, const lv_area_t * area, lv_color_t * color_map)

‎lvgl_tft/disp_driver.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ extern "C" {
6767
**********************/
6868

6969
/* Initialize display */
70-
void disp_driver_init(void);
70+
void *disp_driver_init(void);
7171

7272
/* Display flush callback */
7373
void disp_driver_flush(lv_disp_drv_t * drv, const lv_area_t * area, lv_color_t * color_map);

‎lvgl_tft/esp_lcd_backlight.c

Lines changed: 83 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -8,51 +8,95 @@
88
*********************/
99
#include "esp_lcd_backlight.h"
1010
#include "driver/ledc.h"
11+
#include "driver/gpio.h"
1112
#include "esp_log.h"
13+
#include "esp_rom_gpio.h" // for output signal inversion
1214

13-
static const char *TAG = "disp_brightness";
15+
typedef struct {
16+
bool pwm_control; // true: LEDC is used, false: GPIO is used
17+
int index; // Either GPIO or LEDC channel
18+
} disp_backlight_t;
1419

15-
void disp_brightness_control_enable(void)
20+
static const char *TAG = "disp_backlight";
21+
22+
disp_backlight_h disp_backlight_new(const disp_backlight_config_t *config)
1623
{
17-
/*
18-
Configure LED (Backlight) pin as PWM for Brightness control.
19-
*/
20-
ledc_channel_config_t LCD_backlight_channel = {
21-
.gpio_num = DISP_PIN_BCKL,
22-
.speed_mode = LEDC_LOW_SPEED_MODE,
23-
.channel = LEDC_CHANNEL_0,
24-
.intr_type = LEDC_INTR_DISABLE,
25-
.timer_sel = LEDC_TIMER_0,
26-
.duty = 0,
27-
.hpoint = 0,
28-
.flags.output_invert = 0
29-
};
30-
ledc_timer_config_t LCD_backlight_timer = {
31-
.speed_mode = LEDC_LOW_SPEED_MODE,
32-
.bit_num = LEDC_TIMER_10_BIT,
33-
.timer_num = LEDC_TIMER_0,
34-
.freq_hz = 5000,
35-
.clk_cfg = LEDC_AUTO_CLK
36-
};
37-
38-
ESP_ERROR_CHECK( ledc_timer_config(&LCD_backlight_timer) );
39-
ESP_ERROR_CHECK( ledc_channel_config(&LCD_backlight_channel) );
24+
if (config == NULL)
25+
return NULL;
26+
disp_backlight_t *bckl_dev = calloc(1, sizeof(disp_backlight_t));
27+
if (bckl_dev == NULL){
28+
ESP_LOGW(TAG, "Could not create new LCD backlight instance");
29+
return NULL;
30+
}
31+
32+
if (config->pwm_control){
33+
// Configure LED (Backlight) pin as PWM for Brightness control.
34+
bckl_dev->pwm_control = true;
35+
bckl_dev->index = config->channel_idx;
36+
const ledc_channel_config_t LCD_backlight_channel = {
37+
.gpio_num = config->gpio_num,
38+
.speed_mode = LEDC_LOW_SPEED_MODE,
39+
.channel = config->channel_idx,
40+
.intr_type = LEDC_INTR_DISABLE,
41+
.timer_sel = config->timer_idx,
42+
.duty = 0,
43+
.hpoint = 0,
44+
.flags.output_invert = config->output_invert //@todo added only in recent IDF versions
45+
};
46+
const ledc_timer_config_t LCD_backlight_timer = {
47+
.speed_mode = LEDC_LOW_SPEED_MODE,
48+
.bit_num = LEDC_TIMER_10_BIT,
49+
.timer_num = config->timer_idx,
50+
.freq_hz = 5000,
51+
.clk_cfg = LEDC_AUTO_CLK};
52+
53+
ESP_ERROR_CHECK(ledc_timer_config(&LCD_backlight_timer));
54+
ESP_ERROR_CHECK(ledc_channel_config(&LCD_backlight_channel));
55+
}
56+
else
57+
{
58+
// Configure GPIO for output
59+
bckl_dev->index = config->gpio_num;
60+
gpio_pad_select_gpio(config->gpio_num);
61+
ESP_ERROR_CHECK(gpio_set_direction(config->gpio_num, GPIO_MODE_OUTPUT));
62+
esp_rom_gpio_connect_out_signal(config->gpio_num, SIG_GPIO_OUT_IDX, config->output_invert, false);
63+
}
4064

65+
return (disp_backlight_h)bckl_dev;
4166
}
4267

43-
void disp_set_brightness(uint16_t brightness)
68+
void disp_backlight_set(disp_backlight_h bckl, int brightness_percent)
4469
{
45-
/*
46-
Set brightness.
47-
0 -> Display off
48-
100 -> Full brightness
49-
NOTE: brightness value must be between 0 - 100
50-
*/
51-
if(brightness > 100)
52-
{
53-
ESP_LOGE(TAG, "Brightness value must be between 0 - 100");
54-
return;
55-
}
56-
ESP_ERROR_CHECK( ledc_set_duty(LEDC_LOW_SPEED_MODE, LEDC_CHANNEL_0, brightness*10) );
57-
ESP_ERROR_CHECK( ledc_update_duty(LEDC_LOW_SPEED_MODE, LEDC_CHANNEL_0) );
70+
// Check input paramters
71+
if (bckl == NULL)
72+
return;
73+
if (brightness_percent > 100)
74+
brightness_percent = 100;
75+
if (brightness_percent < 0)
76+
brightness_percent = 0;
77+
78+
disp_backlight_t *bckl_dev = (disp_backlight_t *) bckl;
79+
ESP_LOGI(TAG, "Setting LCD backlight: %d%%", brightness_percent);
80+
81+
if (bckl_dev->pwm_control) {
82+
uint32_t duty_cycle = (1023 * brightness_percent) / 100; // LEDC resolution set to 10bits, thus: 100% = 1023
83+
ESP_ERROR_CHECK(ledc_set_duty(LEDC_LOW_SPEED_MODE, bckl_dev->index, duty_cycle));
84+
ESP_ERROR_CHECK(ledc_update_duty(LEDC_LOW_SPEED_MODE, bckl_dev->index));
85+
} else {
86+
ESP_ERROR_CHECK(gpio_set_level(bckl_dev->index, brightness_percent));
87+
}
88+
}
89+
90+
void disp_backlight_delete(disp_backlight_h bckl)
91+
{
92+
if (bckl == NULL)
93+
return;
94+
95+
disp_backlight_t *bckl_dev = (disp_backlight_t *) bckl;
96+
if (bckl_dev->pwm_control) {
97+
ledc_stop(LEDC_LOW_SPEED_MODE, bckl_dev->index, 0);
98+
} else {
99+
gpio_reset_pin(bckl_dev->index);
100+
}
101+
free (bckl);
58102
}

0 commit comments

Comments
 (0)