NEORV32 - Software Framework Documentation
Loading...
Searching...
No Matches
neorv32_gptmr.h
Go to the documentation of this file.
1// #################################################################################################
2// # << NEORV32: neorv32_gptmr.h - General Purpose Timer (GPTMR) HW Driver >> #
3// # ********************************************************************************************* #
4// # BSD 3-Clause License #
5// # #
6// # Copyright (c) 2024, Stephan Nolting. All rights reserved. #
7// # #
8// # Redistribution and use in source and binary forms, with or without modification, are #
9// # permitted provided that the following conditions are met: #
10// # #
11// # 1. Redistributions of source code must retain the above copyright notice, this list of #
12// # conditions and the following disclaimer. #
13// # #
14// # 2. Redistributions in binary form must reproduce the above copyright notice, this list of #
15// # conditions and the following disclaimer in the documentation and/or other materials #
16// # provided with the distribution. #
17// # #
18// # 3. Neither the name of the copyright holder nor the names of its contributors may be used to #
19// # endorse or promote products derived from this software without specific prior written #
20// # permission. #
21// # #
22// # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS #
23// # OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF #
24// # MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE #
25// # COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, #
26// # EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE #
27// # GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED #
28// # AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING #
29// # NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED #
30// # OF THE POSSIBILITY OF SUCH DAMAGE. #
31// # ********************************************************************************************* #
32// # The NEORV32 Processor - https://github.com/stnolting/neorv32 (c) Stephan Nolting #
33// #################################################################################################
34
35
36/**********************************************************************/
43#ifndef neorv32_gptmr_h
44#define neorv32_gptmr_h
45
46/**********************************************************************/
51typedef volatile struct __attribute__((packed,aligned(4))) {
52 uint32_t CTRL;
53 uint32_t THRES;
54 uint32_t COUNT;
55 uint32_t CAPTURE;
57
59#define NEORV32_GPTMR ((neorv32_gptmr_t*) (NEORV32_GPTMR_BASE))
60
79/**********************************************************************/
84void neorv32_gptmr_setup(int prsc, uint32_t threshold, int match_irq);
85void neorv32_gptmr_capture(int rising, int falling, int filter, int capture_irq);
86void neorv32_gptmr_disable(void);
87void neorv32_gptmr_enable(void);
90void neorv32_gptmr_restart(void);
91uint32_t neorv32_gptmr_counter_get(void);
92uint32_t neorv32_gptmr_capture_get(void);
96#endif // neorv32_gptmr_h
NEORV32_GPTMR_CTRL_enum
Definition neorv32_gptmr.h:62
@ GPTMR_CTRL_FILTER
Definition neorv32_gptmr.h:71
@ GPTMR_CTRL_PRSC2
Definition neorv32_gptmr.h:66
@ GPTMR_CTRL_PRSC1
Definition neorv32_gptmr.h:65
@ GPTMR_CTRL_TRIGM
Definition neorv32_gptmr.h:73
@ GPTMR_CTRL_FALL
Definition neorv32_gptmr.h:70
@ GPTMR_CTRL_IRQC
Definition neorv32_gptmr.h:68
@ GPTMR_CTRL_IRQM
Definition neorv32_gptmr.h:67
@ GPTMR_CTRL_RISE
Definition neorv32_gptmr.h:69
@ GPTMR_CTRL_EN
Definition neorv32_gptmr.h:63
@ GPTMR_CTRL_PRSC0
Definition neorv32_gptmr.h:64
@ GPTMR_CTRL_TRIGC
Definition neorv32_gptmr.h:74
void neorv32_gptmr_restart(void)
Definition neorv32_gptmr.c:165
void neorv32_gptmr_capture(int rising, int falling, int filter, int capture_irq)
Definition neorv32_gptmr.c:93
uint32_t neorv32_gptmr_capture_get(void)
Definition neorv32_gptmr.c:187
void neorv32_gptmr_enable(void)
Definition neorv32_gptmr.c:116
void neorv32_gptmr_disable(void)
Definition neorv32_gptmr.c:107
uint32_t neorv32_gptmr_counter_get(void)
Definition neorv32_gptmr.c:176
int neorv32_gptmr_trigger_matched(void)
Definition neorv32_gptmr.c:127
void neorv32_gptmr_setup(int prsc, uint32_t threshold, int match_irq)
Definition neorv32_gptmr.c:70
int neorv32_gptmr_trigger_captured(void)
Definition neorv32_gptmr.c:147
int neorv32_gptmr_available(void)
Definition neorv32_gptmr.c:52
Definition neorv32_gptmr.h:51
uint32_t COUNT
Definition neorv32_gptmr.h:54
uint32_t CTRL
Definition neorv32_gptmr.h:52
uint32_t CAPTURE
Definition neorv32_gptmr.h:55
uint32_t THRES
Definition neorv32_gptmr.h:53