Merge tag 'for-5.3/dm-changes' of git://git.kernel.org/pub/scm/linux/kernel/git/devic...
[platform/kernel/linux-rpi.git] / include / linux / mtd / cfi.h
1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2 /*
3  * Copyright © 2000-2010 David Woodhouse <dwmw2@infradead.org> et al.
4  */
5
6 #ifndef __MTD_CFI_H__
7 #define __MTD_CFI_H__
8
9 #include <linux/delay.h>
10 #include <linux/types.h>
11 #include <linux/bug.h>
12 #include <linux/interrupt.h>
13 #include <linux/mtd/flashchip.h>
14 #include <linux/mtd/map.h>
15 #include <linux/mtd/cfi_endian.h>
16 #include <linux/mtd/xip.h>
17
18 #ifdef CONFIG_MTD_CFI_I1
19 #define cfi_interleave(cfi) 1
20 #define cfi_interleave_is_1(cfi) (cfi_interleave(cfi) == 1)
21 #else
22 #define cfi_interleave_is_1(cfi) (0)
23 #endif
24
25 #ifdef CONFIG_MTD_CFI_I2
26 # ifdef cfi_interleave
27 #  undef cfi_interleave
28 #  define cfi_interleave(cfi) ((cfi)->interleave)
29 # else
30 #  define cfi_interleave(cfi) 2
31 # endif
32 #define cfi_interleave_is_2(cfi) (cfi_interleave(cfi) == 2)
33 #else
34 #define cfi_interleave_is_2(cfi) (0)
35 #endif
36
37 #ifdef CONFIG_MTD_CFI_I4
38 # ifdef cfi_interleave
39 #  undef cfi_interleave
40 #  define cfi_interleave(cfi) ((cfi)->interleave)
41 # else
42 #  define cfi_interleave(cfi) 4
43 # endif
44 #define cfi_interleave_is_4(cfi) (cfi_interleave(cfi) == 4)
45 #else
46 #define cfi_interleave_is_4(cfi) (0)
47 #endif
48
49 #ifdef CONFIG_MTD_CFI_I8
50 # ifdef cfi_interleave
51 #  undef cfi_interleave
52 #  define cfi_interleave(cfi) ((cfi)->interleave)
53 # else
54 #  define cfi_interleave(cfi) 8
55 # endif
56 #define cfi_interleave_is_8(cfi) (cfi_interleave(cfi) == 8)
57 #else
58 #define cfi_interleave_is_8(cfi) (0)
59 #endif
60
61 #ifndef cfi_interleave
62 #warning No CONFIG_MTD_CFI_Ix selected. No NOR chip support can work.
63 static inline int cfi_interleave(void *cfi)
64 {
65         BUG();
66         return 0;
67 }
68 #endif
69
70 static inline int cfi_interleave_supported(int i)
71 {
72         switch (i) {
73 #ifdef CONFIG_MTD_CFI_I1
74         case 1:
75 #endif
76 #ifdef CONFIG_MTD_CFI_I2
77         case 2:
78 #endif
79 #ifdef CONFIG_MTD_CFI_I4
80         case 4:
81 #endif
82 #ifdef CONFIG_MTD_CFI_I8
83         case 8:
84 #endif
85                 return 1;
86
87         default:
88                 return 0;
89         }
90 }
91
92
93 /* NB: these values must represents the number of bytes needed to meet the
94  *     device type (x8, x16, x32).  Eg. a 32 bit device is 4 x 8 bytes.
95  *     These numbers are used in calculations.
96  */
97 #define CFI_DEVICETYPE_X8  (8 / 8)
98 #define CFI_DEVICETYPE_X16 (16 / 8)
99 #define CFI_DEVICETYPE_X32 (32 / 8)
100 #define CFI_DEVICETYPE_X64 (64 / 8)
101
102
103 /* Device Interface Code Assignments from the "Common Flash Memory Interface
104  * Publication 100" dated December 1, 2001.
105  */
106 #define CFI_INTERFACE_X8_ASYNC          0x0000
107 #define CFI_INTERFACE_X16_ASYNC         0x0001
108 #define CFI_INTERFACE_X8_BY_X16_ASYNC   0x0002
109 #define CFI_INTERFACE_X32_ASYNC         0x0003
110 #define CFI_INTERFACE_X16_BY_X32_ASYNC  0x0005
111 #define CFI_INTERFACE_NOT_ALLOWED       0xffff
112
113
114 /* NB: We keep these structures in memory in HOST byteorder, except
115  * where individually noted.
116  */
117
118 /* Basic Query Structure */
119 struct cfi_ident {
120         uint8_t  qry[3];
121         uint16_t P_ID;
122         uint16_t P_ADR;
123         uint16_t A_ID;
124         uint16_t A_ADR;
125         uint8_t  VccMin;
126         uint8_t  VccMax;
127         uint8_t  VppMin;
128         uint8_t  VppMax;
129         uint8_t  WordWriteTimeoutTyp;
130         uint8_t  BufWriteTimeoutTyp;
131         uint8_t  BlockEraseTimeoutTyp;
132         uint8_t  ChipEraseTimeoutTyp;
133         uint8_t  WordWriteTimeoutMax;
134         uint8_t  BufWriteTimeoutMax;
135         uint8_t  BlockEraseTimeoutMax;
136         uint8_t  ChipEraseTimeoutMax;
137         uint8_t  DevSize;
138         uint16_t InterfaceDesc;
139         uint16_t MaxBufWriteSize;
140         uint8_t  NumEraseRegions;
141         uint32_t EraseRegionInfo[0]; /* Not host ordered */
142 } __packed;
143
144 /* Extended Query Structure for both PRI and ALT */
145
146 struct cfi_extquery {
147         uint8_t  pri[3];
148         uint8_t  MajorVersion;
149         uint8_t  MinorVersion;
150 } __packed;
151
152 /* Vendor-Specific PRI for Intel/Sharp Extended Command Set (0x0001) */
153
154 struct cfi_pri_intelext {
155         uint8_t  pri[3];
156         uint8_t  MajorVersion;
157         uint8_t  MinorVersion;
158         uint32_t FeatureSupport; /* if bit 31 is set then an additional uint32_t feature
159                                     block follows - FIXME - not currently supported */
160         uint8_t  SuspendCmdSupport;
161         uint16_t BlkStatusRegMask;
162         uint8_t  VccOptimal;
163         uint8_t  VppOptimal;
164         uint8_t  NumProtectionFields;
165         uint16_t ProtRegAddr;
166         uint8_t  FactProtRegSize;
167         uint8_t  UserProtRegSize;
168         uint8_t  extra[0];
169 } __packed;
170
171 struct cfi_intelext_otpinfo {
172         uint32_t ProtRegAddr;
173         uint16_t FactGroups;
174         uint8_t  FactProtRegSize;
175         uint16_t UserGroups;
176         uint8_t  UserProtRegSize;
177 } __packed;
178
179 struct cfi_intelext_blockinfo {
180         uint16_t NumIdentBlocks;
181         uint16_t BlockSize;
182         uint16_t MinBlockEraseCycles;
183         uint8_t  BitsPerCell;
184         uint8_t  BlockCap;
185 } __packed;
186
187 struct cfi_intelext_regioninfo {
188         uint16_t NumIdentPartitions;
189         uint8_t  NumOpAllowed;
190         uint8_t  NumOpAllowedSimProgMode;
191         uint8_t  NumOpAllowedSimEraMode;
192         uint8_t  NumBlockTypes;
193         struct cfi_intelext_blockinfo BlockTypes[1];
194 } __packed;
195
196 struct cfi_intelext_programming_regioninfo {
197         uint8_t  ProgRegShift;
198         uint8_t  Reserved1;
199         uint8_t  ControlValid;
200         uint8_t  Reserved2;
201         uint8_t  ControlInvalid;
202         uint8_t  Reserved3;
203 } __packed;
204
205 /* Vendor-Specific PRI for AMD/Fujitsu Extended Command Set (0x0002) */
206
207 struct cfi_pri_amdstd {
208         uint8_t  pri[3];
209         uint8_t  MajorVersion;
210         uint8_t  MinorVersion;
211         uint8_t  SiliconRevision; /* bits 1-0: Address Sensitive Unlock */
212         uint8_t  EraseSuspend;
213         uint8_t  BlkProt;
214         uint8_t  TmpBlkUnprotect;
215         uint8_t  BlkProtUnprot;
216         uint8_t  SimultaneousOps;
217         uint8_t  BurstMode;
218         uint8_t  PageMode;
219         uint8_t  VppMin;
220         uint8_t  VppMax;
221         uint8_t  TopBottom;
222 } __packed;
223
224 /* Vendor-Specific PRI for Atmel chips (command set 0x0002) */
225
226 struct cfi_pri_atmel {
227         uint8_t pri[3];
228         uint8_t MajorVersion;
229         uint8_t MinorVersion;
230         uint8_t Features;
231         uint8_t BottomBoot;
232         uint8_t BurstMode;
233         uint8_t PageMode;
234 } __packed;
235
236 struct cfi_pri_query {
237         uint8_t  NumFields;
238         uint32_t ProtField[1]; /* Not host ordered */
239 } __packed;
240
241 struct cfi_bri_query {
242         uint8_t  PageModeReadCap;
243         uint8_t  NumFields;
244         uint32_t ConfField[1]; /* Not host ordered */
245 } __packed;
246
247 #define P_ID_NONE               0x0000
248 #define P_ID_INTEL_EXT          0x0001
249 #define P_ID_AMD_STD            0x0002
250 #define P_ID_INTEL_STD          0x0003
251 #define P_ID_AMD_EXT            0x0004
252 #define P_ID_WINBOND            0x0006
253 #define P_ID_ST_ADV             0x0020
254 #define P_ID_MITSUBISHI_STD     0x0100
255 #define P_ID_MITSUBISHI_EXT     0x0101
256 #define P_ID_SST_PAGE           0x0102
257 #define P_ID_SST_OLD            0x0701
258 #define P_ID_INTEL_PERFORMANCE  0x0200
259 #define P_ID_INTEL_DATA         0x0210
260 #define P_ID_RESERVED           0xffff
261
262
263 #define CFI_MODE_CFI    1
264 #define CFI_MODE_JEDEC  0
265
266 struct cfi_private {
267         uint16_t cmdset;
268         void *cmdset_priv;
269         int interleave;
270         int device_type;
271         int cfi_mode;           /* Are we a JEDEC device pretending to be CFI? */
272         int addr_unlock1;
273         int addr_unlock2;
274         struct mtd_info *(*cmdset_setup)(struct map_info *);
275         struct cfi_ident *cfiq; /* For now only one. We insist that all devs
276                                   must be of the same type. */
277         int mfr, id;
278         int numchips;
279         map_word sector_erase_cmd;
280         unsigned long chipshift; /* Because they're of the same type */
281         const char *im_name;     /* inter_module name for cmdset_setup */
282         struct flchip chips[0];  /* per-chip data structure for each chip */
283 };
284
285 uint32_t cfi_build_cmd_addr(uint32_t cmd_ofs,
286                                 struct map_info *map, struct cfi_private *cfi);
287
288 map_word cfi_build_cmd(u_long cmd, struct map_info *map, struct cfi_private *cfi);
289 #define CMD(x)  cfi_build_cmd((x), map, cfi)
290
291 unsigned long cfi_merge_status(map_word val, struct map_info *map,
292                                            struct cfi_private *cfi);
293 #define MERGESTATUS(x) cfi_merge_status((x), map, cfi)
294
295 uint32_t cfi_send_gen_cmd(u_char cmd, uint32_t cmd_addr, uint32_t base,
296                                 struct map_info *map, struct cfi_private *cfi,
297                                 int type, map_word *prev_val);
298
299 static inline uint8_t cfi_read_query(struct map_info *map, uint32_t addr)
300 {
301         map_word val = map_read(map, addr);
302
303         if (map_bankwidth_is_1(map)) {
304                 return val.x[0];
305         } else if (map_bankwidth_is_2(map)) {
306                 return cfi16_to_cpu(map, val.x[0]);
307         } else {
308                 /* No point in a 64-bit byteswap since that would just be
309                    swapping the responses from different chips, and we are
310                    only interested in one chip (a representative sample) */
311                 return cfi32_to_cpu(map, val.x[0]);
312         }
313 }
314
315 static inline uint16_t cfi_read_query16(struct map_info *map, uint32_t addr)
316 {
317         map_word val = map_read(map, addr);
318
319         if (map_bankwidth_is_1(map)) {
320                 return val.x[0] & 0xff;
321         } else if (map_bankwidth_is_2(map)) {
322                 return cfi16_to_cpu(map, val.x[0]);
323         } else {
324                 /* No point in a 64-bit byteswap since that would just be
325                    swapping the responses from different chips, and we are
326                    only interested in one chip (a representative sample) */
327                 return cfi32_to_cpu(map, val.x[0]);
328         }
329 }
330
331 void cfi_udelay(int us);
332
333 int __xipram cfi_qry_present(struct map_info *map, __u32 base,
334                              struct cfi_private *cfi);
335 int __xipram cfi_qry_mode_on(uint32_t base, struct map_info *map,
336                              struct cfi_private *cfi);
337 void __xipram cfi_qry_mode_off(uint32_t base, struct map_info *map,
338                                struct cfi_private *cfi);
339
340 struct cfi_extquery *cfi_read_pri(struct map_info *map, uint16_t adr, uint16_t size,
341                              const char* name);
342 struct cfi_fixup {
343         uint16_t mfr;
344         uint16_t id;
345         void (*fixup)(struct mtd_info *mtd);
346 };
347
348 #define CFI_MFR_ANY             0xFFFF
349 #define CFI_ID_ANY              0xFFFF
350 #define CFI_MFR_CONTINUATION    0x007F
351
352 #define CFI_MFR_AMD             0x0001
353 #define CFI_MFR_AMIC            0x0037
354 #define CFI_MFR_ATMEL           0x001F
355 #define CFI_MFR_EON             0x001C
356 #define CFI_MFR_FUJITSU         0x0004
357 #define CFI_MFR_HYUNDAI         0x00AD
358 #define CFI_MFR_INTEL           0x0089
359 #define CFI_MFR_MACRONIX        0x00C2
360 #define CFI_MFR_NEC             0x0010
361 #define CFI_MFR_PMC             0x009D
362 #define CFI_MFR_SAMSUNG         0x00EC
363 #define CFI_MFR_SHARP           0x00B0
364 #define CFI_MFR_SST             0x00BF
365 #define CFI_MFR_ST              0x0020 /* STMicroelectronics */
366 #define CFI_MFR_MICRON          0x002C /* Micron */
367 #define CFI_MFR_TOSHIBA         0x0098
368 #define CFI_MFR_WINBOND         0x00DA
369
370 void cfi_fixup(struct mtd_info *mtd, struct cfi_fixup* fixups);
371
372 typedef int (*varsize_frob_t)(struct map_info *map, struct flchip *chip,
373                               unsigned long adr, int len, void *thunk);
374
375 int cfi_varsize_frob(struct mtd_info *mtd, varsize_frob_t frob,
376         loff_t ofs, size_t len, void *thunk);
377
378
379 #endif /* __MTD_CFI_H__ */