max14914.h File Reference

Header file of MAX14914 Driver. More...

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

Include dependency graph for max14914.h:

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

Go to the source code of this file.

Classes
struct	max14914_desc
	Structure holding the MAX14914 device descriptor. More...
struct	max14914_init_param
	Structure holding the MAX14914 initialization parameter. More...

Enumerations
enum	max14914_state {   MAX14914_DIGITAL_OUTPUT_PP,   MAX14914_DIGITAL_OUTPUT_HIGH_SIDE,   MAX14914_DIGITAL_OUTPUT_LOW_SIDE,   MAX14914_DIGITAL_INPUT_IEC_TYPE1_3,   MAX14914_DIGITAL_INPUT_IEC_TYPE2 }

Functions
int	max14914_set_state (struct max14914_desc *desc, enum max14914_state state)
	Set the state of the MAX14914. More...
int	max14914_init (struct max14914_desc **desc, struct max14914_init_param *init_param)
	Initialize the MAX14914 device. More...
int	max14914_remove (struct max14914_desc *desc)
	Free resources allocated by the init function. More...

Detailed Description

Header file of MAX14914 Driver.

Author

Radu Sabau (radu..nosp@m.saba.nosp@m.u@ana.nosp@m.log..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.

Enumeration Type Documentation

max14914_state

enum max14914_state

Enumerator
MAX14914_DIGITAL_OUTPUT_PP
MAX14914_DIGITAL_OUTPUT_HIGH_SIDE
MAX14914_DIGITAL_OUTPUT_LOW_SIDE
MAX14914_DIGITAL_INPUT_IEC_TYPE1_3
MAX14914_DIGITAL_INPUT_IEC_TYPE2

Function Documentation

max14914_init()

int max14914_init	(	struct max14914_desc **	desc,
		struct max14914_init_param *	init_param
	)

Initialize the MAX14914 device.

Parameters

desc	- MAX14914 device descriptor
init_param	- MAX14914 initialization parameter

Returns

0 in case of succes, negative error code otherwise

Here is the caller graph for this function:

max14914_remove()

int max14914_remove

(

struct max14914_desc *

desc

)

Free resources allocated by the init function.

Parameters

desc	- MAX14914 device descriptor

Returns

0 in case of succes, negative error code otherwise

Here is the caller graph for this function:

max14914_set_state()

int max14914_set_state	(	struct max14914_desc *	desc,
		enum max14914_state	state
	)

Set the state of the MAX14914.

Parameters

desc	- MAX14914 device descriptor
state	- State for the device to be set in.

Returns

0 in case of succes, negative error code otherwise

Here is the caller graph for this function: