Public function

Functions
void	boostinv_cfg_setup (boostinv_cfg_t *cfg)
	Config Object Initialization function.
BOOSTINV_RETVAL	boostinv_init (boostinv_t *ctx, boostinv_cfg_t *cfg)
	Initialization function.
void	boostinv_default_cfg (boostinv_t *ctx)
	Click Default Configuration function.
void	boostinv_generic_write (boostinv_t *ctx, uint8_t reg_addr, uint8_t tx_data)
	Functions for write one byte in register.
uint8_t	boostinv_generic_read (boostinv_t *ctx, uint8_t reg_addr)
	Generic read function.
void	boostinv_enable (boostinv_t *ctx)
	Functions for enable chip.
void	boostinv_set_positive_voltage (boostinv_t *ctx, uint16_t voltage)
	Functions for set positive output voltage.
void	boostinv_set_negative_voltage (boostinv_t *ctx, int16_t voltage)
	Functions for set negative output voltage.

Detailed Description

Function Documentation

boostinv_cfg_setup()

void boostinv_cfg_setup

(

boostinv_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.

boostinv_default_cfg()

void boostinv_default_cfg

(

boostinv_t *

ctx

)

Click Default Configuration function.

Parameters

ctx	Click object.

@description This function executes default configuration for BoostInv click.

Note

Click default configuration:

   1) Enable Boost Inv

   2) Configuration:

   BOOSTINV_REG_CONFIG
-------------------------------------------------
   BOOSTINV_CFG_PUSEQ_VOUTP_RAMP_1ST

BOOSTINV_REG_COMMAND

   BOOSTINV_CMD_REGISTER_SELECT_POS_VOUT
   BOOSTINV_CMD_REGISTER_SELECT_NEG_VOUT
   BOOSTINV_CMD_REGISTER_SELECT_CONFIG

boostinv_enable()

void boostinv_enable

(

boostinv_t *

ctx

)

Functions for enable chip.

Parameters

ctx	Click object.

@description This function enable chip device for Boost INV click.

boostinv_generic_read()

uint8_t boostinv_generic_read	(	boostinv_t *	ctx,
		uint8_t	reg_addr )

Generic read function.

Parameters

ctx	Click object.
reg_addr	Register address.

Returns

uint8_t read data.

@description This function reads the byte of data from the desired register.

boostinv_generic_write()

void boostinv_generic_write	(	boostinv_t *	ctx,
		uint8_t	reg_addr,
		uint8_t	tx_data )

Functions for write one byte in register.

Parameters

ctx	Click object.
reg_addr	Register in which the data will be written.
tx_data	Data which be written in the register.

@description This function write the byte of data to the desired register.

boostinv_init()

BOOSTINV_RETVAL boostinv_init	(	boostinv_t *	ctx,
		boostinv_cfg_t *	cfg )

Initialization function.

Parameters

boostinv	Click object.
cfg	Click configuration structure.

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

boostinv_set_negative_voltage()

void boostinv_set_negative_voltage	(	boostinv_t *	ctx,
		int16_t	voltage )

Functions for set negative output voltage.

Parameters

ctx	Click object.
voltage	Voltage that will be set

@description Negative output voltage goes from -1200mV to -13950mV with a step of 50mV.

boostinv_set_positive_voltage()

void boostinv_set_positive_voltage	(	boostinv_t *	ctx,
		uint16_t	voltage )

Functions for set positive output voltage.

Parameters

ctx	Click object.
voltage	Voltage that will be set

@description Positive output voltage goes from 3200mV to 12750mV with a step of 50mV.