source: rtems/bsps/arm/atsam/include/libchip/include/dac_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: 6.1 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 (DACC) peripheral.
36 *
37 *  \section Usage
38 *
39 *  -# Configurate the pins for DACC
40 *  -# Initialize the DACC with DACC_Initialize().
41 *  -# Select the active channel using DACC_EnableChannel()
42 *  -# Start the conversion with DACC_StartConversion()
43 *  -# Wait the end of the conversion by polling status with DACC_GetStatus()
44 *  -# Finally, get the converted data using DACC_GetConvertedData()
45 *
46*/
47#ifndef _DAC_DMA_
48#define _DAC_DMA_
49
50/*----------------------------------------------------------------------------
51 *        Headers
52 *----------------------------------------------------------------------------*/
53#include "chip.h"
54
55#include <stdint.h>
56#include <assert.h>
57
58
59#ifdef __cplusplus
60extern "C" {
61#endif
62
63
64/*----------------------------------------------------------------------------
65 *        Types
66 *----------------------------------------------------------------------------*/
67
68/** DAC transfer complete callback. */
69typedef void (*DacCallback)(uint8_t, void *);
70
71/** \brief Dac Transfer Request prepared by the application upper layer.
72 *
73 * This structure is sent to the DAC_SendCommand function to start the transfer.
74 * At the end of the transfer, the callback is invoked by the interrupt handler.
75 */
76typedef struct {
77        /** Pointer to the Tx data. */
78        uint8_t *pTxBuff;
79        /** Tx size in bytes. */
80        uint16_t TxSize;
81        /** Tx loop back. */
82        uint16_t loopback;
83        /** DACC channel*/
84        uint8_t dacChannel;
85        /** Callback function invoked at the end of transfer. */
86        DacCallback callback;
87        /** Callback arguments. */
88        void *pArgument;
89} DacCmd;
90
91
92/** Constant structure associated with DAC port. This structure prevents
93    client applications to have access in the same time. */
94typedef struct {
95        /** Pointer to DAC Hardware registers */
96        Dacc *pDacHw;
97        /** Current SpiCommand being processed */
98        DacCmd *pCurrentCommand;
99        /** Pointer to DMA driver */
100        sXdmad *pXdmad;
101        /** DACC Id as defined in the product datasheet */
102        uint8_t dacId;
103        /** Mutual exclusion semaphore. */
104        volatile int8_t semaphore;
105} DacDma;
106
107
108/*------------------------------------------------------------------------------
109 *         Definitions
110 *------------------------------------------------------------------------------*/
111#define DAC_OK          0
112#define DAC_ERROR       1
113#define DAC_ERROR_LOCK  2
114
115#define DACC_CHANNEL_0 0
116#define DACC_CHANNEL_1 1
117
118/*------------------------------------------------------------------------------
119 *         Exported functions
120 *------------------------------------------------------------------------------*/
121extern uint32_t Dac_ConfigureDma(DacDma *pDacd ,
122                                                                  Dacc *pDacHw ,
123                                                                  uint8_t DacId,
124                                                                  sXdmad *pXdmad);
125extern uint32_t Dac_SendData(DacDma *pDacd, DacCmd *pCommand);
126
127
128/*------------------------------------------------------------------------------
129 *         Macros function of register access
130 *------------------------------------------------------------------------------*/
131#define DACC_SoftReset(pDACC)                 ((pDACC)->DACC_CR = DACC_CR_SWRST)
132#define DACC_CfgModeReg(pDACC, mode)          { (pDACC)->DACC_MR = (mode); }
133#define DACC_GetModeReg(pDACC)                ((pDACC)->DACC_MR)
134#define DACC_CfgTrigger(pDACC, mode)          { (pDACC)->DACC_TRIGR = (mode); }
135
136#define DACC_EnableChannel(pDACC, channel)    {(pDACC)->DACC_CHER = (1 << (channel));}
137#define DACC_DisableChannel(pDACC, channel)   {(pDACC)->DACC_CHDR = (1 << (channel));}
138
139#define DACC_EnableIt(pDACC, mode)            {(pDACC)->DACC_IER = (mode);}
140#define DACC_DisableIt(pDACC, mode)           {(pDACC)->DACC_IDR = (mode);}
141#define DACC_GetStatus(pDACC)                 ((pDACC)->DACC_ISR)
142#define DACC_GetChannelStatus(pDACC)          ((pDACC)->DACC_CHSR)
143#define DACC_GetInterruptMaskStatus(pDACC)    ((pDACC)->DACC_IMR)
144
145
146#ifdef __cplusplus
147}
148#endif
149
150#endif /* #ifndef _DAC_DMA_ */
Note: See TracBrowser for help on using the repository browser.