flash_write_example.c File Reference

Writing EEPROM and Flash in ATxmega256A3 / ATxmega256A3B - Rev B. More...

#include "sp_driver.h"

Go to the source code of this file.

Defines
#define	APP_END   0x40000
#define	FLASH_PAGE_SIZE   512
Functions
void	ClearFlashBuffer (void)
void	EraseApplicationPage (uint32_t address)
void	EraseWriteApplicationPage (uint32_t address)
	ISR (NVM_SPM_vect)
void	LoadFlashWord (uint32_t address, uint16_t word)
int	main (void)
	Example to show how to read and write to the flash.
void	PMIC_SetVectorLocationToApplication (void)
void	PMIC_SetVectorLocationToBoot (void)
void	Prepare_to_Sleep (void)
Variables
uint8_t	globalInt
uint8_t	pmicStore
uint8_t	sleepCtr
uint8_t	spmintStore
uint8_t	statusStore

---

Detailed Description

Writing EEPROM and Flash in ATxmega256A3 / ATxmega256A3B - Rev B.

This file contains an example application that demonstrates Self-programming for ATxmega256A3 / ATxmega256A3B - Rev B.

Application note:

AVR1008: Writing EEPROM and Flash in ATxmega256A3 / ATxmega256A3B - Rev B

Documentation

For comprehensive code documentation, supported compilers, compiler settings and supported devices see readme.html

Author:

Atmel Corporation: http://www.atmel.com
Support email: avr@atmel.com

Revision

2740

Date

2009-09-02 10:43:01 +0200 (on, 02 sep 2009)

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:

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. The name of ATMEL may not be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY ATMEL "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 EXPRESSLY AND SPECIFICALLY 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.

Definition in file flash_write_example.c.

---

Define Documentation

#define APP_END   0x40000

Definition at line 51 of file flash_write_example.c.

Referenced by main().

#define FLASH_PAGE_SIZE   512

Definition at line 52 of file flash_write_example.c.

Referenced by main().

---

Function Documentation

void ClearFlashBuffer

(

void

)

Definition at line 133 of file flash_write_example.c.

References Prepare_to_Sleep(), and SP_EraseFlashBuffer().

Referenced by main().

{
        /*Set the correct settings and store critical registers before NVM-workaround*/
        Prepare_to_Sleep(); 
        /*Assembly "function" to erase flash buffer*/
        SP_EraseFlashBuffer();
}

void EraseApplicationPage

(

uint32_t

address

)

Definition at line 117 of file flash_write_example.c.

References Prepare_to_Sleep(), and SP_EraseApplicationPage().

{
        /*Set the correct settings and store critical registers before NVM-workaround*/
        Prepare_to_Sleep();
        /*Assembly "function" to preform page erase*/
        SP_EraseApplicationPage(address);
}

void EraseWriteApplicationPage

(

uint32_t

address

)

Definition at line 125 of file flash_write_example.c.

References Prepare_to_Sleep(), and SP_EraseWriteApplicationPage().

Referenced by main().

{
        /*Set the correct settings and store critical registers before NVM-workaround*/
        Prepare_to_Sleep(); 
        /*Assembly "function" to preform page erase-write*/
        SP_EraseWriteApplicationPage(address);
}

ISR

(

NVM_SPM_vect

)

Definition at line 65 of file flash_write_example.c.

References globalInt, pmicStore, sleepCtr, spmintStore, and statusStore.

{
        /* Disable the SPM interrupt */
        NVM.INTCTRL = (NVM.INTCTRL & ~NVM_SPMLVL_gm);
        /* Restore sleep settings */
        SLEEP.CTRL = sleepCtr;
        /* Restore PMIC status and control registers */
        PMIC.STATUS = statusStore;
        PMIC.CTRL = pmicStore;
        /* Restore SPM interruptsettings */
        NVM.INTCTRL = spmintStore;
        /* Restore global interrupt settings */
        SREG = globalInt;
        return;
}

void LoadFlashWord	(	uint32_t	address,
		uint16_t	word
	)

Definition at line 141 of file flash_write_example.c.

References Prepare_to_Sleep(), and SP_LoadFlashWord().

