panel_io.hpp

Go to the documentation of this file.

// SPDX-License-Identifier: Apache-2.0
// Copyright 2026 Chris Leishman
 
#pragma once
 
#include <idfxx/i2c/master>
#include <idfxx/spi/master>
 
#include <esp_lcd_panel_io.h>
#include <frequency/frequency>
#include <functional>
#include <memory>
 
namespace idfxx {
 
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::nc();    
        gpio dc_gpio = gpio::nc();    
        int spi_mode = 0;             
        freq::hertz pclk_freq{0};     
        size_t trans_queue_depth = 0; 
        color_transfer_done_callback on_color_transfer_done =
            nullptr;            
        int lcd_cmd_bits = 0;   
        int lcd_param_bits = 0; 
        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 = {};                            
    };
 
    struct i2c_config {
        uint16_t device_address = 0; 
        freq::hertz scl_speed{0};    
        color_transfer_done_callback on_color_transfer_done =
            nullptr;                    
        size_t control_phase_bytes = 0; 
        unsigned int dc_bit_offset = 0; 
        int lcd_cmd_bits = 0;           
        int lcd_param_bits = 0;         
        struct {
            unsigned int dc_low_on_data : 1 = 0; 
            unsigned int disable_control_phase : 1 = 0; 
        } flags = {};                                   
    };
 
#ifdef CONFIG_COMPILER_CXX_EXCEPTIONS
    [[nodiscard]] explicit panel_io(idfxx::spi::master_bus& spi_bus, spi_config config);
#endif
 
    [[nodiscard]] static result<panel_io> make(idfxx::spi::master_bus& spi_bus, spi_config config);
 
#ifdef CONFIG_COMPILER_CXX_EXCEPTIONS
    [[nodiscard]] explicit panel_io(idfxx::i2c::master_bus& i2c_bus, i2c_config config);
#endif
 
    [[nodiscard]] static result<panel_io> make(idfxx::i2c::master_bus& i2c_bus, i2c_config config);
 
    ~panel_io();
 
    panel_io(const panel_io&) = delete;
    panel_io& operator=(const panel_io&) = delete;
    panel_io(panel_io&& other) noexcept;
    panel_io& operator=(panel_io&& other) noexcept;
 
    [[nodiscard]] esp_lcd_panel_io_handle_t idf_handle() const { return _handle; }
 
private:
    panel_io() = default;
 
    struct callback_state {
        color_transfer_done_callback on_color_transfer_done;
    };
 
    panel_io(esp_lcd_panel_io_handle_t handle, std::unique_ptr<callback_state> callbacks);
 
    static bool
    on_color_transfer_done(esp_lcd_panel_io_handle_t handle, esp_lcd_panel_io_event_data_t* edata, void* user_ctx);
 
    esp_lcd_panel_io_handle_t _handle = nullptr;
    std::unique_ptr<callback_state> _callbacks; // heap-stable state for ESP-IDF callbacks
};
 
 
} // namespace idfxx