lcd.h

Go to the documentation of this file.

/****************************************************************************
**
** Copyright (C) 2024 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** This file is part of the mikroSDK package
**
** Commercial License Usage
**
** Licensees holding valid commercial NECTO compilers AI licenses may use this
** file in accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The MikroElektronika Company.
** For licensing terms and conditions see
** https://www.mikroe.com/legal/software-license-agreement.
** For further information use the contact form at
** https://www.mikroe.com/contact.
**
**
** GNU Lesser General Public License Usage
**
** Alternatively, this file may be used for
** non-commercial projects under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** OF MERCHANTABILITY, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
** TO THE WARRANTIES FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE
** OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
**
****************************************************************************/
#ifndef _LCD_H_
#define _LCD_H_
 
#ifdef __cplusplus
extern "C"{
#endif
 
#include "lcd_controllers.h"
 
#define LCD_CMD_FUNCTION_SET        ((uint8_t)0x20)
#define LCD_CMD_CLEAR               ((uint8_t)0x1)
#define LCD_CMD_RETURN_HOME         ((uint8_t)0x2)
#define LCD_CMD_CURSOR_OFF          ((uint8_t)0xC)
#define LCD_CMD_UNDERLINE_ON        ((uint8_t)0xE)
#define LCD_CMD_BLINK_CURSOR_ON     ((uint8_t)0xF)
#define LCD_CMD_MOVE_CURSOR_LEFT    ((uint8_t)0x10)
#define LCD_CMD_MOVE_CURSOR_RIGHT   ((uint8_t)0x14)
#define LCD_CMD_TURN_OFF            ((uint8_t)0x8)
#define LCD_CMD_TURN_ON             ((uint8_t)0xC)
#define LCD_CMD_SHIFT_LEFT          ((uint8_t)0x18)
#define LCD_CMD_SHIFT_RIGHT         ((uint8_t)0x1C)
#define LCD_CMD_MODE_4BIT           ((uint8_t)0x08)
 // lcdcommands
 
#define LCD_MAP_PINS(lcd_cfg) LCD_MAP_PINS_4BIT(lcd_cfg)
 
#define LCD_MAP_PINS_4BIT(lcd_cfg) \
        lcd_cfg.pin_cs = TFT_CS; \
        lcd_cfg.pin_rst = TFT_RST; \
        lcd_cfg.pin_backlight = TFT_BPWM; \
        lcd_cfg.pin_d4 = TFT_D4; \
        lcd_cfg.pin_d5 = TFT_D5; \
        lcd_cfg.pin_d6 = TFT_D6; \
        lcd_cfg.pin_d7 = TFT_D7;
 
#define LCD_MAP_PINS_8BIT(lcd_cfg) \
        lcd_cfg.pin_cs = TFT_CS; \
        lcd_cfg.pin_rst = TFT_RST; \
        lcd_cfg.pin_backlight = TFT_BPWM; \
        lcd_cfg.pin_d0 = TFT_D0; \
        lcd_cfg.pin_d1 = TFT_D1; \
        lcd_cfg.pin_d2 = TFT_D2; \
        lcd_cfg.pin_d3 = TFT_D3; \
        lcd_cfg.pin_d4 = TFT_D4; \
        lcd_cfg.pin_d5 = TFT_D5; \
        lcd_cfg.pin_d6 = TFT_D6; \
        lcd_cfg.pin_d7 = TFT_D7;
 
typedef enum
{
    LCD_SUCCESS = 0,            
    LCD_ERROR = (-1)            
} lcd_err_t;
 
typedef enum
{
    LCD_SELECT_CMD = 0,         
    LCD_SELECT_DATA             
} lcd_select_t;
 
typedef enum
{
    LCD_MODE_BIT_4 = 0,         
    LCD_MODE_BIT_8              
} lcd_mode_t;
 
typedef enum
{
    LCD_ROW_1 = 0x80,           
    LCD_ROW_2 = 0xC0,           
    LCD_ROW_3 = 0x94,           
    LCD_ROW_4 = 0xD4            
} lcd_row_t;
 
typedef struct lcd_config
{
    pin_name_t pin_cs;          
    pin_name_t pin_rst;         
    pin_name_t pin_backlight;   
    pin_name_t pin_d0;          
    pin_name_t pin_d1;          
    pin_name_t pin_d2;          
    pin_name_t pin_d3;          
    pin_name_t pin_d4;          
    pin_name_t pin_d5;          
    pin_name_t pin_d6;          
    pin_name_t pin_d7;          
    lcd_mode_t mode;            
    uint16_t waitBetweenWrites; 
} lcd_config_t;
 
typedef void (*init_sequence_ptr)(uint32_t);
 
typedef struct lcd_handle
{
    lcd_config_t config;              
    digital_out_t cs_pin;             
    digital_out_t rst_pin;            
    digital_out_t backlight_pin;      
    digital_out_t data_pins[8];       
    init_sequence_ptr init_sequence;  
    bool init_state;
} lcd_handle_t;
 
void lcd_configure_default( lcd_config_t *config );
 
lcd_err_t lcd_configure( lcd_handle_t *lcd_handle, lcd_config_t *config );
 
void lcd_init( lcd_handle_t lcd_handle, init_sequence_ptr init_sequence );
 
void lcd_write( lcd_handle_t lcd_handle, char lcd_cmd_data, lcd_select_t cmd_or_data );
 
void lcd_write_text( lcd_handle_t lcd_handle, char *lcd_data, lcd_row_t row );
 
void lcd_shift_right( lcd_handle_t lcd_handle );
 
void lcd_shift_left( lcd_handle_t lcd_handle );
 
void lcd_set_row( lcd_handle_t lcd_handle, lcd_row_t row );
 
void lcd_turn_on( lcd_handle_t lcd_handle );
 
void lcd_turn_off( lcd_handle_t lcd_handle );
 
void lcd_clear( lcd_handle_t lcd_handle );
 
void lcd_cursor_move_home( lcd_handle_t lcd_handle );
 
void lcd_cursor_move_left( lcd_handle_t lcd_handle );
 
void lcd_cursor_move_right( lcd_handle_t lcd_handle );
 
void lcd_cursor_off( lcd_handle_t lcd_handle );
 
void lcd_cursor_on( lcd_handle_t lcd_handle );
 
void lcd_backlight_off( lcd_handle_t lcd_handle );
 
void lcd_backlight_on( lcd_handle_t lcd_handle );
 
 // middlewaregroup
 // lcd
 
#ifdef __cplusplus
}
#endif
 
#endif // _LCD_H_
 
// ------------------------------------------------------------------------ END