bl_ImageLoader_v5.c 40.1 KB
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492
/*****************************************************************************
*  Copyright Statement:
*  --------------------
*  This software is protected by Copyright and the information contained
*  herein is confidential. The software may not be copied and the information
*  contained herein may not be used or disclosed except with the written
*  permission of MediaTek Inc. (C) 2005
*
*  BY OPENING THIS FILE, BUYER HEREBY UNEQUIVOCALLY ACKNOWLEDGES AND AGREES
*  THAT THE SOFTWARE/FIRMWARE AND ITS DOCUMENTATIONS ("MEDIATEK SOFTWARE")
*  RECEIVED FROM MEDIATEK AND/OR ITS REPRESENTATIVES ARE PROVIDED TO BUYER ON
*  AN "AS-IS" BASIS ONLY. MEDIATEK EXPRESSLY DISCLAIMS ANY AND ALL WARRANTIES,
*  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF
*  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NONINFRINGEMENT.
*  NEITHER DOES MEDIATEK PROVIDE ANY WARRANTY WHATSOEVER WITH RESPECT TO THE
*  SOFTWARE OF ANY THIRD PARTY WHICH MAY BE USED BY, INCORPORATED IN, OR
*  SUPPLIED WITH THE MEDIATEK SOFTWARE, AND BUYER AGREES TO LOOK ONLY TO SUCH
*  THIRD PARTY FOR ANY WARRANTY CLAIM RELATING THERETO. MEDIATEK SHALL ALSO
*  NOT BE RESPONSIBLE FOR ANY MEDIATEK SOFTWARE RELEASES MADE TO BUYER'S
*  SPECIFICATION OR TO CONFORM TO A PARTICULAR STANDARD OR OPEN FORUM.
*
*  BUYER'S SOLE AND EXCLUSIVE REMEDY AND MEDIATEK'S ENTIRE AND CUMULATIVE
*  LIABILITY WITH RESPECT TO THE MEDIATEK SOFTWARE RELEASED HEREUNDER WILL BE,
*  AT MEDIATEK'S OPTION, TO REVISE OR REPLACE THE MEDIATEK SOFTWARE AT ISSUE,
*  OR REFUND ANY SOFTWARE LICENSE FEES OR SERVICE CHARGE PAID BY BUYER TO
*  MEDIATEK FOR SUCH MEDIATEK SOFTWARE AT ISSUE. 
*
*  THE TRANSACTION CONTEMPLATED HEREUNDER SHALL BE CONSTRUED IN ACCORDANCE
*  WITH THE LAWS OF THE STATE OF CALIFORNIA, USA, EXCLUDING ITS CONFLICT OF
*  LAWS PRINCIPLES.  ANY DISPUTES, CONTROVERSIES OR CLAIMS ARISING THEREOF AND
*  RELATED THERETO SHALL BE SETTLED BY ARBITRATION IN SAN FRANCISCO, CA, UNDER
*  THE RULES OF THE INTERNATIONAL CHAMBER OF COMMERCE (ICC).
*
*****************************************************************************/

/*****************************************************************************
 *
 * Filename:
 * ---------
 *   bl_ImageLoader_v5.c
 *
 * Project:
 * --------
 *   Bootloader
 *
 * Description:
 * ------------
 *   Reponsible for loading image on SV5 platform
 *
 * Author:
 * -------
 *   
 *
 *============================================================================
 *             HISTORY
 * Below this line, this part is controlled by PVCS VM. DO NOT MODIFY!!
 *------------------------------------------------------------------------------
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *------------------------------------------------------------------------------
 * Upper this line, this part is controlled by PVCS VM. DO NOT MODIFY!!
 *============================================================================
 ****************************************************************************/

#ifdef __SV5_ENABLED__

#include "kal_general_types.h"
#include "kal_public_api.h"
#include "sw_types.h"
#include "bl_common.h"
#include "br_GFH_file_info.h"
#include "br_GFH_bl_info.h"
#include "bl_GFH_body.h"
#include "bl_BootInfo.h"
#include "bl_common.h"
#include "bl_loader.h"
#include "bl_custom.h"
#include "bl_setting.h"
#include "bl_status.h"
#include "bl_FOTA.h"
#include "bl_init.h"
#include "br_bl_param.h"

#include "custom_img_config.h"

#include "br_time_stamp.h"
#ifdef __TIME_STAMP__ 
#include "br_time_stamp_cb.h"
#include "bl_time_stamp_id.h"
#endif

#include "FTL.h"
#include "br_header_block.h"
#include "br_GFH_error.h"
#include "br_shared_flash_drv.h"
#include "cbr.h"
#include "Cbr_record_def.h"

#include <string.h>
/*************************************************************************
 * Macro and const definition
 *************************************************************************/
extern kal_uint32 custom_RAM_baseaddr(void);
extern kal_uint32 custom_FACTORY_ROM_baseaddr(void);
extern kal_bool IsMetaModeEnabled(void);
extern U32  GFH_Find(U32 buf_addr, GFH_TYPE type, void ** pp_gfh);
 
#define REMAPPING_ADDR (custom_RAM_baseaddr())
#define REMAPPING_MASK (custom_RAM_baseaddr()-1)
#define MAX_FLASH_BOUNDARY (0xffffffff)

#ifndef __USE_EXTERNAL_READ_BUFFER__
#define PAGE_BUFFER_ADDR (SYSRAM_BASE+0x1000)
#else
#define PAGE_BUFFER_ADDR ((kal_uint32)(&externalPageBuffer))
#endif

#ifdef __NFI_SHARED_DRV__
extern void FTL_SetNFISharedDrv(kal_uint32 funcTblAddr, kal_uint32 *pHandleBufAddr);
#endif /* __NFI_SHARED_DRV__ */

extern kal_uint32 bl_slim_div(const kal_uint32 n, const kal_uint32 d, kal_uint32 *pR);
extern kal_uint32 bl_slim_mod(const kal_uint32 n, const kal_uint32 d);
extern kal_uint32 SST_CheckBootloaderHash(kal_uint32* pBinary);

#if defined(__EXT_BL_UPDATE__)
const kal_uint32 EXT_BL_END_MARK[] = MTK_EXT_BL_END_MARK;
#endif /* __EXT_BL_UPDATE__ */

/*************************************************************************
 * Structure definition
 *************************************************************************/

