[thirdparty/u-boot.git] / include / mxs_nand.h

/* SPDX-License-Identifier: GPL-2.0+ */
/*
 * NXP GPMI NAND flash driver
 *
 * Copyright (C) 2018 Toradex
 * Authors:
 * Stefan Agner <stefan.agner@toradex.com>
 */

#include <linux/mtd/mtd.h>
#include <linux/mtd/rawnand.h>
#include <asm/cache.h>
#include <nand.h>
#include <asm/mach-imx/dma.h>
#include <clk.h>

/**
 * @gf_len:                   The length of Galois Field. (e.g., 13 or 14)
 * @ecc_strength:             A number that describes the strength of the ECC
 *                            algorithm.
 * @ecc_chunk0_size:          The size, in bytes, of a first ECC chunk.
 * @ecc_chunkn_size:          The size, in bytes, of a single ECC chunk after
 *                            the first chunk in the page.
 * @ecc_chunk_count:          The number of ECC chunks in the page,
 * @block_mark_byte_offset:   The byte offset in the ECC-based page view at
 *                            which the underlying physical block mark appears.
 * @block_mark_bit_offset:    The bit offset into the ECC-based page view at
 *                            which the underlying physical block mark appears.
 * @ecc_for_meta:             The flag to indicate if there is a dedicate ecc
 *                            for meta.
 */
struct bch_geometry {
	unsigned int  gf_len;
	unsigned int  ecc_strength;
	unsigned int  ecc_chunk0_size;
	unsigned int  ecc_chunkn_size;
	unsigned int  ecc_chunk_count;
	unsigned int  block_mark_byte_offset;
	unsigned int  block_mark_bit_offset;
	unsigned int  ecc_for_meta; /* ECC for meta data */
};

struct mxs_nand_info {
	struct nand_chip chip;
	struct udevice *dev;
	unsigned int	max_ecc_strength_supported;
	int		max_chain_delay;
	bool		use_minimum_ecc;
	int		cur_chip;

	uint32_t	cmd_queue_len;
	uint32_t	data_buf_size;
	struct bch_geometry bch_geometry;

	uint8_t		*cmd_buf;
	uint8_t		*data_buf;
	uint8_t		*oob_buf;

	uint8_t		marking_block_bad;
	uint8_t		raw_oob_mode;

	struct mxs_gpmi_regs *gpmi_regs;
	struct mxs_bch_regs *bch_regs;
	struct clk *gpmi_clk;

	/* Functions with altered behaviour */
	int		(*hooked_read_oob)(struct mtd_info *mtd,
				loff_t from, struct mtd_oob_ops *ops);
	int		(*hooked_write_oob)(struct mtd_info *mtd,
				loff_t to, struct mtd_oob_ops *ops);
	int		(*hooked_block_markbad)(struct mtd_info *mtd,
				loff_t ofs);

	/* DMA descriptors */
	struct mxs_dma_desc	**desc;
	uint32_t		desc_index;

	/* Hardware BCH interface and randomizer */
	u32 en_randomizer;
	u32 writesize;
	u32 oobsize;
	u32 bch_flash0layout0;
	u32 bch_flash0layout1;
};

struct mxs_nand_layout {
	u32 nblocks;
	u32 meta_size;
	u32 data0_size;
	u32 ecc0;
	u32 datan_size;
	u32 eccn;
	u32 gf_len;
};

int mxs_nand_init_ctrl(struct mxs_nand_info *nand_info);
int mxs_nand_init_spl(struct nand_chip *nand);
int mxs_nand_setup_ecc(struct mtd_info *mtd);

void mxs_nand_mode_fcb_62bit(struct mtd_info *mtd);
void mxs_nand_mode_fcb_40bit(struct mtd_info *mtd);
void mxs_nand_mode_normal(struct mtd_info *mtd);
u32 mxs_nand_mark_byte_offset(struct mtd_info *mtd);
u32 mxs_nand_mark_bit_offset(struct mtd_info *mtd);
void mxs_nand_get_layout(struct mtd_info *mtd, struct mxs_nand_layout *l);
Commit	Line	Data
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	10	#include <linux/mtd/mtd.h>
1cefed1e	11	#include <linux/mtd/rawnand.h>
68748340 SA	12	#include <asm/cache.h>
	13	#include <nand.h>
	14	#include <asm/mach-imx/dma.h>
