source: rtems/bsps/arm/atsam/include/libchip/include/flashd.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: 3.8 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 * The flash driver provides the unified interface for flash program operations.
34 *
35 */
36
37#ifndef _FLASHD_
38#define _FLASHD_
39
40#include <stdint.h>
41
42#ifdef __cplusplus
43extern "C" {
44#endif
45
46#define GPNVBit_SecurityBit     0
47#define GPNVBit_BootMode        1
48#define GPNVBit_TCMBit1         6
49#define GPNVBit_TCMBit2         7
50
51/*----------------------------------------------------------------------------
52 *        Exported functions
53 *----------------------------------------------------------------------------*/
54
55extern void FLASHD_Initialize(uint32_t dwMCk, uint32_t dwUseIAP);
56
57extern uint32_t FLASHD_Erase(uint32_t dwAddress);
58
59extern uint32_t FLASHD_EraseSector(uint32_t dwAddress);
60
61extern uint32_t FLASHD_ErasePages(uint32_t dwAddress, uint32_t dwPageNum);
62
63extern uint32_t FLASHD_Write(uint32_t dwAddress, const void *pvBuffer,
64                                                          uint32_t dwSize);
65
66extern uint32_t FLASHD_Lock(uint32_t dwStart, uint32_t dwEnd,
67                                                         uint32_t *pdwActualStart, uint32_t *pdwActualEnd);
68
69extern uint32_t FLASHD_Unlock(uint32_t dwStart, uint32_t dwEnd,
70                                                           uint32_t *pdwActualStart, uint32_t *pdwActualEnd);
71
72extern uint32_t FLASHD_IsLocked(uint32_t dwStart, uint32_t dwEnd);
73
74extern uint32_t FLASHD_SetGPNVM(uint8_t gpnvm);
75
76extern uint32_t FLASHD_ClearGPNVM(uint8_t gpnvm);
77
78extern uint32_t FLASHD_IsGPNVMSet(uint8_t gpnvm);
79
80#define FLASHD_IsSecurityBitSet() FLASHD_IsGPNVMSet(0)
81
82#define FLASHD_SetSecurityBit()   FLASHD_SetGPNVM(0)
83
84extern uint32_t FLASHD_ReadUniqueID(uint32_t *pdwUniqueID);
85
86#ifdef __cplusplus
87}
88#endif
89
90#endif /* #ifndef _FLASHD_ */
91
Note: See TracBrowser for help on using the repository browser.