arch/powerpc/cpu/mpc8xxx/ddr/main.c

   1 /*
   2  * Copyright 2008-2011 Freescale Semiconductor, Inc.
   3  *
   4  * This program is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU General Public License
   6  * Version 2 as published by the Free Software Foundation.
   7  */
   8
   9 /*
  10  * Generic driver for Freescale DDR/DDR2/DDR3 memory controller.
  11  * Based on code from spd_sdram.c
  12  * Author: James Yang [at freescale.com]
  13  */
  14
  15 #include <common.h>
  16 #include <i2c.h>
  17 #include <asm/fsl_ddr_sdram.h>
  18
  19 #include "ddr.h"
  20
  21 extern void fsl_ddr_set_lawbar(
  22                 const common_timing_params_t *memctl_common_params,
  23                 unsigned int memctl_interleaved,
  24                 unsigned int ctrl_num);
  25
  26 /* processor specific function */
  27 extern void fsl_ddr_set_memctl_regs(const fsl_ddr_cfg_regs_t *regs,
  28                                    unsigned int ctrl_num);
  29
  30 #if defined(SPD_EEPROM_ADDRESS) || \
  31     defined(SPD_EEPROM_ADDRESS1) || defined(SPD_EEPROM_ADDRESS2) || \
  32     defined(SPD_EEPROM_ADDRESS3) || defined(SPD_EEPROM_ADDRESS4)
  33 #if (CONFIG_NUM_DDR_CONTROLLERS == 1) && (CONFIG_DIMM_SLOTS_PER_CTLR == 1)
  34 u8 spd_i2c_addr[CONFIG_NUM_DDR_CONTROLLERS][CONFIG_DIMM_SLOTS_PER_CTLR] = {
  35         [0][0] = SPD_EEPROM_ADDRESS,
  36 };
  37 #endif
  38 #if (CONFIG_NUM_DDR_CONTROLLERS == 2) && (CONFIG_DIMM_SLOTS_PER_CTLR == 1)
  39 u8 spd_i2c_addr[CONFIG_NUM_DDR_CONTROLLERS][CONFIG_DIMM_SLOTS_PER_CTLR] = {
  40         [0][0] = SPD_EEPROM_ADDRESS1,   /* controller 1 */
  41         [1][0] = SPD_EEPROM_ADDRESS2,   /* controller 2 */
  42 };
  43 #endif
  44 #if (CONFIG_NUM_DDR_CONTROLLERS == 2) && (CONFIG_DIMM_SLOTS_PER_CTLR == 2)
  45 u8 spd_i2c_addr[CONFIG_NUM_DDR_CONTROLLERS][CONFIG_DIMM_SLOTS_PER_CTLR] = {
  46         [0][0] = SPD_EEPROM_ADDRESS1,   /* controller 1 */
  47         [0][1] = SPD_EEPROM_ADDRESS2,   /* controller 1 */
  48         [1][0] = SPD_EEPROM_ADDRESS3,   /* controller 2 */
  49         [1][1] = SPD_EEPROM_ADDRESS4,   /* controller 2 */
  50 };
  51 #endif
  52
  53 static void __get_spd(generic_spd_eeprom_t *spd, u8 i2c_address)
  54 {
  55         int ret = i2c_read(i2c_address, 0, 1, (uchar *)spd,
  56                                 sizeof(generic_spd_eeprom_t));
  57
  58         if (ret) {
  59                 printf("DDR: failed to read SPD from address %u\n", i2c_address);
  60                 memset(spd, 0, sizeof(generic_spd_eeprom_t));
  61         }
  62 }
  63
  64 __attribute__((weak, alias("__get_spd")))
  65 void get_spd(generic_spd_eeprom_t *spd, u8 i2c_address);
  66
  67 void fsl_ddr_get_spd(generic_spd_eeprom_t *ctrl_dimms_spd,
  68                       unsigned int ctrl_num)
  69 {
  70         unsigned int i;
  71         unsigned int i2c_address = 0;
  72
  73         if (ctrl_num >= CONFIG_NUM_DDR_CONTROLLERS) {
  74                 printf("%s unexpected ctrl_num = %u\n", __FUNCTION__, ctrl_num);
  75                 return;
  76         }
  77
  78         for (i = 0; i < CONFIG_DIMM_SLOTS_PER_CTLR; i++) {
  79                 i2c_address = spd_i2c_addr[ctrl_num][i];
  80                 get_spd(&(ctrl_dimms_spd[i]), i2c_address);
  81         }
  82 }
  83 #else
  84 void fsl_ddr_get_spd(generic_spd_eeprom_t *ctrl_dimms_spd,
  85                       unsigned int ctrl_num)
  86 {
  87 }
  88 #endif /* SPD_EEPROM_ADDRESSx */
  89
  90 /*
  91  * ASSUMPTIONS:
  92  *    - Same number of CONFIG_DIMM_SLOTS_PER_CTLR on each controller
  93  *    - Same memory data bus width on all controllers
  94  *
  95  * NOTES:
  96  *
  97  * The memory controller and associated documentation use confusing
  98  * terminology when referring to the orgranization of DRAM.
  99  *
 100  * Here is a terminology translation table:
 101  *
 102  * memory controller/documention  |industry   |this code  |signals
 103  * -------------------------------|-----------|-----------|-----------------
 104  * physical bank/bank             |rank       |rank       |chip select (CS)
 105  * logical bank/sub-bank          |bank       |bank       |bank address (BA)
 106  * page/row                       |row        |page       |row address
 107  * ???                            |column     |column     |column address
 108  *
 109  * The naming confusion is further exacerbated by the descriptions of the
 110  * memory controller interleaving feature, where accesses are interleaved
 111  * _BETWEEN_ two seperate memory controllers.  This is configured only in
 112  * CS0_CONFIG[INTLV_CTL] of each memory controller.
 113  *
 114  * memory controller documentation | number of chip selects
 115  *                                 | per memory controller supported
 116  * --------------------------------|-----------------------------------------
 117  * cache line interleaving         | 1 (CS0 only)
 118  * page interleaving               | 1 (CS0 only)
 119  * bank interleaving               | 1 (CS0 only)
 120  * superbank interleraving         | depends on bank (chip select)
 121  *                                 |   interleraving [rank interleaving]
 122  *                                 |   mode used on every memory controller
 123  *
 124  * Even further confusing is the existence of the interleaving feature
 125  * _WITHIN_ each memory controller.  The feature is referred to in
 126  * documentation as chip select interleaving or bank interleaving,
 127  * although it is configured in the DDR_SDRAM_CFG field.
 128  *
 129  * Name of field                | documentation name    | this code
 130  * -----------------------------|-----------------------|------------------
 131  * DDR_SDRAM_CFG[BA_INTLV_CTL]  | Bank (chip select)    | rank interleaving
 132  *                              |  interleaving
 133  */
 134
 135 #ifdef DEBUG
 136 const char *step_string_tbl[] = {
 137         "STEP_GET_SPD",
 138         "STEP_COMPUTE_DIMM_PARMS",
 139         "STEP_COMPUTE_COMMON_PARMS",
 140         "STEP_GATHER_OPTS",
 141         "STEP_ASSIGN_ADDRESSES",
 142         "STEP_COMPUTE_REGS",
 143         "STEP_PROGRAM_REGS",
 144         "STEP_ALL"
 145 };
 146
 147 const char * step_to_string(unsigned int step) {
 148
 149         unsigned int s = __ilog2(step);
 150
 151         if ((1 << s) != step)
 152                 return step_string_tbl[7];
 153
 154         return step_string_tbl[s];
 155 }
 156 #endif
 157
 158 int step_assign_addresses(fsl_ddr_info_t *pinfo,
 159                           unsigned int dbw_cap_adj[],
 160                           unsigned int *all_memctl_interleaving,
 161                           unsigned int *all_ctlr_rank_interleaving)
 162 {
 163         int i, j;
 164
 165         /*
 166          * If a reduced data width is requested, but the SPD
 167          * specifies a physically wider device, adjust the
 168          * computed dimm capacities accordingly before
 169          * assigning addresses.
 170          */
 171         for (i = 0; i < CONFIG_NUM_DDR_CONTROLLERS; i++) {
 172                 unsigned int found = 0;
 173
 174                 switch (pinfo->memctl_opts[i].data_bus_width) {
 175                 case 2:
 176                         /* 16-bit */
 177                         for (j = 0; j < CONFIG_DIMM_SLOTS_PER_CTLR; j++) {
 178                                 unsigned int dw;
 179                                 if (!pinfo->dimm_params[i][j].n_ranks)
 180                                         continue;
 181                                 dw = pinfo->dimm_params[i][j].primary_sdram_width;
 182                                 if ((dw == 72 || dw == 64)) {
 183                                         dbw_cap_adj[i] = 2;
 184                                         break;
 185                                 } else if ((dw == 40 || dw == 32)) {
 186                                         dbw_cap_adj[i] = 1;
 187                                         break;
 188                                 }
 189                         }
 190                         break;
 191
 192                 case 1:
 193                         /* 32-bit */
 194                         for (j = 0; j < CONFIG_DIMM_SLOTS_PER_CTLR; j++) {
 195                                 unsigned int dw;
 196                                 dw = pinfo->dimm_params[i][j].data_width;
 197                                 if (pinfo->dimm_params[i][j].n_ranks
 198                                     && (dw == 72 || dw == 64)) {
 199                                         /*
 200                                          * FIXME: can't really do it
 201                                          * like this because this just
 202                                          * further reduces the memory
 203                                          */
 204                                         found = 1;
 205                                         break;
 206                                 }
 207                         }
 208                         if (found) {
 209                                 dbw_cap_adj[i] = 1;
 210                         }
 211                         break;
 212
 213                 case 0:
 214                         /* 64-bit */
 215                         break;
 216
 217                 default:
 218                         printf("unexpected data bus width "
 219                                 "specified controller %u\n", i);
 220                         return 1;
 221                 }
 222         }
 223
 224         j = 0;
 225         for (i = 0; i < CONFIG_NUM_DDR_CONTROLLERS; i++)
 226                 if (pinfo->memctl_opts[i].memctl_interleaving)
 227                         j++;
 228         /*
 229          * Not support less than all memory controllers interleaving
 230          * if more than two controllers
 231          */
 232         if (j == CONFIG_NUM_DDR_CONTROLLERS)
 233                 *all_memctl_interleaving = 1;
 234
 235         /* Check that all controllers are rank interleaving. */
 236         j = 0;
 237         for (i = 0; i < CONFIG_NUM_DDR_CONTROLLERS; i++)
 238                 if (pinfo->memctl_opts[i].ba_intlv_ctl)
 239                         j++;
 240         /*
 241          * All memory controllers must be populated to qualify for
 242          * all controller rank interleaving
 243          */
 244          if (j == CONFIG_NUM_DDR_CONTROLLERS)
 245                 *all_ctlr_rank_interleaving = 1;
 246
 247         if (*all_memctl_interleaving) {
 248                 unsigned long long addr, total_mem_per_ctlr = 0;
 249                 /*
 250                  * If interleaving between memory controllers,
 251                  * make each controller start at a base address
 252                  * of 0.
 253                  *
 254                  * Also, if bank interleaving (chip select
 255                  * interleaving) is enabled on each memory
 256                  * controller, CS0 needs to be programmed to
 257                  * cover the entire memory range on that memory
 258                  * controller
 259                  *
 260                  * Bank interleaving also implies that each
 261                  * addressed chip select is identical in size.
 262                  */
 263
 264                 for (i = 0; i < CONFIG_NUM_DDR_CONTROLLERS; i++) {
 265                         addr = 0;
 266                         pinfo->common_timing_params[i].base_address = 0ull;
 267                         for (j = 0; j < CONFIG_DIMM_SLOTS_PER_CTLR; j++) {
 268                                 unsigned long long cap
 269                                         = pinfo->dimm_params[i][j].capacity;
 270
 271                                 pinfo->dimm_params[i][j].base_address = addr;
 272                                 addr += cap >> dbw_cap_adj[i];
 273                                 total_mem_per_ctlr += cap >> dbw_cap_adj[i];
 274                         }
 275                 }
 276                 pinfo->common_timing_params[0].total_mem = total_mem_per_ctlr;
 277         } else {
 278                 /*
 279                  * Simple linear assignment if memory
 280                  * controllers are not interleaved.
 281                  */
 282                 unsigned long long cur_memsize = 0;
 283                 for (i = 0; i < CONFIG_NUM_DDR_CONTROLLERS; i++) {
 284                         u64 total_mem_per_ctlr = 0;
 285                         pinfo->common_timing_params[i].base_address =
 286                                                 cur_memsize;
 287                         for (j = 0; j < CONFIG_DIMM_SLOTS_PER_CTLR; j++) {
 288                                 /* Compute DIMM base addresses. */
 289                                 unsigned long long cap =
 290                                         pinfo->dimm_params[i][j].capacity;
 291                                 pinfo->dimm_params[i][j].base_address =
 292                                         cur_memsize;
 293                                 cur_memsize += cap >> dbw_cap_adj[i];
 294                                 total_mem_per_ctlr += cap >> dbw_cap_adj[i];
 295                         }
 296                         pinfo->common_timing_params[i].total_mem =
 297                                                         total_mem_per_ctlr;
 298                 }
 299         }
 300
 301         return 0;
 302 }
 303
 304 unsigned long long
 305 fsl_ddr_compute(fsl_ddr_info_t *pinfo, unsigned int start_step,
 306                                        unsigned int size_only)
 307 {
 308         unsigned int i, j;
 309         unsigned int all_controllers_memctl_interleaving = 0;
 310         unsigned int all_controllers_rank_interleaving = 0;
 311         unsigned long long total_mem = 0;
 312
 313         fsl_ddr_cfg_regs_t *ddr_reg = pinfo->fsl_ddr_config_reg;
 314         common_timing_params_t *timing_params = pinfo->common_timing_params;
 315
 316         /* data bus width capacity adjust shift amount */
 317         unsigned int dbw_capacity_adjust[CONFIG_NUM_DDR_CONTROLLERS];
 318
 319         for (i = 0; i < CONFIG_NUM_DDR_CONTROLLERS; i++) {
 320                 dbw_capacity_adjust[i] = 0;
 321         }
 322
 323         debug("starting at step %u (%s)\n",
 324               start_step, step_to_string(start_step));
 325
 326         switch (start_step) {
 327         case STEP_GET_SPD:
 328                 /* STEP 1:  Gather all DIMM SPD data */
 329                 for (i = 0; i < CONFIG_NUM_DDR_CONTROLLERS; i++) {
 330                         fsl_ddr_get_spd(pinfo->spd_installed_dimms[i], i);
 331                 }
 332
 333         case STEP_COMPUTE_DIMM_PARMS:
 334                 /* STEP 2:  Compute DIMM parameters from SPD data */
 335
 336                 for (i = 0; i < CONFIG_NUM_DDR_CONTROLLERS; i++) {
 337                         for (j = 0; j < CONFIG_DIMM_SLOTS_PER_CTLR; j++) {
 338                                 unsigned int retval;
 339                                 generic_spd_eeprom_t *spd =
 340                                         &(pinfo->spd_installed_dimms[i][j]);
 341                                 dimm_params_t *pdimm =
 342                                         &(pinfo->dimm_params[i][j]);
 343
 344                                 retval = compute_dimm_parameters(spd, pdimm, i);
 345                                 if (retval == 2) {
 346                                         printf("Error: compute_dimm_parameters"
 347                                         " non-zero returned FATAL value "
 348                                         "for memctl=%u dimm=%u\n", i, j);
 349                                         return 0;
 350                                 }
 351                                 if (retval) {
 352                                         debug("Warning: compute_dimm_parameters"
 353                                         " non-zero return value for memctl=%u "
 354                                         "dimm=%u\n", i, j);
 355                                 }
 356                         }
 357                 }
 358
 359         case STEP_COMPUTE_COMMON_PARMS:
 360                 /*
 361                  * STEP 3: Compute a common set of timing parameters
 362                  * suitable for all of the DIMMs on each memory controller
 363                  */
 364                 for (i = 0; i < CONFIG_NUM_DDR_CONTROLLERS; i++) {
 365                         debug("Computing lowest common DIMM"
 366                                 " parameters for memctl=%u\n", i);
 367                         compute_lowest_common_dimm_parameters(
 368                                 pinfo->dimm_params[i],
 369                                 &timing_params[i],
 370                                 CONFIG_DIMM_SLOTS_PER_CTLR);
 371                 }
 372
 373         case STEP_GATHER_OPTS:
 374                 /* STEP 4:  Gather configuration requirements from user */
 375                 for (i = 0; i < CONFIG_NUM_DDR_CONTROLLERS; i++) {
 376                         debug("Reloading memory controller "
 377                                 "configuration options for memctl=%u\n", i);
 378                         /*
 379                          * This "reloads" the memory controller options
 380                          * to defaults.  If the user "edits" an option,
 381                          * next_step points to the step after this,
 382                          * which is currently STEP_ASSIGN_ADDRESSES.
 383                          */
 384                         populate_memctl_options(
 385                                         timing_params[i].all_DIMMs_registered,
 386                                         &pinfo->memctl_opts[i],
 387                                         pinfo->dimm_params[i], i);
 388                 }
 389                 check_interleaving_options(pinfo);
 390         case STEP_ASSIGN_ADDRESSES:
 391                 /* STEP 5:  Assign addresses to chip selects */
 392                 step_assign_addresses(pinfo,
 393                                 dbw_capacity_adjust,
 394                                 &all_controllers_memctl_interleaving,
 395                                 &all_controllers_rank_interleaving);
 396
 397         case STEP_COMPUTE_REGS:
 398                 /* STEP 6:  compute controller register values */
 399                 debug("FSL Memory ctrl cg register computation\n");
 400                 for (i = 0; i < CONFIG_NUM_DDR_CONTROLLERS; i++) {
 401                         if (timing_params[i].ndimms_present == 0) {
 402                                 memset(&ddr_reg[i], 0,
 403                                         sizeof(fsl_ddr_cfg_regs_t));
 404                                 continue;
 405                         }
 406
 407                         compute_fsl_memctl_config_regs(
 408                                         &pinfo->memctl_opts[i],
 409                                         &ddr_reg[i], &timing_params[i],
 410                                         pinfo->dimm_params[i],
 411                                         dbw_capacity_adjust[i],
 412                                         size_only);
 413                 }
 414
 415         default:
 416                 break;
 417         }
 418
 419         /* Compute the total amount of memory. */
 420
 421         /*
 422          * If bank interleaving but NOT memory controller interleaving
 423          * CS_BNDS describe the quantity of memory on each memory
 424          * controller, so the total is the sum across.
 425          */
 426         if (!all_controllers_memctl_interleaving
 427             && all_controllers_rank_interleaving) {
 428                 total_mem = 0;
 429                 for (i = 0; i < CONFIG_NUM_DDR_CONTROLLERS; i++) {
 430                         total_mem += timing_params[i].total_mem;
 431                 }
 432
 433         } else {
 434                 /*
 435                  * Compute the amount of memory available just by
 436                  * looking for the highest valid CSn_BNDS value.
 437                  * This allows us to also experiment with using
 438                  * only CS0 when using dual-rank DIMMs.
 439                  */
 440                 unsigned int max_end = 0;
 441
 442                 for (i = 0; i < CONFIG_NUM_DDR_CONTROLLERS; i++) {
 443                         for (j = 0; j < CONFIG_CHIP_SELECTS_PER_CTRL; j++) {
 444                                 fsl_ddr_cfg_regs_t *reg = &ddr_reg[i];
 445                                 if (reg->cs[j].config & 0x80000000) {
 446                                         unsigned int end;
 447                                         end = reg->cs[j].bnds & 0xFFF;
 448                                         if (end > max_end) {
 449                                                 max_end = end;
 450                                         }
 451                                 }
 452                         }
 453                 }
 454
 455                 total_mem = 1 + (((unsigned long long)max_end << 24ULL)
 456                                     | 0xFFFFFFULL);
 457         }
 458
 459         return total_mem;
 460 }
 461
 462 /*
 463  * fsl_ddr_sdram() -- this is the main function to be called by
 464  *      initdram() in the board file.
 465  *
 466  * It returns amount of memory configured in bytes.
 467  */
 468 phys_size_t fsl_ddr_sdram(void)
 469 {
 470         unsigned int i;
 471         unsigned int memctl_interleaved;
 472         unsigned long long total_memory;
 473         fsl_ddr_info_t info;
 474
 475         /* Reset info structure. */
 476         memset(&info, 0, sizeof(fsl_ddr_info_t));
 477
 478         /* Compute it once normally. */
 479         total_memory = fsl_ddr_compute(&info, STEP_GET_SPD, 0);
 480
 481         /* Check for memory controller interleaving. */
 482         memctl_interleaved = 0;
 483         for (i = 0; i < CONFIG_NUM_DDR_CONTROLLERS; i++) {
 484                 memctl_interleaved +=
 485                         info.memctl_opts[i].memctl_interleaving;
 486         }
 487
 488         if (memctl_interleaved) {
 489                 if (memctl_interleaved == CONFIG_NUM_DDR_CONTROLLERS) {
 490                         debug("memctl interleaving\n");
 491                         /*
 492                          * Change the meaning of memctl_interleaved
 493                          * to be "boolean".
 494                          */
 495                         memctl_interleaved = 1;
 496                 } else {
 497                         printf("Warning: memctl interleaving not "
 498                                 "properly configured on all controllers\n");
 499                         memctl_interleaved = 0;
 500                         for (i = 0; i < CONFIG_NUM_DDR_CONTROLLERS; i++)
 501                                 info.memctl_opts[i].memctl_interleaving = 0;
 502                         debug("Recomputing with memctl_interleaving off.\n");
 503                         total_memory = fsl_ddr_compute(&info,
 504                                                        STEP_ASSIGN_ADDRESSES,
 505                                                        0);
 506                 }
 507         }
 508
 509         /* Program configuration registers. */
 510         for (i = 0; i < CONFIG_NUM_DDR_CONTROLLERS; i++) {
 511                 debug("Programming controller %u\n", i);
 512                 if (info.common_timing_params[i].ndimms_present == 0) {
 513                         debug("No dimms present on controller %u; "
 514                                         "skipping programming\n", i);
 515                         continue;
 516                 }
 517
 518                 fsl_ddr_set_memctl_regs(&(info.fsl_ddr_config_reg[i]), i);
 519         }
 520
 521         if (memctl_interleaved) {
 522                 const unsigned int ctrl_num = 0;
 523
 524                 /* Only set LAWBAR1 if memory controller interleaving is on. */
 525                 fsl_ddr_set_lawbar(&info.common_timing_params[0],
 526                                          memctl_interleaved, ctrl_num);
 527         } else {
 528                 /*
 529                  * Memory controller interleaving is NOT on;
 530                  * set each lawbar individually.
 531                  */
 532                 for (i = 0; i < CONFIG_NUM_DDR_CONTROLLERS; i++) {
 533                         fsl_ddr_set_lawbar(&info.common_timing_params[i],
 534                                                  0, i);
 535                 }
 536         }
 537
 538         debug("total_memory = %llu\n", total_memory);
 539
 540 #if !defined(CONFIG_PHYS_64BIT)
 541         /* Check for 4G or more.  Bad. */
 542         if (total_memory >= (1ull << 32)) {
 543                 printf("Detected %lld MB of memory\n", total_memory >> 20);
 544                 printf("       This U-Boot only supports < 4G of DDR\n");
 545                 printf("       You could rebuild it with CONFIG_PHYS_64BIT\n");
 546                 printf("       "); /* re-align to match init_func_ram print */
 547                 total_memory = CONFIG_MAX_MEM_MAPPED;
 548         }
 549 #endif
 550
 551         return total_memory;
 552 }
 553
 554 /*
 555  * fsl_ddr_sdram_size() - This function only returns the size of the total
 556  * memory without setting ddr control registers.
 557  */
 558 phys_size_t
 559 fsl_ddr_sdram_size(void)
 560 {
 561         fsl_ddr_info_t  info;
 562         unsigned long long total_memory = 0;
 563
 564         memset(&info, 0 , sizeof(fsl_ddr_info_t));
 565
 566         /* Compute it once normally. */
 567         total_memory = fsl_ddr_compute(&info, STEP_GET_SPD, 1);
 568
 569         return total_memory;
 570 }