## @ PatchBinFv.py
#
# Copyright (c) 2017, Intel Corporation. All rights reserved.<BR>
# This program and the accompanying materials are licensed and made available under
# the terms and conditions of the BSD License that accompanies this distribution.
# The full text of the license may be found at
# http://opensource.org/licenses/bsd-license.php.
#
# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
#
##

import os
import re
import sys
import time
import shutil
import struct
import binascii
from   ctypes import *

class FileChecker:
    def __init__(self):
        self.SyncSectionList = ["PatchPcd"]
        self.FvName = ""
        self.target = ""
        self.sourceRoot = ""
        self.reportFile = ""
        self.InfPcdList = []

    def GetSectionName(self, line):
        splitLine = line[1:-1].split(".")
        return splitLine[0]

    def IsSyncSection(self, line):
        name = self.GetSectionName(line)
        for sectionName in self.SyncSectionList:
            if (cmp (sectionName, name) == 0) :
                return True
        return False

    def PrintPcdList(self, pcdList):
        for pcd in pcdList:
            print "PCD: " + pcd[0] + "|" + pcd[1] + "|" + pcd[2] + " <== " + pcd[3] + "(" + pcd[4] + ")"

    def GetInfFileGuid(self, fileName):
        guid = ""
        try :
            file = open(fileName)
        except Exception:
            print "fail to open " + fileName
            return
        try:
            while 1:
                line = file.readline()
                if not line:
                    break

                newline = line[:-1]

                if cmp (line[:11], "  FILE_GUID") == 0:
                    splitLine = line.split("=")
                    templine = splitLine[1]
                    guid = templine[1:1+36]
        finally:
            file.close()
        return guid

    def ParseInfFile(self, fileName):
        SyncToDest = False
        try :
            file = open(fileName)
        except Exception:
            print "fail to open " + fileName
            return
        try:
            while 1:
                line = file.readline()
                if not line:
                    break

                newline = line[:-1]

                if cmp (line[0], "#") == 0:
                    continue


                if cmp (line[0], "[") == 0:
                    SyncToDest = self.IsSyncSection(line)
                    PatchOffset = False

                if (cmp (self.GetSectionName(line), "PatchPcd") == 0) :
                    PatchOffset = True
                    continue

                if SyncToDest == True :
                    line = line.strip()
                    if (cmp (line, "") == 0) :
                        continue
                    if (cmp (line[0], "#") == 0) :
                        continue

                    splitLine = line.split(" ")
                    line = splitLine[0]

                    splitLine = line.split("|")

                    self.InfPcdList.append([splitLine[0], splitLine[1], splitLine[2], "", ""])

        finally:
            file.close()
        return

    def ProcessFvInf(self, fvName):
        sourceFileName = os.path.join(self.sourceRoot,fvName+"\\"+self.target+"\\"+fvName+".inf")
        print "\nprocessing - " + sourceFileName
        fileGuid = self.GetInfFileGuid (sourceFileName)
        print "FV NAME GUID - " + fileGuid

        self.InfPcdList = []
        self.ParseInfFile(sourceFileName)

        self.InfPcdList.sort()

        #self.PrintPcdList(self.InfPcdList)

        try :
            file = open(self.reportFile)
        except Exception:
            print "fail to open " + self.reportFile
            return
        try:
            for pcd in self.InfPcdList:
                file.seek(0)
                print "checking - " + pcd[0]
                ValuePair = self.GetPcdFromReport (file, pcd[0])
                pcd[3] = ValuePair[0]
                pcd[4] = ValuePair[1]
        finally:
            file.close()

        self.PrintPcdList(self.InfPcdList)

    def PatchFv(self, fvName):
        sourceFileName = os.path.join(self.sourceRoot,fvName+"\\"+self.target+"\\"+fvName+".fv")
        print "patching - " + sourceFileName

        try :
            file = open(sourceFileName, "rb")
        except Exception:
            print "fail to open " + sourceFileName
            return
        try:
            buffer = file.read()
            data = bytearray(buffer)
            file.close()

            for pcd in self.InfPcdList:
                offset = int(pcd[2], 16)
                if (cmp (pcd[4], "BOOLEAN") == 0) or (cmp (pcd[4], "UINT8") == 0):
                    b = struct.pack("B", int(pcd[3],16))
                    print "  [" + hex(offset) + "] " + binascii.hexlify(data[offset:offset+1]) + " <= " + binascii.hexlify(b)
                    data[offset:offset+1] = b
                elif (cmp (pcd[4], "UINT16") == 0):
                    h = struct.pack("H", int(pcd[3],16))
                    print "  [" + hex(offset) + "] " + binascii.hexlify(data[offset:offset+2]) + " <= " + binascii.hexlify(h)
                    data[offset:offset+2] = h
                elif (cmp (pcd[4], "UINT32") == 0):
                    l = struct.pack("L", int(pcd[3],16))
                    print "  [" + hex(offset) + "] " + binascii.hexlify(data[offset:offset+4]) + " <= " + binascii.hexlify(l)
                    data[offset:offset+4] = l
                elif (cmp (pcd[4], "UINT64") == 0):
                    q = struct.pack("Q", int(pcd[3],16))
                    print "  [" + hex(offset) + "] " + binascii.hexlify(data[offset:offset+8]) + " <= " + binascii.hexlify(q)
                    data[offset:offset+8] = q
            file = open(sourceFileName, "wb")
            file.write(data)
        finally:
            file.close()

    def GetPcdFromReport(self, file, pcd):
        FoundPkg = False
        pcdSplit = pcd.split(".")
        TargetPkg = pcdSplit[0]
        TargetPcd = pcdSplit[1]
        while 1:
            line = file.readline()
            if not line:
                break

            newline = line[:-1]

            if (cmp (newline, TargetPkg) == 0):
                FoundPkg = True
                continue

            if (cmp (newline, "") == 0) or ((cmp (newline[0], " ") != 0) and (cmp (newline[0], "0") != 0)):
                FoundPkg = False

            if (FoundPkg == True) :
                newline = newline.strip()
                splitLine = newline.split(" ", 2)
                if (cmp (splitLine[0], "*F") == 0) or (cmp (splitLine[0], "*P") == 0):
                    if (cmp (splitLine[1], TargetPcd) == 0):
                        print "found - " + TargetPkg + "." + TargetPcd

                        splitLine = splitLine[2].strip()[1:].strip().split(" ", 1)
                        if (cmp (splitLine[0], "FIXED") == 0) or (cmp (splitLine[0], "PATCH") == 0):
                            SplitLine = splitLine[1].strip()[1:].split(")", 1)
                            Type = SplitLine[0]
                            Value = SplitLine[1].strip()[1:].strip()
                            print "  Type - (" + Type + "), Value - (" + Value + ")"
                            return [Value, Type]
        return ["", ""]
            
def main():
    global FileChecker

    fileChecker = FileChecker()

    if (len(sys.argv) != 5) :
        print "usage: PatchBinFv <Target> <SourceRoot> <ReportFile> <FvName>"
        return 0

    fileChecker.target = sys.argv[1]
    fileChecker.sourceRoot = sys.argv[2]
    fileChecker.reportFile = sys.argv[3]
    fileChecker.FvName = sys.argv[4]

    fileChecker.ProcessFvInf (fileChecker.FvName)
    fileChecker.PatchFv (fileChecker.FvName)

if __name__ == '__main__':
    sys.exit(main())