idfxx::lcd::panel_io::spi_config Struct Reference

SPI-based panel I/O configuration. More...

#include <idfxx_lcd/include/idfxx/lcd/panel_io.hpp>

Public Attributes
gpio	cs_gpio
	GPIO used for CS line.
gpio	dc_gpio
	GPIO used to select the D/C line, set this to -1 if the D/C line is not used.
int	spi_mode
	Traditional SPI mode (0~3)
freq::hertz	pclk_freq
	Frequency of pixel clock.
size_t	trans_queue_depth
	Size of internal transaction queue.
color_transfer_done_callback	on_color_transfer_done
	Callback invoked when color data transfer has finished.
int	lcd_cmd_bits
	Bit-width of LCD command.
int	lcd_param_bits
	Bit-width of LCD parameter.
uint8_t	cs_enable_pretrans
	Amount of SPI bit-cycles the cs should be activated before the transmission (0-16)
uint8_t	cs_enable_posttrans
	Amount of SPI bit-cycles the cs should stay active after the transmission (0-16)
struct {
unsigned int   dc_high_on_cmd: 1 = 0
	If enabled, DC level = 1 indicates command transfer. More...
unsigned int   dc_low_on_data: 1 = 0
	If enabled, DC level = 0 indicates color data transfer. More...
unsigned int   dc_low_on_param: 1 = 0
	If enabled, DC level = 0 indicates parameter transfer. More...
unsigned int   octal_mode: 1 = 0
	transmit with octal mode (8 data lines), this mode is used to simulate Intel 8080 timing More...
unsigned int   quad_mode: 1 = 0
	transmit with quad mode (4 data lines), this mode is useful when transmitting LCD parameters (Only use one line for command) More...
unsigned int   sio_mode: 1 = 0
	Read and write through a single data line (MOSI) More...
unsigned int   lsb_first: 1 = 0
	transmit LSB bit first More...
unsigned int   cs_high_active: 1 = 0
	CS line is high active. More...
}	flags = {}
	Extra flags to fine-tune the SPI device.

Detailed Description

SPI-based panel I/O configuration.

Definition at line 55 of file panel_io.hpp.

Member Data Documentation

cs_enable_posttrans

uint8_t idfxx::lcd::panel_io::spi_config::cs_enable_posttrans

Initial value:

=
            0

Amount of SPI bit-cycles the cs should stay active after the transmission (0-16)

Definition at line 67 of file panel_io.hpp.

cs_enable_pretrans

uint8_t idfxx::lcd::panel_io::spi_config::cs_enable_pretrans

Initial value:

=
            0

Amount of SPI bit-cycles the cs should be activated before the transmission (0-16)

Definition at line 65 of file panel_io.hpp.

cs_gpio

gpio idfxx::lcd::panel_io::spi_config::cs_gpio

GPIO used for CS line.

Definition at line 56 of file panel_io.hpp.

cs_high_active

unsigned int idfxx::lcd::panel_io::spi_config::cs_high_active

CS line is high active.

Definition at line 79 of file panel_io.hpp.

dc_gpio

gpio idfxx::lcd::panel_io::spi_config::dc_gpio

GPIO used to select the D/C line, set this to -1 if the D/C line is not used.

Definition at line 57 of file panel_io.hpp.

dc_high_on_cmd

unsigned int idfxx::lcd::panel_io::spi_config::dc_high_on_cmd

If enabled, DC level = 1 indicates command transfer.

Definition at line 70 of file panel_io.hpp.

dc_low_on_data

unsigned int idfxx::lcd::panel_io::spi_config::dc_low_on_data

If enabled, DC level = 0 indicates color data transfer.

Definition at line 71 of file panel_io.hpp.

dc_low_on_param

unsigned int idfxx::lcd::panel_io::spi_config::dc_low_on_param

If enabled, DC level = 0 indicates parameter transfer.

Definition at line 72 of file panel_io.hpp.

[struct]

struct { ... } idfxx::lcd::panel_io::spi_config::flags

Extra flags to fine-tune the SPI device.

lcd_cmd_bits

int idfxx::lcd::panel_io::spi_config::lcd_cmd_bits

Bit-width of LCD command.

Definition at line 63 of file panel_io.hpp.

lcd_param_bits

int idfxx::lcd::panel_io::spi_config::lcd_param_bits

Bit-width of LCD parameter.

Definition at line 64 of file panel_io.hpp.

lsb_first

unsigned int idfxx::lcd::panel_io::spi_config::lsb_first

transmit LSB bit first

Definition at line 78 of file panel_io.hpp.

octal_mode

unsigned int idfxx::lcd::panel_io::spi_config::octal_mode

transmit with octal mode (8 data lines), this mode is used to simulate Intel 8080 timing

Definition at line 73 of file panel_io.hpp.

on_color_transfer_done

color_transfer_done_callback idfxx::lcd::panel_io::spi_config::on_color_transfer_done

Initial value:

=
            nullptr

Callback invoked when color data transfer has finished.

Definition at line 61 of file panel_io.hpp.

pclk_freq

freq::hertz idfxx::lcd::panel_io::spi_config::pclk_freq

Frequency of pixel clock.

Definition at line 59 of file panel_io.hpp.

quad_mode

unsigned int idfxx::lcd::panel_io::spi_config::quad_mode

transmit with quad mode (4 data lines), this mode is useful when transmitting LCD parameters (Only use one line for command)

Definition at line 75 of file panel_io.hpp.

sio_mode

unsigned int idfxx::lcd::panel_io::spi_config::sio_mode

Read and write through a single data line (MOSI)

Definition at line 77 of file panel_io.hpp.

spi_mode

int idfxx::lcd::panel_io::spi_config::spi_mode

Traditional SPI mode (0~3)

Definition at line 58 of file panel_io.hpp.

trans_queue_depth

size_t idfxx::lcd::panel_io::spi_config::trans_queue_depth

Size of internal transaction queue.

Definition at line 60 of file panel_io.hpp.

---

The documentation for this struct was generated from the following file:

• idfxx_lcd/include/idfxx/lcd/panel_io.hpp