no-OS
•All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
Classes | Macros | Enumerations | Functions
ltc4296.h File Reference

Header file for the LTC4296 Driver. More...

#include <stdint.h>
#include "no_os_util.h"
#include "no_os_spi.h"
#include "no_os_gpio.h"
Include dependency graph for ltc4296.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  ltc4296_dev
 Device Structure. More...
 
struct  ltc4296_init_param
 Initialization Structure. More...
 

Macros

#define LTC4296_REG_GFLTEV   0x02
 
#define LTC4296_REG_GFLTMSK   0x03
 
#define LTC4296_REG_GCAP   0x06
 
#define LTC4296_REG_GIOST   0x07
 
#define LTC4296_REG_GCMD   0x08
 
#define LTC4296_REG_GCFG   0x09
 
#define LTC4296_REG_GADCCFG   0x0A
 
#define LTC4296_REG_GADCDAT   0x0B
 
#define LTC4296_REG_P0EV   0x10
 
#define LTC4296_REG_P0ST   0x12
 
#define LTC4296_REG_P0CFG0   0x13
 
#define LTC4296_REG_P0CFG1   0x14
 
#define LTC4296_REG_P0ADCCFG   0x15
 
#define LTC4296_REG_P0ADCDAT   0x16
 
#define LTC4296_REG_P0SELFTEST   0x17
 
#define LTC4296_REG_P1EV   0x20
 
#define LTC4296_REG_P1ST   0x22
 
#define LTC4296_REG_P1CFG0   0x23
 
#define LTC4296_REG_P1CFG1   0x24
 
#define LTC4296_REG_P1ADCCFG   0x25
 
#define LTC4296_REG_P1ADCDAT   0x26
 
#define LTC4296_REG_P1SELFTEST   0x27
 
#define LTC4296_REG_P2EV   0x30
 
#define LTC4296_REG_P2ST   0x32
 
#define LTC4296_REG_P2CFG0   0x33
 
#define LTC4296_REG_P2CFG1   0x34
 
#define LTC4296_REG_P2ADCCFG   0x35
 
#define LTC4296_REG_P2ADCDAT   0x36
 
#define LTC4296_REG_P2SELFTEST   0x37
 
#define LTC4296_REG_P3EV   0x40
 
#define LTC4296_REG_P3ST   0x42
 
#define LTC4296_REG_P3CFG0   0x43
 
#define LTC4296_REG_P3CFG1   0x44
 
#define LTC4296_REG_P3ADCCFG   0x45
 
#define LTC4296_REG_P3ADCDAT   0x46
 
#define LTC4296_REG_P3SELFTEST   0x47
 
#define LTC4296_REG_P4EV   0x50
 
#define LTC4296_REG_P4ST   0x52
 
#define LTC4296_REG_P4CFG0   0x53
 
#define LTC4296_REG_P4CFG1   0x54
 
#define LTC4296_REG_P4ADCCFG   0x55
 
#define LTC4296_REG_P4ADCDAT   0x56
 
#define LTC4296_REG_P4SELFTEST   0x57
 
#define LTC4296_UVLO_DIGITAL_MSK   NO_OS_BIT(4)
 
#define LTC4296_COMMAND_FAULT_MSK   NO_OS_BIT(3)
 
#define LTC4296_PEC_FAULT_MSK   NO_OS_BIT(2)
 
#define LTC4296_MEMORY_FAULT_MSK   NO_OS_BIT(1)
 
#define LTC4296_LOW_CKT_BRK_FAULT_MSK   NO_OS_BIT(0)
 
#define LTC4296_SCCP_SUPPORT_MSK   NO_OS_BIT(6)
 
#define LTC4296_WAKE_FWD_SUPPORT_MSK   NO_OS_BIT(5)
 
#define LTC4296_NUMPORTS_MSK   NO_OS_GENMASK(4, 0)
 
#define LTC4296_PG_OUT4_MSK   NO_OS_BIT(8)
 
#define LTC4296_PG_OUT3_MSK   NO_OS_BIT(7)
 
#define LTC4296_PG_OUT2_MSK   NO_OS_BIT(6)
 
#define LTC4296_PG_OUT1_MSK   NO_OS_BIT(5)
 
#define LTC4296_PG_OUT0_MSK   NO_OS_BIT(4)
 
#define LTC4296_PAD_AUTO_MSK   NO_OS_BIT(3)
 
#define LTC4296_PAD_WAKEUP_MSK   NO_OS_BIT(2)
 
#define LTC4296_PAD_WAKEUP_DRIVE_MSK   NO_OS_BIT(1)
 
#define LTC4296_SW_RESET_MSK   NO_OS_GENMASK(15, 8)
 
#define LTC4296_WRITE_PROTECT_MSK   NO_OS_GENMASK(7, 0)
 
#define LTC4296_MASK_LOWFAULT_MSK   NO_OS_BIT(5)
 
#define LTC4296_TLIM_DISABLE_MSK   NO_OS_BIT(4)
 
#define LTC4296_TLIM_TIMER_SLEEP_MSK   NO_OS_GENMASK(3, 2)
 
#define LTC4296_REFRESH_MSK   NO_OS_BIT(1)
 
#define LTC4296_SW_VIN_PGOOD_MSK   NO_OS_BIT(0)
 
#define LTC4296_GADC_SAMPLE_MODE_MSK   NO_OS_GENMASK(6, 5)
 
#define LTC4296_GADC_SEL_MSK   NO_OS_GENMASK(4, 0)
 
#define LTC4296_GADC_MISSED_MSK   NO_OS_BIT(13)
 
#define LTC4296_GADC_NEW_MSK   NO_OS_BIT(12)
 
#define LTC4296_GADC_MSK   NO_OS_GENMASK(11, 0)
 
#define LTC4296_VALID_SIGNATURE_MSK   NO_OS_BIT(9)
 
#define LTC4296_INVALID_SIGNATURE_MSK   NO_OS_BIT(8)
 
#define LTC4296_TOFF_TIMER_DONE_MSK   NO_OS_BIT(7)
 
#define LTC4296_OVERLOAD_DETECTED_ISLEEP_MSK   NO_OS_BIT(6)
 
#define LTC4296_OVERLOAD_DETECTED_IPOWERED_MSK   NO_OS_BIT(5)
 
#define LTC4296_MFVS_TIMEOUT_MSK   NO_OS_BIT(4)
 
#define LTC4296_TINRUSH_TIMER_DONE_MSK   NO_OS_BIT(3)
 
#define LTC4296_PD_WAKEUP_MSK   NO_OS_BIT(2)
 
#define LTC4296_LSNS_FORWARD_FAULT_MSK   NO_OS_BIT(1)
 
