components/esp_lcd/interface/esp_lcd_panel_io_interface.h (ESP-IDF)

/* * SPDX-FileCopyrightText: 2021-2022 Espressif Systems (Shanghai) CO LTD * * 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 typedef struct esp_lcd_panel_io_t esp_lcd_panel_io_t; /*!< Type of LCD panel IO */ /** * @brief LCD panel IO interface */ struct esp_lcd_panel_io_t { /** * @brief Transmit LCD command and receive corresponding parameters * * @note This is the panel-specific interface called by function `esp_lcd_panel_io_rx_param()`. * * @param[in] io LCD panel IO handle, which is created by other factory API like `esp_lcd_new_panel_io_spi()` * @param[in] lcd_cmd The specific LCD command, set to -1 if no command needed * @param[out] param Buffer for the command data * @param[in] param_size Size of `param` buffer * @return * - ESP_ERR_INVALID_ARG if parameter is invalid * - ESP_ERR_NOT_SUPPORTED if read is not supported by transport * - ESP_OK on success */ esp_err_t (*rx_param)(esp_lcd_panel_io_t *io, int lcd_cmd, void *param, size_t param_size); /** * @brief Transmit LCD command and corresponding parameters * * @note This is the panel-specific interface called by function `esp_lcd_panel_io_tx_param()`. * * @param[in] io LCD panel IO handle, which is created by other factory API like `esp_lcd_new_panel_io_spi()` * @param[in] lcd_cmd The specific LCD command * @param[in] param Buffer that holds the command specific parameters, set to NULL if no parameter is needed for the command * @param[in] param_size Size of `param` in memory, in bytes, set to zero if no parameter is needed for the command * @return * - ESP_ERR_INVALID_ARG if parameter is invalid * - ESP_OK on success */ esp_err_t (*tx_param)(esp_lcd_panel_io_t *io, int lcd_cmd, const void *param, size_t param_size); /** * @brief Transmit LCD RGB data * * @note This is the panel-specific interface called by function `esp_lcd_panel_io_tx_color()`. * * @param[in] io LCD panel IO handle, which is created by other factory API like `esp_lcd_new_panel_io_spi()` * @param[in] lcd_cmd The specific LCD command * @param[in] color Buffer that holds the RGB color data * @param[in] color_size Size of `color` in memory, in bytes * @return * - ESP_ERR_INVALID_ARG if parameter is invalid * - ESP_OK on success */ esp_err_t (*tx_color)(esp_lcd_panel_io_t *io, int lcd_cmd, const void *color, size_t color_size); /** * @brief Destroy LCD panel IO handle (deinitialize all and free resource) * * @param[in] io LCD panel IO handle, which is created by other factory API like `esp_lcd_new_panel_io_spi()` * @return * - ESP_ERR_INVALID_ARG if parameter is invalid * - ESP_OK on success */ esp_err_t (*del)(esp_lcd_panel_io_t *io); /** * @brief Register LCD panel IO callbacks * * @param[in] io LCD panel IO handle, which is created by factory API like `esp_lcd_new_panel_io_spi()` * @param[in] cbs structure with all LCD panel IO callbacks * @param[in] user_ctx User private data, passed directly to callback's user_ctx * @return * - ESP_ERR_INVALID_ARG if parameter is invalid * - ESP_OK on success */ esp_err_t (*register_event_callbacks)(esp_lcd_panel_io_t *io, const esp_lcd_panel_io_callbacks_t *cbs, void *user_ctx); }; #ifdef __cplusplus } #endif