driver_ssd1315.h

Go to the documentation of this file.

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



typedef enum
{
    SSD1315_INTERFACE_IIC = 0x00,        
    SSD1315_INTERFACE_SPI = 0x01,        
} ssd1315_interface_t;

typedef enum  
{
    SSD1315_ADDR_SA0_0 = 0x78,        
    SSD1315_ADDR_SA0_1 = 0x7A,        
} ssd1315_address_t;

typedef enum  
{
    SSD1315_MEMORY_ADDRESSING_MODE_HORIZONTAL = 0x00,        
    SSD1315_MEMORY_ADDRESSING_MODE_VERTICAL   = 0x01,        
    SSD1315_MEMORY_ADDRESSING_MODE_PAGE       = 0x02,        
} ssd1315_memory_addressing_mode_t;

typedef enum  
{
    SSD1315_FADE_BLINKING_MODE_DISABLE  = 0x00,        
    SSD1315_FADE_BLINKING_MODE_FADE_OUT = 0x02,        
    SSD1315_FADE_BLINKING_MODE_BLINKING = 0x03,        
} ssd1315_fade_blinking_mode_t;

typedef enum  
{
    SSD1315_HORIZONTAL_SCROLL_DISABLE = 0x00,        
    SSD1315_HORIZONTAL_SCROLL_ENABLE  = 0x01,        
} ssd1315_horizontal_scroll_t;

typedef enum  
{
    SSD1315_SCROLL_FRAME_2    = 0x07,        
    SSD1315_SCROLL_FRAME_3    = 0x04,        
    SSD1315_SCROLL_FRAME_4    = 0x05,        
    SSD1315_SCROLL_FRAME_5    = 0x06,        
    SSD1315_SCROLL_FRAME_6    = 0x00,        
    SSD1315_SCROLL_FRAME_32   = 0x01,        
    SSD1315_SCROLL_FRAME_64   = 0x02,        
    SSD1315_SCROLL_FRAME_128  = 0x03,        
} ssd1315_scroll_frame_t;

typedef enum  
{
    SSD1315_CHARGE_PUMP_DISABLE = 0x00,        
    SSD1315_CHARGE_PUMP_ENABLE  = 0x01,        
} ssd1315_charge_pump_t;

typedef enum  
{
    SSD1315_CHARGE_PUMP_MODE_7P5V = 0x00,        
    SSD1315_CHARGE_PUMP_MODE_8P5V = 0x02,        
    SSD1315_CHARGE_PUMP_MODE_9P0V = 0x03,        
} ssd1315_charge_pump_mode_t;

typedef enum  
{
    SSD1315_SEGMENT_COLUMN_ADDRESS_0   = 0x00,        
    SSD1315_SEGMENT_COLUMN_ADDRESS_127 = 0x01,        
} ssd1315_segment_column_remap_t;

typedef enum  
{
    SSD1315_ENTIRE_DISPLAY_OFF = 0x00,        
    SSD1315_ENTIRE_DISPLAY_ON  = 0x01,        
} ssd1315_entire_display_t;

typedef enum  
{
    SSD1315_DISPLAY_MODE_NORMAL  = 0x00,        
    SSD1315_DISPLAY_MODE_INVERSE = 0x01,        
} ssd1315_display_mode_t;

typedef enum  
{
    SSD1315_DISPLAY_OFF = 0x00,        
    SSD1315_DISPLAY_ON  = 0x01,        
} ssd1315_display_t;

typedef enum  
{
    SSD1315_SCAN_DIRECTION_COM0_START   = 0x00,        
    SSD1315_SCAN_DIRECTION_COMN_1_START = 0x01,        
} ssd1315_scan_direction_t;

typedef enum  
{
    SSD1315_ZOOM_IN_DISABLE = 0x00,        
    SSD1315_ZOOM_IN_ENABLE  = 0x01,        
} ssd1315_zoom_in_t;

typedef enum  
{
    SSD1315_PIN_CONF_SEQUENTIAL  = 0x00,        
    SSD1315_PIN_CONF_ALTERNATIVE = 0x01,        
} ssd1315_pin_conf_t;

typedef enum  
{
    SSD1315_LEFT_RIGHT_REMAP_DISABLE = 0x00,        
    SSD1315_LEFT_RIGHT_REMAP_ENABLE  = 0x01,        
} ssd1315_left_right_remap_t;

typedef enum  
{
    SSD1315_DESELECT_LEVEL_0P65 = 0x00,        
    SSD1315_DESELECT_LEVEL_0P77 = 0x02,        
    SSD1315_DESELECT_LEVEL_0P83 = 0x03,        
} ssd1315_deselect_level_t;

typedef enum  
{
    SSD1315_IREF_DISABLE = 0x00,        
    SSD1315_IREF_ENABLE  = 0x01,        
} ssd1315_iref_t;

typedef enum  
{
    SSD1315_IREF_VALUE_19UA_150UA = 0x00,        
    SSD1315_IREF_VALUE_30UA_240UA = 0x01,        
} ssd1315_iref_value_t;

typedef enum  
{
    SSD1315_FONT_12 = 0x0C,        
    SSD1315_FONT_16 = 0x10,        
    SSD1315_FONT_24 = 0x18,        
} ssd1315_font_t;

typedef struct ssd1315_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];                                                               
} ssd1315_handle_t;

typedef struct ssd1315_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;           
} ssd1315_info_t;



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

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

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

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

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

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

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

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

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

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

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

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

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

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

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



uint8_t ssd1315_info(ssd1315_info_t *info);

uint8_t ssd1315_set_interface(ssd1315_handle_t *handle, ssd1315_interface_t interface);

uint8_t ssd1315_get_interface(ssd1315_handle_t *handle, ssd1315_interface_t *interface);

uint8_t ssd1315_set_addr_pin(ssd1315_handle_t *handle, ssd1315_address_t addr_pin);

uint8_t ssd1315_get_addr_pin(ssd1315_handle_t *handle, ssd1315_address_t *addr_pin);

uint8_t ssd1315_init(ssd1315_handle_t *handle);

uint8_t ssd1315_deinit(ssd1315_handle_t *handle);

uint8_t ssd1315_clear(ssd1315_handle_t *handle);

uint8_t ssd1315_gram_update(ssd1315_handle_t *handle);

uint8_t ssd1315_write_point(ssd1315_handle_t *handle, uint8_t x, uint8_t y, uint8_t data);

uint8_t ssd1315_read_point(ssd1315_handle_t *handle, uint8_t x, uint8_t y, uint8_t *data);

uint8_t ssd1315_gram_write_point(ssd1315_handle_t *handle, uint8_t x, uint8_t y, uint8_t data);

uint8_t ssd1315_gram_read_point(ssd1315_handle_t *handle, uint8_t x, uint8_t y, uint8_t *data);

uint8_t ssd1315_gram_write_string(ssd1315_handle_t *handle, uint8_t x, uint8_t y, char *str, uint16_t len, uint8_t color, ssd1315_font_t font);

uint8_t ssd1315_gram_fill_rect(ssd1315_handle_t *handle, uint8_t left, uint8_t top, uint8_t right, uint8_t bottom, uint8_t color);

uint8_t ssd1315_gram_draw_picture(ssd1315_handle_t *handle, uint8_t left, uint8_t top, uint8_t right, uint8_t bottom, uint8_t *img);

uint8_t ssd1315_set_low_column_start_address(ssd1315_handle_t *handle, uint8_t addr);

uint8_t ssd1315_set_high_column_start_address(ssd1315_handle_t *handle, uint8_t addr);

uint8_t ssd1315_set_memory_addressing_mode(ssd1315_handle_t *handle, ssd1315_memory_addressing_mode_t mode);

uint8_t ssd1315_set_column_address_range(ssd1315_handle_t *handle, uint8_t start_addr, uint8_t end_addr);

uint8_t ssd1315_set_page_address_range(ssd1315_handle_t *handle, uint8_t start_addr, uint8_t end_addr);

uint8_t ssd1315_set_fade_blinking_mode(ssd1315_handle_t *handle, ssd1315_fade_blinking_mode_t mode, uint8_t frames);

uint8_t ssd1315_set_right_horizontal_scroll(ssd1315_handle_t *handle, uint8_t start_page_addr, uint8_t end_page_addr, 
                                            ssd1315_scroll_frame_t frames);

