ldo 2.1.0.0
ldo.h File Reference

This file contains API for LDO Click Driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_i2c_master.h"

Go to the source code of this file.

Data Structures

struct  ldo_t
 LDO Click context object. More...
 
struct  ldo_cfg_t
 LDO Click configuration object. More...
 

Macros

#define LDO_REG_INPUT_PORT   0x00
 LDO register list.
 
#define LDO_REG_OUTPUT_PORT   0x01
 
#define LDO_REG_POLARITY_INV   0x02
 
#define LDO_REG_CONFIG   0x03
 
#define LDO_PIN_NONE   0x00
 LDO pin mask values.
 
#define LDO_PIN_1600_mV   0x01
 
#define LDO_PIN_800_mV   0x02
 
#define LDO_PIN_400_mV   0x04
 
#define LDO_PIN_200_mV   0x08
 
#define LDO_PIN_100_mV   0x10
 
#define LDO_PIN_50_mV   0x20
 
#define LDO_PIN_ALL   0x3F
 
#define LDO_PIN_LOW   0
 LDO pin logic level setting.
 
#define LDO_PIN_OPEN   1
 
#define LDO_VOUT_MIN   800
 LDO VOUT settings.
 
#define LDO_VOUT_STEP   50
 
#define LDO_VOUT_MAX   3950
 
#define LDO_DEVICE_ADDRESS_0   0x38
 LDO device address setting.
 
#define LDO_DEVICE_ADDRESS_1   0x39
 
#define LDO_DEVICE_ADDRESS_2   0x3A
 
#define LDO_DEVICE_ADDRESS_3   0x3B
 
#define LDO_DEVICE_ADDRESS_4   0x3C
 
#define LDO_DEVICE_ADDRESS_5   0x3D
 
#define LDO_DEVICE_ADDRESS_6   0x3E
 
#define LDO_DEVICE_ADDRESS_7   0x3F
 
#define LDO_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping.
 

Enumerations

enum  ldo_return_value_t { LDO_OK = 0 , LDO_ERROR = -1 }
 LDO Click return value data. More...
 

Functions

void ldo_cfg_setup (ldo_cfg_t *cfg)
 LDO configuration object setup function.
 
err_t ldo_init (ldo_t *ctx, ldo_cfg_t *cfg)
 LDO initialization function.
 
err_t ldo_default_cfg (ldo_t *ctx)
 LDO default configuration function.
 
err_t ldo_write_register (ldo_t *ctx, uint8_t reg, uint8_t data_in)
 LDO write register function.
 
err_t ldo_read_register (ldo_t *ctx, uint8_t reg, uint8_t *data_out)
 LDO read register function.
 
err_t ldo_set_pin_state (ldo_t *ctx, uint8_t pin_mask, uint8_t state)
 LDO set pin state function.
 
err_t ldo_set_vout (ldo_t *ctx, uint16_t vout)
 LDO set vout function.
 
void ldo_enable_device (ldo_t *ctx)
 LDO enable device function.
 
void ldo_disable_device (ldo_t *ctx)
 LDO disable device function.
 

Detailed Description

This file contains API for LDO Click Driver.

Enumeration Type Documentation

◆ ldo_return_value_t

LDO Click return value data.

Predefined enum values for driver return values.

Enumerator
LDO_OK 
LDO_ERROR