[J-u-boot.git] / drivers / mtd / cfi_mtd.c

/*
 * (C) Copyright 2008 Semihalf
 *
 * Written by: Piotr Ziecik <[email protected]>
 *
 * See file CREDITS for list of people who contributed to this
 * project.
 *
 * This program 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., 59 Temple Place, Suite 330, Boston,
 * MA 02111-1307 USA
 *
 */

#include <common.h>
#include <flash.h>
#include <malloc.h>

#include <asm/errno.h>
#include <linux/mtd/mtd.h>
#include <linux/mtd/concat.h>
#include <mtd/cfi_flash.h>

static struct mtd_info cfi_mtd_info[CFI_MAX_FLASH_BANKS];
static char cfi_mtd_names[CFI_MAX_FLASH_BANKS][16];
#ifdef CONFIG_MTD_CONCAT
static char c_mtd_name[16];
#endif

static int cfi_mtd_erase(struct mtd_info *mtd, struct erase_info *instr)
{
	flash_info_t *fi = mtd->priv;
	size_t a_start = fi->start[0] + instr->addr;
	size_t a_end = a_start + instr->len;
	int s_first = -1;
	int s_last = -1;
	int error, sect;

	for (sect = 0; sect < fi->sector_count; sect++) {
		if (a_start == fi->start[sect])
			s_first = sect;

		if (sect < fi->sector_count - 1) {
			if (a_end == fi->start[sect + 1]) {
				s_last = sect;
				break;
			}
		} else {
			s_last = sect;
			break;
		}
	}

	if (s_first >= 0 && s_first <= s_last) {
		instr->state = MTD_ERASING;

		flash_set_verbose(0);
		error = flash_erase(fi, s_first, s_last);
		flash_set_verbose(1);

		if (error) {
			instr->state = MTD_ERASE_FAILED;
			return -EIO;
		}

		instr->state = MTD_ERASE_DONE;
		mtd_erase_callback(instr);
		return 0;
	}

	return -EINVAL;
}

static int cfi_mtd_read(struct mtd_info *mtd, loff_t from, size_t len,
	size_t *retlen, u_char *buf)
{
	flash_info_t *fi = mtd->priv;
	u_char *f = (u_char*)(fi->start[0]) + from;

	memcpy(buf, f, len);
	*retlen = len;

	return 0;
}

static int cfi_mtd_write(struct mtd_info *mtd, loff_t to, size_t len,
	size_t *retlen, const u_char *buf)
{
	flash_info_t *fi = mtd->priv;
	u_long t = fi->start[0] + to;
	int error;

	flash_set_verbose(0);
	error = write_buff(fi, (u_char*)buf, t, len);
	flash_set_verbose(1);

	if (!error) {
		*retlen = len;
		return 0;
	}

	return -EIO;
}

static void cfi_mtd_sync(struct mtd_info *mtd)
{
	/*
	 * This function should wait until all pending operations
	 * finish. However this driver is fully synchronous, so
	 * this function returns immediately
	 */
}

static int cfi_mtd_lock(struct mtd_info *mtd, loff_t ofs, uint64_t len)
{
	flash_info_t *fi = mtd->priv;

	flash_set_verbose(0);
	flash_protect(FLAG_PROTECT_SET, fi->start[0] + ofs,
					fi->start[0] + ofs + len - 1, fi);
	flash_set_verbose(1);

	return 0;
}

static int cfi_mtd_unlock(struct mtd_info *mtd, loff_t ofs, uint64_t len)
{
	flash_info_t *fi = mtd->priv;

	flash_set_verbose(0);
	flash_protect(FLAG_PROTECT_CLEAR, fi->start[0] + ofs,
					fi->start[0] + ofs + len - 1, fi);
	flash_set_verbose(1);

	return 0;
}

