lcd_low.h

Go to the documentation of this file.

/*
 * MIT License
 *
 * Copyright (c) 2022 Damian Ślusarczyk
 *
 * 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_LOW_H
#define LCD_LOW_H
 
#include <stdbool.h>
#include <stdint.h>
#include <stddef.h>
 
#include "lcd_error_codes.h"
#include "lcd_image.h"
#include "lcd_font.h"
 
typedef struct LCD_com_t            LCD_com_t;
typedef struct LCD_controller_t     LCD_controller_t;
typedef struct LCD_t                LCD_t;
 
typedef struct LCD_com_t *          LCD_com_handle_t;
typedef struct LCD_controller_t *   LCD_controller_handle_t;
typedef struct LCD_t *              LCD_handle_t;
 
struct LCD_com_t
{
    bool (*write_cmd)(LCD_handle_t base, const uint8_t cmd);
    bool (*write_single_bytes)(LCD_handle_t base, const uint8_t *data, const size_t dataSize);
    bool (*write_two_bytes)(LCD_handle_t base, const uint16_t data);
};
 
struct LCD_controller_t
{
    LCD_error_t (*Init)(LCD_handle_t base);
    LCD_error_t (*DisplayOn)(LCD_handle_t base);
    LCD_error_t (*DisplayOff)(LCD_handle_t base);
    LCD_error_t (*DrawRect)(LCD_handle_t base, const uint16_t x, const uint16_t y, const uint16_t width, 
        const uint16_t height, const uint16_t color);
    LCD_error_t (*DrawImage)(LCD_handle_t base, const uint16_t x, const uint16_t y, const LCD_image_t *image);
    LCD_error_t (*DrawText)(LCD_handle_t base, uint16_t x, uint16_t y, const char *text, 
        const int16_t letterSpacing, const int16_t lineSpacing, const LCD_font_t *font, 
        const uint16_t fontColor, const uint16_t bgrColor);
    LCD_error_t (*ClearScreen)(LCD_handle_t base, const uint16_t color);
    LCD_error_t (*Destroy)(LCD_handle_t base);
};
 
struct LCD_t
{
    uint16_t                    width;          
    uint16_t                    height;         
    bool                        displayState;   
    LCD_com_handle_t            com;            
    LCD_controller_handle_t     controller;     
};
 
#endif /* LCD_LOW_H */