2 * st_spi_fsm.c - ST Fast Sequence Mode (FSM) Serial Flash Controller
4 * Author: Angus Clark <angus.clark@st.com>
6 * Copyright (C) 2010-2014 STMicroelectronics Limited
8 * JEDEC probe based on drivers/mtd/devices/m25p80.c
10 * This code is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License version 2 as
12 * published by the Free Software Foundation.
15 #include <linux/kernel.h>
16 #include <linux/module.h>
17 #include <linux/regmap.h>
18 #include <linux/platform_device.h>
19 #include <linux/mfd/syscon.h>
20 #include <linux/mtd/mtd.h>
21 #include <linux/mtd/partitions.h>
22 #include <linux/sched.h>
23 #include <linux/delay.h>
27 #include "serial_flash_cmds.h"
30 * FSM SPI Controller Registers
32 #define SPI_CLOCKDIV 0x0010
33 #define SPI_MODESELECT 0x0018
34 #define SPI_CONFIGDATA 0x0020
35 #define SPI_STA_MODE_CHANGE 0x0028
36 #define SPI_FAST_SEQ_TRANSFER_SIZE 0x0100
37 #define SPI_FAST_SEQ_ADD1 0x0104
38 #define SPI_FAST_SEQ_ADD2 0x0108
39 #define SPI_FAST_SEQ_ADD_CFG 0x010c
40 #define SPI_FAST_SEQ_OPC1 0x0110
41 #define SPI_FAST_SEQ_OPC2 0x0114
42 #define SPI_FAST_SEQ_OPC3 0x0118
43 #define SPI_FAST_SEQ_OPC4 0x011c
44 #define SPI_FAST_SEQ_OPC5 0x0120
45 #define SPI_MODE_BITS 0x0124
46 #define SPI_DUMMY_BITS 0x0128
47 #define SPI_FAST_SEQ_FLASH_STA_DATA 0x012c
48 #define SPI_FAST_SEQ_1 0x0130
49 #define SPI_FAST_SEQ_2 0x0134
50 #define SPI_FAST_SEQ_3 0x0138
51 #define SPI_FAST_SEQ_4 0x013c
52 #define SPI_FAST_SEQ_CFG 0x0140
53 #define SPI_FAST_SEQ_STA 0x0144
54 #define SPI_QUAD_BOOT_SEQ_INIT_1 0x0148
55 #define SPI_QUAD_BOOT_SEQ_INIT_2 0x014c
56 #define SPI_QUAD_BOOT_READ_SEQ_1 0x0150
57 #define SPI_QUAD_BOOT_READ_SEQ_2 0x0154
58 #define SPI_PROGRAM_ERASE_TIME 0x0158
59 #define SPI_MULT_PAGE_REPEAT_SEQ_1 0x015c
60 #define SPI_MULT_PAGE_REPEAT_SEQ_2 0x0160
61 #define SPI_STATUS_WR_TIME_REG 0x0164
62 #define SPI_FAST_SEQ_DATA_REG 0x0300
65 * Register: SPI_MODESELECT
67 #define SPI_MODESELECT_CONTIG 0x01
68 #define SPI_MODESELECT_FASTREAD 0x02
69 #define SPI_MODESELECT_DUALIO 0x04
70 #define SPI_MODESELECT_FSM 0x08
71 #define SPI_MODESELECT_QUADBOOT 0x10
74 * Register: SPI_CONFIGDATA
76 #define SPI_CFG_DEVICE_ST 0x1
77 #define SPI_CFG_DEVICE_ATMEL 0x4
78 #define SPI_CFG_MIN_CS_HIGH(x) (((x) & 0xfff) << 4)
79 #define SPI_CFG_CS_SETUPHOLD(x) (((x) & 0xff) << 16)
80 #define SPI_CFG_DATA_HOLD(x) (((x) & 0xff) << 24)
82 #define SPI_CFG_DEFAULT_MIN_CS_HIGH SPI_CFG_MIN_CS_HIGH(0x0AA)
83 #define SPI_CFG_DEFAULT_CS_SETUPHOLD SPI_CFG_CS_SETUPHOLD(0xA0)
84 #define SPI_CFG_DEFAULT_DATA_HOLD SPI_CFG_DATA_HOLD(0x00)
87 * Register: SPI_FAST_SEQ_TRANSFER_SIZE
89 #define TRANSFER_SIZE(x) ((x) * 8)
92 * Register: SPI_FAST_SEQ_ADD_CFG
94 #define ADR_CFG_CYCLES_ADD1(x) ((x) << 0)
95 #define ADR_CFG_PADS_1_ADD1 (0x0 << 6)
96 #define ADR_CFG_PADS_2_ADD1 (0x1 << 6)
97 #define ADR_CFG_PADS_4_ADD1 (0x3 << 6)
98 #define ADR_CFG_CSDEASSERT_ADD1 (1 << 8)
99 #define ADR_CFG_CYCLES_ADD2(x) ((x) << (0+16))
100 #define ADR_CFG_PADS_1_ADD2 (0x0 << (6+16))
101 #define ADR_CFG_PADS_2_ADD2 (0x1 << (6+16))
102 #define ADR_CFG_PADS_4_ADD2 (0x3 << (6+16))
103 #define ADR_CFG_CSDEASSERT_ADD2 (1 << (8+16))
106 * Register: SPI_FAST_SEQ_n
108 #define SEQ_OPC_OPCODE(x) ((x) << 0)
109 #define SEQ_OPC_CYCLES(x) ((x) << 8)
110 #define SEQ_OPC_PADS_1 (0x0 << 14)
111 #define SEQ_OPC_PADS_2 (0x1 << 14)
112 #define SEQ_OPC_PADS_4 (0x3 << 14)
113 #define SEQ_OPC_CSDEASSERT (1 << 16)
116 * Register: SPI_FAST_SEQ_CFG
118 #define SEQ_CFG_STARTSEQ (1 << 0)
119 #define SEQ_CFG_SWRESET (1 << 5)
120 #define SEQ_CFG_CSDEASSERT (1 << 6)
121 #define SEQ_CFG_READNOTWRITE (1 << 7)
122 #define SEQ_CFG_ERASE (1 << 8)
123 #define SEQ_CFG_PADS_1 (0x0 << 16)
124 #define SEQ_CFG_PADS_2 (0x1 << 16)
125 #define SEQ_CFG_PADS_4 (0x3 << 16)
128 * Register: SPI_MODE_BITS
130 #define MODE_DATA(x) (x & 0xff)
131 #define MODE_CYCLES(x) ((x & 0x3f) << 16)
132 #define MODE_PADS_1 (0x0 << 22)
133 #define MODE_PADS_2 (0x1 << 22)
134 #define MODE_PADS_4 (0x3 << 22)
135 #define DUMMY_CSDEASSERT (1 << 24)
138 * Register: SPI_DUMMY_BITS
140 #define DUMMY_CYCLES(x) ((x & 0x3f) << 16)
141 #define DUMMY_PADS_1 (0x0 << 22)
142 #define DUMMY_PADS_2 (0x1 << 22)
143 #define DUMMY_PADS_4 (0x3 << 22)
144 #define DUMMY_CSDEASSERT (1 << 24)
147 * Register: SPI_FAST_SEQ_FLASH_STA_DATA
149 #define STA_DATA_BYTE1(x) ((x & 0xff) << 0)
150 #define STA_DATA_BYTE2(x) ((x & 0xff) << 8)
151 #define STA_PADS_1 (0x0 << 16)
152 #define STA_PADS_2 (0x1 << 16)
153 #define STA_PADS_4 (0x3 << 16)
154 #define STA_CSDEASSERT (0x1 << 20)
155 #define STA_RDNOTWR (0x1 << 21)
158 * FSM SPI Instruction Opcodes
160 #define STFSM_OPC_CMD 0x1
161 #define STFSM_OPC_ADD 0x2
162 #define STFSM_OPC_STA 0x3
163 #define STFSM_OPC_MODE 0x4
164 #define STFSM_OPC_DUMMY 0x5
165 #define STFSM_OPC_DATA 0x6
166 #define STFSM_OPC_WAIT 0x7
167 #define STFSM_OPC_JUMP 0x8
168 #define STFSM_OPC_GOTO 0x9
169 #define STFSM_OPC_STOP 0xF
172 * FSM SPI Instructions (== opcode + operand).
174 #define STFSM_INSTR(cmd, op) ((cmd) | ((op) << 4))
176 #define STFSM_INST_CMD1 STFSM_INSTR(STFSM_OPC_CMD, 1)
177 #define STFSM_INST_CMD2 STFSM_INSTR(STFSM_OPC_CMD, 2)
178 #define STFSM_INST_CMD3 STFSM_INSTR(STFSM_OPC_CMD, 3)
179 #define STFSM_INST_CMD4 STFSM_INSTR(STFSM_OPC_CMD, 4)
180 #define STFSM_INST_CMD5 STFSM_INSTR(STFSM_OPC_CMD, 5)
181 #define STFSM_INST_ADD1 STFSM_INSTR(STFSM_OPC_ADD, 1)
182 #define STFSM_INST_ADD2 STFSM_INSTR(STFSM_OPC_ADD, 2)
184 #define STFSM_INST_DATA_WRITE STFSM_INSTR(STFSM_OPC_DATA, 1)
185 #define STFSM_INST_DATA_READ STFSM_INSTR(STFSM_OPC_DATA, 2)
187 #define STFSM_INST_STA_RD1 STFSM_INSTR(STFSM_OPC_STA, 0x1)
188 #define STFSM_INST_STA_WR1 STFSM_INSTR(STFSM_OPC_STA, 0x1)
189 #define STFSM_INST_STA_RD2 STFSM_INSTR(STFSM_OPC_STA, 0x2)
190 #define STFSM_INST_STA_WR1_2 STFSM_INSTR(STFSM_OPC_STA, 0x3)
192 #define STFSM_INST_MODE STFSM_INSTR(STFSM_OPC_MODE, 0)
193 #define STFSM_INST_DUMMY STFSM_INSTR(STFSM_OPC_DUMMY, 0)
194 #define STFSM_INST_WAIT STFSM_INSTR(STFSM_OPC_WAIT, 0)
195 #define STFSM_INST_STOP STFSM_INSTR(STFSM_OPC_STOP, 0)
197 #define STFSM_DEFAULT_EMI_FREQ 100000000UL /* 100 MHz */
198 #define STFSM_DEFAULT_WR_TIME (STFSM_DEFAULT_EMI_FREQ * (15/1000)) /* 15ms */
200 #define STFSM_FLASH_SAFE_FREQ 10000000UL /* 10 MHz */
202 #define STFSM_MAX_WAIT_SEQ_MS 1000 /* FSM execution time */
205 #define FLASH_CMD_WREN 0x06
206 #define FLASH_CMD_WRDI 0x04
207 #define FLASH_CMD_RDID 0x9f
208 #define FLASH_CMD_RDSR 0x05
209 #define FLASH_CMD_RDSR2 0x35
210 #define FLASH_CMD_WRSR 0x01
211 #define FLASH_CMD_SE_4K 0x20
212 #define FLASH_CMD_SE_32K 0x52
213 #define FLASH_CMD_SE 0xd8
214 #define FLASH_CMD_CHIPERASE 0xc7
215 #define FLASH_CMD_WRVCR 0x81
216 #define FLASH_CMD_RDVCR 0x85
218 #define FLASH_CMD_READ 0x03 /* READ */
219 #define FLASH_CMD_READ_FAST 0x0b /* FAST READ */
220 #define FLASH_CMD_READ_1_1_2 0x3b /* DUAL OUTPUT READ */
221 #define FLASH_CMD_READ_1_2_2 0xbb /* DUAL I/O READ */
222 #define FLASH_CMD_READ_1_1_4 0x6b /* QUAD OUTPUT READ */
223 #define FLASH_CMD_READ_1_4_4 0xeb /* QUAD I/O READ */
225 #define FLASH_CMD_WRITE 0x02 /* PAGE PROGRAM */
226 #define FLASH_CMD_WRITE_1_1_2 0xa2 /* DUAL INPUT PROGRAM */
227 #define FLASH_CMD_WRITE_1_2_2 0xd2 /* DUAL INPUT EXT PROGRAM */
228 #define FLASH_CMD_WRITE_1_1_4 0x32 /* QUAD INPUT PROGRAM */
229 #define FLASH_CMD_WRITE_1_4_4 0x12 /* QUAD INPUT EXT PROGRAM */
231 #define FLASH_CMD_EN4B_ADDR 0xb7 /* Enter 4-byte address mode */
232 #define FLASH_CMD_EX4B_ADDR 0xe9 /* Exit 4-byte address mode */
234 /* READ commands with 32-bit addressing (N25Q256 and S25FLxxxS) */
235 #define FLASH_CMD_READ4 0x13
236 #define FLASH_CMD_READ4_FAST 0x0c
237 #define FLASH_CMD_READ4_1_1_2 0x3c
238 #define FLASH_CMD_READ4_1_2_2 0xbc
239 #define FLASH_CMD_READ4_1_1_4 0x6c
240 #define FLASH_CMD_READ4_1_4_4 0xec
242 /* S25FLxxxS commands */
243 #define S25FL_CMD_WRITE4_1_1_4 0x34
244 #define S25FL_CMD_SE4 0xdc
245 #define S25FL_CMD_CLSR 0x30
246 #define S25FL_CMD_DYBWR 0xe1
247 #define S25FL_CMD_DYBRD 0xe0
248 #define S25FL_CMD_WRITE4 0x12 /* Note, opcode clashes with
249 * 'FLASH_CMD_WRITE_1_4_4'
250 * as found on N25Qxxx devices! */
252 /* Status register */
253 #define FLASH_STATUS_BUSY 0x01
254 #define FLASH_STATUS_WEL 0x02
255 #define FLASH_STATUS_BP0 0x04
256 #define FLASH_STATUS_BP1 0x08
257 #define FLASH_STATUS_BP2 0x10
258 #define FLASH_STATUS_SRWP0 0x80
259 #define FLASH_STATUS_TIMEOUT 0xff
260 /* S25FL Error Flags */
261 #define S25FL_STATUS_E_ERR 0x20
262 #define S25FL_STATUS_P_ERR 0x40
264 #define FLASH_PAGESIZE 256 /* In Bytes */
265 #define FLASH_PAGESIZE_32 (FLASH_PAGESIZE / 4) /* In uint32_t */
266 #define FLASH_MAX_BUSY_WAIT (300 * HZ) /* Maximum 'CHIPERASE' time */
269 * Flags to tweak operation of default read/write/erase routines
271 #define CFG_READ_TOGGLE_32BIT_ADDR 0x00000001
272 #define CFG_WRITE_TOGGLE_32BIT_ADDR 0x00000002
273 #define CFG_WRITE_EX_32BIT_ADDR_DELAY 0x00000004
274 #define CFG_ERASESEC_TOGGLE_32BIT_ADDR 0x00000008
275 #define CFG_S25FL_CHECK_ERROR_FLAGS 0x00000010
288 } __packed __aligned(4);
293 struct resource *region;
296 struct flash_info *info;
298 uint32_t configuration;
299 uint32_t fifo_dir_delay;
300 bool booted_from_spi;
304 struct stfsm_seq stfsm_seq_read;
305 struct stfsm_seq stfsm_seq_write;
306 struct stfsm_seq stfsm_seq_en_32bit_addr;
309 /* Parameters to configure a READ or WRITE FSM sequence */
310 struct seq_rw_config {
311 uint32_t flags; /* flags to support config */
312 uint8_t cmd; /* FLASH command */
313 int write; /* Write Sequence */
314 uint8_t addr_pads; /* No. of addr pads (MODE & DUMMY) */
315 uint8_t data_pads; /* No. of data pads */
316 uint8_t mode_data; /* MODE data */
317 uint8_t mode_cycles; /* No. of MODE cycles */
318 uint8_t dummy_cycles; /* No. of DUMMY cycles */
321 /* SPI Flash Device Table */
325 * JEDEC id zero means "no ID" (most older chips); otherwise it has
326 * a high byte of zero plus three data bytes: the manufacturer id,
327 * then a two byte device id.
332 * The size listed here is what works with FLASH_CMD_SE, which isn't
333 * necessarily called a "sector" by the vendor.
335 unsigned sector_size;
339 * Note, where FAST_READ is supported, freq_max specifies the
340 * FAST_READ frequency, not the READ frequency.
343 int (*config)(struct stfsm *);
346 static int stfsm_n25q_config(struct stfsm *fsm);
347 static int stfsm_mx25_config(struct stfsm *fsm);
348 static int stfsm_s25fl_config(struct stfsm *fsm);
349 static int stfsm_w25q_config(struct stfsm *fsm);
351 static struct flash_info flash_types[] = {
353 * ST Microelectronics/Numonyx --
354 * (newer production versions may have feature updates
355 * (eg faster operating frequency)
357 #define M25P_FLAG (FLASH_FLAG_READ_WRITE | FLASH_FLAG_READ_FAST)
358 { "m25p40", 0x202013, 0, 64 * 1024, 8, M25P_FLAG, 25, NULL },
359 { "m25p80", 0x202014, 0, 64 * 1024, 16, M25P_FLAG, 25, NULL },
360 { "m25p16", 0x202015, 0, 64 * 1024, 32, M25P_FLAG, 25, NULL },
361 { "m25p32", 0x202016, 0, 64 * 1024, 64, M25P_FLAG, 50, NULL },
362 { "m25p64", 0x202017, 0, 64 * 1024, 128, M25P_FLAG, 50, NULL },
363 { "m25p128", 0x202018, 0, 256 * 1024, 64, M25P_FLAG, 50, NULL },
365 #define M25PX_FLAG (FLASH_FLAG_READ_WRITE | \
366 FLASH_FLAG_READ_FAST | \
367 FLASH_FLAG_READ_1_1_2 | \
368 FLASH_FLAG_WRITE_1_1_2)
369 { "m25px32", 0x207116, 0, 64 * 1024, 64, M25PX_FLAG, 75, NULL },
370 { "m25px64", 0x207117, 0, 64 * 1024, 128, M25PX_FLAG, 75, NULL },
372 #define MX25_FLAG (FLASH_FLAG_READ_WRITE | \
373 FLASH_FLAG_READ_FAST | \
374 FLASH_FLAG_READ_1_1_2 | \
375 FLASH_FLAG_READ_1_2_2 | \
376 FLASH_FLAG_READ_1_1_4 | \
377 FLASH_FLAG_READ_1_4_4 | \
380 { "mx25l25635e", 0xc22019, 0, 64*1024, 512,
381 (MX25_FLAG | FLASH_FLAG_32BIT_ADDR | FLASH_FLAG_RESET), 70,
384 #define N25Q_FLAG (FLASH_FLAG_READ_WRITE | \
385 FLASH_FLAG_READ_FAST | \
386 FLASH_FLAG_READ_1_1_2 | \
387 FLASH_FLAG_READ_1_2_2 | \
388 FLASH_FLAG_READ_1_1_4 | \
389 FLASH_FLAG_READ_1_4_4 | \
390 FLASH_FLAG_WRITE_1_1_2 | \
391 FLASH_FLAG_WRITE_1_2_2 | \
392 FLASH_FLAG_WRITE_1_1_4 | \
393 FLASH_FLAG_WRITE_1_4_4)
394 { "n25q128", 0x20ba18, 0, 64 * 1024, 256, N25Q_FLAG, 108,
396 { "n25q256", 0x20ba19, 0, 64 * 1024, 512,
397 N25Q_FLAG | FLASH_FLAG_32BIT_ADDR, 108, stfsm_n25q_config },
401 * - 256KiB and 64KiB sector variants (identified by ext. JEDEC)
403 #define S25FLXXXP_FLAG (FLASH_FLAG_READ_WRITE | \
404 FLASH_FLAG_READ_1_1_2 | \
405 FLASH_FLAG_READ_1_2_2 | \
406 FLASH_FLAG_READ_1_1_4 | \
407 FLASH_FLAG_READ_1_4_4 | \
408 FLASH_FLAG_WRITE_1_1_4 | \
409 FLASH_FLAG_READ_FAST)
410 { "s25fl129p0", 0x012018, 0x4d00, 256 * 1024, 64, S25FLXXXP_FLAG, 80,
411 stfsm_s25fl_config },
412 { "s25fl129p1", 0x012018, 0x4d01, 64 * 1024, 256, S25FLXXXP_FLAG, 80,
413 stfsm_s25fl_config },
417 * - 256KiB and 64KiB sector variants (identified by ext. JEDEC)
418 * - RESET# signal supported by die but not bristled out on all
419 * package types. The package type is a function of board design,
420 * so this information is captured in the board's flags.
421 * - Supports 'DYB' sector protection. Depending on variant, sectors
422 * may default to locked state on power-on.
424 #define S25FLXXXS_FLAG (S25FLXXXP_FLAG | \
426 FLASH_FLAG_DYB_LOCKING)
427 { "s25fl128s0", 0x012018, 0x0300, 256 * 1024, 64, S25FLXXXS_FLAG, 80,
428 stfsm_s25fl_config },
429 { "s25fl128s1", 0x012018, 0x0301, 64 * 1024, 256, S25FLXXXS_FLAG, 80,
430 stfsm_s25fl_config },
431 { "s25fl256s0", 0x010219, 0x4d00, 256 * 1024, 128,
432 S25FLXXXS_FLAG | FLASH_FLAG_32BIT_ADDR, 80, stfsm_s25fl_config },
433 { "s25fl256s1", 0x010219, 0x4d01, 64 * 1024, 512,
434 S25FLXXXS_FLAG | FLASH_FLAG_32BIT_ADDR, 80, stfsm_s25fl_config },
436 /* Winbond -- w25x "blocks" are 64K, "sectors" are 4KiB */
437 #define W25X_FLAG (FLASH_FLAG_READ_WRITE | \
438 FLASH_FLAG_READ_FAST | \
439 FLASH_FLAG_READ_1_1_2 | \
440 FLASH_FLAG_WRITE_1_1_2)
441 { "w25x40", 0xef3013, 0, 64 * 1024, 8, W25X_FLAG, 75, NULL },
442 { "w25x80", 0xef3014, 0, 64 * 1024, 16, W25X_FLAG, 75, NULL },
443 { "w25x16", 0xef3015, 0, 64 * 1024, 32, W25X_FLAG, 75, NULL },
444 { "w25x32", 0xef3016, 0, 64 * 1024, 64, W25X_FLAG, 75, NULL },
445 { "w25x64", 0xef3017, 0, 64 * 1024, 128, W25X_FLAG, 75, NULL },
447 /* Winbond -- w25q "blocks" are 64K, "sectors" are 4KiB */
448 #define W25Q_FLAG (FLASH_FLAG_READ_WRITE | \
449 FLASH_FLAG_READ_FAST | \
450 FLASH_FLAG_READ_1_1_2 | \
451 FLASH_FLAG_READ_1_2_2 | \
452 FLASH_FLAG_READ_1_1_4 | \
453 FLASH_FLAG_READ_1_4_4 | \
454 FLASH_FLAG_WRITE_1_1_4)
455 { "w25q80", 0xef4014, 0, 64 * 1024, 16, W25Q_FLAG, 80,
457 { "w25q16", 0xef4015, 0, 64 * 1024, 32, W25Q_FLAG, 80,
459 { "w25q32", 0xef4016, 0, 64 * 1024, 64, W25Q_FLAG, 80,
461 { "w25q64", 0xef4017, 0, 64 * 1024, 128, W25Q_FLAG, 80,
465 { NULL, 0x000000, 0, 0, 0, 0, 0, NULL },
469 * FSM message sequence configurations:
471 * All configs are presented in order of preference
474 /* Default READ configurations, in order of preference */
475 static struct seq_rw_config default_read_configs[] = {
476 {FLASH_FLAG_READ_1_4_4, FLASH_CMD_READ_1_4_4, 0, 4, 4, 0x00, 2, 4},
477 {FLASH_FLAG_READ_1_1_4, FLASH_CMD_READ_1_1_4, 0, 1, 4, 0x00, 4, 0},
478 {FLASH_FLAG_READ_1_2_2, FLASH_CMD_READ_1_2_2, 0, 2, 2, 0x00, 4, 0},
479 {FLASH_FLAG_READ_1_1_2, FLASH_CMD_READ_1_1_2, 0, 1, 2, 0x00, 0, 8},
480 {FLASH_FLAG_READ_FAST, FLASH_CMD_READ_FAST, 0, 1, 1, 0x00, 0, 8},
481 {FLASH_FLAG_READ_WRITE, FLASH_CMD_READ, 0, 1, 1, 0x00, 0, 0},
482 {0x00, 0, 0, 0, 0, 0x00, 0, 0},
485 /* Default WRITE configurations */
486 static struct seq_rw_config default_write_configs[] = {
487 {FLASH_FLAG_WRITE_1_4_4, FLASH_CMD_WRITE_1_4_4, 1, 4, 4, 0x00, 0, 0},
488 {FLASH_FLAG_WRITE_1_1_4, FLASH_CMD_WRITE_1_1_4, 1, 1, 4, 0x00, 0, 0},
489 {FLASH_FLAG_WRITE_1_2_2, FLASH_CMD_WRITE_1_2_2, 1, 2, 2, 0x00, 0, 0},
490 {FLASH_FLAG_WRITE_1_1_2, FLASH_CMD_WRITE_1_1_2, 1, 1, 2, 0x00, 0, 0},
491 {FLASH_FLAG_READ_WRITE, FLASH_CMD_WRITE, 1, 1, 1, 0x00, 0, 0},
492 {0x00, 0, 0, 0, 0, 0x00, 0, 0},
496 * [N25Qxxx] Configuration
498 #define N25Q_VCR_DUMMY_CYCLES(x) (((x) & 0xf) << 4)
499 #define N25Q_VCR_XIP_DISABLED ((uint8_t)0x1 << 3)
500 #define N25Q_VCR_WRAP_CONT 0x3
502 /* N25Q 3-byte Address READ configurations
503 * - 'FAST' variants configured for 8 dummy cycles.
505 * Note, the number of dummy cycles used for 'FAST' READ operations is
506 * configurable and would normally be tuned according to the READ command and
507 * operating frequency. However, this applies universally to all 'FAST' READ
508 * commands, including those used by the SPIBoot controller, and remains in
509 * force until the device is power-cycled. Since the SPIBoot controller is
510 * hard-wired to use 8 dummy cycles, we must configure the device to also use 8
513 static struct seq_rw_config n25q_read3_configs[] = {
514 {FLASH_FLAG_READ_1_4_4, FLASH_CMD_READ_1_4_4, 0, 4, 4, 0x00, 0, 8},
515 {FLASH_FLAG_READ_1_1_4, FLASH_CMD_READ_1_1_4, 0, 1, 4, 0x00, 0, 8},
516 {FLASH_FLAG_READ_1_2_2, FLASH_CMD_READ_1_2_2, 0, 2, 2, 0x00, 0, 8},
517 {FLASH_FLAG_READ_1_1_2, FLASH_CMD_READ_1_1_2, 0, 1, 2, 0x00, 0, 8},
518 {FLASH_FLAG_READ_FAST, FLASH_CMD_READ_FAST, 0, 1, 1, 0x00, 0, 8},
519 {FLASH_FLAG_READ_WRITE, FLASH_CMD_READ, 0, 1, 1, 0x00, 0, 0},
520 {0x00, 0, 0, 0, 0, 0x00, 0, 0},
523 /* N25Q 4-byte Address READ configurations
524 * - use special 4-byte address READ commands (reduces overheads, and
525 * reduces risk of hitting watchdog reset issues).
526 * - 'FAST' variants configured for 8 dummy cycles (see note above.)
528 static struct seq_rw_config n25q_read4_configs[] = {
529 {FLASH_FLAG_READ_1_4_4, FLASH_CMD_READ4_1_4_4, 0, 4, 4, 0x00, 0, 8},
530 {FLASH_FLAG_READ_1_1_4, FLASH_CMD_READ4_1_1_4, 0, 1, 4, 0x00, 0, 8},
531 {FLASH_FLAG_READ_1_2_2, FLASH_CMD_READ4_1_2_2, 0, 2, 2, 0x00, 0, 8},
532 {FLASH_FLAG_READ_1_1_2, FLASH_CMD_READ4_1_1_2, 0, 1, 2, 0x00, 0, 8},
533 {FLASH_FLAG_READ_FAST, FLASH_CMD_READ4_FAST, 0, 1, 1, 0x00, 0, 8},
534 {FLASH_FLAG_READ_WRITE, FLASH_CMD_READ4, 0, 1, 1, 0x00, 0, 0},
535 {0x00, 0, 0, 0, 0, 0x00, 0, 0},
539 * [MX25xxx] Configuration
541 #define MX25_STATUS_QE (0x1 << 6)
543 static int stfsm_mx25_en_32bit_addr_seq(struct stfsm_seq *seq)
545 seq->seq_opc[0] = (SEQ_OPC_PADS_1 |
547 SEQ_OPC_OPCODE(FLASH_CMD_EN4B_ADDR) |
550 seq->seq[0] = STFSM_INST_CMD1;
551 seq->seq[1] = STFSM_INST_WAIT;
552 seq->seq[2] = STFSM_INST_STOP;
554 seq->seq_cfg = (SEQ_CFG_PADS_1 |
556 SEQ_CFG_READNOTWRITE |
564 * [S25FLxxx] Configuration
566 #define STFSM_S25FL_CONFIG_QE (0x1 << 1)
569 * S25FLxxxS devices provide three ways of supporting 32-bit addressing: Bank
570 * Register, Extended Address Modes, and a 32-bit address command set. The
571 * 32-bit address command set is used here, since it avoids any problems with
572 * entering a state that is incompatible with the SPIBoot Controller.
574 static struct seq_rw_config stfsm_s25fl_read4_configs[] = {
575 {FLASH_FLAG_READ_1_4_4, FLASH_CMD_READ4_1_4_4, 0, 4, 4, 0x00, 2, 4},
576 {FLASH_FLAG_READ_1_1_4, FLASH_CMD_READ4_1_1_4, 0, 1, 4, 0x00, 0, 8},
577 {FLASH_FLAG_READ_1_2_2, FLASH_CMD_READ4_1_2_2, 0, 2, 2, 0x00, 4, 0},
578 {FLASH_FLAG_READ_1_1_2, FLASH_CMD_READ4_1_1_2, 0, 1, 2, 0x00, 0, 8},
579 {FLASH_FLAG_READ_FAST, FLASH_CMD_READ4_FAST, 0, 1, 1, 0x00, 0, 8},
580 {FLASH_FLAG_READ_WRITE, FLASH_CMD_READ4, 0, 1, 1, 0x00, 0, 0},
581 {0x00, 0, 0, 0, 0, 0x00, 0, 0},
584 static struct seq_rw_config stfsm_s25fl_write4_configs[] = {
585 {FLASH_FLAG_WRITE_1_1_4, S25FL_CMD_WRITE4_1_1_4, 1, 1, 4, 0x00, 0, 0},
586 {FLASH_FLAG_READ_WRITE, S25FL_CMD_WRITE4, 1, 1, 1, 0x00, 0, 0},
587 {0x00, 0, 0, 0, 0, 0x00, 0, 0},
591 * [W25Qxxx] Configuration
593 #define W25Q_STATUS_QE (0x1 << 9)
595 static struct stfsm_seq stfsm_seq_read_jedec = {
596 .data_size = TRANSFER_SIZE(8),
597 .seq_opc[0] = (SEQ_OPC_PADS_1 |
599 SEQ_OPC_OPCODE(FLASH_CMD_RDID)),
602 STFSM_INST_DATA_READ,
605 .seq_cfg = (SEQ_CFG_PADS_1 |
606 SEQ_CFG_READNOTWRITE |
611 static struct stfsm_seq stfsm_seq_read_status_fifo = {
612 .data_size = TRANSFER_SIZE(4),
613 .seq_opc[0] = (SEQ_OPC_PADS_1 |
615 SEQ_OPC_OPCODE(FLASH_CMD_RDSR)),
618 STFSM_INST_DATA_READ,
621 .seq_cfg = (SEQ_CFG_PADS_1 |
622 SEQ_CFG_READNOTWRITE |
627 static struct stfsm_seq stfsm_seq_erase_sector = {
628 /* 'addr_cfg' configured during initialisation */
630 (SEQ_OPC_PADS_1 | SEQ_OPC_CYCLES(8) |
631 SEQ_OPC_OPCODE(FLASH_CMD_WREN) | SEQ_OPC_CSDEASSERT),
633 (SEQ_OPC_PADS_1 | SEQ_OPC_CYCLES(8) |
634 SEQ_OPC_OPCODE(FLASH_CMD_SE)),
643 .seq_cfg = (SEQ_CFG_PADS_1 |
644 SEQ_CFG_READNOTWRITE |
649 static struct stfsm_seq stfsm_seq_erase_chip = {
651 (SEQ_OPC_PADS_1 | SEQ_OPC_CYCLES(8) |
652 SEQ_OPC_OPCODE(FLASH_CMD_WREN) | SEQ_OPC_CSDEASSERT),
654 (SEQ_OPC_PADS_1 | SEQ_OPC_CYCLES(8) |
655 SEQ_OPC_OPCODE(FLASH_CMD_CHIPERASE) | SEQ_OPC_CSDEASSERT),
663 .seq_cfg = (SEQ_CFG_PADS_1 |
665 SEQ_CFG_READNOTWRITE |
670 static struct stfsm_seq stfsm_seq_write_status = {
671 .seq_opc[0] = (SEQ_OPC_PADS_1 | SEQ_OPC_CYCLES(8) |
672 SEQ_OPC_OPCODE(FLASH_CMD_WREN) | SEQ_OPC_CSDEASSERT),
673 .seq_opc[1] = (SEQ_OPC_PADS_1 | SEQ_OPC_CYCLES(8) |
674 SEQ_OPC_OPCODE(FLASH_CMD_WRSR)),
681 .seq_cfg = (SEQ_CFG_PADS_1 |
682 SEQ_CFG_READNOTWRITE |
687 static struct stfsm_seq stfsm_seq_wrvcr = {
688 .seq_opc[0] = (SEQ_OPC_PADS_1 | SEQ_OPC_CYCLES(8) |
689 SEQ_OPC_OPCODE(FLASH_CMD_WREN) | SEQ_OPC_CSDEASSERT),
690 .seq_opc[1] = (SEQ_OPC_PADS_1 | SEQ_OPC_CYCLES(8) |
691 SEQ_OPC_OPCODE(FLASH_CMD_WRVCR)),
698 .seq_cfg = (SEQ_CFG_PADS_1 |
699 SEQ_CFG_READNOTWRITE |
704 static int stfsm_n25q_en_32bit_addr_seq(struct stfsm_seq *seq)
706 seq->seq_opc[0] = (SEQ_OPC_PADS_1 | SEQ_OPC_CYCLES(8) |
707 SEQ_OPC_OPCODE(FLASH_CMD_EN4B_ADDR));
708 seq->seq_opc[1] = (SEQ_OPC_PADS_1 | SEQ_OPC_CYCLES(8) |
709 SEQ_OPC_OPCODE(FLASH_CMD_WREN) |
712 seq->seq[0] = STFSM_INST_CMD2;
713 seq->seq[1] = STFSM_INST_CMD1;
714 seq->seq[2] = STFSM_INST_WAIT;
715 seq->seq[3] = STFSM_INST_STOP;
717 seq->seq_cfg = (SEQ_CFG_PADS_1 |
719 SEQ_CFG_READNOTWRITE |
726 static inline int stfsm_is_idle(struct stfsm *fsm)
728 return readl(fsm->base + SPI_FAST_SEQ_STA) & 0x10;
731 static inline uint32_t stfsm_fifo_available(struct stfsm *fsm)
733 return (readl(fsm->base + SPI_FAST_SEQ_STA) >> 5) & 0x7f;
736 static void stfsm_clear_fifo(struct stfsm *fsm)
741 avail = stfsm_fifo_available(fsm);
746 readl(fsm->base + SPI_FAST_SEQ_DATA_REG);
752 static inline void stfsm_load_seq(struct stfsm *fsm,
753 const struct stfsm_seq *seq)
755 void __iomem *dst = fsm->base + SPI_FAST_SEQ_TRANSFER_SIZE;
756 const uint32_t *src = (const uint32_t *)seq;
757 int words = sizeof(*seq) / sizeof(*src);
759 BUG_ON(!stfsm_is_idle(fsm));
768 static void stfsm_wait_seq(struct stfsm *fsm)
770 unsigned long deadline;
773 deadline = jiffies + msecs_to_jiffies(STFSM_MAX_WAIT_SEQ_MS);
776 if (time_after_eq(jiffies, deadline))
779 if (stfsm_is_idle(fsm))
785 dev_err(fsm->dev, "timeout on sequence completion\n");
788 static void stfsm_read_fifo(struct stfsm *fsm, uint32_t *buf, uint32_t size)
790 uint32_t remaining = size >> 2;
794 dev_dbg(fsm->dev, "Reading %d bytes from FIFO\n", size);
796 BUG_ON((((uint32_t)buf) & 0x3) || (size & 0x3));
800 avail = stfsm_fifo_available(fsm);
805 words = min(avail, remaining);
808 readsl(fsm->base + SPI_FAST_SEQ_DATA_REG, buf, words);
813 static int stfsm_write_fifo(struct stfsm *fsm, const uint32_t *buf,
816 uint32_t words = size >> 2;
818 dev_dbg(fsm->dev, "writing %d bytes to FIFO\n", size);
820 BUG_ON((((uint32_t)buf) & 0x3) || (size & 0x3));
822 writesl(fsm->base + SPI_FAST_SEQ_DATA_REG, buf, words);
827 static int stfsm_enter_32bit_addr(struct stfsm *fsm, int enter)
829 struct stfsm_seq *seq = &fsm->stfsm_seq_en_32bit_addr;
830 uint32_t cmd = enter ? FLASH_CMD_EN4B_ADDR : FLASH_CMD_EX4B_ADDR;
832 seq->seq_opc[0] = (SEQ_OPC_PADS_1 |
834 SEQ_OPC_OPCODE(cmd) |
837 stfsm_load_seq(fsm, seq);
844 static uint8_t stfsm_wait_busy(struct stfsm *fsm)
846 struct stfsm_seq *seq = &stfsm_seq_read_status_fifo;
847 unsigned long deadline;
852 seq->seq_opc[0] = (SEQ_OPC_PADS_1 |
854 SEQ_OPC_OPCODE(FLASH_CMD_RDSR));
856 /* Load read_status sequence */
857 stfsm_load_seq(fsm, seq);
860 * Repeat until busy bit is deasserted, or timeout, or error (S25FLxxxS)
862 deadline = jiffies + FLASH_MAX_BUSY_WAIT;
864 if (time_after_eq(jiffies, deadline))
869 stfsm_read_fifo(fsm, &status, 4);
871 if ((status & FLASH_STATUS_BUSY) == 0)
874 if ((fsm->configuration & CFG_S25FL_CHECK_ERROR_FLAGS) &&
875 ((status & S25FL_STATUS_P_ERR) ||
876 (status & S25FL_STATUS_E_ERR)))
877 return (uint8_t)(status & 0xff);
881 writel(seq->seq_cfg, fsm->base + SPI_FAST_SEQ_CFG);
886 dev_err(fsm->dev, "timeout on wait_busy\n");
888 return FLASH_STATUS_TIMEOUT;
891 static int stfsm_read_status(struct stfsm *fsm, uint8_t cmd,
894 struct stfsm_seq *seq = &stfsm_seq_read_status_fifo;
897 dev_dbg(fsm->dev, "reading STA[%s]\n",
898 (cmd == FLASH_CMD_RDSR) ? "1" : "2");
900 seq->seq_opc[0] = (SEQ_OPC_PADS_1 |
902 SEQ_OPC_OPCODE(cmd)),
904 stfsm_load_seq(fsm, seq);
906 stfsm_read_fifo(fsm, &tmp, 4);
908 *status = (uint8_t)(tmp >> 24);
915 static int stfsm_write_status(struct stfsm *fsm, uint16_t status,
918 struct stfsm_seq *seq = &stfsm_seq_write_status;
920 dev_dbg(fsm->dev, "writing STA[%s] 0x%04x\n",
921 (sta_bytes == 1) ? "1" : "1+2", status);
923 seq->status = (uint32_t)status | STA_PADS_1 | STA_CSDEASSERT;
924 seq->seq[2] = (sta_bytes == 1) ?
925 STFSM_INST_STA_WR1 : STFSM_INST_STA_WR1_2;
927 stfsm_load_seq(fsm, seq);
934 static int stfsm_wrvcr(struct stfsm *fsm, uint8_t data)
936 struct stfsm_seq *seq = &stfsm_seq_wrvcr;
938 dev_dbg(fsm->dev, "writing VCR 0x%02x\n", data);
940 seq->status = (STA_DATA_BYTE1(data) | STA_PADS_1 | STA_CSDEASSERT);
942 stfsm_load_seq(fsm, seq);
950 * SoC reset on 'boot-from-spi' systems
952 * Certain modes of operation cause the Flash device to enter a particular state
953 * for a period of time (e.g. 'Erase Sector', 'Quad Enable', and 'Enter 32-bit
954 * Addr' commands). On boot-from-spi systems, it is important to consider what
955 * happens if a warm reset occurs during this period. The SPIBoot controller
956 * assumes that Flash device is in its default reset state, 24-bit address mode,
957 * and ready to accept commands. This can be achieved using some form of
958 * on-board logic/controller to force a device POR in response to a SoC-level
959 * reset or by making use of the device reset signal if available (limited
960 * number of devices only).
962 * Failure to take such precautions can cause problems following a warm reset.
963 * For some operations (e.g. ERASE), there is little that can be done. For
964 * other modes of operation (e.g. 32-bit addressing), options are often
965 * available that can help minimise the window in which a reset could cause a
969 static bool stfsm_can_handle_soc_reset(struct stfsm *fsm)
971 /* Reset signal is available on the board and supported by the device */
972 if (fsm->reset_signal && fsm->info->flags & FLASH_FLAG_RESET)
975 /* Board-level logic forces a power-on-reset */
979 /* Reset is not properly handled and may result in failure to reboot */
983 /* Configure 'addr_cfg' according to addressing mode */
984 static void stfsm_prepare_erasesec_seq(struct stfsm *fsm,
985 struct stfsm_seq *seq)
987 int addr1_cycles = fsm->info->flags & FLASH_FLAG_32BIT_ADDR ? 16 : 8;
989 seq->addr_cfg = (ADR_CFG_CYCLES_ADD1(addr1_cycles) |
990 ADR_CFG_PADS_1_ADD1 |
991 ADR_CFG_CYCLES_ADD2(16) |
992 ADR_CFG_PADS_1_ADD2 |
993 ADR_CFG_CSDEASSERT_ADD2);
996 /* Search for preferred configuration based on available flags */
997 static struct seq_rw_config *
998 stfsm_search_seq_rw_configs(struct stfsm *fsm,
999 struct seq_rw_config cfgs[])
1001 struct seq_rw_config *config;
1002 int flags = fsm->info->flags;
1004 for (config = cfgs; config->cmd != 0; config++)
1005 if ((config->flags & flags) == config->flags)
1011 /* Prepare a READ/WRITE sequence according to configuration parameters */
1012 static void stfsm_prepare_rw_seq(struct stfsm *fsm,
1013 struct stfsm_seq *seq,
1014 struct seq_rw_config *cfg)
1016 int addr1_cycles, addr2_cycles;
1019 memset(seq, 0, sizeof(*seq));
1021 /* Add READ/WRITE OPC */
1022 seq->seq_opc[i++] = (SEQ_OPC_PADS_1 |
1024 SEQ_OPC_OPCODE(cfg->cmd));
1026 /* Add WREN OPC for a WRITE sequence */
1028 seq->seq_opc[i++] = (SEQ_OPC_PADS_1 |
1030 SEQ_OPC_OPCODE(FLASH_CMD_WREN) |
1031 SEQ_OPC_CSDEASSERT);
1033 /* Address configuration (24 or 32-bit addresses) */
1034 addr1_cycles = (fsm->info->flags & FLASH_FLAG_32BIT_ADDR) ? 16 : 8;
1035 addr1_cycles /= cfg->addr_pads;
1036 addr2_cycles = 16 / cfg->addr_pads;
1037 seq->addr_cfg = ((addr1_cycles & 0x3f) << 0 | /* ADD1 cycles */
1038 (cfg->addr_pads - 1) << 6 | /* ADD1 pads */
1039 (addr2_cycles & 0x3f) << 16 | /* ADD2 cycles */
1040 ((cfg->addr_pads - 1) << 22)); /* ADD2 pads */
1042 /* Data/Sequence configuration */
1043 seq->seq_cfg = ((cfg->data_pads - 1) << 16 |
1045 SEQ_CFG_CSDEASSERT);
1047 seq->seq_cfg |= SEQ_CFG_READNOTWRITE;
1049 /* Mode configuration (no. of pads taken from addr cfg) */
1050 seq->mode = ((cfg->mode_data & 0xff) << 0 | /* data */
1051 (cfg->mode_cycles & 0x3f) << 16 | /* cycles */
1052 (cfg->addr_pads - 1) << 22); /* pads */
1054 /* Dummy configuration (no. of pads taken from addr cfg) */
1055 seq->dummy = ((cfg->dummy_cycles & 0x3f) << 16 | /* cycles */
1056 (cfg->addr_pads - 1) << 22); /* pads */
1059 /* Instruction sequence */
1062 seq->seq[i++] = STFSM_INST_CMD2;
1064 seq->seq[i++] = STFSM_INST_CMD1;
1066 seq->seq[i++] = STFSM_INST_ADD1;
1067 seq->seq[i++] = STFSM_INST_ADD2;
1069 if (cfg->mode_cycles)
1070 seq->seq[i++] = STFSM_INST_MODE;
1072 if (cfg->dummy_cycles)
1073 seq->seq[i++] = STFSM_INST_DUMMY;
1076 cfg->write ? STFSM_INST_DATA_WRITE : STFSM_INST_DATA_READ;
1077 seq->seq[i++] = STFSM_INST_STOP;
1080 static int stfsm_search_prepare_rw_seq(struct stfsm *fsm,
1081 struct stfsm_seq *seq,
1082 struct seq_rw_config *cfgs)
1084 struct seq_rw_config *config;
1086 config = stfsm_search_seq_rw_configs(fsm, cfgs);
1088 dev_err(fsm->dev, "failed to find suitable config\n");
1092 stfsm_prepare_rw_seq(fsm, seq, config);
1097 /* Prepare a READ/WRITE/ERASE 'default' sequences */
1098 static int stfsm_prepare_rwe_seqs_default(struct stfsm *fsm)
1100 uint32_t flags = fsm->info->flags;
1103 /* Configure 'READ' sequence */
1104 ret = stfsm_search_prepare_rw_seq(fsm, &fsm->stfsm_seq_read,
1105 default_read_configs);
1108 "failed to prep READ sequence with flags [0x%08x]\n",
1113 /* Configure 'WRITE' sequence */
1114 ret = stfsm_search_prepare_rw_seq(fsm, &fsm->stfsm_seq_write,
1115 default_write_configs);
1118 "failed to prep WRITE sequence with flags [0x%08x]\n",
1123 /* Configure 'ERASE_SECTOR' sequence */
1124 stfsm_prepare_erasesec_seq(fsm, &stfsm_seq_erase_sector);
1129 static int stfsm_mx25_config(struct stfsm *fsm)
1131 uint32_t flags = fsm->info->flags;
1138 * Use default READ/WRITE sequences
1140 ret = stfsm_prepare_rwe_seqs_default(fsm);
1145 * Configure 32-bit Address Support
1147 if (flags & FLASH_FLAG_32BIT_ADDR) {
1148 /* Configure 'enter_32bitaddr' FSM sequence */
1149 stfsm_mx25_en_32bit_addr_seq(&fsm->stfsm_seq_en_32bit_addr);
1151 soc_reset = stfsm_can_handle_soc_reset(fsm);
1152 if (soc_reset || !fsm->booted_from_spi) {
1153 /* If we can handle SoC resets, we enable 32-bit address
1154 * mode pervasively */
1155 stfsm_enter_32bit_addr(fsm, 1);
1158 /* Else, enable/disable 32-bit addressing before/after
1160 fsm->configuration = (CFG_READ_TOGGLE_32BIT_ADDR |
1161 CFG_WRITE_TOGGLE_32BIT_ADDR |
1162 CFG_ERASESEC_TOGGLE_32BIT_ADDR);
1163 /* It seems a small delay is required after exiting
1164 * 32-bit mode following a write operation. The issue
1165 * is under investigation.
1167 fsm->configuration |= CFG_WRITE_EX_32BIT_ADDR_DELAY;
1171 /* For QUAD mode, set 'QE' STATUS bit */
1172 data_pads = ((fsm->stfsm_seq_read.seq_cfg >> 16) & 0x3) + 1;
1173 if (data_pads == 4) {
1174 stfsm_read_status(fsm, FLASH_CMD_RDSR, &sta);
1175 sta |= MX25_STATUS_QE;
1176 stfsm_write_status(fsm, sta, 1);
1182 static int stfsm_n25q_config(struct stfsm *fsm)
1184 uint32_t flags = fsm->info->flags;
1189 /* Configure 'READ' sequence */
1190 if (flags & FLASH_FLAG_32BIT_ADDR)
1191 ret = stfsm_search_prepare_rw_seq(fsm, &fsm->stfsm_seq_read,
1192 n25q_read4_configs);
1194 ret = stfsm_search_prepare_rw_seq(fsm, &fsm->stfsm_seq_read,
1195 n25q_read3_configs);
1198 "failed to prepare READ sequence with flags [0x%08x]\n",
1203 /* Configure 'WRITE' sequence (default configs) */
1204 ret = stfsm_search_prepare_rw_seq(fsm, &fsm->stfsm_seq_write,
1205 default_write_configs);
1208 "preparing WRITE sequence using flags [0x%08x] failed\n",
1213 /* * Configure 'ERASE_SECTOR' sequence */
1214 stfsm_prepare_erasesec_seq(fsm, &stfsm_seq_erase_sector);
1216 /* Configure 32-bit address support */
1217 if (flags & FLASH_FLAG_32BIT_ADDR) {
1218 stfsm_n25q_en_32bit_addr_seq(&fsm->stfsm_seq_en_32bit_addr);
1220 soc_reset = stfsm_can_handle_soc_reset(fsm);
1221 if (soc_reset || !fsm->booted_from_spi) {
1223 * If we can handle SoC resets, we enable 32-bit
1224 * address mode pervasively
1226 stfsm_enter_32bit_addr(fsm, 1);
1229 * If not, enable/disable for WRITE and ERASE
1230 * operations (READ uses special commands)
1232 fsm->configuration = (CFG_WRITE_TOGGLE_32BIT_ADDR |
1233 CFG_ERASESEC_TOGGLE_32BIT_ADDR);
1238 * Configure device to use 8 dummy cycles
1240 vcr = (N25Q_VCR_DUMMY_CYCLES(8) | N25Q_VCR_XIP_DISABLED |
1241 N25Q_VCR_WRAP_CONT);
1242 stfsm_wrvcr(fsm, vcr);
1247 static void stfsm_s25fl_prepare_erasesec_seq_32(struct stfsm_seq *seq)
1249 seq->seq_opc[1] = (SEQ_OPC_PADS_1 |
1251 SEQ_OPC_OPCODE(S25FL_CMD_SE4));
1253 seq->addr_cfg = (ADR_CFG_CYCLES_ADD1(16) |
1254 ADR_CFG_PADS_1_ADD1 |
1255 ADR_CFG_CYCLES_ADD2(16) |
1256 ADR_CFG_PADS_1_ADD2 |
1257 ADR_CFG_CSDEASSERT_ADD2);
1260 static void stfsm_s25fl_read_dyb(struct stfsm *fsm, uint32_t offs, uint8_t *dby)
1263 struct stfsm_seq seq = {
1264 .data_size = TRANSFER_SIZE(4),
1265 .seq_opc[0] = (SEQ_OPC_PADS_1 |
1267 SEQ_OPC_OPCODE(S25FL_CMD_DYBRD)),
1268 .addr_cfg = (ADR_CFG_CYCLES_ADD1(16) |
1269 ADR_CFG_PADS_1_ADD1 |
1270 ADR_CFG_CYCLES_ADD2(16) |
1271 ADR_CFG_PADS_1_ADD2),
1272 .addr1 = (offs >> 16) & 0xffff,
1273 .addr2 = offs & 0xffff,
1278 STFSM_INST_DATA_READ,
1281 .seq_cfg = (SEQ_CFG_PADS_1 |
1282 SEQ_CFG_READNOTWRITE |
1283 SEQ_CFG_CSDEASSERT |
1287 stfsm_load_seq(fsm, &seq);
1289 stfsm_read_fifo(fsm, &tmp, 4);
1291 *dby = (uint8_t)(tmp >> 24);
1293 stfsm_wait_seq(fsm);
1296 static void stfsm_s25fl_write_dyb(struct stfsm *fsm, uint32_t offs, uint8_t dby)
1298 struct stfsm_seq seq = {
1299 .seq_opc[0] = (SEQ_OPC_PADS_1 | SEQ_OPC_CYCLES(8) |
1300 SEQ_OPC_OPCODE(FLASH_CMD_WREN) |
1301 SEQ_OPC_CSDEASSERT),
1302 .seq_opc[1] = (SEQ_OPC_PADS_1 | SEQ_OPC_CYCLES(8) |
1303 SEQ_OPC_OPCODE(S25FL_CMD_DYBWR)),
1304 .addr_cfg = (ADR_CFG_CYCLES_ADD1(16) |
1305 ADR_CFG_PADS_1_ADD1 |
1306 ADR_CFG_CYCLES_ADD2(16) |
1307 ADR_CFG_PADS_1_ADD2),
1308 .status = (uint32_t)dby | STA_PADS_1 | STA_CSDEASSERT,
1309 .addr1 = (offs >> 16) & 0xffff,
1310 .addr2 = offs & 0xffff,
1319 .seq_cfg = (SEQ_CFG_PADS_1 |
1320 SEQ_CFG_READNOTWRITE |
1321 SEQ_CFG_CSDEASSERT |
1325 stfsm_load_seq(fsm, &seq);
1326 stfsm_wait_seq(fsm);
1328 stfsm_wait_busy(fsm);
1331 static int stfsm_s25fl_clear_status_reg(struct stfsm *fsm)
1333 struct stfsm_seq seq = {
1334 .seq_opc[0] = (SEQ_OPC_PADS_1 |
1336 SEQ_OPC_OPCODE(S25FL_CMD_CLSR) |
1337 SEQ_OPC_CSDEASSERT),
1338 .seq_opc[1] = (SEQ_OPC_PADS_1 |
1340 SEQ_OPC_OPCODE(FLASH_CMD_WRDI) |
1341 SEQ_OPC_CSDEASSERT),
1348 .seq_cfg = (SEQ_CFG_PADS_1 |
1350 SEQ_CFG_READNOTWRITE |
1351 SEQ_CFG_CSDEASSERT |
1355 stfsm_load_seq(fsm, &seq);
1357 stfsm_wait_seq(fsm);
1362 static int stfsm_s25fl_config(struct stfsm *fsm)
1364 struct flash_info *info = fsm->info;
1365 uint32_t flags = info->flags;
1369 uint8_t sr1, cr1, dyb;
1372 if (flags & FLASH_FLAG_32BIT_ADDR) {
1374 * Prepare Read/Write/Erase sequences according to S25FLxxx
1375 * 32-bit address command set
1377 ret = stfsm_search_prepare_rw_seq(fsm, &fsm->stfsm_seq_read,
1378 stfsm_s25fl_read4_configs);
1382 ret = stfsm_search_prepare_rw_seq(fsm, &fsm->stfsm_seq_write,
1383 stfsm_s25fl_write4_configs);
1387 stfsm_s25fl_prepare_erasesec_seq_32(&stfsm_seq_erase_sector);
1390 /* Use default configurations for 24-bit addressing */
1391 ret = stfsm_prepare_rwe_seqs_default(fsm);
1397 * For devices that support 'DYB' sector locking, check lock status and
1398 * unlock sectors if necessary (some variants power-on with sectors
1399 * locked by default)
1401 if (flags & FLASH_FLAG_DYB_LOCKING) {
1403 for (offs = 0; offs < info->sector_size * info->n_sectors;) {
1404 stfsm_s25fl_read_dyb(fsm, offs, &dyb);
1406 stfsm_s25fl_write_dyb(fsm, offs, 0xff);
1408 /* Handle bottom/top 4KiB parameter sectors */
1409 if ((offs < info->sector_size * 2) ||
1410 (offs >= (info->sector_size - info->n_sectors * 4)))
1417 /* Check status of 'QE' bit */
1418 data_pads = ((fsm->stfsm_seq_read.seq_cfg >> 16) & 0x3) + 1;
1419 stfsm_read_status(fsm, FLASH_CMD_RDSR2, &cr1);
1420 if (data_pads == 4) {
1421 if (!(cr1 & STFSM_S25FL_CONFIG_QE)) {
1423 cr1 |= STFSM_S25FL_CONFIG_QE;
1425 stfsm_read_status(fsm, FLASH_CMD_RDSR, &sr1);
1426 sta_wr = ((uint16_t)cr1 << 8) | sr1;
1428 stfsm_write_status(fsm, sta_wr, 2);
1430 stfsm_wait_busy(fsm);
1433 if ((cr1 & STFSM_S25FL_CONFIG_QE)) {
1435 cr1 &= ~STFSM_S25FL_CONFIG_QE;
1437 stfsm_read_status(fsm, FLASH_CMD_RDSR, &sr1);
1438 sta_wr = ((uint16_t)cr1 << 8) | sr1;
1440 stfsm_write_status(fsm, sta_wr, 2);
1442 stfsm_wait_busy(fsm);
1448 * S25FLxxx devices support Program and Error error flags.
1449 * Configure driver to check flags and clear if necessary.
1451 fsm->configuration |= CFG_S25FL_CHECK_ERROR_FLAGS;
1456 static int stfsm_w25q_config(struct stfsm *fsm)
1463 ret = stfsm_prepare_rwe_seqs_default(fsm);
1467 /* If using QUAD mode, set QE STATUS bit */
1468 data_pads = ((fsm->stfsm_seq_read.seq_cfg >> 16) & 0x3) + 1;
1469 if (data_pads == 4) {
1470 stfsm_read_status(fsm, FLASH_CMD_RDSR, &sta1);
1471 stfsm_read_status(fsm, FLASH_CMD_RDSR2, &sta2);
1473 sta_wr = ((uint16_t)sta2 << 8) | sta1;
1475 sta_wr |= W25Q_STATUS_QE;
1477 stfsm_write_status(fsm, sta_wr, 2);
1479 stfsm_wait_busy(fsm);
1485 static int stfsm_read(struct stfsm *fsm, uint8_t *buf, uint32_t size,
1488 struct stfsm_seq *seq = &fsm->stfsm_seq_read;
1495 uint32_t page_buf[FLASH_PAGESIZE_32];
1498 dev_dbg(fsm->dev, "reading %d bytes from 0x%08x\n", size, offset);
1500 /* Enter 32-bit address mode, if required */
1501 if (fsm->configuration & CFG_READ_TOGGLE_32BIT_ADDR)
1502 stfsm_enter_32bit_addr(fsm, 1);
1504 /* Must read in multiples of 32 cycles (or 32*pads/8 Bytes) */
1505 data_pads = ((seq->seq_cfg >> 16) & 0x3) + 1;
1506 read_mask = (data_pads << 2) - 1;
1508 /* Handle non-aligned buf */
1509 p = ((uint32_t)buf & 0x3) ? (uint8_t *)page_buf : buf;
1511 /* Handle non-aligned size */
1512 size_ub = (size + read_mask) & ~read_mask;
1513 size_lb = size & ~read_mask;
1514 size_mop = size & read_mask;
1516 seq->data_size = TRANSFER_SIZE(size_ub);
1517 seq->addr1 = (offset >> 16) & 0xffff;
1518 seq->addr2 = offset & 0xffff;
1520 stfsm_load_seq(fsm, seq);
1523 stfsm_read_fifo(fsm, (uint32_t *)p, size_lb);
1526 stfsm_read_fifo(fsm, tmp, read_mask + 1);
1527 memcpy(p + size_lb, &tmp, size_mop);
1530 /* Handle non-aligned buf */
1531 if ((uint32_t)buf & 0x3)
1532 memcpy(buf, page_buf, size);
1534 /* Wait for sequence to finish */
1535 stfsm_wait_seq(fsm);
1537 stfsm_clear_fifo(fsm);
1539 /* Exit 32-bit address mode, if required */
1540 if (fsm->configuration & CFG_READ_TOGGLE_32BIT_ADDR)
1541 stfsm_enter_32bit_addr(fsm, 0);
1546 static int stfsm_write(struct stfsm *fsm, const uint8_t *buf,
1547 uint32_t size, uint32_t offset)
1549 struct stfsm_seq *seq = &fsm->stfsm_seq_write;
1551 uint32_t write_mask;
1556 uint32_t page_buf[FLASH_PAGESIZE_32];
1557 uint8_t *t = (uint8_t *)&tmp;
1562 dev_dbg(fsm->dev, "writing %d bytes to 0x%08x\n", size, offset);
1564 /* Enter 32-bit address mode, if required */
1565 if (fsm->configuration & CFG_WRITE_TOGGLE_32BIT_ADDR)
1566 stfsm_enter_32bit_addr(fsm, 1);
1568 /* Must write in multiples of 32 cycles (or 32*pads/8 bytes) */
1569 data_pads = ((seq->seq_cfg >> 16) & 0x3) + 1;
1570 write_mask = (data_pads << 2) - 1;
1572 /* Handle non-aligned buf */
1573 if ((uint32_t)buf & 0x3) {
1574 memcpy(page_buf, buf, size);
1575 p = (uint8_t *)page_buf;
1580 /* Handle non-aligned size */
1581 size_ub = (size + write_mask) & ~write_mask;
1582 size_lb = size & ~write_mask;
1583 size_mop = size & write_mask;
1585 seq->data_size = TRANSFER_SIZE(size_ub);
1586 seq->addr1 = (offset >> 16) & 0xffff;
1587 seq->addr2 = offset & 0xffff;
1589 /* Need to set FIFO to write mode, before writing data to FIFO (see
1592 writel(0x00040000, fsm->base + SPI_FAST_SEQ_CFG);
1595 * Before writing data to the FIFO, apply a small delay to allow a
1596 * potential change of FIFO direction to complete.
1598 if (fsm->fifo_dir_delay == 0)
1599 readl(fsm->base + SPI_FAST_SEQ_CFG);
1601 udelay(fsm->fifo_dir_delay);
1604 /* Write data to FIFO, before starting sequence (see GNBvd79593) */
1606 stfsm_write_fifo(fsm, (uint32_t *)p, size_lb);
1610 /* Handle non-aligned size */
1612 memset(t, 0xff, write_mask + 1); /* fill with 0xff's */
1613 for (i = 0; i < size_mop; i++)
1616 stfsm_write_fifo(fsm, tmp, write_mask + 1);
1619 /* Start sequence */
1620 stfsm_load_seq(fsm, seq);
1622 /* Wait for sequence to finish */
1623 stfsm_wait_seq(fsm);
1625 /* Wait for completion */
1626 ret = stfsm_wait_busy(fsm);
1627 if (ret && fsm->configuration & CFG_S25FL_CHECK_ERROR_FLAGS)
1628 stfsm_s25fl_clear_status_reg(fsm);
1630 /* Exit 32-bit address mode, if required */
1631 if (fsm->configuration & CFG_WRITE_TOGGLE_32BIT_ADDR) {
1632 stfsm_enter_32bit_addr(fsm, 0);
1633 if (fsm->configuration & CFG_WRITE_EX_32BIT_ADDR_DELAY)
1641 * Read an address range from the flash chip. The address range
1642 * may be any size provided it is within the physical boundaries.
1644 static int stfsm_mtd_read(struct mtd_info *mtd, loff_t from, size_t len,
1645 size_t *retlen, u_char *buf)
1647 struct stfsm *fsm = dev_get_drvdata(mtd->dev.parent);
1650 dev_dbg(fsm->dev, "%s from 0x%08x, len %zd\n",
1651 __func__, (u32)from, len);
1653 mutex_lock(&fsm->lock);
1656 bytes = min_t(size_t, len, FLASH_PAGESIZE);
1658 stfsm_read(fsm, buf, bytes, from);
1667 mutex_unlock(&fsm->lock);
1672 static int stfsm_erase_sector(struct stfsm *fsm, uint32_t offset)
1674 struct stfsm_seq *seq = &stfsm_seq_erase_sector;
1677 dev_dbg(fsm->dev, "erasing sector at 0x%08x\n", offset);
1679 /* Enter 32-bit address mode, if required */
1680 if (fsm->configuration & CFG_ERASESEC_TOGGLE_32BIT_ADDR)
1681 stfsm_enter_32bit_addr(fsm, 1);
1683 seq->addr1 = (offset >> 16) & 0xffff;
1684 seq->addr2 = offset & 0xffff;
1686 stfsm_load_seq(fsm, seq);
1688 stfsm_wait_seq(fsm);
1690 /* Wait for completion */
1691 ret = stfsm_wait_busy(fsm);
1692 if (ret && fsm->configuration & CFG_S25FL_CHECK_ERROR_FLAGS)
1693 stfsm_s25fl_clear_status_reg(fsm);
1695 /* Exit 32-bit address mode, if required */
1696 if (fsm->configuration & CFG_ERASESEC_TOGGLE_32BIT_ADDR)
1697 stfsm_enter_32bit_addr(fsm, 0);
1702 static int stfsm_erase_chip(struct stfsm *fsm)
1704 const struct stfsm_seq *seq = &stfsm_seq_erase_chip;
1706 dev_dbg(fsm->dev, "erasing chip\n");
1708 stfsm_load_seq(fsm, seq);
1710 stfsm_wait_seq(fsm);
1712 return stfsm_wait_busy(fsm);
1716 * Write an address range to the flash chip. Data must be written in
1717 * FLASH_PAGESIZE chunks. The address range may be any size provided
1718 * it is within the physical boundaries.
1720 static int stfsm_mtd_write(struct mtd_info *mtd, loff_t to, size_t len,
1721 size_t *retlen, const u_char *buf)
1723 struct stfsm *fsm = dev_get_drvdata(mtd->dev.parent);
1727 uint8_t *b = (uint8_t *)buf;
1730 dev_dbg(fsm->dev, "%s to 0x%08x, len %zd\n", __func__, (u32)to, len);
1732 /* Offset within page */
1733 page_offs = to % FLASH_PAGESIZE;
1735 mutex_lock(&fsm->lock);
1738 /* Write up to page boundary */
1739 bytes = min(FLASH_PAGESIZE - page_offs, len);
1741 ret = stfsm_write(fsm, b, bytes, to);
1749 /* We are now page-aligned */
1757 mutex_unlock(&fsm->lock);
1763 * Erase an address range on the flash chip. The address range may extend
1764 * one or more erase sectors. Return an error is there is a problem erasing.
1766 static int stfsm_mtd_erase(struct mtd_info *mtd, struct erase_info *instr)
1768 struct stfsm *fsm = dev_get_drvdata(mtd->dev.parent);
1772 dev_dbg(fsm->dev, "%s at 0x%llx, len %lld\n", __func__,
1773 (long long)instr->addr, (long long)instr->len);
1778 mutex_lock(&fsm->lock);
1780 /* Whole-chip erase? */
1781 if (len == mtd->size) {
1782 ret = stfsm_erase_chip(fsm);
1787 ret = stfsm_erase_sector(fsm, addr);
1791 addr += mtd->erasesize;
1792 len -= mtd->erasesize;
1796 mutex_unlock(&fsm->lock);
1798 instr->state = MTD_ERASE_DONE;
1799 mtd_erase_callback(instr);
1804 instr->state = MTD_ERASE_FAILED;
1805 mutex_unlock(&fsm->lock);
1810 static void stfsm_read_jedec(struct stfsm *fsm, uint8_t *jedec)
1812 const struct stfsm_seq *seq = &stfsm_seq_read_jedec;
1815 stfsm_load_seq(fsm, seq);
1817 stfsm_read_fifo(fsm, tmp, 8);
1819 memcpy(jedec, tmp, 5);
1821 stfsm_wait_seq(fsm);
1824 static struct flash_info *stfsm_jedec_probe(struct stfsm *fsm)
1826 struct flash_info *info;
1831 stfsm_read_jedec(fsm, id);
1833 jedec = id[0] << 16 | id[1] << 8 | id[2];
1835 * JEDEC also defines an optional "extended device information"
1836 * string for after vendor-specific data, after the three bytes
1837 * we use here. Supporting some chips might require using it.
1839 ext_jedec = id[3] << 8 | id[4];
1841 dev_dbg(fsm->dev, "JEDEC = 0x%08x [%02x %02x %02x %02x %02x]\n",
1842 jedec, id[0], id[1], id[2], id[3], id[4]);
1844 for (info = flash_types; info->name; info++) {
1845 if (info->jedec_id == jedec) {
1846 if (info->ext_id && info->ext_id != ext_jedec)
1851 dev_err(fsm->dev, "Unrecognized JEDEC id %06x\n", jedec);
1856 static int stfsm_set_mode(struct stfsm *fsm, uint32_t mode)
1858 int ret, timeout = 10;
1860 /* Wait for controller to accept mode change */
1862 ret = readl(fsm->base + SPI_STA_MODE_CHANGE);
1871 writel(mode, fsm->base + SPI_MODESELECT);
1876 static void stfsm_set_freq(struct stfsm *fsm, uint32_t spi_freq)
1881 /* TODO: Make this dynamic */
1882 emi_freq = STFSM_DEFAULT_EMI_FREQ;
1885 * Calculate clk_div - values between 2 and 128
1886 * Multiple of 2, rounded up
1888 clk_div = 2 * DIV_ROUND_UP(emi_freq, 2 * spi_freq);
1891 else if (clk_div > 128)
1895 * Determine a suitable delay for the IP to complete a change of
1896 * direction of the FIFO. The required delay is related to the clock
1897 * divider used. The following heuristics are based on empirical tests,
1898 * using a 100MHz EMI clock.
1901 fsm->fifo_dir_delay = 0;
1902 else if (clk_div <= 10)
1903 fsm->fifo_dir_delay = 1;
1905 fsm->fifo_dir_delay = DIV_ROUND_UP(clk_div, 10);
1907 dev_dbg(fsm->dev, "emi_clk = %uHZ, spi_freq = %uHZ, clk_div = %u\n",
1908 emi_freq, spi_freq, clk_div);
1910 writel(clk_div, fsm->base + SPI_CLOCKDIV);
1913 static int stfsm_init(struct stfsm *fsm)
1917 /* Perform a soft reset of the FSM controller */
1918 writel(SEQ_CFG_SWRESET, fsm->base + SPI_FAST_SEQ_CFG);
1920 writel(0, fsm->base + SPI_FAST_SEQ_CFG);
1922 /* Set clock to 'safe' frequency initially */
1923 stfsm_set_freq(fsm, STFSM_FLASH_SAFE_FREQ);
1926 ret = stfsm_set_mode(fsm, SPI_MODESELECT_FSM);
1930 /* Set timing parameters */
1931 writel(SPI_CFG_DEVICE_ST |
1932 SPI_CFG_DEFAULT_MIN_CS_HIGH |
1933 SPI_CFG_DEFAULT_CS_SETUPHOLD |
1934 SPI_CFG_DEFAULT_DATA_HOLD,
1935 fsm->base + SPI_CONFIGDATA);
1936 writel(STFSM_DEFAULT_WR_TIME, fsm->base + SPI_STATUS_WR_TIME_REG);
1938 /* Clear FIFO, just in case */
1939 stfsm_clear_fifo(fsm);
1944 static void stfsm_fetch_platform_configs(struct platform_device *pdev)
1946 struct stfsm *fsm = platform_get_drvdata(pdev);
1947 struct device_node *np = pdev->dev.of_node;
1948 struct regmap *regmap;
1949 uint32_t boot_device_reg;
1950 uint32_t boot_device_spi;
1951 uint32_t boot_device; /* Value we read from *boot_device_reg */
1954 /* Booting from SPI NOR Flash is the default */
1955 fsm->booted_from_spi = true;
1957 regmap = syscon_regmap_lookup_by_phandle(np, "st,syscfg");
1959 goto boot_device_fail;
1961 fsm->reset_signal = of_property_read_bool(np, "st,reset-signal");
1963 fsm->reset_por = of_property_read_bool(np, "st,reset-por");
1965 /* Where in the syscon the boot device information lives */
1966 ret = of_property_read_u32(np, "st,boot-device-reg", &boot_device_reg);
1968 goto boot_device_fail;
1970 /* Boot device value when booted from SPI NOR */
1971 ret = of_property_read_u32(np, "st,boot-device-spi", &boot_device_spi);
1973 goto boot_device_fail;
1975 ret = regmap_read(regmap, boot_device_reg, &boot_device);
1977 goto boot_device_fail;
1979 if (boot_device != boot_device_spi)
1980 fsm->booted_from_spi = false;
1985 dev_warn(&pdev->dev,
1986 "failed to fetch boot device, assuming boot from SPI\n");
1989 static int stfsm_probe(struct platform_device *pdev)
1991 struct device_node *np = pdev->dev.of_node;
1992 struct mtd_part_parser_data ppdata;
1993 struct flash_info *info;
1994 struct resource *res;
1999 dev_err(&pdev->dev, "No DT found\n");
2002 ppdata.of_node = np;
2004 fsm = devm_kzalloc(&pdev->dev, sizeof(*fsm), GFP_KERNEL);
2008 fsm->dev = &pdev->dev;
2010 platform_set_drvdata(pdev, fsm);
2012 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
2014 dev_err(&pdev->dev, "Resource not found\n");
2018 fsm->base = devm_ioremap_resource(&pdev->dev, res);
2019 if (IS_ERR(fsm->base)) {
2021 "Failed to reserve memory region %pR\n", res);
2022 return PTR_ERR(fsm->base);
2025 mutex_init(&fsm->lock);
2027 ret = stfsm_init(fsm);
2029 dev_err(&pdev->dev, "Failed to initialise FSM Controller\n");
2033 stfsm_fetch_platform_configs(pdev);
2035 /* Detect SPI FLASH device */
2036 info = stfsm_jedec_probe(fsm);
2041 /* Use device size to determine address width */
2042 if (info->sector_size * info->n_sectors > 0x1000000)
2043 info->flags |= FLASH_FLAG_32BIT_ADDR;
2046 * Configure READ/WRITE/ERASE sequences according to platform and
2050 ret = info->config(fsm);
2054 ret = stfsm_prepare_rwe_seqs_default(fsm);
2059 fsm->mtd.name = info->name;
2060 fsm->mtd.dev.parent = &pdev->dev;
2061 fsm->mtd.type = MTD_NORFLASH;
2062 fsm->mtd.writesize = 4;
2063 fsm->mtd.writebufsize = fsm->mtd.writesize;
2064 fsm->mtd.flags = MTD_CAP_NORFLASH;
2065 fsm->mtd.size = info->sector_size * info->n_sectors;
2066 fsm->mtd.erasesize = info->sector_size;
2068 fsm->mtd._read = stfsm_mtd_read;
2069 fsm->mtd._write = stfsm_mtd_write;
2070 fsm->mtd._erase = stfsm_mtd_erase;
2072 dev_info(&pdev->dev,
2073 "Found serial flash device: %s\n"
2074 " size = %llx (%lldMiB) erasesize = 0x%08x (%uKiB)\n",
2076 (long long)fsm->mtd.size, (long long)(fsm->mtd.size >> 20),
2077 fsm->mtd.erasesize, (fsm->mtd.erasesize >> 10));
2079 return mtd_device_parse_register(&fsm->mtd, NULL, &ppdata, NULL, 0);
2082 static int stfsm_remove(struct platform_device *pdev)
2084 struct stfsm *fsm = platform_get_drvdata(pdev);
2086 return mtd_device_unregister(&fsm->mtd);
2089 static struct of_device_id stfsm_match[] = {
2090 { .compatible = "st,spi-fsm", },
2093 MODULE_DEVICE_TABLE(of, stfsm_match);
2095 static struct platform_driver stfsm_driver = {
2096 .probe = stfsm_probe,
2097 .remove = stfsm_remove,
2099 .name = "st-spi-fsm",
2100 .owner = THIS_MODULE,
2101 .of_match_table = stfsm_match,
2104 module_platform_driver(stfsm_driver);
2106 MODULE_AUTHOR("Angus Clark <angus.clark@st.com>");
2107 MODULE_DESCRIPTION("ST SPI FSM driver");
2108 MODULE_LICENSE("GPL");