static int cfi_mtd_set_erasesize(struct mtd_info *mtd, flash_info_t *fi)
{
	int sect_size = 0;
	int sect_size_old = 0;
	int sect;
	int regions = 0;
	int numblocks = 0;
	ulong offset;
	ulong base_addr;

	/*
	 * First detect the number of eraseregions so that we can allocate
	 * the array of eraseregions correctly
	 */
	for (sect = 0; sect < fi->sector_count; sect++) {
		if (sect_size_old != flash_sector_size(fi, sect))
			regions++;
		sect_size_old = flash_sector_size(fi, sect);
	}

	switch (regions) {
	case 0:
		return 1;
	case 1:	/* flash has uniform erase size */
		mtd->numeraseregions = 0;
		mtd->erasesize = sect_size_old;
		return 0;
	}

	mtd->numeraseregions = regions;
	mtd->eraseregions = malloc(sizeof(struct mtd_erase_region_info) * regions);

	/*
	 * Now detect the largest sector and fill the eraseregions
	 */
	regions = 0;
	base_addr = offset = fi->start[0];
	sect_size_old = flash_sector_size(fi, 0);
	for (sect = 0; sect < fi->sector_count; sect++) {
		if (sect_size_old != flash_sector_size(fi, sect)) {
			mtd->eraseregions[regions].offset = offset - base_addr;
			mtd->eraseregions[regions].erasesize = sect_size_old;
			mtd->eraseregions[regions].numblocks = numblocks;
			/* Now start counting the next eraseregions */
			numblocks = 0;
			regions++;
			offset = fi->start[sect];
		}
		numblocks++;

		/*
		 * Select the largest sector size as erasesize (e.g. for UBI)
		 */
		if (flash_sector_size(fi, sect) > sect_size)
			sect_size = flash_sector_size(fi, sect);

		sect_size_old = flash_sector_size(fi, sect);
	}

	/*
	 * Set the last region
	 */
	mtd->eraseregions[regions].offset = offset - base_addr;
	mtd->eraseregions[regions].erasesize = sect_size_old;
	mtd->eraseregions[regions].numblocks = numblocks;

	mtd->erasesize = sect_size;

	return 0;
}

int cfi_mtd_init(void)
{
	struct mtd_info *mtd;
	flash_info_t *fi;
	int error, i;
	int devices_found = 0;
	struct mtd_info *mtd_list[CONFIG_SYS_MAX_FLASH_BANKS];

	for (i = 0; i < CONFIG_SYS_MAX_FLASH_BANKS; i++) {
		fi = &flash_info[i];
		mtd = &cfi_mtd_info[i];

		memset(mtd, 0, sizeof(struct mtd_info));

		error = cfi_mtd_set_erasesize(mtd, fi);
		if (error)
			continue;

		sprintf(cfi_mtd_names[i], "nor%d", i);
		mtd->name		= cfi_mtd_names[i];
		mtd->type		= MTD_NORFLASH;
		mtd->flags		= MTD_CAP_NORFLASH;
		mtd->size		= fi->size;
		mtd->writesize		= 1;

		mtd->erase		= cfi_mtd_erase;
		mtd->read		= cfi_mtd_read;
		mtd->write		= cfi_mtd_write;
		mtd->sync		= cfi_mtd_sync;
		mtd->lock		= cfi_mtd_lock;
		mtd->unlock		= cfi_mtd_unlock;
		mtd->priv		= fi;

		if (add_mtd_device(mtd))
			return -ENOMEM;

		mtd_list[devices_found++] = mtd;
	}

#ifdef CONFIG_MTD_CONCAT
	if (devices_found > 1) {
		/*
		 * We detected multiple devices. Concatenate them together.
		 */
		sprintf(c_mtd_name, "nor%d", devices_found);
		mtd = mtd_concat_create(mtd_list, devices_found, c_mtd_name);

		if (mtd == NULL)
			return -ENXIO;

		if (add_mtd_device(mtd))
			return -ENOMEM;
	}
#endif /* CONFIG_MTD_CONCAT */

	return 0;
}
Commit	Line	Data
91809ed5 PZ	1	/*
	2	* (C) Copyright 2008 Semihalf
	3	*
	4	* Written by: Piotr Ziecik <[email protected]>
	5	*
	6	* See file CREDITS for list of people who contributed to this
	7	* project.
	8	*
	9	* This program is free software; you can redistribute it and/or
	10	* modify it under the terms of the GNU General Public License as
	11	* published by the Free Software Foundation; either version 2 of
	12	* the License, or (at your option) any later version.
	13	*
	14	* This program is distributed in the hope that it will be useful,
	15	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	16	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	17	* GNU General Public License for more details.
	18	*
	19	* You should have received a copy of the GNU General Public License
	20	* along with this program; if not, write to the Free Software
	21	* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
	22	* MA 02111-1307 USA
	23	*
	24	*/
	25
	26	#include <common.h>
	27	#include <flash.h>
0a572655	28	#include <malloc.h>
91809ed5 PZ	29
	30	#include <asm/errno.h>
	31	#include <linux/mtd/mtd.h>
0a572655	32	#include <linux/mtd/concat.h>
3c29975e	33	#include <mtd/cfi_flash.h>
91809ed5	34
9578718c KP	35	static struct mtd_info cfi_mtd_info[CFI_MAX_FLASH_BANKS];
9578718c KP	36	static char cfi_mtd_names[CFI_MAX_FLASH_BANKS][16];
0a572655 SR	37	#ifdef CONFIG_MTD_CONCAT
	38	static char c_mtd_name[16];
	39	#endif