/*************************************************************************
 * Global variables definition
 *************************************************************************/

kal_uint32 g_maui_load_addr = INVALID_START_ADDR;
FTL_FuncTbl *g_ftlFuncTbl = NULL;

#if defined(_NAND_FLASH_BOOTING_) || defined(__EMMC_BOOTING__) || defined(__XIP_SHADOWING__)

static kal_uint32 mauiReadLen = 0, restMauiFlashAddr = 0;

#endif

#pragma arm section zidata = "EXT_UN_INIT_ZI"

#ifdef __USE_EXTERNAL_READ_BUFFER__
static kal_uint32 externalPageBuffer[8192/4];
#endif

static kal_uint32 g_mauiInfoBuf[1024/4];

#pragma arm section zidata

static kal_bool g_mauiInfoRead = KAL_FALSE;

/*************************************************************************
 * External symbols
 *************************************************************************/

extern const kal_char blID1[];
extern const kal_char blID2[];
extern FTL_FuncTbl ftlFuncTbl;
extern FTL_FuncTbl ftlFuncTblBl;
extern BL_Info_Wrapper_st BL_Shared_info;
extern BL_Param_v4 *g_pBROM_BL_Param;
extern kal_bool g_bootupDisabled;
extern kal_uint32 g_bootupStatus;
   
/*************************************************************************
 * Declaration
 *************************************************************************/

kal_uint32 GetBinaryStartInFlash(GFH_FILE_TYPE type);

/*************************************************************************
 * Main code
 *************************************************************************/

#ifdef __NAND_BOOT__
/**********************************************************
Description : Initialziation routines for each memory devices
Input       : None
Output      : None
***********************************************************/
BL_STATUS InitNFI(void)
{
   
#if __MINI_BOOTLOADER__
   kal_uint32 i;
   kal_uint32 *pSrc, *pDst;

   // Copy the Bootloader Header from predefined space
   pSrc = (kal_uint32 *)(&g_pBROM_BL_Param->m_hdrblk_info.m_region0_u.m_nand_hdr);
   pDst = (kal_uint32 *)&BLHeader;
   
   for (i=0; i<(sizeof(BLHeader)>>2); i++)  // Need to make sure BLHeader is 4 bytes multiple.
   {
      *pDst++ = *pSrc++;
   }
   
   if ( strcmp(blID1, BLHeader.ID1) || strcmp(blID2, BLHeader.ID2) )
   {
      BL_PRINT(LOG_ERROR, "\nBootloader Header ID incorrect, quit!\n\r");
      BL_PRINT(LOG_ERROR, "\nID1(default %s) = %s\n\r", blID1, BLHeader.ID1);
      BL_PRINT(LOG_ERROR, "\nID2(default %s) = %s\n\n\n\r", blID2, BLHeader.ID2);
      return INVALID_START_ADDR;
   }

#ifdef __NFI_SHARED_DRV__
if(g_pBROM_BL_Param->m_ver >= 4 )
    //((SD_Flash_Mapping_Table*)(((U32 *)(g_pBROM_BL_Param->m_sd_flash_drv_tbl_addr))[g_pBROM_BL_Param->m_sd_flash_drv_idx]))->m_sd_flash_drv_tbl_addr,
   FTL_SetNFISharedDrv( 0xfff0b440, &g_pBROM_BL_Param->m_sd_flash_drv_handle_addr);
else
   FTL_SetNFISharedDrv(g_pBROM_BL_Param->m_sd_nand_flash_drv_tbl_addr, &g_pBROM_BL_Param->m_sd_flash_drv_handle_addr);
#endif /* __NFI_SHARED_DRV__ */

   g_ftlFuncTbl = &ftlFuncTblBl;

#else

   g_ftlFuncTbl = &ftlFuncTbl;

#endif

   g_ftlFuncTbl->FTL_Init(&BLHeader);

   return BL_ERROR_NONE;
}

#endif /* __NAND_BOOT__ */

#ifdef __EMMC_BOOT__
/**********************************************************
Description : Exported API for loading ExtBootloader
Input       : None
Output      : None
***********************************************************/
BL_STATUS InitEMMC(void)
{
   g_ftlFuncTbl = &ftlFuncTbl;
    
   g_ftlFuncTbl->FTL_Init(NULL);
   
   return BL_ERROR_NONE;
}
#endif /* __EMMC_BOOT__ */

#ifdef __SF_BOOT__
/**********************************************************
Description : Exported API for loading ExtBootloader
Input       : None
Output      : None
***********************************************************/
BL_STATUS InitSF(void)
{
   g_ftlFuncTbl = &ftlFuncTbl;
    
   g_ftlFuncTbl->FTL_Init(NULL);
   
   return BL_ERROR_NONE;
}
#endif /* __SF_BOOT__ */

#ifdef __NOR_BOOT__
/**********************************************************
Description : Exported API for loading ExtBootloader
Input       : None
Output      : None
***********************************************************/
BL_STATUS InitNOR(void)
{
   g_ftlFuncTbl = &ftlFuncTbl;
    
   g_ftlFuncTbl->FTL_Init(NULL);
   
   return BL_ERROR_NONE;
}
#endif /* __NOR_BOOT__ */

/**********************************************************
Description : Exported API for loading ExtBootloader
Input       : None
Output      : None
***********************************************************/
void InitFlashDriver(void)
{
#if defined(__NAND_BOOT__)

   InitNFI();

#elif defined(__EMMC_BOOT__)

   InitEMMC();

#elif defined(__SF_BOOT__)

   InitSF();

#elif defined(__NOR_BOOT__)

   InitNOR();

#endif
}


#if defined(_NAND_FLASH_BOOTING_) || defined(__EMMC_BOOTING__)

/**********************************************************
Description : Get the first block next to bootloader region
Input       : None
Output      : None
***********************************************************/
void SetTTBL(U32 *pTtbl, U32 num)
{
   
}

