dm_hd44780.h

Go to the documentation of this file.

// ---------------------------------------------------------------------------+
//                  This file is part of SLS LCD Library
// ---------------------------------------------------------------------------+
// Copyright (C) 2025 Simon Litt <simon@1itt.net> https://coding.1itt.net,
//                                                https://github.com/SimonLitt
//
// This program is free software: you can redistribute it and/or modify it
// under the terms of the GNU General Public License as published by the Free
// Software Foundation, version 3.
//
// This program is distributed in the hope that it will be useful, but WITHOUT
// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
// FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
// more details.
//
// You should have received a copy of the GNU General Public License along
// with this program. If not, see <https://www.gnu.org/licenses/>.
// ---------------------------------------------------------------------------+
#ifndef SLS_LCD_DM_HD44780_H_
#define SLS_LCD_DM_HD44780_H_
 
#ifdef SLS_AVR_AVR_H_
#   if !(defined SLS_AVR_LCD_HD44780_PIN_H_)
#       error "Include <sls-avr/lcd_hd44780_pin.h> instead of this file!"
        //TODO i2c support "Include <sls-avr/lcd_hd44780_pin.h> or <sls-avr/lcd_hd44780_i2c.h> instead of this file!"
#   endif
#else
#  error "First, enable the target microcontroller header!"
#endif
 
// ---------------------------------------------------------------------------+
// Delays. Default from HD44780 and analogs datasheets. Universal settings.
// ---------------------------------------------------------------------------+
 
#ifndef HD44780_WAIT_INIT_MS
#   define HD44780_WAIT_INIT_MS         18 
#endif
 
#ifndef HD44780_EXEC_TIME_US
#   define HD44780_EXEC_TIME_US         50 
#endif
 
#ifndef HD44780_LONG_EXEC_TIME_US
#   define HD44780_LONG_EXEC_TIME_US    1760 
#endif
 
#ifndef HD44780_ENABLE_PULSE_US         // 1.5/250000 = 0.6 us
#   define HD44780_ENABLE_PULSE_US      0.8 
#endif
 
#ifndef HD44780_WAIT_BF_LOOP_US
#   define HD44780_WAIT_BF_LOOP_US      0 
#endif
 
#ifndef HD44780_INIT_1_MS
#   define HD44780_INIT_1_MS            5 
#endif
 
#ifndef HD44780_INIT_2_US
#   define HD44780_INIT_2_US            120 
#endif
 
#ifndef HD44780_INIT_3_US
#   define HD44780_INIT_3_US            50 
#endif
 
#ifndef HD44780_INIT_4_4_US
#   define HD44780_INIT_4_4_US          50 
#endif
 
#ifndef HD44780_INIT_OTHER_ADD_US
#   define HD44780_INIT_OTHER_ADD_US    10 
#endif
 
// ---------------------------------------------------------------------------+
// Init commands
// ---------------------------------------------------------------------------+
#define _HD44780_INIT_8_1_CMD           0b00110000
#define _HD44780_INIT_8_2_CMD           0b00110000
#define _HD44780_INIT_8_3_CMD           0b00110000
 
#define _HD44780_INIT_4_1_CMD           0b00000011
#define _HD44780_INIT_4_2_CMD           0b00000011
#define _HD44780_INIT_4_3_CMD           0b00000011
#define _HD44780_INIT_4_4_CMD           0b00000010
 
// ---------------------------------------------------------------------------+
// Clear display instruction
// ---------------------------------------------------------------------------+
#define _HD44780_CLEAR                  0b00000001
 
// ---------------------------------------------------------------------------+
// Return home instruction
// ---------------------------------------------------------------------------+
#define _HD44780_HOME                   0b00000010
#define _HD44780_HOME_MASK              0b00000001
 
#define __HD44780_UNUSED_HOME_0_BIT     0 // Used by some compatible controllers
#define _HD44780_UNUSED_HOME_0_OFF      0x00
#define _HD44780_UNUSED_HOME_0_ON       (_BV(__HD44780_UNUSED_HOME_0_BIT))
 
// ---------------------------------------------------------------------------+
// Entry mode
// ---------------------------------------------------------------------------+
#define _HD44780_ENTRY                  0b00000100
#define _HD44780_ENTRY_MASK             0b00000011
 
