185 lines
7.7 KiB
C
185 lines
7.7 KiB
C
//*****************************************************************************
|
|
//
|
|
// am_hal_flash.h
|
|
//! @file
|
|
//!
|
|
//! @brief Functions for performing Flash operations.
|
|
//!
|
|
//! @addtogroup flash1 Flash
|
|
//! @ingroup apollo1hal
|
|
//! @{
|
|
//
|
|
//*****************************************************************************
|
|
|
|
//*****************************************************************************
|
|
//
|
|
// Copyright (c) 2020, Ambiq Micro
|
|
// All rights reserved.
|
|
//
|
|
// Redistribution and use in source and binary forms, with or without
|
|
// modification, are permitted provided that the following conditions are met:
|
|
//
|
|
// 1. Redistributions of source code must retain the above copyright notice,
|
|
// this list of conditions and the following disclaimer.
|
|
//
|
|
// 2. Redistributions in binary form must reproduce the above copyright
|
|
// notice, this list of conditions and the following disclaimer in the
|
|
// documentation and/or other materials provided with the distribution.
|
|
//
|
|
// 3. Neither the name of the copyright holder nor the names of its
|
|
// contributors may be used to endorse or promote products derived from this
|
|
// software without specific prior written permission.
|
|
//
|
|
// Third party software included in this distribution is subject to the
|
|
// additional license terms as defined in the /docs/licenses directory.
|
|
//
|
|
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
|
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS 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.
|
|
//
|
|
// This is part of revision 2.4.2 of the AmbiqSuite Development Package.
|
|
//
|
|
//*****************************************************************************
|
|
#ifndef AM_HAL_FLASH_H
|
|
#define AM_HAL_FLASH_H
|
|
|
|
#include <stdint.h>
|
|
#include <stdbool.h>
|
|
|
|
//*****************************************************************************
|
|
//
|
|
// Flash Program keys.
|
|
//
|
|
//*****************************************************************************
|
|
#define AM_HAL_FLASH_PROGRAM_KEY 0x12344321
|
|
#define AM_HAL_FLASH_OTP_KEY 0x87655678
|
|
|
|
//*****************************************************************************
|
|
//
|
|
// Some helpful flash values and macros.
|
|
//
|
|
//*****************************************************************************
|
|
#define AM_HAL_FLASH_ADDR 0x00000000
|
|
#define AM_HAL_FLASH_PAGE_SIZE ( 2 * 1024 )
|
|
#define AM_HAL_FLASH_INFO_SIZE AM_HAL_FLASH_PAGE_SIZE
|
|
#define AM_HAL_FLASH_BLOCK_SIZE ( 256 * 1024 )
|
|
#define AM_HAL_FLASH_BLOCK_PAGES ( AM_HAL_FLASH_BLOCK_SIZE / AM_HAL_FLASH_PAGE_SIZE )
|
|
#define AM_HAL_FLASH_INSTANCE_SIZE AM_HAL_FLASH_BLOCK_SIZE
|
|
#define AM_HAL_FLASH_INSTANCE_PAGES AM_HAL_FLASH_BLOCK_PAGES
|
|
#define AM_HAL_FLASH_TOTAL_SIZE ( AM_HAL_FLASH_BLOCK_SIZE * 2 )
|
|
#define AM_HAL_FLASH_LARGEST_VALID_ADDR ( AM_HAL_FLASH_ADDR + AM_HAL_FLASH_TOTAL_SIZE - 1 )
|
|
|
|
//
|
|
// Convert an absolute flash address to a block (instance)
|
|
//
|
|
#define AM_HAL_FLASH_ADDR2BLOCK(addr) ( ( addr >> 18 ) & 1 )
|
|
#define AM_HAL_FLASH_ADDR2INST(addr) ( ( addr >> 18 ) & 1 )
|
|
|
|
//
|
|
// Convert an absolute flash address to a page number relative to the block
|
|
//
|
|
#define AM_HAL_FLASH_ADDR2PAGE(addr) ( ( addr >> 11 ) & 0x7F )
|
|
|
|
//
|
|
// Convert an absolute flash address to an absolute page number
|
|
//
|
|
#define AM_HAL_FLASH_ADDR2ABSPAGE(addr) ( addr >> 11 )
|
|
|
|
//*****************************************************************************
|
|
//
|
|
// Given an integer number of microseconds, convert to a value representing the
|
|
// number of am_hal_flash_delay() cycles that will provide that amount of delay.
|
|
// This macro is designed to take into account some of the call overhead.
|
|
//
|
|
// e.g. To provide a 2us delay:
|
|
// am_hal_flash_delay( FLASH_CYCLES_US(2) );
|
|
//
|
|
// IMPORTANT - Apollo is spec'ed to run at multiple frequencies from 24MHz down
|
|
// to 3MHz. The macro must be able to handle any frequency and must be
|
|
// determined at runtime. Because 3MHz is a valid frequency, the macro cannot
|
|
// account for any overhead.
|
|
// For best results, when 24MHz operation is known use FLASH_CYCLES_US_MAX().
|
|
//
|
|
//*****************************************************************************
|
|
#define FLASH_CYCLES_US_MAX(n) ((n * (AM_HAL_CLKGEN_FREQ_MAX_MHZ / 3)) - 4)
|
|
#define FLASH_CYCLES_US(n) ((n * ((am_hal_clkgen_sysclk_get() / 1000000) / 3)) - 0)
|
|
|
|
//*****************************************************************************
|
|
//
|
|
// Structure of function pointers to helper functions for invoking various
|
|
// flash operations.
|
|
//
|
|
//*****************************************************************************
|
|
typedef struct am_hal_flash_helper_struct
|
|
{
|
|
int (*am_hal_flash_mass_erase)(uint32_t, uint32_t);
|
|
int (*am_hal_flash_page_erase)(uint32_t, uint32_t, uint32_t);
|
|
int (*am_hal_flash_program_main)(uint32_t, const uint32_t *,
|
|
uint32_t*, uint32_t);
|
|
int (*am_hal_flash_program_otp)(uint32_t, uint32_t,
|
|
const uint32_t*, uint32_t, uint32_t);
|
|
void (*am_hal_flash_program_main_sram)(void);
|
|
void (*am_hal_flash_program_otp_sram)(void);
|
|
void (*am_hal_flash_erase_main_pages_sram)(void);
|
|
void (*am_hal_flash_mass_erase_sram)(void);
|
|
} g_am_hal_flash_t;
|
|
extern const g_am_hal_flash_t g_am_hal_flash;
|
|
|
|
#ifdef __cplusplus
|
|
extern "C"
|
|
{
|
|
#endif
|
|
|
|
//*****************************************************************************
|
|
//
|
|
// Function prototypes for the helper functions
|
|
//
|
|
//*****************************************************************************
|
|
extern void am_hal_flash_delay(uint32_t ui32Iterations);
|
|
extern uint32_t am_hal_flash_delay_status_change(uint32_t ui32usDelay,
|
|
uint32_t ui32Address,
|
|
uint32_t ui32Mask,
|
|
uint32_t ui32Value);
|
|
extern int am_hal_flash_mass_erase(uint32_t ui32Value,
|
|
uint32_t ui32FlashBlk);
|
|
extern int am_hal_flash_page_erase(uint32_t ui32Value,
|
|
uint32_t ui32FlashBlk,
|
|
uint32_t ui32PageNum);
|
|
extern int am_hal_flash_program_otp(uint32_t ui32Value,
|
|
uint32_t ui32FlashBlk,
|
|
const uint32_t *pui32Src,
|
|
uint32_t ui32Offset,
|
|
uint32_t ui32NumWords);
|
|
extern int am_hal_flash_program_main(uint32_t value, const uint32_t *pSrc,
|
|
uint32_t *pDst, uint32_t NumberOfWords);
|
|
|
|
// SRAM variants
|
|
extern void am_hal_flash_erase_main_pages_sram(void);
|
|
extern void am_hal_flash_mass_erase_sram(void);
|
|
extern void am_hal_flash_program_otp_sram(void);
|
|
extern void am_hal_flash_program_main_sram(void);
|
|
|
|
// SRAM resident reader function for OTP can't be in FLASH
|
|
uint32_t am_hal_flash_load_ui32(uint32_t ui32Address);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif // AM_HAL_FLASH_H
|
|
|
|
//*****************************************************************************
|
|
//
|
|
// End Doxygen group.
|
|
//! @}
|
|
//
|
|
//*****************************************************************************
|