1
2
3
4
5
6
7
8#ifndef __LINUX_MTD_SPINAND_H
9#define __LINUX_MTD_SPINAND_H
10
11#ifndef __UBOOT__
12#include <linux/mutex.h>
13#include <linux/bitops.h>
14#include <linux/device.h>
15#include <linux/mtd/mtd.h>
16#include <linux/mtd/nand.h>
17#include <linux/spi/spi.h>
18#include <linux/spi/spi-mem.h>
19#else
20#include <common.h>
21#include <spi.h>
22#include <spi-mem.h>
23#include <linux/mtd/nand.h>
24#endif
25
26
27
28
29
30#define SPINAND_RESET_OP \
31 SPI_MEM_OP(SPI_MEM_OP_CMD(0xff, 1), \
32 SPI_MEM_OP_NO_ADDR, \
33 SPI_MEM_OP_NO_DUMMY, \
34 SPI_MEM_OP_NO_DATA)
35
36#define SPINAND_WR_EN_DIS_OP(enable) \
37 SPI_MEM_OP(SPI_MEM_OP_CMD((enable) ? 0x06 : 0x04, 1), \
38 SPI_MEM_OP_NO_ADDR, \
39 SPI_MEM_OP_NO_DUMMY, \
40 SPI_MEM_OP_NO_DATA)
41
42#define SPINAND_READID_OP(ndummy, buf, len) \
43 SPI_MEM_OP(SPI_MEM_OP_CMD(0x9f, 1), \
44 SPI_MEM_OP_NO_ADDR, \
45 SPI_MEM_OP_DUMMY(ndummy, 1), \
46 SPI_MEM_OP_DATA_IN(len, buf, 1))
47
48#define SPINAND_SET_FEATURE_OP(reg, valptr) \
49 SPI_MEM_OP(SPI_MEM_OP_CMD(0x1f, 1), \
50 SPI_MEM_OP_ADDR(1, reg, 1), \
51 SPI_MEM_OP_NO_DUMMY, \
52 SPI_MEM_OP_DATA_OUT(1, valptr, 1))
53
54#define SPINAND_GET_FEATURE_OP(reg, valptr) \
55 SPI_MEM_OP(SPI_MEM_OP_CMD(0x0f, 1), \
56 SPI_MEM_OP_ADDR(1, reg, 1), \
57 SPI_MEM_OP_NO_DUMMY, \
58 SPI_MEM_OP_DATA_IN(1, valptr, 1))
59
60#define SPINAND_BLK_ERASE_OP(addr) \
61 SPI_MEM_OP(SPI_MEM_OP_CMD(0xd8, 1), \
62 SPI_MEM_OP_ADDR(3, addr, 1), \
63 SPI_MEM_OP_NO_DUMMY, \
64 SPI_MEM_OP_NO_DATA)
65
66#define SPINAND_PAGE_READ_OP(addr) \
67 SPI_MEM_OP(SPI_MEM_OP_CMD(0x13, 1), \
68 SPI_MEM_OP_ADDR(3, addr, 1), \
69 SPI_MEM_OP_NO_DUMMY, \
70 SPI_MEM_OP_NO_DATA)
71
72#define SPINAND_PAGE_READ_FROM_CACHE_OP(fast, addr, ndummy, buf, len) \
73 SPI_MEM_OP(SPI_MEM_OP_CMD(fast ? 0x0b : 0x03, 1), \
74 SPI_MEM_OP_ADDR(2, addr, 1), \
75 SPI_MEM_OP_DUMMY(ndummy, 1), \
76 SPI_MEM_OP_DATA_IN(len, buf, 1))
77
78#define SPINAND_PAGE_READ_FROM_CACHE_X2_OP(addr, ndummy, buf, len) \
79 SPI_MEM_OP(SPI_MEM_OP_CMD(0x3b, 1), \
80 SPI_MEM_OP_ADDR(2, addr, 1), \
81 SPI_MEM_OP_DUMMY(ndummy, 1), \
82 SPI_MEM_OP_DATA_IN(len, buf, 2))
83
84#define SPINAND_PAGE_READ_FROM_CACHE_X4_OP(addr, ndummy, buf, len) \
85 SPI_MEM_OP(SPI_MEM_OP_CMD(0x6b, 1), \
86 SPI_MEM_OP_ADDR(2, addr, 1), \
87 SPI_MEM_OP_DUMMY(ndummy, 1), \
88 SPI_MEM_OP_DATA_IN(len, buf, 4))
89
90#define SPINAND_PAGE_READ_FROM_CACHE_DUALIO_OP(addr, ndummy, buf, len) \
91 SPI_MEM_OP(SPI_MEM_OP_CMD(0xbb, 1), \
92 SPI_MEM_OP_ADDR(2, addr, 2), \
93 SPI_MEM_OP_DUMMY(ndummy, 2), \
94 SPI_MEM_OP_DATA_IN(len, buf, 2))
95
96#define SPINAND_PAGE_READ_FROM_CACHE_QUADIO_OP(addr, ndummy, buf, len) \
97 SPI_MEM_OP(SPI_MEM_OP_CMD(0xeb, 1), \
98 SPI_MEM_OP_ADDR(2, addr, 4), \
99 SPI_MEM_OP_DUMMY(ndummy, 4), \
100 SPI_MEM_OP_DATA_IN(len, buf, 4))
101
102#define SPINAND_PROG_EXEC_OP(addr) \
103 SPI_MEM_OP(SPI_MEM_OP_CMD(0x10, 1), \
104 SPI_MEM_OP_ADDR(3, addr, 1), \
105 SPI_MEM_OP_NO_DUMMY, \
106 SPI_MEM_OP_NO_DATA)
107
108#define SPINAND_PROG_LOAD(reset, addr, buf, len) \
109 SPI_MEM_OP(SPI_MEM_OP_CMD(reset ? 0x02 : 0x84, 1), \
110 SPI_MEM_OP_ADDR(2, addr, 1), \
111 SPI_MEM_OP_NO_DUMMY, \
112 SPI_MEM_OP_DATA_OUT(len, buf, 1))
113
114#define SPINAND_PROG_LOAD_X4(reset, addr, buf, len) \
115 SPI_MEM_OP(SPI_MEM_OP_CMD(reset ? 0x32 : 0x34, 1), \
116 SPI_MEM_OP_ADDR(2, addr, 1), \
117 SPI_MEM_OP_NO_DUMMY, \
118 SPI_MEM_OP_DATA_OUT(len, buf, 4))
119
120
121
122
123#define SPINAND_CMD_PROG_LOAD_X4 0x32
124#define SPINAND_CMD_PROG_LOAD_RDM_DATA_X4 0x34
125
126
127#define REG_BLOCK_LOCK 0xa0
128#define BL_ALL_UNLOCKED 0x00
129
130
131#define REG_CFG 0xb0
132#define CFG_OTP_ENABLE BIT(6)
133#define CFG_ECC_ENABLE BIT(4)
134#define CFG_QUAD_ENABLE BIT(0)
135
136
137#define REG_STATUS 0xc0
138#define STATUS_BUSY BIT(0)
139#define STATUS_ERASE_FAILED BIT(2)
140#define STATUS_PROG_FAILED BIT(3)
141#define STATUS_ECC_MASK GENMASK(5, 4)
142#define STATUS_ECC_NO_BITFLIPS (0 << 4)
143#define STATUS_ECC_HAS_BITFLIPS (1 << 4)
144#define STATUS_ECC_UNCOR_ERROR (2 << 4)
145
146struct spinand_op;
147struct spinand_device;
148
149#define SPINAND_MAX_ID_LEN 4
150
151
152
153
154
155
156
157
158
159
160
161
162struct spinand_id {
163 u8 data[SPINAND_MAX_ID_LEN];
164 int len;
165};
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185struct spinand_manufacturer_ops {
186 int (*detect)(struct spinand_device *spinand);
187 int (*init)(struct spinand_device *spinand);
188 void (*cleanup)(struct spinand_device *spinand);
189};
190
191
192
193
194
195
196
197struct spinand_manufacturer {
198 u8 id;
199 char *name;
200 const struct spinand_manufacturer_ops *ops;
201};
202
203
204extern const struct spinand_manufacturer gigadevice_spinand_manufacturer;
205extern const struct spinand_manufacturer macronix_spinand_manufacturer;
206extern const struct spinand_manufacturer micron_spinand_manufacturer;
207extern const struct spinand_manufacturer toshiba_spinand_manufacturer;
208extern const struct spinand_manufacturer winbond_spinand_manufacturer;
209
210
211
212
213
214
215
216
217
218
219
220
221struct spinand_op_variants {
222 const struct spi_mem_op *ops;
223 unsigned int nops;
224};
225
226#define SPINAND_OP_VARIANTS(name, ...) \
227 const struct spinand_op_variants name = { \
228 .ops = (struct spi_mem_op[]) { __VA_ARGS__ }, \
229 .nops = sizeof((struct spi_mem_op[]){ __VA_ARGS__ }) / \
230 sizeof(struct spi_mem_op), \
231 }
232
233
234
235
236
237
238
239
240
241
242
243struct spinand_ecc_info {
244 int (*get_status)(struct spinand_device *spinand, u8 status);
245 const struct mtd_ooblayout_ops *ooblayout;
246};
247
248#define SPINAND_HAS_QE_BIT BIT(0)
249#define SPINAND_HAS_CR_FEAT_BIT BIT(1)
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269struct spinand_info {
270 const char *model;
271 u8 devid;
272 u32 flags;
273 struct nand_memory_organization memorg;
274 struct nand_ecc_req eccreq;
275 struct spinand_ecc_info eccinfo;
276 struct {
277 const struct spinand_op_variants *read_cache;
278 const struct spinand_op_variants *write_cache;
279 const struct spinand_op_variants *update_cache;
280 } op_variants;
281 int (*select_target)(struct spinand_device *spinand,
282 unsigned int target);
283};
284
285#define SPINAND_INFO_OP_VARIANTS(__read, __write, __update) \
286 { \
287 .read_cache = __read, \
288 .write_cache = __write, \
289 .update_cache = __update, \
290 }
291
292#define SPINAND_ECCINFO(__ooblayout, __get_status) \
293 .eccinfo = { \
294 .ooblayout = __ooblayout, \
295 .get_status = __get_status, \
296 }
297
298#define SPINAND_SELECT_TARGET(__func) \
299 .select_target = __func,
300
301#define SPINAND_INFO(__model, __id, __memorg, __eccreq, __op_variants, \
302 __flags, ...) \
303 { \
304 .model = __model, \
305 .devid = __id, \
306 .memorg = __memorg, \
307 .eccreq = __eccreq, \
308 .op_variants = __op_variants, \
309 .flags = __flags, \
310 __VA_ARGS__ \
311 }
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339struct spinand_device {
340 struct nand_device base;
341#ifndef __UBOOT__
342 struct spi_mem *spimem;
343 struct mutex lock;
344#else
345 struct spi_slave *slave;
346#endif
347 struct spinand_id id;
348 u32 flags;
349
350 struct {
351 const struct spi_mem_op *read_cache;
352 const struct spi_mem_op *write_cache;
353 const struct spi_mem_op *update_cache;
354 } op_templates;
355
356 int (*select_target)(struct spinand_device *spinand,
357 unsigned int target);
358 unsigned int cur_target;
359
360 struct spinand_ecc_info eccinfo;
361
362 u8 *cfg_cache;
363 u8 *databuf;
364 u8 *oobbuf;
365 u8 *scratchbuf;
366 const struct spinand_manufacturer *manufacturer;
367 void *priv;
368};
369
370
371
372
373
374
375
376static inline struct spinand_device *mtd_to_spinand(struct mtd_info *mtd)
377{
378 return container_of(mtd_to_nanddev(mtd), struct spinand_device, base);
379}
380
381
382
383
384
385
386
387static inline struct mtd_info *spinand_to_mtd(struct spinand_device *spinand)
388{
389 return nanddev_to_mtd(&spinand->base);
390}
391
392
393
394
395
396
397
398static inline struct spinand_device *nand_to_spinand(struct nand_device *nand)
399{
400 return container_of(nand, struct spinand_device, base);
401}
402
403
404
405
406
407
408
409static inline struct nand_device *
410spinand_to_nand(struct spinand_device *spinand)
411{
412 return &spinand->base;
413}
414
415
416
417
418
419
420
421
422static inline void spinand_set_of_node(struct spinand_device *spinand,
423 const struct device_node *np)
424{
425 nanddev_set_of_node(&spinand->base, np);
426}
427
428int spinand_match_and_init(struct spinand_device *dev,
429 const struct spinand_info *table,
430 unsigned int table_size, u8 devid);
431
432int spinand_upd_cfg(struct spinand_device *spinand, u8 mask, u8 val);
433int spinand_select_target(struct spinand_device *spinand, unsigned int target);
434
435#endif
436