summaryrefslogtreecommitdiff
path: root/peripherals/eefc
diff options
context:
space:
mode:
authorHarald Welte <laforge@gnumonks.org>2011-07-04 20:52:54 +0200
committerHarald Welte <laforge@gnumonks.org>2011-07-04 20:52:54 +0200
commit044ad7c3987460ede48ff27afd6bdb0ca05a0432 (patch)
tree924818cdb0d39ca08aec540d18da7bd406eaae8c /peripherals/eefc
import at91lib from at91lib_20100901_softpack_1_9_v_1_0_svn_v1501120100901_softpack_1_9_v_1_0_svn_v15011
it's sad to see that atmel doesn't publish their svn repo or has a centralized location or even puts proper version/release info into the library itself
Diffstat (limited to 'peripherals/eefc')
-rw-r--r--peripherals/eefc/eefc.c296
-rw-r--r--peripherals/eefc/eefc.dir37
-rw-r--r--peripherals/eefc/eefc.h147
3 files changed, 480 insertions, 0 deletions
diff --git a/peripherals/eefc/eefc.c b/peripherals/eefc/eefc.c
new file mode 100644
index 0000000..506e016
--- /dev/null
+++ b/peripherals/eefc/eefc.c
@@ -0,0 +1,296 @@
+/* ----------------------------------------------------------------------------
+ * ATMEL Microcontroller Software Support
+ * ----------------------------------------------------------------------------
+ * Copyright (c) 2009, Atmel Corporation
+ *
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are 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.
+ * ----------------------------------------------------------------------------
+ */
+
+//------------------------------------------------------------------------------
+// Headers
+//------------------------------------------------------------------------------
+
+#include <board.h>
+#include "eefc.h"
+
+#if !defined (CHIP_FLASH_EEFC)
+#error eefc not supported
+#endif
+
+#include <utility/assert.h>
+#include <utility/trace.h>
+
+//------------------------------------------------------------------------------
+// Global functions
+//------------------------------------------------------------------------------
+
+//------------------------------------------------------------------------------
+/// Enables the flash ready interrupt source on the EEFC peripheral.
+/// \param pEfc Pointer to an AT91S_EFC structure.
+//------------------------------------------------------------------------------
+void EFC_EnableFrdyIt(AT91S_EFC *pEfc)
+{
+ pEfc->EFC_FMR |= AT91C_EFC_FRDY;
+}
+
+//------------------------------------------------------------------------------
+/// Disables the flash ready interrupt source on the EEFC peripheral.
+/// \param pEfc Pointer to an AT91S_EFC structure.
+//------------------------------------------------------------------------------
+void EFC_DisableFrdyIt(AT91S_EFC *pEfc)
+{
+ pEfc->EFC_FMR &= ~AT91C_EFC_FRDY;
+}
+
+//------------------------------------------------------------------------------
+/// Translates the given address page and offset values. The resulting
+/// values are stored in the provided variables if they are not null.
+/// \param ppEfc Pointer to target EFC peripheral.
+/// \param address Address to translate.
+/// \param pPage First page accessed.
+/// \param pOffset Byte offset in first page.
+//------------------------------------------------------------------------------
+void EFC_TranslateAddress(
+ AT91S_EFC **ppEfc,
+ unsigned int address,
+ unsigned short *pPage,
+ unsigned short *pOffset)
+{
+ AT91S_EFC *pEfc;
+ unsigned short page;
+ unsigned short offset;
+
+#if defined(AT91C_BASE_EFC1)
+ // Convert wrapped address to physical address.
+ address &= 0x19FFFF;
+ SANITY_CHECK(address >= AT91C_IFLASH);
+ if (address >= AT91C_IFLASH1) {
+ SANITY_CHECK(address <= (AT91C_IFLASH1 + AT91C_IFLASH1_SIZE));
+ }
+ else {
+ SANITY_CHECK(address <= (AT91C_IFLASH + AT91C_IFLASH_SIZE));
+ }
+#else
+ SANITY_CHECK(address >= AT91C_IFLASH);
+ SANITY_CHECK(address <= (AT91C_IFLASH + AT91C_IFLASH_SIZE));
+#endif
+
+ pEfc = AT91C_BASE_EFC;
+ page = (address - AT91C_IFLASH) / AT91C_IFLASH_PAGE_SIZE;
+ offset = (address - AT91C_IFLASH) % AT91C_IFLASH_PAGE_SIZE;
+
+#if defined(AT91C_BASE_EFC1)
+ if (address >= AT91C_IFLASH1) {
+ pEfc = AT91C_BASE_EFC1;
+ page = (address - AT91C_IFLASH1) / AT91C_IFLASH1_PAGE_SIZE;
+ offset = (address - AT91C_IFLASH1) % AT91C_IFLASH1_PAGE_SIZE;
+ }
+#endif
+
+ TRACE_DEBUG("Translated 0x%08X to page=%d and offset=%d\n\r",
+ address, page, offset);
+
+ // Store values
+ if (ppEfc) {
+ *ppEfc = pEfc;
+ }
+ if (pPage) {
+
+ *pPage = page;
+ }
+ if (pOffset) {
+
+ *pOffset = offset;
+ }
+}
+
+//------------------------------------------------------------------------------
+/// Computes the address of a flash access given the page and offset.
+/// \param pEfc Pointer to an AT91S_EFC structure.
+/// \param page Page number.
+/// \param offset Byte offset inside page.
+/// \param pAddress Computed address (optional).
+//------------------------------------------------------------------------------
+void EFC_ComputeAddress(
+ AT91S_EFC *pEfc,
+ unsigned short page,
+ unsigned short offset,
+ unsigned int *pAddress)
+{
+ unsigned int address;
+ SANITY_CHECK(pEfc);
+ SANITY_CHECK(page <= AT91C_IFLASH_NB_OF_PAGES);
+ SANITY_CHECK(offset < AT91C_IFLASH_PAGE_SIZE);
+
+ // Compute address
+ address = AT91C_IFLASH + page * AT91C_IFLASH_PAGE_SIZE + offset;
+#if defined(AT91C_BASE_EFC1)
+ if (pEfc == AT91C_BASE_EFC1) {
+ address = AT91C_IFLASH1 + page * AT91C_IFLASH1_PAGE_SIZE + offset;
+ }
+#endif
+
+ // Store result
+ if (pAddress) {
+
+ *pAddress = address;
+ }
+}
+
+//------------------------------------------------------------------------------
+/// Starts the executing the given command on the EEFC. This function returns
+/// as soon as the command is started. It does NOT set the FMCN field automatically.
+/// \param pEfc Pointer to an AT91S_EFC structure.
+/// \param command Command to execute.
+/// \param argument Command argument (should be 0 if not used).
+//------------------------------------------------------------------------------
+#if defined(flash) || defined (USE_FLASH)
+ #ifdef __ICCARM__
+__ramfunc
+ #else
+__attribute__ ((section (".ramfunc")))
+ #endif
+#endif
+void EFC_StartCommand(AT91S_EFC *pEfc, unsigned char command, unsigned short argument)
+{
+ // Check command & argument
+ switch (command) {
+
+ case AT91C_EFC_FCMD_WP:
+ case AT91C_EFC_FCMD_WPL:
+ case AT91C_EFC_FCMD_EWP:
+ case AT91C_EFC_FCMD_EWPL:
+ case AT91C_EFC_FCMD_EPL:
+ case AT91C_EFC_FCMD_EPA:
+ case AT91C_EFC_FCMD_SLB:
+ case AT91C_EFC_FCMD_CLB:
+ ASSERT(argument < AT91C_IFLASH_NB_OF_PAGES,
+ "-F- Embedded flash has only %d pages\n\r",
+ AT91C_IFLASH_NB_OF_PAGES);
+ break;
+
+ case AT91C_EFC_FCMD_SFB:
+ case AT91C_EFC_FCMD_CFB:
+ ASSERT(argument < CHIP_EFC_NUM_GPNVMS, "-F- Embedded flash has only %d GPNVMs\n\r", CHIP_EFC_NUM_GPNVMS);
+ break;
+
+ case AT91C_EFC_FCMD_GETD:
+ case AT91C_EFC_FCMD_EA:
+ case AT91C_EFC_FCMD_GLB:
+ case AT91C_EFC_FCMD_GFB:
+#ifdef AT91C_EFC_FCMD_STUI
+ case AT91C_EFC_FCMD_STUI:
+#endif
+ ASSERT(argument == 0, "-F- Argument is meaningless for the given command.\n\r");
+ break;
+
+ default: ASSERT(0, "-F- Unknown command %d\n\r", command);
+ }
+
+ // Start commandEmbedded flash
+ ASSERT((pEfc->EFC_FSR & AT91C_EFC_FRDY) == AT91C_EFC_FRDY, "-F- EEFC is not ready\n\r");
+ pEfc->EFC_FCR = (0x5A << 24) | (argument << 8) | command;
+}
+
+//------------------------------------------------------------------------------
+/// Performs the given command and wait until its completion (or an error).
+/// Returns 0 if successful; otherwise returns an error code.
+/// \param pEfc Pointer to an AT91S_EFC structure.
+/// \param command Command to perform.
+/// \param argument Optional command argument.
+//------------------------------------------------------------------------------
+#if defined(flash) || defined (USE_FLASH)
+ #ifdef __ICCARM__
+__ramfunc
+ #else
+__attribute__ ((section (".ramfunc")))
+ #endif
+#endif
+unsigned char EFC_PerformCommand(AT91S_EFC *pEfc, unsigned char command, unsigned short argument)
+{
+ unsigned int status;
+
+#ifdef CHIP_FLASH_IAP_ADDRESS
+
+#ifdef AT91C_BASE_EFC1
+
+// Pointer on IAP function in ROM
+ static unsigned int (*IAP_PerformCommand)(unsigned int, unsigned int);
+ unsigned int index = 0;
+ if (pEfc == AT91C_BASE_EFC1) {
+
+ index = 1;
+ }
+ IAP_PerformCommand = (unsigned int (*)(unsigned int, unsigned int)) *((unsigned int *) CHIP_FLASH_IAP_ADDRESS);
+ EFCIndex = pEfc == AT91C_BASE_EFC0? 0: 1;
+ // Check if IAP function is implemented (opcode in SWI != 'b' or 'ldr') */
+ if ((((((unsigned long) IAP_PerformCommand >> 24) & 0xFF) != 0xEA) &&
+ (((unsigned long) IAP_PerformCommand >> 24) & 0xFF) != 0xE5)) {
+
+ IAP_PerformCommand(index, (0x5A << 24) | (argument << 8) | command);
+ return (pEfc->EFC_FSR & (AT91C_EFC_LOCKE | AT91C_EFC_FCMDE));
+ }
+#else //only have one EEFC (AT91SAM9XE for example)
+ // Pointer on IAP function in ROM
+ static void (*IAP_PerformCommand)(unsigned int);
+ IAP_PerformCommand = (void (*)(unsigned int)) *((unsigned int *) CHIP_FLASH_IAP_ADDRESS);
+
+ // Check if IAP function is implemented (opcode in SWI != 'b' or 'ldr') */
+ if ((((((unsigned long) IAP_PerformCommand >> 24) & 0xFF) != 0xEA) &&
+ (((unsigned long) IAP_PerformCommand >> 24) & 0xFF) != 0xE5)) {
+
+ IAP_PerformCommand((0x5A << 24) | (argument << 8) | command);
+ return (pEfc->EFC_FSR & (AT91C_EFC_LOCKE | AT91C_EFC_FCMDE));
+ }
+#endif
+#endif
+ pEfc->EFC_FCR = (0x5A << 24) | (argument << 8) | command;
+ do {
+
+ status = pEfc->EFC_FSR;
+ }
+ while ((status & AT91C_EFC_FRDY) != AT91C_EFC_FRDY);
+
+ return (status & (AT91C_EFC_LOCKE | AT91C_EFC_FCMDE));
+}
+
+//------------------------------------------------------------------------------
+/// Returns the current status of the EEFC. Keep in mind that this function clears
+/// the value of some status bits (LOCKE, PROGE).
+/// \param pEfc Pointer to an AT91S_EFC structure.
+//------------------------------------------------------------------------------
+unsigned int EFC_GetStatus(AT91S_EFC *pEfc)
+{
+ return pEfc->EFC_FSR;
+}
+
+//------------------------------------------------------------------------------
+/// Returns the result of the last executed command.
+/// \param pEfc Pointer to an AT91S_EFC structure.
+//------------------------------------------------------------------------------
+unsigned int EFC_GetResult(AT91S_EFC *pEfc) {
+
+ return pEfc->EFC_FRR;
+}
+
diff --git a/peripherals/eefc/eefc.dir b/peripherals/eefc/eefc.dir
new file mode 100644
index 0000000..8b969db
--- /dev/null
+++ b/peripherals/eefc/eefc.dir
@@ -0,0 +1,37 @@
+/* ----------------------------------------------------------------------------
+ * ATMEL Microcontroller Software Support
+ * ----------------------------------------------------------------------------
+ * Copyright (c) 2008, Atmel Corporation
+ *
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are 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.
+ * ----------------------------------------------------------------------------
+ */
+
+//------------------------------------------------------------------------------
+/// \dir
+///
+/// !!!Purpose
+///
+/// Contains the peripheral API for the Enhance Embedded Flash Controller (EEFC).
+//------------------------------------------------------------------------------
+
diff --git a/peripherals/eefc/eefc.h b/peripherals/eefc/eefc.h
new file mode 100644
index 0000000..a5ebd09
--- /dev/null
+++ b/peripherals/eefc/eefc.h
@@ -0,0 +1,147 @@
+/* ----------------------------------------------------------------------------
+ * ATMEL Microcontroller Software Support
+ * ----------------------------------------------------------------------------
+ * Copyright (c) 2009, Atmel Corporation
+ *
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are 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.
+ * ----------------------------------------------------------------------------
+ */
+//------------------------------------------------------------------------------
+/// \unit
+///
+/// !Purpose
+///
+/// Interface for configuration the Enhanced Embedded Flash Controller (EEFC)
+/// peripheral.
+///
+/// !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_StartCommand()
+/// -# Retrieve the current status of the EFC using EFC_GetStatus().
+/// -# Retrieve the result of the last executed command with EFC_GetResult().
+//------------------------------------------------------------------------------
+#ifndef EEFC_H
+#define EEFC_H
+
+//------------------------------------------------------------------------------
+// Headers
+//------------------------------------------------------------------------------
+
+#include <board.h>
+
+#if !defined (CHIP_FLASH_EEFC)
+#error eefc not supported
+#endif
+
+//------------------------------------------------------------------------------
+// Constants
+//------------------------------------------------------------------------------
+
+//------------------------------------------------------------------------------
+// Types
+//------------------------------------------------------------------------------
+
+// Needed when EEFC is integrated in MC.
+#if !defined(AT91C_BASE_EFC) && defined(AT91C_BASE_MC)
+typedef struct _AT91S_EFC {
+ AT91_REG EFC_FMR; // EFC Flash Mode Register
+ AT91_REG EFC_FCR; // EFC Flash Command Register
+ AT91_REG EFC_FSR; // EFC Flash Status Register
+ AT91_REG EFC_FRR; // EFC Flash Result Register
+ AT91_REG EFC_FVR; // EFC Flash Version Register
+} AT91S_EFC, *AT91PS_EFC;
+
+#define AT91C_EFC_FRDY AT91C_MC_FRDY
+#define AT91C_EFC_FWS AT91C_MC_FWS
+#define AT91C_EFC_FWS_0WS AT91C_MC_FWS_0WS
+#define AT91C_EFC_FWS_1WS AT91C_MC_FWS_1WS
+#define AT91C_EFC_FWS_2WS AT91C_MC_FWS_2WS
+#define AT91C_EFC_FWS_3WS AT91C_MC_FWS_3WS
+#define AT91C_EFC_FCMD AT91C_MC_FCMD
+#define AT91C_EFC_FCMD_GETD AT91C_MC_FCMD_GETD
+#define AT91C_EFC_FCMD_WP AT91C_MC_FCMD_WP
+#define AT91C_EFC_FCMD_WPL AT91C_MC_FCMD_WPL
+#define AT91C_EFC_FCMD_EWP AT91C_MC_FCMD_EWP
+#define AT91C_EFC_FCMD_EWPL AT91C_MC_FCMD_EWPL
+#define AT91C_EFC_FCMD_EA AT91C_MC_FCMD_EA
+#define AT91C_EFC_FCMD_EPL AT91C_MC_FCMD_EPL
+#define AT91C_EFC_FCMD_EPA AT91C_MC_FCMD_EPA
+#define AT91C_EFC_FCMD_SLB AT91C_MC_FCMD_SLB
+#define AT91C_EFC_FCMD_CLB AT91C_MC_FCMD_CLB
+#define AT91C_EFC_FCMD_GLB AT91C_MC_FCMD_GLB
+#define AT91C_EFC_FCMD_SFB AT91C_MC_FCMD_SFB
+#define AT91C_EFC_FCMD_CFB AT91C_MC_FCMD_CFB
+#define AT91C_EFC_FCMD_GFB AT91C_MC_FCMD_GFB
+#define AT91C_EFC_FARG AT91C_MC_FARG
+#define AT91C_EFC_FKEY AT91C_MC_FKEY
+#define AT91C_EFC_FRDY_S AT91C_MC_FRDY_S
+#define AT91C_EFC_FCMDE AT91C_MC_FCMDE
+#define AT91C_EFC_LOCKE AT91C_MC_LOCKE
+#define AT91C_EFC_FVALUE AT91C_MC_FVALUE
+
+#define AT91C_BASE_EFC (AT91_CAST(AT91PS_EFC) 0xFFFFFF60)
+
+#endif //#if !defined(AT91C_BASE_EFC) && defined(AT91C_BASE_MC)
+
+//------------------------------------------------------------------------------
+// Functions
+//------------------------------------------------------------------------------
+
+extern void EFC_EnableFrdyIt(AT91S_EFC *pEfc);
+
+extern void EFC_DisableFrdyIt(AT91S_EFC *pEfc);
+
+extern void EFC_TranslateAddress(
+ AT91S_EFC **ppEfc,
+ unsigned int address,
+ unsigned short *pPage,
+ unsigned short *pOffset);
+
+extern void EFC_ComputeAddress(
+ AT91S_EFC *pEfc,
+ unsigned short page,
+ unsigned short offset,
+ unsigned int *pAddress);
+
+extern void EFC_StartCommand(
+ AT91S_EFC *pEfc,
+ unsigned char command,
+ unsigned short argument);
+
+extern unsigned char EFC_PerformCommand(
+ AT91S_EFC *pEfc,
+ unsigned char command,
+ unsigned short argument);
+
+extern unsigned int EFC_GetStatus(AT91S_EFC *pEfc);
+
+extern unsigned int EFC_GetResult(AT91S_EFC *pEfc);
+
+#endif //#ifndef EEFC_H
+
personal git repositories of Harald Welte. Your mileage may vary