91809ed5 PZ	40
	41	static int cfi_mtd_erase(struct mtd_info mtd, struct erase_info instr)
	42	{
	43	flash_info_t *fi = mtd->priv;
	44	size_t a_start = fi->start[0] + instr->addr;
	45	size_t a_end = a_start + instr->len;
	46	int s_first = -1;
	47	int s_last = -1;
	48	int error, sect;
	49
dba6fcf6	50	for (sect = 0; sect < fi->sector_count; sect++) {
91809ed5 PZ	51	if (a_start == fi->start[sect])
	52	s_first = sect;
	53
dba6fcf6 SR	54	if (sect < fi->sector_count - 1) {
	55	if (a_end == fi->start[sect + 1]) {
	56	s_last = sect;
	57	break;
	58	}
	59	} else {
91809ed5 PZ	60	s_last = sect;
	61	break;
	62	}
	63	}
	64
	65	if (s_first >= 0 && s_first <= s_last) {
	66	instr->state = MTD_ERASING;
	67
	68	flash_set_verbose(0);
	69	error = flash_erase(fi, s_first, s_last);
	70	flash_set_verbose(1);
	71
	72	if (error) {
	73	instr->state = MTD_ERASE_FAILED;
	74	return -EIO;
	75	}
	76
	77	instr->state = MTD_ERASE_DONE;
	78	mtd_erase_callback(instr);
	79	return 0;
	80	}
	81
	82	return -EINVAL;
	83	}
	84
	85	static int cfi_mtd_read(struct mtd_info *mtd, loff_t from, size_t len,
	86	size_t retlen, u_char buf)
	87	{
	88	flash_info_t *fi = mtd->priv;
	89	u_char f = (u_char)(fi->start[0]) + from;
	90
	91	memcpy(buf, f, len);
	92	*retlen = len;
	93
	94	return 0;
	95	}
	96
	97	static int cfi_mtd_write(struct mtd_info *mtd, loff_t to, size_t len,
	98	size_t retlen, const u_char buf)
	99	{
	100	flash_info_t *fi = mtd->priv;
	101	u_long t = fi->start[0] + to;
	102	int error;
	103
	104	flash_set_verbose(0);
	105	error = write_buff(fi, (u_char*)buf, t, len);
	106	flash_set_verbose(1);
	107
	108	if (!error) {
	109	*retlen = len;
	110	return 0;
	111	}
	112
	113	return -EIO;
	114	}
	115
	116	static void cfi_mtd_sync(struct mtd_info *mtd)
	117	{
	118	/*
	119	* This function should wait until all pending operations
	120	* finish. However this driver is fully synchronous, so
	121	* this function returns immediately
	122	*/
	123	}
124
8d2effea	125	static int cfi_mtd_lock(struct mtd_info *mtd, loff_t ofs, uint64_t len)
91809ed5 PZ	126	{
	127	flash_info_t *fi = mtd->priv;
	128
	129	flash_set_verbose(0);
	130	flash_protect(FLAG_PROTECT_SET, fi->start[0] + ofs,
	131	fi->start[0] + ofs + len - 1, fi);
	132	flash_set_verbose(1);
	133
	134	return 0;
	135	}
	136