/**********************************************************
Description : Get the first block next to bootloader region
Input       : None
Output      : None
***********************************************************/
kal_bool ReadDataX(kal_uint32 ptr, kal_uint32 pageNo, kal_uint32 length, kal_bool bDAL, kal_uint32 *pNextPage)
{
   kal_uint32  page_size = g_ftlFuncTbl->FTL_GetPageSize();
   kal_uint32  page_per_block;
   FTL_OptParam ftl_opt;

   kal_bool goodBlockChecked = KAL_FALSE;

   ftl_opt.bypass_dal = (bDAL == KAL_TRUE) ? KAL_FALSE : KAL_TRUE;

   page_per_block = BL_SLIM_UDIV(g_ftlFuncTbl->FTL_GetBlockSize(0, &ftl_opt), page_size);

   ASSERT((BL_SLIM_UMOD(length, page_size)) == 0);

   if(length == 0)
   {
      return KAL_TRUE;
   }

   WacthDogRestart();

   while(length)
   {
      if(!goodBlockChecked)
      {
         while( g_ftlFuncTbl->FTL_CheckGoodBlock(BL_SLIM_UDIV(pageNo, page_per_block), &ftl_opt) == FTL_ERROR_BAD_BLOCK )
         {
            /* Skip the bad block */
            BL_PRINT(LOG_INFO, "\n\rBad block at block %d\n\r", BL_SLIM_UDIV(pageNo, page_per_block));
            
            pageNo = (BL_SLIM_UDIV(pageNo, page_per_block)+1)*page_per_block;
         }

         goodBlockChecked = KAL_TRUE;
      }

      if( g_ftlFuncTbl->FTL_ReadPage(BL_SLIM_UDIV(pageNo, page_per_block), BL_SLIM_UMOD(pageNo, page_per_block), (kal_uint32*)ptr, &ftl_opt) != FTL_SUCCESS )
      {
         BL_PRINT(LOG_CRIT, "Read error at block %d, page %d\n\r", BL_SLIM_UDIV(pageNo, page_per_block), BL_SLIM_UMOD(pageNo, page_per_block));
         return KAL_FALSE;
      }

      pageNo++;
      length -= page_size;
      ptr += page_size;

      /* Looking for the next good block */
      if ( (BL_SLIM_UMOD(pageNo, page_per_block))==0 )
      {
         goodBlockChecked = KAL_FALSE;
         BL_PRINT(LOG_INFO, "..");       
      }
   }

   if(pNextPage)
   {
      *pNextPage = pageNo;
   }

   return KAL_TRUE;
}

/**********************************************************
Description : Read the first page and check the GFH structure
Input       : None
Output      : None
***********************************************************/
kal_uint32 bl_ReadFileGFH(kal_uint32 flashBeginPage, kal_uint32 flashBoundPage, kal_uint32 *pNextPage, kal_uint32 *pReadLength)
{
   kal_uint32 target_addr;
   GFH_FILE_INFO_v1 *pGFHFileInfo;

   kal_uint32 page_no = flashBeginPage;
   kal_uint32 page_size = g_ftlFuncTbl->FTL_GetPageSize();
   kal_int32 to_read, read_part;

   pGFHFileInfo = (GFH_FILE_INFO_v1*)PAGE_BUFFER_ADDR;

   /* GFH_info should be smaller than one page */
   ASSERT(sizeof(GFH_FILE_INFO_v1) <= page_size);

   /* Read first page (GFH Info) to internal page buffer */
   if( ReadDataX((kal_uint32)pGFHFileInfo, page_no, page_size, KAL_TRUE, &page_no) == KAL_FALSE )
   {
      return INVALID_START_ADDR;
   }

   /* Sanity test of GFH */
   if( GFH_FILE_INFO_IsValid(pGFHFileInfo) != B_OK )
   {
      BL_PRINT(LOG_ERROR, "Invalid GFH File Info\n\r");
      return INVALID_START_ADDR;
   }

   /* Make sure the length of the data is still in the region */
   if( BL_SLIM_UDIV((pGFHFileInfo->m_file_len+page_size-1), page_size) + flashBeginPage > flashBoundPage )
   {
      BL_PRINT(LOG_ERROR, "file_len>bound_addr\n\r");
      return INVALID_START_ADDR;
   }

   /* Make sure the load address is in bank 0 */
   if( pGFHFileInfo->m_load_addr >= EMI_BANK_END || pGFHFileInfo->m_load_addr+pGFHFileInfo->m_file_len > EMI_BANK_END )
   {
      BL_PRINT(LOG_ERROR, "Invalad load addr %x\n\r", pGFHFileInfo->m_load_addr);
      return INVALID_START_ADDR;
   }

   target_addr = pGFHFileInfo->m_load_addr;
   
   /* Move the first page to its load address */
   memmove((kal_uint32*)(target_addr), (kal_uint32*)pGFHFileInfo, page_size);

   /* Read other GFHs */
   to_read = (kal_uint32)(BL_SLIM_UDIV(((pGFHFileInfo->m_content_offset - page_size)+(page_size-1)), page_size))*page_size;
   
   read_part = to_read + page_size;
   
   if(to_read > 0)
   {
      if(ReadDataX(target_addr+page_size, page_no, to_read, KAL_TRUE, &page_no) == KAL_FALSE)
      {
         return INVALID_START_ADDR;
      }
   }

   if(pReadLength)
   {
      *pReadLength = read_part;
   }

   if(pNextPage)
   {
      *pNextPage = page_no;
   }
   
   return target_addr;
}

/**********************************************************
Description : Read the the binary body, with a given skiping length
Input       : pGFHFileInfo:   The binary load address. GFH has to be loaded already
              pageNo:         Starting page number
              readPart:       Read length
Output      : Original buffer address
***********************************************************/
kal_uint32 bl_ReadFileBody(GFH_FILE_INFO_v1 *pGFHFileInfo, kal_uint32 pageNo, kal_uint32 readPart)
{
   kal_uint32 page_size = g_ftlFuncTbl->FTL_GetPageSize();
   
   kal_uint32 to_read = (kal_uint32)(BL_SLIM_UDIV(((pGFHFileInfo->m_file_len - readPart)+(page_size-1)), page_size))*page_size;
   
   if(to_read > 0)
   {
      if(ReadDataX(((kal_uint32)pGFHFileInfo)+readPart, pageNo, to_read, KAL_TRUE, NULL) == KAL_FALSE)
      {
         return INVALID_START_ADDR;
      }
   }

   return (kal_uint32)pGFHFileInfo;
}


#elif defined(__XIP_SHADOWING__)

