px_lcd_st7567_jhd12864.c

/* =============================================================================
     _____   _____   _____   ____    _   _    ____    __  __   _____  __   __
    |  __ \ |_   _| / ____| / __ \  | \ | |  / __ \  |  \/  | |_   _| \ \ / /
    | |__) |  | |  | |     | |  | | |  \| | | |  | | | \  / |   | |    \ V /
    |  ___/   | |  | |     | |  | | | . ` | | |  | | | |\/| |   | |     > < 
    | |      _| |_ | |____ | |__| | | |\  | | |__| | | |  | |  _| |_   / . \
    |_|     |_____| \_____| \____/  |_| \_|  \____/  |_|  |_| |_____| /_/ \_\
 
    Copyright (c) 2018 Pieter Conradie <https://piconomix.com>
 
    License: MIT
    https://github.com/piconomix/px-fwlib/blob/master/LICENSE.md
 
    Title:          px_lcd_st7567_jhd12864.h : JHD JHD12864-G176BSW 128x64 monochrome LCD wtih Sitronix ST7567 driver
    Author(s):      Pieter Conradie
    Creation Date:  2018-09-10
 
============================================================================= */
 
/* _____STANDARD INCLUDES____________________________________________________ */
 
/* _____PROJECT INCLUDES_____________________________________________________ */
#include "px_lcd_st7567_jhd12864.h"
#include "px_log.h"
 
/* _____LOCAL DEFINITIONS____________________________________________________ */
PX_LOG_NAME("lcd");
 
/// @name ST7567 commands (Table 8, page 21)
/// @{
#define PX_LCD_CMD_DISP_ON_OFF          0xae    ///< (1)  Display ON/OFF
#define PX_LCD_CMD_SET_START_LINE       0x40    ///< (2)  Set display start line
#define PX_LCD_CMD_SET_PAGE_ADR         0xb0    ///< (3)  Set page address
#define PX_LCD_CMD_SET_COL_ADR_HI       0x10    ///< (4)  Set column address (MSB)
#define PX_LCD_CMD_SET_COL_ADR_LO       0x00    ///< (4)  Set column address (LSB)
#define PX_LCD_CMD_SEG_DIR              0xa0    ///< (8)  SEG Direction
#define PX_LCD_CMD_INVERSE_DISPLAY      0xa6    ///< (9)  Display normal/reverse
#define PX_LCD_CMD_ALL_PIXEL_ON         0xa4    ///< (10) Set all pixel ON or normal display
#define PX_LCD_CMD_BIAS_SELECT          0xa2    ///< (11) Select bias setting
#define PX_LCD_CMD_RESET                0xe2    ///< (14) Software reset
#define PX_LCD_CMD_COM_DIRECTION        0xc0    ///< (15) Set output direction of COM
#define PX_LCD_CMD_POWER_CONTROL        0x28    ///< (16) Control built-in power circuit
#define PX_LCD_CMD_REG_RATIO            0x20    ///< (17) Select regulation resistor ratio
#define PX_LCD_CMD_SET_EV               0x81    ///< (18) Set electronic volume (EV) command
#define PX_LCD_CMD_SET_BOOSTER          0xf8    ///< (19) Set booster level command
/// @}
 
#define PX_LCD_ST7567_MAX_NR_OF_COLS    132
#define PX_LCD_ST7567_MAX_NR_OF_ROWS    65
 
/* _____MACROS_______________________________________________________________ */
 
/* _____GLOBAL VARIABLES_____________________________________________________ */
 
/* _____LOCAL VARIABLES______________________________________________________ */
///  SPI handle to communicate with LCD
static px_spi_handle_t * px_lcd_spi_handle;
 
/* _____LOCAL FUNCTION DECLARATIONS__________________________________________ */
 
/* _____LOCAL FUNCTIONS______________________________________________________ */
static void px_lcd_wr_control_data(uint8_t data)
{
    //PX_LOG_INFO("LCD Cmd 0x%02X", data);
    PX_LCD_CFG_RS_LO();
    px_spi_wr(px_lcd_spi_handle, &data, 1, PX_SPI_FLAG_START_AND_STOP);
    PX_LCD_CFG_RS_HI();
}
 
