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:

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.
int	max14914_init (struct max14914_desc **desc, struct max14914_init_param *init_param)
	Initialize the MAX14914 device.
int	max14914_remove (struct max14914_desc *desc)
	Free resources allocated by the init function.

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.

SPDX-License-Identifier: BSD-3-Clause

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

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

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