include/linux/mtd/sh_flctl.h

   1 /*
   2  * SuperH FLCTL nand controller
   3  *
   4  * Copyright © 2008 Renesas Solutions Corp.
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; version 2 of the License.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  18  */
  19
  20 #ifndef __SH_FLCTL_H__
  21 #define __SH_FLCTL_H__
  22
  23 #include <linux/mtd/mtd.h>
  24 #include <linux/mtd/nand.h>
  25 #include <linux/mtd/partitions.h>
  26
  27 /* FLCTL registers */
  28 #define FLCMNCR(f)              (f->reg + 0x0)
  29 #define FLCMDCR(f)              (f->reg + 0x4)
  30 #define FLCMCDR(f)              (f->reg + 0x8)
  31 #define FLADR(f)                (f->reg + 0xC)
  32 #define FLADR2(f)               (f->reg + 0x3C)
  33 #define FLDATAR(f)              (f->reg + 0x10)
  34 #define FLDTCNTR(f)             (f->reg + 0x14)
  35 #define FLINTDMACR(f)           (f->reg + 0x18)
  36 #define FLBSYTMR(f)             (f->reg + 0x1C)
  37 #define FLBSYCNT(f)             (f->reg + 0x20)
  38 #define FLDTFIFO(f)             (f->reg + 0x24)
  39 #define FLECFIFO(f)             (f->reg + 0x28)
  40 #define FLTRCR(f)               (f->reg + 0x2C)
  41 #define FL4ECCRESULT0(f)        (f->reg + 0x80)
  42 #define FL4ECCRESULT1(f)        (f->reg + 0x84)
  43 #define FL4ECCRESULT2(f)        (f->reg + 0x88)
  44 #define FL4ECCRESULT3(f)        (f->reg + 0x8C)
  45 #define FL4ECCCR(f)             (f->reg + 0x90)
  46 #define FL4ECCCNT(f)            (f->reg + 0x94)
  47 #define FLERRADR(f)             (f->reg + 0x98)
  48
  49 /* FLCMNCR control bits */
  50 #define ECCPOS2         (0x1 << 25)
  51 #define _4ECCCNTEN      (0x1 << 24)
  52 #define _4ECCEN         (0x1 << 23)
  53 #define _4ECCCORRECT    (0x1 << 22)
  54 #define SHBUSSEL        (0x1 << 20)
  55 #define SEL_16BIT       (0x1 << 19)
  56 #define SNAND_E         (0x1 << 18)     /* SNAND (0=512 1=2048)*/
  57 #define QTSEL_E         (0x1 << 17)
  58 #define ENDIAN          (0x1 << 16)     /* 1 = little endian */
  59 #define FCKSEL_E        (0x1 << 15)
  60 #define ECCPOS_00       (0x00 << 12)
  61 #define ECCPOS_01       (0x01 << 12)
  62 #define ECCPOS_02       (0x02 << 12)
  63 #define ACM_SACCES_MODE (0x01 << 10)
  64 #define NANWF_E         (0x1 << 9)
  65 #define SE_D            (0x1 << 8)      /* Spare area disable */
  66 #define CE1_ENABLE      (0x1 << 4)      /* Chip Enable 1 */
  67 #define CE0_ENABLE      (0x1 << 3)      /* Chip Enable 0 */
  68 #define TYPESEL_SET     (0x1 << 0)
  69
  70 /*
  71  * Clock settings using the PULSEx registers from FLCMNCR
  72  *
  73  * Some hardware uses bits called PULSEx instead of FCKSEL_E and QTSEL_E
  74  * to control the clock divider used between the High-Speed Peripheral Clock
  75  * and the FLCTL internal clock. If so, use CLK_8_BIT_xxx for connecting 8 bit
  76  * and CLK_16_BIT_xxx for connecting 16 bit bus bandwith NAND chips. For the 16
  77  * bit version the divider is seperate for the pulse width of high and low
  78  * signals.
  79  */
  80 #define PULSE3  (0x1 << 27)
  81 #define PULSE2  (0x1 << 17)
  82 #define PULSE1  (0x1 << 15)
  83 #define PULSE0  (0x1 << 9)
  84 #define CLK_8B_0_5                      PULSE1
  85 #define CLK_8B_1                        0x0
  86 #define CLK_8B_1_5                      (PULSE1 | PULSE2)
  87 #define CLK_8B_2                        PULSE0
  88 #define CLK_8B_3                        (PULSE0 | PULSE1 | PULSE2)
  89 #define CLK_8B_4                        (PULSE0 | PULSE2)
  90 #define CLK_16B_6L_2H                   PULSE0
  91 #define CLK_16B_9L_3H                   (PULSE0 | PULSE1 | PULSE2)
  92 #define CLK_16B_12L_4H                  (PULSE0 | PULSE2)
  93
  94 /* FLCMDCR control bits */
  95 #define ADRCNT2_E       (0x1 << 31)     /* 5byte address enable */
  96 #define ADRMD_E         (0x1 << 26)     /* Sector address access */
  97 #define CDSRC_E         (0x1 << 25)     /* Data buffer selection */
  98 #define DOSR_E          (0x1 << 24)     /* Status read check */
  99 #define SELRW           (0x1 << 21)     /*  0:read 1:write */
 100 #define DOADR_E         (0x1 << 20)     /* Address stage execute */
 101 #define ADRCNT_1        (0x00 << 18)    /* Address data bytes: 1byte */
 102 #define ADRCNT_2        (0x01 << 18)    /* Address data bytes: 2byte */
 103 #define ADRCNT_3        (0x02 << 18)    /* Address data bytes: 3byte */
 104 #define ADRCNT_4        (0x03 << 18)    /* Address data bytes: 4byte */
 105 #define DOCMD2_E        (0x1 << 17)     /* 2nd cmd stage execute */
 106 #define DOCMD1_E        (0x1 << 16)     /* 1st cmd stage execute */
 107
 108 /* FLTRCR control bits */
 109 #define TRSTRT          (0x1 << 0)      /* translation start */
 110 #define TREND           (0x1 << 1)      /* translation end */
 111
 112 /* FL4ECCCR control bits */
 113 #define _4ECCFA         (0x1 << 2)      /* 4 symbols correct fault */
 114 #define _4ECCEND        (0x1 << 1)      /* 4 symbols end */
 115 #define _4ECCEXST       (0x1 << 0)      /* 4 symbols exist */
 116
 117 #define INIT_FL4ECCRESULT_VAL   0x03FF03FF
 118 #define LOOP_TIMEOUT_MAX        0x00010000
 119
 120 struct sh_flctl {
 121         struct mtd_info         mtd;
 122         struct nand_chip        chip;
 123         struct platform_device  *pdev;
 124         void __iomem            *reg;
 125
 126         uint8_t done_buff[2048 + 64];   /* max size 2048 + 64 */
 127         int     read_bytes;
 128         int     index;
 129         int     seqin_column;           /* column in SEQIN cmd */
 130         int     seqin_page_addr;        /* page_addr in SEQIN cmd */
 131         uint32_t seqin_read_cmd;                /* read cmd in SEQIN cmd */
 132         int     erase1_page_addr;       /* page_addr in ERASE1 cmd */
 133         uint32_t erase_ADRCNT;          /* bits of FLCMDCR in ERASE1 cmd */
 134         uint32_t rw_ADRCNT;     /* bits of FLCMDCR in READ WRITE cmd */
 135         uint32_t flcmncr_base;  /* base value of FLCMNCR */
 136
 137         int     hwecc_cant_correct[4];
 138
 139         unsigned page_size:1;   /* NAND page size (0 = 512, 1 = 2048) */
 140         unsigned hwecc:1;       /* Hardware ECC (0 = disabled, 1 = enabled) */
 141 };
 142
 143 struct sh_flctl_platform_data {
 144         struct mtd_partition    *parts;
 145         int                     nr_parts;
 146         unsigned long           flcmncr_val;
 147
 148         unsigned has_hwecc:1;
 149 };
 150
 151 static inline struct sh_flctl *mtd_to_flctl(struct mtd_info *mtdinfo)
 152 {
 153         return container_of(mtdinfo, struct sh_flctl, mtd);
 154 }
 155
 156 #endif  /* __SH_FLCTL_H__ */