ltc3350.c File Reference

Implementation of LTC3350 Driver. More...

#include <stdint.h>
#include <stdlib.h>
#include <errno.h>
#include "no_os_util.h"
#include "no_os_delay.h"
#include "no_os_alloc.h"
#include "no_os_i2c.h"
#include "ltc3350.h"

Include dependency graph for ltc3350.c:

Functions
int	ltc3350_init (struct ltc3350_dev **device, struct ltc3350_init_param *init_param)
	Initializes the communication peripheral and checks if the LTC3350 part is present. More...
int	ltc3350_remove (struct ltc3350_dev *dev)
	Free the resources allocated by ltc3350_init(). More...
int	ltc3350_read_device_data (struct ltc3350_dev *dev, uint8_t base_address, uint16_t *read_data)
	Reads data from the device (I2C). More...
int	ltc3350_write_device_data (struct ltc3350_dev *dev, uint8_t base_address, uint16_t write_data)
	Writes data to the device (I2C) More...
int	ltc3350_get_num_caps (struct ltc3350_dev *dev, uint8_t *num_caps)
	Gets number of capacitors configured based on PIN. More...
int	ltc3350_get_esr (struct ltc3350_dev *dev, uint16_t *value)
	Reads the ESR data. More...
int	ltc3350_get_vcap (struct ltc3350_dev *dev, uint8_t n_cap, uint16_t *value)
	Reads the Vcap data for selected capacitor. More...

Detailed Description

Implementation of LTC3350 Driver.

Authors

Sankalp Khandkar (sanka.nosp@m.lp.k.nosp@m.handk.nosp@m.ar@a.nosp@m.nalog.nosp@m..com) Ignacio Rojas (ignac.nosp@m.io.r.nosp@m.ojas@.nosp@m.anal.nosp@m.og.co.nosp@m.m)

Copyright 2023(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.

Function Documentation

ltc3350_get_esr()

int ltc3350_get_esr	(	struct ltc3350_dev *	dev,
		uint16_t *	value
	)

Reads the ESR data.

Parameters

dev	- The device structure.
value	- Measured ESR.

Returns

ret - Result of the reading procedure.

ltc3350_get_num_caps()

int ltc3350_get_num_caps	(	struct ltc3350_dev *	dev,
		uint8_t *	num_caps
	)

Gets number of capacitors configured based on PIN.

Parameters

dev	- The device structure.
num_caps	- Number of capacitors configured. 00-1 cap, 01 - 2 caps, 10 - 3caps and 11 - 4 caps

Returns

ret - Result of the reading procedure.

ltc3350_get_vcap()

int ltc3350_get_vcap	(	struct ltc3350_dev *	dev,
		uint8_t	n_cap,
		uint16_t *	value
	)

Reads the Vcap data for selected capacitor.

Parameters

dev	- The device structure.
n_cap	- Number of capacitor to read, 0 for stack voltage
value	- The read value

Returns

ret - Result of the reading procedure.

ltc3350_init()

int ltc3350_init	(	struct ltc3350_dev **	device,
		struct ltc3350_init_param *	init_param
	)

Initializes the communication peripheral and checks if the LTC3350 part is present.

Parameters

device	- The device structure.
init_param	- The structure that contains the device initial parameters.

Returns

ret - Result of the initialization procedure.

ltc3350_read_device_data()

int ltc3350_read_device_data	(	struct ltc3350_dev *	dev,
		uint8_t	base_address,
		uint16_t *	read_data
	)

Reads data from the device (I2C).

Parameters

dev	- The device structure.
base_address	- Address of the base register.
read_data	- The read data value

Returns

ret - Result of the reading procedure.

Here is the caller graph for this function:

ltc3350_remove()

int ltc3350_remove

(

struct ltc3350_dev *

dev

)

Free the resources allocated by ltc3350_init().

Parameters

dev	- The device structure.

Returns

ret - Result of the remove procedure.

ltc3350_write_device_data()

int ltc3350_write_device_data	(	struct ltc3350_dev *	dev,
		uint8_t	base_address,
		uint16_t	write_data
	)

Writes data to the device (I2C)

Parameters

dev	- The device structure.
base_address	- Address of the base register.
write_data	- The data which is going to be written.

Returns

ret - Result of the writing procedure.