stepdown5 2.1.0.0
stepdown5.h File Reference

This file contains API for Step Down 5 Click Driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_i2c_master.h"

Go to the source code of this file.

Data Structures

struct  stepdown5_t
 Step Down 5 Click context object. More...
 
struct  stepdown5_cfg_t
 Step Down 5 Click configuration object. More...
 

Macros

#define STEPDOWN5_PFM_PWM_MODE   0x00
 Step Down 5 description setting.
 
#define STEPDOWN5_FORCED_PWM_MODE   0x01
 
#define STEPDOWN5_R1_RPROG_ADDRESS   0x00
 
#define STEPDOWN5_R2_RPROG_ADDRESS   0x10
 
#define STEPDOWN5_DIGIPOT_MAX_VALUE   100000ul
 Step Down 5 calculation setting.
 
#define STEPDOWN5_DIGIPOT_RESOLUTION   257
 
#define STEPDOWN5_ROUND_TO_NEAREST_INT   0.5
 
#define STEPDOWN5_OUTPUT_0V6   1
 Step Down 5 output voltage setting.
 
#define STEPDOWN5_OUTPUT_1V5   2
 
#define STEPDOWN5_OUTPUT_2V5   3
 
#define STEPDOWN5_OUTPUT_3V3   4
 
#define STEPDOWN5_OUTPUT_5V   5
 
#define STEPDOWN5_ADDR_A2A1A0_000   0x28
 Step Down 5 device address setting.
 
#define STEPDOWN5_ADDR_A2A1A0_001   0x29
 
#define STEPDOWN5_ADDR_A2A1A0_010   0x2A
 
#define STEPDOWN5_ADDR_A2A1A0_011   0x2B
 
#define STEPDOWN5_ADDR_A2A1A0_100   0x2C
 
#define STEPDOWN5_ADDR_A2A1A0_101   0x2D
 
#define STEPDOWN5_ADDR_A2A1A0_110   0x2E
 
#define STEPDOWN5_ADDR_A2A1A0_111   0x2F
 
#define STEPDOWN5_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping.
 

Enumerations

enum  stepdown5_return_value_t { STEPDOWN5_OK = 0 , STEPDOWN5_ERROR = -1 }
 Step Down 5 Click return value data. More...
 

Functions

void stepdown5_cfg_setup (stepdown5_cfg_t *cfg)
 Step Down 5 configuration object setup function.
 
err_t stepdown5_init (stepdown5_t *ctx, stepdown5_cfg_t *cfg)
 Step Down 5 initialization function.
 
err_t stepdown5_default_cfg (stepdown5_t *ctx)
 Step Down 5 default configuration function.
 
err_t stepdown5_generic_write (stepdown5_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len)
 Step Down 5 I2C writing function.
 
err_t stepdown5_generic_read (stepdown5_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len)
 Step Down 5 I2C reading function.
 
void stepdown5_set_mode (stepdown5_t *ctx, uint8_t mode)
 Step Down 5 mode selection function.
 
uint8_t stepdown5_get_pg_state (stepdown5_t *ctx)
 Step Down 5 get PG pin state function.
 
err_t stepdown5_set_wiper_0_pos (stepdown5_t *ctx, uint16_t wiper_0_pos)
 Step Down 5 set wiper 0 position.
 
err_t stepdown5_set_wiper_1_pos (stepdown5_t *ctx, uint16_t wiper_1_pos)
 Step Down 5 set wiper 1 position.
 
err_t stepdown5_set_r1_resistance (stepdown5_t *ctx, uint32_t resistance)
 Step Down 5 set potentiometer 0 resistance.
 
err_t stepdown5_set_r2_resistance (stepdown5_t *ctx, uint32_t resistance)
 Step Down 5 set potentiometer 1 resistance.
 
err_t stepdown5_set_output (stepdown5_t *ctx, uint8_t voltage)
 Step Down 5 set output voltage.
 

Detailed Description

This file contains API for Step Down 5 Click Driver.

Enumeration Type Documentation

◆ stepdown5_return_value_t

Step Down 5 Click return value data.

Predefined enum values for driver return values.

Enumerator
STEPDOWN5_OK 
STEPDOWN5_ERROR