source: rtems/bsps/include/rtems/umon.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.6 KB
Line 
1/*
2 * umon.h - RTEMS specific interface to MicroMonitor.
3 *
4 *  COPYRIGHT (c) 1989-2009.
5 *  On-Line Applications Research Corporation (OAR).
6 *
7 *  Modified by Fernando Nicodemos <fgnicodemos@terra.com.br>
8 *  from NCB - Sistemas Embarcados Ltda. (Brazil)
9 *
10 *  The license and distribution terms for this file may be
11 *  found in the file LICENSE in this distribution or at
12 *  http://www.rtems.org/license/LICENSE.
13*/
14
15#ifndef __rtems_umon_h
16#define __rtems_umon_h
17
18#include <umon/monlib.h>
19
20#ifdef __cplusplus
21extern "C" {
22#endif
23
24/**
25 * @brief Connect RTEMS Application to MicroMonitor
26 *
27 * RTEMS uMonitor wrapper for monConnect().  This will deal with the
28 * getting MONCOMPTR as well as providing the locking routines.
29 */
30void rtems_umon_connect(void);
31
32/**
33 * @brief Obtain BSP specific pointer to MicroMonitor
34 *
35 * BSP specific routine to help when calling monConnect().  This
36 * returns the value known to uMon as MONCOMPTR.
37 *
38 * @return This method returns the address of the base area of MicroMonitor.
39 */
40void *rtems_bsp_get_umon_monptr(void);
41
42/**
43 * @brief Initialize the TFS-RTEMS file system
44 *
45 * This method initializes and mounts the TFS-RTEMS file system.
46 *
47 * @param[in] path is the mount point
48 *
49 * @return This method returns 0 on success.
50 */
51int rtems_initialize_tfs_filesystem(
52  const char *path
53);
54
55/**
56 * @brief Read from MicroMonitor Port
57 *
58 * This method reads a character from the MicroMonitor console.
59 *
60 * @return This method returns a character.
61 */
62int umoncons_poll_read(int minor);
63
64#ifdef __cplusplus
65}
66#endif
67
68#endif /* __rtems_umon_h */
Note: See TracBrowser for help on using the repository browser.