summaryrefslogtreecommitdiff
path: root/include/cadence-nand.h
blob: f08dce19cb9faa1f9088574babfc4de30a3e9dc5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
/* SPDX-License-Identifier: GPL-2.0+ */
/*
 * Cadence NAND flash controller driver
 *
 * Copyright (C) 2019 Cadence
 *
 * Author: Piotr Sroka <piotrs@cadence.com>
 *
 */

#ifndef _CADENCE_NAND_H_
#define _CADENCE_NAND_H_
#include <clk.h>
#include <reset.h>
#include <linux/types.h>
#include <linux/mtd/rawnand.h>

/*
 * HPNFC can work in 3 modes:
 * -  PIO - can work in master or slave DMA
 * -  CDMA - needs Master DMA for accessing command descriptors.
 * -  Generic mode - can use only slave DMA.
 * CDMA and PIO modes can be used to execute only base commands.
 * CDMA and PIO modes can be used to execute only base commands.
 * Generic mode can be used to execute any command
 * on NAND flash memory. Driver uses CDMA mode for
 * block erasing, page reading, page programing.
 * Generic mode is used for executing rest of commands.
 */

#define DMA_DATA_SIZE_ALIGN 8

/* Register definition. */
/*
 * Command register 0.
 * Writing data to this register will initiate a new transaction
 * of the NF controller.
 */
#define CMD_REG0            0x0000
/* Command type field mask. */
#define CMD_REG0_CT         GENMASK(31, 30)
/* Command type CDMA. */
#define CMD_REG0_CT_CDMA    0uL
/* Command type generic. */
#define CMD_REG0_CT_GEN     3uL
/* Command thread number field mask. */
#define CMD_REG0_TN         GENMASK(27, 24)

/* Command register 2. */
#define CMD_REG2            0x0008
/* Command register 3. */
#define CMD_REG3            0x000C
/* Pointer register to select which thread status will be selected. */
#define CMD_STATUS_PTR      0x0010
/* Command status register for selected thread. */
#define CMD_STATUS          0x0014

/* Interrupt status register. */
#define INTR_STATUS             0x0110
#define INTR_STATUS_SDMA_ERR    BIT(22)
#define INTR_STATUS_SDMA_TRIGG  BIT(21)
#define INTR_STATUS_UNSUPP_CMD  BIT(19)
#define INTR_STATUS_DDMA_TERR   BIT(18)
#define INTR_STATUS_CDMA_TERR   BIT(17)
#define INTR_STATUS_CDMA_IDL    BIT(16)

/* Interrupt enable register. */
#define INTR_ENABLE             0x0114
#define INTR_ENABLE_INTR_EN     BIT(31)

/* Controller internal state. */
#define CTRL_STATUS             0x0118
#define CTRL_STATUS_INIT_COMP   BIT(9)
#define CTRL_STATUS_CTRL_BUSY   BIT(8)

/* Command Engine threads state. */
#define TRD_STATUS              0x0120

/* Command Engine interrupt thread error status. */
#define TRD_ERR_INT_STATUS      0x0128
/* Command Engine interrupt thread error enable. */
#define TRD_ERR_INT_STATUS_EN   0x0130
/* Command Engine interrupt thread complete status. */
#define TRD_COMP_INT_STATUS     0x0138

/*
 * Transfer config 0 register.
 * Configures data transfer parameters.
 */
#define TRAN_CFG_0              0x0400
/* Offset value from the beginning of the page. */
#define TRAN_CFG_0_OFFSET       GENMASK(31, 16)
/* Numbers of sectors to transfer within singlNF device's page. */
#define TRAN_CFG_0_SEC_CNT      GENMASK(7, 0)

/*
 * Transfer config 1 register.
 * Configures data transfer parameters.
 */
#define TRAN_CFG_1                   0x0404
/* Size of last data sector. */
#define TRAN_CFG_1_LAST_SEC_SIZE     GENMASK(31, 16)
/* Size of not-last data sector. */
#define TRAN_CFG_1_SECTOR_SIZE       GENMASK(15, 0)