#define LTC4296_LSNS_REVERSE_FAULT_MSK   NO_OS_BIT(0)
 
#define LTC4296_DET_VHIGH_MSK   NO_OS_BIT(13)
 
#define LTC4296_DET_VLOW_MSK   NO_OS_BIT(12)
 
#define LTC4296_POWER_STABLE_HI_MSK   NO_OS_BIT(11)
 
#define LTC4296_POWER_STABLE_LO_MSK   NO_OS_BIT(10)
 
#define LTC4296_POWER_STABLE_MSK   NO_OS_BIT(9)
 
#define LTC4296_OVERLOAD_HELD_MSK   NO_OS_BIT(8)
 
#define LTC4296_PI_SLEEPING_MSK   NO_OS_BIT(7)
 
#define LTC4296_PI_PREBIASED_MSK   NO_OS_BIT(6)
 
#define LTC4296_PI_DETECTING_MSK   NO_OS_BIT(5)
 
#define LTC4296_PI_POWERED_MSK   NO_OS_BIT(4)
 
#define LTC4296_PI_DISCHARGE_EN_MSK   NO_OS_BIT(3)
 
#define LTC4296_PSE_STATUS_MSK   NO_OS_GENMASK(2, 0)
 
#define LTC4296_SW_INRUSH_MSK   NO_OS_BIT(15)
 
#define LTC4296_END_CLASSIFICATION_MSK   NO_OS_BIT(14)
 
#define LTC4296_SET_CLASSIFICATION_MODE_MSK   NO_OS_BIT(13)
 
#define LTC4296_DISABLE_DETECTION_PULLUP_MSK   NO_OS_BIT(12)
 
#define LTC4296_TDET_DISABLE_MSK   NO_OS_BIT(11)
 
#define LTC4296_FOLDBACK_DISABLE_MSK   NO_OS_BIT(10)
 
#define LTC4296_SOFT_START_DISABLE_MSK   NO_OS_BIT(9)
 
#define LTC4296_TOFF_TIMER_DISABLE_MSK   NO_OS_BIT(8)
 
#define LTC4296_TMFVDO_TIMER_DISABLE_MSK   NO_OS_BIT(7)
 
#define LTC4296_SW_PSE_READY_MSK   NO_OS_BIT(6)
 
#define LTC4296_SW_POWER_AVAILABLE_MSK   NO_OS_BIT(5)
 
#define LTC4296_UPSTREAM_WAKEUP_DISABLE_MSK   NO_OS_BIT(4)
 
#define LTC4296_DOWNSTREAM_WAKEUP_DISABLE_MSK   NO_OS_BIT(3)
 
#define LTC4296_SW_PSE_WAKEUP_MSK   NO_OS_BIT(2)
 
#define LTC4296_HW_EN_MASK_MSK   NO_OS_BIT(1)
 
#define LTC4296_SW_EN_MSK   NO_OS_BIT(0)
 
#define LTC4296_PREBIAS_OVERRIDE_GOOD_MSK   NO_OS_BIT(8)
 
#define LTC4296_TLIM_TIMER_TOP_MSK   NO_OS_GENMASK(7, 6)
 
#define LTC4296_TOD_TRESTART_TIMER_MSK   NO_OS_GENMASK(5, 4)
 
#define LTC4296_TINRUSH_TIMER_MSK   NO_OS_GENMASK(3, 2)
 
#define LTC4296_SIG_OVERRIDE_BAD_MSK   NO_OS_BIT(1)
 
#define LTC4296_SIG_OVERRIDE_GOOD_MSK   NO_OS_BIT(0)
 
#define LTC4296_MFVS_THRESHOLD_MSK   NO_OS_GENMASK(7, 0)
 
#define LTC4296_MISSED_MSK   NO_OS_BIT(13)
 
#define LTC4296_NEW_MSK   NO_OS_BIT(12)
 
#define LTC4296_SOURCE_CURRENT_MSK   NO_OS_GENMASK(11, 0)
 
#define LTC4296_SPI_READ   0x01
 
#define LTC4296_SPI_WRITE   0x00
 
#define LTC4296_RESET_CODE   0x73
 
#define LTC4296_UNLOCK_KEY   0x05
 
#define LTC4296_LOCK_KEY   0xA0
 
#define LTC4296_ADC_OFFSET   2049
 
#define LTC4296_VGAIN   35230 / 1000
 
#define LTC4296_IGAIN   1 / 10
 
#define LTC4296_VMAX   1
 
#define LTC4296_VMIN   0
 
#define LTC4296_MAX_PORTS   5
 
#define RTESTLOAD   200 /*(ohm)*/
 

Enumerations

enum  ltc4296_state {
  LTC_UNLOCKED = 0 ,
  LTC_LOCKED
}
 Device State. More...
 
enum  ltc4296_port {
  LTC_PORT0 = 0 ,
  LTC_PORT1 ,
  LTC_PORT2 ,
  LTC_PORT3 ,
  LTC_PORT4 ,
  LTC_NO_PORT
}
 Device Port Numbers. More...
 
enum  ltc4296_port_status {
  LTC_PORT_DISABLED = 0 ,
  LTC_PORT_ENABLED
}
 Device Port Status. More...
 
enum  ltc4296_pse_status {
  LTC_PSE_STATUS_DISABLED = 0 ,
  LTC_PSE_STATUS_SLEEPING ,
  LTC_PSE_STATUS_DELIVERING ,
  LTC_PSE_STATUS_SEARCHING ,
  LTC_PSE_STATUS_ERROR ,
  LTC_PSE_STATUS_IDLE ,
  LTC_PSE_STATUS_PREPDET ,
  LTC_PSE_STATUS_UNKNOWN
}
 Device PSE Status. More...
 
enum  ltc4296_board_class {
  SPOE_CLASS10 = 0 ,
  SPOE_CLASS11 ,
  SPOE_CLASS12 ,
  SPOE_CLASS13 ,
  SPOE_CLASS14 ,
  SPOE_CLASS15 ,
  APL_CLASSA ,
  APL_CLASSA_NOAUTONEG ,
  APL_CLASSC ,
  APL_CLASS3 ,
  PRODUCTION_POWER_TEST ,
  APL_CLASSA_OLD_DEMO ,
  SPOE_OFF ,
  PRODUCTION_DATA_TEST ,
  RESERVED ,
  DEBUGMODE
}
 Board Classes. More...
 
enum  ltc4296_config {
  LTC_CFG_SCCP_MODE = 0 ,
  LTC_CFG_APL_MODE ,
  LTC_CFG_RESET
}
 Device Configuration Modes. More...
 
