source: rtems/bsps/powerpc/mpc55xxevb/include/bsp/console-generic.h @ 2afb22b

5
Last change on this file since 2afb22b was 2afb22b, checked in by Chris Johns <chrisj@…>, on Dec 23, 2017 at 7:18:56 AM

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.9 KB
Line 
1/**
2 * @file
3 *
4 * @brief Generic console driver API.
5 */
6
7/*
8 * Copyright (c) 2011 embedded brains GmbH.  All rights reserved.
9 *
10 *  embedded brains GmbH
11 *  Obere Lagerstr. 30
12 *  82178 Puchheim
13 *  Germany
14 *  <rtems@embedded-brains.de>
15 *
16 * The license and distribution terms for this file may be
17 * found in the file LICENSE in this distribution or at
18 * http://www.rtems.org/license/LICENSE.
19 */
20
21#ifndef LIBBSP_SHARED_CONSOLE_GENERIC_H
22#define LIBBSP_SHARED_CONSOLE_GENERIC_H
23
24#include <rtems/libio.h>
25#include <rtems/termiostypes.h>
26
27#ifdef __cplusplus
28extern "C" {
29#endif /* __cplusplus */
30
31typedef struct {
32  rtems_termios_callbacks termios_callbacks;
33  int (*poll_read)(int minor);
34  void (*poll_write)(int minor, char c);
35} console_generic_callbacks;
36
37typedef struct {
38  void *context;
39  const console_generic_callbacks *callbacks;
40  const char *device_path;
41} console_generic_info;
42
43extern const console_generic_info console_generic_info_table [];
44
45extern const size_t console_generic_info_count;
46
47extern const rtems_device_minor_number console_generic_minor;
48
49#define CONSOLE_GENERIC_INFO_TABLE \
50  const console_generic_info console_generic_info_table []
51
52#define CONSOLE_GENERIC_INFO(context, callbacks, device_path) \
53  { context, callbacks, device_path }
54
55#define CONSOLE_GENERIC_INFO_COUNT \
56  const size_t console_generic_info_count = \
57    sizeof(console_generic_info_table) / sizeof(console_generic_info_table [0])
58
59#define CONSOLE_GENERIC_MINOR(minor) \
60  const rtems_device_minor_number console_generic_minor = (minor)
61
62static inline void *console_generic_get_context(int minor)
63{
64  return console_generic_info_table [minor].context;
65}
66
67static inline struct rtems_termios_tty *console_generic_get_tty_at_open(
68  void *arg
69)
70{
71  const rtems_libio_open_close_args_t *oc =
72    (const rtems_libio_open_close_args_t *) arg;
73
74  return (struct rtems_termios_tty *) oc->iop->data1;
75}
76
77#ifdef __cplusplus
78}
79#endif /* __cplusplus */
80
81#endif /* LIBBSP_SHARED_CONSOLE_GENERIC_H */
Note: See TracBrowser for help on using the repository browser.