Files
rtems/bsps/arm/lpc176x/include/bsp/io.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

89 lines
2.1 KiB
C

/**
* @file io.h
*
* @ingroup lpc176x
*
* @brief Input/output module methods definitions.
*/
/*
* Copyright (c) 2014 Taller Technologies.
*
* @author Boretto Martin (martin.boretto@tallertechnologies.com)
* @author Diaz Marcos (marcos.diaz@tallertechnologies.com)
* @author Lenarduzzi Federico (federico.lenarduzzi@tallertechnologies.com)
* @author Daniel Chicco (daniel.chicco@tallertechnologies.com)
*
* 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_ARM_LPC176X_IO_H
#define LIBBSP_ARM_LPC176X_IO_H
#include <assert.h>
#include <rtems.h>
#include <bsp/io-defs.h>
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
/**
* @brief Sets pin to the selected function.
*
* @param pin The pin to set.
* @param function Defines the function to set.
*/
void lpc176x_pin_select(
uint32_t pin,
lpc176x_pin_function function
);
/**
* @brief Sets pin to the selected mode.
*
* @param pin The pin to set.
* @param mode Defines the mode to set.
*/
void lpc176x_pin_set_mode(
const uint32_t pin,
const lpc176x_pin_mode mode
);
/**
* @brief Enables the module power and clock.
*
* @param module Represents the module to be enabled.
* @param clock Represents the clock to set for this module.
* @return RTEMS_SUCCESFULL if the module was enabled succesfully.
*/
rtems_status_code lpc176x_module_enable(
lpc176x_module module,
lpc176x_module_clock clock
);
/**
* @brief Checks if the current module is turned off and disables a module.
*
* @param module Represents the module to be disabled.
* @return RTEMS_SUCCESFULL if the module was disabled succesfully.
*/
rtems_status_code lpc176x_module_disable( lpc176x_module module );
/**
* @brief Checks if the current module is enabled or not.
*
* @param module Represents the module to be checked.
* @return TRUE if the module is enabled.
* FALSE otherwise.
*/
bool lpc176x_module_is_enabled( lpc176x_module module );
#ifdef __cplusplus
}
#endif /* __cplusplus */
#endif /* LIBBSP_ARM_LPC176X_IO_H */