c42e37bd119b5881018b9e2230a8df29b803de16
[mirror_edk2.git] / BaseTools / Scripts / BinToPcd.py
1 ## @file
2 # Convert a binary file to a VOID* PCD value or DSC file VOID* PCD statement.
3 #
4 # Copyright (c) 2016 - 2018, Intel Corporation. All rights reserved.<BR>
5 # This program and the accompanying materials
6 # are licensed and made available under the terms and conditions of the BSD License
7 # which accompanies this distribution. The full text of the license may be found at
8 # http://opensource.org/licenses/bsd-license.php
9 #
10 # THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 # WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
12 #
13
14 '''
15 BinToPcd
16 '''
17 from __future__ import print_function
18
19 import sys
20 import argparse
21 import re
22 import xdrlib
23
24 #
25 # Globals for help information
26 #
27 __prog__ = 'BinToPcd'
28 __copyright__ = 'Copyright (c) 2016 - 2018, Intel Corporation. All rights reserved.'
29 __description__ = 'Convert one or more binary files to a VOID* PCD value or DSC file VOID* PCD statement.\n'
30
31 if __name__ == '__main__':
32 def ValidateUnsignedInteger (Argument):
33 try:
34 Value = int (Argument, 0)
35 except:
36 Message = '{Argument} is not a valid integer value.'.format (Argument = Argument)
37 raise argparse.ArgumentTypeError (Message)
38 if Value < 0:
39 Message = '{Argument} is a negative value.'.format (Argument = Argument)
40 raise argparse.ArgumentTypeError (Message)
41 return Value
42
43 def ValidatePcdName (Argument):
44 if re.split ('[a-zA-Z\_][a-zA-Z0-9\_]*\.[a-zA-Z\_][a-zA-Z0-9\_]*', Argument) != ['', '']:
45 Message = '{Argument} is not in the form <PcdTokenSpaceGuidCName>.<PcdCName>'.format (Argument = Argument)
46 raise argparse.ArgumentTypeError (Message)
47 return Argument
48
49 def ValidateGuidName (Argument):
50 if re.split ('[a-zA-Z\_][a-zA-Z0-9\_]*', Argument) != ['', '']:
51 Message = '{Argument} is not a valid GUID C name'.format (Argument = Argument)
52 raise argparse.ArgumentTypeError (Message)
53 return Argument
54
55 def ByteArray (Buffer, Xdr = False):
56 if Xdr:
57 #
58 # If Xdr flag is set then encode data using the Variable-Length Opaque
59 # Data format of RFC 4506 External Data Representation Standard (XDR).
60 #
61 XdrEncoder = xdrlib.Packer ()
62 for Item in Buffer:
63 XdrEncoder.pack_bytes (Item)
64 Buffer = bytearray (XdrEncoder.get_buffer ())
65 else:
66 #
67 # If Xdr flag is not set, then concatenate all the data
68 #
69 Buffer = b''.join (Buffer)
70 #
71 # Return a PCD value of the form '{0x01, 0x02, ...}' along with the PCD length in bytes
72 #
73 return '{' + (', '.join (['0x{Byte:02X}'.format (Byte = Item) for Item in Buffer])) + '}', len (Buffer)
74
75 #
76 # Create command line argument parser object
77 #
78 parser = argparse.ArgumentParser (prog = __prog__,
79 description = __description__ + __copyright__,
80 conflict_handler = 'resolve')
81 parser.add_argument ("-i", "--input", dest = 'InputFile', type = argparse.FileType ('rb'), action='append', required = True,
82 help = "Input binary filename. Multiple input files are combined into a single PCD.")
83 parser.add_argument ("-o", "--output", dest = 'OutputFile', type = argparse.FileType ('wb'),
84 help = "Output filename for PCD value or PCD statement")
85 parser.add_argument ("-p", "--pcd", dest = 'PcdName', type = ValidatePcdName,
86 help = "Name of the PCD in the form <PcdTokenSpaceGuidCName>.<PcdCName>")
87 parser.add_argument ("-t", "--type", dest = 'PcdType', default = None, choices = ['VPD', 'HII'],
88 help = "PCD statement type (HII or VPD). Default is standard.")
89 parser.add_argument ("-m", "--max-size", dest = 'MaxSize', type = ValidateUnsignedInteger,
90 help = "Maximum size of the PCD. Ignored with --type HII.")
91 parser.add_argument ("-f", "--offset", dest = 'Offset', type = ValidateUnsignedInteger,
92 help = "VPD offset if --type is VPD. UEFI Variable offset if --type is HII. Must be 8-byte aligned.")
93 parser.add_argument ("-n", "--variable-name", dest = 'VariableName',
94 help = "UEFI variable name. Only used with --type HII.")
95 parser.add_argument ("-g", "--variable-guid", type = ValidateGuidName, dest = 'VariableGuid',
96 help = "UEFI variable GUID C name. Only used with --type HII.")
97 parser.add_argument ("-x", "--xdr", dest = 'Xdr', action = "store_true",
98 help = "Encode PCD using the Variable-Length Opaque Data format of RFC 4506 External Data Representation Standard (XDR)")
99 parser.add_argument ("-v", "--verbose", dest = 'Verbose', action = "store_true",
100 help = "Increase output messages")
101 parser.add_argument ("-q", "--quiet", dest = 'Quiet', action = "store_true",
102 help = "Reduce output messages")
103 parser.add_argument ("--debug", dest = 'Debug', type = int, metavar = '[0-9]', choices = range (0, 10), default = 0,
104 help = "Set debug level")
105
106 #
107 # Parse command line arguments
108 #
109 args = parser.parse_args ()
110
111 #
112 # Read all binary input files
113 #
114 Buffer = []
115 for File in args.InputFile:
116 try:
117 Buffer.append (File.read ())
118 File.close ()
119 except:
120 print ('BinToPcd: error: can not read binary input file {File}'.format (File = File))
121 sys.exit (1)
122
123 #
124 # Convert PCD to an encoded string of hex values and determine the size of
125 # the encoded PCD in bytes.
126 #
127 PcdValue, PcdSize = ByteArray (Buffer, args.Xdr)
128
129 #
130 # Convert binary buffer to a DSC file PCD statement
131 #
132 if args.PcdName is None:
133 #
134 # If PcdName is None, then only a PCD value is being requested.
135 #
136 Pcd = PcdValue
137 if args.Verbose:
138 print ('BinToPcd: Convert binary file to PCD Value')
139 elif args.PcdType is None:
140 #
141 # If --type is neither VPD nor HII, then use PCD statement syntax that is
142 # compatible with [PcdsFixedAtBuild], [PcdsPatchableInModule],
143 # [PcdsDynamicDefault], and [PcdsDynamicExDefault].
144 #
145 if args.MaxSize is None:
146 #
147 # If --max-size is not provided, then do not generate the syntax that
148 # includes the maximum size.
149 #
150 Pcd = ' {Name}|{Value}'.format (Name = args.PcdName, Value = PcdValue)
151 elif args.MaxSize < PcdSize:
152 print ('BinToPcd: error: argument --max-size is smaller than input file.')
153 sys.exit (1)
154 else:
155 Pcd = ' {Name}|{Value}|VOID*|{Size}'.format (Name = args.PcdName, Value = PcdValue, Size = args.MaxSize)
156
157 if args.Verbose:
158 print ('BinToPcd: Convert binary file to PCD statement compatible with PCD sections:')
159 print (' [PcdsFixedAtBuild]')
160 print (' [PcdsPatchableInModule]')
161 print (' [PcdsDynamicDefault]')
162 print (' [PcdsDynamicExDefault]')
163 elif args.PcdType == 'VPD':
164 if args.MaxSize is None:
165 #
166 # If --max-size is not provided, then set maximum size to the size of the
167 # binary input file
168 #
169 args.MaxSize = PcdSize
170 if args.MaxSize < PcdSize:
171 print ('BinToPcd: error: argument --max-size is smaller than input file.')
172 sys.exit (1)
173 if args.Offset is None:
174 #
175 # if --offset is not provided, then set offset field to '*' so build
176 # tools will compute offset of PCD in VPD region.
177 #
178 Pcd = ' {Name}|*|{Size}|{Value}'.format (Name = args.PcdName, Size = args.MaxSize, Value = PcdValue)
179 else:
180 #
181 # --offset value must be 8-byte aligned
182 #
183 if (args.Offset % 8) != 0:
184 print ('BinToPcd: error: argument --offset must be 8-byte aligned.')
185 sys.exit (1)
186 #
187 # Use the --offset value provided.
188 #
189 Pcd = ' {Name}|{Offset}|{Size}|{Value}'.format (Name = args.PcdName, Offset = args.Offset, Size = args.MaxSize, Value = PcdValue)
190 if args.Verbose:
191 print ('BinToPcd: Convert binary file to PCD statement compatible with PCD sections')
192 print (' [PcdsDynamicVpd]')
193 print (' [PcdsDynamicExVpd]')
194 elif args.PcdType == 'HII':
195 if args.VariableGuid is None or args.VariableName is None:
196 print ('BinToPcd: error: arguments --variable-guid and --variable-name are required for --type HII.')
197 sys.exit (1)
198 if args.Offset is None:
199 #
200 # Use UEFI Variable offset of 0 if --offset is not provided
201 #
202 args.Offset = 0
203 #
204 # --offset value must be 8-byte aligned
205 #
206 if (args.Offset % 8) != 0:
207 print ('BinToPcd: error: argument --offset must be 8-byte aligned.')
208 sys.exit (1)
209 Pcd = ' {Name}|L"{VarName}"|{VarGuid}|{Offset}|{Value}'.format (Name = args.PcdName, VarName = args.VariableName, VarGuid = args.VariableGuid, Offset = args.Offset, Value = PcdValue)
210 if args.Verbose:
211 print ('BinToPcd: Convert binary file to PCD statement compatible with PCD sections')
212 print (' [PcdsDynamicHii]')
213 print (' [PcdsDynamicExHii]')
214
215 #
216 # Write PCD value or PCD statement to the output file
217 #
218 try:
219 args.OutputFile.write (Pcd)
220 args.OutputFile.close ()
221 except:
222 #
223 # If output file is not specified or it can not be written, then write the
224 # PCD value or PCD statement to the console
225 #
226 print (Pcd)