c16x12.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 C16X12_H
#define C16X12_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_digital_in.h"
#include "drv_i2c_master.h"
 
// -------------------------------------------------------------- PUBLIC MACROS 
#define C16X12_MAP_MIKROBUS( cfg, mikrobus ) \
  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
  cfg.sdb = MIKROBUS( mikrobus, MIKROBUS_CS ); \
  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
#define C16X12_RETVAL uint8_t
 
#define C16X12_OK           0x00
#define C16X12_INIT_ERROR   0xFF
#define C16X12G_PSR               0xFD     
#define C16X12G_PSWL              0xFE     
#define C16X12G_IMR               0xF0     
#define C16X12G_ISR               0xF1     
#define C16X12G_PSWL_DISABLE      0x00     
#define C16X12G_PSWL_ENABLE       0xC5     
#define C16X12G_IMR_IAC           0x08     
#define C16X12G_IMR_IAB           0x04     
#define C16X12G_IMR_IS            0x02     
#define C16X12G_IMR_IO            0x01     
#define C16X12G_ISR_ABM3          0x10     
#define C16X12G_ISR_ABM2          0x08     
#define C16X12G_ISR_ABM1          0x04     
#define C16X12G_ISR_SB            0x02     
#define C16X12G_ISR_OB            0x01     
#define C16X12G_CR_SYNC_MASTER  0x40
#define C16X12G_CR_SYNC_SLAVE   0x80
#define C16X12G_CR_OSD          0x04
#define C16X12G_CR_BEN          0x02
#define C16X12G_CR_SSD          0x01
#define C16X12G_LEDONOFF        0x0000
#define C16X12G_LEDOPEN         0x0018
#define C16X12G_LEDSHORT        0x0030
#define C16X12G_LEDPWM          0x0100
#define C16X12G_LEDABM          0x0200
#define C16X12G_CR              0x0300 
#define C16X12G_GCC             0x0301 
#define C16X12G_ABM1            0x0302 
#define C16X12G_ABM2            0x0306 
#define C16X12G_ABM3            0x030A 
#define C16X12G_TUR             0x030E 
#define C16X12G_SWPUR           0x030F 
#define C16X12G_CSPDR           0x0310 
#define C16X12G_RESET           0x0311 
#define C16X12G_CS                  16 
#define C16X12G_SW                  12 
#define C16X12G_GND_ADDR            0x00 
#define C16X12G_SCL_ADDR            0x01 
#define C16X12G_SDA_ADDR            0x02 
#define C16X12G_VCC_ADDR            0x03 
#define C16X12G_ABM_LOOP_TIMES_MAX  0x0FFF 
#define C16X12G_ABM_LOOP_FOREVER    0x0000 
#define C16X12G_LED_STATE_OFF  0x00 
#define C16X12G_LED_STATE_ON   0x01 
#define C16X12G_CONTINUE_SETTINGS  0x00 
#define C16X12G_STOP_SETTINGS      0x01 
#define C16X12G_LED_STATUS_NORMAL   0x00 
#define C16X12G_LED_STATUS_OPEN     0x01 
#define C16X12G_LED_STATUS_SHORT    0x02 
#define C16X12G_LED_STATUS_UNKNOWN  0x03 
#define C16X12G_RESISTOR_OFF 0x00 
#define C16X12G_RESISTOR_500 0x01 
#define C16X12G_RESISTOR_1K  0x02 
#define C16X12G_RESISTOR_2K  0x03 
#define C16X12G_RESISTOR_4K  0x04 
#define C16X12G_RESISTOR_8K  0x05 
#define C16X12G_RESISTOR_16K 0x06 
#define C16X12G_RESISTOR_32K 0x07 
#define C16X12G_LED_MODE_PWM  0x00 
#define C16X12G_LED_MODE_ABM1 0x01 
#define C16X12G_LED_MODE_ABM2 0x02 
#define C16X12G_LED_MODE_ABM3 0x03 
#define C16X12G_ABM_T1_210MS   0x00 
#define C16X12G_ABM_T1_420MS   0x20 
#define C16X12G_ABM_T1_840MS   0x40 
#define C16X12G_ABM_T1_1680MS  0x60 
#define C16X12G_ABM_T1_3360MS  0x80 
#define C16X12G_ABM_T1_6720MS  0xA0 
#define C16X12G_ABM_T1_13440MS 0xC0 
#define C16X12G_ABM_T1_26880MS 0xE0 
#define C16X12G_ABM_T2_0MS     0x00 
#define C16X12G_ABM_T2_210MS   0x02 
#define C16X12G_ABM_T2_420MS   0x04 
#define C16X12G_ABM_T2_840MS   0x06 
#define C16X12G_ABM_T2_1680MS  0x08 
#define C16X12G_ABM_T2_3360MS  0x0A 
#define C16X12G_ABM_T2_6720MS  0x0C 
#define C16X12G_ABM_T2_13440MS 0x0E 
#define C16X12G_ABM_T2_26880MS 0x10 
#define C16X12G_ABM_T3_210MS   0x00 
#define C16X12G_ABM_T3_420MS   0x20 
#define C16X12G_ABM_T3_840MS   0x40 
#define C16X12G_ABM_T3_1680MS  0x60 
#define C16X12G_ABM_T3_3360MS  0x80 
#define C16X12G_ABM_T3_6720MS  0xA0 
#define C16X12G_ABM_T3_13440MS 0xC0 
#define C16X12G_ABM_T3_26880MS 0xE0 
#define C16X12G_ABM_T4_0MS      0x00 
#define C16X12G_ABM_T4_210MS    0x02 
#define C16X12G_ABM_T4_420MS    0x04 
#define C16X12G_ABM_T4_840MS    0x06 
#define C16X12G_ABM_T4_1680MS   0x08 
#define C16X12G_ABM_T4_3360MS   0x0A 
#define C16X12G_ABM_T4_6720MS   0x0C 
#define C16X12G_ABM_T4_13440MS  0x0E 
#define C16X12G_ABM_T4_26880MS  0x10 
#define C16X12G_ABM_T4_53760MS  0x12 
#define C16X12G_ABM_T4_107520MS 0x14 
#define C16X12G_ABM_LOOP_BEGIN_T1 0x00 
#define C16X12G_ABM_LOOP_BEGIN_T2 0x10 
#define C16X12G_ABM_LOOP_BEGIN_T3 0x20 
#define C16X12G_ABM_LOOP_BEGIN_T4 0x30 
#define C16X12G_ABM_LOOP_END_T3 0x00 
#define C16X12G_ABM_LOOP_END_T1 0x40 
#define C16X12G_ABM_NUM_1 0x0302 
#define C16X12G_ABM_NUM_2 0x0306 
#define C16X12G_ABM_NUM_3 0x030A 
 // End group macro 
 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
    // Output pins 
 
    digital_out_t rst;
    digital_out_t sdb;
    
    // Input pins 
 
    digital_in_t int_pin;
    
    // Modules 
 
    i2c_master_t i2c;
 
    // ctx variable 
 
    uint8_t slave_address;
 
} c16x12_t;
 
typedef struct
{
    // Communication gpio pins 
 
    pin_name_t scl;
    pin_name_t sda;
    
    // Additional gpio pins 
 
    pin_name_t rst;
    pin_name_t sdb;
    pin_name_t int_pin;
 
    // static variable 
 
    uint32_t i2c_speed;
    uint8_t i2c_address;
 
} c16x12_cfg_t;
 
typedef struct
{
    uint8_t  time_1;
    uint8_t  time_2;
    uint8_t  time_3;
    uint8_t  time_4;
    uint8_t  loop_begin;
    uint8_t  loop_end;
    uint16_t loop_times;
 
}c16x12_abm_t;
 
 // End types group
 
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void c16x12_cfg_setup ( c16x12_cfg_t *cfg );
 
C16X12_RETVAL c16x12_init ( c16x12_t *ctx, c16x12_cfg_t *cfg );
 
void c16x12_default_cfg ( c16x12_t *ctx );
 
void c16x12_generic_write ( c16x12_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
 
void c16x12_generic_read ( c16x12_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
 
void c16x12g_write_reg ( c16x12_t *ctx, uint8_t reg, uint8_t c_data );
 
void c16x12g_select_page ( c16x12_t *ctx, uint8_t page );
 
void c16x12g_write_page_byte ( c16x12_t *ctx, uint16_t reg_addr, uint8_t reg_value );
 
void c16x12g_write_page_data ( c16x12_t *ctx, uint16_t reg, uint8_t *data_buf, uint8_t n_data );
 
uint8_t c16x12g_read_reg ( c16x12_t *ctx, uint8_t reg );
 
void c16x12g_set_stand_by ( c16x12_t *ctx, uint8_t state );
 
void c16x12g_device_reset ( c16x12_t *ctx );
 
uint8_t c16x12g_get_interrupt ( c16x12_t *ctx );
 
void c16x12g_device_configuration ( c16x12_t *ctx );
 
void c16x12g_set_all_leds ( c16x12_t *ctx, uint8_t state );
 
void c16x12g_set_global_current_control ( c16x12_t *ctx, uint8_t gcc );
 
void c16x12g_clear_display ( c16x12_t *ctx );
 
void c16x12g_set_column_state ( c16x12_t *ctx, uint8_t col, uint16_t state, uint8_t c_end );
 
void c16x12g_set_leds_mode ( c16x12_t *ctx, uint8_t mode );
 
void c16x12g_set_pmw ( c16x12_t *ctx, uint8_t pwm_value );
 
void c16x12g_set_led ( c16x12_t *ctx, uint8_t x_pos, uint8_t y_pos, uint8_t state, uint8_t c_end );
 
void c16x12g_display_byte ( c16x12_t *ctx, char ch );
 
void c16x12g_display_image ( c16x12_t *ctx, uint16_t *p_image );
 
void c16x12g_display_text ( c16x12_t *ctx, char *p_text, uint8_t n_char, uint8_t speed );
 
void c16x12g_config_abm ( c16x12_t *ctx, uint16_t n_abm, c16x12_abm_t *config );
 
void c16x12g_start_abm ( c16x12_t *ctx );
 
 
 
#ifdef __cplusplus
}
#endif
#endif  // _C16X12_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END