powermux3 2.2.0
Loading...
Searching...
No Matches
Power MUX 3 Click Driver

API for configuring and manipulating Power MUX 3 Click driver. More...

Topics

 Power MUX 3 MikroBUS Map
 MikroBUS pin mapping of Power MUX 3 Click driver.

Functions

void powermux3_cfg_setup (powermux3_cfg_t *cfg)
 Power MUX 3 configuration object setup function.
err_t powermux3_init (powermux3_t *ctx, powermux3_cfg_t *cfg)
 Power MUX 3 initialization function.
void powermux3_enable_device (powermux3_t *ctx)
 Power MUX 3 enable device function.
void powermux3_disable_device (powermux3_t *ctx)
 Power MUX 3 disable device function.
void powermux3_enable_output (powermux3_t *ctx)
 Power MUX 3 enable output function.
void powermux3_disable_output (powermux3_t *ctx)
 Power MUX 3 disable output function.

Detailed Description

API for configuring and manipulating Power MUX 3 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

◆ powermux3_cfg_setup()

void powermux3_cfg_setup ( powermux3_cfg_t * cfg)

Power MUX 3 configuration object setup function.

This function initializes Click configuration structure to initial values.

Parameters
[out]cfg: Click configuration structure. See powermux3_cfg_t object definition for detailed explanation.
Returns
Nothing.
Note
The all used pins will be set to unconnected state.

◆ powermux3_disable_device()

void powermux3_disable_device ( powermux3_t * ctx)

Power MUX 3 disable device function.

This function disables the device by setting the SHD pin to LOW on the Power MUX 3 Click board.

Parameters
[in]ctx: Click context object. See powermux3_t object definition for detailed explanation.
Returns
None.
Note
None.

◆ powermux3_disable_output()

void powermux3_disable_output ( powermux3_t * ctx)

Power MUX 3 disable output function.

This function disables the output by setting the EN pin to LOW on the Power MUX 3 Click board.

Parameters
[in]ctx: Click context object. See powermux3_t object definition for detailed explanation.
Returns
None.
Note
None.

◆ powermux3_enable_device()

void powermux3_enable_device ( powermux3_t * ctx)

Power MUX 3 enable device function.

This function enables the device by setting the SHD pin to HIGH on the Power MUX 3 Click board.

Parameters
[in]ctx: Click context object. See powermux3_t object definition for detailed explanation.
Returns
None.
Note
None.

◆ powermux3_enable_output()

void powermux3_enable_output ( powermux3_t * ctx)

Power MUX 3 enable output function.

This function enables the output by setting the EN pin to HIGH on the Power MUX 3 Click board.

Parameters
[in]ctx: Click context object. See powermux3_t object definition for detailed explanation.
Returns
None.
Note
None.

◆ powermux3_init()

err_t powermux3_init ( powermux3_t * ctx,
powermux3_cfg_t * cfg )

Power MUX 3 initialization function.

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

Parameters
[out]ctx: Click context object. See powermux3_t object definition for detailed explanation.
[in]cfg: Click configuration structure. See powermux3_cfg_t object definition for detailed explanation.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.