digipot14.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 DIGIPOT14_H
#define DIGIPOT14_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 DIGIPOT14_VOLATILE_REG_WRA                  0x00
#define DIGIPOT14_VOLATILE_REG_WRB                  0x01
#define DIGIPOT14_VOLATILE_REG_ACR                  0x10
#define DIGIPOT14_NON_VOLATILE_REG_IVRA             0x00
#define DIGIPOT14_NON_VOLATILE_REG_IVRB             0x01
 
 // digipot14_reg
 
#define DIGIPOT14_VOLATILE_REG_WRITE                0x80
#define DIGIPOT14_NON_VOLATILE_REG_WRITE            0x00
#define DIGIPOT14_DISABLE_SHUT_DOWN                 0x40
#define DIGIPOT14_ENABLE_SHUT_DOWN                  0x00
#define DIGIPOT14_NON_VOLATILE_WR_IN_PROGRESS       0x20
#define DIGIPOT14_NON_VOLATILE_WR_NOT_IN_PROGRESS   0x00
 
#define DIGIPOT14_MAX_RESISTANCE_KOHM               100.0
#define DIGIPOT14_MAX_POSITION                      255
#define DIGIPOT14_MAX_POSITION_NUM                  256.0
#define DIGIPOT14_MIN_POSITION                      0
 
#define DIGIPOT14_DEVICE_ADDRESS_000                0x50
#define DIGIPOT14_DEVICE_ADDRESS_001                0x51
#define DIGIPOT14_DEVICE_ADDRESS_010                0x52
#define DIGIPOT14_DEVICE_ADDRESS_011                0x53
#define DIGIPOT14_DEVICE_ADDRESS_100                0x54
#define DIGIPOT14_DEVICE_ADDRESS_101                0x55
#define DIGIPOT14_DEVICE_ADDRESS_110                0x56
#define DIGIPOT14_DEVICE_ADDRESS_111                0x57
 
 // digipot14_set
 
#define DIGIPOT14_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA );
 
 // digipot14_map
 // digipot14
 
typedef struct
{
    // Modules
    i2c_master_t i2c;           
    // I2C slave address
    uint8_t slave_address;      
} digipot14_t;
 
typedef struct
{
    pin_name_t scl;             
    pin_name_t sda;             
    uint32_t   i2c_speed;       
    uint8_t    i2c_address;     
} digipot14_cfg_t;
 
typedef enum
{
    DIGIPOT14_OK = 0,
    DIGIPOT14_ERROR = -1
 
} digipot14_return_value_t;
 
void digipot14_cfg_setup ( digipot14_cfg_t *cfg );
 
err_t digipot14_init ( digipot14_t *ctx, digipot14_cfg_t *cfg );
 
err_t digipot14_default_cfg ( digipot14_t *ctx );
 
err_t digipot14_generic_write ( digipot14_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
 
err_t digipot14_generic_read ( digipot14_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
 
err_t digipot14_reg_write ( digipot14_t *ctx, uint8_t reg, uint8_t data_in );
 
err_t digipot14_reg_read ( digipot14_t *ctx, uint8_t reg, uint8_t *data_out );
 
err_t digipot14_set_pot_a_wiper ( digipot14_t *ctx, uint8_t wiper_pos );
 
err_t digipot14_set_pot_b_wiper ( digipot14_t *ctx, uint8_t wiper_pos );
 
#ifdef __cplusplus
}
#endif
#endif // DIGIPOT14_H
 
 // digipot14
 
// ------------------------------------------------------------------------ END