1*4882a593Smuzhiyun /*
2*4882a593Smuzhiyun * FSL UPM NAND driver
3*4882a593Smuzhiyun *
4*4882a593Smuzhiyun * Copyright (C) 2007 MontaVista Software, Inc.
5*4882a593Smuzhiyun * Anton Vorontsov <avorontsov@ru.mvista.com>
6*4882a593Smuzhiyun *
7*4882a593Smuzhiyun * SPDX-License-Identifier: GPL-2.0+
8*4882a593Smuzhiyun */
9*4882a593Smuzhiyun
10*4882a593Smuzhiyun #include <config.h>
11*4882a593Smuzhiyun #include <common.h>
12*4882a593Smuzhiyun #include <asm/io.h>
13*4882a593Smuzhiyun #include <linux/errno.h>
14*4882a593Smuzhiyun #include <linux/mtd/mtd.h>
15*4882a593Smuzhiyun #include <linux/mtd/fsl_upm.h>
16*4882a593Smuzhiyun #include <nand.h>
17*4882a593Smuzhiyun
fsl_upm_start_pattern(struct fsl_upm * upm,u32 pat_offset)18*4882a593Smuzhiyun static void fsl_upm_start_pattern(struct fsl_upm *upm, u32 pat_offset)
19*4882a593Smuzhiyun {
20*4882a593Smuzhiyun clrsetbits_be32(upm->mxmr, MxMR_MAD_MSK, MxMR_OP_RUNP | pat_offset);
21*4882a593Smuzhiyun (void)in_be32(upm->mxmr);
22*4882a593Smuzhiyun }
23*4882a593Smuzhiyun
fsl_upm_end_pattern(struct fsl_upm * upm)24*4882a593Smuzhiyun static void fsl_upm_end_pattern(struct fsl_upm *upm)
25*4882a593Smuzhiyun {
26*4882a593Smuzhiyun clrbits_be32(upm->mxmr, MxMR_OP_RUNP);
27*4882a593Smuzhiyun
28*4882a593Smuzhiyun while (in_be32(upm->mxmr) & MxMR_OP_RUNP)
29*4882a593Smuzhiyun eieio();
30*4882a593Smuzhiyun }
31*4882a593Smuzhiyun
fsl_upm_run_pattern(struct fsl_upm * upm,int width,void __iomem * io_addr,u32 mar)32*4882a593Smuzhiyun static void fsl_upm_run_pattern(struct fsl_upm *upm, int width,
33*4882a593Smuzhiyun void __iomem *io_addr, u32 mar)
34*4882a593Smuzhiyun {
35*4882a593Smuzhiyun out_be32(upm->mar, mar);
36*4882a593Smuzhiyun (void)in_be32(upm->mar);
37*4882a593Smuzhiyun switch (width) {
38*4882a593Smuzhiyun case 8:
39*4882a593Smuzhiyun out_8(io_addr, 0x0);
40*4882a593Smuzhiyun break;
41*4882a593Smuzhiyun case 16:
42*4882a593Smuzhiyun out_be16(io_addr, 0x0);
43*4882a593Smuzhiyun break;
44*4882a593Smuzhiyun case 32:
45*4882a593Smuzhiyun out_be32(io_addr, 0x0);
46*4882a593Smuzhiyun break;
47*4882a593Smuzhiyun }
48*4882a593Smuzhiyun }
49*4882a593Smuzhiyun
fun_wait(struct fsl_upm_nand * fun)50*4882a593Smuzhiyun static void fun_wait(struct fsl_upm_nand *fun)
51*4882a593Smuzhiyun {
52*4882a593Smuzhiyun if (fun->dev_ready) {
53*4882a593Smuzhiyun while (!fun->dev_ready(fun->chip_nr))
54*4882a593Smuzhiyun debug("unexpected busy state\n");
55*4882a593Smuzhiyun } else {
56*4882a593Smuzhiyun /*
57*4882a593Smuzhiyun * If the R/B pin is not connected,
58*4882a593Smuzhiyun * a short delay is necessary.
59*4882a593Smuzhiyun */
60*4882a593Smuzhiyun udelay(1);
61*4882a593Smuzhiyun }
62*4882a593Smuzhiyun }
63*4882a593Smuzhiyun
64*4882a593Smuzhiyun #if CONFIG_SYS_NAND_MAX_CHIPS > 1
fun_select_chip(struct mtd_info * mtd,int chip_nr)65*4882a593Smuzhiyun static void fun_select_chip(struct mtd_info *mtd, int chip_nr)
66*4882a593Smuzhiyun {
67*4882a593Smuzhiyun struct nand_chip *chip = mtd_to_nand(mtd);
68*4882a593Smuzhiyun struct fsl_upm_nand *fun = nand_get_controller_data(chip);
69*4882a593Smuzhiyun
70*4882a593Smuzhiyun if (chip_nr >= 0) {
71*4882a593Smuzhiyun fun->chip_nr = chip_nr;
72*4882a593Smuzhiyun chip->IO_ADDR_R = chip->IO_ADDR_W =
73*4882a593Smuzhiyun fun->upm.io_addr + fun->chip_offset * chip_nr;
74*4882a593Smuzhiyun } else if (chip_nr == -1) {
75*4882a593Smuzhiyun chip->cmd_ctrl(mtd, NAND_CMD_NONE, 0 | NAND_CTRL_CHANGE);
76*4882a593Smuzhiyun }
77*4882a593Smuzhiyun }
78*4882a593Smuzhiyun #endif
79*4882a593Smuzhiyun
fun_cmd_ctrl(struct mtd_info * mtd,int cmd,unsigned int ctrl)80*4882a593Smuzhiyun static void fun_cmd_ctrl(struct mtd_info *mtd, int cmd, unsigned int ctrl)
81*4882a593Smuzhiyun {
82*4882a593Smuzhiyun struct nand_chip *chip = mtd_to_nand(mtd);
83*4882a593Smuzhiyun struct fsl_upm_nand *fun = nand_get_controller_data(chip);
84*4882a593Smuzhiyun void __iomem *io_addr;
85*4882a593Smuzhiyun u32 mar;
86*4882a593Smuzhiyun
87*4882a593Smuzhiyun if (!(ctrl & fun->last_ctrl)) {
88*4882a593Smuzhiyun fsl_upm_end_pattern(&fun->upm);
89*4882a593Smuzhiyun
90*4882a593Smuzhiyun if (cmd == NAND_CMD_NONE)
91*4882a593Smuzhiyun return;
92*4882a593Smuzhiyun
93*4882a593Smuzhiyun fun->last_ctrl = ctrl & (NAND_ALE | NAND_CLE);
94*4882a593Smuzhiyun }
95*4882a593Smuzhiyun
96*4882a593Smuzhiyun if (ctrl & NAND_CTRL_CHANGE) {
97*4882a593Smuzhiyun if (ctrl & NAND_ALE)
98*4882a593Smuzhiyun fsl_upm_start_pattern(&fun->upm, fun->upm_addr_offset);
99*4882a593Smuzhiyun else if (ctrl & NAND_CLE)
100*4882a593Smuzhiyun fsl_upm_start_pattern(&fun->upm, fun->upm_cmd_offset);
101*4882a593Smuzhiyun }
102*4882a593Smuzhiyun
103*4882a593Smuzhiyun mar = cmd << (32 - fun->width);
104*4882a593Smuzhiyun io_addr = fun->upm.io_addr;
105*4882a593Smuzhiyun #if CONFIG_SYS_NAND_MAX_CHIPS > 1
106*4882a593Smuzhiyun if (fun->chip_nr > 0) {
107*4882a593Smuzhiyun io_addr += fun->chip_offset * fun->chip_nr;
108*4882a593Smuzhiyun if (fun->upm_mar_chip_offset)
109*4882a593Smuzhiyun mar |= fun->upm_mar_chip_offset * fun->chip_nr;
110*4882a593Smuzhiyun }
111*4882a593Smuzhiyun #endif
112*4882a593Smuzhiyun fsl_upm_run_pattern(&fun->upm, fun->width, io_addr, mar);
113*4882a593Smuzhiyun
114*4882a593Smuzhiyun /*
115*4882a593Smuzhiyun * Some boards/chips needs this. At least the MPC8360E-RDK
116*4882a593Smuzhiyun * needs it. Probably weird chip, because I don't see any
117*4882a593Smuzhiyun * need for this on MPC8555E + Samsung K9F1G08U0A. Usually
118*4882a593Smuzhiyun * here are 0-2 unexpected busy states per block read.
119*4882a593Smuzhiyun */
120*4882a593Smuzhiyun if (fun->wait_flags & FSL_UPM_WAIT_RUN_PATTERN)
121*4882a593Smuzhiyun fun_wait(fun);
122*4882a593Smuzhiyun }
123*4882a593Smuzhiyun
upm_nand_read_byte(struct mtd_info * mtd)124*4882a593Smuzhiyun static u8 upm_nand_read_byte(struct mtd_info *mtd)
125*4882a593Smuzhiyun {
126*4882a593Smuzhiyun struct nand_chip *chip = mtd_to_nand(mtd);
127*4882a593Smuzhiyun
128*4882a593Smuzhiyun return in_8(chip->IO_ADDR_R);
129*4882a593Smuzhiyun }
130*4882a593Smuzhiyun
upm_nand_write_buf(struct mtd_info * mtd,const u_char * buf,int len)131*4882a593Smuzhiyun static void upm_nand_write_buf(struct mtd_info *mtd, const u_char *buf, int len)
132*4882a593Smuzhiyun {
133*4882a593Smuzhiyun int i;
134*4882a593Smuzhiyun struct nand_chip *chip = mtd_to_nand(mtd);
135*4882a593Smuzhiyun struct fsl_upm_nand *fun = nand_get_controller_data(chip);
136*4882a593Smuzhiyun
137*4882a593Smuzhiyun for (i = 0; i < len; i++) {
138*4882a593Smuzhiyun out_8(chip->IO_ADDR_W, buf[i]);
139*4882a593Smuzhiyun if (fun->wait_flags & FSL_UPM_WAIT_WRITE_BYTE)
140*4882a593Smuzhiyun fun_wait(fun);
141*4882a593Smuzhiyun }
142*4882a593Smuzhiyun
143*4882a593Smuzhiyun if (fun->wait_flags & FSL_UPM_WAIT_WRITE_BUFFER)
144*4882a593Smuzhiyun fun_wait(fun);
145*4882a593Smuzhiyun }
146*4882a593Smuzhiyun
upm_nand_read_buf(struct mtd_info * mtd,u_char * buf,int len)147*4882a593Smuzhiyun static void upm_nand_read_buf(struct mtd_info *mtd, u_char *buf, int len)
148*4882a593Smuzhiyun {
149*4882a593Smuzhiyun int i;
150*4882a593Smuzhiyun struct nand_chip *chip = mtd_to_nand(mtd);
151*4882a593Smuzhiyun
152*4882a593Smuzhiyun for (i = 0; i < len; i++)
153*4882a593Smuzhiyun buf[i] = in_8(chip->IO_ADDR_R);
154*4882a593Smuzhiyun }
155*4882a593Smuzhiyun
nand_dev_ready(struct mtd_info * mtd)156*4882a593Smuzhiyun static int nand_dev_ready(struct mtd_info *mtd)
157*4882a593Smuzhiyun {
158*4882a593Smuzhiyun struct nand_chip *chip = mtd_to_nand(mtd);
159*4882a593Smuzhiyun struct fsl_upm_nand *fun = nand_get_controller_data(chip);
160*4882a593Smuzhiyun
161*4882a593Smuzhiyun return fun->dev_ready(fun->chip_nr);
162*4882a593Smuzhiyun }
163*4882a593Smuzhiyun
fsl_upm_nand_init(struct nand_chip * chip,struct fsl_upm_nand * fun)164*4882a593Smuzhiyun int fsl_upm_nand_init(struct nand_chip *chip, struct fsl_upm_nand *fun)
165*4882a593Smuzhiyun {
166*4882a593Smuzhiyun if (fun->width != 8 && fun->width != 16 && fun->width != 32)
167*4882a593Smuzhiyun return -ENOSYS;
168*4882a593Smuzhiyun
169*4882a593Smuzhiyun fun->last_ctrl = NAND_CLE;
170*4882a593Smuzhiyun
171*4882a593Smuzhiyun nand_set_controller_data(chip, fun);
172*4882a593Smuzhiyun chip->chip_delay = fun->chip_delay;
173*4882a593Smuzhiyun chip->ecc.mode = NAND_ECC_SOFT;
174*4882a593Smuzhiyun chip->cmd_ctrl = fun_cmd_ctrl;
175*4882a593Smuzhiyun #if CONFIG_SYS_NAND_MAX_CHIPS > 1
176*4882a593Smuzhiyun chip->select_chip = fun_select_chip;
177*4882a593Smuzhiyun #endif
178*4882a593Smuzhiyun chip->read_byte = upm_nand_read_byte;
179*4882a593Smuzhiyun chip->read_buf = upm_nand_read_buf;
180*4882a593Smuzhiyun chip->write_buf = upm_nand_write_buf;
181*4882a593Smuzhiyun if (fun->dev_ready)
182*4882a593Smuzhiyun chip->dev_ready = nand_dev_ready;
183*4882a593Smuzhiyun
184*4882a593Smuzhiyun return 0;
185*4882a593Smuzhiyun }
186