SAMV71 Xplained Ultra Software Package 1.0

TranslatedNandFlash.h

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 #ifndef TRANSLATEDNANDFLASH_H
00031 #define TRANSLATEDNANDFLASH_H
00032 
00033 /*----------------------------------------------------------------------------
00034  *        Headers
00035  *----------------------------------------------------------------------------*/
00036 
00037 #include "MappedNandFlash.h"
00038 
00039 /*----------------------------------------------------------------------------
00040  *        Type
00041  *----------------------------------------------------------------------------*/
00042 struct TranslatedNandFlash {
00043 
00044     struct MappedNandFlash mapped;
00045     int16_t currentLogicalBlock;
00046     int16_t previousPhysicalBlock;
00047     uint8_t currentBlockPageStatuses[NandCommon_MAXNUMPAGESPERBLOCK / 8];
00048 };
00049 
00050 /*----------------------------------------------------------------------------
00051  *        Exportd functions
00052  *----------------------------------------------------------------------------*/
00053 
00054 extern uint8_t TranslatedNandFlash_Initialize(
00055     struct TranslatedNandFlash *translated,
00056     const struct NandFlashModel *model,
00057     uint32_t commandAddress,
00058     uint32_t addressAddress,
00059     uint32_t dataAddress,
00060     const Pin pinChipEnable,
00061     const Pin pinReadyBusy,
00062     uint16_t baseBlock,
00063     uint16_t sizeInBlocks);
00064 
00065 extern uint8_t TranslatedNandFlash_ReadPage(
00066     const struct TranslatedNandFlash *translated,
00067     uint16_t block,
00068     uint16_t page,
00069     void *data,
00070     void *spare);
00071 
00072 extern uint8_t TranslatedNandFlash_WritePage(
00073     struct TranslatedNandFlash *translated,
00074     uint16_t block,
00075     uint16_t page,
00076     void *data,
00077     void *spare);
00078 
00079 extern uint8_t TranslatedNandFlash_Flush(
00080     struct TranslatedNandFlash *translated);
00081 
00082 extern uint8_t TranslatedNandFlash_EraseAll(
00083     struct TranslatedNandFlash *translated,
00084     uint8_t level);
00085 
00086 extern uint8_t TranslatedNandFlash_SaveLogicalMapping(
00087     struct TranslatedNandFlash *translated);
00088 
00089 extern uint16_t TranslatedNandFlash_GetDeviceSizeInBlocks(
00090    const struct TranslatedNandFlash *translated);
00091 
00092 extern uint32_t TranslatedNandFlash_GetDeviceSizeInPages(
00093    const struct TranslatedNandFlash *translated);
00094 
00095 extern unsigned long long TranslatedNandFlash_GetDeviceSizeInBytes(
00096    const struct TranslatedNandFlash *translated);
00097 
00098 #endif /*#ifndef TRANSLATEDNANDFLASH_H */
00099 
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Defines