source: rtems/bsps/arm/atsam/include/libchip/include/afe_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: 5.0 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 *  \section Purpose
34 *
35 *  Interface for configuration the Analog-to-Digital Converter (AFEC) peripheral.
36 *
37 *  \section Usage
38 *
39 *  -# Configurate the pins for AFEC.
40 *  -# Initialize the AFEC with AFEC_Initialize().
41 *  -# Set AFEC clock and timing with AFEC_SetClock() and AFEC_SetTiming().
42 *  -# Select the active channel using AFEC_EnableChannel().
43 *  -# Start the conversion with AFEC_StartConversion().
44 *  -# Wait the end of the conversion by polling status with AFEC_GetStatus().
45 *  -# Finally, get the converted data using AFEC_GetConvertedData() or
46 * AFEC_GetLastConvertedData().
47 *
48*/
49#ifndef _AFE_DMA_
50#define _AFE_DMA_
51
52/*----------------------------------------------------------------------------
53 *        Headers
54 *----------------------------------------------------------------------------*/
55
56#include "chip.h"
57
58
59/*----------------------------------------------------------------------------
60 *        Types
61 *----------------------------------------------------------------------------*/
62
63/** AFE transfer complete callback. */
64typedef void (*AfeCallback)(uint8_t, void *);
65
66/** \brief Spi Transfer Request prepared by the application upper layer.
67 *
68 * This structure is sent to the AFE_SendCommand function to start the transfer.
69 * At the end of the transfer, the callback is invoked by the interrupt handler.
70 */
71typedef struct {
72        /** Pointer to the Rx data. */
73        uint32_t *pRxBuff;
74        /** Rx size in bytes. */
75        uint16_t RxSize;
76        /** Callback function invoked at the end of transfer. */
77        AfeCallback callback;
78        /** Callback arguments. */
79        void *pArgument;
80} AfeCmd;
81
82
83/** Constant structure associated with AFE port. This structure prevents
84    client applications to have access in the same time. */
85typedef struct {
86        /** Pointer to AFE Hardware registers */
87        Afec *pAfeHw;
88        /** Current SpiCommand being processed */
89        AfeCmd *pCurrentCommand;
90        /** Pointer to DMA driver */
91        sXdmad *pXdmad;
92        /** AFEC Id as defined in the product datasheet */
93        uint8_t afeId;
94        /** Mutual exclusion semaphore. */
95        volatile int8_t semaphore;
96} AfeDma;
97
98
99/*------------------------------------------------------------------------------
100 *         Definitions
101 *----------------------------------------------------------------------------*/
102#define AFE_OK          0
103#define AFE_ERROR       1
104#define AFE_ERROR_LOCK  2
105/*------------------------------------------------------------------------------
106 *         Exported functions
107 *----------------------------------------------------------------------------*/
108extern uint32_t Afe_ConfigureDma(AfeDma *pAfed ,
109                                                                  Afec *pAfeHw ,
110                                                                  uint8_t AfeId,
111                                                                  sXdmad *pXdmad);
112extern uint32_t Afe_SendData(AfeDma *pAfed, AfeCmd *pCommand);
113
114
115#endif /* #ifndef _AFE_DMA_ */
116
Note: See TracBrowser for help on using the repository browser.