#define HD44780_S_BIT                   0
#define HD44780_ID_BIT                  1
 
#define HD44780_S_OFF                   0x00 
#define HD44780_S_ON                    (_BV(HD44780_S_BIT)) 
 
#define HD44780_ID_DEC                  0x00 
#define HD44780_ID_INC                  (_BV(HD44780_ID_BIT)) 
 
// ---------------------------------------------------------------------------+
// Display on/off instruction
// ---------------------------------------------------------------------------+
#define _HD44780_DISPLAY                0b00001000
#define _HD44780_DISPLAY_MASK           0b00000111
 
#define __HD44780_B_BIT                 0
#define __HD44780_C_BIT                 1
#define __HD44780_D_BIT                 2
 
#define HD44780_B_OFF                   0x00 
#define HD44780_B_ON                    (_BV(__HD44780_B_BIT)) 
 
#define HD44780_C_OFF                   0x00 
#define HD44780_C_ON                    (_BV(__HD44780_C_BIT)) 
 
#define HD44780_D_OFF                   0x00 
#define HD44780_D_ON                    (_BV(__HD44780_D_BIT)) 
 
// ---------------------------------------------------------------------------+
// Cursor / shift
// ---------------------------------------------------------------------------+
#define _HD44780_CURSOR                 0b00010000
#define _HD44780_CURSOR_MASK            0b00001111
 
#define __HD44780_UNUSED_CURSOR_0_BIT   0 // Used by some compatible controllers
#define __HD44780_UNUSED_CURSOR_1_BIT   1 // Used by some compatible controllers
#define __HD44780_RL_BIT                2
#define __HD44780_SCN_BIT               3
 
#define _HD44780_UNUSED_CURSOR_0_OFF    0x00
#define _HD44780_UNUSED_CURSOR_0_ON     (_BV(__HD44780_UNUSED_CURSOR_0_BIT))
 
#define _HD44780_UNUSED_CURSOR_1_OFF    0x00
#define _HD44780_UNUSED_CURSOR_1_ON     (_BV(__HD44780_UNUSED_CURSOR_1_BIT))
 
#define HD44780_RL_LEFT                 0x00 
#define HD44780_RL_RIGHT                (_BV(__HD44780_RL_BIT)) 
 
#define HD44780_SCN_CURS                0x00 
#define HD44780_SCN_DISP                (_BV(__HD44780_SCN_BIT)) 
 
// ---------------------------------------------------------------------------+
// Function set instruction
// ---------------------------------------------------------------------------+
#define _HD44780_FUNC                   0b00100000
#define _HD44780_FUNC_MASK              0b00011111
 
#define __HD44780_UNUSED_FUNC_0_BIT     0 // Used by some compatible controllers
#define __HD44780_UNUSED_FUNC_1_BIT     1 // Used by some compatible controllers
#define __HD44780_F_BIT                 2
#define __HD44780_N_BIT                 3
#define __HD44780_DL_BIT                4
 
#define _HD44780_UNUSED_FUNC_0_OFF      0x00
#define _HD44780_UNUSED_FUNC_0_ON       (_BV(__HD44780_UNUSED_FUNC_0_BIT))
 
#define _HD44780_UNUSED_FUNC_1_OFF      0x00
#define _HD44780_UNUSED_FUNC_1_ON       (_BV(__HD44780_UNUSED_FUNC_1_BIT))
 
#define HD44780_F_NORMAL                0x00 
#define HD44780_F_BIG                   (_BV(__HD44780_F_BIT)) 
 
#define HD44780_N_1L                    0x00 
#define HD44780_N_2L                    (_BV(__HD44780_N_BIT)) 
 
#define HD44780_DL_4BIT                 0x00 
#define HD44780_DL_8BIT                 (_BV(__HD44780_DL_BIT)) 
 
 
// ---------------------------------------------------------------------------+
// CGRAM Address Set
// ---------------------------------------------------------------------------+
#define _HD44780_CGRAM                  0b01000000
#define _HD44780_CGRAM_MASK             0b00111111
 