/**********************************************************
Description : Read the first page and check the GFH structure
Input       : None
Output      : None
***********************************************************/
kal_uint32 bl_ReadFileGFH(kal_uint32 flashBeginAddr, kal_uint32 flashBoundAddr, kal_uint32 *pNextAddr, kal_uint32 *pReadLength)
{
   kal_uint32 target_addr;
  
   GFH_FILE_INFO_v1 *pGFHFileInfo;

   pGFHFileInfo = (GFH_FILE_INFO_v1*)flashBeginAddr;

   /* Sanity test of GFH */
   if( GFH_FILE_INFO_IsValid(pGFHFileInfo) != B_OK )
   {
      BL_PRINT(LOG_ERROR, "Invalid GFH File Info\n\r");
      return INVALID_START_ADDR;
   }

   /* Make sure the length of the data is still in the region */
   if( pGFHFileInfo->m_file_len + flashBeginAddr > flashBoundAddr )
   {
      BL_PRINT(LOG_ERROR, "file_len>bound_addr\n\r");
      return INVALID_START_ADDR;
   }

   /* Make sure the load address is in bank 0 */
   if( pGFHFileInfo->m_load_addr >= EMI_BANK_END || pGFHFileInfo->m_load_addr+pGFHFileInfo->m_file_len > EMI_BANK_END )
   {
      BL_PRINT(LOG_ERROR, "Invalad load addr %x\n\r", pGFHFileInfo->m_load_addr);
      return INVALID_START_ADDR;
   }

   // Because m_load_addr in XIP shadowing is flash address, we use a general variable generated by sysgen
   //target_addr = pGFHFileInfo->m_load_addr;
   target_addr = MAUI_LV_ADDR_NOR;
   
   /* Move the first page to its load address */
   memmove((kal_uint32*)(target_addr), (kal_uint32*)pGFHFileInfo, pGFHFileInfo->m_content_offset);

   if(pReadLength)
   {
      *pReadLength = pGFHFileInfo->m_content_offset;
   }

   if(pNextAddr)
   {
      *pNextAddr = flashBeginAddr + pGFHFileInfo->m_content_offset;
   }

   return target_addr;
}

/**********************************************************
Description : Read the the binary body, with a given skiping length
Input       : pGFHFileInfo:   The binary load address. GFH has to be loaded already
              flashAddr:      Starting address
              readPart:       Read length
Output      : Original buffer address
***********************************************************/

kal_uint32 bl_ReadFileBody(GFH_FILE_INFO_v1 *pGFHFileInfo, kal_uint32 flashAddr, kal_uint32 readPart)
{
   memcpy((kal_uint8*)pGFHFileInfo+readPart, (kal_uint8*)flashAddr, pGFHFileInfo->m_file_len-readPart);
   
   return (kal_uint32)pGFHFileInfo;
}

#endif /* _NAND_FLASH_BOOTING_ || __EMMC_BOOTING__ */

#if !defined(_NAND_FLASH_BOOTING_) && !defined(__EMMC_BOOTING__)
kal_uint32 MapToCurrentFlashAddr(kal_uint32 addr)
{

#if defined(__RAM_FLASH_REMAP_DONE_IN_EMI_INIT__)
   //In new EMI, remap is always done by EMI init such that flash is on bank 1
   addr |= REMAPPING_ADDR;
#else
   addr &= REMAPPING_MASK;
#endif
   return addr;
}
#endif

#ifdef __MINI_BOOTLOADER__

#if defined(__EXT_BL_UPDATE__) && (defined(_NAND_FLASH_BOOTING_) || defined(__EMMC_BOOTING__))

kal_bool bl_LoadAndCompareExtBootloaderEndMark(U32 begin_addr, U32 bound_addr)
{
   GFH_FILE_INFO_v1 *pGFHFileInfo;
   
   kal_uint32 page_size = g_ftlFuncTbl->FTL_GetPageSize();
   kal_uint32 page_per_block = BL_SLIM_UDIV(g_ftlFuncTbl->FTL_GetBlockSize(0, NULL), g_ftlFuncTbl->FTL_GetPageSize());
   kal_int32 markerPage = bound_addr-1;

   ASSERT(BL_SLIM_UMOD(bound_addr, page_per_block) == 0);
   
   pGFHFileInfo = (GFH_FILE_INFO_v1*)PAGE_BUFFER_ADDR;

   for(;markerPage>=begin_addr; markerPage-=page_per_block)
   {
      if(g_ftlFuncTbl->FTL_CheckGoodBlock(BL_SLIM_UDIV(markerPage, page_per_block), NULL) == FTL_ERROR_BAD_BLOCK)
      {
         BL_PRINT(LOG_INFO, "Bad block at block %d\n\r", BL_SLIM_UDIV(markerPage, page_per_block));
         continue;
      }

      if(g_ftlFuncTbl->FTL_ReadPage(BL_SLIM_UDIV(markerPage, page_per_block), BL_SLIM_UMOD(markerPage, page_per_block), (kal_uint32*)PAGE_BUFFER_ADDR, NULL) == FTL_SUCCESS )
      {
         if(CompareEndMarkWithError((kal_uint32*)(PAGE_BUFFER_ADDR+page_size-sizeof(EXT_BL_END_MARK)), EXT_BL_END_MARK, BIT_ERROR_THRESHOLD) == KAL_TRUE)
         {
            return KAL_TRUE;
         }
      }

      break;
   }

   return KAL_FALSE;
}

#endif /* __EXT_BL_UPDATE__ &&  (_NAND_FLASH_BOOTING_ || __EMMC_BOOTING__) */

#if defined(__NAND_BOOT__) || defined(__EMMC_BOOT__)
/**********************************************************
Description : Read Ext Bootloader from bootloader
Input       : None
Output      : None
***********************************************************/
kal_uint32 bl_ReadExtBootloaderFromFlash(kal_uint32 flashBegin, kal_uint32 flashBound)
{
   kal_uint32 page, readLen;
   kal_uint32 targetAddr;
   GFH_FILE_INFO_v1* pExtBlGFH;
   
   targetAddr = bl_ReadFileGFH(flashBegin, flashBound, &page, &readLen);
   pExtBlGFH = (GFH_FILE_INFO_v1*)targetAddr;

   if(targetAddr == INVALID_START_ADDR)
   {
      BL_PRINT(LOG_CRIT, "No ExtBL GFH found\n\r");
      return INVALID_START_ADDR;
   }

   //Do sanity test again on loaded GFH to detect EMI failure
   if( GFH_FILE_INFO_IsValid(pExtBlGFH) != B_OK )
   {
      BL_PRINT(LOG_ERROR, "Re-check ExtBL GFH failed. May be EMI problem!!\r");
      return INVALID_START_ADDR;
   }

   targetAddr = bl_ReadFileBody(pExtBlGFH, page, readLen);
   if(targetAddr == INVALID_START_ADDR)
   {
      BL_PRINT(LOG_CRIT, "Read ExtBL Body failed\n\r");
      return INVALID_START_ADDR;
   }

   return targetAddr;
}
#endif /* __NAND_BOOT__ || __EMMC_BOOT__  */

