]> git.proxmox.com Git - mirror_edk2.git/blame - BaseTools/Source/Python/AutoGen/GenVar.py
BaseTools: Update SkuId as SKU_ID type to follow current implementation
[mirror_edk2.git] / BaseTools / Source / Python / AutoGen / GenVar.py
CommitLineData
34952f49
LG
1# Copyright (c) 2017, Intel Corporation. All rights reserved.<BR>\r
2# This program and the accompanying materials\r
3# are licensed and made available under the terms and conditions of the BSD License\r
4# which accompanies this distribution. The full text of the license may be found at\r
5# http://opensource.org/licenses/bsd-license.php\r
6#\r
7# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
8# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
9\r
10#\r
11# This file is used to collect the Variable checking information\r
12#\r
13\r
14# #\r
15# Import Modules\r
16#\r
17from struct import pack,unpack\r
18import collections\r
19import copy\r
20from Common.VariableAttributes import VariableAttributes\r
21from Common.Misc import *\r
22import collections\r
23\r
24var_info = collections.namedtuple("uefi_var", "pcdindex,pcdname,defaultstoragename,skuname,var_name, var_guid, var_attribute,pcd_default_value, default_value, data_type")\r
25NvStorageHeaderSize = 28\r
26VariableHeaderSize = 32\r
27\r
28def StringArrayToList(StringArray):\r
29 StringArray = StringArray[1:-1]\r
30 StringArray = '[' + StringArray + ']'\r
31 return eval(StringArray)\r
32\r
33def PackGUID(Guid):\r
34 GuidBuffer = pack('=LHHBBBBBBBB',\r
35 int(Guid[0], 16),\r
36 int(Guid[1], 16),\r
37 int(Guid[2], 16),\r
38 int(Guid[3][-4:-2], 16),\r
39 int(Guid[3][-2:], 16),\r
40 int(Guid[4][-12:-10], 16),\r
41 int(Guid[4][-10:-8], 16),\r
42 int(Guid[4][-8:-6], 16),\r
43 int(Guid[4][-6:-4], 16),\r
44 int(Guid[4][-4:-2], 16),\r
45 int(Guid[4][-2:], 16)\r
46 )\r
47 return GuidBuffer\r
48\r
8518bf0b
LG
49class VariableMgr(object):\r
50 def __init__(self, DefaultStoreMap,SkuIdMap):\r
34952f49 51 self.VarInfo = []\r
8518bf0b
LG
52 self.DefaultStoreMap = DefaultStoreMap\r
53 self.SkuIdMap = SkuIdMap\r
47854fd5
LG
54 self.VpdRegionSize = 0\r
55 self.VpdRegionOffset = 0\r
56 self.NVHeaderBuff = None\r
57 self.VarDefaultBuff = None\r
58 self.VarDeltaBuff = None\r
34952f49
LG
59\r
60 def append_variable(self,uefi_var):\r
61 self.VarInfo.append(uefi_var)\r
62\r
47854fd5
LG
63 def SetVpdRegionMaxSize(self,maxsize):\r
64 self.VpdRegionSize = maxsize\r
65\r
66 def SetVpdRegionOffset(self,vpdoffset):\r
67 self.VpdRegionOffset = vpdoffset\r
68\r
69 def PatchNVStoreDefaultMaxSize(self,maxsize):\r
70 if not self.NVHeaderBuff:\r
71 return ""\r
7e6e459a 72 self.NVHeaderBuff = self.NVHeaderBuff[:8] + pack("=Q",maxsize)\r
47854fd5
LG
73 default_var_bin = self.format_data(self.NVHeaderBuff + self.VarDefaultBuff + self.VarDeltaBuff)\r
74 value_str = "{"\r
75 default_var_bin_strip = [ data.strip("""'""") for data in default_var_bin]\r
76 value_str += ",".join(default_var_bin_strip)\r
77 value_str += "}"\r
78 return value_str\r
79\r
34952f49
LG
80 def process_variable_data(self):\r
81\r
82 var_data = dict()\r
83\r
84 indexedvarinfo = collections.OrderedDict()\r
85 for item in self.VarInfo:\r
86 if item.pcdindex not in indexedvarinfo:\r
87 indexedvarinfo[item.pcdindex] = dict()\r
8518bf0b 88 indexedvarinfo[item.pcdindex][(item.skuname,item.defaultstoragename)] = item\r
34952f49
LG
89\r
90 for index in indexedvarinfo:\r
91 sku_var_info = indexedvarinfo[index]\r
92\r
93 default_data_buffer = ""\r
94 others_data_buffer = ""\r
95 tail = None\r
8518bf0b 96 default_sku_default = indexedvarinfo.get(index).get(("DEFAULT","STANDARD"))\r
34952f49
LG
97\r
98 if default_sku_default.data_type not in ["UINT8","UINT16","UINT32","UINT64","BOOLEAN"]:\r
99 var_max_len = max([len(var_item.default_value.split(",")) for var_item in sku_var_info.values()])\r
100 if len(default_sku_default.default_value.split(",")) < var_max_len:\r
101 tail = ",".join([ "0x00" for i in range(var_max_len-len(default_sku_default.default_value.split(",")))])\r
102\r
103 default_data_buffer = self.PACK_VARIABLES_DATA(default_sku_default.default_value,default_sku_default.data_type,tail)\r
104\r
105 default_data_array = ()\r
106 for item in default_data_buffer:\r
107 default_data_array += unpack("B",item)\r
108\r
8518bf0b
LG
109 if ("DEFAULT","STANDARD") not in var_data:\r
110 var_data[("DEFAULT","STANDARD")] = collections.OrderedDict()\r
111 var_data[("DEFAULT","STANDARD")][index] = (default_data_buffer,sku_var_info[("DEFAULT","STANDARD")])\r
34952f49
LG
112\r
113 for (skuid,defaultstoragename) in indexedvarinfo.get(index):\r
114 tail = None\r
8518bf0b 115 if (skuid,defaultstoragename) == ("DEFAULT","STANDARD"):\r
34952f49
LG
116 continue\r
117 other_sku_other = indexedvarinfo.get(index).get((skuid,defaultstoragename))\r
118\r
119 if default_sku_default.data_type not in ["UINT8","UINT16","UINT32","UINT64","BOOLEAN"]:\r
120 if len(other_sku_other.default_value.split(",")) < var_max_len:\r
121 tail = ",".join([ "0x00" for i in range(var_max_len-len(other_sku_other.default_value.split(",")))])\r
122\r
123 others_data_buffer = self.PACK_VARIABLES_DATA(other_sku_other.default_value,other_sku_other.data_type,tail)\r
124\r
125 others_data_array = ()\r
126 for item in others_data_buffer:\r
127 others_data_array += unpack("B",item)\r
128\r
129 data_delta = self.calculate_delta(default_data_array, others_data_array)\r
130\r
131 if (skuid,defaultstoragename) not in var_data:\r
132 var_data[(skuid,defaultstoragename)] = collections.OrderedDict()\r
133 var_data[(skuid,defaultstoragename)][index] = (data_delta,sku_var_info[(skuid,defaultstoragename)])\r
134 return var_data\r
135\r
136 def new_process_varinfo(self):\r
137\r
138 var_data = self.process_variable_data()\r
139\r
2b8a6c44
LG
140 if not var_data:\r
141 return []\r
142\r
47854fd5 143 pcds_default_data = var_data.get(("DEFAULT","STANDARD"),{})\r
34952f49
LG
144 NvStoreDataBuffer = ""\r
145 var_data_offset = collections.OrderedDict()\r
146 offset = NvStorageHeaderSize\r
147 for default_data,default_info in pcds_default_data.values():\r
148 var_name_buffer = self.PACK_VARIABLE_NAME(default_info.var_name)\r
149\r
150 vendorguid = default_info.var_guid.split('-')\r
151\r
152 if default_info.var_attribute:\r
153 var_attr_value,_ = VariableAttributes.GetVarAttributes(default_info.var_attribute)\r
154 else:\r
155 var_attr_value = 0x07\r
156\r
34952f49
LG
157 DataBuffer = self.AlignData(var_name_buffer + default_data)\r
158\r
159 data_size = len(DataBuffer)\r
160 offset += VariableHeaderSize + len(default_info.var_name.split(","))\r
161 var_data_offset[default_info.pcdindex] = offset\r
162 offset += data_size - len(default_info.var_name.split(","))\r
163\r
8518bf0b 164 var_header_buffer = self.PACK_VARIABLE_HEADER(var_attr_value, len(default_info.var_name.split(",")), len (default_data), vendorguid)\r
34952f49
LG
165 NvStoreDataBuffer += (var_header_buffer + DataBuffer)\r
166\r
167 variable_storage_header_buffer = self.PACK_VARIABLE_STORE_HEADER(len(NvStoreDataBuffer) + 28)\r
168\r
7e6e459a 169 nv_default_part = self.AlignData(self.PACK_DEFAULT_DATA(0, 0, self.unpack_data(variable_storage_header_buffer+NvStoreDataBuffer)), 8)\r
34952f49 170\r
34952f49 171 data_delta_structure_buffer = ""\r
8518bf0b
LG
172 for skuname,defaultstore in var_data:\r
173 if (skuname,defaultstore) == ("DEFAULT","STANDARD"):\r
34952f49 174 continue\r
8518bf0b 175 pcds_sku_data = var_data.get((skuname,defaultstore))\r
34952f49
LG
176 delta_data_set = []\r
177 for pcdindex in pcds_sku_data:\r
178 offset = var_data_offset[pcdindex]\r
179 delta_data,_ = pcds_sku_data[pcdindex]\r
180 delta_data = [(item[0] + offset, item[1]) for item in delta_data]\r
181 delta_data_set.extend(delta_data)\r
182\r
7e6e459a 183 data_delta_structure_buffer += self.AlignData(self.PACK_DELTA_DATA(skuname,defaultstore,delta_data_set), 8)\r
34952f49 184\r
7e6e459a 185 size = len(nv_default_part + data_delta_structure_buffer) + 16\r
47854fd5
LG
186 maxsize = self.VpdRegionSize if self.VpdRegionSize else size\r
187 NV_Store_Default_Header = self.PACK_NV_STORE_DEFAULT_HEADER(size,maxsize)\r
188\r
189 self.NVHeaderBuff = NV_Store_Default_Header\r
190 self.VarDefaultBuff =nv_default_part\r
191 self.VarDeltaBuff = data_delta_structure_buffer\r
192 return self.format_data(NV_Store_Default_Header + nv_default_part + data_delta_structure_buffer)\r
34952f49
LG
193\r
194\r
195 def format_data(self,data):\r
196\r
197 return [hex(item) for item in self.unpack_data(data)]\r
198\r
199 def unpack_data(self,data):\r
200 final_data = ()\r
201 for item in data:\r
202 final_data += unpack("B",item)\r
203 return final_data\r
204\r
205 def calculate_delta(self, default, theother):\r
34952f49
LG
206 if len(default) - len(theother) != 0:\r
207 EdkLogger.error("build", FORMAT_INVALID, 'The variable data length is not the same for the same PCD.')\r
208 data_delta = []\r
209 for i in range(len(default)):\r
210 if default[i] != theother[i]:\r
211 data_delta.append((i,theother[i]))\r
212 return data_delta\r
213\r
214 def dump(self):\r
215\r
216 default_var_bin = self.new_process_varinfo()\r
2b8a6c44
LG
217 if default_var_bin:\r
218 value_str = "{"\r
219 default_var_bin_strip = [ data.strip("""'""") for data in default_var_bin]\r
220 value_str += ",".join(default_var_bin_strip)\r
221 value_str += "}"\r
222 return value_str\r
223 return ""\r
34952f49
LG
224\r
225 def PACK_VARIABLE_STORE_HEADER(self,size):\r
226 #Signature: gEfiVariableGuid\r
227 Guid = "{ 0xddcf3616, 0x3275, 0x4164, { 0x98, 0xb6, 0xfe, 0x85, 0x70, 0x7f, 0xfe, 0x7d }}"\r
228 Guid = GuidStructureStringToGuidString(Guid)\r
229 GuidBuffer = PackGUID(Guid.split('-'))\r
230\r
231 SizeBuffer = pack('=L',size)\r
232 FormatBuffer = pack('=B',0x5A)\r
233 StateBuffer = pack('=B',0xFE)\r
234 reservedBuffer = pack('=H',0)\r
235 reservedBuffer += pack('=L',0)\r
236\r
237 return GuidBuffer + SizeBuffer + FormatBuffer + StateBuffer + reservedBuffer\r
238\r
47854fd5
LG
239 def PACK_NV_STORE_DEFAULT_HEADER(self,size,maxsize):\r
240 Signature = pack('=B',ord('N'))\r
241 Signature += pack("=B",ord('S'))\r
242 Signature += pack("=B",ord('D'))\r
243 Signature += pack("=B",ord('B'))\r
244\r
245 SizeBuffer = pack("=L",size)\r
7e6e459a 246 MaxSizeBuffer = pack("=Q",maxsize)\r
47854fd5
LG
247\r
248 return Signature + SizeBuffer + MaxSizeBuffer\r
34952f49
LG
249\r
250 def PACK_VARIABLE_HEADER(self,attribute,namesize,datasize,vendorguid):\r
251\r
252 Buffer = pack('=H',0x55AA) # pack StartID\r
253 Buffer += pack('=B',0x3F) # pack State\r
254 Buffer += pack('=B',0) # pack reserved\r
255\r
256 Buffer += pack('=L',attribute)\r
257 Buffer += pack('=L',namesize)\r
258 Buffer += pack('=L',datasize)\r
259\r
260 Buffer += PackGUID(vendorguid)\r
261\r
262 return Buffer\r
263\r
264 def PACK_VARIABLES_DATA(self, var_value,data_type, tail = None):\r
265 Buffer = ""\r
266 data_len = 0\r
267 if data_type == "VOID*":\r
268 for value_char in var_value.strip("{").strip("}").split(","):\r
269 Buffer += pack("=B",int(value_char,16))\r
270 data_len += len(var_value.split(","))\r
271 if tail:\r
272 for value_char in tail.split(","):\r
273 Buffer += pack("=B",int(value_char,16))\r
274 data_len += len(tail.split(","))\r
275 elif data_type == "BOOLEAN":\r
276 Buffer += pack("=B",True) if var_value.upper() == "TRUE" else pack("=B",False)\r
277 data_len += 1\r
278 elif data_type == "UINT8":\r
279 Buffer += pack("=B",GetIntegerValue(var_value))\r
280 data_len += 1\r
281 elif data_type == "UINT16":\r
282 Buffer += pack("=H",GetIntegerValue(var_value))\r
283 data_len += 2\r
284 elif data_type == "UINT32":\r
285 Buffer += pack("=L",GetIntegerValue(var_value))\r
286 data_len += 4\r
287 elif data_type == "UINT64":\r
288 Buffer += pack("=Q",GetIntegerValue(var_value))\r
289 data_len += 8\r
290\r
291 return Buffer\r
292\r
293 def PACK_DEFAULT_DATA(self, defaultstoragename,skuid,var_value):\r
294 Buffer = ""\r
7e6e459a
LG
295 Buffer += pack("=L",4+8+8)\r
296 Buffer += pack("=Q",int(skuid))\r
297 Buffer += pack("=Q",int(defaultstoragename))\r
34952f49
LG
298\r
299 for item in var_value:\r
300 Buffer += pack("=B",item)\r
301\r
302 Buffer = pack("=L",len(Buffer)+4) + Buffer\r
303\r
304 return Buffer\r
305\r
8518bf0b
LG
306 def GetSkuId(self,skuname):\r
307 if skuname not in self.SkuIdMap:\r
308 return None\r
309 return self.SkuIdMap.get(skuname)[0]\r
310 def GetDefaultStoreId(self,dname):\r
311 if dname not in self.DefaultStoreMap:\r
312 return None\r
313 return self.DefaultStoreMap.get(dname)[0]\r
314 def PACK_DELTA_DATA(self,skuname,defaultstoragename,delta_list):\r
315 skuid = self.GetSkuId(skuname)\r
316 defaultstorageid = self.GetDefaultStoreId(defaultstoragename)\r
34952f49 317 Buffer = ""\r
7e6e459a
LG
318 Buffer += pack("=L",4+8+8)\r
319 Buffer += pack("=Q",int(skuid))\r
320 Buffer += pack("=Q",int(defaultstorageid))\r
34952f49
LG
321 for (delta_offset,value) in delta_list:\r
322 Buffer += pack("=L",delta_offset)\r
323 Buffer = Buffer[:-1] + pack("=B",value)\r
324\r
325 Buffer = pack("=L",len(Buffer) + 4) + Buffer\r
326\r
327 return Buffer\r
328\r
329 def AlignData(self,data, align = 4):\r
330 mybuffer = data\r
7e6e459a
LG
331 if (len(data) % align) > 0:\r
332 for i in range(align - (len(data) % align)):\r
333 mybuffer += pack("=B",0)\r
34952f49
LG
334\r
335 return mybuffer\r
336\r
337 def PACK_VARIABLE_NAME(self, var_name):\r
338 Buffer = ""\r
339 for name_char in var_name.strip("{").strip("}").split(","):\r
340 Buffer += pack("=B",int(name_char,16))\r
341\r
8518bf0b 342 return Buffer\r