c8x8r.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 c8x8R_H
#define c8x8R_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_spi_master.h"
 
#define C8X8R_DECODE_MODE_REG     0x09
#define C8X8R_INTENSITY_REG       0x0A
#define C8X8R_SCAN_LIMIT_REG      0x0B
#define C8X8R_SHUTDOWN_REG        0x0C
#define C8X8R_DISPLAY_TEST_REG    0x0F
 
#define C8X8R_NO_DECODE           0x00
#define C8X8R_DECODE_DIGIT_0      0x01
#define C8X8R_DECODE_DIGIT_3_0    0x0F
#define C8X8R_DECODE_DIGIT_7      0xFF
 
#define C8X8R_INTENSITY_1         0x00
#define C8X8R_INTENSITY_3         0x01
#define C8X8R_INTENSITY_5         0x02
#define C8X8R_INTENSITY_7         0x03
#define C8X8R_INTENSITY_9         0x04
#define C8X8R_INTENSITY_11        0x05
#define C8X8R_INTENSITY_13        0x06
#define C8X8R_INTENSITY_15        0x07
#define C8X8R_INTENSITY_17        0x08
#define C8X8R_INTENSITY_19        0x09
#define C8X8R_INTENSITY_21        0x0A
#define C8X8R_INTENSITY_23        0x0B
#define C8X8R_INTENSITY_25        0x0C
#define C8X8R_INTENSITY_27        0x0D
#define C8X8R_INTENSITY_29        0x0E
#define C8X8R_INTENSITY_31        0x0F
 
#define C8X8R_DISPLAY_DIGIT_0     0x00
#define C8X8R_DISPLAY_DIGIT_0_1   0x01
#define C8X8R_DISPLAY_DIGIT_0_2   0x02
#define C8X8R_DISPLAY_DIGIT_0_3   0x03
#define C8X8R_DISPLAY_DIGIT_0_4   0x04
#define C8X8R_DISPLAY_DIGIT_0_5   0x05
#define C8X8R_DISPLAY_DIGIT_0_6   0x06
#define C8X8R_DISPLAY_DIGIT_0_7   0x07
 
#define C8X8R_SHUTDOWN_MODE       0x00
#define C8X8R_NORMAL_OPERATION    0x01
 
 
#define C8X8R_DISPLAY_NORMAL_OPERATION  0x00
#define C8X8R_DISPLAY_TEST_MODE         0X01
 // c8x8r_reg
 
 // c8x8r_set
 
#define C8X8R_SPEED_FAST    3
#define C8X8R_SPEED_MEDIUM  2
#define C8X8R_SPEED_SLOW    1
 
 // c8x8r_scroll_speed
 
#define C8X8R_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 )
 
 // c8x8r_map
 // c8x8r
 
typedef struct
{
    
    spi_master_t  spi;                               
    pin_name_t  chip_select;                         
    uint8_t speed_scroll;
    
} c8x8r_t;
 
typedef struct
{
    // Communication gpio pins
 
    pin_name_t  miso;                                    
    pin_name_t  mosi;                                    
    pin_name_t  sck;                                     
    pin_name_t  cs;                                      
    // static variable
 
    uint32_t                           spi_speed;        
    spi_master_mode_t                  spi_mode;         
    spi_master_chip_select_polarity_t  cs_polarity;      
} c8x8r_cfg_t;
 
typedef enum
{
   C8X8R_OK = 0,
   C8X8R_ERROR = -1
 
} c8x8r_return_value_t;
 
void c8x8r_cfg_setup ( c8x8r_cfg_t *cfg );
 
err_t c8x8r_init ( c8x8r_t *ctx, c8x8r_cfg_t *cfg );
 
void c8x8r_default_cfg ( c8x8r_t *ctx );
 
void c8x8r_write_cmd ( c8x8r_t *ctx, uint8_t cmd, uint8_t tx_data  );
 
void c8x8r_display_refresh ( c8x8r_t *ctx );
 
void c8x8r_set_speed_scroll ( c8x8r_t *ctx, uint8_t speed );
 
void c8x8r_display_string ( c8x8r_t *ctx, char *p_array );
 
void c8x8r_display_byte ( c8x8r_t *ctx, char tx_byte );
 
void c8x8r_display_image ( c8x8r_t *ctx, uint8_t *p_image );
 
#ifdef __cplusplus
}
#endif
#endif // c8x8R_H
 
 // c8x8r
 
// ------------------------------------------------------------------------ END