driver_ssd1309.h

Go to the documentation of this file.

 
#ifndef DRIVER_SSD1309_H
#define DRIVER_SSD1309_H
 
#include <stdint.h>
#include <stdio.h>
#include <string.h>
 
#ifdef __cplusplus
extern "C"{
#endif



typedef enum
{
    SSD1309_INTERFACE_IIC = 0x00,        
    SSD1309_INTERFACE_SPI = 0x01,        
} ssd1309_interface_t;

typedef enum  
{
    SSD1309_ADDR_SA0_0 = 0x78,        
    SSD1309_ADDR_SA0_1 = 0x7A,        
} ssd1309_address_t;

typedef enum
{
    SSD1309_BOOL_FALSE = 0x00,        
    SSD1309_BOOL_TRUE  = 0x01,        
} ssd1309_bool_t;

typedef enum  
{
    SSD1309_MEMORY_ADDRESSING_MODE_HORIZONTAL = 0x00,        
    SSD1309_MEMORY_ADDRESSING_MODE_VERTICAL   = 0x01,        
    SSD1309_MEMORY_ADDRESSING_MODE_PAGE       = 0x02,        
} ssd1309_memory_addressing_mode_t;

typedef enum  
{
    SSD1309_SCROLL_FRAME_1    = 0x07,        
    SSD1309_SCROLL_FRAME_2    = 0x04,        
    SSD1309_SCROLL_FRAME_3    = 0x05,        
    SSD1309_SCROLL_FRAME_4    = 0x06,        
    SSD1309_SCROLL_FRAME_5    = 0x00,        
    SSD1309_SCROLL_FRAME_64   = 0x01,        
    SSD1309_SCROLL_FRAME_128  = 0x02,        
    SSD1309_SCROLL_FRAME_256  = 0x03,        
} ssd1309_scroll_frame_t;

typedef enum  
{
    SSD1309_SEGMENT_COLUMN_ADDRESS_0   = 0x00,        
    SSD1309_SEGMENT_COLUMN_ADDRESS_127 = 0x01,        
} ssd1309_segment_column_remap_t;

typedef enum  
{
    SSD1309_ENTIRE_DISPLAY_OFF = 0x00,        
    SSD1309_ENTIRE_DISPLAY_ON  = 0x01,        
} ssd1309_entire_display_t;

typedef enum  
{
    SSD1309_DISPLAY_MODE_NORMAL  = 0x00,        
    SSD1309_DISPLAY_MODE_INVERSE = 0x01,        
} ssd1309_display_mode_t;

typedef enum  
{
    SSD1309_DISPLAY_OFF = 0x00,        
    SSD1309_DISPLAY_ON  = 0x01,        
} ssd1309_display_t;

typedef enum  
{
    SSD1309_SCAN_DIRECTION_COM0_START   = 0x00,        
    SSD1309_SCAN_DIRECTION_COMN_1_START = 0x01,        
} ssd1309_scan_direction_t;

typedef enum  
{
    SSD1309_PIN_CONF_SEQUENTIAL  = 0x00,        
    SSD1309_PIN_CONF_ALTERNATIVE = 0x01,        
} ssd1309_pin_conf_t;

typedef enum  
{
    SSD1309_LEFT_RIGHT_REMAP_DISABLE = 0x00,        
    SSD1309_LEFT_RIGHT_REMAP_ENABLE  = 0x01,        
} ssd1309_left_right_remap_t;

typedef enum  
{
    SSD1309_DESELECT_LEVEL_0P64 = 0x00,        
    SSD1309_DESELECT_LEVEL_0P78 = 0x0D,        
    SSD1309_DESELECT_LEVEL_0P84 = 0x0F,        
} ssd1309_deselect_level_t;

typedef enum  
{
    SSD1309_GPIO_HIZ_INPUT_DISABLE = 0x00,        
    SSD1309_GPIO_HIZ_INPUT_ENABLE  = 0x01,        
    SSD1309_GPIO_OUTPUT_LOW        = 0x02,        
    SSD1309_GPIO_OUTPUT_HIGH       = 0x03,        
} ssd1309_gpio_t;

typedef enum  
{
    SSD1309_FONT_12 = 0x0C,        
    SSD1309_FONT_16 = 0x10,        
    SSD1309_FONT_24 = 0x18,        
} ssd1309_font_t;

typedef struct ssd1309_handle_s
{
    uint8_t (*iic_init)(void);                                                          
    uint8_t (*iic_deinit)(void);                                                        
    uint8_t (*iic_write)(uint8_t addr, uint8_t reg, uint8_t *buf, uint16_t len);        
    uint8_t (*spi_init)(void);                                                          
    uint8_t (*spi_deinit)(void);                                                        
    uint8_t (*spi_write_cmd)(uint8_t *buf, uint16_t len);                               
    uint8_t (*spi_cmd_data_gpio_init)(void);                                            
    uint8_t (*spi_cmd_data_gpio_deinit)(void);                                          
    uint8_t (*spi_cmd_data_gpio_write)(uint8_t value);                                  
    uint8_t (*reset_gpio_init)(void);                                                   
    uint8_t (*reset_gpio_deinit)(void);                                                 
    uint8_t (*reset_gpio_write)(uint8_t value);                                         
    void (*debug_print)(const char *const fmt, ...);                                    
    void (*delay_ms)(uint32_t ms);                                                      
    uint8_t inited;                                                                     
    uint8_t iic_addr;                                                                   
    uint8_t iic_spi;                                                                    
    uint8_t gram[128][8];                                                               
} ssd1309_handle_t;

typedef struct ssd1309_info_s
{
    char chip_name[32];                
    char manufacturer_name[32];        
    char interface[8];                 
    float supply_voltage_min_v;        
    float supply_voltage_max_v;        
    float max_current_ma;              
    float temperature_min;             
    float temperature_max;             
    uint32_t driver_version;           
} ssd1309_info_t;



#define DRIVER_SSD1309_LINK_INIT(HANDLE, STRUCTURE)                     memset(HANDLE, 0, sizeof(STRUCTURE))

#define DRIVER_SSD1309_LINK_IIC_INIT(HANDLE, FUC)                      (HANDLE)->iic_init = FUC

#define DRIVER_SSD1309_LINK_IIC_DEINIT(HANDLE, FUC)                    (HANDLE)->iic_deinit = FUC

#define DRIVER_SSD1309_LINK_IIC_WRITE(HANDLE, FUC)                     (HANDLE)->iic_write = FUC

#define DRIVER_SSD1309_LINK_SPI_INIT(HANDLE, FUC)                      (HANDLE)->spi_init = FUC

#define DRIVER_SSD1309_LINK_SPI_DEINIT(HANDLE, FUC)                    (HANDLE)->spi_deinit = FUC

#define DRIVER_SSD1309_LINK_SPI_WRITE_COMMAND(HANDLE, FUC)             (HANDLE)->spi_write_cmd = FUC

#define DRIVER_SSD1309_LINK_SPI_COMMAND_DATA_GPIO_INIT(HANDLE, FUC)    (HANDLE)->spi_cmd_data_gpio_init = FUC

#define DRIVER_SSD1309_LINK_SPI_COMMAND_DATA_GPIO_DEINIT(HANDLE, FUC)  (HANDLE)->spi_cmd_data_gpio_deinit = FUC

#define DRIVER_SSD1309_LINK_SPI_COMMAND_DATA_GPIO_WRITE(HANDLE, FUC)   (HANDLE)->spi_cmd_data_gpio_write = FUC

#define DRIVER_SSD1309_LINK_RESET_GPIO_INIT(HANDLE, FUC)               (HANDLE)->reset_gpio_init = FUC

#define DRIVER_SSD1309_LINK_RESET_GPIO_DEINIT(HANDLE, FUC)             (HANDLE)->reset_gpio_deinit = FUC

#define DRIVER_SSD1309_LINK_RESET_GPIO_WRITE(HANDLE, FUC)              (HANDLE)->reset_gpio_write = FUC

#define DRIVER_SSD1309_LINK_DELAY_MS(HANDLE, FUC)                      (HANDLE)->delay_ms = FUC

#define DRIVER_SSD1309_LINK_DEBUG_PRINT(HANDLE, FUC)                   (HANDLE)->debug_print = FUC



uint8_t ssd1309_info(ssd1309_info_t *info);

uint8_t ssd1309_set_interface(ssd1309_handle_t *handle, ssd1309_interface_t interface);

uint8_t ssd1309_get_interface(ssd1309_handle_t *handle, ssd1309_interface_t *interface);

uint8_t ssd1309_set_addr_pin(ssd1309_handle_t *handle, ssd1309_address_t addr_pin);

uint8_t ssd1309_get_addr_pin(ssd1309_handle_t *handle, ssd1309_address_t *addr_pin);

uint8_t ssd1309_init(ssd1309_handle_t *handle);

uint8_t ssd1309_deinit(ssd1309_handle_t *handle);

uint8_t ssd1309_clear(ssd1309_handle_t *handle);

uint8_t ssd1309_write_point(ssd1309_handle_t *handle, uint8_t x, uint8_t y, uint8_t data);

uint8_t ssd1309_read_point(ssd1309_handle_t *handle, uint8_t x, uint8_t y, uint8_t *data);

uint8_t ssd1309_gram_write_point(ssd1309_handle_t *handle, uint8_t x, uint8_t y, uint8_t data);

uint8_t ssd1309_gram_read_point(ssd1309_handle_t *handle, uint8_t x, uint8_t y, uint8_t *data);

uint8_t ssd1309_gram_write_string(ssd1309_handle_t *handle, uint8_t x, uint8_t y, char *str, uint16_t len, uint8_t color, ssd1309_font_t font);

uint8_t ssd1309_gram_fill_rect(ssd1309_handle_t *handle, uint8_t left, uint8_t top, uint8_t right, uint8_t bottom, uint8_t color);

uint8_t ssd1309_gram_draw_picture(ssd1309_handle_t *handle, uint8_t left, uint8_t top, uint8_t right, uint8_t bottom, uint8_t *img);

uint8_t ssd1309_gram_update(ssd1309_handle_t *handle);

uint8_t ssd1309_set_low_column_start_address(ssd1309_handle_t *handle, uint8_t addr);

uint8_t ssd1309_set_high_column_start_address(ssd1309_handle_t *handle, uint8_t addr);

uint8_t ssd1309_set_memory_addressing_mode(ssd1309_handle_t *handle, ssd1309_memory_addressing_mode_t mode);

uint8_t ssd1309_set_column_address_range(ssd1309_handle_t *handle, uint8_t start_addr, uint8_t end_addr);

uint8_t ssd1309_set_page_address_range(ssd1309_handle_t *handle, uint8_t start_addr, uint8_t end_addr);

uint8_t ssd1309_set_right_horizontal_scroll(ssd1309_handle_t *handle, uint8_t start_page_addr, 
                                            uint8_t end_page_addr, ssd1309_scroll_frame_t frames, 
                                            uint8_t start_column_addr, uint8_t end_column_addr);

uint8_t ssd1309_set_left_horizontal_scroll(ssd1309_handle_t *handle, uint8_t start_page_addr,
                                           uint8_t end_page_addr, ssd1309_scroll_frame_t frames,
                                           uint8_t start_column_addr, uint8_t end_column_addr);

uint8_t ssd1309_set_vertical_right_horizontal_scroll(ssd1309_handle_t *handle, ssd1309_bool_t horizontal_scroll, 
                                                     uint8_t start_page_addr, uint8_t end_page_addr, 
                                                     uint8_t rows, ssd1309_scroll_frame_t frames,
                                                     uint8_t start_column_addr, uint8_t end_column_addr);

uint8_t ssd1309_set_vertical_left_horizontal_scroll(ssd1309_handle_t *handle, ssd1309_bool_t horizontal_scroll, 
                                                    uint8_t start_page_addr, uint8_t end_page_addr, 
                                                    uint8_t rows, ssd1309_scroll_frame_t frames,
                                                    uint8_t start_column_addr, uint8_t end_column_addr);

uint8_t ssd1309_deactivate_scroll(ssd1309_handle_t *handle);

uint8_t ssd1309_activate_scroll(ssd1309_handle_t *handle);

uint8_t ssd1309_set_display_start_line(ssd1309_handle_t *handle, uint8_t l);

uint8_t ssd1309_set_contrast(ssd1309_handle_t *handle, uint8_t contrast);

uint8_t ssd1309_set_segment_remap(ssd1309_handle_t *handle, ssd1309_segment_column_remap_t remap);

uint8_t ssd1309_set_vertical_scroll_area(ssd1309_handle_t *handle, uint8_t start_row, uint8_t end_row);

uint8_t ssd1309_set_entire_display(ssd1309_handle_t *handle, ssd1309_entire_display_t enable);

uint8_t ssd1309_set_display_mode(ssd1309_handle_t *handle, ssd1309_display_mode_t mode);

uint8_t ssd1309_set_multiplex_ratio(ssd1309_handle_t *handle, uint8_t multiplex);

uint8_t ssd1309_set_display(ssd1309_handle_t *handle, ssd1309_display_t on_off);

uint8_t ssd1309_set_page_address(ssd1309_handle_t *handle, uint8_t addr);

uint8_t ssd1309_set_scan_direction(ssd1309_handle_t *handle, ssd1309_scan_direction_t dir);

uint8_t ssd1309_set_display_offset(ssd1309_handle_t *handle, uint8_t offset);

uint8_t ssd1309_set_display_clock(ssd1309_handle_t *handle, uint8_t oscillator_frequency, uint8_t clock_divide);

uint8_t ssd1309_set_precharge_period(ssd1309_handle_t *handle, uint8_t phase1_period, uint8_t phase2_period);

uint8_t ssd1309_set_com_pins_hardware_conf(ssd1309_handle_t *handle, ssd1309_pin_conf_t conf, ssd1309_left_right_remap_t remap);

uint8_t ssd1309_set_deselect_level(ssd1309_handle_t *handle, ssd1309_deselect_level_t level);

uint8_t ssd1309_set_right_horizontal_scroll_one_column(ssd1309_handle_t *handle, uint8_t start_page_addr, 
                                                       uint8_t end_page_addr, uint8_t start_column_addr,
                                                       uint8_t end_column_addr);

uint8_t ssd1309_set_left_horizontal_scroll_one_column(ssd1309_handle_t *handle, uint8_t start_page_addr, 
                                                      uint8_t end_page_addr, uint8_t start_column_addr,
                                                      uint8_t end_column_addr);

uint8_t ssd1309_set_gpio(ssd1309_handle_t *handle, ssd1309_gpio_t gpio);

uint8_t ssd1309_set_mcu_interface_lock(ssd1309_handle_t *handle, ssd1309_bool_t enable);



uint8_t ssd1309_write_cmd(ssd1309_handle_t *handle, uint8_t *buf, uint8_t len);

uint8_t ssd1309_write_data(ssd1309_handle_t *handle, uint8_t *buf, uint8_t len);


 
#ifdef __cplusplus
}
#endif
 
#endif