226 lines
6.3 KiB
C
226 lines
6.3 KiB
C
/** @addtogroup flash_file
|
|
*
|
|
*/
|
|
|
|
/*
|
|
* This file is part of the libopencm3 project.
|
|
*
|
|
* Copyright (C) 2014 Ken Sarkies <ksarkies@internode.on.net>
|
|
*
|
|
* This library is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU Lesser General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This library is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public License
|
|
* along with this library. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
/**@{*/
|
|
|
|
#include <libopencm3/stm32/flash.h>
|
|
|
|
/*---------------------------------------------------------------------------*/
|
|
/** @brief Enable the FLASH Prefetch Buffer
|
|
|
|
This buffer is used for instruction fetches and is enabled by default after
|
|
reset.
|
|
|
|
Note carefully the clock restrictions under which the prefetch buffer may be
|
|
enabled or disabled. Changes are normally made while the clock is running in
|
|
the power-on low frequency mode before being set to a higher speed mode.
|
|
See the reference manual for details.
|
|
*/
|
|
|
|
void flash_prefetch_enable(void)
|
|
{
|
|
FLASH_ACR |= FLASH_ACR_PRFTBE;
|
|
}
|
|
|
|
/*---------------------------------------------------------------------------*/
|
|
/** @brief Disable the FLASH Prefetch Buffer
|
|
|
|
Note carefully the clock restrictions under which the prefetch buffer may be
|
|
set to disabled. See the reference manual for details.
|
|
*/
|
|
|
|
void flash_prefetch_disable(void)
|
|
{
|
|
FLASH_ACR &= ~FLASH_ACR_PRFTBE;
|
|
}
|
|
/*---------------------------------------------------------------------------*/
|
|
/** @brief Set the Number of Wait States
|
|
|
|
Used to match the system clock to the FLASH memory access time. See the
|
|
reference manual for more information on clock speed ranges for each wait state.
|
|
The latency must be changed to the appropriate value <b>before</b> any increase
|
|
in clock speed, or <b>after</b> any decrease in clock speed.
|
|
|
|
@param[in] ws values from @ref flash_latency.
|
|
*/
|
|
|
|
void flash_set_ws(uint32_t ws)
|
|
{
|
|
FLASH_ACR = (FLASH_ACR & ~FLASH_ACR_LATENCY) | ws;
|
|
}
|
|
|
|
/*---------------------------------------------------------------------------*/
|
|
/** @brief Unlock the Flash Program and Erase Controller
|
|
|
|
This enables write access to the Flash memory. It is locked by default on
|
|
reset.
|
|
*/
|
|
|
|
void flash_unlock(void)
|
|
{
|
|
/* Clear the unlock state. */
|
|
FLASH_CR |= FLASH_CR_LOCK;
|
|
|
|
/* Authorize the FPEC access. */
|
|
FLASH_KEYR = FLASH_KEYR_KEY1;
|
|
FLASH_KEYR = FLASH_KEYR_KEY2;
|
|
}
|
|
|
|
/*---------------------------------------------------------------------------*/
|
|
/** @brief Lock the Flash Program and Erase Controller
|
|
|
|
Used to prevent spurious writes to FLASH.
|
|
*/
|
|
|
|
void flash_lock(void)
|
|
{
|
|
FLASH_CR |= FLASH_CR_LOCK;
|
|
}
|
|
|
|
/*---------------------------------------------------------------------------*/
|
|
/** @brief Clear the Programming Error Status Flag
|
|
|
|
*/
|
|
|
|
void flash_clear_pgerr_flag(void)
|
|
{
|
|
FLASH_SR |= FLASH_SR_PGERR;
|
|
}
|
|
|
|
/*---------------------------------------------------------------------------*/
|
|
/** @brief Clear the End of Operation Status Flag
|
|
|
|
*/
|
|
|
|
void flash_clear_eop_flag(void)
|
|
{
|
|
FLASH_SR |= FLASH_SR_EOP;
|
|
}
|
|
|
|
/*---------------------------------------------------------------------------*/
|
|
/** @brief Clear the Write Protect Error Status Flag
|
|
|
|
*/
|
|
|
|
void flash_clear_wrprterr_flag(void)
|
|
{
|
|
FLASH_SR |= FLASH_SR_WRPRTERR;
|
|
}
|
|
|
|
/*---------------------------------------------------------------------------*/
|
|
/** @brief Wait until Last Operation has Ended
|
|
|
|
This loops indefinitely until an operation (write or erase) has completed by
|
|
testing the busy flag.
|
|
*/
|
|
|
|
void flash_wait_for_last_operation(void)
|
|
{
|
|
while ((flash_get_status_flags() & FLASH_SR_BSY) == FLASH_SR_BSY);
|
|
}
|
|
|
|
/*---------------------------------------------------------------------------*/
|
|
/** @brief Program a 32 bit Word to FLASH
|
|
|
|
This performs all operations necessary to program a 32 bit word to FLASH memory.
|
|
The program error flag should be checked separately for the event that memory
|
|
was not properly erased.
|
|
|
|
Status bit polling is used to detect end of operation.
|
|
|
|
@param[in] address Full address of flash word to be programmed.
|
|
@param[in] data word to write
|
|
*/
|
|
|
|
void flash_program_word(uint32_t address, uint32_t data)
|
|
{
|
|
flash_program_half_word(address, (uint16_t)data);
|
|
flash_program_half_word(address+2, (uint16_t)(data>>16));
|
|
}
|
|
|
|
/*---------------------------------------------------------------------------*/
|
|
/** @brief Unlock the Option Byte Access
|
|
|
|
This enables write access to the option bytes. It is locked by default on
|
|
reset.
|
|
*/
|
|
|
|
void flash_unlock_option_bytes(void)
|
|
{
|
|
/* F1 uses same keys for flash and option */
|
|
FLASH_OPTKEYR = FLASH_KEYR_KEY1;
|
|
FLASH_OPTKEYR = FLASH_KEYR_KEY2;
|
|
}
|
|
|
|
/*---------------------------------------------------------------------------*/
|
|
/** @brief Erase All Option Bytes
|
|
|
|
This performs all operations necessary to erase the option bytes. These must
|
|
first be fully erased before attempting to program them, therefore it is
|
|
recommended to check these after an erase attempt.
|
|
*/
|
|
|
|
void flash_erase_option_bytes(void)
|
|
{
|
|
flash_wait_for_last_operation();
|
|
|
|
if ((FLASH_CR & FLASH_CR_OPTWRE) == 0) {
|
|
flash_unlock_option_bytes();
|
|
}
|
|
|
|
FLASH_CR |= FLASH_CR_OPTER; /* Enable option byte erase. */
|
|
FLASH_CR |= FLASH_CR_STRT;
|
|
flash_wait_for_last_operation();
|
|
FLASH_CR &= ~FLASH_CR_OPTER; /* Disable option byte erase. */
|
|
}
|
|
|
|
/*---------------------------------------------------------------------------*/
|
|
/** @brief Program the Option Bytes
|
|
|
|
This performs all operations necessary to program the option bytes.
|
|
The write protect error flag should be checked separately for the event that
|
|
an option byte had not been properly erased before calling this function.
|
|
|
|
Only the lower 8 bits of the data is significant.
|
|
|
|
@param[in] address Address of option byte from @ref flash_options.
|
|
@param[in] data value to write
|
|
*/
|
|
|
|
void flash_program_option_bytes(uint32_t address, uint16_t data)
|
|
{
|
|
flash_wait_for_last_operation();
|
|
|
|
if ((FLASH_CR & FLASH_CR_OPTWRE) == 0) {
|
|
flash_unlock_option_bytes();
|
|
}
|
|
|
|
FLASH_CR |= FLASH_CR_OPTPG; /* Enable option byte programming. */
|
|
MMIO16(address) = data;
|
|
flash_wait_for_last_operation();
|
|
FLASH_CR &= ~FLASH_CR_OPTPG; /* Disable option byte programming. */
|
|
}
|
|
|
|
/**@}*/
|
|
|