mirror of
https://github.com/espressif/esp-idf.git
synced 2024-10-05 20:47:46 -04:00
change(esp_lcd): split panel vendor driver into seperate header file
This commit is contained in:
morris
parent
c4dc16c612
commit
2be27f292e
37
components/esp_lcd/include/esp_lcd_panel_dev.h
Normal file
37
components/esp_lcd/include/esp_lcd_panel_dev.h
Normal file
@ -0,0 +1,37 @@
|
||||
/*
|
||||
* SPDX-FileCopyrightText: 2021-2023 Espressif Systems (Shanghai) CO LTD
|
||||
*
|
||||
* SPDX-License-Identifier: Apache-2.0
|
||||
*/
|
||||
#pragma once
|
||||
|
||||
#include <stdbool.h>
|
||||
#include <stdint.h>
|
||||
#include "esp_err.h"
|
||||
#include "esp_lcd_types.h"
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
/**
|
||||
* @brief Configuration structure for panel device
|
||||
*/
|
||||
typedef struct {
|
||||
int reset_gpio_num; /*!< GPIO used to reset the LCD panel, set to -1 if it's not used */
|
||||
union {
|
||||
lcd_rgb_element_order_t color_space; /*!< @deprecated Set RGB color space, please use rgb_ele_order instead */
|
||||
lcd_rgb_element_order_t rgb_endian; /*!< @deprecated Set RGB data endian, please use rgb_ele_order instead */
|
||||
lcd_rgb_element_order_t rgb_ele_order; /*!< Set RGB element order, RGB or BGR */
|
||||
};
|
||||
lcd_rgb_data_endian_t data_endian; /*!< Set the data endian for color data larger than 1 byte */
|
||||
uint32_t bits_per_pixel; /*!< Color depth, in bpp */
|
||||
struct {
|
||||
uint32_t reset_active_high: 1; /*!< Setting this if the panel reset is high level active */
|
||||
} flags; /*!< LCD panel config flags */
|
||||
void *vendor_config; /*!< vendor specific configuration, optional, left as NULL if not used */
|
||||
} esp_lcd_panel_dev_config_t;
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
31
components/esp_lcd/include/esp_lcd_panel_nt35510.h
Normal file
31
components/esp_lcd/include/esp_lcd_panel_nt35510.h
Normal file
@ -0,0 +1,31 @@
|
||||
/*
|
||||
* SPDX-FileCopyrightText: 2021-2023 Espressif Systems (Shanghai) CO LTD
|
||||
*
|
||||
* SPDX-License-Identifier: Apache-2.0
|
||||
*/
|
||||
#pragma once
|
||||
|
||||
#include <stdbool.h>
|
||||
#include "esp_err.h"
|
||||
#include "esp_lcd_panel_dev.h"
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
/**
|
||||
* @brief Create LCD panel for model NT35510
|
||||
*
|
||||
* @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_nt35510(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);
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
31
components/esp_lcd/include/esp_lcd_panel_st7789.h
Normal file
31
components/esp_lcd/include/esp_lcd_panel_st7789.h
Normal file
@ -0,0 +1,31 @@
|
||||
/*
|
||||
* SPDX-FileCopyrightText: 2021-2023 Espressif Systems (Shanghai) CO LTD
|
||||
*
|
||||
* SPDX-License-Identifier: Apache-2.0
|
||||
*/
|
||||
#pragma once
|
||||
|
||||
#include <stdbool.h>
|
||||
#include "esp_err.h"
|
||||
#include "esp_lcd_panel_dev.h"
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
/**
|
||||
* @brief Create LCD panel for model ST7789
|
||||
*
|
||||
* @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_st7789(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);
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
@ -3,118 +3,10 @@
|
||||
*
|
||||
* SPDX-License-Identifier: Apache-2.0
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
|
||||
#include <stdbool.h>
|
||||
#include "esp_err.h"
|
||||
#include "esp_lcd_types.h"
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
/**
|
||||
* @brief Configuration structure for panel device
|
||||
*/
|
||||
typedef struct {
|
||||
int reset_gpio_num; /*!< GPIO used to reset the LCD panel, set to -1 if it's not used */
|
||||
union {
|
||||
lcd_rgb_element_order_t color_space; /*!< @deprecated Set RGB color space, please use rgb_ele_order instead */
|
||||
lcd_rgb_element_order_t rgb_endian; /*!< @deprecated Set RGB data endian, please use rgb_ele_order instead */
|
||||
lcd_rgb_element_order_t rgb_ele_order; /*!< Set RGB element order, RGB or BGR */
|
||||
};
|
||||
lcd_rgb_data_endian_t data_endian; /*!< Set the data endian for color data larger than 1 byte */
|
||||
unsigned int bits_per_pixel; /*!< Color depth, in bpp */
|
||||
struct {
|
||||
unsigned int reset_active_high: 1; /*!< Setting this if the panel reset is high level active */
|
||||
} flags; /*!< LCD panel config flags */
|
||||
void *vendor_config; /*!< vendor specific configuration, optional, left as NULL if not used */
|
||||
} esp_lcd_panel_dev_config_t;
|
||||
|
||||
/**
|
||||
* @brief Create LCD panel for model ST7789
|
||||
*
|
||||
* @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_st7789(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 Create LCD panel for model NT35510
|
||||
*
|
||||
* @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_nt35510(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 SSD1306 configuration structure
|
||||
*
|
||||
* To be used as esp_lcd_panel_dev_config_t.vendor_config.
|
||||
* See esp_lcd_new_panel_ssd1306().
|
||||
*/
|
||||
typedef struct {
|
||||
/**
|
||||
* @brief Multiplex ratio: (0..63)
|
||||
*
|
||||
* Display's height minus one.
|
||||
*/
|
||||
uint8_t mux_ratio;
|
||||
|
||||
/**
|
||||
* @brief Enables alternative COM pin configuration.
|
||||
*
|
||||
* When unset then Sequential COM pin configuration is used.
|
||||
*/
|
||||
bool com_pin_alt;
|
||||
|
||||
/**
|
||||
* @brief COM Left/Right remap.
|
||||
*/
|
||||
bool com_lr_remap;
|
||||
} esp_lcd_panel_ssd1306_config_t;
|
||||
|
||||
/**
|
||||
* @brief Create LCD panel for model SSD1306
|
||||
*
|
||||
* @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
|
||||
*
|
||||
* @note The default panel size is 128x64.
|
||||
* @note Use esp_lcd_panel_ssd1306_config_t to set the correct size.
|
||||
* Example usage:
|
||||
* @code {c}
|
||||
*
|
||||
* esp_lcd_panel_ssd1306_config_t ssd1306_config = {
|
||||
* .width = 128,
|
||||
* .height = 32
|
||||
* };
|
||||
* esp_lcd_panel_dev_config_t panel_config = {
|
||||
* <...>
|
||||
* .vendor_config = &ssd1306_config
|
||||
* };
|
||||
*
|
||||
* esp_lcd_panel_handle_t panel_handle = NULL;
|
||||
* esp_lcd_new_panel_ssd1306(io_handle, &panel_config, &panel_handle);
|
||||
* @endcode
|
||||
*/
|
||||
esp_err_t esp_lcd_new_panel_ssd1306(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);
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
#include "esp_lcd_panel_dev.h"
|
||||
#include "esp_lcd_panel_ssd1306.h"
|
||||
#include "esp_lcd_panel_st7789.h"
|
||||
#include "esp_lcd_panel_nt35510.h"
|
||||
|
||||
@ -173,6 +173,10 @@ INPUT = \
|
||||
$(PROJECT_PATH)/components/esp_lcd/include/esp_lcd_panel_ops.h \
|
||||
$(PROJECT_PATH)/components/esp_lcd/include/esp_lcd_panel_rgb.h \
|
||||
$(PROJECT_PATH)/components/esp_lcd/include/esp_lcd_panel_vendor.h \
|
||||
$(PROJECT_PATH)/components/esp_lcd/include/esp_lcd_panel_dev.h \
|
||||
$(PROJECT_PATH)/components/esp_lcd/include/esp_lcd_panel_ssd1306.h \
|
||||
$(PROJECT_PATH)/components/esp_lcd/include/esp_lcd_panel_st7789.h \
|
||||
$(PROJECT_PATH)/components/esp_lcd/include/esp_lcd_panel_nt35510.h \
|
||||
$(PROJECT_PATH)/components/esp_lcd/include/esp_lcd_types.h \
|
||||
$(PROJECT_PATH)/components/esp_local_ctrl/include/esp_local_ctrl.h \
|
||||
$(PROJECT_PATH)/components/esp_mm/include/esp_mmu_map.h \
|
||||
|
||||
Loading…
Reference in New Issue
Block a user