/* ECC engine configuration register 0. */
#define ECC_CONFIG_0                 0x0428
/* Correction strength. */
#define ECC_CONFIG_0_CORR_STR        GENMASK(10, 8)
/* Enable erased pages detection mechanism. */
#define ECC_CONFIG_0_ERASE_DET_EN    BIT(1)
/* Enable controller ECC check bits generation and correction. */
#define ECC_CONFIG_0_ECC_EN          BIT(0)

/* ECC engine configuration register 1. */
#define ECC_CONFIG_1            0x042C

/* Multiplane settings register. */
#define MULTIPLANE_CFG          0x0434
/* Cache operation settings. */
#define CACHE_CFG               0x0438

/* Transferred data block size for the slave DMA module. */
#define SDMA_SIZE               0x0440

/* Thread number associated with transferred data block
 * for the slave DMA module.
 */
#define SDMA_TRD_NUM            0x0444
/* Thread number mask. */
#define SDMA_TRD_NUM_SDMA_TRD   GENMASK(2, 0)

#define CONTROL_DATA_CTRL       0x0494
/* Thread number mask. */
#define CONTROL_DATA_CTRL_SIZE  GENMASK(15, 0)

#define CTRL_VERSION            0x800
#define CTRL_VERSION_REV        GENMASK(7, 0)

/* Available hardware features of the controller. */
#define CTRL_FEATURES                0x804
/* Support for NV-DDR2/3 work mode. */
#define CTRL_FEATURES_NVDDR_2_3      BIT(28)
/* Support for NV-DDR work mode. */
#define CTRL_FEATURES_NVDDR          BIT(27)
/* Support for asynchronous work mode. */
#define CTRL_FEATURES_ASYNC          BIT(26)
/* Support for asynchronous work mode. */
#define CTRL_FEATURES_N_BANKS        GENMASK(25, 24)
/* Slave and Master DMA data width. */
#define CTRL_FEATURES_DMA_DWITH64    BIT(21)
/* Availability of Control Data feature.*/
#define CTRL_FEATURES_CONTROL_DATA   BIT(10)

/* BCH Engine identification register 0 - correction strengths. */
#define BCH_CFG_0               0x838
#define BCH_CFG_0_CORR_CAP_0    GENMASK(7, 0)
#define BCH_CFG_0_CORR_CAP_1    GENMASK(15, 8)
#define BCH_CFG_0_CORR_CAP_2    GENMASK(23, 16)
#define BCH_CFG_0_CORR_CAP_3    GENMASK(31, 24)

/* BCH Engine identification register 1 - correction strengths. */
#define BCH_CFG_1               0x83C
#define BCH_CFG_1_CORR_CAP_4    GENMASK(7, 0)
#define BCH_CFG_1_CORR_CAP_5    GENMASK(15, 8)
#define BCH_CFG_1_CORR_CAP_6    GENMASK(23, 16)
#define BCH_CFG_1_CORR_CAP_7    GENMASK(31, 24)

/* BCH Engine identification register 2 - sector sizes. */
#define BCH_CFG_2               0x840
#define BCH_CFG_2_SECT_0        GENMASK(15, 0)
#define BCH_CFG_2_SECT_1        GENMASK(31, 16)

/* BCH Engine identification register 3. */
#define BCH_CFG_3               0x844
#define BCH_CFG_3_METADATA_SIZE GENMASK(23, 16)

/* Ready/Busy# line status. */
#define RBN_SETINGS             0x1004

/* Common settings. */
#define COMMON_SET              0x1008
/* 16 bit device connected to the NAND Flash interface. */
#define COMMON_SET_DEVICE_16BIT BIT(8)

/* Skip_bytes registers. */
#define SKIP_BYTES_CONF             0x100C
#define SKIP_BYTES_MARKER_VALUE     GENMASK(31, 16)
#define SKIP_BYTES_NUM_OF_BYTES     GENMASK(7, 0)

#define SKIP_BYTES_OFFSET           0x1010
#define SKIP_BYTES_OFFSET_VALUE     GENMASK(23, 0)

