1 // SPDX-License-Identifier: GPL-2.0+
3 * Copyright Altera Corporation (C) 2014-2015
13 #include <asm/arch/fpga_manager.h>
14 #include <asm/arch/reset_manager.h>
15 #include <asm/arch/sdram.h>
16 #include <asm/arch/system_manager.h>
18 #include <dm/device_compat.h>
20 #include "sequencer.h"
22 #ifdef CONFIG_SPL_BUILD
24 struct altera_gen5_sdram_priv {
28 struct altera_gen5_sdram_platdata {
29 struct socfpga_sdr *sdr;
32 struct sdram_prot_rule {
33 u32 sdram_start; /* SDRAM start address */
34 u32 sdram_end; /* SDRAM end address */
35 u32 rule; /* SDRAM protection rule number: 0-19 */
36 int valid; /* Rule valid or not? 1 - valid, 0 not*/
45 static unsigned long sdram_calculate_size(struct socfpga_sdr_ctrl *sdr_ctrl);
48 * get_errata_rows() - Up the number of DRAM rows to cover entire address space
49 * @cfg: SDRAM controller configuration data
51 * SDRAM Failure happens when accessing non-existent memory. Artificially
52 * increase the number of rows so that the memory controller thinks it has
53 * 4GB of RAM. This function returns such amount of rows.
55 static int get_errata_rows(const struct socfpga_sdram_config *cfg)
57 /* Define constant for 4G memory - used for SDRAM errata workaround */
58 #define MEMSIZE_4G (4ULL * 1024ULL * 1024ULL * 1024ULL)
59 const unsigned long long memsize = MEMSIZE_4G;
60 const unsigned int cs =
61 ((cfg->dram_addrw & SDR_CTRLGRP_DRAMADDRW_CSBITS_MASK) >>
62 SDR_CTRLGRP_DRAMADDRW_CSBITS_LSB) + 1;
63 const unsigned int rows =
64 (cfg->dram_addrw & SDR_CTRLGRP_DRAMADDRW_ROWBITS_MASK) >>
65 SDR_CTRLGRP_DRAMADDRW_ROWBITS_LSB;
66 const unsigned int banks =
67 (cfg->dram_addrw & SDR_CTRLGRP_DRAMADDRW_BANKBITS_MASK) >>
68 SDR_CTRLGRP_DRAMADDRW_BANKBITS_LSB;
69 const unsigned int cols =
70 (cfg->dram_addrw & SDR_CTRLGRP_DRAMADDRW_COLBITS_MASK) >>
71 SDR_CTRLGRP_DRAMADDRW_COLBITS_LSB;
72 const unsigned int width = 8;
74 unsigned long long newrows;
75 int bits, inewrowslog2;
77 debug("workaround rows - memsize %lld\n", memsize);
78 debug("workaround rows - cs %d\n", cs);
79 debug("workaround rows - width %d\n", width);
80 debug("workaround rows - rows %d\n", rows);
81 debug("workaround rows - banks %d\n", banks);
82 debug("workaround rows - cols %d\n", cols);
84 newrows = lldiv(memsize, cs * (width / 8));
85 debug("rows workaround - term1 %lld\n", newrows);
87 newrows = lldiv(newrows, (1 << banks) * (1 << cols));
88 debug("rows workaround - term2 %lld\n", newrows);
91 * Compute the hamming weight - same as number of bits set.
92 * Need to see if result is ordinal power of 2 before
93 * attempting log2 of result.
95 bits = generic_hweight32(newrows);
97 debug("rows workaround - bits %d\n", bits);
100 printf("SDRAM workaround failed, bits set %d\n", bits);
104 if (newrows > UINT_MAX) {
105 printf("SDRAM workaround rangecheck failed, %lld\n", newrows);
109 inewrowslog2 = __ilog2(newrows);
111 debug("rows workaround - ilog2 %d, %lld\n", inewrowslog2, newrows);
113 if (inewrowslog2 == -1) {
114 printf("SDRAM workaround failed, newrows %lld\n", newrows);
121 /* SDRAM protection rules vary from 0-19, a total of 20 rules. */
122 static void sdram_set_rule(struct socfpga_sdr_ctrl *sdr_ctrl,
123 struct sdram_prot_rule *prule)
127 int ruleno = prule->rule;
129 /* Select the rule */
130 writel(ruleno, &sdr_ctrl->prot_rule_rdwr);
132 /* Obtain the address bits */
133 lo_addr_bits = prule->sdram_start >> 20ULL;
134 hi_addr_bits = (prule->sdram_end - 1) >> 20ULL;
136 debug("sdram set rule start %x, %d\n", lo_addr_bits,
138 debug("sdram set rule end %x, %d\n", hi_addr_bits,
141 /* Set rule addresses */
142 writel(lo_addr_bits | (hi_addr_bits << 12), &sdr_ctrl->prot_rule_addr);
144 /* Set rule protection ids */
145 writel(prule->lo_prot_id | (prule->hi_prot_id << 12),
146 &sdr_ctrl->prot_rule_id);
148 /* Set the rule data */
149 writel(prule->security | (prule->valid << 2) |
150 (prule->portmask << 3) | (prule->result << 13),
151 &sdr_ctrl->prot_rule_data);
154 writel(ruleno | (1 << 5), &sdr_ctrl->prot_rule_rdwr);
156 /* Set rule number to 0 by default */
157 writel(0, &sdr_ctrl->prot_rule_rdwr);
160 static void sdram_get_rule(struct socfpga_sdr_ctrl *sdr_ctrl,
161 struct sdram_prot_rule *prule)
166 int ruleno = prule->rule;
169 writel(ruleno, &sdr_ctrl->prot_rule_rdwr);
170 writel(ruleno | (1 << 6), &sdr_ctrl->prot_rule_rdwr);
172 /* Get the addresses */
173 addr = readl(&sdr_ctrl->prot_rule_addr);
174 prule->sdram_start = (addr & 0xFFF) << 20;
175 prule->sdram_end = ((addr >> 12) & 0xFFF) << 20;
177 /* Get the configured protection IDs */
178 id = readl(&sdr_ctrl->prot_rule_id);
179 prule->lo_prot_id = id & 0xFFF;
180 prule->hi_prot_id = (id >> 12) & 0xFFF;
182 /* Get protection data */
183 data = readl(&sdr_ctrl->prot_rule_data);
185 prule->security = data & 0x3;
186 prule->valid = (data >> 2) & 0x1;
187 prule->portmask = (data >> 3) & 0x3FF;
188 prule->result = (data >> 13) & 0x1;
192 sdram_set_protection_config(struct socfpga_sdr_ctrl *sdr_ctrl,
193 const u32 sdram_start, const u32 sdram_end)
195 struct sdram_prot_rule rule;
198 /* Start with accepting all SDRAM transaction */
199 writel(0x0, &sdr_ctrl->protport_default);
201 /* Clear all protection rules for warm boot case */
202 memset(&rule, 0, sizeof(rule));
204 for (rules = 0; rules < 20; rules++) {
206 sdram_set_rule(sdr_ctrl, &rule);
209 /* new rule: accept SDRAM */
210 rule.sdram_start = sdram_start;
211 rule.sdram_end = sdram_end;
212 rule.lo_prot_id = 0x0;
213 rule.hi_prot_id = 0xFFF;
214 rule.portmask = 0x3FF;
221 sdram_set_rule(sdr_ctrl, &rule);
223 /* default rule: reject everything */
224 writel(0x3ff, &sdr_ctrl->protport_default);
227 static void sdram_dump_protection_config(struct socfpga_sdr_ctrl *sdr_ctrl)
229 struct sdram_prot_rule rule;
232 debug("SDRAM Prot rule, default %x\n",
233 readl(&sdr_ctrl->protport_default));
235 for (rules = 0; rules < 20; rules++) {
237 sdram_get_rule(sdr_ctrl, &rule);
238 debug("Rule %d, rules ...\n", rules);
239 debug(" sdram start %x\n", rule.sdram_start);
240 debug(" sdram end %x\n", rule.sdram_end);
241 debug(" low prot id %d, hi prot id %d\n",
244 debug(" portmask %x\n", rule.portmask);
245 debug(" security %d\n", rule.security);
246 debug(" result %d\n", rule.result);
247 debug(" valid %d\n", rule.valid);
252 * sdram_write_verify() - write to register and verify the write.
253 * @addr: Register address
254 * @val: Value to be written and verified
256 * This function writes to a register, reads back the value and compares
257 * the result with the written value to check if the data match.
259 static unsigned sdram_write_verify(const u32 *addr, const u32 val)
263 debug(" Write - Address 0x%p Data 0x%08x\n", addr, val);
266 debug(" Read and verify...");
269 debug("FAIL - Address 0x%p Expected 0x%08x Data 0x%08x\n",
279 * sdr_get_ctrlcfg() - Get the value of DRAM CTRLCFG register
280 * @cfg: SDRAM controller configuration data
282 * Return the value of DRAM CTRLCFG register.
284 static u32 sdr_get_ctrlcfg(const struct socfpga_sdram_config *cfg)
287 ((cfg->dram_addrw & SDR_CTRLGRP_DRAMADDRW_CSBITS_MASK) >>
288 SDR_CTRLGRP_DRAMADDRW_CSBITS_LSB) + 1;
290 (cfg->ctrl_cfg & SDR_CTRLGRP_CTRLCFG_ADDRORDER_MASK) >>
291 SDR_CTRLGRP_CTRLCFG_ADDRORDER_LSB;
293 u32 ctrl_cfg = cfg->ctrl_cfg;
296 * SDRAM Failure When Accessing Non-Existent Memory
297 * Set the addrorder field of the SDRAM control register
298 * based on the CSBITs setting.
302 debug("INFO: Changing address order to 0 (chip, row, bank, column)\n");
304 } else if (csbits == 2) {
306 debug("INFO: Changing address order to 2 (row, chip, bank, column)\n");
310 ctrl_cfg &= ~SDR_CTRLGRP_CTRLCFG_ADDRORDER_MASK;
311 ctrl_cfg |= addrorder << SDR_CTRLGRP_CTRLCFG_ADDRORDER_LSB;
317 * sdr_get_addr_rw() - Get the value of DRAM ADDRW register
318 * @cfg: SDRAM controller configuration data
320 * Return the value of DRAM ADDRW register.
322 static u32 sdr_get_addr_rw(const struct socfpga_sdram_config *cfg)
325 * SDRAM Failure When Accessing Non-Existent Memory
326 * Set SDR_CTRLGRP_DRAMADDRW_CSBITS_LSB to
327 * log2(number of chip select bits). Since there's only
328 * 1 or 2 chip selects, log2(1) => 0, and log2(2) => 1,
329 * which is the same as "chip selects" - 1.
331 const int rows = get_errata_rows(cfg);
332 u32 dram_addrw = cfg->dram_addrw & ~SDR_CTRLGRP_DRAMADDRW_ROWBITS_MASK;
334 return dram_addrw | (rows << SDR_CTRLGRP_DRAMADDRW_ROWBITS_LSB);
338 * sdr_load_regs() - Load SDRAM controller registers
339 * @cfg: SDRAM controller configuration data
341 * This function loads the register values into the SDRAM controller block.
343 static void sdr_load_regs(struct socfpga_sdr_ctrl *sdr_ctrl,
344 const struct socfpga_sdram_config *cfg)
346 const u32 ctrl_cfg = sdr_get_ctrlcfg(cfg);
347 const u32 dram_addrw = sdr_get_addr_rw(cfg);
349 debug("\nConfiguring CTRLCFG\n");
350 writel(ctrl_cfg, &sdr_ctrl->ctrl_cfg);
352 debug("Configuring DRAMTIMING1\n");
353 writel(cfg->dram_timing1, &sdr_ctrl->dram_timing1);
355 debug("Configuring DRAMTIMING2\n");
356 writel(cfg->dram_timing2, &sdr_ctrl->dram_timing2);
358 debug("Configuring DRAMTIMING3\n");
359 writel(cfg->dram_timing3, &sdr_ctrl->dram_timing3);
361 debug("Configuring DRAMTIMING4\n");
362 writel(cfg->dram_timing4, &sdr_ctrl->dram_timing4);
364 debug("Configuring LOWPWRTIMING\n");
365 writel(cfg->lowpwr_timing, &sdr_ctrl->lowpwr_timing);
367 debug("Configuring DRAMADDRW\n");
368 writel(dram_addrw, &sdr_ctrl->dram_addrw);
370 debug("Configuring DRAMIFWIDTH\n");
371 writel(cfg->dram_if_width, &sdr_ctrl->dram_if_width);
373 debug("Configuring DRAMDEVWIDTH\n");
374 writel(cfg->dram_dev_width, &sdr_ctrl->dram_dev_width);
376 debug("Configuring LOWPWREQ\n");
377 writel(cfg->lowpwr_eq, &sdr_ctrl->lowpwr_eq);
379 debug("Configuring DRAMINTR\n");
380 writel(cfg->dram_intr, &sdr_ctrl->dram_intr);
382 debug("Configuring STATICCFG\n");
383 writel(cfg->static_cfg, &sdr_ctrl->static_cfg);
385 debug("Configuring CTRLWIDTH\n");
386 writel(cfg->ctrl_width, &sdr_ctrl->ctrl_width);
388 debug("Configuring PORTCFG\n");
389 writel(cfg->port_cfg, &sdr_ctrl->port_cfg);
391 debug("Configuring FIFOCFG\n");
392 writel(cfg->fifo_cfg, &sdr_ctrl->fifo_cfg);
394 debug("Configuring MPPRIORITY\n");
395 writel(cfg->mp_priority, &sdr_ctrl->mp_priority);
397 debug("Configuring MPWEIGHT_MPWEIGHT_0\n");
398 writel(cfg->mp_weight0, &sdr_ctrl->mp_weight0);
399 writel(cfg->mp_weight1, &sdr_ctrl->mp_weight1);
400 writel(cfg->mp_weight2, &sdr_ctrl->mp_weight2);
401 writel(cfg->mp_weight3, &sdr_ctrl->mp_weight3);
403 debug("Configuring MPPACING_MPPACING_0\n");
404 writel(cfg->mp_pacing0, &sdr_ctrl->mp_pacing0);
405 writel(cfg->mp_pacing1, &sdr_ctrl->mp_pacing1);
406 writel(cfg->mp_pacing2, &sdr_ctrl->mp_pacing2);
407 writel(cfg->mp_pacing3, &sdr_ctrl->mp_pacing3);
409 debug("Configuring MPTHRESHOLDRST_MPTHRESHOLDRST_0\n");
410 writel(cfg->mp_threshold0, &sdr_ctrl->mp_threshold0);
411 writel(cfg->mp_threshold1, &sdr_ctrl->mp_threshold1);
412 writel(cfg->mp_threshold2, &sdr_ctrl->mp_threshold2);
414 debug("Configuring PHYCTRL_PHYCTRL_0\n");
415 writel(cfg->phy_ctrl0, &sdr_ctrl->phy_ctrl0);
417 debug("Configuring CPORTWIDTH\n");
418 writel(cfg->cport_width, &sdr_ctrl->cport_width);
420 debug("Configuring CPORTWMAP\n");
421 writel(cfg->cport_wmap, &sdr_ctrl->cport_wmap);
423 debug("Configuring CPORTRMAP\n");
424 writel(cfg->cport_rmap, &sdr_ctrl->cport_rmap);
426 debug("Configuring RFIFOCMAP\n");
427 writel(cfg->rfifo_cmap, &sdr_ctrl->rfifo_cmap);
429 debug("Configuring WFIFOCMAP\n");
430 writel(cfg->wfifo_cmap, &sdr_ctrl->wfifo_cmap);
432 debug("Configuring CPORTRDWR\n");
433 writel(cfg->cport_rdwr, &sdr_ctrl->cport_rdwr);
435 debug("Configuring DRAMODT\n");
436 writel(cfg->dram_odt, &sdr_ctrl->dram_odt);
438 if (dram_is_ddr(3)) {
439 debug("Configuring EXTRATIME1\n");
440 writel(cfg->extratime1, &sdr_ctrl->extratime1);
445 * sdram_mmr_init_full() - Function to initialize SDRAM MMR
446 * @sdr_phy_reg: Value of the PHY control register 0
448 * Initialize the SDRAM MMR.
450 int sdram_mmr_init_full(struct socfpga_sdr_ctrl *sdr_ctrl,
451 unsigned int sdr_phy_reg)
453 const struct socfpga_sdram_config *cfg = socfpga_get_sdram_config();
454 const unsigned int rows =
455 (cfg->dram_addrw & SDR_CTRLGRP_DRAMADDRW_ROWBITS_MASK) >>
456 SDR_CTRLGRP_DRAMADDRW_ROWBITS_LSB;
460 socfpga_get_sysmgr_addr() + SYSMGR_ISWGRP_HANDOFF_OFFSET(4));
462 sdr_load_regs(sdr_ctrl, cfg);
464 /* saving this value to SYSMGR.ISWGRP.HANDOFF.FPGA2SDR */
465 writel(cfg->fpgaport_rst,
466 socfpga_get_sysmgr_addr() + SYSMGR_ISWGRP_HANDOFF_OFFSET(3));
468 /* only enable if the FPGA is programmed */
469 if (fpgamgr_test_fpga_ready()) {
470 ret = sdram_write_verify(&sdr_ctrl->fpgaport_rst,
476 /* Restore the SDR PHY Register if valid */
477 if (sdr_phy_reg != 0xffffffff)
478 writel(sdr_phy_reg, &sdr_ctrl->phy_ctrl0);
480 /* Final step - apply configuration changes */
481 debug("Configuring STATICCFG\n");
482 clrsetbits_le32(&sdr_ctrl->static_cfg,
483 SDR_CTRLGRP_STATICCFG_APPLYCFG_MASK,
484 1 << SDR_CTRLGRP_STATICCFG_APPLYCFG_LSB);
486 sdram_set_protection_config(sdr_ctrl, 0,
487 sdram_calculate_size(sdr_ctrl) - 1);
489 sdram_dump_protection_config(sdr_ctrl);
495 * sdram_calculate_size() - Calculate SDRAM size
497 * Calculate SDRAM device size based on SDRAM controller parameters.
498 * Size is specified in bytes.
500 static unsigned long sdram_calculate_size(struct socfpga_sdr_ctrl *sdr_ctrl)
503 unsigned long row, bank, col, cs, width;
504 const struct socfpga_sdram_config *cfg = socfpga_get_sdram_config();
505 const unsigned int csbits =
506 ((cfg->dram_addrw & SDR_CTRLGRP_DRAMADDRW_CSBITS_MASK) >>
507 SDR_CTRLGRP_DRAMADDRW_CSBITS_LSB) + 1;
508 const unsigned int rowbits =
509 (cfg->dram_addrw & SDR_CTRLGRP_DRAMADDRW_ROWBITS_MASK) >>
510 SDR_CTRLGRP_DRAMADDRW_ROWBITS_LSB;
512 temp = readl(&sdr_ctrl->dram_addrw);
513 col = (temp & SDR_CTRLGRP_DRAMADDRW_COLBITS_MASK) >>
514 SDR_CTRLGRP_DRAMADDRW_COLBITS_LSB;
517 * SDRAM Failure When Accessing Non-Existent Memory
518 * Use ROWBITS from Quartus/QSys to calculate SDRAM size
519 * since the FB specifies we modify ROWBITs to work around SDRAM
522 row = readl(socfpga_get_sysmgr_addr() +
523 SYSMGR_ISWGRP_HANDOFF_OFFSET(4));
527 * If the stored handoff value for rows is greater than
528 * the field width in the sdr.dramaddrw register then
529 * something is very wrong. Revert to using the the #define
530 * value handed off by the SOCEDS tool chain instead of
531 * using a broken value.
536 bank = (temp & SDR_CTRLGRP_DRAMADDRW_BANKBITS_MASK) >>
537 SDR_CTRLGRP_DRAMADDRW_BANKBITS_LSB;
540 * SDRAM Failure When Accessing Non-Existent Memory
541 * Use CSBITs from Quartus/QSys to calculate SDRAM size
542 * since the FB specifies we modify CSBITs to work around SDRAM
547 width = readl(&sdr_ctrl->dram_if_width);
549 /* ECC would not be calculated as its not addressible */
550 if (width == SDRAM_WIDTH_32BIT_WITH_ECC)
552 if (width == SDRAM_WIDTH_16BIT_WITH_ECC)
555 /* calculate the SDRAM size base on this info */
556 temp = 1 << (row + bank + col);
557 temp = temp * cs * (width / 8);
559 debug("%s returns %ld\n", __func__, temp);
564 static int altera_gen5_sdram_ofdata_to_platdata(struct udevice *dev)
566 struct altera_gen5_sdram_platdata *plat = dev->platdata;
568 plat->sdr = (struct socfpga_sdr *)devfdt_get_addr_index(dev, 0);
575 static int altera_gen5_sdram_probe(struct udevice *dev)
578 unsigned long sdram_size;
579 struct altera_gen5_sdram_platdata *plat = dev->platdata;
580 struct altera_gen5_sdram_priv *priv = dev_get_priv(dev);
581 struct socfpga_sdr_ctrl *sdr_ctrl = &plat->sdr->sdr_ctrl;
582 struct reset_ctl_bulk resets;
584 ret = reset_get_bulk(dev, &resets);
586 dev_err(dev, "Can't get reset: %d\n", ret);
589 reset_deassert_bulk(&resets);
591 if (sdram_mmr_init_full(sdr_ctrl, 0xffffffff) != 0) {
592 puts("SDRAM init failed.\n");
596 debug("SDRAM: Calibrating PHY\n");
597 /* SDRAM calibration */
598 if (sdram_calibration_full(plat->sdr) == 0) {
599 puts("SDRAM calibration failed.\n");
603 sdram_size = sdram_calculate_size(sdr_ctrl);
604 debug("SDRAM: %ld MiB\n", sdram_size >> 20);
606 /* Sanity check ensure correct SDRAM size specified */
607 if (get_ram_size(0, sdram_size) != sdram_size) {
608 puts("SDRAM size check failed!\n");
613 priv->info.size = sdram_size;
618 reset_release_bulk(&resets);
622 static int altera_gen5_sdram_get_info(struct udevice *dev,
623 struct ram_info *info)
625 struct altera_gen5_sdram_priv *priv = dev_get_priv(dev);
627 info->base = priv->info.base;
628 info->size = priv->info.size;
633 static const struct ram_ops altera_gen5_sdram_ops = {
634 .get_info = altera_gen5_sdram_get_info,
637 static const struct udevice_id altera_gen5_sdram_ids[] = {
638 { .compatible = "altr,sdr-ctl" },
642 U_BOOT_DRIVER(altera_gen5_sdram) = {
643 .name = "altr_sdr_ctl",
645 .of_match = altera_gen5_sdram_ids,
646 .ops = &altera_gen5_sdram_ops,
647 .ofdata_to_platdata = altera_gen5_sdram_ofdata_to_platdata,
648 .platdata_auto_alloc_size = sizeof(struct altera_gen5_sdram_platdata),
649 .probe = altera_gen5_sdram_probe,
650 .priv_auto_alloc_size = sizeof(struct altera_gen5_sdram_priv),
653 #endif /* CONFIG_SPL_BUILD */