source: rtems/bsps/include/bsp/console-polled.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: 990 bytes
Line 
1/**
2 * @file
3 *
4 * @ingroup Console
5 *
6 * This file defines the interfaces between the single port
7 * polled console framework and the BSP.
8 */
9
10/*
11 *  The license and distribution terms for this file may be
12 *  found in the file LICENSE in this distribution or at
13 *  http://www.rtems.org/license/LICENSE.
14 */
15
16#ifndef __BSP_CONSOLE_POLLED_h
17#define __BSP_CONSOLE_POLLED_h
18
19/**
20 * This method polls the specified character @a ch to the specified
21 * console @a port.
22 *
23 * @param[in] port is the output port
24 * @param[in] ch is the character to print
25 */
26void console_outbyte_polled(int port, char ch);
27
28/**
29 * This method polls the specified @a port for an input character.
30 * console @a port.
31 *
32 * @param[in] port is the input port
33 *
34 * @return This method returns the character read of -1 if there is no data.
35 */
36int console_inbyte_nonblocking(int port);
37
38/**
39 * This method is invoked to initialize the console hardware device(s).
40 */
41void console_initialize_hardware(void);
42
43#endif
Note: See TracBrowser for help on using the repository browser.