source: rtems/bsps/arm/lpc176x/include/bsp/watchdog.h @ 9964895

5
Last change on this file since 9964895 was 2afb22b, checked in by Chris Johns <chrisj@…>, on 12/23/17 at 07:18:56

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.
  • Property mode set to 100644
File size: 1.8 KB
Line 
1/**
2 * @file watchdog.h
3 *
4 * @ingroup lpc176x
5 *
6 * @brief API of the Watchdog driver for the lpc176x bsp in RTEMS.
7 */
8
9/*
10 * Copyright (c) 2014 Taller Technologies.
11 *
12 * @author  Boretto Martin    (martin.boretto@tallertechnologies.com)
13 * @author  Diaz Marcos (marcos.diaz@tallertechnologies.com)
14 * @author  Lenarduzzi Federico  (federico.lenarduzzi@tallertechnologies.com)
15 * @author  Daniel Chicco  (daniel.chicco@tallertechnologies.com)
16 *
17 * The license and distribution terms for this file may be
18 * found in the file LICENSE in this distribution or at
19 * http://www.rtems.org/license/LICENSE.
20 */
21
22#ifndef LIBBSP_ARM_LPC176X_WATCHDOG_H
23#define LIBBSP_ARM_LPC176X_WATCHDOG_H
24
25#include <bsp/watchdog-defs.h>
26
27#ifdef __cplusplus
28extern "C" {
29#endif /* __cplusplus */
30
31/**
32 * @brief Checks if the watchdog was executed by software or not. Set when
33 *        the watchdog timer times out, cleared by software.
34 *
35 * @return TRUE if the watchdog was executed.
36 *         FALSE otherwise.
37 */
38bool lpc176x_been_reset_by_watchdog( void );
39
40/**
41 * @brief Resets the watchdog timer.
42 */
43void lpc176x_watchdog_reset( void );
44
45/**
46 * @brief Configures the watchdog's timer.
47 *
48 * @param tcount Timer's out value.
49 * @return RTEMS_SUCCESSFUL if the watchdog was configured successfully.
50 */
51rtems_status_code lpc176x_watchdog_config( lpc176x_microseconds tcount );
52
53/**
54 * @brief Configures the timer watchdog using interrupt.
55 *
56 * @param tcount Timer's out value.
57 * @param interrupt Interrupt to register.
58 * @return RTEMS_SUCCESSFUL if the watchdog was configured successfully
59 *                          with interrupts.
60 */
61rtems_status_code lpc176x_watchdog_config_with_interrupt(
62  lpc176x_wd_isr_funct interrupt,
63  lpc176x_microseconds tcount
64);
65
66#ifdef __cplusplus
67}
68#endif /* __cplusplus */
69
70#endif  /* LIBBSP_ARM_LPC176X_WATCHDOG_H */
Note: See TracBrowser for help on using the repository browser.