oledb.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 _OLEDB_H_
#define _OLEDB_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_i2c_master.h"
#include "drv_spi_master.h"
#include "oledb_resources.h"
 
// -------------------------------------------------------------- PUBLIC MACROS
#define OLEDB_SSD1306_WIDTH                         128
#define OLEDB_DISPLAY_WIDTH                         96
#define OLEDB_DISPLAY_HEIGHT                        39
#define OLEDB_DISPLAY_ROWS                          5
#define OLEDB_FONT_5X7                              0
#define OLEDB_FONT_6X8                              1
#define OLEDB_DISPLAYOFF                            0xAE
#define OLEDB_SETDISPLAYCLOCKDIV                    0xD5
#define OLEDB_SETMULTIPLEX                          0xA8
#define OLEDB_SETDISPLAYOFFSET                      0xD3
#define OLEDB_SETSTARTLINE                          0x40
#define OLEDB_CHARGEPUMP                            0x8D
#define OLEDB_SETSEGMENTREMAP                       0xA1
#define OLEDB_SEGREMAP                              0xA0
#define OLEDB_COMSCANDEC                            0xC8
#define OLEDB_SETCOMPINS                            0xDA
#define OLEDB_SETCONTRAST                           0x81
#define OLEDB_SETPRECHARGE                          0xD9
#define OLEDB_SETVCOMDETECT                         0xDB
#define OLEDB_DISPLAYALLON_RESUME                   0xA4
#define OLEDB_NORMALDISPLAY                         0xA6
#define OLEDB_DISPLAYON                             0xAF
#define OLEDB_DISPLAYALLON                          0xA5
#define OLEDB_INVERTDISPLAY                         0xA7
#define OLEDB_SETLOWCOLUMN                          0x00
#define OLEDB_SETHIGHCOLUMN                         0x10
#define OLEDB_MEMORYMODE                            0x20
#define OLEDB_COLUMNADDR                            0x21
#define OLEDB_PAGEADDR                              0x22
#define OLEDB_COMSCANINC                            0xC0
#define OLEDB_EXTERNALVCC                           0x01
#define OLEDB_SWITCHCAPVCC                          0x02
#define OLEDB_ACTIVATE_SCROLL                       0x2F
#define OLEDB_DEACTIVATE_SCROLL                     0x2E
#define OLEDB_SET_VERTICAL_SCROLL_AREA              0xA3
#define OLEDB_RIGHT_HORIZONTAL_SCROLL               0x26
#define OLEDB_LEFT_HORIZONTAL_SCROLL                0x27
#define OLEDB_VERTICAL_AND_RIGHT_HORIZONTAL_SCROLL  0x29
#define OLEDB_VERTICAL_AND_LEFT_HORIZONTAL_SCROLL   0x2A
#define OLEDB_COMMAND                               0x3C
#define OLEDB_DATA                                  0x3D
#define OLEDB_MASTER_I2C                            0
#define OLEDB_MASTER_SPI                            1
#define err_t  uint8_t
#define OLEDB_OK                                    0x00
#define OLEDB_INIT_ERROR                            0xFF
#define OLEDB_INVALID_DATA_MODE                     0xFE
#define OLEDB_INVALID_DRIVER_SELECTOR               0xFD
 //  End error group
 
#define OLEDB_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST  ); \
    cfg.dc  = MIKROBUS( mikrobus, MIKROBUS_PWM  ); \
    cfg.cs  = MIKROBUS( mikrobus, MIKROBUS_CS   ); \
    cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK  ); \
    cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
    cfg.sdi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL  ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA  )
 //  End macros group
// --------------------------------------------------------------- PUBLIC TYPES
typedef uint8_t  oledb_drv_select_t;
 
typedef uint8_t  oledb_data_t;
 
typedef const uint8_t  oledb_resources_t;
 
typedef void ( *oledb_master_write_t )( struct oledb_s *, oledb_data_t *, uint8_t );
typedef uint8_t  oledb_select_t;
 
typedef struct oledb_s
{
    //  Click mikrobus DRV objects.
    digital_out_t  cs;
    digital_out_t  rst;
    digital_out_t  dc;
 
    // Modules 
    spi_master_t   spi;
    i2c_master_t   i2c;
 
    // ctx variable 
 
    uint8_t slave_address;
    pin_name_t chip_select;
 
    //  Click send function pointer.
    oledb_master_write_t  send;
    oledb_select_t master_sel;
 
} oledb_t;
 
typedef struct
{
    //  Used mikrobus pins.
    pin_name_t  rst;
    pin_name_t  dc;
    pin_name_t  cs;
    pin_name_t  sck;
    pin_name_t  sdi;
    pin_name_t  scl;
    pin_name_t  sda;
    pin_name_t  miso;
 
    // static variable 
 
    uint32_t i2c_speed;
    uint8_t  i2c_address;
    uint32_t spi_speed;
    spi_master_mode_t   spi_mode;
    spi_master_chip_select_polarity_t cs_polarity;
 
    oledb_select_t  sel;
 
} oledb_cfg_t;
 
 //  End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
#ifdef __cplusplus
extern "C"{
#endif
 
void oledb_cfg_setup( oledb_cfg_t *cfg );
 
err_t oledb_init( oledb_t *ctx, oledb_cfg_t *cfg );
 
void oledb_send_cmd( oledb_t *ctx, oledb_data_t tx_cmd );
 
void oledb_send_data( oledb_t *ctx, oledb_data_t *tx_data, uint8_t data_len );
 
void oledb_default_cfg( oledb_t *ctx );
 
void oledb_set_page( oledb_t *ctx, oledb_data_t page_addr );
 
void oledb_set_column( oledb_t *ctx, oledb_data_t col_addr );
 
void oledb_display_picture( oledb_t *ctx, oledb_resources_t *pic );
 
void oledb_clear_display( oledb_t *ctx );
 
void oledb_write_char( oledb_t *ctx, uint8_t font, uint8_t row, uint8_t position, uint8_t data_in );
 
void oledb_write_string( oledb_t *ctx, uint8_t font, uint8_t row, uint8_t position, uint8_t *data_in );
 
void oledb_set_contrast( oledb_t *ctx, oledb_data_t value );
 
void oledb_scroll_right( oledb_t *ctx, oledb_data_t start_page_addr, oledb_data_t end_page_addr );
 
void oledb_scroll_left( oledb_t *ctx, oledb_data_t start_page_addr, oledb_data_t end_page_addr );
 
void oledb_scroll_diag_right( oledb_t *ctx, oledb_data_t start_page_addr, oledb_data_t end_page_addr );
 
void oledb_scroll_diag_left( oledb_t *ctx, oledb_data_t start_page_addr, oledb_data_t end_page_addr );
 
void oledb_stop_scroll( oledb_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // OLEDB_H
 
 // oledb
 
// ------------------------------------------------------------------------ END