/*This file is prepared for Doxygen automatic documentation generation.*/
//! \file *********************************************************************
//!
//! \brief This file contains a set of routines to perform eeprom access.
//!
//! - Compiler:           IAR EWAVR and GNU GCC for AVR
//! - Supported devices:  ATmega32U4
//!
//! \author               Atmel Corporation: http://www.atmel.com \n
//!                       Support and FAQ: http://support.atmel.no/
//!
//! ***************************************************************************

/* 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.
 *
 * 4. This software may only be redistributed and used in connection with an Atmel
 * AVR product.
 *
 * 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 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.
 */
#ifndef _EEP_LIB_H
#define _EEP_LIB_H

/*_____ I N C L U D E S ____________________________________________________*/

/*_____ M A C R O S ________________________________________________________*/

/*_____ D E F I N I T I O N S ______________________________________________*/
#define EEPROM_BLANK_VALUE    0xFF

/*_____ D E C L A R A T I O N S ____________________________________________*/
/**
 * @brief This function erases the whole eeprom memory.
 *
 * @return The result of function.
 *          - FALSE: result KO
 *          - TRUE:  result OK
 *
 */
bit     eeprom_erase          (void);

/**
 * @brief This function writes a byte in the eeprom memory.
 *
 * @param addr Address of the eeprom memory to write
 * @param value Byte to write
 * @return The result of function.
 *          - FALSE: result KO
 *          - TRUE:  result OK
 */
bit     eeprom_wr_byte        (Uint16 addr, Uchar value);

/**
 * @brief This function reads a byte in the eeprom memory.
 *
 * @param addr Address of the eeprom memory to read
 * 
 * @return Value read in the eeprom memory
 *         
 */
Byte  eeprom_rd_byte        (Uint16 addr);

/**
 * @brief This function reads up to 256 bytes in the eeprom memory.
 *
 * @param src Address of the array to store read data
 * @param *dest Address of the eeprom memory to read
 * @param n number of byte to read
 * @return The result of function.
 *          - FALSE: result KO
 *          - TRUE:  result OK
 */
bit     eeprom_rd_block       (Uint16 src, Byte _MemType_* dest, Byte n);

/**
 * @brief This function writes up to 256 bytes in the eeprom memory.
 *
 * @param *src Address of the array to write
 * @param dest Address of the eeprom memory to write
 * @param n number of byte to write
 * @return The result of function.
 *          - FALSE: result KO
 *          - TRUE:  result OK
 */
bit     eeprom_wr_block       (Byte _MemType_* src, Uint16 dest, U16 n);

#endif  /* _EEP_LIB_H */

