source: rtems/bsps/arm/atsam/include/libchip/include/qspi_dma.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.6 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 * Implementation of SPI driver, transfer data through DMA.
34 *
35 */
36
37#ifndef QSPI_DMA_H
38#define QSPI_DMA_H
39
40/*----------------------------------------------------------------------------
41 *        Headers
42 *----------------------------------------------------------------------------*/
43
44#include "chip.h"
45#ifndef __rtems__
46#include "../../../../utils/utility.h"
47#endif /* __rtems__ */
48
49/*----------------------------------------------------------------------------
50 *        Definitions
51 *----------------------------------------------------------------------------*/
52
53/** An unspecified error has occurred.*/
54#define QSPID_ERROR          1
55
56/** SPI driver is currently in use.*/
57#define QSPID_ERROR_LOCK     2
58
59#define QSPID_CH_NOT_ENABLED 0xFF
60/*----------------------------------------------------------------------------
61 *        Types
62 *----------------------------------------------------------------------------*/
63
64/** SPI transfer complete callback. */
65typedef void (*QspidCallback)(uint8_t, void *);
66
67/** Constant structure associated with SPI port. This structure prevents
68    client applications to have access in the same time. */
69typedef struct _Qspid {
70        Qspid_t Qspid;
71        /** Pointer to DMA driver */
72        sXdmad *pXdmad;
73        /** Polling  */
74        uint8_t Polling;
75        /** Tx ch num  */
76        uint8_t TxChNum;
77        /** Rx ch num  */
78        uint8_t RxChNum;
79        /** QSPI Xfr state. */
80        volatile uint8_t progress;
81} QspiDma_t;
82
83#ifdef __cplusplus
84extern "C" {
85#endif
86/*----------------------------------------------------------------------------
87 *        Exported functions
88 *----------------------------------------------------------------------------*/
89
90uint32_t QSPID_Configure(QspiDma_t *pQspidma, QspiMode_t Mode,
91                                                  uint32_t dwConfiguration,  sXdmad *pXdmad);
92
93uint32_t QSPID_EnableQspiRxChannel(QspiDma_t *pQspidma);
94
95uint32_t QSPID_EnableQspiTxChannel(QspiDma_t *pQspidma);
96
97uint32_t QSPID_DisableQspiRxChannel(QspiDma_t *pQspidma);
98
99uint32_t QSPID_DisableQspiTxChannel(QspiDma_t *pQspidma);
100
101uint32_t QSPID_DisableSpiChannel(QspiDma_t *pQspidma);
102
103uint32_t QSPID_EnableSpiChannel(QspiDma_t *pQspidma);
104
105uint32_t QSPID_ReadWriteQSPI(QspiDma_t *pQspidma, Access_t const ReadWrite);
106
107uint32_t QSPID_ReadWriteSPI(QspiDma_t *pQspidma, Access_t const ReadWrite);
108
109uint32_t QSPID_IsBusy(volatile uint8_t *QspiSemaphore);
110
111#ifdef __cplusplus
112}
113#endif
114
115#endif /* #ifndef _SPI_DMA_ */
Note: See TracBrowser for help on using the repository browser.