leddriver19.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 LEDDRIVER19_H
#define LEDDRIVER19_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 LEDDRIVER19_REG_DEVICE_ID               0x00
#define LEDDRIVER19_REG_DEVICE_EN               0x01
#define LEDDRIVER19_REG_CH_EN_LOW               0x02
#define LEDDRIVER19_REG_CH_EN_HIGH              0x03
#define LEDDRIVER19_REG_CONFIG                  0x04
#define LEDDRIVER19_REG_FAULT_MASK              0x05
#define LEDDRIVER19_REG_FAULT_INT               0x06
#define LEDDRIVER19_REG_OPEN_LED_LOW            0x07
#define LEDDRIVER19_REG_OPEN_LED_HIGH           0x08
#define LEDDRIVER19_REG_CUR_LED_CS0             0x09
#define LEDDRIVER19_REG_CUR_LED_CS1             0x0A
#define LEDDRIVER19_REG_CUR_LED_CS2             0x0B
#define LEDDRIVER19_REG_CUR_LED_CS3             0x0C
#define LEDDRIVER19_REG_CUR_LED_CS4             0x0D
#define LEDDRIVER19_REG_CUR_LED_CS5             0x0E
#define LEDDRIVER19_REG_CUR_LED_CS6             0x0F
#define LEDDRIVER19_REG_CUR_LED_CS7             0x10
#define LEDDRIVER19_REG_CUR_LED_CS8             0x11
#define LEDDRIVER19_REG_CUR_LED_CS9             0x12
#define LEDDRIVER19_REG_CUR_LED_CS10            0x13
#define LEDDRIVER19_REG_CUR_LED_CS11            0x14
#define LEDDRIVER19_REG_PATTERN_SEQ_REP         0x15
#define LEDDRIVER19_REG_PATTERN_0_DUR           0x16
#define LEDDRIVER19_REG_PATTERN_1_DUR           0x17
#define LEDDRIVER19_REG_PATTERN_2_DUR           0x18
#define LEDDRIVER19_REG_PATTERN_3_DUR           0x19
#define LEDDRIVER19_REG_PATTERN_4_DUR           0x1A
#define LEDDRIVER19_REG_PATTERN_5_DUR           0x1B
#define LEDDRIVER19_REG_PATTERN_6_DUR           0x1C
#define LEDDRIVER19_REG_PATTERN_7_DUR           0x1D
#define LEDDRIVER19_REG_PWMREG_OFFSET           0x1E
#define LEDDRIVER19_REG_CLOCK_CONFIG            0xE0
 
 
 // leddriver19_reg
 
#define LEDDRIVER19_DEVICE_ID                   0x12
 
#define LEDDRIVER19_PIN_STATE_HIGH              0x01
#define LEDDRIVER19_PIN_STATE_LOW               0x00
 
#define LEDDRIVER19_SW_RESET                    0x80
#define LEDDRIVER19_ENABLE                      0x01
 
#define LEDDRIVER19_PATSEL_0                    0x00
#define LEDDRIVER19_PATSEL_1                    0x01
#define LEDDRIVER19_PATSEL_2                    0x02
#define LEDDRIVER19_PATSEL_3                    0x03
#define LEDDRIVER19_PATSEL_4                    0x04
#define LEDDRIVER19_PATSEL_5                    0x05
#define LEDDRIVER19_PATSEL_6                    0x06
#define LEDDRIVER19_PATSEL_7                    0x07
 
#define LEDDRIVER19_CH_SEL_0                    0x00
#define LEDDRIVER19_CH_SEL_1                    0x01
#define LEDDRIVER19_CH_SEL_2                    0x02
#define LEDDRIVER19_CH_SEL_3                    0x03
#define LEDDRIVER19_CH_SEL_4                    0x04
#define LEDDRIVER19_CH_SEL_5                    0x05
#define LEDDRIVER19_CH_SEL_6                    0x06
#define LEDDRIVER19_CH_SEL_7                    0x07
#define LEDDRIVER19_CH_SEL_8                    0x08
#define LEDDRIVER19_CH_SEL_9                    0x09
#define LEDDRIVER19_CH_SEL_10                   0x0A
#define LEDDRIVER19_CH_SEL_11                   0x0B
 
#define LEDDRIVER19_SHFT_EN                     0x08
#define LEDDRIVER19_SHFT_DIS                    0x00
#define LEDDRIVER19_GCTRL_EN                    0x01
#define LEDDRIVER19_GCTRL_DIS                   0x00
#define LEDDRIVER19_PATSR_RUNING                0x01
#define LEDDRIVER19_PATSR_DONE                  0x00
#define LEDDRIVER19_PATS_EN                     0x01
#define LEDDRIVER19_PATS_DIS                    0x00
 
#define LEDDRIVER19_OVTP_MASK                   0x01
#define LEDDRIVER19_OPEN_MASK                   0x02
#define LEDDRIVER19_PAT_MASK                    0x04
#define LEDDRIVER19_SOF_MASK                    0x08
 
#define LEDDRIVER19_OVTP                        0x01
#define LEDDRIVER19_OPEN                        0x02
#define LEDDRIVER19_PAT                         0x04
#define LEDDRIVER19_SOF                         0x08
 
