leddriver9.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 LEDDRIVER9_H
#define LEDDRIVER9_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_i2c_master.h"
 
#define LEDDRIVER9_REG_MODE1                                        0x00
 
#define LEDDRIVER9_REG_MODE2                                        0x01
 
#define LEDDRIVER9_REG_PWM0                                         0x02
 
#define LEDDRIVER9_REG_PWM1                                         0x03
 
#define LEDDRIVER9_REG_PWM2                                         0x04
 
#define LEDDRIVER9_REG_PWM3                                         0x05
 
#define LEDDRIVER9_REG_PWM4                                         0x06
 
#define LEDDRIVER9_REG_PWM5                                         0x07
 
#define LEDDRIVER9_REG_PWM6                                         0x08
 
#define LEDDRIVER9_REG_PWM7                                         0x09
 
#define LEDDRIVER9_REG_PWM8                                         0x0A
 
#define LEDDRIVER9_REG_PWM9                                         0x0B
 
#define LEDDRIVER9_REG_PWM10                                        0x0C
 
#define LEDDRIVER9_REG_PWM11                                        0x0D
 
#define LEDDRIVER9_REG_PWM12                                        0x0E
 
#define LEDDRIVER9_REG_PWM13                                        0x0F
 
#define LEDDRIVER9_REG_PWM14                                        0x10
 
#define LEDDRIVER9_REG_PWM15                                        0x11
 
#define LEDDRIVER9_REG_GRPPWM                                       0x12
 
#define LEDDRIVER9_REG_GRPFREQ                                      0x13
 
#define LEDDRIVER9_REG_LEDOUT0                                      0x14
 
#define LEDDRIVER9_REG_LEDOUT1                                      0x15
 
#define LEDDRIVER9_REG_LEDOUT2                                      0x16
 
#define LEDDRIVER9_REG_LEDOUT3                                      0x17
 
#define LEDDRIVER9_REG_SUBADR1                                      0x18
 
#define LEDDRIVER9_REG_SUBADR2                                      0x19
 
#define LEDDRIVER9_REG_SUBADR3                                      0x1A
 
#define LEDDRIVER9_REG_ALLCALLADR                                   0x1B
 
#define LEDDRIVER9_REG_IREF                                         0x1C
 
#define LEDDRIVER9_REG_EFLAG1                                       0x1D
 
#define LEDDRIVER9_REG_EFLAG2                                       0x1E
 
 // leddriver9_reg
 
#define LEDDRIVER9_SET_DEV_ADDR  0x60
 
 // leddriver9_set
 
#define LEDDRIVER9_MAP_MIKROBUS( cfg, mikrobus )  \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST )
 
 // leddriver9_map
 // leddriver9
 
typedef struct
{
    // Output pins
 
    digital_out_t  rst;
 
    // Modules
 
    i2c_master_t i2c;                                
    // I2C slave address
 
    uint8_t slave_address;                           
} leddriver9_t;
 
typedef struct
{
    pin_name_t  scl;                                 
    pin_name_t  sda;                                 
    pin_name_t  rst;                                 
    uint32_t  i2c_speed;                             
    uint8_t   i2c_address;                           
} leddriver9_cfg_t;
 
typedef enum
{
    LEDDRIVER9_OK = 0,
    LEDDRIVER9_ERROR = -1
 
} leddriver9_return_value_t;
 
 
typedef enum
{
    LEDDRIVER9_CHANNEL0 = 0,
    LEDDRIVER9_CHANNEL1,
    LEDDRIVER9_CHANNEL2,
    LEDDRIVER9_CHANNEL3,
    LEDDRIVER9_CHANNEL4,
    LEDDRIVER9_CHANNEL5,
    LEDDRIVER9_CHANNEL6,
    LEDDRIVER9_CHANNEL7,
    LEDDRIVER9_CHANNEL8,
    LEDDRIVER9_CHANNEL9,
    LEDDRIVER9_CHANNEL10,
    LEDDRIVER9_CHANNEL11,
    LEDDRIVER9_CHANNEL12,
    LEDDRIVER9_CHANNEL13,
    LEDDRIVER9_CHANNEL14,
    LEDDRIVER9_CHANNEL15
 
} leddriver9_channel_sel_t;
 
 
typedef enum
{
    LEDDRIVER9_OFF = 0,                              
    LEDDRIVER9_FULL_ON,                              
    LEDDRIVER9_INDIVIDUAL,                           
    LEDDRIVER9_GROUP                                 
} leddriver9_ledout_sel_t;
 
 
typedef struct
{
    union
    {
        uint8_t byte;                                
        struct
        {
            uint8_t ALLCALL : 1;                     
            uint8_t SUB3 : 1;                        
            uint8_t SUB2 : 1;                        
            uint8_t SUB1 : 1;                        
            uint8_t OSC : 1;                         
            uint8_t AI0 : 1;                         
            uint8_t AI1 : 1;                         
            uint8_t AI2 : 1;                         
        };
    } mode_1;
    
    union
    {
        uint8_t byte;                                
        struct
        {
            uint8_t RES : 3;                         
            uint8_t OCH : 1;                         
            uint8_t RES1 : 1;                        
            uint8_t DMBLNK : 1;                      
            uint8_t RES2 : 1;                        
            uint8_t EFCLR : 1;                       
        };
    } mode_2;
    
} leddriver9_mode_reg_t;
 
typedef struct
{
    union
    {
        uint8_t byte;                                
        struct
        {
            uint8_t LDR0 : 2;                        
            uint8_t LDR1 : 2;                        
            uint8_t LDR2 : 2;                        
            uint8_t LDR3 : 2;                        
        };
    } LEDOUT0;
    
    union
    {
        uint8_t byte;                                
        struct
        {
            uint8_t LDR4 : 2;                        
            uint8_t LDR5 : 2;                        
            uint8_t LDR6 : 2;                        
            uint8_t LDR7 : 2;                        
        };
    } LEDOUT1;
    
    union
    {
        uint8_t byte;                                
        struct
        {
            uint8_t LDR8 : 2;                        
            uint8_t LDR9 : 2;                        
            uint8_t LDR10 : 2;                       
            uint8_t LDR11 : 2;                       
        };
    } LEDOUT2;
    
    union
    {
        uint8_t byte;                                
        struct
        {
            uint8_t LDR12 : 2;                       
            uint8_t LDR13 : 2;                       
            uint8_t LDR14 : 2;                       
            uint8_t LDR15 : 2;                       
        };
    } LEDOUT3;
    
} leddriver9_output_state_t;
 
void leddriver9_cfg_setup ( leddriver9_cfg_t *cfg );
 
err_t leddriver9_init ( leddriver9_t *ctx, leddriver9_cfg_t *cfg );
 
void leddriver9_default_cfg ( leddriver9_t *ctx );
 
err_t leddriver9_generic_write ( leddriver9_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len );
 
err_t leddriver9_generic_read ( leddriver9_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len );
 
err_t leddriver9_mode1_reg_write ( leddriver9_t *ctx, leddriver9_mode_reg_t *mode_reg );
 
err_t leddriver9_mode1_reg_read ( leddriver9_t *ctx, leddriver9_mode_reg_t *mode_reg );
 
err_t leddriver9_mode2_reg_write ( leddriver9_t *ctx, leddriver9_mode_reg_t *mode_reg );
 
err_t leddriver9_mode2_reg_read ( leddriver9_t *ctx, leddriver9_mode_reg_t *mode_reg );
 
err_t leddriver9_ledout_state ( leddriver9_t *ctx, leddriver9_output_state_t *output_state );
 
err_t leddriver9_set_pwm ( leddriver9_t *ctx, leddriver9_channel_sel_t ch_out, float duty_cycle );
 
err_t leddriver9_set_dimmer_pwm ( leddriver9_t *ctx, float duty_cycle );
 
err_t leddriver9_set_blink_period ( leddriver9_t *ctx, float period );
 
void leddriver9_hardware_reset ( leddriver9_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // LEDDRIVER9_H
 
 // leddriver9
 
// ------------------------------------------------------------------------ END