source: rtems/bsps/arm/xilinx-zynq/include/bsp/zynq-uart.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.4 KB
Line 
1/**
2 * @file
3 * @ingroup zynq_uart
4 * @brief UART support.
5 */
6
7/*
8 * Copyright (c) 2013, 2017 embedded brains GmbH.  All rights reserved.
9 *
10 *  embedded brains GmbH
11 *  Dornierstr. 4
12 *  82178 Puchheim
13 *  Germany
14 *  <info@embedded-brains.de>
15 *
16 * The license and distribution terms for this file may be
17 * found in the file LICENSE in this distribution or at
18 * http://www.rtems.org/license/LICENSE.
19 */
20
21#ifndef LIBBSP_ARM_XILINX_ZYNQ_UART_H
22#define LIBBSP_ARM_XILINX_ZYNQ_UART_H
23
24#include <rtems/termiostypes.h>
25
26#ifdef __cplusplus
27extern "C" {
28#endif /* __cplusplus */
29
30/**
31 * @defgroup zynq_uart UART Support
32 * @ingroup arm_zynq
33 * @brief UART Support
34 */
35
36typedef struct {
37  rtems_termios_device_context base;
38  volatile struct zynq_uart *regs;
39  bool transmitting;
40  rtems_vector_number irq;
41} zynq_uart_context;
42
43const rtems_termios_device_handler zynq_uart_handler;
44
45extern zynq_uart_context zynq_uart_instances[2];
46
47#define ZYNQ_UART_DEFAULT_BAUD 115200
48
49void zynq_uart_initialize(rtems_termios_device_context *base);
50
51int zynq_uart_read_polled(rtems_termios_device_context *base);
52
53void zynq_uart_write_polled(
54  rtems_termios_device_context *base,
55  char c
56);
57
58/**
59  * Flush TX FIFO and wait until it is empty. Used in bsp_reset.
60  */
61void zynq_uart_reset_tx_flush(zynq_uart_context *ctx);
62
63#ifdef __cplusplus
64}
65#endif /* __cplusplus */
66
67#endif /* LIBBSP_ARM_XILINX_ZYNQ_UART_H */
Note: See TracBrowser for help on using the repository browser.