// ---------------------------------------------------------------------------+
// Set DDRAM Address Set
// ---------------------------------------------------------------------------+
#define _HD44780_DDRAM                  0b10000000
#define _HD44780_DDRAM_MASK             0b01111111

#define __HD44780_ROW_1_DDRAM_ADR       0x00
#define __HD44780_ROW_2_DDRAM_ADR       0x40
#define __HD44780_ROW_3_DDRAM_ADR       0x10
#define __HD44780_ROW_4_DDRAM_ADR       0x50
 
#define __HD44780_ROW_3_20x4_DDRAM_ADR  0x14
#define __HD44780_ROW_4_20x4_DDRAM_ADR  0x54
#   ifndef HD44780_ROW_1_DDRAM_ADR
#       define HD44780_ROW_1_DDRAM_ADR __HD44780_ROW_1_DDRAM_ADR 
#   endif
#   ifndef HD44780_ROW_2_DDRAM_ADR
#       define HD44780_ROW_2_DDRAM_ADR __HD44780_ROW_2_DDRAM_ADR 
#   endif
#   ifndef HD44780_ROW_3_DDRAM_ADR
#       define HD44780_ROW_3_DDRAM_ADR __HD44780_ROW_3_DDRAM_ADR 
#   endif
#   ifndef HD44780_ROW_4_DDRAM_ADR
#       define HD44780_ROW_4_DDRAM_ADR __HD44780_ROW_4_DDRAM_ADR 
#   endif
 
#   ifndef HD44780_ROW_3_20x4_DDRAM_ADR
#       define HD44780_ROW_3_20x4_DDRAM_ADR __HD44780_ROW_3_20x4_DDRAM_ADR 
#   endif
#   ifndef HD44780_ROW_4_20x4_DDRAM_ADR
#       define HD44780_ROW_4_20x4_DDRAM_ADR __HD44780_ROW_4_20x4_DDRAM_ADR 
#   endif
 
// ---------------------------------------------------------------------------+
// Busy Flag / Address Read
// ---------------------------------------------------------------------------+
#define __HD44780_BF_BIT                7
#define _HD44780_ADDR_MASK              0b01111111

 
// ---------------------------------------------------------------------------+
#define HD44780_CUSTOM_CHAR_0           0 
#define HD44780_CUSTOM_CHAR_1           1 
#define HD44780_CUSTOM_CHAR_2           2 
#define HD44780_CUSTOM_CHAR_3           3 
#define HD44780_CUSTOM_CHAR_4           4 
#define HD44780_CUSTOM_CHAR_5           5 
#define HD44780_CUSTOM_CHAR_6           6 
#define HD44780_CUSTOM_CHAR_7           7 
 
// ---------------------------------------------------------------------------+
typedef enum {
    LCD_ROW_1 = 0, 
    LCD_ROW_2,     
    LCD_ROW_3,     
    LCD_ROW_4,     
} lcd_line_t;
 
#define HD44780_DISPLAY_8X1             1 
#define HD44780_DISPLAY_16X1            2 
 
#define HD44780_DISPLAY_16X2            12 
#define HD44780_DISPLAY_20X2            13 
#define HD44780_DISPLAY_32X2            14 
#define HD44780_DISPLAY_40X2            15 
 
#define HD44780_DISPLAY_16X4            22 
#define HD44780_DISPLAY_20X4            23 
#define HD44780_DISPLAY_40X4            25 

typedef enum {
    LCD_8X1      = HD44780_DISPLAY_8X1,  
    LCD_16X1    = HD44780_DISPLAY_16X1, 
    LCD_16X2    = HD44780_DISPLAY_16X2, 
    LCD_20X2    = HD44780_DISPLAY_20X2, 
    LCD_32X2    = HD44780_DISPLAY_32X2, 
    LCD_40X2    = HD44780_DISPLAY_40X2, 
    LCD_16X4    = HD44780_DISPLAY_16X4, 
    LCD_20X4    = HD44780_DISPLAY_20X4, 
    //LCD_40X4  = HD44780_DISPLAY_40X4, /**< \brief Resolution 40х4 characters */
} lcd_display_t;
 
#endif // SLS_LCD_DM_HD44780_H_