source: rtems/bsps/arm/stm32f4/include/bsp/i2c.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: 2.1 KB
Line 
1/**
2 * @file
3 * @ingroup stm32f4_i2c I2C Support
4 * @brief I2C-module.
5 */
6
7/*
8 * Copyright (c) 2013 Christian Mauderer.  All rights reserved.
9 *
10 *  embedded brains GmbH
11 *  Obere Lagerstr. 30
12 *  82178 Puchheim
13 *  Germany
14 *  <rtems@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/* The I2C-module can not run with libi2c. The reason for this is, that libi2c
22 * needs a possibility to generate a stop condition separately. This controller
23 * wants to generate the condition automatically when sending or receiving data.
24 */
25
26#ifndef LIBBSP_ARM_STM32F4_I2C_H
27#define LIBBSP_ARM_STM32F4_I2C_H
28
29#include <rtems.h>
30
31#include <bsp/io.h>
32#include <bsp/stm32f4.h>
33
34#ifdef __cplusplus
35extern "C" {
36#endif /* __cplusplus */
37
38/**
39 * @defgroup stm32f4_i2c I2C Support
40 * @ingroup arm_stm32f4
41 * @brief I2C Module
42 * @{
43 */
44
45typedef struct {
46  /**
47   * @brief The address of the slave without the read write bit.
48   * A 7-Bit address should be placed in the bits [6..0]
49   */
50  uint16_t addr;
51  /** @brief Read (true) or write (false) data */
52  bool read;
53  /** @brief Size of data to read or write */
54  size_t len;
55  /** @brief Buffer for data */
56  uint8_t *buf;
57} stm32f4_i2c_message;
58
59typedef struct {
60  volatile stm32f4_i2c *regs;
61  size_t index;
62  rtems_vector_number vector;
63  rtems_id mutex;
64  rtems_id task_id;
65  uint8_t *data;
66  uint8_t *last;
67  size_t len;
68  bool read;
69  uint8_t addr_with_rw;
70} stm32f4_i2c_bus_entry;
71
72/** @brief Initialise the i2c module. */
73rtems_status_code stm32f4_i2c_init(stm32f4_i2c_bus_entry *e);
74
75/** @brief Process a i2c message */
76rtems_status_code stm32f4_i2c_process_message(
77  stm32f4_i2c_bus_entry *e,
78  stm32f4_i2c_message *msg
79);
80
81/** @brief Set another baud rate than the default one */
82rtems_status_code stm32f4_i2c_set_bitrate(
83  stm32f4_i2c_bus_entry *e,
84  uint32_t br
85);
86
87extern stm32f4_i2c_bus_entry *const stm32f4_i2c1;
88extern stm32f4_i2c_bus_entry *const stm32f4_i2c2;
89
90/** @} */
91
92#ifdef __cplusplus
93}
94#endif /* __cplusplus */
95
96#endif /* LIBBSP_ARM_STM32F4_I2C_H */
Note: See TracBrowser for help on using the repository browser.