]> git.ipfire.org Git - people/ms/u-boot.git/blame - drivers/mtd/nand/denali.h
Merge git://git.denx.de/u-boot-sunxi
[people/ms/u-boot.git] / drivers / mtd / nand / denali.h
CommitLineData
3eb3e72a
CLS
1/*
2 * Copyright (C) 2013-2014 Altera Corporation <www.altera.com>
3 * Copyright (C) 2009-2010, Intel Corporation and its suppliers.
4 *
5 * SPDX-License-Identifier: GPL-2.0+
6 */
7
d3963721
SW
8#ifndef __DENALI_H__
9#define __DENALI_H__
10
350d052d 11#include <linux/bitops.h>
6ae3900a 12#include <linux/mtd/rawnand.h>
350d052d 13#include <linux/types.h>
3eb3e72a
CLS
14
15#define DEVICE_RESET 0x0
350d052d 16#define DEVICE_RESET__BANK(bank) BIT(bank)
3eb3e72a
CLS
17
18#define TRANSFER_SPARE_REG 0x10
350d052d 19#define TRANSFER_SPARE_REG__FLAG BIT(0)
3eb3e72a
CLS
20
21#define LOAD_WAIT_CNT 0x20
350d052d 22#define LOAD_WAIT_CNT__VALUE GENMASK(15, 0)
3eb3e72a
CLS
23
24#define PROGRAM_WAIT_CNT 0x30
350d052d 25#define PROGRAM_WAIT_CNT__VALUE GENMASK(15, 0)
3eb3e72a
CLS
26
27#define ERASE_WAIT_CNT 0x40
350d052d 28#define ERASE_WAIT_CNT__VALUE GENMASK(15, 0)
3eb3e72a
CLS
29
30#define INT_MON_CYCCNT 0x50
350d052d 31#define INT_MON_CYCCNT__VALUE GENMASK(15, 0)
3eb3e72a
CLS
32
33#define RB_PIN_ENABLED 0x60
350d052d 34#define RB_PIN_ENABLED__BANK(bank) BIT(bank)
3eb3e72a
CLS
35
36#define MULTIPLANE_OPERATION 0x70
350d052d 37#define MULTIPLANE_OPERATION__FLAG BIT(0)
3eb3e72a
CLS
38
39#define MULTIPLANE_READ_ENABLE 0x80
350d052d 40#define MULTIPLANE_READ_ENABLE__FLAG BIT(0)
3eb3e72a
CLS
41
42#define COPYBACK_DISABLE 0x90
350d052d 43#define COPYBACK_DISABLE__FLAG BIT(0)
3eb3e72a
CLS
44
45#define CACHE_WRITE_ENABLE 0xa0
350d052d 46#define CACHE_WRITE_ENABLE__FLAG BIT(0)
3eb3e72a
CLS
47
48#define CACHE_READ_ENABLE 0xb0
350d052d 49#define CACHE_READ_ENABLE__FLAG BIT(0)
3eb3e72a
CLS
50
51#define PREFETCH_MODE 0xc0
350d052d
MY
52#define PREFETCH_MODE__PREFETCH_EN BIT(0)
53#define PREFETCH_MODE__PREFETCH_BURST_LENGTH GENMASK(15, 4)
3eb3e72a
CLS
54
55#define CHIP_ENABLE_DONT_CARE 0xd0
350d052d 56#define CHIP_EN_DONT_CARE__FLAG BIT(0)
3eb3e72a
CLS
57
58#define ECC_ENABLE 0xe0
350d052d 59#define ECC_ENABLE__FLAG BIT(0)
3eb3e72a
CLS
60
61#define GLOBAL_INT_ENABLE 0xf0
350d052d 62#define GLOBAL_INT_EN_FLAG BIT(0)
3eb3e72a 63
350d052d
MY
64#define TWHR2_AND_WE_2_RE 0x100
65#define TWHR2_AND_WE_2_RE__WE_2_RE GENMASK(5, 0)
66#define TWHR2_AND_WE_2_RE__TWHR2 GENMASK(13, 8)
3eb3e72a 67
350d052d
MY
68#define TCWAW_AND_ADDR_2_DATA 0x110
69/* The width of ADDR_2_DATA is 6 bit for old IP, 7 bit for new IP */
70#define TCWAW_AND_ADDR_2_DATA__ADDR_2_DATA GENMASK(6, 0)
71#define TCWAW_AND_ADDR_2_DATA__TCWAW GENMASK(13, 8)
3eb3e72a
CLS
72
73#define RE_2_WE 0x120
350d052d 74#define RE_2_WE__VALUE GENMASK(5, 0)
3eb3e72a
CLS
75
76#define ACC_CLKS 0x130
350d052d 77#define ACC_CLKS__VALUE GENMASK(3, 0)
3eb3e72a
CLS
78
79#define NUMBER_OF_PLANES 0x140
350d052d 80#define NUMBER_OF_PLANES__VALUE GENMASK(2, 0)
3eb3e72a
CLS
81
82#define PAGES_PER_BLOCK 0x150
350d052d 83#define PAGES_PER_BLOCK__VALUE GENMASK(15, 0)
3eb3e72a
CLS
84
85#define DEVICE_WIDTH 0x160
350d052d 86#define DEVICE_WIDTH__VALUE GENMASK(1, 0)
3eb3e72a
CLS
87
88#define DEVICE_MAIN_AREA_SIZE 0x170
350d052d 89#define DEVICE_MAIN_AREA_SIZE__VALUE GENMASK(15, 0)
3eb3e72a
CLS
90
91#define DEVICE_SPARE_AREA_SIZE 0x180
350d052d 92#define DEVICE_SPARE_AREA_SIZE__VALUE GENMASK(15, 0)
3eb3e72a
CLS
93
94#define TWO_ROW_ADDR_CYCLES 0x190
350d052d 95#define TWO_ROW_ADDR_CYCLES__FLAG BIT(0)
3eb3e72a
CLS
96
97#define MULTIPLANE_ADDR_RESTRICT 0x1a0
350d052d 98#define MULTIPLANE_ADDR_RESTRICT__FLAG BIT(0)
3eb3e72a
CLS
99
100#define ECC_CORRECTION 0x1b0
350d052d
MY
101#define ECC_CORRECTION__VALUE GENMASK(4, 0)
102#define ECC_CORRECTION__ERASE_THRESHOLD GENMASK(31, 16)
3eb3e72a
CLS
103
104#define READ_MODE 0x1c0
350d052d 105#define READ_MODE__VALUE GENMASK(3, 0)
3eb3e72a
CLS
106
107#define WRITE_MODE 0x1d0
350d052d 108#define WRITE_MODE__VALUE GENMASK(3, 0)
3eb3e72a
CLS
109
110#define COPYBACK_MODE 0x1e0
350d052d 111#define COPYBACK_MODE__VALUE GENMASK(3, 0)
3eb3e72a
CLS
112
113#define RDWR_EN_LO_CNT 0x1f0
350d052d 114#define RDWR_EN_LO_CNT__VALUE GENMASK(4, 0)
3eb3e72a
CLS
115
116#define RDWR_EN_HI_CNT 0x200
350d052d 117#define RDWR_EN_HI_CNT__VALUE GENMASK(4, 0)
3eb3e72a
CLS
118
119#define MAX_RD_DELAY 0x210
350d052d 120#define MAX_RD_DELAY__VALUE GENMASK(3, 0)
3eb3e72a
CLS
121
122#define CS_SETUP_CNT 0x220
350d052d
MY
123#define CS_SETUP_CNT__VALUE GENMASK(4, 0)
124#define CS_SETUP_CNT__TWB GENMASK(17, 12)
3eb3e72a
CLS
125
126#define SPARE_AREA_SKIP_BYTES 0x230
350d052d 127#define SPARE_AREA_SKIP_BYTES__VALUE GENMASK(5, 0)
3eb3e72a
CLS
128
129#define SPARE_AREA_MARKER 0x240
350d052d 130#define SPARE_AREA_MARKER__VALUE GENMASK(15, 0)
3eb3e72a
CLS
131
132#define DEVICES_CONNECTED 0x250
350d052d 133#define DEVICES_CONNECTED__VALUE GENMASK(2, 0)
3eb3e72a
CLS
134
135#define DIE_MASK 0x260
350d052d 136#define DIE_MASK__VALUE GENMASK(7, 0)
3eb3e72a
CLS
137
138#define FIRST_BLOCK_OF_NEXT_PLANE 0x270
350d052d 139#define FIRST_BLOCK_OF_NEXT_PLANE__VALUE GENMASK(15, 0)
3eb3e72a
CLS
140
141#define WRITE_PROTECT 0x280
350d052d 142#define WRITE_PROTECT__FLAG BIT(0)
3eb3e72a
CLS
143
144#define RE_2_RE 0x290
350d052d 145#define RE_2_RE__VALUE GENMASK(5, 0)
3eb3e72a
CLS
146
147#define MANUFACTURER_ID 0x300
350d052d 148#define MANUFACTURER_ID__VALUE GENMASK(7, 0)
3eb3e72a
CLS
149
150#define DEVICE_ID 0x310
350d052d 151#define DEVICE_ID__VALUE GENMASK(7, 0)
3eb3e72a
CLS
152
153#define DEVICE_PARAM_0 0x320
350d052d 154#define DEVICE_PARAM_0__VALUE GENMASK(7, 0)
3eb3e72a
CLS
155
156#define DEVICE_PARAM_1 0x330
350d052d 157#define DEVICE_PARAM_1__VALUE GENMASK(7, 0)
3eb3e72a
CLS
158
159#define DEVICE_PARAM_2 0x340
350d052d 160#define DEVICE_PARAM_2__VALUE GENMASK(7, 0)
3eb3e72a
CLS
161
162#define LOGICAL_PAGE_DATA_SIZE 0x350
350d052d 163#define LOGICAL_PAGE_DATA_SIZE__VALUE GENMASK(15, 0)
3eb3e72a
CLS
164
165#define LOGICAL_PAGE_SPARE_SIZE 0x360
350d052d 166#define LOGICAL_PAGE_SPARE_SIZE__VALUE GENMASK(15, 0)
3eb3e72a
CLS
167
168#define REVISION 0x370
350d052d 169#define REVISION__VALUE GENMASK(15, 0)
3eb3e72a
CLS
170
171#define ONFI_DEVICE_FEATURES 0x380
350d052d 172#define ONFI_DEVICE_FEATURES__VALUE GENMASK(5, 0)
3eb3e72a
CLS
173
174#define ONFI_OPTIONAL_COMMANDS 0x390
350d052d 175#define ONFI_OPTIONAL_COMMANDS__VALUE GENMASK(5, 0)
3eb3e72a
CLS
176
177#define ONFI_TIMING_MODE 0x3a0
350d052d 178#define ONFI_TIMING_MODE__VALUE GENMASK(5, 0)
3eb3e72a
CLS
179
180#define ONFI_PGM_CACHE_TIMING_MODE 0x3b0
350d052d 181#define ONFI_PGM_CACHE_TIMING_MODE__VALUE GENMASK(5, 0)
3eb3e72a
CLS
182
183#define ONFI_DEVICE_NO_OF_LUNS 0x3c0
350d052d
MY
184#define ONFI_DEVICE_NO_OF_LUNS__NO_OF_LUNS GENMASK(7, 0)
185#define ONFI_DEVICE_NO_OF_LUNS__ONFI_DEVICE BIT(8)
3eb3e72a
CLS
186
187#define ONFI_DEVICE_NO_OF_BLOCKS_PER_LUN_L 0x3d0
350d052d 188#define ONFI_DEVICE_NO_OF_BLOCKS_PER_LUN_L__VALUE GENMASK(15, 0)
3eb3e72a
CLS
189
190#define ONFI_DEVICE_NO_OF_BLOCKS_PER_LUN_U 0x3e0
350d052d
MY
191#define ONFI_DEVICE_NO_OF_BLOCKS_PER_LUN_U__VALUE GENMASK(15, 0)
192
193#define FEATURES 0x3f0
194#define FEATURES__N_BANKS GENMASK(1, 0)
195#define FEATURES__ECC_MAX_ERR GENMASK(5, 2)
196#define FEATURES__DMA BIT(6)
197#define FEATURES__CMD_DMA BIT(7)
198#define FEATURES__PARTITION BIT(8)
199#define FEATURES__XDMA_SIDEBAND BIT(9)
200#define FEATURES__GPREG BIT(10)
201#define FEATURES__INDEX_ADDR BIT(11)
3eb3e72a
CLS
202
203#define TRANSFER_MODE 0x400
350d052d
MY
204#define TRANSFER_MODE__VALUE GENMASK(1, 0)
205
206#define INTR_STATUS(bank) (0x410 + (bank) * 0x50)
207#define INTR_EN(bank) (0x420 + (bank) * 0x50)
208/* bit[1:0] is used differently depending on IP version */
209#define INTR__ECC_UNCOR_ERR BIT(0) /* new IP */
210#define INTR__ECC_TRANSACTION_DONE BIT(0) /* old IP */
211#define INTR__ECC_ERR BIT(1) /* old IP */
212#define INTR__DMA_CMD_COMP BIT(2)
213#define INTR__TIME_OUT BIT(3)
214#define INTR__PROGRAM_FAIL BIT(4)
215#define INTR__ERASE_FAIL BIT(5)
216#define INTR__LOAD_COMP BIT(6)
217#define INTR__PROGRAM_COMP BIT(7)
218#define INTR__ERASE_COMP BIT(8)
219#define INTR__PIPE_CPYBCK_CMD_COMP BIT(9)
220#define INTR__LOCKED_BLK BIT(10)
221#define INTR__UNSUP_CMD BIT(11)
222#define INTR__INT_ACT BIT(12)
223#define INTR__RST_COMP BIT(13)
224#define INTR__PIPE_CMD_ERR BIT(14)
225#define INTR__PAGE_XFER_INC BIT(15)
226#define INTR__ERASED_PAGE BIT(16)
227
228#define PAGE_CNT(bank) (0x430 + (bank) * 0x50)
229#define ERR_PAGE_ADDR(bank) (0x440 + (bank) * 0x50)
230#define ERR_BLOCK_ADDR(bank) (0x450 + (bank) * 0x50)
3eb3e72a
CLS
231
232#define ECC_THRESHOLD 0x600
350d052d 233#define ECC_THRESHOLD__VALUE GENMASK(9, 0)
3eb3e72a
CLS
234
235#define ECC_ERROR_BLOCK_ADDRESS 0x610
350d052d 236#define ECC_ERROR_BLOCK_ADDRESS__VALUE GENMASK(15, 0)
3eb3e72a
CLS
237
238#define ECC_ERROR_PAGE_ADDRESS 0x620
350d052d
MY
239#define ECC_ERROR_PAGE_ADDRESS__VALUE GENMASK(11, 0)
240#define ECC_ERROR_PAGE_ADDRESS__BANK GENMASK(15, 12)
3eb3e72a
CLS
241
242#define ECC_ERROR_ADDRESS 0x630
350d052d
MY
243#define ECC_ERROR_ADDRESS__OFFSET GENMASK(11, 0)
244#define ECC_ERROR_ADDRESS__SECTOR GENMASK(15, 12)
3eb3e72a
CLS
245
246#define ERR_CORRECTION_INFO 0x640
350d052d
MY
247#define ERR_CORRECTION_INFO__BYTE GENMASK(7, 0)
248#define ERR_CORRECTION_INFO__DEVICE GENMASK(11, 8)
249#define ERR_CORRECTION_INFO__UNCOR BIT(14)
250#define ERR_CORRECTION_INFO__LAST_ERR BIT(15)
251
252#define ECC_COR_INFO(bank) (0x650 + (bank) / 2 * 0x10)
253#define ECC_COR_INFO__SHIFT(bank) ((bank) % 2 * 8)
254#define ECC_COR_INFO__MAX_ERRORS GENMASK(6, 0)
255#define ECC_COR_INFO__UNCOR_ERR BIT(7)
256
257#define CFG_DATA_BLOCK_SIZE 0x6b0
258
259#define CFG_LAST_DATA_BLOCK_SIZE 0x6c0
260
261#define CFG_NUM_DATA_BLOCKS 0x6d0
262
263#define CFG_META_DATA_SIZE 0x6e0
3eb3e72a
CLS
264
265#define DMA_ENABLE 0x700
350d052d 266#define DMA_ENABLE__FLAG BIT(0)
3eb3e72a
CLS
267
268#define IGNORE_ECC_DONE 0x710
350d052d 269#define IGNORE_ECC_DONE__FLAG BIT(0)
3eb3e72a
CLS
270
271#define DMA_INTR 0x720
3eb3e72a 272#define DMA_INTR_EN 0x730
350d052d
MY
273#define DMA_INTR__TARGET_ERROR BIT(0)
274#define DMA_INTR__DESC_COMP_CHANNEL0 BIT(1)
275#define DMA_INTR__DESC_COMP_CHANNEL1 BIT(2)
276#define DMA_INTR__DESC_COMP_CHANNEL2 BIT(3)
277#define DMA_INTR__DESC_COMP_CHANNEL3 BIT(4)
278#define DMA_INTR__MEMCOPY_DESC_COMP BIT(5)
3eb3e72a
CLS
279
280#define TARGET_ERR_ADDR_LO 0x740
350d052d 281#define TARGET_ERR_ADDR_LO__VALUE GENMASK(15, 0)
3eb3e72a
CLS
282
283#define TARGET_ERR_ADDR_HI 0x750
350d052d 284#define TARGET_ERR_ADDR_HI__VALUE GENMASK(15, 0)
3eb3e72a
CLS
285
286#define CHNL_ACTIVE 0x760
350d052d
MY
287#define CHNL_ACTIVE__CHANNEL0 BIT(0)
288#define CHNL_ACTIVE__CHANNEL1 BIT(1)
289#define CHNL_ACTIVE__CHANNEL2 BIT(2)
290#define CHNL_ACTIVE__CHANNEL3 BIT(3)
3eb3e72a 291
350d052d 292struct udevice;
3eb3e72a
CLS
293
294struct denali_nand_info {
65e4145a 295 struct nand_chip nand;
a89b9bc0 296 unsigned long clk_x_rate; /* bus interface clock rate */
350d052d
MY
297 int active_bank; /* currently selected bank */
298 struct udevice *dev;
3eb3e72a 299 uint32_t page;
350d052d
MY
300 void __iomem *reg; /* Register Interface */
301 void __iomem *host; /* Host Data/Command Interface */
302 u32 irq_mask; /* interrupts we are waiting for */
303 u32 irq_status; /* interrupts that have happened */
3eb3e72a 304 int irq;
350d052d
MY
305 void *buf; /* for syndrome layout conversion */
306 dma_addr_t dma_addr;
307 int dma_avail; /* can support DMA? */
308 int devs_per_cs; /* devices connected in parallel */
309 int oob_skip_bytes; /* number of bytes reserved for BBM */
310 int max_banks;
311 unsigned int revision; /* IP revision */
312 unsigned int caps; /* IP capability (or quirk) */
313 const struct nand_ecc_caps *ecc_caps;
314 u32 (*host_read)(struct denali_nand_info *denali, u32 addr);
315 void (*host_write)(struct denali_nand_info *denali, u32 addr, u32 data);
316 void (*setup_dma)(struct denali_nand_info *denali, dma_addr_t dma_addr,
317 int page, int write);
3eb3e72a
CLS
318};
319
6c71b6f4
MY
320#define DENALI_CAP_HW_ECC_FIXUP BIT(0)
321#define DENALI_CAP_DMA_64BIT BIT(1)
322
350d052d 323int denali_calc_ecc_bytes(int step_size, int strength);
1d9654dc
MY
324int denali_init(struct denali_nand_info *denali);
325
d3963721 326#endif /* __DENALI_H__ */