maxim_timer.c File Reference

Source file for Maxim timer platform driver. More...

#include "tmr.h"
#include "maxim_timer.h"
#include "no_os_error.h"
#include "no_os_util.h"
#include "no_os_alloc.h"

Include dependency graph for maxim_timer.c:

Functions
int32_t	max_timer_init (struct no_os_timer_desc **desc, const struct no_os_timer_init_param *param)
	Timer driver init function.
int32_t	max_timer_remove (struct no_os_timer_desc *desc)
	Timer driver remove function.
int32_t	max_timer_start (struct no_os_timer_desc *desc)
	Timer count start function.
int32_t	max_timer_stop (struct no_os_timer_desc *desc)
	Timer count stop function.
int32_t	max_timer_counter_get (struct no_os_timer_desc *desc, uint32_t *counter)
	Function to get the current timer counter value.
int32_t	max_timer_counter_set (struct no_os_timer_desc *desc, uint32_t new_val)
	Function to set the timer counter value.
int32_t	max_timer_count_clk_get (struct no_os_timer_desc *desc, uint32_t *freq_hz)
	Function to get the timer frequency.
int32_t	max_timer_count_clk_set (struct no_os_timer_desc *desc, uint32_t freq_hz)
	Function to set the timer frequency.
int32_t	max_get_elapsed_nsec (struct no_os_timer_desc *desc, uint64_t *elapsed_time)
	Not implemented.

Variables
const struct no_os_timer_platform_ops	max_timer_ops
	maxim platform specific timer platform ops structure

Detailed Description

Source file for Maxim timer platform driver.

Author

Ciprian Regus (cipri.nosp@m.an.r.nosp@m.egus@.nosp@m.anal.nosp@m.og.co.nosp@m.m)

Copyright 2022(c) Analog Devices, Inc.

SPDX-License-Identifier: BSD-3-Clause

Function Documentation

max_get_elapsed_nsec()

int32_t max_get_elapsed_nsec	(	struct no_os_timer_desc *	desc,
		uint64_t *	elapsed_time )

Not implemented.

Parameters

desc	- timer descriptor
elapsed_time	- time in nanoseconds

Returns

-ENOSYS

max_timer_count_clk_get()

int32_t max_timer_count_clk_get	(	struct no_os_timer_desc *	desc,
		uint32_t *	freq_hz )

Function to get the timer frequency.

Parameters

desc	- timer descriptor
freq_hz	- the timer frequency value

Returns

0 in case of success, -EINVAL otherwise.

max_timer_count_clk_set()

int32_t max_timer_count_clk_set	(	struct no_os_timer_desc *	desc,
		uint32_t	freq_hz )

Function to set the timer frequency.

Parameters

desc	- timer descriptor.
freq_hz	- the timer frequency value to be set.

Returns

0 in case of success, negative errno error codes otherwise.

max_timer_counter_get()

int32_t max_timer_counter_get	(	struct no_os_timer_desc *	desc,
		uint32_t *	counter )

Function to get the current timer counter value.

Parameters

desc	- timer descriptor
counter	- the timer counter value

Returns

0 in case of success, -EINVAL otherwise.

max_timer_counter_set()

int32_t max_timer_counter_set	(	struct no_os_timer_desc *	desc,
		uint32_t	new_val )

Function to set the timer counter value.

Parameters

desc	- timer descriptor
new_val	- timer counter value to be set

Returns

0 in case of success, -EINVAL otherwise.

max_timer_init()

int32_t max_timer_init	(	struct no_os_timer_desc **	desc,
		const struct no_os_timer_init_param *	param )

Timer driver init function.

Parameters

desc	- timer descriptor to be initialized
param	- initialization parameter for the desc

Returns

0 in case of success, negative errno error codes otherwise.

max_timer_remove()

int32_t max_timer_remove

(

struct no_os_timer_desc *

desc

)

Timer driver remove function.

Parameters

desc	- timer descriptor

Returns

0 in case of success, -EINVAL otherwise.

max_timer_start()

int32_t max_timer_start

(

struct no_os_timer_desc *

desc

)

Timer count start function.

Parameters

desc	- timer descriptor

Returns

0 in case of success, -EINVAL otherwise.

max_timer_stop()

int32_t max_timer_stop

(

struct no_os_timer_desc *

desc

)

Timer count stop function.

Parameters

desc	- timer descriptor

Returns

0 in case of success, -EINVAL otherwise.

Variable Documentation

max_timer_ops

const struct no_os_timer_platform_ops max_timer_ops

Initial value:

= {
    .init = max_timer_init,
    .start = max_timer_start,
    .stop = max_timer_stop,
    .counter_get = max_timer_counter_get,
    .counter_set = max_timer_counter_set,
    .count_clk_get = max_timer_count_clk_get,
    .count_clk_set = max_timer_count_clk_set,
    .get_elapsed_time_nsec = max_get_elapsed_nsec,
    .remove = max_timer_remove
}

maxim platform specific timer platform ops structure

Maxim specific timer platform ops.