drivers/mtd/nand/ndfc.c

   1 /*
   2  * Overview:
   3  *   Platform independend driver for NDFC (NanD Flash Controller)
   4  *   integrated into IBM/AMCC PPC4xx cores
   5  *
   6  * (C) Copyright 2006-2009
   7  * Stefan Roese, DENX Software Engineering, sr@denx.de.
   8  *
   9  * Based on original work by
  10  *      Thomas Gleixner
  11  *      Copyright 2006 IBM
  12  *
  13  * See file CREDITS for list of people who contributed to this
  14  * project.
  15  *
  16  * This program is free software; you can redistribute it and/or
  17  * modify it under the terms of the GNU General Public License as
  18  * published by the Free Software Foundation; either version 2 of
  19  * the License, or (at your option) any later version.
  20  *
  21  * This program is distributed in the hope that it will be useful,
  22  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  23  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  24  * GNU General Public License for more details.
  25  *
  26  * You should have received a copy of the GNU General Public License
  27  * along with this program; if not, write to the Free Software
  28  * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
  29  * MA 02111-1307 USA
  30  */
  31
  32 #include <common.h>
  33 #include <nand.h>
  34 #include <linux/mtd/ndfc.h>
  35 #include <linux/mtd/nand_ecc.h>
  36 #include <asm/processor.h>
  37 #include <asm/io.h>
  38 #include <asm/ppc4xx.h>
  39
  40 #ifndef CONFIG_SYS_NAND_BCR
  41 #define CONFIG_SYS_NAND_BCR 0x80002222
  42 #endif
  43 #ifndef CONFIG_SYS_NDFC_EBC0_CFG
  44 #define CONFIG_SYS_NDFC_EBC0_CFG 0xb8400000
  45 #endif
  46
  47 /*
  48  * We need to store the info, which chip-select (CS) is used for the
  49  * chip number. For example on Sequoia NAND chip #0 uses
  50  * CS #3.
  51  */
  52 static int ndfc_cs[NDFC_MAX_BANKS];
  53
  54 static void ndfc_hwcontrol(struct mtd_info *mtd, int cmd, unsigned int ctrl)
  55 {
  56         struct nand_chip *this = mtd->priv;
  57         ulong base = (ulong) this->IO_ADDR_W & 0xffffff00;
  58
  59         if (cmd == NAND_CMD_NONE)
  60                 return;
  61
  62         if (ctrl & NAND_CLE)
  63                 out_8((u8 *)(base + NDFC_CMD), cmd & 0xFF);
  64         else
  65                 out_8((u8 *)(base + NDFC_ALE), cmd & 0xFF);
  66 }
  67
  68 static int ndfc_dev_ready(struct mtd_info *mtdinfo)
  69 {
  70         struct nand_chip *this = mtdinfo->priv;
  71         ulong base = (ulong) this->IO_ADDR_W & 0xffffff00;
  72
  73         return (in_be32((u32 *)(base + NDFC_STAT)) & NDFC_STAT_IS_READY);
  74 }
  75
  76 static void ndfc_enable_hwecc(struct mtd_info *mtdinfo, int mode)
  77 {
  78         struct nand_chip *this = mtdinfo->priv;
  79         ulong base = (ulong) this->IO_ADDR_W & 0xffffff00;
  80         u32 ccr;
  81
  82         ccr = in_be32((u32 *)(base + NDFC_CCR));
  83         ccr |= NDFC_CCR_RESET_ECC;
  84         out_be32((u32 *)(base + NDFC_CCR), ccr);
  85 }
  86
  87 static int ndfc_calculate_ecc(struct mtd_info *mtdinfo,
  88                               const u_char *dat, u_char *ecc_code)
  89 {
  90         struct nand_chip *this = mtdinfo->priv;
  91         ulong base = (ulong) this->IO_ADDR_W & 0xffffff00;
  92         u32 ecc;
  93         u8 *p = (u8 *)&ecc;
  94
  95         ecc = in_be32((u32 *)(base + NDFC_ECC));
  96
  97         /* The NDFC uses Smart Media (SMC) bytes order
  98          */
  99         ecc_code[0] = p[1];
 100         ecc_code[1] = p[2];
 101         ecc_code[2] = p[3];
 102
 103         return 0;
 104 }
 105
 106 /*
 107  * Speedups for buffer read/write/verify
 108  *
 109  * NDFC allows 32bit read/write of data. So we can speed up the buffer
 110  * functions. No further checking, as nand_base will always read/write
 111  * page aligned.
 112  */
 113 static void ndfc_read_buf(struct mtd_info *mtdinfo, uint8_t *buf, int len)
 114 {
 115         struct nand_chip *this = mtdinfo->priv;
 116         ulong base = (ulong) this->IO_ADDR_W & 0xffffff00;
 117         uint32_t *p = (uint32_t *) buf;
 118
 119         for (;len > 0; len -= 4)
 120                 *p++ = in_be32((u32 *)(base + NDFC_DATA));
 121 }
 122
 123 #ifndef CONFIG_NAND_SPL
 124 /*
 125  * Don't use these speedup functions in NAND boot image, since the image
 126  * has to fit into 4kByte.
 127  */
 128 static void ndfc_write_buf(struct mtd_info *mtdinfo, const uint8_t *buf, int len)
 129 {
 130         struct nand_chip *this = mtdinfo->priv;
 131         ulong base = (ulong) this->IO_ADDR_W & 0xffffff00;
 132         uint32_t *p = (uint32_t *) buf;
 133
 134         for (; len > 0; len -= 4)
 135                 out_be32((u32 *)(base + NDFC_DATA), *p++);
 136 }
 137
 138 static int ndfc_verify_buf(struct mtd_info *mtdinfo, const uint8_t *buf, int len)
 139 {
 140         struct nand_chip *this = mtdinfo->priv;
 141         ulong base = (ulong) this->IO_ADDR_W & 0xffffff00;
 142         uint32_t *p = (uint32_t *) buf;
 143
 144         for (; len > 0; len -= 4)
 145                 if (*p++ != in_be32((u32 *)(base + NDFC_DATA)))
 146                         return -1;
 147
 148         return 0;
 149 }
 150
 151 /*
 152  * Read a byte from the NDFC.
 153  */
 154 static uint8_t ndfc_read_byte(struct mtd_info *mtd)
 155 {
 156
 157         struct nand_chip *chip = mtd->priv;
 158
 159 #ifdef CONFIG_SYS_NAND_BUSWIDTH_16BIT
 160         return (uint8_t) readw(chip->IO_ADDR_R);
 161 #else
 162         return readb(chip->IO_ADDR_R);
 163 #endif
 164
 165 }
 166
 167 #endif /* #ifndef CONFIG_NAND_SPL */
 168
 169 void board_nand_select_device(struct nand_chip *nand, int chip)
 170 {
 171         /*
 172          * Don't use "chip" to address the NAND device,
 173          * generate the cs from the address where it is encoded.
 174          */
 175         ulong base = (ulong)nand->IO_ADDR_W & 0xffffff00;
 176         int cs = ndfc_cs[chip];
 177
 178         /* Set NandFlash Core Configuration Register */
 179         /* 1 col x 2 rows */
 180         out_be32((u32 *)(base + NDFC_CCR), 0x00000000 | (cs << 24));
 181         out_be32((u32 *)(base + NDFC_BCFG0 + (cs << 2)), CONFIG_SYS_NAND_BCR);
 182 }
 183
 184 static void ndfc_select_chip(struct mtd_info *mtd, int chip)
 185 {
 186         /*
 187          * Nothing to do here!
 188          */
 189 }
 190
 191 int board_nand_init(struct nand_chip *nand)
 192 {
 193         int cs = (ulong)nand->IO_ADDR_W & 0x00000003;
 194         ulong base = (ulong)nand->IO_ADDR_W & 0xffffff00;
 195         static int chip = 0;
 196
 197         /*
 198          * Save chip-select for this chip #
 199          */
 200         ndfc_cs[chip] = cs;
 201
 202         /*
 203          * Select required NAND chip in NDFC
 204          */
 205         board_nand_select_device(nand, chip);
 206
 207         nand->IO_ADDR_R = (void __iomem *)(base + NDFC_DATA);
 208         nand->IO_ADDR_W = (void __iomem *)(base + NDFC_DATA);
 209         nand->cmd_ctrl = ndfc_hwcontrol;
 210         nand->chip_delay = 50;
 211         nand->read_buf = ndfc_read_buf;
 212         nand->dev_ready = ndfc_dev_ready;
 213         nand->ecc.correct = nand_correct_data;
 214         nand->ecc.hwctl = ndfc_enable_hwecc;
 215         nand->ecc.calculate = ndfc_calculate_ecc;
 216         nand->ecc.mode = NAND_ECC_HW;
 217         nand->ecc.size = 256;
 218         nand->ecc.bytes = 3;
 219         nand->ecc.strength = 1;
 220         nand->select_chip = ndfc_select_chip;
 221
 222 #ifdef CONFIG_SYS_NAND_BUSWIDTH_16BIT
 223         nand->options |= NAND_BUSWIDTH_16;
 224 #endif
 225
 226 #ifndef CONFIG_NAND_SPL
 227         nand->write_buf  = ndfc_write_buf;
 228         nand->verify_buf = ndfc_verify_buf;
 229         nand->read_byte = ndfc_read_byte;
 230
 231         chip++;
 232 #else
 233         /*
 234          * Setup EBC (CS0 only right now)
 235          */
 236         mtebc(EBC0_CFG, CONFIG_SYS_NDFC_EBC0_CFG);
 237
 238         mtebc(PB0CR, CONFIG_SYS_EBC_PB0CR);
 239         mtebc(PB0AP, CONFIG_SYS_EBC_PB0AP);
 240 #endif
 241
 242         return 0;
 243 }