lcdmono.h

Go to the documentation of this file.

/*
 * MikroSDK - MikroE Software Development Kit
 * Copyright© 2020 MikroElektronika d.o.o.
 *
 * 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 LCDMONO_H
#define LCDMONO_H
 
#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_spi_master.h"
#include "generic_pointer.h"
 
// -------------------------------------------------------------- PUBLIC MACROS
#define LCDMONO_MAP_MIKROBUS( cfg, mikrobus ) \
   cfg.miso  = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
   cfg.mosi  = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
   cfg.sck   = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
   cfg.cs    = MIKROBUS( mikrobus, MIKROBUS_CS ); \
   cfg.com   = MIKROBUS( mikrobus, MIKROBUS_PWM )
#define LCDMONO_OK                      0
#define LCDMONO_ERROR                  -1
#define LCDMONO_DISPLAY_WIDTH           128
#define LCDMONO_DISPLAY_HEIGHT          128
#define LCDMONO_DISPLAY_RESOLUTIONS     2307
#define LCDMONO_COLOR_WHITE             0x00
#define LCDMONO_COLOR_BLACK             0x01
#define LCDMONO_REFRESH_DISPLAY_END     0x01
#define LCDMONO_CHECK_NEW_TEXT          0x00
#define LCDMONO_REFRESH_TEXT_BUFFER     0x10
#define LCDMONO_CMD_DISPLAY_FLAG        0x80
#define LCDMONO_CMD_CLEAR_FLAG          0x20
#define LCDMONO_DUMMY_BYTE              0x00
#define LCDMONO_POWER_ON                1
#define LCDMONO_POWER_OFF               0
 // End group macro
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
    uint8_t * __generic_ptr this_font;
    uint16_t first_char;
    uint16_t last_char;
    uint16_t height;
 
} lcdmono_font_t;
 
typedef struct
{
    uint16_t x;
    uint16_t y;
 
} lcdmono_coordinate_t;
 
typedef struct
{
    // Draw Text
    uint8_t len;             // Number of characters in the text
    uint16_t start_cord_x;   // X position of the text
    uint16_t start_cord_y;   // Y position of the text
    uint8_t bg_color;        // Background color
 
} lcdmono_text_settings_t;
 
typedef struct
{
    // Output pins
    digital_out_t com;
 
    // Modules
    spi_master_t spi;
    pin_name_t chip_select;
 
    uint8_t lcd_frame[ 2307 ];
    uint8_t lcd_frame_color;
 
    lcdmono_font_t lcd_font;
    lcdmono_coordinate_t lcd_cord;
    lcdmono_text_settings_t tx_set;
 
} lcdmono_t;
 
typedef struct
{
    // Communication gpio pins
    pin_name_t miso;
    pin_name_t mosi;
    pin_name_t sck;
    pin_name_t cs;
 
    // Additional gpio pins
    pin_name_t com;
 
    // Static variable
    uint32_t spi_speed;
    spi_master_mode_t spi_mode;
    spi_master_chip_select_polarity_t cs_polarity;
 
    uint8_t dev_lcd_frame_color;
 
} lcdmono_cfg_t;
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
#ifdef __cplusplus
extern "C"{
#endif
 
void lcdmono_cfg_setup ( lcdmono_cfg_t *cfg );
 
err_t lcdmono_init ( lcdmono_t *ctx, lcdmono_cfg_t *cfg );
 
void lcdmono_send_line_package ( lcdmono_t *ctx, uint8_t addr, uint8_t * __generic_ptr tx_data );
 
void lcdmono_clear ( lcdmono_t *ctx );
 
void lcdmono_draw_frame ( lcdmono_t *ctx, uint8_t * __generic_ptr frame_data );
 
void lcdmono_draw_text ( lcdmono_t *ctx, uint8_t * __generic_ptr text_buf, lcdmono_text_settings_t *tx_set, uint8_t end_mode );
 
void lcdmono_set_font ( lcdmono_t *ctx, lcdmono_font_t *dev_lcd_font );
 
void lcdmono_display_power ( lcdmono_t *ctx, uint8_t ctrl );
 
void lcdmono_display_reset ( lcdmono_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif  // LCDMONO_H
 
 // End public_function group
 
// ------------------------------------------------------------------------ END