source: rtems/bsps/m68k/mcf5206elite/include/nvram.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.9 KB
Line 
1/*
2 * nvram.h -- DS1307-based non-volatile memory device driver.
3 *
4 * This driver support file-like operations to 56-bytes long non-volatile
5 * memory of DS1307 I2C real-time clock chip.
6 *
7 * Copyright (C) 2000 OKTET Ltd., St.-Petersburg, Russia
8 * Author: Victor V. Vengerov <vvv@oktet.ru>
9 *
10 * The license and distribution terms for this file may be
11 * found in the file LICENSE in this distribution or at
12 *
13 * http://www.rtems.org/license/LICENSE.
14 */
15
16#ifndef __DRIVER__NVRAM_H__
17#define __DRIVER__NVRAM_H__
18
19#ifdef __cplusplus
20extern "C" {
21#endif
22
23#define NVRAM_DRIVER_TABLE_ENTRY \
24  { nvram_driver_initialize, nvram_driver_open, nvram_driver_close, \
25    nvram_driver_read, nvram_driver_write, NULL }
26
27/* nvram_driver_initialize --
28 *     Non-volatile memory device driver initialization.
29 */
30rtems_device_driver
31nvram_driver_initialize(rtems_device_major_number major,
32                        rtems_device_minor_number minor,
33                        void *arg);
34
35/* nvram_driver_open --
36 *     Non-volatile memory device driver open primitive.
37 */
38rtems_device_driver
39nvram_driver_open(rtems_device_major_number major,
40                  rtems_device_minor_number minor,
41                  void *arg);
42
43/* nvram_driver_close --
44 *     Non-volatile memory device driver close primitive.
45 */
46rtems_device_driver
47nvram_driver_close(rtems_device_major_number major,
48                   rtems_device_minor_number minor,
49                   void *arg);
50
51/* nvram_driver_read --
52 *     Non-volatile memory device driver read primitive.
53 */
54rtems_device_driver
55nvram_driver_read(rtems_device_major_number major,
56                  rtems_device_minor_number minor,
57                  void *arg);
58
59/* nvram_driver_write --
60 *     Non-volatile memory device driver write primitive.
61 */
62rtems_device_driver
63nvram_driver_write(rtems_device_major_number major,
64                   rtems_device_minor_number minor,
65                   void *arg);
66
67#ifdef __cplusplus
68}
69#endif
70
71#endif /* __VFDDRV_H__ */
Note: See TracBrowser for help on using the repository browser.