lcdmini.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2020 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** 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 LCDMINI_H
#define LCDMINI_H
 
#ifdef __cplusplus
extern "C"{
#endif
 
#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_spi_master.h"
#include "spi_specifics.h"
#include "drv_pwm.h"
 
#define LCDMINI_IODIRB_BANK0                    0x01
#define LCDMINI_OLATB_BANK0                     0x15
#define LCDMINI_IOCON_BANK0                     0x0A
#define LCDMINI_ADDRESS_CODE                    0x40
#define LCDMINI_GPIO_REGISTER                   0x09
 
 // lcdmini_reg
 
#define LCDMINI_ENABLE                          0x08
#define LCDMINI_RESET                           0x04
 
#define LCDMINI_OP_CODE_READ                    0x01
#define LCDMINI_OP_CODE_WRITE                   0xFE
 
#define LCDMINI_CLEAR                           0x01
#define LCDMINI_RETURN_HOME                     0x02
#define LCDMINI_DISPLAY_OFF_CURSOR_OFF          0x08
#define LCDMINI_CURSOR_OFF                      0x0C
#define LCDMINI_UNDERLINE_ON                    0x0E
#define LCDMINI_BLINK_CURSOR_ON                 0x0F
#define LCDMINI_MOVE_CURSOR_LEFT                0x10
#define LCDMINI_MOVE_CURSOR_RIGHT               0x14
#define LCDMINI_TURN_ON                         0x0A
#define LCDMINI_TURN_OFF                        0x0C
#define LCDMINI_SHIFT_LEFT                      0x18
#define LCDMINI_SHIFT_RIGHT                     0x1C
#define LCDMINI_2_LINE_5X7                      0x28
 
#define LCDMINI_FIRST_ROW                       0x80      
#define LCDMINI_SECOND_ROW                      0xC0   
#define LCDMINI_THIRD_ROW                       0x94 
#define LCDMINI_FOURTH_ROW                      0xD4
 
 
#define LCDMINI_DEF_FREQ                        500
 
#define LCDMINI_SET_DATA_SAMPLE_EDGE      SET_SPI_DATA_SAMPLE_EDGE
#define LCDMINI_SET_DATA_SAMPLE_MIDDLE    SET_SPI_DATA_SAMPLE_MIDDLE
 
 // lcdmini_set
 
#define LCDMINI_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.cs2  = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.rst  = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.pwm  = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // lcdmini_map
 // lcdmini
 
typedef struct
{
    // Output pins
    digital_out_t  cs2;             
    digital_out_t  rst;             
    // Input pins
    digital_in_t  int_pin;          
    // Modules
    pwm_t pwm;                      
    spi_master_t  spi;              
    pin_name_t  chip_select;        
    uint32_t pwm_freq;              
} lcdmini_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   cs2;               
    pin_name_t  rst;                
    pin_name_t  pwm;                
    pin_name_t  int_pin;            
    // Static variables
    uint32_t dev_pwm_freq;           
    uint32_t                           spi_speed;        
    spi_master_mode_t                  spi_mode;         
    spi_master_chip_select_polarity_t  cs_polarity;      
} lcdmini_cfg_t;
 
typedef enum
{
   LCDMINI_OK = 0,
   LCDMINI_ERROR = -1
 
} lcdmini_return_value_t;
 
void lcdmini_cfg_setup ( lcdmini_cfg_t *cfg );
 
err_t lcdmini_init ( lcdmini_t *ctx, lcdmini_cfg_t *cfg );
 
err_t lcdmini_default_cfg ( lcdmini_t *ctx );
 
err_t lcdmini_generic_write ( lcdmini_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
 
err_t lcdmini_generic_read ( lcdmini_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
 
err_t lcdmini_set_duty_cycle ( lcdmini_t *ctx, float duty_cycle );
 
err_t lcdmini_pwm_stop ( lcdmini_t *ctx );
 
err_t lcdmini_pwm_start ( lcdmini_t *ctx );
 
void lcdmini_set_backlight ( lcdmini_t *ctx, float backlight_value );
 
void lcdmini_set_contrast( lcdmini_t *ctx, uint8_t contrast_value );
 
uint8_t lcdmini_get_interrupt( lcdmini_t *ctx );
 
void lcdmini_hw_reset( lcdmini_t *ctx );
 
err_t lcdmini_read_register ( lcdmini_t *ctx, uint8_t reg , uint8_t *data_out );
 
err_t lcdmini_write_register ( lcdmini_t *ctx, uint8_t reg , uint8_t data_in );
 
void lcdmini_send_cmd ( lcdmini_t *ctx, uint8_t command );
 
void lcdmini_send_char ( lcdmini_t *ctx, uint8_t character );
 
void lcdmini_display_char ( lcdmini_t *ctx, uint8_t row, uint8_t column, char character );
 
void lcdmini_display_text ( lcdmini_t *ctx, uint8_t row, uint8_t column, char *data_in );
 
#ifdef __cplusplus
}
#endif
#endif // LCDMINI_H
 
 // lcdmini
 
// ------------------------------------------------------------------------ END