no-OS
Functions
timer.c File Reference

Timer and GIC control module source. More...

#include <stdlib.h>
#include <xparameters.h>
#include "no-os/timer.h"
#include "timer_extra.h"
#include "no-os/error.h"
Include dependency graph for timer.c:

Functions

int32_t timer_init (struct timer_desc **desc, struct timer_init_param *param)
 Initialize hardware timer and the handler structure associated with it. More...
 
int32_t timer_remove (struct timer_desc *desc)
 Free the memory allocated by timer_setup(). More...
 
int32_t timer_start (struct timer_desc *desc)
 Start a timer. More...
 
int32_t timer_stop (struct timer_desc *desc)
 Stop a timer from counting. More...
 
int32_t timer_counter_get (struct timer_desc *desc, uint32_t *counter)
 Get the current counter value of the timer. More...
 
int32_t timer_counter_set (struct timer_desc *desc, uint32_t new_val)
 Set the current counter value of the timer. More...
 
int32_t timer_count_clk_get (struct timer_desc *desc, uint32_t *freq_hz)
 Get the timer clock frequency. More...
 
int32_t timer_count_clk_set (struct timer_desc *desc, uint32_t freq_hz)
 Set the timer clock frequency. More...
 

Detailed Description

Timer and GIC 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 2020(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:

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

◆ timer_count_clk_get()

int32_t timer_count_clk_get ( struct timer_desc desc,
uint32_t *  freq_hz 
)

Get the timer clock frequency.

Get the frequency the timer counts with.

Parameters
[in]desc- Pointer to the device handler.
[out]freq_hz- Pointer to the returned frequency.
Returns
SUCCESS in case of success, FAILURE otherwise

◆ timer_count_clk_set()

int32_t timer_count_clk_set ( struct timer_desc desc,
uint32_t  freq_hz 
)

Set the timer clock frequency.

Set the frequency the timer counts with.

Parameters
[in]desc- Pointer to the device handler.
[in]freq_hz- New timer frequency in hertz.
Returns
SUCCESS in case of success, FAILURE otherwise

◆ timer_counter_get()

int32_t timer_counter_get ( struct timer_desc desc,
uint32_t *  counter 
)

Get the current counter value of the timer.

Get the value the timer is at.

Parameters
[in]desc- Pointer to the device handler.
[out]counter- Pointer to the current counter value.
Returns
SUCCESS in case of success, FAILURE otherwise

◆ timer_counter_set()

int32_t timer_counter_set ( struct timer_desc desc,
uint32_t  new_val 
)

Set the current counter value of the timer.

Set a new value for the timer.

Parameters
[in]desc- Pointer to the device handler.
[in]new_val- New value for the timer counter.
Returns
SUCCESS in case of success, FAILURE otherwise

◆ timer_init()

int32_t timer_init ( struct timer_desc **  desc,
struct timer_init_param param 
)

Initialize hardware timer and the handler structure associated with it.

Initialize a instance of a timer.

Parameters
[out]desc- Pointer to the reference of the device handler.
[in]param- Initialization structure.
Returns
SUCCESS in case of success, FAILURE otherwise
Here is the caller graph for this function:

◆ timer_remove()

int32_t timer_remove ( struct timer_desc desc)

Free the memory allocated by timer_setup().

Remove a instance of a timer.

Parameters
[in]desc- Pointer to the device handler.
Returns
SUCCESS in case of success, FAILURE otherwise

◆ timer_start()

int32_t timer_start ( struct timer_desc desc)

Start a timer.

Enable counting in the timer instance.

Parameters
[in]desc- Pointer to the device handler.
Returns
SUCCESS in case of success, FAILURE otherwise

◆ timer_stop()

int32_t timer_stop ( struct timer_desc desc)

Stop a timer from counting.

Stop counting the timer instance.

Parameters
[in]desc- Pointer to the device handler.
Returns
SUCCESS in case of success, FAILURE otherwise