1f3529a7f152674f6b7de8cc81b6c4646f714f1f
[fw/openocd] / src / flash / mx3_nand.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 iMX3* OpenOCD NAND Flash controller support.
25  *
26  * Many thanks to Ben Dooks for writing s3c24xx driver.
27  */
28 #include <nand.h>
29
30 #define         MX3_NF_BASE_ADDR                0xb8000000
31 #define         MX3_NF_BUFSIZ                   (MX3_NF_BASE_ADDR + 0xe00)
32 #define         MX3_NF_BUFADDR                  (MX3_NF_BASE_ADDR + 0xe04)
33 #define         MX3_NF_FADDR                    (MX3_NF_BASE_ADDR + 0xe06)
34 #define         MX3_NF_FCMD                             (MX3_NF_BASE_ADDR + 0xe08)
35 #define         MX3_NF_BUFCFG                   (MX3_NF_BASE_ADDR + 0xe0a)
36 #define         MX3_NF_ECCSTATUS                        (MX3_NF_BASE_ADDR + 0xe0c)
37 #define         MX3_NF_ECCMAINPOS                       (MX3_NF_BASE_ADDR + 0xe0e)
38 #define         MX3_NF_ECCSPAREPOS                      (MX3_NF_BASE_ADDR + 0xe10)
39 #define         MX3_NF_FWP                      (MX3_NF_BASE_ADDR + 0xe12)
40 #define         MX3_NF_LOCKSTART                        (MX3_NF_BASE_ADDR + 0xe14)
41 #define         MX3_NF_LOCKEND                  (MX3_NF_BASE_ADDR + 0xe16)
42 #define         MX3_NF_FWPSTATUS                        (MX3_NF_BASE_ADDR + 0xe18)
43  /*
44   * all bits not marked as self-clearing bit
45   */
46 #define         MX3_NF_CFG1                     (MX3_NF_BASE_ADDR + 0xe1a)
47 #define         MX3_NF_CFG2                     (MX3_NF_BASE_ADDR + 0xe1c)
48
49 #define         MX3_NF_MAIN_BUFFER0             (MX3_NF_BASE_ADDR + 0x0000)
50 #define         MX3_NF_MAIN_BUFFER1             (MX3_NF_BASE_ADDR + 0x0200)
51 #define         MX3_NF_MAIN_BUFFER2             (MX3_NF_BASE_ADDR + 0x0400)
52 #define         MX3_NF_MAIN_BUFFER3             (MX3_NF_BASE_ADDR + 0x0600)
53 #define         MX3_NF_SPARE_BUFFER0    (MX3_NF_BASE_ADDR + 0x0800)
54 #define         MX3_NF_SPARE_BUFFER1    (MX3_NF_BASE_ADDR + 0x0810)
55 #define         MX3_NF_SPARE_BUFFER2    (MX3_NF_BASE_ADDR + 0x0820)
56 #define         MX3_NF_SPARE_BUFFER3    (MX3_NF_BASE_ADDR + 0x0830)
57 #define         MX3_NF_MAIN_BUFFER_LEN  512
58 #define         MX3_NF_SPARE_BUFFER_LEN 16
59 #define         MX3_NF_LAST_BUFFER_ADDR ((MX3_NF_SPARE_BUFFER3) + MX3_NF_SPARE_BUFFER_LEN - 2)
60
61 /* bits in MX3_NF_CFG1 register */
62 #define         MX3_NF_BIT_SPARE_ONLY_EN        (1<<2)
63 #define         MX3_NF_BIT_ECC_EN                       (1<<3)
64 #define         MX3_NF_BIT_INT_DIS                      (1<<4)
65 #define         MX3_NF_BIT_BE_EN                        (1<<5)
66 #define         MX3_NF_BIT_RESET_EN                     (1<<6)
67 #define         MX3_NF_BIT_FORCE_CE                     (1<<7)
68
69 /* bits in MX3_NF_CFG2 register */
70
71 /*Flash Command Input*/
72 #define         MX3_NF_BIT_OP_FCI                       (1<<0)
73  /*
74   * Flash Address Input
75   */
76 #define         MX3_NF_BIT_OP_FAI                       (1<<1)
77  /*
78   * Flash Data Input
79   */
80 #define         MX3_NF_BIT_OP_FDI                       (1<<2)
81
82 /* see "enum mx_dataout_type" below */
83 #define         MX3_NF_BIT_DATAOUT_TYPE(x)      ((x)<<3)
84 #define         MX3_NF_BIT_OP_DONE                      (1<<15)
85
86 #define         MX3_CCM_CGR2            0x53f80028
87 #define         MX3_GPR                         0x43fac008
88 #define         MX3_PCSR                        0x53f8000c
89
90 enum mx_dataout_type
91 {
92         MX3_NF_DATAOUT_PAGE = 1,
93         MX3_NF_DATAOUT_NANDID = 2,
94         MX3_NF_DATAOUT_NANDSTATUS = 4,
95 };
96 enum mx_nf_finalize_action
97 {
98         MX3_NF_FIN_NONE,
99         MX3_NF_FIN_DATAOUT,
100 };
101
102 struct mx3_nf_flags
103 {
104         unsigned host_little_endian:1;
105         unsigned target_little_endian:1;
106         unsigned nand_readonly:1;
107         unsigned one_kb_sram:1;
108         unsigned hw_ecc_enabled:1;
109 };
110
111 struct mx3_nf_controller
112 {
113         struct target_s *target;
114         enum mx_dataout_type optype;
115         enum mx_nf_finalize_action fin;
116         struct mx3_nf_flags flags;
117 };