/* Timings configuration. */
#define ASYNC_TOGGLE_TIMINGS        0x101c
#define ASYNC_TOGGLE_TIMINGS_TRH    GENMASK(28, 24)
#define ASYNC_TOGGLE_TIMINGS_TRP    GENMASK(20, 16)
#define ASYNC_TOGGLE_TIMINGS_TWH    GENMASK(12, 8)
#define ASYNC_TOGGLE_TIMINGS_TWP    GENMASK(4, 0)

#define TIMINGS0                    0x1024
#define TIMINGS0_TADL               GENMASK(31, 24)
#define TIMINGS0_TCCS               GENMASK(23, 16)
#define TIMINGS0_TWHR               GENMASK(15, 8)
#define TIMINGS0_TRHW               GENMASK(7, 0)

#define TIMINGS1                    0x1028
#define TIMINGS1_TRHZ               GENMASK(31, 24)
#define TIMINGS1_TWB                GENMASK(23, 16)
#define TIMINGS1_TVDLY              GENMASK(7, 0)

#define TIMINGS2                    0x102c
#define TIMINGS2_TFEAT              GENMASK(25, 16)
#define TIMINGS2_CS_HOLD_TIME       GENMASK(13, 8)
#define TIMINGS2_CS_SETUP_TIME      GENMASK(5, 0)

/* Configuration of the resynchronization of slave DLL of PHY. */
#define DLL_PHY_CTRL                    0x1034
#define DLL_PHY_CTRL_DLL_RST_N          BIT(24)
#define DLL_PHY_CTRL_EXTENDED_WR_MODE   BIT(17)
#define DLL_PHY_CTRL_EXTENDED_RD_MODE   BIT(16)
#define DLL_PHY_CTRL_RS_HIGH_WAIT_CNT   GENMASK(11, 8)
#define DLL_PHY_CTRL_RS_IDLE_CNT        GENMASK(7, 0)

/* TODO: - Identify better way to handle PHY address */
#define PHY_OFFSET                      0x10000

/* Register controlling DQ related timing. */
#define PHY_DQ_TIMING                   PHY_OFFSET + 0x2000
/* Register controlling DSQ related timing.  */
#define PHY_DQS_TIMING                  PHY_OFFSET + 0x2004
#define PHY_DQS_TIMING_DQS_SEL_OE_END   GENMASK(3, 0)
#define PHY_DQS_TIMING_PHONY_DQS_SEL    BIT(16)
#define PHY_DQS_TIMING_USE_PHONY_DQS    BIT(20)

/* Register controlling the gate and loopback control related timing. */
#define PHY_GATE_LPBK_CTRL              PHY_OFFSET + 0x2008
#define PHY_GATE_LPBK_CTRL_RDS          GENMASK(24, 19)

/* Register holds the control for the master DLL logic. */
#define PHY_DLL_MASTER_CTRL             PHY_OFFSET + 0x200C
#define PHY_DLL_MASTER_CTRL_BYPASS_MODE BIT(23)

/* Register holds the control for the slave DLL logic. */
#define PHY_DLL_SLAVE_CTRL              PHY_OFFSET + 0x2010

/* This register handles the global control settings for the PHY. */
#define PHY_CTRL                        PHY_OFFSET + 0x2080
#define PHY_CTRL_SDR_DQS                BIT(14)
#define PHY_CTRL_PHONY_DQS              GENMASK(9, 4)

/*
 * This register handles the global control settings
 * for the termination selects for reads.
 */
#define PHY_TSEL                PHY_OFFSET + 0x2084

/* Generic command layout. */
#define GCMD_LAY_CS             GENMASK_ULL(11, 8)
/*
 * This bit informs the minicotroller if it has to wait for tWB
 * after sending the last CMD/ADDR/DATA in the sequence.
 */
#define GCMD_LAY_TWB            BIT_ULL(6)
/* Type of generic instruction. */
#define GCMD_LAY_INSTR          GENMASK_ULL(5, 0)

/* Generic CMD sequence type. */
#define GCMD_LAY_INSTR_CMD      0
/* Generic ADDR sequence type. */
#define GCMD_LAY_INSTR_ADDR     1
/* Generic data transfer sequence type. */
#define GCMD_LAY_INSTR_DATA     2

/* Input part of generic command type of input is command. */
#define GCMD_LAY_INPUT_CMD          GENMASK_ULL(23, 16)

