include/bsp/watchdog.h

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /*  watchdog.h
0004  *
0005  *  The LEON3 BSP timer watch-dog interface
0006  *
0007  *  COPYRIGHT (c) 2012.
0008  *  Cobham Gaisler AB.
0009  *
0010  * Redistribution and use in source and binary forms, with or without
0011  * modification, are permitted provided that the following conditions
0012  * are met:
0013  * 1. Redistributions of source code must retain the above copyright
0014  *    notice, this list of conditions and the following disclaimer.
0015  * 2. Redistributions in binary form must reproduce the above copyright
0016  *    notice, this list of conditions and the following disclaimer in the
0017  *    documentation and/or other materials provided with the distribution.
0018  *
0019  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
0020  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
0021  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
0022  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
0023  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
0024  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
0025  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
0026  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
0027  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
0028  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
0029  * POSSIBILITY OF SUCH DAMAGE.
0030  */
0031
0032 #ifndef __WATCHDOG_H__
0033 #define __WATCHDOG_H__
0034
0035 #ifdef __cplusplus
0036 extern "C" {
0037 #endif
0038
0039 /* Initialize BSP watchdog routines. Returns number of watchdog timers found.
0040  * Currently only one is supported.
0041  */
0042 int bsp_watchdog_init(void);
0043
0044 /* Reload watchdog (last timer on the first GPTIMER core), all systems does not
0045  * feature a watchdog, it is expected that if this function is called the
0046  * user knows that there is a watchdog available.
0047  *
0048  * The prescaler is normally set to number of MHz of system, this is to
0049  * make the system clock tick be stable.
0050  *
0051  * Arguments
0052  *  watchdog       - Always 0 for now
0053  *  reload_value   - Number of timer clocks (after prescaler) to count before
0054  *                   watchdog is woken.
0055  */
0056 void bsp_watchdog_reload(int watchdog, unsigned int reload_value);
0057
0058 /* Stop watchdog timer */
0059 void bsp_watchdog_stop(int watchdog);
0060
0061 /* Use watchdog0 timer to reset the system */
0062 void bsp_watchdog_system_reset(void);
0063
0064 #ifdef __cplusplus
0065 }
0066 #endif
0067
0068 #endif