Hardware Libraries  20.1
Stratix 10 SoC Hardware Manager
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups
alt_watchdog.h
1 /******************************************************************************
2 *
3 * Copyright 2013,2017 Altera Corporation. All Rights Reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are met:
7 *
8 * 1. Redistributions of source code must retain the above copyright notice,
9 * this list of conditions and the following disclaimer.
10 *
11 * 2. Redistributions in binary form must reproduce the above copyright notice,
12 * this list of conditions and the following disclaimer in the documentation
13 * and/or other materials provided with the distribution.
14 *
15 * 3. Neither the name of the copyright holder nor the names of its contributors
16 * may be used to endorse or promote products derived from this software without
17 * specific prior written permission.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
20 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
23 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 * POSSIBILITY OF SUCH DAMAGE.
30 *
31 ******************************************************************************/
32 
33 /*
34  * $Id: //acds/main/embedded/ip/hps/armv8/hwlib/include/alt_watchdog.h#1 $
35  */
36 
37 #ifndef __ALT_WDOG_H__
38 #define __ALT_WDOG_H__
39 
40 #include "hwlib.h"
41 
42 #ifdef __cplusplus
43 extern "C" {
44 #endif /* __cplusplus */
45 
80 /******************************************************************************/
81 
86 typedef enum ALT_WDOG_TIMER_e {
87  /* OSC1 Clock Group */
94 
101 
108 
115 
125 
135 
145 
155 
157 
158 /******************************************************************************/
163 typedef enum ALT_WDOG_TIMEOUT_e {
168 
173 
178 
183 
188 
193 
198 
203 
208 
213 
218 
223 
228 
233 
239 
245 
246 /******************************************************************************/
251 typedef enum ALT_WDOG_RESET_TYPE_e {
256 
264 
272 
274 
275 /******************************************************************************/
283 /******************************************************************************/
290 ALT_STATUS_CODE alt_wdog_init(void);
291 
292 /******************************************************************************/
299 ALT_STATUS_CODE alt_wdog_uninit(void);
300 
301 /******************************************************************************/
313 ALT_STATUS_CODE alt_wdog_stop(ALT_WDOG_TIMER_t tmr_id);
314 
315 /******************************************************************************/
326 ALT_STATUS_CODE alt_wdog_start(ALT_WDOG_TIMER_t tmr_id);
327 
328 /******************************************************************************/
339 
340 /******************************************************************************/
356 ALT_STATUS_CODE alt_wdog_reset(ALT_WDOG_TIMER_t tmr_id);
357 
359 /******************************************************************************/
368 /******************************************************************************/
390 ALT_STATUS_CODE alt_wdog_counter_set(ALT_WDOG_TIMER_t tmr_id, ALT_WDOG_TIMEOUT_t val);
391 
392 /******************************************************************************/
403 
404 /******************************************************************************/
416 
417 /******************************************************************************/
432 
433 /******************************************************************************/
448 
449 /******************************************************************************/
464 
465 /******************************************************************************/
478 
479 /******************************************************************************/
492 
493 
494 /******************************************************************************/
507 
509 /******************************************************************************/
518 /******************************************************************************/
519 
520 /******************************************************************************/
533 
534 /******************************************************************************/
545 
546 /******************************************************************************/
557 ALT_STATUS_CODE alt_wdog_int_clear(ALT_WDOG_TIMER_t tmr_id);
558 
559 /******************************************************************************/
572 
573 /******************************************************************************/
595 ALT_STATUS_CODE alt_wdog_response_mode_set(ALT_WDOG_TIMER_t tmr_id,
596  ALT_WDOG_RESET_TYPE_t type);
597 
598 /******************************************************************************/
611 
612 
613 /******************************************************************************/
624 uint32_t alt_wdog_compcode_get(ALT_WDOG_TIMER_t tmr_id);
625 
626 /******************************************************************************/
636 uint32_t alt_wdog_ver_get(ALT_WDOG_TIMER_t tmr_id);
637 
638 
639 /******************************************************************************/
640 
643 #ifdef __cplusplus
644 }
645 #endif /* __cplusplus */
646 #endif /* __ALT_WDOG_H__ */