mcu/tools/MemoryUtility/TCMMargin.pl

#!/usr/bin/perl
#
#  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) 2006
#
#  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:
#* ---------
#*   TCMmargin.pl
#*
#* Project:
#* --------
#*
#*
#* Description:
#* ------------
#*   This perl is used to get TCM margin
#*       
#*
#* Author:
#* -------
#*   Carl Kao (mtk08237)
#*
#****************************************************************************/

BEGIN { push @INC, "./" , '../', './tools/', './tools/MemoryUtility/' }  # add additional library path
use systemInfo;
use LinkerOutputParser;
use CommonUtility;
use FileInfoParser;
use strict;

#****************************************************************************
# Constants
#****************************************************************************
my $TCMMARGIN_VERNO     = " LR12_v0.01";
             # LR12_v0.01 , 2016/01/25,  Memory Utility Refinement for LR12 
             # u0.01 , 2015/01/19,  Memory Utility Refinement for LR11
             # m0.03 , 2012/08/03,  Shows more TCM information(Physical size)
             # m0.02 , 2012/08/03,  Push additional library path
             # m0.01 , 2012/07/21,  Initial revision

#****************************************************************************
# Global variable
#****************************************************************************
my $DebugPrint = 0;

#****************************************************************************
# Subroutine:  TCMmargin_verno - to query this package's version number
# Parameters:  x
# Returns:     version number string
#****************************************************************************
sub TCMmargin_verno
{
    return $TCMMARGIN_VERNO;
}

#****************************************************************************
# 1 >>>  Get in put parameters
#****************************************************************************
&Usage() if($#ARGV != 2);
my ($makeFile, $memorymapfile, $linkeroutputfile) = @ARGV;

#****************************************************************************
# 2 >>>  Parse make file
#****************************************************************************
my %MAKEFILE_OPTIONS;
&FileInfo::Parse_MAKEFILE($makeFile, \%MAKEFILE_OPTIONS);

#****************************************************************************
# 3 >>>  Calculate TCM margin
#****************************************************************************
&CalcTCMmargin();

#****************************************************************************
# oo >>>  Finished
#****************************************************************************
exit 0;

#****************************************************************************
# subroutine:  CalcTCMmargin - calculate TCM margin
# Input:       x
# Output:      x
#****************************************************************************
sub CalcTCMmargin
{
    my %ChipInsideRam_region;
    my $nChipInsideRAMnum = 0;
    my %ChipInsideRAMinfo;
    my $TCMmargin_href;

    # Get all chipInsideRAM regions
    $nChipInsideRAMnum =  &sysInfo::GetChipInsideRAMregion($memorymapfile, \%ChipInsideRam_region, \%MAKEFILE_OPTIONS);

    # Parse link output file
    &LinkerOutputParser::FileParse($linkeroutputfile);
    
    # Get the size of all chipInsideRAM regions and store to a Hash
    foreach my $strRegionName (keys %ChipInsideRam_region)
    {
        $ChipInsideRAMinfo{$strRegionName}[0] =   # 0: size
            &LinkerOutputParser::GetTotalSizeByExeRegion($strRegionName);
        $ChipInsideRAMinfo{$strRegionName}[1] =   # 1: VMA
            &LinkerOutputParser::GetVMAByExeRegion($strRegionName);
    }

    # Get TCM margin via the Hash content TCM size info
    $TCMmargin_href =  &sysInfo::GetTCMmargin($memorymapfile, \%ChipInsideRAMinfo, \%MAKEFILE_OPTIONS);
    
    # Print TCM margin
    print ("-------------------------------------------------------------------\n");
    
    my @sorted_keys = sort {
        my @aa = $a =~ /^([A-Za-z]+)(\d*)$/;
        my @bb = $b =~ /^([A-Za-z]+)(\d*)$/;
        $aa[1] <=> $bb[1] or lc $aa[0] cmp lc $bb[0];
    } keys %$TCMmargin_href;
    
    # foreach my $strRegionname (sort keys %$TCMmargin_href) # old way, no sort
    for (my $i=0; $i<2; ++$i)
    {
        foreach (@sorted_keys)
        {
            my $strRegionname = $_;
            
            next if ( $i == 0 && $strRegionname !~ /\d$/ ); # show per-core part in first round
            next if ( $i == 1 && $strRegionname =~ /\d$/ ); # show common part in first round
            
            printf("%10s %20s 0x%08x = %8d bytes = %5d KB\n", $strRegionname, "physical size = ", 
                                                $TCMmargin_href->{$strRegionname}->[0], 
                                                $TCMmargin_href->{$strRegionname}->[0], 
                                                $TCMmargin_href->{$strRegionname}->[0]/1024);
            printf("%10s %20s 0x%08x = %8d bytes = %5d KB \n", $strRegionname, "margin = ", 
                                                $TCMmargin_href->{$strRegionname}->[1], 
                                                $TCMmargin_href->{$strRegionname}->[1],
                                                $TCMmargin_href->{$strRegionname}->[1]/1024);
            #reserve for debugging
            #printf("%10s %20s 0x%08x KB \n", $strRegionname, "end addr = ", ($TCMmargin_href->{$strRegionname}->[0]-$TCMmargin_href->{$strRegionname}->[1]));
            print ("-------------------------------------------------------------------\n");
        }
    }
}

#****************************************************************************
# subroutine:  Usage - usage template
# Input:       x
# Output:      x
#****************************************************************************
sub Usage
{
  print <<"__EOFUSAGE";

usage: perl TCMMargin.pl makefile_path scatter_file_path/lds_file_path lis_file_path/sym_file_path 

NOTE: scatter file should input with lis file
      lds file should input with sym file

e.g. 
perl TCMMargin.pl "/[path]/MT6280_R7R8_HSPA(FULL_VERSION_RVCT).mak" "/[path]/scatMT6280_R7R8.txt" "/[path]/MT6280_EVB_R7R8_PCB01_hspa_MT6280_S00.lis"

__EOFUSAGE

  exit 1;
}