/**********************************************************
Description : Read Ext Bootloader from bootloader
Input       : None
Output      : None
***********************************************************/
kal_uint32 bl_ReadExtBootloaderContent(U32 begin_addr, U32 bound_addr, GFH_FLASH_DEV dev_type)
{
   kal_uint32 target_addr = INVALID_START_ADDR;
#ifdef __EMMC_BOOT__   
   kal_uint32 page_size;
#endif   
   
   TS_BEGIN(TSID_BL_LOAD_EXT_BOOTLOADER_BODY);
   
   switch(dev_type)
   {
#ifdef __NAND_BOOT__
      case F_NAND_TTBL:
      case F_NAND_SEQUENTIAL:         
      case F_NAND_FDM50:
      case F_SPI_NAND_SEQUENTIAL:
      case F_SPI_NAND_TTBL:
      case F_SPI_NAND_FDM50:

         if(dev_type == F_NAND_TTBL || dev_type == F_SPI_NAND_TTBL)
         {
            /* Set and enable TTBL translation */
            SetTTBL((U32*)&g_pBROM_BL_Param->m_hdrblk_info.m_region2_u.m_br_ttbl.m_log2phy_map.m_entry, 
                    g_pBROM_BL_Param->m_hdrblk_info.m_region2_u.m_br_ttbl.m_log2phy_map.m_num);
         }
         else
         {
            SetTTBL(0, 0);
         }

#if defined(__EXT_BL_UPDATE__)
         if(bl_LoadAndCompareExtBootloaderEndMark(begin_addr, bound_addr) == KAL_FALSE)
         {
            BL_PRINT(LOG_INFO, "End mark is not found\r\n");
            return INVALID_START_ADDR;
         }
#endif /* __EXT_BL_UPDATE__ */

         target_addr = bl_ReadExtBootloaderFromFlash(begin_addr, bound_addr);
         
         break;
#endif /* __NAND_BOOT__ */

#ifdef __EMMC_BOOT__
      case F_EMMC_BOOT_REGION:
      case F_EMMC_DATA_REGION:

         page_size = g_ftlFuncTbl->FTL_GetPageSize();
         ASSERT(BL_SLIM_UMOD(begin_addr, page_size) == 0 && BL_SLIM_UMOD(bound_addr, page_size) == 0);

         begin_addr = BL_SLIM_UDIV(begin_addr, page_size);
         bound_addr = BL_SLIM_UDIV(bound_addr, page_size);

#if defined(__EXT_BL_UPDATE__)
         if(bl_LoadAndCompareExtBootloaderEndMark(begin_addr, bound_addr) == KAL_FALSE)
         {
            BL_PRINT(LOG_INFO, "End mark is not found\r\n");
            return INVALID_START_ADDR;
         }
#endif /* __EXT_BL_UPDATE__ */

         target_addr = bl_ReadExtBootloaderFromFlash(begin_addr, bound_addr);

         break;
#endif /* __EMMC_BOOT__ */

#if defined(__NOR_BOOT__) || defined(__SF_BOOT__)
      case F_NOR:
      case F_SF:
         begin_addr = MapToCurrentFlashAddr(begin_addr);

#if defined(__EXT_BL_UPDATE__)
         if(CompareEndMarkWithError((kal_uint32*)(begin_addr+BL_IMG_MAX_SIZE-sizeof(EXT_BL_END_MARK)), EXT_BL_END_MARK, BIT_ERROR_THRESHOLD) == KAL_FALSE)
         {
            BL_PRINT(LOG_INFO, "End mark is not found\r\n");
            return INVALID_START_ADDR;
         }
#endif /* __EXT_BL_UPDATE__ */

         if(GFH_FILE_INFO_IsValid((GFH_FILE_INFO_v1*)begin_addr) == 0)
         {
            target_addr = begin_addr;
         }

         if((((GFH_FILE_INFO_v1*)begin_addr)->m_attr & FILE_INFO_ATTR_XIP) == 0)
         {
            memcpy((void*)((GFH_FILE_INFO_v1*)begin_addr)->m_load_addr, (void*)begin_addr, ((GFH_FILE_INFO_v1*)begin_addr)->m_file_len);
            target_addr = ((GFH_FILE_INFO_v1*)begin_addr)->m_load_addr;
         }
            
         break;
#endif /* __NOR_BOOT__ || __SF_BOOT__ */

      default:
         BL_PRINT(LOG_ERROR, "Unsupported dev type %d", dev_type);
   }

   if(target_addr != INVALID_START_ADDR)
   {
      TS_INFO(TSID_BL_LOAD_EXT_BOOTLOADER_BODY, 0, ((GFH_FILE_INFO_v1*)(target_addr))->m_file_len, 0);
   }

   TS_END(TSID_BL_LOAD_EXT_BOOTLOADER_BODY);
   
   return target_addr;
}

/**********************************************************
Description : Exported API for loading ExtBootloader
Input       : None
Output      : None
***********************************************************/

