Added board type as a parameter to mx2 NFC as they have different base addresses.
[fw/openocd] / src / flash / nand / mx2.h
1
2 /***************************************************************************
3  *   Copyright (C) 2009 by Alexei Babich                                   *
4  *   Rezonans plc., Chelyabinsk, Russia                                    *
5  *   impatt@mail.ru                                                        *
6  *                                                                         *
7  *   This program is free software; you can redistribute it and/or modify  *
8  *   it under the terms of the GNU General Public License as published by  *
9  *   the Free Software Foundation; either version 2 of the License, or     *
10  *   (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                         *
19  *   Free Software Foundation, Inc.,                                       *
20  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
21  ***************************************************************************/
22
23 /*
24  * Freescale iMX OpenOCD NAND Flash controller support.
25  * based on Freescale iMX2* and iMX3* OpenOCD NAND Flash controller support.
26  *
27  * Many thanks to Ben Dooks for writing s3c24xx driver.
28  */
29
30 #define         MXC_NF_BUFSIZ                           (mxc_nf_info->mxc_base_addr + 0xe00)
31 #define         MXC_NF_BUFADDR                          (mxc_nf_info->mxc_base_addr + 0xe04)
32 #define         MXC_NF_FADDR                            (mxc_nf_info->mxc_base_addr + 0xe06)
33 #define         MXC_NF_FCMD                                     (mxc_nf_info->mxc_base_addr + 0xe08)
34 #define         MXC_NF_BUFCFG                           (mxc_nf_info->mxc_base_addr + 0xe0a)
35 #define         MXC_NF_ECCSTATUS                        (mxc_nf_info->mxc_base_addr + 0xe0c)
36 #define         MXC_NF_ECCMAINPOS                       (mxc_nf_info->mxc_base_addr + 0xe0e)
37 #define         MXC_NF_ECCSPAREPOS                      (mxc_nf_info->mxc_base_addr + 0xe10)
38 #define         MXC_NF_FWP                                      (mxc_nf_info->mxc_base_addr + 0xe12)
39 #define         MXC_NF_LOCKSTART                        (mxc_nf_info->mxc_base_addr + 0xe14)
40 #define         MXC_NF_LOCKEND                          (mxc_nf_info->mxc_base_addr + 0xe16)
41 #define         MXC_NF_FWPSTATUS                        (mxc_nf_info->mxc_base_addr + 0xe18)
42  /*
43   * all bits not marked as self-clearing bit
44   */
45 #define         MXC_NF_CFG1                                     (mxc_nf_info->mxc_base_addr + 0xe1a)
46 #define         MXC_NF_CFG2                                     (mxc_nf_info->mxc_base_addr + 0xe1c)
47
48 #define         MXC_NF_MAIN_BUFFER0                     (mxc_nf_info->mxc_base_addr + 0x0000)
49 #define         MXC_NF_MAIN_BUFFER1                     (mxc_nf_info->mxc_base_addr + 0x0200)
50 #define         MXC_NF_MAIN_BUFFER2                     (mxc_nf_info->mxc_base_addr + 0x0400)
51 #define         MXC_NF_MAIN_BUFFER3                     (mxc_nf_info->mxc_base_addr + 0x0600)
52 #define         MXC_NF_SPARE_BUFFER0            (mxc_nf_info->mxc_base_addr + 0x0800)
53 #define         MXC_NF_SPARE_BUFFER1            (mxc_nf_info->mxc_base_addr + 0x0810)
54 #define         MXC_NF_SPARE_BUFFER2            (mxc_nf_info->mxc_base_addr + 0x0820)
55 #define         MXC_NF_SPARE_BUFFER3            (mxc_nf_info->mxc_base_addr + 0x0830)
56 #define         MXC_NF_MAIN_BUFFER_LEN          512
57 #define         MXC_NF_SPARE_BUFFER_LEN         16
58 #define         MXC_NF_LAST_BUFFER_ADDR         ((MXC_NF_SPARE_BUFFER3) + \
59         MXC_NF_SPARE_BUFFER_LEN - 2)
60
61 /* bits in MXC_NF_CFG1 register */
62 #define         MXC_NF_BIT_SPARE_ONLY_EN        (1<<2)
63 #define         MXC_NF_BIT_ECC_EN                       (1<<3)
64 #define         MXC_NF_BIT_INT_DIS                      (1<<4)
65 #define         MXC_NF_BIT_BE_EN                        (1<<5)
66 #define         MXC_NF_BIT_RESET_EN                     (1<<6)
67 #define         MXC_NF_BIT_FORCE_CE                     (1<<7)
68
69 /* bits in MXC_NF_CFG2 register */
70
71 /*Flash Command Input*/
72 #define         MXC_NF_BIT_OP_FCI                       (1<<0)
73  /*
74   * Flash Address Input
75   */
76 #define         MXC_NF_BIT_OP_FAI                       (1<<1)
77  /*
78   * Flash Data Input
79   */
80 #define         MXC_NF_BIT_OP_FDI                       (1<<2)
81
82 /* see "enum mx_dataout_type" below */
83 #define         MXC_NF_BIT_DATAOUT_TYPE(x)      ((x)<<3)
84 #define         MXC_NF_BIT_OP_DONE                      (1<<15)
85
86 #define         MXC_CCM_CGR2                            0x53f80028
87 #define         MXC_GPR                                         0x43fac008
88 /*#define               MXC_PCSR                                        0x53f8000c*/
89 #define         MXC_FMCR                                        0x10027814
90 #define         MXC_FMCR_NF_16BIT_SEL           (1<<4)
91 #define         MXC_FMCR_NF_FMS                         (1<<5)
92
93 enum mxc_dataout_type {
94         MXC_NF_DATAOUT_PAGE = 1,
95         MXC_NF_DATAOUT_NANDID = 2,
96         MXC_NF_DATAOUT_NANDSTATUS = 4,
97 };
98
99 enum mxc_nf_finalize_action {
100         MXC_NF_FIN_NONE,
101         MXC_NF_FIN_DATAOUT,
102 };
103
104 struct mxc_nf_flags {
105         unsigned host_little_endian:1;
106         unsigned target_little_endian:1;
107         unsigned nand_readonly:1;
108         unsigned one_kb_sram:1;
109         unsigned hw_ecc_enabled:1;
110 };
111
112 struct mxc_nf_controller {
113         uint32_t mxc_base_addr;
114         enum mxc_dataout_type optype;
115         enum mxc_nf_finalize_action fin;
116         struct mxc_nf_flags flags;
117 };