Referenced by main().

{
        /*Set the correct settings and store critical registers before NVM-workaround*/
        Prepare_to_Sleep();   
        /*Assembly "function" to load flash buffer*/
        SP_LoadFlashWord(address, word);
}

int main

(

void

)

Example to show how to read and write to the flash.

Definition at line 152 of file flash_write_example.c.

References APP_END, ClearFlashBuffer(), EraseWriteApplicationPage(), FLASH_PAGE_SIZE, LoadFlashWord(), PMIC_SetVectorLocationToBoot(), SP_ReadByte(), and SP_WaitForSPM().

{
        /* Assume success until proven otherwise. */
        bool success = true;
        PMIC_SetVectorLocationToBoot();
        /* Fill the entire application section of the flash memory with bogus data */
        for (uint32_t address = 0; address < APP_END; address+=FLASH_PAGE_SIZE) {
        
                /* Load flash buffer with data */
                ClearFlashBuffer(); //Clear the flash buffer first to avoid data corruption
                for (uint16_t i = 0; i < FLASH_PAGE_SIZE; i += 2) {
                        uint8_t lowByte = i;
                        uint8_t highByte = i+1;
                        
                        LoadFlashWord((uint32_t)i, ((uint16_t) highByte << 8) | lowByte);
                        SP_WaitForSPM();
                }
                
                /* Perform erase-page write. */ 
                EraseWriteApplicationPage(address);
        }
        
        /* Check if data is written correctly */
        for (uint32_t address = 0; address < APP_END; address++)
        {
           if(SP_ReadByte(address) != (uint8_t)address) success = false;
        }
        
        /* Allow for breakpoint to check the value of "success". */
        if (success) {
                while(true){
                        nop();
                }
        } else {
                while(true){
                        nop();
                }
        }
}

void PMIC_SetVectorLocationToApplication

(

void

)

Definition at line 90 of file flash_write_example.c.

{
        uint8_t temp = PMIC.CTRL & ~PMIC_IVSEL_bm;
        CCP = CCP_IOREG_gc;
        PMIC.CTRL = temp;
}

void PMIC_SetVectorLocationToBoot

(

void

)

Definition at line 82 of file flash_write_example.c.

Referenced by main().

{
        uint8_t temp = PMIC.CTRL | PMIC_IVSEL_bm;
        CCP = CCP_IOREG_gc;
        PMIC.CTRL = temp;
}

void Prepare_to_Sleep

(

void

)

Definition at line 98 of file flash_write_example.c.

References globalInt, pmicStore, sleepCtr, spmintStore, and statusStore.

Referenced by ClearFlashBuffer(), EraseApplicationPage(), EraseWriteApplicationPage(), and LoadFlashWord().

{
        sleepCtr = SLEEP.CTRL;
        /* Set sleep mode to IDLE */
        SLEEP.CTRL =  0x00; 
        /* Save the PMIC Status and control registers */
        statusStore = PMIC.STATUS;                                                              
        pmicStore = PMIC.CTRL;          
        /* Enable only the highest level of interrupts */                                                                       
        PMIC.CTRL = (PMIC.CTRL & ~PMIC_HILVLEN_bm) | PMIC_HILVLEN_bm;
        /* Save SREG for later use */
        globalInt = SREG;
        /* Enable global interrupts */
        sei();
        /* Save SPM interrupt settings for later */ 
        spmintStore = NVM.INTCTRL;
}

---

Variable Documentation

uint8_t globalInt

Definition at line 61 of file flash_write_example.c.

Referenced by ISR(), and Prepare_to_Sleep().

uint8_t pmicStore

Definition at line 60 of file flash_write_example.c.

Referenced by ISR(), and Prepare_to_Sleep().

uint8_t sleepCtr

Definition at line 58 of file flash_write_example.c.

Referenced by ISR(), and Prepare_to_Sleep().

uint8_t spmintStore

Definition at line 62 of file flash_write_example.c.

Referenced by ISR(), and Prepare_to_Sleep().

uint8_t statusStore

Definition at line 59 of file flash_write_example.c.

Referenced by ISR(), and Prepare_to_Sleep().