/************************************************************************
* (c) Copyright Freescale Semiconductor, Inc 2008, All Rights Reserved  *
************************************************************************/

/************************************************************************
*             EEPROM Emulation Driver for S12XS/S12P with Intr          *
*                                                                       *
*   FILE NAME     :  readme.txt                                         *
*   DATE          :  Nov, 20 2008                                       *
*   AUTHOR        :  Infosys Team, Mysore                               *
*   EMAIL         :  r56611@freescale.com                               *
*************************************************************************/

/****************************** CHANGES *********************************
* 0.1.0    10.31.2008     Sindhu R01      Preliminary Release Version
* 0.1.1    11.20.2008     Sindhu R01      Final Release Version
*************************************************************************/

1. Overview

The S12XS/S12P EEPROM Emulation Driver's high level functions include 
FSL_InitEeprom,FSL_ReadEeprom,FSL_WriteEeprom, FSL_ReportEepromStatus,
FSL_DeinitEeprom and FSL_Main. 

The basic functionality of the five modules are listed below:
 1. FSL_InitEeprom - Initilazes EEPROM based on kind (first or repeat) of 
             usage;
 2. FSL_ReadEeprom - Reads for a required data in all the active sectors;
 3. FSL_WriteEeprom - Writes in the currently active Set of sectors; 
 4. FSL_ReportEepromStatus - Provides the erasing cycles of the current 
                 active sector; 
 5. FSL_DeinitEeprom - Deinitializes the currently Emulated Eeprom to 
               flash. 
 6. FSL_Main - Completes the Jobs of INIT, WRITE and DEINIT functions if necessary.               
 
2. File Structure
FREENMDD_S12XS_S12P_EED_INT_FINALRELEASE
|   
+---Demo
|               
+---Docs
|       
+---Driver
|   |   readme.txt
|   |   
|   +---Include
|   |       ee_emulation.h
|   |       SSD_SGF18.h
|   |       SSD_SGF18_Internal.h
|   |       SSD_Types.h
|   |       
|   \---Source
|           DFlashErase.c
|           DFlashEraseVerify.c
|           DFlashProgram.c
|           EED_HighLevel.c
|           EED_MiddleLevel.c
|           FlashCommandSequence.c
|           FlashInit.c
|           FlashInterruptSet.c
|           FlashProgramVerify.c
|           FlashSetUserMargin.c
|           
\---Test


Descriptions of file structure:
    1) ".\Source" contains S12XS/S12P EEPROM Emulation Driver (in source code format).
    2) ".\Include" directory contains all the related headers.
 
The code supports CodeWarrior v4.7. 