esp32c3-usb_serial/components/esp_lcd_st7735/include/esp_lcd_st7735.h

160 lines
7.1 KiB
C
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

#pragma once
#include "hal/spi_ll.h"
#include "esp_lcd_panel_vendor.h"
//--------------------------------------------------------------------------------
// System Function Command List and Description
//--------------------------------------------------------------------------------
#define ST7735_SWRESET 0x01 // Software Reset
#define ST7735_RDDID 0x04 // Read Display ID
#define ST7735_RDDST 0x09 // Read Display Status
#define ST7735_RDDPM 0x0A // Read Display Power Mode
#define ST7735_RDDMADCTL 0x0B // Read Display MADCTL
#define ST7735_RDDCOLMOD 0x0C // Read Display Pixel Format
#define ST7735_RDDIM 0x0D // Read Display Image Mode
#define ST7735_RDDSM 0x0E // Read Display Signal Mode
#define ST7735_RDDSDR 0x0F // Read Display Self-Diagnostic Result .
#define ST7735_SLPIN 0x10 // Sleep In
#define ST7735_SLPOUT 0x11 // Sleep Out
#define ST7735_PTLON 0x12 // Partial Display Mode On
#define ST7735_NORON 0x13 // Normal Display Mode On
#define ST7735_INVOFF 0x20 // Display Inversion OFF
#define ST7735_INVON 0x21 // Display Inversion On
#define ST7735_GAMSET 0x26 // Gamma Set
#define ST7735_DISPOFF 0x28 // Display Off
#define ST7735_DISPON 0x29 // Display On
#define ST7735_CASET 0x2A // Column Address Set
#define ST7735_RASET 0x2B // Row Address Set
#define ST7735_RAMWR 0x2C // Memory Write
#define ST7735_RGBSET 0x2D // Color Setting for 4K, 65K and 262K
#define ST7735_RAMRD 0x2E // Memory Read
#define ST7735_PTLAR 0x30 // Partial Area
#define ST7735_SCRLAR 0x33 // Scroll Area Set
#define ST7735_TEOFF 0x34 // Tearing Effect Line OFF
#define ST7735_TEON 0x35 // Tearing Effect Line ON
#define ST7735_MADCTL 0x36 // Memory Data Access Control
#define ST7735_VSCSAD 0x37 // Vertical Scroll Start Address of RAM
#define ST7735_IDMOFF 0x38 // Idle Mode Off
#define ST7735_IDMON 0x39 // Idle Mode On
#define ST7735_COLMOD 0x3A // Interface Pixel Format
#define ST7735_RDID1 0xDA // Read ID1 Value
#define ST7735_RDID2 0xDB // Read ID2 Value
#define ST7735_RDID3 0xDC // Read ID3 Value
//--------------------------------------------------------------------------------
// Panel Function Command List and Description
//--------------------------------------------------------------------------------
#define ST7735_FRMCTR1 0xB1 // Frame Rate Control (In normal mode/ Full colors)
#define ST7735_FRMCTR2 0xB2 // Frame Rate Control (In Idle mode/ 8-colors)
#define ST7735_FRMCTR3 0xB3 // Frame Rate Control (In Partial mode/ full colors)
#define ST7735_INVCTR 0xB4 // Display Inversion Control
#define ST7735_PWCTR1 0xC0 // Power Control 1
#define ST7735_PWCTR2 0xC1 // Power Control 2
#define ST7735_PWCTR3 0xC2 // Power Control 3 (in Normal mode/ Full colors)
#define ST7735_PWCTR4 0xC3 // Power Control 4 (in Idle mode/ 8-colors)
#define ST7735_PWCTR5 0xC4 // Power Control 5 (in Partial mode/ full-colors)
#define ST7735_VMCTR1 0xC5 // VCOM Control 1
#define ST7735_VMOFCTR 0xC7 // VCOM Offset Control
#define ST7735_WRID2 0xD1 // Write ID2 Value
#define ST7735_WRID3 0xD2 // Write ID3 Value
#define ST7735_NVFCTR1 0xD9 // NVM Control Status
#define ST7735_NVFCTR2 0xDE // NVM Read Command
#define ST7735_NVFCTR3 0xDF // NVM Write Command
#define ST7735_GMCTRP1 0xE0 // Gamma (‘+’polarity) Correction Characteristics Setting
#define ST7735_GMCTRN1 0xE1 // Gamma ‘-’polarity Correction Characteristics Setting
#define ST7735_GCV 0xFC // Gate Pump Clock Frequency Variable
#ifdef __cplusplus
extern "C"
{
#endif
/**
* @brief LCD panel initialization commands.
*
*/
typedef struct
{
int cmd; /*<! The specific LCD command */
const void *data; /*<! Buffer that holds the command specific data */
size_t data_bytes; /*<! Size of `data` in memory, in bytes */
unsigned int delay_ms; /*<! Delay in milliseconds after this command */
} st7735_lcd_init_cmd_t;
/**
* @brief LCD panel vendor configuration.
*
* @note This structure needs to be passed to the `vendor_config` field in `esp_lcd_panel_dev_config_t`.
*
*/
typedef struct
{
const st7735_lcd_init_cmd_t *init_cmds; /*!< Pointer to initialization commands array. Set to NULL if using default commands.
* The array should be declared as `static const` and positioned outside the function.
* Please refer to `vendor_specific_init_default` in source file.
*/
uint16_t init_cmds_size; /*<! Number of commands in above array */
} st7735_vendor_config_t;
/**
* @brief Create LCD panel for model st7735
*
* @note Vendor specific initialization can be different between manufacturers, should consult the LCD supplier for initialization sequence code.
*
* @param[in] io LCD panel IO handle
* @param[in] panel_dev_config general panel device configuration
* @param[out] ret_panel Returned LCD panel handle
* @return
* - ESP_ERR_INVALID_ARG if parameter is invalid
* - ESP_ERR_NO_MEM if out of memory
* - ESP_OK on success
*/
esp_err_t esp_lcd_new_panel_st7735(const esp_lcd_panel_io_handle_t io, const esp_lcd_panel_dev_config_t *panel_dev_config, esp_lcd_panel_handle_t *ret_panel);
/**
* @brief LCD panel bus configuration structure
*
* @param[in] sclk SPI clock pin number
* @param[in] mosi SPI MOSI pin number
* @param[in] max_trans_sz Maximum transfer size in bytes
*
*/
#define st7735_PANEL_BUS_SPI_CONFIG(sclk, mosi, max_trans_sz) \
{ \
.sclk_io_num = sclk, \
.mosi_io_num = mosi, \
.miso_io_num = -1, \
.quadhd_io_num = -1, \
.quadwp_io_num = -1, \
.max_transfer_sz = max_trans_sz, \
}
/**
* @brief LCD panel IO configuration structure
*
* @param[in] cs SPI chip select pin number
* @param[in] dc SPI data/command pin number
* @param[in] cb Callback function when SPI transfer is done
* @param[in] cb_ctx Callback function context
*
*/
#define st7735_PANEL_IO_SPI_CONFIG(cs, dc, callback, callback_ctx) \
{ \
.cs_gpio_num = cs, \
.dc_gpio_num = dc, \
.spi_mode = 0, \
.pclk_hz = 40 * 1000 * 1000, \
.trans_queue_depth = 10, \
.on_color_trans_done = callback, \
.user_ctx = callback_ctx, \
.lcd_cmd_bits = 8, \
.lcd_param_bits = 8, \
}
#ifdef __cplusplus
}
#endif