xref: /OK3568_Linux_fs/u-boot/drivers/mtd/spi/spi-nor-tiny.c (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun // SPDX-License-Identifier: GPL-2.0
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun  * Based on m25p80.c, by Mike Lavender (mike@steroidmicros.com), with
4*4882a593Smuzhiyun  * influence from lart.c (Abraham Van Der Merwe) and mtd_dataflash.c
5*4882a593Smuzhiyun  *
6*4882a593Smuzhiyun  * Copyright (C) 2005, Intec Automation Inc.
7*4882a593Smuzhiyun  * Copyright (C) 2014, Freescale Semiconductor, Inc.
8*4882a593Smuzhiyun  *
9*4882a593Smuzhiyun  * Synced from Linux v4.19
10*4882a593Smuzhiyun  */
11*4882a593Smuzhiyun 
12*4882a593Smuzhiyun #include <common.h>
13*4882a593Smuzhiyun #include <linux/err.h>
14*4882a593Smuzhiyun #include <linux/errno.h>
15*4882a593Smuzhiyun #include <linux/log2.h>
16*4882a593Smuzhiyun #include <linux/math64.h>
17*4882a593Smuzhiyun #include <linux/sizes.h>
18*4882a593Smuzhiyun 
19*4882a593Smuzhiyun #include <linux/mtd/mtd.h>
20*4882a593Smuzhiyun #include <linux/mtd/spi-nor.h>
21*4882a593Smuzhiyun #include <spi-mem.h>
22*4882a593Smuzhiyun #include <spi.h>
23*4882a593Smuzhiyun 
24*4882a593Smuzhiyun #include "sf_internal.h"
25*4882a593Smuzhiyun 
26*4882a593Smuzhiyun /* Define max times to check status register before we give up. */
27*4882a593Smuzhiyun 
28*4882a593Smuzhiyun /*
29*4882a593Smuzhiyun  * For everything but full-chip erase; probably could be much smaller, but kept
30*4882a593Smuzhiyun  * around for safety for now
31*4882a593Smuzhiyun  */
32*4882a593Smuzhiyun 
33*4882a593Smuzhiyun #define HZ					CONFIG_SYS_HZ
34*4882a593Smuzhiyun 
35*4882a593Smuzhiyun #define DEFAULT_READY_WAIT_JIFFIES		(40UL * HZ)
36*4882a593Smuzhiyun 
spi_nor_read_write_reg(struct spi_nor * nor,struct spi_mem_op * op,void * buf)37*4882a593Smuzhiyun static int spi_nor_read_write_reg(struct spi_nor *nor, struct spi_mem_op
38*4882a593Smuzhiyun 		*op, void *buf)
39*4882a593Smuzhiyun {
40*4882a593Smuzhiyun 	if (op->data.dir == SPI_MEM_DATA_IN)
41*4882a593Smuzhiyun 		op->data.buf.in = buf;
42*4882a593Smuzhiyun 	else
43*4882a593Smuzhiyun 		op->data.buf.out = buf;
44*4882a593Smuzhiyun 	return spi_mem_exec_op(nor->spi, op);
45*4882a593Smuzhiyun }
46*4882a593Smuzhiyun 
spi_nor_read_reg(struct spi_nor * nor,u8 code,u8 * val,int len)47*4882a593Smuzhiyun static int spi_nor_read_reg(struct spi_nor *nor, u8 code, u8 *val, int len)
48*4882a593Smuzhiyun {
49*4882a593Smuzhiyun 	struct spi_mem_op op = SPI_MEM_OP(SPI_MEM_OP_CMD(code, 1),
50*4882a593Smuzhiyun 					  SPI_MEM_OP_NO_ADDR,
51*4882a593Smuzhiyun 					  SPI_MEM_OP_NO_DUMMY,
52*4882a593Smuzhiyun 					  SPI_MEM_OP_DATA_IN(len, NULL, 1));
53*4882a593Smuzhiyun 	int ret;
54*4882a593Smuzhiyun 
55*4882a593Smuzhiyun 	ret = spi_nor_read_write_reg(nor, &op, val);
56*4882a593Smuzhiyun 	if (ret < 0)
57*4882a593Smuzhiyun 		dev_dbg(&flash->spimem->spi->dev, "error %d reading %x\n", ret,
58*4882a593Smuzhiyun 			code);
59*4882a593Smuzhiyun 
60*4882a593Smuzhiyun 	return ret;
61*4882a593Smuzhiyun }
62*4882a593Smuzhiyun 
spi_nor_write_reg(struct spi_nor * nor,u8 opcode,u8 * buf,int len)63*4882a593Smuzhiyun static int spi_nor_write_reg(struct spi_nor *nor, u8 opcode, u8 *buf, int len)
64*4882a593Smuzhiyun {
65*4882a593Smuzhiyun 	struct spi_mem_op op = SPI_MEM_OP(SPI_MEM_OP_CMD(opcode, 1),
66*4882a593Smuzhiyun 					  SPI_MEM_OP_NO_ADDR,
67*4882a593Smuzhiyun 					  SPI_MEM_OP_NO_DUMMY,
68*4882a593Smuzhiyun 					  SPI_MEM_OP_DATA_OUT(len, NULL, 1));
69*4882a593Smuzhiyun 
70*4882a593Smuzhiyun 	return spi_nor_read_write_reg(nor, &op, buf);
71*4882a593Smuzhiyun }
72*4882a593Smuzhiyun 
spi_nor_read_data(struct spi_nor * nor,loff_t from,size_t len,u_char * buf)73*4882a593Smuzhiyun static ssize_t spi_nor_read_data(struct spi_nor *nor, loff_t from, size_t len,
74*4882a593Smuzhiyun 				 u_char *buf)
75*4882a593Smuzhiyun {
76*4882a593Smuzhiyun 	struct spi_mem_op op =
77*4882a593Smuzhiyun 			SPI_MEM_OP(SPI_MEM_OP_CMD(nor->read_opcode, 1),
78*4882a593Smuzhiyun 				   SPI_MEM_OP_ADDR(nor->addr_width, from, 1),
79*4882a593Smuzhiyun 				   SPI_MEM_OP_DUMMY(nor->read_dummy, 1),
80*4882a593Smuzhiyun 				   SPI_MEM_OP_DATA_IN(len, buf, 1));
81*4882a593Smuzhiyun 	size_t remaining = len;
82*4882a593Smuzhiyun 	int ret;
83*4882a593Smuzhiyun 
84*4882a593Smuzhiyun 	/* get transfer protocols. */
85*4882a593Smuzhiyun 	op.cmd.buswidth = spi_nor_get_protocol_inst_nbits(nor->read_proto);
86*4882a593Smuzhiyun 	op.addr.buswidth = spi_nor_get_protocol_addr_nbits(nor->read_proto);
87*4882a593Smuzhiyun 	op.dummy.buswidth = op.addr.buswidth;
88*4882a593Smuzhiyun 	op.data.buswidth = spi_nor_get_protocol_data_nbits(nor->read_proto);
89*4882a593Smuzhiyun 
90*4882a593Smuzhiyun 	/* convert the dummy cycles to the number of bytes */
91*4882a593Smuzhiyun 	op.dummy.nbytes = (nor->read_dummy * op.dummy.buswidth) / 8;
92*4882a593Smuzhiyun 
93*4882a593Smuzhiyun 	while (remaining) {
94*4882a593Smuzhiyun 		op.data.nbytes = remaining < UINT_MAX ? remaining : UINT_MAX;
95*4882a593Smuzhiyun 		ret = spi_mem_adjust_op_size(nor->spi, &op);
96*4882a593Smuzhiyun 		if (ret)
97*4882a593Smuzhiyun 			return ret;
98*4882a593Smuzhiyun 
99*4882a593Smuzhiyun 		ret = spi_mem_exec_op(nor->spi, &op);
100*4882a593Smuzhiyun 		if (ret)
101*4882a593Smuzhiyun 			return ret;
102*4882a593Smuzhiyun 
103*4882a593Smuzhiyun 		op.addr.val += op.data.nbytes;
104*4882a593Smuzhiyun 		remaining -= op.data.nbytes;
105*4882a593Smuzhiyun 		op.data.buf.in += op.data.nbytes;
106*4882a593Smuzhiyun 	}
107*4882a593Smuzhiyun 
108*4882a593Smuzhiyun 	return len;
109*4882a593Smuzhiyun }
110*4882a593Smuzhiyun 
111*4882a593Smuzhiyun #if defined(CONFIG_SPI_FLASH_SPANSION) || defined(CONFIG_SPI_FLASH_WINBOND)
112*4882a593Smuzhiyun /*
113*4882a593Smuzhiyun  * Read configuration register, returning its value in the
114*4882a593Smuzhiyun  * location. Return the configuration register value.
115*4882a593Smuzhiyun  * Returns negative if error occurred.
116*4882a593Smuzhiyun  */
read_cr(struct spi_nor * nor)117*4882a593Smuzhiyun static int read_cr(struct spi_nor *nor)
118*4882a593Smuzhiyun {
119*4882a593Smuzhiyun 	int ret;
120*4882a593Smuzhiyun 	u8 val;
121*4882a593Smuzhiyun 
122*4882a593Smuzhiyun 	ret = spi_nor_read_reg(nor, SPINOR_OP_RDCR, &val, 1);
123*4882a593Smuzhiyun 	if (ret < 0) {
124*4882a593Smuzhiyun 		dev_dbg(nor->dev, "error %d reading CR\n", ret);
125*4882a593Smuzhiyun 		return ret;
126*4882a593Smuzhiyun 	}
127*4882a593Smuzhiyun 
128*4882a593Smuzhiyun 	return val;
129*4882a593Smuzhiyun }
130*4882a593Smuzhiyun #endif
131*4882a593Smuzhiyun 
132*4882a593Smuzhiyun /*
133*4882a593Smuzhiyun  * Write status register 1 byte
134*4882a593Smuzhiyun  * Returns negative if error occurred.
135*4882a593Smuzhiyun  */
write_sr(struct spi_nor * nor,u8 val)136*4882a593Smuzhiyun static inline int write_sr(struct spi_nor *nor, u8 val)
137*4882a593Smuzhiyun {
138*4882a593Smuzhiyun 	nor->cmd_buf[0] = val;
139*4882a593Smuzhiyun 	return spi_nor_write_reg(nor, SPINOR_OP_WRSR, nor->cmd_buf, 1);
140*4882a593Smuzhiyun }
141*4882a593Smuzhiyun 
142*4882a593Smuzhiyun /*
143*4882a593Smuzhiyun  * Set write enable latch with Write Enable command.
144*4882a593Smuzhiyun  * Returns negative if error occurred.
145*4882a593Smuzhiyun  */
write_enable(struct spi_nor * nor)146*4882a593Smuzhiyun static inline int write_enable(struct spi_nor *nor)
147*4882a593Smuzhiyun {
148*4882a593Smuzhiyun 	return spi_nor_write_reg(nor, SPINOR_OP_WREN, NULL, 0);
149*4882a593Smuzhiyun }
150*4882a593Smuzhiyun 
151*4882a593Smuzhiyun /*
152*4882a593Smuzhiyun  * Send write disable instruction to the chip.
153*4882a593Smuzhiyun  */
write_disable(struct spi_nor * nor)154*4882a593Smuzhiyun static inline int write_disable(struct spi_nor *nor)
155*4882a593Smuzhiyun {
156*4882a593Smuzhiyun 	return spi_nor_write_reg(nor, SPINOR_OP_WRDI, NULL, 0);
157*4882a593Smuzhiyun }
158*4882a593Smuzhiyun 
mtd_to_spi_nor(struct mtd_info * mtd)159*4882a593Smuzhiyun static inline struct spi_nor *mtd_to_spi_nor(struct mtd_info *mtd)
160*4882a593Smuzhiyun {
161*4882a593Smuzhiyun 	return mtd->priv;
162*4882a593Smuzhiyun }
163*4882a593Smuzhiyun 
spi_nor_convert_opcode(u8 opcode,const u8 table[][2],size_t size)164*4882a593Smuzhiyun static u8 spi_nor_convert_opcode(u8 opcode, const u8 table[][2], size_t size)
165*4882a593Smuzhiyun {
166*4882a593Smuzhiyun 	size_t i;
167*4882a593Smuzhiyun 
168*4882a593Smuzhiyun 	for (i = 0; i < size; i++)
169*4882a593Smuzhiyun 		if (table[i][0] == opcode)
170*4882a593Smuzhiyun 			return table[i][1];
171*4882a593Smuzhiyun 
172*4882a593Smuzhiyun 	/* No conversion found, keep input op code. */
173*4882a593Smuzhiyun 	return opcode;
174*4882a593Smuzhiyun }
175*4882a593Smuzhiyun 
spi_nor_convert_3to4_read(u8 opcode)176*4882a593Smuzhiyun static inline u8 spi_nor_convert_3to4_read(u8 opcode)
177*4882a593Smuzhiyun {
178*4882a593Smuzhiyun 	static const u8 spi_nor_3to4_read[][2] = {
179*4882a593Smuzhiyun 		{ SPINOR_OP_READ,	SPINOR_OP_READ_4B },
180*4882a593Smuzhiyun 		{ SPINOR_OP_READ_FAST,	SPINOR_OP_READ_FAST_4B },
181*4882a593Smuzhiyun 		{ SPINOR_OP_READ_1_1_2,	SPINOR_OP_READ_1_1_2_4B },
182*4882a593Smuzhiyun 		{ SPINOR_OP_READ_1_2_2,	SPINOR_OP_READ_1_2_2_4B },
183*4882a593Smuzhiyun 		{ SPINOR_OP_READ_1_1_4,	SPINOR_OP_READ_1_1_4_4B },
184*4882a593Smuzhiyun 		{ SPINOR_OP_READ_1_4_4,	SPINOR_OP_READ_1_4_4_4B },
185*4882a593Smuzhiyun 	};
186*4882a593Smuzhiyun 
187*4882a593Smuzhiyun 	return spi_nor_convert_opcode(opcode, spi_nor_3to4_read,
188*4882a593Smuzhiyun 				      ARRAY_SIZE(spi_nor_3to4_read));
189*4882a593Smuzhiyun }
190*4882a593Smuzhiyun 
spi_nor_set_4byte_opcodes(struct spi_nor * nor,const struct flash_info * info)191*4882a593Smuzhiyun static void spi_nor_set_4byte_opcodes(struct spi_nor *nor,
192*4882a593Smuzhiyun 				      const struct flash_info *info)
193*4882a593Smuzhiyun {
194*4882a593Smuzhiyun 	nor->read_opcode = spi_nor_convert_3to4_read(nor->read_opcode);
195*4882a593Smuzhiyun }
196*4882a593Smuzhiyun 
197*4882a593Smuzhiyun /* Enable/disable 4-byte addressing mode. */
set_4byte(struct spi_nor * nor,const struct flash_info * info,int enable)198*4882a593Smuzhiyun static inline int set_4byte(struct spi_nor *nor, const struct flash_info *info,
199*4882a593Smuzhiyun 			    int enable)
200*4882a593Smuzhiyun {
201*4882a593Smuzhiyun 	int status;
202*4882a593Smuzhiyun 	bool need_wren = false;
203*4882a593Smuzhiyun 	u8 cmd;
204*4882a593Smuzhiyun 
205*4882a593Smuzhiyun 	switch (JEDEC_MFR(info)) {
206*4882a593Smuzhiyun 	case SNOR_MFR_ST:
207*4882a593Smuzhiyun 	case SNOR_MFR_MICRON:
208*4882a593Smuzhiyun 		/* Some Micron need WREN command; all will accept it */
209*4882a593Smuzhiyun 		need_wren = true;
210*4882a593Smuzhiyun 	case SNOR_MFR_MACRONIX:
211*4882a593Smuzhiyun 	case SNOR_MFR_WINBOND:
212*4882a593Smuzhiyun 		if (need_wren)
213*4882a593Smuzhiyun 			write_enable(nor);
214*4882a593Smuzhiyun 
215*4882a593Smuzhiyun 		cmd = enable ? SPINOR_OP_EN4B : SPINOR_OP_EX4B;
216*4882a593Smuzhiyun 		status = spi_nor_write_reg(nor, cmd, NULL, 0);
217*4882a593Smuzhiyun 		if (need_wren)
218*4882a593Smuzhiyun 			write_disable(nor);
219*4882a593Smuzhiyun 
220*4882a593Smuzhiyun 		if (!status && !enable &&
221*4882a593Smuzhiyun 		    JEDEC_MFR(info) == SNOR_MFR_WINBOND) {
222*4882a593Smuzhiyun 			/*
223*4882a593Smuzhiyun 			 * On Winbond W25Q256FV, leaving 4byte mode causes
224*4882a593Smuzhiyun 			 * the Extended Address Register to be set to 1, so all
225*4882a593Smuzhiyun 			 * 3-byte-address reads come from the second 16M.
226*4882a593Smuzhiyun 			 * We must clear the register to enable normal behavior.
227*4882a593Smuzhiyun 			 */
228*4882a593Smuzhiyun 			write_enable(nor);
229*4882a593Smuzhiyun 			nor->cmd_buf[0] = 0;
230*4882a593Smuzhiyun 			spi_nor_write_reg(nor, SPINOR_OP_WREAR,
231*4882a593Smuzhiyun 					  nor->cmd_buf, 1);
232*4882a593Smuzhiyun 			write_disable(nor);
233*4882a593Smuzhiyun 		}
234*4882a593Smuzhiyun 
235*4882a593Smuzhiyun 		return status;
236*4882a593Smuzhiyun 	default:
237*4882a593Smuzhiyun 		/* Spansion style */
238*4882a593Smuzhiyun 		nor->cmd_buf[0] = enable << 7;
239*4882a593Smuzhiyun 		return spi_nor_write_reg(nor, SPINOR_OP_BRWR, nor->cmd_buf, 1);
240*4882a593Smuzhiyun 	}
241*4882a593Smuzhiyun }
242*4882a593Smuzhiyun 
243*4882a593Smuzhiyun #if defined(CONFIG_SPI_FLASH_SPANSION) ||	\
244*4882a593Smuzhiyun 	defined(CONFIG_SPI_FLASH_WINBOND) ||	\
245*4882a593Smuzhiyun 	defined(CONFIG_SPI_FLASH_MACRONIX)
246*4882a593Smuzhiyun /*
247*4882a593Smuzhiyun  * Read the status register, returning its value in the location
248*4882a593Smuzhiyun  * Return the status register value.
249*4882a593Smuzhiyun  * Returns negative if error occurred.
250*4882a593Smuzhiyun  */
read_sr(struct spi_nor * nor)251*4882a593Smuzhiyun static int read_sr(struct spi_nor *nor)
252*4882a593Smuzhiyun {
253*4882a593Smuzhiyun 	int ret;
254*4882a593Smuzhiyun 	u8 val;
255*4882a593Smuzhiyun 
256*4882a593Smuzhiyun 	ret = spi_nor_read_reg(nor, SPINOR_OP_RDSR, &val, 1);
257*4882a593Smuzhiyun 	if (ret < 0) {
258*4882a593Smuzhiyun 		pr_debug("error %d reading SR\n", (int)ret);
259*4882a593Smuzhiyun 		return ret;
260*4882a593Smuzhiyun 	}
261*4882a593Smuzhiyun 
262*4882a593Smuzhiyun 	return val;
263*4882a593Smuzhiyun }
264*4882a593Smuzhiyun 
265*4882a593Smuzhiyun /*
266*4882a593Smuzhiyun  * Read the flag status register, returning its value in the location
267*4882a593Smuzhiyun  * Return the status register value.
268*4882a593Smuzhiyun  * Returns negative if error occurred.
269*4882a593Smuzhiyun  */
read_fsr(struct spi_nor * nor)270*4882a593Smuzhiyun static int read_fsr(struct spi_nor *nor)
271*4882a593Smuzhiyun {
272*4882a593Smuzhiyun 	int ret;
273*4882a593Smuzhiyun 	u8 val;
274*4882a593Smuzhiyun 
275*4882a593Smuzhiyun 	ret = spi_nor_read_reg(nor, SPINOR_OP_RDFSR, &val, 1);
276*4882a593Smuzhiyun 	if (ret < 0) {
277*4882a593Smuzhiyun 		pr_debug("error %d reading FSR\n", ret);
278*4882a593Smuzhiyun 		return ret;
279*4882a593Smuzhiyun 	}
280*4882a593Smuzhiyun 
281*4882a593Smuzhiyun 	return val;
282*4882a593Smuzhiyun }
283*4882a593Smuzhiyun 
spi_nor_sr_ready(struct spi_nor * nor)284*4882a593Smuzhiyun static int spi_nor_sr_ready(struct spi_nor *nor)
285*4882a593Smuzhiyun {
286*4882a593Smuzhiyun 	int sr = read_sr(nor);
287*4882a593Smuzhiyun 
288*4882a593Smuzhiyun 	if (sr < 0)
289*4882a593Smuzhiyun 		return sr;
290*4882a593Smuzhiyun 
291*4882a593Smuzhiyun 	return !(sr & SR_WIP);
292*4882a593Smuzhiyun }
293*4882a593Smuzhiyun 
spi_nor_fsr_ready(struct spi_nor * nor)294*4882a593Smuzhiyun static int spi_nor_fsr_ready(struct spi_nor *nor)
295*4882a593Smuzhiyun {
296*4882a593Smuzhiyun 	int fsr = read_fsr(nor);
297*4882a593Smuzhiyun 
298*4882a593Smuzhiyun 	if (fsr < 0)
299*4882a593Smuzhiyun 		return fsr;
300*4882a593Smuzhiyun 	return fsr & FSR_READY;
301*4882a593Smuzhiyun }
302*4882a593Smuzhiyun 
spi_nor_ready(struct spi_nor * nor)303*4882a593Smuzhiyun static int spi_nor_ready(struct spi_nor *nor)
304*4882a593Smuzhiyun {
305*4882a593Smuzhiyun 	int sr, fsr;
306*4882a593Smuzhiyun 
307*4882a593Smuzhiyun 	sr = spi_nor_sr_ready(nor);
308*4882a593Smuzhiyun 	if (sr < 0)
309*4882a593Smuzhiyun 		return sr;
310*4882a593Smuzhiyun 	fsr = nor->flags & SNOR_F_USE_FSR ? spi_nor_fsr_ready(nor) : 1;
311*4882a593Smuzhiyun 	if (fsr < 0)
312*4882a593Smuzhiyun 		return fsr;
313*4882a593Smuzhiyun 	return sr && fsr;
314*4882a593Smuzhiyun }
315*4882a593Smuzhiyun 
316*4882a593Smuzhiyun /*
317*4882a593Smuzhiyun  * Service routine to read status register until ready, or timeout occurs.
318*4882a593Smuzhiyun  * Returns non-zero if error.
319*4882a593Smuzhiyun  */
spi_nor_wait_till_ready_with_timeout(struct spi_nor * nor,unsigned long timeout)320*4882a593Smuzhiyun static int spi_nor_wait_till_ready_with_timeout(struct spi_nor *nor,
321*4882a593Smuzhiyun 						unsigned long timeout)
322*4882a593Smuzhiyun {
323*4882a593Smuzhiyun 	unsigned long timebase;
324*4882a593Smuzhiyun 	int ret;
325*4882a593Smuzhiyun 
326*4882a593Smuzhiyun 	timebase = get_timer(0);
327*4882a593Smuzhiyun 
328*4882a593Smuzhiyun 	while (get_timer(timebase) < timeout) {
329*4882a593Smuzhiyun 		ret = spi_nor_ready(nor);
330*4882a593Smuzhiyun 		if (ret < 0)
331*4882a593Smuzhiyun 			return ret;
332*4882a593Smuzhiyun 		if (ret)
333*4882a593Smuzhiyun 			return 0;
334*4882a593Smuzhiyun 	}
335*4882a593Smuzhiyun 
336*4882a593Smuzhiyun 	dev_err(nor->dev, "flash operation timed out\n");
337*4882a593Smuzhiyun 
338*4882a593Smuzhiyun 	return -ETIMEDOUT;
339*4882a593Smuzhiyun }
340*4882a593Smuzhiyun 
spi_nor_wait_till_ready(struct spi_nor * nor)341*4882a593Smuzhiyun static int spi_nor_wait_till_ready(struct spi_nor *nor)
342*4882a593Smuzhiyun {
343*4882a593Smuzhiyun 	return spi_nor_wait_till_ready_with_timeout(nor,
344*4882a593Smuzhiyun 						    DEFAULT_READY_WAIT_JIFFIES);
345*4882a593Smuzhiyun }
346*4882a593Smuzhiyun #endif /* CONFIG_SPI_FLASH_SPANSION */
347*4882a593Smuzhiyun 
348*4882a593Smuzhiyun /*
349*4882a593Smuzhiyun  * Erase an address range on the nor chip.  The address range may extend
350*4882a593Smuzhiyun  * one or more erase sectors.  Return an error is there is a problem erasing.
351*4882a593Smuzhiyun  */
spi_nor_erase(struct mtd_info * mtd,struct erase_info * instr)352*4882a593Smuzhiyun static int spi_nor_erase(struct mtd_info *mtd, struct erase_info *instr)
353*4882a593Smuzhiyun {
354*4882a593Smuzhiyun 	return -ENOTSUPP;
355*4882a593Smuzhiyun }
356*4882a593Smuzhiyun 
spi_nor_read_id(struct spi_nor * nor)357*4882a593Smuzhiyun static const struct flash_info *spi_nor_read_id(struct spi_nor *nor)
358*4882a593Smuzhiyun {
359*4882a593Smuzhiyun 	int			tmp;
360*4882a593Smuzhiyun 	u8			id[SPI_NOR_MAX_ID_LEN];
361*4882a593Smuzhiyun 	const struct flash_info	*info;
362*4882a593Smuzhiyun 
363*4882a593Smuzhiyun 	tmp = spi_nor_read_reg(nor, SPINOR_OP_RDID, id, SPI_NOR_MAX_ID_LEN);
364*4882a593Smuzhiyun 	if (tmp < 0) {
365*4882a593Smuzhiyun 		dev_dbg(nor->dev, "error %d reading JEDEC ID\n", tmp);
366*4882a593Smuzhiyun 		return ERR_PTR(tmp);
367*4882a593Smuzhiyun 	}
368*4882a593Smuzhiyun 
369*4882a593Smuzhiyun 	info = spi_nor_ids;
370*4882a593Smuzhiyun 	for (; info->sector_size != 0; info++) {
371*4882a593Smuzhiyun 		if (info->id_len) {
372*4882a593Smuzhiyun 			if (!memcmp(info->id, id, info->id_len))
373*4882a593Smuzhiyun 				return info;
374*4882a593Smuzhiyun 		}
375*4882a593Smuzhiyun 	}
376*4882a593Smuzhiyun 	dev_dbg(nor->dev, "unrecognized JEDEC id bytes: %02x, %02x, %02x\n",
377*4882a593Smuzhiyun 		id[0], id[1], id[2]);
378*4882a593Smuzhiyun 	return ERR_PTR(-ENODEV);
379*4882a593Smuzhiyun }
380*4882a593Smuzhiyun 
spi_nor_read(struct mtd_info * mtd,loff_t from,size_t len,size_t * retlen,u_char * buf)381*4882a593Smuzhiyun static int spi_nor_read(struct mtd_info *mtd, loff_t from, size_t len,
382*4882a593Smuzhiyun 			size_t *retlen, u_char *buf)
383*4882a593Smuzhiyun {
384*4882a593Smuzhiyun 	struct spi_nor *nor = mtd_to_spi_nor(mtd);
385*4882a593Smuzhiyun 	int ret;
386*4882a593Smuzhiyun 
387*4882a593Smuzhiyun 	dev_dbg(nor->dev, "from 0x%08x, len %zd\n", (u32)from, len);
388*4882a593Smuzhiyun 
389*4882a593Smuzhiyun 	while (len) {
390*4882a593Smuzhiyun 		loff_t addr = from;
391*4882a593Smuzhiyun 
392*4882a593Smuzhiyun 		ret = spi_nor_read_data(nor, addr, len, buf);
393*4882a593Smuzhiyun 		if (ret == 0) {
394*4882a593Smuzhiyun 			/* We shouldn't see 0-length reads */
395*4882a593Smuzhiyun 			ret = -EIO;
396*4882a593Smuzhiyun 			goto read_err;
397*4882a593Smuzhiyun 		}
398*4882a593Smuzhiyun 		if (ret < 0)
399*4882a593Smuzhiyun 			goto read_err;
400*4882a593Smuzhiyun 
401*4882a593Smuzhiyun 		*retlen += ret;
402*4882a593Smuzhiyun 		buf += ret;
403*4882a593Smuzhiyun 		from += ret;
404*4882a593Smuzhiyun 		len -= ret;
405*4882a593Smuzhiyun 	}
406*4882a593Smuzhiyun 	ret = 0;
407*4882a593Smuzhiyun 
408*4882a593Smuzhiyun read_err:
409*4882a593Smuzhiyun 	return ret;
410*4882a593Smuzhiyun }
411*4882a593Smuzhiyun 
412*4882a593Smuzhiyun /*
413*4882a593Smuzhiyun  * Write an address range to the nor chip.  Data must be written in
414*4882a593Smuzhiyun  * FLASH_PAGESIZE chunks.  The address range may be any size provided
415*4882a593Smuzhiyun  * it is within the physical boundaries.
416*4882a593Smuzhiyun  */
spi_nor_write(struct mtd_info * mtd,loff_t to,size_t len,size_t * retlen,const u_char * buf)417*4882a593Smuzhiyun static int spi_nor_write(struct mtd_info *mtd, loff_t to, size_t len,
418*4882a593Smuzhiyun 			 size_t *retlen, const u_char *buf)
419*4882a593Smuzhiyun {
420*4882a593Smuzhiyun 	return -ENOTSUPP;
421*4882a593Smuzhiyun }
422*4882a593Smuzhiyun 
423*4882a593Smuzhiyun #ifdef CONFIG_SPI_FLASH_MACRONIX
424*4882a593Smuzhiyun /**
425*4882a593Smuzhiyun  * macronix_quad_enable() - set QE bit in Status Register.
426*4882a593Smuzhiyun  * @nor:	pointer to a 'struct spi_nor'
427*4882a593Smuzhiyun  *
428*4882a593Smuzhiyun  * Set the Quad Enable (QE) bit in the Status Register.
429*4882a593Smuzhiyun  *
430*4882a593Smuzhiyun  * bit 6 of the Status Register is the QE bit for Macronix like QSPI memories.
431*4882a593Smuzhiyun  *
432*4882a593Smuzhiyun  * Return: 0 on success, -errno otherwise.
433*4882a593Smuzhiyun  */
macronix_quad_enable(struct spi_nor * nor)434*4882a593Smuzhiyun static int macronix_quad_enable(struct spi_nor *nor)
435*4882a593Smuzhiyun {
436*4882a593Smuzhiyun 	int ret, val;
437*4882a593Smuzhiyun 
438*4882a593Smuzhiyun 	val = read_sr(nor);
439*4882a593Smuzhiyun 	if (val < 0)
440*4882a593Smuzhiyun 		return val;
441*4882a593Smuzhiyun 	if (val & SR_QUAD_EN_MX)
442*4882a593Smuzhiyun 		return 0;
443*4882a593Smuzhiyun 
444*4882a593Smuzhiyun 	write_enable(nor);
445*4882a593Smuzhiyun 
446*4882a593Smuzhiyun 	write_sr(nor, val | SR_QUAD_EN_MX);
447*4882a593Smuzhiyun 
448*4882a593Smuzhiyun 	ret = spi_nor_wait_till_ready(nor);
449*4882a593Smuzhiyun 	if (ret)
450*4882a593Smuzhiyun 		return ret;
451*4882a593Smuzhiyun 
452*4882a593Smuzhiyun 	ret = read_sr(nor);
453*4882a593Smuzhiyun 	if (!(ret > 0 && (ret & SR_QUAD_EN_MX))) {
454*4882a593Smuzhiyun 		dev_err(nor->dev, "Macronix Quad bit not set\n");
455*4882a593Smuzhiyun 		return -EINVAL;
456*4882a593Smuzhiyun 	}
457*4882a593Smuzhiyun 
458*4882a593Smuzhiyun 	return 0;
459*4882a593Smuzhiyun }
460*4882a593Smuzhiyun #endif
461*4882a593Smuzhiyun 
462*4882a593Smuzhiyun #if defined(CONFIG_SPI_FLASH_SPANSION) || defined(CONFIG_SPI_FLASH_WINBOND)
463*4882a593Smuzhiyun /*
464*4882a593Smuzhiyun  * Write status Register and configuration register with 2 bytes
465*4882a593Smuzhiyun  * The first byte will be written to the status register, while the
466*4882a593Smuzhiyun  * second byte will be written to the configuration register.
467*4882a593Smuzhiyun  * Return negative if error occurred.
468*4882a593Smuzhiyun  */
write_sr_cr(struct spi_nor * nor,u8 * sr_cr)469*4882a593Smuzhiyun static int write_sr_cr(struct spi_nor *nor, u8 *sr_cr)
470*4882a593Smuzhiyun {
471*4882a593Smuzhiyun 	int ret;
472*4882a593Smuzhiyun 
473*4882a593Smuzhiyun 	write_enable(nor);
474*4882a593Smuzhiyun 
475*4882a593Smuzhiyun 	ret = spi_nor_write_reg(nor, SPINOR_OP_WRSR, sr_cr, 2);
476*4882a593Smuzhiyun 	if (ret < 0) {
477*4882a593Smuzhiyun 		dev_dbg(nor->dev,
478*4882a593Smuzhiyun 			"error while writing configuration register\n");
479*4882a593Smuzhiyun 		return -EINVAL;
480*4882a593Smuzhiyun 	}
481*4882a593Smuzhiyun 
482*4882a593Smuzhiyun 	ret = spi_nor_wait_till_ready(nor);
483*4882a593Smuzhiyun 	if (ret) {
484*4882a593Smuzhiyun 		dev_dbg(nor->dev,
485*4882a593Smuzhiyun 			"timeout while writing configuration register\n");
486*4882a593Smuzhiyun 		return ret;
487*4882a593Smuzhiyun 	}
488*4882a593Smuzhiyun 
489*4882a593Smuzhiyun 	return 0;
490*4882a593Smuzhiyun }
491*4882a593Smuzhiyun 
492*4882a593Smuzhiyun /**
493*4882a593Smuzhiyun  * spansion_read_cr_quad_enable() - set QE bit in Configuration Register.
494*4882a593Smuzhiyun  * @nor:	pointer to a 'struct spi_nor'
495*4882a593Smuzhiyun  *
496*4882a593Smuzhiyun  * Set the Quad Enable (QE) bit in the Configuration Register.
497*4882a593Smuzhiyun  * This function should be used with QSPI memories supporting the Read
498*4882a593Smuzhiyun  * Configuration Register (35h) instruction.
499*4882a593Smuzhiyun  *
500*4882a593Smuzhiyun  * bit 1 of the Configuration Register is the QE bit for Spansion like QSPI
501*4882a593Smuzhiyun  * memories.
502*4882a593Smuzhiyun  *
503*4882a593Smuzhiyun  * Return: 0 on success, -errno otherwise.
504*4882a593Smuzhiyun  */
spansion_read_cr_quad_enable(struct spi_nor * nor)505*4882a593Smuzhiyun static int spansion_read_cr_quad_enable(struct spi_nor *nor)
506*4882a593Smuzhiyun {
507*4882a593Smuzhiyun 	u8 sr_cr[2];
508*4882a593Smuzhiyun 	int ret;
509*4882a593Smuzhiyun 
510*4882a593Smuzhiyun 	/* Check current Quad Enable bit value. */
511*4882a593Smuzhiyun 	ret = read_cr(nor);
512*4882a593Smuzhiyun 	if (ret < 0) {
513*4882a593Smuzhiyun 		dev_dbg(dev, "error while reading configuration register\n");
514*4882a593Smuzhiyun 		return -EINVAL;
515*4882a593Smuzhiyun 	}
516*4882a593Smuzhiyun 
517*4882a593Smuzhiyun 	if (ret & CR_QUAD_EN_SPAN)
518*4882a593Smuzhiyun 		return 0;
519*4882a593Smuzhiyun 
520*4882a593Smuzhiyun 	sr_cr[1] = ret | CR_QUAD_EN_SPAN;
521*4882a593Smuzhiyun 
522*4882a593Smuzhiyun 	/* Keep the current value of the Status Register. */
523*4882a593Smuzhiyun 	ret = read_sr(nor);
524*4882a593Smuzhiyun 	if (ret < 0) {
525*4882a593Smuzhiyun 		dev_dbg(dev, "error while reading status register\n");
526*4882a593Smuzhiyun 		return -EINVAL;
527*4882a593Smuzhiyun 	}
528*4882a593Smuzhiyun 	sr_cr[0] = ret;
529*4882a593Smuzhiyun 
530*4882a593Smuzhiyun 	ret = write_sr_cr(nor, sr_cr);
531*4882a593Smuzhiyun 	if (ret)
532*4882a593Smuzhiyun 		return ret;
533*4882a593Smuzhiyun 
534*4882a593Smuzhiyun 	/* Read back and check it. */
535*4882a593Smuzhiyun 	ret = read_cr(nor);
536*4882a593Smuzhiyun 	if (!(ret > 0 && (ret & CR_QUAD_EN_SPAN))) {
537*4882a593Smuzhiyun 		dev_dbg(nor->dev, "Spansion Quad bit not set\n");
538*4882a593Smuzhiyun 		return -EINVAL;
539*4882a593Smuzhiyun 	}
540*4882a593Smuzhiyun 
541*4882a593Smuzhiyun 	return 0;
542*4882a593Smuzhiyun }
543*4882a593Smuzhiyun #endif /* CONFIG_SPI_FLASH_SPANSION */
544*4882a593Smuzhiyun 
545*4882a593Smuzhiyun struct spi_nor_read_command {
546*4882a593Smuzhiyun 	u8			num_mode_clocks;
547*4882a593Smuzhiyun 	u8			num_wait_states;
548*4882a593Smuzhiyun 	u8			opcode;
549*4882a593Smuzhiyun 	enum spi_nor_protocol	proto;
550*4882a593Smuzhiyun };
551*4882a593Smuzhiyun 
552*4882a593Smuzhiyun enum spi_nor_read_command_index {
553*4882a593Smuzhiyun 	SNOR_CMD_READ,
554*4882a593Smuzhiyun 	SNOR_CMD_READ_FAST,
555*4882a593Smuzhiyun 
556*4882a593Smuzhiyun 	/* Quad SPI */
557*4882a593Smuzhiyun 	SNOR_CMD_READ_1_1_4,
558*4882a593Smuzhiyun 
559*4882a593Smuzhiyun 	SNOR_CMD_READ_MAX
560*4882a593Smuzhiyun };
561*4882a593Smuzhiyun 
562*4882a593Smuzhiyun struct spi_nor_flash_parameter {
563*4882a593Smuzhiyun 	struct spi_nor_hwcaps		hwcaps;
564*4882a593Smuzhiyun 	struct spi_nor_read_command	reads[SNOR_CMD_READ_MAX];
565*4882a593Smuzhiyun };
566*4882a593Smuzhiyun 
567*4882a593Smuzhiyun static void
spi_nor_set_read_settings(struct spi_nor_read_command * read,u8 num_mode_clocks,u8 num_wait_states,u8 opcode,enum spi_nor_protocol proto)568*4882a593Smuzhiyun spi_nor_set_read_settings(struct spi_nor_read_command *read,
569*4882a593Smuzhiyun 			  u8 num_mode_clocks,
570*4882a593Smuzhiyun 			  u8 num_wait_states,
571*4882a593Smuzhiyun 			  u8 opcode,
572*4882a593Smuzhiyun 			  enum spi_nor_protocol proto)
573*4882a593Smuzhiyun {
574*4882a593Smuzhiyun 	read->num_mode_clocks = num_mode_clocks;
575*4882a593Smuzhiyun 	read->num_wait_states = num_wait_states;
576*4882a593Smuzhiyun 	read->opcode = opcode;
577*4882a593Smuzhiyun 	read->proto = proto;
578*4882a593Smuzhiyun }
579*4882a593Smuzhiyun 
spi_nor_init_params(struct spi_nor * nor,const struct flash_info * info,struct spi_nor_flash_parameter * params)580*4882a593Smuzhiyun static int spi_nor_init_params(struct spi_nor *nor,
581*4882a593Smuzhiyun 			       const struct flash_info *info,
582*4882a593Smuzhiyun 			       struct spi_nor_flash_parameter *params)
583*4882a593Smuzhiyun {
584*4882a593Smuzhiyun 	/* (Fast) Read settings. */
585*4882a593Smuzhiyun 	params->hwcaps.mask = SNOR_HWCAPS_READ;
586*4882a593Smuzhiyun 	spi_nor_set_read_settings(&params->reads[SNOR_CMD_READ],
587*4882a593Smuzhiyun 				  0, 0, SPINOR_OP_READ,
588*4882a593Smuzhiyun 				  SNOR_PROTO_1_1_1);
589*4882a593Smuzhiyun 
590*4882a593Smuzhiyun 	if (!(info->flags & SPI_NOR_NO_FR)) {
591*4882a593Smuzhiyun 		params->hwcaps.mask |= SNOR_HWCAPS_READ_FAST;
592*4882a593Smuzhiyun 		spi_nor_set_read_settings(&params->reads[SNOR_CMD_READ_FAST],
593*4882a593Smuzhiyun 					  0, 8, SPINOR_OP_READ_FAST,
594*4882a593Smuzhiyun 					  SNOR_PROTO_1_1_1);
595*4882a593Smuzhiyun 	}
596*4882a593Smuzhiyun 
597*4882a593Smuzhiyun 	if (info->flags & SPI_NOR_QUAD_READ) {
598*4882a593Smuzhiyun 		params->hwcaps.mask |= SNOR_HWCAPS_READ_1_1_4;
599*4882a593Smuzhiyun 		spi_nor_set_read_settings(&params->reads[SNOR_CMD_READ_1_1_4],
600*4882a593Smuzhiyun 					  0, 8, SPINOR_OP_READ_1_1_4,
601*4882a593Smuzhiyun 					  SNOR_PROTO_1_1_4);
602*4882a593Smuzhiyun 	}
603*4882a593Smuzhiyun 
604*4882a593Smuzhiyun 	return 0;
605*4882a593Smuzhiyun }
606*4882a593Smuzhiyun 
spi_nor_select_read(struct spi_nor * nor,const struct spi_nor_flash_parameter * params,u32 shared_hwcaps)607*4882a593Smuzhiyun static int spi_nor_select_read(struct spi_nor *nor,
608*4882a593Smuzhiyun 			       const struct spi_nor_flash_parameter *params,
609*4882a593Smuzhiyun 			       u32 shared_hwcaps)
610*4882a593Smuzhiyun {
611*4882a593Smuzhiyun 	int best_match = shared_hwcaps & SNOR_HWCAPS_READ_MASK;
612*4882a593Smuzhiyun 	int cmd;
613*4882a593Smuzhiyun 	const struct spi_nor_read_command *read;
614*4882a593Smuzhiyun 
615*4882a593Smuzhiyun 	if (best_match < 0)
616*4882a593Smuzhiyun 		return -EINVAL;
617*4882a593Smuzhiyun 
618*4882a593Smuzhiyun 	if (best_match & SNOR_HWCAPS_READ_1_1_4)
619*4882a593Smuzhiyun 		cmd = SNOR_CMD_READ_1_1_4;
620*4882a593Smuzhiyun 	else if (best_match & SNOR_HWCAPS_READ_FAST)
621*4882a593Smuzhiyun 		cmd = SNOR_CMD_READ_FAST;
622*4882a593Smuzhiyun 	else
623*4882a593Smuzhiyun 		cmd = SNOR_CMD_READ;
624*4882a593Smuzhiyun 
625*4882a593Smuzhiyun 	read = &params->reads[cmd];
626*4882a593Smuzhiyun 	nor->read_opcode = read->opcode;
627*4882a593Smuzhiyun 	nor->read_proto = read->proto;
628*4882a593Smuzhiyun 
629*4882a593Smuzhiyun 	/*
630*4882a593Smuzhiyun 	 * In the spi-nor framework, we don't need to make the difference
631*4882a593Smuzhiyun 	 * between mode clock cycles and wait state clock cycles.
632*4882a593Smuzhiyun 	 * Indeed, the value of the mode clock cycles is used by a QSPI
633*4882a593Smuzhiyun 	 * flash memory to know whether it should enter or leave its 0-4-4
634*4882a593Smuzhiyun 	 * (Continuous Read / XIP) mode.
635*4882a593Smuzhiyun 	 * eXecution In Place is out of the scope of the mtd sub-system.
636*4882a593Smuzhiyun 	 * Hence we choose to merge both mode and wait state clock cycles
637*4882a593Smuzhiyun 	 * into the so called dummy clock cycles.
638*4882a593Smuzhiyun 	 */
639*4882a593Smuzhiyun 	nor->read_dummy = read->num_mode_clocks + read->num_wait_states;
640*4882a593Smuzhiyun 	return 0;
641*4882a593Smuzhiyun }
642*4882a593Smuzhiyun 
spi_nor_setup(struct spi_nor * nor,const struct flash_info * info,const struct spi_nor_flash_parameter * params,const struct spi_nor_hwcaps * hwcaps)643*4882a593Smuzhiyun static int spi_nor_setup(struct spi_nor *nor, const struct flash_info *info,
644*4882a593Smuzhiyun 			 const struct spi_nor_flash_parameter *params,
645*4882a593Smuzhiyun 			 const struct spi_nor_hwcaps *hwcaps)
646*4882a593Smuzhiyun {
647*4882a593Smuzhiyun 	u32 shared_mask;
648*4882a593Smuzhiyun 	int err;
649*4882a593Smuzhiyun 
650*4882a593Smuzhiyun 	/*
651*4882a593Smuzhiyun 	 * Keep only the hardware capabilities supported by both the SPI
652*4882a593Smuzhiyun 	 * controller and the SPI flash memory.
653*4882a593Smuzhiyun 	 */
654*4882a593Smuzhiyun 	shared_mask = hwcaps->mask & params->hwcaps.mask;
655*4882a593Smuzhiyun 
656*4882a593Smuzhiyun 	/* Select the (Fast) Read command. */
657*4882a593Smuzhiyun 	err = spi_nor_select_read(nor, params, shared_mask);
658*4882a593Smuzhiyun 	if (err) {
659*4882a593Smuzhiyun 		dev_dbg(nor->dev,
660*4882a593Smuzhiyun 			"can't select read settings supported by both the SPI controller and memory.\n");
661*4882a593Smuzhiyun 		return err;
662*4882a593Smuzhiyun 	}
663*4882a593Smuzhiyun 
664*4882a593Smuzhiyun 	/* Enable Quad I/O if needed. */
665*4882a593Smuzhiyun 	if (spi_nor_get_protocol_width(nor->read_proto) == 4) {
666*4882a593Smuzhiyun 		switch (JEDEC_MFR(info)) {
667*4882a593Smuzhiyun #ifdef CONFIG_SPI_FLASH_MACRONIX
668*4882a593Smuzhiyun 		case SNOR_MFR_MACRONIX:
669*4882a593Smuzhiyun 			err = macronix_quad_enable(nor);
670*4882a593Smuzhiyun 			break;
671*4882a593Smuzhiyun #endif
672*4882a593Smuzhiyun 		case SNOR_MFR_ST:
673*4882a593Smuzhiyun 		case SNOR_MFR_MICRON:
674*4882a593Smuzhiyun 			break;
675*4882a593Smuzhiyun 
676*4882a593Smuzhiyun 		default:
677*4882a593Smuzhiyun #if defined(CONFIG_SPI_FLASH_SPANSION) || defined(CONFIG_SPI_FLASH_WINBOND)
678*4882a593Smuzhiyun 			/* Kept only for backward compatibility purpose. */
679*4882a593Smuzhiyun 			err = spansion_read_cr_quad_enable(nor);
680*4882a593Smuzhiyun #endif
681*4882a593Smuzhiyun 			break;
682*4882a593Smuzhiyun 		}
683*4882a593Smuzhiyun 	}
684*4882a593Smuzhiyun 	if (err) {
685*4882a593Smuzhiyun 		dev_dbg(nor->dev, "quad mode not supported\n");
686*4882a593Smuzhiyun 		return err;
687*4882a593Smuzhiyun 	}
688*4882a593Smuzhiyun 
689*4882a593Smuzhiyun 	return 0;
690*4882a593Smuzhiyun }
691*4882a593Smuzhiyun 
spi_nor_init(struct spi_nor * nor)692*4882a593Smuzhiyun static int spi_nor_init(struct spi_nor *nor)
693*4882a593Smuzhiyun {
694*4882a593Smuzhiyun 	if (nor->addr_width == 4 &&
695*4882a593Smuzhiyun 	    (JEDEC_MFR(nor->info) != SNOR_MFR_SPANSION) &&
696*4882a593Smuzhiyun 	    !(nor->info->flags & SPI_NOR_4B_OPCODES)) {
697*4882a593Smuzhiyun 		/*
698*4882a593Smuzhiyun 		 * If the RESET# pin isn't hooked up properly, or the system
699*4882a593Smuzhiyun 		 * otherwise doesn't perform a reset command in the boot
700*4882a593Smuzhiyun 		 * sequence, it's impossible to 100% protect against unexpected
701*4882a593Smuzhiyun 		 * reboots (e.g., crashes). Warn the user (or hopefully, system
702*4882a593Smuzhiyun 		 * designer) that this is bad.
703*4882a593Smuzhiyun 		 */
704*4882a593Smuzhiyun 		if (nor->flags & SNOR_F_BROKEN_RESET)
705*4882a593Smuzhiyun 			printf("enabling reset hack; may not recover from unexpected reboots\n");
706*4882a593Smuzhiyun 		set_4byte(nor, nor->info, 1);
707*4882a593Smuzhiyun 	}
708*4882a593Smuzhiyun 
709*4882a593Smuzhiyun 	return 0;
710*4882a593Smuzhiyun }
711*4882a593Smuzhiyun 
spi_nor_scan(struct spi_nor * nor)712*4882a593Smuzhiyun int spi_nor_scan(struct spi_nor *nor)
713*4882a593Smuzhiyun {
714*4882a593Smuzhiyun 	struct spi_nor_flash_parameter params;
715*4882a593Smuzhiyun 	const struct flash_info *info = NULL;
716*4882a593Smuzhiyun 	struct mtd_info *mtd = &nor->mtd;
717*4882a593Smuzhiyun 	struct spi_nor_hwcaps hwcaps = {
718*4882a593Smuzhiyun 		.mask = SNOR_HWCAPS_READ |
719*4882a593Smuzhiyun 			SNOR_HWCAPS_READ_FAST
720*4882a593Smuzhiyun 	};
721*4882a593Smuzhiyun 	struct spi_slave *spi = nor->spi;
722*4882a593Smuzhiyun 	int ret;
723*4882a593Smuzhiyun 
724*4882a593Smuzhiyun 	/* Reset SPI protocol for all commands. */
725*4882a593Smuzhiyun 	nor->reg_proto = SNOR_PROTO_1_1_1;
726*4882a593Smuzhiyun 	nor->read_proto = SNOR_PROTO_1_1_1;
727*4882a593Smuzhiyun 	nor->write_proto = SNOR_PROTO_1_1_1;
728*4882a593Smuzhiyun 
729*4882a593Smuzhiyun 	if (spi->mode & SPI_RX_QUAD)
730*4882a593Smuzhiyun 		hwcaps.mask |= SNOR_HWCAPS_READ_1_1_4;
731*4882a593Smuzhiyun 
732*4882a593Smuzhiyun 	info = spi_nor_read_id(nor);
733*4882a593Smuzhiyun 	if (IS_ERR_OR_NULL(info))
734*4882a593Smuzhiyun 		return -ENOENT;
735*4882a593Smuzhiyun 	/* Parse the Serial Flash Discoverable Parameters table. */
736*4882a593Smuzhiyun 	ret = spi_nor_init_params(nor, info, &params);
737*4882a593Smuzhiyun 	if (ret)
738*4882a593Smuzhiyun 		return ret;
739*4882a593Smuzhiyun 
740*4882a593Smuzhiyun 	mtd->name = "spi-flash";
741*4882a593Smuzhiyun 	mtd->priv = nor;
742*4882a593Smuzhiyun 	mtd->type = MTD_NORFLASH;
743*4882a593Smuzhiyun 	mtd->writesize = 1;
744*4882a593Smuzhiyun 	mtd->flags = MTD_CAP_NORFLASH;
745*4882a593Smuzhiyun 	mtd->size = info->sector_size * info->n_sectors;
746*4882a593Smuzhiyun 	mtd->_erase = spi_nor_erase;
747*4882a593Smuzhiyun 	mtd->_read = spi_nor_read;
748*4882a593Smuzhiyun 	mtd->_write = spi_nor_write;
749*4882a593Smuzhiyun 
750*4882a593Smuzhiyun 	nor->size = mtd->size;
751*4882a593Smuzhiyun 
752*4882a593Smuzhiyun 	if (info->flags & USE_FSR)
753*4882a593Smuzhiyun 		nor->flags |= SNOR_F_USE_FSR;
754*4882a593Smuzhiyun 	if (info->flags & USE_CLSR)
755*4882a593Smuzhiyun 		nor->flags |= SNOR_F_USE_CLSR;
756*4882a593Smuzhiyun 
757*4882a593Smuzhiyun 	if (info->flags & SPI_NOR_NO_FR)
758*4882a593Smuzhiyun 		params.hwcaps.mask &= ~SNOR_HWCAPS_READ_FAST;
759*4882a593Smuzhiyun 
760*4882a593Smuzhiyun 	/*
761*4882a593Smuzhiyun 	 * Configure the SPI memory:
762*4882a593Smuzhiyun 	 * - select op codes for (Fast) Read, Page Program and Sector Erase.
763*4882a593Smuzhiyun 	 * - set the number of dummy cycles (mode cycles + wait states).
764*4882a593Smuzhiyun 	 * - set the SPI protocols for register and memory accesses.
765*4882a593Smuzhiyun 	 * - set the Quad Enable bit if needed (required by SPI x-y-4 protos).
766*4882a593Smuzhiyun 	 */
767*4882a593Smuzhiyun 	ret = spi_nor_setup(nor, info, &params, &hwcaps);
768*4882a593Smuzhiyun 	if (ret)
769*4882a593Smuzhiyun 		return ret;
770*4882a593Smuzhiyun 
771*4882a593Smuzhiyun 	if (nor->addr_width) {
772*4882a593Smuzhiyun 		/* already configured from SFDP */
773*4882a593Smuzhiyun 	} else if (info->addr_width) {
774*4882a593Smuzhiyun 		nor->addr_width = info->addr_width;
775*4882a593Smuzhiyun 	} else if (mtd->size > 0x1000000) {
776*4882a593Smuzhiyun 		/* enable 4-byte addressing if the device exceeds 16MiB */
777*4882a593Smuzhiyun 		nor->addr_width = 4;
778*4882a593Smuzhiyun 		if (JEDEC_MFR(info) == SNOR_MFR_SPANSION ||
779*4882a593Smuzhiyun 		    info->flags & SPI_NOR_4B_OPCODES)
780*4882a593Smuzhiyun 			spi_nor_set_4byte_opcodes(nor, info);
781*4882a593Smuzhiyun 	} else {
782*4882a593Smuzhiyun 		nor->addr_width = 3;
783*4882a593Smuzhiyun 	}
784*4882a593Smuzhiyun 
785*4882a593Smuzhiyun 	if (nor->addr_width > SPI_NOR_MAX_ADDR_WIDTH) {
786*4882a593Smuzhiyun 		dev_dbg(dev, "address width is too large: %u\n",
787*4882a593Smuzhiyun 			nor->addr_width);
788*4882a593Smuzhiyun 		return -EINVAL;
789*4882a593Smuzhiyun 	}
790*4882a593Smuzhiyun 
791*4882a593Smuzhiyun 	/* Send all the required SPI flash commands to initialize device */
792*4882a593Smuzhiyun 	nor->info = info;
793*4882a593Smuzhiyun 	ret = spi_nor_init(nor);
794*4882a593Smuzhiyun 	if (ret)
795*4882a593Smuzhiyun 		return ret;
796*4882a593Smuzhiyun 
797*4882a593Smuzhiyun 	return 0;
798*4882a593Smuzhiyun }
799*4882a593Smuzhiyun 
800*4882a593Smuzhiyun /* U-Boot specific functions, need to extend MTD to support these */
spi_flash_cmd_get_sw_write_prot(struct spi_nor * nor)801*4882a593Smuzhiyun int spi_flash_cmd_get_sw_write_prot(struct spi_nor *nor)
802*4882a593Smuzhiyun {
803*4882a593Smuzhiyun 	return -ENOTSUPP;
804*4882a593Smuzhiyun }
805