8d2effea	137	static int cfi_mtd_unlock(struct mtd_info *mtd, loff_t ofs, uint64_t len)
91809ed5 PZ	138	{
	139	flash_info_t *fi = mtd->priv;
	140
	141	flash_set_verbose(0);
	142	flash_protect(FLAG_PROTECT_CLEAR, fi->start[0] + ofs,
	143	fi->start[0] + ofs + len - 1, fi);
	144	flash_set_verbose(1);
	145
	146	return 0;
	147	}
	148
	149	static int cfi_mtd_set_erasesize(struct mtd_info mtd, flash_info_t fi)
	150	{
	151	int sect_size = 0;
0a572655	152	int sect_size_old = 0;
91809ed5	153	int sect;
0a572655 SR	154	int regions = 0;
0a572655 SR	155	int numblocks = 0;
f3dec798 LM	156	ulong offset;
f3dec798 LM	157	ulong base_addr;
91809ed5	158
f8e2b310	159	/*
0a572655 SR	160	* First detect the number of eraseregions so that we can allocate
0a572655 SR	161	* the array of eraseregions correctly
f8e2b310	162	*/
91809ed5	163	for (sect = 0; sect < fi->sector_count; sect++) {
0a572655 SR	164	if (sect_size_old != flash_sector_size(fi, sect))
	165	regions++;
	166	sect_size_old = flash_sector_size(fi, sect);
	167	}
	168
f3dec798 LM	169	switch (regions) {
	170	case 0:
	171	return 1;
	172	case 1: /* flash has uniform erase size */
	173	mtd->numeraseregions = 0;
	174	mtd->erasesize = sect_size_old;
	175	return 0;
	176	}
	177
	178	mtd->numeraseregions = regions;
0a572655 SR	179	mtd->eraseregions = malloc(sizeof(struct mtd_erase_region_info) * regions);
	180
	181	/*
	182	* Now detect the largest sector and fill the eraseregions
	183	*/
0a572655	184	regions = 0;
f3dec798 LM	185	base_addr = offset = fi->start[0];
f3dec798 LM	186	sect_size_old = flash_sector_size(fi, 0);
0a572655	187	for (sect = 0; sect < fi->sector_count; sect++) {
f3dec798	188	if (sect_size_old != flash_sector_size(fi, sect)) {
0a572655 SR	189	mtd->eraseregions[regions].offset = offset - base_addr;
	190	mtd->eraseregions[regions].erasesize = sect_size_old;
	191	mtd->eraseregions[regions].numblocks = numblocks;
0a572655 SR	192	/* Now start counting the next eraseregions */
	193	numblocks = 0;
	194	regions++;
0a572655	195	offset = fi->start[sect];
f3dec798 LM	196	}
f3dec798 LM	197	numblocks++;
0a572655 SR	198
	199	/*
	200	* Select the largest sector size as erasesize (e.g. for UBI)
	201	*/
f8e2b310	202	if (flash_sector_size(fi, sect) > sect_size)
91809ed5	203	sect_size = flash_sector_size(fi, sect);
0a572655 SR	204
0a572655 SR	205	sect_size_old = flash_sector_size(fi, sect);
91809ed5 PZ	206	}
91809ed5 PZ	207
0a572655 SR	208	/*
	209	* Set the last region
	210	*/
	211	mtd->eraseregions[regions].offset = offset - base_addr;
	212	mtd->eraseregions[regions].erasesize = sect_size_old;
f3dec798	213	mtd->eraseregions[regions].numblocks = numblocks;
0a572655	214
91809ed5 PZ	215	mtd->erasesize = sect_size;
	216
	217	return 0;
	218	}
	219
	220	int cfi_mtd_init(void)
	221	{
	222	struct mtd_info *mtd;
	223	flash_info_t *fi;
	224	int error, i;
0a572655 SR	225	int devices_found = 0;
0a572655 SR	226	struct mtd_info *mtd_list[CONFIG_SYS_MAX_FLASH_BANKS];
91809ed5 PZ	227
	228	for (i = 0; i < CONFIG_SYS_MAX_FLASH_BANKS; i++) {
	229	fi = &flash_info[i];
	230	mtd = &cfi_mtd_info[i];
	231
	232	memset(mtd, 0, sizeof(struct mtd_info));
	233
	234	error = cfi_mtd_set_erasesize(mtd, fi);
	235	if (error)
	236	continue;
	237
c203ef5d AH	238	sprintf(cfi_mtd_names[i], "nor%d", i);
c203ef5d AH	239	mtd->name = cfi_mtd_names[i];
91809ed5 PZ	240	mtd->type = MTD_NORFLASH;
	241	mtd->flags = MTD_CAP_NORFLASH;
	242	mtd->size = fi->size;
	243	mtd->writesize = 1;
	244
	245	mtd->erase = cfi_mtd_erase;
	246	mtd->read = cfi_mtd_read;
	247	mtd->write = cfi_mtd_write;
	248	mtd->sync = cfi_mtd_sync;
	249	mtd->lock = cfi_mtd_lock;
	250	mtd->unlock = cfi_mtd_unlock;
	251	mtd->priv = fi;
	252
	253	if (add_mtd_device(mtd))
	254	return -ENOMEM;
0a572655 SR	255
	256	mtd_list[devices_found++] = mtd;
	257	}
	258
	259	#ifdef CONFIG_MTD_CONCAT
	260	if (devices_found > 1) {
	261	/*
	262	* We detected multiple devices. Concatenate them together.
	263	*/
	264	sprintf(c_mtd_name, "nor%d", devices_found);
	265	mtd = mtd_concat_create(mtd_list, devices_found, c_mtd_name);
	266
	267	if (mtd == NULL)
	268	return -ENXIO;
	269
	270	if (add_mtd_device(mtd))
	271	return -ENOMEM;
91809ed5	272	}
0a572655	273	#endif /* CONFIG_MTD_CONCAT */
91809ed5 PZ	274
	275	return 0;
	276	}