Public function

Functions
void	buck3_cfg_setup (buck3_cfg_t *cfg)
	Config Object Initialization function.
BUCK3_RETVAL	buck3_init (buck3_t *ctx, buck3_cfg_t *cfg)
	Initialization function.
void	buck3_default_cfg (buck3_t *ctx)
	Click Default Configuration function.
uint8_t	buck3_get_power_good (buck3_t *ctx)
	Function reads state of PGD pin.
void	buck3_set_device_state (buck3_t *ctx, uint8_t state)
	Function for setting chip mode.

Detailed Description

Function Documentation

buck3_cfg_setup()

void buck3_cfg_setup

(

buck3_cfg_t *

cfg

)

Config Object Initialization function.

Parameters

cfg	Click configuration structure.

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

Note

All used pins will be set to unconnected state.

buck3_default_cfg()

void buck3_default_cfg

(

buck3_t *

ctx

)

Click Default Configuration function.

Parameters

ctx	Click object.

@description This function executes default configuration for Buck 3 click.

Note

Default configuration contains:

   - Power mode (Device actiive)

buck3_get_power_good()

uint8_t buck3_get_power_good

(

buck3_t *

ctx

)

Function reads state of PGD pin.

Parameters

ctx	Click object.

Returns

State of PGD pin

 - 1 / FB pin voltage is between 93% and 107% of the internal reference voltage (VREF).
 - 0 / Overvoltage detected or device is under thermal shutdown.

buck3_init()

BUCK3_RETVAL buck3_init	(	buck3_t *	ctx,
		buck3_cfg_t *	cfg )

Initialization function.

Parameters

buck3	Click object.
cfg	Click configuration structure.

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

buck3_set_device_state()

void buck3_set_device_state	(	buck3_t *	ctx,
		uint8_t	state )

Function for setting chip mode.

Parameters

ctx	Click object.
state	Turns device ON or OFF

Note

Options:

  - ACTIVE mode
  - SLEEP mode