API for configuring and manipulating Buck 15 Click driver. More...

Topics
	Buck 15 Registers Settings
	Settings for registers of Buck 15 Click driver.

	Buck 15 MikroBUS Map
	MikroBUS pin mapping of Buck 15 Click driver.

Functions
void	buck15_cfg_setup (buck15_cfg_t *cfg)
	Buck 15 configuration object setup function.

err_t	buck15_init (buck15_t ctx, buck15_cfg_t cfg)
	Buck 15 initialization function.

err_t	buck15_default_cfg (buck15_t *ctx)
	Buck 15 default configuration function.

void	buck15_enable_device (buck15_t *ctx)
	Buck 15 enable device function.

void	buck15_disable_device (buck15_t *ctx)
	Buck 15 disable device function.

uint8_t	buck15_get_power_good (buck15_t *ctx)
	Buck 15 disable device function.

err_t	buck15_generic_write (buck15_t *ctx, uint8_t instr, uint8_t data_in)
	Buck 15 I2C writing function.

err_t	buck15_generic_read (buck15_t ctx, uint8_t instr, uint8_t data_out)
	Buck 15 I2C reading function.

err_t	buck15_set_vset (buck15_t *ctx, uint8_t vset_wp)
	Buck 15 set VSET function.

err_t	buck15_set_vos (buck15_t *ctx, uint8_t vos_wp)
	Buck 15 set VOS function.

err_t	buck15_set_vout (buck15_t *ctx, buck15_vout_t vout)
	Buck 15 set VOUT function.

Detailed Description

API for configuring and manipulating Buck 15 Click driver.

Any initialization code needed for MCU to function properly. Do not remove this line or clock might not be set correctly.

Function Documentation

◆ buck15_cfg_setup()

void buck15_cfg_setup ( buck15_cfg_t * cfg )

Buck 15 configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters

[out] cfg : Click configuration structure. See buck15_cfg_t object definition for detailed explanation.

Returns: Nothing.

Note: The all used pins will be set to unconnected state.

◆ buck15_default_cfg()

err_t buck15_default_cfg ( buck15_t * ctx )

Buck 15 default configuration function.

This function executes a default configuration of Buck 15 click board.

Parameters

[in] ctx : Click context object. See buck15_t object definition for detailed explanation.

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: This function can consist any necessary configuration or setting to put device into operating mode.

◆ buck15_disable_device()

void buck15_disable_device ( buck15_t * ctx )

Buck 15 disable device function.

This function disables the device by setting the EN pin to high logic state of the TPS62903, 3-V to 17-V, High Efficiency and Low IQ Buck Converter on the Buck 15 Click board.

Parameters

[in] ctx : Click context object. See buck15_t object definition for detailed explanation.

Returns: Nothing.

Note: None.

◆ buck15_enable_device()

void buck15_enable_device ( buck15_t * ctx )

Buck 15 enable device function.

This function enables the device by setting the EN pin to high logic state of the TPS62903, 3-V to 17-V, High Efficiency and Low IQ Buck Converter on the Buck 15 Click board.

Parameters

[in] ctx : Click context object. See buck15_t object definition for detailed explanation.

Returns: Nothing.

Note: None.

◆ buck15_generic_read()

err_t buck15_generic_read	(	buck15_t *	ctx,
		uint8_t	instr,
		uint8_t *	data_out )

Buck 15 I2C reading function.

This function reads a desired data bytes from the selected register by using I2C serial interface.

Parameters

[in]	ctx	: Click context object. See buck15_t object definition for detailed explanation.
[in]	instr	: Instruction Byte.
[out]	data_out	: Output read data.

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ buck15_generic_write()

err_t buck15_generic_write	(	buck15_t *	ctx,
		uint8_t	instr,
		uint8_t	data_in )

Buck 15 I2C writing function.

This function writes a data byte to the selected register by using I2C serial interface.

Parameters

[in]	ctx	: Click context object. See buck15_t object definition for detailed explanation.
[in]	instr	: Instruction Byte.
[in]	data_in	: Data to be written.

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ buck15_get_power_good()

uint8_t buck15_get_power_good ( buck15_t * ctx )

Buck 15 disable device function.

This function disables the device of the TPS62903, 3-V to 17-V, High Efficiency and Low IQ Buck Converter on the Buck 15 Click board.

Parameters

[in] ctx : Click context object. See buck15_t object definition for detailed explanation.

Returns: Nothing.

Note: None.

◆ buck15_init()

err_t buck15_init	(	buck15_t *	ctx,
		buck15_cfg_t *	cfg )

Buck 15 initialization function.

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

Parameters

[out]	ctx	: Click context object. See buck15_t object definition for detailed explanation.
[in]	cfg	: Click configuration structure. See buck15_cfg_t object definition for detailed explanation.

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ buck15_set_vos()

err_t buck15_set_vos	(	buck15_t *	ctx,
		uint8_t	vos_wp )

Buck 15 set VOS function.

This function sets the wiper position for the output voltage sense by using an I2C serial interface.

Parameters

[in]	ctx	: Click context object. See buck15_t object definition for detailed explanation.
[in]	vos_wp	: VOS wiper position.

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ buck15_set_vout()

err_t buck15_set_vout	(	buck15_t *	ctx,
		buck15_vout_t	vout )

Buck 15 set VOUT function.

This function sets the voltage output by using an I2C serial interface.

Parameters

[in]	ctx	: Click context object. See buck15_t object definition for detailed explanation.
[in]	vout	: Voltage output. See buck15_vout_t object definition for detailed explanation.

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ buck15_set_vset()

err_t buck15_set_vset	(	buck15_t *	ctx,
		uint8_t	vset_wp )

Buck 15 set VSET function.

This function sets the wiper position for the output voltage settings by using an I2C serial interface.

Parameters

[in]	ctx	: Click context object. See buck15_t object definition for detailed explanation.
[in]	vos_wp	: VSET wiper position.

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

Topics

Functions

Detailed Description

Function Documentation

◆ buck15_cfg_setup()

◆ buck15_default_cfg()

◆ buck15_disable_device()

◆ buck15_enable_device()

◆ buck15_generic_read()

◆ buck15_generic_write()

◆ buck15_get_power_good()

◆ buck15_init()

◆ buck15_set_vos()

◆ buck15_set_vout()

◆ buck15_set_vset()