Full configuration structure for initializing an SSD1309 display handle. More...

#include <ssd1309.h>

Collaboration diagram for SSD1309_CFG_ts:

[legend]

Public Attributes
I2C_REGDEF_ts *	i2c_instance
GPIO_REGDEF_ts *	scl_gpio_port
GPIO_PIN_te	scl_gpio_pin
GPIO_REGDEF_ts *	sda_gpio_port
GPIO_PIN_te	sda_gpio_pin
GPIO_ALTERNATE_FUNCTION_te	gpio_alternate_function
SSD1309_LOW_COL_START_ADDR_PAM_te	low_col_start_addr_pam
SSD1309_HIGH_COL_START_ADDR_PAM_te	high_col_start_addr_pam
SSD1309_MEM_ADDR_MODE_te	mem_addr_mode
SSD1309_COL_ADDR_START_HAM_VAM_te	col_addr_start_ham_vam
SSD1309_COL_ADDR_END_HAM_VAM_te	col_addr_end_ham_vam
SSD1309_PAGE_ADDR_START_HAM_VAM_te	page_addr_start_ham_vam
SSD1309_PAGE_ADDR_END_HAM_VAM_te	page_addr_end_ham_vam
SSD1309_START_LINE_te	start_line
SSD1309_CONTRAST_te	contrast
SSD1309_HORIZONTAL_FLIP_te	horizontal_flip
SSD1309_INVERSE_MODE_te	inverse_mode
SSD1309_MULTIPLEX_RATIO_te	multiplex_ratio
SSD1309_PAGE_START_ADDR_PAM_te	page_start_addr_pam
SSD1309_VERTICAL_FLIP_te	vertical_flip
SSD1309_OFFSET_te	offset
SSD1309_CLK_DIV_RATIO_te	clk_div_ratio
SSD1309_CLK_SPEED_LVL_te	clk_speed_lvl
SSD1309_PHASE1_PRECHARGE_DCLK_te	phase1_precharge_dclk
SSD1309_PHASE2_PRECHARGE_DCLK_te	phase2_precharge_dclk
SSD1309_VCOMH_DESELECT_LVL_te	vcomh_deselect_lvl

Detailed Description

Full configuration structure for initializing an SSD1309 display handle.

Passed to ssd1309_init_handle. Use ssd1309_get_def_cfg to obtain a sensible default configuration and then override specific fields as needed.

Fields are grouped by addressing mode relevance:

PAM fields: low_col_start_addr_pam, high_col_start_addr_pam, page_start_addr_pam
HAM/VAM fields: col_addr_start_ham_vam, col_addr_end_ham_vam, page_addr_start_ham_vam, page_addr_end_ham_vam

Definition at line 1046 of file ssd1309.h.

Member Data Documentation

◆ i2c_instance

I2C_REGDEF_ts* SSD1309_CFG_ts::i2c_instance

Pointer to the I2C peripheral instance connected to the display.

Definition at line 1048 of file ssd1309.h.

◆ scl_gpio_port

GPIO_REGDEF_ts* SSD1309_CFG_ts::scl_gpio_port

GPIO port of the I2C SCL pin.

Definition at line 1051 of file ssd1309.h.

◆ scl_gpio_pin

GPIO_PIN_te SSD1309_CFG_ts::scl_gpio_pin

GPIO pin number of the I2C SCL pin.

Definition at line 1054 of file ssd1309.h.

◆ sda_gpio_port

GPIO_REGDEF_ts* SSD1309_CFG_ts::sda_gpio_port

GPIO port of the I2C SDA pin.

Definition at line 1057 of file ssd1309.h.

◆ sda_gpio_pin

GPIO_PIN_te SSD1309_CFG_ts::sda_gpio_pin

GPIO pin number of the I2C SDA pin.

Definition at line 1060 of file ssd1309.h.

◆ gpio_alternate_function

GPIO_ALTERNATE_FUNCTION_te SSD1309_CFG_ts::gpio_alternate_function

Alternate function mapping for both SCL and SDA GPIO pins.

Definition at line 1063 of file ssd1309.h.

◆ low_col_start_addr_pam

SSD1309_LOW_COL_START_ADDR_PAM_te SSD1309_CFG_ts::low_col_start_addr_pam

Lower nibble of the column start address (PAM only).

Definition at line 1066 of file ssd1309.h.

◆ high_col_start_addr_pam

SSD1309_HIGH_COL_START_ADDR_PAM_te SSD1309_CFG_ts::high_col_start_addr_pam

