mirror of
https://github.com/acidanthera/audk.git
synced 2025-04-08 17:05:09 +02:00
8c09d862bf
The xdrlib dependency was removed in commit 5cadb8ce2148979b6c464f6da5a8cd97425c5165 but the actual import of the module was not removed. This commit removes the import of xdrlib and sorts the imports. Signed-off-by: Joey Vagedes <joey.vagedes@gmail.com>
231 lines
10 KiB
Python
231 lines
10 KiB
Python
## @file
|
|
# Convert a binary file to a VOID* PCD value or DSC file VOID* PCD statement.
|
|
#
|
|
# Copyright (c) 2016 - 2018, Intel Corporation. All rights reserved.<BR>
|
|
# SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
#
|
|
|
|
'''
|
|
BinToPcd
|
|
'''
|
|
from __future__ import print_function
|
|
|
|
import argparse
|
|
import io
|
|
import math
|
|
import re
|
|
import struct
|
|
import sys
|
|
|
|
#
|
|
# Globals for help information
|
|
#
|
|
__prog__ = 'BinToPcd'
|
|
__copyright__ = 'Copyright (c) 2016 - 2018, Intel Corporation. All rights reserved.'
|
|
__description__ = 'Convert one or more binary files to a VOID* PCD value or DSC file VOID* PCD statement.\n'
|
|
|
|
if __name__ == '__main__':
|
|
def ValidateUnsignedInteger (Argument):
|
|
try:
|
|
Value = int (Argument, 0)
|
|
except:
|
|
Message = '{Argument} is not a valid integer value.'.format (Argument = Argument)
|
|
raise argparse.ArgumentTypeError (Message)
|
|
if Value < 0:
|
|
Message = '{Argument} is a negative value.'.format (Argument = Argument)
|
|
raise argparse.ArgumentTypeError (Message)
|
|
return Value
|
|
|
|
def ValidatePcdName (Argument):
|
|
if re.split ('[a-zA-Z\_][a-zA-Z0-9\_]*\.[a-zA-Z\_][a-zA-Z0-9\_]*', Argument) != ['', '']:
|
|
Message = '{Argument} is not in the form <PcdTokenSpaceGuidCName>.<PcdCName>'.format (Argument = Argument)
|
|
raise argparse.ArgumentTypeError (Message)
|
|
return Argument
|
|
|
|
def ValidateGuidName (Argument):
|
|
if re.split ('[a-zA-Z\_][a-zA-Z0-9\_]*', Argument) != ['', '']:
|
|
Message = '{Argument} is not a valid GUID C name'.format (Argument = Argument)
|
|
raise argparse.ArgumentTypeError (Message)
|
|
return Argument
|
|
|
|
def XdrPackBuffer (buffer):
|
|
packed_bytes = io.BytesIO()
|
|
for unpacked_bytes in buffer:
|
|
n = len(unpacked_bytes)
|
|
packed_bytes.write(struct.pack('>L',n))
|
|
data = unpacked_bytes[:n]
|
|
n = math.ceil(n/4)*4
|
|
data = data + (n - len(data)) * b'\0'
|
|
packed_bytes.write(data)
|
|
return packed_bytes.getvalue()
|
|
|
|
def ByteArray (Buffer, Xdr = False):
|
|
if Xdr:
|
|
#
|
|
# If Xdr flag is set then encode data using the Variable-Length Opaque
|
|
# Data format of RFC 4506 External Data Representation Standard (XDR).
|
|
#
|
|
Buffer = bytearray (XdrPackBuffer (Buffer))
|
|
else:
|
|
#
|
|
# If Xdr flag is not set, then concatenate all the data
|
|
#
|
|
Buffer = bytearray (b''.join (Buffer))
|
|
#
|
|
# Return a PCD value of the form '{0x01, 0x02, ...}' along with the PCD length in bytes
|
|
#
|
|
return '{' + (', '.join (['0x{Byte:02X}'.format (Byte = Item) for Item in Buffer])) + '}', len (Buffer)
|
|
|
|
#
|
|
# Create command line argument parser object
|
|
#
|
|
parser = argparse.ArgumentParser (prog = __prog__,
|
|
description = __description__ + __copyright__,
|
|
conflict_handler = 'resolve')
|
|
parser.add_argument ("-i", "--input", dest = 'InputFile', type = argparse.FileType ('rb'), action='append', required = True,
|
|
help = "Input binary filename. Multiple input files are combined into a single PCD.")
|
|
parser.add_argument ("-o", "--output", dest = 'OutputFile', type = argparse.FileType ('w'),
|
|
help = "Output filename for PCD value or PCD statement")
|
|
parser.add_argument ("-p", "--pcd", dest = 'PcdName', type = ValidatePcdName,
|
|
help = "Name of the PCD in the form <PcdTokenSpaceGuidCName>.<PcdCName>")
|
|
parser.add_argument ("-t", "--type", dest = 'PcdType', default = None, choices = ['VPD', 'HII'],
|
|
help = "PCD statement type (HII or VPD). Default is standard.")
|
|
parser.add_argument ("-m", "--max-size", dest = 'MaxSize', type = ValidateUnsignedInteger,
|
|
help = "Maximum size of the PCD. Ignored with --type HII.")
|
|
parser.add_argument ("-f", "--offset", dest = 'Offset', type = ValidateUnsignedInteger,
|
|
help = "VPD offset if --type is VPD. UEFI Variable offset if --type is HII. Must be 8-byte aligned.")
|
|
parser.add_argument ("-n", "--variable-name", dest = 'VariableName',
|
|
help = "UEFI variable name. Only used with --type HII.")
|
|
parser.add_argument ("-g", "--variable-guid", type = ValidateGuidName, dest = 'VariableGuid',
|
|
help = "UEFI variable GUID C name. Only used with --type HII.")
|
|
parser.add_argument ("-x", "--xdr", dest = 'Xdr', action = "store_true",
|
|
help = "Encode PCD using the Variable-Length Opaque Data format of RFC 4506 External Data Representation Standard (XDR)")
|
|
parser.add_argument ("-v", "--verbose", dest = 'Verbose', action = "store_true",
|
|
help = "Increase output messages")
|
|
parser.add_argument ("-q", "--quiet", dest = 'Quiet', action = "store_true",
|
|
help = "Reduce output messages")
|
|
parser.add_argument ("--debug", dest = 'Debug', type = int, metavar = '[0-9]', choices = range (0, 10), default = 0,
|
|
help = "Set debug level")
|
|
|
|
#
|
|
# Parse command line arguments
|
|
#
|
|
args = parser.parse_args ()
|
|
|
|
#
|
|
# Read all binary input files
|
|
#
|
|
Buffer = []
|
|
for File in args.InputFile:
|
|
try:
|
|
Buffer.append (File.read ())
|
|
File.close ()
|
|
except:
|
|
print ('BinToPcd: error: can not read binary input file {File}'.format (File = File))
|
|
sys.exit (1)
|
|
|
|
#
|
|
# Convert PCD to an encoded string of hex values and determine the size of
|
|
# the encoded PCD in bytes.
|
|
#
|
|
PcdValue, PcdSize = ByteArray (Buffer, args.Xdr)
|
|
|
|
#
|
|
# Convert binary buffer to a DSC file PCD statement
|
|
#
|
|
if args.PcdName is None:
|
|
#
|
|
# If PcdName is None, then only a PCD value is being requested.
|
|
#
|
|
Pcd = PcdValue
|
|
if args.Verbose:
|
|
print ('BinToPcd: Convert binary file to PCD Value')
|
|
elif args.PcdType is None:
|
|
#
|
|
# If --type is neither VPD nor HII, then use PCD statement syntax that is
|
|
# compatible with [PcdsFixedAtBuild], [PcdsPatchableInModule],
|
|
# [PcdsDynamicDefault], and [PcdsDynamicExDefault].
|
|
#
|
|
if args.MaxSize is None:
|
|
#
|
|
# If --max-size is not provided, then do not generate the syntax that
|
|
# includes the maximum size.
|
|
#
|
|
Pcd = ' {Name}|{Value}'.format (Name = args.PcdName, Value = PcdValue)
|
|
elif args.MaxSize < PcdSize:
|
|
print ('BinToPcd: error: argument --max-size is smaller than input file.')
|
|
sys.exit (1)
|
|
else:
|
|
Pcd = ' {Name}|{Value}|VOID*|{Size}'.format (Name = args.PcdName, Value = PcdValue, Size = args.MaxSize)
|
|
|
|
if args.Verbose:
|
|
print ('BinToPcd: Convert binary file to PCD statement compatible with PCD sections:')
|
|
print (' [PcdsFixedAtBuild]')
|
|
print (' [PcdsPatchableInModule]')
|
|
print (' [PcdsDynamicDefault]')
|
|
print (' [PcdsDynamicExDefault]')
|
|
elif args.PcdType == 'VPD':
|
|
if args.MaxSize is None:
|
|
#
|
|
# If --max-size is not provided, then set maximum size to the size of the
|
|
# binary input file
|
|
#
|
|
args.MaxSize = PcdSize
|
|
if args.MaxSize < PcdSize:
|
|
print ('BinToPcd: error: argument --max-size is smaller than input file.')
|
|
sys.exit (1)
|
|
if args.Offset is None:
|
|
#
|
|
# if --offset is not provided, then set offset field to '*' so build
|
|
# tools will compute offset of PCD in VPD region.
|
|
#
|
|
Pcd = ' {Name}|*|{Size}|{Value}'.format (Name = args.PcdName, Size = args.MaxSize, Value = PcdValue)
|
|
else:
|
|
#
|
|
# --offset value must be 8-byte aligned
|
|
#
|
|
if (args.Offset % 8) != 0:
|
|
print ('BinToPcd: error: argument --offset must be 8-byte aligned.')
|
|
sys.exit (1)
|
|
#
|
|
# Use the --offset value provided.
|
|
#
|
|
Pcd = ' {Name}|{Offset}|{Size}|{Value}'.format (Name = args.PcdName, Offset = args.Offset, Size = args.MaxSize, Value = PcdValue)
|
|
if args.Verbose:
|
|
print ('BinToPcd: Convert binary file to PCD statement compatible with PCD sections')
|
|
print (' [PcdsDynamicVpd]')
|
|
print (' [PcdsDynamicExVpd]')
|
|
elif args.PcdType == 'HII':
|
|
if args.VariableGuid is None or args.VariableName is None:
|
|
print ('BinToPcd: error: arguments --variable-guid and --variable-name are required for --type HII.')
|
|
sys.exit (1)
|
|
if args.Offset is None:
|
|
#
|
|
# Use UEFI Variable offset of 0 if --offset is not provided
|
|
#
|
|
args.Offset = 0
|
|
#
|
|
# --offset value must be 8-byte aligned
|
|
#
|
|
if (args.Offset % 8) != 0:
|
|
print ('BinToPcd: error: argument --offset must be 8-byte aligned.')
|
|
sys.exit (1)
|
|
Pcd = ' {Name}|L"{VarName}"|{VarGuid}|{Offset}|{Value}'.format (Name = args.PcdName, VarName = args.VariableName, VarGuid = args.VariableGuid, Offset = args.Offset, Value = PcdValue)
|
|
if args.Verbose:
|
|
print ('BinToPcd: Convert binary file to PCD statement compatible with PCD sections')
|
|
print (' [PcdsDynamicHii]')
|
|
print (' [PcdsDynamicExHii]')
|
|
|
|
#
|
|
# Write PCD value or PCD statement to the output file
|
|
#
|
|
try:
|
|
args.OutputFile.write (Pcd)
|
|
args.OutputFile.close ()
|
|
except:
|
|
#
|
|
# If output file is not specified or it can not be written, then write the
|
|
# PCD value or PCD statement to the console
|
|
#
|
|
print (Pcd)
|