driver_st7920.h

Go to the documentation of this file.

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



#ifndef ST7920_COMMAND_CMD_DELAY
    #define ST7920_COMMAND_CMD_DELAY        100        
#endif

#ifndef ST7920_COMMAND_DATA_DELAY
    #define ST7920_COMMAND_DATA_DELAY        10        
#endif

typedef enum
{
    ST7920_BOOL_FALSE = 0x00,        
    ST7920_BOOL_TRUE  = 0x01,        
} st7920_bool_t;

typedef enum
{
    ST7920_ADDRESS_COUNTER_MODE_DECREASE = 0x00,        
    ST7920_ADDRESS_COUNTER_MODE_INCREASE = 0x01,        
} st7920_address_counter_mode_t;

typedef enum
{
    ST7920_DISPLAY_SHIFT_RIGHT = 0x00,        
    ST7920_DISPLAY_SHIFT_LEFT  = 0x01,        
} st7920_display_shift_t;

typedef enum
{
    ST7920_DISPLAY_SHIFT_MODE_LL = 0x00,        
    ST7920_DISPLAY_SHIFT_MODE_LH = 0x01,        
    ST7920_DISPLAY_SHIFT_MODE_HL = 0x02,        
    ST7920_DISPLAY_SHIFT_MODE_HH = 0x03,        
} st7920_display_shift_mode_t;

typedef enum
{
    ST7920_INTERFACE_BUS_BIT_4 = 0x00,        
    ST7920_INTERFACE_BUS_BIT_8 = 0x01,        
} st7920_interface_bus_bit_t;

typedef enum
{
    ST7920_COMMAND_MODE_BASIC    = 0x00,        
    ST7920_COMMAND_MODE_EXTENDED = 0x01,        
} st7920_command_mode_t;



typedef enum
{
    ST7920_REVERSE_LINE_FIRST  = 0x00,        
    ST7920_REVERSE_LINE_SECOND = 0x01,        
    ST7920_REVERSE_LINE_THIRD  = 0x02,        
    ST7920_REVERSE_LINE_FOURTH = 0x03,        
} st7920_reverse_line_t;



typedef struct st7920_handle_s
{
    uint8_t (*cs_gpio_init)(void);                          
    uint8_t (*cs_gpio_deinit)(void);                        
    uint8_t (*cs_gpio_write)(uint8_t value);                
    uint8_t (*sclk_gpio_init)(void);                        
    uint8_t (*sclk_gpio_deinit)(void);                      
    uint8_t (*sclk_gpio_write)(uint8_t value);              
    uint8_t (*sid_gpio_init)(void);                         
    uint8_t (*sid_gpio_deinit)(void);                       
    uint8_t (*sid_gpio_write)(uint8_t value);               
    void (*debug_print)(const char *const fmt, ...);        
    void (*delay_ms)(uint32_t ms);                          
    void (*delay_us)(uint32_t us);                          
    uint8_t basic_extended;                                 
    uint8_t inited;                                         
    uint8_t scroll_address;                                 
    uint16_t gram[8][64];                                   
} st7920_handle_t;

typedef struct st7920_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;           
} st7920_info_t;



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

#define DRIVER_ST7920_LINK_CS_GPIO_INIT(HANDLE, FUC)        (HANDLE)->cs_gpio_init = FUC

#define DRIVER_ST7920_LINK_CS_GPIO_DEINIT(HANDLE, FUC)      (HANDLE)->cs_gpio_deinit = FUC

#define DRIVER_ST7920_LINK_CS_GPIO_WRITE(HANDLE, FUC)       (HANDLE)->cs_gpio_write = FUC

#define DRIVER_ST7920_LINK_SCLK_GPIO_INIT(HANDLE, FUC)      (HANDLE)->sclk_gpio_init = FUC

#define DRIVER_ST7920_LINK_SCLK_GPIO_DEINIT(HANDLE, FUC)    (HANDLE)->sclk_gpio_deinit = FUC

