blob: 320c6a308630afb5b915771b4e7be5bc8b48f3c8 [file] [log] [blame]
Mike Lavender2f9f7622006-01-08 13:34:27 -08001/*
David Brownellfa0a8c72007-06-24 15:12:35 -07002 * MTD SPI driver for ST M25Pxx (and similar) serial flash chips
Mike Lavender2f9f7622006-01-08 13:34:27 -08003 *
4 * Author: Mike Lavender, mike@steroidmicros.com
5 *
6 * Copyright (c) 2005, Intec Automation Inc.
7 *
8 * Some parts are based on lart.c by Abraham Van Der Merwe
9 *
10 * Cleaned up and generalized based on mtd_dataflash.c
11 *
12 * This code is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License version 2 as
14 * published by the Free Software Foundation.
15 *
16 */
17
18#include <linux/init.h>
Anton Vorontsov9d2c4f32010-06-22 20:57:42 +040019#include <linux/err.h>
20#include <linux/errno.h>
Mike Lavender2f9f7622006-01-08 13:34:27 -080021#include <linux/module.h>
22#include <linux/device.h>
23#include <linux/interrupt.h>
David Brownell7d5230e2007-06-24 15:09:13 -070024#include <linux/mutex.h>
Artem Bityutskiyd85316a2008-12-18 14:10:05 +020025#include <linux/math64.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090026#include <linux/slab.h>
Alexey Dobriyand43c36d2009-10-07 17:09:06 +040027#include <linux/sched.h>
Anton Vorontsovb34bc032009-10-12 20:24:35 +040028#include <linux/mod_devicetable.h>
David Brownell7d5230e2007-06-24 15:09:13 -070029
Kevin Cernekeeaa084652011-05-08 10:48:00 -070030#include <linux/mtd/cfi.h>
Mike Lavender2f9f7622006-01-08 13:34:27 -080031#include <linux/mtd/mtd.h>
32#include <linux/mtd/partitions.h>
Shaohui Xie5f949132011-10-14 15:49:00 +080033#include <linux/of_platform.h>
David Brownell7d5230e2007-06-24 15:09:13 -070034
Mike Lavender2f9f7622006-01-08 13:34:27 -080035#include <linux/spi/spi.h>
36#include <linux/spi/flash.h>
37
Mike Lavender2f9f7622006-01-08 13:34:27 -080038/* Flash opcodes. */
David Brownellfa0a8c72007-06-24 15:12:35 -070039#define OPCODE_WREN 0x06 /* Write enable */
40#define OPCODE_RDSR 0x05 /* Read status register */
Michael Hennerich72289822008-07-03 23:54:42 -070041#define OPCODE_WRSR 0x01 /* Write status register 1 byte */
Bryan Wu2230b762008-04-25 12:07:32 +080042#define OPCODE_NORM_READ 0x03 /* Read data bytes (low frequency) */
David Brownellfa0a8c72007-06-24 15:12:35 -070043#define OPCODE_FAST_READ 0x0b /* Read data bytes (high frequency) */
Sourav Poddar3487a6392013-11-06 20:05:35 +053044#define OPCODE_QUAD_READ 0x6b /* Read data bytes */
David Brownellfa0a8c72007-06-24 15:12:35 -070045#define OPCODE_PP 0x02 /* Page program (up to 256 bytes) */
Chen Gong78546432008-11-26 10:23:57 +000046#define OPCODE_BE_4K 0x20 /* Erase 4KiB block */
Michel Stempin6c3b8892013-07-15 12:13:56 +020047#define OPCODE_BE_4K_PMC 0xd7 /* Erase 4KiB block on PMC chips */
David Woodhouse02d087d2007-06-28 22:38:38 +010048#define OPCODE_BE_32K 0x52 /* Erase 32KiB block */
Chen Gong78546432008-11-26 10:23:57 +000049#define OPCODE_CHIP_ERASE 0xc7 /* Erase whole flash chip */
David Woodhouse02d087d2007-06-28 22:38:38 +010050#define OPCODE_SE 0xd8 /* Sector erase (usually 64KiB) */
Mike Lavender2f9f7622006-01-08 13:34:27 -080051#define OPCODE_RDID 0x9f /* Read JEDEC ID */
Sourav Poddar3487a6392013-11-06 20:05:35 +053052#define OPCODE_RDCR 0x35 /* Read configuration register */
Mike Lavender2f9f7622006-01-08 13:34:27 -080053
Brian Norris87c95112013-04-11 01:34:57 -070054/* 4-byte address opcodes - used on Spansion and some Macronix flashes. */
55#define OPCODE_NORM_READ_4B 0x13 /* Read data bytes (low frequency) */
56#define OPCODE_FAST_READ_4B 0x0c /* Read data bytes (high frequency) */
Sourav Poddar3487a6392013-11-06 20:05:35 +053057#define OPCODE_QUAD_READ_4B 0x6c /* Read data bytes */
Brian Norris87c95112013-04-11 01:34:57 -070058#define OPCODE_PP_4B 0x12 /* Page program (up to 256 bytes) */
59#define OPCODE_SE_4B 0xdc /* Sector erase (usually 64KiB) */
60
Graf Yang49aac4a2009-06-15 08:23:41 +000061/* Used for SST flashes only. */
62#define OPCODE_BP 0x02 /* Byte program */
63#define OPCODE_WRDI 0x04 /* Write disable */
64#define OPCODE_AAI_WP 0xad /* Auto address increment word program */
65
Brian Norriscaddab02013-04-11 01:34:58 -070066/* Used for Macronix and Winbond flashes. */
Kevin Cernekee4b7f7422010-10-30 21:11:03 -070067#define OPCODE_EN4B 0xb7 /* Enter 4-byte mode */
68#define OPCODE_EX4B 0xe9 /* Exit 4-byte mode */
69
Kevin Cernekeebaa9ae32011-05-08 10:48:01 -070070/* Used for Spansion flashes only. */
71#define OPCODE_BRWR 0x17 /* Bank register write */
72
Mike Lavender2f9f7622006-01-08 13:34:27 -080073/* Status Register bits. */
74#define SR_WIP 1 /* Write in progress */
75#define SR_WEL 2 /* Write enable latch */
David Brownellfa0a8c72007-06-24 15:12:35 -070076/* meaning of other SR_* bits may differ between vendors */
Mike Lavender2f9f7622006-01-08 13:34:27 -080077#define SR_BP0 4 /* Block protect 0 */
78#define SR_BP1 8 /* Block protect 1 */
79#define SR_BP2 0x10 /* Block protect 2 */
80#define SR_SRWD 0x80 /* SR write protect */
81
Sourav Poddar3487a6392013-11-06 20:05:35 +053082#define SR_QUAD_EN_MX 0x40 /* Macronix Quad I/O */
83
84/* Configuration Register bits. */
85#define CR_QUAD_EN_SPAN 0x2 /* Spansion Quad I/O */
86
Mike Lavender2f9f7622006-01-08 13:34:27 -080087/* Define max times to check status register before we give up. */
Steven A. Falco89bb8712009-06-26 12:42:47 -040088#define MAX_READY_WAIT_JIFFIES (40 * HZ) /* M25P16 specs 40s max chip erase */
Brian Norris778d2262013-07-24 18:32:07 -070089#define MAX_CMD_SIZE 6
Mike Lavender2f9f7622006-01-08 13:34:27 -080090
Kevin Cernekeeaa084652011-05-08 10:48:00 -070091#define JEDEC_MFR(_jedec_id) ((_jedec_id) >> 16)
92
Mike Lavender2f9f7622006-01-08 13:34:27 -080093/****************************************************************************/
94
Sourav Poddar8552b432013-11-06 20:05:34 +053095enum read_type {
96 M25P80_NORMAL = 0,
97 M25P80_FAST,
Sourav Poddar3487a6392013-11-06 20:05:35 +053098 M25P80_QUAD,
Sourav Poddar8552b432013-11-06 20:05:34 +053099};
100
Mike Lavender2f9f7622006-01-08 13:34:27 -0800101struct m25p {
102 struct spi_device *spi;
David Brownell7d5230e2007-06-24 15:09:13 -0700103 struct mutex lock;
Mike Lavender2f9f7622006-01-08 13:34:27 -0800104 struct mtd_info mtd;
Anton Vorontsov837479d2009-10-12 20:24:40 +0400105 u16 page_size;
106 u16 addr_width;
David Brownellfa0a8c72007-06-24 15:12:35 -0700107 u8 erase_opcode;
Brian Norris87c95112013-04-11 01:34:57 -0700108 u8 read_opcode;
109 u8 program_opcode;
Johannes Stezenbach61c35062009-10-28 14:21:37 +0100110 u8 *command;
Sourav Poddar8552b432013-11-06 20:05:34 +0530111 enum read_type flash_read;
Mike Lavender2f9f7622006-01-08 13:34:27 -0800112};
113
114static inline struct m25p *mtd_to_m25p(struct mtd_info *mtd)
115{
116 return container_of(mtd, struct m25p, mtd);
117}
118
119/****************************************************************************/
120
121/*
122 * Internal helper functions
123 */
124
125/*
126 * Read the status register, returning its value in the location
127 * Return the status register value.
128 * Returns negative if error occurred.
129 */
130static int read_sr(struct m25p *flash)
131{
132 ssize_t retval;
133 u8 code = OPCODE_RDSR;
134 u8 val;
135
136 retval = spi_write_then_read(flash->spi, &code, 1, &val, 1);
137
138 if (retval < 0) {
139 dev_err(&flash->spi->dev, "error %d reading SR\n",
140 (int) retval);
141 return retval;
142 }
143
144 return val;
145}
146
Michael Hennerich72289822008-07-03 23:54:42 -0700147/*
Sourav Poddar3487a6392013-11-06 20:05:35 +0530148 * Read configuration register, returning its value in the
149 * location. Return the configuration register value.
150 * Returns negative if error occured.
151 */
152static int read_cr(struct m25p *flash)
153{
154 u8 code = OPCODE_RDCR;
155 int ret;
156 u8 val;
157
158 ret = spi_write_then_read(flash->spi, &code, 1, &val, 1);
159 if (ret < 0) {
160 dev_err(&flash->spi->dev, "error %d reading CR\n", ret);
161 return ret;
162 }
163
164 return val;
165}
166
167/*
Michael Hennerich72289822008-07-03 23:54:42 -0700168 * Write status register 1 byte
169 * Returns negative if error occurred.
170 */
171static int write_sr(struct m25p *flash, u8 val)
172{
173 flash->command[0] = OPCODE_WRSR;
174 flash->command[1] = val;
175
176 return spi_write(flash->spi, flash->command, 2);
177}
Mike Lavender2f9f7622006-01-08 13:34:27 -0800178
179/*
180 * Set write enable latch with Write Enable command.
181 * Returns negative if error occurred.
182 */
183static inline int write_enable(struct m25p *flash)
184{
185 u8 code = OPCODE_WREN;
186
David Woodhouse8a1a6272008-10-20 09:26:16 +0100187 return spi_write_then_read(flash->spi, &code, 1, NULL, 0);
Mike Lavender2f9f7622006-01-08 13:34:27 -0800188}
189
Graf Yang49aac4a2009-06-15 08:23:41 +0000190/*
191 * Send write disble instruction to the chip.
192 */
193static inline int write_disable(struct m25p *flash)
194{
195 u8 code = OPCODE_WRDI;
196
197 return spi_write_then_read(flash->spi, &code, 1, NULL, 0);
198}
Mike Lavender2f9f7622006-01-08 13:34:27 -0800199
200/*
Kevin Cernekee4b7f7422010-10-30 21:11:03 -0700201 * Enable/disable 4-byte addressing mode.
202 */
Kevin Cernekeebaa9ae32011-05-08 10:48:01 -0700203static inline int set_4byte(struct m25p *flash, u32 jedec_id, int enable)
Kevin Cernekee4b7f7422010-10-30 21:11:03 -0700204{
Elie De Brauwer2b468ef2013-09-17 19:48:22 +0200205 int status;
206 bool need_wren = false;
207
Kevin Cernekeebaa9ae32011-05-08 10:48:01 -0700208 switch (JEDEC_MFR(jedec_id)) {
Brian Norriseedeac32013-08-17 12:16:29 -0700209 case CFI_MFR_ST: /* Micron, actually */
Elie De Brauwer2b468ef2013-09-17 19:48:22 +0200210 /* Some Micron need WREN command; all will accept it */
211 need_wren = true;
212 case CFI_MFR_MACRONIX:
Matthieu CASTET0aa87b72012-09-25 11:05:27 +0200213 case 0xEF /* winbond */:
Elie De Brauwer2b468ef2013-09-17 19:48:22 +0200214 if (need_wren)
215 write_enable(flash);
216
Kevin Cernekeebaa9ae32011-05-08 10:48:01 -0700217 flash->command[0] = enable ? OPCODE_EN4B : OPCODE_EX4B;
Elie De Brauwer2b468ef2013-09-17 19:48:22 +0200218 status = spi_write(flash->spi, flash->command, 1);
219
220 if (need_wren)
221 write_disable(flash);
222
223 return status;
Kevin Cernekeebaa9ae32011-05-08 10:48:01 -0700224 default:
225 /* Spansion style */
226 flash->command[0] = OPCODE_BRWR;
227 flash->command[1] = enable << 7;
228 return spi_write(flash->spi, flash->command, 2);
229 }
Kevin Cernekee4b7f7422010-10-30 21:11:03 -0700230}
231
232/*
Mike Lavender2f9f7622006-01-08 13:34:27 -0800233 * Service routine to read status register until ready, or timeout occurs.
234 * Returns non-zero if error.
235 */
236static int wait_till_ready(struct m25p *flash)
237{
Peter Hortoncd1a6de2009-05-08 13:51:53 +0100238 unsigned long deadline;
Mike Lavender2f9f7622006-01-08 13:34:27 -0800239 int sr;
240
Peter Hortoncd1a6de2009-05-08 13:51:53 +0100241 deadline = jiffies + MAX_READY_WAIT_JIFFIES;
242
243 do {
Mike Lavender2f9f7622006-01-08 13:34:27 -0800244 if ((sr = read_sr(flash)) < 0)
245 break;
246 else if (!(sr & SR_WIP))
247 return 0;
248
Peter Hortoncd1a6de2009-05-08 13:51:53 +0100249 cond_resched();
250
251 } while (!time_after_eq(jiffies, deadline));
Mike Lavender2f9f7622006-01-08 13:34:27 -0800252
253 return 1;
254}
255
Chen Gongfaff3752008-08-11 16:59:13 +0800256/*
Sourav Poddar3487a6392013-11-06 20:05:35 +0530257 * Write status Register and configuration register with 2 bytes
258 * The first byte will be written to the status register, while the
259 * second byte will be written to the configuration register.
260 * Return negative if error occured.
261 */
262static int write_sr_cr(struct m25p *flash, u16 val)
263{
264 flash->command[0] = OPCODE_WRSR;
265 flash->command[1] = val & 0xff;
266 flash->command[2] = (val >> 8);
267
268 return spi_write(flash->spi, flash->command, 3);
269}
270
271static int macronix_quad_enable(struct m25p *flash)
272{
273 int ret, val;
274 u8 cmd[2];
275 cmd[0] = OPCODE_WRSR;
276
277 val = read_sr(flash);
278 cmd[1] = val | SR_QUAD_EN_MX;
279 write_enable(flash);
280
281 spi_write(flash->spi, &cmd, 2);
282
283 if (wait_till_ready(flash))
284 return 1;
285
286 ret = read_sr(flash);
287 if (!(ret > 0 && (ret & SR_QUAD_EN_MX))) {
288 dev_err(&flash->spi->dev, "Macronix Quad bit not set\n");
289 return -EINVAL;
290 }
291
292 return 0;
293}
294
295static int spansion_quad_enable(struct m25p *flash)
296{
297 int ret;
298 int quad_en = CR_QUAD_EN_SPAN << 8;
299
300 write_enable(flash);
301
302 ret = write_sr_cr(flash, quad_en);
303 if (ret < 0) {
304 dev_err(&flash->spi->dev,
305 "error while writing configuration register\n");
306 return -EINVAL;
307 }
308
309 /* read back and check it */
310 ret = read_cr(flash);
311 if (!(ret > 0 && (ret & CR_QUAD_EN_SPAN))) {
312 dev_err(&flash->spi->dev, "Spansion Quad bit not set\n");
313 return -EINVAL;
314 }
315
316 return 0;
317}
318
319static int set_quad_mode(struct m25p *flash, u32 jedec_id)
320{
321 int status;
322
323 switch (JEDEC_MFR(jedec_id)) {
324 case CFI_MFR_MACRONIX:
325 status = macronix_quad_enable(flash);
326 if (status) {
327 dev_err(&flash->spi->dev,
328 "Macronix quad-read not enabled\n");
329 return -EINVAL;
330 }
331 return status;
332 default:
333 status = spansion_quad_enable(flash);
334 if (status) {
335 dev_err(&flash->spi->dev,
336 "Spansion quad-read not enabled\n");
337 return -EINVAL;
338 }
339 return status;
340 }
341}
342
343/*
Chen Gongfaff3752008-08-11 16:59:13 +0800344 * Erase the whole flash memory
345 *
346 * Returns 0 if successful, non-zero otherwise.
347 */
Chen Gong78546432008-11-26 10:23:57 +0000348static int erase_chip(struct m25p *flash)
Chen Gongfaff3752008-08-11 16:59:13 +0800349{
Brian Norris0a32a102011-07-19 10:06:10 -0700350 pr_debug("%s: %s %lldKiB\n", dev_name(&flash->spi->dev), __func__,
351 (long long)(flash->mtd.size >> 10));
Chen Gongfaff3752008-08-11 16:59:13 +0800352
353 /* Wait until finished previous write command. */
354 if (wait_till_ready(flash))
355 return 1;
356
357 /* Send write enable, then erase commands. */
358 write_enable(flash);
359
360 /* Set up command buffer. */
Chen Gong78546432008-11-26 10:23:57 +0000361 flash->command[0] = OPCODE_CHIP_ERASE;
Chen Gongfaff3752008-08-11 16:59:13 +0800362
363 spi_write(flash->spi, flash->command, 1);
364
365 return 0;
366}
Mike Lavender2f9f7622006-01-08 13:34:27 -0800367
Anton Vorontsov837479d2009-10-12 20:24:40 +0400368static void m25p_addr2cmd(struct m25p *flash, unsigned int addr, u8 *cmd)
369{
370 /* opcode is in cmd[0] */
371 cmd[1] = addr >> (flash->addr_width * 8 - 8);
372 cmd[2] = addr >> (flash->addr_width * 8 - 16);
373 cmd[3] = addr >> (flash->addr_width * 8 - 24);
Kevin Cernekee4b7f7422010-10-30 21:11:03 -0700374 cmd[4] = addr >> (flash->addr_width * 8 - 32);
Anton Vorontsov837479d2009-10-12 20:24:40 +0400375}
376
377static int m25p_cmdsz(struct m25p *flash)
378{
379 return 1 + flash->addr_width;
380}
381
Mike Lavender2f9f7622006-01-08 13:34:27 -0800382/*
383 * Erase one sector of flash memory at offset ``offset'' which is any
384 * address within the sector which should be erased.
385 *
386 * Returns 0 if successful, non-zero otherwise.
387 */
388static int erase_sector(struct m25p *flash, u32 offset)
389{
Brian Norris0a32a102011-07-19 10:06:10 -0700390 pr_debug("%s: %s %dKiB at 0x%08x\n", dev_name(&flash->spi->dev),
391 __func__, flash->mtd.erasesize / 1024, offset);
Mike Lavender2f9f7622006-01-08 13:34:27 -0800392
393 /* Wait until finished previous write command. */
394 if (wait_till_ready(flash))
395 return 1;
396
397 /* Send write enable, then erase commands. */
398 write_enable(flash);
399
400 /* Set up command buffer. */
David Brownellfa0a8c72007-06-24 15:12:35 -0700401 flash->command[0] = flash->erase_opcode;
Anton Vorontsov837479d2009-10-12 20:24:40 +0400402 m25p_addr2cmd(flash, offset, flash->command);
Mike Lavender2f9f7622006-01-08 13:34:27 -0800403
Anton Vorontsov837479d2009-10-12 20:24:40 +0400404 spi_write(flash->spi, flash->command, m25p_cmdsz(flash));
Mike Lavender2f9f7622006-01-08 13:34:27 -0800405
406 return 0;
407}
408
409/****************************************************************************/
410
411/*
412 * MTD implementation
413 */
414
415/*
416 * Erase an address range on the flash chip. The address range may extend
417 * one or more erase sectors. Return an error is there is a problem erasing.
418 */
419static int m25p80_erase(struct mtd_info *mtd, struct erase_info *instr)
420{
421 struct m25p *flash = mtd_to_m25p(mtd);
422 u32 addr,len;
Artem Bityutskiyd85316a2008-12-18 14:10:05 +0200423 uint32_t rem;
Mike Lavender2f9f7622006-01-08 13:34:27 -0800424
Brian Norris0a32a102011-07-19 10:06:10 -0700425 pr_debug("%s: %s at 0x%llx, len %lld\n", dev_name(&flash->spi->dev),
426 __func__, (long long)instr->addr,
427 (long long)instr->len);
Mike Lavender2f9f7622006-01-08 13:34:27 -0800428
Artem Bityutskiyd85316a2008-12-18 14:10:05 +0200429 div_u64_rem(instr->len, mtd->erasesize, &rem);
430 if (rem)
Mike Lavender2f9f7622006-01-08 13:34:27 -0800431 return -EINVAL;
Mike Lavender2f9f7622006-01-08 13:34:27 -0800432
433 addr = instr->addr;
434 len = instr->len;
435
David Brownell7d5230e2007-06-24 15:09:13 -0700436 mutex_lock(&flash->lock);
Mike Lavender2f9f7622006-01-08 13:34:27 -0800437
Chen Gong78546432008-11-26 10:23:57 +0000438 /* whole-chip erase? */
Steven A. Falco3f33b0a2009-04-27 17:10:10 -0400439 if (len == flash->mtd.size) {
440 if (erase_chip(flash)) {
441 instr->state = MTD_ERASE_FAILED;
442 mutex_unlock(&flash->lock);
443 return -EIO;
444 }
Chen Gong78546432008-11-26 10:23:57 +0000445
446 /* REVISIT in some cases we could speed up erasing large regions
447 * by using OPCODE_SE instead of OPCODE_BE_4K. We may have set up
448 * to use "small sector erase", but that's not always optimal.
449 */
450
451 /* "sector"-at-a-time erase */
Chen Gongfaff3752008-08-11 16:59:13 +0800452 } else {
453 while (len) {
454 if (erase_sector(flash, addr)) {
455 instr->state = MTD_ERASE_FAILED;
456 mutex_unlock(&flash->lock);
457 return -EIO;
458 }
Mike Lavender2f9f7622006-01-08 13:34:27 -0800459
Chen Gongfaff3752008-08-11 16:59:13 +0800460 addr += mtd->erasesize;
461 len -= mtd->erasesize;
462 }
Mike Lavender2f9f7622006-01-08 13:34:27 -0800463 }
464
David Brownell7d5230e2007-06-24 15:09:13 -0700465 mutex_unlock(&flash->lock);
Mike Lavender2f9f7622006-01-08 13:34:27 -0800466
467 instr->state = MTD_ERASE_DONE;
468 mtd_erase_callback(instr);
469
470 return 0;
471}
472
473/*
Sourav Poddar8552b432013-11-06 20:05:34 +0530474 * Dummy Cycle calculation for different type of read.
475 * It can be used to support more commands with
476 * different dummy cycle requirements.
477 */
478static inline int m25p80_dummy_cycles_read(struct m25p *flash)
479{
480 switch (flash->flash_read) {
481 case M25P80_FAST:
Sourav Poddar3487a6392013-11-06 20:05:35 +0530482 case M25P80_QUAD:
Sourav Poddar8552b432013-11-06 20:05:34 +0530483 return 1;
484 case M25P80_NORMAL:
485 return 0;
486 default:
487 dev_err(&flash->spi->dev, "No valid read type supported\n");
488 return -1;
489 }
490}
491
492/*
Mike Lavender2f9f7622006-01-08 13:34:27 -0800493 * Read an address range from the flash chip. The address range
494 * may be any size provided it is within the physical boundaries.
495 */
496static int m25p80_read(struct mtd_info *mtd, loff_t from, size_t len,
497 size_t *retlen, u_char *buf)
498{
499 struct m25p *flash = mtd_to_m25p(mtd);
500 struct spi_transfer t[2];
501 struct spi_message m;
Marek Vasut12ad2be2012-09-24 03:39:39 +0200502 uint8_t opcode;
Sourav Poddar8552b432013-11-06 20:05:34 +0530503 int dummy;
Mike Lavender2f9f7622006-01-08 13:34:27 -0800504
Brian Norris0a32a102011-07-19 10:06:10 -0700505 pr_debug("%s: %s from 0x%08x, len %zd\n", dev_name(&flash->spi->dev),
506 __func__, (u32)from, len);
Mike Lavender2f9f7622006-01-08 13:34:27 -0800507
Vitaly Wool8275c642006-01-08 13:34:28 -0800508 spi_message_init(&m);
509 memset(t, 0, (sizeof t));
510
Sourav Poddar8552b432013-11-06 20:05:34 +0530511 dummy = m25p80_dummy_cycles_read(flash);
512 if (dummy < 0) {
513 dev_err(&flash->spi->dev, "No valid read command supported\n");
514 return -EINVAL;
515 }
516
Vitaly Wool8275c642006-01-08 13:34:28 -0800517 t[0].tx_buf = flash->command;
Sourav Poddar8552b432013-11-06 20:05:34 +0530518 t[0].len = m25p_cmdsz(flash) + dummy;
Vitaly Wool8275c642006-01-08 13:34:28 -0800519 spi_message_add_tail(&t[0], &m);
520
521 t[1].rx_buf = buf;
522 t[1].len = len;
523 spi_message_add_tail(&t[1], &m);
524
David Brownell7d5230e2007-06-24 15:09:13 -0700525 mutex_lock(&flash->lock);
Mike Lavender2f9f7622006-01-08 13:34:27 -0800526
527 /* Wait till previous write/erase is done. */
528 if (wait_till_ready(flash)) {
529 /* REVISIT status return?? */
David Brownell7d5230e2007-06-24 15:09:13 -0700530 mutex_unlock(&flash->lock);
Mike Lavender2f9f7622006-01-08 13:34:27 -0800531 return 1;
532 }
533
Mike Lavender2f9f7622006-01-08 13:34:27 -0800534 /* Set up the write data buffer. */
Brian Norris87c95112013-04-11 01:34:57 -0700535 opcode = flash->read_opcode;
Marek Vasut12ad2be2012-09-24 03:39:39 +0200536 flash->command[0] = opcode;
Anton Vorontsov837479d2009-10-12 20:24:40 +0400537 m25p_addr2cmd(flash, from, flash->command);
Mike Lavender2f9f7622006-01-08 13:34:27 -0800538
Mike Lavender2f9f7622006-01-08 13:34:27 -0800539 spi_sync(flash->spi, &m);
540
Sourav Poddar8552b432013-11-06 20:05:34 +0530541 *retlen = m.actual_length - m25p_cmdsz(flash) - dummy;
Mike Lavender2f9f7622006-01-08 13:34:27 -0800542
David Brownell7d5230e2007-06-24 15:09:13 -0700543 mutex_unlock(&flash->lock);
Mike Lavender2f9f7622006-01-08 13:34:27 -0800544
545 return 0;
546}
547
548/*
549 * Write an address range to the flash chip. Data must be written in
550 * FLASH_PAGESIZE chunks. The address range may be any size provided
551 * it is within the physical boundaries.
552 */
553static int m25p80_write(struct mtd_info *mtd, loff_t to, size_t len,
554 size_t *retlen, const u_char *buf)
555{
556 struct m25p *flash = mtd_to_m25p(mtd);
557 u32 page_offset, page_size;
558 struct spi_transfer t[2];
559 struct spi_message m;
560
Brian Norris0a32a102011-07-19 10:06:10 -0700561 pr_debug("%s: %s to 0x%08x, len %zd\n", dev_name(&flash->spi->dev),
562 __func__, (u32)to, len);
Mike Lavender2f9f7622006-01-08 13:34:27 -0800563
Vitaly Wool8275c642006-01-08 13:34:28 -0800564 spi_message_init(&m);
565 memset(t, 0, (sizeof t));
566
567 t[0].tx_buf = flash->command;
Anton Vorontsov837479d2009-10-12 20:24:40 +0400568 t[0].len = m25p_cmdsz(flash);
Vitaly Wool8275c642006-01-08 13:34:28 -0800569 spi_message_add_tail(&t[0], &m);
570
571 t[1].tx_buf = buf;
572 spi_message_add_tail(&t[1], &m);
573
David Brownell7d5230e2007-06-24 15:09:13 -0700574 mutex_lock(&flash->lock);
Mike Lavender2f9f7622006-01-08 13:34:27 -0800575
576 /* Wait until finished previous write command. */
Chen Gongbc018862008-06-05 21:50:04 +0800577 if (wait_till_ready(flash)) {
578 mutex_unlock(&flash->lock);
Mike Lavender2f9f7622006-01-08 13:34:27 -0800579 return 1;
Chen Gongbc018862008-06-05 21:50:04 +0800580 }
Mike Lavender2f9f7622006-01-08 13:34:27 -0800581
582 write_enable(flash);
583
Mike Lavender2f9f7622006-01-08 13:34:27 -0800584 /* Set up the opcode in the write buffer. */
Brian Norris87c95112013-04-11 01:34:57 -0700585 flash->command[0] = flash->program_opcode;
Anton Vorontsov837479d2009-10-12 20:24:40 +0400586 m25p_addr2cmd(flash, to, flash->command);
Mike Lavender2f9f7622006-01-08 13:34:27 -0800587
Anton Vorontsov837479d2009-10-12 20:24:40 +0400588 page_offset = to & (flash->page_size - 1);
Mike Lavender2f9f7622006-01-08 13:34:27 -0800589
590 /* do all the bytes fit onto one page? */
Anton Vorontsov837479d2009-10-12 20:24:40 +0400591 if (page_offset + len <= flash->page_size) {
Mike Lavender2f9f7622006-01-08 13:34:27 -0800592 t[1].len = len;
593
594 spi_sync(flash->spi, &m);
595
Anton Vorontsov837479d2009-10-12 20:24:40 +0400596 *retlen = m.actual_length - m25p_cmdsz(flash);
Mike Lavender2f9f7622006-01-08 13:34:27 -0800597 } else {
598 u32 i;
599
600 /* the size of data remaining on the first page */
Anton Vorontsov837479d2009-10-12 20:24:40 +0400601 page_size = flash->page_size - page_offset;
Mike Lavender2f9f7622006-01-08 13:34:27 -0800602
Mike Lavender2f9f7622006-01-08 13:34:27 -0800603 t[1].len = page_size;
604 spi_sync(flash->spi, &m);
605
Anton Vorontsov837479d2009-10-12 20:24:40 +0400606 *retlen = m.actual_length - m25p_cmdsz(flash);
Mike Lavender2f9f7622006-01-08 13:34:27 -0800607
Anton Vorontsov837479d2009-10-12 20:24:40 +0400608 /* write everything in flash->page_size chunks */
Mike Lavender2f9f7622006-01-08 13:34:27 -0800609 for (i = page_size; i < len; i += page_size) {
610 page_size = len - i;
Anton Vorontsov837479d2009-10-12 20:24:40 +0400611 if (page_size > flash->page_size)
612 page_size = flash->page_size;
Mike Lavender2f9f7622006-01-08 13:34:27 -0800613
614 /* write the next page to flash */
Anton Vorontsov837479d2009-10-12 20:24:40 +0400615 m25p_addr2cmd(flash, to + i, flash->command);
Mike Lavender2f9f7622006-01-08 13:34:27 -0800616
617 t[1].tx_buf = buf + i;
618 t[1].len = page_size;
619
620 wait_till_ready(flash);
621
622 write_enable(flash);
623
624 spi_sync(flash->spi, &m);
625
Dan Carpenterb06cd212010-08-12 09:53:52 +0200626 *retlen += m.actual_length - m25p_cmdsz(flash);
David Brownell7d5230e2007-06-24 15:09:13 -0700627 }
628 }
Mike Lavender2f9f7622006-01-08 13:34:27 -0800629
David Brownell7d5230e2007-06-24 15:09:13 -0700630 mutex_unlock(&flash->lock);
Mike Lavender2f9f7622006-01-08 13:34:27 -0800631
632 return 0;
633}
634
Graf Yang49aac4a2009-06-15 08:23:41 +0000635static int sst_write(struct mtd_info *mtd, loff_t to, size_t len,
636 size_t *retlen, const u_char *buf)
637{
638 struct m25p *flash = mtd_to_m25p(mtd);
639 struct spi_transfer t[2];
640 struct spi_message m;
641 size_t actual;
642 int cmd_sz, ret;
643
Brian Norris0a32a102011-07-19 10:06:10 -0700644 pr_debug("%s: %s to 0x%08x, len %zd\n", dev_name(&flash->spi->dev),
645 __func__, (u32)to, len);
Nicolas Ferredcf12462010-12-15 12:59:32 +0100646
Graf Yang49aac4a2009-06-15 08:23:41 +0000647 spi_message_init(&m);
648 memset(t, 0, (sizeof t));
649
650 t[0].tx_buf = flash->command;
Anton Vorontsov837479d2009-10-12 20:24:40 +0400651 t[0].len = m25p_cmdsz(flash);
Graf Yang49aac4a2009-06-15 08:23:41 +0000652 spi_message_add_tail(&t[0], &m);
653
654 t[1].tx_buf = buf;
655 spi_message_add_tail(&t[1], &m);
656
657 mutex_lock(&flash->lock);
658
659 /* Wait until finished previous write command. */
660 ret = wait_till_ready(flash);
661 if (ret)
662 goto time_out;
663
664 write_enable(flash);
665
666 actual = to % 2;
667 /* Start write from odd address. */
668 if (actual) {
669 flash->command[0] = OPCODE_BP;
Anton Vorontsov837479d2009-10-12 20:24:40 +0400670 m25p_addr2cmd(flash, to, flash->command);
Graf Yang49aac4a2009-06-15 08:23:41 +0000671
672 /* write one byte. */
673 t[1].len = 1;
674 spi_sync(flash->spi, &m);
675 ret = wait_till_ready(flash);
676 if (ret)
677 goto time_out;
Anton Vorontsov837479d2009-10-12 20:24:40 +0400678 *retlen += m.actual_length - m25p_cmdsz(flash);
Graf Yang49aac4a2009-06-15 08:23:41 +0000679 }
680 to += actual;
681
682 flash->command[0] = OPCODE_AAI_WP;
Anton Vorontsov837479d2009-10-12 20:24:40 +0400683 m25p_addr2cmd(flash, to, flash->command);
Graf Yang49aac4a2009-06-15 08:23:41 +0000684
685 /* Write out most of the data here. */
Anton Vorontsov837479d2009-10-12 20:24:40 +0400686 cmd_sz = m25p_cmdsz(flash);
Graf Yang49aac4a2009-06-15 08:23:41 +0000687 for (; actual < len - 1; actual += 2) {
688 t[0].len = cmd_sz;
689 /* write two bytes. */
690 t[1].len = 2;
691 t[1].tx_buf = buf + actual;
692
693 spi_sync(flash->spi, &m);
694 ret = wait_till_ready(flash);
695 if (ret)
696 goto time_out;
697 *retlen += m.actual_length - cmd_sz;
698 cmd_sz = 1;
699 to += 2;
700 }
701 write_disable(flash);
702 ret = wait_till_ready(flash);
703 if (ret)
704 goto time_out;
705
706 /* Write out trailing byte if it exists. */
707 if (actual != len) {
708 write_enable(flash);
709 flash->command[0] = OPCODE_BP;
Anton Vorontsov837479d2009-10-12 20:24:40 +0400710 m25p_addr2cmd(flash, to, flash->command);
711 t[0].len = m25p_cmdsz(flash);
Graf Yang49aac4a2009-06-15 08:23:41 +0000712 t[1].len = 1;
713 t[1].tx_buf = buf + actual;
714
715 spi_sync(flash->spi, &m);
716 ret = wait_till_ready(flash);
717 if (ret)
718 goto time_out;
Anton Vorontsov837479d2009-10-12 20:24:40 +0400719 *retlen += m.actual_length - m25p_cmdsz(flash);
Graf Yang49aac4a2009-06-15 08:23:41 +0000720 write_disable(flash);
721 }
722
723time_out:
724 mutex_unlock(&flash->lock);
725 return ret;
726}
Mike Lavender2f9f7622006-01-08 13:34:27 -0800727
Austin Boyle972e1b72013-01-04 13:02:28 +1300728static int m25p80_lock(struct mtd_info *mtd, loff_t ofs, uint64_t len)
729{
730 struct m25p *flash = mtd_to_m25p(mtd);
731 uint32_t offset = ofs;
732 uint8_t status_old, status_new;
733 int res = 0;
734
735 mutex_lock(&flash->lock);
736 /* Wait until finished previous command */
737 if (wait_till_ready(flash)) {
738 res = 1;
739 goto err;
740 }
741
742 status_old = read_sr(flash);
743
744 if (offset < flash->mtd.size-(flash->mtd.size/2))
745 status_new = status_old | SR_BP2 | SR_BP1 | SR_BP0;
746 else if (offset < flash->mtd.size-(flash->mtd.size/4))
747 status_new = (status_old & ~SR_BP0) | SR_BP2 | SR_BP1;
748 else if (offset < flash->mtd.size-(flash->mtd.size/8))
749 status_new = (status_old & ~SR_BP1) | SR_BP2 | SR_BP0;
750 else if (offset < flash->mtd.size-(flash->mtd.size/16))
751 status_new = (status_old & ~(SR_BP0|SR_BP1)) | SR_BP2;
752 else if (offset < flash->mtd.size-(flash->mtd.size/32))
753 status_new = (status_old & ~SR_BP2) | SR_BP1 | SR_BP0;
754 else if (offset < flash->mtd.size-(flash->mtd.size/64))
755 status_new = (status_old & ~(SR_BP2|SR_BP0)) | SR_BP1;
756 else
757 status_new = (status_old & ~(SR_BP2|SR_BP1)) | SR_BP0;
758
759 /* Only modify protection if it will not unlock other areas */
760 if ((status_new&(SR_BP2|SR_BP1|SR_BP0)) >
761 (status_old&(SR_BP2|SR_BP1|SR_BP0))) {
762 write_enable(flash);
763 if (write_sr(flash, status_new) < 0) {
764 res = 1;
765 goto err;
766 }
767 }
768
769err: mutex_unlock(&flash->lock);
770 return res;
771}
772
773static int m25p80_unlock(struct mtd_info *mtd, loff_t ofs, uint64_t len)
774{
775 struct m25p *flash = mtd_to_m25p(mtd);
776 uint32_t offset = ofs;
777 uint8_t status_old, status_new;
778 int res = 0;
779
780 mutex_lock(&flash->lock);
781 /* Wait until finished previous command */
782 if (wait_till_ready(flash)) {
783 res = 1;
784 goto err;
785 }
786
787 status_old = read_sr(flash);
788
789 if (offset+len > flash->mtd.size-(flash->mtd.size/64))
790 status_new = status_old & ~(SR_BP2|SR_BP1|SR_BP0);
791 else if (offset+len > flash->mtd.size-(flash->mtd.size/32))
792 status_new = (status_old & ~(SR_BP2|SR_BP1)) | SR_BP0;
793 else if (offset+len > flash->mtd.size-(flash->mtd.size/16))
794 status_new = (status_old & ~(SR_BP2|SR_BP0)) | SR_BP1;
795 else if (offset+len > flash->mtd.size-(flash->mtd.size/8))
796 status_new = (status_old & ~SR_BP2) | SR_BP1 | SR_BP0;
797 else if (offset+len > flash->mtd.size-(flash->mtd.size/4))
798 status_new = (status_old & ~(SR_BP0|SR_BP1)) | SR_BP2;
799 else if (offset+len > flash->mtd.size-(flash->mtd.size/2))
800 status_new = (status_old & ~SR_BP1) | SR_BP2 | SR_BP0;
801 else
802 status_new = (status_old & ~SR_BP0) | SR_BP2 | SR_BP1;
803
804 /* Only modify protection if it will not lock other areas */
805 if ((status_new&(SR_BP2|SR_BP1|SR_BP0)) <
806 (status_old&(SR_BP2|SR_BP1|SR_BP0))) {
807 write_enable(flash);
808 if (write_sr(flash, status_new) < 0) {
809 res = 1;
810 goto err;
811 }
812 }
813
814err: mutex_unlock(&flash->lock);
815 return res;
816}
817
Mike Lavender2f9f7622006-01-08 13:34:27 -0800818/****************************************************************************/
819
820/*
821 * SPI device driver setup and teardown
822 */
823
824struct flash_info {
David Brownellfa0a8c72007-06-24 15:12:35 -0700825 /* JEDEC id zero means "no ID" (most older chips); otherwise it has
826 * a high byte of zero plus three data bytes: the manufacturer id,
827 * then a two byte device id.
828 */
829 u32 jedec_id;
Chen Gongd0e8c472008-08-11 16:59:15 +0800830 u16 ext_id;
David Brownellfa0a8c72007-06-24 15:12:35 -0700831
832 /* The size listed here is what works with OPCODE_SE, which isn't
833 * necessarily called a "sector" by the vendor.
834 */
Mike Lavender2f9f7622006-01-08 13:34:27 -0800835 unsigned sector_size;
David Brownellfa0a8c72007-06-24 15:12:35 -0700836 u16 n_sectors;
837
Anton Vorontsov837479d2009-10-12 20:24:40 +0400838 u16 page_size;
839 u16 addr_width;
840
David Brownellfa0a8c72007-06-24 15:12:35 -0700841 u16 flags;
842#define SECT_4K 0x01 /* OPCODE_BE_4K works uniformly */
Anton Vorontsov837479d2009-10-12 20:24:40 +0400843#define M25P_NO_ERASE 0x02 /* No erase command needed */
Krzysztof Mazure534ee42013-02-22 15:51:05 +0100844#define SST_WRITE 0x04 /* use SST byte programming */
Sascha Hauer58146992013-08-20 09:54:40 +0200845#define M25P_NO_FR 0x08 /* Can't do fastread */
Michel Stempin6c3b8892013-07-15 12:13:56 +0200846#define SECT_4K_PMC 0x10 /* OPCODE_BE_4K_PMC works uniformly */
Sourav Poddar3487a6392013-11-06 20:05:35 +0530847#define M25P80_QUAD_READ 0x20 /* Flash supports Quad Read */
Mike Lavender2f9f7622006-01-08 13:34:27 -0800848};
849
Anton Vorontsovb34bc032009-10-12 20:24:35 +0400850#define INFO(_jedec_id, _ext_id, _sector_size, _n_sectors, _flags) \
851 ((kernel_ulong_t)&(struct flash_info) { \
852 .jedec_id = (_jedec_id), \
853 .ext_id = (_ext_id), \
854 .sector_size = (_sector_size), \
855 .n_sectors = (_n_sectors), \
Anton Vorontsov837479d2009-10-12 20:24:40 +0400856 .page_size = 256, \
Anton Vorontsovb34bc032009-10-12 20:24:35 +0400857 .flags = (_flags), \
858 })
David Brownellfa0a8c72007-06-24 15:12:35 -0700859
Sascha Hauer7e7d83b2013-08-20 09:54:39 +0200860#define CAT25_INFO(_sector_size, _n_sectors, _page_size, _addr_width, _flags) \
Anton Vorontsov837479d2009-10-12 20:24:40 +0400861 ((kernel_ulong_t)&(struct flash_info) { \
862 .sector_size = (_sector_size), \
863 .n_sectors = (_n_sectors), \
864 .page_size = (_page_size), \
865 .addr_width = (_addr_width), \
Sascha Hauer7e7d83b2013-08-20 09:54:39 +0200866 .flags = (_flags), \
Anton Vorontsov837479d2009-10-12 20:24:40 +0400867 })
David Brownellfa0a8c72007-06-24 15:12:35 -0700868
869/* NOTE: double check command sets and memory organization when you add
870 * more flash chips. This current list focusses on newer chips, which
871 * have been converging on command sets which including JEDEC ID.
872 */
Anton Vorontsovb34bc032009-10-12 20:24:35 +0400873static const struct spi_device_id m25p_ids[] = {
David Brownellfa0a8c72007-06-24 15:12:35 -0700874 /* Atmel -- some are (confusingly) marketed as "DataFlash" */
Anton Vorontsovb34bc032009-10-12 20:24:35 +0400875 { "at25fs010", INFO(0x1f6601, 0, 32 * 1024, 4, SECT_4K) },
876 { "at25fs040", INFO(0x1f6604, 0, 64 * 1024, 8, SECT_4K) },
David Brownellfa0a8c72007-06-24 15:12:35 -0700877
Anton Vorontsovb34bc032009-10-12 20:24:35 +0400878 { "at25df041a", INFO(0x1f4401, 0, 64 * 1024, 8, SECT_4K) },
Mikhail Kshevetskiyada766e2011-09-23 19:36:18 +0400879 { "at25df321a", INFO(0x1f4701, 0, 64 * 1024, 64, SECT_4K) },
Anton Vorontsovb34bc032009-10-12 20:24:35 +0400880 { "at25df641", INFO(0x1f4800, 0, 64 * 1024, 128, SECT_4K) },
David Brownellfa0a8c72007-06-24 15:12:35 -0700881
Anton Vorontsovb34bc032009-10-12 20:24:35 +0400882 { "at26f004", INFO(0x1f0400, 0, 64 * 1024, 8, SECT_4K) },
883 { "at26df081a", INFO(0x1f4501, 0, 64 * 1024, 16, SECT_4K) },
884 { "at26df161a", INFO(0x1f4601, 0, 64 * 1024, 32, SECT_4K) },
Aleksandr Koltsoff8fffed82011-01-04 10:42:35 +0200885 { "at26df321", INFO(0x1f4700, 0, 64 * 1024, 64, SECT_4K) },
David Brownellfa0a8c72007-06-24 15:12:35 -0700886
Chunhe Lana5b2d762012-06-19 10:55:08 +0800887 { "at45db081d", INFO(0x1f2500, 0, 64 * 1024, 16, SECT_4K) },
888
Gabor Juhos37a23c202011-01-25 11:20:26 +0100889 /* EON -- en25xxx */
Brian Norris6e5d9bd2013-08-09 19:41:13 -0700890 { "en25f32", INFO(0x1c3116, 0, 64 * 1024, 64, SECT_4K) },
891 { "en25p32", INFO(0x1c2016, 0, 64 * 1024, 64, 0) },
892 { "en25q32b", INFO(0x1c3016, 0, 64 * 1024, 64, 0) },
893 { "en25p64", INFO(0x1c2017, 0, 64 * 1024, 128, 0) },
894 { "en25q64", INFO(0x1c3017, 0, 64 * 1024, 128, SECT_4K) },
895 { "en25qh256", INFO(0x1c7019, 0, 64 * 1024, 512, 0) },
Gabor Juhos60845e72010-08-04 21:14:25 +0200896
Flavio Silveirae6db7c82013-09-03 20:25:54 -0300897 /* ESMT */
898 { "f25l32pa", INFO(0x8c2016, 0, 64 * 1024, 64, SECT_4K) },
899
Marek Vasut5ca11ca2012-05-01 04:04:00 +0200900 /* Everspin */
Brian Norris6e5d9bd2013-08-09 19:41:13 -0700901 { "mr25h256", CAT25_INFO( 32 * 1024, 1, 256, 2, M25P_NO_ERASE | M25P_NO_FR) },
902 { "mr25h10", CAT25_INFO(128 * 1024, 1, 256, 3, M25P_NO_ERASE | M25P_NO_FR) },
Marek Vasut5ca11ca2012-05-01 04:04:00 +0200903
Michel Stempin55bf75b2013-01-06 00:39:36 +0100904 /* GigaDevice */
905 { "gd25q32", INFO(0xc84016, 0, 64 * 1024, 64, SECT_4K) },
906 { "gd25q64", INFO(0xc84017, 0, 64 * 1024, 128, SECT_4K) },
907
Gabor Juhosf80e5212010-08-05 16:58:36 +0200908 /* Intel/Numonyx -- xxxs33b */
909 { "160s33b", INFO(0x898911, 0, 64 * 1024, 32, 0) },
910 { "320s33b", INFO(0x898912, 0, 64 * 1024, 64, 0) },
911 { "640s33b", INFO(0x898913, 0, 64 * 1024, 128, 0) },
912
Lennert Buytenhekab1ff212009-05-20 13:07:11 +0200913 /* Macronix */
John Crispinbb08bc12012-04-30 19:30:45 +0200914 { "mx25l2005a", INFO(0xc22012, 0, 64 * 1024, 4, SECT_4K) },
Simon Guinotdf0094d2009-12-05 15:28:00 +0100915 { "mx25l4005a", INFO(0xc22013, 0, 64 * 1024, 8, SECT_4K) },
Martin Michlmayr6175f4a2010-06-07 19:31:01 +0100916 { "mx25l8005", INFO(0xc22014, 0, 64 * 1024, 16, 0) },
Gabor Juhos9c76b4e2011-03-25 08:48:52 +0100917 { "mx25l1606e", INFO(0xc22015, 0, 64 * 1024, 32, SECT_4K) },
Anton Vorontsovb34bc032009-10-12 20:24:35 +0400918 { "mx25l3205d", INFO(0xc22016, 0, 64 * 1024, 64, 0) },
Brian Norris5ff14822013-10-23 13:38:09 -0700919 { "mx25l3255e", INFO(0xc29e16, 0, 64 * 1024, 64, SECT_4K) },
Anton Vorontsovb34bc032009-10-12 20:24:35 +0400920 { "mx25l6405d", INFO(0xc22017, 0, 64 * 1024, 128, 0) },
921 { "mx25l12805d", INFO(0xc22018, 0, 64 * 1024, 256, 0) },
922 { "mx25l12855e", INFO(0xc22618, 0, 64 * 1024, 256, 0) },
Kevin Cernekee4b7f7422010-10-30 21:11:03 -0700923 { "mx25l25635e", INFO(0xc22019, 0, 64 * 1024, 512, 0) },
Kevin Cernekeeac622f52010-10-30 21:11:04 -0700924 { "mx25l25655e", INFO(0xc22619, 0, 64 * 1024, 512, 0) },
Sourav Poddar3487a6392013-11-06 20:05:35 +0530925 { "mx66l51235l", INFO(0xc2201a, 0, 64 * 1024, 1024, M25P80_QUAD_READ) },
Lennert Buytenhekab1ff212009-05-20 13:07:11 +0200926
Vivien Didelot8da28682012-08-14 15:24:07 -0400927 /* Micron */
Brian Norris6e5d9bd2013-08-09 19:41:13 -0700928 { "n25q064", INFO(0x20ba17, 0, 64 * 1024, 128, 0) },
929 { "n25q128a11", INFO(0x20bb18, 0, 64 * 1024, 256, 0) },
930 { "n25q128a13", INFO(0x20ba18, 0, 64 * 1024, 256, 0) },
931 { "n25q256a", INFO(0x20ba19, 0, 64 * 1024, 512, SECT_4K) },
932 { "n25q512a", INFO(0x20bb20, 0, 64 * 1024, 1024, SECT_4K) },
Vivien Didelot8da28682012-08-14 15:24:07 -0400933
Michel Stempin6c3b8892013-07-15 12:13:56 +0200934 /* PMC */
Brian Norris6e5d9bd2013-08-09 19:41:13 -0700935 { "pm25lv512", INFO(0, 0, 32 * 1024, 2, SECT_4K_PMC) },
936 { "pm25lv010", INFO(0, 0, 32 * 1024, 4, SECT_4K_PMC) },
937 { "pm25lq032", INFO(0x7f9d46, 0, 64 * 1024, 64, SECT_4K) },
Michel Stempin6c3b8892013-07-15 12:13:56 +0200938
David Brownellfa0a8c72007-06-24 15:12:35 -0700939 /* Spansion -- single (large) sector size only, at least
940 * for the chips listed here (without boot sectors).
941 */
Marek Vasutb277f772012-09-04 05:31:36 +0200942 { "s25sl032p", INFO(0x010215, 0x4d00, 64 * 1024, 64, 0) },
943 { "s25sl064p", INFO(0x010216, 0x4d00, 64 * 1024, 128, 0) },
Kevin Cernekeebaa9ae32011-05-08 10:48:01 -0700944 { "s25fl256s0", INFO(0x010219, 0x4d00, 256 * 1024, 128, 0) },
Sourav Poddar3487a6392013-11-06 20:05:35 +0530945 { "s25fl256s1", INFO(0x010219, 0x4d01, 64 * 1024, 512, M25P80_QUAD_READ) },
Geert Uytterhoevend8d5d102014-01-21 13:59:16 +0100946 { "s25fl512s", INFO(0x010220, 0x4d00, 256 * 1024, 256, M25P80_QUAD_READ) },
Kevin Cernekee3d2d2b62011-05-08 10:48:02 -0700947 { "s70fl01gs", INFO(0x010221, 0x4d00, 256 * 1024, 256, 0) },
Anton Vorontsovb34bc032009-10-12 20:24:35 +0400948 { "s25sl12800", INFO(0x012018, 0x0300, 256 * 1024, 64, 0) },
949 { "s25sl12801", INFO(0x012018, 0x0301, 64 * 1024, 256, 0) },
950 { "s25fl129p0", INFO(0x012018, 0x4d00, 256 * 1024, 64, 0) },
951 { "s25fl129p1", INFO(0x012018, 0x4d01, 64 * 1024, 256, 0) },
Marek Vasut8bb8b852012-07-06 08:10:26 +0200952 { "s25sl004a", INFO(0x010212, 0, 64 * 1024, 8, 0) },
953 { "s25sl008a", INFO(0x010213, 0, 64 * 1024, 16, 0) },
954 { "s25sl016a", INFO(0x010214, 0, 64 * 1024, 32, 0) },
955 { "s25sl032a", INFO(0x010215, 0, 64 * 1024, 64, 0) },
956 { "s25sl064a", INFO(0x010216, 0, 64 * 1024, 128, 0) },
Gernot Hoylerf2df1ae2010-09-02 17:27:20 +0200957 { "s25fl016k", INFO(0xef4015, 0, 64 * 1024, 32, SECT_4K) },
958 { "s25fl064k", INFO(0xef4017, 0, 64 * 1024, 128, SECT_4K) },
David Brownellfa0a8c72007-06-24 15:12:35 -0700959
960 /* SST -- large erase sizes are "overlays", "sectors" are 4K */
Krzysztof Mazure534ee42013-02-22 15:51:05 +0100961 { "sst25vf040b", INFO(0xbf258d, 0, 64 * 1024, 8, SECT_4K | SST_WRITE) },
962 { "sst25vf080b", INFO(0xbf258e, 0, 64 * 1024, 16, SECT_4K | SST_WRITE) },
963 { "sst25vf016b", INFO(0xbf2541, 0, 64 * 1024, 32, SECT_4K | SST_WRITE) },
964 { "sst25vf032b", INFO(0xbf254a, 0, 64 * 1024, 64, SECT_4K | SST_WRITE) },
Krzysztof Mazur89134052013-02-22 15:51:06 +0100965 { "sst25vf064c", INFO(0xbf254b, 0, 64 * 1024, 128, SECT_4K) },
Krzysztof Mazure534ee42013-02-22 15:51:05 +0100966 { "sst25wf512", INFO(0xbf2501, 0, 64 * 1024, 1, SECT_4K | SST_WRITE) },
967 { "sst25wf010", INFO(0xbf2502, 0, 64 * 1024, 2, SECT_4K | SST_WRITE) },
968 { "sst25wf020", INFO(0xbf2503, 0, 64 * 1024, 4, SECT_4K | SST_WRITE) },
969 { "sst25wf040", INFO(0xbf2504, 0, 64 * 1024, 8, SECT_4K | SST_WRITE) },
David Brownellfa0a8c72007-06-24 15:12:35 -0700970
971 /* ST Microelectronics -- newer production may have feature updates */
Anton Vorontsovb34bc032009-10-12 20:24:35 +0400972 { "m25p05", INFO(0x202010, 0, 32 * 1024, 2, 0) },
973 { "m25p10", INFO(0x202011, 0, 32 * 1024, 4, 0) },
974 { "m25p20", INFO(0x202012, 0, 64 * 1024, 4, 0) },
975 { "m25p40", INFO(0x202013, 0, 64 * 1024, 8, 0) },
976 { "m25p80", INFO(0x202014, 0, 64 * 1024, 16, 0) },
977 { "m25p16", INFO(0x202015, 0, 64 * 1024, 32, 0) },
978 { "m25p32", INFO(0x202016, 0, 64 * 1024, 64, 0) },
979 { "m25p64", INFO(0x202017, 0, 64 * 1024, 128, 0) },
980 { "m25p128", INFO(0x202018, 0, 256 * 1024, 64, 0) },
Knut Wohlrab48003992012-07-17 15:45:53 +0200981 { "n25q032", INFO(0x20ba16, 0, 64 * 1024, 64, 0) },
David Brownellfa0a8c72007-06-24 15:12:35 -0700982
Anton Vorontsovf7b00092010-06-22 20:57:34 +0400983 { "m25p05-nonjedec", INFO(0, 0, 32 * 1024, 2, 0) },
984 { "m25p10-nonjedec", INFO(0, 0, 32 * 1024, 4, 0) },
985 { "m25p20-nonjedec", INFO(0, 0, 64 * 1024, 4, 0) },
986 { "m25p40-nonjedec", INFO(0, 0, 64 * 1024, 8, 0) },
987 { "m25p80-nonjedec", INFO(0, 0, 64 * 1024, 16, 0) },
988 { "m25p16-nonjedec", INFO(0, 0, 64 * 1024, 32, 0) },
989 { "m25p32-nonjedec", INFO(0, 0, 64 * 1024, 64, 0) },
990 { "m25p64-nonjedec", INFO(0, 0, 64 * 1024, 128, 0) },
991 { "m25p128-nonjedec", INFO(0, 0, 256 * 1024, 64, 0) },
992
Anton Vorontsovb34bc032009-10-12 20:24:35 +0400993 { "m45pe10", INFO(0x204011, 0, 64 * 1024, 2, 0) },
994 { "m45pe80", INFO(0x204014, 0, 64 * 1024, 16, 0) },
995 { "m45pe16", INFO(0x204015, 0, 64 * 1024, 32, 0) },
David Brownellfa0a8c72007-06-24 15:12:35 -0700996
Alexandre Pereira da Silva943b35a2012-06-12 16:42:40 -0300997 { "m25pe20", INFO(0x208012, 0, 64 * 1024, 4, 0) },
Anton Vorontsovb34bc032009-10-12 20:24:35 +0400998 { "m25pe80", INFO(0x208014, 0, 64 * 1024, 16, 0) },
999 { "m25pe16", INFO(0x208015, 0, 64 * 1024, 32, SECT_4K) },
David Brownellfa0a8c72007-06-24 15:12:35 -07001000
Igor Grinberg574926c2013-11-11 22:55:29 +02001001 { "m25px16", INFO(0x207115, 0, 64 * 1024, 32, SECT_4K) },
Kevin Cernekee16004f32011-05-08 10:47:59 -07001002 { "m25px32", INFO(0x207116, 0, 64 * 1024, 64, SECT_4K) },
1003 { "m25px32-s0", INFO(0x207316, 0, 64 * 1024, 64, SECT_4K) },
1004 { "m25px32-s1", INFO(0x206316, 0, 64 * 1024, 64, SECT_4K) },
1005 { "m25px64", INFO(0x207117, 0, 64 * 1024, 128, 0) },
Yoshihiro Shimodad8f90b22011-02-09 17:00:33 +09001006
David Woodhouse02d087d2007-06-28 22:38:38 +01001007 /* Winbond -- w25x "blocks" are 64K, "sectors" are 4KiB */
Anton Vorontsovb34bc032009-10-12 20:24:35 +04001008 { "w25x10", INFO(0xef3011, 0, 64 * 1024, 2, SECT_4K) },
1009 { "w25x20", INFO(0xef3012, 0, 64 * 1024, 4, SECT_4K) },
1010 { "w25x40", INFO(0xef3013, 0, 64 * 1024, 8, SECT_4K) },
1011 { "w25x80", INFO(0xef3014, 0, 64 * 1024, 16, SECT_4K) },
1012 { "w25x16", INFO(0xef3015, 0, 64 * 1024, 32, SECT_4K) },
1013 { "w25x32", INFO(0xef3016, 0, 64 * 1024, 64, SECT_4K) },
Gabor Juhos0af18d22010-08-04 21:14:27 +02001014 { "w25q32", INFO(0xef4016, 0, 64 * 1024, 64, SECT_4K) },
ing. Federico Fuga9d6367f2012-06-05 17:37:01 +02001015 { "w25q32dw", INFO(0xef6016, 0, 64 * 1024, 64, SECT_4K) },
Anton Vorontsovb34bc032009-10-12 20:24:35 +04001016 { "w25x64", INFO(0xef3017, 0, 64 * 1024, 128, SECT_4K) },
Thierry Redingd2ac4672010-08-30 13:00:48 +02001017 { "w25q64", INFO(0xef4017, 0, 64 * 1024, 128, SECT_4K) },
Girish K S4b6ff7a2013-04-16 14:01:14 +05301018 { "w25q128", INFO(0xef4018, 0, 64 * 1024, 256, SECT_4K) },
Thomas Abraham4fba37a2012-05-09 04:04:54 +05301019 { "w25q80", INFO(0xef5014, 0, 64 * 1024, 16, SECT_4K) },
Stephen Warren9b7ef602012-11-12 12:58:28 -07001020 { "w25q80bl", INFO(0xef4014, 0, 64 * 1024, 16, SECT_4K) },
Rafał Miłecki001c33a2013-02-24 13:57:26 +01001021 { "w25q128", INFO(0xef4018, 0, 64 * 1024, 256, SECT_4K) },
Matthieu CASTET0aa87b72012-09-25 11:05:27 +02001022 { "w25q256", INFO(0xef4019, 0, 64 * 1024, 512, SECT_4K) },
Mike Lavender2f9f7622006-01-08 13:34:27 -08001023
Anton Vorontsov837479d2009-10-12 20:24:40 +04001024 /* Catalyst / On Semiconductor -- non-JEDEC */
Sascha Hauer58146992013-08-20 09:54:40 +02001025 { "cat25c11", CAT25_INFO( 16, 8, 16, 1, M25P_NO_ERASE | M25P_NO_FR) },
1026 { "cat25c03", CAT25_INFO( 32, 8, 16, 2, M25P_NO_ERASE | M25P_NO_FR) },
1027 { "cat25c09", CAT25_INFO( 128, 8, 32, 2, M25P_NO_ERASE | M25P_NO_FR) },
1028 { "cat25c17", CAT25_INFO( 256, 8, 32, 2, M25P_NO_ERASE | M25P_NO_FR) },
1029 { "cat25128", CAT25_INFO(2048, 8, 64, 2, M25P_NO_ERASE | M25P_NO_FR) },
Anton Vorontsovb34bc032009-10-12 20:24:35 +04001030 { },
Mike Lavender2f9f7622006-01-08 13:34:27 -08001031};
Anton Vorontsovb34bc032009-10-12 20:24:35 +04001032MODULE_DEVICE_TABLE(spi, m25p_ids);
Mike Lavender2f9f7622006-01-08 13:34:27 -08001033
Bill Pemberton06f25512012-11-19 13:23:07 -05001034static const struct spi_device_id *jedec_probe(struct spi_device *spi)
David Brownellfa0a8c72007-06-24 15:12:35 -07001035{
1036 int tmp;
1037 u8 code = OPCODE_RDID;
Chen Gongdaa84732008-09-16 14:14:12 +08001038 u8 id[5];
David Brownellfa0a8c72007-06-24 15:12:35 -07001039 u32 jedec;
Chen Gongd0e8c472008-08-11 16:59:15 +08001040 u16 ext_jedec;
David Brownellfa0a8c72007-06-24 15:12:35 -07001041 struct flash_info *info;
1042
1043 /* JEDEC also defines an optional "extended device information"
1044 * string for after vendor-specific data, after the three bytes
1045 * we use here. Supporting some chips might require using it.
1046 */
Chen Gongdaa84732008-09-16 14:14:12 +08001047 tmp = spi_write_then_read(spi, &code, 1, id, 5);
David Brownellfa0a8c72007-06-24 15:12:35 -07001048 if (tmp < 0) {
Brian Norris289c0522011-07-19 10:06:09 -07001049 pr_debug("%s: error %d reading JEDEC ID\n",
Brian Norris0a32a102011-07-19 10:06:10 -07001050 dev_name(&spi->dev), tmp);
Anton Vorontsov9d2c4f32010-06-22 20:57:42 +04001051 return ERR_PTR(tmp);
David Brownellfa0a8c72007-06-24 15:12:35 -07001052 }
1053 jedec = id[0];
1054 jedec = jedec << 8;
1055 jedec |= id[1];
1056 jedec = jedec << 8;
1057 jedec |= id[2];
1058
Chen Gongd0e8c472008-08-11 16:59:15 +08001059 ext_jedec = id[3] << 8 | id[4];
1060
Anton Vorontsovb34bc032009-10-12 20:24:35 +04001061 for (tmp = 0; tmp < ARRAY_SIZE(m25p_ids) - 1; tmp++) {
1062 info = (void *)m25p_ids[tmp].driver_data;
Mike Frysingera3d3f732008-11-26 10:23:25 +00001063 if (info->jedec_id == jedec) {
Mike Frysinger9168ab82008-11-26 10:23:35 +00001064 if (info->ext_id != 0 && info->ext_id != ext_jedec)
Chen Gongd0e8c472008-08-11 16:59:15 +08001065 continue;
Anton Vorontsovb34bc032009-10-12 20:24:35 +04001066 return &m25p_ids[tmp];
Mike Frysingera3d3f732008-11-26 10:23:25 +00001067 }
David Brownellfa0a8c72007-06-24 15:12:35 -07001068 }
Kevin Cernekeef0dff9b2010-10-30 21:11:02 -07001069 dev_err(&spi->dev, "unrecognized JEDEC id %06x\n", jedec);
Anton Vorontsov9d2c4f32010-06-22 20:57:42 +04001070 return ERR_PTR(-ENODEV);
David Brownellfa0a8c72007-06-24 15:12:35 -07001071}
1072
1073
Mike Lavender2f9f7622006-01-08 13:34:27 -08001074/*
1075 * board specific setup should have ensured the SPI clock used here
1076 * matches what the READ command supports, at least until this driver
1077 * understands FAST_READ (for clocks over 25 MHz).
1078 */
Bill Pemberton06f25512012-11-19 13:23:07 -05001079static int m25p_probe(struct spi_device *spi)
Mike Lavender2f9f7622006-01-08 13:34:27 -08001080{
Anton Vorontsov18c61822009-10-12 20:24:38 +04001081 const struct spi_device_id *id = spi_get_device_id(spi);
Mike Lavender2f9f7622006-01-08 13:34:27 -08001082 struct flash_platform_data *data;
1083 struct m25p *flash;
1084 struct flash_info *info;
1085 unsigned i;
Dmitry Eremin-Solenikovea6a4722011-05-30 01:02:20 +04001086 struct mtd_part_parser_data ppdata;
Brian Norrisdc525ff2013-10-23 19:34:46 -07001087 struct device_node *np = spi->dev.of_node;
Sourav Poddar3487a6392013-11-06 20:05:35 +05301088 int ret;
Shaohui Xie5f949132011-10-14 15:49:00 +08001089
Mike Lavender2f9f7622006-01-08 13:34:27 -08001090 /* Platform data helps sort out which chip type we have, as
David Brownellfa0a8c72007-06-24 15:12:35 -07001091 * well as how this board partitions it. If we don't have
1092 * a chip ID, try the JEDEC id commands; they'll work for most
1093 * newer chips, even if we don't recognize the particular chip.
Mike Lavender2f9f7622006-01-08 13:34:27 -08001094 */
Jingoo Han0278fd32013-07-30 17:17:44 +09001095 data = dev_get_platdata(&spi->dev);
David Brownellfa0a8c72007-06-24 15:12:35 -07001096 if (data && data->type) {
Anton Vorontsov18c61822009-10-12 20:24:38 +04001097 const struct spi_device_id *plat_id;
1098
Anton Vorontsovb34bc032009-10-12 20:24:35 +04001099 for (i = 0; i < ARRAY_SIZE(m25p_ids) - 1; i++) {
Anton Vorontsov18c61822009-10-12 20:24:38 +04001100 plat_id = &m25p_ids[i];
1101 if (strcmp(data->type, plat_id->name))
Anton Vorontsovb34bc032009-10-12 20:24:35 +04001102 continue;
1103 break;
David Brownellfa0a8c72007-06-24 15:12:35 -07001104 }
Mike Lavender2f9f7622006-01-08 13:34:27 -08001105
Dan Carpenterf78ec6b2010-08-12 09:58:27 +02001106 if (i < ARRAY_SIZE(m25p_ids) - 1)
Anton Vorontsov18c61822009-10-12 20:24:38 +04001107 id = plat_id;
1108 else
1109 dev_warn(&spi->dev, "unrecognized id %s\n", data->type);
Anton Vorontsovb34bc032009-10-12 20:24:35 +04001110 }
David Brownellfa0a8c72007-06-24 15:12:35 -07001111
Anton Vorontsov18c61822009-10-12 20:24:38 +04001112 info = (void *)id->driver_data;
David Brownellfa0a8c72007-06-24 15:12:35 -07001113
Anton Vorontsov18c61822009-10-12 20:24:38 +04001114 if (info->jedec_id) {
1115 const struct spi_device_id *jid;
1116
1117 jid = jedec_probe(spi);
Anton Vorontsov9d2c4f32010-06-22 20:57:42 +04001118 if (IS_ERR(jid)) {
1119 return PTR_ERR(jid);
Anton Vorontsov18c61822009-10-12 20:24:38 +04001120 } else if (jid != id) {
1121 /*
1122 * JEDEC knows better, so overwrite platform ID. We
1123 * can't trust partitions any longer, but we'll let
1124 * mtd apply them anyway, since some partitions may be
1125 * marked read-only, and we don't want to lose that
1126 * information, even if it's not 100% accurate.
1127 */
1128 dev_warn(&spi->dev, "found %s, expected %s\n",
1129 jid->name, id->name);
1130 id = jid;
1131 info = (void *)jid->driver_data;
David Brownellfa0a8c72007-06-24 15:12:35 -07001132 }
Anton Vorontsov18c61822009-10-12 20:24:38 +04001133 }
Mike Lavender2f9f7622006-01-08 13:34:27 -08001134
Brian Norris778d2262013-07-24 18:32:07 -07001135 flash = devm_kzalloc(&spi->dev, sizeof(*flash), GFP_KERNEL);
Mike Lavender2f9f7622006-01-08 13:34:27 -08001136 if (!flash)
1137 return -ENOMEM;
Brian Norris778d2262013-07-24 18:32:07 -07001138
1139 flash->command = devm_kzalloc(&spi->dev, MAX_CMD_SIZE, GFP_KERNEL);
1140 if (!flash->command)
Johannes Stezenbach61c35062009-10-28 14:21:37 +01001141 return -ENOMEM;
Mike Lavender2f9f7622006-01-08 13:34:27 -08001142
1143 flash->spi = spi;
David Brownell7d5230e2007-06-24 15:09:13 -07001144 mutex_init(&flash->lock);
Jingoo Han975aefc2013-04-06 15:41:32 +09001145 spi_set_drvdata(spi, flash);
Mike Lavender2f9f7622006-01-08 13:34:27 -08001146
Michael Hennerich72289822008-07-03 23:54:42 -07001147 /*
Gabor Juhosf80e5212010-08-05 16:58:36 +02001148 * Atmel, SST and Intel/Numonyx serial flash tend to power
Graf Yangea60658a2009-09-24 15:46:22 -04001149 * up with the software protection bits set
Michael Hennerich72289822008-07-03 23:54:42 -07001150 */
1151
Kevin Cernekeeaa084652011-05-08 10:48:00 -07001152 if (JEDEC_MFR(info->jedec_id) == CFI_MFR_ATMEL ||
1153 JEDEC_MFR(info->jedec_id) == CFI_MFR_INTEL ||
1154 JEDEC_MFR(info->jedec_id) == CFI_MFR_SST) {
Michael Hennerich72289822008-07-03 23:54:42 -07001155 write_enable(flash);
1156 write_sr(flash, 0);
1157 }
1158
David Brownellfa0a8c72007-06-24 15:12:35 -07001159 if (data && data->name)
Mike Lavender2f9f7622006-01-08 13:34:27 -08001160 flash->mtd.name = data->name;
1161 else
Kay Sievers160bbab2008-12-23 10:00:14 +00001162 flash->mtd.name = dev_name(&spi->dev);
Mike Lavender2f9f7622006-01-08 13:34:27 -08001163
1164 flash->mtd.type = MTD_NORFLASH;
Artem B. Bityutskiy783ed812006-06-14 19:53:44 +04001165 flash->mtd.writesize = 1;
Mike Lavender2f9f7622006-01-08 13:34:27 -08001166 flash->mtd.flags = MTD_CAP_NORFLASH;
1167 flash->mtd.size = info->sector_size * info->n_sectors;
Artem Bityutskiy3c3c10b2012-01-30 14:58:32 +02001168 flash->mtd._erase = m25p80_erase;
1169 flash->mtd._read = m25p80_read;
Graf Yang49aac4a2009-06-15 08:23:41 +00001170
Austin Boyle972e1b72013-01-04 13:02:28 +13001171 /* flash protection support for STmicro chips */
1172 if (JEDEC_MFR(info->jedec_id) == CFI_MFR_ST) {
1173 flash->mtd._lock = m25p80_lock;
1174 flash->mtd._unlock = m25p80_unlock;
1175 }
1176
Graf Yang49aac4a2009-06-15 08:23:41 +00001177 /* sst flash chips use AAI word program */
Krzysztof Mazure534ee42013-02-22 15:51:05 +01001178 if (info->flags & SST_WRITE)
Artem Bityutskiy3c3c10b2012-01-30 14:58:32 +02001179 flash->mtd._write = sst_write;
Graf Yang49aac4a2009-06-15 08:23:41 +00001180 else
Artem Bityutskiy3c3c10b2012-01-30 14:58:32 +02001181 flash->mtd._write = m25p80_write;
Mike Lavender2f9f7622006-01-08 13:34:27 -08001182
David Brownellfa0a8c72007-06-24 15:12:35 -07001183 /* prefer "small sector" erase if possible */
1184 if (info->flags & SECT_4K) {
1185 flash->erase_opcode = OPCODE_BE_4K;
1186 flash->mtd.erasesize = 4096;
Michel Stempin6c3b8892013-07-15 12:13:56 +02001187 } else if (info->flags & SECT_4K_PMC) {
1188 flash->erase_opcode = OPCODE_BE_4K_PMC;
1189 flash->mtd.erasesize = 4096;
David Brownellfa0a8c72007-06-24 15:12:35 -07001190 } else {
1191 flash->erase_opcode = OPCODE_SE;
1192 flash->mtd.erasesize = info->sector_size;
1193 }
1194
Anton Vorontsov837479d2009-10-12 20:24:40 +04001195 if (info->flags & M25P_NO_ERASE)
1196 flash->mtd.flags |= MTD_NO_ERASE;
David Brownell87f39f02009-03-26 00:42:50 -07001197
Dmitry Eremin-Solenikovea6a4722011-05-30 01:02:20 +04001198 ppdata.of_node = spi->dev.of_node;
Artem Bityutskiyd85316a2008-12-18 14:10:05 +02001199 flash->mtd.dev.parent = &spi->dev;
Anton Vorontsov837479d2009-10-12 20:24:40 +04001200 flash->page_size = info->page_size;
Brian Norrisb54f47c2012-01-31 00:06:03 -08001201 flash->mtd.writebufsize = flash->page_size;
Kevin Cernekee4b7f7422010-10-30 21:11:03 -07001202
Sourav Poddar8552b432013-11-06 20:05:34 +05301203 if (np) {
Brian Norrisddba7c52013-08-19 21:30:22 -07001204 /* If we were instantiated by DT, use it */
Sourav Poddar8552b432013-11-06 20:05:34 +05301205 if (of_property_read_bool(np, "m25p,fast-read"))
1206 flash->flash_read = M25P80_FAST;
Brian Norris99ed1a12013-12-04 22:59:40 -08001207 else
1208 flash->flash_read = M25P80_NORMAL;
Sourav Poddar8552b432013-11-06 20:05:34 +05301209 } else {
Brian Norrisddba7c52013-08-19 21:30:22 -07001210 /* If we weren't instantiated by DT, default to fast-read */
Sourav Poddar8552b432013-11-06 20:05:34 +05301211 flash->flash_read = M25P80_FAST;
1212 }
Marek Vasut12ad2be2012-09-24 03:39:39 +02001213
Brian Norrisddba7c52013-08-19 21:30:22 -07001214 /* Some devices cannot do fast-read, no matter what DT tells us */
Sascha Hauer58146992013-08-20 09:54:40 +02001215 if (info->flags & M25P_NO_FR)
Sourav Poddar8552b432013-11-06 20:05:34 +05301216 flash->flash_read = M25P80_NORMAL;
Marek Vasut12ad2be2012-09-24 03:39:39 +02001217
Sourav Poddar3487a6392013-11-06 20:05:35 +05301218 /* Quad-read mode takes precedence over fast/normal */
1219 if (spi->mode & SPI_RX_QUAD && info->flags & M25P80_QUAD_READ) {
1220 ret = set_quad_mode(flash, info->jedec_id);
1221 if (ret) {
1222 dev_err(&flash->spi->dev, "quad mode not supported\n");
1223 return ret;
1224 }
1225 flash->flash_read = M25P80_QUAD;
1226 }
1227
Brian Norris87c95112013-04-11 01:34:57 -07001228 /* Default commands */
Sourav Poddar8552b432013-11-06 20:05:34 +05301229 switch (flash->flash_read) {
Sourav Poddar3487a6392013-11-06 20:05:35 +05301230 case M25P80_QUAD:
1231 flash->read_opcode = OPCODE_QUAD_READ;
1232 break;
Sourav Poddar8552b432013-11-06 20:05:34 +05301233 case M25P80_FAST:
Brian Norris87c95112013-04-11 01:34:57 -07001234 flash->read_opcode = OPCODE_FAST_READ;
Sourav Poddar8552b432013-11-06 20:05:34 +05301235 break;
1236 case M25P80_NORMAL:
Brian Norris87c95112013-04-11 01:34:57 -07001237 flash->read_opcode = OPCODE_NORM_READ;
Sourav Poddar8552b432013-11-06 20:05:34 +05301238 break;
1239 default:
1240 dev_err(&flash->spi->dev, "No Read opcode defined\n");
1241 return -EINVAL;
1242 }
Brian Norris87c95112013-04-11 01:34:57 -07001243
1244 flash->program_opcode = OPCODE_PP;
1245
Kevin Cernekee4b7f7422010-10-30 21:11:03 -07001246 if (info->addr_width)
1247 flash->addr_width = info->addr_width;
Brian Norris87c95112013-04-11 01:34:57 -07001248 else if (flash->mtd.size > 0x1000000) {
Kevin Cernekee4b7f7422010-10-30 21:11:03 -07001249 /* enable 4-byte addressing if the device exceeds 16MiB */
Brian Norris87c95112013-04-11 01:34:57 -07001250 flash->addr_width = 4;
1251 if (JEDEC_MFR(info->jedec_id) == CFI_MFR_AMD) {
1252 /* Dedicated 4-byte command set */
Sourav Poddar8552b432013-11-06 20:05:34 +05301253 switch (flash->flash_read) {
Sourav Poddar3487a6392013-11-06 20:05:35 +05301254 case M25P80_QUAD:
Geert Uytterhoeven7587f642014-01-15 16:48:55 +01001255 flash->read_opcode = OPCODE_QUAD_READ_4B;
Sourav Poddar3487a6392013-11-06 20:05:35 +05301256 break;
Sourav Poddar8552b432013-11-06 20:05:34 +05301257 case M25P80_FAST:
1258 flash->read_opcode = OPCODE_FAST_READ_4B;
1259 break;
1260 case M25P80_NORMAL:
1261 flash->read_opcode = OPCODE_NORM_READ_4B;
1262 break;
1263 }
Brian Norris87c95112013-04-11 01:34:57 -07001264 flash->program_opcode = OPCODE_PP_4B;
1265 /* No small sector erase for 4-byte command set */
1266 flash->erase_opcode = OPCODE_SE_4B;
1267 flash->mtd.erasesize = info->sector_size;
Kevin Cernekee4b7f7422010-10-30 21:11:03 -07001268 } else
Brian Norris87c95112013-04-11 01:34:57 -07001269 set_4byte(flash, info->jedec_id, 1);
1270 } else {
1271 flash->addr_width = 3;
Kevin Cernekee4b7f7422010-10-30 21:11:03 -07001272 }
Artem Bityutskiyd85316a2008-12-18 14:10:05 +02001273
Anton Vorontsovb34bc032009-10-12 20:24:35 +04001274 dev_info(&spi->dev, "%s (%lld Kbytes)\n", id->name,
Mike Lavender2f9f7622006-01-08 13:34:27 -08001275 (long long)flash->mtd.size >> 10);
1276
Brian Norris289c0522011-07-19 10:06:09 -07001277 pr_debug("mtd .name = %s, .size = 0x%llx (%lldMiB) "
David Woodhouse02d087d2007-06-28 22:38:38 +01001278 ".erasesize = 0x%.8x (%uKiB) .numeraseregions = %d\n",
Mike Lavender2f9f7622006-01-08 13:34:27 -08001279 flash->mtd.name,
Artem Bityutskiyd85316a2008-12-18 14:10:05 +02001280 (long long)flash->mtd.size, (long long)(flash->mtd.size >> 20),
Mike Lavender2f9f7622006-01-08 13:34:27 -08001281 flash->mtd.erasesize, flash->mtd.erasesize / 1024,
1282 flash->mtd.numeraseregions);
1283
1284 if (flash->mtd.numeraseregions)
1285 for (i = 0; i < flash->mtd.numeraseregions; i++)
Brian Norris289c0522011-07-19 10:06:09 -07001286 pr_debug("mtd.eraseregions[%d] = { .offset = 0x%llx, "
David Woodhouse02d087d2007-06-28 22:38:38 +01001287 ".erasesize = 0x%.8x (%uKiB), "
Mike Lavender2f9f7622006-01-08 13:34:27 -08001288 ".numblocks = %d }\n",
Artem Bityutskiyd85316a2008-12-18 14:10:05 +02001289 i, (long long)flash->mtd.eraseregions[i].offset,
Mike Lavender2f9f7622006-01-08 13:34:27 -08001290 flash->mtd.eraseregions[i].erasesize,
1291 flash->mtd.eraseregions[i].erasesize / 1024,
1292 flash->mtd.eraseregions[i].numblocks);
1293
1294
1295 /* partitions should match sector boundaries; and it may be good to
1296 * use readonly partitions for writeprotected sectors (BP2..BP0).
1297 */
Dmitry Eremin-Solenikov871770b2011-06-02 17:59:16 +04001298 return mtd_device_parse_register(&flash->mtd, NULL, &ppdata,
1299 data ? data->parts : NULL,
1300 data ? data->nr_parts : 0);
Mike Lavender2f9f7622006-01-08 13:34:27 -08001301}
1302
1303
Bill Pemberton810b7e02012-11-19 13:26:04 -05001304static int m25p_remove(struct spi_device *spi)
Mike Lavender2f9f7622006-01-08 13:34:27 -08001305{
Jingoo Han975aefc2013-04-06 15:41:32 +09001306 struct m25p *flash = spi_get_drvdata(spi);
Mike Lavender2f9f7622006-01-08 13:34:27 -08001307
1308 /* Clean up MTD stuff. */
Brian Norris9650b9b2013-10-27 15:42:12 -07001309 return mtd_device_unregister(&flash->mtd);
Mike Lavender2f9f7622006-01-08 13:34:27 -08001310}
1311
1312
1313static struct spi_driver m25p80_driver = {
1314 .driver = {
1315 .name = "m25p80",
Mike Lavender2f9f7622006-01-08 13:34:27 -08001316 .owner = THIS_MODULE,
1317 },
Anton Vorontsovb34bc032009-10-12 20:24:35 +04001318 .id_table = m25p_ids,
Mike Lavender2f9f7622006-01-08 13:34:27 -08001319 .probe = m25p_probe,
Bill Pemberton5153b882012-11-19 13:21:24 -05001320 .remove = m25p_remove,
David Brownellfa0a8c72007-06-24 15:12:35 -07001321
1322 /* REVISIT: many of these chips have deep power-down modes, which
1323 * should clearly be entered on suspend() to minimize power use.
1324 * And also when they're otherwise idle...
1325 */
Mike Lavender2f9f7622006-01-08 13:34:27 -08001326};
1327
Axel Linc9d1b752012-01-27 15:45:20 +08001328module_spi_driver(m25p80_driver);
Mike Lavender2f9f7622006-01-08 13:34:27 -08001329
1330MODULE_LICENSE("GPL");
1331MODULE_AUTHOR("Mike Lavender");
1332MODULE_DESCRIPTION("MTD SPI driver for ST M25Pxx flash chips");