Upper nibble of the column start address (PAM only).

Definition at line 1069 of file ssd1309.h.

◆ mem_addr_mode

SSD1309_MEM_ADDR_MODE_te SSD1309_CFG_ts::mem_addr_mode

Memory addressing mode: HAM, VAM, or PAM.

Definition at line 1072 of file ssd1309.h.

◆ col_addr_start_ham_vam

SSD1309_COL_ADDR_START_HAM_VAM_te SSD1309_CFG_ts::col_addr_start_ham_vam

Column start address for RAM scanning (HAM and VAM only).

Definition at line 1075 of file ssd1309.h.

◆ col_addr_end_ham_vam

SSD1309_COL_ADDR_END_HAM_VAM_te SSD1309_CFG_ts::col_addr_end_ham_vam

Column end address for RAM scanning (HAM and VAM only).

Definition at line 1078 of file ssd1309.h.

◆ page_addr_start_ham_vam

SSD1309_PAGE_ADDR_START_HAM_VAM_te SSD1309_CFG_ts::page_addr_start_ham_vam

Page start address for RAM scanning (HAM and VAM only).

Definition at line 1081 of file ssd1309.h.

◆ page_addr_end_ham_vam

SSD1309_PAGE_ADDR_END_HAM_VAM_te SSD1309_CFG_ts::page_addr_end_ham_vam

Page end address for RAM scanning (HAM and VAM only).

Definition at line 1084 of file ssd1309.h.

◆ start_line

SSD1309_START_LINE_te SSD1309_CFG_ts::start_line

RAM row that maps to the top of the display.

Definition at line 1087 of file ssd1309.h.

◆ contrast

SSD1309_CONTRAST_te SSD1309_CFG_ts::contrast

Display brightness (current control level, 0–255).

Definition at line 1090 of file ssd1309.h.

◆ horizontal_flip

SSD1309_HORIZONTAL_FLIP_te SSD1309_CFG_ts::horizontal_flip

Horizontal segment re-map (left/right flip).

Definition at line 1093 of file ssd1309.h.

◆ inverse_mode

SSD1309_INVERSE_MODE_te SSD1309_CFG_ts::inverse_mode

Inverse video mode (swap on/off pixel polarity).

Definition at line 1096 of file ssd1309.h.

◆ multiplex_ratio

SSD1309_MULTIPLEX_RATIO_te SSD1309_CFG_ts::multiplex_ratio

Number of active COM lines (display height in rows).

Definition at line 1099 of file ssd1309.h.

◆ page_start_addr_pam

SSD1309_PAGE_START_ADDR_PAM_te SSD1309_CFG_ts::page_start_addr_pam

Page start address for the first displayed page (PAM only).

Definition at line 1102 of file ssd1309.h.

◆ vertical_flip

SSD1309_VERTICAL_FLIP_te SSD1309_CFG_ts::vertical_flip

COM output scan direction (top/bottom flip).

Definition at line 1105 of file ssd1309.h.

◆ offset

SSD1309_OFFSET_te SSD1309_CFG_ts::offset

COM pin vertical shift (maps RAM row 0 to a different COM output).

Definition at line 1108 of file ssd1309.h.

◆ clk_div_ratio

SSD1309_CLK_DIV_RATIO_te SSD1309_CFG_ts::clk_div_ratio

Display clock divide ratio.

Definition at line 1111 of file ssd1309.h.

◆ clk_speed_lvl

SSD1309_CLK_SPEED_LVL_te SSD1309_CFG_ts::clk_speed_lvl

Display oscillator frequency level.

Definition at line 1114 of file ssd1309.h.

◆ phase1_precharge_dclk

SSD1309_PHASE1_PRECHARGE_DCLK_te SSD1309_CFG_ts::phase1_precharge_dclk

Phase 1 (discharge) duration of the pixel drive waveform in DCLKs.

Definition at line 1117 of file ssd1309.h.

◆ phase2_precharge_dclk

SSD1309_PHASE2_PRECHARGE_DCLK_te SSD1309_CFG_ts::phase2_precharge_dclk

Phase 2 (charge) duration of the pixel drive waveform in DCLKs.

Definition at line 1120 of file ssd1309.h.

◆ vcomh_deselect_lvl

SSD1309_VCOMH_DESELECT_LVL_te SSD1309_CFG_ts::vcomh_deselect_lvl

VCOMH deselect voltage level relative to Vcc.

Definition at line 1123 of file ssd1309.h.

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

core/inc/ssd1309.h

Public Attributes