rtems/score/watchdogticks.h

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /**
0004  * @file
0005  *
0006  * @ingroup RTEMSScoreWatchdog
0007  *
0008  * @brief This header file provides the interfaces of the
0009  *   @ref RTEMSScoreWatchdog related to watchdog ticks which are used by the
0010  *   implementation and the @ref RTEMSImplApplConfig.
0011  */
0012
0013 /*
0014  *  COPYRIGHT (c) 1989-2009.
0015  *  On-Line Applications Research Corporation (OAR).
0016  *
0017  * Redistribution and use in source and binary forms, with or without
0018  * modification, are permitted provided that the following conditions
0019  * are met:
0020  * 1. Redistributions of source code must retain the above copyright
0021  *    notice, this list of conditions and the following disclaimer.
0022  * 2. Redistributions in binary form must reproduce the above copyright
0023  *    notice, this list of conditions and the following disclaimer in the
0024  *    documentation and/or other materials provided with the distribution.
0025  *
0026  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
0027  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
0028  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
0029  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
0030  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
0031  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
0032  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
0033  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
0034  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
0035  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
0036  * POSSIBILITY OF SUCH DAMAGE.
0037  */
0038
0039 #ifndef _RTEMS_SCORE_WATCHDOGTICKS_H
0040 #define _RTEMS_SCORE_WATCHDOGTICKS_H
0041
0042 #include <rtems/score/basedefs.h>
0043
0044 #ifdef __cplusplus
0045 extern "C" {
0046 #endif
0047
0048 /**
0049  * @addtogroup RTEMSScoreWatchdog
0050  *
0051  * @{
0052  */
0053
0054 /**
0055  *  @brief Type is used to specify the length of intervals.
0056  *
0057  *  This type is used to specify the length of intervals.
0058  */
0059 typedef uint32_t   Watchdog_Interval;
0060
0061 /**
0062  * @brief Special watchdog ticks value to indicate an infinite wait.
0063  */
0064 #define WATCHDOG_NO_TIMEOUT 0
0065
0066 /**
0067  * @brief Default value for the watchdog ticks per timeslice.
0068  */
0069 #define WATCHDOG_TICKS_PER_TIMESLICE_DEFAULT 50
0070
0071 /**
0072  * @brief The watchdog ticks counter.
0073  *
0074  * With a 1ms watchdog tick, this counter overflows after 50 days since boot.
0075  */
0076 extern volatile Watchdog_Interval _Watchdog_Ticks_since_boot;
0077
0078 /**
0079  * @brief The watchdog microseconds per tick.
0080  *
0081  * This constant is defined by the application configuration via
0082  * <rtems/confdefs.h>.
0083  */
0084 extern const uint32_t _Watchdog_Microseconds_per_tick;
0085
0086 /**
0087  * @brief The watchdog nanoseconds per tick.
0088  *
0089  * This constant is defined by the application configuration via
0090  * <rtems/confdefs.h>.
0091  */
0092 extern const uint32_t _Watchdog_Nanoseconds_per_tick;
0093
0094 /**
0095  * @brief The watchdog ticks per second.
0096  *
0097  * This constant is defined by the application configuration via
0098  * <rtems/confdefs.h>.
0099  */
0100 extern const uint32_t _Watchdog_Ticks_per_second;
0101
0102 /**
0103  * @brief The watchdog ticks per timeslice.
0104  *
0105  * This constant is defined by the application configuration via
0106  * <rtems/confdefs.h>.
0107  */
0108 extern const uint32_t _Watchdog_Ticks_per_timeslice;
0109
0110 /** @} */
0111
0112 #ifdef __cplusplus
0113 }
0114 #endif
0115
0116 #endif
0117 /* end of include file */