90cce058	15	#include <clk.h>
68748340 SA	16
	17	/**
	18	* @gf_len: The length of Galois Field. (e.g., 13 or 14)
	19	* @ecc_strength: A number that describes the strength of the ECC
	20	* algorithm.
616f03da YL	21	* @ecc_chunk0_size: The size, in bytes, of a first ECC chunk.
	22	* @ecc_chunkn_size: The size, in bytes, of a single ECC chunk after
	23	* the first chunk in the page.
68748340 SA	24	* @ecc_chunk_count: The number of ECC chunks in the page,
	25	* @block_mark_byte_offset: The byte offset in the ECC-based page view at
	26	* which the underlying physical block mark appears.
	27	* @block_mark_bit_offset: The bit offset into the ECC-based page view at
	28	* which the underlying physical block mark appears.
616f03da YL	29	* @ecc_for_meta: The flag to indicate if there is a dedicate ecc
616f03da YL	30	* for meta.
68748340 SA	31	*/
	32	struct bch_geometry {
	33	unsigned int gf_len;
	34	unsigned int ecc_strength;
616f03da YL	35	unsigned int ecc_chunk0_size;
616f03da YL	36	unsigned int ecc_chunkn_size;
68748340 SA	37	unsigned int ecc_chunk_count;
	38	unsigned int block_mark_byte_offset;
	39	unsigned int block_mark_bit_offset;
616f03da	40	unsigned int ecc_for_meta; /* ECC for meta data */
68748340 SA	41	};
	42
	43	struct mxs_nand_info {
	44	struct nand_chip chip;
	45	struct udevice *dev;
	46	unsigned int max_ecc_strength_supported;
90cce058	47	int max_chain_delay;
68748340 SA	48	bool use_minimum_ecc;
	49	int cur_chip;
	50
	51	uint32_t cmd_queue_len;
	52	uint32_t data_buf_size;
	53	struct bch_geometry bch_geometry;
	54
	55	uint8_t *cmd_buf;
	56	uint8_t *data_buf;
	57	uint8_t *oob_buf;
	58
	59	uint8_t marking_block_bad;
	60	uint8_t raw_oob_mode;
	61
	62	struct mxs_gpmi_regs *gpmi_regs;
	63	struct mxs_bch_regs *bch_regs;
90cce058	64	struct clk *gpmi_clk;
68748340 SA	65
	66	/* Functions with altered behaviour */
	67	int (hooked_read_oob)(struct mtd_info mtd,
	68	loff_t from, struct mtd_oob_ops *ops);
	69	int (hooked_write_oob)(struct mtd_info mtd,
	70	loff_t to, struct mtd_oob_ops *ops);
	71	int (hooked_block_markbad)(struct mtd_info mtd,
	72	loff_t ofs);
	73
	74	/* DMA descriptors */
	75	struct mxs_dma_desc **desc;
	76	uint32_t desc_index;
9ab5f221 IO	77
	78	/* Hardware BCH interface and randomizer */
	79	u32 en_randomizer;
	80	u32 writesize;
	81	u32 oobsize;
	82	u32 bch_flash0layout0;
	83	u32 bch_flash0layout1;
	84	};
	85
	86	struct mxs_nand_layout {
	87	u32 nblocks;
	88	u32 meta_size;
	89	u32 data0_size;
	90	u32 ecc0;
	91	u32 datan_size;
	92	u32 eccn;
17282f45	93	u32 gf_len;
68748340 SA	94	};
	95
	96	int mxs_nand_init_ctrl(struct mxs_nand_info *nand_info);
9345943b	97	int mxs_nand_init_spl(struct nand_chip *nand);
5346c31e	98	int mxs_nand_setup_ecc(struct mtd_info *mtd);
9ab5f221	99
bf9382ad HX	100	void mxs_nand_mode_fcb_62bit(struct mtd_info *mtd);
bf9382ad HX	101	void mxs_nand_mode_fcb_40bit(struct mtd_info *mtd);
9ab5f221 IO	102	void mxs_nand_mode_normal(struct mtd_info *mtd);
	103	u32 mxs_nand_mark_byte_offset(struct mtd_info *mtd);
	104	u32 mxs_nand_mark_bit_offset(struct mtd_info *mtd);
	105	void mxs_nand_get_layout(struct mtd_info mtd, struct mxs_nand_layout l);