source: rtems/cpukit/include/rtems/termios_printk.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: 5.0 KB
Line 
1/*===============================================================*\
2| Project: RTEMS remote gdb over serial line                      |
3+-----------------------------------------------------------------+
4| File: termios_printk.h                                          |
5+-----------------------------------------------------------------+
6|                    Copyright (c) 2002 IMD                       |
7|      Ingenieurbuero fuer Microcomputertechnik Th. Doerfler      |
8|               <Thomas.Doerfler@imd-systems.de>                  |
9|                       all rights reserved                       |
10+-----------------------------------------------------------------+
11| this file declares intialization functions to add               |
12| printk polled output via termios polled drivers                 |
13|                                                                 |
14+-----------------------------------------------------------------+
15|   date                      history                        ID   |
16| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
17| 13.04.02  creation                                         doe  |
18\*===============================================================*/
19#ifndef _TERMIOS_PRINTK_H
20#define _TERMIOS_PRINTK_H
21
22#include <rtems.h>
23#include <termios.h>
24
25#ifdef __cplusplus
26extern "C" {
27#endif
28
29typedef struct {
30  uint32_t   baudrate;      /* debug baud rate, e.g. 57600            */
31  void (*callout)(void);    /* callout pointer during polling         */
32  const char *devname;      /* debug device, e.g. "/dev/tty01"        */
33} termios_printk_conf_t;
34
35/*
36 * must be defined in init module...
37 */
38extern termios_printk_conf_t termios_printk_conf;
39
40/*=========================================================================*\
41| Function:                                                                 |
42\*-------------------------------------------------------------------------*/
43void termios_printk_outputchar
44/*-------------------------------------------------------------------------*\
45| Purpose:                                                                  |
46|    send one character to serial port                                      |
47+---------------------------------------------------------------------------+
48| Input Parameters:                                                         |
49\*-------------------------------------------------------------------------*/
50(
51 char c  /* character to print */
52 );
53/*-------------------------------------------------------------------------*\
54| Return Value:                                                             |
55|    <none>                                                                 |
56\*=========================================================================*/
57
58/*=========================================================================*\
59| Function:                                                                 |
60\*-------------------------------------------------------------------------*/
61int termios_printk_inputchar
62/*-------------------------------------------------------------------------*\
63| Purpose:                                                                  |
64|    wait for one character from serial port                                |
65+---------------------------------------------------------------------------+
66| Input Parameters:                                                         |
67\*-------------------------------------------------------------------------*/
68(
69 void  /* none */
70 );
71/*-------------------------------------------------------------------------*\
72| Return Value:                                                             |
73|    received character                                                     |
74\*=========================================================================*/
75
76
77/*=========================================================================*\
78| Function:                                                                 |
79\*-------------------------------------------------------------------------*/
80int termios_printk_open
81
82/*-------------------------------------------------------------------------*\
83| Purpose:                                                                  |
84|    try to open given serial debug port                                    |
85+---------------------------------------------------------------------------+
86| Input Parameters:                                                         |
87\*-------------------------------------------------------------------------*/
88(
89 const char *dev_name, /* name of device to open */
90 uint32_t   baudrate   /* baud rate to use       */
91 );
92/*-------------------------------------------------------------------------*\
93| Return Value:                                                             |
94|    0 on success, -1 and errno otherwise                                   |
95\*=========================================================================*/
96
97#ifdef __cplusplus
98}
99#endif
100
101#endif /* _TERMIOS_PRINTK_H */
Note: See TracBrowser for help on using the repository browser.