source: rtems/cpukit/include/rtems/serdbg.h @ 0fb724a

5
Last change on this file since 0fb724a 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: 7.5 KB
Line 
1/*===============================================================*\
2| Project: RTEMS remote gdb over serial line                      |
3+-----------------------------------------------------------------+
4| File: serdbg.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| a gdb remote debug stub to an RTEMS system                      |
13|                                                                 |
14+-----------------------------------------------------------------+
15|   date                      history                        ID   |
16| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
17| 04.04.02  creation                                         doe  |
18\*===============================================================*/
19#ifndef _SERDBG_H
20#define _SERDBG_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  int  (*open_io)(const char *dev_name, uint32_t baudrate); /* I/O open fnc */
33  const char *devname;      /* debug device, e.g. "/dev/tty01"        */
34  bool      skip_init_bkpt; /* if TRUE, do not stop when initializing */
35} serdbg_conf_t;
36
37/*
38 * must be defined in init module...
39 */
40extern serdbg_conf_t serdbg_conf;
41
42
43/*=========================================================================*\
44| Function:                                                                 |
45\*-------------------------------------------------------------------------*/
46void putDebugChar
47(
48/*-------------------------------------------------------------------------*\
49| Purpose:                                                                  |
50|   send character to remote debugger                                       |
51+---------------------------------------------------------------------------+
52| Input Parameters:                                                         |
53\*-------------------------------------------------------------------------*/
54 char        c                          /* char to send                    */
55 );
56/*-------------------------------------------------------------------------*\
57| Return Value:                                                             |
58|    <none>                                                                 |
59\*=========================================================================*/
60
61/*=========================================================================*\
62| Function:                                                                 |
63\*-------------------------------------------------------------------------*/
64int getDebugChar
65(
66/*-------------------------------------------------------------------------*\
67| Purpose:                                                                  |
68|   get character from remote debugger                                      |
69+---------------------------------------------------------------------------+
70| Input Parameters:                                                         |
71\*-------------------------------------------------------------------------*/
72 void                                   /* <none>                          */
73 );
74/*-------------------------------------------------------------------------*\
75| Return Value:                                                             |
76|    <none>                                                                 |
77\*=========================================================================*/
78
79/*=========================================================================*\
80| Function:                                                                 |
81\*-------------------------------------------------------------------------*/
82void serdbg_exceptionHandler
83(
84/*-------------------------------------------------------------------------*\
85| Purpose:                                                                  |
86|   hook directly to an exception vector                                    |
87+---------------------------------------------------------------------------+
88| Input Parameters:                                                         |
89\*-------------------------------------------------------------------------*/
90 int vecnum,                            /* vector index to hook at         */
91 void *vector                           /* address of handler function     */
92 );
93/*-------------------------------------------------------------------------*\
94| Return Value:                                                             |
95|    <none>                                                                 |
96\*=========================================================================*/
97
98/*=========================================================================*\
99| Function:                                                                 |
100\*-------------------------------------------------------------------------*/
101int serdbg_init
102(
103/*-------------------------------------------------------------------------*\
104| Purpose:                                                                  |
105|   initialize remote gdb session over serial line                          |
106+---------------------------------------------------------------------------+
107| Input Parameters:                                                         |
108\*-------------------------------------------------------------------------*/
109 void
110 );
111/*-------------------------------------------------------------------------*\
112| Return Value:                                                             |
113|    rtems_status_code                                                      |
114\*=========================================================================*/
115
116/*
117 * stuff from serdbgio.c
118 */
119/*=========================================================================*\
120| Function:                                                                 |
121\*-------------------------------------------------------------------------*/
122int serdbg_open
123
124/*-------------------------------------------------------------------------*\
125| Purpose:                                                                  |
126|    try to open given serial debug port                                    |
127+---------------------------------------------------------------------------+
128| Input Parameters:                                                         |
129\*-------------------------------------------------------------------------*/
130(
131 const char *dev_name, /* name of device to open */
132 uint32_t   baudrate   /* baud rate to use       */
133 );
134/*-------------------------------------------------------------------------*\
135| Return Value:                                                             |
136|    0 on success, -1 and errno otherwise                                   |
137\*=========================================================================*/
138
139
140extern int serdbg_init_dbg(void);
141
142/*
143 * Assumed to be provided by the BSP
144 */
145extern void set_debug_traps(void);
146extern void breakpoint(void);
147#ifdef __cplusplus
148}
149#endif
150
151#endif /* _SERDBG_H */
Note: See TracBrowser for help on using the repository browser.