uint8_t ssd1315_set_left_horizontal_scroll(ssd1315_handle_t *handle, uint8_t start_page_addr, uint8_t end_page_addr, 
                                           ssd1315_scroll_frame_t frames);

uint8_t ssd1315_set_vertical_right_horizontal_scroll(ssd1315_handle_t *handle, ssd1315_horizontal_scroll_t enable,
                                                     uint8_t start_page_addr, uint8_t end_page_addr, 
                                                     uint8_t vertical_scrolling_offset, ssd1315_scroll_frame_t frames,
                                                     uint8_t start_column_addr, uint8_t end_column_addr);

uint8_t ssd1315_set_vertical_left_horizontal_scroll(ssd1315_handle_t *handle, ssd1315_horizontal_scroll_t enable,
                                                    uint8_t start_page_addr, uint8_t end_page_addr, 
                                                    uint8_t vertical_scrolling_offset, ssd1315_scroll_frame_t frames,
                                                    uint8_t start_column_addr, uint8_t end_column_addr);

uint8_t ssd1315_deactivate_scroll(ssd1315_handle_t *handle);

uint8_t ssd1315_activate_scroll(ssd1315_handle_t *handle);

uint8_t ssd1315_set_display_start_line(ssd1315_handle_t *handle, uint8_t l);

uint8_t ssd1315_set_contrast(ssd1315_handle_t *handle, uint8_t contrast);

uint8_t ssd1315_set_charge_pump(ssd1315_handle_t *handle, ssd1315_charge_pump_t enable, ssd1315_charge_pump_mode_t mode);

uint8_t ssd1315_set_segment_remap(ssd1315_handle_t *handle, ssd1315_segment_column_remap_t remap);

uint8_t ssd1315_set_vertical_scroll_area(ssd1315_handle_t *handle, uint8_t start_row, uint8_t end_row);

uint8_t ssd1315_set_entire_display(ssd1315_handle_t *handle, ssd1315_entire_display_t enable);

uint8_t ssd1315_set_display_mode(ssd1315_handle_t *handle, ssd1315_display_mode_t mode);

uint8_t ssd1315_set_multiplex_ratio(ssd1315_handle_t *handle, uint8_t multiplex);

uint8_t ssd1315_set_display(ssd1315_handle_t *handle, ssd1315_display_t on_off);

uint8_t ssd1315_set_page_address(ssd1315_handle_t *handle, uint8_t addr);

uint8_t ssd1315_set_scan_direction(ssd1315_handle_t *handle, ssd1315_scan_direction_t dir);

uint8_t ssd1315_set_display_offset(ssd1315_handle_t *handle, uint8_t offset);

uint8_t ssd1315_set_display_clock(ssd1315_handle_t *handle, uint8_t oscillator_frequency, uint8_t clock_divide);

uint8_t ssd1315_set_zoom_in(ssd1315_handle_t *handle, ssd1315_zoom_in_t zoom);

uint8_t ssd1315_set_precharge_period(ssd1315_handle_t *handle, uint8_t phase1_period, uint8_t phase2_period);

uint8_t ssd1315_set_com_pins_hardware_conf(ssd1315_handle_t *handle, ssd1315_pin_conf_t conf, ssd1315_left_right_remap_t remap);

uint8_t ssd1315_set_deselect_level(ssd1315_handle_t *handle, ssd1315_deselect_level_t level);

uint8_t ssd1315_set_iref(ssd1315_handle_t *handle, ssd1315_iref_t enable, ssd1315_iref_value_t iref);

uint8_t ssd1315_set_right_horizontal_scroll_one_column(ssd1315_handle_t *handle, uint8_t start_page, uint8_t end_page,
                                                       uint8_t start_column_addr, uint8_t end_column_addr);

uint8_t ssd1315_set_left_horizontal_scroll_one_column(ssd1315_handle_t *handle, uint8_t start_page, uint8_t end_page,
                                                      uint8_t start_column_addr, uint8_t end_column_addr);



uint8_t ssd1315_write_cmd(ssd1315_handle_t *handle, uint8_t *buf, uint8_t len);

uint8_t ssd1315_write_data(ssd1315_handle_t *handle, uint8_t *buf, uint8_t len);


 
#ifdef __cplusplus
}
#endif
 
#endif