SAMV71 Xplained Ultra Software Package 1.0

EccNandFlash.h

Go to the documentation of this file.
00001 /* ----------------------------------------------------------------------------
00002  *         ATMEL Microcontroller Software Support
00003  * ----------------------------------------------------------------------------
00004  * Copyright (c) 2009, Atmel Corporation
00005  *
00006  * All rights reserved.
00007  *
00008  * Redistribution and use in source and binary forms, with or without
00009  * modification, are permitted provided that the following conditions are met:
00010  *
00011  * - Redistributions of source code must retain the above copyright notice,
00012  * this list of conditions and the disclaimer below.
00013  *
00014  * Atmel's name may not be used to endorse or promote products derived from
00015  * this software without specific prior written permission.
00016  *
00017  * DISCLAIMER: THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR
00018  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
00019  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE
00020  * DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR ANY DIRECT, INDIRECT,
00021  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
00022  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
00023  * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00024  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00025  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
00026  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00027  * ----------------------------------------------------------------------------
00028  */
00029 
00030 /**
00031  * \file
00032  *
00033  * EccNandFlash layer is called by SkipBlockNandFlash driver, it will call the bl driver (RawNandFlash)
00034  * to do write/read operations, and do ECC check to the write/read result, it then will feedback the
00035  * ecc check result to the upper SkipBlockNandFlash layer driver.
00036  */
00037 
00038 #ifndef ECCNANDFLASH_H
00039 #define ECCNANDFLASH_H
00040 
00041 /*----------------------------------------------------------------------------
00042  *        Headers
00043  *----------------------------------------------------------------------------*/
00044 
00045 #include "RawNandFlash.h"
00046 
00047 /*----------------------------------------------------------------------------
00048  *        Types
00049  *----------------------------------------------------------------------------*/
00050 
00051 struct EccNandFlash {
00052 
00053     struct RawNandFlash raw;
00054 };
00055 
00056 /*----------------------------------------------------------------------------
00057  *        Exported functions
00058  *----------------------------------------------------------------------------*/
00059 extern unsigned char EccNandFlash_Initialize(
00060     struct EccNandFlash *ecc,
00061     const struct NandFlashModel *model,
00062     unsigned int commandAddress,
00063     unsigned int addressAddress,
00064     unsigned int dataAddress,
00065     const Pin pinChipEnable,
00066     const Pin pinReadyBusy);
00067 
00068 extern unsigned char EccNandFlash_ReadPage(
00069     const struct EccNandFlash *ecc,
00070     unsigned short block,
00071     unsigned short page,
00072     void *data,
00073     void *spare);
00074 
00075 extern unsigned char EccNandFlash_WritePage(
00076     const struct EccNandFlash *ecc,
00077     unsigned short block,
00078     unsigned short page,
00079     void *data,
00080     void *spare);
00081 
00082 #endif /*#ifndef ECCNANDFLASH_H */
00083 
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Defines