enum  ltc4296_port_reg_offset_e {
  LTC_PORT_EVENTS = 0 ,
  LTC_PORT_STATUS = 2 ,
  LTC_PORT_CFG0 = 3 ,
  LTC_PORT_CFG1 = 4 ,
  LTC_PORT_ADCCFG = 5 ,
  LTC_PORT_ADCDAT = 6 ,
  LTC_PORT_SELFTEST = 7
}
 Device Port Register offsets. More...
 
enum  adi_ltc_result {
  ADI_LTC_SUCCESS = 0 ,
  ADI_LTC_DISCONTINUE_SCCP ,
  ADI_LTC_SCCP_COMPLETE ,
  ADI_LTC_SCCP_PD_DETECTION_FAILED ,
  ADI_LTC_SCCP_PD_NOT_PRESENT ,
  ADI_LTC_SCCP_PD_RES_INVALID ,
  ADI_LTC_SCCP_PD_PRESENT ,
  ADI_LTC_SCCP_PD_CLASS_COMPATIBLE ,
  ADI_LTC_SCCP_PD_CLASS_NOT_SUPPORTED ,
  ADI_LTC_SCCP_PD_CLASS_NOT_COMPATIBLE ,
  ADI_LTC_SCCP_PD_LINE_NOT_HIGH ,
  ADI_LTC_SCCP_PD_LINE_NOT_LOW ,
  ADI_LTC_SCCP_PD_CRC_FAILED ,
  ADI_LTC_APL_COMPLETE ,
  ADI_LTC_DISCONTINUE_APL ,
  ADI_LTC_INVALID_ADC_VOLTAGE ,
  ADI_LTC_INVALID_ADC_PORT_CURRENT ,
  ADI_LTC_TEST_COMPLETE ,
  ADI_LTC_DISCONTINUE_TEST ,
  ADI_LTC_TEST_FAILED ,
  ADI_LTC_INVALID_VIN
}
 Device Result Codes. More...
 

Functions

int ltc4296_reg_write (struct ltc4296_dev *dev, uint8_t reg, uint16_t data)
 Register Write.
 
int ltc4296_reg_read (struct ltc4296_dev *dev, uint8_t reg, uint16_t *data)
 Register Read.
 
int ltc4296_reset (struct ltc4296_dev *dev)
 Software reset.
 
int ltc4296_get_port_addr (enum ltc4296_port port_no, enum ltc4296_port_reg_offset_e port_offset, uint8_t *port_addr)
 Get port address.
 
int ltc4296_clear_global_faults (struct ltc4296_dev *dev)
 Clear global faults.
 
int ltc4296_clear_ckt_breaker (struct ltc4296_dev *dev)
 Clear circuit break faults.
 
int ltc4296_read_global_faults (struct ltc4296_dev *dev, uint16_t *g_events)
 Read global faults.
 
int ltc4296_unlock (struct ltc4296_dev *dev)
 Device unlock.
 
int ltc4296_is_locked (struct ltc4296_dev *dev, enum ltc4296_state *state)
 Check device state.
 
int ltc4296_read_gadc (struct ltc4296_dev *dev, int *port_voltage_mv)
 Read global ADC.
 
int ltc4296_set_gadc_vin (struct ltc4296_dev *dev)
 Set the global ADC to measure voltage.
 
int ltc4296_is_vin_valid (struct ltc4296_dev *dev, int port_vin_mv, enum ltc4296_board_class ltcboard_class, bool *vin_valid)
 Check if input voltage is valid.
 
int ltc4296_is_vout_valid (struct ltc4296_dev *dev, int port_vout_mv, enum ltc4296_board_class ltcboard_class, bool *vout_valid)
 Check if output voltage is valid.
 
int ltc4296_disable_gadc (struct ltc4296_dev *dev)
 Disable the global ADC.
 
int ltc4296_read_port_events (struct ltc4296_dev *dev, enum ltc4296_port port_no, uint16_t *port_events)
 Read Port Events.
 
int ltc4296_clear_port_events (struct ltc4296_dev *dev, enum ltc4296_port port_no)
 Clear Port Events.
 
int ltc4296_read_port_status (struct ltc4296_dev *dev, enum ltc4296_port port_no, uint16_t *port_status)
 Read Port Status.
 
int ltc4296_is_port_disabled (struct ltc4296_dev *dev, enum ltc4296_port port_no, enum ltc4296_port_status *port_chk)
 Check if port is enabled/disabled.
 
int ltc4296_port_disable (struct ltc4296_dev *dev, enum ltc4296_port port_no)
 Check if port is disabled.
 
int ltc4296_is_port_deliver_pwr (struct ltc4296_dev *dev, enum ltc4296_port port_no, enum ltc4296_pse_status *pwr_status)
 Check if port delivers power.
 
int ltc4296_is_port_pwr_stable (struct ltc4296_dev *dev, enum ltc4296_port port_no, bool *pwr_status)
 Check if port has stable power.
 
int ltc4296_read_port_adc (struct ltc4296_dev *dev, enum ltc4296_port port_no, int *port_i_out_ma)
 Read port ADC.
 
int ltc4296_port_prebias (struct ltc4296_dev *dev, enum ltc4296_port port_no, enum ltc4296_config mode)
 Stimulate valid wake-up signature for a port.
 
int ltc4296_port_en (struct ltc4296_dev *dev, enum ltc4296_port port_no)
 Enable specific port.
 
int ltc4296_port_en_and_classification (struct ltc4296_dev *dev, enum ltc4296_port port_no)
 Enable specific port and classify.
 
int ltc4296_set_port_mfvs (struct ltc4296_dev *dev, enum ltc4296_port port_no)
 Set port to maintain full voltage signature.
 
int ltc4296_set_port_pwr (struct ltc4296_dev *dev, enum ltc4296_port port_no)
 Set port to power mode.
 
int ltc4296_force_port_pwr (struct ltc4296_dev *dev, enum ltc4296_port port_no)
 Force port to power mode.
 
int ltc4296_port_pwr_available (struct ltc4296_dev *dev, enum ltc4296_port port_no)
 Set port is able to source power.
 
int ltc4296_set_gadc_vout (struct ltc4296_dev *dev, enum ltc4296_port port_no)
 Configure Global ADC to read output voltage.
 
int ltc4296_print_global_faults (uint16_t g_events)
 Print global faults.
 
int ltc4296_print_port_events (enum ltc4296_port port_no, uint16_t port_events)
 Print port events.
 
int ltc4296_chk_global_events (struct ltc4296_dev *dev)
 Check global events.
 
int ltc4296_chk_port_events (struct ltc4296_dev *dev, enum ltc4296_port ltc4296_port)
 
int ltc4296_init (struct ltc4296_dev **device, struct ltc4296_init_param *init_param)
 Device initialization.
 
int ltc4296_remove (struct ltc4296_dev *dev)
 Free allocated resources.
 

Detailed Description

