source: rtems/bsps/include/libchip/spi-sd-card.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.0 KB
Line 
1/**
2 * @file
3 *
4 * @brief SD Card LibI2C driver.
5 */
6
7/*
8 * Copyright (c) 2008
9 * Embedded Brains GmbH
10 * Obere Lagerstr. 30
11 * D-82178 Puchheim
12 * Germany
13 * rtems@embedded-brains.de
14 *
15 * The license and distribution terms for this file may be
16 * found in the file LICENSE in this distribution or at
17 * http://www.rtems.org/license/LICENSE.
18 */
19
20#ifndef LIBI2C_SD_CARD_H
21#define LIBI2C_SD_CARD_H
22
23#include <stdint.h>
24#include <stdbool.h>
25
26#include <rtems/libi2c.h>
27
28#ifdef __cplusplus
29extern "C" {
30#endif /* __cplusplus */
31
32#define SD_CARD_IDLE_TOKEN 0xff
33
34/**
35 * 1 idle token before command
36 * 6 bytes for the command
37 * 1 to 8 bytes for response start (N_CR)
38 * 1 to 2 bytes for response
39 * 1 idle token after command (minimum N_RC)
40 */
41#define SD_CARD_COMMAND_SIZE 18
42
43#define SD_CARD_TRANSFER_MODE_DEFAULT { .baudrate = 400000, .bits_per_char = 8, .lsb_first = FALSE, .clock_inv = FALSE, .clock_phs = FALSE, .idle_char = SD_CARD_IDLE_TOKEN }
44
45#define SD_CARD_COMMAND_DEFAULT { \
46        SD_CARD_IDLE_TOKEN, \
47        0x40, 0, 0, 0, 0, 0x95, \
48        SD_CARD_IDLE_TOKEN, SD_CARD_IDLE_TOKEN, \
49        SD_CARD_IDLE_TOKEN, SD_CARD_IDLE_TOKEN, \
50        SD_CARD_IDLE_TOKEN, SD_CARD_IDLE_TOKEN, \
51        SD_CARD_IDLE_TOKEN, SD_CARD_IDLE_TOKEN, \
52        SD_CARD_IDLE_TOKEN, SD_CARD_IDLE_TOKEN, \
53        SD_CARD_IDLE_TOKEN \
54}
55
56/* Default speed = 400kbps, default timeout = 100ms, n_ac_max is in bytes */
57#define SD_CARD_N_AC_MAX_DEFAULT 5000
58
59typedef struct {
60        const char *device_name;
61        rtems_device_minor_number bus;
62        rtems_libi2c_tfr_mode_t transfer_mode;
63        uint8_t command [SD_CARD_COMMAND_SIZE];
64        uint8_t response [SD_CARD_COMMAND_SIZE];
65        int response_index;
66        uint32_t n_ac_max;
67        uint32_t block_number;
68        uint32_t block_size;
69        uint32_t block_size_shift;
70        bool busy;
71        bool verbose;
72        bool schedule_if_busy;
73        uint32_t retries;
74} sd_card_driver_entry;
75
76extern sd_card_driver_entry sd_card_driver_table [];
77
78extern size_t sd_card_driver_table_size;
79
80rtems_status_code sd_card_register( void);
81
82#ifdef __cplusplus
83}
84#endif /* __cplusplus */
85
86#endif /* LIBI2C_SD_CARD_H */
Note: See TracBrowser for help on using the repository browser.