source: rtems/bsps/i386/pc386/include/bsp/rtd316.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.8 KB
Line 
1/**
2 * @file
3 *
4 * @ingroup i386_pc386
5 *
6 * @brief RTD316 driver interface defintions.
7 */
8
9/*
10 *  COPYRIGHT (c) 1989-2014.
11 *  On-Line Applications Research Corporation (OAR).
12 *
13 *  The license and distribution terms for this file may be
14 *  found in the file LICENSE in this distribution or at
15 *  http://www.rtems.org/license/LICENSE.
16 */
17
18#ifndef _BSP_RTD_316_h
19#define _BSP_RTD_316_h
20
21#ifdef __cplusplus
22extern "C" {
23#endif
24
25/**
26 *  This macro defines the standard device driver table entry for
27 *  a console device driver.
28 */
29#define RTD316_DRIVER_TABLE_ENTRY \
30  { rtd316_initialize, NULL, NULL, NULL, NULL, NULL }
31
32/**
33 *  @brief RTD316 Initialization Entry Point
34 *
35 *  This method initializes the RTD316 device driver.
36 *
37 *  @param[in] major is the device driver major number
38 *  @param[in] minor is the device driver minor number
39 *  @param[in] arg is the parameters to this call
40 *
41 *  @return This method returns RTEMS_SUCCESSFUL when
42 *          the device driver is successfully initialized.
43 */
44rtems_device_driver rtd316_initialize(
45  rtems_device_major_number  major,
46  rtems_device_minor_number  minor,
47  void                      *arg
48);
49
50/**
51 *  @brief RTD316 Obtain Register Helper
52 *
53 *  This method is used to read registers on the RTD316.
54 *
55 *  @param[in] addr is the base address
56 *  @param[in] reg is the register number
57 *
58 *  @return This method returns the value of the register.
59 */
60uint8_t rtd316_com_get_register(uint32_t addr, uint8_t reg);
61
62/**
63 *  @brief RTD316 Set Register Helper
64 *
65 *  This method is used to set registers on the RTD316.
66 *
67 *  @param[in] addr is the base address
68 *  @param[in] reg is the register number
69 */
70void rtd316_com_set_register(uint32_t addr,uint8_t reg, uint8_t val);
71
72#ifdef __cplusplus
73}
74#endif
75
76#endif
77/* end of include file */
Note: See TracBrowser for help on using the repository browser.