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.
22 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
24 #include <linux/clk.h>
25 #include <linux/slab.h>
26 #include <linux/interrupt.h>
27 #include <linux/module.h>
28 #include <linux/mtd/partitions.h>
30 #include <linux/of_device.h>
31 #include <linux/of_mtd.h>
32 #include "gpmi-nand.h"
34 /* Resource names for the GPMI NAND driver. */
35 #define GPMI_NAND_GPMI_REGS_ADDR_RES_NAME "gpmi-nand"
36 #define GPMI_NAND_BCH_REGS_ADDR_RES_NAME "bch"
37 #define GPMI_NAND_BCH_INTERRUPT_RES_NAME "bch"
39 /* add our owner bbt descriptor */
40 static uint8_t scan_ff_pattern
[] = { 0xff };
41 static struct nand_bbt_descr gpmi_bbt_descr
= {
45 .pattern
= scan_ff_pattern
48 /* We will use all the (page + OOB). */
49 static struct nand_ecclayout gpmi_hw_ecclayout
= {
52 .oobfree
= { {.offset
= 0, .length
= 0} }
55 static irqreturn_t
bch_irq(int irq
, void *cookie
)
57 struct gpmi_nand_data
*this = cookie
;
60 complete(&this->bch_done
);
65 * Calculate the ECC strength by hand:
66 * E : The ECC strength.
67 * G : the length of Galois Field.
68 * N : The chunk count of per page.
69 * O : the oobsize of the NAND chip.
70 * M : the metasize of per page.
74 * ------------ <= (O - M)
82 static inline int get_ecc_strength(struct gpmi_nand_data
*this)
84 struct bch_geometry
*geo
= &this->bch_geometry
;
85 struct mtd_info
*mtd
= &this->mtd
;
88 ecc_strength
= ((mtd
->oobsize
- geo
->metadata_size
) * 8)
89 / (geo
->gf_len
* geo
->ecc_chunk_count
);
91 /* We need the minor even number. */
92 return round_down(ecc_strength
, 2);
95 static inline bool gpmi_check_ecc(struct gpmi_nand_data
*this)
97 struct bch_geometry
*geo
= &this->bch_geometry
;
99 /* Do the sanity check. */
100 if (GPMI_IS_MX23(this) || GPMI_IS_MX28(this)) {
101 /* The mx23/mx28 only support the GF13. */
102 if (geo
->gf_len
== 14)
105 if (geo
->ecc_strength
> MXS_ECC_STRENGTH_MAX
)
107 } else if (GPMI_IS_MX6Q(this)) {
108 if (geo
->ecc_strength
> MX6_ECC_STRENGTH_MAX
)
114 int common_nfc_set_geometry(struct gpmi_nand_data
*this)
116 struct bch_geometry
*geo
= &this->bch_geometry
;
117 struct mtd_info
*mtd
= &this->mtd
;
118 unsigned int metadata_size
;
119 unsigned int status_size
;
120 unsigned int block_mark_bit_offset
;
123 * The size of the metadata can be changed, though we set it to 10
124 * bytes now. But it can't be too large, because we have to save
125 * enough space for BCH.
127 geo
->metadata_size
= 10;
129 /* The default for the length of Galois Field. */
132 /* The default for chunk size. */
133 geo
->ecc_chunk_size
= 512;
134 while (geo
->ecc_chunk_size
< mtd
->oobsize
) {
135 geo
->ecc_chunk_size
*= 2; /* keep C >= O */
139 geo
->ecc_chunk_count
= mtd
->writesize
/ geo
->ecc_chunk_size
;
141 /* We use the same ECC strength for all chunks. */
142 geo
->ecc_strength
= get_ecc_strength(this);
143 if (!gpmi_check_ecc(this)) {
145 "We can not support this nand chip."
146 " Its required ecc strength(%d) is beyond our"
147 " capability(%d).\n", geo
->ecc_strength
,
148 (GPMI_IS_MX6Q(this) ? MX6_ECC_STRENGTH_MAX
149 : MXS_ECC_STRENGTH_MAX
));
153 geo
->page_size
= mtd
->writesize
+ mtd
->oobsize
;
154 geo
->payload_size
= mtd
->writesize
;
157 * The auxiliary buffer contains the metadata and the ECC status. The
158 * metadata is padded to the nearest 32-bit boundary. The ECC status
159 * contains one byte for every ECC chunk, and is also padded to the
160 * nearest 32-bit boundary.
162 metadata_size
= ALIGN(geo
->metadata_size
, 4);
163 status_size
= ALIGN(geo
->ecc_chunk_count
, 4);
165 geo
->auxiliary_size
= metadata_size
+ status_size
;
166 geo
->auxiliary_status_offset
= metadata_size
;
168 if (!this->swap_block_mark
)
172 * We need to compute the byte and bit offsets of
173 * the physical block mark within the ECC-based view of the page.
175 * NAND chip with 2K page shows below:
181 * +---+----------+-+----------+-+----------+-+----------+-+
182 * | M | data |E| data |E| data |E| data |E|
183 * +---+----------+-+----------+-+----------+-+----------+-+
185 * The position of block mark moves forward in the ECC-based view
186 * of page, and the delta is:
189 * D = (---------------- + M)
192 * With the formula to compute the ECC strength, and the condition
193 * : C >= O (C is the ecc chunk size)
195 * It's easy to deduce to the following result:
197 * E * G (O - M) C - M C - M
198 * ----------- <= ------- <= -------- < ---------
204 * D = (---------------- + M) < C
207 * The above inequality means the position of block mark
208 * within the ECC-based view of the page is still in the data chunk,
209 * and it's NOT in the ECC bits of the chunk.
211 * Use the following to compute the bit position of the
212 * physical block mark within the ECC-based view of the page:
213 * (page_size - D) * 8
217 block_mark_bit_offset
= mtd
->writesize
* 8 -
218 (geo
->ecc_strength
* geo
->gf_len
* (geo
->ecc_chunk_count
- 1)
219 + geo
->metadata_size
* 8);
221 geo
->block_mark_byte_offset
= block_mark_bit_offset
/ 8;
222 geo
->block_mark_bit_offset
= block_mark_bit_offset
% 8;
226 struct dma_chan
*get_dma_chan(struct gpmi_nand_data
*this)
228 int chipnr
= this->current_chip
;
230 return this->dma_chans
[chipnr
];
233 /* Can we use the upper's buffer directly for DMA? */
234 void prepare_data_dma(struct gpmi_nand_data
*this, enum dma_data_direction dr
)
236 struct scatterlist
*sgl
= &this->data_sgl
;
239 this->direct_dma_map_ok
= true;
241 /* first try to map the upper buffer directly */
242 sg_init_one(sgl
, this->upper_buf
, this->upper_len
);
243 ret
= dma_map_sg(this->dev
, sgl
, 1, dr
);
245 /* We have to use our own DMA buffer. */
246 sg_init_one(sgl
, this->data_buffer_dma
, PAGE_SIZE
);
248 if (dr
== DMA_TO_DEVICE
)
249 memcpy(this->data_buffer_dma
, this->upper_buf
,
252 ret
= dma_map_sg(this->dev
, sgl
, 1, dr
);
254 pr_err("DMA mapping failed.\n");
256 this->direct_dma_map_ok
= false;
260 /* This will be called after the DMA operation is finished. */
261 static void dma_irq_callback(void *param
)
263 struct gpmi_nand_data
*this = param
;
264 struct completion
*dma_c
= &this->dma_done
;
268 switch (this->dma_type
) {
269 case DMA_FOR_COMMAND
:
270 dma_unmap_sg(this->dev
, &this->cmd_sgl
, 1, DMA_TO_DEVICE
);
273 case DMA_FOR_READ_DATA
:
274 dma_unmap_sg(this->dev
, &this->data_sgl
, 1, DMA_FROM_DEVICE
);
275 if (this->direct_dma_map_ok
== false)
276 memcpy(this->upper_buf
, this->data_buffer_dma
,
280 case DMA_FOR_WRITE_DATA
:
281 dma_unmap_sg(this->dev
, &this->data_sgl
, 1, DMA_TO_DEVICE
);
284 case DMA_FOR_READ_ECC_PAGE
:
285 case DMA_FOR_WRITE_ECC_PAGE
:
286 /* We have to wait the BCH interrupt to finish. */
290 pr_err("in wrong DMA operation.\n");
294 int start_dma_without_bch_irq(struct gpmi_nand_data
*this,
295 struct dma_async_tx_descriptor
*desc
)
297 struct completion
*dma_c
= &this->dma_done
;
300 init_completion(dma_c
);
302 desc
->callback
= dma_irq_callback
;
303 desc
->callback_param
= this;
304 dmaengine_submit(desc
);
305 dma_async_issue_pending(get_dma_chan(this));
307 /* Wait for the interrupt from the DMA block. */
308 err
= wait_for_completion_timeout(dma_c
, msecs_to_jiffies(1000));
310 pr_err("DMA timeout, last DMA :%d\n", this->last_dma_type
);
311 gpmi_dump_info(this);
318 * This function is used in BCH reading or BCH writing pages.
319 * It will wait for the BCH interrupt as long as ONE second.
320 * Actually, we must wait for two interrupts :
321 * [1] firstly the DMA interrupt and
322 * [2] secondly the BCH interrupt.
324 int start_dma_with_bch_irq(struct gpmi_nand_data
*this,
325 struct dma_async_tx_descriptor
*desc
)
327 struct completion
*bch_c
= &this->bch_done
;
330 /* Prepare to receive an interrupt from the BCH block. */
331 init_completion(bch_c
);
334 start_dma_without_bch_irq(this, desc
);
336 /* Wait for the interrupt from the BCH block. */
337 err
= wait_for_completion_timeout(bch_c
, msecs_to_jiffies(1000));
339 pr_err("BCH timeout, last DMA :%d\n", this->last_dma_type
);
340 gpmi_dump_info(this);
346 static int acquire_register_block(struct gpmi_nand_data
*this,
347 const char *res_name
)
349 struct platform_device
*pdev
= this->pdev
;
350 struct resources
*res
= &this->resources
;
354 r
= platform_get_resource_byname(pdev
, IORESOURCE_MEM
, res_name
);
356 pr_err("Can't get resource for %s\n", res_name
);
360 p
= ioremap(r
->start
, resource_size(r
));
362 pr_err("Can't remap %s\n", res_name
);
366 if (!strcmp(res_name
, GPMI_NAND_GPMI_REGS_ADDR_RES_NAME
))
368 else if (!strcmp(res_name
, GPMI_NAND_BCH_REGS_ADDR_RES_NAME
))
371 pr_err("unknown resource name : %s\n", res_name
);
376 static void release_register_block(struct gpmi_nand_data
*this)
378 struct resources
*res
= &this->resources
;
380 iounmap(res
->gpmi_regs
);
382 iounmap(res
->bch_regs
);
383 res
->gpmi_regs
= NULL
;
384 res
->bch_regs
= NULL
;
387 static int acquire_bch_irq(struct gpmi_nand_data
*this, irq_handler_t irq_h
)
389 struct platform_device
*pdev
= this->pdev
;
390 struct resources
*res
= &this->resources
;
391 const char *res_name
= GPMI_NAND_BCH_INTERRUPT_RES_NAME
;
395 r
= platform_get_resource_byname(pdev
, IORESOURCE_IRQ
, res_name
);
397 pr_err("Can't get resource for %s\n", res_name
);
401 err
= request_irq(r
->start
, irq_h
, 0, res_name
, this);
403 pr_err("Can't own %s\n", res_name
);
407 res
->bch_low_interrupt
= r
->start
;
408 res
->bch_high_interrupt
= r
->end
;
412 static void release_bch_irq(struct gpmi_nand_data
*this)
414 struct resources
*res
= &this->resources
;
415 int i
= res
->bch_low_interrupt
;
417 for (; i
<= res
->bch_high_interrupt
; i
++)
421 static void release_dma_channels(struct gpmi_nand_data
*this)
424 for (i
= 0; i
< DMA_CHANS
; i
++)
425 if (this->dma_chans
[i
]) {
426 dma_release_channel(this->dma_chans
[i
]);
427 this->dma_chans
[i
] = NULL
;
431 static int acquire_dma_channels(struct gpmi_nand_data
*this)
433 struct platform_device
*pdev
= this->pdev
;
434 struct dma_chan
*dma_chan
;
436 /* request dma channel */
437 dma_chan
= dma_request_slave_channel(&pdev
->dev
, "rx-tx");
439 pr_err("Failed to request DMA channel.\n");
443 this->dma_chans
[0] = dma_chan
;
447 release_dma_channels(this);
451 static void gpmi_put_clks(struct gpmi_nand_data
*this)
453 struct resources
*r
= &this->resources
;
457 for (i
= 0; i
< GPMI_CLK_MAX
; i
++) {
466 static char *extra_clks_for_mx6q
[GPMI_CLK_MAX
] = {
467 "gpmi_apb", "gpmi_bch", "gpmi_bch_apb", "per1_bch",
470 static int gpmi_get_clks(struct gpmi_nand_data
*this)
472 struct resources
*r
= &this->resources
;
473 char **extra_clks
= NULL
;
477 /* The main clock is stored in the first. */
478 r
->clock
[0] = clk_get(this->dev
, "gpmi_io");
479 if (IS_ERR(r
->clock
[0])) {
480 err
= PTR_ERR(r
->clock
[0]);
484 /* Get extra clocks */
485 if (GPMI_IS_MX6Q(this))
486 extra_clks
= extra_clks_for_mx6q
;
490 for (i
= 1; i
< GPMI_CLK_MAX
; i
++) {
491 if (extra_clks
[i
- 1] == NULL
)
494 clk
= clk_get(this->dev
, extra_clks
[i
- 1]);
503 if (GPMI_IS_MX6Q(this))
505 * Set the default value for the gpmi clock in mx6q:
507 * If you want to use the ONFI nand which is in the
508 * Synchronous Mode, you should change the clock as you need.
510 clk_set_rate(r
->clock
[0], 22000000);
515 dev_dbg(this->dev
, "failed in finding the clocks.\n");
520 static int acquire_resources(struct gpmi_nand_data
*this)
524 ret
= acquire_register_block(this, GPMI_NAND_GPMI_REGS_ADDR_RES_NAME
);
528 ret
= acquire_register_block(this, GPMI_NAND_BCH_REGS_ADDR_RES_NAME
);
532 ret
= acquire_bch_irq(this, bch_irq
);
536 ret
= acquire_dma_channels(this);
538 goto exit_dma_channels
;
540 ret
= gpmi_get_clks(this);
546 release_dma_channels(this);
548 release_bch_irq(this);
550 release_register_block(this);
554 static void release_resources(struct gpmi_nand_data
*this)
557 release_register_block(this);
558 release_bch_irq(this);
559 release_dma_channels(this);
562 static int init_hardware(struct gpmi_nand_data
*this)
567 * This structure contains the "safe" GPMI timing that should succeed
568 * with any NAND Flash device
569 * (although, with less-than-optimal performance).
571 struct nand_timing safe_timing
= {
572 .data_setup_in_ns
= 80,
573 .data_hold_in_ns
= 60,
574 .address_setup_in_ns
= 25,
575 .gpmi_sample_delay_in_ns
= 6,
581 /* Initialize the hardwares. */
582 ret
= gpmi_init(this);
586 this->timing
= safe_timing
;
590 static int read_page_prepare(struct gpmi_nand_data
*this,
591 void *destination
, unsigned length
,
592 void *alt_virt
, dma_addr_t alt_phys
, unsigned alt_size
,
593 void **use_virt
, dma_addr_t
*use_phys
)
595 struct device
*dev
= this->dev
;
597 if (virt_addr_valid(destination
)) {
598 dma_addr_t dest_phys
;
600 dest_phys
= dma_map_single(dev
, destination
,
601 length
, DMA_FROM_DEVICE
);
602 if (dma_mapping_error(dev
, dest_phys
)) {
603 if (alt_size
< length
) {
604 pr_err("%s, Alternate buffer is too small\n",
610 *use_virt
= destination
;
611 *use_phys
= dest_phys
;
612 this->direct_dma_map_ok
= true;
617 *use_virt
= alt_virt
;
618 *use_phys
= alt_phys
;
619 this->direct_dma_map_ok
= false;
623 static inline void read_page_end(struct gpmi_nand_data
*this,
624 void *destination
, unsigned length
,
625 void *alt_virt
, dma_addr_t alt_phys
, unsigned alt_size
,
626 void *used_virt
, dma_addr_t used_phys
)
628 if (this->direct_dma_map_ok
)
629 dma_unmap_single(this->dev
, used_phys
, length
, DMA_FROM_DEVICE
);
632 static inline void read_page_swap_end(struct gpmi_nand_data
*this,
633 void *destination
, unsigned length
,
634 void *alt_virt
, dma_addr_t alt_phys
, unsigned alt_size
,
635 void *used_virt
, dma_addr_t used_phys
)
637 if (!this->direct_dma_map_ok
)
638 memcpy(destination
, alt_virt
, length
);
641 static int send_page_prepare(struct gpmi_nand_data
*this,
642 const void *source
, unsigned length
,
643 void *alt_virt
, dma_addr_t alt_phys
, unsigned alt_size
,
644 const void **use_virt
, dma_addr_t
*use_phys
)
646 struct device
*dev
= this->dev
;
648 if (virt_addr_valid(source
)) {
649 dma_addr_t source_phys
;
651 source_phys
= dma_map_single(dev
, (void *)source
, length
,
653 if (dma_mapping_error(dev
, source_phys
)) {
654 if (alt_size
< length
) {
655 pr_err("%s, Alternate buffer is too small\n",
662 *use_phys
= source_phys
;
667 * Copy the content of the source buffer into the alternate
668 * buffer and set up the return values accordingly.
670 memcpy(alt_virt
, source
, length
);
672 *use_virt
= alt_virt
;
673 *use_phys
= alt_phys
;
677 static void send_page_end(struct gpmi_nand_data
*this,
678 const void *source
, unsigned length
,
679 void *alt_virt
, dma_addr_t alt_phys
, unsigned alt_size
,
680 const void *used_virt
, dma_addr_t used_phys
)
682 struct device
*dev
= this->dev
;
683 if (used_virt
== source
)
684 dma_unmap_single(dev
, used_phys
, length
, DMA_TO_DEVICE
);
687 static void gpmi_free_dma_buffer(struct gpmi_nand_data
*this)
689 struct device
*dev
= this->dev
;
691 if (this->page_buffer_virt
&& virt_addr_valid(this->page_buffer_virt
))
692 dma_free_coherent(dev
, this->page_buffer_size
,
693 this->page_buffer_virt
,
694 this->page_buffer_phys
);
695 kfree(this->cmd_buffer
);
696 kfree(this->data_buffer_dma
);
698 this->cmd_buffer
= NULL
;
699 this->data_buffer_dma
= NULL
;
700 this->page_buffer_virt
= NULL
;
701 this->page_buffer_size
= 0;
704 /* Allocate the DMA buffers */
705 static int gpmi_alloc_dma_buffer(struct gpmi_nand_data
*this)
707 struct bch_geometry
*geo
= &this->bch_geometry
;
708 struct device
*dev
= this->dev
;
710 /* [1] Allocate a command buffer. PAGE_SIZE is enough. */
711 this->cmd_buffer
= kzalloc(PAGE_SIZE
, GFP_DMA
| GFP_KERNEL
);
712 if (this->cmd_buffer
== NULL
)
715 /* [2] Allocate a read/write data buffer. PAGE_SIZE is enough. */
716 this->data_buffer_dma
= kzalloc(PAGE_SIZE
, GFP_DMA
| GFP_KERNEL
);
717 if (this->data_buffer_dma
== NULL
)
721 * [3] Allocate the page buffer.
723 * Both the payload buffer and the auxiliary buffer must appear on
724 * 32-bit boundaries. We presume the size of the payload buffer is a
725 * power of two and is much larger than four, which guarantees the
726 * auxiliary buffer will appear on a 32-bit boundary.
728 this->page_buffer_size
= geo
->payload_size
+ geo
->auxiliary_size
;
729 this->page_buffer_virt
= dma_alloc_coherent(dev
, this->page_buffer_size
,
730 &this->page_buffer_phys
, GFP_DMA
);
731 if (!this->page_buffer_virt
)
735 /* Slice up the page buffer. */
736 this->payload_virt
= this->page_buffer_virt
;
737 this->payload_phys
= this->page_buffer_phys
;
738 this->auxiliary_virt
= this->payload_virt
+ geo
->payload_size
;
739 this->auxiliary_phys
= this->payload_phys
+ geo
->payload_size
;
743 gpmi_free_dma_buffer(this);
744 pr_err("Error allocating DMA buffers!\n");
748 static void gpmi_cmd_ctrl(struct mtd_info
*mtd
, int data
, unsigned int ctrl
)
750 struct nand_chip
*chip
= mtd
->priv
;
751 struct gpmi_nand_data
*this = chip
->priv
;
755 * Every operation begins with a command byte and a series of zero or
756 * more address bytes. These are distinguished by either the Address
757 * Latch Enable (ALE) or Command Latch Enable (CLE) signals being
758 * asserted. When MTD is ready to execute the command, it will deassert
759 * both latch enables.
761 * Rather than run a separate DMA operation for every single byte, we
762 * queue them up and run a single DMA operation for the entire series
763 * of command and data bytes. NAND_CMD_NONE means the END of the queue.
765 if ((ctrl
& (NAND_ALE
| NAND_CLE
))) {
766 if (data
!= NAND_CMD_NONE
)
767 this->cmd_buffer
[this->command_length
++] = data
;
771 if (!this->command_length
)
774 ret
= gpmi_send_command(this);
776 pr_err("Chip: %u, Error %d\n", this->current_chip
, ret
);
778 this->command_length
= 0;
781 static int gpmi_dev_ready(struct mtd_info
*mtd
)
783 struct nand_chip
*chip
= mtd
->priv
;
784 struct gpmi_nand_data
*this = chip
->priv
;
786 return gpmi_is_ready(this, this->current_chip
);
789 static void gpmi_select_chip(struct mtd_info
*mtd
, int chipnr
)
791 struct nand_chip
*chip
= mtd
->priv
;
792 struct gpmi_nand_data
*this = chip
->priv
;
794 if ((this->current_chip
< 0) && (chipnr
>= 0))
796 else if ((this->current_chip
>= 0) && (chipnr
< 0))
799 this->current_chip
= chipnr
;
802 static void gpmi_read_buf(struct mtd_info
*mtd
, uint8_t *buf
, int len
)
804 struct nand_chip
*chip
= mtd
->priv
;
805 struct gpmi_nand_data
*this = chip
->priv
;
807 pr_debug("len is %d\n", len
);
808 this->upper_buf
= buf
;
809 this->upper_len
= len
;
811 gpmi_read_data(this);
814 static void gpmi_write_buf(struct mtd_info
*mtd
, const uint8_t *buf
, int len
)
816 struct nand_chip
*chip
= mtd
->priv
;
817 struct gpmi_nand_data
*this = chip
->priv
;
819 pr_debug("len is %d\n", len
);
820 this->upper_buf
= (uint8_t *)buf
;
821 this->upper_len
= len
;
823 gpmi_send_data(this);
826 static uint8_t gpmi_read_byte(struct mtd_info
*mtd
)
828 struct nand_chip
*chip
= mtd
->priv
;
829 struct gpmi_nand_data
*this = chip
->priv
;
830 uint8_t *buf
= this->data_buffer_dma
;
832 gpmi_read_buf(mtd
, buf
, 1);
837 * Handles block mark swapping.
838 * It can be called in swapping the block mark, or swapping it back,
839 * because the the operations are the same.
841 static void block_mark_swapping(struct gpmi_nand_data
*this,
842 void *payload
, void *auxiliary
)
844 struct bch_geometry
*nfc_geo
= &this->bch_geometry
;
849 unsigned char from_data
;
850 unsigned char from_oob
;
852 if (!this->swap_block_mark
)
856 * If control arrives here, we're swapping. Make some convenience
859 bit
= nfc_geo
->block_mark_bit_offset
;
860 p
= payload
+ nfc_geo
->block_mark_byte_offset
;
864 * Get the byte from the data area that overlays the block mark. Since
865 * the ECC engine applies its own view to the bits in the page, the
866 * physical block mark won't (in general) appear on a byte boundary in
869 from_data
= (p
[0] >> bit
) | (p
[1] << (8 - bit
));
871 /* Get the byte from the OOB. */
877 mask
= (0x1 << bit
) - 1;
878 p
[0] = (p
[0] & mask
) | (from_oob
<< bit
);
881 p
[1] = (p
[1] & mask
) | (from_oob
>> (8 - bit
));
884 static int gpmi_ecc_read_page(struct mtd_info
*mtd
, struct nand_chip
*chip
,
885 uint8_t *buf
, int oob_required
, int page
)
887 struct gpmi_nand_data
*this = chip
->priv
;
888 struct bch_geometry
*nfc_geo
= &this->bch_geometry
;
890 dma_addr_t payload_phys
;
891 void *auxiliary_virt
;
892 dma_addr_t auxiliary_phys
;
894 unsigned char *status
;
895 unsigned int max_bitflips
= 0;
898 pr_debug("page number is : %d\n", page
);
899 ret
= read_page_prepare(this, buf
, mtd
->writesize
,
900 this->payload_virt
, this->payload_phys
,
901 nfc_geo
->payload_size
,
902 &payload_virt
, &payload_phys
);
904 pr_err("Inadequate DMA buffer\n");
908 auxiliary_virt
= this->auxiliary_virt
;
909 auxiliary_phys
= this->auxiliary_phys
;
912 ret
= gpmi_read_page(this, payload_phys
, auxiliary_phys
);
913 read_page_end(this, buf
, mtd
->writesize
,
914 this->payload_virt
, this->payload_phys
,
915 nfc_geo
->payload_size
,
916 payload_virt
, payload_phys
);
918 pr_err("Error in ECC-based read: %d\n", ret
);
922 /* handle the block mark swapping */
923 block_mark_swapping(this, payload_virt
, auxiliary_virt
);
925 /* Loop over status bytes, accumulating ECC status. */
926 status
= auxiliary_virt
+ nfc_geo
->auxiliary_status_offset
;
928 for (i
= 0; i
< nfc_geo
->ecc_chunk_count
; i
++, status
++) {
929 if ((*status
== STATUS_GOOD
) || (*status
== STATUS_ERASED
))
932 if (*status
== STATUS_UNCORRECTABLE
) {
933 mtd
->ecc_stats
.failed
++;
936 mtd
->ecc_stats
.corrected
+= *status
;
937 max_bitflips
= max_t(unsigned int, max_bitflips
, *status
);
942 * It's time to deliver the OOB bytes. See gpmi_ecc_read_oob()
943 * for details about our policy for delivering the OOB.
945 * We fill the caller's buffer with set bits, and then copy the
946 * block mark to th caller's buffer. Note that, if block mark
947 * swapping was necessary, it has already been done, so we can
948 * rely on the first byte of the auxiliary buffer to contain
951 memset(chip
->oob_poi
, ~0, mtd
->oobsize
);
952 chip
->oob_poi
[0] = ((uint8_t *) auxiliary_virt
)[0];
955 read_page_swap_end(this, buf
, mtd
->writesize
,
956 this->payload_virt
, this->payload_phys
,
957 nfc_geo
->payload_size
,
958 payload_virt
, payload_phys
);
963 static int gpmi_ecc_write_page(struct mtd_info
*mtd
, struct nand_chip
*chip
,
964 const uint8_t *buf
, int oob_required
)
966 struct gpmi_nand_data
*this = chip
->priv
;
967 struct bch_geometry
*nfc_geo
= &this->bch_geometry
;
968 const void *payload_virt
;
969 dma_addr_t payload_phys
;
970 const void *auxiliary_virt
;
971 dma_addr_t auxiliary_phys
;
974 pr_debug("ecc write page.\n");
975 if (this->swap_block_mark
) {
977 * If control arrives here, we're doing block mark swapping.
978 * Since we can't modify the caller's buffers, we must copy them
981 memcpy(this->payload_virt
, buf
, mtd
->writesize
);
982 payload_virt
= this->payload_virt
;
983 payload_phys
= this->payload_phys
;
985 memcpy(this->auxiliary_virt
, chip
->oob_poi
,
986 nfc_geo
->auxiliary_size
);
987 auxiliary_virt
= this->auxiliary_virt
;
988 auxiliary_phys
= this->auxiliary_phys
;
990 /* Handle block mark swapping. */
991 block_mark_swapping(this,
992 (void *) payload_virt
, (void *) auxiliary_virt
);
995 * If control arrives here, we're not doing block mark swapping,
996 * so we can to try and use the caller's buffers.
998 ret
= send_page_prepare(this,
1000 this->payload_virt
, this->payload_phys
,
1001 nfc_geo
->payload_size
,
1002 &payload_virt
, &payload_phys
);
1004 pr_err("Inadequate payload DMA buffer\n");
1008 ret
= send_page_prepare(this,
1009 chip
->oob_poi
, mtd
->oobsize
,
1010 this->auxiliary_virt
, this->auxiliary_phys
,
1011 nfc_geo
->auxiliary_size
,
1012 &auxiliary_virt
, &auxiliary_phys
);
1014 pr_err("Inadequate auxiliary DMA buffer\n");
1015 goto exit_auxiliary
;
1020 ret
= gpmi_send_page(this, payload_phys
, auxiliary_phys
);
1022 pr_err("Error in ECC-based write: %d\n", ret
);
1024 if (!this->swap_block_mark
) {
1025 send_page_end(this, chip
->oob_poi
, mtd
->oobsize
,
1026 this->auxiliary_virt
, this->auxiliary_phys
,
1027 nfc_geo
->auxiliary_size
,
1028 auxiliary_virt
, auxiliary_phys
);
1030 send_page_end(this, buf
, mtd
->writesize
,
1031 this->payload_virt
, this->payload_phys
,
1032 nfc_geo
->payload_size
,
1033 payload_virt
, payload_phys
);
1040 * There are several places in this driver where we have to handle the OOB and
1041 * block marks. This is the function where things are the most complicated, so
1042 * this is where we try to explain it all. All the other places refer back to
1045 * These are the rules, in order of decreasing importance:
1047 * 1) Nothing the caller does can be allowed to imperil the block mark.
1049 * 2) In read operations, the first byte of the OOB we return must reflect the
1050 * true state of the block mark, no matter where that block mark appears in
1051 * the physical page.
1053 * 3) ECC-based read operations return an OOB full of set bits (since we never
1054 * allow ECC-based writes to the OOB, it doesn't matter what ECC-based reads
1057 * 4) "Raw" read operations return a direct view of the physical bytes in the
1058 * page, using the conventional definition of which bytes are data and which
1059 * are OOB. This gives the caller a way to see the actual, physical bytes
1060 * in the page, without the distortions applied by our ECC engine.
1063 * What we do for this specific read operation depends on two questions:
1065 * 1) Are we doing a "raw" read, or an ECC-based read?
1067 * 2) Are we using block mark swapping or transcription?
1069 * There are four cases, illustrated by the following Karnaugh map:
1071 * | Raw | ECC-based |
1072 * -------------+-------------------------+-------------------------+
1073 * | Read the conventional | |
1074 * | OOB at the end of the | |
1075 * Swapping | page and return it. It | |
1076 * | contains exactly what | |
1077 * | we want. | Read the block mark and |
1078 * -------------+-------------------------+ return it in a buffer |
1079 * | Read the conventional | full of set bits. |
1080 * | OOB at the end of the | |
1081 * | page and also the block | |
1082 * Transcribing | mark in the metadata. | |
1083 * | Copy the block mark | |
1084 * | into the first byte of | |
1086 * -------------+-------------------------+-------------------------+
1088 * Note that we break rule #4 in the Transcribing/Raw case because we're not
1089 * giving an accurate view of the actual, physical bytes in the page (we're
1090 * overwriting the block mark). That's OK because it's more important to follow
1093 * It turns out that knowing whether we want an "ECC-based" or "raw" read is not
1094 * easy. When reading a page, for example, the NAND Flash MTD code calls our
1095 * ecc.read_page or ecc.read_page_raw function. Thus, the fact that MTD wants an
1096 * ECC-based or raw view of the page is implicit in which function it calls
1097 * (there is a similar pair of ECC-based/raw functions for writing).
1099 * FIXME: The following paragraph is incorrect, now that there exist
1100 * ecc.read_oob_raw and ecc.write_oob_raw functions.
1102 * Since MTD assumes the OOB is not covered by ECC, there is no pair of
1103 * ECC-based/raw functions for reading or or writing the OOB. The fact that the
1104 * caller wants an ECC-based or raw view of the page is not propagated down to
1107 static int gpmi_ecc_read_oob(struct mtd_info
*mtd
, struct nand_chip
*chip
,
1110 struct gpmi_nand_data
*this = chip
->priv
;
1112 pr_debug("page number is %d\n", page
);
1113 /* clear the OOB buffer */
1114 memset(chip
->oob_poi
, ~0, mtd
->oobsize
);
1116 /* Read out the conventional OOB. */
1117 chip
->cmdfunc(mtd
, NAND_CMD_READ0
, mtd
->writesize
, page
);
1118 chip
->read_buf(mtd
, chip
->oob_poi
, mtd
->oobsize
);
1121 * Now, we want to make sure the block mark is correct. In the
1122 * Swapping/Raw case, we already have it. Otherwise, we need to
1123 * explicitly read it.
1125 if (!this->swap_block_mark
) {
1126 /* Read the block mark into the first byte of the OOB buffer. */
1127 chip
->cmdfunc(mtd
, NAND_CMD_READ0
, 0, page
);
1128 chip
->oob_poi
[0] = chip
->read_byte(mtd
);
1135 gpmi_ecc_write_oob(struct mtd_info
*mtd
, struct nand_chip
*chip
, int page
)
1138 * The BCH will use all the (page + oob).
1139 * Our gpmi_hw_ecclayout can only prohibit the JFFS2 to write the oob.
1140 * But it can not stop some ioctls such MEMWRITEOOB which uses
1141 * MTD_OPS_PLACE_OOB. So We have to implement this function to prohibit
1147 static int gpmi_block_markbad(struct mtd_info
*mtd
, loff_t ofs
)
1149 struct nand_chip
*chip
= mtd
->priv
;
1150 struct gpmi_nand_data
*this = chip
->priv
;
1152 uint8_t *block_mark
;
1153 int column
, page
, status
, chipnr
;
1155 /* Get block number */
1156 block
= (int)(ofs
>> chip
->bbt_erase_shift
);
1158 chip
->bbt
[block
>> 2] |= 0x01 << ((block
& 0x03) << 1);
1160 /* Do we have a flash based bad block table ? */
1161 if (chip
->bbt_options
& NAND_BBT_USE_FLASH
)
1162 ret
= nand_update_bbt(mtd
, ofs
);
1164 chipnr
= (int)(ofs
>> chip
->chip_shift
);
1165 chip
->select_chip(mtd
, chipnr
);
1167 column
= this->swap_block_mark
? mtd
->writesize
: 0;
1169 /* Write the block mark. */
1170 block_mark
= this->data_buffer_dma
;
1171 block_mark
[0] = 0; /* bad block marker */
1173 /* Shift to get page */
1174 page
= (int)(ofs
>> chip
->page_shift
);
1176 chip
->cmdfunc(mtd
, NAND_CMD_SEQIN
, column
, page
);
1177 chip
->write_buf(mtd
, block_mark
, 1);
1178 chip
->cmdfunc(mtd
, NAND_CMD_PAGEPROG
, -1, -1);
1180 status
= chip
->waitfunc(mtd
, chip
);
1181 if (status
& NAND_STATUS_FAIL
)
1184 chip
->select_chip(mtd
, -1);
1187 mtd
->ecc_stats
.badblocks
++;
1192 static int nand_boot_set_geometry(struct gpmi_nand_data
*this)
1194 struct boot_rom_geometry
*geometry
= &this->rom_geometry
;
1197 * Set the boot block stride size.
1199 * In principle, we should be reading this from the OTP bits, since
1200 * that's where the ROM is going to get it. In fact, we don't have any
1201 * way to read the OTP bits, so we go with the default and hope for the
1204 geometry
->stride_size_in_pages
= 64;
1207 * Set the search area stride exponent.
1209 * In principle, we should be reading this from the OTP bits, since
1210 * that's where the ROM is going to get it. In fact, we don't have any
1211 * way to read the OTP bits, so we go with the default and hope for the
1214 geometry
->search_area_stride_exponent
= 2;
1218 static const char *fingerprint
= "STMP";
1219 static int mx23_check_transcription_stamp(struct gpmi_nand_data
*this)
1221 struct boot_rom_geometry
*rom_geo
= &this->rom_geometry
;
1222 struct device
*dev
= this->dev
;
1223 struct mtd_info
*mtd
= &this->mtd
;
1224 struct nand_chip
*chip
= &this->nand
;
1225 unsigned int search_area_size_in_strides
;
1226 unsigned int stride
;
1228 uint8_t *buffer
= chip
->buffers
->databuf
;
1229 int saved_chip_number
;
1230 int found_an_ncb_fingerprint
= false;
1232 /* Compute the number of strides in a search area. */
1233 search_area_size_in_strides
= 1 << rom_geo
->search_area_stride_exponent
;
1235 saved_chip_number
= this->current_chip
;
1236 chip
->select_chip(mtd
, 0);
1239 * Loop through the first search area, looking for the NCB fingerprint.
1241 dev_dbg(dev
, "Scanning for an NCB fingerprint...\n");
1243 for (stride
= 0; stride
< search_area_size_in_strides
; stride
++) {
1244 /* Compute the page addresses. */
1245 page
= stride
* rom_geo
->stride_size_in_pages
;
1247 dev_dbg(dev
, "Looking for a fingerprint in page 0x%x\n", page
);
1250 * Read the NCB fingerprint. The fingerprint is four bytes long
1251 * and starts in the 12th byte of the page.
1253 chip
->cmdfunc(mtd
, NAND_CMD_READ0
, 12, page
);
1254 chip
->read_buf(mtd
, buffer
, strlen(fingerprint
));
1256 /* Look for the fingerprint. */
1257 if (!memcmp(buffer
, fingerprint
, strlen(fingerprint
))) {
1258 found_an_ncb_fingerprint
= true;
1264 chip
->select_chip(mtd
, saved_chip_number
);
1266 if (found_an_ncb_fingerprint
)
1267 dev_dbg(dev
, "\tFound a fingerprint\n");
1269 dev_dbg(dev
, "\tNo fingerprint found\n");
1270 return found_an_ncb_fingerprint
;
1273 /* Writes a transcription stamp. */
1274 static int mx23_write_transcription_stamp(struct gpmi_nand_data
*this)
1276 struct device
*dev
= this->dev
;
1277 struct boot_rom_geometry
*rom_geo
= &this->rom_geometry
;
1278 struct mtd_info
*mtd
= &this->mtd
;
1279 struct nand_chip
*chip
= &this->nand
;
1280 unsigned int block_size_in_pages
;
1281 unsigned int search_area_size_in_strides
;
1282 unsigned int search_area_size_in_pages
;
1283 unsigned int search_area_size_in_blocks
;
1285 unsigned int stride
;
1287 uint8_t *buffer
= chip
->buffers
->databuf
;
1288 int saved_chip_number
;
1291 /* Compute the search area geometry. */
1292 block_size_in_pages
= mtd
->erasesize
/ mtd
->writesize
;
1293 search_area_size_in_strides
= 1 << rom_geo
->search_area_stride_exponent
;
1294 search_area_size_in_pages
= search_area_size_in_strides
*
1295 rom_geo
->stride_size_in_pages
;
1296 search_area_size_in_blocks
=
1297 (search_area_size_in_pages
+ (block_size_in_pages
- 1)) /
1298 block_size_in_pages
;
1300 dev_dbg(dev
, "Search Area Geometry :\n");
1301 dev_dbg(dev
, "\tin Blocks : %u\n", search_area_size_in_blocks
);
1302 dev_dbg(dev
, "\tin Strides: %u\n", search_area_size_in_strides
);
1303 dev_dbg(dev
, "\tin Pages : %u\n", search_area_size_in_pages
);
1305 /* Select chip 0. */
1306 saved_chip_number
= this->current_chip
;
1307 chip
->select_chip(mtd
, 0);
1309 /* Loop over blocks in the first search area, erasing them. */
1310 dev_dbg(dev
, "Erasing the search area...\n");
1312 for (block
= 0; block
< search_area_size_in_blocks
; block
++) {
1313 /* Compute the page address. */
1314 page
= block
* block_size_in_pages
;
1316 /* Erase this block. */
1317 dev_dbg(dev
, "\tErasing block 0x%x\n", block
);
1318 chip
->cmdfunc(mtd
, NAND_CMD_ERASE1
, -1, page
);
1319 chip
->cmdfunc(mtd
, NAND_CMD_ERASE2
, -1, -1);
1321 /* Wait for the erase to finish. */
1322 status
= chip
->waitfunc(mtd
, chip
);
1323 if (status
& NAND_STATUS_FAIL
)
1324 dev_err(dev
, "[%s] Erase failed.\n", __func__
);
1327 /* Write the NCB fingerprint into the page buffer. */
1328 memset(buffer
, ~0, mtd
->writesize
);
1329 memset(chip
->oob_poi
, ~0, mtd
->oobsize
);
1330 memcpy(buffer
+ 12, fingerprint
, strlen(fingerprint
));
1332 /* Loop through the first search area, writing NCB fingerprints. */
1333 dev_dbg(dev
, "Writing NCB fingerprints...\n");
1334 for (stride
= 0; stride
< search_area_size_in_strides
; stride
++) {
1335 /* Compute the page addresses. */
1336 page
= stride
* rom_geo
->stride_size_in_pages
;
1338 /* Write the first page of the current stride. */
1339 dev_dbg(dev
, "Writing an NCB fingerprint in page 0x%x\n", page
);
1340 chip
->cmdfunc(mtd
, NAND_CMD_SEQIN
, 0x00, page
);
1341 chip
->ecc
.write_page_raw(mtd
, chip
, buffer
, 0);
1342 chip
->cmdfunc(mtd
, NAND_CMD_PAGEPROG
, -1, -1);
1344 /* Wait for the write to finish. */
1345 status
= chip
->waitfunc(mtd
, chip
);
1346 if (status
& NAND_STATUS_FAIL
)
1347 dev_err(dev
, "[%s] Write failed.\n", __func__
);
1350 /* Deselect chip 0. */
1351 chip
->select_chip(mtd
, saved_chip_number
);
1355 static int mx23_boot_init(struct gpmi_nand_data
*this)
1357 struct device
*dev
= this->dev
;
1358 struct nand_chip
*chip
= &this->nand
;
1359 struct mtd_info
*mtd
= &this->mtd
;
1360 unsigned int block_count
;
1369 * If control arrives here, we can't use block mark swapping, which
1370 * means we're forced to use transcription. First, scan for the
1371 * transcription stamp. If we find it, then we don't have to do
1372 * anything -- the block marks are already transcribed.
1374 if (mx23_check_transcription_stamp(this))
1378 * If control arrives here, we couldn't find a transcription stamp, so
1379 * so we presume the block marks are in the conventional location.
1381 dev_dbg(dev
, "Transcribing bad block marks...\n");
1383 /* Compute the number of blocks in the entire medium. */
1384 block_count
= chip
->chipsize
>> chip
->phys_erase_shift
;
1387 * Loop over all the blocks in the medium, transcribing block marks as
1390 for (block
= 0; block
< block_count
; block
++) {
1392 * Compute the chip, page and byte addresses for this block's
1393 * conventional mark.
1395 chipnr
= block
>> (chip
->chip_shift
- chip
->phys_erase_shift
);
1396 page
= block
<< (chip
->phys_erase_shift
- chip
->page_shift
);
1397 byte
= block
<< chip
->phys_erase_shift
;
1399 /* Send the command to read the conventional block mark. */
1400 chip
->select_chip(mtd
, chipnr
);
1401 chip
->cmdfunc(mtd
, NAND_CMD_READ0
, mtd
->writesize
, page
);
1402 block_mark
= chip
->read_byte(mtd
);
1403 chip
->select_chip(mtd
, -1);
1406 * Check if the block is marked bad. If so, we need to mark it
1407 * again, but this time the result will be a mark in the
1408 * location where we transcribe block marks.
1410 if (block_mark
!= 0xff) {
1411 dev_dbg(dev
, "Transcribing mark in block %u\n", block
);
1412 ret
= chip
->block_markbad(mtd
, byte
);
1414 dev_err(dev
, "Failed to mark block bad with "
1419 /* Write the stamp that indicates we've transcribed the block marks. */
1420 mx23_write_transcription_stamp(this);
1424 static int nand_boot_init(struct gpmi_nand_data
*this)
1426 nand_boot_set_geometry(this);
1428 /* This is ROM arch-specific initilization before the BBT scanning. */
1429 if (GPMI_IS_MX23(this))
1430 return mx23_boot_init(this);
1434 static int gpmi_set_geometry(struct gpmi_nand_data
*this)
1438 /* Free the temporary DMA memory for reading ID. */
1439 gpmi_free_dma_buffer(this);
1441 /* Set up the NFC geometry which is used by BCH. */
1442 ret
= bch_set_geometry(this);
1444 pr_err("Error setting BCH geometry : %d\n", ret
);
1448 /* Alloc the new DMA buffers according to the pagesize and oobsize */
1449 return gpmi_alloc_dma_buffer(this);
1452 static int gpmi_pre_bbt_scan(struct gpmi_nand_data
*this)
1456 /* Set up swap_block_mark, must be set before the gpmi_set_geometry() */
1457 if (GPMI_IS_MX23(this))
1458 this->swap_block_mark
= false;
1460 this->swap_block_mark
= true;
1462 /* Set up the medium geometry */
1463 ret
= gpmi_set_geometry(this);
1467 /* Adjust the ECC strength according to the chip. */
1468 this->nand
.ecc
.strength
= this->bch_geometry
.ecc_strength
;
1469 this->mtd
.ecc_strength
= this->bch_geometry
.ecc_strength
;
1470 this->mtd
.bitflip_threshold
= this->bch_geometry
.ecc_strength
;
1472 /* NAND boot init, depends on the gpmi_set_geometry(). */
1473 return nand_boot_init(this);
1476 static int gpmi_scan_bbt(struct mtd_info
*mtd
)
1478 struct nand_chip
*chip
= mtd
->priv
;
1479 struct gpmi_nand_data
*this = chip
->priv
;
1482 /* Prepare for the BBT scan. */
1483 ret
= gpmi_pre_bbt_scan(this);
1488 * Can we enable the extra features? such as EDO or Sync mode.
1490 * We do not check the return value now. That's means if we fail in
1491 * enable the extra features, we still can run in the normal way.
1493 gpmi_extra_init(this);
1495 /* use the default BBT implementation */
1496 return nand_default_bbt(mtd
);
1499 static void gpmi_nfc_exit(struct gpmi_nand_data
*this)
1501 nand_release(&this->mtd
);
1502 gpmi_free_dma_buffer(this);
1505 static int gpmi_nfc_init(struct gpmi_nand_data
*this)
1507 struct mtd_info
*mtd
= &this->mtd
;
1508 struct nand_chip
*chip
= &this->nand
;
1509 struct mtd_part_parser_data ppdata
= {};
1512 /* init current chip */
1513 this->current_chip
= -1;
1515 /* init the MTD data structures */
1517 mtd
->name
= "gpmi-nand";
1518 mtd
->owner
= THIS_MODULE
;
1520 /* init the nand_chip{}, we don't support a 16-bit NAND Flash bus. */
1522 chip
->select_chip
= gpmi_select_chip
;
1523 chip
->cmd_ctrl
= gpmi_cmd_ctrl
;
1524 chip
->dev_ready
= gpmi_dev_ready
;
1525 chip
->read_byte
= gpmi_read_byte
;
1526 chip
->read_buf
= gpmi_read_buf
;
1527 chip
->write_buf
= gpmi_write_buf
;
1528 chip
->ecc
.read_page
= gpmi_ecc_read_page
;
1529 chip
->ecc
.write_page
= gpmi_ecc_write_page
;
1530 chip
->ecc
.read_oob
= gpmi_ecc_read_oob
;
1531 chip
->ecc
.write_oob
= gpmi_ecc_write_oob
;
1532 chip
->scan_bbt
= gpmi_scan_bbt
;
1533 chip
->badblock_pattern
= &gpmi_bbt_descr
;
1534 chip
->block_markbad
= gpmi_block_markbad
;
1535 chip
->options
|= NAND_NO_SUBPAGE_WRITE
;
1536 chip
->ecc
.mode
= NAND_ECC_HW
;
1538 chip
->ecc
.strength
= 8;
1539 chip
->ecc
.layout
= &gpmi_hw_ecclayout
;
1540 if (of_get_nand_on_flash_bbt(this->dev
->of_node
))
1541 chip
->bbt_options
|= NAND_BBT_USE_FLASH
| NAND_BBT_NO_OOB
;
1543 /* Allocate a temporary DMA buffer for reading ID in the nand_scan() */
1544 this->bch_geometry
.payload_size
= 1024;
1545 this->bch_geometry
.auxiliary_size
= 128;
1546 ret
= gpmi_alloc_dma_buffer(this);
1550 ret
= nand_scan(mtd
, 1);
1552 pr_err("Chip scan failed\n");
1556 ppdata
.of_node
= this->pdev
->dev
.of_node
;
1557 ret
= mtd_device_parse_register(mtd
, NULL
, &ppdata
, NULL
, 0);
1563 gpmi_nfc_exit(this);
1567 static const struct platform_device_id gpmi_ids
[] = {
1568 { .name
= "imx23-gpmi-nand", .driver_data
= IS_MX23
, },
1569 { .name
= "imx28-gpmi-nand", .driver_data
= IS_MX28
, },
1570 { .name
= "imx6q-gpmi-nand", .driver_data
= IS_MX6Q
, },
1574 static const struct of_device_id gpmi_nand_id_table
[] = {
1576 .compatible
= "fsl,imx23-gpmi-nand",
1577 .data
= (void *)&gpmi_ids
[IS_MX23
]
1579 .compatible
= "fsl,imx28-gpmi-nand",
1580 .data
= (void *)&gpmi_ids
[IS_MX28
]
1582 .compatible
= "fsl,imx6q-gpmi-nand",
1583 .data
= (void *)&gpmi_ids
[IS_MX6Q
]
1586 MODULE_DEVICE_TABLE(of
, gpmi_nand_id_table
);
1588 static int gpmi_nand_probe(struct platform_device
*pdev
)
1590 struct gpmi_nand_data
*this;
1591 const struct of_device_id
*of_id
;
1594 of_id
= of_match_device(gpmi_nand_id_table
, &pdev
->dev
);
1596 pdev
->id_entry
= of_id
->data
;
1598 pr_err("Failed to find the right device id.\n");
1602 this = kzalloc(sizeof(*this), GFP_KERNEL
);
1604 pr_err("Failed to allocate per-device memory\n");
1608 platform_set_drvdata(pdev
, this);
1610 this->dev
= &pdev
->dev
;
1612 ret
= acquire_resources(this);
1614 goto exit_acquire_resources
;
1616 ret
= init_hardware(this);
1620 ret
= gpmi_nfc_init(this);
1624 dev_info(this->dev
, "driver registered.\n");
1629 release_resources(this);
1630 exit_acquire_resources
:
1631 dev_err(this->dev
, "driver registration failed: %d\n", ret
);
1637 static int gpmi_nand_remove(struct platform_device
*pdev
)
1639 struct gpmi_nand_data
*this = platform_get_drvdata(pdev
);
1641 gpmi_nfc_exit(this);
1642 release_resources(this);
1647 static struct platform_driver gpmi_nand_driver
= {
1649 .name
= "gpmi-nand",
1650 .of_match_table
= gpmi_nand_id_table
,
1652 .probe
= gpmi_nand_probe
,
1653 .remove
= gpmi_nand_remove
,
1654 .id_table
= gpmi_ids
,
1656 module_platform_driver(gpmi_nand_driver
);
1658 MODULE_AUTHOR("Freescale Semiconductor, Inc.");
1659 MODULE_DESCRIPTION("i.MX GPMI NAND Flash Controller Driver");
1660 MODULE_LICENSE("GPL");