summaryrefslogtreecommitdiffstats
path: root/bsps/arm/atsam/include/libchip/include/efc.h
diff options
context:
space:
mode:
authorChris Johns <chrisj@rtems.org>2017-12-23 18:18:56 +1100
committerSebastian Huber <sebastian.huber@embedded-brains.de>2018-01-25 08:45:26 +0100
commit2afb22b7e1ebcbe40373ff7e0efae7d207c655a9 (patch)
tree44759efe9374f13200a97e96d91bd9a2b7e5ce2a /bsps/arm/atsam/include/libchip/include/efc.h
parentMAINTAINERS: Add myself to Write After Approval. (diff)
downloadrtems-2afb22b7e1ebcbe40373ff7e0efae7d207c655a9.tar.bz2
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.
Diffstat (limited to 'bsps/arm/atsam/include/libchip/include/efc.h')
-rw-r--r--bsps/arm/atsam/include/libchip/include/efc.h128
1 files changed, 128 insertions, 0 deletions
diff --git a/bsps/arm/atsam/include/libchip/include/efc.h b/bsps/arm/atsam/include/libchip/include/efc.h
new file mode 100644
index 0000000000..c4ff7c49f6
--- /dev/null
+++ b/bsps/arm/atsam/include/libchip/include/efc.h
@@ -0,0 +1,128 @@
+/* ---------------------------------------------------------------------------- */
+/* Atmel Microcontroller Software Support */
+/* SAM Software Package License */
+/* ---------------------------------------------------------------------------- */
+/* Copyright (c) 2015, Atmel Corporation */
+/* */
+/* All rights reserved. */
+/* */
+/* Redistribution and use in source and binary forms, with or without */
+/* modification, are permitted provided that the following condition is met: */
+/* */
+/* - Redistributions of source code must retain the above copyright notice, */
+/* this list of conditions and the disclaimer below. */
+/* */
+/* Atmel's name may not be used to endorse or promote products derived from */
+/* this software without specific prior written permission. */
+/* */
+/* DISCLAIMER: THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR */
+/* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF */
+/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE */
+/* DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR ANY DIRECT, INDIRECT, */
+/* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT */
+/* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, */
+/* OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF */
+/* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING */
+/* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, */
+/* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */
+/* ---------------------------------------------------------------------------- */
+
+/**
+ * \file
+ *
+ * \section Purpose
+ *
+ * Interface for configuration the Enhanced Embedded Flash Controller (EEFC)
+ * peripheral.
+ *
+ * \section Usage
+ *
+ * -# Enable/disable %flash ready interrupt sources using EFC_EnableFrdyIt()
+ * and EFC_DisableFrdyIt().
+ * -# Translates the given address into which EEFC, page and offset values
+ * for difference density %flash memory using EFC_TranslateAddress().
+ * -# Computes the address of a %flash access given the EFC, page and offset
+ * for difference density %flash memory using EFC_ComputeAddress().
+ * -# Start the executing command with EFC_PerformCommand()
+ * -# Retrieve the current status of the EFC using EFC_GetStatus().
+ * -# Retrieve the result of the last executed command with EFC_GetResult().
+ */
+
+#ifndef _EEFC_
+#define _EEFC_
+
+/*----------------------------------------------------------------------------
+ * Headers
+ *----------------------------------------------------------------------------*/
+#include "chip.h"
+
+#include <stdint.h>
+
+/*----------------------------------------------------------------------------
+ * Definitions
+ *----------------------------------------------------------------------------*/
+/* TODO: Temporary definition for missing symbol in header file */
+#define IFLASH_SECTOR_SIZE 65536u
+
+
+/* EFC command */
+#define EFC_FCMD_GETD 0x00 /* Get Flash Descriptor */
+#define EFC_FCMD_WP 0x01 /* Write page */
+#define EFC_FCMD_WPL 0x02 /* Write page and lock */
+#define EFC_FCMD_EWP 0x03 /* Erase page and write page */
+#define EFC_FCMD_EWPL 0x04 /* Erase page and write page then lock */
+#define EFC_FCMD_EA 0x05 /* Erase all */
+#define EFC_FCMD_EPA 0x07 /* Erase pages */
+#define EFC_FCMD_SLB 0x08 /* Set Lock Bit */
+#define EFC_FCMD_CLB 0x09 /* Clear Lock Bit */
+#define EFC_FCMD_GLB 0x0A /* Get Lock Bit */
+#define EFC_FCMD_SFB 0x0B /* Set GPNVM Bit */
+#define EFC_FCMD_CFB 0x0C /* Clear GPNVM Bit */
+#define EFC_FCMD_GFB 0x0D /* Get GPNVM Bit */
+#define EFC_FCMD_STUI 0x0E /* Start unique ID */
+#define EFC_FCMD_SPUI 0x0F /* Stop unique ID */
+#define EFC_FCMD_GCALB 0x10 /* Get CALIB Bit */
+#define EFC_FCMD_ES 0x11 /* Erase Sector */
+#define EFC_FCMD_WUS 0x12 /* Write User Signature */
+#define EFC_FCMD_EUS 0x13 /* Erase User Signature */
+#define EFC_FCMD_STUS 0x14 /* Start Read User Signature */
+#define EFC_FCMD_SPUS 0x15 /* Stop Read User Signature */
+
+/* The IAP function entry address */
+#define CHIP_FLASH_IAP_ADDRESS (0x00800008)
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/*----------------------------------------------------------------------------
+ * Exported functions
+ *----------------------------------------------------------------------------*/
+
+extern void EFC_EnableFrdyIt(Efc *efc);
+
+extern void EFC_DisableFrdyIt(Efc *efc);
+
+extern void EFC_SetWaitState(Efc *efc, uint8_t cycles);
+
+extern void EFC_TranslateAddress(Efc **pEfc, uint32_t dwAddress,
+ uint16_t *pwPage, uint16_t *pwOffset);
+
+extern void EFC_ComputeAddress(Efc *efc, uint16_t wPage, uint16_t wOffset,
+ uint32_t *pdwAddress);
+
+extern uint32_t EFC_PerformCommand(Efc *efc, uint32_t dwCommand,
+ uint32_t dwArgument, uint32_t dwUseIAP);
+
+extern uint32_t EFC_GetStatus(Efc *efc);
+
+extern uint32_t EFC_GetResult(Efc *efc);
+
+extern void EFC_SetFlashAccessMode(Efc *efc, uint32_t dwMode);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* #ifndef _EEFC_ */
+