OpenCores
URL https://opencores.org/ocsvn/neorv32/neorv32/trunk

Subversion Repositories neorv32

[/] [neorv32/] [trunk/] [sw/] [lib/] [source/] [neorv32_wdt.c] - Blame information for rev 61

Go to most recent revision | Details | Compare with Previous | View Log

Line No. Rev Author Line
1 2 zero_gravi
// #################################################################################################
2
// # << NEORV32: neorv32_wdt.c - Watchdog Timer (WDT) HW Driver >>                                 #
3
// # ********************************************************************************************* #
4
// # BSD 3-Clause License                                                                          #
5
// #                                                                                               #
6 44 zero_gravi
// # Copyright (c) 2021, Stephan Nolting. All rights reserved.                                     #
7 2 zero_gravi
// #                                                                                               #
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
/**********************************************************************//**
37
 * @file neorv32_wdt.c
38
 * @author Stephan Nolting
39
 * @brief Watchdog Timer (WDT) HW driver source file.
40
 *
41 44 zero_gravi
 * @note These functions should only be used if the WDT unit was synthesized (IO_WDT_EN = true).
42 2 zero_gravi
 **************************************************************************/
43
 
44
#include "neorv32.h"
45
#include "neorv32_wdt.h"
46
 
47
 
48
/**********************************************************************//**
49
 * Check if WDT unit was synthesized.
50
 *
51
 * @return 0 if WDT was not synthesized, 1 if WDT is available.
52
 **************************************************************************/
53
int neorv32_wdt_available(void) {
54
 
55 12 zero_gravi
  if (SYSINFO_FEATURES & (1 << SYSINFO_FEATURES_IO_WDT)) {
56 2 zero_gravi
    return 1;
57
  }
58
  else {
59
    return 0;
60
  }
61
}
62
 
63
 
64
/**********************************************************************//**
65 47 zero_gravi
 * Configure and enable watchdog timer. The WDT control register bits are listed in #NEORV32_WDT_CT_enum.
66 2 zero_gravi
 *
67 61 zero_gravi
 * @param[in] prsc Clock prescaler to select timeout interval. See #NEORV32_CLOCK_PRSC_enum.
68 47 zero_gravi
 * @param[in] mode Trigger system reset on timeout when 1, trigger interrupt on timeout when 0.
69 61 zero_gravi
 * @param[in] lock Control register will be locked when 1 (until next reset).
70 2 zero_gravi
 **************************************************************************/
71 47 zero_gravi
void neorv32_wdt_setup(uint8_t prsc, uint8_t mode, uint8_t lock) {
72 2 zero_gravi
 
73 47 zero_gravi
  WDT_CT = (1 << WDT_CT_RESET); // reset WDT counter
74 2 zero_gravi
 
75 47 zero_gravi
  uint32_t prsc_int = (uint32_t)(prsc & 0x07);
76
  prsc_int = prsc_int << WDT_CT_CLK_SEL0;
77 2 zero_gravi
 
78 47 zero_gravi
  uint32_t mode_int = (uint32_t)(mode & 0x01);
79
  mode_int = mode_int << WDT_CT_MODE;
80 2 zero_gravi
 
81 47 zero_gravi
  uint32_t lock_int = (uint32_t)(lock & 0x01);
82
  lock_int = lock_int << WDT_CT_LOCK;
83 2 zero_gravi
 
84 47 zero_gravi
  const uint32_t enable = (uint32_t)(1 << WDT_CT_EN);
85
 
86
  // update WDT control register
87
  WDT_CT = enable | mode_int | prsc_int | lock_int;
88 2 zero_gravi
}
89
 
90
 
91
/**********************************************************************//**
92
 * Disable watchdog timer.
93 47 zero_gravi
 *
94 61 zero_gravi
 * @return Returns 0 if WDT is really deactivated, -1 otherwise.
95 2 zero_gravi
 **************************************************************************/
96 47 zero_gravi
int neorv32_wdt_disable(void) {
97
 
98
  WDT_CT = 0;
99 2 zero_gravi
 
100 47 zero_gravi
  // check if wdt is really off
101
  if (WDT_CT & (1 << WDT_CT_EN)) {
102
    return -1; // WDT still active
103
  }
104
  else {
105
    return 0;
106
  }
107 2 zero_gravi
}
108
 
109
 
110
/**********************************************************************//**
111
 * Reset (running) watchdog.
112
 **************************************************************************/
113
void neorv32_wdt_reset(void) {
114
 
115 47 zero_gravi
  WDT_CT = (1 << WDT_CT_RESET);
116 2 zero_gravi
}
117
 
118
 
119
/**********************************************************************//**
120 47 zero_gravi
 * Get cause of last system reset.
121 2 zero_gravi
 *
122 47 zero_gravi
 * @return Cause of last reset/IRQ (0: external reset, 1: watchdog timeout).
123 2 zero_gravi
 **************************************************************************/
124 47 zero_gravi
int neorv32_wdt_get_cause(void) {
125 2 zero_gravi
 
126 47 zero_gravi
  if (WDT_CT & (1 << WDT_CT_RCAUSE)) { // reset caused by watchdog
127
    return 1;
128 2 zero_gravi
  }
129
  else { // external reset
130 47 zero_gravi
    return 0;
131 2 zero_gravi
  }
132
}
133
 
134
 
135
/**********************************************************************//**
136 47 zero_gravi
 * Force immediate watchdog action (reset/IRQ).
137 2 zero_gravi
 **************************************************************************/
138
void neorv32_wdt_force(void) {
139
 
140 47 zero_gravi
  WDT_CT = WDT_CT | (1 << WDT_CT_FORCE);
141 2 zero_gravi
}

powered by: WebSVN 2.1.0

© copyright 1999-2024 OpenCores.org, equivalent to Oliscience, all rights reserved. OpenCores®, registered trademark.