source: rtems/cpukit/include/rtems/deviceio.h @ 7e86e00

5
Last change on this file since 7e86e00 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
3 *
4 * @brief Operations on IMFS Device Nodes
5 */
6
7/*
8 *  COPYRIGHT (c) 1989-2012.
9 *  On-Line Applications Research Corporation (OAR).
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 _RTEMS_DEVICEIO_H
17#define _RTEMS_DEVICEIO_H
18
19#include <rtems/libio.h>
20
21/**
22 *  @defgroup IMFSDevices IMFS Device IO Handler
23 *
24 *  @ingroup IMFS
25 *
26 *  This contains the interface to device drivers using the RTEMS Classic API.
27 */
28/**@{*/
29
30#ifdef __cplusplus
31extern "C" {
32#endif /* __cplusplus */
33
34/**
35 * @brief IMFS device node handlers.
36 *
37 * IMFS Device Node Handlers
38 *
39 * This file contains the set of handlers used to map operations on
40 * IMFS device nodes onto calls to the RTEMS Classic API IO Manager.
41 */
42int rtems_deviceio_open(
43  rtems_libio_t *iop,
44  const char *path,
45  int oflag,
46  mode_t mode,
47  rtems_device_major_number major,
48  rtems_device_minor_number minor
49);
50
51int rtems_deviceio_close(
52  rtems_libio_t *iop,
53  rtems_device_major_number major,
54  rtems_device_minor_number minor
55);
56
57ssize_t rtems_deviceio_read(
58  rtems_libio_t *iop,
59  void *buf,
60  size_t nbyte,
61  rtems_device_major_number major,
62  rtems_device_minor_number minor
63);
64
65ssize_t rtems_deviceio_write(
66  rtems_libio_t *iop,
67  const void *buf,
68  size_t nbyte,
69  rtems_device_major_number major,
70  rtems_device_minor_number minor
71);
72
73int rtems_deviceio_control(
74  rtems_libio_t *iop,
75  ioctl_command_t command,
76  void *buffer,
77  rtems_device_major_number major,
78  rtems_device_minor_number minor
79);
80
81#ifdef __cplusplus
82}
83#endif
84/* __cplusplus */
85
86/**@}*/
87
88#endif /* _RTEMS_DEVICEIO_H */
Note: See TracBrowser for help on using the repository browser.