xref: /OK3568_Linux_fs/u-boot/drivers/mtd/spi/sf_probe.c (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /*
2*4882a593Smuzhiyun  * SPI flash probing
3*4882a593Smuzhiyun  *
4*4882a593Smuzhiyun  * Copyright (C) 2008 Atmel Corporation
5*4882a593Smuzhiyun  * Copyright (C) 2010 Reinhard Meyer, EMK Elektronik
6*4882a593Smuzhiyun  * Copyright (C) 2013 Jagannadha Sutradharudu Teki, Xilinx Inc.
7*4882a593Smuzhiyun  *
8*4882a593Smuzhiyun  * SPDX-License-Identifier:	GPL-2.0+
9*4882a593Smuzhiyun  */
10*4882a593Smuzhiyun 
11*4882a593Smuzhiyun #include <common.h>
12*4882a593Smuzhiyun #include <blk.h>
13*4882a593Smuzhiyun #include <dm.h>
14*4882a593Smuzhiyun #include <errno.h>
15*4882a593Smuzhiyun #include <malloc.h>
16*4882a593Smuzhiyun #include <spi.h>
17*4882a593Smuzhiyun #include <spi_flash.h>
18*4882a593Smuzhiyun 
19*4882a593Smuzhiyun #include "sf_internal.h"
20*4882a593Smuzhiyun 
21*4882a593Smuzhiyun /**
22*4882a593Smuzhiyun  * spi_flash_probe_slave() - Probe for a SPI flash device on a bus
23*4882a593Smuzhiyun  *
24*4882a593Smuzhiyun  * @flashp: Pointer to place to put flash info, which may be NULL if the
25*4882a593Smuzhiyun  * space should be allocated
26*4882a593Smuzhiyun  */
spi_flash_probe_slave(struct spi_flash * flash)27*4882a593Smuzhiyun static int spi_flash_probe_slave(struct spi_flash *flash)
28*4882a593Smuzhiyun {
29*4882a593Smuzhiyun 	struct spi_slave *spi = flash->spi;
30*4882a593Smuzhiyun 	int ret;
31*4882a593Smuzhiyun 
32*4882a593Smuzhiyun 	/* Setup spi_slave */
33*4882a593Smuzhiyun 	if (!spi) {
34*4882a593Smuzhiyun 		printf("SF: Failed to set up slave\n");
35*4882a593Smuzhiyun 		return -ENODEV;
36*4882a593Smuzhiyun 	}
37*4882a593Smuzhiyun 
38*4882a593Smuzhiyun 	/* Claim spi bus */
39*4882a593Smuzhiyun 	ret = spi_claim_bus(spi);
40*4882a593Smuzhiyun 	if (ret) {
41*4882a593Smuzhiyun 		debug("SF: Failed to claim SPI bus: %d\n", ret);
42*4882a593Smuzhiyun 		return ret;
43*4882a593Smuzhiyun 	}
44*4882a593Smuzhiyun 
45*4882a593Smuzhiyun #if !CONFIG_IS_ENABLED(SPI_FLASH_TINY)
46*4882a593Smuzhiyun 	flash->mtd.name = (char *)ofnode_read_string(spi->dev->node, "label");
47*4882a593Smuzhiyun #endif
48*4882a593Smuzhiyun 
49*4882a593Smuzhiyun 	ret = spi_nor_scan(flash);
50*4882a593Smuzhiyun 	if (ret)
51*4882a593Smuzhiyun 		goto err_read_id;
52*4882a593Smuzhiyun 
53*4882a593Smuzhiyun #ifdef CONFIG_SPI_FLASH_MTD
54*4882a593Smuzhiyun 	ret = spi_flash_mtd_register(flash);
55*4882a593Smuzhiyun #endif
56*4882a593Smuzhiyun 
57*4882a593Smuzhiyun err_read_id:
58*4882a593Smuzhiyun 	spi_release_bus(spi);
59*4882a593Smuzhiyun 	return ret;
60*4882a593Smuzhiyun }
61*4882a593Smuzhiyun 
62*4882a593Smuzhiyun #ifndef CONFIG_DM_SPI_FLASH
spi_flash_probe(unsigned int busnum,unsigned int cs,unsigned int max_hz,unsigned int spi_mode)63*4882a593Smuzhiyun struct spi_flash *spi_flash_probe(unsigned int busnum, unsigned int cs,
64*4882a593Smuzhiyun 				  unsigned int max_hz, unsigned int spi_mode)
65*4882a593Smuzhiyun {
66*4882a593Smuzhiyun 	struct spi_slave *bus;
67*4882a593Smuzhiyun 	struct spi_flash *flash;
68*4882a593Smuzhiyun 
69*4882a593Smuzhiyun 	bus = spi_setup_slave(busnum, cs, max_hz, spi_mode);
70*4882a593Smuzhiyun 	if (!bus)
71*4882a593Smuzhiyun 		return NULL;
72*4882a593Smuzhiyun 
73*4882a593Smuzhiyun 	/* Allocate space if needed (not used by sf-uclass */
74*4882a593Smuzhiyun 	flash = calloc(1, sizeof(*flash));
75*4882a593Smuzhiyun 	if (!flash) {
76*4882a593Smuzhiyun 		debug("SF: Failed to allocate spi_flash\n");
77*4882a593Smuzhiyun 		return NULL;
78*4882a593Smuzhiyun 	}
79*4882a593Smuzhiyun 
80*4882a593Smuzhiyun 	flash->spi = bus;
81*4882a593Smuzhiyun 	if (spi_flash_probe_slave(flash)) {
82*4882a593Smuzhiyun 		spi_free_slave(bus);
83*4882a593Smuzhiyun 		free(flash);
84*4882a593Smuzhiyun 		return NULL;
85*4882a593Smuzhiyun 	}
86*4882a593Smuzhiyun 
87*4882a593Smuzhiyun 	return flash;
88*4882a593Smuzhiyun }
89*4882a593Smuzhiyun 
spi_flash_free(struct spi_flash * flash)90*4882a593Smuzhiyun void spi_flash_free(struct spi_flash *flash)
91*4882a593Smuzhiyun {
92*4882a593Smuzhiyun #ifdef CONFIG_SPI_FLASH_MTD
93*4882a593Smuzhiyun 	spi_flash_mtd_unregister();
94*4882a593Smuzhiyun #endif
95*4882a593Smuzhiyun 	spi_free_slave(flash->spi);
96*4882a593Smuzhiyun 	free(flash);
97*4882a593Smuzhiyun }
98*4882a593Smuzhiyun 
99*4882a593Smuzhiyun #else /* defined CONFIG_DM_SPI_FLASH */
100*4882a593Smuzhiyun 
spi_flash_std_read(struct udevice * dev,u32 offset,size_t len,void * buf)101*4882a593Smuzhiyun static int spi_flash_std_read(struct udevice *dev, u32 offset, size_t len,
102*4882a593Smuzhiyun 			      void *buf)
103*4882a593Smuzhiyun {
104*4882a593Smuzhiyun 	struct spi_flash *flash = dev_get_uclass_priv(dev);
105*4882a593Smuzhiyun 	struct mtd_info *mtd = &flash->mtd;
106*4882a593Smuzhiyun 	size_t retlen;
107*4882a593Smuzhiyun 
108*4882a593Smuzhiyun 	return log_ret(mtd->_read(mtd, offset, len, &retlen, buf));
109*4882a593Smuzhiyun }
110*4882a593Smuzhiyun 
spi_flash_std_write(struct udevice * dev,u32 offset,size_t len,const void * buf)111*4882a593Smuzhiyun static int spi_flash_std_write(struct udevice *dev, u32 offset, size_t len,
112*4882a593Smuzhiyun 			       const void *buf)
113*4882a593Smuzhiyun {
114*4882a593Smuzhiyun 	struct spi_flash *flash = dev_get_uclass_priv(dev);
115*4882a593Smuzhiyun 	struct mtd_info *mtd = &flash->mtd;
116*4882a593Smuzhiyun 	size_t retlen;
117*4882a593Smuzhiyun 
118*4882a593Smuzhiyun 	return mtd->_write(mtd, offset, len, &retlen, buf);
119*4882a593Smuzhiyun }
120*4882a593Smuzhiyun 
spi_flash_std_erase(struct udevice * dev,u32 offset,size_t len)121*4882a593Smuzhiyun static int spi_flash_std_erase(struct udevice *dev, u32 offset, size_t len)
122*4882a593Smuzhiyun {
123*4882a593Smuzhiyun 	struct spi_flash *flash = dev_get_uclass_priv(dev);
124*4882a593Smuzhiyun 	struct mtd_info *mtd = &flash->mtd;
125*4882a593Smuzhiyun 	struct erase_info instr;
126*4882a593Smuzhiyun 
127*4882a593Smuzhiyun 	if (offset % mtd->erasesize || len % mtd->erasesize) {
128*4882a593Smuzhiyun 		printf("SF: Erase offset/length not multiple of erase size\n");
129*4882a593Smuzhiyun 		return -EINVAL;
130*4882a593Smuzhiyun 	}
131*4882a593Smuzhiyun 
132*4882a593Smuzhiyun 	memset(&instr, 0, sizeof(instr));
133*4882a593Smuzhiyun 	instr.addr = offset;
134*4882a593Smuzhiyun 	instr.len = len;
135*4882a593Smuzhiyun 
136*4882a593Smuzhiyun 	return mtd->_erase(mtd, &instr);
137*4882a593Smuzhiyun }
138*4882a593Smuzhiyun 
spi_flash_std_get_sw_write_prot(struct udevice * dev)139*4882a593Smuzhiyun static int spi_flash_std_get_sw_write_prot(struct udevice *dev)
140*4882a593Smuzhiyun {
141*4882a593Smuzhiyun 	struct spi_flash *flash = dev_get_uclass_priv(dev);
142*4882a593Smuzhiyun 
143*4882a593Smuzhiyun 	return spi_flash_cmd_get_sw_write_prot(flash);
144*4882a593Smuzhiyun }
145*4882a593Smuzhiyun 
spi_flash_std_bind(struct udevice * udev)146*4882a593Smuzhiyun static int spi_flash_std_bind(struct udevice *udev)
147*4882a593Smuzhiyun {
148*4882a593Smuzhiyun 	int ret = 0;
149*4882a593Smuzhiyun 
150*4882a593Smuzhiyun #ifdef CONFIG_MTD_BLK
151*4882a593Smuzhiyun 	struct udevice *bdev;
152*4882a593Smuzhiyun 
153*4882a593Smuzhiyun 	ret = blk_create_devicef(udev, "mtd_blk", "blk", IF_TYPE_MTD,
154*4882a593Smuzhiyun 				 BLK_MTD_SPI_NOR, 512, 0, &bdev);
155*4882a593Smuzhiyun 	if (ret)
156*4882a593Smuzhiyun 		printf("Cannot create block device\n");
157*4882a593Smuzhiyun #endif
158*4882a593Smuzhiyun 	return ret;
159*4882a593Smuzhiyun }
160*4882a593Smuzhiyun 
spi_flash_std_probe(struct udevice * dev)161*4882a593Smuzhiyun static int spi_flash_std_probe(struct udevice *dev)
162*4882a593Smuzhiyun {
163*4882a593Smuzhiyun 	struct spi_slave *slave = dev_get_parent_priv(dev);
164*4882a593Smuzhiyun 	struct dm_spi_slave_platdata *plat = dev_get_parent_platdata(dev);
165*4882a593Smuzhiyun 	struct spi_flash *flash;
166*4882a593Smuzhiyun 
167*4882a593Smuzhiyun 	flash = dev_get_uclass_priv(dev);
168*4882a593Smuzhiyun 	flash->dev = dev;
169*4882a593Smuzhiyun 	flash->spi = slave;
170*4882a593Smuzhiyun 	debug("%s: slave=%p, cs=%d\n", __func__, slave, plat->cs);
171*4882a593Smuzhiyun 	return spi_flash_probe_slave(flash);
172*4882a593Smuzhiyun }
173*4882a593Smuzhiyun 
spi_flash_std_remove(struct udevice * dev)174*4882a593Smuzhiyun static int spi_flash_std_remove(struct udevice *dev)
175*4882a593Smuzhiyun {
176*4882a593Smuzhiyun #ifdef CONFIG_SPI_FLASH_MTD
177*4882a593Smuzhiyun 	spi_flash_mtd_unregister();
178*4882a593Smuzhiyun #endif
179*4882a593Smuzhiyun 	return 0;
180*4882a593Smuzhiyun }
181*4882a593Smuzhiyun 
182*4882a593Smuzhiyun static const struct dm_spi_flash_ops spi_flash_std_ops = {
183*4882a593Smuzhiyun 	.read = spi_flash_std_read,
184*4882a593Smuzhiyun 	.write = spi_flash_std_write,
185*4882a593Smuzhiyun 	.erase = spi_flash_std_erase,
186*4882a593Smuzhiyun 	.get_sw_write_prot = spi_flash_std_get_sw_write_prot,
187*4882a593Smuzhiyun };
188*4882a593Smuzhiyun 
189*4882a593Smuzhiyun static const struct udevice_id spi_flash_std_ids[] = {
190*4882a593Smuzhiyun 	{ .compatible = "jedec,spi-nor" },
191*4882a593Smuzhiyun 	{ }
192*4882a593Smuzhiyun };
193*4882a593Smuzhiyun 
194*4882a593Smuzhiyun U_BOOT_DRIVER(spi_flash_std) = {
195*4882a593Smuzhiyun 	.name		= "spi_flash_std",
196*4882a593Smuzhiyun 	.id		= UCLASS_SPI_FLASH,
197*4882a593Smuzhiyun 	.of_match	= spi_flash_std_ids,
198*4882a593Smuzhiyun 	.bind		= spi_flash_std_bind,
199*4882a593Smuzhiyun 	.probe		= spi_flash_std_probe,
200*4882a593Smuzhiyun 	.remove		= spi_flash_std_remove,
201*4882a593Smuzhiyun 	.priv_auto_alloc_size = sizeof(struct spi_flash),
202*4882a593Smuzhiyun 	.ops		= &spi_flash_std_ops,
203*4882a593Smuzhiyun };
204*4882a593Smuzhiyun 
205*4882a593Smuzhiyun #endif /* CONFIG_DM_SPI_FLASH */
206