max25603.h File Reference

Header file of MAX25603 Driver. More...

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

Include dependency graph for max25603.h:

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

Go to the source code of this file.

Classes
struct	max25603_init_param
struct	max25603_desc

Enumerations
enum	max25603_comp {   MAX25603_COMP1,   MAX25603_COMP2 }
enum	max25603_enable {   MAX25603_DISABLE_EN,   MAX25603_EN1,   MAX25603_EN2 }
enum	max25603_beam {   MAX25603_DISABLE_BEAM,   MAX25603_HIGH_BEAM,   MAX25603_LOW_BEAM,   MAX25603_DRL_BEAM,   MAX25603_TURN_BEAM }

Functions
int	max25603_sel_comp (struct max25603_desc *desc, enum max25603_comp comp)
	MAX25603 select comparator function. More...
int	max25603_set_enable (struct max25603_desc *desc, enum max25603_enable enable, uint32_t freq_hz, uint8_t duty)
	MAX25603 set and configure ENABLE PWM dimming. More...
int	max25603_set_beam (struct max25603_desc *desc, enum max25603_beam beam, uint32_t freq_hz, uint8_t duty)
	MAX25603 set and configure BEAM PWM dimming. More...
int	max25603_init (struct max25603_desc **desc, struct max25603_init_param *init_param)
	MAX25603 descriptor initialization function. More...
int	max25603_remove (struct max25603_desc *desc)
	Deallocates all the resources used at initialization. More...

Detailed Description

Header file of MAX25603 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

max25603_beam

enum max25603_beam

Enumerator
MAX25603_DISABLE_BEAM
MAX25603_HIGH_BEAM
MAX25603_LOW_BEAM
MAX25603_DRL_BEAM
MAX25603_TURN_BEAM

max25603_comp

enum max25603_comp

Enumerator
MAX25603_COMP1
MAX25603_COMP2

max25603_enable

enum max25603_enable

Enumerator
MAX25603_DISABLE_EN
MAX25603_EN1
MAX25603_EN2

Function Documentation

max25603_init()

int max25603_init	(	struct max25603_desc **	desc,
		struct max25603_init_param *	init_param
	)

MAX25603 descriptor initialization function.

MAX25603 device initialization function.

Parameters

desc	- MAX25603 device descriptor.
init_param	- Initialization parameter containing data about the device descriptor to be initialized.

Returns

0 in case of succes, negative error code otherwise.

Here is the caller graph for this function:

max25603_remove()

int max25603_remove

(

struct max25603_desc *

desc

)

Deallocates all the resources used at initialization.

Deallocates all resouces used at initialization.

Parameters

desc	- MAX25603 device descriptor.

Returns

0 in case of succes, negative error code otherwise.

Here is the caller graph for this function:

max25603_sel_comp()

int max25603_sel_comp	(	struct max25603_desc *	desc,
		enum max25603_comp	comp
	)

MAX25603 select comparator function.

MAX25603 select comparator function.

Parameters

desc	- MAX25603 device descriptor
comp	- Comparator selected to be used at the GATE's output

Returns

0 in case of succes, negative error code otherwise

Here is the caller graph for this function:

max25603_set_beam()

int max25603_set_beam	(	struct max25603_desc *	desc,
		enum max25603_beam	beam,
		uint32_t	freq_hz,
		uint8_t	duty
	)

MAX25603 set and configure BEAM PWM dimming.

MAX25603 set and configure BEAM PWM dimming.

Parameters

desc	- MAX25603 device descriptor
beam	- Beam pin to be configured/enabled.
freq_hz	- Beam pin PWM's frequency in Hz.
duty	- Duty cycle percentage (from 0 to 100)

Returns

0 in case of succes, negative error code otherwise

Here is the caller graph for this function:

max25603_set_enable()

int max25603_set_enable	(	struct max25603_desc *	desc,
		enum max25603_enable	enable,
		uint32_t	freq_hz,
		uint8_t	duty
	)

MAX25603 set and configure ENABLE PWM dimming.

MAX25603 set and configure ENABLE PWM dimming.

Parameters

desc	- MAX25603 device descriptor
enable	- Enable pin to be configured/enabled.
freq_hz	- Enable pin PWM's frequency in Hz.
duty	- Duty cycle percentage (from 0 to 100)

Returns

0 in case of succes, negative error code otherwise

Here is the caller graph for this function: