[net-next-2.6.git] / drivers / staging / spectra / README

This is a driver for NAND controller of Intel Moorestown platform.

This driver is a standalone linux block device driver, it acts as if it's a normal hard disk.
It includes three layer:
	block layer interface - file ffsport.c
	Flash Translation Layer (FTL) - file flash.c (implement the NAND flash Translation Layer, includs address mapping, garbage collection, wear-leveling and so on)
	Low level layer - file lld_nand.c/lld_cdma.c/lld_emu.c (which implements actual controller hardware registers access)

This driver can be build as modules or build-in.

Dependency:
This driver has dependency on IA Firmware of Intel Moorestown platform.
It need the IA Firmware to create the block table for the first time.
And to validate this driver code without IA Firmware, you can change the
macro AUTO_FORMAT_FLASH from 0 to 1 in file spectraswconfig.h. Thus the
driver will erase the whole nand flash and create a new block table.

TODO:
	- Enable Command DMA feature support
	- lower the memory footprint
	- Remove most of the unnecessary global variables
	- Change all the upcase variable / functions name to lowercase
	- Some other misc bugs

Please send patches to:
	Greg Kroah-Hartman <gregkh@suse.de>

And Cc to: Gao Yunpeng <yunpeng.gao@intel.com>
Commit	Line	Data
494a43bb AO	1	This is a driver for NAND controller of Intel Moorestown platform.
	2
	3	This driver is a standalone linux block device driver, it acts as if it's a normal hard disk.
	4	It includes three layer:
	5	block layer interface - file ffsport.c
	6	Flash Translation Layer (FTL) - file flash.c (implement the NAND flash Translation Layer, includs address mapping, garbage collection, wear-leveling and so on)
	7	Low level layer - file lld_nand.c/lld_cdma.c/lld_emu.c (which implements actual controller hardware registers access)
	8
	9	This driver can be build as modules or build-in.
	10
	11	Dependency:
	12	This driver has dependency on IA Firmware of Intel Moorestown platform.
	13	It need the IA Firmware to create the block table for the first time.
	14	And to validate this driver code without IA Firmware, you can change the
	15	macro AUTO_FORMAT_FLASH from 0 to 1 in file spectraswconfig.h. Thus the
	16	driver will erase the whole nand flash and create a new block table.
	17
	18	TODO:
	19	- Enable Command DMA feature support
	20	- lower the memory footprint
	21	- Remove most of the unnecessary global variables
	22	- Change all the upcase variable / functions name to lowercase
	23	- Some other misc bugs
	24
	25	Please send patches to:
	26	Greg Kroah-Hartman <gregkh@suse.de>
	27
	28	And Cc to: Gao Yunpeng <yunpeng.gao@intel.com>
	29