lcd_common.h

Go to the documentation of this file.

/*
    MIT License

    Copyright (c) 2017-2019, Alexey Dynda

    Permission is hereby granted, free of charge, to any person obtaining a copy
    of this software and associated documentation files (the "Software"), to deal
    in the Software without restriction, including without limitation the rights
    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
    copies of the Software, and to permit persons to whom the Software is
    furnished to do so, subject to the following conditions:

    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, EXPRESS OR
    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    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_COMMON_H_
#define _LCD_COMMON_H_

#include "ssd1306_hal/io.h"

#ifdef __cplusplus
extern "C" {
#endif

typedef enum
{
    LCD_TYPE_SSD1306,
    LCD_TYPE_PCD8544,
    LCD_TYPE_SH1106,
    LCD_TYPE_SSD1331,
    LCD_TYPE_CUSTOM,
} lcd_type_t;

typedef enum
{
    LCD_MODE_NORMAL = 0,

    LCD_MODE_SSD1306_COMPAT = 1,
} lcd_mode_t;

typedef struct
{
    lcd_type_t type;

    lcduint_t  width;

    lcduint_t  height;

    void (*set_block)(lcduint_t x, lcduint_t y, lcduint_t w);

    void (*next_page)(void);

    void (*send_pixels1)(uint8_t data);

    void (*send_pixels_buffer1)(const uint8_t *buffer, uint16_t len);

    void (*send_pixels8)(uint8_t data);

    void (*send_pixels16)(uint16_t data);

    void (*set_mode)(lcd_mode_t mode);
} ssd1306_lcd_t;

extern ssd1306_lcd_t ssd1306_lcd;

#define s_displayHeight   ssd1306_lcd.height

#define s_displayWidth    ssd1306_lcd.width

#define g_lcd_type  ssd1306_lcd.type

void         ssd1306_sendData(uint8_t data) __attribute__ ((deprecated));

#define ssd1306_setRamBlock   ssd1306_lcd.set_block

#define ssd1306_nextRamPage   ssd1306_lcd.next_page

#define ssd1306_sendPixels    ssd1306_lcd.send_pixels1

#define ssd1306_sendPixelsBuffer  ssd1306_lcd.send_pixels_buffer1

#define ssd1306_sendPixel8        ssd1306_lcd.send_pixels8

void ssd1306_configureI2cDisplay(const uint8_t *config, uint8_t configSize);

void ssd1306_configureSpiDisplay(const uint8_t *config, uint8_t configSize);

void ssd1306_configureSpiDisplay2(const uint8_t *config, uint8_t configSize);

void ssd1306_setMode(lcd_mode_t mode);

void ssd1306_resetController(int8_t rstPin, uint8_t delayMs);

#define SSD1306_COMPAT_SPI_BLOCK_8BIT_CMDS(column_cmd, row_cmd) \
    static uint8_t __s_column; \
    static uint8_t __s_page; \
    static void set_block_compat(lcduint_t x, lcduint_t y, lcduint_t w) \
    { \
        uint8_t rx = w ? (x + w - 1) : (ssd1306_lcd.width - 1); \
        __s_column = x; \
        __s_page = y; \
        ssd1306_intf.start(); \
        ssd1306_spiDataMode(0); \
        ssd1306_intf.send(column_cmd); \
        ssd1306_intf.send(x); \
        ssd1306_intf.send(rx < ssd1306_lcd.width ? rx : (ssd1306_lcd.width - 1)); \
        ssd1306_intf.send(row_cmd); \
        ssd1306_intf.send(y<<3); \
        ssd1306_intf.send(((y<<3) + 7) < ssd1306_lcd.height ? ((y<<3) + 7) : (ssd1306_lcd.height - 1)); \
        ssd1306_spiDataMode(1); \
    } \
    static void next_page_compat(void) \
    { \
        ssd1306_intf.stop(); \
        set_block_compat(__s_column,__s_page+1,0); \
    } \


#define CONTROLLER_NATIVE_SPI_BLOCK_8BIT_CMDS(column_cmd, row_cmd) \
    static void set_block_native(lcduint_t x, lcduint_t y, lcduint_t w) \
    { \
        uint8_t rx = w ? (x + w - 1) : (ssd1306_lcd.width - 1); \
        ssd1306_intf.start(); \
        ssd1306_spiDataMode(0); \
        ssd1306_intf.send(column_cmd); \
        ssd1306_intf.send(x); \
        ssd1306_intf.send(rx < ssd1306_lcd.width ? rx : (ssd1306_lcd.width - 1)); \
        ssd1306_intf.send(row_cmd); \
        ssd1306_intf.send(y); \
        ssd1306_intf.send(ssd1306_lcd.height - 1); \
        ssd1306_spiDataMode(1); \
    } \
    static void next_page_native(void) \
    { \
    } \


#define SSD1306_COMPAT_SEND_PIXELS_RGB8_CMDS() \
    extern uint16_t ssd1306_color; \
    static void send_pixels_compat(uint8_t data) \
    { \
        for (uint8_t i=8; i>0; i--) \
        { \
            if ( data & 0x01 ) \
            { \
                ssd1306_intf.send( (uint8_t)ssd1306_color ); \
            } \
            else \
            { \
                ssd1306_intf.send( 0B00000000 ); \
            } \
            data >>= 1; \
        } \
    } \
    static void send_pixels_buffer_compat(const uint8_t *buffer, uint16_t len) \
    { \
        while(len--) \
        { \
            send_pixels_compat(*buffer); \
            buffer++; \
        } \
    }

#define SSD1306_COMPAT_SEND_PIXELS_RGB16_CMDS() \
    extern uint16_t ssd1306_color; \
    static void send_pixels_compat16(uint8_t data) \
    { \
        for (uint8_t i=8; i>0; i--) \
        { \
            if ( data & 0x01 ) \
            { \
                ssd1306_intf.send( (uint8_t)(ssd1306_color >> 8 ) ); \
                ssd1306_intf.send( (uint8_t)(ssd1306_color & 0xFF) ); \
            } \
            else \
            { \
                ssd1306_intf.send( 0B00000000 ); \
                ssd1306_intf.send( 0B00000000 ); \
            } \
            data >>= 1; \
        } \
    } \
    static void send_pixels_buffer_compat16(const uint8_t *buffer, uint16_t len) \
    { \
        while(len--) \
        { \
            send_pixels_compat16(*buffer); \
            buffer++; \
        } \
    }


#ifdef __cplusplus
}
#endif

#endif /* _LCD_COMMON_H_ */