/* Generic command address sequence - address fields. */
#define GCMD_LAY_INPUT_ADDR         GENMASK_ULL(63, 16)
/* Generic command address sequence - address size. */
#define GCMD_LAY_INPUT_ADDR_SIZE    GENMASK_ULL(13, 11)

/* Transfer direction field of generic command data sequence. */
#define GCMD_DIR            BIT_ULL(11)
/* Read transfer direction of generic command data sequence. */
#define GCMD_DIR_READ       0
/* Write transfer direction of generic command data sequence. */
#define GCMD_DIR_WRITE      1

/* ECC enabled flag of generic command data sequence - ECC enabled. */
#define GCMD_ECC_EN             BIT_ULL(12)
/* Generic command data sequence - sector size. */
#define GCMD_SECT_SIZE          GENMASK_ULL(31, 16)
/* Generic command data sequence - sector count. */
#define GCMD_SECT_CNT           GENMASK_ULL(39, 32)
/* Generic command data sequence - last sector size. */
#define GCMD_LAST_SIZE          GENMASK_ULL(55, 40)

/* CDMA descriptor fields. */
/* Erase command type of CDMA descriptor. */
#define CDMA_CT_ERASE           0x1000
/* Program page command type of CDMA descriptor. */
#define CDMA_CT_WR              0x2100
/* Read page command type of CDMA descriptor. */
#define CDMA_CT_RD              0x2200

/* Flash pointer memory shift. */
#define CDMA_CFPTR_MEM_SHIFT    24
/* Flash pointer memory mask. */
#define CDMA_CFPTR_MEM          GENMASK(26, 24)

/*
 * Command DMA descriptor flags. If set causes issue interrupt after
 * the completion of descriptor processing.
 */
#define CDMA_CF_INT         BIT(8)
/*
 * Command DMA descriptor flags - the next descriptor
 * address field is valid and descriptor processing should continue.
 */
#define CDMA_CF_CONT        BIT(9)
/* DMA master flag of command DMA descriptor. */
#define CDMA_CF_DMA_MASTER  BIT(10)

/* Operation complete status of command descriptor. */
#define CDMA_CS_COMP        BIT(15)
/* Operation complete status of command descriptor. */
/* Command descriptor status - operation fail. */
#define CDMA_CS_FAIL        BIT(14)
/* Command descriptor status - page erased. */
#define CDMA_CS_ERP         BIT(11)
/* Command descriptor status - timeout occurred. */
#define CDMA_CS_TOUT        BIT(10)
/*
 * Maximum amount of correction applied to one ECC sector.
 * It is part of command descriptor status.
 */
#define CDMA_CS_MAXERR      GENMASK(9, 2)
/* Command descriptor status - uncorrectable ECC error. */
#define CDMA_CS_UNCE        BIT(1)
/* Command descriptor status - descriptor error. */
#define CDMA_CS_ERR         BIT(0)

/* Status of operation - OK. */
#define STAT_OK             0
/* Status of operation - FAIL. */
#define STAT_FAIL           2
/* Status of operation - uncorrectable ECC error. */
#define STAT_ECC_UNCORR     3
/* Status of operation - page erased. */
#define STAT_ERASED         5
/* Status of operation - correctable ECC error. */
#define STAT_ECC_CORR       6
/* Status of operation - unsuspected state. */
#define STAT_UNKNOWN        7
/* Status of operation - operation is not completed yet. */
#define STAT_BUSY           0xFF

#define BCH_MAX_NUM_CORR_CAPS       8
#define BCH_MAX_NUM_SECTOR_SIZES    2

#define ONE_CYCLE                   1
#define TIMEOUT_US                  1000000

struct cadence_nand_timings {
	u32 async_toggle_timings;
	u32 timings0;
	u32 timings1;
	u32 timings2;
	u32 dll_phy_ctrl;
	u32 phy_ctrl;
	u32 phy_dqs_timing;
	u32 phy_gate_lpbk_ctrl;
};

/* Command DMA descriptor. */
struct cadence_nand_cdma_desc {
	/* Next descriptor address. */
	u64 next_pointer;

