pico_timer.c File Reference

Implementation of pico timer driver. More...

#include "no_os_error.h"
#include "no_os_util.h"
#include "no_os_timer.h"
#include "no_os_alloc.h"
#include "pico_timer.h"
#include "hardware/timer.h"
#include "hardware/irq.h"

Include dependency graph for pico_timer.c:

Macros
#define	PICO_ALARM_MAX_NB   4

Functions
int32_t	pico_timer_init (struct no_os_timer_desc **desc, const struct no_os_timer_init_param *param)
	Initialize the timer peripheral. More...
int32_t	pico_timer_remove (struct no_os_timer_desc *desc)
	Free the resources allocated by no_os_timer_init(). More...
int32_t	pico_timer_start (struct no_os_timer_desc *desc)
	Start a timer. More...
int32_t	pico_timer_stop (struct no_os_timer_desc *desc)
	Stop a timer from counting. More...
int32_t	pico_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	pico_timer_counter_set (struct no_os_timer_desc *desc, uint32_t new_val)
	Set the timer counter register value. More...
int32_t	pico_timer_count_clk_get (struct no_os_timer_desc *desc, uint32_t *freq_hz)
	Get the timer clock frequency. More...
int32_t	pico_timer_count_clk_set (struct no_os_timer_desc *desc, uint32_t freq_hz)
	Set the timer clock frequency. More...
int32_t	pico_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
struct no_os_timer_desc *	pico_alarm_desc [PICO_ALARM_MAX_NB] = {NULL}
const struct no_os_timer_platform_ops	pico_timer_ops
	pico platform specific timer platform ops structure More...

Detailed Description

Implementation of pico timer driver.

Author

RBolboac (ramon.nosp@m.a.bo.nosp@m.lboac.nosp@m.a@an.nosp@m.alog..nosp@m.com)

Copyright 2022(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.

Macro Definition Documentation

PICO_ALARM_MAX_NB

#define PICO_ALARM_MAX_NB   4

Function Documentation

pico_timer_count_clk_get()

int32_t pico_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.

pico_timer_count_clk_set()

int32_t pico_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.

pico_timer_counter_get()

int32_t pico_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

-ENOSYS

pico_timer_counter_set()

int32_t pico_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

-ENOSYS

pico_timer_get_elapsed_time_nsec()

int32_t pico_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.

pico_timer_init()

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

Initialize the timer peripheral.

Parameters

desc	- The timer descriptor.
param	- The structure that contains the timer parameters.

Returns

0 in case of success, error code otherwise.

pico_timer_remove()

int32_t pico_timer_remove

(

struct no_os_timer_desc *

desc

)

Free the resources allocated by no_os_timer_init().

Parameters

desc	- The timer descriptor.

Returns

0 in case of success, error code otherwise.

pico_timer_start()

int32_t pico_timer_start

(

struct no_os_timer_desc *

desc

)

Start a timer.

Parameters

desc	- Pointer to the device handler.

Returns

0 in case of success, error code otherwise.

pico_timer_stop()

int32_t pico_timer_stop

(

struct no_os_timer_desc *

desc

)

Stop a timer from counting.

Parameters

desc	- Pointer to the device handler.

Returns

0 in case of success, error code otherwise.

Variable Documentation

pico_alarm_desc

struct no_os_timer_desc* pico_alarm_desc[PICO_ALARM_MAX_NB] = {NULL}

pico_timer_ops

const struct no_os_timer_platform_ops pico_timer_ops

Initial value:

= {
    .init = &pico_timer_init,
    .start = &pico_timer_start,
    .stop = &pico_timer_stop,
    .counter_get = &pico_timer_counter_get,
    .counter_set = &pico_timer_counter_set,
    .count_clk_get = &pico_timer_count_clk_get,
    .count_clk_set = &pico_timer_count_clk_set,
    .get_elapsed_time_nsec = &pico_timer_get_elapsed_time_nsec,
    .remove = &pico_timer_remove
}

pico platform specific timer platform ops structure

pico specific timer platform ops structure