Files
rtems/bsps/sparc/leon3/include/bsp/watchdog.h
Chris Johns 2afb22b7e1 Remove make preinstall
A speciality of the RTEMS build system was the make preinstall step.  It
copied header files from arbitrary locations into the build tree.  The
header files were included via the -Bsome/build/tree/path GCC command
line option.

This has at least seven problems:

* The make preinstall step itself needs time and disk space.

* Errors in header files show up in the build tree copy.  This makes it
  hard for editors to open the right file to fix the error.

* There is no clear relationship between source and build tree header
  files.  This makes an audit of the build process difficult.

* The visibility of all header files in the build tree makes it
  difficult to enforce API barriers.  For example it is discouraged to
  use BSP-specifics in the cpukit.

* An introduction of a new build system is difficult.

* Include paths specified by the -B option are system headers.  This
  may suppress warnings.

* The parallel build had sporadic failures on some hosts.

This patch removes the make preinstall step.   All installed header
files are moved to dedicated include directories in the source tree.
Let @RTEMS_CPU@ be the target architecture, e.g. arm, powerpc, sparc,
etc.  Let @RTEMS_BSP_FAMILIY@ be a BSP family base directory, e.g.
erc32, imx, qoriq, etc.

The new cpukit include directories are:

* cpukit/include

* cpukit/score/cpu/@RTEMS_CPU@/include

* cpukit/libnetworking

The new BSP include directories are:

* bsps/include

* bsps/@RTEMS_CPU@/include

* bsps/@RTEMS_CPU@/@RTEMS_BSP_FAMILIY@/include

There are build tree include directories for generated files.

The include directory order favours the most general header file, e.g.
it is not possible to override general header files via the include path
order.

The "bootstrap -p" option was removed.  The new "bootstrap -H" option
should be used to regenerate the "headers.am" files.

Update #3254.
2018-01-25 08:45:26 +01:00

50 lines
1.2 KiB
C

/* watchdog.h
*
* The LEON3 BSP timer watch-dog interface
*
* COPYRIGHT (c) 2012.
* Cobham Gaisler AB.
*
* The license and distribution terms for this file may be
* found in the file LICENSE in this distribution or at
* http://www.rtems.org/license/LICENSE.
*/
#ifndef __WATCHDOG_H__
#define __WATCHDOG_H__
#ifdef __cplusplus
extern "C" {
#endif
/* Initialize BSP watchdog routines. Returns number of watchdog timers found.
* Currently only one is supported.
*/
int bsp_watchdog_init(void);
/* Reload watchdog (last timer on the first GPTIMER core), all systems does not
* feature a watchdog, it is expected that if this function is called the
* user knows that there is a watchdog available.
*
* The prescaler is normally set to number of MHz of system, this is to
* make the system clock tick be stable.
*
* Arguments
* watchdog - Always 0 for now
* reload_value - Number of timer clocks (after prescaler) to count before
* watchdog is woken.
*/
void bsp_watchdog_reload(int watchdog, unsigned int reload_value);
/* Stop watchdog timer */
void bsp_watchdog_stop(int watchdog);
/* Use watchdog0 timer to reset the system */
void bsp_watchdog_system_reset(void);
#ifdef __cplusplus
}
#endif
#endif