source: rtems/bsps/arm/lpc176x/include/bsp/lpc-gpio.h @ c77cd426

5
Last change on this file since c77cd426 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: 2.5 KB
Line 
1/**
2 * @file lpc-gpio.h
3 *
4 * @ingroup lpc176x
5 *
6 * @brief API of the GPIO 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_GPIO_H
23#define LIBBSP_ARM_LPC176X_GPIO_H
24
25#include <bsp/lpc176x.h>
26#include <bsp/gpio-defs.h>
27
28#ifdef __cplusplus
29extern "C" {
30#endif /* __cplusplus */
31
32/**
33 * @brief Configures the pin as input or output GPIO.
34 *
35 * @param pin The pin to configure
36 * @param dir Input or output.
37 */
38rtems_status_code lpc176x_gpio_config(
39  lpc176x_pin_number     pin,
40  lpc176x_gpio_direction dir
41);
42
43/**
44 * @brief Configures the pin as input, enables interrupt for an
45 * edge/s and sets isrfunct as the function to call when that
46 * interrupt occurs.
47 *
48 * @param pin The pin to configure.
49 * @param edge Which edge or edges will activate the interrupt.
50 * @param isrfunct The function that is called when the interrupt occurs.
51 * @return RTEMS_SUCCESSFULL if the configurations was success.
52 */
53rtems_status_code lpc176x_gpio_config_input_with_interrupt(
54  lpc176x_pin_number              pin,
55  lpc176x_gpio_interrupt          edge,
56  lpc176x_gpio_interrupt_function isrfunct
57);
58
59/**
60 * @brief Sets the output pin to 1.
61 *
62 * @param pin The pin to set
63 */
64rtems_status_code lpc176x_gpio_set_pin( lpc176x_pin_number pin );
65
66/**
67 * @brief Sets the output pin to 0.
68 *
69 * @param pin The pin to set
70 */
71rtems_status_code lpc176x_gpio_clear_pin( lpc176x_pin_number pin );
72
73/**
74 * @brief Sets the output pin to 0 or 1 according to value.
75 *
76 * @param pin The pin to set
77 * @param value the value to set.
78 */
79rtems_status_code lpc176x_gpio_write_pin(
80  lpc176x_pin_number pin,
81  bool               value
82);
83
84/**
85 * @brief Returns the value at the given input pin.
86 *
87 * @param pin The pin where to read the value.
88 * @param pin_value TRUE if the pin value was getted successfuly.
89 * @return RTEMS_SUCCESSFUL if the pin value was getted successfuly.
90 */
91rtems_status_code lpc176x_gpio_get_pin_value(
92  lpc176x_pin_number pin,
93  bool              *pin_value
94);
95
96#ifdef __cplusplus
97}
98#endif /* __cplusplus */
99
100#endif /* LIBBSP_ARM_LPC176X_GPIO_H */
Note: See TracBrowser for help on using the repository browser.