buck15
2.1.0.0
|
API for configuring and manipulating Buck 15 Click driver. More...
Modules | |
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. More... | |
err_t | buck15_init (buck15_t *ctx, buck15_cfg_t *cfg) |
Buck 15 initialization function. More... | |
err_t | buck15_default_cfg (buck15_t *ctx) |
Buck 15 default configuration function. More... | |
void | buck15_enable_device (buck15_t *ctx) |
Buck 15 enable device function. More... | |
void | buck15_disable_device (buck15_t *ctx) |
Buck 15 disable device function. More... | |
uint8_t | buck15_get_power_good (buck15_t *ctx) |
Buck 15 disable device function. More... | |
err_t | buck15_generic_write (buck15_t *ctx, uint8_t instr, uint8_t data_in) |
Buck 15 I2C writing function. More... | |
err_t | buck15_generic_read (buck15_t *ctx, uint8_t instr, uint8_t *data_out) |
Buck 15 I2C reading function. More... | |
err_t | buck15_set_vset (buck15_t *ctx, uint8_t vset_wp) |
Buck 15 set VSET function. More... | |
err_t | buck15_set_vos (buck15_t *ctx, uint8_t vos_wp) |
Buck 15 set VOS function. More... | |
err_t | buck15_set_vout (buck15_t *ctx, buck15_vout_t vout) |
Buck 15 set VOUT function. More... | |
API for configuring and manipulating Buck 15 Click driver.
void buck15_cfg_setup | ( | buck15_cfg_t * | cfg | ) |
Buck 15 configuration object setup function.
This function initializes click configuration structure to initial values.
[out] | cfg | : Click configuration structure. See buck15_cfg_t object definition for detailed explanation. |
err_t buck15_default_cfg | ( | buck15_t * | ctx | ) |
Buck 15 default configuration function.
This function executes a default configuration of Buck 15 click board.
[in] | ctx | : Click context object. See buck15_t object definition for detailed explanation. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. 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.
[in] | ctx | : Click context object. See buck15_t object definition for detailed explanation. |
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.
[in] | ctx | : Click context object. See buck15_t object definition for detailed explanation. |
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.
[in] | ctx | : Click context object. See buck15_t object definition for detailed explanation. |
[in] | instr | : Instruction Byte. |
[out] | data_out | : Output read data. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. 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.
[in] | ctx | : Click context object. See buck15_t object definition for detailed explanation. |
[in] | instr | : Instruction Byte. |
[in] | data_in | : Data to be written. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. 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.
[in] | ctx | : Click context object. See buck15_t object definition for detailed explanation. |
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.
[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. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. 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.
[in] | ctx | : Click context object. See buck15_t object definition for detailed explanation. |
[in] | vos_wp | : VOS wiper position. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. 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.
[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. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. 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.
[in] | ctx | : Click context object. See buck15_t object definition for detailed explanation. |
[in] | vos_wp | : VSET wiper position. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation.