maxim_pwm.c File Reference

Maxim platform specific implementation PWM API. More...

#include "tmr.h"
#include "no_os_alloc.h"
#include "no_os_error.h"
#include "no_os_util.h"
#include "no_os_units.h"
#include "maxim_pwm.h"

Include dependency graph for maxim_pwm.c:

Functions
int32_t	max_pwm_enable (struct no_os_pwm_desc *desc)
	Enable the PWM.
int32_t	max_pwm_disable (struct no_os_pwm_desc *desc)
	Disable the PWM.
int32_t	max_pwm_set_period (struct no_os_pwm_desc *desc, uint32_t period_ns)
	Set the PWM period.
int32_t	max_pwm_get_period (struct no_os_pwm_desc *desc, uint32_t *period_ns)
	Get the PWM period.
int32_t	max_pwm_set_duty_cycle (struct no_os_pwm_desc *desc, uint32_t duty_cycle_ns)
	Set the PWM duty cycle.
int32_t	max_pwm_get_duty_cycle (struct no_os_pwm_desc *desc, uint32_t *duty_cycle_ns)
	Get the PWM duty cycle.
int32_t	max_pwm_init (struct no_os_pwm_desc **desc, const struct no_os_pwm_init_param *param)
	Initialize the PWM.
int32_t	max_pwm_remove (struct no_os_pwm_desc *desc)
	Free the resources allocated by max_pwm_init().

Variables
const struct no_os_pwm_platform_ops	max_pwm_ops
	Maxim platform specific callbacks for the PWM API.

Detailed Description

Maxim platform specific implementation PWM API.

Author

Dragos Bogdan (drago.nosp@m.s.bo.nosp@m.gdan@.nosp@m.anal.nosp@m.og.co.nosp@m.m)

Copyright 2024(c) Analog Devices, Inc.

SPDX-License-Identifier: BSD-3-Clause

Function Documentation

max_pwm_disable()

int32_t max_pwm_disable

(

struct no_os_pwm_desc *

desc

)

Disable the PWM.

Parameters

desc	- PWM descriptor.

Returns

0 in case of success, negative error otherwise.

max_pwm_enable()

int32_t max_pwm_enable

(

struct no_os_pwm_desc *

desc

)

Enable the PWM.

Parameters

desc	- PWM descriptor.

Returns

0 in case of success, negative error code otherwise.

max_pwm_get_duty_cycle()

int32_t max_pwm_get_duty_cycle	(	struct no_os_pwm_desc *	desc,
		uint32_t *	duty_cycle_ns )

Get the PWM duty cycle.

Parameters

desc	- Pointer where the configured instance is stored.
duty_cycle_ns	- PWM duty cycle.

Returns

0 in case of success, negative error code otherwise.

max_pwm_get_period()

int32_t max_pwm_get_period	(	struct no_os_pwm_desc *	desc,
		uint32_t *	period_ns )

Get the PWM period.

Parameters

desc	- Pointer where the configured instance is stored.
period_ns	- PWM period.

Returns

0 in case of success, negative error code otherwise.

max_pwm_init()

int32_t max_pwm_init	(	struct no_os_pwm_desc **	desc,
		const struct no_os_pwm_init_param *	param )

Initialize the PWM.

Parameters

desc	- PWM descriptor.
param	- The structure containing PWM init parameters.

Returns

0 in case of success, negative error code otherwise.

max_pwm_remove()

int32_t max_pwm_remove

(

struct no_os_pwm_desc *

desc

)

Free the resources allocated by max_pwm_init().

Parameters

desc	- PWM descriptor

Returns

0 in case of success, negative error code otherwise.

max_pwm_set_duty_cycle()

int32_t max_pwm_set_duty_cycle	(	struct no_os_pwm_desc *	desc,
		uint32_t	duty_cycle_ns )

Set the PWM duty cycle.

Parameters

desc	- Pointer where the configured instance is stored.
duty_cycle_ns	- PWM duty cycle.

Returns

0 in case of success, negative error code otherwise.

max_pwm_set_period()

int32_t max_pwm_set_period	(	struct no_os_pwm_desc *	desc,
		uint32_t	period_ns )

Set the PWM period.

Parameters

desc	- Pointer where the configured instance is stored.
period_ns	- PWM period.

Returns

0 in case of success, negative error code otherwise.

Variable Documentation

max_pwm_ops

const struct no_os_pwm_platform_ops max_pwm_ops

Initial value:

= {
    .pwm_ops_enable = max_pwm_enable,
    .pwm_ops_disable = max_pwm_disable,
    .pwm_ops_set_period = max_pwm_set_period,
    .pwm_ops_get_period = max_pwm_get_period,
    .pwm_ops_set_duty_cycle = max_pwm_set_duty_cycle,
    .pwm_ops_get_duty_cycle = max_pwm_get_duty_cycle,
    .pwm_ops_init = max_pwm_init,
    .pwm_ops_remove = max_pwm_remove
}

Maxim platform specific callbacks for the PWM API.

Maxim specific PWM ops.