#define LEDDRIVER19_PATTERN_SEL_OFFSET          0x18
 
#define LEDDRIVER19_PWM_MASK                    0x0FFFu
 
#define LEDDRIVER19_CS0_OPEN                    0x0001u
#define LEDDRIVER19_CS1_OPEN                    0x0002u
#define LEDDRIVER19_CS2_OPEN                    0x0004u
#define LEDDRIVER19_CS3_OPEN                    0x0008u
#define LEDDRIVER19_CS4_OPEN                    0x0010u
#define LEDDRIVER19_CS5_OPEN                    0x0020u
#define LEDDRIVER19_CS6_OPEN                    0x0040u
#define LEDDRIVER19_CS7_OPEN                    0x0080u
#define LEDDRIVER19_CS8_OPEN                    0x0100u
#define LEDDRIVER19_CS9_OPEN                    0x0200u
#define LEDDRIVER19_CS10_OPEN                   0x0400u
#define LEDDRIVER19_CS11_OPEN                   0x0800u
 
#define LEDDRIVER19_CS0_ENABLE                  0x0001u
#define LEDDRIVER19_CS1_ENABLE                  0x0002u
#define LEDDRIVER19_CS2_ENABLE                  0x0004u
#define LEDDRIVER19_CS3_ENABLE                  0x0008u
#define LEDDRIVER19_CS4_ENABLE                  0x0010u
#define LEDDRIVER19_CS5_ENABLE                  0x0020u
#define LEDDRIVER19_CS6_ENABLE                  0x0040u
#define LEDDRIVER19_CS7_ENABLE                  0x0080u
#define LEDDRIVER19_CS8_ENABLE                  0x0100u
#define LEDDRIVER19_CS9_ENABLE                  0x0200u
#define LEDDRIVER19_CS10_ENABLE                 0x0400u
#define LEDDRIVER19_CS11_ENABLE                 0x0800u
#define LEDDRIVER19_CS_ENABLE_ALL               0x0FFFu
 
#define LEDDRIVER19_PWM_VAL_CONVERSION          40.95f
#define LEDDRIVER19_CURRENT_STEP_TO_MA          0.07843f
#define LEDDRIVER19_CURRENT_STEP_TO_HEX         12.75f
 
#define LEDDRIVER19_DEVICE_ADDRESS_0            0x58
#define LEDDRIVER19_DEVICE_ADDRESS_1            0x59
#define LEDDRIVER19_DEVICE_ADDRESS_2            0x5A
#define LEDDRIVER19_DEVICE_ADDRESS_3            0x5B
 
 // leddriver19_set
 
#define LEDDRIVER19_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // leddriver19_map
 // leddriver19
 
typedef struct
{
    // Input pins
    digital_in_t int_pin;       
    // Modules
    i2c_master_t i2c;           
    // I2C slave address
    uint8_t slave_address;      
} leddriver19_t;
 
typedef struct
{
    pin_name_t scl;             
    pin_name_t sda;             
    pin_name_t int_pin;         
    uint32_t   i2c_speed;       
    uint8_t    i2c_address;     
} leddriver19_cfg_t;
 
typedef enum
{
    LEDDRIVER19_OK = 0,
    LEDDRIVER19_ERROR = -1
 
} leddriver19_return_value_t;
 
void leddriver19_cfg_setup ( leddriver19_cfg_t *cfg );
 
err_t leddriver19_init ( leddriver19_t *ctx, leddriver19_cfg_t *cfg );
 
err_t leddriver19_default_cfg ( leddriver19_t *ctx );
 
err_t leddriver19_generic_write ( leddriver19_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
 
err_t leddriver19_generic_read ( leddriver19_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
 
uint8_t leddriver19_get_int_pin ( leddriver19_t *ctx );
 
err_t leddriver19_write_reg ( leddriver19_t *ctx, uint8_t reg, uint8_t data_in );
 
err_t leddriver19_read_reg ( leddriver19_t *ctx, uint8_t reg, uint8_t *data_out );
 
err_t leddriver19_sw_reset ( leddriver19_t *ctx );
 
err_t leddriver19_enable_channels ( leddriver19_t *ctx, uint16_t channels_en );
 
err_t leddriver19_disable_channels ( leddriver19_t *ctx, uint16_t channels_dis );
 
 
err_t leddriver19_set_pattern_pwm ( leddriver19_t *ctx, uint8_t pattern_sel, uint8_t channel_sel, 
                                    float pwm_value );
 
err_t leddriver19_get_ch_current ( leddriver19_t *ctx, uint8_t channel_sel, float *current_val );
 
err_t leddriver19_set_ch_current ( leddriver19_t *ctx, uint8_t channel_sel, float current_val );
 
err_t leddriver19_get_int_data ( leddriver19_t *ctx, uint8_t *int_data );
 
err_t leddriver19_get_nc_led ( leddriver19_t *ctx, uint16_t *led_data );
 
#ifdef __cplusplus
}
#endif
#endif // LEDDRIVER19_H
 
 // leddriver19
 
// ------------------------------------------------------------------------ END