source: rtems/bsps/arm/atsam/include/libchip/include/pio_capture.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.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#ifndef PIO_CAPTURE_H
31#define PIO_CAPTURE_H
32
33/*----------------------------------------------------------------------------
34 *        Types
35 *----------------------------------------------------------------------------*/
36
37/** \brief PIO Parallel Capture structure for initialize.
38 *
39 * At the end of the transfer, the callback is invoked by the interrupt handler.
40 */
41typedef struct _SpioCaptureInit {
42
43        /** PIO_PCRHR register is a BYTE, HALF-WORD or WORD */
44        uint8_t dsize;
45        /** PDC size, data to be received */
46        uint16_t dPDCsize;
47        /** Data to be received */
48        uint32_t *pData;
49        /** Parallel Capture Mode Always Sampling */
50        uint8_t alwaysSampling;
51        /** Parallel Capture Mode Half Sampling */
52        uint8_t halfSampling;
53        /** Parallel Capture Mode First Sample */
54        uint8_t modeFirstSample;
55        /** Callback function invoked at Mode Data Ready */
56        void (*CbkDataReady)(struct _SpioCaptureInit *);
57        /** Callback function invoked at Mode Overrun Error */
58        void (*CbkOverrun)(struct _SpioCaptureInit *);
59        /** Callback function invoked at End of Reception Transfer */
60        void (*CbkEndReception)(struct _SpioCaptureInit *);
61        /** Callback function invoked at Reception Buffer Full */
62        void (*CbkBuffFull)(struct _SpioCaptureInit *);
63        /** Callback arguments.*/
64        void *pParam;
65
66} SpioCaptureInit;
67
68
69/*----------------------------------------------------------------------------
70 *        Global Functions
71 *----------------------------------------------------------------------------*/
72extern void PIO_CaptureDisableIt(uint32_t itToDisable);
73extern void PIO_CaptureEnableIt(uint32_t itToEnable);
74extern void PIO_CaptureEnable(void);
75extern void PIO_CaptureDisable(void);
76extern void PIO_CaptureInit(SpioCaptureInit *pInit);
77
78#endif /* #ifndef PIO_CAPTURE_H */
79
Note: See TracBrowser for help on using the repository browser.