Remove FSF address from GPL notices
[fw/openocd] / src / flash / nand / mx3.h
1 /***************************************************************************
2  *   Copyright (C) 2009 by Alexei Babich                                   *
3  *   Rezonans plc., Chelyabinsk, Russia                                    *
4  *   impatt@mail.ru                                                        *
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; either version 2 of the License, or     *
9  *   (at your option) any later version.                                   *
10  *                                                                         *
11  *   This program is distributed in the hope that it will be useful,       *
12  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
13  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
14  *   GNU General Public License for more details.                          *
15  *                                                                         *
16  *   You should have received a copy of the GNU General Public License     *
17  *   along with this program.  If not, see <http://www.gnu.org/licenses/>. *
18  ***************************************************************************/
19
20 /*
21  * Freescale iMX3* OpenOCD NAND Flash controller support.
22  *
23  * Many thanks to Ben Dooks for writing s3c24xx driver.
24  */
25
26 #define MX3_NF_BASE_ADDR                                0xb8000000
27 #define MX3_NF_BUFSIZ                                   (MX3_NF_BASE_ADDR + 0xe00)
28 #define MX3_NF_BUFADDR                                  (MX3_NF_BASE_ADDR + 0xe04)
29 #define MX3_NF_FADDR                                    (MX3_NF_BASE_ADDR + 0xe06)
30 #define MX3_NF_FCMD                                             (MX3_NF_BASE_ADDR + 0xe08)
31 #define MX3_NF_BUFCFG                                   (MX3_NF_BASE_ADDR + 0xe0a)
32 #define MX3_NF_ECCSTATUS                                (MX3_NF_BASE_ADDR + 0xe0c)
33 #define MX3_NF_ECCMAINPOS                               (MX3_NF_BASE_ADDR + 0xe0e)
34 #define MX3_NF_ECCSPAREPOS                              (MX3_NF_BASE_ADDR + 0xe10)
35 #define MX3_NF_FWP                                              (MX3_NF_BASE_ADDR + 0xe12)
36 #define MX3_NF_LOCKSTART                                (MX3_NF_BASE_ADDR + 0xe14)
37 #define MX3_NF_LOCKEND                                  (MX3_NF_BASE_ADDR + 0xe16)
38 #define MX3_NF_FWPSTATUS                                (MX3_NF_BASE_ADDR + 0xe18)
39 /*
40  * all bits not marked as self-clearing bit
41  */
42 #define MX3_NF_CFG1                                             (MX3_NF_BASE_ADDR + 0xe1a)
43 #define MX3_NF_CFG2                                             (MX3_NF_BASE_ADDR + 0xe1c)
44
45 #define MX3_NF_MAIN_BUFFER0                             (MX3_NF_BASE_ADDR + 0x0000)
46 #define MX3_NF_MAIN_BUFFER1                             (MX3_NF_BASE_ADDR + 0x0200)
47 #define MX3_NF_MAIN_BUFFER2                             (MX3_NF_BASE_ADDR + 0x0400)
48 #define MX3_NF_MAIN_BUFFER3                             (MX3_NF_BASE_ADDR + 0x0600)
49 #define MX3_NF_SPARE_BUFFER0                    (MX3_NF_BASE_ADDR + 0x0800)
50 #define MX3_NF_SPARE_BUFFER1                    (MX3_NF_BASE_ADDR + 0x0810)
51 #define MX3_NF_SPARE_BUFFER2                    (MX3_NF_BASE_ADDR + 0x0820)
52 #define MX3_NF_SPARE_BUFFER3                    (MX3_NF_BASE_ADDR + 0x0830)
53 #define MX3_NF_MAIN_BUFFER_LEN                  512
54 #define MX3_NF_SPARE_BUFFER_LEN                 16
55 #define MX3_NF_LAST_BUFFER_ADDR                 ((MX3_NF_SPARE_BUFFER3) + MX3_NF_SPARE_BUFFER_LEN - 2)
56
57 /* bits in MX3_NF_CFG1 register */
58 #define MX3_NF_BIT_SPARE_ONLY_EN                (1<<2)
59 #define MX3_NF_BIT_ECC_EN                               (1<<3)
60 #define MX3_NF_BIT_INT_DIS                              (1<<4)
61 #define MX3_NF_BIT_BE_EN                                (1<<5)
62 #define MX3_NF_BIT_RESET_EN                             (1<<6)
63 #define MX3_NF_BIT_FORCE_CE                             (1<<7)
64
65 /* bits in MX3_NF_CFG2 register */
66
67 /*Flash Command Input*/
68 #define MX3_NF_BIT_OP_FCI                               (1<<0)
69 /*
70  * Flash Address Input
71  */
72 #define MX3_NF_BIT_OP_FAI                               (1<<1)
73 /*
74  * Flash Data Input
75  */
76 #define MX3_NF_BIT_OP_FDI                               (1<<2)
77
78 /* see "enum mx_dataout_type" below */
79 #define MX3_NF_BIT_DATAOUT_TYPE(x)              ((x)<<3)
80 #define MX3_NF_BIT_OP_DONE                              (1<<15)
81
82 #define MX3_CCM_CGR2                                    0x53f80028
83 #define MX3_GPR                                                 0x43fac008
84 #define MX3_PCSR                                                0x53f8000c
85
86 enum mx_dataout_type {
87         MX3_NF_DATAOUT_PAGE = 1,
88         MX3_NF_DATAOUT_NANDID = 2,
89         MX3_NF_DATAOUT_NANDSTATUS = 4,
90 };
91 enum mx_nf_finalize_action {
92         MX3_NF_FIN_NONE,
93         MX3_NF_FIN_DATAOUT,
94 };
95
96 struct mx3_nf_flags {
97         unsigned target_little_endian:1;
98         unsigned nand_readonly:1;
99         unsigned one_kb_sram:1;
100         unsigned hw_ecc_enabled:1;
101 };
102
103 struct mx3_nf_controller {
104         enum mx_dataout_type optype;
105         enum mx_nf_finalize_action fin;
106         struct mx3_nf_flags flags;
107 };