/* _____GLOBAL FUNCTIONS_____________________________________________________ */
void px_lcd_init(px_spi_handle_t * handle)
{
    // Save handle
    px_lcd_spi_handle = handle;
 
    // Perform hardware reset
    px_board_delay_ms(1);
    PX_LCD_CFG_RST_LO();
    px_board_delay_ms(50);
    PX_LCD_CFG_RST_HI();
    px_board_delay_ms(1);
 
    // Select 1/9 bias (1/65 duty)
    px_lcd_wr_control_data(PX_LCD_CMD_BIAS_SELECT | 0);
 
#if !PX_LCD_CFG_ROT_180_DEG
    // Normal SEG output direction
    px_lcd_wr_control_data(PX_LCD_CMD_SEG_DIR | 0);
    // Select normal COM output scan direction
    px_lcd_wr_control_data(PX_LCD_CMD_COM_DIRECTION | 0x00);
#else
    // Reverse SEG output direction, because LCD is rotated by 180 deg
    px_lcd_wr_control_data(PX_LCD_CMD_SEG_DIR | 1);    
#endif
 
    // Select normal COM output scan direction
    px_lcd_wr_control_data(PX_LCD_CMD_COM_DIRECTION | 0x00);
 
    // Set regulation ratio to 5.0 (VO = 9.01)
    px_lcd_wr_control_data(PX_LCD_CMD_REG_RATIO | 0x04);
 
    // Set electronic volume (EV) to 40
    px_lcd_wr_control_data(PX_LCD_CMD_SET_EV);
    px_lcd_wr_control_data(40);
 
    // Enable voltage booster
    px_lcd_wr_control_data(PX_LCD_CMD_POWER_CONTROL | 0x04);
    px_board_delay_ms(84);
    // Enable voltage booster + regulator
    px_lcd_wr_control_data(PX_LCD_CMD_POWER_CONTROL | 0x06);
    px_board_delay_ms(42);
    // Enable voltage booster + regulator + follower
    px_lcd_wr_control_data(PX_LCD_CMD_POWER_CONTROL | 0x07);
    px_board_delay_ms(84);
 
    // Set booster level
    px_lcd_wr_control_data(PX_LCD_CMD_SET_BOOSTER);
    px_lcd_wr_control_data(0xaf);
 
    // Set display line adr to 0
    px_lcd_wr_control_data(PX_LCD_CMD_SET_START_LINE | 0);
    // Set normal display
    px_lcd_wr_control_data(PX_LCD_CMD_ALL_PIXEL_ON | 0);
    // Set reverse display OFF
    px_lcd_wr_control_data(PX_LCD_CMD_INVERSE_DISPLAY | 0);
    // Clear RAM buffer
    px_lcd_clr();
    // Turn the display ON
    px_lcd_wr_control_data(PX_LCD_CMD_DISP_ON_OFF | 1);
}
 
void px_lcd_power_save_on(void)
{
    // Turn the display OFF
    px_lcd_wr_control_data(PX_LCD_CMD_DISP_ON_OFF | 0);
    // Turn all pixels ON
    px_lcd_wr_control_data(PX_LCD_CMD_ALL_PIXEL_ON | 1);
}
 
void px_lcd_power_save_off(void)
{
    // Cancel all pixels ON
    px_lcd_wr_control_data(PX_LCD_CMD_ALL_PIXEL_ON | 0);
    // Turn the display ON
    px_lcd_wr_control_data(PX_LCD_CMD_DISP_ON_OFF | 1);
    
}
 
void px_lcd_clr(void)
{
    uint8_t y;
    uint8_t data[PX_LCD_NR_OF_COLS];
 
    // Set data for whole column to zero
    memset(data, 0, PX_LCD_NR_OF_COLS);
 
    // Repeat for each page
    for(y = 0; y < PX_LCD_NR_OF_PAGES; y++)
    {
        // Select page
        px_lcd_sel_page(y);
        // Start at column 0
        px_lcd_sel_col(0);
        // Clear whole column
        px_lcd_wr_disp_data(data, PX_LCD_NR_OF_COLS);        
    }
}
 
void px_lcd_sel_col(uint8_t col)
{
#if PX_LCD_CFG_ROT_180_DEG
    col = (PX_LCD_ST7567_MAX_NR_OF_COLS - PX_LCD_NR_OF_COLS) + col;
#endif
 
    // Column most significant nibble
    px_lcd_wr_control_data(PX_LCD_CMD_SET_COL_ADR_HI | ((col & 0xf0) >> 4));
    // Column least significant nibble
    px_lcd_wr_control_data(PX_LCD_CMD_SET_COL_ADR_LO | (col & 0x0f));
}
 
void px_lcd_sel_page(uint8_t page)
{
#if !PX_LCD_CFG_ROT_180_DEG
    page = (PX_LCD_NR_OF_PAGES - 1) - page;
#endif
 
    px_lcd_wr_control_data(PX_LCD_CMD_SET_PAGE_ADR | page);
}
 
void px_lcd_wr_disp_u8(uint8_t data)
{
    px_spi_wr(px_lcd_spi_handle, &data, 1, PX_SPI_FLAG_START_AND_STOP);
}
 
void px_lcd_wr_disp_data(uint8_t * data, size_t nr_of_bytes)
{
    px_spi_wr(px_lcd_spi_handle, data, nr_of_bytes, PX_SPI_FLAG_START_AND_STOP);
}