mirror of
https://github.com/espressif/esp-idf.git
synced 2025-10-31 13:09:38 +00:00
100 lines
4.4 KiB
C
100 lines
4.4 KiB
C
/*
|
|
* SPDX-FileCopyrightText: 2021-2024 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"
|
|
#include "esp_lcd_io_i80.h"
|
|
#include "esp_lcd_io_i2c.h"
|
|
#include "esp_lcd_io_spi.h"
|
|
#include "esp_lcd_io_parl.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/**
|
|
* @brief Transmit LCD command and receive corresponding parameters
|
|
*
|
|
* @note Commands sent by this function are short, so they are sent using polling transactions.
|
|
* The function does not return before the command transfer is completed.
|
|
* If any queued transactions sent by `esp_lcd_panel_io_tx_color()` are still pending when this function is called,
|
|
* this function will wait until they are finished and the queue is empty before sending the command(s).
|
|
*
|
|
* @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 esp_lcd_panel_io_rx_param(esp_lcd_panel_io_handle_t io, int lcd_cmd, void *param, size_t param_size);
|
|
|
|
/**
|
|
* @brief Transmit LCD command and corresponding parameters
|
|
*
|
|
* @note Commands sent by this function are short, so they are sent using polling transactions.
|
|
* The function does not return before the command transfer is completed.
|
|
* If any queued transactions sent by `esp_lcd_panel_io_tx_color()` are still pending when this function is called,
|
|
* this function will wait until they are finished and the queue is empty before sending the command(s).
|
|
*
|
|
* @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[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 esp_lcd_panel_io_tx_param(esp_lcd_panel_io_handle_t io, int lcd_cmd, const void *param, size_t param_size);
|
|
|
|
/**
|
|
* @brief Transmit LCD RGB data
|
|
*
|
|
* @note This function will package the command and RGB data into a transaction, and push into a queue.
|
|
* The real transmission is performed in the background (DMA+interrupt).
|
|
* The caller should take care of the lifecycle of the `color` buffer.
|
|
* Recycling of color buffer should be done in the callback `on_color_trans_done()`.
|
|
*
|
|
* @param[in] io LCD panel IO handle, which is created by 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[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 esp_lcd_panel_io_tx_color(esp_lcd_panel_io_handle_t io, int lcd_cmd, const void *color, size_t color_size);
|
|
|
|
/**
|
|
* @brief Destroy LCD panel IO handle (deinitialize panel and free all corresponding resource)
|
|
*
|
|
* @param[in] io LCD panel IO handle, which is created by 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 esp_lcd_panel_io_del(esp_lcd_panel_io_handle_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 esp_lcd_panel_io_register_event_callbacks(esp_lcd_panel_io_handle_t io, const esp_lcd_panel_io_callbacks_t *cbs, void *user_ctx);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|