Files
rtems/bsps/include/bsp/fdt.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

68 lines
1.6 KiB
C

/*
* Copyright (c) 2015, 2017 embedded brains GmbH. All rights reserved.
*
* embedded brains GmbH
* Dornierstr. 4
* 82178 Puchheim
* Germany
* <rtems@embedded-brains.de>
*
* 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 LIBBSP_SHARED_FDT_H
#define LIBBSP_SHARED_FDT_H
#include <bsp.h>
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
/*
* BSPs that implement the FDT support functions must define
* BSP_FDT_IS_SUPPORTED.
*/
/**
* @brief Copies the specified source FDT to a dedicated global data area.
*
* The source FDT is usually provided by a bootloader and may be located in a
* memory area that is used by the program. The low-level initialization
* should copy the FDT for later use.
*
* The copy can be accessed by bsp_fdt_get().
*
* @param[in] src The source FDT.
*/
void bsp_fdt_copy(const void *src);
/**
* @brief Returns the FDT of the BSP.
*
* @return The FDT of the BSP.
*/
const void *bsp_fdt_get(void);
/**
* @brief Maps the interrupt number of the FDT to the interrupt vector used by
* the interrupt management.
*
* This function is used by the libbsd to implement the OFW_BUS_MAP_INTR bus
* method.
*
* @param[in] intr The FDT interrupt number cells.
* @param[in] icells The FDT interrupt cell count.
*
* @return The interrupt vector of the FDT interrupt number.
*/
uint32_t bsp_fdt_map_intr(const uint32_t *intr, size_t icells);
#ifdef __cplusplus
}
#endif /* __cplusplus */
#endif /* LIBBSP_SHARED_FDT_H */