2021-05-12 03:26:07 +00:00
/*
* SPDX - FileCopyrightText : 2021 Espressif Systems ( Shanghai ) CO LTD
*
* SPDX - License - Identifier : Apache - 2.0
*/
// #define LOG_LOCAL_LEVEL ESP_LOG_DEBUG
# include <stdlib.h>
# include <string.h>
# include <sys/cdefs.h>
# include "esp_lcd_panel_io_interface.h"
# include "esp_lcd_panel_io.h"
# include "driver/i2c.h"
# include "driver/gpio.h"
# include "esp_log.h"
# include "esp_check.h"
static const char * TAG = " lcd_panel.io.i2c " ;
2021-07-09 06:56:08 +00:00
# define CMD_HANDLER_BUFFER_SIZE I2C_LINK_RECOMMENDED_SIZE(7) // only 7 operations will be queued in the handler ATTOW
# define BYTESHIFT(VAR, IDX) (((VAR) >> ((IDX) * 8)) & 0xFF)
2021-05-12 03:26:07 +00:00
static esp_err_t panel_io_i2c_del ( esp_lcd_panel_io_t * io ) ;
static esp_err_t panel_io_i2c_tx_param ( esp_lcd_panel_io_t * io , int lcd_cmd , int lcd_cmd_bits , const void * param , size_t param_size ) ;
static esp_err_t panel_io_i2c_tx_color ( esp_lcd_panel_io_t * io , int lcd_cmd , int lcd_cmd_bits , const void * color , size_t color_size ) ;
typedef struct {
esp_lcd_panel_io_t base ; // Base class of generic lcd panel io
uint32_t i2c_bus_id ; // I2C bus id, indicating which I2C port
uint32_t dev_addr ; // Device address
uint32_t control_phase_cmd ; // control byte when transferring command
uint32_t control_phase_data ; // control byte when transferring data
bool ( * on_color_trans_done ) ( esp_lcd_panel_io_handle_t panel_io , void * user_data , void * event_data ) ; // User register's callback, invoked when color data trans done
void * user_data ; // User's private data, passed directly to callback on_color_trans_done()
2021-07-09 06:56:08 +00:00
uint8_t cmdlink_buffer [ ] ; // pre-alloc I2C command link buffer, to be reused in all transactions
2021-05-12 03:26:07 +00:00
} lcd_panel_io_i2c_t ;
esp_err_t esp_lcd_new_panel_io_i2c ( esp_lcd_i2c_bus_handle_t bus , const esp_lcd_panel_io_i2c_config_t * io_config , esp_lcd_panel_io_handle_t * ret_io )
{
esp_err_t ret = ESP_OK ;
lcd_panel_io_i2c_t * i2c_panel_io = NULL ;
ESP_GOTO_ON_FALSE ( io_config & & ret_io , ESP_ERR_INVALID_ARG , err , TAG , " invalid argument " ) ;
ESP_GOTO_ON_FALSE ( io_config - > control_phase_bytes * 8 > io_config - > dc_bit_offset , ESP_ERR_INVALID_ARG , err , TAG , " D/C bit exceeds control bytes " ) ;
2021-07-09 06:56:08 +00:00
i2c_panel_io = calloc ( 1 , sizeof ( lcd_panel_io_i2c_t ) + CMD_HANDLER_BUFFER_SIZE ) ; // expand zero-length array cmdlink_buffer
2021-05-12 03:26:07 +00:00
ESP_GOTO_ON_FALSE ( i2c_panel_io , ESP_ERR_NO_MEM , err , TAG , " no mem for i2c panel io " ) ;
i2c_panel_io - > i2c_bus_id = ( uint32_t ) bus ;
i2c_panel_io - > on_color_trans_done = io_config - > on_color_trans_done ;
i2c_panel_io - > control_phase_data = ( ! io_config - > flags . dc_low_on_data ) < < ( io_config - > dc_bit_offset ) ;
i2c_panel_io - > control_phase_cmd = ( io_config - > flags . dc_low_on_data ) < < ( io_config - > dc_bit_offset ) ;
i2c_panel_io - > user_data = io_config - > user_data ;
i2c_panel_io - > dev_addr = io_config - > dev_addr ;
i2c_panel_io - > base . del = panel_io_i2c_del ;
i2c_panel_io - > base . tx_param = panel_io_i2c_tx_param ;
i2c_panel_io - > base . tx_color = panel_io_i2c_tx_color ;
* ret_io = & ( i2c_panel_io - > base ) ;
ESP_LOGD ( TAG , " new i2c lcd panel io @%p " , i2c_panel_io ) ;
return ESP_OK ;
err :
return ret ;
}
static esp_err_t panel_io_i2c_del ( esp_lcd_panel_io_t * io )
{
esp_err_t ret = ESP_OK ;
lcd_panel_io_i2c_t * i2c_panel_io = __containerof ( io , lcd_panel_io_i2c_t , base ) ;
ESP_LOGD ( TAG , " del lcd panel io spi @%p " , i2c_panel_io ) ;
free ( i2c_panel_io ) ;
return ret ;
}
2021-07-09 06:56:08 +00:00
static esp_err_t panel_io_i2c_tx_buffer ( esp_lcd_panel_io_t * io , int lcd_cmd , int lcd_cmd_bits , const void * buffer , size_t buffer_size , bool is_param )
2021-05-12 03:26:07 +00:00
{
esp_err_t ret = ESP_OK ;
lcd_panel_io_i2c_t * i2c_panel_io = __containerof ( io , lcd_panel_io_i2c_t , base ) ;
2021-07-09 06:56:08 +00:00
i2c_cmd_handle_t cmd_link = i2c_cmd_link_create_static ( i2c_panel_io - > cmdlink_buffer , CMD_HANDLER_BUFFER_SIZE ) ;
2021-05-12 03:26:07 +00:00
ESP_GOTO_ON_FALSE ( cmd_link , ESP_ERR_NO_MEM , err , TAG , " no mem for i2c cmd link " ) ;
ESP_GOTO_ON_ERROR ( i2c_master_start ( cmd_link ) , err , TAG , " issue start failed " ) ; // start phase
ESP_GOTO_ON_ERROR ( i2c_master_write_byte ( cmd_link , ( i2c_panel_io - > dev_addr < < 1 ) | I2C_MASTER_WRITE , true ) , err , TAG , " write address failed " ) ; // address phase
2021-07-09 06:56:08 +00:00
ESP_GOTO_ON_ERROR (
i2c_master_write_byte ( cmd_link , is_param ? i2c_panel_io - > control_phase_cmd : i2c_panel_io - > control_phase_data , true ) ,
err , TAG , " write control phase failed " ) ; // control phase
uint8_t cmds [ 4 ] = { BYTESHIFT ( lcd_cmd , 3 ) , BYTESHIFT ( lcd_cmd , 2 ) , BYTESHIFT ( lcd_cmd , 1 ) , BYTESHIFT ( lcd_cmd , 0 ) } ;
size_t cmds_size = lcd_cmd_bits / 8 ;
if ( cmds_size > 0 & & cmds_size < = sizeof ( cmds ) ) {
ESP_GOTO_ON_ERROR ( i2c_master_write ( cmd_link , cmds + ( sizeof ( cmds ) - cmds_size ) , cmds_size , true ) , err , TAG ,
" write LCD cmd failed " ) ;
2021-05-12 03:26:07 +00:00
}
2021-07-09 06:56:08 +00:00
if ( buffer ) {
ESP_GOTO_ON_ERROR ( i2c_master_write ( cmd_link , buffer , buffer_size , true ) , err , TAG , " write data failed " ) ;
2021-05-12 03:26:07 +00:00
}
2021-07-09 06:56:08 +00:00
ESP_GOTO_ON_ERROR ( i2c_master_stop ( cmd_link ) , err , TAG , " issue stop failed " ) ; // stop phase
2021-05-12 03:26:07 +00:00
ESP_GOTO_ON_ERROR ( i2c_master_cmd_begin ( i2c_panel_io - > i2c_bus_id , cmd_link , portMAX_DELAY ) , err , TAG , " i2c transaction failed " ) ;
2021-07-09 06:56:08 +00:00
i2c_cmd_link_delete_static ( cmd_link ) ;
if ( ! is_param ) {
// trans done callback
if ( i2c_panel_io - > on_color_trans_done ) {
i2c_panel_io - > on_color_trans_done ( & ( i2c_panel_io - > base ) , i2c_panel_io - > user_data , NULL ) ;
}
}
2021-05-12 03:26:07 +00:00
return ESP_OK ;
err :
if ( cmd_link ) {
2021-07-09 06:56:08 +00:00
i2c_cmd_link_delete_static ( cmd_link ) ;
2021-05-12 03:26:07 +00:00
}
return ret ;
}
2021-07-09 06:56:08 +00:00
static esp_err_t panel_io_i2c_tx_param ( esp_lcd_panel_io_t * io , int lcd_cmd , int lcd_cmd_bits , const void * param , size_t param_size )
2021-05-12 03:26:07 +00:00
{
2021-07-09 06:56:08 +00:00
return panel_io_i2c_tx_buffer ( io , lcd_cmd , lcd_cmd_bits , param , param_size , true ) ;
}
2021-05-12 03:26:07 +00:00
2021-07-09 06:56:08 +00:00
static esp_err_t panel_io_i2c_tx_color ( esp_lcd_panel_io_t * io , int lcd_cmd , int lcd_cmd_bits , const void * color , size_t color_size )
{
return panel_io_i2c_tx_buffer ( io , lcd_cmd , lcd_cmd_bits , color , color_size , false ) ;
2021-05-12 03:26:07 +00:00
}