include/fsl_nfc.h

   1 /*
   2  * (c) 2009 Magnus Lilja <lilja.magnus@gmail.com>
   3  *
   4  * See file CREDITS for list of people who contributed to this
   5  * project.
   6  *
   7  * This program is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License as
   9  * published by the Free Software Foundation; either version 2 of
  10  * the License, or (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program; if not, write to the Free Software
  19  * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
  20  * MA 02111-1307 USA
  21  */
  22
  23 #ifndef __FSL_NFC_H
  24 #define __FSL_NFC_H
  25
  26 /*
  27  * Register map and bit definitions for the Freescale NAND Flash Controller
  28  * present in various i.MX devices.
  29  *
  30  * MX31 and MX27 have version 1, which has:
  31  *      4 512-byte main buffers and
  32  *      4 16-byte spare buffers
  33  *      to support up to 2K byte pagesize nand.
  34  *      Reading or writing a 2K page requires 4 FDI/FDO cycles.
  35  *
  36  * MX25 and MX35 have version 1.1, which has:
  37  *      8 512-byte main buffers and
  38  *      8 64-byte spare buffers
  39  *      to support up to 4K byte pagesize nand.
  40  *      Reading or writing a 2K or 4K page requires only 1 FDI/FDO cycle.
  41  *      Also some of registers are moved and/or changed meaning as seen below.
  42  */
  43 #if defined(CONFIG_MX27) || defined(CONFIG_MX31)
  44 #define MXC_NFC_V1
  45 #elif defined(CONFIG_MX25) || defined(CONFIG_MX35)
  46 #define MXC_NFC_V1_1
  47 #else
  48 #warning "MXC NFC version not defined"
  49 #endif
  50
  51 #if defined(MXC_NFC_V1)
  52 #define NAND_MXC_NR_BUFS                4
  53 #define NAND_MXC_SPARE_BUF_SIZE         16
  54 #define NAND_MXC_REG_OFFSET             0xe00
  55 #define NAND_MXC_2K_MULTI_CYCLE
  56 #define is_mxc_nfc_11()                 0
  57 #elif defined(MXC_NFC_V1_1)
  58 #define NAND_MXC_NR_BUFS                8
  59 #define NAND_MXC_SPARE_BUF_SIZE         64
  60 #define NAND_MXC_REG_OFFSET             0x1e00
  61 #define is_mxc_nfc_11()                 1
  62 #else
  63 #error "define CONFIG_NAND_MXC_VXXX to use the mxc nand driver"
  64 #endif
  65
  66 struct fsl_nfc_regs {
  67         u8 main_area[NAND_MXC_NR_BUFS][0x200];
  68         u8 spare_area[NAND_MXC_NR_BUFS][NAND_MXC_SPARE_BUF_SIZE];
  69         /*
  70          * reserved size is offset of nfc registers
  71          * minus total main and spare sizes
  72          */
  73         u8 reserved1[NAND_MXC_REG_OFFSET
  74                 - NAND_MXC_NR_BUFS * (512 + NAND_MXC_SPARE_BUF_SIZE)];
  75 #if defined(MXC_NFC_V1)
  76         u16 buf_size;
  77         u16 reserved2;
  78         u16 buf_addr;
  79         u16 flash_addr;
  80         u16 flash_cmd;
  81         u16 config;
  82         u16 ecc_status_result;
  83         u16 rsltmain_area;
  84         u16 rsltspare_area;
  85         u16 wrprot;
  86         u16 unlockstart_blkaddr;
  87         u16 unlockend_blkaddr;
  88         u16 nf_wrprst;
  89         u16 config1;
  90         u16 config2;
  91 #elif defined(MXC_NFC_V1_1)
  92         u16 reserved2[2];
  93         u16 buf_addr;
  94         u16 flash_addr;
  95         u16 flash_cmd;
  96         u16 config;
  97         u16 ecc_status_result;
  98         u16 ecc_status_result2;
  99         u16 spare_area_size;
 100         u16 wrprot;
 101         u16 reserved3[2];
 102         u16 nf_wrprst;
 103         u16 config1;
 104         u16 config2;
 105         u16 reserved4;
 106         u16 unlockstart_blkaddr;
 107         u16 unlockend_blkaddr;
 108         u16 unlockstart_blkaddr1;
 109         u16 unlockend_blkaddr1;
 110         u16 unlockstart_blkaddr2;
 111         u16 unlockend_blkaddr2;
 112         u16 unlockstart_blkaddr3;
 113         u16 unlockend_blkaddr3;
 114 #endif
 115 };
 116
 117 /*
 118  * Set INT to 0, FCMD to 1, rest to 0 in NFC_CONFIG2 Register for Command
 119  * operation
 120  */
 121 #define NFC_CMD         0x1
 122
 123 /*
 124  * Set INT to 0, FADD to 1, rest to 0 in NFC_CONFIG2 Register for Address
 125  * operation
 126  */
 127 #define NFC_ADDR        0x2
 128
 129 /*
 130  * Set INT to 0, FDI to 1, rest to 0 in NFC_CONFIG2 Register for Input
 131  * operation
 132  */
 133 #define NFC_INPUT       0x4
 134
 135 /*
 136  * Set INT to 0, FDO to 001, rest to 0 in NFC_CONFIG2 Register for Data
 137  * Output operation
 138  */
 139 #define NFC_OUTPUT      0x8
 140
 141 /*
 142  * Set INT to 0, FD0 to 010, rest to 0 in NFC_CONFIG2 Register for Read ID
 143  * operation
 144  */
 145 #define NFC_ID          0x10
 146
 147 /*
 148  * Set INT to 0, FDO to 100, rest to 0 in NFC_CONFIG2 Register for Read
 149  * Status operation
 150  */
 151 #define NFC_STATUS      0x20
 152
 153 /*
 154  * Set INT to 1, rest to 0 in NFC_CONFIG2 Register for Read Status
 155  * operation
 156  */
 157 #define NFC_INT         0x8000
 158
 159 #ifdef MXC_NFC_V1_1
 160 #define NFC_4_8N_ECC    (1 << 0)
 161 #endif
 162 #define NFC_SP_EN       (1 << 2)
 163 #define NFC_ECC_EN      (1 << 3)
 164 #define NFC_INT_MSK     (1 << 4)
 165 #define NFC_BIG         (1 << 5)
 166 #define NFC_RST         (1 << 6)
 167 #define NFC_CE          (1 << 7)
 168 #define NFC_ONE_CYCLE   (1 << 8)
 169 #define NFC_FP_INT      (1 << 11)
 170
 171 #endif /* __FSL_NFC_H */