SAMV71 Xplained Ultra Software Package 1.0

MappedNandFlash.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  *  \file
00031  *
00032  *  Include Defines & macros for the mapped nand flash layer.
00033  */
00034 
00035 #ifndef MAPPEDNANDFLASH_H
00036 #define MAPPEDNANDFLASH_H
00037 
00038 /*----------------------------------------------------------------------------
00039  *        Headers
00040  *----------------------------------------------------------------------------*/
00041 
00042 #include "ManagedNandFlash.h"
00043 
00044 /*----------------------------------------------------------------------------
00045  *        Type
00046  *----------------------------------------------------------------------------*/
00047 
00048 struct MappedNandFlash {
00049 
00050     struct ManagedNandFlash managed;
00051     int16_t logicalMapping[NandCommon_MAXNUMBLOCKS];
00052     int16_t logicalMappingBlock;
00053     uint8_t mappingModified;
00054     uint8_t reserved;
00055 };
00056 
00057 /*----------------------------------------------------------------------------
00058  *        Exported functions
00059  *----------------------------------------------------------------------------*/
00060 
00061 extern uint8_t MappedNandFlash_Initialize(
00062     struct MappedNandFlash *mapped,
00063     const struct NandFlashModel *model,
00064     uint32_t commandAddress,
00065     uint32_t addressAddress,
00066     uint32_t dataAddress,
00067     const Pin pinChipEnable,
00068     const Pin pinReadyBusy,
00069     uint16_t baseBlock,
00070     uint16_t sizeInBlocks);
00071 
00072 extern uint8_t MappedNandFlash_ReadPage(
00073     const struct MappedNandFlash *mapped,
00074     uint16_t block,
00075     uint16_t page,
00076     void *data,
00077     void *spare);
00078 
00079 extern uint8_t MappedNandFlash_WritePage(
00080     const struct MappedNandFlash *mapped,
00081     uint16_t block,
00082     uint16_t page,
00083     void *data,
00084     void *spare);
00085 
00086 extern uint8_t MappedNandFlash_Map(
00087     struct MappedNandFlash *mapped,
00088     uint16_t logicalBlock,
00089     uint16_t physicalBlock);
00090 
00091 extern uint8_t MappedNandFlash_Unmap(
00092     struct MappedNandFlash *mapped,
00093     uint16_t logicalBlock);
00094 
00095 extern int16_t MappedNandFlash_LogicalToPhysical(
00096     const struct MappedNandFlash *mapped,
00097     uint16_t logicalBlock);
00098 
00099 extern int16_t MappedNandFlash_PhysicalToLogical(
00100     const struct MappedNandFlash *mapped,
00101     uint16_t physicalBlock);
00102 
00103 extern uint8_t MappedNandFlash_SaveLogicalMapping(
00104     struct MappedNandFlash *mapped,
00105     uint16_t physicalBlock);
00106 
00107 extern uint8_t MappedNandFlash_EraseAll(
00108     struct MappedNandFlash *mapped,
00109     uint8_t level);
00110 
00111 #endif /* #ifndef MAPPEDNANDFLASH_H*/
00112 
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Defines