kal_uint32 LoadExtBootloader()
{
   BR_Layout_v1 *pBootRegionLayout;
   kal_uint32 i;
   kal_uint32 ext_bl_addr = INVALID_START_ADDR;

   TS_BEGIN(TSID_BL_LOAD_EXT_BOOTLOADER);

   TS_BEGIN(TSID_BL_INIT_MINI_FLASH_DRV);
   InitFlashDriver();
   TS_END(TSID_BL_INIT_MINI_FLASH_DRV);

   /* Sanity test on Boot region layout */
   pBootRegionLayout = &g_pBROM_BL_Param->m_hdrblk_info.m_region1_u.m_br_layout;

   if(strcmp(pBootRegionLayout->m_identifier, BRLYT_ID))
   {
      BL_PRINT(LOG_ERROR, "\nLayout ID error\n\r");
      return INVALID_START_ADDR;
   }

   /* Scan all possible bootloaders */
   for(i=0; i<MAX_BL_NUM; i++)
   {
      if(pBootRegionLayout->m_bl_desc[i].m_bl_type != ARM_EXT_BL
#if defined(__EXT_BL_UPDATE__)
      && pBootRegionLayout->m_bl_desc[i].m_bl_type != ARM_EXT_BL_BACKUP         
#endif         
         )
      {
         continue;
      }

      //Basic checks
      
      if(pBootRegionLayout->m_bl_desc[i].m_bl_exist_magic != BL_EXIST_MAGIC)
      {
         BL_PRINT(LOG_ERROR, "No EXIST_MAGIC for ExtBootloader\n\r");
         return INVALID_START_ADDR;
      }

      if(pBootRegionLayout->m_bl_desc[i].m_bl_attribute & BL_ATTR_LOAD_BY_BOOTROM)
      {
         BL_PRINT(LOG_WARN, "Bootrom has loaded ExtBootloader!?\n\r");
         return INVALID_START_ADDR;
      }

      //Load the bootloader
      
      ext_bl_addr = bl_ReadExtBootloaderContent(pBootRegionLayout->m_bl_desc[i].m_bl_begin_dev_addr, pBootRegionLayout->m_bl_desc[i].m_bl_boundary_dev_addr, pBootRegionLayout->m_bl_desc[i].m_bl_dev);


#if !defined(__BRINGUP_SUPPORT__)

#if !defined(__16_3_SEG__) && !defined(__32_32_SEG__) || defined(__MTK_SECURE_PLATFORM__)

      //Check the bootloader hash
      
      if(ext_bl_addr != INVALID_START_ADDR)
      {
         if(SST_CheckBootloaderHash((kal_uint32*)ext_bl_addr) != 0)
         {
            BL_PRINT(LOG_INFO, "Bad ExtBL hash\r\n");
            ext_bl_addr = INVALID_START_ADDR;
         }
      }

#endif
      
#endif /* !__BRINGUP_SUPPORT__ */

      if(ext_bl_addr == INVALID_START_ADDR)
      {
#if defined(__EXT_BL_UPDATE__)
         if(pBootRegionLayout->m_bl_desc[i].m_bl_type == ARM_EXT_BL)
         {
            BL_PRINT(LOG_INFO, "Failed to load ExtBootloader, try Backup\r\n");
            continue;
         }
#endif
         BL_PRINT(LOG_CRIT, "Error when loading ExtBootloader\n\r");
         return INVALID_START_ADDR;
      }

      if(ext_bl_addr != ((GFH_FILE_INFO_v1*)(ext_bl_addr))->m_load_addr)
      {
         BL_PRINT(LOG_ERROR, "Mismatched load address\n\r");
         return INVALID_START_ADDR;
      }

#if defined(__EXT_BL_UPDATE__)
      g_extBlUpdateInfo.m_current_bl          = (pBootRegionLayout->m_bl_desc[i].m_bl_type == ARM_EXT_BL) ? E_EXTBL_PRIMARY_REGION : E_EXTBL_BACKUP_REGION;
      g_extBlUpdateInfo.m_current_bl_size     = ((GFH_FILE_INFO_v1*)(ext_bl_addr))->m_file_len;
#endif

      break;
   }

   if(i == MAX_BL_NUM)
   {
      BL_PRINT(LOG_ERROR, "No ExtBootloader exists in BR\n\r");
      return INVALID_START_ADDR;
   }

   TS_END(TSID_BL_LOAD_EXT_BOOTLOADER);

   return ext_bl_addr;
}

#endif /* __MINI_BOOTLOADER__ */

#ifdef __EXT_BOOTLOADER__


#if defined(_NAND_FLASH_BOOTING_) || defined(__EMMC_BOOTING__)

/**********************************************************
Description : load image list information.
Input       : start_blk: start block of searching
Output      : Return if Image List or backup is loaded
Assumptions : FUE image is programmed to flash in block aligned manner
***********************************************************/
kal_bool LoadImageListblock(kal_uint32 start_blk)
{
   extern FTL_FuncTbl *g_ftlFuncTbl;
   
   kal_int32 status;
   kal_bool ret = KAL_TRUE;
   
   TS_BEGIN(TSID_BL_LOAD_ILB_CBR);

   CBR_SetEnv(E_CBR_IDX_CBR, (kal_uint32*)PAGE_BUFFER_ADDR, 8192, g_ftlFuncTbl);
   
   TS_BEGIN(TSID_BL_INIT_CBR);
   status = CBR_Init(E_CBR_IDX_CBR, start_blk);
   TS_END(TSID_BL_INIT_CBR);

   if(status != CBR_SUCCESS)
   {
      if(status == CBR_NO_BLOCK_FOUND)
      {
         BL_PRINT(LOG_INFO, "No CBR is found\n\r");
         goto _error;
      }

      BL_PRINT(LOG_ERROR, "Serious error in CBR, %d\n\r", status);
      ret = KAL_FALSE;
      goto _error;
      
   }

   TS_BEGIN(TSID_BL_READ_FLASH_LAYOUT_INFO);
   status = CBR_ReadRecord(E_CBR_IDX_CBR, CBR_RECORD_FLASH_LAYOUT, (kal_uint8*)&BL_Shared_info.m_bl_flash_layout, sizeof(FlashLayout), NULL);
  
   if(status < CBR_SUCCESS)
   {
      BL_PRINT(LOG_ERROR, "Unable to read FlashLayout, %d\n\r", status);
      goto _error;
   }
  
   status = CBR_ReadRecord(E_CBR_IDX_CBR, CBR_RECORD_FLASH_SPACE_INFO, (kal_uint8*)&BL_Shared_info.m_bl_image_space, sizeof(Nand_ImageSpace_ST), NULL);
  
   if(status < CBR_SUCCESS)
   {
      BL_PRINT(LOG_ERROR, "Unable to read SpaceInfo, %d\n\r", status);
      goto _error;
   }

   status = CBR_ReadRecord(E_CBR_IDX_CBR, CBR_RECORD_MAUI_INFO, (kal_uint8*)&g_mauiInfoBuf, sizeof(g_mauiInfoBuf), NULL);

#if 0  
/* under construction !*/
/* under construction !*/
/* under construction !*/
/* under construction !*/
/* under construction !*/
#else
   if(status >= CBR_SUCCESS)
   {
      g_mauiInfoRead = KAL_TRUE;
   }
#endif
   
   TS_END(TSID_BL_READ_FLASH_LAYOUT_INFO);       

   TS_END(TSID_BL_LOAD_ILB_CBR);
   return ret;

_error:
   g_bootupDisabled = KAL_TRUE;   
   g_bootupStatus = BL_BOOTUP_FAIL_REASON_UNABLE_TO_READ_ILB;
   return ret;
}

