Espressif ESP32-S2 User Manual

Chapter 2. API Reference
Functional Overview
In esp_lcd, an LCD panel is represented by esp_lcd_panel_handle_t, which plays the role of an abstract
frame buffer, regardless of the frame memory is allocated inside ESP chip or in external LCD controller. Based on
the location of the frame buffer, the LCD panel allocation functions are mainly grouped into the following categories:
• RGB LCD panel - is simply based on a group of specific synchronous signals indicating where to start and
stop a frame.
• Controller based LCD panel involves multiple steps to get a panel handle, like bus allocation, IO
device registration and controller driver install.
After we get the LCD handle, the remaining LCD operations are the same for different LCD interfaces and vendors.
Application Example
LCD examples are located under: peripherals/lcd:
• Jpeg decoding and LCD display - peripherals/lcd/tjpgd
• LVGL porting and animation UI - peripherals/lcd/lvgl
API Reference
Header File
• components/hal/include/hal/lcd_types.h
Enumerations
enum lcd_clock_source_t
LCD clock source.
Note User should select the clock source based on the real requirement:
LCD clock source Features Power Management
LCD_CLK_SRC_PLL160M High resolution ESP_PM_APB_FREQ_MAX lock
LCD_CLK_SRC_APLL Configurable resolution ESP_PM_NO_LIGHT_SLEEP lock
LCD_CLK_SRC_XTAL Medium resolution No PM lock
Values:
LCD_CLK_SRC_PLL160M
Select PLL160M as the source clock
LCD_CLK_SRC_APLL
Select APLL as the source clock
LCD_CLK_SRC_XTAL
Select XTAL as the source clock
Header File
• components/esp_lcd/include/esp_lcd_types.h
Type Definitions
typedef struct esp_lcd_panel_io_t *esp_lcd_panel_io_handle_t
Type of LCD panel IO handle
typedef struct esp_lcd_panel_t *esp_lcd_panel_handle_t
Type of LCD panel handle
Espressif Systems 307
Submit Document Feedback
Release v4.4

Espressif ESP32-S2 Specifications

General

Brand	Espressif
Model	ESP32-S2
Category	Single board computers
Language	English