xref: /OK3568_Linux_fs/u-boot/drivers/mtd/spi/sf_mtd.c (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /*
2*4882a593Smuzhiyun  * Copyright (C) 2012-2014 Daniel Schwierzeck, daniel.schwierzeck@gmail.com
3*4882a593Smuzhiyun  *
4*4882a593Smuzhiyun  * SPDX-License-Identifier:	GPL-2.0+
5*4882a593Smuzhiyun  */
6*4882a593Smuzhiyun 
7*4882a593Smuzhiyun #include <common.h>
8*4882a593Smuzhiyun #include <malloc.h>
9*4882a593Smuzhiyun #include <linux/errno.h>
10*4882a593Smuzhiyun #include <linux/mtd/mtd.h>
11*4882a593Smuzhiyun #include <spi_flash.h>
12*4882a593Smuzhiyun 
13*4882a593Smuzhiyun static struct mtd_info sf_mtd_info;
14*4882a593Smuzhiyun static bool sf_mtd_registered;
15*4882a593Smuzhiyun static char sf_mtd_name[8];
16*4882a593Smuzhiyun 
spi_flash_mtd_erase(struct mtd_info * mtd,struct erase_info * instr)17*4882a593Smuzhiyun static int spi_flash_mtd_erase(struct mtd_info *mtd, struct erase_info *instr)
18*4882a593Smuzhiyun {
19*4882a593Smuzhiyun 	struct spi_flash *flash = mtd->priv;
20*4882a593Smuzhiyun 	int err;
21*4882a593Smuzhiyun 
22*4882a593Smuzhiyun 	if (!flash)
23*4882a593Smuzhiyun 		return -ENODEV;
24*4882a593Smuzhiyun 
25*4882a593Smuzhiyun 	instr->state = MTD_ERASING;
26*4882a593Smuzhiyun 
27*4882a593Smuzhiyun 	err = spi_flash_erase(flash, instr->addr, instr->len);
28*4882a593Smuzhiyun 	if (err) {
29*4882a593Smuzhiyun 		instr->state = MTD_ERASE_FAILED;
30*4882a593Smuzhiyun 		instr->fail_addr = MTD_FAIL_ADDR_UNKNOWN;
31*4882a593Smuzhiyun 		return -EIO;
32*4882a593Smuzhiyun 	}
33*4882a593Smuzhiyun 
34*4882a593Smuzhiyun 	instr->state = MTD_ERASE_DONE;
35*4882a593Smuzhiyun 	mtd_erase_callback(instr);
36*4882a593Smuzhiyun 
37*4882a593Smuzhiyun 	return 0;
38*4882a593Smuzhiyun }
39*4882a593Smuzhiyun 
spi_flash_mtd_read(struct mtd_info * mtd,loff_t from,size_t len,size_t * retlen,u_char * buf)40*4882a593Smuzhiyun static int spi_flash_mtd_read(struct mtd_info *mtd, loff_t from, size_t len,
41*4882a593Smuzhiyun 	size_t *retlen, u_char *buf)
42*4882a593Smuzhiyun {
43*4882a593Smuzhiyun 	struct spi_flash *flash = mtd->priv;
44*4882a593Smuzhiyun 	int err;
45*4882a593Smuzhiyun 
46*4882a593Smuzhiyun 	if (!flash)
47*4882a593Smuzhiyun 		return -ENODEV;
48*4882a593Smuzhiyun 
49*4882a593Smuzhiyun 	err = spi_flash_read(flash, from, len, buf);
50*4882a593Smuzhiyun 	if (!err)
51*4882a593Smuzhiyun 		*retlen = len;
52*4882a593Smuzhiyun 
53*4882a593Smuzhiyun 	return err;
54*4882a593Smuzhiyun }
55*4882a593Smuzhiyun 
spi_flash_mtd_write(struct mtd_info * mtd,loff_t to,size_t len,size_t * retlen,const u_char * buf)56*4882a593Smuzhiyun static int spi_flash_mtd_write(struct mtd_info *mtd, loff_t to, size_t len,
57*4882a593Smuzhiyun 	size_t *retlen, const u_char *buf)
58*4882a593Smuzhiyun {
59*4882a593Smuzhiyun 	struct spi_flash *flash = mtd->priv;
60*4882a593Smuzhiyun 	int err;
61*4882a593Smuzhiyun 
62*4882a593Smuzhiyun 	if (!flash)
63*4882a593Smuzhiyun 		return -ENODEV;
64*4882a593Smuzhiyun 
65*4882a593Smuzhiyun 	err = spi_flash_write(flash, to, len, buf);
66*4882a593Smuzhiyun 	if (!err)
67*4882a593Smuzhiyun 		*retlen = len;
68*4882a593Smuzhiyun 
69*4882a593Smuzhiyun 	return err;
70*4882a593Smuzhiyun }
71*4882a593Smuzhiyun 
spi_flash_mtd_sync(struct mtd_info * mtd)72*4882a593Smuzhiyun static void spi_flash_mtd_sync(struct mtd_info *mtd)
73*4882a593Smuzhiyun {
74*4882a593Smuzhiyun }
75*4882a593Smuzhiyun 
spi_flash_mtd_number(void)76*4882a593Smuzhiyun static int spi_flash_mtd_number(void)
77*4882a593Smuzhiyun {
78*4882a593Smuzhiyun #ifdef CONFIG_SYS_MAX_FLASH_BANKS
79*4882a593Smuzhiyun 	return CONFIG_SYS_MAX_FLASH_BANKS;
80*4882a593Smuzhiyun #else
81*4882a593Smuzhiyun 	return 0;
82*4882a593Smuzhiyun #endif
83*4882a593Smuzhiyun }
84*4882a593Smuzhiyun 
spi_flash_mtd_register(struct spi_flash * flash)85*4882a593Smuzhiyun int spi_flash_mtd_register(struct spi_flash *flash)
86*4882a593Smuzhiyun {
87*4882a593Smuzhiyun 	int ret;
88*4882a593Smuzhiyun 
89*4882a593Smuzhiyun 	if (sf_mtd_registered) {
90*4882a593Smuzhiyun 		ret = del_mtd_device(&sf_mtd_info);
91*4882a593Smuzhiyun 		if (ret)
92*4882a593Smuzhiyun 			return ret;
93*4882a593Smuzhiyun 
94*4882a593Smuzhiyun 		sf_mtd_registered = false;
95*4882a593Smuzhiyun 	}
96*4882a593Smuzhiyun 
97*4882a593Smuzhiyun 	sf_mtd_registered = false;
98*4882a593Smuzhiyun 	memset(&sf_mtd_info, 0, sizeof(sf_mtd_info));
99*4882a593Smuzhiyun 	sprintf(sf_mtd_name, "nor%d", spi_flash_mtd_number());
100*4882a593Smuzhiyun 
101*4882a593Smuzhiyun 	sf_mtd_info.name = sf_mtd_name;
102*4882a593Smuzhiyun 	sf_mtd_info.type = MTD_NORFLASH;
103*4882a593Smuzhiyun 	sf_mtd_info.flags = MTD_CAP_NORFLASH;
104*4882a593Smuzhiyun 	sf_mtd_info.writesize = 1;
105*4882a593Smuzhiyun 	sf_mtd_info.writebufsize = flash->page_size;
106*4882a593Smuzhiyun 
107*4882a593Smuzhiyun 	sf_mtd_info._erase = spi_flash_mtd_erase;
108*4882a593Smuzhiyun 	sf_mtd_info._read = spi_flash_mtd_read;
109*4882a593Smuzhiyun 	sf_mtd_info._write = spi_flash_mtd_write;
110*4882a593Smuzhiyun 	sf_mtd_info._sync = spi_flash_mtd_sync;
111*4882a593Smuzhiyun 
112*4882a593Smuzhiyun 	sf_mtd_info.size = flash->size;
113*4882a593Smuzhiyun 	sf_mtd_info.priv = flash;
114*4882a593Smuzhiyun 
115*4882a593Smuzhiyun 	/* Only uniform flash devices for now */
116*4882a593Smuzhiyun 	sf_mtd_info.numeraseregions = 0;
117*4882a593Smuzhiyun 	sf_mtd_info.erasesize = flash->sector_size;
118*4882a593Smuzhiyun 
119*4882a593Smuzhiyun 	ret = add_mtd_device(&sf_mtd_info);
120*4882a593Smuzhiyun 	if (!ret)
121*4882a593Smuzhiyun 		sf_mtd_registered = true;
122*4882a593Smuzhiyun 
123*4882a593Smuzhiyun 	return ret;
124*4882a593Smuzhiyun }
125*4882a593Smuzhiyun 
spi_flash_mtd_unregister(void)126*4882a593Smuzhiyun void spi_flash_mtd_unregister(void)
127*4882a593Smuzhiyun {
128*4882a593Smuzhiyun 	int ret;
129*4882a593Smuzhiyun 
130*4882a593Smuzhiyun 	if (!sf_mtd_registered)
131*4882a593Smuzhiyun 		return;
132*4882a593Smuzhiyun 
133*4882a593Smuzhiyun 	ret = del_mtd_device(&sf_mtd_info);
134*4882a593Smuzhiyun 	if (!ret) {
135*4882a593Smuzhiyun 		sf_mtd_registered = false;
136*4882a593Smuzhiyun 		return;
137*4882a593Smuzhiyun 	}
138*4882a593Smuzhiyun 
139*4882a593Smuzhiyun 	/*
140*4882a593Smuzhiyun 	 * Setting mtd->priv to NULL is the best we can do. Thanks to that,
141*4882a593Smuzhiyun 	 * the MTD layer can still call mtd hooks without risking a
142*4882a593Smuzhiyun 	 * use-after-free bug. Still, things should be fixed to prevent the
143*4882a593Smuzhiyun 	 * spi_flash object from being destroyed when del_mtd_device() fails.
144*4882a593Smuzhiyun 	 */
145*4882a593Smuzhiyun 	sf_mtd_info.priv = NULL;
146*4882a593Smuzhiyun 	printf("Failed to unregister MTD %s and the spi_flash object is going away: you're in deep trouble!",
147*4882a593Smuzhiyun 	       sf_mtd_info.name);
148*4882a593Smuzhiyun }
149