#define DRIVER_ST7920_LINK_SCLK_GPIO_WRITE(HANDLE, FUC)     (HANDLE)->sclk_gpio_write = FUC

#define DRIVER_ST7920_LINK_SID_GPIO_INIT(HANDLE, FUC)       (HANDLE)->sid_gpio_init = FUC

#define DRIVER_ST7920_LINK_SID_GPIO_DEINIT(HANDLE, FUC)     (HANDLE)->sid_gpio_deinit = FUC

#define DRIVER_ST7920_LINK_SID_GPIO_WRITE(HANDLE, FUC)      (HANDLE)->sid_gpio_write = FUC

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

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

#define DRIVER_ST7920_LINK_DELAY_US(HANDLE, FUC)            (HANDLE)->delay_us = FUC



uint8_t st7920_info(st7920_info_t *info);

uint8_t st7920_init(st7920_handle_t *handle);

uint8_t st7920_deinit(st7920_handle_t *handle);

uint8_t st7920_write_string(st7920_handle_t *handle, uint8_t x, uint8_t y, char *str);

uint8_t st7920_display_clear(st7920_handle_t *handle);

uint8_t st7920_return_home(st7920_handle_t *handle);

uint8_t st7920_set_entry_mode(st7920_handle_t *handle, st7920_display_shift_t shift, st7920_address_counter_mode_t mode);

uint8_t st7920_set_display_control(st7920_handle_t *handle, st7920_bool_t display_on, st7920_bool_t cursor_on, st7920_bool_t character_blink_on);

uint8_t st7920_set_display_shift_mode(st7920_handle_t *handle, st7920_display_shift_mode_t mode);

uint8_t st7920_set_function(st7920_handle_t *handle, st7920_interface_bus_bit_t bus_bit, st7920_command_mode_t mode);

uint8_t st7920_set_cgram_address(st7920_handle_t *handle, uint8_t addr);

uint8_t st7920_set_ddram_address(st7920_handle_t *handle, uint8_t addr);

uint8_t st7920_write_ram(st7920_handle_t *handle, uint8_t *data, uint8_t len);



uint8_t st7920_write_point(st7920_handle_t *handle, uint8_t x, uint8_t y, uint8_t data);

uint8_t st7920_read_point(st7920_handle_t *handle, uint8_t x, uint8_t y, uint8_t *data);

uint8_t st7920_fill_rect(st7920_handle_t *handle, uint8_t left, uint8_t top, uint8_t right, uint8_t bottom, uint8_t color);

uint8_t st7920_draw_picture(st7920_handle_t *handle, uint8_t left, uint8_t top, uint8_t right, uint8_t bottom, uint8_t *img);

uint8_t st7920_draw_compress_picture(st7920_handle_t *handle, uint8_t left, uint8_t top, uint8_t right, uint8_t bottom, uint8_t *img);

uint8_t st7920_set_standby(st7920_handle_t *handle);

uint8_t st7920_set_vertical_scroll(st7920_handle_t *handle, st7920_bool_t enable);

uint8_t st7920_set_reverse_line(st7920_handle_t *handle, st7920_reverse_line_t l);

uint8_t st7920_set_extended_function(st7920_handle_t *handle, st7920_interface_bus_bit_t bus_bit,
                                     st7920_command_mode_t mode, st7920_bool_t graphic_display_enable);

uint8_t st7920_set_scroll_address(st7920_handle_t *handle, uint8_t addr);

uint8_t st7920_set_graphic_address(st7920_handle_t *handle, uint8_t vertical_addr, uint8_t horizontal_addr);



uint8_t st7920_write_cmd(st7920_handle_t *handle, uint8_t cmd);

uint8_t st7920_write_data(st7920_handle_t *handle, uint8_t data);


 
#ifdef __cplusplus
}
#endif
 
#endif