blob: bd8941ea5fc3c2768ee0c2c08b5f30640ce58c1a [file] [log] [blame]
wdenk3a473b22004-01-03 00:43:19 +00001/*
2 * (C) Copyright 2000
3 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4 *
5 * See file CREDITS for list of people who contributed to this
6 * project.
7 *
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License as
10 * published by the Free Software Foundation; either version 2 of
11 * the License, or (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
21 * MA 02111-1307 USA
22 *
23 * Hacked for the marvell db64360 eval board by
24 * Ingo Assmus <ingo.assmus@keymile.com>
25 */
26
27/*************** DEFINES for Intel StrataFlash FLASH chip ********************/
28
29/*
30 * acceptable chips types are:
31 *
32 * 28F320J5, 28F640J5, 28F320J3A, 28F640J3A and 28F128J3A
33 */
34
35/* register addresses, valid only following an CHIP_CMD_RD_ID command */
36#define CHIP_ADDR_REG_MAN 0x000000 /* manufacturer's id */
37#define CHIP_ADDR_REG_DEV 0x000001 /* device id */
38#define CHIP_ADDR_REG_CFGM 0x000003 /* master lock config */
39#define CHIP_ADDR_REG_CFG(b) (((b)<<16)|2) /* lock config for block b */
40
41/* Commands */
42#define CHIP_CMD_RST 0xFF /* reset flash */
43#define CHIP_CMD_RD_ID 0x90 /* read the id and lock bits */
44#define CHIP_CMD_RD_QUERY 0x98 /* read device capabilities */
45#define CHIP_CMD_RD_STAT 0x70 /* read the status register */
46#define CHIP_CMD_CLR_STAT 0x50 /* clear the staus register */
47#define CHIP_CMD_WR_BUF 0xE8 /* clear the staus register */
48#define CHIP_CMD_PROG 0x40 /* program word command */
49#define CHIP_CMD_ERASE1 0x20 /* 1st word for block erase */
50#define CHIP_CMD_ERASE2 0xD0 /* 2nd word for block erase */
51#define CHIP_CMD_ERASE_SUSP 0xB0 /* suspend block erase */
52#define CHIP_CMD_LOCK 0x60 /* 1st word for all lock cmds */
53#define CHIP_CMD_SET_LOCK_BLK 0x01 /* 2nd wrd set block lock bit */
54#define CHIP_CMD_SET_LOCK_MSTR 0xF1 /* 2nd wrd set master lck bit */
55#define CHIP_CMD_CLR_LOCK_BLK 0xD0 /* 2nd wrd clear blk lck bit */
56
57/* status register bits */
58#define CHIP_STAT_DPS 0x02 /* Device Protect Status */
59#define CHIP_STAT_VPPS 0x08 /* VPP Status */
60#define CHIP_STAT_PSLBS 0x10 /* Program+Set Lock Bit Stat */
61#define CHIP_STAT_ECLBS 0x20 /* Erase+Clr Lock Bit Stat */
62#define CHIP_STAT_ESS 0x40 /* Erase Suspend Status */
63#define CHIP_STAT_RDY 0x80 /* WSM Mach Status, 1=rdy */
64
65#define CHIP_STAT_ERR (CHIP_STAT_VPPS | CHIP_STAT_DPS | \
66 CHIP_STAT_ECLBS | CHIP_STAT_PSLBS)
67
68/* ID and Lock Configuration */
69#define CHIP_RD_ID_LOCK 0x01 /* Bit 0 of each byte */
70#define CHIP_RD_ID_MAN 0x89 /* Manufacturer code = 0x89 */
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +020071#define CHIP_RD_ID_DEV CONFIG_SYS_FLASH_ID
wdenk3a473b22004-01-03 00:43:19 +000072
73/* dimensions */
74#define CHIP_WIDTH 2 /* chips are in 16 bit mode */
75#define CHIP_WSHIFT 1 /* (log2 of CHIP_WIDTH) */
76#define CHIP_NBLOCKS 128
77#define CHIP_BLKSZ (128 * 1024) /* of 128Kbytes each */
78#define CHIP_SIZE (CHIP_BLKSZ * CHIP_NBLOCKS)
79
80/********************** DEFINES for Hymod Flash ******************************/
81
82/*
83 * The hymod board has 2 x 28F320J5 chips running in
84 * 16 bit mode, for a 32 bit wide bank.
85 */
86
87typedef unsigned short bank_word_t; /* 8/16/32/64bit unsigned int */
88typedef volatile bank_word_t *bank_addr_t;
89typedef unsigned long bank_size_t; /* want this big - >= 32 bit */
90
91#define BANK_CHIP_WIDTH 1 /* each bank is 1 chip wide */
92#define BANK_CHIP_WSHIFT 0 /* (log2 of BANK_CHIP_WIDTH) */
93
94#define BANK_WIDTH (CHIP_WIDTH * BANK_CHIP_WIDTH)
95#define BANK_WSHIFT (CHIP_WSHIFT + BANK_CHIP_WSHIFT)
96#define BANK_NBLOCKS CHIP_NBLOCKS
97#define BANK_BLKSZ (CHIP_BLKSZ * BANK_CHIP_WIDTH)
98#define BANK_SIZE (CHIP_SIZE * BANK_CHIP_WIDTH)
99
100#define MAX_BANKS 1 /* only one bank possible */
101
102/* align bank addresses and sizes to bank word boundaries */
103#define BANK_ADDR_WORD_ALIGN(a) ((bank_addr_t)((bank_size_t)(a) \
104 & ~(BANK_WIDTH - 1)))
105#define BANK_SIZE_WORD_ALIGN(s) ((bank_size_t)BANK_ADDR_WORD_ALIGN( \
106 (bank_size_t)(s) + (BANK_WIDTH - 1)))
107
108/* align bank addresses and sizes to bank block boundaries */
109#define BANK_ADDR_BLK_ALIGN(a) ((bank_addr_t)((bank_size_t)(a) \
110 & ~(BANK_BLKSZ - 1)))
111#define BANK_SIZE_BLK_ALIGN(s) ((bank_size_t)BANK_ADDR_BLK_ALIGN( \
112 (bank_size_t)(s) + (BANK_BLKSZ - 1)))
113
114/* align bank addresses and sizes to bank boundaries */
115#define BANK_ADDR_BANK_ALIGN(a) ((bank_addr_t)((bank_size_t)(a) \
116 & ~(BANK_SIZE - 1)))
117#define BANK_SIZE_BANK_ALIGN(s) ((bank_size_t)BANK_ADDR_BANK_ALIGN( \
118 (bank_size_t)(s) + (BANK_SIZE - 1)))
119
120/* add an offset to a bank address */
121#define BANK_ADDR_OFFSET(a, o) (bank_addr_t)((bank_size_t)(a) + \
122 (bank_size_t)(o))
123
124/* get base address of bank b, given flash base address a */
125#define BANK_ADDR_BASE(a, b) BANK_ADDR_OFFSET(BANK_ADDR_BANK_ALIGN(a), \
126 (bank_size_t)(b) * BANK_SIZE)
127
128/* adjust a bank address to start of next word, block or bank */
129#define BANK_ADDR_NEXT_WORD(a) BANK_ADDR_OFFSET(BANK_ADDR_WORD_ALIGN(a), \
130 BANK_WIDTH)
131#define BANK_ADDR_NEXT_BLK(a) BANK_ADDR_OFFSET(BANK_ADDR_BLK_ALIGN(a), \
132 BANK_BLKSZ)
133#define BANK_ADDR_NEXT_BANK(a) BANK_ADDR_OFFSET(BANK_ADDR_BANK_ALIGN(a), \
134 BANK_SIZE)
135
136/* get bank address of chip register r given a bank base address a */
137#define BANK_ADDR_REG(a, r) BANK_ADDR_OFFSET(BANK_ADDR_BANK_ALIGN(a), \
138 ((bank_size_t)(r) << BANK_WSHIFT))
139
140/* make a bank address for each chip register address */
141
142#define BANK_ADDR_REG_MAN(a) BANK_ADDR_REG((a), CHIP_ADDR_REG_MAN)
143#define BANK_ADDR_REG_DEV(a) BANK_ADDR_REG((a), CHIP_ADDR_REG_DEV)
144#define BANK_ADDR_REG_CFGM(a) BANK_ADDR_REG((a), CHIP_ADDR_REG_CFGM)
145#define BANK_ADDR_REG_CFG(b,a) BANK_ADDR_REG((a), CHIP_ADDR_REG_CFG(b))
146
147/*
148 * replicate a chip cmd/stat/rd value into each byte position within a word
149 * so that multiple chips are accessed in a single word i/o operation
150 *
151 * this must be as wide as the bank_word_t type, and take into account the
152 * chip width and bank layout
153 */
154
155#define BANK_FILL_WORD(o) ((bank_word_t)(o))
156
157/* make a bank word value for each chip cmd/stat/rd value */
158
159/* Commands */
160#define BANK_CMD_RST BANK_FILL_WORD(CHIP_CMD_RST)
161#define BANK_CMD_RD_ID BANK_FILL_WORD(CHIP_CMD_RD_ID)
162#define BANK_CMD_RD_STAT BANK_FILL_WORD(CHIP_CMD_RD_STAT)
163#define BANK_CMD_CLR_STAT BANK_FILL_WORD(CHIP_CMD_CLR_STAT)
164#define BANK_CMD_ERASE1 BANK_FILL_WORD(CHIP_CMD_ERASE1)
165#define BANK_CMD_ERASE2 BANK_FILL_WORD(CHIP_CMD_ERASE2)
166#define BANK_CMD_PROG BANK_FILL_WORD(CHIP_CMD_PROG)
167#define BANK_CMD_LOCK BANK_FILL_WORD(CHIP_CMD_LOCK)
168#define BANK_CMD_SET_LOCK_BLK BANK_FILL_WORD(CHIP_CMD_SET_LOCK_BLK)
169#define BANK_CMD_SET_LOCK_MSTR BANK_FILL_WORD(CHIP_CMD_SET_LOCK_MSTR)
170#define BANK_CMD_CLR_LOCK_BLK BANK_FILL_WORD(CHIP_CMD_CLR_LOCK_BLK)
171
172/* status register bits */
173#define BANK_STAT_DPS BANK_FILL_WORD(CHIP_STAT_DPS)
174#define BANK_STAT_PSS BANK_FILL_WORD(CHIP_STAT_PSS)
175#define BANK_STAT_VPPS BANK_FILL_WORD(CHIP_STAT_VPPS)
176#define BANK_STAT_PSLBS BANK_FILL_WORD(CHIP_STAT_PSLBS)
177#define BANK_STAT_ECLBS BANK_FILL_WORD(CHIP_STAT_ECLBS)
178#define BANK_STAT_ESS BANK_FILL_WORD(CHIP_STAT_ESS)
179#define BANK_STAT_RDY BANK_FILL_WORD(CHIP_STAT_RDY)
180
181#define BANK_STAT_ERR BANK_FILL_WORD(CHIP_STAT_ERR)
182
183/* ID and Lock Configuration */
184#define BANK_RD_ID_LOCK BANK_FILL_WORD(CHIP_RD_ID_LOCK)
185#define BANK_RD_ID_MAN BANK_FILL_WORD(CHIP_RD_ID_MAN)
186#define BANK_RD_ID_DEV BANK_FILL_WORD(CHIP_RD_ID_DEV)