2 * Common Flash Interface support:
3 * Intel Extended Vendor Command Set (ID 0x0001)
5 * (C) 2000 Red Hat. GPL'd
8 * 10/10/2000 Nicolas Pitre <nico@fluxnic.net>
9 * - completely revamped method functions so they are aware and
10 * independent of the flash geometry (buswidth, interleave, etc.)
11 * - scalability vs code size is completely set at compile-time
12 * (see include/linux/mtd/cfi.h for selection)
13 * - optimized write buffer method
14 * 02/05/2002 Christopher Hoover <ch@hpl.hp.com>/<ch@murgatroid.com>
15 * - reworked lock/unlock/erase support for var size flash
16 * 21/03/2007 Rodolfo Giometti <giometti@linux.it>
17 * - auto unlock sectors on resume for auto locking flash on power up
20 #include <linux/module.h>
21 #include <linux/types.h>
22 #include <linux/kernel.h>
23 #include <linux/sched.h>
25 #include <asm/byteorder.h>
27 #include <linux/errno.h>
28 #include <linux/slab.h>
29 #include <linux/delay.h>
30 #include <linux/interrupt.h>
31 #include <linux/reboot.h>
32 #include <linux/bitmap.h>
33 #include <linux/mtd/xip.h>
34 #include <linux/mtd/map.h>
35 #include <linux/mtd/mtd.h>
36 #include <linux/mtd/cfi.h>
38 /* #define CMDSET0001_DISABLE_ERASE_SUSPEND_ON_WRITE */
39 /* #define CMDSET0001_DISABLE_WRITE_SUSPEND */
41 // debugging, turns off buffer write mode if set to 1
42 #define FORCE_WORD_WRITE 0
45 #define I82802AB 0x00ad
46 #define I82802AC 0x00ac
47 #define PF38F4476 0x881c
48 /* STMicroelectronics chips */
49 #define M50LPW080 0x002F
50 #define M50FLW080A 0x0080
51 #define M50FLW080B 0x0081
53 #define AT49BV640D 0x02de
54 #define AT49BV640DT 0x02db
56 #define LH28F640BFHE_PTTL90 0x00b0
57 #define LH28F640BFHE_PBTL90 0x00b1
58 #define LH28F640BFHE_PTTL70A 0x00b2
59 #define LH28F640BFHE_PBTL70A 0x00b3
61 static int cfi_intelext_read (struct mtd_info
*, loff_t
, size_t, size_t *, u_char
*);
62 static int cfi_intelext_write_words(struct mtd_info
*, loff_t
, size_t, size_t *, const u_char
*);
63 static int cfi_intelext_write_buffers(struct mtd_info
*, loff_t
, size_t, size_t *, const u_char
*);
64 static int cfi_intelext_writev(struct mtd_info
*, const struct kvec
*, unsigned long, loff_t
, size_t *);
65 static int cfi_intelext_erase_varsize(struct mtd_info
*, struct erase_info
*);
66 static void cfi_intelext_sync (struct mtd_info
*);
67 static int cfi_intelext_lock(struct mtd_info
*mtd
, loff_t ofs
, uint64_t len
);
68 static int cfi_intelext_unlock(struct mtd_info
*mtd
, loff_t ofs
, uint64_t len
);
69 static int cfi_intelext_is_locked(struct mtd_info
*mtd
, loff_t ofs
,
72 static int cfi_intelext_read_fact_prot_reg (struct mtd_info
*, loff_t
, size_t, size_t *, u_char
*);
73 static int cfi_intelext_read_user_prot_reg (struct mtd_info
*, loff_t
, size_t, size_t *, u_char
*);
74 static int cfi_intelext_write_user_prot_reg (struct mtd_info
*, loff_t
, size_t, size_t *, u_char
*);
75 static int cfi_intelext_lock_user_prot_reg (struct mtd_info
*, loff_t
, size_t);
76 static int cfi_intelext_get_fact_prot_info(struct mtd_info
*, size_t,
77 size_t *, struct otp_info
*);
78 static int cfi_intelext_get_user_prot_info(struct mtd_info
*, size_t,
79 size_t *, struct otp_info
*);
81 static int cfi_intelext_suspend (struct mtd_info
*);
82 static void cfi_intelext_resume (struct mtd_info
*);
83 static int cfi_intelext_reboot (struct notifier_block
*, unsigned long, void *);
85 static void cfi_intelext_destroy(struct mtd_info
*);
87 struct mtd_info
*cfi_cmdset_0001(struct map_info
*, int);
89 static struct mtd_info
*cfi_intelext_setup (struct mtd_info
*);
90 static int cfi_intelext_partition_fixup(struct mtd_info
*, struct cfi_private
**);
92 static int cfi_intelext_point (struct mtd_info
*mtd
, loff_t from
, size_t len
,
93 size_t *retlen
, void **virt
, resource_size_t
*phys
);
94 static int cfi_intelext_unpoint(struct mtd_info
*mtd
, loff_t from
, size_t len
);
96 static int chip_ready (struct map_info
*map
, struct flchip
*chip
, unsigned long adr
, int mode
);
97 static int get_chip(struct map_info
*map
, struct flchip
*chip
, unsigned long adr
, int mode
);
98 static void put_chip(struct map_info
*map
, struct flchip
*chip
, unsigned long adr
);
104 * *********** SETUP AND PROBE BITS ***********
107 static struct mtd_chip_driver cfi_intelext_chipdrv
= {
108 .probe
= NULL
, /* Not usable directly */
109 .destroy
= cfi_intelext_destroy
,
110 .name
= "cfi_cmdset_0001",
111 .module
= THIS_MODULE
114 /* #define DEBUG_LOCK_BITS */
115 /* #define DEBUG_CFI_FEATURES */
117 #ifdef DEBUG_CFI_FEATURES
118 static void cfi_tell_features(struct cfi_pri_intelext
*extp
)
121 printk(" Extended Query version %c.%c\n", extp
->MajorVersion
, extp
->MinorVersion
);
122 printk(" Feature/Command Support: %4.4X\n", extp
->FeatureSupport
);
123 printk(" - Chip Erase: %s\n", extp
->FeatureSupport
&1?"supported":"unsupported");
124 printk(" - Suspend Erase: %s\n", extp
->FeatureSupport
&2?"supported":"unsupported");
125 printk(" - Suspend Program: %s\n", extp
->FeatureSupport
&4?"supported":"unsupported");
126 printk(" - Legacy Lock/Unlock: %s\n", extp
->FeatureSupport
&8?"supported":"unsupported");
127 printk(" - Queued Erase: %s\n", extp
->FeatureSupport
&16?"supported":"unsupported");
128 printk(" - Instant block lock: %s\n", extp
->FeatureSupport
&32?"supported":"unsupported");
129 printk(" - Protection Bits: %s\n", extp
->FeatureSupport
&64?"supported":"unsupported");
130 printk(" - Page-mode read: %s\n", extp
->FeatureSupport
&128?"supported":"unsupported");
131 printk(" - Synchronous read: %s\n", extp
->FeatureSupport
&256?"supported":"unsupported");
132 printk(" - Simultaneous operations: %s\n", extp
->FeatureSupport
&512?"supported":"unsupported");
133 printk(" - Extended Flash Array: %s\n", extp
->FeatureSupport
&1024?"supported":"unsupported");
134 for (i
=11; i
<32; i
++) {
135 if (extp
->FeatureSupport
& (1<<i
))
136 printk(" - Unknown Bit %X: supported\n", i
);
139 printk(" Supported functions after Suspend: %2.2X\n", extp
->SuspendCmdSupport
);
140 printk(" - Program after Erase Suspend: %s\n", extp
->SuspendCmdSupport
&1?"supported":"unsupported");
141 for (i
=1; i
<8; i
++) {
142 if (extp
->SuspendCmdSupport
& (1<<i
))
143 printk(" - Unknown Bit %X: supported\n", i
);
146 printk(" Block Status Register Mask: %4.4X\n", extp
->BlkStatusRegMask
);
147 printk(" - Lock Bit Active: %s\n", extp
->BlkStatusRegMask
&1?"yes":"no");
148 printk(" - Lock-Down Bit Active: %s\n", extp
->BlkStatusRegMask
&2?"yes":"no");
149 for (i
=2; i
<3; i
++) {
150 if (extp
->BlkStatusRegMask
& (1<<i
))
151 printk(" - Unknown Bit %X Active: yes\n",i
);
153 printk(" - EFA Lock Bit: %s\n", extp
->BlkStatusRegMask
&16?"yes":"no");
154 printk(" - EFA Lock-Down Bit: %s\n", extp
->BlkStatusRegMask
&32?"yes":"no");
155 for (i
=6; i
<16; i
++) {
156 if (extp
->BlkStatusRegMask
& (1<<i
))
157 printk(" - Unknown Bit %X Active: yes\n",i
);
160 printk(" Vcc Logic Supply Optimum Program/Erase Voltage: %d.%d V\n",
161 extp
->VccOptimal
>> 4, extp
->VccOptimal
& 0xf);
162 if (extp
->VppOptimal
)
163 printk(" Vpp Programming Supply Optimum Program/Erase Voltage: %d.%d V\n",
164 extp
->VppOptimal
>> 4, extp
->VppOptimal
& 0xf);
168 /* Atmel chips don't use the same PRI format as Intel chips */
169 static void fixup_convert_atmel_pri(struct mtd_info
*mtd
)
171 struct map_info
*map
= mtd
->priv
;
172 struct cfi_private
*cfi
= map
->fldrv_priv
;
173 struct cfi_pri_intelext
*extp
= cfi
->cmdset_priv
;
174 struct cfi_pri_atmel atmel_pri
;
175 uint32_t features
= 0;
177 /* Reverse byteswapping */
178 extp
->FeatureSupport
= cpu_to_le32(extp
->FeatureSupport
);
179 extp
->BlkStatusRegMask
= cpu_to_le16(extp
->BlkStatusRegMask
);
180 extp
->ProtRegAddr
= cpu_to_le16(extp
->ProtRegAddr
);
182 memcpy(&atmel_pri
, extp
, sizeof(atmel_pri
));
183 memset((char *)extp
+ 5, 0, sizeof(*extp
) - 5);
185 printk(KERN_ERR
"atmel Features: %02x\n", atmel_pri
.Features
);
187 if (atmel_pri
.Features
& 0x01) /* chip erase supported */
189 if (atmel_pri
.Features
& 0x02) /* erase suspend supported */
191 if (atmel_pri
.Features
& 0x04) /* program suspend supported */
193 if (atmel_pri
.Features
& 0x08) /* simultaneous operations supported */
195 if (atmel_pri
.Features
& 0x20) /* page mode read supported */
197 if (atmel_pri
.Features
& 0x40) /* queued erase supported */
199 if (atmel_pri
.Features
& 0x80) /* Protection bits supported */
202 extp
->FeatureSupport
= features
;
204 /* burst write mode not supported */
205 cfi
->cfiq
->BufWriteTimeoutTyp
= 0;
206 cfi
->cfiq
->BufWriteTimeoutMax
= 0;
209 static void fixup_at49bv640dx_lock(struct mtd_info
*mtd
)
211 struct map_info
*map
= mtd
->priv
;
212 struct cfi_private
*cfi
= map
->fldrv_priv
;
213 struct cfi_pri_intelext
*cfip
= cfi
->cmdset_priv
;
215 cfip
->FeatureSupport
|= (1 << 5);
216 mtd
->flags
|= MTD_POWERUP_LOCK
;
219 #ifdef CMDSET0001_DISABLE_ERASE_SUSPEND_ON_WRITE
220 /* Some Intel Strata Flash prior to FPO revision C has bugs in this area */
221 static void fixup_intel_strataflash(struct mtd_info
*mtd
)
223 struct map_info
*map
= mtd
->priv
;
224 struct cfi_private
*cfi
= map
->fldrv_priv
;
225 struct cfi_pri_intelext
*extp
= cfi
->cmdset_priv
;
227 printk(KERN_WARNING
"cfi_cmdset_0001: Suspend "
228 "erase on write disabled.\n");
229 extp
->SuspendCmdSupport
&= ~1;
233 #ifdef CMDSET0001_DISABLE_WRITE_SUSPEND
234 static void fixup_no_write_suspend(struct mtd_info
*mtd
)
236 struct map_info
*map
= mtd
->priv
;
237 struct cfi_private
*cfi
= map
->fldrv_priv
;
238 struct cfi_pri_intelext
*cfip
= cfi
->cmdset_priv
;
240 if (cfip
&& (cfip
->FeatureSupport
&4)) {
241 cfip
->FeatureSupport
&= ~4;
242 printk(KERN_WARNING
"cfi_cmdset_0001: write suspend disabled\n");
247 static void fixup_st_m28w320ct(struct mtd_info
*mtd
)
249 struct map_info
*map
= mtd
->priv
;
250 struct cfi_private
*cfi
= map
->fldrv_priv
;
252 cfi
->cfiq
->BufWriteTimeoutTyp
= 0; /* Not supported */
253 cfi
->cfiq
->BufWriteTimeoutMax
= 0; /* Not supported */
256 static void fixup_st_m28w320cb(struct mtd_info
*mtd
)
258 struct map_info
*map
= mtd
->priv
;
259 struct cfi_private
*cfi
= map
->fldrv_priv
;
261 /* Note this is done after the region info is endian swapped */
262 cfi
->cfiq
->EraseRegionInfo
[1] =
263 (cfi
->cfiq
->EraseRegionInfo
[1] & 0xffff0000) | 0x3e;
266 static int is_LH28F640BF(struct cfi_private
*cfi
)
268 /* Sharp LH28F640BF Family */
269 if (cfi
->mfr
== CFI_MFR_SHARP
&& (
270 cfi
->id
== LH28F640BFHE_PTTL90
|| cfi
->id
== LH28F640BFHE_PBTL90
||
271 cfi
->id
== LH28F640BFHE_PTTL70A
|| cfi
->id
== LH28F640BFHE_PBTL70A
))
276 static void fixup_LH28F640BF(struct mtd_info
*mtd
)
278 struct map_info
*map
= mtd
->priv
;
279 struct cfi_private
*cfi
= map
->fldrv_priv
;
280 struct cfi_pri_intelext
*extp
= cfi
->cmdset_priv
;
282 /* Reset the Partition Configuration Register on LH28F640BF
283 * to a single partition (PCR = 0x000): PCR is embedded into A0-A15. */
284 if (is_LH28F640BF(cfi
)) {
285 printk(KERN_INFO
"Reset Partition Config. Register: 1 Partition of 4 planes\n");
286 map_write(map
, CMD(0x60), 0);
287 map_write(map
, CMD(0x04), 0);
289 /* We have set one single partition thus
290 * Simultaneous Operations are not allowed */
291 printk(KERN_INFO
"cfi_cmdset_0001: Simultaneous Operations disabled\n");
292 extp
->FeatureSupport
&= ~512;
296 static void fixup_use_point(struct mtd_info
*mtd
)
298 struct map_info
*map
= mtd
->priv
;
299 if (!mtd
->_point
&& map_is_linear(map
)) {
300 mtd
->_point
= cfi_intelext_point
;
301 mtd
->_unpoint
= cfi_intelext_unpoint
;
305 static void fixup_use_write_buffers(struct mtd_info
*mtd
)
307 struct map_info
*map
= mtd
->priv
;
308 struct cfi_private
*cfi
= map
->fldrv_priv
;
309 if (cfi
->cfiq
->BufWriteTimeoutTyp
) {
310 printk(KERN_INFO
"Using buffer write method\n" );
311 mtd
->_write
= cfi_intelext_write_buffers
;
312 mtd
->_writev
= cfi_intelext_writev
;
317 * Some chips power-up with all sectors locked by default.
319 static void fixup_unlock_powerup_lock(struct mtd_info
*mtd
)
321 struct map_info
*map
= mtd
->priv
;
322 struct cfi_private
*cfi
= map
->fldrv_priv
;
323 struct cfi_pri_intelext
*cfip
= cfi
->cmdset_priv
;
325 if (cfip
->FeatureSupport
&32) {
326 printk(KERN_INFO
"Using auto-unlock on power-up/resume\n" );
327 mtd
->flags
|= MTD_POWERUP_LOCK
;
331 static struct cfi_fixup cfi_fixup_table
[] = {
332 { CFI_MFR_ATMEL
, CFI_ID_ANY
, fixup_convert_atmel_pri
},
333 { CFI_MFR_ATMEL
, AT49BV640D
, fixup_at49bv640dx_lock
},
334 { CFI_MFR_ATMEL
, AT49BV640DT
, fixup_at49bv640dx_lock
},
335 #ifdef CMDSET0001_DISABLE_ERASE_SUSPEND_ON_WRITE
336 { CFI_MFR_ANY
, CFI_ID_ANY
, fixup_intel_strataflash
},
338 #ifdef CMDSET0001_DISABLE_WRITE_SUSPEND
339 { CFI_MFR_ANY
, CFI_ID_ANY
, fixup_no_write_suspend
},
341 #if !FORCE_WORD_WRITE
342 { CFI_MFR_ANY
, CFI_ID_ANY
, fixup_use_write_buffers
},
344 { CFI_MFR_ST
, 0x00ba, /* M28W320CT */ fixup_st_m28w320ct
},
345 { CFI_MFR_ST
, 0x00bb, /* M28W320CB */ fixup_st_m28w320cb
},
346 { CFI_MFR_INTEL
, CFI_ID_ANY
, fixup_unlock_powerup_lock
},
347 { CFI_MFR_SHARP
, CFI_ID_ANY
, fixup_unlock_powerup_lock
},
348 { CFI_MFR_SHARP
, CFI_ID_ANY
, fixup_LH28F640BF
},
352 static struct cfi_fixup jedec_fixup_table
[] = {
353 { CFI_MFR_INTEL
, I82802AB
, fixup_use_fwh_lock
},
354 { CFI_MFR_INTEL
, I82802AC
, fixup_use_fwh_lock
},
355 { CFI_MFR_ST
, M50LPW080
, fixup_use_fwh_lock
},
356 { CFI_MFR_ST
, M50FLW080A
, fixup_use_fwh_lock
},
357 { CFI_MFR_ST
, M50FLW080B
, fixup_use_fwh_lock
},
360 static struct cfi_fixup fixup_table
[] = {
361 /* The CFI vendor ids and the JEDEC vendor IDs appear
362 * to be common. It is like the devices id's are as
363 * well. This table is to pick all cases where
364 * we know that is the case.
366 { CFI_MFR_ANY
, CFI_ID_ANY
, fixup_use_point
},
370 static void cfi_fixup_major_minor(struct cfi_private
*cfi
,
371 struct cfi_pri_intelext
*extp
)
373 if (cfi
->mfr
== CFI_MFR_INTEL
&&
374 cfi
->id
== PF38F4476
&& extp
->MinorVersion
== '3')
375 extp
->MinorVersion
= '1';
378 static inline struct cfi_pri_intelext
*
379 read_pri_intelext(struct map_info
*map
, __u16 adr
)
381 struct cfi_private
*cfi
= map
->fldrv_priv
;
382 struct cfi_pri_intelext
*extp
;
383 unsigned int extra_size
= 0;
384 unsigned int extp_size
= sizeof(*extp
);
387 extp
= (struct cfi_pri_intelext
*)cfi_read_pri(map
, adr
, extp_size
, "Intel/Sharp");
391 cfi_fixup_major_minor(cfi
, extp
);
393 if (extp
->MajorVersion
!= '1' ||
394 (extp
->MinorVersion
< '0' || extp
->MinorVersion
> '5')) {
395 printk(KERN_ERR
" Unknown Intel/Sharp Extended Query "
396 "version %c.%c.\n", extp
->MajorVersion
,
402 /* Do some byteswapping if necessary */
403 extp
->FeatureSupport
= le32_to_cpu(extp
->FeatureSupport
);
404 extp
->BlkStatusRegMask
= le16_to_cpu(extp
->BlkStatusRegMask
);
405 extp
->ProtRegAddr
= le16_to_cpu(extp
->ProtRegAddr
);
407 if (extp
->MinorVersion
>= '0') {
410 /* Protection Register info */
411 extra_size
+= (extp
->NumProtectionFields
- 1) *
412 sizeof(struct cfi_intelext_otpinfo
);
415 if (extp
->MinorVersion
>= '1') {
416 /* Burst Read info */
418 if (extp_size
< sizeof(*extp
) + extra_size
)
420 extra_size
+= extp
->extra
[extra_size
- 1];
423 if (extp
->MinorVersion
>= '3') {
426 /* Number of hardware-partitions */
428 if (extp_size
< sizeof(*extp
) + extra_size
)
430 nb_parts
= extp
->extra
[extra_size
- 1];
432 /* skip the sizeof(partregion) field in CFI 1.4 */
433 if (extp
->MinorVersion
>= '4')
436 for (i
= 0; i
< nb_parts
; i
++) {
437 struct cfi_intelext_regioninfo
*rinfo
;
438 rinfo
= (struct cfi_intelext_regioninfo
*)&extp
->extra
[extra_size
];
439 extra_size
+= sizeof(*rinfo
);
440 if (extp_size
< sizeof(*extp
) + extra_size
)
442 rinfo
->NumIdentPartitions
=le16_to_cpu(rinfo
->NumIdentPartitions
);
443 extra_size
+= (rinfo
->NumBlockTypes
- 1)
444 * sizeof(struct cfi_intelext_blockinfo
);
447 if (extp
->MinorVersion
>= '4')
448 extra_size
+= sizeof(struct cfi_intelext_programming_regioninfo
);
450 if (extp_size
< sizeof(*extp
) + extra_size
) {
452 extp_size
= sizeof(*extp
) + extra_size
;
454 if (extp_size
> 4096) {
456 "%s: cfi_pri_intelext is too fat\n",
467 struct mtd_info
*cfi_cmdset_0001(struct map_info
*map
, int primary
)
469 struct cfi_private
*cfi
= map
->fldrv_priv
;
470 struct mtd_info
*mtd
;
473 mtd
= kzalloc(sizeof(*mtd
), GFP_KERNEL
);
477 mtd
->type
= MTD_NORFLASH
;
479 /* Fill in the default mtd operations */
480 mtd
->_erase
= cfi_intelext_erase_varsize
;
481 mtd
->_read
= cfi_intelext_read
;
482 mtd
->_write
= cfi_intelext_write_words
;
483 mtd
->_sync
= cfi_intelext_sync
;
484 mtd
->_lock
= cfi_intelext_lock
;
485 mtd
->_unlock
= cfi_intelext_unlock
;
486 mtd
->_is_locked
= cfi_intelext_is_locked
;
487 mtd
->_suspend
= cfi_intelext_suspend
;
488 mtd
->_resume
= cfi_intelext_resume
;
489 mtd
->flags
= MTD_CAP_NORFLASH
;
490 mtd
->name
= map
->name
;
492 mtd
->writebufsize
= cfi_interleave(cfi
) << cfi
->cfiq
->MaxBufWriteSize
;
494 mtd
->reboot_notifier
.notifier_call
= cfi_intelext_reboot
;
496 if (cfi
->cfi_mode
== CFI_MODE_CFI
) {
498 * It's a real CFI chip, not one for which the probe
499 * routine faked a CFI structure. So we read the feature
502 __u16 adr
= primary
?cfi
->cfiq
->P_ADR
:cfi
->cfiq
->A_ADR
;
503 struct cfi_pri_intelext
*extp
;
505 extp
= read_pri_intelext(map
, adr
);
511 /* Install our own private info structure */
512 cfi
->cmdset_priv
= extp
;
514 cfi_fixup(mtd
, cfi_fixup_table
);
516 #ifdef DEBUG_CFI_FEATURES
517 /* Tell the user about it in lots of lovely detail */
518 cfi_tell_features(extp
);
521 if(extp
->SuspendCmdSupport
& 1) {
522 printk(KERN_NOTICE
"cfi_cmdset_0001: Erase suspend on write enabled\n");
525 else if (cfi
->cfi_mode
== CFI_MODE_JEDEC
) {
526 /* Apply jedec specific fixups */
527 cfi_fixup(mtd
, jedec_fixup_table
);
529 /* Apply generic fixups */
530 cfi_fixup(mtd
, fixup_table
);
532 for (i
=0; i
< cfi
->numchips
; i
++) {
533 if (cfi
->cfiq
->WordWriteTimeoutTyp
)
534 cfi
->chips
[i
].word_write_time
=
535 1<<cfi
->cfiq
->WordWriteTimeoutTyp
;
537 cfi
->chips
[i
].word_write_time
= 50000;
539 if (cfi
->cfiq
->BufWriteTimeoutTyp
)
540 cfi
->chips
[i
].buffer_write_time
=
541 1<<cfi
->cfiq
->BufWriteTimeoutTyp
;
542 /* No default; if it isn't specified, we won't use it */
544 if (cfi
->cfiq
->BlockEraseTimeoutTyp
)
545 cfi
->chips
[i
].erase_time
=
546 1000<<cfi
->cfiq
->BlockEraseTimeoutTyp
;
548 cfi
->chips
[i
].erase_time
= 2000000;
550 if (cfi
->cfiq
->WordWriteTimeoutTyp
&&
551 cfi
->cfiq
->WordWriteTimeoutMax
)
552 cfi
->chips
[i
].word_write_time_max
=
553 1<<(cfi
->cfiq
->WordWriteTimeoutTyp
+
554 cfi
->cfiq
->WordWriteTimeoutMax
);
556 cfi
->chips
[i
].word_write_time_max
= 50000 * 8;
558 if (cfi
->cfiq
->BufWriteTimeoutTyp
&&
559 cfi
->cfiq
->BufWriteTimeoutMax
)
560 cfi
->chips
[i
].buffer_write_time_max
=
561 1<<(cfi
->cfiq
->BufWriteTimeoutTyp
+
562 cfi
->cfiq
->BufWriteTimeoutMax
);
564 if (cfi
->cfiq
->BlockEraseTimeoutTyp
&&
565 cfi
->cfiq
->BlockEraseTimeoutMax
)
566 cfi
->chips
[i
].erase_time_max
=
567 1000<<(cfi
->cfiq
->BlockEraseTimeoutTyp
+
568 cfi
->cfiq
->BlockEraseTimeoutMax
);
570 cfi
->chips
[i
].erase_time_max
= 2000000 * 8;
572 cfi
->chips
[i
].ref_point_counter
= 0;
573 init_waitqueue_head(&(cfi
->chips
[i
].wq
));
576 map
->fldrv
= &cfi_intelext_chipdrv
;
578 return cfi_intelext_setup(mtd
);
580 struct mtd_info
*cfi_cmdset_0003(struct map_info
*map
, int primary
) __attribute__((alias("cfi_cmdset_0001")));
581 struct mtd_info
*cfi_cmdset_0200(struct map_info
*map
, int primary
) __attribute__((alias("cfi_cmdset_0001")));
582 EXPORT_SYMBOL_GPL(cfi_cmdset_0001
);
583 EXPORT_SYMBOL_GPL(cfi_cmdset_0003
);
584 EXPORT_SYMBOL_GPL(cfi_cmdset_0200
);
586 static struct mtd_info
*cfi_intelext_setup(struct mtd_info
*mtd
)
588 struct map_info
*map
= mtd
->priv
;
589 struct cfi_private
*cfi
= map
->fldrv_priv
;
590 unsigned long offset
= 0;
592 unsigned long devsize
= (1<<cfi
->cfiq
->DevSize
) * cfi
->interleave
;
594 //printk(KERN_DEBUG "number of CFI chips: %d\n", cfi->numchips);
596 mtd
->size
= devsize
* cfi
->numchips
;
598 mtd
->numeraseregions
= cfi
->cfiq
->NumEraseRegions
* cfi
->numchips
;
599 mtd
->eraseregions
= kmalloc(sizeof(struct mtd_erase_region_info
)
600 * mtd
->numeraseregions
, GFP_KERNEL
);
601 if (!mtd
->eraseregions
)
604 for (i
=0; i
<cfi
->cfiq
->NumEraseRegions
; i
++) {
605 unsigned long ernum
, ersize
;
606 ersize
= ((cfi
->cfiq
->EraseRegionInfo
[i
] >> 8) & ~0xff) * cfi
->interleave
;
607 ernum
= (cfi
->cfiq
->EraseRegionInfo
[i
] & 0xffff) + 1;
609 if (mtd
->erasesize
< ersize
) {
610 mtd
->erasesize
= ersize
;
612 for (j
=0; j
<cfi
->numchips
; j
++) {
613 mtd
->eraseregions
[(j
*cfi
->cfiq
->NumEraseRegions
)+i
].offset
= (j
*devsize
)+offset
;
614 mtd
->eraseregions
[(j
*cfi
->cfiq
->NumEraseRegions
)+i
].erasesize
= ersize
;
615 mtd
->eraseregions
[(j
*cfi
->cfiq
->NumEraseRegions
)+i
].numblocks
= ernum
;
616 mtd
->eraseregions
[(j
*cfi
->cfiq
->NumEraseRegions
)+i
].lockmap
= kmalloc(ernum
/ 8 + 1, GFP_KERNEL
);
618 offset
+= (ersize
* ernum
);
621 if (offset
!= devsize
) {
623 printk(KERN_WARNING
"Sum of regions (%lx) != total size of set of interleaved chips (%lx)\n", offset
, devsize
);
627 for (i
=0; i
<mtd
->numeraseregions
;i
++){
628 printk(KERN_DEBUG
"erase region %d: offset=0x%llx,size=0x%x,blocks=%d\n",
629 i
,(unsigned long long)mtd
->eraseregions
[i
].offset
,
630 mtd
->eraseregions
[i
].erasesize
,
631 mtd
->eraseregions
[i
].numblocks
);
634 #ifdef CONFIG_MTD_OTP
635 mtd
->_read_fact_prot_reg
= cfi_intelext_read_fact_prot_reg
;
636 mtd
->_read_user_prot_reg
= cfi_intelext_read_user_prot_reg
;
637 mtd
->_write_user_prot_reg
= cfi_intelext_write_user_prot_reg
;
638 mtd
->_lock_user_prot_reg
= cfi_intelext_lock_user_prot_reg
;
639 mtd
->_get_fact_prot_info
= cfi_intelext_get_fact_prot_info
;
640 mtd
->_get_user_prot_info
= cfi_intelext_get_user_prot_info
;
643 /* This function has the potential to distort the reality
644 a bit and therefore should be called last. */
645 if (cfi_intelext_partition_fixup(mtd
, &cfi
) != 0)
648 __module_get(THIS_MODULE
);
649 register_reboot_notifier(&mtd
->reboot_notifier
);
653 kfree(mtd
->eraseregions
);
655 kfree(cfi
->cmdset_priv
);
659 static int cfi_intelext_partition_fixup(struct mtd_info
*mtd
,
660 struct cfi_private
**pcfi
)
662 struct map_info
*map
= mtd
->priv
;
663 struct cfi_private
*cfi
= *pcfi
;
664 struct cfi_pri_intelext
*extp
= cfi
->cmdset_priv
;
667 * Probing of multi-partition flash chips.
669 * To support multiple partitions when available, we simply arrange
670 * for each of them to have their own flchip structure even if they
671 * are on the same physical chip. This means completely recreating
672 * a new cfi_private structure right here which is a blatent code
673 * layering violation, but this is still the least intrusive
674 * arrangement at this point. This can be rearranged in the future
675 * if someone feels motivated enough. --nico
677 if (extp
&& extp
->MajorVersion
== '1' && extp
->MinorVersion
>= '3'
678 && extp
->FeatureSupport
& (1 << 9)) {
679 struct cfi_private
*newcfi
;
681 struct flchip_shared
*shared
;
682 int offs
, numregions
, numparts
, partshift
, numvirtchips
, i
, j
;
684 /* Protection Register info */
685 offs
= (extp
->NumProtectionFields
- 1) *
686 sizeof(struct cfi_intelext_otpinfo
);
688 /* Burst Read info */
689 offs
+= extp
->extra
[offs
+1]+2;
691 /* Number of partition regions */
692 numregions
= extp
->extra
[offs
];
695 /* skip the sizeof(partregion) field in CFI 1.4 */
696 if (extp
->MinorVersion
>= '4')
699 /* Number of hardware partitions */
701 for (i
= 0; i
< numregions
; i
++) {
702 struct cfi_intelext_regioninfo
*rinfo
;
703 rinfo
= (struct cfi_intelext_regioninfo
*)&extp
->extra
[offs
];
704 numparts
+= rinfo
->NumIdentPartitions
;
705 offs
+= sizeof(*rinfo
)
706 + (rinfo
->NumBlockTypes
- 1) *
707 sizeof(struct cfi_intelext_blockinfo
);
713 /* Programming Region info */
714 if (extp
->MinorVersion
>= '4') {
715 struct cfi_intelext_programming_regioninfo
*prinfo
;
716 prinfo
= (struct cfi_intelext_programming_regioninfo
*)&extp
->extra
[offs
];
717 mtd
->writesize
= cfi
->interleave
<< prinfo
->ProgRegShift
;
718 mtd
->flags
&= ~MTD_BIT_WRITEABLE
;
719 printk(KERN_DEBUG
"%s: program region size/ctrl_valid/ctrl_inval = %d/%d/%d\n",
720 map
->name
, mtd
->writesize
,
721 cfi
->interleave
* prinfo
->ControlValid
,
722 cfi
->interleave
* prinfo
->ControlInvalid
);
726 * All functions below currently rely on all chips having
727 * the same geometry so we'll just assume that all hardware
728 * partitions are of the same size too.
730 partshift
= cfi
->chipshift
- __ffs(numparts
);
732 if ((1 << partshift
) < mtd
->erasesize
) {
734 "%s: bad number of hw partitions (%d)\n",
739 numvirtchips
= cfi
->numchips
* numparts
;
740 newcfi
= kmalloc(sizeof(struct cfi_private
) + numvirtchips
* sizeof(struct flchip
), GFP_KERNEL
);
743 shared
= kmalloc(sizeof(struct flchip_shared
) * cfi
->numchips
, GFP_KERNEL
);
748 memcpy(newcfi
, cfi
, sizeof(struct cfi_private
));
749 newcfi
->numchips
= numvirtchips
;
750 newcfi
->chipshift
= partshift
;
752 chip
= &newcfi
->chips
[0];
753 for (i
= 0; i
< cfi
->numchips
; i
++) {
754 shared
[i
].writing
= shared
[i
].erasing
= NULL
;
755 mutex_init(&shared
[i
].lock
);
756 for (j
= 0; j
< numparts
; j
++) {
757 *chip
= cfi
->chips
[i
];
758 chip
->start
+= j
<< partshift
;
759 chip
->priv
= &shared
[i
];
760 /* those should be reset too since
761 they create memory references. */
762 init_waitqueue_head(&chip
->wq
);
763 mutex_init(&chip
->mutex
);
768 printk(KERN_DEBUG
"%s: %d set(s) of %d interleaved chips "
769 "--> %d partitions of %d KiB\n",
770 map
->name
, cfi
->numchips
, cfi
->interleave
,
771 newcfi
->numchips
, 1<<(newcfi
->chipshift
-10));
773 map
->fldrv_priv
= newcfi
;
782 * *********** CHIP ACCESS FUNCTIONS ***********
784 static int chip_ready (struct map_info
*map
, struct flchip
*chip
, unsigned long adr
, int mode
)
786 DECLARE_WAITQUEUE(wait
, current
);
787 struct cfi_private
*cfi
= map
->fldrv_priv
;
788 map_word status
, status_OK
= CMD(0x80), status_PWS
= CMD(0x01);
789 struct cfi_pri_intelext
*cfip
= cfi
->cmdset_priv
;
790 unsigned long timeo
= jiffies
+ HZ
;
792 /* Prevent setting state FL_SYNCING for chip in suspended state. */
793 if (mode
== FL_SYNCING
&& chip
->oldstate
!= FL_READY
)
796 switch (chip
->state
) {
800 status
= map_read(map
, adr
);
801 if (map_word_andequal(map
, status
, status_OK
, status_OK
))
804 /* At this point we're fine with write operations
805 in other partitions as they don't conflict. */
806 if (chip
->priv
&& map_word_andequal(map
, status
, status_PWS
, status_PWS
))
809 mutex_unlock(&chip
->mutex
);
811 mutex_lock(&chip
->mutex
);
812 /* Someone else might have been playing with it. */
823 !(cfip
->FeatureSupport
& 2) ||
824 !(mode
== FL_READY
|| mode
== FL_POINT
||
825 (mode
== FL_WRITING
&& (cfip
->SuspendCmdSupport
& 1))))
830 map_write(map
, CMD(0xB0), adr
);
832 /* If the flash has finished erasing, then 'erase suspend'
833 * appears to make some (28F320) flash devices switch to
834 * 'read' mode. Make sure that we switch to 'read status'
835 * mode so we get the right data. --rmk
837 map_write(map
, CMD(0x70), adr
);
838 chip
->oldstate
= FL_ERASING
;
839 chip
->state
= FL_ERASE_SUSPENDING
;
840 chip
->erase_suspended
= 1;
842 status
= map_read(map
, adr
);
843 if (map_word_andequal(map
, status
, status_OK
, status_OK
))
846 if (time_after(jiffies
, timeo
)) {
847 /* Urgh. Resume and pretend we weren't here.
848 * Make sure we're in 'read status' mode if it had finished */
849 put_chip(map
, chip
, adr
);
850 printk(KERN_ERR
"%s: Chip not ready after erase "
851 "suspended: status = 0x%lx\n", map
->name
, status
.x
[0]);
855 mutex_unlock(&chip
->mutex
);
857 mutex_lock(&chip
->mutex
);
858 /* Nobody will touch it while it's in state FL_ERASE_SUSPENDING.
859 So we can just loop here. */
861 chip
->state
= FL_STATUS
;
864 case FL_XIP_WHILE_ERASING
:
865 if (mode
!= FL_READY
&& mode
!= FL_POINT
&&
866 (mode
!= FL_WRITING
|| !cfip
|| !(cfip
->SuspendCmdSupport
&1)))
868 chip
->oldstate
= chip
->state
;
869 chip
->state
= FL_READY
;
873 /* The machine is rebooting now,so no one can get chip anymore */
876 /* Only if there's no operation suspended... */
877 if (mode
== FL_READY
&& chip
->oldstate
== FL_READY
)
882 set_current_state(TASK_UNINTERRUPTIBLE
);
883 add_wait_queue(&chip
->wq
, &wait
);
884 mutex_unlock(&chip
->mutex
);
886 remove_wait_queue(&chip
->wq
, &wait
);
887 mutex_lock(&chip
->mutex
);
892 static int get_chip(struct map_info
*map
, struct flchip
*chip
, unsigned long adr
, int mode
)
895 DECLARE_WAITQUEUE(wait
, current
);
899 (mode
== FL_WRITING
|| mode
== FL_ERASING
|| mode
== FL_OTP_WRITE
900 || mode
== FL_SHUTDOWN
) && chip
->state
!= FL_SYNCING
) {
902 * OK. We have possibility for contention on the write/erase
903 * operations which are global to the real chip and not per
904 * partition. So let's fight it over in the partition which
905 * currently has authority on the operation.
907 * The rules are as follows:
909 * - any write operation must own shared->writing.
911 * - any erase operation must own _both_ shared->writing and
914 * - contention arbitration is handled in the owner's context.
916 * The 'shared' struct can be read and/or written only when
919 struct flchip_shared
*shared
= chip
->priv
;
920 struct flchip
*contender
;
921 mutex_lock(&shared
->lock
);
922 contender
= shared
->writing
;
923 if (contender
&& contender
!= chip
) {
925 * The engine to perform desired operation on this
926 * partition is already in use by someone else.
927 * Let's fight over it in the context of the chip
928 * currently using it. If it is possible to suspend,
929 * that other partition will do just that, otherwise
930 * it'll happily send us to sleep. In any case, when
931 * get_chip returns success we're clear to go ahead.
933 ret
= mutex_trylock(&contender
->mutex
);
934 mutex_unlock(&shared
->lock
);
937 mutex_unlock(&chip
->mutex
);
938 ret
= chip_ready(map
, contender
, contender
->start
, mode
);
939 mutex_lock(&chip
->mutex
);
941 if (ret
== -EAGAIN
) {
942 mutex_unlock(&contender
->mutex
);
946 mutex_unlock(&contender
->mutex
);
949 mutex_lock(&shared
->lock
);
951 /* We should not own chip if it is already
952 * in FL_SYNCING state. Put contender and retry. */
953 if (chip
->state
== FL_SYNCING
) {
954 put_chip(map
, contender
, contender
->start
);
955 mutex_unlock(&contender
->mutex
);
958 mutex_unlock(&contender
->mutex
);
961 /* Check if we already have suspended erase
962 * on this chip. Sleep. */
963 if (mode
== FL_ERASING
&& shared
->erasing
964 && shared
->erasing
->oldstate
== FL_ERASING
) {
965 mutex_unlock(&shared
->lock
);
966 set_current_state(TASK_UNINTERRUPTIBLE
);
967 add_wait_queue(&chip
->wq
, &wait
);
968 mutex_unlock(&chip
->mutex
);
970 remove_wait_queue(&chip
->wq
, &wait
);
971 mutex_lock(&chip
->mutex
);
976 shared
->writing
= chip
;
977 if (mode
== FL_ERASING
)
978 shared
->erasing
= chip
;
979 mutex_unlock(&shared
->lock
);
981 ret
= chip_ready(map
, chip
, adr
, mode
);
988 static void put_chip(struct map_info
*map
, struct flchip
*chip
, unsigned long adr
)
990 struct cfi_private
*cfi
= map
->fldrv_priv
;
993 struct flchip_shared
*shared
= chip
->priv
;
994 mutex_lock(&shared
->lock
);
995 if (shared
->writing
== chip
&& chip
->oldstate
== FL_READY
) {
996 /* We own the ability to write, but we're done */
997 shared
->writing
= shared
->erasing
;
998 if (shared
->writing
&& shared
->writing
!= chip
) {
999 /* give back ownership to who we loaned it from */
1000 struct flchip
*loaner
= shared
->writing
;
1001 mutex_lock(&loaner
->mutex
);
1002 mutex_unlock(&shared
->lock
);
1003 mutex_unlock(&chip
->mutex
);
1004 put_chip(map
, loaner
, loaner
->start
);
1005 mutex_lock(&chip
->mutex
);
1006 mutex_unlock(&loaner
->mutex
);
1010 shared
->erasing
= NULL
;
1011 shared
->writing
= NULL
;
1012 } else if (shared
->erasing
== chip
&& shared
->writing
!= chip
) {
1014 * We own the ability to erase without the ability
1015 * to write, which means the erase was suspended
1016 * and some other partition is currently writing.
1017 * Don't let the switch below mess things up since
1018 * we don't have ownership to resume anything.
1020 mutex_unlock(&shared
->lock
);
1024 mutex_unlock(&shared
->lock
);
1027 switch(chip
->oldstate
) {
1029 /* What if one interleaved chip has finished and the
1030 other hasn't? The old code would leave the finished
1031 one in READY mode. That's bad, and caused -EROFS
1032 errors to be returned from do_erase_oneblock because
1033 that's the only bit it checked for at the time.
1034 As the state machine appears to explicitly allow
1035 sending the 0x70 (Read Status) command to an erasing
1036 chip and expecting it to be ignored, that's what we
1038 map_write(map
, CMD(0xd0), adr
);
1039 map_write(map
, CMD(0x70), adr
);
1040 chip
->oldstate
= FL_READY
;
1041 chip
->state
= FL_ERASING
;
1044 case FL_XIP_WHILE_ERASING
:
1045 chip
->state
= chip
->oldstate
;
1046 chip
->oldstate
= FL_READY
;
1051 case FL_JEDEC_QUERY
:
1054 printk(KERN_ERR
"%s: put_chip() called with oldstate %d!!\n", map
->name
, chip
->oldstate
);
1059 #ifdef CONFIG_MTD_XIP
1062 * No interrupt what so ever can be serviced while the flash isn't in array
1063 * mode. This is ensured by the xip_disable() and xip_enable() functions
1064 * enclosing any code path where the flash is known not to be in array mode.
1065 * And within a XIP disabled code path, only functions marked with __xipram
1066 * may be called and nothing else (it's a good thing to inspect generated
1067 * assembly to make sure inline functions were actually inlined and that gcc
1068 * didn't emit calls to its own support functions). Also configuring MTD CFI
1069 * support to a single buswidth and a single interleave is also recommended.
1072 static void xip_disable(struct map_info
*map
, struct flchip
*chip
,
1075 /* TODO: chips with no XIP use should ignore and return */
1076 (void) map_read(map
, adr
); /* ensure mmu mapping is up to date */
1077 local_irq_disable();
1080 static void __xipram
xip_enable(struct map_info
*map
, struct flchip
*chip
,
1083 struct cfi_private
*cfi
= map
->fldrv_priv
;
1084 if (chip
->state
!= FL_POINT
&& chip
->state
!= FL_READY
) {
1085 map_write(map
, CMD(0xff), adr
);
1086 chip
->state
= FL_READY
;
1088 (void) map_read(map
, adr
);
1094 * When a delay is required for the flash operation to complete, the
1095 * xip_wait_for_operation() function is polling for both the given timeout
1096 * and pending (but still masked) hardware interrupts. Whenever there is an
1097 * interrupt pending then the flash erase or write operation is suspended,
1098 * array mode restored and interrupts unmasked. Task scheduling might also
1099 * happen at that point. The CPU eventually returns from the interrupt or
1100 * the call to schedule() and the suspended flash operation is resumed for
1101 * the remaining of the delay period.
1103 * Warning: this function _will_ fool interrupt latency tracing tools.
1106 static int __xipram
xip_wait_for_operation(
1107 struct map_info
*map
, struct flchip
*chip
,
1108 unsigned long adr
, unsigned int chip_op_time_max
)
1110 struct cfi_private
*cfi
= map
->fldrv_priv
;
1111 struct cfi_pri_intelext
*cfip
= cfi
->cmdset_priv
;
1112 map_word status
, OK
= CMD(0x80);
1113 unsigned long usec
, suspended
, start
, done
;
1114 flstate_t oldstate
, newstate
;
1116 start
= xip_currtime();
1117 usec
= chip_op_time_max
;
1124 if (xip_irqpending() && cfip
&&
1125 ((chip
->state
== FL_ERASING
&& (cfip
->FeatureSupport
&2)) ||
1126 (chip
->state
== FL_WRITING
&& (cfip
->FeatureSupport
&4))) &&
1127 (cfi_interleave_is_1(cfi
) || chip
->oldstate
== FL_READY
)) {
1129 * Let's suspend the erase or write operation when
1130 * supported. Note that we currently don't try to
1131 * suspend interleaved chips if there is already
1132 * another operation suspended (imagine what happens
1133 * when one chip was already done with the current
1134 * operation while another chip suspended it, then
1135 * we resume the whole thing at once). Yes, it
1139 map_write(map
, CMD(0xb0), adr
);
1140 map_write(map
, CMD(0x70), adr
);
1141 suspended
= xip_currtime();
1143 if (xip_elapsed_since(suspended
) > 100000) {
1145 * The chip doesn't want to suspend
1146 * after waiting for 100 msecs.
1147 * This is a critical error but there
1148 * is not much we can do here.
1152 status
= map_read(map
, adr
);
1153 } while (!map_word_andequal(map
, status
, OK
, OK
));
1155 /* Suspend succeeded */
1156 oldstate
= chip
->state
;
1157 if (oldstate
== FL_ERASING
) {
1158 if (!map_word_bitsset(map
, status
, CMD(0x40)))
1160 newstate
= FL_XIP_WHILE_ERASING
;
1161 chip
->erase_suspended
= 1;
1163 if (!map_word_bitsset(map
, status
, CMD(0x04)))
1165 newstate
= FL_XIP_WHILE_WRITING
;
1166 chip
->write_suspended
= 1;
1168 chip
->state
= newstate
;
1169 map_write(map
, CMD(0xff), adr
);
1170 (void) map_read(map
, adr
);
1173 mutex_unlock(&chip
->mutex
);
1178 * We're back. However someone else might have
1179 * decided to go write to the chip if we are in
1180 * a suspended erase state. If so let's wait
1183 mutex_lock(&chip
->mutex
);
1184 while (chip
->state
!= newstate
) {
1185 DECLARE_WAITQUEUE(wait
, current
);
1186 set_current_state(TASK_UNINTERRUPTIBLE
);
1187 add_wait_queue(&chip
->wq
, &wait
);
1188 mutex_unlock(&chip
->mutex
);
1190 remove_wait_queue(&chip
->wq
, &wait
);
1191 mutex_lock(&chip
->mutex
);
1193 /* Disallow XIP again */
1194 local_irq_disable();
1196 /* Resume the write or erase operation */
1197 map_write(map
, CMD(0xd0), adr
);
1198 map_write(map
, CMD(0x70), adr
);
1199 chip
->state
= oldstate
;
1200 start
= xip_currtime();
1201 } else if (usec
>= 1000000/HZ
) {
1203 * Try to save on CPU power when waiting delay
1204 * is at least a system timer tick period.
1205 * No need to be extremely accurate here.
1209 status
= map_read(map
, adr
);
1210 done
= xip_elapsed_since(start
);
1211 } while (!map_word_andequal(map
, status
, OK
, OK
)
1214 return (done
>= usec
) ? -ETIME
: 0;
1218 * The INVALIDATE_CACHED_RANGE() macro is normally used in parallel while
1219 * the flash is actively programming or erasing since we have to poll for
1220 * the operation to complete anyway. We can't do that in a generic way with
1221 * a XIP setup so do it before the actual flash operation in this case
1222 * and stub it out from INVAL_CACHE_AND_WAIT.
1224 #define XIP_INVAL_CACHED_RANGE(map, from, size) \
1225 INVALIDATE_CACHED_RANGE(map, from, size)
1227 #define INVAL_CACHE_AND_WAIT(map, chip, cmd_adr, inval_adr, inval_len, usec, usec_max) \
1228 xip_wait_for_operation(map, chip, cmd_adr, usec_max)
1232 #define xip_disable(map, chip, adr)
1233 #define xip_enable(map, chip, adr)
1234 #define XIP_INVAL_CACHED_RANGE(x...)
1235 #define INVAL_CACHE_AND_WAIT inval_cache_and_wait_for_operation
1237 static int inval_cache_and_wait_for_operation(
1238 struct map_info
*map
, struct flchip
*chip
,
1239 unsigned long cmd_adr
, unsigned long inval_adr
, int inval_len
,
1240 unsigned int chip_op_time
, unsigned int chip_op_time_max
)
1242 struct cfi_private
*cfi
= map
->fldrv_priv
;
1243 map_word status
, status_OK
= CMD(0x80);
1244 int chip_state
= chip
->state
;
1245 unsigned int timeo
, sleep_time
, reset_timeo
;
1247 mutex_unlock(&chip
->mutex
);
1249 INVALIDATE_CACHED_RANGE(map
, inval_adr
, inval_len
);
1250 mutex_lock(&chip
->mutex
);
1252 timeo
= chip_op_time_max
;
1255 reset_timeo
= timeo
;
1256 sleep_time
= chip_op_time
/ 2;
1259 if (chip
->state
!= chip_state
) {
1260 /* Someone's suspended the operation: sleep */
1261 DECLARE_WAITQUEUE(wait
, current
);
1262 set_current_state(TASK_UNINTERRUPTIBLE
);
1263 add_wait_queue(&chip
->wq
, &wait
);
1264 mutex_unlock(&chip
->mutex
);
1266 remove_wait_queue(&chip
->wq
, &wait
);
1267 mutex_lock(&chip
->mutex
);
1271 status
= map_read(map
, cmd_adr
);
1272 if (map_word_andequal(map
, status
, status_OK
, status_OK
))
1275 if (chip
->erase_suspended
&& chip_state
== FL_ERASING
) {
1276 /* Erase suspend occurred while sleep: reset timeout */
1277 timeo
= reset_timeo
;
1278 chip
->erase_suspended
= 0;
1280 if (chip
->write_suspended
&& chip_state
== FL_WRITING
) {
1281 /* Write suspend occurred while sleep: reset timeout */
1282 timeo
= reset_timeo
;
1283 chip
->write_suspended
= 0;
1286 map_write(map
, CMD(0x70), cmd_adr
);
1287 chip
->state
= FL_STATUS
;
1291 /* OK Still waiting. Drop the lock, wait a while and retry. */
1292 mutex_unlock(&chip
->mutex
);
1293 if (sleep_time
>= 1000000/HZ
) {
1295 * Half of the normal delay still remaining
1296 * can be performed with a sleeping delay instead
1299 msleep(sleep_time
/1000);
1300 timeo
-= sleep_time
;
1301 sleep_time
= 1000000/HZ
;
1307 mutex_lock(&chip
->mutex
);
1310 /* Done and happy. */
1311 chip
->state
= FL_STATUS
;
1317 #define WAIT_TIMEOUT(map, chip, adr, udelay, udelay_max) \
1318 INVAL_CACHE_AND_WAIT(map, chip, adr, 0, 0, udelay, udelay_max);
1321 static int do_point_onechip (struct map_info
*map
, struct flchip
*chip
, loff_t adr
, size_t len
)
1323 unsigned long cmd_addr
;
1324 struct cfi_private
*cfi
= map
->fldrv_priv
;
1329 /* Ensure cmd read/writes are aligned. */
1330 cmd_addr
= adr
& ~(map_bankwidth(map
)-1);
1332 mutex_lock(&chip
->mutex
);
1334 ret
= get_chip(map
, chip
, cmd_addr
, FL_POINT
);
1337 if (chip
->state
!= FL_POINT
&& chip
->state
!= FL_READY
)
1338 map_write(map
, CMD(0xff), cmd_addr
);
1340 chip
->state
= FL_POINT
;
1341 chip
->ref_point_counter
++;
1343 mutex_unlock(&chip
->mutex
);
1348 static int cfi_intelext_point(struct mtd_info
*mtd
, loff_t from
, size_t len
,
1349 size_t *retlen
, void **virt
, resource_size_t
*phys
)
1351 struct map_info
*map
= mtd
->priv
;
1352 struct cfi_private
*cfi
= map
->fldrv_priv
;
1353 unsigned long ofs
, last_end
= 0;
1360 /* Now lock the chip(s) to POINT state */
1362 /* ofs: offset within the first chip that the first read should start */
1363 chipnum
= (from
>> cfi
->chipshift
);
1364 ofs
= from
- (chipnum
<< cfi
->chipshift
);
1366 *virt
= map
->virt
+ cfi
->chips
[chipnum
].start
+ ofs
;
1368 *phys
= map
->phys
+ cfi
->chips
[chipnum
].start
+ ofs
;
1371 unsigned long thislen
;
1373 if (chipnum
>= cfi
->numchips
)
1376 /* We cannot point across chips that are virtually disjoint */
1378 last_end
= cfi
->chips
[chipnum
].start
;
1379 else if (cfi
->chips
[chipnum
].start
!= last_end
)
1382 if ((len
+ ofs
-1) >> cfi
->chipshift
)
1383 thislen
= (1<<cfi
->chipshift
) - ofs
;
1387 ret
= do_point_onechip(map
, &cfi
->chips
[chipnum
], ofs
, thislen
);
1395 last_end
+= 1 << cfi
->chipshift
;
1401 static int cfi_intelext_unpoint(struct mtd_info
*mtd
, loff_t from
, size_t len
)
1403 struct map_info
*map
= mtd
->priv
;
1404 struct cfi_private
*cfi
= map
->fldrv_priv
;
1406 int chipnum
, err
= 0;
1408 /* Now unlock the chip(s) POINT state */
1410 /* ofs: offset within the first chip that the first read should start */
1411 chipnum
= (from
>> cfi
->chipshift
);
1412 ofs
= from
- (chipnum
<< cfi
->chipshift
);
1414 while (len
&& !err
) {
1415 unsigned long thislen
;
1416 struct flchip
*chip
;
1418 chip
= &cfi
->chips
[chipnum
];
1419 if (chipnum
>= cfi
->numchips
)
1422 if ((len
+ ofs
-1) >> cfi
->chipshift
)
1423 thislen
= (1<<cfi
->chipshift
) - ofs
;
1427 mutex_lock(&chip
->mutex
);
1428 if (chip
->state
== FL_POINT
) {
1429 chip
->ref_point_counter
--;
1430 if(chip
->ref_point_counter
== 0)
1431 chip
->state
= FL_READY
;
1433 printk(KERN_ERR
"%s: Error: unpoint called on non pointed region\n", map
->name
);
1437 put_chip(map
, chip
, chip
->start
);
1438 mutex_unlock(&chip
->mutex
);
1448 static inline int do_read_onechip(struct map_info
*map
, struct flchip
*chip
, loff_t adr
, size_t len
, u_char
*buf
)
1450 unsigned long cmd_addr
;
1451 struct cfi_private
*cfi
= map
->fldrv_priv
;
1456 /* Ensure cmd read/writes are aligned. */
1457 cmd_addr
= adr
& ~(map_bankwidth(map
)-1);
1459 mutex_lock(&chip
->mutex
);
1460 ret
= get_chip(map
, chip
, cmd_addr
, FL_READY
);
1462 mutex_unlock(&chip
->mutex
);
1466 if (chip
->state
!= FL_POINT
&& chip
->state
!= FL_READY
) {
1467 map_write(map
, CMD(0xff), cmd_addr
);
1469 chip
->state
= FL_READY
;
1472 map_copy_from(map
, buf
, adr
, len
);
1474 put_chip(map
, chip
, cmd_addr
);
1476 mutex_unlock(&chip
->mutex
);
1480 static int cfi_intelext_read (struct mtd_info
*mtd
, loff_t from
, size_t len
, size_t *retlen
, u_char
*buf
)
1482 struct map_info
*map
= mtd
->priv
;
1483 struct cfi_private
*cfi
= map
->fldrv_priv
;
1488 /* ofs: offset within the first chip that the first read should start */
1489 chipnum
= (from
>> cfi
->chipshift
);
1490 ofs
= from
- (chipnum
<< cfi
->chipshift
);
1493 unsigned long thislen
;
1495 if (chipnum
>= cfi
->numchips
)
1498 if ((len
+ ofs
-1) >> cfi
->chipshift
)
1499 thislen
= (1<<cfi
->chipshift
) - ofs
;
1503 ret
= do_read_onechip(map
, &cfi
->chips
[chipnum
], ofs
, thislen
, buf
);
1517 static int __xipram
do_write_oneword(struct map_info
*map
, struct flchip
*chip
,
1518 unsigned long adr
, map_word datum
, int mode
)
1520 struct cfi_private
*cfi
= map
->fldrv_priv
;
1521 map_word status
, write_cmd
;
1528 write_cmd
= (cfi
->cfiq
->P_ID
!= P_ID_INTEL_PERFORMANCE
) ? CMD(0x40) : CMD(0x41);
1531 write_cmd
= CMD(0xc0);
1537 mutex_lock(&chip
->mutex
);
1538 ret
= get_chip(map
, chip
, adr
, mode
);
1540 mutex_unlock(&chip
->mutex
);
1544 XIP_INVAL_CACHED_RANGE(map
, adr
, map_bankwidth(map
));
1546 xip_disable(map
, chip
, adr
);
1547 map_write(map
, write_cmd
, adr
);
1548 map_write(map
, datum
, adr
);
1551 ret
= INVAL_CACHE_AND_WAIT(map
, chip
, adr
,
1552 adr
, map_bankwidth(map
),
1553 chip
->word_write_time
,
1554 chip
->word_write_time_max
);
1556 xip_enable(map
, chip
, adr
);
1557 printk(KERN_ERR
"%s: word write error (status timeout)\n", map
->name
);
1561 /* check for errors */
1562 status
= map_read(map
, adr
);
1563 if (map_word_bitsset(map
, status
, CMD(0x1a))) {
1564 unsigned long chipstatus
= MERGESTATUS(status
);
1567 map_write(map
, CMD(0x50), adr
);
1568 map_write(map
, CMD(0x70), adr
);
1569 xip_enable(map
, chip
, adr
);
1571 if (chipstatus
& 0x02) {
1573 } else if (chipstatus
& 0x08) {
1574 printk(KERN_ERR
"%s: word write error (bad VPP)\n", map
->name
);
1577 printk(KERN_ERR
"%s: word write error (status 0x%lx)\n", map
->name
, chipstatus
);
1584 xip_enable(map
, chip
, adr
);
1585 out
: DISABLE_VPP(map
);
1586 put_chip(map
, chip
, adr
);
1587 mutex_unlock(&chip
->mutex
);
1592 static int cfi_intelext_write_words (struct mtd_info
*mtd
, loff_t to
, size_t len
, size_t *retlen
, const u_char
*buf
)
1594 struct map_info
*map
= mtd
->priv
;
1595 struct cfi_private
*cfi
= map
->fldrv_priv
;
1600 chipnum
= to
>> cfi
->chipshift
;
1601 ofs
= to
- (chipnum
<< cfi
->chipshift
);
1603 /* If it's not bus-aligned, do the first byte write */
1604 if (ofs
& (map_bankwidth(map
)-1)) {
1605 unsigned long bus_ofs
= ofs
& ~(map_bankwidth(map
)-1);
1606 int gap
= ofs
- bus_ofs
;
1610 n
= min_t(int, len
, map_bankwidth(map
)-gap
);
1611 datum
= map_word_ff(map
);
1612 datum
= map_word_load_partial(map
, datum
, buf
, gap
, n
);
1614 ret
= do_write_oneword(map
, &cfi
->chips
[chipnum
],
1615 bus_ofs
, datum
, FL_WRITING
);
1624 if (ofs
>> cfi
->chipshift
) {
1627 if (chipnum
== cfi
->numchips
)
1632 while(len
>= map_bankwidth(map
)) {
1633 map_word datum
= map_word_load(map
, buf
);
1635 ret
= do_write_oneword(map
, &cfi
->chips
[chipnum
],
1636 ofs
, datum
, FL_WRITING
);
1640 ofs
+= map_bankwidth(map
);
1641 buf
+= map_bankwidth(map
);
1642 (*retlen
) += map_bankwidth(map
);
1643 len
-= map_bankwidth(map
);
1645 if (ofs
>> cfi
->chipshift
) {
1648 if (chipnum
== cfi
->numchips
)
1653 if (len
& (map_bankwidth(map
)-1)) {
1656 datum
= map_word_ff(map
);
1657 datum
= map_word_load_partial(map
, datum
, buf
, 0, len
);
1659 ret
= do_write_oneword(map
, &cfi
->chips
[chipnum
],
1660 ofs
, datum
, FL_WRITING
);
1671 static int __xipram
do_write_buffer(struct map_info
*map
, struct flchip
*chip
,
1672 unsigned long adr
, const struct kvec
**pvec
,
1673 unsigned long *pvec_seek
, int len
)
1675 struct cfi_private
*cfi
= map
->fldrv_priv
;
1676 map_word status
, write_cmd
, datum
;
1677 unsigned long cmd_adr
;
1678 int ret
, wbufsize
, word_gap
, words
;
1679 const struct kvec
*vec
;
1680 unsigned long vec_seek
;
1681 unsigned long initial_adr
;
1682 int initial_len
= len
;
1684 wbufsize
= cfi_interleave(cfi
) << cfi
->cfiq
->MaxBufWriteSize
;
1687 cmd_adr
= adr
& ~(wbufsize
-1);
1689 /* Sharp LH28F640BF chips need the first address for the
1690 * Page Buffer Program command. See Table 5 of
1691 * LH28F320BF, LH28F640BF, LH28F128BF Series (Appendix FUM00701) */
1692 if (is_LH28F640BF(cfi
))
1695 /* Let's determine this according to the interleave only once */
1696 write_cmd
= (cfi
->cfiq
->P_ID
!= P_ID_INTEL_PERFORMANCE
) ? CMD(0xe8) : CMD(0xe9);
1698 mutex_lock(&chip
->mutex
);
1699 ret
= get_chip(map
, chip
, cmd_adr
, FL_WRITING
);
1701 mutex_unlock(&chip
->mutex
);
1705 XIP_INVAL_CACHED_RANGE(map
, initial_adr
, initial_len
);
1707 xip_disable(map
, chip
, cmd_adr
);
1709 /* §4.8 of the 28FxxxJ3A datasheet says "Any time SR.4 and/or SR.5 is set
1710 [...], the device will not accept any more Write to Buffer commands".
1711 So we must check here and reset those bits if they're set. Otherwise
1712 we're just pissing in the wind */
1713 if (chip
->state
!= FL_STATUS
) {
1714 map_write(map
, CMD(0x70), cmd_adr
);
1715 chip
->state
= FL_STATUS
;
1717 status
= map_read(map
, cmd_adr
);
1718 if (map_word_bitsset(map
, status
, CMD(0x30))) {
1719 xip_enable(map
, chip
, cmd_adr
);
1720 printk(KERN_WARNING
"SR.4 or SR.5 bits set in buffer write (status %lx). Clearing.\n", status
.x
[0]);
1721 xip_disable(map
, chip
, cmd_adr
);
1722 map_write(map
, CMD(0x50), cmd_adr
);
1723 map_write(map
, CMD(0x70), cmd_adr
);
1726 chip
->state
= FL_WRITING_TO_BUFFER
;
1727 map_write(map
, write_cmd
, cmd_adr
);
1728 ret
= WAIT_TIMEOUT(map
, chip
, cmd_adr
, 0, 0);
1730 /* Argh. Not ready for write to buffer */
1731 map_word Xstatus
= map_read(map
, cmd_adr
);
1732 map_write(map
, CMD(0x70), cmd_adr
);
1733 chip
->state
= FL_STATUS
;
1734 status
= map_read(map
, cmd_adr
);
1735 map_write(map
, CMD(0x50), cmd_adr
);
1736 map_write(map
, CMD(0x70), cmd_adr
);
1737 xip_enable(map
, chip
, cmd_adr
);
1738 printk(KERN_ERR
"%s: Chip not ready for buffer write. Xstatus = %lx, status = %lx\n",
1739 map
->name
, Xstatus
.x
[0], status
.x
[0]);
1743 /* Figure out the number of words to write */
1744 word_gap
= (-adr
& (map_bankwidth(map
)-1));
1745 words
= DIV_ROUND_UP(len
- word_gap
, map_bankwidth(map
));
1749 word_gap
= map_bankwidth(map
) - word_gap
;
1751 datum
= map_word_ff(map
);
1754 /* Write length of data to come */
1755 map_write(map
, CMD(words
), cmd_adr
);
1759 vec_seek
= *pvec_seek
;
1761 int n
= map_bankwidth(map
) - word_gap
;
1762 if (n
> vec
->iov_len
- vec_seek
)
1763 n
= vec
->iov_len
- vec_seek
;
1767 if (!word_gap
&& len
< map_bankwidth(map
))
1768 datum
= map_word_ff(map
);
1770 datum
= map_word_load_partial(map
, datum
,
1771 vec
->iov_base
+ vec_seek
,
1776 if (!len
|| word_gap
== map_bankwidth(map
)) {
1777 map_write(map
, datum
, adr
);
1778 adr
+= map_bankwidth(map
);
1783 if (vec_seek
== vec
->iov_len
) {
1789 *pvec_seek
= vec_seek
;
1792 map_write(map
, CMD(0xd0), cmd_adr
);
1793 chip
->state
= FL_WRITING
;
1795 ret
= INVAL_CACHE_AND_WAIT(map
, chip
, cmd_adr
,
1796 initial_adr
, initial_len
,
1797 chip
->buffer_write_time
,
1798 chip
->buffer_write_time_max
);
1800 map_write(map
, CMD(0x70), cmd_adr
);
1801 chip
->state
= FL_STATUS
;
1802 xip_enable(map
, chip
, cmd_adr
);
1803 printk(KERN_ERR
"%s: buffer write error (status timeout)\n", map
->name
);
1807 /* check for errors */
1808 status
= map_read(map
, cmd_adr
);
1809 if (map_word_bitsset(map
, status
, CMD(0x1a))) {
1810 unsigned long chipstatus
= MERGESTATUS(status
);
1813 map_write(map
, CMD(0x50), cmd_adr
);
1814 map_write(map
, CMD(0x70), cmd_adr
);
1815 xip_enable(map
, chip
, cmd_adr
);
1817 if (chipstatus
& 0x02) {
1819 } else if (chipstatus
& 0x08) {
1820 printk(KERN_ERR
"%s: buffer write error (bad VPP)\n", map
->name
);
1823 printk(KERN_ERR
"%s: buffer write error (status 0x%lx)\n", map
->name
, chipstatus
);
1830 xip_enable(map
, chip
, cmd_adr
);
1831 out
: DISABLE_VPP(map
);
1832 put_chip(map
, chip
, cmd_adr
);
1833 mutex_unlock(&chip
->mutex
);
1837 static int cfi_intelext_writev (struct mtd_info
*mtd
, const struct kvec
*vecs
,
1838 unsigned long count
, loff_t to
, size_t *retlen
)
1840 struct map_info
*map
= mtd
->priv
;
1841 struct cfi_private
*cfi
= map
->fldrv_priv
;
1842 int wbufsize
= cfi_interleave(cfi
) << cfi
->cfiq
->MaxBufWriteSize
;
1845 unsigned long ofs
, vec_seek
, i
;
1848 for (i
= 0; i
< count
; i
++)
1849 len
+= vecs
[i
].iov_len
;
1854 chipnum
= to
>> cfi
->chipshift
;
1855 ofs
= to
- (chipnum
<< cfi
->chipshift
);
1859 /* We must not cross write block boundaries */
1860 int size
= wbufsize
- (ofs
& (wbufsize
-1));
1864 ret
= do_write_buffer(map
, &cfi
->chips
[chipnum
],
1865 ofs
, &vecs
, &vec_seek
, size
);
1873 if (ofs
>> cfi
->chipshift
) {
1876 if (chipnum
== cfi
->numchips
)
1880 /* Be nice and reschedule with the chip in a usable state for other
1889 static int cfi_intelext_write_buffers (struct mtd_info
*mtd
, loff_t to
,
1890 size_t len
, size_t *retlen
, const u_char
*buf
)
1894 vec
.iov_base
= (void *) buf
;
1897 return cfi_intelext_writev(mtd
, &vec
, 1, to
, retlen
);
1900 static int __xipram
do_erase_oneblock(struct map_info
*map
, struct flchip
*chip
,
1901 unsigned long adr
, int len
, void *thunk
)
1903 struct cfi_private
*cfi
= map
->fldrv_priv
;
1911 mutex_lock(&chip
->mutex
);
1912 ret
= get_chip(map
, chip
, adr
, FL_ERASING
);
1914 mutex_unlock(&chip
->mutex
);
1918 XIP_INVAL_CACHED_RANGE(map
, adr
, len
);
1920 xip_disable(map
, chip
, adr
);
1922 /* Clear the status register first */
1923 map_write(map
, CMD(0x50), adr
);
1926 map_write(map
, CMD(0x20), adr
);
1927 map_write(map
, CMD(0xD0), adr
);
1928 chip
->state
= FL_ERASING
;
1929 chip
->erase_suspended
= 0;
1931 ret
= INVAL_CACHE_AND_WAIT(map
, chip
, adr
,
1934 chip
->erase_time_max
);
1936 map_write(map
, CMD(0x70), adr
);
1937 chip
->state
= FL_STATUS
;
1938 xip_enable(map
, chip
, adr
);
1939 printk(KERN_ERR
"%s: block erase error: (status timeout)\n", map
->name
);
1943 /* We've broken this before. It doesn't hurt to be safe */
1944 map_write(map
, CMD(0x70), adr
);
1945 chip
->state
= FL_STATUS
;
1946 status
= map_read(map
, adr
);
1948 /* check for errors */
1949 if (map_word_bitsset(map
, status
, CMD(0x3a))) {
1950 unsigned long chipstatus
= MERGESTATUS(status
);
1952 /* Reset the error bits */
1953 map_write(map
, CMD(0x50), adr
);
1954 map_write(map
, CMD(0x70), adr
);
1955 xip_enable(map
, chip
, adr
);
1957 if ((chipstatus
& 0x30) == 0x30) {
1958 printk(KERN_ERR
"%s: block erase error: (bad command sequence, status 0x%lx)\n", map
->name
, chipstatus
);
1960 } else if (chipstatus
& 0x02) {
1961 /* Protection bit set */
1963 } else if (chipstatus
& 0x8) {
1965 printk(KERN_ERR
"%s: block erase error: (bad VPP)\n", map
->name
);
1967 } else if (chipstatus
& 0x20 && retries
--) {
1968 printk(KERN_DEBUG
"block erase failed at 0x%08lx: status 0x%lx. Retrying...\n", adr
, chipstatus
);
1970 put_chip(map
, chip
, adr
);
1971 mutex_unlock(&chip
->mutex
);
1974 printk(KERN_ERR
"%s: block erase failed at 0x%08lx (status 0x%lx)\n", map
->name
, adr
, chipstatus
);
1981 xip_enable(map
, chip
, adr
);
1982 out
: DISABLE_VPP(map
);
1983 put_chip(map
, chip
, adr
);
1984 mutex_unlock(&chip
->mutex
);
1988 static int cfi_intelext_erase_varsize(struct mtd_info
*mtd
, struct erase_info
*instr
)
1990 unsigned long ofs
, len
;
1996 ret
= cfi_varsize_frob(mtd
, do_erase_oneblock
, ofs
, len
, NULL
);
2000 instr
->state
= MTD_ERASE_DONE
;
2001 mtd_erase_callback(instr
);
2006 static void cfi_intelext_sync (struct mtd_info
*mtd
)
2008 struct map_info
*map
= mtd
->priv
;
2009 struct cfi_private
*cfi
= map
->fldrv_priv
;
2011 struct flchip
*chip
;
2014 for (i
=0; !ret
&& i
<cfi
->numchips
; i
++) {
2015 chip
= &cfi
->chips
[i
];
2017 mutex_lock(&chip
->mutex
);
2018 ret
= get_chip(map
, chip
, chip
->start
, FL_SYNCING
);
2021 chip
->oldstate
= chip
->state
;
2022 chip
->state
= FL_SYNCING
;
2023 /* No need to wake_up() on this state change -
2024 * as the whole point is that nobody can do anything
2025 * with the chip now anyway.
2028 mutex_unlock(&chip
->mutex
);
2031 /* Unlock the chips again */
2033 for (i
--; i
>=0; i
--) {
2034 chip
= &cfi
->chips
[i
];
2036 mutex_lock(&chip
->mutex
);
2038 if (chip
->state
== FL_SYNCING
) {
2039 chip
->state
= chip
->oldstate
;
2040 chip
->oldstate
= FL_READY
;
2043 mutex_unlock(&chip
->mutex
);
2047 static int __xipram
do_getlockstatus_oneblock(struct map_info
*map
,
2048 struct flchip
*chip
,
2050 int len
, void *thunk
)
2052 struct cfi_private
*cfi
= map
->fldrv_priv
;
2053 int status
, ofs_factor
= cfi
->interleave
* cfi
->device_type
;
2056 xip_disable(map
, chip
, adr
+(2*ofs_factor
));
2057 map_write(map
, CMD(0x90), adr
+(2*ofs_factor
));
2058 chip
->state
= FL_JEDEC_QUERY
;
2059 status
= cfi_read_query(map
, adr
+(2*ofs_factor
));
2060 xip_enable(map
, chip
, 0);
2064 #ifdef DEBUG_LOCK_BITS
2065 static int __xipram
do_printlockstatus_oneblock(struct map_info
*map
,
2066 struct flchip
*chip
,
2068 int len
, void *thunk
)
2070 printk(KERN_DEBUG
"block status register for 0x%08lx is %x\n",
2071 adr
, do_getlockstatus_oneblock(map
, chip
, adr
, len
, thunk
));
2076 #define DO_XXLOCK_ONEBLOCK_LOCK ((void *) 1)
2077 #define DO_XXLOCK_ONEBLOCK_UNLOCK ((void *) 2)
2079 static int __xipram
do_xxlock_oneblock(struct map_info
*map
, struct flchip
*chip
,
2080 unsigned long adr
, int len
, void *thunk
)
2082 struct cfi_private
*cfi
= map
->fldrv_priv
;
2083 struct cfi_pri_intelext
*extp
= cfi
->cmdset_priv
;
2089 mutex_lock(&chip
->mutex
);
2090 ret
= get_chip(map
, chip
, adr
, FL_LOCKING
);
2092 mutex_unlock(&chip
->mutex
);
2097 xip_disable(map
, chip
, adr
);
2099 map_write(map
, CMD(0x60), adr
);
2100 if (thunk
== DO_XXLOCK_ONEBLOCK_LOCK
) {
2101 map_write(map
, CMD(0x01), adr
);
2102 chip
->state
= FL_LOCKING
;
2103 } else if (thunk
== DO_XXLOCK_ONEBLOCK_UNLOCK
) {
2104 map_write(map
, CMD(0xD0), adr
);
2105 chip
->state
= FL_UNLOCKING
;
2110 * If Instant Individual Block Locking supported then no need
2114 * Unlocking may take up to 1.4 seconds on some Intel flashes. So
2115 * lets use a max of 1.5 seconds (1500ms) as timeout.
2117 * See "Clear Block Lock-Bits Time" on page 40 in
2118 * "3 Volt Intel StrataFlash Memory" 28F128J3,28F640J3,28F320J3 manual
2119 * from February 2003
2121 mdelay
= (!extp
|| !(extp
->FeatureSupport
& (1 << 5))) ? 1500 : 0;
2123 ret
= WAIT_TIMEOUT(map
, chip
, adr
, mdelay
, mdelay
* 1000);
2125 map_write(map
, CMD(0x70), adr
);
2126 chip
->state
= FL_STATUS
;
2127 xip_enable(map
, chip
, adr
);
2128 printk(KERN_ERR
"%s: block unlock error: (status timeout)\n", map
->name
);
2132 xip_enable(map
, chip
, adr
);
2133 out
: DISABLE_VPP(map
);
2134 put_chip(map
, chip
, adr
);
2135 mutex_unlock(&chip
->mutex
);
2139 static int cfi_intelext_lock(struct mtd_info
*mtd
, loff_t ofs
, uint64_t len
)
2143 #ifdef DEBUG_LOCK_BITS
2144 printk(KERN_DEBUG
"%s: lock status before, ofs=0x%08llx, len=0x%08X\n",
2145 __func__
, ofs
, len
);
2146 cfi_varsize_frob(mtd
, do_printlockstatus_oneblock
,
2150 ret
= cfi_varsize_frob(mtd
, do_xxlock_oneblock
,
2151 ofs
, len
, DO_XXLOCK_ONEBLOCK_LOCK
);
2153 #ifdef DEBUG_LOCK_BITS
2154 printk(KERN_DEBUG
"%s: lock status after, ret=%d\n",
2156 cfi_varsize_frob(mtd
, do_printlockstatus_oneblock
,
2163 static int cfi_intelext_unlock(struct mtd_info
*mtd
, loff_t ofs
, uint64_t len
)
2167 #ifdef DEBUG_LOCK_BITS
2168 printk(KERN_DEBUG
"%s: lock status before, ofs=0x%08llx, len=0x%08X\n",
2169 __func__
, ofs
, len
);
2170 cfi_varsize_frob(mtd
, do_printlockstatus_oneblock
,
2174 ret
= cfi_varsize_frob(mtd
, do_xxlock_oneblock
,
2175 ofs
, len
, DO_XXLOCK_ONEBLOCK_UNLOCK
);
2177 #ifdef DEBUG_LOCK_BITS
2178 printk(KERN_DEBUG
"%s: lock status after, ret=%d\n",
2180 cfi_varsize_frob(mtd
, do_printlockstatus_oneblock
,
2187 static int cfi_intelext_is_locked(struct mtd_info
*mtd
, loff_t ofs
,
2190 return cfi_varsize_frob(mtd
, do_getlockstatus_oneblock
,
2191 ofs
, len
, NULL
) ? 1 : 0;
2194 #ifdef CONFIG_MTD_OTP
2196 typedef int (*otp_op_t
)(struct map_info
*map
, struct flchip
*chip
,
2197 u_long data_offset
, u_char
*buf
, u_int size
,
2198 u_long prot_offset
, u_int groupno
, u_int groupsize
);
2201 do_otp_read(struct map_info
*map
, struct flchip
*chip
, u_long offset
,
2202 u_char
*buf
, u_int size
, u_long prot
, u_int grpno
, u_int grpsz
)
2204 struct cfi_private
*cfi
= map
->fldrv_priv
;
2207 mutex_lock(&chip
->mutex
);
2208 ret
= get_chip(map
, chip
, chip
->start
, FL_JEDEC_QUERY
);
2210 mutex_unlock(&chip
->mutex
);
2214 /* let's ensure we're not reading back cached data from array mode */
2215 INVALIDATE_CACHED_RANGE(map
, chip
->start
+ offset
, size
);
2217 xip_disable(map
, chip
, chip
->start
);
2218 if (chip
->state
!= FL_JEDEC_QUERY
) {
2219 map_write(map
, CMD(0x90), chip
->start
);
2220 chip
->state
= FL_JEDEC_QUERY
;
2222 map_copy_from(map
, buf
, chip
->start
+ offset
, size
);
2223 xip_enable(map
, chip
, chip
->start
);
2225 /* then ensure we don't keep OTP data in the cache */
2226 INVALIDATE_CACHED_RANGE(map
, chip
->start
+ offset
, size
);
2228 put_chip(map
, chip
, chip
->start
);
2229 mutex_unlock(&chip
->mutex
);
2234 do_otp_write(struct map_info
*map
, struct flchip
*chip
, u_long offset
,
2235 u_char
*buf
, u_int size
, u_long prot
, u_int grpno
, u_int grpsz
)
2240 unsigned long bus_ofs
= offset
& ~(map_bankwidth(map
)-1);
2241 int gap
= offset
- bus_ofs
;
2242 int n
= min_t(int, size
, map_bankwidth(map
)-gap
);
2243 map_word datum
= map_word_ff(map
);
2245 datum
= map_word_load_partial(map
, datum
, buf
, gap
, n
);
2246 ret
= do_write_oneword(map
, chip
, bus_ofs
, datum
, FL_OTP_WRITE
);
2259 do_otp_lock(struct map_info
*map
, struct flchip
*chip
, u_long offset
,
2260 u_char
*buf
, u_int size
, u_long prot
, u_int grpno
, u_int grpsz
)
2262 struct cfi_private
*cfi
= map
->fldrv_priv
;
2265 /* make sure area matches group boundaries */
2269 datum
= map_word_ff(map
);
2270 datum
= map_word_clr(map
, datum
, CMD(1 << grpno
));
2271 return do_write_oneword(map
, chip
, prot
, datum
, FL_OTP_WRITE
);
2274 static int cfi_intelext_otp_walk(struct mtd_info
*mtd
, loff_t from
, size_t len
,
2275 size_t *retlen
, u_char
*buf
,
2276 otp_op_t action
, int user_regs
)
2278 struct map_info
*map
= mtd
->priv
;
2279 struct cfi_private
*cfi
= map
->fldrv_priv
;
2280 struct cfi_pri_intelext
*extp
= cfi
->cmdset_priv
;
2281 struct flchip
*chip
;
2282 struct cfi_intelext_otpinfo
*otp
;
2283 u_long devsize
, reg_prot_offset
, data_offset
;
2284 u_int chip_num
, chip_step
, field
, reg_fact_size
, reg_user_size
;
2285 u_int groups
, groupno
, groupsize
, reg_fact_groups
, reg_user_groups
;
2290 /* Check that we actually have some OTP registers */
2291 if (!extp
|| !(extp
->FeatureSupport
& 64) || !extp
->NumProtectionFields
)
2294 /* we need real chips here not virtual ones */
2295 devsize
= (1 << cfi
->cfiq
->DevSize
) * cfi
->interleave
;
2296 chip_step
= devsize
>> cfi
->chipshift
;
2299 /* Some chips have OTP located in the _top_ partition only.
2300 For example: Intel 28F256L18T (T means top-parameter device) */
2301 if (cfi
->mfr
== CFI_MFR_INTEL
) {
2306 chip_num
= chip_step
- 1;
2310 for ( ; chip_num
< cfi
->numchips
; chip_num
+= chip_step
) {
2311 chip
= &cfi
->chips
[chip_num
];
2312 otp
= (struct cfi_intelext_otpinfo
*)&extp
->extra
[0];
2314 /* first OTP region */
2316 reg_prot_offset
= extp
->ProtRegAddr
;
2317 reg_fact_groups
= 1;
2318 reg_fact_size
= 1 << extp
->FactProtRegSize
;
2319 reg_user_groups
= 1;
2320 reg_user_size
= 1 << extp
->UserProtRegSize
;
2323 /* flash geometry fixup */
2324 data_offset
= reg_prot_offset
+ 1;
2325 data_offset
*= cfi
->interleave
* cfi
->device_type
;
2326 reg_prot_offset
*= cfi
->interleave
* cfi
->device_type
;
2327 reg_fact_size
*= cfi
->interleave
;
2328 reg_user_size
*= cfi
->interleave
;
2331 groups
= reg_user_groups
;
2332 groupsize
= reg_user_size
;
2333 /* skip over factory reg area */
2334 groupno
= reg_fact_groups
;
2335 data_offset
+= reg_fact_groups
* reg_fact_size
;
2337 groups
= reg_fact_groups
;
2338 groupsize
= reg_fact_size
;
2342 while (len
> 0 && groups
> 0) {
2345 * Special case: if action is NULL
2346 * we fill buf with otp_info records.
2348 struct otp_info
*otpinfo
;
2350 len
-= sizeof(struct otp_info
);
2353 ret
= do_otp_read(map
, chip
,
2355 (u_char
*)&lockword
,
2360 otpinfo
= (struct otp_info
*)buf
;
2361 otpinfo
->start
= from
;
2362 otpinfo
->length
= groupsize
;
2364 !map_word_bitsset(map
, lockword
,
2367 buf
+= sizeof(*otpinfo
);
2368 *retlen
+= sizeof(*otpinfo
);
2369 } else if (from
>= groupsize
) {
2371 data_offset
+= groupsize
;
2373 int size
= groupsize
;
2374 data_offset
+= from
;
2379 ret
= action(map
, chip
, data_offset
,
2380 buf
, size
, reg_prot_offset
,
2381 groupno
, groupsize
);
2387 data_offset
+= size
;
2393 /* next OTP region */
2394 if (++field
== extp
->NumProtectionFields
)
2396 reg_prot_offset
= otp
->ProtRegAddr
;
2397 reg_fact_groups
= otp
->FactGroups
;
2398 reg_fact_size
= 1 << otp
->FactProtRegSize
;
2399 reg_user_groups
= otp
->UserGroups
;
2400 reg_user_size
= 1 << otp
->UserProtRegSize
;
2408 static int cfi_intelext_read_fact_prot_reg(struct mtd_info
*mtd
, loff_t from
,
2409 size_t len
, size_t *retlen
,
2412 return cfi_intelext_otp_walk(mtd
, from
, len
, retlen
,
2413 buf
, do_otp_read
, 0);
2416 static int cfi_intelext_read_user_prot_reg(struct mtd_info
*mtd
, loff_t from
,
2417 size_t len
, size_t *retlen
,
2420 return cfi_intelext_otp_walk(mtd
, from
, len
, retlen
,
2421 buf
, do_otp_read
, 1);
2424 static int cfi_intelext_write_user_prot_reg(struct mtd_info
*mtd
, loff_t from
,
2425 size_t len
, size_t *retlen
,
2428 return cfi_intelext_otp_walk(mtd
, from
, len
, retlen
,
2429 buf
, do_otp_write
, 1);
2432 static int cfi_intelext_lock_user_prot_reg(struct mtd_info
*mtd
,
2433 loff_t from
, size_t len
)
2436 return cfi_intelext_otp_walk(mtd
, from
, len
, &retlen
,
2437 NULL
, do_otp_lock
, 1);
2440 static int cfi_intelext_get_fact_prot_info(struct mtd_info
*mtd
, size_t len
,
2441 size_t *retlen
, struct otp_info
*buf
)
2444 return cfi_intelext_otp_walk(mtd
, 0, len
, retlen
, (u_char
*)buf
,
2448 static int cfi_intelext_get_user_prot_info(struct mtd_info
*mtd
, size_t len
,
2449 size_t *retlen
, struct otp_info
*buf
)
2451 return cfi_intelext_otp_walk(mtd
, 0, len
, retlen
, (u_char
*)buf
,
2457 static void cfi_intelext_save_locks(struct mtd_info
*mtd
)
2459 struct mtd_erase_region_info
*region
;
2460 int block
, status
, i
;
2464 for (i
= 0; i
< mtd
->numeraseregions
; i
++) {
2465 region
= &mtd
->eraseregions
[i
];
2466 if (!region
->lockmap
)
2469 for (block
= 0; block
< region
->numblocks
; block
++){
2470 len
= region
->erasesize
;
2471 adr
= region
->offset
+ block
* len
;
2473 status
= cfi_varsize_frob(mtd
,
2474 do_getlockstatus_oneblock
, adr
, len
, NULL
);
2476 set_bit(block
, region
->lockmap
);
2478 clear_bit(block
, region
->lockmap
);
2483 static int cfi_intelext_suspend(struct mtd_info
*mtd
)
2485 struct map_info
*map
= mtd
->priv
;
2486 struct cfi_private
*cfi
= map
->fldrv_priv
;
2487 struct cfi_pri_intelext
*extp
= cfi
->cmdset_priv
;
2489 struct flchip
*chip
;
2492 if ((mtd
->flags
& MTD_POWERUP_LOCK
)
2493 && extp
&& (extp
->FeatureSupport
& (1 << 5)))
2494 cfi_intelext_save_locks(mtd
);
2496 for (i
=0; !ret
&& i
<cfi
->numchips
; i
++) {
2497 chip
= &cfi
->chips
[i
];
2499 mutex_lock(&chip
->mutex
);
2501 switch (chip
->state
) {
2505 case FL_JEDEC_QUERY
:
2506 if (chip
->oldstate
== FL_READY
) {
2507 /* place the chip in a known state before suspend */
2508 map_write(map
, CMD(0xFF), cfi
->chips
[i
].start
);
2509 chip
->oldstate
= chip
->state
;
2510 chip
->state
= FL_PM_SUSPENDED
;
2511 /* No need to wake_up() on this state change -
2512 * as the whole point is that nobody can do anything
2513 * with the chip now anyway.
2516 /* There seems to be an operation pending. We must wait for it. */
2517 printk(KERN_NOTICE
"Flash device refused suspend due to pending operation (oldstate %d)\n", chip
->oldstate
);
2522 /* Should we actually wait? Once upon a time these routines weren't
2523 allowed to. Or should we return -EAGAIN, because the upper layers
2524 ought to have already shut down anything which was using the device
2525 anyway? The latter for now. */
2526 printk(KERN_NOTICE
"Flash device refused suspend due to active operation (state %d)\n", chip
->state
);
2528 case FL_PM_SUSPENDED
:
2531 mutex_unlock(&chip
->mutex
);
2534 /* Unlock the chips again */
2537 for (i
--; i
>=0; i
--) {
2538 chip
= &cfi
->chips
[i
];
2540 mutex_lock(&chip
->mutex
);
2542 if (chip
->state
== FL_PM_SUSPENDED
) {
2543 /* No need to force it into a known state here,
2544 because we're returning failure, and it didn't
2546 chip
->state
= chip
->oldstate
;
2547 chip
->oldstate
= FL_READY
;
2550 mutex_unlock(&chip
->mutex
);
2557 static void cfi_intelext_restore_locks(struct mtd_info
*mtd
)
2559 struct mtd_erase_region_info
*region
;
2564 for (i
= 0; i
< mtd
->numeraseregions
; i
++) {
2565 region
= &mtd
->eraseregions
[i
];
2566 if (!region
->lockmap
)
2569 for_each_clear_bit(block
, region
->lockmap
, region
->numblocks
) {
2570 len
= region
->erasesize
;
2571 adr
= region
->offset
+ block
* len
;
2572 cfi_intelext_unlock(mtd
, adr
, len
);
2577 static void cfi_intelext_resume(struct mtd_info
*mtd
)
2579 struct map_info
*map
= mtd
->priv
;
2580 struct cfi_private
*cfi
= map
->fldrv_priv
;
2581 struct cfi_pri_intelext
*extp
= cfi
->cmdset_priv
;
2583 struct flchip
*chip
;
2585 for (i
=0; i
<cfi
->numchips
; i
++) {
2587 chip
= &cfi
->chips
[i
];
2589 mutex_lock(&chip
->mutex
);
2591 /* Go to known state. Chip may have been power cycled */
2592 if (chip
->state
== FL_PM_SUSPENDED
) {
2593 /* Refresh LH28F640BF Partition Config. Register */
2594 fixup_LH28F640BF(mtd
);
2595 map_write(map
, CMD(0xFF), cfi
->chips
[i
].start
);
2596 chip
->oldstate
= chip
->state
= FL_READY
;
2600 mutex_unlock(&chip
->mutex
);
2603 if ((mtd
->flags
& MTD_POWERUP_LOCK
)
2604 && extp
&& (extp
->FeatureSupport
& (1 << 5)))
2605 cfi_intelext_restore_locks(mtd
);
2608 static int cfi_intelext_reset(struct mtd_info
*mtd
)
2610 struct map_info
*map
= mtd
->priv
;
2611 struct cfi_private
*cfi
= map
->fldrv_priv
;
2614 for (i
=0; i
< cfi
->numchips
; i
++) {
2615 struct flchip
*chip
= &cfi
->chips
[i
];
2617 /* force the completion of any ongoing operation
2618 and switch to array mode so any bootloader in
2619 flash is accessible for soft reboot. */
2620 mutex_lock(&chip
->mutex
);
2621 ret
= get_chip(map
, chip
, chip
->start
, FL_SHUTDOWN
);
2623 map_write(map
, CMD(0xff), chip
->start
);
2624 chip
->state
= FL_SHUTDOWN
;
2625 put_chip(map
, chip
, chip
->start
);
2627 mutex_unlock(&chip
->mutex
);
2633 static int cfi_intelext_reboot(struct notifier_block
*nb
, unsigned long val
,
2636 struct mtd_info
*mtd
;
2638 mtd
= container_of(nb
, struct mtd_info
, reboot_notifier
);
2639 cfi_intelext_reset(mtd
);
2643 static void cfi_intelext_destroy(struct mtd_info
*mtd
)
2645 struct map_info
*map
= mtd
->priv
;
2646 struct cfi_private
*cfi
= map
->fldrv_priv
;
2647 struct mtd_erase_region_info
*region
;
2649 cfi_intelext_reset(mtd
);
2650 unregister_reboot_notifier(&mtd
->reboot_notifier
);
2651 kfree(cfi
->cmdset_priv
);
2653 kfree(cfi
->chips
[0].priv
);
2655 for (i
= 0; i
< mtd
->numeraseregions
; i
++) {
2656 region
= &mtd
->eraseregions
[i
];
2657 kfree(region
->lockmap
);
2659 kfree(mtd
->eraseregions
);
2662 MODULE_LICENSE("GPL");
2663 MODULE_AUTHOR("David Woodhouse <dwmw2@infradead.org> et al.");
2664 MODULE_DESCRIPTION("MTD chip driver for Intel/Sharp flash chips");
2665 MODULE_ALIAS("cfi_cmdset_0003");
2666 MODULE_ALIAS("cfi_cmdset_0200");