blob: a717987be67a42b05f1e674ea8046f202aab5ebe [file] [log] [blame]
Dinesh Maniyamf61a2212025-02-27 00:18:17 +08001// SPDX-License-Identifier: GPL-2.0+
2/*
3 * Cadence NAND flash controller driver
4 *
5 * Copyright (C) 2019 Cadence
6 *
7 * Author: Piotr Sroka <piotrs@cadence.com>
8 *
9 */
10
11#include <cadence-nand.h>
12#include <clk.h>
13#include <dm.h>
14#include <hang.h>
15#include <malloc.h>
16#include <memalign.h>
17#include <nand.h>
18#include <reset.h>
19#include <wait_bit.h>
20#include <dm/device_compat.h>
21#include <dm/devres.h>
22#include <linux/bitfield.h>
23#include <linux/bug.h>
24#include <linux/delay.h>
25#include <linux/dma-direction.h>
26#include <linux/dma-mapping.h>
27#include <linux/io.h>
28#include <linux/iopoll.h>
29#include <linux/ioport.h>
30#include <linux/printk.h>
31#include <linux/sizes.h>
32
33static inline struct
34cdns_nand_chip *to_cdns_nand_chip(struct nand_chip *chip)
35{
36 return container_of(chip, struct cdns_nand_chip, chip);
37}
38
39static inline struct
40cadence_nand_info *to_cadence_nand_info(struct nand_hw_control *controller)
41{
42 return container_of(controller, struct cadence_nand_info, controller);
43}
44
45static bool
46cadence_nand_dma_buf_ok(struct cadence_nand_info *cadence, const void *buf,
47 u32 buf_len)
48{
49 u8 data_dma_width = cadence->caps2.data_dma_width;
50
51 return buf &&
52 likely(IS_ALIGNED((uintptr_t)buf, data_dma_width)) &&
53 likely(IS_ALIGNED(buf_len, DMA_DATA_SIZE_ALIGN));
54}
55
56static int cadence_nand_wait_for_value(struct cadence_nand_info *cadence,
57 u32 reg_offset, u32 timeout_us,
58 u32 mask, bool is_clear)
59{
60 u32 val;
61 int ret;
62
63 ret = readl_poll_sleep_timeout(cadence->reg + reg_offset,
64 val, !(val & mask) == is_clear,
65 10, timeout_us);
66
67 if (ret < 0) {
68 dev_err(cadence->dev,
69 "Timeout while waiting for reg %x with mask %x is clear %d\n",
70 reg_offset, mask, is_clear);
71 }
72
73 return ret;
74}
75
76static int cadence_nand_set_ecc_enable(struct cadence_nand_info *cadence,
77 bool enable)
78{
79 u32 reg;
80
81 if (cadence_nand_wait_for_value(cadence, CTRL_STATUS,
82 TIMEOUT_US,
83 CTRL_STATUS_CTRL_BUSY, true))
84 return -ETIMEDOUT;
85
86 reg = readl_relaxed(cadence->reg + ECC_CONFIG_0);
87
88 if (enable)
89 reg |= ECC_CONFIG_0_ECC_EN;
90 else
91 reg &= ~ECC_CONFIG_0_ECC_EN;
92
93 writel_relaxed(reg, cadence->reg + ECC_CONFIG_0);
94
95 return 0;
96}
97
98static void cadence_nand_set_ecc_strength(struct cadence_nand_info *cadence,
99 u8 corr_str_idx)
100{
101 u32 reg;
102
103 if (cadence->curr_corr_str_idx == corr_str_idx)
104 return;
105
106 reg = readl_relaxed(cadence->reg + ECC_CONFIG_0);
107 reg &= ~ECC_CONFIG_0_CORR_STR;
108 reg |= FIELD_PREP(ECC_CONFIG_0_CORR_STR, corr_str_idx);
109 writel_relaxed(reg, cadence->reg + ECC_CONFIG_0);
110
111 cadence->curr_corr_str_idx = corr_str_idx;
112}
113
114static int cadence_nand_get_ecc_strength_idx(struct cadence_nand_info *cadence,
115 u8 strength)
116{
117 int i, corr_str_idx = -1;
118
119 for (i = 0; i < BCH_MAX_NUM_CORR_CAPS; i++) {
120 if (cadence->ecc_strengths[i] == strength) {
121 corr_str_idx = i;
122 break;
123 }
124 }
125
126 return corr_str_idx;
127}
128
129static int cadence_nand_set_skip_marker_val(struct cadence_nand_info *cadence,
130 u16 marker_value)
131{
132 u32 reg;
133
134 if (cadence_nand_wait_for_value(cadence, CTRL_STATUS,
135 TIMEOUT_US,
136 CTRL_STATUS_CTRL_BUSY, true))
137 return -ETIMEDOUT;
138
139 reg = readl_relaxed(cadence->reg + SKIP_BYTES_CONF);
140 reg &= ~SKIP_BYTES_MARKER_VALUE;
141 reg |= FIELD_PREP(SKIP_BYTES_MARKER_VALUE,
142 marker_value);
143
144 writel_relaxed(reg, cadence->reg + SKIP_BYTES_CONF);
145
146 return 0;
147}
148
149static int cadence_nand_set_skip_bytes_conf(struct cadence_nand_info *cadence,
150 u8 num_of_bytes,
151 u32 offset_value,
152 int enable)
153{
154 u32 reg, skip_bytes_offset;
155
156 if (cadence_nand_wait_for_value(cadence, CTRL_STATUS,
157 TIMEOUT_US,
158 CTRL_STATUS_CTRL_BUSY, true))
159 return -ETIMEDOUT;
160
161 if (!enable) {
162 num_of_bytes = 0;
163 offset_value = 0;
164 }
165
166 reg = readl_relaxed(cadence->reg + SKIP_BYTES_CONF);
167 reg &= ~SKIP_BYTES_NUM_OF_BYTES;
168 reg |= FIELD_PREP(SKIP_BYTES_NUM_OF_BYTES,
169 num_of_bytes);
170 skip_bytes_offset = FIELD_PREP(SKIP_BYTES_OFFSET_VALUE,
171 offset_value);
172
173 writel_relaxed(reg, cadence->reg + SKIP_BYTES_CONF);
174 writel_relaxed(skip_bytes_offset, cadence->reg + SKIP_BYTES_OFFSET);
175
176 return 0;
177}
178
179/* Functions enables/disables hardware detection of erased data */
180static void cadence_nand_set_erase_detection(struct cadence_nand_info *cadence,
181 bool enable,
182 u8 bitflips_threshold)
183{
184 u32 reg;
185
186 reg = readl_relaxed(cadence->reg + ECC_CONFIG_0);
187
188 if (enable)
189 reg |= ECC_CONFIG_0_ERASE_DET_EN;
190 else
191 reg &= ~ECC_CONFIG_0_ERASE_DET_EN;
192
193 writel_relaxed(reg, cadence->reg + ECC_CONFIG_0);
194 writel_relaxed(bitflips_threshold, cadence->reg + ECC_CONFIG_1);
195}
196
197static int cadence_nand_set_access_width16(struct cadence_nand_info *cadence,
198 bool bit_bus16)
199{
200 u32 reg;
201
202 if (cadence_nand_wait_for_value(cadence, CTRL_STATUS,
203 TIMEOUT_US,
204 CTRL_STATUS_CTRL_BUSY, true))
205 return -ETIMEDOUT;
206
207 reg = readl_relaxed(cadence->reg + COMMON_SET);
208 if (!bit_bus16)
209 reg &= ~COMMON_SET_DEVICE_16BIT;
210 else
211 reg |= COMMON_SET_DEVICE_16BIT;
212 writel_relaxed(reg, cadence->reg + COMMON_SET);
213
214 return 0;
215}
216
217static void
218cadence_nand_clear_interrupt(struct cadence_nand_info *cadence,
219 struct cadence_nand_irq_status *irq_status)
220{
221 writel_relaxed(irq_status->status, cadence->reg + INTR_STATUS);
222 writel_relaxed(irq_status->trd_status,
223 cadence->reg + TRD_COMP_INT_STATUS);
224 writel_relaxed(irq_status->trd_error,
225 cadence->reg + TRD_ERR_INT_STATUS);
226}
227
228static void
229cadence_nand_read_int_status(struct cadence_nand_info *cadence,
230 struct cadence_nand_irq_status *irq_status)
231{
232 irq_status->status = readl_relaxed(cadence->reg + INTR_STATUS);
233 irq_status->trd_status = readl_relaxed(cadence->reg
234 + TRD_COMP_INT_STATUS);
235 irq_status->trd_error = readl_relaxed(cadence->reg
236 + TRD_ERR_INT_STATUS);
237}
238
239static u32 irq_detected(struct cadence_nand_info *cadence,
240 struct cadence_nand_irq_status *irq_status)
241{
242 cadence_nand_read_int_status(cadence, irq_status);
243
244 return irq_status->status || irq_status->trd_status ||
245 irq_status->trd_error;
246}
247
248static void cadence_nand_reset_irq(struct cadence_nand_info *cadence)
249{
250 memset(&cadence->irq_status, 0, sizeof(cadence->irq_status));
251 memset(&cadence->irq_mask, 0, sizeof(cadence->irq_mask));
252}
253
254/*
255 * This is the interrupt service routine. It handles all interrupts
256 * sent to this device.
257 */
258static irqreturn_t cadence_nand_isr(struct cadence_nand_info *cadence)
259{
260 struct cadence_nand_irq_status irq_status;
261 irqreturn_t result = IRQ_NONE;
262
263 if (irq_detected(cadence, &irq_status)) {
264 /* Handle interrupt. */
265 /* First acknowledge it. */
266 cadence_nand_clear_interrupt(cadence, &irq_status);
267 /* Status in the device context for someone to read. */
268 cadence->irq_status.status |= irq_status.status;
269 cadence->irq_status.trd_status |= irq_status.trd_status;
270 cadence->irq_status.trd_error |= irq_status.trd_error;
271 /* Tell the OS that we've handled this. */
272 result = IRQ_HANDLED;
273 }
274 return result;
275}
276
277static void cadence_nand_set_irq_mask(struct cadence_nand_info *cadence,
278 struct cadence_nand_irq_status *irq_mask)
279{
280 writel_relaxed(INTR_ENABLE_INTR_EN | irq_mask->status,
281 cadence->reg + INTR_ENABLE);
282
283 writel_relaxed(irq_mask->trd_error,
284 cadence->reg + TRD_ERR_INT_STATUS_EN);
285}
286
287static void
288cadence_nand_wait_for_irq(struct cadence_nand_info *cadence,
289 struct cadence_nand_irq_status *irq_mask,
290 struct cadence_nand_irq_status *irq_status)
291{
292 irqreturn_t result = IRQ_NONE;
293 u32 start = get_timer(0);
294
295 while (get_timer(start) < TIMEOUT_US) {
296 result = cadence_nand_isr(cadence);
297
298 if (result == IRQ_HANDLED) {
299 *irq_status = cadence->irq_status;
300 break;
301 }
302 udelay(1);
303 }
304
305 if (!result) {
306 /* Timeout error. */
307 dev_err(cadence->dev, "timeout occurred:\n");
308 dev_err(cadence->dev, "\tstatus = 0x%x, mask = 0x%x\n",
309 irq_status->status, irq_mask->status);
310 dev_err(cadence->dev,
311 "\ttrd_status = 0x%x, trd_status mask = 0x%x\n",
312 irq_status->trd_status, irq_mask->trd_status);
313 dev_err(cadence->dev,
314 "\t trd_error = 0x%x, trd_error mask = 0x%x\n",
315 irq_status->trd_error, irq_mask->trd_error);
316 }
317}
318
319/* Execute generic command on NAND controller. */
320static int cadence_nand_generic_cmd_send(struct cadence_nand_info *cadence,
321 u8 chip_nr,
322 u64 mini_ctrl_cmd)
323{
324 u32 mini_ctrl_cmd_l, mini_ctrl_cmd_h, reg;
325
326 mini_ctrl_cmd |= FIELD_PREP(GCMD_LAY_CS, chip_nr);
327 mini_ctrl_cmd_l = mini_ctrl_cmd & 0xFFFFFFFF;
328 mini_ctrl_cmd_h = mini_ctrl_cmd >> 32;
329
330 if (cadence_nand_wait_for_value(cadence, CTRL_STATUS,
331 TIMEOUT_US,
332 CTRL_STATUS_CTRL_BUSY, true))
333 return -ETIMEDOUT;
334
335 cadence_nand_reset_irq(cadence);
336
337 writel_relaxed(mini_ctrl_cmd_l, cadence->reg + CMD_REG2);
338 writel_relaxed(mini_ctrl_cmd_h, cadence->reg + CMD_REG3);
339
340 /* Select generic command. */
341 reg = FIELD_PREP(CMD_REG0_CT, CMD_REG0_CT_GEN);
342 /* Thread number. */
343 reg |= FIELD_PREP(CMD_REG0_TN, 0);
344
345 /* Issue command. */
346 writel_relaxed(reg, cadence->reg + CMD_REG0);
Dinesh Maniyamd7bc8562025-02-27 00:18:18 +0800347 cadence->buf_index = 0;
Dinesh Maniyamf61a2212025-02-27 00:18:17 +0800348
349 return 0;
350}
351
352/* Wait for data on slave DMA interface. */
353static int cadence_nand_wait_on_sdma(struct cadence_nand_info *cadence, u8 *out_sdma_trd,
354 u32 *out_sdma_size)
355{
356 struct cadence_nand_irq_status irq_mask, irq_status;
357
358 irq_mask.trd_status = 0;
359 irq_mask.trd_error = 0;
360 irq_mask.status = INTR_STATUS_SDMA_TRIGG
361 | INTR_STATUS_SDMA_ERR
362 | INTR_STATUS_UNSUPP_CMD;
363
364 cadence_nand_set_irq_mask(cadence, &irq_mask);
365 cadence_nand_wait_for_irq(cadence, &irq_mask, &irq_status);
366 if (irq_status.status == 0) {
367 dev_err(cadence->dev, "Timeout while waiting for SDMA\n");
368 return -ETIMEDOUT;
369 }
370
371 if (irq_status.status & INTR_STATUS_SDMA_TRIGG) {
372 *out_sdma_size = readl_relaxed(cadence->reg + SDMA_SIZE);
373 *out_sdma_trd = readl_relaxed(cadence->reg + SDMA_TRD_NUM);
374 *out_sdma_trd =
375 FIELD_GET(SDMA_TRD_NUM_SDMA_TRD, *out_sdma_trd);
376 } else {
377 dev_err(cadence->dev, "SDMA error - irq_status %x\n",
378 irq_status.status);
379 return -EIO;
380 }
381
382 return 0;
383}
384
385static void cadence_nand_get_caps(struct cadence_nand_info *cadence)
386{
387 u32 reg;
388
389 reg = readl_relaxed(cadence->reg + CTRL_FEATURES);
390
391 cadence->caps2.max_banks = 1 << FIELD_GET(CTRL_FEATURES_N_BANKS, reg);
392
393 if (FIELD_GET(CTRL_FEATURES_DMA_DWITH64, reg))
394 cadence->caps2.data_dma_width = 8;
395 else
396 cadence->caps2.data_dma_width = 4;
397
398 if (reg & CTRL_FEATURES_CONTROL_DATA)
399 cadence->caps2.data_control_supp = true;
400
401 if (reg & (CTRL_FEATURES_NVDDR_2_3
402 | CTRL_FEATURES_NVDDR))
403 cadence->caps2.is_phy_type_dll = true;
404}
405
406/* Prepare CDMA descriptor. */
407static void
408cadence_nand_cdma_desc_prepare(struct cadence_nand_info *cadence,
409 char nf_mem, u32 flash_ptr, dma_addr_t mem_ptr,
410 dma_addr_t ctrl_data_ptr, u16 ctype)
411{
412 struct cadence_nand_cdma_desc *cdma_desc = cadence->cdma_desc;
413
414 memset(cdma_desc, 0, sizeof(struct cadence_nand_cdma_desc));
415
416 /* Set fields for one descriptor. */
417 cdma_desc->flash_pointer = flash_ptr;
418 if (cadence->ctrl_rev >= 13)
419 cdma_desc->bank = nf_mem;
420 else
421 cdma_desc->flash_pointer |= (nf_mem << CDMA_CFPTR_MEM_SHIFT);
422
423 cdma_desc->command_flags |= CDMA_CF_DMA_MASTER;
424 cdma_desc->command_flags |= CDMA_CF_INT;
425
426 cdma_desc->memory_pointer = mem_ptr;
427 cdma_desc->status = 0;
428 cdma_desc->sync_flag_pointer = 0;
429 cdma_desc->sync_arguments = 0;
430
431 cdma_desc->command_type = ctype;
432 cdma_desc->ctrl_data_ptr = ctrl_data_ptr;
Dinesh Maniyamf110c572025-02-27 00:18:23 +0800433
434 flush_cache((dma_addr_t)cadence->cdma_desc,
435 ROUND(sizeof(struct cadence_nand_cdma_desc),
436 ARCH_DMA_MINALIGN));
Dinesh Maniyamf61a2212025-02-27 00:18:17 +0800437}
438
439static u8 cadence_nand_check_desc_error(struct cadence_nand_info *cadence,
440 u32 desc_status)
441{
442 if (desc_status & CDMA_CS_ERP)
443 return STAT_ERASED;
444
445 if (desc_status & CDMA_CS_UNCE)
446 return STAT_ECC_UNCORR;
447
448 if (desc_status & CDMA_CS_ERR) {
449 dev_err(cadence->dev, ":CDMA desc error flag detected.\n");
450 return STAT_FAIL;
451 }
452
453 if (FIELD_GET(CDMA_CS_MAXERR, desc_status))
454 return STAT_ECC_CORR;
455
456 return STAT_FAIL;
457}
458
459static int cadence_nand_cdma_finish(struct cadence_nand_info *cadence)
460{
461 struct cadence_nand_cdma_desc *desc_ptr = cadence->cdma_desc;
462 u8 status = STAT_BUSY;
463
Dinesh Maniyamf110c572025-02-27 00:18:23 +0800464 invalidate_dcache_range((dma_addr_t)cadence->cdma_desc,
465 (dma_addr_t)cadence->cdma_desc +
466 ROUND(sizeof(struct cadence_nand_cdma_desc),
467 ARCH_DMA_MINALIGN));
468
Dinesh Maniyamf61a2212025-02-27 00:18:17 +0800469 if (desc_ptr->status & CDMA_CS_FAIL) {
470 status = cadence_nand_check_desc_error(cadence,
471 desc_ptr->status);
472 dev_err(cadence->dev, ":CDMA error %x\n", desc_ptr->status);
473 } else if (desc_ptr->status & CDMA_CS_COMP) {
474 /* Descriptor finished with no errors. */
475 if (desc_ptr->command_flags & CDMA_CF_CONT) {
476 dev_info(cadence->dev, "DMA unsupported flag is set");
477 status = STAT_UNKNOWN;
478 } else {
479 /* Last descriptor. */
480 status = STAT_OK;
481 }
482 }
483
484 return status;
485}
486
487static int cadence_nand_cdma_send(struct cadence_nand_info *cadence,
488 u8 thread)
489{
490 u32 reg;
491 int status;
492
493 /* Wait for thread ready. */
494 status = cadence_nand_wait_for_value(cadence, TRD_STATUS,
495 TIMEOUT_US,
496 BIT(thread), true);
497 if (status)
498 return status;
499
500 cadence_nand_reset_irq(cadence);
501
502 writel_relaxed((u32)cadence->dma_cdma_desc,
503 cadence->reg + CMD_REG2);
504 writel_relaxed(0, cadence->reg + CMD_REG3);
505
506 /* Select CDMA mode. */
507 reg = FIELD_PREP(CMD_REG0_CT, CMD_REG0_CT_CDMA);
508 /* Thread number. */
509 reg |= FIELD_PREP(CMD_REG0_TN, thread);
510 /* Issue command. */
511 writel_relaxed(reg, cadence->reg + CMD_REG0);
512
513 return 0;
514}
515
516/* Send SDMA command and wait for finish. */
517static u32
518cadence_nand_cdma_send_and_wait(struct cadence_nand_info *cadence,
519 u8 thread)
520{
521 struct cadence_nand_irq_status irq_mask, irq_status = {0};
522 int status;
523
524 irq_mask.trd_status = BIT(thread);
525 irq_mask.trd_error = BIT(thread);
526 irq_mask.status = INTR_STATUS_CDMA_TERR;
527
528 cadence_nand_set_irq_mask(cadence, &irq_mask);
529
530 status = cadence_nand_cdma_send(cadence, thread);
531 if (status)
532 return status;
533
534 cadence_nand_wait_for_irq(cadence, &irq_mask, &irq_status);
535
536 if (irq_status.status == 0 && irq_status.trd_status == 0 &&
537 irq_status.trd_error == 0) {
538 dev_err(cadence->dev, "CDMA command timeout\n");
539 return -ETIMEDOUT;
540 }
541 if (irq_status.status & irq_mask.status) {
542 dev_err(cadence->dev, "CDMA command failed\n");
543 return -EIO;
544 }
545
546 return 0;
547}
548
549/*
550 * ECC size depends on configured ECC strength and on maximum supported
551 * ECC step size.
552 */
553static int cadence_nand_calc_ecc_bytes(int max_step_size, int strength)
554{
555 int nbytes = DIV_ROUND_UP(fls(8 * max_step_size) * strength, 8);
556
557 return ALIGN(nbytes, 2);
558}
559
560#define CADENCE_NAND_CALC_ECC_BYTES(max_step_size) \
561 static int \
562 cadence_nand_calc_ecc_bytes_##max_step_size(int step_size, \
563 int strength)\
564 {\
565 return cadence_nand_calc_ecc_bytes(max_step_size, strength);\
566 }
567
568CADENCE_NAND_CALC_ECC_BYTES(256)
569CADENCE_NAND_CALC_ECC_BYTES(512)
570CADENCE_NAND_CALC_ECC_BYTES(1024)
571CADENCE_NAND_CALC_ECC_BYTES(2048)
572CADENCE_NAND_CALC_ECC_BYTES(4096)
573
574/* Function reads BCH capabilities. */
575static int cadence_nand_read_bch_caps(struct cadence_nand_info *cadence)
576{
577 struct nand_ecc_caps *ecc_caps = &cadence->ecc_caps;
578 int max_step_size = 0, nstrengths, i;
579 u32 reg;
580
581 reg = readl_relaxed(cadence->reg + BCH_CFG_3);
582 cadence->bch_metadata_size = FIELD_GET(BCH_CFG_3_METADATA_SIZE, reg);
583 if (cadence->bch_metadata_size < 4) {
584 dev_err(cadence->dev,
585 "Driver needs at least 4 bytes of BCH meta data\n");
586 return -EIO;
587 }
588
589 reg = readl_relaxed(cadence->reg + BCH_CFG_0);
590 cadence->ecc_strengths[0] = FIELD_GET(BCH_CFG_0_CORR_CAP_0, reg);
591 cadence->ecc_strengths[1] = FIELD_GET(BCH_CFG_0_CORR_CAP_1, reg);
592 cadence->ecc_strengths[2] = FIELD_GET(BCH_CFG_0_CORR_CAP_2, reg);
593 cadence->ecc_strengths[3] = FIELD_GET(BCH_CFG_0_CORR_CAP_3, reg);
594
595 reg = readl_relaxed(cadence->reg + BCH_CFG_1);
596 cadence->ecc_strengths[4] = FIELD_GET(BCH_CFG_1_CORR_CAP_4, reg);
597 cadence->ecc_strengths[5] = FIELD_GET(BCH_CFG_1_CORR_CAP_5, reg);
598 cadence->ecc_strengths[6] = FIELD_GET(BCH_CFG_1_CORR_CAP_6, reg);
599 cadence->ecc_strengths[7] = FIELD_GET(BCH_CFG_1_CORR_CAP_7, reg);
600
601 reg = readl_relaxed(cadence->reg + BCH_CFG_2);
602 cadence->ecc_stepinfos[0].stepsize =
603 FIELD_GET(BCH_CFG_2_SECT_0, reg);
604
605 cadence->ecc_stepinfos[1].stepsize =
606 FIELD_GET(BCH_CFG_2_SECT_1, reg);
607
608 nstrengths = 0;
609 for (i = 0; i < BCH_MAX_NUM_CORR_CAPS; i++) {
610 if (cadence->ecc_strengths[i] != 0)
611 nstrengths++;
612 }
613
614 ecc_caps->nstepinfos = 0;
615 for (i = 0; i < BCH_MAX_NUM_SECTOR_SIZES; i++) {
616 /* ECC strengths are common for all step infos. */
617 cadence->ecc_stepinfos[i].nstrengths = nstrengths;
618 cadence->ecc_stepinfos[i].strengths =
619 cadence->ecc_strengths;
620
621 if (cadence->ecc_stepinfos[i].stepsize != 0)
622 ecc_caps->nstepinfos++;
623
624 if (cadence->ecc_stepinfos[i].stepsize > max_step_size)
625 max_step_size = cadence->ecc_stepinfos[i].stepsize;
626 }
627 ecc_caps->stepinfos = &cadence->ecc_stepinfos[0];
628
629 switch (max_step_size) {
630 case 256:
631 ecc_caps->calc_ecc_bytes = &cadence_nand_calc_ecc_bytes_256;
632 break;
633 case 512:
634 ecc_caps->calc_ecc_bytes = &cadence_nand_calc_ecc_bytes_512;
635 break;
636 case 1024:
637 ecc_caps->calc_ecc_bytes = &cadence_nand_calc_ecc_bytes_1024;
638 break;
639 case 2048:
640 ecc_caps->calc_ecc_bytes = &cadence_nand_calc_ecc_bytes_2048;
641 break;
642 case 4096:
643 ecc_caps->calc_ecc_bytes = &cadence_nand_calc_ecc_bytes_4096;
644 break;
645 default:
646 dev_err(cadence->dev,
647 "Unsupported sector size(ecc step size) %d\n",
648 max_step_size);
649 return -EIO;
650 }
651
652 return 0;
653}
654
655/* Hardware initialization. */
656static int cadence_nand_hw_init(struct cadence_nand_info *cadence)
657{
658 int status;
659 u32 reg;
660
661 status = cadence_nand_wait_for_value(cadence, CTRL_STATUS,
662 TIMEOUT_US,
663 CTRL_STATUS_INIT_COMP, false);
664 if (status)
665 return status;
666
667 reg = readl_relaxed(cadence->reg + CTRL_VERSION);
668 cadence->ctrl_rev = FIELD_GET(CTRL_VERSION_REV, reg);
669
670 dev_info(cadence->dev,
671 "%s: cadence nand controller version reg %x\n",
672 __func__, reg);
673
674 /* Disable cache and multiplane. */
675 writel_relaxed(0, cadence->reg + MULTIPLANE_CFG);
676 writel_relaxed(0, cadence->reg + CACHE_CFG);
677
678 /* Clear all interrupts. */
679 writel_relaxed(0xFFFFFFFF, cadence->reg + INTR_STATUS);
680
681 cadence_nand_get_caps(cadence);
682 if (cadence_nand_read_bch_caps(cadence))
683 return -EIO;
684
685 /*
686 * Set IO width access to 8.
687 * It is because during SW device discovering width access
688 * is expected to be 8.
689 */
690 status = cadence_nand_set_access_width16(cadence, false);
691
692 return status;
693}
694
695#define TT_MAIN_OOB_AREAS 2
696#define TT_RAW_PAGE 3
697#define TT_BBM 4
698#define TT_MAIN_OOB_AREA_EXT 5
699
700/* Prepare size of data to transfer. */
701static void
702cadence_nand_prepare_data_size(struct mtd_info *mtd,
703 int transfer_type)
704{
705 struct nand_chip *chip = mtd_to_nand(mtd);
706 struct cadence_nand_info *cadence = to_cadence_nand_info(chip->controller);
707 struct cdns_nand_chip *cdns_chip = to_cdns_nand_chip(chip);
708 u32 sec_size = 0, offset = 0, sec_cnt = 1;
709 u32 last_sec_size = cdns_chip->sector_size;
710 u32 data_ctrl_size = 0;
711 u32 reg = 0;
712
713 if (cadence->curr_trans_type == transfer_type)
714 return;
715
716 switch (transfer_type) {
717 case TT_MAIN_OOB_AREA_EXT:
718 sec_cnt = cdns_chip->sector_count;
719 sec_size = cdns_chip->sector_size;
720 data_ctrl_size = cdns_chip->avail_oob_size;
721 break;
722 case TT_MAIN_OOB_AREAS:
723 sec_cnt = cdns_chip->sector_count;
724 last_sec_size = cdns_chip->sector_size
725 + cdns_chip->avail_oob_size;
726 sec_size = cdns_chip->sector_size;
727 break;
728 case TT_RAW_PAGE:
729 last_sec_size = mtd->writesize + mtd->oobsize;
730 break;
731 case TT_BBM:
732 offset = mtd->writesize + cdns_chip->bbm_offs;
733 last_sec_size = 8;
734 break;
735 }
736
737 reg = 0;
738 reg |= FIELD_PREP(TRAN_CFG_0_OFFSET, offset);
739 reg |= FIELD_PREP(TRAN_CFG_0_SEC_CNT, sec_cnt);
740 writel_relaxed(reg, cadence->reg + TRAN_CFG_0);
741
742 reg = 0;
743 reg |= FIELD_PREP(TRAN_CFG_1_LAST_SEC_SIZE, last_sec_size);
744 reg |= FIELD_PREP(TRAN_CFG_1_SECTOR_SIZE, sec_size);
745 writel_relaxed(reg, cadence->reg + TRAN_CFG_1);
746
747 if (cadence->caps2.data_control_supp) {
748 reg = readl_relaxed(cadence->reg + CONTROL_DATA_CTRL);
749 reg &= ~CONTROL_DATA_CTRL_SIZE;
750 reg |= FIELD_PREP(CONTROL_DATA_CTRL_SIZE, data_ctrl_size);
751 writel_relaxed(reg, cadence->reg + CONTROL_DATA_CTRL);
752 }
753
754 cadence->curr_trans_type = transfer_type;
755}
756
757static int
758cadence_nand_cdma_transfer(struct cadence_nand_info *cadence, u8 chip_nr,
759 int page, void *buf, void *ctrl_dat, u32 buf_size,
760 u32 ctrl_dat_size, enum dma_data_direction dir,
761 bool with_ecc)
762{
763 dma_addr_t dma_buf, dma_ctrl_dat = 0;
764 u8 thread_nr = chip_nr;
765 int status;
766 u16 ctype;
767
768 if (dir == DMA_FROM_DEVICE)
769 ctype = CDMA_CT_RD;
770 else
771 ctype = CDMA_CT_WR;
772
773 cadence_nand_set_ecc_enable(cadence, with_ecc);
774
775 dma_buf = dma_map_single(buf, buf_size, dir);
776 if (dma_mapping_error(cadence->dev, dma_buf)) {
777 dev_err(cadence->dev, "Failed to map DMA buffer\n");
778 return -EIO;
779 }
780
781 if (ctrl_dat && ctrl_dat_size) {
782 dma_ctrl_dat = dma_map_single(ctrl_dat,
783 ctrl_dat_size, dir);
784 if (dma_mapping_error(cadence->dev, dma_ctrl_dat)) {
785 dma_unmap_single(dma_buf,
786 buf_size, dir);
787 dev_err(cadence->dev, "Failed to map DMA buffer\n");
788 return -EIO;
789 }
790 }
791
792 cadence_nand_cdma_desc_prepare(cadence, chip_nr, page,
793 dma_buf, dma_ctrl_dat, ctype);
794
795 status = cadence_nand_cdma_send_and_wait(cadence, thread_nr);
796
797 dma_unmap_single(dma_buf,
798 buf_size, dir);
799
800 if (ctrl_dat && ctrl_dat_size)
801 dma_unmap_single(dma_ctrl_dat,
802 ctrl_dat_size, dir);
803 if (status)
804 return status;
805
806 return cadence_nand_cdma_finish(cadence);
807}
808
809static void cadence_nand_set_timings(struct cadence_nand_info *cadence,
810 struct cadence_nand_timings *t)
811{
812 writel_relaxed(t->async_toggle_timings,
813 cadence->reg + ASYNC_TOGGLE_TIMINGS);
814 writel_relaxed(t->timings0, cadence->reg + TIMINGS0);
815 writel_relaxed(t->timings1, cadence->reg + TIMINGS1);
816 writel_relaxed(t->timings2, cadence->reg + TIMINGS2);
817
818 if (cadence->caps2.is_phy_type_dll)
819 writel_relaxed(t->dll_phy_ctrl, cadence->reg + DLL_PHY_CTRL);
820
821 writel_relaxed(t->phy_ctrl, cadence->reg + PHY_CTRL);
822
823 if (cadence->caps2.is_phy_type_dll) {
824 writel_relaxed(0, cadence->reg + PHY_TSEL);
825 writel_relaxed(2, cadence->reg + PHY_DQ_TIMING);
826 writel_relaxed(t->phy_dqs_timing,
827 cadence->reg + PHY_DQS_TIMING);
828 writel_relaxed(t->phy_gate_lpbk_ctrl,
829 cadence->reg + PHY_GATE_LPBK_CTRL);
830 writel_relaxed(PHY_DLL_MASTER_CTRL_BYPASS_MODE,
831 cadence->reg + PHY_DLL_MASTER_CTRL);
832 writel_relaxed(0, cadence->reg + PHY_DLL_SLAVE_CTRL);
833 }
834}
835
836static int cadence_nand_select_target(struct nand_chip *chip)
837{
838 struct cadence_nand_info *cadence = to_cadence_nand_info(chip->controller);
839 struct cdns_nand_chip *cdns_chip = to_cdns_nand_chip(chip);
840
841 if (chip == cadence->selected_chip)
842 return 0;
843
844 if (cadence_nand_wait_for_value(cadence, CTRL_STATUS,
845 TIMEOUT_US,
846 CTRL_STATUS_CTRL_BUSY, true))
847 return -ETIMEDOUT;
848
849 cadence_nand_set_timings(cadence, &cdns_chip->timings);
850
851 cadence_nand_set_ecc_strength(cadence,
852 cdns_chip->corr_str_idx);
853
854 cadence_nand_set_erase_detection(cadence, true,
855 chip->ecc.strength);
856
857 cadence->curr_trans_type = -1;
858 cadence->selected_chip = chip;
859
860 return 0;
861}
862
863static int cadence_nand_erase(struct mtd_info *mtd, int page)
864{
865 struct nand_chip *chip = mtd_to_nand(mtd);
866 struct cadence_nand_info *cadence = to_cadence_nand_info(chip->controller);
867 struct cdns_nand_chip *cdns_chip = to_cdns_nand_chip(chip);
868 int status;
869 u8 thread_nr = cdns_chip->cs[chip->cur_cs];
870
871 cadence_nand_cdma_desc_prepare(cadence,
872 cdns_chip->cs[chip->cur_cs],
873 page, 0, 0,
874 CDMA_CT_ERASE);
875 status = cadence_nand_cdma_send_and_wait(cadence, thread_nr);
876 if (status) {
877 dev_err(cadence->dev, "erase operation failed\n");
878 return -EIO;
879 }
880
881 status = cadence_nand_cdma_finish(cadence);
882 if (status)
883 return status;
884
885 return 0;
886}
887
888static int cadence_ecc_setup(struct mtd_info *mtd, struct nand_chip *chip, int oobavail)
889{
890 struct cadence_nand_info *cadence = to_cadence_nand_info(chip->controller);
891 int ret;
892
893 /*
894 * If .size and .strength are already set (usually by DT),
895 * check if they are supported by this controller.
896 */
897 if (chip->ecc.size && chip->ecc.strength)
898 return nand_check_ecc_caps(chip, &cadence->ecc_caps, oobavail);
899
900 /*
901 * We want .size and .strength closest to the chip's requirement
902 * unless NAND_ECC_MAXIMIZE is requested.
903 */
904 if (!(chip->ecc.options & NAND_ECC_MAXIMIZE)) {
905 ret = nand_match_ecc_req(chip, &cadence->ecc_caps, oobavail);
906 if (!ret)
907 return 0;
908 }
909
910 /* Max ECC strength is the last thing we can do */
911 return nand_maximize_ecc(chip, &cadence->ecc_caps, oobavail);
912}
913
914static int cadence_nand_read_bbm(struct mtd_info *mtd, struct nand_chip *chip, int page, u8 *buf)
915{
916 int status;
917 struct cadence_nand_info *cadence = to_cadence_nand_info(chip->controller);
918 struct cdns_nand_chip *cdns_chip = to_cdns_nand_chip(chip);
919
920 cadence_nand_prepare_data_size(mtd, TT_BBM);
921
922 cadence_nand_set_skip_bytes_conf(cadence, 0, 0, 0);
923
924 /*
925 * Read only bad block marker from offset
926 * defined by a memory manufacturer.
927 */
928 status = cadence_nand_cdma_transfer(cadence,
929 cdns_chip->cs[chip->cur_cs],
930 page, cadence->buf, NULL,
931 mtd->oobsize,
932 0, DMA_FROM_DEVICE, false);
933 if (status) {
934 dev_err(cadence->dev, "read BBM failed\n");
935 return -EIO;
936 }
937
938 memcpy(buf + cdns_chip->bbm_offs, cadence->buf, cdns_chip->bbm_len);
939
940 return 0;
941}
942
943static int cadence_nand_write_page(struct mtd_info *mtd, struct nand_chip *chip,
944 const u8 *buf, int oob_required, int page)
945{
946 struct cadence_nand_info *cadence = to_cadence_nand_info(chip->controller);
947 struct cdns_nand_chip *cdns_chip = to_cdns_nand_chip(chip);
948 int status;
949 u16 marker_val = 0xFFFF;
950
951 status = cadence_nand_select_target(chip);
952 if (status)
953 return status;
954
955 cadence_nand_set_skip_bytes_conf(cadence, cdns_chip->bbm_len,
956 mtd->writesize
957 + cdns_chip->bbm_offs,
958 1);
959
960 if (oob_required) {
961 marker_val = *(u16 *)(chip->oob_poi
962 + cdns_chip->bbm_offs);
963 } else {
964 /* Set oob data to 0xFF. */
965 memset(cadence->buf + mtd->writesize, 0xFF,
966 cdns_chip->avail_oob_size);
967 }
968
969 cadence_nand_set_skip_marker_val(cadence, marker_val);
970
971 cadence_nand_prepare_data_size(mtd, TT_MAIN_OOB_AREA_EXT);
972
973 if (cadence_nand_dma_buf_ok(cadence, buf, mtd->writesize) &&
974 cadence->caps2.data_control_supp) {
975 u8 *oob;
976
977 if (oob_required)
978 oob = chip->oob_poi;
979 else
980 oob = cadence->buf + mtd->writesize;
981
982 status = cadence_nand_cdma_transfer(cadence,
983 cdns_chip->cs[chip->cur_cs],
984 page, (void *)buf, oob,
985 mtd->writesize,
986 cdns_chip->avail_oob_size,
987 DMA_TO_DEVICE, true);
988 if (status) {
989 dev_err(cadence->dev, "write page failed\n");
990 return -EIO;
991 }
992
993 return 0;
994 }
995
996 if (oob_required) {
997 /* Transfer the data to the oob area. */
998 memcpy(cadence->buf + mtd->writesize, chip->oob_poi,
999 cdns_chip->avail_oob_size);
1000 }
1001
1002 memcpy(cadence->buf, buf, mtd->writesize);
1003
1004 cadence_nand_prepare_data_size(mtd, TT_MAIN_OOB_AREAS);
1005
1006 return cadence_nand_cdma_transfer(cadence,
1007 cdns_chip->cs[chip->cur_cs],
1008 page, cadence->buf, NULL,
1009 mtd->writesize
1010 + cdns_chip->avail_oob_size,
1011 0, DMA_TO_DEVICE, true);
1012}
1013
1014static int cadence_nand_write_oob(struct mtd_info *mtd, struct nand_chip *chip,
1015 int page)
1016{
1017 struct cadence_nand_info *cadence = to_cadence_nand_info(chip->controller);
1018
1019 memset(cadence->buf, 0xFF, mtd->writesize);
1020
1021 return cadence_nand_write_page(mtd, chip, cadence->buf, 1, page);
1022}
1023
1024static int cadence_nand_write_page_raw(struct mtd_info *mtd, struct nand_chip *chip,
1025 const u8 *buf, int oob_required, int page)
1026{
1027 struct cadence_nand_info *cadence = to_cadence_nand_info(chip->controller);
1028 struct cdns_nand_chip *cdns_chip = to_cdns_nand_chip(chip);
1029 int writesize = mtd->writesize;
1030 int oobsize = mtd->oobsize;
1031 int ecc_steps = chip->ecc.steps;
1032 int ecc_size = chip->ecc.size;
1033 int ecc_bytes = chip->ecc.bytes;
1034 void *tmp_buf = cadence->buf;
1035 int oob_skip = cdns_chip->bbm_len;
1036 size_t size = writesize + oobsize;
1037 int i, pos, len;
1038 int status;
1039
1040 status = cadence_nand_select_target(chip);
1041 if (status)
1042 return status;
1043
1044 /*
1045 * Fill the buffer with 0xff first except the full page transfer.
1046 * This simplifies the logic.
1047 */
1048 if (!buf || !oob_required)
1049 memset(tmp_buf, 0xff, size);
1050
1051 cadence_nand_set_skip_bytes_conf(cadence, 0, 0, 0);
1052
1053 /* Arrange the buffer for syndrome payload/ecc layout. */
1054 if (buf) {
1055 for (i = 0; i < ecc_steps; i++) {
1056 pos = i * (ecc_size + ecc_bytes);
1057 len = ecc_size;
1058
1059 if (pos >= writesize)
1060 pos += oob_skip;
1061 else if (pos + len > writesize)
1062 len = writesize - pos;
1063
1064 memcpy(tmp_buf + pos, buf, len);
1065 buf += len;
1066 if (len < ecc_size) {
1067 len = ecc_size - len;
1068 memcpy(tmp_buf + writesize + oob_skip, buf,
1069 len);
1070 buf += len;
1071 }
1072 }
1073 }
1074
1075 if (oob_required) {
1076 const u8 *oob = chip->oob_poi;
1077 u32 oob_data_offset = (cdns_chip->sector_count - 1) *
1078 (cdns_chip->sector_size + chip->ecc.bytes)
1079 + cdns_chip->sector_size + oob_skip;
1080
1081 /* BBM at the beginning of the OOB area. */
1082 memcpy(tmp_buf + writesize, oob, oob_skip);
1083
1084 /* OOB free. */
1085 memcpy(tmp_buf + oob_data_offset, oob,
1086 cdns_chip->avail_oob_size);
1087 oob += cdns_chip->avail_oob_size;
1088
1089 /* OOB ECC. */
1090 for (i = 0; i < ecc_steps; i++) {
1091 pos = ecc_size + i * (ecc_size + ecc_bytes);
1092 if (i == (ecc_steps - 1))
1093 pos += cdns_chip->avail_oob_size;
1094
1095 len = ecc_bytes;
1096
1097 if (pos >= writesize)
1098 pos += oob_skip;
1099 else if (pos + len > writesize)
1100 len = writesize - pos;
1101
1102 memcpy(tmp_buf + pos, oob, len);
1103 oob += len;
1104 if (len < ecc_bytes) {
1105 len = ecc_bytes - len;
1106 memcpy(tmp_buf + writesize + oob_skip, oob,
1107 len);
1108 oob += len;
1109 }
1110 }
1111 }
1112
1113 cadence_nand_prepare_data_size(mtd, TT_RAW_PAGE);
1114
1115 return cadence_nand_cdma_transfer(cadence,
1116 cdns_chip->cs[chip->cur_cs],
1117 page, cadence->buf, NULL,
1118 mtd->writesize +
1119 mtd->oobsize,
1120 0, DMA_TO_DEVICE, false);
1121}
1122
1123static int cadence_nand_write_oob_raw(struct mtd_info *mtd, struct nand_chip *chip,
1124 int page)
1125{
1126 return cadence_nand_write_page_raw(mtd, chip, NULL, true, page);
1127}
1128
1129static int cadence_nand_read_page(struct mtd_info *mtd, struct nand_chip *chip,
1130 u8 *buf, int oob_required, int page)
1131{
1132 struct cadence_nand_info *cadence = to_cadence_nand_info(chip->controller);
1133 struct cdns_nand_chip *cdns_chip = to_cdns_nand_chip(chip);
1134 int status;
1135 int ecc_err_count = 0;
1136
1137 status = cadence_nand_select_target(chip);
1138 if (status)
1139 return status;
1140
1141 cadence_nand_set_skip_bytes_conf(cadence, cdns_chip->bbm_len,
1142 mtd->writesize
1143 + cdns_chip->bbm_offs, 1);
1144
1145 /*
1146 * If data buffer can be accessed by DMA and data_control feature
1147 * is supported then transfer data and oob directly.
1148 */
1149 if (cadence_nand_dma_buf_ok(cadence, buf, mtd->writesize) &&
1150 cadence->caps2.data_control_supp) {
1151 u8 *oob;
1152
1153 if (oob_required)
1154 oob = chip->oob_poi;
1155 else
1156 oob = cadence->buf + mtd->writesize;
1157
1158 cadence_nand_prepare_data_size(mtd, TT_MAIN_OOB_AREA_EXT);
1159 status = cadence_nand_cdma_transfer(cadence,
1160 cdns_chip->cs[chip->cur_cs],
1161 page, buf, oob,
1162 mtd->writesize,
1163 cdns_chip->avail_oob_size,
1164 DMA_FROM_DEVICE, true);
1165 /* Otherwise use bounce buffer. */
1166 } else {
1167 cadence_nand_prepare_data_size(mtd, TT_MAIN_OOB_AREAS);
1168 status = cadence_nand_cdma_transfer(cadence,
1169 cdns_chip->cs[chip->cur_cs],
1170 page, cadence->buf,
1171 NULL, mtd->writesize
1172 + cdns_chip->avail_oob_size,
1173 0, DMA_FROM_DEVICE, true);
1174
1175 memcpy(buf, cadence->buf, mtd->writesize);
1176 if (oob_required)
1177 memcpy(chip->oob_poi,
1178 cadence->buf + mtd->writesize,
1179 mtd->oobsize);
1180 }
1181
1182 switch (status) {
1183 case STAT_ECC_UNCORR:
1184 mtd->ecc_stats.failed++;
1185 ecc_err_count++;
1186 break;
1187 case STAT_ECC_CORR:
1188 ecc_err_count = FIELD_GET(CDMA_CS_MAXERR,
1189 cadence->cdma_desc->status);
1190 mtd->ecc_stats.corrected += ecc_err_count;
1191 break;
1192 case STAT_ERASED:
1193 case STAT_OK:
1194 break;
1195 default:
1196 dev_err(cadence->dev, "read page failed\n");
1197 return -EIO;
1198 }
1199
1200 if (oob_required)
1201 if (cadence_nand_read_bbm(mtd, chip, page, chip->oob_poi))
1202 return -EIO;
1203
1204 return ecc_err_count;
1205}
1206
1207static int cadence_nand_read_oob(struct mtd_info *mtd, struct nand_chip *chip,
1208 int page)
1209{
1210 struct cadence_nand_info *cadence = to_cadence_nand_info(chip->controller);
1211
1212 return cadence_nand_read_page(mtd, chip, cadence->buf, 1, page);
1213}
1214
1215static int cadence_nand_read_page_raw(struct mtd_info *mtd, struct nand_chip *chip,
1216 u8 *buf, int oob_required, int page)
1217{
1218 struct cadence_nand_info *cadence = to_cadence_nand_info(chip->controller);
1219 struct cdns_nand_chip *cdns_chip = to_cdns_nand_chip(chip);
1220 int oob_skip = cdns_chip->bbm_len;
1221 int writesize = mtd->writesize;
1222 int ecc_steps = chip->ecc.steps;
1223 int ecc_size = chip->ecc.size;
1224 int ecc_bytes = chip->ecc.bytes;
1225 void *tmp_buf = cadence->buf;
1226 int i, pos, len;
1227 int status;
1228
1229 status = cadence_nand_select_target(chip);
1230 if (status)
1231 return status;
1232
1233 cadence_nand_set_skip_bytes_conf(cadence, 0, 0, 0);
1234
1235 cadence_nand_prepare_data_size(mtd, TT_RAW_PAGE);
1236 status = cadence_nand_cdma_transfer(cadence,
1237 cdns_chip->cs[chip->cur_cs],
1238 page, cadence->buf, NULL,
1239 mtd->writesize
1240 + mtd->oobsize,
1241 0, DMA_FROM_DEVICE, false);
1242
1243 switch (status) {
1244 case STAT_ERASED:
1245 case STAT_OK:
1246 break;
1247 default:
1248 dev_err(cadence->dev, "read raw page failed\n");
1249 return -EIO;
1250 }
1251
1252 /* Arrange the buffer for syndrome payload/ecc layout. */
1253 if (buf) {
1254 for (i = 0; i < ecc_steps; i++) {
1255 pos = i * (ecc_size + ecc_bytes);
1256 len = ecc_size;
1257
1258 if (pos >= writesize)
1259 pos += oob_skip;
1260 else if (pos + len > writesize)
1261 len = writesize - pos;
1262
1263 memcpy(buf, tmp_buf + pos, len);
1264 buf += len;
1265 if (len < ecc_size) {
1266 len = ecc_size - len;
1267 memcpy(buf, tmp_buf + writesize + oob_skip,
1268 len);
1269 buf += len;
1270 }
1271 }
1272 }
1273
1274 if (oob_required) {
1275 u8 *oob = chip->oob_poi;
1276 u32 oob_data_offset = (cdns_chip->sector_count - 1) *
1277 (cdns_chip->sector_size + chip->ecc.bytes)
1278 + cdns_chip->sector_size + oob_skip;
1279
1280 /* OOB free. */
1281 memcpy(oob, tmp_buf + oob_data_offset,
1282 cdns_chip->avail_oob_size);
1283
1284 /* BBM at the beginning of the OOB area. */
1285 memcpy(oob, tmp_buf + writesize, oob_skip);
1286
1287 oob += cdns_chip->avail_oob_size;
1288
1289 /* OOB ECC */
1290 for (i = 0; i < ecc_steps; i++) {
1291 pos = ecc_size + i * (ecc_size + ecc_bytes);
1292 len = ecc_bytes;
1293
1294 if (i == (ecc_steps - 1))
1295 pos += cdns_chip->avail_oob_size;
1296
1297 if (pos >= writesize)
1298 pos += oob_skip;
1299 else if (pos + len > writesize)
1300 len = writesize - pos;
1301
1302 memcpy(oob, tmp_buf + pos, len);
1303 oob += len;
1304 if (len < ecc_bytes) {
1305 len = ecc_bytes - len;
1306 memcpy(oob, tmp_buf + writesize + oob_skip,
1307 len);
1308 oob += len;
1309 }
1310 }
1311 }
1312 return 0;
1313}
1314
1315static int cadence_nand_read_oob_raw(struct mtd_info *mtd, struct nand_chip *chip,
1316 int page)
1317{
1318 return cadence_nand_read_page_raw(mtd, chip, NULL, true, page);
1319}
1320
1321static void cadence_nand_read_buf(struct mtd_info *mtd, u8 *buf, int len)
1322{
1323 struct nand_chip *chip = mtd_to_nand(mtd);
1324 struct cadence_nand_info *cadence = to_cadence_nand_info(chip->controller);
1325 u8 thread_nr = 0;
1326 u32 sdma_size;
1327 int status;
1328 int len_in_words = len >> 2;
1329
1330 /* Wait until slave DMA interface is ready to data transfer. */
1331 status = cadence_nand_wait_on_sdma(cadence, &thread_nr, &sdma_size);
1332 if (status) {
1333 pr_err("Wait on sdma failed:%x\n", status);
1334 hang();
1335 }
1336
1337 if (!cadence->caps1->has_dma) {
1338 readsq(cadence->io.virt, buf, len_in_words);
1339
1340 if (sdma_size > len) {
1341 memcpy(cadence->buf, buf + (len_in_words << 2),
1342 len - (len_in_words << 2));
1343 readsl(cadence->io.virt, cadence->buf,
1344 sdma_size / 4 - len_in_words);
1345 }
1346 }
1347}
1348
1349static void cadence_nand_write_buf(struct mtd_info *mtd, const u8 *buf, int len)
1350{
1351 struct nand_chip *chip = mtd_to_nand(mtd);
1352 struct cadence_nand_info *cadence = to_cadence_nand_info(chip->controller);
1353 u8 thread_nr = 0;
1354 u32 sdma_size;
1355 int status;
1356 int len_in_words = len >> 2;
1357
1358 /* Wait until slave DMA interface is ready to data transfer. */
1359 status = cadence_nand_wait_on_sdma(cadence, &thread_nr, &sdma_size);
1360 if (status) {
1361 pr_err("Wait on sdma failed:%x\n", status);
1362 hang();
1363 }
1364
1365 if (!cadence->caps1->has_dma) {
1366 writesq(cadence->io.virt, buf, len_in_words);
1367
1368 if (sdma_size > len) {
1369 memcpy(cadence->buf, buf + (len_in_words << 2),
1370 len - (len_in_words << 2));
1371 writesl(cadence->io.virt, cadence->buf,
1372 sdma_size / 4 - len_in_words);
1373 }
1374 }
1375}
1376
1377static int cadence_nand_cmd_opcode(struct nand_chip *chip, unsigned int op_id)
1378{
1379 struct cadence_nand_info *cadence = to_cadence_nand_info(chip->controller);
1380 struct cdns_nand_chip *cdns_chip = to_cdns_nand_chip(chip);
1381 u64 mini_ctrl_cmd = 0;
1382 int ret;
1383
1384 mini_ctrl_cmd |= GCMD_LAY_TWB;
1385 mini_ctrl_cmd |= FIELD_PREP(GCMD_LAY_INSTR, GCMD_LAY_INSTR_CMD);
1386 mini_ctrl_cmd |= FIELD_PREP(GCMD_LAY_INPUT_CMD, op_id);
1387
1388 ret = cadence_nand_generic_cmd_send(cadence,
1389 cdns_chip->cs[chip->cur_cs],
1390 mini_ctrl_cmd);
1391
1392 if (ret)
1393 dev_err(cadence->dev, "send cmd %x failed\n",
1394 op_id);
1395
1396 return ret;
1397}
1398
1399static int cadence_nand_cmd_address(struct nand_chip *chip,
1400 unsigned int naddrs, const u8 *addrs)
1401{
1402 struct cadence_nand_info *cadence = to_cadence_nand_info(chip->controller);
1403 struct cdns_nand_chip *cdns_chip = to_cdns_nand_chip(chip);
1404 u64 address = 0;
1405 u64 mini_ctrl_cmd = 0;
1406 int ret;
1407 int i;
1408
1409 mini_ctrl_cmd |= GCMD_LAY_TWB;
1410
1411 mini_ctrl_cmd |= FIELD_PREP(GCMD_LAY_INSTR,
1412 GCMD_LAY_INSTR_ADDR);
1413
1414 for (i = 0; i < naddrs; i++)
1415 address |= (u64)addrs[i] << (8 * i);
1416
1417 mini_ctrl_cmd |= FIELD_PREP(GCMD_LAY_INPUT_ADDR,
1418 address);
1419 mini_ctrl_cmd |= FIELD_PREP(GCMD_LAY_INPUT_ADDR_SIZE,
1420 naddrs - 1);
1421
1422 ret = cadence_nand_generic_cmd_send(cadence,
1423 cdns_chip->cs[chip->cur_cs],
1424 mini_ctrl_cmd);
1425
1426 if (ret)
1427 pr_err("send address %llx failed\n", address);
1428
1429 return ret;
1430}
1431
1432static int cadence_nand_cmd_data(struct nand_chip *chip,
1433 unsigned int len, u8 mode)
1434{
1435 struct cadence_nand_info *cadence = to_cadence_nand_info(chip->controller);
1436 struct cdns_nand_chip *cdns_chip = to_cdns_nand_chip(chip);
1437 u64 mini_ctrl_cmd = 0;
1438 int ret;
1439
1440 mini_ctrl_cmd |= GCMD_LAY_TWB;
1441 mini_ctrl_cmd |= FIELD_PREP(GCMD_LAY_INSTR,
1442 GCMD_LAY_INSTR_DATA);
1443
1444 if (mode)
1445 mini_ctrl_cmd |= FIELD_PREP(GCMD_DIR, GCMD_DIR_WRITE);
1446
1447 mini_ctrl_cmd |= FIELD_PREP(GCMD_SECT_CNT, 1);
1448 mini_ctrl_cmd |= FIELD_PREP(GCMD_LAST_SIZE, len);
1449
1450 ret = cadence_nand_generic_cmd_send(cadence,
1451 cdns_chip->cs[chip->cur_cs],
1452 mini_ctrl_cmd);
1453
1454 if (ret) {
1455 pr_err("send generic data cmd failed\n");
1456 return ret;
1457 }
1458
1459 return ret;
1460}
1461
1462static int cadence_nand_waitfunc(struct mtd_info *mtd, struct nand_chip *chip)
1463{
1464 struct cadence_nand_info *cadence = to_cadence_nand_info(chip->controller);
1465 struct cdns_nand_chip *cdns_chip = to_cdns_nand_chip(chip);
1466 int status;
1467
1468 status = cadence_nand_wait_for_value(cadence, RBN_SETINGS,
1469 TIMEOUT_US,
1470 BIT(cdns_chip->cs[chip->cur_cs]),
1471 false);
1472 return status;
1473}
1474
1475static int cadence_nand_ooblayout_free(struct mtd_info *mtd, int section,
1476 struct mtd_oob_region *oobregion)
1477{
1478 struct nand_chip *chip = mtd_to_nand(mtd);
1479 struct cdns_nand_chip *cdns_chip = to_cdns_nand_chip(chip);
1480
1481 if (section)
1482 return -ERANGE;
1483
1484 oobregion->offset = cdns_chip->bbm_len;
1485 oobregion->length = cdns_chip->avail_oob_size
1486 - cdns_chip->bbm_len;
1487
1488 return 0;
1489}
1490
1491static int cadence_nand_ooblayout_ecc(struct mtd_info *mtd, int section,
1492 struct mtd_oob_region *oobregion)
1493{
1494 struct nand_chip *chip = mtd_to_nand(mtd);
1495 struct cdns_nand_chip *cdns_chip = to_cdns_nand_chip(chip);
1496
1497 if (section)
1498 return -ERANGE;
1499
1500 oobregion->offset = cdns_chip->avail_oob_size;
1501 oobregion->length = chip->ecc.total;
1502
1503 return 0;
1504}
1505
1506static const struct mtd_ooblayout_ops cadence_nand_ooblayout_ops = {
1507 .rfree = cadence_nand_ooblayout_free,
1508 .ecc = cadence_nand_ooblayout_ecc,
1509};
1510
1511static int calc_cycl(u32 timing, u32 clock)
1512{
1513 if (timing == 0 || clock == 0)
1514 return 0;
1515
1516 if ((timing % clock) > 0)
1517 return timing / clock;
1518 else
1519 return timing / clock - 1;
1520}
1521
1522/* Calculate max data valid window. */
1523static inline u32 calc_tdvw_max(u32 trp_cnt, u32 clk_period, u32 trhoh_min,
1524 u32 board_delay_skew_min, u32 ext_mode)
1525{
1526 if (ext_mode == 0)
1527 clk_period /= 2;
1528
1529 return (trp_cnt + 1) * clk_period + trhoh_min +
1530 board_delay_skew_min;
1531}
1532
1533/* Calculate data valid window. */
1534static inline u32 calc_tdvw(u32 trp_cnt, u32 clk_period, u32 trhoh_min,
1535 u32 trea_max, u32 ext_mode)
1536{
1537 if (ext_mode == 0)
1538 clk_period /= 2;
1539
1540 return (trp_cnt + 1) * clk_period + trhoh_min - trea_max;
1541}
1542
1543static inline int of_get_child_count(const ofnode node)
1544{
1545 return fdtdec_get_child_count(gd->fdt_blob, ofnode_to_offset(node));
1546}
1547
1548static int cadence_setup_data_interface(struct mtd_info *mtd, int chipnr,
1549 const struct nand_data_interface *conf)
1550{
1551 struct nand_chip *chip = mtd_to_nand(mtd);
1552 struct cadence_nand_info *cadence = to_cadence_nand_info(chip->controller);
1553 struct cdns_nand_chip *cdns_chip = to_cdns_nand_chip(mtd_to_nand(mtd));
1554 const struct nand_sdr_timings *sdr;
1555 struct cadence_nand_timings *t = &cdns_chip->timings;
1556 u32 reg;
1557 u32 board_delay = cadence->board_delay;
1558 u32 clk_period = DIV_ROUND_DOWN_ULL(1000000000000ULL,
1559 cadence->nf_clk_rate);
1560 u32 tceh_cnt, tcs_cnt, tadl_cnt, tccs_cnt;
1561 u32 tfeat_cnt, trhz_cnt, tvdly_cnt;
1562 u32 trhw_cnt, twb_cnt, twh_cnt = 0, twhr_cnt;
1563 u32 twp_cnt = 0, trp_cnt = 0, trh_cnt = 0;
1564 u32 if_skew = cadence->caps1->if_skew;
1565 u32 board_delay_skew_min = board_delay - if_skew;
1566 u32 board_delay_skew_max = board_delay + if_skew;
1567 u32 dqs_sampl_res, phony_dqs_mod;
1568 u32 tdvw, tdvw_min, tdvw_max;
1569 u32 ext_rd_mode, ext_wr_mode;
1570 u32 dll_phy_dqs_timing = 0, phony_dqs_timing = 0, rd_del_sel = 0;
1571 u32 sampling_point;
1572
1573 sdr = nand_get_sdr_timings(conf);
1574 if (IS_ERR(sdr))
1575 return PTR_ERR(sdr);
1576
1577 memset(t, 0, sizeof(*t));
1578 /* Sampling point calculation. */
1579 if (cadence->caps2.is_phy_type_dll)
1580 phony_dqs_mod = 2;
1581 else
1582 phony_dqs_mod = 1;
1583
1584 dqs_sampl_res = clk_period / phony_dqs_mod;
1585
1586 tdvw_min = sdr->tREA_max + board_delay_skew_max;
1587 /*
1588 * The idea of those calculation is to get the optimum value
1589 * for tRP and tRH timings. If it is NOT possible to sample data
1590 * with optimal tRP/tRH settings, the parameters will be extended.
1591 * If clk_period is 50ns (the lowest value) this condition is met
1592 * for SDR timing modes 1, 2, 3, 4 and 5.
1593 * If clk_period is 20ns the condition is met only for SDR timing
1594 * mode 5.
1595 */
1596 if (sdr->tRC_min <= clk_period &&
1597 sdr->tRP_min <= (clk_period / 2) &&
1598 sdr->tREH_min <= (clk_period / 2)) {
1599 /* Performance mode. */
1600 ext_rd_mode = 0;
1601 tdvw = calc_tdvw(trp_cnt, clk_period, sdr->tRHOH_min,
1602 sdr->tREA_max, ext_rd_mode);
1603 tdvw_max = calc_tdvw_max(trp_cnt, clk_period, sdr->tRHOH_min,
1604 board_delay_skew_min,
1605 ext_rd_mode);
1606 /*
1607 * Check if data valid window and sampling point can be found
1608 * and is not on the edge (ie. we have hold margin).
1609 * If not extend the tRP timings.
1610 */
1611 if (tdvw > 0) {
1612 if (tdvw_max <= tdvw_min ||
1613 (tdvw_max % dqs_sampl_res) == 0) {
1614 /*
1615 * No valid sampling point so the RE pulse need
1616 * to be widen widening by half clock cycle.
1617 */
1618 ext_rd_mode = 1;
1619 }
1620 } else {
1621 /*
1622 * There is no valid window
1623 * to be able to sample data the tRP need to be widen.
1624 * Very safe calculations are performed here.
1625 */
1626 trp_cnt = (sdr->tREA_max + board_delay_skew_max
1627 + dqs_sampl_res) / clk_period;
1628 ext_rd_mode = 1;
1629 }
1630
1631 } else {
1632 /* Extended read mode. */
1633 u32 trh;
1634
1635 ext_rd_mode = 1;
1636 trp_cnt = calc_cycl(sdr->tRP_min, clk_period);
1637 trh = sdr->tRC_min - ((trp_cnt + 1) * clk_period);
1638 if (sdr->tREH_min >= trh)
1639 trh_cnt = calc_cycl(sdr->tREH_min, clk_period);
1640 else
1641 trh_cnt = calc_cycl(trh, clk_period);
1642
1643 tdvw = calc_tdvw(trp_cnt, clk_period, sdr->tRHOH_min,
1644 sdr->tREA_max, ext_rd_mode);
1645 /*
1646 * Check if data valid window and sampling point can be found
1647 * or if it is at the edge check if previous is valid
1648 * - if not extend the tRP timings.
1649 */
1650 if (tdvw > 0) {
1651 tdvw_max = calc_tdvw_max(trp_cnt, clk_period,
1652 sdr->tRHOH_min,
1653 board_delay_skew_min,
1654 ext_rd_mode);
1655
1656 if ((((tdvw_max / dqs_sampl_res)
1657 * dqs_sampl_res) <= tdvw_min) ||
1658 (((tdvw_max % dqs_sampl_res) == 0) &&
1659 (((tdvw_max / dqs_sampl_res - 1)
1660 * dqs_sampl_res) <= tdvw_min))) {
1661 /*
1662 * Data valid window width is lower than
1663 * sampling resolution and do not hit any
1664 * sampling point to be sure the sampling point
1665 * will be found the RE low pulse width will be
1666 * extended by one clock cycle.
1667 */
1668 trp_cnt = trp_cnt + 1;
1669 }
1670 } else {
1671 /*
1672 * There is no valid window to be able to sample data.
1673 * The tRP need to be widen.
1674 * Very safe calculations are performed here.
1675 */
1676 trp_cnt = (sdr->tREA_max + board_delay_skew_max
1677 + dqs_sampl_res) / clk_period;
1678 }
1679 }
1680
1681 tdvw_max = calc_tdvw_max(trp_cnt, clk_period,
1682 sdr->tRHOH_min,
1683 board_delay_skew_min, ext_rd_mode);
1684
1685 if (sdr->tWC_min <= clk_period &&
1686 (sdr->tWP_min + if_skew) <= (clk_period / 2) &&
1687 (sdr->tWH_min + if_skew) <= (clk_period / 2)) {
1688 ext_wr_mode = 0;
1689 } else {
1690 u32 twh;
1691
1692 ext_wr_mode = 1;
1693 twp_cnt = calc_cycl(sdr->tWP_min + if_skew, clk_period);
1694 if ((twp_cnt + 1) * clk_period < (sdr->tALS_min + if_skew))
1695 twp_cnt = calc_cycl(sdr->tALS_min + if_skew,
1696 clk_period);
1697
1698 twh = (sdr->tWC_min - (twp_cnt + 1) * clk_period);
1699 if (sdr->tWH_min >= twh)
1700 twh = sdr->tWH_min;
1701
1702 twh_cnt = calc_cycl(twh + if_skew, clk_period);
1703 }
1704
1705 reg = FIELD_PREP(ASYNC_TOGGLE_TIMINGS_TRH, trh_cnt);
1706 reg |= FIELD_PREP(ASYNC_TOGGLE_TIMINGS_TRP, trp_cnt);
1707 reg |= FIELD_PREP(ASYNC_TOGGLE_TIMINGS_TWH, twh_cnt);
1708 reg |= FIELD_PREP(ASYNC_TOGGLE_TIMINGS_TWP, twp_cnt);
1709 t->async_toggle_timings = reg;
1710 dev_dbg(cadence->dev, "ASYNC_TOGGLE_TIMINGS_SDR\t%x\n", reg);
1711
1712 tadl_cnt = calc_cycl((sdr->tADL_min + if_skew), clk_period);
1713 tccs_cnt = calc_cycl((sdr->tCCS_min + if_skew), clk_period);
1714 twhr_cnt = calc_cycl((sdr->tWHR_min + if_skew), clk_period);
1715 trhw_cnt = calc_cycl((sdr->tRHW_min + if_skew), clk_period);
1716 reg = FIELD_PREP(TIMINGS0_TADL, tadl_cnt);
1717
1718 /*
1719 * If timing exceeds delay field in timing register
1720 * then use maximum value.
1721 */
1722 if (FIELD_FIT(TIMINGS0_TCCS, tccs_cnt))
1723 reg |= FIELD_PREP(TIMINGS0_TCCS, tccs_cnt);
1724 else
1725 reg |= TIMINGS0_TCCS;
1726
1727 reg |= FIELD_PREP(TIMINGS0_TWHR, twhr_cnt);
1728 reg |= FIELD_PREP(TIMINGS0_TRHW, trhw_cnt);
1729 t->timings0 = reg;
1730 dev_dbg(cadence->dev, "TIMINGS0_SDR\t%x\n", reg);
1731
1732 /* The following is related to single signal so skew is not needed. */
1733 trhz_cnt = calc_cycl(sdr->tRHZ_max, clk_period);
1734 trhz_cnt = trhz_cnt + 1;
1735 twb_cnt = calc_cycl((sdr->tWB_max + board_delay), clk_period);
1736 /*
1737 * Because of the two stage syncflop the value must be increased by 3
1738 * first value is related with sync, second value is related
1739 * with output if delay.
1740 */
1741 twb_cnt = twb_cnt + 3 + 5;
1742 /*
1743 * The following is related to the we edge of the random data input
1744 * sequence so skew is not needed.
1745 */
1746 tvdly_cnt = calc_cycl(500000 + if_skew, clk_period);
1747 reg = FIELD_PREP(TIMINGS1_TRHZ, trhz_cnt);
1748 reg |= FIELD_PREP(TIMINGS1_TWB, twb_cnt);
1749 reg |= FIELD_PREP(TIMINGS1_TVDLY, tvdly_cnt);
1750 t->timings1 = reg;
1751 dev_dbg(cadence->dev, "TIMINGS1_SDR\t%x\n", reg);
1752
1753 tfeat_cnt = calc_cycl(sdr->tFEAT_max, clk_period);
1754 if (tfeat_cnt < twb_cnt)
1755 tfeat_cnt = twb_cnt;
1756
1757 tceh_cnt = calc_cycl(sdr->tCEH_min, clk_period);
1758 tcs_cnt = calc_cycl((sdr->tCS_min + if_skew), clk_period);
1759
1760 reg = FIELD_PREP(TIMINGS2_TFEAT, tfeat_cnt);
1761 reg |= FIELD_PREP(TIMINGS2_CS_HOLD_TIME, tceh_cnt);
1762 reg |= FIELD_PREP(TIMINGS2_CS_SETUP_TIME, tcs_cnt);
1763 t->timings2 = reg;
1764 dev_dbg(cadence->dev, "TIMINGS2_SDR\t%x\n", reg);
1765
1766 if (cadence->caps2.is_phy_type_dll) {
1767 reg = DLL_PHY_CTRL_DLL_RST_N;
1768 if (ext_wr_mode)
1769 reg |= DLL_PHY_CTRL_EXTENDED_WR_MODE;
1770 if (ext_rd_mode)
1771 reg |= DLL_PHY_CTRL_EXTENDED_RD_MODE;
1772
1773 reg |= FIELD_PREP(DLL_PHY_CTRL_RS_HIGH_WAIT_CNT, 7);
1774 reg |= FIELD_PREP(DLL_PHY_CTRL_RS_IDLE_CNT, 7);
1775 t->dll_phy_ctrl = reg;
1776 dev_dbg(cadence->dev, "DLL_PHY_CTRL_SDR\t%x\n", reg);
1777 }
1778
1779 /* Sampling point calculation. */
1780 if ((tdvw_max % dqs_sampl_res) > 0)
1781 sampling_point = tdvw_max / dqs_sampl_res;
1782 else
1783 sampling_point = (tdvw_max / dqs_sampl_res - 1);
1784
1785 if (sampling_point * dqs_sampl_res > tdvw_min) {
1786 dll_phy_dqs_timing =
1787 FIELD_PREP(PHY_DQS_TIMING_DQS_SEL_OE_END, 4);
1788 dll_phy_dqs_timing |= PHY_DQS_TIMING_USE_PHONY_DQS;
1789 phony_dqs_timing = sampling_point / phony_dqs_mod;
1790
1791 if ((sampling_point % 2) > 0) {
1792 dll_phy_dqs_timing |= PHY_DQS_TIMING_PHONY_DQS_SEL;
1793 if ((tdvw_max % dqs_sampl_res) == 0)
1794 /*
1795 * Calculation for sampling point at the edge
1796 * of data and being odd number.
1797 */
1798 phony_dqs_timing = (tdvw_max / dqs_sampl_res)
1799 / phony_dqs_mod - 1;
1800
1801 if (!cadence->caps2.is_phy_type_dll)
1802 phony_dqs_timing--;
1803
1804 } else {
1805 phony_dqs_timing--;
1806 }
1807 rd_del_sel = phony_dqs_timing + 3;
1808 } else {
1809 dev_warn(cadence->dev,
1810 "ERROR : cannot find valid sampling point\n");
1811 }
1812
1813 reg = FIELD_PREP(PHY_CTRL_PHONY_DQS, phony_dqs_timing);
1814 if (cadence->caps2.is_phy_type_dll)
1815 reg |= PHY_CTRL_SDR_DQS;
1816 t->phy_ctrl = reg;
1817 dev_dbg(cadence->dev, "PHY_CTRL_REG_SDR\t%x\n", reg);
1818
1819 if (cadence->caps2.is_phy_type_dll) {
1820 dev_dbg(cadence->dev, "PHY_TSEL_REG_SDR\t%x\n", 0);
1821 dev_dbg(cadence->dev, "PHY_DQ_TIMING_REG_SDR\t%x\n", 2);
1822 dev_dbg(cadence->dev, "PHY_DQS_TIMING_REG_SDR\t%x\n",
1823 dll_phy_dqs_timing);
1824 t->phy_dqs_timing = dll_phy_dqs_timing;
1825
1826 reg = FIELD_PREP(PHY_GATE_LPBK_CTRL_RDS, rd_del_sel);
1827 dev_dbg(cadence->dev, "PHY_GATE_LPBK_CTRL_REG_SDR\t%x\n",
1828 reg);
1829 t->phy_gate_lpbk_ctrl = reg;
1830
1831 dev_dbg(cadence->dev, "PHY_DLL_MASTER_CTRL_REG_SDR\t%lx\n",
1832 PHY_DLL_MASTER_CTRL_BYPASS_MODE);
1833 dev_dbg(cadence->dev, "PHY_DLL_SLAVE_CTRL_REG_SDR\t%x\n", 0);
1834 }
1835 return 0;
1836}
1837
1838static int cadence_nand_attach_chip(struct nand_chip *chip)
1839{
1840 struct cadence_nand_info *cadence = to_cadence_nand_info(chip->controller);
1841 struct cdns_nand_chip *cdns_chip = to_cdns_nand_chip(chip);
1842 static struct nand_ecclayout nand_oob;
1843 u32 ecc_size;
1844 struct mtd_info *mtd = nand_to_mtd(chip);
1845 int ret;
1846
1847 if (chip->options & NAND_BUSWIDTH_16) {
1848 ret = cadence_nand_set_access_width16(cadence, true);
1849 if (ret)
1850 return ret;
1851 }
1852
1853 chip->bbt_options |= NAND_BBT_USE_FLASH;
1854 chip->bbt_options |= NAND_BBT_NO_OOB;
1855 chip->ecc.mode = NAND_ECC_HW_SYNDROME;
1856
1857 chip->options |= NAND_NO_SUBPAGE_WRITE;
1858
1859 cdns_chip->bbm_offs = chip->badblockpos;
1860 cdns_chip->bbm_offs &= ~0x01;
1861 /* this value should be even number */
1862 cdns_chip->bbm_len = 2;
1863
1864 ret = cadence_ecc_setup(mtd, chip, mtd->oobsize - cdns_chip->bbm_len);
1865 if (ret) {
1866 dev_err(cadence->dev, "ECC configuration failed\n");
1867 return ret;
1868 }
1869
1870 dev_dbg(cadence->dev,
1871 "chosen ECC settings: step=%d, strength=%d, bytes=%d\n",
1872 chip->ecc.size, chip->ecc.strength, chip->ecc.bytes);
1873
1874 /* Error correction configuration. */
1875 cdns_chip->sector_size = chip->ecc.size;
1876 cdns_chip->sector_count = mtd->writesize / cdns_chip->sector_size;
1877 ecc_size = cdns_chip->sector_count * chip->ecc.bytes;
1878
1879 cdns_chip->avail_oob_size = mtd->oobsize - ecc_size;
1880
1881 if (cdns_chip->avail_oob_size > cadence->bch_metadata_size)
1882 cdns_chip->avail_oob_size = cadence->bch_metadata_size;
1883
1884 if ((cdns_chip->avail_oob_size + cdns_chip->bbm_len + ecc_size)
1885 > mtd->oobsize)
1886 cdns_chip->avail_oob_size -= 4;
1887
1888 ret = cadence_nand_get_ecc_strength_idx(cadence, chip->ecc.strength);
1889 if (ret < 0)
1890 return -EINVAL;
1891
1892 cdns_chip->corr_str_idx = (u8)ret;
1893
1894 if (cadence_nand_wait_for_value(cadence, CTRL_STATUS,
1895 TIMEOUT_US,
1896 CTRL_STATUS_CTRL_BUSY, true))
1897 return -ETIMEDOUT;
1898
1899 cadence_nand_set_ecc_strength(cadence,
1900 cdns_chip->corr_str_idx);
1901
1902 cadence_nand_set_erase_detection(cadence, true,
1903 chip->ecc.strength);
1904
1905 dev_dbg(cadence->dev,
1906 "chosen ECC settings: step=%d, strength=%d, bytes=%d\n",
1907 chip->ecc.size, chip->ecc.strength, chip->ecc.bytes);
1908
1909 /* Override the default read operations. */
1910 chip->ecc.options |= NAND_ECC_CUSTOM_PAGE_ACCESS;
1911 chip->ecc.read_page = cadence_nand_read_page;
1912 chip->ecc.read_page_raw = cadence_nand_read_page_raw;
1913 chip->ecc.write_page = cadence_nand_write_page;
1914 chip->ecc.write_page_raw = cadence_nand_write_page_raw;
1915 chip->ecc.read_oob = cadence_nand_read_oob;
1916 chip->ecc.write_oob = cadence_nand_write_oob;
1917 chip->ecc.read_oob_raw = cadence_nand_read_oob_raw;
1918 chip->ecc.write_oob_raw = cadence_nand_write_oob_raw;
1919 chip->erase = cadence_nand_erase;
1920
1921 if ((mtd->writesize + mtd->oobsize) > cadence->buf_size)
1922 cadence->buf_size = mtd->writesize + mtd->oobsize;
1923
1924 mtd_set_ooblayout(mtd, &cadence_nand_ooblayout_ops);
1925
1926 nand_oob.eccbytes = cdns_chip->chip.ecc.bytes;
1927 cdns_chip->chip.ecc.layout = &nand_oob;
1928
1929 return 0;
1930}
1931
1932/* Dummy implementation: we don't support multiple chips */
1933static void cadence_nand_select_chip(struct mtd_info *mtd, int chipnr)
1934{
1935 switch (chipnr) {
1936 case -1:
1937 case 0:
1938 break;
1939
1940 default:
1941 WARN_ON(chipnr);
1942 }
1943}
1944
Dinesh Maniyamd7bc8562025-02-27 00:18:18 +08001945static int cadence_nand_status(struct mtd_info *mtd, unsigned int command)
1946{
1947 struct nand_chip *chip = mtd_to_nand(mtd);
1948 int ret = 0;
1949
1950 ret = cadence_nand_cmd_opcode(chip, command);
1951 if (ret)
1952 return ret;
1953
1954 ret = cadence_nand_cmd_data(chip, 1, GCMD_DIR_READ);
1955 if (ret)
1956 return ret;
1957
1958 return 0;
1959}
1960
Dinesh Maniyam113be182025-02-27 00:18:19 +08001961static int cadence_nand_readid(struct mtd_info *mtd, int offset_in_page, unsigned int command)
1962{
1963 struct nand_chip *chip = mtd_to_nand(mtd);
1964 u8 addrs = (u8)offset_in_page;
1965 int ret = 0;
1966
1967 ret = cadence_nand_cmd_opcode(chip, command);
1968 if (ret)
1969 return ret;
1970
1971 ret = cadence_nand_cmd_address(chip, ONE_CYCLE, &addrs);
1972 if (ret)
1973 return ret;
1974
1975 ret = cadence_nand_cmd_data(chip, 8, GCMD_DIR_READ);
1976 if (ret)
1977 return ret;
1978
1979 return 0;
1980}
1981
Dinesh Maniyam890c01c2025-02-27 00:18:20 +08001982static int cadence_nand_param(struct mtd_info *mtd, u8 offset_in_page, unsigned int command)
1983{
1984 struct nand_chip *chip = mtd_to_nand(mtd);
1985 int ret = 0;
1986
1987 ret = cadence_nand_cmd_opcode(chip, command);
1988 if (ret)
1989 return ret;
1990
1991 ret = cadence_nand_cmd_address(chip, ONE_CYCLE, &offset_in_page);
1992 if (ret)
1993 return ret;
1994
1995 ret = cadence_nand_waitfunc(mtd, chip);
1996 if (ret)
1997 return ret;
1998
1999 ret = cadence_nand_cmd_data(chip, sizeof(struct nand_jedec_params), GCMD_DIR_READ);
2000 if (ret)
2001 return ret;
2002
2003 return 0;
2004}
2005
Dinesh Maniyam5c586362025-02-27 00:18:21 +08002006static int cadence_nand_reset(struct mtd_info *mtd, unsigned int command)
2007{
2008 struct nand_chip *chip = mtd_to_nand(mtd);
2009 int ret = 0;
2010
2011 ret = cadence_nand_cmd_opcode(chip, command);
2012 if (ret)
2013 return ret;
2014
2015 ret = cadence_nand_waitfunc(mtd, chip);
2016 if (ret)
2017 return ret;
2018
2019 return 0;
2020}
2021
Dinesh Maniyamf33923f2025-02-27 00:18:22 +08002022static int cadence_nand_features(struct mtd_info *mtd, u8 offset_in_page, u32 command)
2023{
2024 struct nand_chip *chip = mtd_to_nand(mtd);
2025 int ret = 0;
2026
2027 ret = cadence_nand_cmd_opcode(chip, command);
2028 if (ret)
2029 return ret;
2030
2031 ret = cadence_nand_cmd_address(chip, ONE_CYCLE, &offset_in_page);
2032 if (ret)
2033 return ret;
2034
2035 if (command == NAND_CMD_GET_FEATURES)
2036 ret = cadence_nand_cmd_data(chip, ONFI_SUBFEATURE_PARAM_LEN,
2037 GCMD_DIR_READ);
2038 else
2039 ret = cadence_nand_cmd_data(chip, ONFI_SUBFEATURE_PARAM_LEN,
2040 GCMD_DIR_WRITE);
2041
2042 return ret;
2043}
2044
Dinesh Maniyamf61a2212025-02-27 00:18:17 +08002045static void cadence_nand_cmdfunc(struct mtd_info *mtd, unsigned int command,
2046 int offset_in_page, int page)
2047{
Dinesh Maniyamd7bc8562025-02-27 00:18:18 +08002048 struct nand_chip *chip = mtd_to_nand(mtd);
2049 struct cadence_nand_info *cadence = to_cadence_nand_info(chip->controller);
2050 int ret = 0;
2051
2052 cadence->cmd = command;
2053 switch (command) {
2054 case NAND_CMD_STATUS:
2055 ret = cadence_nand_status(mtd, command);
2056 break;
Dinesh Maniyam113be182025-02-27 00:18:19 +08002057
2058 case NAND_CMD_READID:
2059 ret = cadence_nand_readid(mtd, offset_in_page, command);
2060 break;
2061
Dinesh Maniyam890c01c2025-02-27 00:18:20 +08002062 case NAND_CMD_PARAM:
2063 ret = cadence_nand_param(mtd, offset_in_page, command);
2064 break;
Dinesh Maniyam5c586362025-02-27 00:18:21 +08002065
2066 case NAND_CMD_RESET:
2067 ret = cadence_nand_reset(mtd, command);
2068 break;
Dinesh Maniyamf33923f2025-02-27 00:18:22 +08002069
2070 case NAND_CMD_SET_FEATURES:
2071 case NAND_CMD_GET_FEATURES:
2072 ret = cadence_nand_features(mtd, offset_in_page, command);
2073 break;
Dinesh Maniyamd7bc8562025-02-27 00:18:18 +08002074 /*
2075 * ecc will override other command for read, write and erase
2076 */
2077 default:
2078 break;
2079 }
2080
Dinesh Maniyam5c586362025-02-27 00:18:21 +08002081 if (cadence->cmd == NAND_CMD_RESET) {
2082 ret = cadence_nand_select_target(chip);
2083 if (ret)
2084 dev_err(cadence->dev, "Chip select failure after reset\n");
2085 }
2086
Dinesh Maniyamd7bc8562025-02-27 00:18:18 +08002087 if (ret != 0)
2088 printf("ERROR:%s:command:0x%x\n", __func__, cadence->cmd);
Dinesh Maniyamf61a2212025-02-27 00:18:17 +08002089}
2090
2091static int cadence_nand_dev_ready(struct mtd_info *mtd)
2092{
2093 struct nand_chip *chip = mtd_to_nand(mtd);
2094 struct cadence_nand_info *cadence = to_cadence_nand_info(chip->controller);
2095
2096 if (cadence_nand_wait_for_value(cadence, CTRL_STATUS,
2097 TIMEOUT_US,
2098 CTRL_STATUS_CTRL_BUSY, true))
2099 return -ETIMEDOUT;
2100
2101 return 0;
2102}
2103
2104static u8 cadence_nand_read_byte(struct mtd_info *mtd)
2105{
Dinesh Maniyamd7bc8562025-02-27 00:18:18 +08002106 struct nand_chip *chip = mtd_to_nand(mtd);
2107 struct cadence_nand_info *cadence = to_cadence_nand_info(chip->controller);
2108 u32 size = 1;
2109 u8 val;
2110
Dinesh Maniyam113be182025-02-27 00:18:19 +08002111 if (cadence->buf_index == 0) {
2112 if (cadence->cmd == NAND_CMD_READID)
2113 size = 8;
Dinesh Maniyam890c01c2025-02-27 00:18:20 +08002114 else if (cadence->cmd == NAND_CMD_PARAM)
2115 size = sizeof(struct nand_jedec_params);
Dinesh Maniyamf33923f2025-02-27 00:18:22 +08002116 else if (cadence->cmd == NAND_CMD_GET_FEATURES)
2117 size = ONFI_SUBFEATURE_PARAM_LEN;
Dinesh Maniyam113be182025-02-27 00:18:19 +08002118
Dinesh Maniyamd7bc8562025-02-27 00:18:18 +08002119 cadence_nand_read_buf(mtd, &cadence->buf[0], size);
Dinesh Maniyam113be182025-02-27 00:18:19 +08002120 }
Dinesh Maniyamd7bc8562025-02-27 00:18:18 +08002121
2122 val = *(&cadence->buf[0] + cadence->buf_index);
2123 cadence->buf_index++;
2124
2125 return val;
Dinesh Maniyamf61a2212025-02-27 00:18:17 +08002126}
2127
2128static void cadence_nand_write_byte(struct mtd_info *mtd, u8 byte)
2129{
2130 cadence_nand_write_buf(mtd, &byte, 1);
2131}
2132
2133static int cadence_nand_chip_init(struct cadence_nand_info *cadence, ofnode node)
2134{
2135 struct cdns_nand_chip *cdns_chip;
2136 struct nand_chip *chip;
2137 struct mtd_info *mtd;
2138 int ret, i;
2139 int nsels;
2140 u32 cs;
2141
2142 if (!ofnode_get_property(node, "reg", &nsels))
2143 return -ENODEV;
2144
2145 nsels /= sizeof(u32);
2146 if (nsels <= 0) {
2147 dev_err(cadence->dev, "invalid reg property size %d\n", nsels);
2148 return -EINVAL;
2149 }
2150
2151 cdns_chip = devm_kzalloc(cadence->dev, sizeof(*cdns_chip) +
2152 (nsels * sizeof(u8)), GFP_KERNEL);
2153 if (!cdns_chip)
2154 return -ENODEV;
2155
2156 cdns_chip->nsels = nsels;
2157 for (i = 0; i < nsels; i++) {
2158 /* Retrieve CS id. */
2159 ret = ofnode_read_u32_index(node, "reg", i, &cs);
2160 if (ret) {
2161 dev_err(cadence->dev,
2162 "could not retrieve reg property: %d\n",
2163 ret);
2164 goto free_buf;
2165 }
2166
2167 if (cs >= cadence->caps2.max_banks) {
2168 dev_err(cadence->dev,
2169 "invalid reg value: %u (max CS = %d)\n",
2170 cs, cadence->caps2.max_banks);
2171 ret = -EINVAL;
2172 goto free_buf;
2173 }
2174
2175 if (test_and_set_bit(cs, &cadence->assigned_cs)) {
2176 dev_err(cadence->dev,
2177 "CS %d already assigned\n", cs);
2178 ret = -EINVAL;
2179 goto free_buf;
2180 }
2181
2182 cdns_chip->cs[i] = cs;
2183 }
2184
2185 chip = &cdns_chip->chip;
2186 chip->controller = &cadence->controller;
2187 nand_set_flash_node(chip, node);
2188 mtd = nand_to_mtd(chip);
2189 mtd->dev->parent = cadence->dev;
2190
2191 chip->options |= NAND_BUSWIDTH_AUTO;
2192 chip->select_chip = cadence_nand_select_chip;
2193 chip->cmdfunc = cadence_nand_cmdfunc;
2194 chip->dev_ready = cadence_nand_dev_ready;
2195 chip->read_byte = cadence_nand_read_byte;
2196 chip->write_byte = cadence_nand_write_byte;
2197 chip->waitfunc = cadence_nand_waitfunc;
2198 chip->read_buf = cadence_nand_read_buf;
2199 chip->write_buf = cadence_nand_write_buf;
2200 chip->setup_data_interface = cadence_setup_data_interface;
2201
2202 ret = nand_scan_ident(mtd, 1, NULL);
2203 if (ret) {
2204 dev_err(cadence->dev, "Chip identification failure\n");
2205 goto free_buf;
2206 }
2207
2208 ret = cadence_nand_attach_chip(chip);
2209 if (ret) {
2210 dev_err(cadence->dev, "Chip not able to attached\n");
2211 goto free_buf;
2212 }
2213
2214 ret = nand_scan_tail(mtd);
2215 if (ret) {
2216 dev_err(cadence->dev, "could not scan the nand chip\n");
2217 goto free_buf;
2218 }
2219
2220 ret = nand_register(0, mtd);
2221 if (ret) {
2222 dev_err(cadence->dev, "Failed to register MTD: %d\n", ret);
2223 goto free_buf;
2224 }
2225
2226 return 0;
2227
2228free_buf:
2229 devm_kfree(cadence->dev, cdns_chip);
2230 return ret;
2231}
2232
2233static int cadence_nand_chips_init(struct cadence_nand_info *cadence)
2234{
2235 struct udevice *dev = cadence->dev;
2236 ofnode node = dev_ofnode(dev);
2237 ofnode nand_node;
2238 int max_cs = cadence->caps2.max_banks;
2239 int nchips, ret;
2240
2241 nchips = of_get_child_count(node);
2242
2243 if (nchips > max_cs) {
2244 dev_err(cadence->dev,
2245 "too many NAND chips: %d (max = %d CS)\n",
2246 nchips, max_cs);
2247 return -EINVAL;
2248 }
2249
2250 ofnode_for_each_subnode(nand_node, node) {
2251 ret = cadence_nand_chip_init(cadence, nand_node);
2252 if (ret)
2253 return ret;
2254 }
2255
2256 return 0;
2257}
2258
2259static int cadence_nand_init(struct cadence_nand_info *cadence)
2260{
2261 int ret;
2262
2263 cadence->cdma_desc = dma_alloc_coherent(sizeof(*cadence->cdma_desc),
2264 (unsigned long *)&cadence->dma_cdma_desc);
2265 if (!cadence->cdma_desc)
2266 return -ENOMEM;
2267
2268 cadence->buf_size = SZ_16K;
2269 cadence->buf = kmalloc(cadence->buf_size, GFP_KERNEL);
2270 if (!cadence->buf) {
2271 ret = -ENOMEM;
2272 goto free_buf_desc;
2273 }
2274
2275 //Hardware initialization
2276 ret = cadence_nand_hw_init(cadence);
2277 if (ret)
2278 goto free_buf;
2279
2280 cadence->curr_corr_str_idx = 0xFF;
2281
2282 ret = cadence_nand_chips_init(cadence);
2283 if (ret) {
2284 dev_err(cadence->dev, "Failed to register MTD: %d\n",
2285 ret);
2286 goto free_buf;
2287 }
2288
2289 kfree(cadence->buf);
2290 cadence->buf = kzalloc(cadence->buf_size, GFP_KERNEL);
2291 if (!cadence->buf) {
2292 ret = -ENOMEM;
2293 goto free_buf_desc;
2294 }
2295
2296 return 0;
2297
2298free_buf:
2299 kfree(cadence->buf);
2300
2301free_buf_desc:
2302 dma_free_coherent(cadence->cdma_desc);
2303
2304 return ret;
2305}
2306
2307static const struct cadence_nand_dt_devdata cadence_nand_default = {
2308 .if_skew = 0,
2309 .has_dma = 0,
2310};
2311
2312static const struct udevice_id cadence_nand_dt_ids[] = {
2313 {
2314 .compatible = "cdns,nand",
2315 .data = (unsigned long)&cadence_nand_default
2316 }, {}
2317};
2318
2319static int cadence_nand_dt_probe(struct udevice *dev)
2320{
2321 struct cadence_nand_info *cadence = dev_get_priv(dev);
2322 const struct udevice_id *of_id;
2323 const struct cadence_nand_dt_devdata *devdata;
2324 struct resource res;
2325 int ret;
2326 u32 val;
2327
2328 if (!dev) {
2329 dev_warn(dev, "Device ptr null\n");
2330 return -EINVAL;
2331 }
2332
2333 of_id = &cadence_nand_dt_ids[0];
2334 devdata = (struct cadence_nand_dt_devdata *)of_id->data;
2335
2336 cadence->caps1 = devdata;
2337 cadence->dev = dev;
2338
2339 ret = clk_get_by_index(dev, 0, &cadence->clk);
2340 if (ret)
2341 return ret;
2342
2343 ret = clk_enable(&cadence->clk);
2344 if (ret && ret != -ENOSYS && ret != -ENOMEM) {
2345 dev_err(dev, "failed to enable clock\n");
2346 return ret;
2347 }
2348 cadence->nf_clk_rate = clk_get_rate(&cadence->clk);
2349
2350 ret = reset_get_by_index(dev, 1, &cadence->softphy_reset);
2351 if (ret) {
2352 if (ret != -ENOMEM)
2353 dev_warn(dev, "Can't get softphy_reset: %d\n", ret);
2354 } else {
2355 reset_deassert(&cadence->softphy_reset);
2356 }
2357
2358 ret = reset_get_by_index(dev, 0, &cadence->nand_reset);
2359 if (ret) {
2360 if (ret != -ENOMEM)
2361 dev_warn(dev, "Can't get nand_reset: %d\n", ret);
2362 } else {
2363 reset_deassert(&cadence->nand_reset);
2364 }
2365
2366 ret = dev_read_resource_byname(dev, "reg", &res);
2367 if (ret)
2368 return ret;
2369 cadence->reg = devm_ioremap(dev, res.start, resource_size(&res));
2370
2371 ret = dev_read_resource_byname(dev, "sdma", &res);
2372 if (ret)
2373 return ret;
2374 cadence->io.dma = res.start;
2375 cadence->io.virt = devm_ioremap(dev, res.start, resource_size(&res));
2376
2377 ret = ofnode_read_u32(dev_ofnode(dev->parent),
2378 "cdns,board-delay-ps", &val);
2379 if (ret) {
2380 val = 4830;
2381 dev_info(cadence->dev,
2382 "missing cdns,board-delay-ps property, %d was set\n",
2383 val);
2384 }
2385 cadence->board_delay = val;
2386
2387 ret = cadence_nand_init(cadence);
2388 if (ret)
2389 return ret;
2390
2391 return 0;
2392}
2393
2394U_BOOT_DRIVER(cadence_nand_dt) = {
2395 .name = "cadence-nand-dt",
2396 .id = UCLASS_MTD,
2397 .of_match = cadence_nand_dt_ids,
2398 .probe = cadence_nand_dt_probe,
2399 .priv_auto = sizeof(struct cadence_nand_info),
2400};
2401
2402void board_nand_init(void)
2403{
2404 struct udevice *dev;
2405 int ret;
2406
2407 ret = uclass_get_device_by_driver(UCLASS_MTD,
2408 DM_DRIVER_GET(cadence_nand_dt),
2409 &dev);
2410 if (ret && ret != -ENODEV)
2411 pr_err("Failed to initialize Cadence NAND controller. (error %d)\n",
2412 ret);
2413}