lcd.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2018 Koen Zandberg
 * SPDX-FileCopyrightText: 2021 Francisco Molina
 * SPDX-FileCopyrightText: 2023 Gunar Schorcht
 * SPDX-License-Identifier: LGPL-2.1-only
 */
 
#pragma once

 
#include "board.h"
#include "mutex.h"
#include "periph/spi.h"
#include "periph/gpio.h"
 
#ifdef MODULE_DISP_DEV
#include "disp_dev.h"
#endif
 
#ifdef __cplusplus
extern "C" {
#endif

#ifdef DOXYGEN
#define CONFIG_LCD_LE_MODE
#endif

#define LCD_MADCTL_MY           0x80    
#define LCD_MADCTL_MX           0x40    
#define LCD_MADCTL_MV           0x20    
#define LCD_MADCTL_ML           0x10    
#define LCD_MADCTL_BGR          0x08    
#define LCD_MADCTL_MH           0x04    
 
#if MODULE_LCD_PARALLEL || DOXYGEN
typedef enum {
    LCD_IF_SPI,             
    LCD_IF_PARALLEL_8BIT,   
    LCD_IF_PARALLEL_16BIT,  
} lcd_if_mode_t;
#endif

typedef  struct {
#if MODULE_LCD_SPI || DOXYGEN
    /* Interface parameters used for serial interface */
    spi_t spi;                  
    spi_clk_t spi_clk;          
    spi_mode_t spi_mode;        
#endif
#if MODULE_LCD_PARALLEL || DOXYGEN
    lcd_if_mode_t mode;         
    /* Interface parameters used for MCU 8080 8-bit parallel interface */
    gpio_t wrx_pin;             
    gpio_t rdx_pin;             
    gpio_t d0_pin;              
    gpio_t d1_pin;              
    gpio_t d2_pin;              
    gpio_t d3_pin;              
    gpio_t d4_pin;              
    gpio_t d5_pin;              
    gpio_t d6_pin;              
    gpio_t d7_pin;              
#if MODULE_LCD_PARALLEL_16BIT || DOXYGEN
    /* Interface parameters used for MCU 8080 16-bit parallel interface */
    gpio_t d8_pin;              
    gpio_t d9_pin;              
    gpio_t d10_pin;             
    gpio_t d11_pin;             
    gpio_t d12_pin;             
    gpio_t d13_pin;             
    gpio_t d14_pin;             
    gpio_t d15_pin;             
#endif /* MODULE_LCD_PARALLEL_16BIT */
#endif /* MODULE_LCD_PARALLEL */
    /* Common interface parameters */
    gpio_t cs_pin;              
    gpio_t dcx_pin;             
    gpio_t rst_pin;             
    bool rgb;                   
    bool inverted;              
    uint16_t lines;             
    uint16_t rgb_channels;      
    uint8_t rotation;           
    uint8_t offset_x;           
    uint8_t offset_y;           
#if MODULE_LCD_MULTI_CNTRL || DOXYGEN
    uint8_t cntrl;              
#endif
} lcd_params_t;

typedef struct lcd_driver lcd_driver_t;

typedef struct {
#if MODULE_DISP_DEV || DOXYGEN
    disp_dev_t *dev;                
#endif
    const lcd_driver_t *driver;     
    const lcd_params_t *params;     
#if MODULE_LCD_PARALLEL || DOXYGEN
    mutex_t lock;                   
#endif
#if MODULE_LCD_PARALLEL_16BIT || DOXYGEN
    bool word_access;               
#endif
} lcd_t;

struct lcd_driver {
    int (*init)(lcd_t *dev, const lcd_params_t *params);

    void (*set_area)(lcd_t *dev, uint16_t x1, uint16_t x2, uint16_t y1,
                     uint16_t y2);
};

void lcd_ll_acquire(lcd_t *dev);

void lcd_ll_release(lcd_t *dev);

void lcd_ll_write_cmd(lcd_t *dev, uint8_t cmd, const uint8_t *data,
                      size_t len);

void lcd_ll_read_cmd(lcd_t *dev, uint8_t cmd, uint8_t *data, size_t len);

void lcd_ll_set_area(lcd_t *dev, uint16_t x1, uint16_t x2, uint16_t y1, uint16_t y2);

int lcd_init(lcd_t *dev, const lcd_params_t *params);

void lcd_fill(lcd_t *dev, uint16_t x1, uint16_t x2,
              uint16_t y1, uint16_t y2, uint16_t color);

void lcd_pixmap(lcd_t *dev, uint16_t x1, uint16_t x2, uint16_t y1,
                uint16_t y2, const uint16_t *color);

void lcd_write_cmd(lcd_t *dev, uint8_t cmd, const uint8_t *data,
                   size_t len);

void lcd_read_cmd(lcd_t *dev, uint8_t cmd, uint8_t *data, size_t len);

void lcd_invert_on(lcd_t *dev);

void lcd_invert_off(lcd_t *dev);
 
#if MODULE_LCD_PARALLEL || DOXYGEN

typedef struct {
    void (*init)(lcd_t *dev);

    void (*set_data_dir)(lcd_t *dev, bool output);

    void (*cmd_start)(lcd_t *dev, uint8_t cmd, bool cont);

    void (*write_byte)(lcd_t *dev, bool cont, uint8_t out);

    uint8_t (*read_byte)(lcd_t *dev, bool cont);
 
#if MODULE_LCD_PARALLEL_16BIT || DOXYGEN
    void (*write_word)(lcd_t *dev, bool cont, uint16_t out);

    uint16_t (*read_word)(lcd_t *dev, bool cont);
#endif
} lcd_ll_par_driver_t;

extern const lcd_ll_par_driver_t lcd_ll_par_driver;

#endif
 
#ifdef __cplusplus
}
#endif