source: rtems/bsps/arm/atsam/include/libchip/include/pio_it.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.5 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 *  \par Purpose
34 *
35 *  Configuration and handling of interrupts on PIO status changes. The API
36 *  provided here have several advantages over the traditional PIO interrupt
37 *  configuration approach:
38 *     - It is highly portable
39 *     - It automatically demultiplexes interrupts when multiples pins have been
40 *       configured on a single PIO controller
41 *     - It allows a group of pins to share the same interrupt
42 *
43 *  However, it also has several minor drawbacks that may prevent from using it
44 *  in particular applications:
45 *     - It enables the clocks of all PIO controllers
46 *     - PIO controllers all share the same interrupt handler, which does the
47 *       demultiplexing and can be slower than direct configuration
48 *     - It reserves space for a fixed number of interrupts, which can be
49 *       increased by modifying the appropriate constant in pio_it.c.
50 *
51 *  \par Usage
52 *
53 *  -# Initialize the PIO interrupt mechanism using PIO_InitializeInterrupts()
54 *     with the desired priority (0 ... 7).
55 *  -# Configure a status change interrupt on one or more pin(s) with
56 *     PIO_ConfigureIt().
57 *  -# Enable & disable interrupts on pins using PIO_EnableIt() and
58 *     PIO_DisableIt().
59 */
60
61#ifndef _PIO_IT_
62#define _PIO_IT_
63
64/*
65 *         Headers
66 */
67
68#include "pio.h"
69
70#ifdef __cplusplus
71extern "C" {
72#endif
73
74/*
75 *         Global functions
76 */
77
78extern void PIO_InitializeInterrupts(uint32_t dwPriority);
79
80extern void PIO_ConfigureIt(const Pin *pPin,
81    void (*handler)(const Pin *, void *arg), void *arg);
82
83
84/**
85 * Enables the given interrupt source if it has been configured. The status
86 * register of the corresponding PIO controller is cleared prior to enabling
87 * the interrupt.
88 * \param pPin  Interrupt source to enable.
89 */
90static inline void PIO_EnableIt(const Pin *pPin)
91{
92        pPin->pio->PIO_ISR;
93        pPin->pio->PIO_IER = pPin->mask;
94}
95
96/**
97 * Disables a given interrupt source, with no added side effects.
98 *
99 * \param pPin  Interrupt source to disable.
100 */
101static inline void PIO_DisableIt(const Pin *pPin)
102{
103        pPin->pio->PIO_IDR = pPin->mask;
104}
105
106extern void PIO_IT_InterruptHandler(void);
107
108extern void PioInterruptHandler(uint32_t id, Pio *pPio);
109
110extern void PIO_CaptureHandler(void);
111
112#ifdef __cplusplus
113}
114#endif
115
116#endif /* #ifndef _PIO_IT_ */
117
Note: See TracBrowser for help on using the repository browser.