generic_timer.c File Reference

Timer control module source. More...

#include "no_os_error.h"
#include "no_os_timer.h"
#include "no_os_util.h"

Include dependency graph for generic_timer.c:

Functions
int32_t	generic_timer_init (struct no_os_timer_desc **desc, const struct no_os_timer_init_param *param)
	Initialize hardware timer and the handler structure associated with it. More...
int32_t	generic_timer_remove (struct no_os_timer_desc *desc)
	Free the memory allocated by timer_setup(). More...
int32_t	generic_timer_start (struct no_os_timer_desc *desc)
	Start a timer. More...
int32_t	generic_timer_stop (struct no_os_timer_desc *desc)
	Stop a timer from counting. More...
int32_t	generic_timer_counter_get (struct no_os_timer_desc *desc, uint32_t *counter)
	Get the value of the counter register for the timer. More...
int32_t	generic_timer_counter_set (struct no_os_timer_desc *desc, uint32_t new_val)
	Set the timer counter register value. More...
int32_t	generic_timer_count_clk_get (struct no_os_timer_desc *desc, uint32_t *freq_hz)
	Get the timer clock frequency. More...
int32_t	generic_timer_count_clk_set (struct no_os_timer_desc *desc, uint32_t freq_hz)
	Set the timer clock frequency. More...
int32_t	generic_timer_get_elapsed_time_nsec (struct no_os_timer_desc *desc, uint64_t *elapsed_time)
	Get the elapsed time in nsec for the timer. More...

Variables
const struct no_os_timer_platform_ops	generic_timer_ops
	generic platform specific timer platform ops structure More...

Detailed Description

Timer control module source.

Author

Andrei Drimbarean (andre.nosp@m.i.dr.nosp@m.imbar.nosp@m.ean@.nosp@m.analo.nosp@m.g.co.nosp@m.m)

Copyright 2019(c) Analog Devices, Inc.

All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

• Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
• 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.
• 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.
• The use of this software may or may not infringe the patent rights of one or more patent holders. This license does not release you from the requirement that you obtain separate licenses from these patent holders to use this software.
• Use of the software either in source or binary form, must be run on or directly connected to an Analog Devices Inc. component.

THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL ANALOG DEVICES BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, INTELLECTUAL PROPERTY RIGHTS, 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.

Function Documentation

generic_timer_count_clk_get()

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

Get the timer clock frequency.

Parameters

[in]	desc	- Pointer to the device handler.
[out]	freq_hz	- The value in Hz of the timer clock.

Returns

0 in case of success, error code otherwise.

generic_timer_count_clk_set()

int32_t generic_timer_count_clk_set	(	struct no_os_timer_desc *	desc,
		uint32_t	freq_hz
	)

Set the timer clock frequency.

Parameters

[in]	desc	- Pointer to the device handler.
[in]	freq_hz	- The value in Hz of the new timer clock.

Returns

0 in case of success, error code otherwise.

generic_timer_counter_get()

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

Get the value of the counter register for the timer.

Parameters

[in]	desc	- Pointer to the device handler.
[out]	counter	- Pointer to the counter value.

Returns

0 in case of success, error code otherwise.

generic_timer_counter_set()

int32_t generic_timer_counter_set	(	struct no_os_timer_desc *	desc,
		uint32_t	new_val
	)

Set the timer counter register value.

Parameters

[in]	desc	- Pointer to the device handler.
[in]	new_val	- The new value of the counter register.

Returns

0 in case of success, error code otherwise.

generic_timer_get_elapsed_time_nsec()

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

Get the elapsed time in nsec for the timer.

Parameters

[in]	desc	- Pointer to the device handler.
[in]	elapsed_time	- The elapsed time in nsec.

Returns

0 in case of success, error code otherwise.

generic_timer_init()

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

Initialize hardware timer and the handler structure associated with it.

Parameters

[out]	desc	- Pointer to the reference of the device handler.
[in]	param	- Initialization structure.

Returns

0 in case of success, negative error code otherwise

generic_timer_remove()

int32_t generic_timer_remove

(

struct no_os_timer_desc *

desc

)

Free the memory allocated by timer_setup().

Parameters

[in]

desc

- Pointer to the device handler.

Returns

0 in case of success, negative error code otherwise

generic_timer_start()

int32_t generic_timer_start

(

struct no_os_timer_desc *

desc

)

Start a timer.

Parameters

[in]

desc

- Pointer to the device handler.

Returns

0 in case of success, negative error code otherwise

generic_timer_stop()

int32_t generic_timer_stop

(

struct no_os_timer_desc *

desc

)

Stop a timer from counting.

Parameters

[in]

desc

- Pointer to the device handler.

Returns

0 in case of success, negative error code otherwise

Variable Documentation

generic_timer_ops

const struct no_os_timer_platform_ops generic_timer_ops

Initial value:

= {
    .init = &generic_timer_init,
    .start = &generic_timer_start,
    .stop = &generic_timer_stop,
    .counter_get = &generic_timer_counter_get,
    .counter_set = &generic_timer_counter_set,
    .count_clk_get = &generic_timer_count_clk_get,
    .count_clk_set = &generic_timer_count_clk_set,
    .get_elapsed_time_nsec = &generic_timer_get_elapsed_time_nsec,
    .remove = &generic_timer_remove
}

generic platform specific timer platform ops structure