Header file for the LTC4296 Driver.

Author
Antoniu Miclaus (anton.nosp@m.iu.m.nosp@m.iclau.nosp@m.s@an.nosp@m.alog..nosp@m.com)

Copyright 2024(c) Analog Devices, Inc.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
  3. Neither the name of Analog Devices, Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES, INC. “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL ANALOG DEVICES, INC. BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Macro Definition Documentation

◆ LTC4296_ADC_OFFSET

#define LTC4296_ADC_OFFSET   2049

◆ LTC4296_COMMAND_FAULT_MSK

#define LTC4296_COMMAND_FAULT_MSK   NO_OS_BIT(3)

◆ LTC4296_DET_VHIGH_MSK

#define LTC4296_DET_VHIGH_MSK   NO_OS_BIT(13)

◆ LTC4296_DET_VLOW_MSK

#define LTC4296_DET_VLOW_MSK   NO_OS_BIT(12)

◆ LTC4296_DISABLE_DETECTION_PULLUP_MSK

#define LTC4296_DISABLE_DETECTION_PULLUP_MSK   NO_OS_BIT(12)

◆ LTC4296_DOWNSTREAM_WAKEUP_DISABLE_MSK

#define LTC4296_DOWNSTREAM_WAKEUP_DISABLE_MSK   NO_OS_BIT(3)

◆ LTC4296_END_CLASSIFICATION_MSK

#define LTC4296_END_CLASSIFICATION_MSK   NO_OS_BIT(14)

◆ LTC4296_FOLDBACK_DISABLE_MSK

#define LTC4296_FOLDBACK_DISABLE_MSK   NO_OS_BIT(10)

◆ LTC4296_GADC_MISSED_MSK

#define LTC4296_GADC_MISSED_MSK   NO_OS_BIT(13)

◆ LTC4296_GADC_MSK

#define LTC4296_GADC_MSK   NO_OS_GENMASK(11, 0)

◆ LTC4296_GADC_NEW_MSK

#define LTC4296_GADC_NEW_MSK   NO_OS_BIT(12)

◆ LTC4296_GADC_SAMPLE_MODE_MSK

#define LTC4296_GADC_SAMPLE_MODE_MSK   NO_OS_GENMASK(6, 5)

◆ LTC4296_GADC_SEL_MSK

#define LTC4296_GADC_SEL_MSK   NO_OS_GENMASK(4, 0)

◆ LTC4296_HW_EN_MASK_MSK

#define LTC4296_HW_EN_MASK_MSK   NO_OS_BIT(1)

◆ LTC4296_IGAIN

#define LTC4296_IGAIN   1 / 10

◆ LTC4296_INVALID_SIGNATURE_MSK

#define LTC4296_INVALID_SIGNATURE_MSK   NO_OS_BIT(8)

◆ LTC4296_LOCK_KEY

#define LTC4296_LOCK_KEY   0xA0

◆ LTC4296_LOW_CKT_BRK_FAULT_MSK

#define LTC4296_LOW_CKT_BRK_FAULT_MSK   NO_OS_BIT(0)

◆ LTC4296_LSNS_FORWARD_FAULT_MSK

#define LTC4296_LSNS_FORWARD_FAULT_MSK   NO_OS_BIT(1)

◆ LTC4296_LSNS_REVERSE_FAULT_MSK

#define LTC4296_LSNS_REVERSE_FAULT_MSK   NO_OS_BIT(0)

◆ LTC4296_MASK_LOWFAULT_MSK

#define LTC4296_MASK_LOWFAULT_MSK   NO_OS_BIT(5)

◆ LTC4296_MAX_PORTS

#define LTC4296_MAX_PORTS   5

◆ LTC4296_MEMORY_FAULT_MSK

#define LTC4296_MEMORY_FAULT_MSK   NO_OS_BIT(1)

◆ LTC4296_MFVS_THRESHOLD_MSK

#define LTC4296_MFVS_THRESHOLD_MSK   NO_OS_GENMASK(7, 0)

◆ LTC4296_MFVS_TIMEOUT_MSK

#define LTC4296_MFVS_TIMEOUT_MSK   NO_OS_BIT(4)

◆ LTC4296_MISSED_MSK

#define LTC4296_MISSED_MSK   NO_OS_BIT(13)

◆ LTC4296_NEW_MSK

#define LTC4296_NEW_MSK   NO_OS_BIT(12)

◆ LTC4296_NUMPORTS_MSK

#define LTC4296_NUMPORTS_MSK   NO_OS_GENMASK(4, 0)

◆ LTC4296_OVERLOAD_DETECTED_IPOWERED_MSK

#define LTC4296_OVERLOAD_DETECTED_IPOWERED_MSK   NO_OS_BIT(5)

◆ LTC4296_OVERLOAD_DETECTED_ISLEEP_MSK

#define LTC4296_OVERLOAD_DETECTED_ISLEEP_MSK   NO_OS_BIT(6)

◆ LTC4296_OVERLOAD_HELD_MSK

#define LTC4296_OVERLOAD_HELD_MSK   NO_OS_BIT(8)

◆ LTC4296_PAD_AUTO_MSK

#define LTC4296_PAD_AUTO_MSK   NO_OS_BIT(3)

◆ LTC4296_PAD_WAKEUP_DRIVE_MSK

#define LTC4296_PAD_WAKEUP_DRIVE_MSK   NO_OS_BIT(1)

◆ LTC4296_PAD_WAKEUP_MSK

#define LTC4296_PAD_WAKEUP_MSK   NO_OS_BIT(2)

◆ LTC4296_PD_WAKEUP_MSK

#define LTC4296_PD_WAKEUP_MSK   NO_OS_BIT(2)

◆ LTC4296_PEC_FAULT_MSK

#define LTC4296_PEC_FAULT_MSK   NO_OS_BIT(2)

◆ LTC4296_PG_OUT0_MSK

#define LTC4296_PG_OUT0_MSK   NO_OS_BIT(4)

◆ LTC4296_PG_OUT1_MSK

#define LTC4296_PG_OUT1_MSK   NO_OS_BIT(5)

◆ LTC4296_PG_OUT2_MSK

#define LTC4296_PG_OUT2_MSK   NO_OS_BIT(6)

◆ LTC4296_PG_OUT3_MSK

#define LTC4296_PG_OUT3_MSK   NO_OS_BIT(7)

◆ LTC4296_PG_OUT4_MSK

#define LTC4296_PG_OUT4_MSK   NO_OS_BIT(8)

◆ LTC4296_PI_DETECTING_MSK

#define LTC4296_PI_DETECTING_MSK   NO_OS_BIT(5)

◆ LTC4296_PI_DISCHARGE_EN_MSK

#define LTC4296_PI_DISCHARGE_EN_MSK   NO_OS_BIT(3)

◆ LTC4296_PI_POWERED_MSK

#define LTC4296_PI_POWERED_MSK   NO_OS_BIT(4)

◆ LTC4296_PI_PREBIASED_MSK

#define LTC4296_PI_PREBIASED_MSK   NO_OS_BIT(6)

◆ LTC4296_PI_SLEEPING_MSK

#define LTC4296_PI_SLEEPING_MSK   NO_OS_BIT(7)

◆ LTC4296_POWER_STABLE_HI_MSK

#define LTC4296_POWER_STABLE_HI_MSK   NO_OS_BIT(11)

◆ LTC4296_POWER_STABLE_LO_MSK

#define LTC4296_POWER_STABLE_LO_MSK   NO_OS_BIT(10)

◆ LTC4296_POWER_STABLE_MSK

#define LTC4296_POWER_STABLE_MSK   NO_OS_BIT(9)

◆ LTC4296_PREBIAS_OVERRIDE_GOOD_MSK

#define LTC4296_PREBIAS_OVERRIDE_GOOD_MSK   NO_OS_BIT(8)

◆ LTC4296_PSE_STATUS_MSK

#define LTC4296_PSE_STATUS_MSK   NO_OS_GENMASK(2, 0)

◆ LTC4296_REFRESH_MSK

#define LTC4296_REFRESH_MSK   NO_OS_BIT(1)

◆ LTC4296_REG_GADCCFG

#define LTC4296_REG_GADCCFG   0x0A

◆ LTC4296_REG_GADCDAT

#define LTC4296_REG_GADCDAT   0x0B

◆ LTC4296_REG_GCAP

#define LTC4296_REG_GCAP   0x06

◆ LTC4296_REG_GCFG

#define LTC4296_REG_GCFG   0x09

◆ LTC4296_REG_GCMD

#define LTC4296_REG_GCMD   0x08

◆ LTC4296_REG_GFLTEV

#define LTC4296_REG_GFLTEV   0x02

◆ LTC4296_REG_GFLTMSK

#define LTC4296_REG_GFLTMSK   0x03

◆ LTC4296_REG_GIOST

#define LTC4296_REG_GIOST   0x07

◆ LTC4296_REG_P0ADCCFG

#define LTC4296_REG_P0ADCCFG   0x15

◆ LTC4296_REG_P0ADCDAT

#define LTC4296_REG_P0ADCDAT   0x16

◆ LTC4296_REG_P0CFG0

#define LTC4296_REG_P0CFG0   0x13

◆ LTC4296_REG_P0CFG1

#define LTC4296_REG_P0CFG1   0x14

◆ LTC4296_REG_P0EV

#define LTC4296_REG_P0EV   0x10

◆ LTC4296_REG_P0SELFTEST

#define LTC4296_REG_P0SELFTEST   0x17

◆ LTC4296_REG_P0ST

#define LTC4296_REG_P0ST   0x12

◆ LTC4296_REG_P1ADCCFG

#define LTC4296_REG_P1ADCCFG   0x25

◆ LTC4296_REG_P1ADCDAT

#define LTC4296_REG_P1ADCDAT   0x26

◆ LTC4296_REG_P1CFG0

#define LTC4296_REG_P1CFG0   0x23

◆ LTC4296_REG_P1CFG1

#define LTC4296_REG_P1CFG1   0x24

◆ LTC4296_REG_P1EV

#define LTC4296_REG_P1EV   0x20

◆ LTC4296_REG_P1SELFTEST

#define LTC4296_REG_P1SELFTEST   0x27

◆ LTC4296_REG_P1ST

#define LTC4296_REG_P1ST   0x22

◆ LTC4296_REG_P2ADCCFG

#define LTC4296_REG_P2ADCCFG   0x35

◆ LTC4296_REG_P2ADCDAT

#define LTC4296_REG_P2ADCDAT   0x36

◆ LTC4296_REG_P2CFG0

#define LTC4296_REG_P2CFG0   0x33

◆ LTC4296_REG_P2CFG1

#define LTC4296_REG_P2CFG1   0x34

◆ LTC4296_REG_P2EV

#define LTC4296_REG_P2EV   0x30

◆ LTC4296_REG_P2SELFTEST

#define LTC4296_REG_P2SELFTEST   0x37

◆ LTC4296_REG_P2ST

#define LTC4296_REG_P2ST   0x32

◆ LTC4296_REG_P3ADCCFG

#define LTC4296_REG_P3ADCCFG   0x45

◆ LTC4296_REG_P3ADCDAT

#define LTC4296_REG_P3ADCDAT   0x46

◆ LTC4296_REG_P3CFG0

#define LTC4296_REG_P3CFG0   0x43

◆ LTC4296_REG_P3CFG1

#define LTC4296_REG_P3CFG1   0x44

◆ LTC4296_REG_P3EV

#define LTC4296_REG_P3EV   0x40

◆ LTC4296_REG_P3SELFTEST

#define LTC4296_REG_P3SELFTEST   0x47

◆ LTC4296_REG_P3ST

#define LTC4296_REG_P3ST   0x42

◆ LTC4296_REG_P4ADCCFG

#define LTC4296_REG_P4ADCCFG   0x55

◆ LTC4296_REG_P4ADCDAT

#define LTC4296_REG_P4ADCDAT   0x56

◆ LTC4296_REG_P4CFG0

#define LTC4296_REG_P4CFG0   0x53

◆ LTC4296_REG_P4CFG1

#define LTC4296_REG_P4CFG1   0x54

◆ LTC4296_REG_P4EV

#define LTC4296_REG_P4EV   0x50

◆ LTC4296_REG_P4SELFTEST

#define LTC4296_REG_P4SELFTEST   0x57

◆ LTC4296_REG_P4ST

#define LTC4296_REG_P4ST   0x52

◆ LTC4296_RESET_CODE

#define LTC4296_RESET_CODE   0x73

◆ LTC4296_SCCP_SUPPORT_MSK

#define LTC4296_SCCP_SUPPORT_MSK   NO_OS_BIT(6)

◆ LTC4296_SET_CLASSIFICATION_MODE_MSK

#define LTC4296_SET_CLASSIFICATION_MODE_MSK   NO_OS_BIT(13)

◆ LTC4296_SIG_OVERRIDE_BAD_MSK

#define LTC4296_SIG_OVERRIDE_BAD_MSK   NO_OS_BIT(1)

◆ LTC4296_SIG_OVERRIDE_GOOD_MSK

#define LTC4296_SIG_OVERRIDE_GOOD_MSK   NO_OS_BIT(0)

◆ LTC4296_SOFT_START_DISABLE_MSK

#define LTC4296_SOFT_START_DISABLE_MSK   NO_OS_BIT(9)

◆ LTC4296_SOURCE_CURRENT_MSK

#define LTC4296_SOURCE_CURRENT_MSK   NO_OS_GENMASK(11, 0)

◆ LTC4296_SPI_READ

#define LTC4296_SPI_READ   0x01

◆ LTC4296_SPI_WRITE

#define LTC4296_SPI_WRITE   0x00

◆ LTC4296_SW_EN_MSK

#define LTC4296_SW_EN_MSK   NO_OS_BIT(0)

◆ LTC4296_SW_INRUSH_MSK

#define LTC4296_SW_INRUSH_MSK   NO_OS_BIT(15)

◆ LTC4296_SW_POWER_AVAILABLE_MSK

#define LTC4296_SW_POWER_AVAILABLE_MSK   NO_OS_BIT(5)

◆ LTC4296_SW_PSE_READY_MSK

#define LTC4296_SW_PSE_READY_MSK   NO_OS_BIT(6)

◆ LTC4296_SW_PSE_WAKEUP_MSK

#define LTC4296_SW_PSE_WAKEUP_MSK   NO_OS_BIT(2)

◆ LTC4296_SW_RESET_MSK

#define LTC4296_SW_RESET_MSK   NO_OS_GENMASK(15, 8)

◆ LTC4296_SW_VIN_PGOOD_MSK

#define LTC4296_SW_VIN_PGOOD_MSK   NO_OS_BIT(0)

◆ LTC4296_TDET_DISABLE_MSK

#define LTC4296_TDET_DISABLE_MSK   NO_OS_BIT(11)

◆ LTC4296_TINRUSH_TIMER_DONE_MSK

#define LTC4296_TINRUSH_TIMER_DONE_MSK   NO_OS_BIT(3)

◆ LTC4296_TINRUSH_TIMER_MSK

#define LTC4296_TINRUSH_TIMER_MSK   NO_OS_GENMASK(3, 2)

◆ LTC4296_TLIM_DISABLE_MSK

#define LTC4296_TLIM_DISABLE_MSK   NO_OS_BIT(4)

◆ LTC4296_TLIM_TIMER_SLEEP_MSK

#define LTC4296_TLIM_TIMER_SLEEP_MSK   NO_OS_GENMASK(3, 2)

◆ LTC4296_TLIM_TIMER_TOP_MSK

#define LTC4296_TLIM_TIMER_TOP_MSK   NO_OS_GENMASK(7, 6)

◆ LTC4296_TMFVDO_TIMER_DISABLE_MSK

#define LTC4296_TMFVDO_TIMER_DISABLE_MSK   NO_OS_BIT(7)

◆ LTC4296_TOD_TRESTART_TIMER_MSK

#define LTC4296_TOD_TRESTART_TIMER_MSK   NO_OS_GENMASK(5, 4)

◆ LTC4296_TOFF_TIMER_DISABLE_MSK

#define LTC4296_TOFF_TIMER_DISABLE_MSK   NO_OS_BIT(8)

◆ LTC4296_TOFF_TIMER_DONE_MSK

#define LTC4296_TOFF_TIMER_DONE_MSK   NO_OS_BIT(7)

◆ LTC4296_UNLOCK_KEY

#define LTC4296_UNLOCK_KEY   0x05

◆ LTC4296_UPSTREAM_WAKEUP_DISABLE_MSK

#define LTC4296_UPSTREAM_WAKEUP_DISABLE_MSK   NO_OS_BIT(4)

◆ LTC4296_UVLO_DIGITAL_MSK

#define LTC4296_UVLO_DIGITAL_MSK   NO_OS_BIT(4)

◆ LTC4296_VALID_SIGNATURE_MSK

#define LTC4296_VALID_SIGNATURE_MSK   NO_OS_BIT(9)

◆ LTC4296_VGAIN

#define LTC4296_VGAIN   35230 / 1000

◆ LTC4296_VMAX

#define LTC4296_VMAX   1

◆ LTC4296_VMIN

#define LTC4296_VMIN   0

◆ LTC4296_WAKE_FWD_SUPPORT_MSK

#define LTC4296_WAKE_FWD_SUPPORT_MSK   NO_OS_BIT(5)

◆ LTC4296_WRITE_PROTECT_MSK

#define LTC4296_WRITE_PROTECT_MSK   NO_OS_GENMASK(7, 0)

◆ RTESTLOAD

#define RTESTLOAD   200 /*(ohm)*/

Enumeration Type Documentation

◆ adi_ltc_result

enum adi_ltc_result

Device Result Codes.

Enumerator
ADI_LTC_SUCCESS 

Success

ADI_LTC_DISCONTINUE_SCCP 

Discontinue the SCCP configuration cycle.

ADI_LTC_SCCP_COMPLETE 

Complete SCCP configuration cycle.

ADI_LTC_SCCP_PD_DETECTION_FAILED 

PD Detection failed

ADI_LTC_SCCP_PD_NOT_PRESENT 

SCCP PD not present

ADI_LTC_SCCP_PD_RES_INVALID 

PD Response is invalid

ADI_LTC_SCCP_PD_PRESENT 

PD is present.

ADI_LTC_SCCP_PD_CLASS_COMPATIBLE 

PD Class is compatible

ADI_LTC_SCCP_PD_CLASS_NOT_SUPPORTED 

PD Class is out of range

ADI_LTC_SCCP_PD_CLASS_NOT_COMPATIBLE 

PD Class is not compatible

ADI_LTC_SCCP_PD_LINE_NOT_HIGH 

PD line has not gone HIGH

ADI_LTC_SCCP_PD_LINE_NOT_LOW 

PD line has not gone LOW

ADI_LTC_SCCP_PD_CRC_FAILED 

CRC received from PD is incorrect

ADI_LTC_APL_COMPLETE 

Complete APL configuration cycle.

ADI_LTC_DISCONTINUE_APL 

Discontinue the APL configuration cycle.

ADI_LTC_INVALID_ADC_VOLTAGE 

Invalid ADC Accumulation result.

ADI_LTC_INVALID_ADC_PORT_CURRENT 

Invalid ADC Port Current

ADI_LTC_TEST_COMPLETE 

LTC Test complete.

ADI_LTC_DISCONTINUE_TEST 

LTC Discontinue Test.

ADI_LTC_TEST_FAILED 

LTC Test Failed.

ADI_LTC_INVALID_VIN 

VIN is invalid

◆ ltc4296_board_class

enum ltc4296_board_class

Board Classes.

Enumerator
SPOE_CLASS10 
SPOE_CLASS11 
SPOE_CLASS12 
SPOE_CLASS13 
SPOE_CLASS14 
SPOE_CLASS15 
APL_CLASSA 
APL_CLASSA_NOAUTONEG 
APL_CLASSC 
APL_CLASS3 
PRODUCTION_POWER_TEST 
APL_CLASSA_OLD_DEMO 
SPOE_OFF 
PRODUCTION_DATA_TEST 
RESERVED 
DEBUGMODE 

◆ ltc4296_config

enum ltc4296_config

Device Configuration Modes.

Enumerator
LTC_CFG_SCCP_MODE 
LTC_CFG_APL_MODE 
LTC_CFG_RESET 

◆ ltc4296_port

enum ltc4296_port

Device Port Numbers.

Enumerator
LTC_PORT0 
LTC_PORT1 
LTC_PORT2 
LTC_PORT3 
LTC_PORT4 
LTC_NO_PORT 

◆ ltc4296_port_reg_offset_e

enum ltc4296_port_reg_offset_e

Device Port Register offsets.

Enumerator
LTC_PORT_EVENTS 
LTC_PORT_STATUS 
LTC_PORT_CFG0 
LTC_PORT_CFG1 
LTC_PORT_ADCCFG 
LTC_PORT_ADCDAT 
LTC_PORT_SELFTEST 

◆ ltc4296_port_status

enum ltc4296_port_status

Device Port Status.

Enumerator
LTC_PORT_DISABLED 
LTC_PORT_ENABLED 

◆ ltc4296_pse_status

enum ltc4296_pse_status

Device PSE Status.

Enumerator
LTC_PSE_STATUS_DISABLED 
LTC_PSE_STATUS_SLEEPING 
LTC_PSE_STATUS_DELIVERING 
LTC_PSE_STATUS_SEARCHING 
LTC_PSE_STATUS_ERROR 
LTC_PSE_STATUS_IDLE 
LTC_PSE_STATUS_PREPDET 
LTC_PSE_STATUS_UNKNOWN 

◆ ltc4296_state

enum ltc4296_state

Device State.

Enumerator
LTC_UNLOCKED 
LTC_LOCKED 

Function Documentation

◆ ltc4296_chk_global_events()

int ltc4296_chk_global_events ( struct ltc4296_dev * dev)

Check global events.

Check global events

Parameters
dev- The device structure
Returns
0 in case of success, negative code otherwise

◆ ltc4296_chk_port_events()

int ltc4296_chk_port_events ( struct ltc4296_dev * dev,
enum ltc4296_port ltc4296_port )

Check port events

◆ ltc4296_clear_ckt_breaker()

int ltc4296_clear_ckt_breaker ( struct ltc4296_dev * dev)

Clear circuit break faults.

Clear circuit break faults

Parameters
dev- The device structure
Returns
0 in case of success, negative code otherwise
Here is the caller graph for this function:

◆ ltc4296_clear_global_faults()

int ltc4296_clear_global_faults ( struct ltc4296_dev * dev)

Clear global faults.

Clear global faults

Parameters
dev- The device structure
Returns
0 in case of success, negative code otherwise
Here is the caller graph for this function:

◆ ltc4296_clear_port_events()

int ltc4296_clear_port_events ( struct ltc4296_dev * dev,
enum ltc4296_port port_no )

Clear Port Events.

Clear Port Events

Parameters
dev- The device structure
port_no- The port number
Returns
0 in case of success, negative code otherwise
Here is the caller graph for this function:

◆ ltc4296_disable_gadc()

int ltc4296_disable_gadc ( struct ltc4296_dev * dev)

Disable the global ADC.

Disable the global ADC

Parameters
dev- The device structure
Returns
0 in case of success, negative code otherwise

◆ ltc4296_force_port_pwr()

int ltc4296_force_port_pwr ( struct ltc4296_dev * dev,
enum ltc4296_port port_no )

Force port to power mode.

Force port to power mode.

Parameters
dev- The device structure
port_no- The port number
Returns
0 in case of success, negative code otherwise

◆ ltc4296_get_port_addr()

int ltc4296_get_port_addr ( enum ltc4296_port port_no,
enum ltc4296_port_reg_offset_e port_offset,
uint8_t * port_addr )

Get port address.

Get port address

Parameters
port_no- The port number
port_offset- The port offset
port_addr- The port address
Returns
0 in case of success, negative code otherwise
Here is the caller graph for this function:

◆ ltc4296_init()

int ltc4296_init ( struct ltc4296_dev ** device,
struct ltc4296_init_param * init_param )

Device initialization.

Device initialization

Parameters
device- The device structure
init_param- The initialization parameters
Returns
0 in case of success, negative code otherwise
Here is the caller graph for this function:

◆ ltc4296_is_locked()

int ltc4296_is_locked ( struct ltc4296_dev * dev,
enum ltc4296_state * state )

Check device state.

Check device state

Parameters
dev- The device structure
state- The state of the device
Returns
0 in case of success, negative code otherwise
Here is the caller graph for this function:

◆ ltc4296_is_port_deliver_pwr()

int ltc4296_is_port_deliver_pwr ( struct ltc4296_dev * dev,
enum ltc4296_port port_no,
enum ltc4296_pse_status * pwr_status )

Check if port delivers power.

Check if port delivers power

Parameters
dev- The device structure
port_no- The port number
pwr_status- The PSE Status of the port
Returns
0 in case of success, negative code otherwise

◆ ltc4296_is_port_disabled()

int ltc4296_is_port_disabled ( struct ltc4296_dev * dev,
enum ltc4296_port port_no,
enum ltc4296_port_status * port_chk )

Check if port is enabled/disabled.

Check if port is enabled/disabled

Parameters
dev- The device structure
port_no- The port number
port_chk- The port is enabled/disabled
Returns
0 in case of success, negative code otherwise

◆ ltc4296_is_port_pwr_stable()

int ltc4296_is_port_pwr_stable ( struct ltc4296_dev * dev,
enum ltc4296_port port_no,
bool * pwr_status )

Check if port has stable power.

Check if port has stable power

Parameters
dev- The device structure
port_no- The port number
pwr_status- The power status
Returns
0 in case of success, negative code otherwise

◆ ltc4296_is_vin_valid()

int ltc4296_is_vin_valid ( struct ltc4296_dev * dev,
int port_vin_mv,
enum ltc4296_board_class ltcboard_class,
bool * vin_valid )

Check if input voltage is valid.

Check if input voltage is valid

Parameters
dev- The device structure
port_vin_mv- The input voltage in mV
ltcboard_class- The board class
vin_valid- Valid input voltage
Returns
0 in case of success, negative code otherwise

◆ ltc4296_is_vout_valid()

int ltc4296_is_vout_valid ( struct ltc4296_dev * dev,
int port_vout_mv,
enum ltc4296_board_class ltcboard_class,
bool * vout_valid )

Check if output voltage is valid.

Check if output voltage is valid.

Parameters
dev- The device structure
port_vout_mv- The output voltage in mV
ltcboard_class- The board class
vout_valid- Valid input voltage
Returns
0 in case of success, negative code otherwise

◆ ltc4296_port_disable()

int ltc4296_port_disable ( struct ltc4296_dev * dev,
enum ltc4296_port port_no )

Check if port is disabled.

Check if port is disabled

Parameters
dev- The device structure
port_no- The port number
Returns
0 in case of success, negative code otherwise

◆ ltc4296_port_en()

int ltc4296_port_en ( struct ltc4296_dev * dev,
enum ltc4296_port port_no )

Enable specific port.

Enable specific port

Parameters
dev- The device structure
port_no- The port number
Returns
0 in case of success, negative code otherwise
Here is the caller graph for this function:

◆ ltc4296_port_en_and_classification()

int ltc4296_port_en_and_classification ( struct ltc4296_dev * dev,
enum ltc4296_port port_no )

Enable specific port and classify.

Enable specific port and classify

Parameters
dev- The device structure
port_no- The port number
Returns
0 in case of success, negative code otherwise

◆ ltc4296_port_prebias()

int ltc4296_port_prebias ( struct ltc4296_dev * dev,
enum ltc4296_port port_no,
enum ltc4296_config mode )

Stimulate valid wake-up signature for a port.

Stimulate valid wake-up signature for a port

Parameters
dev- The device structure
port_no- The port number
mode- The device configuration mode
Returns
0 in case of success, negative code otherwise
Here is the caller graph for this function:

◆ ltc4296_port_pwr_available()

int ltc4296_port_pwr_available ( struct ltc4296_dev * dev,
enum ltc4296_port port_no )

Set port is able to source power.

Set port is able to source power.

Parameters
dev- The device structure
port_no- The port number
Returns
0 in case of success, negative code otherwise

◆ ltc4296_print_global_faults()

int ltc4296_print_global_faults ( uint16_t g_events)

Print global faults.

Print global faults

Parameters
g_events- The global events data
Returns
0 in case of success, negative code otherwise
Here is the caller graph for this function:

◆ ltc4296_print_port_events()

int ltc4296_print_port_events ( enum ltc4296_port port_no,
uint16_t port_events )

Print port events.

Print port events

Parameters
port_no- The port number
port_events- The port events data
Returns
0 in case of success, negative code otherwise
Here is the caller graph for this function:

◆ ltc4296_read_gadc()

int ltc4296_read_gadc ( struct ltc4296_dev * dev,
int * port_voltage_mv )

Read global ADC.

Read global ADC

Parameters
dev- The device structure
port_voltage_mv- The port voltage in mV
Returns
0 in case of success, negative code otherwise

◆ ltc4296_read_global_faults()

int ltc4296_read_global_faults ( struct ltc4296_dev * dev,
uint16_t * g_events )

Read global faults.

Read global faults

Parameters
dev- The device structure
g_events- The global events data read
Returns
0 in case of success, negative code otherwise
Here is the caller graph for this function:

◆ ltc4296_read_port_adc()

int ltc4296_read_port_adc ( struct ltc4296_dev * dev,
enum ltc4296_port port_no,
int * port_i_out_ma )

Read port ADC.

Read port ADC

Parameters
dev- The device structure
port_no- The port number
port_i_out_ma- The port current in mA.
Returns
0 in case of success, negative code otherwise

◆ ltc4296_read_port_events()

int ltc4296_read_port_events ( struct ltc4296_dev * dev,
enum ltc4296_port port_no,
uint16_t * port_events )

Read Port Events.

Read Port Events

Parameters
dev- The device structure
port_no- The port number
port_events- The port events read
Returns
0 in case of success, negative code otherwise
Here is the caller graph for this function:

◆ ltc4296_read_port_status()

int ltc4296_read_port_status ( struct ltc4296_dev * dev,
enum ltc4296_port port_no,
uint16_t * port_status )

Read Port Status.

Read Port Status

Parameters
dev- The device structure
port_no- The port number
port_status- The port status
Returns
0 in case of success, negative code otherwise

◆ ltc4296_reg_read()

int ltc4296_reg_read ( struct ltc4296_dev * dev,
uint8_t reg,
uint16_t * data )

Register Read.

Register Read

Parameters
dev- The device structure
reg- The register value
data- The data read from the device.
Returns
0 in case of success, negative code otherwise
Here is the caller graph for this function:

◆ ltc4296_reg_write()

int ltc4296_reg_write ( struct ltc4296_dev * dev,
uint8_t reg,
uint16_t data )

Register Write.

Register Write

Parameters
dev- The device structure
reg- The register value
data- The data written to the device
Returns
0 in case of success, negative code otherwise
Here is the caller graph for this function:

◆ ltc4296_remove()

int ltc4296_remove ( struct ltc4296_dev * dev)

Free allocated resources.

Free allocated resources

Parameters
dev- The device structure
Returns
0 in case of success, negative code otherwise
Here is the caller graph for this function:

◆ ltc4296_reset()

int ltc4296_reset ( struct ltc4296_dev * dev)

Software reset.

Register Write

Parameters
dev- The device structure
Returns
0 in case of success, negative code otherwise
Here is the caller graph for this function:

◆ ltc4296_set_gadc_vin()

int ltc4296_set_gadc_vin ( struct ltc4296_dev * dev)

Set the global ADC to measure voltage.

Set the global ADC to measure voltage

Parameters
dev- The device structure
Returns
0 in case of success, negative code otherwise

◆ ltc4296_set_gadc_vout()

int ltc4296_set_gadc_vout ( struct ltc4296_dev * dev,
enum ltc4296_port port_no )

Configure Global ADC to read output voltage.

Configure Global ADC to read output voltage

Parameters
dev- The device structure
port_no- The port number
Returns
0 in case of success, negative code otherwise

◆ ltc4296_set_port_mfvs()

int ltc4296_set_port_mfvs ( struct ltc4296_dev * dev,
enum ltc4296_port port_no )

Set port to maintain full voltage signature.

Set port to maintain full voltage signature.

Parameters
dev- The device structure
port_no- The port number
Returns
0 in case of success, negative code otherwise

◆ ltc4296_set_port_pwr()

int ltc4296_set_port_pwr ( struct ltc4296_dev * dev,
enum ltc4296_port port_no )

Set port to power mode.

Set port to power mode.

Parameters
dev- The device structure
port_no- The port number
Returns
0 in case of success, negative code otherwise

◆ ltc4296_unlock()

int ltc4296_unlock ( struct ltc4296_dev * dev)

Device unlock.

Device unlock

Parameters
dev- The device structure
Returns
0 in case of success, negative code otherwise
Here is the caller graph for this function: