max14919.h File Reference

Header file of MAX14919 Driver. More...

#include <stdint.h>
#include <stdbool.h>
#include "no_os_gpio.h"
#include "no_os_util.h"
#include "no_os_error.h"

Include dependency graph for max14919.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	max14919_init_param
	Structure holding the MAX14919 initialization parameter. More...
struct	max14919_desc
	Structure holding te MAX14919 device descriptor. More...

Macros
#define	MAX14919_OUT_CHANNELS   4

Enumerations
enum	max14919_out_state {   MAX14919_OUT_OFF,   MAX14919_OUT_ON }
enum	max14919_out_chan {   MAX14919_OUT1,   MAX14919_OUT2,   MAX14919_OUT3,   MAX14919_OUT4 }

Functions
int	max14919_set_out (struct max14919_desc *desc, enum max14919_out_state *state)
	Set the OUT channels state. More...
int	max14919_set_climit (struct max14919_desc *desc, bool state)
	Set current limiting. More...
int	max14919_get_fault (struct max14919_desc *desc, uint8_t *fault)
	Get the FAULT state of the device. More...
int	max14919_detect_rev (struct max14919_desc *desc, uint8_t *rev)
	Detect reverse polarity of the current. More...
int	max14919_init (struct max14919_desc **desc, struct max14919_init_param *init_param)
	Initialize the MAX14919 device descriptor. More...
int	max14919_remove (struct max14919_desc *desc)
	Free resources allocated by the init function. More...

Detailed Description

Header file of MAX14919 Driver.

Author

Radu Sabau (radu..nosp@m.saba.nosp@m.u@ana.nosp@m.log..nosp@m.com)

Copyright 2024(c) Analog Devices, Inc.

All rights reserved.

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

• Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
• 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.
• 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.
• The use of this software may or may not infringe the patent rights of one or more patent holders. This license does not release you from the requirement that you obtain separate licenses from these patent holders to use this software.
• Use of the software either in source or binary form, must be run on or directly connected to an Analog Devices Inc. component.

THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL ANALOG DEVICES BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, INTELLECTUAL PROPERTY RIGHTS, 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

MAX14919_OUT_CHANNELS

#define MAX14919_OUT_CHANNELS   4

Enumeration Type Documentation

max14919_out_chan

enum max14919_out_chan

Enumerator
MAX14919_OUT1
MAX14919_OUT2
MAX14919_OUT3
MAX14919_OUT4

max14919_out_state

enum max14919_out_state

Enumerator
MAX14919_OUT_OFF
MAX14919_OUT_ON

Function Documentation

max14919_detect_rev()

int max14919_detect_rev	(	struct max14919_desc *	desc,
		uint8_t *	rev
	)

Detect reverse polarity of the current.

Detect REV polarity of the current.

Parameters

desc	- MAX14919 device descriptor
rev	- Reverse polarity state

Returns

0 in case of succes, negative error code otherwise.

Here is the caller graph for this function:

max14919_get_fault()

int max14919_get_fault	(	struct max14919_desc *	desc,
		uint8_t *	fault
	)

Get the FAULT state of the device.

Get FAULT state from the FAULT pin.

Parameters

desc	- MAX14919 device descriptor
fault	- Fault state of the MAX14919

Returns

0 in case of succes, negative error code otherwise.

Here is the caller graph for this function:

max14919_init()

int max14919_init	(	struct max14919_desc **	desc,
		struct max14919_init_param *	init_param
	)

Initialize the MAX14919 device descriptor.

Initialize the MAX14919 device descriptor.

Parameters

desc	- MAX14919 device descriptor
init_param	- MAX14919 initialization parameter

Returns

0 in case of succes, negative error code otherwise

Here is the caller graph for this function:

max14919_remove()

int max14919_remove

(

struct max14919_desc *

desc

)

Free resources allocated by the init function.

Free resources allocated by the init function.

Parameters

desc	- MAX14919 device descriptor

Returns

0 in case of succes, negative error code otherwise

Here is the caller graph for this function:

max14919_set_climit()

int max14919_set_climit	(	struct max14919_desc *	desc,
		bool	state
	)

Set current limiting.

Set 2x current limiting state.

Parameters

desc	- MAX14919 devce descriptor
state	- State to be set. TRUE - on. FALSE - off.

Returns

0 in case of succes, negative error code otherwise

Here is the caller graph for this function:

max14919_set_out()

int max14919_set_out	(	struct max14919_desc *	desc,
		enum max14919_out_state *	state
	)

Set the OUT channels state.

Set output channels state.

Parameters

desc	- MAX14919 device descriptor
state	- OUT channels state array containing information about the to be set channels state.

Returns

0 in case of succes, negative error code otherwise

Here is the caller graph for this function: