source: rtems/bsps/arm/lpc176x/include/bsp/system-clocks.h @ 031df391

5
Last change on this file since 031df391 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 lpc176x_clocks
5 *
6 * @brief System clocks.
7 */
8
9/*
10 * Copyright (c) 2008, 2009
11 * embedded brains GmbH
12 * Obere Lagerstr. 30
13 * D-82178 Puchheim
14 * Germany
15 * <rtems@embedded-brains.de>
16 *
17 * The license and distribution terms for this file may be
18 * found in the file LICENSE in this distribution or at
19 * http://www.rtems.org/license/LICENSE.
20 */
21
22#ifndef LIBBSP_ARM_LPC176X_SYSTEM_CLOCKS_H
23#define LIBBSP_ARM_LPC176X_SYSTEM_CLOCKS_H
24
25#include <bsp/lpc176x.h>
26#include <bsp/timer-defs.h>
27
28#ifdef __cplusplus
29extern "C" {
30#endif /* __cplusplus */
31
32/**
33 * @defgroup lpc176x_clock System Clocks
34 *
35 * @ingroup lpc176x
36 *
37 * @brief System clocks.
38 *
39 * @{
40 */
41
42/**
43 * @brief Initializes the standard timer.
44 *
45 * This function uses Timer 1.
46 */
47void lpc176x_timer_initialize( void );
48
49/**
50 * @brief Returns current standard timer value in CPU clocks.
51 *
52 * @return This function uses Timer 1.
53 */
54static inline unsigned lpc176x_get_timer1( void )
55{
56  return LPC176X_T1TC;
57}
58
59/**
60 * @brief Delay for @a us micro seconds.
61 *
62 * This function uses the standard timer and assumes that the CPU
63 * frequency is in whole MHz numbers.  The delay value @a us will be
64 * converted to CPU ticks and there is no protection against integer
65 * overflows.
66 *
67 * This function uses Timer 1.
68 */
69void lpc176x_micro_seconds_delay( unsigned us );
70
71/**
72 * @brief Returns the PLL output clock frequency in [Hz].
73 *
74 * @return Returns zero in case of an unexpected PLL input frequency.
75 */
76unsigned lpc176x_pllclk( void );
77
78/**
79 * @brief Returns the CPU clock frequency in [Hz].
80 *
81 * @return Returns zero in case of an unexpected PLL input frequency.
82 */
83unsigned lpc176x_cclk( void );
84
85/** @} */
86
87#ifdef __cplusplus
88}
89#endif /* __cplusplus */
90
91#endif /* LIBBSP_ARM_LPC176X_SYSTEM_CLOCKS_H */
Note: See TracBrowser for help on using the repository browser.