	/* Flash address is a 32-bit address comprising of BANK and ROW ADDR. */
	u32 flash_pointer;
	/*field appears in HPNFC version 13*/
	u16 bank;
	u16 rsvd0;

	/* Operation the controller needs to perform. */
	u16 command_type;
	u16 rsvd1;
	/* Flags for operation of this command. */
	u16 command_flags;
	u16 rsvd2;

	/* System/host memory address required for data DMA commands. */
	u64 memory_pointer;

	/* Status of operation. */
	u32 status;
	u32 rsvd3;

	/* Address pointer to sync buffer location. */
	u64 sync_flag_pointer;

	/* Controls the buffer sync mechanism. */
	u32 sync_arguments;
	u32 rsvd4;

	/* Control data pointer. */
	u64 ctrl_data_ptr;
};

/* Interrupt status. */
struct cadence_nand_irq_status {
	/* Thread operation complete status. */
	u32 trd_status;
	/* Thread operation error. */
	u32 trd_error;
	/* Controller status. */
	u32 status;
};

/* Cadence NAND flash controller capabilities get from driver data. */
struct cadence_nand_dt_devdata {
	/* Skew value of the output signals of the NAND Flash interface. */
	u32 if_skew;
	/* It informs if slave DMA interface is connected to DMA engine. */
	unsigned int has_dma:1;
};

/* Cadence NAND flash controller capabilities read from registers. */
struct cdns_nand_caps {
	/* Maximum number of banks supported by hardware. */
	u8 max_banks;
	/* Slave and Master DMA data width in bytes (4 or 8). */
	u8 data_dma_width;
	/* Control Data feature supported. */
	bool data_control_supp;
	/* Is PHY type DLL. */
	bool is_phy_type_dll;
};

struct cadence_nand_info {
	struct nand_hw_control controller;
	struct udevice *dev;
	struct reset_ctl softphy_reset;
	struct reset_ctl nand_reset;
	struct cadence_nand_cdma_desc *cdma_desc;
	/* IP capability. */
	const struct cadence_nand_dt_devdata *caps1;
	struct cdns_nand_caps caps2;
	u8 ctrl_rev;
	dma_addr_t dma_cdma_desc;
	/* command interface buffers */
	u8 *buf;
	u32 buf_size;
	u8 *stat;
	u8 cmd;
	u32 buf_index;

	u8 curr_corr_str_idx;

	/* Register interface. */
	void __iomem *reg;

	struct {
	void __iomem *virt;
	dma_addr_t dma;
	} io;

	int irq;
	/* Interrupts that have happened. */
	struct cadence_nand_irq_status irq_status;
	/* Interrupts we are waiting for. */
	struct cadence_nand_irq_status irq_mask;

	int ecc_strengths[BCH_MAX_NUM_CORR_CAPS];
	struct nand_ecc_step_info ecc_stepinfos[BCH_MAX_NUM_SECTOR_SIZES];
	struct nand_ecc_caps ecc_caps;

	int curr_trans_type;

	struct clk clk;
	u32 nf_clk_rate;
	/*
	 * Estimated Board delay. The value includes the total
	 * round trip delay for the signals and is used for deciding on values
	 * associated with data read capture.
	 */
	u32 board_delay;

	struct nand_chip *selected_chip;

	unsigned long assigned_cs;
	struct list_head chips;
	u8 bch_metadata_size;
};

struct cdns_nand_chip {
	struct cadence_nand_timings timings;
	struct nand_chip chip;
	u8 nsels;
	struct list_head node;

	/*
	 * part of oob area of NAND flash memory page.
	 * This part is available for user to read or write.
	 */
	u32 avail_oob_size;

	/* Sector size. There are few sectors per mtd->writesize */
	u32 sector_size;
	u32 sector_count;

	/* Offset of BBM. */
	u8 bbm_offs;
	/* Number of bytes reserved for BBM. */
	u8 bbm_len;
	/* ECC strength index. */
	u8 corr_str_idx;

	u8 cs[];
};

struct ecc_info {
	int (*calc_ecc_bytes)(int step_size, int strength);
	int max_step_size;
};

#endif /*_CADENCE_NAND_H_*/