1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * LPDDR flash memory device operations. This module provides read, write,
4 * erase, lock/unlock support for LPDDR flash memories
5 * (C) 2008 Korolev Alexey <akorolev@infradead.org>
6 * (C) 2008 Vasiliy Leonenko <vasiliy.leonenko@gmail.com>
7 * Many thanks to Roman Borisov for initial enabling
10 * Implement VPP management
11 * Implement XIP support
12 * Implement OTP support
14 #include <linux/mtd/pfow.h>
15 #include <linux/mtd/qinfo.h>
16 #include <linux/slab.h>
17 #include <linux/module.h>
19 static int lpddr_read(struct mtd_info
*mtd
, loff_t adr
, size_t len
,
20 size_t *retlen
, u_char
*buf
);
21 static int lpddr_write_buffers(struct mtd_info
*mtd
, loff_t to
,
22 size_t len
, size_t *retlen
, const u_char
*buf
);
23 static int lpddr_writev(struct mtd_info
*mtd
, const struct kvec
*vecs
,
24 unsigned long count
, loff_t to
, size_t *retlen
);
25 static int lpddr_erase(struct mtd_info
*mtd
, struct erase_info
*instr
);
26 static int lpddr_lock(struct mtd_info
*mtd
, loff_t ofs
, uint64_t len
);
27 static int lpddr_unlock(struct mtd_info
*mtd
, loff_t ofs
, uint64_t len
);
28 static int lpddr_point(struct mtd_info
*mtd
, loff_t adr
, size_t len
,
29 size_t *retlen
, void **mtdbuf
, resource_size_t
*phys
);
30 static int lpddr_unpoint(struct mtd_info
*mtd
, loff_t adr
, size_t len
);
31 static int get_chip(struct map_info
*map
, struct flchip
*chip
, int mode
);
32 static int chip_ready(struct map_info
*map
, struct flchip
*chip
, int mode
);
33 static void put_chip(struct map_info
*map
, struct flchip
*chip
);
35 struct mtd_info
*lpddr_cmdset(struct map_info
*map
)
37 struct lpddr_private
*lpddr
= map
->fldrv_priv
;
38 struct flchip_shared
*shared
;
44 mtd
= kzalloc(sizeof(*mtd
), GFP_KERNEL
);
48 mtd
->type
= MTD_NORFLASH
;
50 /* Fill in the default mtd operations */
51 mtd
->_read
= lpddr_read
;
52 mtd
->type
= MTD_NORFLASH
;
53 mtd
->flags
= MTD_CAP_NORFLASH
;
54 mtd
->flags
&= ~MTD_BIT_WRITEABLE
;
55 mtd
->_erase
= lpddr_erase
;
56 mtd
->_write
= lpddr_write_buffers
;
57 mtd
->_writev
= lpddr_writev
;
58 mtd
->_lock
= lpddr_lock
;
59 mtd
->_unlock
= lpddr_unlock
;
60 if (map_is_linear(map
)) {
61 mtd
->_point
= lpddr_point
;
62 mtd
->_unpoint
= lpddr_unpoint
;
64 mtd
->size
= 1ULL << lpddr
->qinfo
->DevSizeShift
;
65 mtd
->erasesize
= 1 << lpddr
->qinfo
->UniformBlockSizeShift
;
66 mtd
->writesize
= 1 << lpddr
->qinfo
->BufSizeShift
;
68 shared
= kmalloc_array(lpddr
->numchips
, sizeof(struct flchip_shared
),
75 chip
= &lpddr
->chips
[0];
76 numchips
= lpddr
->numchips
/ lpddr
->qinfo
->HWPartsNum
;
77 for (i
= 0; i
< numchips
; i
++) {
78 shared
[i
].writing
= shared
[i
].erasing
= NULL
;
79 mutex_init(&shared
[i
].lock
);
80 for (j
= 0; j
< lpddr
->qinfo
->HWPartsNum
; j
++) {
81 *chip
= lpddr
->chips
[i
];
82 chip
->start
+= j
<< lpddr
->chipshift
;
83 chip
->oldstate
= chip
->state
= FL_READY
;
84 chip
->priv
= &shared
[i
];
85 /* those should be reset too since
86 they create memory references. */
87 init_waitqueue_head(&chip
->wq
);
88 mutex_init(&chip
->mutex
);
95 EXPORT_SYMBOL(lpddr_cmdset
);
97 static void print_drs_error(unsigned int dsr
)
99 int prog_status
= (dsr
& DSR_RPS
) >> 8;
101 if (!(dsr
& DSR_AVAILABLE
))
102 pr_notice("DSR.15: (0) Device not Available\n");
103 if ((prog_status
& 0x03) == 0x03)
104 pr_notice("DSR.9,8: (11) Attempt to program invalid half with 41h command\n");
105 else if (prog_status
& 0x02)
106 pr_notice("DSR.9,8: (10) Object Mode Program attempt in region with Control Mode data\n");
107 else if (prog_status
& 0x01)
108 pr_notice("DSR.9,8: (01) Program attempt in region with Object Mode data\n");
109 if (!(dsr
& DSR_READY_STATUS
))
110 pr_notice("DSR.7: (0) Device is Busy\n");
112 pr_notice("DSR.6: (1) Erase Suspended\n");
113 if (dsr
& DSR_ERASE_STATUS
)
114 pr_notice("DSR.5: (1) Erase/Blank check error\n");
115 if (dsr
& DSR_PROGRAM_STATUS
)
116 pr_notice("DSR.4: (1) Program Error\n");
118 pr_notice("DSR.3: (1) Vpp low detect, operation aborted\n");
120 pr_notice("DSR.2: (1) Program suspended\n");
122 pr_notice("DSR.1: (1) Aborted Erase/Program attempt on locked block\n");
125 static int wait_for_ready(struct map_info
*map
, struct flchip
*chip
,
126 unsigned int chip_op_time
)
128 unsigned int timeo
, reset_timeo
, sleep_time
;
130 flstate_t chip_state
= chip
->state
;
133 /* set our timeout to 8 times the expected delay */
134 timeo
= chip_op_time
* 8;
138 sleep_time
= chip_op_time
/ 2;
141 dsr
= CMDVAL(map_read(map
, map
->pfow_base
+ PFOW_DSR
));
142 if (dsr
& DSR_READY_STATUS
)
145 printk(KERN_ERR
"%s: Flash timeout error state %d \n",
146 map
->name
, chip_state
);
151 /* OK Still waiting. Drop the lock, wait a while and retry. */
152 mutex_unlock(&chip
->mutex
);
153 if (sleep_time
>= 1000000/HZ
) {
155 * Half of the normal delay still remaining
156 * can be performed with a sleeping delay instead
159 msleep(sleep_time
/1000);
161 sleep_time
= 1000000/HZ
;
167 mutex_lock(&chip
->mutex
);
169 while (chip
->state
!= chip_state
) {
170 /* Someone's suspended the operation: sleep */
171 DECLARE_WAITQUEUE(wait
, current
);
172 set_current_state(TASK_UNINTERRUPTIBLE
);
173 add_wait_queue(&chip
->wq
, &wait
);
174 mutex_unlock(&chip
->mutex
);
176 remove_wait_queue(&chip
->wq
, &wait
);
177 mutex_lock(&chip
->mutex
);
179 if (chip
->erase_suspended
|| chip
->write_suspended
) {
180 /* Suspend has occurred while sleep: reset timeout */
182 chip
->erase_suspended
= chip
->write_suspended
= 0;
185 /* check status for errors */
188 map_write(map
, CMD(~(DSR_ERR
)), map
->pfow_base
+ PFOW_DSR
);
189 printk(KERN_WARNING
"%s: Bad status on wait: 0x%x \n",
191 print_drs_error(dsr
);
194 chip
->state
= FL_READY
;
198 static int get_chip(struct map_info
*map
, struct flchip
*chip
, int mode
)
201 DECLARE_WAITQUEUE(wait
, current
);
204 if (chip
->priv
&& (mode
== FL_WRITING
|| mode
== FL_ERASING
)
205 && chip
->state
!= FL_SYNCING
) {
207 * OK. We have possibility for contension on the write/erase
208 * operations which are global to the real chip and not per
209 * partition. So let's fight it over in the partition which
210 * currently has authority on the operation.
212 * The rules are as follows:
214 * - any write operation must own shared->writing.
216 * - any erase operation must own _both_ shared->writing and
219 * - contension arbitration is handled in the owner's context.
221 * The 'shared' struct can be read and/or written only when
224 struct flchip_shared
*shared
= chip
->priv
;
225 struct flchip
*contender
;
226 mutex_lock(&shared
->lock
);
227 contender
= shared
->writing
;
228 if (contender
&& contender
!= chip
) {
230 * The engine to perform desired operation on this
231 * partition is already in use by someone else.
232 * Let's fight over it in the context of the chip
233 * currently using it. If it is possible to suspend,
234 * that other partition will do just that, otherwise
235 * it'll happily send us to sleep. In any case, when
236 * get_chip returns success we're clear to go ahead.
238 ret
= mutex_trylock(&contender
->mutex
);
239 mutex_unlock(&shared
->lock
);
242 mutex_unlock(&chip
->mutex
);
243 ret
= chip_ready(map
, contender
, mode
);
244 mutex_lock(&chip
->mutex
);
246 if (ret
== -EAGAIN
) {
247 mutex_unlock(&contender
->mutex
);
251 mutex_unlock(&contender
->mutex
);
254 mutex_lock(&shared
->lock
);
256 /* We should not own chip if it is already in FL_SYNCING
257 * state. Put contender and retry. */
258 if (chip
->state
== FL_SYNCING
) {
259 put_chip(map
, contender
);
260 mutex_unlock(&contender
->mutex
);
263 mutex_unlock(&contender
->mutex
);
266 /* Check if we have suspended erase on this chip.
267 Must sleep in such a case. */
268 if (mode
== FL_ERASING
&& shared
->erasing
269 && shared
->erasing
->oldstate
== FL_ERASING
) {
270 mutex_unlock(&shared
->lock
);
271 set_current_state(TASK_UNINTERRUPTIBLE
);
272 add_wait_queue(&chip
->wq
, &wait
);
273 mutex_unlock(&chip
->mutex
);
275 remove_wait_queue(&chip
->wq
, &wait
);
276 mutex_lock(&chip
->mutex
);
281 shared
->writing
= chip
;
282 if (mode
== FL_ERASING
)
283 shared
->erasing
= chip
;
284 mutex_unlock(&shared
->lock
);
287 ret
= chip_ready(map
, chip
, mode
);
294 static int chip_ready(struct map_info
*map
, struct flchip
*chip
, int mode
)
296 struct lpddr_private
*lpddr
= map
->fldrv_priv
;
298 DECLARE_WAITQUEUE(wait
, current
);
300 /* Prevent setting state FL_SYNCING for chip in suspended state. */
301 if (FL_SYNCING
== mode
&& FL_READY
!= chip
->oldstate
)
304 switch (chip
->state
) {
310 if (!lpddr
->qinfo
->SuspEraseSupp
||
311 !(mode
== FL_READY
|| mode
== FL_POINT
))
314 map_write(map
, CMD(LPDDR_SUSPEND
),
315 map
->pfow_base
+ PFOW_PROGRAM_ERASE_SUSPEND
);
316 chip
->oldstate
= FL_ERASING
;
317 chip
->state
= FL_ERASE_SUSPENDING
;
318 ret
= wait_for_ready(map
, chip
, 0);
320 /* Oops. something got wrong. */
321 /* Resume and pretend we weren't here. */
323 printk(KERN_ERR
"%s: suspend operation failed."
324 "State may be wrong \n", map
->name
);
327 chip
->erase_suspended
= 1;
328 chip
->state
= FL_READY
;
332 /* Only if there's no operation suspended... */
333 if (mode
== FL_READY
&& chip
->oldstate
== FL_READY
)
338 set_current_state(TASK_UNINTERRUPTIBLE
);
339 add_wait_queue(&chip
->wq
, &wait
);
340 mutex_unlock(&chip
->mutex
);
342 remove_wait_queue(&chip
->wq
, &wait
);
343 mutex_lock(&chip
->mutex
);
348 static void put_chip(struct map_info
*map
, struct flchip
*chip
)
351 struct flchip_shared
*shared
= chip
->priv
;
352 mutex_lock(&shared
->lock
);
353 if (shared
->writing
== chip
&& chip
->oldstate
== FL_READY
) {
354 /* We own the ability to write, but we're done */
355 shared
->writing
= shared
->erasing
;
356 if (shared
->writing
&& shared
->writing
!= chip
) {
357 /* give back the ownership */
358 struct flchip
*loaner
= shared
->writing
;
359 mutex_lock(&loaner
->mutex
);
360 mutex_unlock(&shared
->lock
);
361 mutex_unlock(&chip
->mutex
);
362 put_chip(map
, loaner
);
363 mutex_lock(&chip
->mutex
);
364 mutex_unlock(&loaner
->mutex
);
368 shared
->erasing
= NULL
;
369 shared
->writing
= NULL
;
370 } else if (shared
->erasing
== chip
&& shared
->writing
!= chip
) {
372 * We own the ability to erase without the ability
373 * to write, which means the erase was suspended
374 * and some other partition is currently writing.
375 * Don't let the switch below mess things up since
376 * we don't have ownership to resume anything.
378 mutex_unlock(&shared
->lock
);
382 mutex_unlock(&shared
->lock
);
385 switch (chip
->oldstate
) {
387 map_write(map
, CMD(LPDDR_RESUME
),
388 map
->pfow_base
+ PFOW_COMMAND_CODE
);
389 map_write(map
, CMD(LPDDR_START_EXECUTION
),
390 map
->pfow_base
+ PFOW_COMMAND_EXECUTE
);
391 chip
->oldstate
= FL_READY
;
392 chip
->state
= FL_ERASING
;
397 printk(KERN_ERR
"%s: put_chip() called with oldstate %d!\n",
398 map
->name
, chip
->oldstate
);
403 static int do_write_buffer(struct map_info
*map
, struct flchip
*chip
,
404 unsigned long adr
, const struct kvec
**pvec
,
405 unsigned long *pvec_seek
, int len
)
407 struct lpddr_private
*lpddr
= map
->fldrv_priv
;
409 int ret
, wbufsize
, word_gap
;
410 const struct kvec
*vec
;
411 unsigned long vec_seek
;
412 unsigned long prog_buf_ofs
;
414 wbufsize
= 1 << lpddr
->qinfo
->BufSizeShift
;
416 mutex_lock(&chip
->mutex
);
417 ret
= get_chip(map
, chip
, FL_WRITING
);
419 mutex_unlock(&chip
->mutex
);
422 /* Figure out the number of words to write */
423 word_gap
= (-adr
& (map_bankwidth(map
)-1));
425 word_gap
= map_bankwidth(map
) - word_gap
;
427 datum
= map_word_ff(map
);
430 /* Get the program buffer offset from PFOW register data first*/
431 prog_buf_ofs
= map
->pfow_base
+ CMDVAL(map_read(map
,
432 map
->pfow_base
+ PFOW_PROGRAM_BUFFER_OFFSET
));
434 vec_seek
= *pvec_seek
;
436 int n
= map_bankwidth(map
) - word_gap
;
438 if (n
> vec
->iov_len
- vec_seek
)
439 n
= vec
->iov_len
- vec_seek
;
443 if (!word_gap
&& (len
< map_bankwidth(map
)))
444 datum
= map_word_ff(map
);
446 datum
= map_word_load_partial(map
, datum
,
447 vec
->iov_base
+ vec_seek
, word_gap
, n
);
451 if (!len
|| word_gap
== map_bankwidth(map
)) {
452 map_write(map
, datum
, prog_buf_ofs
);
453 prog_buf_ofs
+= map_bankwidth(map
);
458 if (vec_seek
== vec
->iov_len
) {
464 *pvec_seek
= vec_seek
;
467 send_pfow_command(map
, LPDDR_BUFF_PROGRAM
, adr
, wbufsize
, NULL
);
468 chip
->state
= FL_WRITING
;
469 ret
= wait_for_ready(map
, chip
, (1<<lpddr
->qinfo
->ProgBufferTime
));
471 printk(KERN_WARNING
"%s Buffer program error: %d at %lx; \n",
472 map
->name
, ret
, adr
);
476 out
: put_chip(map
, chip
);
477 mutex_unlock(&chip
->mutex
);
481 static int do_erase_oneblock(struct mtd_info
*mtd
, loff_t adr
)
483 struct map_info
*map
= mtd
->priv
;
484 struct lpddr_private
*lpddr
= map
->fldrv_priv
;
485 int chipnum
= adr
>> lpddr
->chipshift
;
486 struct flchip
*chip
= &lpddr
->chips
[chipnum
];
489 mutex_lock(&chip
->mutex
);
490 ret
= get_chip(map
, chip
, FL_ERASING
);
492 mutex_unlock(&chip
->mutex
);
495 send_pfow_command(map
, LPDDR_BLOCK_ERASE
, adr
, 0, NULL
);
496 chip
->state
= FL_ERASING
;
497 ret
= wait_for_ready(map
, chip
, (1<<lpddr
->qinfo
->BlockEraseTime
)*1000);
499 printk(KERN_WARNING
"%s Erase block error %d at : %llx\n",
500 map
->name
, ret
, adr
);
503 out
: put_chip(map
, chip
);
504 mutex_unlock(&chip
->mutex
);
508 static int lpddr_read(struct mtd_info
*mtd
, loff_t adr
, size_t len
,
509 size_t *retlen
, u_char
*buf
)
511 struct map_info
*map
= mtd
->priv
;
512 struct lpddr_private
*lpddr
= map
->fldrv_priv
;
513 int chipnum
= adr
>> lpddr
->chipshift
;
514 struct flchip
*chip
= &lpddr
->chips
[chipnum
];
517 mutex_lock(&chip
->mutex
);
518 ret
= get_chip(map
, chip
, FL_READY
);
520 mutex_unlock(&chip
->mutex
);
524 map_copy_from(map
, buf
, adr
, len
);
528 mutex_unlock(&chip
->mutex
);
532 static int lpddr_point(struct mtd_info
*mtd
, loff_t adr
, size_t len
,
533 size_t *retlen
, void **mtdbuf
, resource_size_t
*phys
)
535 struct map_info
*map
= mtd
->priv
;
536 struct lpddr_private
*lpddr
= map
->fldrv_priv
;
537 int chipnum
= adr
>> lpddr
->chipshift
;
538 unsigned long ofs
, last_end
= 0;
539 struct flchip
*chip
= &lpddr
->chips
[chipnum
];
545 /* ofs: offset within the first chip that the first read should start */
546 ofs
= adr
- (chipnum
<< lpddr
->chipshift
);
547 *mtdbuf
= (void *)map
->virt
+ chip
->start
+ ofs
;
550 unsigned long thislen
;
552 if (chipnum
>= lpddr
->numchips
)
555 /* We cannot point across chips that are virtually disjoint */
557 last_end
= chip
->start
;
558 else if (chip
->start
!= last_end
)
561 if ((len
+ ofs
- 1) >> lpddr
->chipshift
)
562 thislen
= (1<<lpddr
->chipshift
) - ofs
;
566 mutex_lock(&chip
->mutex
);
567 ret
= get_chip(map
, chip
, FL_POINT
);
568 mutex_unlock(&chip
->mutex
);
572 chip
->state
= FL_POINT
;
573 chip
->ref_point_counter
++;
578 last_end
+= 1 << lpddr
->chipshift
;
580 chip
= &lpddr
->chips
[chipnum
];
585 static int lpddr_unpoint (struct mtd_info
*mtd
, loff_t adr
, size_t len
)
587 struct map_info
*map
= mtd
->priv
;
588 struct lpddr_private
*lpddr
= map
->fldrv_priv
;
589 int chipnum
= adr
>> lpddr
->chipshift
, err
= 0;
592 /* ofs: offset within the first chip that the first read should start */
593 ofs
= adr
- (chipnum
<< lpddr
->chipshift
);
596 unsigned long thislen
;
599 chip
= &lpddr
->chips
[chipnum
];
600 if (chipnum
>= lpddr
->numchips
)
603 if ((len
+ ofs
- 1) >> lpddr
->chipshift
)
604 thislen
= (1<<lpddr
->chipshift
) - ofs
;
608 mutex_lock(&chip
->mutex
);
609 if (chip
->state
== FL_POINT
) {
610 chip
->ref_point_counter
--;
611 if (chip
->ref_point_counter
== 0)
612 chip
->state
= FL_READY
;
614 printk(KERN_WARNING
"%s: Warning: unpoint called on non"
615 "pointed region\n", map
->name
);
620 mutex_unlock(&chip
->mutex
);
630 static int lpddr_write_buffers(struct mtd_info
*mtd
, loff_t to
, size_t len
,
631 size_t *retlen
, const u_char
*buf
)
635 vec
.iov_base
= (void *) buf
;
638 return lpddr_writev(mtd
, &vec
, 1, to
, retlen
);
642 static int lpddr_writev(struct mtd_info
*mtd
, const struct kvec
*vecs
,
643 unsigned long count
, loff_t to
, size_t *retlen
)
645 struct map_info
*map
= mtd
->priv
;
646 struct lpddr_private
*lpddr
= map
->fldrv_priv
;
649 unsigned long ofs
, vec_seek
, i
;
650 int wbufsize
= 1 << lpddr
->qinfo
->BufSizeShift
;
653 for (i
= 0; i
< count
; i
++)
654 len
+= vecs
[i
].iov_len
;
659 chipnum
= to
>> lpddr
->chipshift
;
665 /* We must not cross write block boundaries */
666 int size
= wbufsize
- (ofs
& (wbufsize
-1));
671 ret
= do_write_buffer(map
, &lpddr
->chips
[chipnum
],
672 ofs
, &vecs
, &vec_seek
, size
);
680 /* Be nice and reschedule with the chip in a usable
681 * state for other processes */
689 static int lpddr_erase(struct mtd_info
*mtd
, struct erase_info
*instr
)
691 unsigned long ofs
, len
;
693 struct map_info
*map
= mtd
->priv
;
694 struct lpddr_private
*lpddr
= map
->fldrv_priv
;
695 int size
= 1 << lpddr
->qinfo
->UniformBlockSizeShift
;
701 ret
= do_erase_oneblock(mtd
, ofs
);
711 #define DO_XXLOCK_LOCK 1
712 #define DO_XXLOCK_UNLOCK 2
713 static int do_xxlock(struct mtd_info
*mtd
, loff_t adr
, uint32_t len
, int thunk
)
716 struct map_info
*map
= mtd
->priv
;
717 struct lpddr_private
*lpddr
= map
->fldrv_priv
;
718 int chipnum
= adr
>> lpddr
->chipshift
;
719 struct flchip
*chip
= &lpddr
->chips
[chipnum
];
721 mutex_lock(&chip
->mutex
);
722 ret
= get_chip(map
, chip
, FL_LOCKING
);
724 mutex_unlock(&chip
->mutex
);
728 if (thunk
== DO_XXLOCK_LOCK
) {
729 send_pfow_command(map
, LPDDR_LOCK_BLOCK
, adr
, adr
+ len
, NULL
);
730 chip
->state
= FL_LOCKING
;
731 } else if (thunk
== DO_XXLOCK_UNLOCK
) {
732 send_pfow_command(map
, LPDDR_UNLOCK_BLOCK
, adr
, adr
+ len
, NULL
);
733 chip
->state
= FL_UNLOCKING
;
737 ret
= wait_for_ready(map
, chip
, 1);
739 printk(KERN_ERR
"%s: block unlock error status %d \n",
743 out
: put_chip(map
, chip
);
744 mutex_unlock(&chip
->mutex
);
748 static int lpddr_lock(struct mtd_info
*mtd
, loff_t ofs
, uint64_t len
)
750 return do_xxlock(mtd
, ofs
, len
, DO_XXLOCK_LOCK
);
753 static int lpddr_unlock(struct mtd_info
*mtd
, loff_t ofs
, uint64_t len
)
755 return do_xxlock(mtd
, ofs
, len
, DO_XXLOCK_UNLOCK
);
758 MODULE_LICENSE("GPL");
759 MODULE_AUTHOR("Alexey Korolev <akorolev@infradead.org>");
760 MODULE_DESCRIPTION("MTD driver for LPDDR flash chips");