139 lines
4.3 KiB
C
139 lines
4.3 KiB
C
/**
|
|
* \file
|
|
* <!--
|
|
* This file is part of BeRTOS.
|
|
*
|
|
* Bertos is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; if not, write to the Free Software
|
|
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
|
|
*
|
|
* As a special exception, you may use this file as part of a free software
|
|
* library without restriction. Specifically, if other files instantiate
|
|
* templates or use macros or inline functions from this file, or you compile
|
|
* this file and link it with other files to produce an executable, this
|
|
* file does not by itself cause the resulting executable to be covered by
|
|
* the GNU General Public License. This exception does not however
|
|
* invalidate any other reasons why the executable file might be covered by
|
|
* the GNU General Public License.
|
|
*
|
|
* Copyright 2011 Develer S.r.l. (http://www.develer.com/)
|
|
* -->
|
|
*
|
|
* \brief ONFI 1.0 compliant NAND kblock driver
|
|
*
|
|
* \author Stefano Fedrigo <aleph@develer.com>
|
|
*
|
|
* $WIZ$ module_name = "nand"
|
|
* $WIZ$ module_depends = "timer", "kblock", "heap"
|
|
* $WIZ$ module_configuration = "bertos/cfg/cfg_nand.h"
|
|
*
|
|
*/
|
|
|
|
#ifndef DRV_NAND_H
|
|
#define DRV_NAND_H
|
|
|
|
#include "cfg/cfg_nand.h"
|
|
#include <io/kblock.h>
|
|
|
|
|
|
// Define log settings for cfg/log.h
|
|
#define LOG_LEVEL CONFIG_NAND_LOG_LEVEL
|
|
#define LOG_FORMAT CONFIG_NAND_LOG_FORMAT
|
|
|
|
/**
|
|
* \name Error codes.
|
|
* \{
|
|
*/
|
|
#define NAND_ERR_ERASE BV(1) ///< Error erasing a block
|
|
#define NAND_ERR_WRITE BV(2) ///< Error writing a page
|
|
#define NAND_ERR_RD_TMOUT BV(3) ///< Read timeout
|
|
#define NAND_ERR_WR_TMOUT BV(4) ///< Write timeout
|
|
#define NAND_ERR_ECC BV(5) ///< Unrecoverable ECC error
|
|
/** \} */
|
|
|
|
|
|
// NAND commands
|
|
#define NAND_CMD_READ_1 0x00
|
|
#define NAND_CMD_READ_2 0x30
|
|
#define NAND_CMD_COPYBACK_READ_1 0x00
|
|
#define NAND_CMD_COPYBACK_READ_2 0x35
|
|
#define NAND_CMD_COPYBACK_PROGRAM_1 0x85
|
|
#define NAND_CMD_COPYBACK_PROGRAM_2 0x10
|
|
#define NAND_CMD_RANDOM_OUT 0x05
|
|
#define NAND_CMD_RANDOM_OUT_2 0xE0
|
|
#define NAND_CMD_RANDOM_IN 0x85
|
|
#define NAND_CMD_READID 0x90
|
|
#define NAND_CMD_WRITE_1 0x80
|
|
#define NAND_CMD_WRITE_2 0x10
|
|
#define NAND_CMD_ERASE_1 0x60
|
|
#define NAND_CMD_ERASE_2 0xD0
|
|
#define NAND_CMD_STATUS 0x70
|
|
#define NAND_CMD_RESET 0xFF
|
|
|
|
|
|
/**
|
|
* NAND context.
|
|
*/
|
|
typedef struct Nand
|
|
{
|
|
KBlock fd; // KBlock descriptor
|
|
|
|
uint8_t chip_select; // Chip select where NAND is connected
|
|
uint8_t status; // Status bitmap
|
|
|
|
uint16_t *block_map; // For bad blocks remapping
|
|
uint16_t remap_start; // First unused remap block
|
|
} Nand;
|
|
|
|
/*
|
|
* Kblock id.
|
|
*/
|
|
#define KBT_NAND MAKE_ID('N', 'A', 'N', 'D')
|
|
|
|
/**
|
|
* Convert + ASSERT from generic KBlock to NAND context.
|
|
*/
|
|
INLINE Nand *NAND_CAST(KBlock *kb)
|
|
{
|
|
ASSERT(kb->priv.type == KBT_NAND);
|
|
return (Nand *)kb;
|
|
}
|
|
|
|
struct Heap;
|
|
|
|
// Kblock interface
|
|
bool nand_init(Nand *chip, struct Heap *heap, unsigned chip_select);
|
|
bool nand_initUnbuffered(Nand *chip, struct Heap *heap, unsigned chip_select);
|
|
|
|
// NAND specific functions
|
|
bool nand_getDevId(Nand *chip, uint8_t dev_id[5]);
|
|
int nand_blockErase(Nand *chip, uint16_t block);
|
|
void nand_format(Nand *chip);
|
|
|
|
#ifdef _DEBUG
|
|
void nand_ruinSomeBlocks(Nand *chip);
|
|
#endif
|
|
|
|
// Hardware specific functions, implemented by cpu specific module
|
|
bool nand_waitReadyBusy(Nand *chip, time_t timeout);
|
|
bool nand_waitTransferComplete(Nand *chip, time_t timeout);
|
|
void nand_sendCommand(Nand *chip, uint32_t cmd1, uint32_t cmd2,
|
|
int num_cycles, uint32_t cycle0, uint32_t cycle1234);
|
|
uint8_t nand_getChipStatus(Nand *chip);
|
|
void *nand_dataBuffer(Nand *chip);
|
|
bool nand_checkEcc(Nand *chip);
|
|
void nand_computeEcc(Nand *chip, const void *buf, size_t size, uint32_t *ecc, size_t ecc_size);
|
|
void nand_hwInit(Nand *chip);
|
|
|
|
#endif /* DRV_NAND_H */
|