source: rtems/bsps/arm/raspberrypi/include/bsp/rpi-gpio.h @ 2afb22b

5
Last change on this file since 2afb22b 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.7 KB
Line 
1/**
2 * @file rpi-gpio.h
3 *
4 * @ingroup raspberrypi_gpio
5 *
6 * @brief Raspberry Pi specific GPIO definitions.
7 */
8
9/*
10 *  Copyright (c) 2015 Andre Marques <andre.lousa.marques at gmail.com>
11 *
12 *  The license and distribution terms for this file may be
13 *  found in the file LICENSE in this distribution or at
14 *  http://www.rtems.org/license/LICENSE.
15 */
16
17#ifndef LIBBSP_ARM_RASPBERRYPI_RPI_GPIO_H
18#define LIBBSP_ARM_RASPBERRYPI_RPI_GPIO_H
19
20#include <rtems.h>
21
22#ifdef __cplusplus
23extern "C" {
24#endif /* __cplusplus */
25
26/**
27 * @brief  Raspberry Pi GPIO functions.
28 */
29#define RPI_DIGITAL_IN  0
30#define RPI_DIGITAL_OUT 1
31#define RPI_ALT_FUNC_0  4
32#define RPI_ALT_FUNC_1  5
33#define RPI_ALT_FUNC_2  6
34#define RPI_ALT_FUNC_3  7
35#define RPI_ALT_FUNC_4  3
36#define RPI_ALT_FUNC_5  2
37#define RPI_ALT_FUNC_MASK 7
38
39/**
40 * @brief Setups a JTAG interface.
41 *
42 * @retval RTEMS_SUCCESSFUL JTAG interface successfully configured.
43 * @retval * At least one of the required pins is currently
44 *            occupied, @see rtems_gpio_request_pin_group().
45 */
46extern rtems_status_code rpi_gpio_select_jtag(void);
47
48/**
49 * @brief Setups a SPI interface.
50 *
51 * @retval RTEMS_SUCCESSFUL SPI interface successfully configured.
52 * @retval * At least one of the required pins is currently
53 *            occupied, @see rtems_gpio_request_pin_group().
54 */
55extern rtems_status_code rpi_gpio_select_spi(void);
56
57/**
58 * @brief Setups a I2C interface.
59 *
60 * @retval RTEMS_SUCCESSFUL I2C interface successfully configured.
61 * @retval * At least one of the required pins is currently
62 *            occupied, @see rtems_gpio_request_pin_group().
63 */
64extern rtems_status_code rpi_gpio_select_i2c(void);
65
66#ifdef __cplusplus
67}
68#endif /* __cplusplus */
69
70#endif /* LIBBSP_ARM_RASPBERRYPI_RPI_GPIO_H */
Note: See TracBrowser for help on using the repository browser.