source: rtems/cpukit/include/rtems/devzero.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 rtems/devzero.h
3 *
4 * @brief RTEMS /dev/zero Device Driver
5 *
6 * This include file defines the interface to the RTEMS /dev/zero
7 * device driver.
8 */
9
10/*
11 * Copyright (c) 2011 embedded brains GmbH.  All rights reserved.
12 *
13 * embedded brains GmbH
14 * Obere Lagerstr. 30
15 * 82178 Puchheim
16 * Germany
17 * <rtems@embedded-brains.de>
18 *
19 * The license and distribution terms for this file may be
20 * found in the file LICENSE in this distribution or at
21 * http://www.rtems.org/license/LICENSE.
22 */
23
24#ifndef _RTEMS_DEVZERO_H
25#define _RTEMS_DEVZERO_H
26
27#include <rtems/io.h>
28
29/**
30 *  @defgroup libmisc_devzero Zero Device Driver
31 *
32 *  @ingroup libmisc
33 */
34/**@{*/
35
36#ifdef __cplusplus
37extern "C" {
38#endif /* __cplusplus */
39
40#define DEVZERO_DEVICE_NAME "/dev/zero"
41
42#define DEVZERO_DRIVER_TABLE_ENTRY \
43  { \
44    dev_zero_initialize, \
45    dev_zero_open, \
46    dev_zero_close, \
47    dev_zero_read, \
48    dev_zero_write, \
49    dev_zero_control \
50  }
51
52rtems_device_driver dev_zero_initialize(
53  rtems_device_major_number major,
54  rtems_device_minor_number minor,
55  void *arg
56);
57
58rtems_device_driver dev_zero_open(
59  rtems_device_major_number major,
60  rtems_device_minor_number minor,
61  void *arg
62);
63
64rtems_device_driver dev_zero_close(
65  rtems_device_major_number major,
66  rtems_device_minor_number minor,
67  void *arg
68);
69
70rtems_device_driver dev_zero_read(
71  rtems_device_major_number major,
72  rtems_device_minor_number minor,
73  void *arg
74);
75
76rtems_device_driver dev_zero_write(
77  rtems_device_major_number major,
78  rtems_device_minor_number minor,
79  void *arg
80);
81
82rtems_device_driver dev_zero_control(
83  rtems_device_major_number major,
84  rtems_device_minor_number minor,
85  void *arg
86);
87
88#ifdef __cplusplus
89}
90#endif /* __cplusplus */
91/**@}*/
92#endif /* _RTEMS_DEVZERO_H */
Note: See TracBrowser for help on using the repository browser.