digipot11.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 DIGIPOT11_H
#define DIGIPOT11_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 DIGIPOT11_WIPER_SEL_A                   0x11
#define DIGIPOT11_WIPER_SEL_B                   0x12
#define DIGIPOT11_WIPER_SEL_BOTH                0x13
 
#define DIGIPOT11_WIPER_FULL_SCALE              0xFF
#define DIGIPOT11_WIPER_MID_SCALE               0x80
#define DIGIPOT11_WIPER_ZERO_SCALE              0x00
 
#define DIGIPOT11_U1_DEVICE_ADDRESS_A1A0_00     0x2C
#define DIGIPOT11_U1_DEVICE_ADDRESS_A1A0_01     0x2D
#define DIGIPOT11_U1_DEVICE_ADDRESS_A1A0_10     0x2E
#define DIGIPOT11_U1_DEVICE_ADDRESS_A1A0_11     0x2F
#define DIGIPOT11_U2_DEVICE_ADDRESS_A1A0_00     0x28
#define DIGIPOT11_U2_DEVICE_ADDRESS_A1A0_01     0x29
#define DIGIPOT11_U2_DEVICE_ADDRESS_A1A0_10     0x2A
#define DIGIPOT11_U2_DEVICE_ADDRESS_A1A0_11     0x2B
 
 // digipot11_set
 
#define DIGIPOT11_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA );
 
 // digipot11_map
 // digipot11
 
typedef struct
{
    // Modules
    i2c_master_t i2c;               
    // I2C slave address
    uint8_t u1_slave_address;       
    uint8_t u2_slave_address;       
} digipot11_t;
 
typedef struct
{
    pin_name_t scl;                 
    pin_name_t sda;                 
    uint32_t   i2c_speed;           
    uint8_t    i2c_address_u1;      
    uint8_t    i2c_address_u2;      
} digipot11_cfg_t;
 
typedef enum
{
    DIGIPOT11_OK = 0,
    DIGIPOT11_ERROR = -1
 
} digipot11_return_value_t;
 
void digipot11_cfg_setup ( digipot11_cfg_t *cfg );
 
err_t digipot11_init ( digipot11_t *ctx, digipot11_cfg_t *cfg );
 
err_t digipot11_set_u1_wiper ( digipot11_t *ctx, uint8_t wiper_sel, uint8_t data_in );
 
err_t digipot11_set_u2_wiper ( digipot11_t *ctx, uint8_t wiper_sel, uint8_t data_in );
 
#ifdef __cplusplus
}
#endif
#endif // DIGIPOT11_H
 
 // digipot11
 
// ------------------------------------------------------------------------ END