nanopower3.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 NANOPOWER3_H
#define NANOPOWER3_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 NANOPOWER3_CMD_VREG                             0x11
#define NANOPOWER3_CMD_NVREG                            0x21
#define NANOPOWER3_CMD_VREGxNVREG                       0x51
#define NANOPOWER3_CMD_NVREGxVREG                       0x61
 
#define NANOPOWER3_1V_OUT_VOLTAGE                       0x00
#define NANOPOWER3_1V2_OUT_VOLTAGE                      0x01
#define NANOPOWER3_1V5_OUT_VOLTAGE                      0x02
#define NANOPOWER3_1V8_OUT_VOLTAGE                      0x03
#define NANOPOWER3_2V_OUT_VOLTAGE                       0x04
#define NANOPOWER3_2V5_OUT_VOLTAGE                      0x05
#define NANOPOWER3_3V_OUT_VOLTAGE                       0x06
#define NANOPOWER3_3V3_OUT_VOLTAGE                      0x07
#define NANOPOWER3_3V5_OUT_VOLTAGE                      0x08
#define NANOPOWER3_4V_OUT_VOLTAGE                       0x09
#define NANOPOWER3_4V5_OUT_VOLTAGE                      0x0A
 
#define NANOPOWER3_1V_RESISTANCE                        187000
#define NANOPOWER3_1V2_RESISTANCE                       93100
#define NANOPOWER3_1V5_RESISTANCE                       53600
#define NANOPOWER3_1V8_RESISTANCE                       37400
#define NANOPOWER3_2V_RESISTANCE                        29000
#define NANOPOWER3_2V5_RESISTANCE                       20000
#define NANOPOWER3_3V_RESISTANCE                        15000
#define NANOPOWER3_3V3_RESISTANCE                       13100
#define NANOPOWER3_3V5_RESISTANCE                       12200
#define NANOPOWER3_4V_RESISTANCE                        10000
#define NANOPOWER3_4V5_RESISTANCE                       9000
 
#define NANOPOWER3_R11_RESISTANCE                       7200
#define NANOPOWER3_DIGIPOT_MAX_RESISTANCE               200000
#define NANOPOWER3_DIGIPOT_MAX_VAL                      255
#define NANOPOWER3_MAX_RESISTANCE                       207200
#define NANOPOWER3_ROUND_TO_NEAREST_INT                 0.5
 
#define NANOPOWER3_PIN_STATE_HIGH                       0x01
#define NANOPOWER3_PIN_STATE_LOW                        0x00
 
#define NANOPOWER3_DEVICE_ADDRESS_GND                   0x28
#define NANOPOWER3_DEVICE_ADDRESS_VCC                   0x29
 
 // nanopower3_set
 
#define NANOPOWER3_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.ctr = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.pg = MIKROBUS( mikrobus, MIKROBUS_INT )
#define NANOPOWER3_MAP_MIKROBUS( cfg, mikrobus ) \ …
 
 // nanopower3_map
 // nanopower3
 
typedef struct
{
    // Output pins
    digital_out_t ctr;          
    // Input pins
    digital_in_t an;            
    digital_in_t pg;            
    // Modules
    i2c_master_t i2c;           
    // I2C slave address
    uint8_t slave_address;      
} nanopower3_t;
typedef struct {…};
 
typedef struct
{
    pin_name_t scl;             
    pin_name_t sda;             
    pin_name_t an;              
    pin_name_t ctr;             
    pin_name_t pg;              
    uint32_t   i2c_speed;       
    uint8_t    i2c_address;     
} nanopower3_cfg_t;
typedef struct {…};
 
typedef enum
{
    NANOPOWER3_OK = 0,
    NANOPOWER3_ERROR = -1
 
} nanopower3_return_value_t;
typedef enum {…};
 
void nanopower3_cfg_setup ( nanopower3_cfg_t *cfg );
 
err_t nanopower3_init ( nanopower3_t *ctx, nanopower3_cfg_t *cfg );
 
err_t nanopower3_default_cfg ( nanopower3_t *ctx );
 
err_t nanopower3_generic_write ( nanopower3_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
 
err_t nanopower3_generic_read ( nanopower3_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
 
uint8_t nanopower3_get_pg_pin_state ( nanopower3_t *ctx );
 
uint8_t nanopower3_get_an_pin_state ( nanopower3_t *ctx );
 
void nanopower3_set_ctr_pin ( nanopower3_t *ctx, uint8_t pin_state );
 
err_t nanopower3_write_data ( nanopower3_t *ctx, uint8_t cmd, uint8_t data_in );
 
err_t nanopower3_set_wiper_pos ( nanopower3_t *ctx, uint8_t wiper_pos );
 
err_t nanopower3_set_resistance ( nanopower3_t *ctx, uint32_t resistance );
 
err_t nanopower3_set_voltage ( nanopower3_t *ctx, uint8_t out_vol );
 
#ifdef __cplusplus
}
#endif
#endif // NANOPOWER3_H
 
 // nanopower3
 
// ------------------------------------------------------------------------ END