#endif /* _NAND_FLASH_BOOTING_ || __EMMC_BOOTING__ */





/**********************************************************
Description : Load rest part of Primary 
Input       : None
Output      : None
***********************************************************/
kal_uint32 LoadMauiBody(void)
{
   kal_uint32 addr;

#if defined(_NAND_FLASH_BOOTING_) || defined(__EMMC_BOOTING__) || defined(__XIP_SHADOWING__)

   TS_BEGIN(TSID_BL_LOAD_MAUI_BODY);
   TS_INFO(TSID_BL_LOAD_MAUI_BODY, ((GFH_FILE_INFO_v1*)g_maui_load_addr)->m_file_len, ((GFH_FILE_INFO_v1*)g_maui_load_addr)->m_file_len-mauiReadLen, g_maui_load_addr);
   addr = bl_ReadFileBody((GFH_FILE_INFO_v1*)g_maui_load_addr, restMauiFlashAddr, mauiReadLen);
   TS_END(TSID_BL_LOAD_MAUI_BODY);

   if(addr == INVALID_START_ADDR)
   {
      BL_PRINT(LOG_ERROR, "Loading MAUI body failed\n\r");
      g_bootupDisabled = KAL_TRUE;
      g_bootupStatus = BL_BOOTUP_FAIL_LOADING_MAUI_BODY_ERROR;
      return addr;
   }

#else

   addr = g_maui_load_addr;

#endif /* _NAND_FLASH_BOOTING_ || __EMMC_BOOTING__ || __XIP_SHADOWING__ */


#ifdef __MTK_SECURE_PLATFORM__
/* under construction !*/
/* under construction !*/
/* under construction !*/
/* under construction !*/
/* under construction !*/
/* under construction !*/
/* under construction !*/
/* under construction !*/
/* under construction !*/
/* under construction !*/
/* under construction !*/
/* under construction !*/
/* under construction !*/
#endif /* __MTK_SECURE_PLATFORM__ */

   return addr;
}


/**********************************************************
Description : Read MAUI's first GFH to its load address
Input       : None
Output      : None
***********************************************************/
BL_STATUS LoadMAUIFirstPart(void)
{

#ifndef __FOTA_DM__

   kal_uint32 mauiFlashAddr = INVALID_START_ADDR;

   const kal_uint32 loadSequence[][2] = { 
      {PRIMARY_MAUI, PRIMARY_FACTORY_BIN},  //For Normal mode, try to lunch MAUI first
      {PRIMARY_FACTORY_BIN, PRIMARY_MAUI},  //For META mode, try to lunch FactoryBin first
   };
   
   kal_int32 currentLoadSequence = 0;
   kal_int32 i;

   TS_BEGIN(TSID_BL_LOAD_MAUI_FIRST_PART);

   //Find the proper binary to load -- MAUI or FACTORY bin
   if(IsMetaModeEnabled())
   {
      currentLoadSequence = 1;
   }
   
   for(i=0; i<sizeof(loadSequence[0])/sizeof(loadSequence[0][0]); i++)
   {
      mauiFlashAddr = GetBinaryStartInFlash((GFH_FILE_TYPE)loadSequence[currentLoadSequence][i]);
      
      if(mauiFlashAddr != INVALID_START_ADDR)
      {
         if(loadSequence[currentLoadSequence][i] == PRIMARY_FACTORY_BIN)
         {
            BL_PRINT(LOG_INFO, "Launching FactoryBin in Combine mode...\r\n");
         }
         
         break;
      }  
   }

   if(mauiFlashAddr != INVALID_START_ADDR)
   {
#if defined(__NAND_BOOT__) || defined(__EMMC_BOOT__) || defined(__XIP_SHADOWING__)

      g_maui_load_addr = bl_ReadFileGFH(mauiFlashAddr, MAX_FLASH_BOUNDARY, &restMauiFlashAddr, &mauiReadLen);

#elif defined(__NOR_BOOT__) || defined(__SF_BOOT__)

      if(GFH_FILE_INFO_IsValid((GFH_FILE_INFO_v1*)mauiFlashAddr) == 0)
      {
         g_maui_load_addr = mauiFlashAddr;
      }
      else
      {
         BL_PRINT(LOG_ERROR, "Invalid MAUI GFH, addr=%x\n\r", mauiFlashAddr);
      }

#endif

      if(g_maui_load_addr == INVALID_START_ADDR)
      {
         BL_PRINT(LOG_ERROR, "Failed to get MAUI's first part\n\r");
         return BL_ERROR;
      }
   }
   else
   {
      BL_PRINT(LOG_ERROR, "No MAUI binary in FlashLayout or Flash\n\r");

      g_bootupDisabled = KAL_TRUE;
      g_bootupStatus = BL_BOOTUP_FAIL_LOADING_MAUI_HEAD_ERROR;
   }

   TS_END(TSID_BL_LOAD_MAUI_FIRST_PART);

#endif /* __FOTA_DM__ */

   return BL_ERROR_NONE;
}


