blob: 9df65efcc3b0fbbd116c70bd205143f27d6da44c [file] [log] [blame]
/* ----------------------------------------------------------------------------
* ATMEL Microcontroller Software Support
* ----------------------------------------------------------------------------
* Copyright (c) 2010, 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:
*
* - Redistributions of source code must retain the above copyright notice,
* this list of conditions and the disclaimer below.
*
* Atmel's name may not be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* DISCLAIMER: 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
* 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.
* ----------------------------------------------------------------------------
*/
/**
* \file
*
* Hardware low level layer Nandflash driver with NFC.
*
*/
#define DMA_TRANSFER
/*----------------------------------------------------------------------------
* Headers
*----------------------------------------------------------------------------*/
#include "memories.h"
#include <assert.h>
#include <string.h>
#if defined(CHIP_NAND_CTRL)
/*----------------------------------------------------------------------------
* Internal definitions
*----------------------------------------------------------------------------*/
#ifndef BOARD_NF_CSID
/** NFC chip select ID definition */
#define BOARD_NF_CSID NFCADDR_CMD_CSID_0
#endif
/** Nand flash chip status codes */
#define STATUS_READY (1 << 6)
#define STATUS_ERROR (1 << 0)
/** Nand flash commands*/
#define COMMAND_READ_1 0x00
#define COMMAND_READ_2 0x30
#define COMMAND_COPYBACK_READ_1 0x00
#define COMMAND_COPYBACK_READ_2 0x35
#define COMMAND_COPYBACK_PROGRAM_1 0x85
#define COMMAND_COPYBACK_PROGRAM_2 0x10
#define COMMAND_RANDOM_OUT 0x05
#define COMMAND_RANDOM_OUT_2 0xE0
#define COMMAND_RANDOM_IN 0x85
#define COMMAND_READID 0x90
#define COMMAND_WRITE_1 0x80
#define COMMAND_WRITE_2 0x10
#define COMMAND_ERASE_1 0x60
#define COMMAND_ERASE_2 0xD0
#define COMMAND_STATUS 0x70
#define COMMAND_RESET 0xFF
/** Nand flash commands (small blocks)*/
#define COMMAND_READ_A 0x00
#define COMMAND_READ_C 0x50
/*----------------------------------------------------------------------------
* Internal Macros
*----------------------------------------------------------------------------*/
#define READ_DATA8(raw) \
(*((volatile uint8_t *) raw->dataAddress))
#define READ_DATA16(raw) \
(*((volatile uint16_t *) raw->dataAddress))
/** Internal cast macros*/
#define MODEL(raw) ((struct NandFlashModel *) raw)
/** Number of tries for erasing a block*/
#define NUMERASETRIES 2
/** Number of tries for writing a block*/
#define NUMWRITETRIES 2
/** Number of tries for copying a block*/
#define NUMCOPYTRIES 2
/*----------------------------------------------------------------------------
* Internal functions
*----------------------------------------------------------------------------*/
/**
* \brief Translates the given column and row address into first and other (1-4) address
* cycles. The resulting values are stored in the provided variables if they are not null.
* \param columnAddress Column address to translate.
* \param rowAddress Row address to translate.
* \param pAddressCycle0 First address cycle.
* \param pAddressCycle1234 four address cycles.
*/
static void NFC_TranslateAddress(
const struct RawNandFlash *raw,
uint16_t columnAddress,
uint32_t rowAddress,
uint32_t *pAddressCycle0,
uint32_t *pAddressCycle1234,
uint8_t useFiveAddress)
{
uint16_t pageDataSize = NandFlashModel_GetPageDataSize(MODEL(raw));
uint32_t numPages = NandFlashModel_GetDeviceSizeInPages(MODEL(raw));
uint8_t numAddressCycles = 0;
uint32_t addressCycle0 = 0;
uint32_t addressCycle1234 = 0;
/* Check the data bus width of the NandFlash */
if (NandFlashModel_GetDataBusWidth(MODEL(raw)) == 16) {
/* Div 2 is because we address in word and not in byte */
columnAddress >>= 1;
}
/* When 5 address cycle are used.*/
if (useFiveAddress) {
while (pageDataSize > 0) {
if (numAddressCycles == 0) {
addressCycle0 = (columnAddress & 0xFF);
}
else {
addressCycle1234 |= (columnAddress & 0xFF) << ((numAddressCycles - 1) * 8);
}
pageDataSize >>= 8;
columnAddress >>= 8;
numAddressCycles ++;
}
while (numPages > 0) {
if (numAddressCycles == 0) {
addressCycle0 = (rowAddress & 0xFF);
}
else {
addressCycle1234 |= (rowAddress & 0xFF) << ((numAddressCycles - 1) * 8);
}
numPages >>= 8;
rowAddress >>= 8;
numAddressCycles ++;
}
}
/* When less than 5 address cycle are used.*/
else {
while (numPages > 0) {
addressCycle1234 |= (rowAddress & 0xFF) << ((numAddressCycles) * 8);
numPages >>= 8;
rowAddress >>= 8;
numAddressCycles ++;
}
}
/* Store values*/
if (pAddressCycle0) {
*pAddressCycle0 = addressCycle0;
}
if (pAddressCycle1234) {
*pAddressCycle1234 = addressCycle1234;
}
return;
}
/**
* \brief Check if program or erase operation is completed in current operation.
* \param columnAddress Column address to translate.
* \param raw Pointer to a RawNandFlash instance.
*/
static uint8_t IsOperationComplete(const struct RawNandFlash *raw)
{
uint8_t status;
SMC_NFC_SendCommand(SMC,
NFCADDR_CMD_NFCCMD | /* Command.*/
0 | /* NFC read data.*/
0 | /* NFC auto R/W is disabled.*/
BOARD_NF_CSID | /* CSID.*/
NFCADDR_CMD_ACYCLE_NONE | /* No address cycle.*/
(COMMAND_STATUS << 2), /* CMD1 (COMMAND_STATUS).*/
0, /* Dummy address cylce 1,2,3,4.*/
0 /* Dummy address cylce 0.*/
);
status = READ_DATA8(raw);
if (((status & STATUS_READY) != STATUS_READY) || ((status & STATUS_ERROR) != 0)) {
return 0;
}
return 1;
}
/**
* \brief Sends data to the NandFlash chip from the provided buffer.
* \param raw Pointer to a RawNandFlash instance.
* \param buffer Buffer where the data area will be stored.
* \param sramOffset NFC internal sram start offset.
* \param size Number of data bytes to send.
*/
static void CopyDataToNfcInternalSram(
const struct RawNandFlash *raw,
uint8_t *data,
uint16_t sramOffset,
uint16_t size)
{
#ifdef DMA_TRANSFER
if (NandFlashIsDmaActived())
{
/* Check the data bus width of the NandFlash */
if (NandFlashModel_GetDataBusWidth(MODEL(raw)) == 16)
{
size >>= 1;
NandFlashDmaTransferRam2Nand( (uint32_t )(NFC_SRAM_BASE_ADDRESS + sramOffset),(uint32_t)data, size );
}
else
{
NandFlashDmaTransferRam2Nand( (uint32_t )(NFC_SRAM_BASE_ADDRESS + sramOffset),(uint32_t)data, size );
}
}
#else
uint8_t * pBuffer;
uint32_t i;
pBuffer = (uint8_t *)(NFC_SRAM_BASE_ADDRESS + sramOffset);
for (i = 0; i < size; i++) {
*pBuffer++ = *data++;
}
#endif
}
/**
* \brief Sends data to the NandFlash chip from the provided buffer.
* \param raw Pointer to a RawNandFlash instance.
* \param data Buffer where the data area will be stored.
* \param sramOffset NFC internal sram start offset.
* \param size Number of data bytes to receive.
*/
static void CopyDataFromNfcInternalSram(
const struct RawNandFlash *raw,
uint8_t *data,
uint16_t sramOffset,
uint16_t size)
{
#ifdef DMA_TRANSFER
if (NandFlashIsDmaActived())
{
/* Check the data bus width of the NandFlash */
if (NandFlashModel_GetDataBusWidth(MODEL(raw)) == 16)
{
size = (size + 1)>> 1;
NandFlashDmaTransferNand2Ram( (uint32_t )(NFC_SRAM_BASE_ADDRESS + sramOffset),(uint32_t)data, size );
}
else
{
NandFlashDmaTransferNand2Ram( (uint32_t )(NFC_SRAM_BASE_ADDRESS + sramOffset), (uint32_t)data, size );
}
}
#else
uint8_t * pBuffer;
uint32_t i;
pBuffer = (uint8_t *)(NFC_SRAM_BASE_ADDRESS + sramOffset);
for (i = 0; i < size; i++) {
*data++ = *pBuffer++;
}
#endif
}
/**
* \brief Erases the specified block of the device.
*
* \param raw Pointer to a RawNandFlash instance.
* \param block Number of the physical block to erase.
* \return 0 if successful; otherwise returns an error code.
*/
static uint8_t EraseBlock(
const struct RawNandFlash *raw,
uint16_t block)
{
uint8_t error = 0;
uint32_t rowAddress;
uint32_t addressCycle1234;
TRACE_DEBUG("EraseBlock(%d)\r\n", block);
/* Calculate address used for erase*/
rowAddress = block * NandFlashModel_GetBlockSizeInPages(MODEL(raw));
NFC_TranslateAddress(raw, 0, rowAddress, 0, &addressCycle1234, 0);
/* Start erase*/
SMC_NFC_SendCommand(SMC,
NFCADDR_CMD_NFCCMD | /* Command.*/
0 | /* NFC read data.*/
0 | /* NFC auto R/W is disabled.*/
BOARD_NF_CSID | /* CSID.*/
NFCADDR_CMD_ACYCLE_THREE | /* Number of address cycle.*/
NFCADDR_CMD_VCMD2 | /* CMD2 enabled.*/
(COMMAND_ERASE_2 << 10) | /* CMD2 (ERASE CONFIRME).*/
(COMMAND_ERASE_1 << 2), /* CMD1 (ERASE).*/
addressCycle1234, /* Address cylce 1, 2, 3, 4.*/
0 /* Dummy address cylce 0.*/
);
while( !SMC_NFC_isReadyBusy(SMC) );
#if !defined (OP_BOOTSTRAP_on)
if (!IsOperationComplete(raw)) {
TRACE_ERROR(
"EraseBlock: Could not erase block %d.\n\r",
block);
error = NandCommon_ERROR_CANNOTERASE;
}
#endif
return error;
}
/**
* \brief Writes the data and/or the spare area of a page on a NandFlash chip.
*
* \param raw Pointer to a RawNandFlash instance.
* \param block Number of the physical block to erase.
* \param page Number of the page to write inside the given block.
* \param data Buffer containing the data area.
* \param spare Buffer containing the spare area.
* \return 0 if successful; otherwise returns an error code.
* \note If one of the buffer pointer is 0, the corresponding area is not written.
*/
static uint8_t WritePage(
const struct RawNandFlash *raw,
uint16_t block,
uint16_t page,
void *data,
void *spare)
{
uint8_t error = 0;
uint32_t pageDataSize = NandFlashModel_GetPageDataSize(MODEL(raw));
uint32_t spareDataSize = NandFlashModel_GetPageSpareSize(MODEL(raw));
uint32_t rowAddress;
uint32_t addressCycle0;
uint32_t addressCycle1234;
TRACE_DEBUG("WritePage(B#%d:P#%d)\r\n", block, page);
/* Calculate physical address of the page*/
rowAddress = block * NandFlashModel_GetBlockSizeInPages(MODEL(raw)) + page;
/*
if (spare){
SMC_NFC_EnableSpareWrite(SMC);
}
else {
SMC_NFC_DisableSpareWrite(SMC);
}
*/
/*Note: special case when ECC parity generation.
ECC results are available as soon as the counter reaches the end of the main area.
But when reach PageSize for an example, it could not generate last ECC_PR, The
workaround enable SPARE_WRITE, whatever real spare area write or not.*/
SMC_NFC_EnableSpareWrite(SMC);
/* Write data area if needed*/
if (data) {
CopyDataToNfcInternalSram(raw, (uint8_t *) data, 0, pageDataSize);
if (spare) {
CopyDataToNfcInternalSram(raw, (uint8_t *) spare, pageDataSize, spareDataSize);
}
NFC_TranslateAddress(raw, 0, rowAddress, &addressCycle0, &addressCycle1234, 1);
}
if (spare && !data) {
CopyDataToNfcInternalSram(raw, (uint8_t *) spare, 0, spareDataSize);
NFC_TranslateAddress(raw, pageDataSize, rowAddress, &addressCycle0, &addressCycle1234, 1);
}
if (data || spare) {
/* Start write operation*/
SMC_NFC_SendCommand(SMC,
NFCADDR_CMD_NFCCMD | /* Command.*/
NFCADDR_CMD_NFCWR | /* NFC write data.*/
NFCADDR_CMD_NFCEN | /* NFC auto R/W is enabled.*/
BOARD_NF_CSID | /* CSID.*/
NFCADDR_CMD_ACYCLE_FIVE | /* Number of address cycle.*/
0 | /* CMD2 disabled.*/
0 | /* CMD2.*/
(COMMAND_WRITE_1 << 2), /* CMD1.*/
addressCycle1234, /* Address cylce 1, 2, 3, 4.*/
addressCycle0 /* Address cylce 0.*/
);
while( !SMC_NFC_isTransferComplete(SMC));
SMC_NFC_SendCommand(SMC,
NFCADDR_CMD_NFCCMD | /* Command.*/
0 | /* No data Transfer.*/
0 | /* NFC auto R/W is disabled.*/
BOARD_NF_CSID | /* CSID.*/
NFCADDR_CMD_ACYCLE_NONE | /* No address cycle.*/
0 | /* CMD2 disabled.*/
0 | /* CMD2.*/
(COMMAND_WRITE_2 << 2), /* CMD1.*/
0, /* Dummy address cylce 1, 2, 3, 4.*/
0 /* Dummy address cylce 0.*/
);
while( !SMC_NFC_isReadyBusy(SMC));
if (!IsOperationComplete(raw)) {
TRACE_ERROR("WritePage: Failed writing data area.\n\r");
error = NandCommon_ERROR_CANNOTWRITE;
}
}
SMC_NFC_DisableSpareWrite(SMC);
return error;
}
/**
* \brief Copies the data in a page of the NandFlash device to an other page on that same chip.
*
* \param raw Pointer to a RawNandFlash instance.
* \param sourceBlock Source block number.
* \param sourcePage Source page number inside the source block.
* \param destBlock Destination block number.
* \param destPage Destination page number inside the destination block.
* \return 0 if successful; otherwise returns an error code.
* \note Both pages must have be even or odd; it is not possible to copy
* and even page to an odd page and vice-versa.
*/
static uint8_t CopyPage(
const struct RawNandFlash *raw,
uint16_t sourceBlock,
uint16_t sourcePage,
uint16_t destBlock,
uint16_t destPage)
{
uint16_t numPages = NandFlashModel_GetBlockSizeInPages(MODEL(raw));
uint32_t sourceRow = sourceBlock * numPages + sourcePage;
uint32_t destRow = destBlock * numPages + destPage;
uint8_t error = 0;
uint32_t addressCycle0;
uint32_t addressCycle1234;
/* Check: Source and destination page must have the same parity */
assert((sourcePage & 1) == (destPage & 1));
TRACE_DEBUG("CopyPage(B#%d:P#%d -> B#%d:P#%d)\n\r",
sourceBlock, sourcePage, destBlock, destPage);
/* Use the copy-back facility if available*/
if (NandFlashModel_SupportsCopyBack(MODEL(raw))) {
/* Start operation*/
NFC_TranslateAddress(raw, 0, sourceRow, &addressCycle0, &addressCycle1234, 1);
/* Start copy-back read*/
SMC_NFC_SendCommand(SMC,
NFCADDR_CMD_NFCCMD | /* Command.*/
0 | /* NFC read data.*/
0 | /* NFC auto R/W is disabled.*/
BOARD_NF_CSID | /* CSID.*/
NFCADDR_CMD_ACYCLE_FIVE | /* Number of address cycle.*/
NFCADDR_CMD_VCMD2 | /* CMD2 enabled.*/
(COMMAND_COPYBACK_READ_2 << 10)| /* CMD2.*/
(COMMAND_COPYBACK_READ_1 << 2), /* CMD1.*/
addressCycle1234, /* Address cylce 1, 2, 3, 4.*/
addressCycle0 /* Address cylce 0.*/
);
while( !SMC_NFC_isReadyBusy(SMC) );
/* Start copy-back write*/
NFC_TranslateAddress(raw, 0, destRow, &addressCycle0, &addressCycle1234, 1);
SMC_NFC_SendCommand(SMC,
NFCADDR_CMD_NFCCMD | /* Command.*/
0 | /* No data transfer.*/
0 | /* NFC auto R/W is disabled. */
BOARD_NF_CSID | /* CSID.*/
NFCADDR_CMD_ACYCLE_FIVE | /* Number of address cycle.*/
NFCADDR_CMD_VCMD2 | /* CMD2 enabled.*/
(COMMAND_COPYBACK_PROGRAM_2 << 10)| /* CMD2.*/
(COMMAND_COPYBACK_PROGRAM_1 << 2), /* CMD1.*/
addressCycle1234, /* Address cylce 1, 2, 3, 4.*/
addressCycle0 /* Address cylce 0.*/
);
while( !SMC_NFC_isReadyBusy(SMC) );
/* Check status*/
if (!IsOperationComplete(raw)) {
TRACE_ERROR("CopyPage: Failed to copy page.\n\r");
error = NandCommon_ERROR_CANNOTCOPY;
}
}
else {
/* Software copy*/
uint8_t data[NandCommon_MAXPAGEDATASIZE];
uint8_t spare[NandCommon_MAXPAGESPARESIZE];
if (RawNandFlash_ReadPage(raw, sourceBlock, sourcePage, data, spare)) {
TRACE_ERROR("CopyPage: Failed to read page to copy\n\r");
error = NandCommon_ERROR_CANNOTREAD;
}
else if (RawNandFlash_WritePage(raw, destBlock, destPage, data, spare)) {
TRACE_ERROR("CopyPage: Failed to write dest. page\n\r");
error = NandCommon_ERROR_CANNOTWRITE;
}
}
return error;
}
/*------------------------------------------------------------------------------
* Exported functions
*----------------------------------------------------------------------------*/
/**
* \brief Initializes a RawNandFlash instance based on the given model and physical interface.
*
* \param raw Pointer to a RawNandFlash instance.
* \param model Pointer to the underlying nand chip model. Can be 0.
* \param commandAddress Address at which commands are sent.
* \param addressAddress Address at which addresses are sent.
* \param dataAddress Address at which data is sent.
* \param pinChipEnable Pin controlling the CE signal of the NandFlash.
* \param pinReadyBusy Pin used to monitor the ready/busy signal of the Nand.
* \return 0 if successful; otherwise returns NandCommon_ERROR_UNKNOWNMODEL.
*/
uint8_t RawNandFlash_Initialize(
struct RawNandFlash *raw,
const struct NandFlashModel *model,
uint32_t commandAddress,
uint32_t addressAddress,
uint32_t dataAddress,
const Pin pinChipEnable,
const Pin pinReadyBusy)
{
TRACE_DEBUG("RawNandFlash_Initialize()\r\n");
/* Initialize NFC controller */
SMC_NFC_Reset(SMC);
SMC_NFC_EnableNfc(SMC);
/* Initialize fields*/
raw->commandAddress = commandAddress;
raw->addressAddress = addressAddress;
raw->dataAddress = dataAddress;
raw->pinChipEnable = pinChipEnable;
raw->pinReadyBusy = pinReadyBusy;
/* Reset*/
RawNandFlash_Reset(raw);
/* If model is not provided, autodetect it*/
if (!model) {
TRACE_DEBUG("No model provided, trying autodetection ...\n\r");
if (NandFlashModel_Find(nandFlashModelList,
NandFlashModelList_SIZE,
RawNandFlash_ReadId(raw),
&(raw->model))) {
TRACE_ERROR(
"RawNandFlash_Initialize: Could not autodetect chip.\n\r");
return NandCommon_ERROR_UNKNOWNMODEL;
}
}
else {
/* Copy provided model*/
raw->model = *model;
}
return 0;
}
/**
* \brief Resets a NandFlash device.
*
* \param raw Pointer to a RawNandFlash instance.
*/
void RawNandFlash_Reset(const struct RawNandFlash *raw)
{
TRACE_DEBUG("RawNandFlash_Reset()\n\r");
/* Remove warnings */
raw = raw;
SMC_NFC_SendCommand(SMC,
NFCADDR_CMD_NFCCMD | /* Command.*/
0 | /* NFC read data.*/
0 | /* NFC auto R/W is disabled.*/
BOARD_NF_CSID | /* CSID.*/
NFCADDR_CMD_ACYCLE_NONE | /* No address Cycle.*/
(COMMAND_RESET << 2), /* CMD1 (COMMAND_RESET).*/
0, /* Dummy address cylce 1,2,3,4.*/
0 /* Dummy address cylce 0.*/
);
while( !SMC_NFC_isReadyBusy(SMC) );
}
/**
* \brief Reads and returns the identifiers of a NandFlash chip.
*
* \param raw Pointer to a RawNandFlash instance.
* \return id1|(id2<<8)|(id3<<16)|(id4<<24)
*/
uint32_t RawNandFlash_ReadId(const struct RawNandFlash *raw)
{
uint32_t chipId;
TRACE_DEBUG("RawNandFlash_ReadId()\n\r");
SMC_NFC_SendCommand(SMC,
NFCADDR_CMD_NFCCMD | /* Command.*/
0 | /* NFC read Data.*/
0 | /* NFC auto R/W is disabled.*/
BOARD_NF_CSID | /* CSID.*/
NFCADDR_CMD_ACYCLE_ONE | /* One address Cycle.*/
(COMMAND_READID << 2), /* CMD1 (COMMAND_READID).*/
0, /* Dummy address cylce 1,2,3,4.*/
0 /* Dummy address cylce 0.*/
);
chipId = READ_DATA8(raw);
chipId |= READ_DATA8(raw) << 8;
chipId |= READ_DATA8(raw) << 16;
chipId |= READ_DATA8(raw) << 24;
return chipId;
}
/**
* \brief Erases the specified block of the device, retrying several time if it fails.
*
* \param raw Pointer to a RawNandFlash instance.
* \param block Number of the physical block to erase.
* \return 0 if successful; otherwise returns NandCommon_ERROR_UNKNOWNMODEL.
*/
uint8_t RawNandFlash_EraseBlock(
const struct RawNandFlash *raw,
uint16_t block)
{
#if !defined(OP_BOOTSTRAP_on)
uint8_t numTries = NUMERASETRIES;
TRACE_DEBUG("RawNandFlash_EraseBlock(B#%d)\n\r", block);
while (numTries > 0) {
if (!EraseBlock(raw, block)) {
return 0;
}
numTries--;
}
TRACE_ERROR("RawNandFlash_EraseBlock: Failed to erase block after %d tries\n\r", NUMERASETRIES);
return NandCommon_ERROR_BADBLOCK;
#else
return EraseBlock(raw, block);
#endif
}
/**
* \brief Reads the data and/or the spare areas of a page of a NandFlash into the provided buffers.
*
* \param raw Pointer to a RawNandFlash instance.
* \param block Number of the physical block to read.
* \param page Number of the page to read inside the given block.
* \param data Buffer where the data area will be read.
* \param spare Buffer where the spare area will be read.
* \return 0 if successful; otherwise returns 1.
* \note If one of the buffer pointer is 0, the corresponding area is not read.
*/
uint8_t RawNandFlash_ReadPage(
const struct RawNandFlash *raw,
uint16_t block,
uint16_t page,
void *data,
void *spare)
{
volatile uint32_t cntTry = 0;
uint8_t hasSmallBlocks = NandFlashModel_HasSmallBlocks(MODEL(raw));
uint32_t pageDataSize = NandFlashModel_GetPageDataSize(MODEL(raw));
uint32_t pageSpareSize = NandFlashModel_GetPageSpareSize(MODEL(raw));
uint32_t colAddress;
uint32_t rowAddress;
uint32_t addressCycle0;
uint32_t addressCycle1234;
/* Check: At least one area must be read */
assert(data || spare);
TRACE_DEBUG("RawNandFlash_ReadPage(B#%d:P#%d)\r\n", block, page);
/* Calculate actual address of the page*/
rowAddress = block * NandFlashModel_GetBlockSizeInPages(MODEL(raw)) + page;
/* Start operation*/
if (data) {
colAddress = 0;
}
else {
/* to read spare area in sequential access*/
colAddress = pageDataSize;
}
if (spare) {
SMC_NFC_EnableSpareRead(SMC);
}
else {
SMC_NFC_DisableSpareRead(SMC);
}
NFC_TranslateAddress(raw, colAddress, rowAddress, &addressCycle0, &addressCycle1234, 1);
/* Use either small blocks or large blocks data area read*/
if (hasSmallBlocks) {
SMC_NFC_SendCommand(SMC,
NFCADDR_CMD_NFCCMD | /* Command.*/
0 | /* NFC read data.*/
NFCADDR_CMD_NFCEN | /* NFC auto R/W is enable.*/
BOARD_NF_CSID | /* CSID.*/
NFCADDR_CMD_ACYCLE_FIVE | /* Number of address cycle.*/
0 | /* CMD2 disabled.*/
0 | /* CMD2.*/
(COMMAND_READ_A << 2), /* CMD1.*/
addressCycle1234, /* Address cylce 1, 2, 3, 4.*/
addressCycle0 /* Address cylce 0.*/
);
}
else {
SMC_NFC_SendCommand(SMC,
NFCADDR_CMD_NFCCMD | /* Command.*/
0 | /* NFC read data.*/
NFCADDR_CMD_NFCEN | /* NFC auto R/W is enabled.*/
BOARD_NF_CSID | /* CSID.*/
NFCADDR_CMD_ACYCLE_FIVE | /* Number of address cycle.*/
NFCADDR_CMD_VCMD2 | /* CMD2 enabled.*/
(COMMAND_READ_2 << 10)| /* CMD2.*/
(COMMAND_READ_1 << 2), /* CMD1.*/
addressCycle1234, /* Address cylce 1, 2, 3, 4.*/
addressCycle0 /* Address cylce 0.*/
);
}
/* Wait for the nand to be ready*/
cntTry = 0;
while( !SMC_NFC_isReadyBusy(SMC) && (cntTry++) < 1000000);
cntTry = 0;
while( !SMC_NFC_isTransferComplete(SMC) && (cntTry++) < 1000000);
/* Read data area if needed*/
if (data) {
CopyDataFromNfcInternalSram(raw, (uint8_t *) data, 0, pageDataSize);
if (spare) {
CopyDataFromNfcInternalSram(raw, (uint8_t *) spare, pageDataSize, pageSpareSize);
}
}
else {
/* Read spare area only*/
CopyDataFromNfcInternalSram(raw, (uint8_t *) spare, 0, pageSpareSize);
}
return 0;
}
/**
* \brief Writes the data and/or the spare areas of a page of a NandFlash into the provided buffers.
*
* \param raw Pointer to a RawNandFlash instance.
* \param block Number of the physical block to write resides.
* \param page Number of the page to write inside the given block.
* \param data Buffer where the data area will be stored.
* \param spare Buffer where the spare area will be stored.
* \return 0 if successful; otherwise returns NandCommon_ERROR_BADBLOCK.
* \note If one of the buffer pointer is 0, the corresponding area is not written.
*/
uint8_t RawNandFlash_WritePage(
const struct RawNandFlash *raw,
uint16_t block,
uint16_t page,
void *data,
void *spare)
{
uint8_t numTries = NUMWRITETRIES;
TRACE_DEBUG("RawNandFlash_WritePage(B#%d:P#%d)\r\n", block, page);
while (numTries > 0) {
if (!WritePage(raw, block, page, data, spare)) {
return 0;
}
numTries--;
}
TRACE_ERROR("RawNandFlash_WritePage: Failed to write page after %d tries\n\r", NUMWRITETRIES);
return NandCommon_ERROR_BADBLOCK;
}
/**
* \brief Copy the data in a page of the NandFlash device to an other page on that same chip.
*
* \param raw Pointer to a RawNandFlash instance.
* \param sourceBlock Source block number.
* \param sourcePage Source page number inside the source block.
* \param destBlock Destination block number.
* \param destPage Destination page number inside the destination block.
* \return 0 if successful; otherwise returns an NandCommon_ERROR_BADBLOCK.
* \note Both pages must have be even or odd; it is not possible to copy
* and even page to an odd page and vice-versa.
*/
uint8_t RawNandFlash_CopyPage(
const struct RawNandFlash *raw,
uint16_t sourceBlock,
uint16_t sourcePage,
uint16_t destBlock,
uint16_t destPage)
{
uint8_t numTries = NUMCOPYTRIES;
TRACE_DEBUG("RawNandFlash_CopyPage(B#%d:P#%d -> B#%d:P#%d)\n\r",
sourceBlock, sourcePage, destBlock, destPage);
while (numTries) {
if (!CopyPage(raw, sourceBlock, sourcePage, destBlock, destPage)) {
return 0;
}
numTries--;
}
TRACE_ERROR("RawNandFlash_CopyPage: Failed to copy page after %d tries\n\r", NUMCOPYTRIES);
return NandCommon_ERROR_BADBLOCK;
}
/**
* \brief Copies the data of one whole block of a NandFlash device to another block.
*
* \param raw Pointer to a RawNandFlash instance.
* \param sourceBlock Source block number.
* \param destBlock Destination block number.
* \return 0 if successful; otherwise returns an NandCommon_ERROR_BADBLOCK.
*/
uint8_t RawNandFlash_CopyBlock(
const struct RawNandFlash *raw,
uint16_t sourceBlock,
uint16_t destBlock)
{
uint16_t numPages = NandFlashModel_GetBlockSizeInPages(MODEL(raw));
uint32_t i;
/* Check: Source block must be different from dest block */
assert(sourceBlock != destBlock);
TRACE_DEBUG("RawNandFlash_CopyBlock(B#%d->B#%d)\n\r",
sourceBlock, destBlock);
/* Copy all pages*/
for (i=0; i < numPages; i++) {
if (RawNandFlash_CopyPage(raw, sourceBlock, i, destBlock, i)) {
TRACE_ERROR(
"RawNandFlash_CopyBlock: Failed to copy page %u\n\r",
i);
return NandCommon_ERROR_BADBLOCK;
}
}
return 0;
}
#endif