panel_io.hpp

Go to the documentation of this file.

// SPDX-License-Identifier: Apache-2.0
// Copyright 2026 Chris Leishman
 
#pragma once
 
#include <idfxx/spi/master>
 
#include <esp_lcd_panel_io.h>
#include <frequency/frequency>
#include <functional>
#include <memory>
 
namespace idfxx::lcd {
 
class panel_io {
public:
    typedef std::move_only_function<bool(esp_lcd_panel_io_event_data_t* edata)> color_transfer_done_callback;
 
    struct spi_config {
        gpio cs_gpio;             
        gpio dc_gpio;             
        int spi_mode;             
        freq::hertz pclk_freq;    
        size_t trans_queue_depth; 
        color_transfer_done_callback on_color_transfer_done =
            nullptr;        
        int lcd_cmd_bits;   
        int lcd_param_bits; 
        uint8_t cs_enable_pretrans =
            0; 
        uint8_t cs_enable_posttrans =
            0; 
        struct {
            unsigned int dc_high_on_cmd : 1 = 0;  
            unsigned int dc_low_on_data : 1 = 0;  
            unsigned int dc_low_on_param : 1 = 0; 
            unsigned int octal_mode : 1 =
                0; 
            unsigned int quad_mode : 1 = 0;      
            unsigned int sio_mode : 1 = 0;       
            unsigned int lsb_first : 1 = 0;      
            unsigned int cs_high_active : 1 = 0; 
        } flags = {};                            
    };
 
    [[nodiscard]] static result<std::unique_ptr<panel_io>>
    make(std::shared_ptr<idfxx::spi::master_bus> spi_bus, spi_config config);
 
#ifdef CONFIG_COMPILER_CXX_EXCEPTIONS
    [[nodiscard]] explicit panel_io(std::shared_ptr<idfxx::spi::master_bus> spi_bus, spi_config config);
#endif
 
    ~panel_io();
 
    panel_io(const panel_io&) = delete;
    panel_io& operator=(const panel_io&) = delete;
    panel_io(panel_io&&) = delete;
    panel_io& operator=(panel_io&&) = delete;
 
    [[nodiscard]] esp_lcd_panel_io_handle_t idf_handle() const { return _handle; }
 
private:
    explicit panel_io() = default;
 
    result<esp_lcd_panel_io_handle_t> make_handle(idfxx::spi::host_device host, const panel_io::spi_config& config);
    static bool
    on_color_transfer_done(esp_lcd_panel_io_handle_t handle, esp_lcd_panel_io_event_data_t* edata, void* user_ctx);
 
    std::shared_ptr<idfxx::spi::master_bus> _spi_bus;
    esp_lcd_panel_io_handle_t _handle;
    color_transfer_done_callback _on_color_transfer_done;
};
 
 
} // namespace idfxx::lcd