/**********************************************************
Description : Get the first block next to bootloader region
Input       : None
Output      : Return 
***********************************************************/
kal_uint32 GetMainRegionStartBlock(void)
{
#if defined(__NAND_BOOT__)
   kal_uint32 page_per_block = BL_SLIM_UDIV(g_ftlFuncTbl->FTL_GetBlockSize(0, NULL), g_ftlFuncTbl->FTL_GetPageSize());
   return BL_SLIM_UDIV((g_pBROM_BL_Param->m_hdrblk_info.m_region1_u.m_br_layout.m_main_region_dev_addr + page_per_block - 1), page_per_block);
#elif defined(__NOR_BOOT__) || defined(__SF_BOOT__) || defined(__EMMC_BOOTING__)
   kal_uint32 block_size = g_ftlFuncTbl->FTL_GetBlockSize(0, NULL);
   return BL_SLIM_UDIV((g_pBROM_BL_Param->m_hdrblk_info.m_region1_u.m_br_layout.m_main_region_dev_addr + block_size - 1), block_size);
#endif
}

/**********************************************************
Description : Search the flash layout structure to find the binary region
Input       : Binary type
Output      : The region the binary may occupy
              NAND, eMMC => page index
              NOR, Serial flash => Address
***********************************************************/
kal_bool GetBinaryRegionInFlash(GFH_FILE_TYPE type, kal_uint32 *pStart, kal_uint32 *pBoundary )
{
   kal_bool found = KAL_FALSE;
   
#if defined(__NAND_BOOT__) || defined(__EMMC_BOOT__)
   kal_uint32 i;
   FlashLayout *pFlashLayout = &(BL_Shared_info.m_bl_flash_layout);
   
   for( i=0 ;i<pFlashLayout->regionCount; i++ )
   {
      if( pFlashLayout->region[i].binaryType == type )
      {
         if(pStart)
         {
            *pStart = pFlashLayout->region[i].u.nandEmmc.startPage;
         }
         if(pBoundary)
         {
            *pBoundary = pFlashLayout->region[i].u.nandEmmc.boundPage;
         }
         found = KAL_TRUE;
         break;
      }
   }
#elif defined(__NOR_BOOT__) || defined(__SF_BOOT__)

   kal_uint32 targetAddr = INVALID_START_ADDR;

   if(type == PRIMARY_MAUI)
   {
      targetAddr = MAUI_START_ADDR_NOR;
   }
   else if(type == PRIMARY_FACTORY_BIN)
   {
      targetAddr = FACTORY_BIN_START_ADDR_NOR;
   }

   if(targetAddr != INVALID_START_ADDR)
   {
      GFH_FILE_INFO_v1 *pGFHFileInfo = (GFH_FILE_INFO_v1*)MapToCurrentFlashAddr(targetAddr);

      if( GFH_FILE_INFO_IsValid(pGFHFileInfo) == B_OK )
      {
         kal_uint32 boundaryAddr;
         
         if(pGFHFileInfo->m_max_size != GFH_FILE_MAX_SIZE_IGNORED)
         {
            boundaryAddr = (kal_uint32)(pGFHFileInfo) + pGFHFileInfo->m_max_size - 1;
         }
         else
         {
            boundaryAddr = (kal_uint32)(pGFHFileInfo) + pGFHFileInfo->m_file_len - 1;
         }
            
         if( pGFHFileInfo->m_file_type == type )
         {
            if(pStart)
            {
               *pStart = (kal_uint32)pGFHFileInfo;
            }
            if(pBoundary)
            {
               *pBoundary = boundaryAddr;
            }
            found = KAL_TRUE;
         }
      }
   }
   
#endif

   return found;
}


/**********************************************************
Description : Get the starting address of specified binary type
Input       : None
Output      : Starting address
              NAND, eMMC => page index
              NOR, Serial flash => Address
***********************************************************/
kal_uint32 GetBinaryStartInFlash(GFH_FILE_TYPE type)
{
   kal_uint32 found = KAL_FALSE;
   kal_uint32 start;
   
   found = GetBinaryRegionInFlash(type, &start, NULL);

   return found ? start : INVALID_START_ADDR;

}

/**********************************************************
Description : Get the binary length from the GFH
Input       : None
Output      : None
***********************************************************/
kal_uint32 bl_GetBinaryLoadAddrAndLength(kal_uint32 flashBeginPage, kal_uint32 *pLength)
{
   kal_uint32 target_addr;
   GFH_FILE_INFO_v1 *pGFHFileInfo = NULL;

   kal_uint32 page_no = flashBeginPage;
   kal_uint32 page_size = g_ftlFuncTbl->FTL_GetPageSize();

   /* GFH_info should be smaller than one page */
   ASSERT(sizeof(GFH_FILE_INFO_v1) <= page_size);

#if defined(__NAND_BOOT__) || defined(__EMMC_BOOT__)

   pGFHFileInfo = (GFH_FILE_INFO_v1*)PAGE_BUFFER_ADDR;

   /* Read first page (GFH Info) to internal page buffer */
   if( ReadDataX((kal_uint32)pGFHFileInfo, page_no, page_size, KAL_TRUE, &page_no) == KAL_FALSE )
   {
      return INVALID_START_ADDR;
   }
#elif defined(__NOR_BOOT__) || defined(__SF_BOOT__)

    ASSERT(0);
    
#endif

   /* Sanity test of GFH */
   if( GFH_FILE_INFO_IsValid(pGFHFileInfo) != B_OK )
   {
      BL_PRINT(LOG_ERROR, "Invalid GFH File Info\n\r");
      return INVALID_START_ADDR;
   }

   target_addr = pGFHFileInfo->m_load_addr;

   if(pLength)
   {
      *pLength = pGFHFileInfo->m_file_len;
   }
   
   return target_addr;
}

GFH_MAUI_INFO_v1 *bl_GetMAUIInfo(void)
{
   GFH_MAUI_INFO_v1 *pMauiInfo = NULL;
   kal_uint32 status;

#if defined(_NAND_FLASH_BOOTING_) || defined(__EMMC_BOOTING__)
   if(g_mauiInfoRead)
   {
      pMauiInfo = (GFH_MAUI_INFO_v1*)&g_mauiInfoBuf;
   }
#endif   

#ifndef __FOTA_DM__
   if(!pMauiInfo)
   {
      if(g_maui_load_addr != INVALID_START_ADDR)
      {
         status = GFH_Find(g_maui_load_addr, GFH_MAUI_INFO, (void **)&pMauiInfo);
      }
   }

   if(!pMauiInfo)
   {
      BL_PRINT(LOG_INFO, "No MAUI INFO found in MAUI bin\n\r");
   }
#endif   

   return pMauiInfo;
}

#endif /* __EXT_BOOTLOADER__ */

#endif /* __SV5_ENABLED__ */