]>
git.proxmox.com Git - mirror_edk2.git/blob - BaseTools/Source/Python/PatchPcdValue/PatchPcdValue.py
2 # Patch value into the binary file.
4 # Copyright (c) 2010, 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
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.
21 from optparse
import OptionParser
22 from optparse
import make_option
23 from Common
.BuildToolError
import *
24 import Common
.EdkLogger
as EdkLogger
25 from Common
.BuildVersion
import gBUILD_VERSION
29 # Version and Copyright
30 __version_number__
= ("0.10" + " " + gBUILD_VERSION
)
31 __version__
= "%prog Version " + __version_number__
32 __copyright__
= "Copyright (c) 2010, Intel Corporation. All rights reserved."
34 ## PatchBinaryFile method
36 # This method mainly patches the data into binary file.
38 # @param FileName File path of the binary file
39 # @param ValueOffset Offset value
40 # @param TypeName DataType Name
41 # @param Value Value String
42 # @param MaxSize MaxSize value
44 # @retval 0 File is updated successfully.
45 # @retval not 0 File is updated failed.
47 def PatchBinaryFile(FileName
, ValueOffset
, TypeName
, ValueString
, MaxSize
=0):
49 # Length of Binary File
51 FileHandle
= open (FileName
, 'rb')
52 FileHandle
.seek (0, 2)
53 FileLength
= FileHandle
.tell()
56 # Unify string to upper string
58 TypeName
= TypeName
.upper()
60 # Get PCD value data length
63 if TypeName
== 'BOOLEAN':
65 elif TypeName
== 'UINT8':
67 elif TypeName
== 'UINT16':
69 elif TypeName
== 'UINT32':
71 elif TypeName
== 'UINT64':
73 elif TypeName
== 'VOID*':
75 return OPTION_MISSING
, "PcdMaxSize is not specified for VOID* type PCD."
78 return PARAMETER_INVALID
, "PCD type %s is not valid." %(CommandOptions
.PcdTypeName
)
80 # Check PcdValue is in the input binary file.
82 if ValueOffset
+ ValueLength
> FileLength
:
83 return PARAMETER_INVALID
, "PcdOffset + PcdMaxSize(DataType) is larger than the input file size."
85 # Read binary file into array
87 FileHandle
= open (FileName
, 'rb')
88 ByteArray
= array
.array('B')
89 ByteArray
.fromfile(FileHandle
, FileLength
)
91 OrigByteList
= ByteArray
.tolist()
92 ByteList
= ByteArray
.tolist()
94 # Clear the data in file
96 for Index
in range(ValueLength
):
97 ByteList
[ValueOffset
+ Index
] = 0
99 # Patch value into offset
101 ValueString
= ValueString
.upper()
103 if TypeName
== 'BOOLEAN':
105 # Get PCD value for BOOLEAN data type
108 if ValueString
== 'TRUE':
110 elif ValueString
== 'FALSE':
112 elif ValueString
.startswith('0X'):
113 ValueNumber
= int (Value
, 16)
115 ValueNumber
= int (Value
)
119 return PARAMETER_INVALID
, "PCD Value %s is not valid dec or hex string." %(ValueString)
121 # Set PCD value into binary data
123 ByteList
[ValueOffset
] = ValueNumber
124 elif TypeName
in ['UINT8', 'UINT16', 'UINT32', 'UINT64']:
126 # Get PCD value for UINT* data type
129 if ValueString
.startswith('0X'):
130 ValueNumber
= int (ValueString
, 16)
132 ValueNumber
= int (ValueString
)
134 return PARAMETER_INVALID
, "PCD Value %s is not valid dec or hex string." %(ValueString)
136 # Set PCD value into binary data
138 for Index
in range(ValueLength
):
139 ByteList
[ValueOffset
+ Index
] = ValueNumber
% 0x100
140 ValueNumber
= ValueNumber
/ 0x100
141 elif TypeName
== 'VOID*':
142 if ValueString
.startswith("L "):
144 # Patch Unicode String
147 for ByteString
in ValueString
[2:]:
149 # Reserve zero as unicode tail
151 if Index
+ 2 >= ValueLength
:
154 # Set string value one by one
156 ByteList
[ValueOffset
+ Index
] = ord(ByteString
)
158 elif ValueString
.startswith("{") and ValueString
.endswith("}"):
160 # Patch {0x1, 0x2, ...} byte by byte
162 ValueList
= ValueString
[1 : len(ValueString
) - 1].split(', ')
165 for ByteString
in ValueList
:
166 if ByteString
.upper().startswith('0X'):
167 ByteValue
= int(ByteString
, 16)
169 ByteValue
= int(ByteString
)
170 ByteList
[ValueOffset
+ Index
] = ByteValue
% 0x100
172 if Index
>= ValueLength
:
175 return PARAMETER_INVALID
, "PCD Value %s is not valid dec or hex string array." %(ValueString)
181 for ByteString
in ValueString
:
183 # Reserve zero as string tail
185 if Index
+ 1 >= ValueLength
:
188 # Set string value one by one
190 ByteList
[ValueOffset
+ Index
] = ord(ByteString
)
193 # Update new data into input file.
195 if ByteList
!= OrigByteList
:
196 ByteArray
= array
.array('B')
197 ByteArray
.fromlist(ByteList
)
198 FileHandle
= open (FileName
, 'wb')
199 ByteArray
.tofile(FileHandle
)
201 return 0, "Patch Value into File %s successfully." %(FileName)
203 ## Parse command line options
205 # Using standard Python module optparse to parse command line option of this tool.
207 # @retval Options A optparse.Values object containing the parsed options
208 # @retval InputFile Path of file to be trimmed
212 make_option("-f", "--offset", dest
="PcdOffset", action
="store", type="int",
213 help="Start offset to the image is used to store PCD value."),
214 make_option("-u", "--value", dest
="PcdValue", action
="store",
215 help="PCD value will be updated into the image."),
216 make_option("-t", "--type", dest
="PcdTypeName", action
="store",
217 help="The name of PCD data type may be one of VOID*,BOOLEAN, UINT8, UINT16, UINT32, UINT64."),
218 make_option("-s", "--maxsize", dest
="PcdMaxSize", action
="store", type="int",
219 help="Max size of data buffer is taken by PCD value.It must be set when PCD type is VOID*."),
220 make_option("-v", "--verbose", dest
="LogLevel", action
="store_const", const
=EdkLogger
.VERBOSE
,
221 help="Run verbosely"),
222 make_option("-d", "--debug", dest
="LogLevel", type="int",
223 help="Run with debug information"),
224 make_option("-q", "--quiet", dest
="LogLevel", action
="store_const", const
=EdkLogger
.QUIET
,
226 make_option("-?", action
="help", help="show this help message and exit"),
229 # use clearer usage to override default usage message
230 UsageString
= "%prog -f Offset -u Value -t Type [-s MaxSize] <input_file>"
232 Parser
= OptionParser(description
=__copyright__
, version
=__version__
, option_list
=OptionList
, usage
=UsageString
)
233 Parser
.set_defaults(LogLevel
=EdkLogger
.INFO
)
235 Options
, Args
= Parser
.parse_args()
239 EdkLogger
.error("PatchPcdValue", PARAMETER_INVALID
, ExtraData
=Parser
.get_usage())
241 InputFile
= Args
[len(Args
) - 1]
242 return Options
, InputFile
246 # This method mainly dispatch specific methods per the command line options.
247 # If no error found, return zero value so the caller of this tool can know
248 # if it's executed successfully or not.
250 # @retval 0 Tool was successful
251 # @retval 1 Tool failed
256 # Check input parameter
258 EdkLogger
.Initialize()
259 CommandOptions
, InputFile
= Options()
260 if CommandOptions
.LogLevel
< EdkLogger
.DEBUG_9
:
261 EdkLogger
.SetLevel(CommandOptions
.LogLevel
+ 1)
263 EdkLogger
.SetLevel(CommandOptions
.LogLevel
)
264 if not os
.path
.exists (InputFile
):
265 EdkLogger
.error("PatchPcdValue", FILE_NOT_FOUND
, ExtraData
=InputFile
)
267 if CommandOptions
.PcdOffset
== None or CommandOptions
.PcdValue
== None or CommandOptions
.PcdTypeName
== None:
268 EdkLogger
.error("PatchPcdValue", OPTION_MISSING
, ExtraData
="PcdOffset or PcdValue of PcdTypeName is not specified.")
270 if CommandOptions
.PcdTypeName
.upper() not in ["BOOLEAN", "UINT8", "UINT16", "UINT32", "UINT64", "VOID*"]:
271 EdkLogger
.error("PatchPcdValue", PARAMETER_INVALID
, ExtraData
="PCD type %s is not valid." %(CommandOptions
.PcdTypeName
))
273 if CommandOptions
.PcdTypeName
.upper() == "VOID*" and CommandOptions
.PcdMaxSize
== None:
274 EdkLogger
.error("PatchPcdValue", OPTION_MISSING
, ExtraData
="PcdMaxSize is not specified for VOID* type PCD.")
277 # Patch value into binary image.
279 ReturnValue
, ErrorInfo
= PatchBinaryFile (InputFile
, CommandOptions
.PcdOffset
, CommandOptions
.PcdTypeName
, CommandOptions
.PcdValue
, CommandOptions
.PcdMaxSize
)
281 EdkLogger
.error("PatchPcdValue", ReturnValue
, ExtraData
=ErrorInfo
)
287 if __name__
== '__main__':