src/main/iblmain.c

   1 /*
   2  *
   3  * Copyright (C) 2010 Texas Instruments Incorporated - http://www.ti.com/
   4  *
   5  *
   6  *  Redistribution and use in source and binary forms, with or without
   7  *  modification, are permitted provided that the following conditions
   8  *  are met:
   9  *
  10  *    Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  *
  13  *    Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the
  16  *    distribution.
  17  *
  18  *    Neither the name of Texas Instruments Incorporated nor the names of
  19  *    its contributors may be used to endorse or promote products derived
  20  *    from this software without specific prior written permission.
  21  *
  22  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  23  *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  24  *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  25  *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  26  *  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  27  *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  28  *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  29  *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  30  *  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  31  *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  32  *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  33  *
  34 */
  35
  36
  37
  38 /*****************************************************************************************
  39  * FILE PURPOSE: Perform the top level boot
  40  *****************************************************************************************
  41  * FILE NAME: iblmain.c
  42  *
  43  * DESCRIPTION: The top level boot examines the boot configuration and performs boot
  44  *                              based on this configuration
  45  *
  46  * @file iblmain.c
  47  *
  48  * @brief
  49  *   This file is used to launch a boot based on the boot configuration structure
  50  *
  51  *****************************************************************************************/
  52 #include "ibl.h"
  53 #include "iblloc.h"
  54 #include "iblcfg.h"
  55 #include "device.h"
  56 #include "ethboot.h"
  57 #include "nandboot.h"
  58 #include "norboot.h"
  59 #include "bis.h"
  60 #include "coffwrap.h"
  61 #include "iblbtbl.h"
  62 #include "iblblob.h"
  63 #include "timer.h"
  64 #include "i2c.h"
  65 #include "spi_api.h"
  66 #include "ibl_elf.h"
  67 #include <string.h>
  68
  69 extern cregister unsigned int IER;
  70
  71 uint32 iblEndianIdx = 0;
  72 uint32 iblImageIdx = 0;
  73
  74 /**
  75  *  @brief
  76  *      Data structures shared between the 1st and 2nd stage IBL load
  77  *      are declared in a single header file, included in both stages
  78  */
  79 #include "iblStage.h"
  80
  81
  82
  83 /* Eat printfs */
  84 void mprintf(char *x, ...) { }
  85
  86 /**
  87  * @b Description
  88  * @n
  89  *
  90  *  Returns TRUE if the input priority is valid and enabled
  91  */
  92 BOOL iblPriorityIsValid (uint32 priority)
  93 {
  94     if ( (priority >= ibl_HIGHEST_PRIORITY)  &&
  95          (priority <= ibl_LOWEST_PRIORITY)   )
  96
  97         return (TRUE);
  98
  99
 100     return (FALSE);
 101
 102 }
 103
 104 /**
 105  * @b Description
 106  * @n
 107  *
 108  *  Returns TRUE if the mac address is 0
 109  */
 110 BOOL iblMacAddrIsZero (uint8 *maddr)
 111 {
 112     int32 i;
 113
 114     for (i = 0; i < 6; i++)
 115         if (maddr[i] != 0)
 116             return (FALSE);
 117
 118     return (TRUE);
 119
 120 }
 121
 122 /**
 123  *  @b Description
 124  *  @n
 125  *
 126  *  For NAND and NOR boots, configure the specified peripheral or memory interface
 127  */
 128 void iblPmemCfg (int32 interface, int32 port, bool enableNand)
 129 {
 130     int32 ret;
 131
 132     switch (interface)  {
 133
 134         #if (!defined(EXCLUDE_NAND_GPIO))
 135
 136         case ibl_PMEM_IF_GPIO:
 137                 ret = devicePowerPeriph (TARGET_PWR_GPIO);
 138                 break;
 139         #endif
 140
 141         #if (!defined(EXCLUDE_NOR_SPI) && !defined(EXCLUDE_NAND_SPI))
 142
 143             case ibl_PMEM_IF_SPI:  {
 144
 145                     Uint32      v;
 146                     spiConfig_t cfg;
 147
 148                     ret = devicePowerPeriph (TARGET_PWR_SPI);
 149                     if (ret != 0)
 150                         break;
 151
 152                     cfg.port      = port;
 153                     cfg.mode      = ibl.spiConfig.mode;
 154                     cfg.addrWidth = ibl.spiConfig.addrWidth;
 155                     cfg.npin      = ibl.spiConfig.nPins;
 156                     cfg.csel      = ibl.spiConfig.csel;
 157                     cfg.c2tdelay  = ibl.spiConfig.c2tdelay;
 158
 159                     /* On c66x devices the PLL module has a built in divide by 6, and the SPI
 160                      * has a maximum clock divider value of 0xff */
 161                     v = ibl.pllConfig[ibl_MAIN_PLL].pllOutFreqMhz / (DEVICE_SPI_MOD_DIVIDER * ibl.spiConfig.busFreqMHz);
 162                     if (v > 0xff)
 163                         v = 0xff;
 164
 165                     cfg.clkdiv =  (UINT16) v;
 166
 167                     ret = hwSpiConfig (&cfg);
 168                     if (ret != 0)  {
 169                         iblStatus.iblFail = ibl_FAIL_CODE_SPI_PARAMS;
 170                         return;
 171                     }
 172
 173                 }
 174                 break;
 175         #endif
 176
 177         #if (!defined(EXCLUDE_NOR_EMIF) || !defined(EXCLUDE_NAND_EMIF))
 178
 179             case ibl_PMEM_IF_CHIPSEL_2:
 180             case ibl_PMEM_IF_CHIPSEL_3:
 181             case ibl_PMEM_IF_CHIPSEL_4:
 182             case ibl_PMEM_IF_CHIPSEL_5:  {
 183
 184                     int i;
 185
 186                     /* Locate the configuration corresponding to this chip select space */
 187                     for (i = 0; i < ibl_MAX_EMIF_PMEM; i++)
 188                         if (ibl.emifConfig[i].csSpace == interface)
 189                             break;
 190
 191                     if (i == ibl_MAX_EMIF_PMEM)  {
 192                         iblStatus.iblFail = ibl_FAIL_CODE_NO_EMIF_CFG;
 193                         return;
 194                     }
 195
 196                     ret = devicePowerPeriph (TARGET_PWR_EMIF);
 197                     if (ret != 0)
 198                         break;
 199
 200                     if (hwEmif25Init (interface, ibl.emifConfig[i].busWidth, ibl.emifConfig[i].waitEnable, enableNand) != 0)
 201                         iblStatus.iblFail = ibl_FAIL_CODE_EMIF_CFG_FAIL;
 202
 203                 }
 204                 break;
 205
 206             #endif
 207
 208             default:
 209
 210
 211
 212                 iblStatus.iblFail = ibl_FAIL_CODE_INVALID_NAND_PERIPH;
 213                 return;
 214     }
 215
 216     if (ret != 0)  {
 217         iblStatus.iblFail = ibl_FAIL_CODE_PERIPH_POWER_UP;
 218         return;
 219     }
 220
 221 }
 222
 223
 224
 225 /**
 226  * @b Description
 227  * @n
 228  *
 229  * The main function kicks off the boot. If it does not find the magic value in the
 230  *     configuration array then default values are loaded. This default load
 231  *     is done only once at the start of boot.
 232  *
 233  * @retval
 234  *  None
 235  */
 236 void main (void)
 237 {
 238     int32 i, j;
 239     UINT32 v, boot_mode_idx, boot_para_idx;
 240     unsigned int dip_setting;
 241
 242     /* Initialize the status structure */
 243     iblMemset (&iblStatus, 0, sizeof(iblStatus_t));
 244     iblStatus.iblMagic   = ibl_MAGIC_VALUE;
 245     iblStatus.iblVersion = ibl_VERSION;
 246
 247
 248     /* Power up the timer */
 249     devicePowerPeriph (TARGET_PWR_TIMER_0);
 250
 251     /* Initialize the system timer (software tracking of the hardware timer state) */
 252     timer_init ();
 253
 254     /* Load default mac addresses for ethernet boot if requested */
 255     for (i = 0; i < ibl_N_BOOT_MODES; i++)  {
 256
 257         if (ibl.bootModes[i].bootMode == ibl_BOOT_MODE_TFTP)  {
 258
 259             if (iblMacAddrIsZero (ibl.bootModes[i].u.ethBoot.ethInfo.hwAddress))
 260
 261                 deviceLoadDefaultEthAddress (ibl.bootModes[i].u.ethBoot.ethInfo.hwAddress);
 262         }
 263     }
 264
 265
 266     /* DDR configuration is device specific */
 267     deviceDdrConfig ();
 268
 269     /* Try booting forever */
 270     for (;;)  {
 271
 272 #ifndef EXCLUDE_MULTI_BOOT
 273         v = DEVICE_REG32_R(DEVICE_JTAG_ID_REG);
 274         v &= DEVICE_JTAG_ID_MASK;
 275         if (
 276             (v == DEVICE_C6678_JTAG_ID_VAL)         ||
 277             (v == DEVICE_C6670_JTAG_ID_VAL)
 278            )
 279         {
 280             IER = 0;
 281
 282             /* For C66x devices, check the DEVSTAT register to find which image on which device to boot. */
 283             v = DEVICE_REG32_R(DEVICE_REG_DEVSTAT);
 284
 285             /* Get the Endianness */
 286             if (ibl_N_ENDIANS == 1)
 287             {
 288                 iblEndianIdx = 0;
 289             }
 290             else
 291             {
 292                 if (v & ibl_ENDIAN_LITTLE)
 293                 {
 294                     iblEndianIdx = 0;
 295                 }
 296                 else
 297                 {
 298                     iblEndianIdx = 1;
 299                 }
 300             }
 301
 302             /* Get the boot mode index */
 303             boot_para_idx = BOOT_READ_BITFIELD(v,8,4);
 304
 305             /* Only 1 image supported for TFTP boot */
 306             if (boot_para_idx > (ibl_N_IMAGES*(ibl_N_BOOT_MODES-1)))
 307             {
 308                 /* boot parameter index not supported */
 309                 continue;
 310             }
 311             boot_mode_idx = boot_para_idx/ibl_N_IMAGES;
 312             /* Get the boot image index */
 313             iblImageIdx = boot_para_idx & (ibl_N_IMAGES - 1);
 314
 315             iblStatus.activeBoot = ibl.bootModes[boot_mode_idx].bootMode;
 316
 317             switch (ibl.bootModes[boot_mode_idx].bootMode)
 318             {
 319 #ifndef EXCLUDE_ETH
 320             case ibl_BOOT_MODE_TFTP:
 321                 iblStatus.activeDevice = ibl_ACTIVE_DEVICE_ETH;
 322                 iblMemcpy (&iblStatus.ethParams, &ibl.bootModes[boot_mode_idx].u.ethBoot.ethInfo, sizeof(iblEthBootInfo_t));
 323                 iblEthBoot (boot_mode_idx);
 324                 break;
 325 #endif
 326
 327 #if ((!defined(EXCLUDE_NAND_EMIF)) || (!defined(EXCLUDE_NAND_GPIO)))
 328             case ibl_BOOT_MODE_NAND:
 329                 iblPmemCfg (ibl.bootModes[boot_mode_idx].u.nandBoot.interface, ibl.bootModes[boot_mode_idx].port, TRUE);
 330                 memset ((void *)0x80000000, 0, 0x20000000);
 331                 iblNandBoot (boot_mode_idx);
 332                 break;
 333 #endif
 334
 335 #if (!defined(EXCLUDE_NOR_EMIF) && !defined(EXCLUDE_NOR_SPI))
 336             case ibl_BOOT_MODE_NOR:
 337                 iblPmemCfg (ibl.bootModes[boot_mode_idx].u.norBoot.interface, ibl.bootModes[boot_mode_idx].port, TRUE);
 338                 iblNorBoot (boot_mode_idx);
 339                 break;
 340 #endif
 341             }
 342             iblStatus.heartBeat += 1;
 343         }
 344         else
 345 #endif
 346         {
 347
 348         dip_setting = get_device_switch_setting();
 349
 350         if (dip_setting == 0)
 351                 boot_mode_idx = 0;
 352         else if (dip_setting == 1)
 353                 boot_mode_idx = 1;
 354
 355         iblStatus.activeBoot = ibl.bootModes[boot_mode_idx].bootMode;
 356
 357         switch (ibl.bootModes[boot_mode_idx].bootMode) {
 358 #ifndef EXCLUDE_ETH
 359                 case ibl_BOOT_MODE_TFTP:
 360                         iblStatus.activeDevice = ibl_ACTIVE_DEVICE_ETH;
 361                         iblMemcpy (&iblStatus.ethParams, &ibl.bootModes[boot_mode_idx].u.ethBoot.ethInfo, sizeof(iblEthBootInfo_t));
 362                         iblEthBoot (boot_mode_idx);
 363                         break;
 364 #endif
 365
 366 #if ((!defined(EXCLUDE_NAND_EMIF)) || (!defined(EXCLUDE_NAND_GPIO)))
 367                 case ibl_BOOT_MODE_NAND:
 368                         iblPmemCfg (ibl.bootModes[boot_mode_idx].u.nandBoot.interface, ibl.bootModes[boot_mode_idx].port, TRUE);
 369                         iblNandBoot (boot_mode_idx);
 370                         break;
 371 #endif
 372         }
 373         iblStatus.heartBeat += 1;
 374         }
 375
 376     }
 377 } /* main */
 378
 379
 380
 381 /**
 382  * @b Description
 383  * @n
 384  *
 385  * The ibl boot function links a device to a data format. The data format
 386  * parser pulls data from the boot device
 387  *
 388  * @param[in] bootFxn      The structure containing the boot device functions
 389  *
 390  * @retval
 391  *  None
 392  */
 393 Uint32 iblBoot (BOOT_MODULE_FXN_TABLE *bootFxn, Int32 dataFormat, void *formatParams)
 394 {
 395     Uint32  entry = 0;
 396     Uint32  value32;
 397     Uint8   dataBuf[4];
 398     Uint16  value16;
 399
 400     /* Determine the data format if required */
 401     if (dataFormat == ibl_BOOT_FORMAT_AUTO)  {
 402
 403         (*bootFxn->peek)(dataBuf, sizeof(dataBuf));
 404         value32 = (dataBuf[0] << 24) | (dataBuf[1] << 16) | (dataBuf[2] << 8) | (dataBuf[3] << 0);
 405         value16 = (dataBuf[0] <<  8) | (dataBuf[1] <<  0);
 406
 407         /* BIS */
 408 #ifndef EXCLUDE_BIS
 409         if (value32 == BIS_MAGIC_NUMBER)
 410             dataFormat = ibl_BOOT_FORMAT_BIS;
 411 #endif
 412
 413 #ifndef EXCLUDE_COFF
 414         if (iblIsCoff (value16))
 415             dataFormat = ibl_BOOT_FORMAT_COFF;
 416 #endif
 417
 418 #ifndef EXCLUDE_ELF
 419         if (iblIsElf (dataBuf))
 420             dataFormat = ibl_BOOT_FORMAT_ELF;
 421 #endif
 422
 423         if (dataFormat == ibl_BOOT_FORMAT_AUTO)  {
 424             iblStatus.autoDetectFailCnt += 1;
 425             return (0);
 426         }
 427     }
 428
 429
 430     iblStatus.activeFileFormat = dataFormat;
 431
 432
 433     /* Invoke the parser */
 434     switch (dataFormat)  {
 435
 436 #ifndef EXCLUDE_BIS
 437         case ibl_BOOT_FORMAT_BIS:
 438             iblBootBis (bootFxn, &entry);
 439             break;
 440 #endif
 441
 442 #ifndef EXCLUDE_COFF
 443         case ibl_BOOT_FORMAT_COFF:
 444             iblBootCoff (bootFxn, &entry);
 445             break;
 446 #endif
 447
 448         case ibl_BOOT_FORMAT_BTBL:
 449             iblBootBtbl (bootFxn, &entry);
 450             break;
 451
 452 #ifndef EXCLUDE_BLOB
 453         case ibl_BOOT_FORMAT_BBLOB:
 454             iblBootBlob (bootFxn, &entry, formatParams);
 455             break;
 456 #endif
 457
 458 #ifndef EXCLUDE_ELF
 459         case ibl_BOOT_FORMAT_ELF:
 460             iblBootElf (bootFxn, &entry);
 461             break;
 462 #endif
 463
 464         default:
 465             iblStatus.invalidDataFormatSpec += 1;
 466             break;
 467
 468     }
 469
 470
 471     return (entry);
 472
 473 }
 474
 475
 476
 477
 478
 479
 480
 481