source: rtems/bsps/arm/atsam/include/libchip/include/spi.h @ 71c5552f

Last change on this file since 71c5552f was 2afb22b, checked in by Chris Johns <chrisj@…>, on Dec 23, 2017 at 7:18:56 AM

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: 4.9 KB
Line 
1/* ---------------------------------------------------------------------------- */
2/*                  Atmel Microcontroller Software Support                      */
3/*                       SAM Software Package License                           */
4/* ---------------------------------------------------------------------------- */
5/* Copyright (c) 2015, Atmel Corporation                                        */
6/*                                                                              */
7/* All rights reserved.                                                         */
8/*                                                                              */
9/* Redistribution and use in source and binary forms, with or without           */
10/* modification, are permitted provided that the following condition is met:    */
11/*                                                                              */
12/* - Redistributions of source code must retain the above copyright notice,     */
13/* this list of conditions and the disclaimer below.                            */
14/*                                                                              */
15/* Atmel's name may not be used to endorse or promote products derived from     */
16/* this software without specific prior written permission.                     */
17/*                                                                              */
18/* DISCLAIMER:  THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR   */
19/* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF */
20/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE   */
21/* DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR ANY DIRECT, INDIRECT,      */
22/* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT */
23/* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,  */
24/* OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF    */
25/* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING         */
26/* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, */
27/* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.                           */
28/* ---------------------------------------------------------------------------- */
29
30/**
31 * \file
32 *
33 * Interface for Serial Peripheral Interface (SPI) controller.
34 *
35 */
36
37#ifndef _SPI_
38#define _SPI_
39
40/*----------------------------------------------------------------------------
41 *        Headers
42 *----------------------------------------------------------------------------*/
43
44#include "chip.h"
45
46/*----------------------------------------------------------------------------
47 *        Macros
48 *----------------------------------------------------------------------------*/
49
50/**
51 *
52 * Here are several macros which should be used when configuring a SPI
53 * peripheral.
54 *
55 * \section spi_configuration_macros SPI Configuration Macros
56 * - \ref SPI_PCS
57 * - \ref SPI_SCBR
58 * - \ref SPI_DLYBS
59 * - \ref SPI_DLYBCT
60 */
61
62/** Calculate the PCS field value given the chip select NPCS value */
63#define SPI_PCS(npcs)       SPI_MR_PCS((~(1 << npcs) & 0xF))
64
65/** Calculates the value of the CSR SCBR field given the baudrate and MCK. */
66#define SPI_SCBR(baudrate, masterClock) \
67        SPI_CSR_SCBR((uint32_t)(masterClock / baudrate))
68
69/** Calculates the value of the CSR DLYBS field given the desired delay (in ns) */
70#define SPI_DLYBS(delay, masterClock)  \
71        SPI_CSR_DLYBS((uint32_t) (((masterClock / 1000000) * delay) / 1000)+1)
72
73/** Calculates the value of the CSR DLYBCT field given the desired delay (in ns) */
74#define SPI_DLYBCT(delay, masterClock) \
75        SPI_CSR_DLYBCT ((uint32_t) (((masterClock / 1000000) * delay) / 32000)+1)
76
77/*------------------------------------------------------------------------------ */
78
79#ifdef __cplusplus
80extern "C" {
81#endif
82
83/*----------------------------------------------------------------------------
84 *        Exported functions
85 *----------------------------------------------------------------------------*/
86
87extern void SPI_Enable(Spi *spi);
88extern void SPI_Disable(Spi *spi);
89
90extern void SPI_EnableIt(Spi *spi, uint32_t dwSources);
91extern void SPI_DisableIt(Spi *spi, uint32_t dwSources);
92
93extern void SPI_Configure(Spi *spi, uint32_t dwId, uint32_t dwConfiguration);
94extern void SPI_SetMode(Spi *spi, uint32_t dwConfiguration);
95
96extern void SPI_ChipSelect(Spi *spi, uint8_t cS);
97extern void SPI_ReleaseCS(Spi *spi);
98
99extern void SPI_ConfigureNPCS(Spi *spi, uint32_t dwNpcs,
100                                                           uint32_t dwConfiguration);
101extern void SPI_ConfigureCSMode(Spi *spi, uint32_t dwNpcs,
102                                                                 uint32_t bReleaseOnLast);
103
104extern uint32_t SPI_Read(Spi *spi);
105extern void SPI_Write(Spi *spi, uint32_t dwNpcs, uint16_t wData);
106extern void SPI_WriteLast(Spi *spi, uint32_t dwNpcs, uint16_t wData);
107
108extern uint32_t SPI_GetStatus(Spi *spi);
109extern uint32_t SPI_IsFinished(Spi *pSpi);
110
111#ifdef __cplusplus
112}
113#endif
114
115#endif /* #ifndef _SPI_ */
116
Note: See TracBrowser for help on using the repository browser.