1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
|
#!/usr/bin/env python
## @ FspDscBsf2Yaml.py
# This script convert DSC or BSF format file into YAML format
#
# Copyright(c) 2021, Intel Corporation. All rights reserved.<BR>
# SPDX-License-Identifier: BSD-2-Clause-Patent
#
##
import os
import re
import sys
from collections import OrderedDict
from datetime import date
from FspGenCfgData import CFspBsf2Dsc, CGenCfgData
__copyright_tmp__ = """## @file
#
# Slim Bootloader CFGDATA %s File.
#
# Copyright (c) %4d, Intel Corporation. All rights reserved.<BR>
# SPDX-License-Identifier: BSD-2-Clause-Patent
#
##
"""
class CFspDsc2Yaml():
def __init__(self):
self._Hdr_key_list = ['EMBED', 'STRUCT']
self._Bsf_key_list = ['NAME', 'HELP', 'TYPE', 'PAGE', 'PAGES',
'OPTION', 'CONDITION', 'ORDER', 'MARKER',
'SUBT', 'FIELD', 'FIND']
self.gen_cfg_data = None
self.cfg_reg_exp = re.compile(
"^([_a-zA-Z0-9$\\(\\)]+)\\s*\\|\\s*(0x[0-9A-F]+|\\*)"
"\\s*\\|\\s*(\\d+|0x[0-9a-fA-F]+)\\s*\\|\\s*(.+)")
self.bsf_reg_exp = re.compile("(%s):{(.+?)}(?:$|\\s+)"
% '|'.join(self._Bsf_key_list))
self.hdr_reg_exp = re.compile("(%s):{(.+?)}"
% '|'.join(self._Hdr_key_list))
self.prefix = ''
self.unused_idx = 0
self.offset = 0
self.base_offset = 0
def load_config_data_from_dsc(self, file_name):
"""
Load and parse a DSC CFGDATA file.
"""
gen_cfg_data = CGenCfgData('FSP')
if file_name.endswith('.dsc'):
if gen_cfg_data.ParseDscFile(file_name) != 0:
raise Exception('DSC file parsing error !')
if gen_cfg_data.CreateVarDict() != 0:
raise Exception('DSC variable creation error !')
else:
raise Exception('Unsupported file "%s" !' % file_name)
gen_cfg_data.UpdateDefaultValue()
self.gen_cfg_data = gen_cfg_data
def print_dsc_line(self):
"""
Debug function to print all DSC lines.
"""
for line in self.gen_cfg_data._DscLines:
print(line)
def format_value(self, field, text, indent=''):
"""
Format a CFGDATA item into YAML format.
"""
if (not text.startswith('!expand')) and (': ' in text):
tgt = ':' if field == 'option' else '- '
text = text.replace(': ', tgt)
lines = text.splitlines()
if len(lines) == 1 and field != 'help':
return text
else:
return '>\n ' + '\n '.join(
[indent + i.lstrip() for i in lines])
def reformat_pages(self, val):
# Convert XXX:YYY into XXX::YYY format for page definition
parts = val.split(',')
if len(parts) <= 1:
return val
new_val = []
for each in parts:
nodes = each.split(':')
if len(nodes) == 2:
each = '%s::%s' % (nodes[0], nodes[1])
new_val.append(each)
ret = ','.join(new_val)
return ret
def reformat_struct_value(self, utype, val):
# Convert DSC UINT16/32/64 array into new format by
# adding prefix 0:0[WDQ] to provide hint to the array format
if utype in ['UINT16', 'UINT32', 'UINT64']:
if val and val[0] == '{' and val[-1] == '}':
if utype == 'UINT16':
unit = 'W'
elif utype == 'UINT32':
unit = 'D'
else:
unit = 'Q'
val = '{ 0:0%s, %s }' % (unit, val[1:-1])
return val
def process_config(self, cfg):
if 'page' in cfg:
cfg['page'] = self.reformat_pages(cfg['page'])
if 'struct' in cfg:
cfg['value'] = self.reformat_struct_value(
cfg['struct'], cfg['value'])
def parse_dsc_line(self, dsc_line, config_dict, init_dict, include):
"""
Parse a line in DSC and update the config dictionary accordingly.
"""
init_dict.clear()
match = re.match('g(CfgData|\\w+FspPkgTokenSpaceGuid)\\.(.+)',
dsc_line)
if match:
match = self.cfg_reg_exp.match(match.group(2))
if not match:
return False
config_dict['cname'] = self.prefix + match.group(1)
value = match.group(4).strip()
length = match.group(3).strip()
config_dict['length'] = length
config_dict['value'] = value
if match.group(2) == '*':
self.offset += int(length, 0)
else:
org_offset = int(match.group(2), 0)
if org_offset == 0:
self.base_offset = self.offset
offset = org_offset + self.base_offset
if self.offset != offset:
if offset > self.offset:
init_dict['padding'] = offset - self.offset
self.offset = offset + int(length, 0)
return True
match = re.match("^\\s*#\\s+!([<>])\\s+include\\s+(.+)", dsc_line)
if match and len(config_dict) == 0:
# !include should not be inside a config field
# if so, do not convert include into YAML
init_dict = dict(config_dict)
config_dict.clear()
config_dict['cname'] = '$ACTION'
if match.group(1) == '<':
config_dict['include'] = match.group(2)
else:
config_dict['include'] = ''
return True
match = re.match("^\\s*#\\s+(!BSF|!HDR)\\s+(.+)", dsc_line)
if not match:
return False
remaining = match.group(2)
if match.group(1) == '!BSF':
result = self.bsf_reg_exp.findall(remaining)
if not result:
return False
for each in result:
key = each[0].lower()
val = each[1]
if key == 'field':
name = each[1]
if ':' not in name:
raise Exception('Incorrect bit field format !')
parts = name.split(':')
config_dict['length'] = parts[1]
config_dict['cname'] = '@' + parts[0]
return True
elif key in ['pages', 'page', 'find']:
init_dict = dict(config_dict)
config_dict.clear()
config_dict['cname'] = '$ACTION'
if key == 'find':
config_dict['find'] = val
else:
config_dict['page'] = val
return True
elif key == 'subt':
config_dict.clear()
parts = each[1].split(':')
tmp_name = parts[0][:-5]
if tmp_name == 'CFGHDR':
cfg_tag = '_$FFF_'
sval = '!expand { %s_TMPL : [ ' % \
tmp_name + '%s, %s, ' % (parts[1], cfg_tag) + \
', '.join(parts[2:]) + ' ] }'
else:
sval = '!expand { %s_TMPL : [ ' % \
tmp_name + ', '.join(parts[1:]) + ' ] }'
config_dict.clear()
config_dict['cname'] = tmp_name
config_dict['expand'] = sval
return True
else:
if key in ['name', 'help', 'option'] and \
val.startswith('+'):
val = config_dict[key] + '\n' + val[1:]
if val.strip() == '':
val = "''"
config_dict[key] = val
else:
match = self.hdr_reg_exp.match(remaining)
if not match:
return False
key = match.group(1)
remaining = match.group(2)
if key == 'EMBED':
parts = remaining.split(':')
names = parts[0].split(',')
if parts[-1] == 'END':
prefix = '>'
else:
prefix = '<'
skip = False
if parts[1].startswith('TAG_'):
tag_txt = '%s:%s' % (names[0], parts[1])
else:
tag_txt = names[0]
if parts[2] in ['START', 'END']:
if names[0] == 'PCIE_RP_PIN_CTRL[]':
skip = True
else:
tag_txt = '%s:%s' % (names[0], parts[1])
if not skip:
config_dict.clear()
config_dict['cname'] = prefix + tag_txt
return True
if key == 'STRUCT':
text = remaining.strip()
config_dict[key.lower()] = text
return False
def process_template_lines(self, lines):
"""
Process a line in DSC template section.
"""
template_name = ''
bsf_temp_dict = OrderedDict()
temp_file_dict = OrderedDict()
include_file = ['.']
for line in lines:
match = re.match("^\\s*#\\s+!([<>])\\s+include\\s+(.+)", line)
if match:
if match.group(1) == '<':
include_file.append(match.group(2))
else:
include_file.pop()
match = re.match(
"^\\s*#\\s+(!BSF)\\s+DEFT:{(.+?):(START|END)}", line)
if match:
if match.group(3) == 'START' and not template_name:
template_name = match.group(2).strip()
temp_file_dict[template_name] = list(include_file)
bsf_temp_dict[template_name] = []
if match.group(3) == 'END' and \
(template_name == match.group(2).strip()) and \
template_name:
template_name = ''
else:
if template_name:
bsf_temp_dict[template_name].append(line)
return bsf_temp_dict, temp_file_dict
def process_option_lines(self, lines):
"""
Process a line in DSC config section.
"""
cfgs = []
struct_end = False
config_dict = dict()
init_dict = dict()
include = ['']
for line in lines:
ret = self.parse_dsc_line(line, config_dict, init_dict, include)
if ret:
if 'padding' in init_dict:
num = init_dict['padding']
init_dict.clear()
padding_dict = {}
cfgs.append(padding_dict)
padding_dict['cname'] = 'UnusedUpdSpace%d' % \
self.unused_idx
padding_dict['length'] = '0x%x' % num
padding_dict['value'] = '{ 0 }'
self.unused_idx += 1
if cfgs and cfgs[-1]['cname'][0] != '@' and \
config_dict['cname'][0] == '@':
# it is a bit field, mark the previous one as virtual
cname = cfgs[-1]['cname']
new_cfg = dict(cfgs[-1])
new_cfg['cname'] = '@$STRUCT'
cfgs[-1].clear()
cfgs[-1]['cname'] = cname
cfgs.append(new_cfg)
if cfgs and cfgs[-1]['cname'] == 'CFGHDR' and \
config_dict['cname'][0] == '<':
# swap CfgHeader and the CFG_DATA order
if ':' in config_dict['cname']:
# replace the real TAG for CFG_DATA
cfgs[-1]['expand'] = cfgs[-1]['expand'].replace(
'_$FFF_', '0x%s' %
config_dict['cname'].split(':')[1][4:])
cfgs.insert(-1, config_dict)
else:
self.process_config(config_dict)
if struct_end:
struct_end = False
cfgs.insert(-1, config_dict)
else:
cfgs.append(config_dict)
if config_dict['cname'][0] == '>':
struct_end = True
config_dict = dict(init_dict)
return cfgs
def variable_fixup(self, each):
"""
Fix up some variable definitions for SBL.
"""
key = each
val = self.gen_cfg_data._MacroDict[each]
return key, val
def template_fixup(self, tmp_name, tmp_list):
"""
Fix up some special config templates for SBL
"""
return
def config_fixup(self, cfg_list):
"""
Fix up some special config items for SBL.
"""
# Insert FSPT_UPD/FSPM_UPD/FSPS_UPD tag so as to create C strcture
idxs = []
for idx, cfg in enumerate(cfg_list):
if cfg['cname'].startswith('<FSP_UPD_HEADER'):
idxs.append(idx)
if len(idxs) != 3:
return
# Handle insert backwards so that the index does not change in the loop
fsp_comp = 'SMT'
idx_comp = 0
for idx in idxs[::-1]:
# Add current FSP?_UPD start tag
cfgfig_dict = {}
cfgfig_dict['cname'] = '<FSP%s_UPD' % fsp_comp[idx_comp]
cfg_list.insert(idx, cfgfig_dict)
if idx_comp < 2:
# Add previous FSP?_UPD end tag
cfgfig_dict = {}
cfgfig_dict['cname'] = '>FSP%s_UPD' % fsp_comp[idx_comp + 1]
cfg_list.insert(idx, cfgfig_dict)
idx_comp += 1
# Add final FSPS_UPD end tag
cfgfig_dict = {}
cfgfig_dict['cname'] = '>FSP%s_UPD' % fsp_comp[0]
cfg_list.append(cfgfig_dict)
return
def get_section_range(self, section_name):
"""
Extract line number range from config file for a given section name.
"""
start = -1
end = -1
for idx, line in enumerate(self.gen_cfg_data._DscLines):
if start < 0 and line.startswith('[%s]' % section_name):
start = idx
elif start >= 0 and line.startswith('['):
end = idx
break
if start == -1:
start = 0
if end == -1:
end = len(self.gen_cfg_data._DscLines)
return start, end
def normalize_file_name(self, file, is_temp=False):
"""
Normalize file name convention so that it is consistent.
"""
if file.endswith('.dsc'):
file = file[:-4] + '.yaml'
dir_name = os.path.dirname(file)
base_name = os.path.basename(file)
if is_temp:
if 'Template_' not in file:
base_name = base_name.replace('Template', 'Template_')
else:
if 'CfgData_' not in file:
base_name = base_name.replace('CfgData', 'CfgData_')
if dir_name:
path = dir_name + '/' + base_name
else:
path = base_name
return path
def output_variable(self):
"""
Output variable block into a line list.
"""
lines = []
for each in self.gen_cfg_data._MacroDict:
key, value = self.variable_fixup(each)
lines.append('%-30s : %s' % (key, value))
return lines
def output_template(self):
"""
Output template block into a line list.
"""
self.offset = 0
self.base_offset = 0
start, end = self.get_section_range('PcdsDynamicVpd.Tmp')
bsf_temp_dict, temp_file_dict = self.process_template_lines(
self.gen_cfg_data._DscLines[start:end])
template_dict = dict()
lines = []
file_lines = {}
last_file = '.'
file_lines[last_file] = []
for tmp_name in temp_file_dict:
temp_file_dict[tmp_name][-1] = self.normalize_file_name(
temp_file_dict[tmp_name][-1], True)
if len(temp_file_dict[tmp_name]) > 1:
temp_file_dict[tmp_name][-2] = self.normalize_file_name(
temp_file_dict[tmp_name][-2], True)
for tmp_name in bsf_temp_dict:
file = temp_file_dict[tmp_name][-1]
if last_file != file and len(temp_file_dict[tmp_name]) > 1:
inc_file = temp_file_dict[tmp_name][-2]
file_lines[inc_file].extend(
['', '- !include %s' % temp_file_dict[tmp_name][-1], ''])
last_file = file
if file not in file_lines:
file_lines[file] = []
lines = file_lines[file]
text = bsf_temp_dict[tmp_name]
tmp_list = self.process_option_lines(text)
self.template_fixup(tmp_name, tmp_list)
template_dict[tmp_name] = tmp_list
lines.append('%s: >' % tmp_name)
lines.extend(self.output_dict(tmp_list, False)['.'])
lines.append('\n')
return file_lines
def output_config(self):
"""
Output config block into a line list.
"""
self.offset = 0
self.base_offset = 0
start, end = self.get_section_range('PcdsDynamicVpd.Upd')
cfgs = self.process_option_lines(
self.gen_cfg_data._DscLines[start:end])
self.config_fixup(cfgs)
file_lines = self.output_dict(cfgs, True)
return file_lines
def output_dict(self, cfgs, is_configs):
"""
Output one config item into a line list.
"""
file_lines = {}
level = 0
file = '.'
for each in cfgs:
if 'length' in each:
if not each['length'].endswith('b') and int(each['length'],
0) == 0:
continue
if 'include' in each:
if each['include']:
each['include'] = self.normalize_file_name(
each['include'])
file_lines[file].extend(
['', '- !include %s' % each['include'], ''])
file = each['include']
else:
file = '.'
continue
if file not in file_lines:
file_lines[file] = []
lines = file_lines[file]
name = each['cname']
prefix = name[0]
if prefix == '<':
level += 1
padding = ' ' * level
if prefix not in '<>@':
padding += ' '
else:
name = name[1:]
if prefix == '@':
padding += ' '
if ':' in name:
parts = name.split(':')
name = parts[0]
padding = padding[2:] if is_configs else padding
if prefix != '>':
if 'expand' in each:
lines.append('%s- %s' % (padding, each['expand']))
else:
lines.append('%s- %-12s :' % (padding, name))
for field in each:
if field in ['cname', 'expand', 'include']:
continue
value_str = self.format_value(
field, each[field], padding + ' ' * 16)
full_line = ' %s %-12s : %s' % (padding, field, value_str)
lines.extend(full_line.splitlines())
if prefix == '>':
level -= 1
if level == 0:
lines.append('')
return file_lines
def bsf_to_dsc(bsf_file, dsc_file):
fsp_dsc = CFspBsf2Dsc(bsf_file)
dsc_lines = fsp_dsc.get_dsc_lines()
fd = open(dsc_file, 'w')
fd.write('\n'.join(dsc_lines))
fd.close()
return
def dsc_to_yaml(dsc_file, yaml_file):
dsc2yaml = CFspDsc2Yaml()
dsc2yaml.load_config_data_from_dsc(dsc_file)
cfgs = {}
for cfg in ['Template', 'Option']:
if cfg == 'Template':
file_lines = dsc2yaml.output_template()
else:
file_lines = dsc2yaml.output_config()
for file in file_lines:
lines = file_lines[file]
if file == '.':
cfgs[cfg] = lines
else:
if ('/' in file or '\\' in file):
continue
file = os.path.basename(file)
out_dir = os.path.dirname(file)
fo = open(os.path.join(out_dir, file), 'w')
fo.write(__copyright_tmp__ % (
cfg, date.today().year) + '\n\n')
for line in lines:
fo.write(line + '\n')
fo.close()
variables = dsc2yaml.output_variable()
fo = open(yaml_file, 'w')
fo.write(__copyright_tmp__ % ('Default', date.today().year))
if len(variables) > 0:
fo.write('\n\nvariable:\n')
for line in variables:
fo.write(' ' + line + '\n')
fo.write('\n\ntemplate:\n')
for line in cfgs['Template']:
fo.write(' ' + line + '\n')
fo.write('\n\nconfigs:\n')
for line in cfgs['Option']:
fo.write(' ' + line + '\n')
fo.close()
def get_fsp_name_from_path(bsf_file):
name = ''
parts = bsf_file.split(os.sep)
for part in parts:
if part.endswith('FspBinPkg'):
name = part[:-9]
break
if not name:
raise Exception('Could not get FSP name from file path!')
return name
def usage():
print('\n'.join([
"FspDscBsf2Yaml Version 0.10",
"Usage:",
" FspDscBsf2Yaml BsfFile|DscFile YamlFile"
]))
def main():
#
# Parse the options and args
#
argc = len(sys.argv)
if argc < 3:
usage()
return 1
bsf_file = sys.argv[1]
yaml_file = sys.argv[2]
if os.path.isdir(yaml_file):
yaml_file = os.path.join(
yaml_file, get_fsp_name_from_path(bsf_file) + '.yaml')
if bsf_file.endswith('.dsc'):
dsc_file = bsf_file
bsf_file = ''
else:
dsc_file = os.path.splitext(yaml_file)[0] + '.dsc'
bsf_to_dsc(bsf_file, dsc_file)
dsc_to_yaml(dsc_file, yaml_file)
print("'%s' was created successfully!" % yaml_file)
return 0
if __name__ == '__main__':
sys.exit(main())
|