]> git.ipfire.org Git - thirdparty/u-boot.git/blame - include/mxs_nand.h
Merge tag 'u-boot-amlogic-20200529' of https://gitlab.denx.de/u-boot/custodians/u...
[thirdparty/u-boot.git] / include / mxs_nand.h
CommitLineData
9345943b
SA
1/* SPDX-License-Identifier: GPL-2.0+ */
2/*
3 * NXP GPMI NAND flash driver
4 *
5 * Copyright (C) 2018 Toradex
6 * Authors:
7 * Stefan Agner <stefan.agner@toradex.com>
8 */
9
68748340
SA
10#include <linux/mtd/mtd.h>
11#include <asm/cache.h>
12#include <nand.h>
13#include <asm/mach-imx/dma.h>
14
15/**
16 * @gf_len: The length of Galois Field. (e.g., 13 or 14)
17 * @ecc_strength: A number that describes the strength of the ECC
18 * algorithm.
616f03da
YL
19 * @ecc_chunk0_size: The size, in bytes, of a first ECC chunk.
20 * @ecc_chunkn_size: The size, in bytes, of a single ECC chunk after
21 * the first chunk in the page.
68748340
SA
22 * @ecc_chunk_count: The number of ECC chunks in the page,
23 * @block_mark_byte_offset: The byte offset in the ECC-based page view at
24 * which the underlying physical block mark appears.
25 * @block_mark_bit_offset: The bit offset into the ECC-based page view at
26 * which the underlying physical block mark appears.
616f03da
YL
27 * @ecc_for_meta: The flag to indicate if there is a dedicate ecc
28 * for meta.
68748340
SA
29 */
30struct bch_geometry {
31 unsigned int gf_len;
32 unsigned int ecc_strength;
616f03da
YL
33 unsigned int ecc_chunk0_size;
34 unsigned int ecc_chunkn_size;
68748340
SA
35 unsigned int ecc_chunk_count;
36 unsigned int block_mark_byte_offset;
37 unsigned int block_mark_bit_offset;
616f03da 38 unsigned int ecc_for_meta; /* ECC for meta data */
68748340
SA
39};
40
41struct mxs_nand_info {
42 struct nand_chip chip;
43 struct udevice *dev;
44 unsigned int max_ecc_strength_supported;
45 bool use_minimum_ecc;
51cdf83e
YL
46 /* legacy bch geometry flag */
47 bool legacy_bch_geometry;
68748340
SA
48 int cur_chip;
49
50 uint32_t cmd_queue_len;
51 uint32_t data_buf_size;
52 struct bch_geometry bch_geometry;
53
54 uint8_t *cmd_buf;
55 uint8_t *data_buf;
56 uint8_t *oob_buf;
57
58 uint8_t marking_block_bad;
59 uint8_t raw_oob_mode;
60
61 struct mxs_gpmi_regs *gpmi_regs;
62 struct mxs_bch_regs *bch_regs;
63
64 /* Functions with altered behaviour */
65 int (*hooked_read_oob)(struct mtd_info *mtd,
66 loff_t from, struct mtd_oob_ops *ops);
67 int (*hooked_write_oob)(struct mtd_info *mtd,
68 loff_t to, struct mtd_oob_ops *ops);
69 int (*hooked_block_markbad)(struct mtd_info *mtd,
70 loff_t ofs);
71
72 /* DMA descriptors */
73 struct mxs_dma_desc **desc;
74 uint32_t desc_index;
9ab5f221
IO
75
76 /* Hardware BCH interface and randomizer */
77 u32 en_randomizer;
78 u32 writesize;
79 u32 oobsize;
80 u32 bch_flash0layout0;
81 u32 bch_flash0layout1;
82};
83
84struct mxs_nand_layout {
85 u32 nblocks;
86 u32 meta_size;
87 u32 data0_size;
88 u32 ecc0;
89 u32 datan_size;
90 u32 eccn;
17282f45 91 u32 gf_len;
68748340
SA
92};
93
94int mxs_nand_init_ctrl(struct mxs_nand_info *nand_info);
9345943b 95int mxs_nand_init_spl(struct nand_chip *nand);
5346c31e 96int mxs_nand_setup_ecc(struct mtd_info *mtd);
9ab5f221 97
bf9382ad
HX
98void mxs_nand_mode_fcb_62bit(struct mtd_info *mtd);
99void mxs_nand_mode_fcb_40bit(struct mtd_info *mtd);
9ab5f221
IO
100void mxs_nand_mode_normal(struct mtd_info *mtd);
101u32 mxs_nand_mark_byte_offset(struct mtd_info *mtd);
102u32 mxs_nand_mark_bit_offset(struct mtd_info *mtd);
103void mxs_nand_get_layout(struct mtd_info *mtd, struct mxs_nand_layout *l);