mic24045 2.0.0.0
Public function

Functions

void mic24045_cfg_setup (mic24045_cfg_t *cfg)
 Config Object Initialization function.
 
MIC24045_RETVAL mic24045_init (mic24045_t *ctx, mic24045_cfg_t *cfg)
 Initialization function.
 
void mic24045_generic_write (mic24045_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
 Generic write function.
 
void mic24045_generic_read (mic24045_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
 Generic read function.
 
uint8_t mic24045_get_status (mic24045_t *ctx)
 Get status function.
 
float mic24045_get_vout (mic24045_t *ctx)
 Get voltage.
 
void mic24045_set_vout (mic24045_t *ctx, float v_out)
 Set voltage.
 
void mic24045_set_vout_decimal (mic24045_t *ctx, uint8_t dec)
 Set voltage decimal.
 
void mic24045_enable (mic24045_t *ctx)
 Enable voltage output.
 
void mic24045_disable (mic24045_t *ctx)
 Disable voltage output.
 
uint8_t mic24045_get_power_good_state (mic24045_t *ctx)
 Get power good state.
 

Detailed Description

Function Documentation

◆ mic24045_cfg_setup()

void mic24045_cfg_setup ( mic24045_cfg_t * cfg)

Config Object Initialization function.

Parameters
cfgClick configuration structure.

@description This function initializes click configuration structure to init state.

Note
All used pins will be set to unconnected state.

◆ mic24045_disable()

void mic24045_disable ( mic24045_t * ctx)

Disable voltage output.

Parameters
ctxClick object.

@description This function is setting EN pin to LOW logic state.

◆ mic24045_enable()

void mic24045_enable ( mic24045_t * ctx)

Enable voltage output.

Parameters
ctxClick object.

@description This function is setting EN pin to HIGH logic state.

◆ mic24045_generic_read()

void mic24045_generic_read ( mic24045_t * ctx,
uint8_t reg,
uint8_t * data_buf,
uint8_t len )

Generic read function.

Parameters
ctxClick object.
regRegister address.
data_bufOutput data buf
lenNumber of the bytes to be read

@description This function reads data from the desired register.

◆ mic24045_generic_write()

void mic24045_generic_write ( mic24045_t * ctx,
uint8_t reg,
uint8_t * data_buf,
uint8_t len )

Generic write function.

Parameters
ctxClick object.
regRegister address.
data_bufData buf to be written.
lenNumber of the bytes in data buf.

@description This function writes data to the desired register.

◆ mic24045_get_power_good_state()

uint8_t mic24045_get_power_good_state ( mic24045_t * ctx)

Get power good state.

Parameters
ctxClick object.

@description This function returns power good pin state.

◆ mic24045_get_status()

uint8_t mic24045_get_status ( mic24045_t * ctx)

Get status function.

Parameters
ctxClick object.

@description This function is getting status.

◆ mic24045_get_vout()

float mic24045_get_vout ( mic24045_t * ctx)

Get voltage.

Parameters
ctxClick object.

@description This function is getting voltage.

◆ mic24045_init()

MIC24045_RETVAL mic24045_init ( mic24045_t * ctx,
mic24045_cfg_t * cfg )

Initialization function.

Parameters
ctxClick object.
cfgClick configuration structure.

@description This function initializes all necessary pins and peripherals used for this click.

◆ mic24045_set_vout()

void mic24045_set_vout ( mic24045_t * ctx,
float v_out )

Set voltage.

Parameters
ctxClick object.
vout float param

@description This function is setting v out.

◆ mic24045_set_vout_decimal()

void mic24045_set_vout_decimal ( mic24045_t * ctx,
uint8_t dec )

Set voltage decimal.

Parameters
ctxClick object.
decDecimal value of vout. VOUT Range Step Size Codes-decimal (hex) 0.640V to 1.280V 5 mV 0 (00h) to 128 (80h) 1.290V to 1.950V 10 mV 129 (81h) to 195 (C3h) 1.980V to 3.420V 30 mV 196 (C4h) to 244 (F4h) 4.750V to 5.250V 50 mV 245 (F5h) to 255 (FFh) @description This function is setting v out.