2 * Freescale GPMI NAND Flash Driver
4 * Copyright (C) 2010-2011 Freescale Semiconductor, Inc.
5 * Copyright (C) 2008 Embedded Alley Solutions, Inc.
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License along
18 * with this program; if not, write to the Free Software Foundation, Inc.,
19 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
21 #include <linux/clk.h>
22 #include <linux/slab.h>
23 #include <linux/interrupt.h>
24 #include <linux/module.h>
25 #include <linux/mtd/partitions.h>
27 #include <linux/of_device.h>
28 #include <linux/of_mtd.h>
29 #include "gpmi-nand.h"
32 /* Resource names for the GPMI NAND driver. */
33 #define GPMI_NAND_GPMI_REGS_ADDR_RES_NAME "gpmi-nand"
34 #define GPMI_NAND_BCH_REGS_ADDR_RES_NAME "bch"
35 #define GPMI_NAND_BCH_INTERRUPT_RES_NAME "bch"
37 /* add our owner bbt descriptor */
38 static uint8_t scan_ff_pattern[] = { 0xff };
39 static struct nand_bbt_descr gpmi_bbt_descr = {
43 .pattern = scan_ff_pattern
47 * We may change the layout if we can get the ECC info from the datasheet,
48 * else we will use all the (page + OOB).
50 static struct nand_ecclayout gpmi_hw_ecclayout = {
53 .oobfree = { {.offset = 0, .length = 0} }
56 static const struct gpmi_devdata gpmi_devdata_imx23 = {
58 .bch_max_ecc_strength = 20,
59 .max_chain_delay = 16,
62 static const struct gpmi_devdata gpmi_devdata_imx28 = {
64 .bch_max_ecc_strength = 20,
65 .max_chain_delay = 16,
68 static const struct gpmi_devdata gpmi_devdata_imx6q = {
70 .bch_max_ecc_strength = 40,
71 .max_chain_delay = 12,
74 static const struct gpmi_devdata gpmi_devdata_imx6sx = {
76 .bch_max_ecc_strength = 62,
77 .max_chain_delay = 12,
80 static irqreturn_t bch_irq(int irq, void *cookie)
82 struct gpmi_nand_data *this = cookie;
85 complete(&this->bch_done);
90 * Calculate the ECC strength by hand:
91 * E : The ECC strength.
92 * G : the length of Galois Field.
93 * N : The chunk count of per page.
94 * O : the oobsize of the NAND chip.
95 * M : the metasize of per page.
99 * ------------ <= (O - M)
107 static inline int get_ecc_strength(struct gpmi_nand_data *this)
109 struct bch_geometry *geo = &this->bch_geometry;
110 struct mtd_info *mtd = &this->mtd;
113 ecc_strength = ((mtd->oobsize - geo->metadata_size) * 8)
114 / (geo->gf_len * geo->ecc_chunk_count);
116 /* We need the minor even number. */
117 return round_down(ecc_strength, 2);
120 static inline bool gpmi_check_ecc(struct gpmi_nand_data *this)
122 struct bch_geometry *geo = &this->bch_geometry;
124 /* Do the sanity check. */
125 if (GPMI_IS_MX23(this) || GPMI_IS_MX28(this)) {
126 /* The mx23/mx28 only support the GF13. */
127 if (geo->gf_len == 14)
130 return geo->ecc_strength <= this->devdata->bch_max_ecc_strength;
134 * If we can get the ECC information from the nand chip, we do not
135 * need to calculate them ourselves.
137 * We may have available oob space in this case.
139 static bool set_geometry_by_ecc_info(struct gpmi_nand_data *this)
141 struct bch_geometry *geo = &this->bch_geometry;
142 struct mtd_info *mtd = &this->mtd;
143 struct nand_chip *chip = mtd->priv;
144 struct nand_oobfree *of = gpmi_hw_ecclayout.oobfree;
145 unsigned int block_mark_bit_offset;
147 if (!(chip->ecc_strength_ds > 0 && chip->ecc_step_ds > 0))
150 switch (chip->ecc_step_ds) {
159 "unsupported nand chip. ecc bits : %d, ecc size : %d\n",
160 chip->ecc_strength_ds, chip->ecc_step_ds);
163 geo->ecc_chunk_size = chip->ecc_step_ds;
164 geo->ecc_strength = round_up(chip->ecc_strength_ds, 2);
165 if (!gpmi_check_ecc(this))
168 /* Keep the C >= O */
169 if (geo->ecc_chunk_size < mtd->oobsize) {
171 "unsupported nand chip. ecc size: %d, oob size : %d\n",
172 chip->ecc_step_ds, mtd->oobsize);
176 /* The default value, see comment in the legacy_set_geometry(). */
177 geo->metadata_size = 10;
179 geo->ecc_chunk_count = mtd->writesize / geo->ecc_chunk_size;
182 * Now, the NAND chip with 2K page(data chunk is 512byte) shows below:
185 * |<----------------------------------------------------->|
189 * |<-------------------------------------------->| D | | O' |
192 * +---+----------+-+----------+-+----------+-+----------+-+-----+
193 * | M | data |E| data |E| data |E| data |E| |
194 * +---+----------+-+----------+-+----------+-+----------+-+-----+
200 * P : the page size for BCH module.
201 * E : The ECC strength.
202 * G : the length of Galois Field.
203 * N : The chunk count of per page.
204 * M : the metasize of per page.
205 * C : the ecc chunk size, aka the "data" above.
206 * P': the nand chip's page size.
207 * O : the nand chip's oob size.
210 * The formula for P is :
213 * P = ------------ + P' + M
216 * The position of block mark moves forward in the ECC-based view
217 * of page, and the delta is:
220 * D = (---------------- + M)
223 * Please see the comment in legacy_set_geometry().
224 * With the condition C >= O , we still can get same result.
225 * So the bit position of the physical block mark within the ECC-based
226 * view of the page is :
229 geo->page_size = mtd->writesize + geo->metadata_size +
230 (geo->gf_len * geo->ecc_strength * geo->ecc_chunk_count) / 8;
232 /* The available oob size we have. */
233 if (geo->page_size < mtd->writesize + mtd->oobsize) {
234 of->offset = geo->page_size - mtd->writesize;
235 of->length = mtd->oobsize - of->offset;
238 geo->payload_size = mtd->writesize;
240 geo->auxiliary_status_offset = ALIGN(geo->metadata_size, 4);
241 geo->auxiliary_size = ALIGN(geo->metadata_size, 4)
242 + ALIGN(geo->ecc_chunk_count, 4);
244 if (!this->swap_block_mark)
248 block_mark_bit_offset = mtd->writesize * 8 -
249 (geo->ecc_strength * geo->gf_len * (geo->ecc_chunk_count - 1)
250 + geo->metadata_size * 8);
252 geo->block_mark_byte_offset = block_mark_bit_offset / 8;
253 geo->block_mark_bit_offset = block_mark_bit_offset % 8;
257 static int legacy_set_geometry(struct gpmi_nand_data *this)
259 struct bch_geometry *geo = &this->bch_geometry;
260 struct mtd_info *mtd = &this->mtd;
261 unsigned int metadata_size;
262 unsigned int status_size;
263 unsigned int block_mark_bit_offset;
266 * The size of the metadata can be changed, though we set it to 10
267 * bytes now. But it can't be too large, because we have to save
268 * enough space for BCH.
270 geo->metadata_size = 10;
272 /* The default for the length of Galois Field. */
275 /* The default for chunk size. */
276 geo->ecc_chunk_size = 512;
277 while (geo->ecc_chunk_size < mtd->oobsize) {
278 geo->ecc_chunk_size *= 2; /* keep C >= O */
282 geo->ecc_chunk_count = mtd->writesize / geo->ecc_chunk_size;
284 /* We use the same ECC strength for all chunks. */
285 geo->ecc_strength = get_ecc_strength(this);
286 if (!gpmi_check_ecc(this)) {
288 "We can not support this nand chip."
289 " Its required ecc strength(%d) is beyond our"
290 " capability(%d).\n", geo->ecc_strength,
291 this->devdata->bch_max_ecc_strength);
295 geo->page_size = mtd->writesize + mtd->oobsize;
296 geo->payload_size = mtd->writesize;
299 * The auxiliary buffer contains the metadata and the ECC status. The
300 * metadata is padded to the nearest 32-bit boundary. The ECC status
301 * contains one byte for every ECC chunk, and is also padded to the
302 * nearest 32-bit boundary.
304 metadata_size = ALIGN(geo->metadata_size, 4);
305 status_size = ALIGN(geo->ecc_chunk_count, 4);
307 geo->auxiliary_size = metadata_size + status_size;
308 geo->auxiliary_status_offset = metadata_size;
310 if (!this->swap_block_mark)
314 * We need to compute the byte and bit offsets of
315 * the physical block mark within the ECC-based view of the page.
317 * NAND chip with 2K page shows below:
323 * +---+----------+-+----------+-+----------+-+----------+-+
324 * | M | data |E| data |E| data |E| data |E|
325 * +---+----------+-+----------+-+----------+-+----------+-+
327 * The position of block mark moves forward in the ECC-based view
328 * of page, and the delta is:
331 * D = (---------------- + M)
334 * With the formula to compute the ECC strength, and the condition
335 * : C >= O (C is the ecc chunk size)
337 * It's easy to deduce to the following result:
339 * E * G (O - M) C - M C - M
340 * ----------- <= ------- <= -------- < ---------
346 * D = (---------------- + M) < C
349 * The above inequality means the position of block mark
350 * within the ECC-based view of the page is still in the data chunk,
351 * and it's NOT in the ECC bits of the chunk.
353 * Use the following to compute the bit position of the
354 * physical block mark within the ECC-based view of the page:
355 * (page_size - D) * 8
359 block_mark_bit_offset = mtd->writesize * 8 -
360 (geo->ecc_strength * geo->gf_len * (geo->ecc_chunk_count - 1)
361 + geo->metadata_size * 8);
363 geo->block_mark_byte_offset = block_mark_bit_offset / 8;
364 geo->block_mark_bit_offset = block_mark_bit_offset % 8;
368 int common_nfc_set_geometry(struct gpmi_nand_data *this)
370 if (of_property_read_bool(this->dev->of_node, "fsl,use-minimum-ecc")
371 && set_geometry_by_ecc_info(this))
373 return legacy_set_geometry(this);
376 struct dma_chan *get_dma_chan(struct gpmi_nand_data *this)
378 /* We use the DMA channel 0 to access all the nand chips. */
379 return this->dma_chans[0];
382 /* Can we use the upper's buffer directly for DMA? */
383 void prepare_data_dma(struct gpmi_nand_data *this, enum dma_data_direction dr)
385 struct scatterlist *sgl = &this->data_sgl;
388 /* first try to map the upper buffer directly */
389 if (virt_addr_valid(this->upper_buf) &&
390 !object_is_on_stack(this->upper_buf)) {
391 sg_init_one(sgl, this->upper_buf, this->upper_len);
392 ret = dma_map_sg(this->dev, sgl, 1, dr);
396 this->direct_dma_map_ok = true;
401 /* We have to use our own DMA buffer. */
402 sg_init_one(sgl, this->data_buffer_dma, this->upper_len);
404 if (dr == DMA_TO_DEVICE)
405 memcpy(this->data_buffer_dma, this->upper_buf, this->upper_len);
407 dma_map_sg(this->dev, sgl, 1, dr);
409 this->direct_dma_map_ok = false;
412 /* This will be called after the DMA operation is finished. */
413 static void dma_irq_callback(void *param)
415 struct gpmi_nand_data *this = param;
416 struct completion *dma_c = &this->dma_done;
418 switch (this->dma_type) {
419 case DMA_FOR_COMMAND:
420 dma_unmap_sg(this->dev, &this->cmd_sgl, 1, DMA_TO_DEVICE);
423 case DMA_FOR_READ_DATA:
424 dma_unmap_sg(this->dev, &this->data_sgl, 1, DMA_FROM_DEVICE);
425 if (this->direct_dma_map_ok == false)
426 memcpy(this->upper_buf, this->data_buffer_dma,
430 case DMA_FOR_WRITE_DATA:
431 dma_unmap_sg(this->dev, &this->data_sgl, 1, DMA_TO_DEVICE);
434 case DMA_FOR_READ_ECC_PAGE:
435 case DMA_FOR_WRITE_ECC_PAGE:
436 /* We have to wait the BCH interrupt to finish. */
440 dev_err(this->dev, "in wrong DMA operation.\n");
446 int start_dma_without_bch_irq(struct gpmi_nand_data *this,
447 struct dma_async_tx_descriptor *desc)
449 struct completion *dma_c = &this->dma_done;
452 init_completion(dma_c);
454 desc->callback = dma_irq_callback;
455 desc->callback_param = this;
456 dmaengine_submit(desc);
457 dma_async_issue_pending(get_dma_chan(this));
459 /* Wait for the interrupt from the DMA block. */
460 err = wait_for_completion_timeout(dma_c, msecs_to_jiffies(1000));
462 dev_err(this->dev, "DMA timeout, last DMA :%d\n",
463 this->last_dma_type);
464 gpmi_dump_info(this);
471 * This function is used in BCH reading or BCH writing pages.
472 * It will wait for the BCH interrupt as long as ONE second.
473 * Actually, we must wait for two interrupts :
474 * [1] firstly the DMA interrupt and
475 * [2] secondly the BCH interrupt.
477 int start_dma_with_bch_irq(struct gpmi_nand_data *this,
478 struct dma_async_tx_descriptor *desc)
480 struct completion *bch_c = &this->bch_done;
483 /* Prepare to receive an interrupt from the BCH block. */
484 init_completion(bch_c);
487 start_dma_without_bch_irq(this, desc);
489 /* Wait for the interrupt from the BCH block. */
490 err = wait_for_completion_timeout(bch_c, msecs_to_jiffies(1000));
492 dev_err(this->dev, "BCH timeout, last DMA :%d\n",
493 this->last_dma_type);
494 gpmi_dump_info(this);
500 static int acquire_register_block(struct gpmi_nand_data *this,
501 const char *res_name)
503 struct platform_device *pdev = this->pdev;
504 struct resources *res = &this->resources;
508 r = platform_get_resource_byname(pdev, IORESOURCE_MEM, res_name);
509 p = devm_ioremap_resource(&pdev->dev, r);
513 if (!strcmp(res_name, GPMI_NAND_GPMI_REGS_ADDR_RES_NAME))
515 else if (!strcmp(res_name, GPMI_NAND_BCH_REGS_ADDR_RES_NAME))
518 dev_err(this->dev, "unknown resource name : %s\n", res_name);
523 static int acquire_bch_irq(struct gpmi_nand_data *this, irq_handler_t irq_h)
525 struct platform_device *pdev = this->pdev;
526 const char *res_name = GPMI_NAND_BCH_INTERRUPT_RES_NAME;
530 r = platform_get_resource_byname(pdev, IORESOURCE_IRQ, res_name);
532 dev_err(this->dev, "Can't get resource for %s\n", res_name);
536 err = devm_request_irq(this->dev, r->start, irq_h, 0, res_name, this);
538 dev_err(this->dev, "error requesting BCH IRQ\n");
543 static void release_dma_channels(struct gpmi_nand_data *this)
546 for (i = 0; i < DMA_CHANS; i++)
547 if (this->dma_chans[i]) {
548 dma_release_channel(this->dma_chans[i]);
549 this->dma_chans[i] = NULL;
553 static int acquire_dma_channels(struct gpmi_nand_data *this)
555 struct platform_device *pdev = this->pdev;
556 struct dma_chan *dma_chan;
558 /* request dma channel */
559 dma_chan = dma_request_slave_channel(&pdev->dev, "rx-tx");
561 dev_err(this->dev, "Failed to request DMA channel.\n");
565 this->dma_chans[0] = dma_chan;
569 release_dma_channels(this);
573 static char *extra_clks_for_mx6q[GPMI_CLK_MAX] = {
574 "gpmi_apb", "gpmi_bch", "gpmi_bch_apb", "per1_bch",
577 static int gpmi_get_clks(struct gpmi_nand_data *this)
579 struct resources *r = &this->resources;
580 char **extra_clks = NULL;
584 /* The main clock is stored in the first. */
585 r->clock[0] = devm_clk_get(this->dev, "gpmi_io");
586 if (IS_ERR(r->clock[0])) {
587 err = PTR_ERR(r->clock[0]);
591 /* Get extra clocks */
592 if (GPMI_IS_MX6(this))
593 extra_clks = extra_clks_for_mx6q;
597 for (i = 1; i < GPMI_CLK_MAX; i++) {
598 if (extra_clks[i - 1] == NULL)
601 clk = devm_clk_get(this->dev, extra_clks[i - 1]);
610 if (GPMI_IS_MX6(this))
612 * Set the default value for the gpmi clock.
614 * If you want to use the ONFI nand which is in the
615 * Synchronous Mode, you should change the clock as you need.
617 clk_set_rate(r->clock[0], 22000000);
622 dev_dbg(this->dev, "failed in finding the clocks.\n");
626 static int acquire_resources(struct gpmi_nand_data *this)
630 ret = acquire_register_block(this, GPMI_NAND_GPMI_REGS_ADDR_RES_NAME);
634 ret = acquire_register_block(this, GPMI_NAND_BCH_REGS_ADDR_RES_NAME);
638 ret = acquire_bch_irq(this, bch_irq);
642 ret = acquire_dma_channels(this);
646 ret = gpmi_get_clks(this);
652 release_dma_channels(this);
657 static void release_resources(struct gpmi_nand_data *this)
659 release_dma_channels(this);
662 static int init_hardware(struct gpmi_nand_data *this)
667 * This structure contains the "safe" GPMI timing that should succeed
668 * with any NAND Flash device
669 * (although, with less-than-optimal performance).
671 struct nand_timing safe_timing = {
672 .data_setup_in_ns = 80,
673 .data_hold_in_ns = 60,
674 .address_setup_in_ns = 25,
675 .gpmi_sample_delay_in_ns = 6,
681 /* Initialize the hardwares. */
682 ret = gpmi_init(this);
686 this->timing = safe_timing;
690 static int read_page_prepare(struct gpmi_nand_data *this,
691 void *destination, unsigned length,
692 void *alt_virt, dma_addr_t alt_phys, unsigned alt_size,
693 void **use_virt, dma_addr_t *use_phys)
695 struct device *dev = this->dev;
697 if (virt_addr_valid(destination)) {
698 dma_addr_t dest_phys;
700 dest_phys = dma_map_single(dev, destination,
701 length, DMA_FROM_DEVICE);
702 if (dma_mapping_error(dev, dest_phys)) {
703 if (alt_size < length) {
704 dev_err(dev, "Alternate buffer is too small\n");
709 *use_virt = destination;
710 *use_phys = dest_phys;
711 this->direct_dma_map_ok = true;
716 *use_virt = alt_virt;
717 *use_phys = alt_phys;
718 this->direct_dma_map_ok = false;
722 static inline void read_page_end(struct gpmi_nand_data *this,
723 void *destination, unsigned length,
724 void *alt_virt, dma_addr_t alt_phys, unsigned alt_size,
725 void *used_virt, dma_addr_t used_phys)
727 if (this->direct_dma_map_ok)
728 dma_unmap_single(this->dev, used_phys, length, DMA_FROM_DEVICE);
731 static inline void read_page_swap_end(struct gpmi_nand_data *this,
732 void *destination, unsigned length,
733 void *alt_virt, dma_addr_t alt_phys, unsigned alt_size,
734 void *used_virt, dma_addr_t used_phys)
736 if (!this->direct_dma_map_ok)
737 memcpy(destination, alt_virt, length);
740 static int send_page_prepare(struct gpmi_nand_data *this,
741 const void *source, unsigned length,
742 void *alt_virt, dma_addr_t alt_phys, unsigned alt_size,
743 const void **use_virt, dma_addr_t *use_phys)
745 struct device *dev = this->dev;
747 if (virt_addr_valid(source)) {
748 dma_addr_t source_phys;
750 source_phys = dma_map_single(dev, (void *)source, length,
752 if (dma_mapping_error(dev, source_phys)) {
753 if (alt_size < length) {
754 dev_err(dev, "Alternate buffer is too small\n");
760 *use_phys = source_phys;
765 * Copy the content of the source buffer into the alternate
766 * buffer and set up the return values accordingly.
768 memcpy(alt_virt, source, length);
770 *use_virt = alt_virt;
771 *use_phys = alt_phys;
775 static void send_page_end(struct gpmi_nand_data *this,
776 const void *source, unsigned length,
777 void *alt_virt, dma_addr_t alt_phys, unsigned alt_size,
778 const void *used_virt, dma_addr_t used_phys)
780 struct device *dev = this->dev;
781 if (used_virt == source)
782 dma_unmap_single(dev, used_phys, length, DMA_TO_DEVICE);
785 static void gpmi_free_dma_buffer(struct gpmi_nand_data *this)
787 struct device *dev = this->dev;
789 if (this->page_buffer_virt && virt_addr_valid(this->page_buffer_virt))
790 dma_free_coherent(dev, this->page_buffer_size,
791 this->page_buffer_virt,
792 this->page_buffer_phys);
793 kfree(this->cmd_buffer);
794 kfree(this->data_buffer_dma);
796 this->cmd_buffer = NULL;
797 this->data_buffer_dma = NULL;
798 this->page_buffer_virt = NULL;
799 this->page_buffer_size = 0;
802 /* Allocate the DMA buffers */
803 static int gpmi_alloc_dma_buffer(struct gpmi_nand_data *this)
805 struct bch_geometry *geo = &this->bch_geometry;
806 struct device *dev = this->dev;
807 struct mtd_info *mtd = &this->mtd;
809 /* [1] Allocate a command buffer. PAGE_SIZE is enough. */
810 this->cmd_buffer = kzalloc(PAGE_SIZE, GFP_DMA | GFP_KERNEL);
811 if (this->cmd_buffer == NULL)
815 * [2] Allocate a read/write data buffer.
816 * The gpmi_alloc_dma_buffer can be called twice.
817 * We allocate a PAGE_SIZE length buffer if gpmi_alloc_dma_buffer
818 * is called before the nand_scan_ident; and we allocate a buffer
819 * of the real NAND page size when the gpmi_alloc_dma_buffer is
820 * called after the nand_scan_ident.
822 this->data_buffer_dma = kzalloc(mtd->writesize ?: PAGE_SIZE,
823 GFP_DMA | GFP_KERNEL);
824 if (this->data_buffer_dma == NULL)
828 * [3] Allocate the page buffer.
830 * Both the payload buffer and the auxiliary buffer must appear on
831 * 32-bit boundaries. We presume the size of the payload buffer is a
832 * power of two and is much larger than four, which guarantees the
833 * auxiliary buffer will appear on a 32-bit boundary.
835 this->page_buffer_size = geo->payload_size + geo->auxiliary_size;
836 this->page_buffer_virt = dma_alloc_coherent(dev, this->page_buffer_size,
837 &this->page_buffer_phys, GFP_DMA);
838 if (!this->page_buffer_virt)
842 /* Slice up the page buffer. */
843 this->payload_virt = this->page_buffer_virt;
844 this->payload_phys = this->page_buffer_phys;
845 this->auxiliary_virt = this->payload_virt + geo->payload_size;
846 this->auxiliary_phys = this->payload_phys + geo->payload_size;
850 gpmi_free_dma_buffer(this);
854 static void gpmi_cmd_ctrl(struct mtd_info *mtd, int data, unsigned int ctrl)
856 struct nand_chip *chip = mtd->priv;
857 struct gpmi_nand_data *this = chip->priv;
861 * Every operation begins with a command byte and a series of zero or
862 * more address bytes. These are distinguished by either the Address
863 * Latch Enable (ALE) or Command Latch Enable (CLE) signals being
864 * asserted. When MTD is ready to execute the command, it will deassert
865 * both latch enables.
867 * Rather than run a separate DMA operation for every single byte, we
868 * queue them up and run a single DMA operation for the entire series
869 * of command and data bytes. NAND_CMD_NONE means the END of the queue.
871 if ((ctrl & (NAND_ALE | NAND_CLE))) {
872 if (data != NAND_CMD_NONE)
873 this->cmd_buffer[this->command_length++] = data;
877 if (!this->command_length)
880 ret = gpmi_send_command(this);
882 dev_err(this->dev, "Chip: %u, Error %d\n",
883 this->current_chip, ret);
885 this->command_length = 0;
888 static int gpmi_dev_ready(struct mtd_info *mtd)
890 struct nand_chip *chip = mtd->priv;
891 struct gpmi_nand_data *this = chip->priv;
893 return gpmi_is_ready(this, this->current_chip);
896 static void gpmi_select_chip(struct mtd_info *mtd, int chipnr)
898 struct nand_chip *chip = mtd->priv;
899 struct gpmi_nand_data *this = chip->priv;
901 if ((this->current_chip < 0) && (chipnr >= 0))
903 else if ((this->current_chip >= 0) && (chipnr < 0))
906 this->current_chip = chipnr;
909 static void gpmi_read_buf(struct mtd_info *mtd, uint8_t *buf, int len)
911 struct nand_chip *chip = mtd->priv;
912 struct gpmi_nand_data *this = chip->priv;
914 dev_dbg(this->dev, "len is %d\n", len);
915 this->upper_buf = buf;
916 this->upper_len = len;
918 gpmi_read_data(this);
921 static void gpmi_write_buf(struct mtd_info *mtd, const uint8_t *buf, int len)
923 struct nand_chip *chip = mtd->priv;
924 struct gpmi_nand_data *this = chip->priv;
926 dev_dbg(this->dev, "len is %d\n", len);
927 this->upper_buf = (uint8_t *)buf;
928 this->upper_len = len;
930 gpmi_send_data(this);
933 static uint8_t gpmi_read_byte(struct mtd_info *mtd)
935 struct nand_chip *chip = mtd->priv;
936 struct gpmi_nand_data *this = chip->priv;
937 uint8_t *buf = this->data_buffer_dma;
939 gpmi_read_buf(mtd, buf, 1);
944 * Handles block mark swapping.
945 * It can be called in swapping the block mark, or swapping it back,
946 * because the the operations are the same.
948 static void block_mark_swapping(struct gpmi_nand_data *this,
949 void *payload, void *auxiliary)
951 struct bch_geometry *nfc_geo = &this->bch_geometry;
956 unsigned char from_data;
957 unsigned char from_oob;
959 if (!this->swap_block_mark)
963 * If control arrives here, we're swapping. Make some convenience
966 bit = nfc_geo->block_mark_bit_offset;
967 p = payload + nfc_geo->block_mark_byte_offset;
971 * Get the byte from the data area that overlays the block mark. Since
972 * the ECC engine applies its own view to the bits in the page, the
973 * physical block mark won't (in general) appear on a byte boundary in
976 from_data = (p[0] >> bit) | (p[1] << (8 - bit));
978 /* Get the byte from the OOB. */
984 mask = (0x1 << bit) - 1;
985 p[0] = (p[0] & mask) | (from_oob << bit);
988 p[1] = (p[1] & mask) | (from_oob >> (8 - bit));
991 static int gpmi_ecc_read_page(struct mtd_info *mtd, struct nand_chip *chip,
992 uint8_t *buf, int oob_required, int page)
994 struct gpmi_nand_data *this = chip->priv;
995 struct bch_geometry *nfc_geo = &this->bch_geometry;
997 dma_addr_t payload_phys;
998 void *auxiliary_virt;
999 dma_addr_t auxiliary_phys;
1001 unsigned char *status;
1002 unsigned int max_bitflips = 0;
1005 dev_dbg(this->dev, "page number is : %d\n", page);
1006 ret = read_page_prepare(this, buf, nfc_geo->payload_size,
1007 this->payload_virt, this->payload_phys,
1008 nfc_geo->payload_size,
1009 &payload_virt, &payload_phys);
1011 dev_err(this->dev, "Inadequate DMA buffer\n");
1015 auxiliary_virt = this->auxiliary_virt;
1016 auxiliary_phys = this->auxiliary_phys;
1019 ret = gpmi_read_page(this, payload_phys, auxiliary_phys);
1020 read_page_end(this, buf, nfc_geo->payload_size,
1021 this->payload_virt, this->payload_phys,
1022 nfc_geo->payload_size,
1023 payload_virt, payload_phys);
1025 dev_err(this->dev, "Error in ECC-based read: %d\n", ret);
1029 /* handle the block mark swapping */
1030 block_mark_swapping(this, payload_virt, auxiliary_virt);
1032 /* Loop over status bytes, accumulating ECC status. */
1033 status = auxiliary_virt + nfc_geo->auxiliary_status_offset;
1035 for (i = 0; i < nfc_geo->ecc_chunk_count; i++, status++) {
1036 if ((*status == STATUS_GOOD) || (*status == STATUS_ERASED))
1039 if (*status == STATUS_UNCORRECTABLE) {
1040 mtd->ecc_stats.failed++;
1043 mtd->ecc_stats.corrected += *status;
1044 max_bitflips = max_t(unsigned int, max_bitflips, *status);
1049 * It's time to deliver the OOB bytes. See gpmi_ecc_read_oob()
1050 * for details about our policy for delivering the OOB.
1052 * We fill the caller's buffer with set bits, and then copy the
1053 * block mark to th caller's buffer. Note that, if block mark
1054 * swapping was necessary, it has already been done, so we can
1055 * rely on the first byte of the auxiliary buffer to contain
1058 memset(chip->oob_poi, ~0, mtd->oobsize);
1059 chip->oob_poi[0] = ((uint8_t *) auxiliary_virt)[0];
1062 read_page_swap_end(this, buf, nfc_geo->payload_size,
1063 this->payload_virt, this->payload_phys,
1064 nfc_geo->payload_size,
1065 payload_virt, payload_phys);
1067 return max_bitflips;
1070 /* Fake a virtual small page for the subpage read */
1071 static int gpmi_ecc_read_subpage(struct mtd_info *mtd, struct nand_chip *chip,
1072 uint32_t offs, uint32_t len, uint8_t *buf, int page)
1074 struct gpmi_nand_data *this = chip->priv;
1075 void __iomem *bch_regs = this->resources.bch_regs;
1076 struct bch_geometry old_geo = this->bch_geometry;
1077 struct bch_geometry *geo = &this->bch_geometry;
1078 int size = chip->ecc.size; /* ECC chunk size */
1079 int meta, n, page_size;
1080 u32 r1_old, r2_old, r1_new, r2_new;
1081 unsigned int max_bitflips;
1082 int first, last, marker_pos;
1083 int ecc_parity_size;
1086 /* The size of ECC parity */
1087 ecc_parity_size = geo->gf_len * geo->ecc_strength / 8;
1089 /* Align it with the chunk size */
1090 first = offs / size;
1091 last = (offs + len - 1) / size;
1094 * Find the chunk which contains the Block Marker. If this chunk is
1095 * in the range of [first, last], we have to read out the whole page.
1096 * Why? since we had swapped the data at the position of Block Marker
1097 * to the metadata which is bound with the chunk 0.
1099 marker_pos = geo->block_mark_byte_offset / size;
1100 if (last >= marker_pos && first <= marker_pos) {
1101 dev_dbg(this->dev, "page:%d, first:%d, last:%d, marker at:%d\n",
1102 page, first, last, marker_pos);
1103 return gpmi_ecc_read_page(mtd, chip, buf, 0, page);
1106 meta = geo->metadata_size;
1108 col = meta + (size + ecc_parity_size) * first;
1109 chip->cmdfunc(mtd, NAND_CMD_RNDOUT, col, -1);
1112 buf = buf + first * size;
1115 /* Save the old environment */
1116 r1_old = r1_new = readl(bch_regs + HW_BCH_FLASH0LAYOUT0);
1117 r2_old = r2_new = readl(bch_regs + HW_BCH_FLASH0LAYOUT1);
1119 /* change the BCH registers and bch_geometry{} */
1120 n = last - first + 1;
1121 page_size = meta + (size + ecc_parity_size) * n;
1123 r1_new &= ~(BM_BCH_FLASH0LAYOUT0_NBLOCKS |
1124 BM_BCH_FLASH0LAYOUT0_META_SIZE);
1125 r1_new |= BF_BCH_FLASH0LAYOUT0_NBLOCKS(n - 1)
1126 | BF_BCH_FLASH0LAYOUT0_META_SIZE(meta);
1127 writel(r1_new, bch_regs + HW_BCH_FLASH0LAYOUT0);
1129 r2_new &= ~BM_BCH_FLASH0LAYOUT1_PAGE_SIZE;
1130 r2_new |= BF_BCH_FLASH0LAYOUT1_PAGE_SIZE(page_size);
1131 writel(r2_new, bch_regs + HW_BCH_FLASH0LAYOUT1);
1133 geo->ecc_chunk_count = n;
1134 geo->payload_size = n * size;
1135 geo->page_size = page_size;
1136 geo->auxiliary_status_offset = ALIGN(meta, 4);
1138 dev_dbg(this->dev, "page:%d(%d:%d)%d, chunk:(%d:%d), BCH PG size:%d\n",
1139 page, offs, len, col, first, n, page_size);
1141 /* Read the subpage now */
1142 this->swap_block_mark = false;
1143 max_bitflips = gpmi_ecc_read_page(mtd, chip, buf, 0, page);
1146 writel(r1_old, bch_regs + HW_BCH_FLASH0LAYOUT0);
1147 writel(r2_old, bch_regs + HW_BCH_FLASH0LAYOUT1);
1148 this->bch_geometry = old_geo;
1149 this->swap_block_mark = true;
1151 return max_bitflips;
1154 static int gpmi_ecc_write_page(struct mtd_info *mtd, struct nand_chip *chip,
1155 const uint8_t *buf, int oob_required)
1157 struct gpmi_nand_data *this = chip->priv;
1158 struct bch_geometry *nfc_geo = &this->bch_geometry;
1159 const void *payload_virt;
1160 dma_addr_t payload_phys;
1161 const void *auxiliary_virt;
1162 dma_addr_t auxiliary_phys;
1165 dev_dbg(this->dev, "ecc write page.\n");
1166 if (this->swap_block_mark) {
1168 * If control arrives here, we're doing block mark swapping.
1169 * Since we can't modify the caller's buffers, we must copy them
1172 memcpy(this->payload_virt, buf, mtd->writesize);
1173 payload_virt = this->payload_virt;
1174 payload_phys = this->payload_phys;
1176 memcpy(this->auxiliary_virt, chip->oob_poi,
1177 nfc_geo->auxiliary_size);
1178 auxiliary_virt = this->auxiliary_virt;
1179 auxiliary_phys = this->auxiliary_phys;
1181 /* Handle block mark swapping. */
1182 block_mark_swapping(this,
1183 (void *) payload_virt, (void *) auxiliary_virt);
1186 * If control arrives here, we're not doing block mark swapping,
1187 * so we can to try and use the caller's buffers.
1189 ret = send_page_prepare(this,
1190 buf, mtd->writesize,
1191 this->payload_virt, this->payload_phys,
1192 nfc_geo->payload_size,
1193 &payload_virt, &payload_phys);
1195 dev_err(this->dev, "Inadequate payload DMA buffer\n");
1199 ret = send_page_prepare(this,
1200 chip->oob_poi, mtd->oobsize,
1201 this->auxiliary_virt, this->auxiliary_phys,
1202 nfc_geo->auxiliary_size,
1203 &auxiliary_virt, &auxiliary_phys);
1205 dev_err(this->dev, "Inadequate auxiliary DMA buffer\n");
1206 goto exit_auxiliary;
1211 ret = gpmi_send_page(this, payload_phys, auxiliary_phys);
1213 dev_err(this->dev, "Error in ECC-based write: %d\n", ret);
1215 if (!this->swap_block_mark) {
1216 send_page_end(this, chip->oob_poi, mtd->oobsize,
1217 this->auxiliary_virt, this->auxiliary_phys,
1218 nfc_geo->auxiliary_size,
1219 auxiliary_virt, auxiliary_phys);
1221 send_page_end(this, buf, mtd->writesize,
1222 this->payload_virt, this->payload_phys,
1223 nfc_geo->payload_size,
1224 payload_virt, payload_phys);
1231 * There are several places in this driver where we have to handle the OOB and
1232 * block marks. This is the function where things are the most complicated, so
1233 * this is where we try to explain it all. All the other places refer back to
1236 * These are the rules, in order of decreasing importance:
1238 * 1) Nothing the caller does can be allowed to imperil the block mark.
1240 * 2) In read operations, the first byte of the OOB we return must reflect the
1241 * true state of the block mark, no matter where that block mark appears in
1242 * the physical page.
1244 * 3) ECC-based read operations return an OOB full of set bits (since we never
1245 * allow ECC-based writes to the OOB, it doesn't matter what ECC-based reads
1248 * 4) "Raw" read operations return a direct view of the physical bytes in the
1249 * page, using the conventional definition of which bytes are data and which
1250 * are OOB. This gives the caller a way to see the actual, physical bytes
1251 * in the page, without the distortions applied by our ECC engine.
1254 * What we do for this specific read operation depends on two questions:
1256 * 1) Are we doing a "raw" read, or an ECC-based read?
1258 * 2) Are we using block mark swapping or transcription?
1260 * There are four cases, illustrated by the following Karnaugh map:
1262 * | Raw | ECC-based |
1263 * -------------+-------------------------+-------------------------+
1264 * | Read the conventional | |
1265 * | OOB at the end of the | |
1266 * Swapping | page and return it. It | |
1267 * | contains exactly what | |
1268 * | we want. | Read the block mark and |
1269 * -------------+-------------------------+ return it in a buffer |
1270 * | Read the conventional | full of set bits. |
1271 * | OOB at the end of the | |
1272 * | page and also the block | |
1273 * Transcribing | mark in the metadata. | |
1274 * | Copy the block mark | |
1275 * | into the first byte of | |
1277 * -------------+-------------------------+-------------------------+
1279 * Note that we break rule #4 in the Transcribing/Raw case because we're not
1280 * giving an accurate view of the actual, physical bytes in the page (we're
1281 * overwriting the block mark). That's OK because it's more important to follow
1284 * It turns out that knowing whether we want an "ECC-based" or "raw" read is not
1285 * easy. When reading a page, for example, the NAND Flash MTD code calls our
1286 * ecc.read_page or ecc.read_page_raw function. Thus, the fact that MTD wants an
1287 * ECC-based or raw view of the page is implicit in which function it calls
1288 * (there is a similar pair of ECC-based/raw functions for writing).
1290 * FIXME: The following paragraph is incorrect, now that there exist
1291 * ecc.read_oob_raw and ecc.write_oob_raw functions.
1293 * Since MTD assumes the OOB is not covered by ECC, there is no pair of
1294 * ECC-based/raw functions for reading or or writing the OOB. The fact that the
1295 * caller wants an ECC-based or raw view of the page is not propagated down to
1298 static int gpmi_ecc_read_oob(struct mtd_info *mtd, struct nand_chip *chip,
1301 struct gpmi_nand_data *this = chip->priv;
1303 dev_dbg(this->dev, "page number is %d\n", page);
1304 /* clear the OOB buffer */
1305 memset(chip->oob_poi, ~0, mtd->oobsize);
1307 /* Read out the conventional OOB. */
1308 chip->cmdfunc(mtd, NAND_CMD_READ0, mtd->writesize, page);
1309 chip->read_buf(mtd, chip->oob_poi, mtd->oobsize);
1312 * Now, we want to make sure the block mark is correct. In the
1313 * Swapping/Raw case, we already have it. Otherwise, we need to
1314 * explicitly read it.
1316 if (!this->swap_block_mark) {
1317 /* Read the block mark into the first byte of the OOB buffer. */
1318 chip->cmdfunc(mtd, NAND_CMD_READ0, 0, page);
1319 chip->oob_poi[0] = chip->read_byte(mtd);
1326 gpmi_ecc_write_oob(struct mtd_info *mtd, struct nand_chip *chip, int page)
1328 struct nand_oobfree *of = mtd->ecclayout->oobfree;
1331 /* Do we have available oob area? */
1335 if (!nand_is_slc(chip))
1338 chip->cmdfunc(mtd, NAND_CMD_SEQIN, mtd->writesize + of->offset, page);
1339 chip->write_buf(mtd, chip->oob_poi + of->offset, of->length);
1340 chip->cmdfunc(mtd, NAND_CMD_PAGEPROG, -1, -1);
1342 status = chip->waitfunc(mtd, chip);
1343 return status & NAND_STATUS_FAIL ? -EIO : 0;
1346 static int gpmi_block_markbad(struct mtd_info *mtd, loff_t ofs)
1348 struct nand_chip *chip = mtd->priv;
1349 struct gpmi_nand_data *this = chip->priv;
1351 uint8_t *block_mark;
1352 int column, page, status, chipnr;
1354 chipnr = (int)(ofs >> chip->chip_shift);
1355 chip->select_chip(mtd, chipnr);
1357 column = this->swap_block_mark ? mtd->writesize : 0;
1359 /* Write the block mark. */
1360 block_mark = this->data_buffer_dma;
1361 block_mark[0] = 0; /* bad block marker */
1363 /* Shift to get page */
1364 page = (int)(ofs >> chip->page_shift);
1366 chip->cmdfunc(mtd, NAND_CMD_SEQIN, column, page);
1367 chip->write_buf(mtd, block_mark, 1);
1368 chip->cmdfunc(mtd, NAND_CMD_PAGEPROG, -1, -1);
1370 status = chip->waitfunc(mtd, chip);
1371 if (status & NAND_STATUS_FAIL)
1374 chip->select_chip(mtd, -1);
1379 static int nand_boot_set_geometry(struct gpmi_nand_data *this)
1381 struct boot_rom_geometry *geometry = &this->rom_geometry;
1384 * Set the boot block stride size.
1386 * In principle, we should be reading this from the OTP bits, since
1387 * that's where the ROM is going to get it. In fact, we don't have any
1388 * way to read the OTP bits, so we go with the default and hope for the
1391 geometry->stride_size_in_pages = 64;
1394 * Set the search area stride exponent.
1396 * In principle, we should be reading this from the OTP bits, since
1397 * that's where the ROM is going to get it. In fact, we don't have any
1398 * way to read the OTP bits, so we go with the default and hope for the
1401 geometry->search_area_stride_exponent = 2;
1405 static const char *fingerprint = "STMP";
1406 static int mx23_check_transcription_stamp(struct gpmi_nand_data *this)
1408 struct boot_rom_geometry *rom_geo = &this->rom_geometry;
1409 struct device *dev = this->dev;
1410 struct mtd_info *mtd = &this->mtd;
1411 struct nand_chip *chip = &this->nand;
1412 unsigned int search_area_size_in_strides;
1413 unsigned int stride;
1415 uint8_t *buffer = chip->buffers->databuf;
1416 int saved_chip_number;
1417 int found_an_ncb_fingerprint = false;
1419 /* Compute the number of strides in a search area. */
1420 search_area_size_in_strides = 1 << rom_geo->search_area_stride_exponent;
1422 saved_chip_number = this->current_chip;
1423 chip->select_chip(mtd, 0);
1426 * Loop through the first search area, looking for the NCB fingerprint.
1428 dev_dbg(dev, "Scanning for an NCB fingerprint...\n");
1430 for (stride = 0; stride < search_area_size_in_strides; stride++) {
1431 /* Compute the page addresses. */
1432 page = stride * rom_geo->stride_size_in_pages;
1434 dev_dbg(dev, "Looking for a fingerprint in page 0x%x\n", page);
1437 * Read the NCB fingerprint. The fingerprint is four bytes long
1438 * and starts in the 12th byte of the page.
1440 chip->cmdfunc(mtd, NAND_CMD_READ0, 12, page);
1441 chip->read_buf(mtd, buffer, strlen(fingerprint));
1443 /* Look for the fingerprint. */
1444 if (!memcmp(buffer, fingerprint, strlen(fingerprint))) {
1445 found_an_ncb_fingerprint = true;
1451 chip->select_chip(mtd, saved_chip_number);
1453 if (found_an_ncb_fingerprint)
1454 dev_dbg(dev, "\tFound a fingerprint\n");
1456 dev_dbg(dev, "\tNo fingerprint found\n");
1457 return found_an_ncb_fingerprint;
1460 /* Writes a transcription stamp. */
1461 static int mx23_write_transcription_stamp(struct gpmi_nand_data *this)
1463 struct device *dev = this->dev;
1464 struct boot_rom_geometry *rom_geo = &this->rom_geometry;
1465 struct mtd_info *mtd = &this->mtd;
1466 struct nand_chip *chip = &this->nand;
1467 unsigned int block_size_in_pages;
1468 unsigned int search_area_size_in_strides;
1469 unsigned int search_area_size_in_pages;
1470 unsigned int search_area_size_in_blocks;
1472 unsigned int stride;
1474 uint8_t *buffer = chip->buffers->databuf;
1475 int saved_chip_number;
1478 /* Compute the search area geometry. */
1479 block_size_in_pages = mtd->erasesize / mtd->writesize;
1480 search_area_size_in_strides = 1 << rom_geo->search_area_stride_exponent;
1481 search_area_size_in_pages = search_area_size_in_strides *
1482 rom_geo->stride_size_in_pages;
1483 search_area_size_in_blocks =
1484 (search_area_size_in_pages + (block_size_in_pages - 1)) /
1485 block_size_in_pages;
1487 dev_dbg(dev, "Search Area Geometry :\n");
1488 dev_dbg(dev, "\tin Blocks : %u\n", search_area_size_in_blocks);
1489 dev_dbg(dev, "\tin Strides: %u\n", search_area_size_in_strides);
1490 dev_dbg(dev, "\tin Pages : %u\n", search_area_size_in_pages);
1492 /* Select chip 0. */
1493 saved_chip_number = this->current_chip;
1494 chip->select_chip(mtd, 0);
1496 /* Loop over blocks in the first search area, erasing them. */
1497 dev_dbg(dev, "Erasing the search area...\n");
1499 for (block = 0; block < search_area_size_in_blocks; block++) {
1500 /* Compute the page address. */
1501 page = block * block_size_in_pages;
1503 /* Erase this block. */
1504 dev_dbg(dev, "\tErasing block 0x%x\n", block);
1505 chip->cmdfunc(mtd, NAND_CMD_ERASE1, -1, page);
1506 chip->cmdfunc(mtd, NAND_CMD_ERASE2, -1, -1);
1508 /* Wait for the erase to finish. */
1509 status = chip->waitfunc(mtd, chip);
1510 if (status & NAND_STATUS_FAIL)
1511 dev_err(dev, "[%s] Erase failed.\n", __func__);
1514 /* Write the NCB fingerprint into the page buffer. */
1515 memset(buffer, ~0, mtd->writesize);
1516 memcpy(buffer + 12, fingerprint, strlen(fingerprint));
1518 /* Loop through the first search area, writing NCB fingerprints. */
1519 dev_dbg(dev, "Writing NCB fingerprints...\n");
1520 for (stride = 0; stride < search_area_size_in_strides; stride++) {
1521 /* Compute the page addresses. */
1522 page = stride * rom_geo->stride_size_in_pages;
1524 /* Write the first page of the current stride. */
1525 dev_dbg(dev, "Writing an NCB fingerprint in page 0x%x\n", page);
1526 chip->cmdfunc(mtd, NAND_CMD_SEQIN, 0x00, page);
1527 chip->ecc.write_page_raw(mtd, chip, buffer, 0);
1528 chip->cmdfunc(mtd, NAND_CMD_PAGEPROG, -1, -1);
1530 /* Wait for the write to finish. */
1531 status = chip->waitfunc(mtd, chip);
1532 if (status & NAND_STATUS_FAIL)
1533 dev_err(dev, "[%s] Write failed.\n", __func__);
1536 /* Deselect chip 0. */
1537 chip->select_chip(mtd, saved_chip_number);
1541 static int mx23_boot_init(struct gpmi_nand_data *this)
1543 struct device *dev = this->dev;
1544 struct nand_chip *chip = &this->nand;
1545 struct mtd_info *mtd = &this->mtd;
1546 unsigned int block_count;
1555 * If control arrives here, we can't use block mark swapping, which
1556 * means we're forced to use transcription. First, scan for the
1557 * transcription stamp. If we find it, then we don't have to do
1558 * anything -- the block marks are already transcribed.
1560 if (mx23_check_transcription_stamp(this))
1564 * If control arrives here, we couldn't find a transcription stamp, so
1565 * so we presume the block marks are in the conventional location.
1567 dev_dbg(dev, "Transcribing bad block marks...\n");
1569 /* Compute the number of blocks in the entire medium. */
1570 block_count = chip->chipsize >> chip->phys_erase_shift;
1573 * Loop over all the blocks in the medium, transcribing block marks as
1576 for (block = 0; block < block_count; block++) {
1578 * Compute the chip, page and byte addresses for this block's
1579 * conventional mark.
1581 chipnr = block >> (chip->chip_shift - chip->phys_erase_shift);
1582 page = block << (chip->phys_erase_shift - chip->page_shift);
1583 byte = block << chip->phys_erase_shift;
1585 /* Send the command to read the conventional block mark. */
1586 chip->select_chip(mtd, chipnr);
1587 chip->cmdfunc(mtd, NAND_CMD_READ0, mtd->writesize, page);
1588 block_mark = chip->read_byte(mtd);
1589 chip->select_chip(mtd, -1);
1592 * Check if the block is marked bad. If so, we need to mark it
1593 * again, but this time the result will be a mark in the
1594 * location where we transcribe block marks.
1596 if (block_mark != 0xff) {
1597 dev_dbg(dev, "Transcribing mark in block %u\n", block);
1598 ret = chip->block_markbad(mtd, byte);
1600 dev_err(dev, "Failed to mark block bad with "
1605 /* Write the stamp that indicates we've transcribed the block marks. */
1606 mx23_write_transcription_stamp(this);
1610 static int nand_boot_init(struct gpmi_nand_data *this)
1612 nand_boot_set_geometry(this);
1614 /* This is ROM arch-specific initilization before the BBT scanning. */
1615 if (GPMI_IS_MX23(this))
1616 return mx23_boot_init(this);
1620 static int gpmi_set_geometry(struct gpmi_nand_data *this)
1624 /* Free the temporary DMA memory for reading ID. */
1625 gpmi_free_dma_buffer(this);
1627 /* Set up the NFC geometry which is used by BCH. */
1628 ret = bch_set_geometry(this);
1630 dev_err(this->dev, "Error setting BCH geometry : %d\n", ret);
1634 /* Alloc the new DMA buffers according to the pagesize and oobsize */
1635 return gpmi_alloc_dma_buffer(this);
1638 static void gpmi_nand_exit(struct gpmi_nand_data *this)
1640 nand_release(&this->mtd);
1641 gpmi_free_dma_buffer(this);
1644 static int gpmi_init_last(struct gpmi_nand_data *this)
1646 struct mtd_info *mtd = &this->mtd;
1647 struct nand_chip *chip = mtd->priv;
1648 struct nand_ecc_ctrl *ecc = &chip->ecc;
1649 struct bch_geometry *bch_geo = &this->bch_geometry;
1652 /* Set up swap_block_mark, must be set before the gpmi_set_geometry() */
1653 this->swap_block_mark = !GPMI_IS_MX23(this);
1655 /* Set up the medium geometry */
1656 ret = gpmi_set_geometry(this);
1660 /* Init the nand_ecc_ctrl{} */
1661 ecc->read_page = gpmi_ecc_read_page;
1662 ecc->write_page = gpmi_ecc_write_page;
1663 ecc->read_oob = gpmi_ecc_read_oob;
1664 ecc->write_oob = gpmi_ecc_write_oob;
1665 ecc->mode = NAND_ECC_HW;
1666 ecc->size = bch_geo->ecc_chunk_size;
1667 ecc->strength = bch_geo->ecc_strength;
1668 ecc->layout = &gpmi_hw_ecclayout;
1671 * We only enable the subpage read when:
1672 * (1) the chip is imx6, and
1673 * (2) the size of the ECC parity is byte aligned.
1675 if (GPMI_IS_MX6(this) &&
1676 ((bch_geo->gf_len * bch_geo->ecc_strength) % 8) == 0) {
1677 ecc->read_subpage = gpmi_ecc_read_subpage;
1678 chip->options |= NAND_SUBPAGE_READ;
1682 * Can we enable the extra features? such as EDO or Sync mode.
1684 * We do not check the return value now. That's means if we fail in
1685 * enable the extra features, we still can run in the normal way.
1687 gpmi_extra_init(this);
1692 static int gpmi_nand_init(struct gpmi_nand_data *this)
1694 struct mtd_info *mtd = &this->mtd;
1695 struct nand_chip *chip = &this->nand;
1696 struct mtd_part_parser_data ppdata = {};
1699 /* init current chip */
1700 this->current_chip = -1;
1702 /* init the MTD data structures */
1704 mtd->name = "gpmi-nand";
1705 mtd->owner = THIS_MODULE;
1707 /* init the nand_chip{}, we don't support a 16-bit NAND Flash bus. */
1709 chip->select_chip = gpmi_select_chip;
1710 chip->cmd_ctrl = gpmi_cmd_ctrl;
1711 chip->dev_ready = gpmi_dev_ready;
1712 chip->read_byte = gpmi_read_byte;
1713 chip->read_buf = gpmi_read_buf;
1714 chip->write_buf = gpmi_write_buf;
1715 chip->badblock_pattern = &gpmi_bbt_descr;
1716 chip->block_markbad = gpmi_block_markbad;
1717 chip->options |= NAND_NO_SUBPAGE_WRITE;
1718 if (of_get_nand_on_flash_bbt(this->dev->of_node))
1719 chip->bbt_options |= NAND_BBT_USE_FLASH | NAND_BBT_NO_OOB;
1722 * Allocate a temporary DMA buffer for reading ID in the
1723 * nand_scan_ident().
1725 this->bch_geometry.payload_size = 1024;
1726 this->bch_geometry.auxiliary_size = 128;
1727 ret = gpmi_alloc_dma_buffer(this);
1731 ret = nand_scan_ident(mtd, GPMI_IS_MX6(this) ? 2 : 1, NULL);
1735 ret = gpmi_init_last(this);
1739 chip->options |= NAND_SKIP_BBTSCAN;
1740 ret = nand_scan_tail(mtd);
1744 ret = nand_boot_init(this);
1747 chip->scan_bbt(mtd);
1749 ppdata.of_node = this->pdev->dev.of_node;
1750 ret = mtd_device_parse_register(mtd, NULL, &ppdata, NULL, 0);
1756 gpmi_nand_exit(this);
1760 static const struct of_device_id gpmi_nand_id_table[] = {
1762 .compatible = "fsl,imx23-gpmi-nand",
1763 .data = (void *)&gpmi_devdata_imx23,
1765 .compatible = "fsl,imx28-gpmi-nand",
1766 .data = (void *)&gpmi_devdata_imx28,
1768 .compatible = "fsl,imx6q-gpmi-nand",
1769 .data = (void *)&gpmi_devdata_imx6q,
1771 .compatible = "fsl,imx6sx-gpmi-nand",
1772 .data = (void *)&gpmi_devdata_imx6sx,
1775 MODULE_DEVICE_TABLE(of, gpmi_nand_id_table);
1777 static int gpmi_nand_probe(struct platform_device *pdev)
1779 struct gpmi_nand_data *this;
1780 const struct of_device_id *of_id;
1783 this = devm_kzalloc(&pdev->dev, sizeof(*this), GFP_KERNEL);
1787 of_id = of_match_device(gpmi_nand_id_table, &pdev->dev);
1789 this->devdata = of_id->data;
1791 dev_err(&pdev->dev, "Failed to find the right device id.\n");
1795 platform_set_drvdata(pdev, this);
1797 this->dev = &pdev->dev;
1799 ret = acquire_resources(this);
1801 goto exit_acquire_resources;
1803 ret = init_hardware(this);
1807 ret = gpmi_nand_init(this);
1811 dev_info(this->dev, "driver registered.\n");
1816 release_resources(this);
1817 exit_acquire_resources:
1818 dev_err(this->dev, "driver registration failed: %d\n", ret);
1823 static int gpmi_nand_remove(struct platform_device *pdev)
1825 struct gpmi_nand_data *this = platform_get_drvdata(pdev);
1827 gpmi_nand_exit(this);
1828 release_resources(this);
1832 static struct platform_driver gpmi_nand_driver = {
1834 .name = "gpmi-nand",
1835 .of_match_table = gpmi_nand_id_table,
1837 .probe = gpmi_nand_probe,
1838 .remove = gpmi_nand_remove,
1840 module_platform_driver(gpmi_nand_driver);
1842 MODULE_AUTHOR("Freescale Semiconductor, Inc.");
1843 MODULE_DESCRIPTION("i.MX GPMI NAND Flash Controller Driver");
1844 MODULE_LICENSE("GPL");