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
|
#
# Copyright 2022 Ettus Research, a National Instruments Company
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
""" Vivado IP sub-core re-targeting.
Script to update the sub-cores in a directory to a specific
part number
"""
import argparse
import os
import re
import sys
# Parse command line options
def get_options():
"""Parse script arguments."""
parser = argparse.ArgumentParser(
description="Utility script to modify subcores for a Xilinx IP XCI file"
)
parser.add_argument(
"xci_filepath", type=str, default=None, help="Name for the IP core"
)
parser.add_argument(
"--target",
type=str,
default=None,
help="Input value for target. Must be of the form <arch>/<device>/<package>/<speedgrade>/<silicon revision>",
)
parser.add_argument(
"--name", type=str, default=None, help="Input value for new IP name"
)
parser.add_argument(
"--output_dir", type=str, default=".", help="Build directory for IP"
)
args = parser.parse_args()
if not args.xci_filepath:
print("ERROR: Please specify the location for the XCI file to operate on\n")
parser.print_help()
sys.exit(1)
if not os.path.isfile(args.xci_filepath):
print(
"ERROR: XCI File "
+ args.xci_filepath
+ " could not be accessed or is not a file.\n"
)
parser.print_help()
sys.exit(1)
return args
def get_match_str(item):
"""Produce the string to an XML parameter with a value."""
return (
r'(.*\<spirit:configurableElementValue spirit:referenceId=".*\.'
+ item
+ r'"\>)(.+)(\</spirit:configurableElementValue\>)'
)
def get_empty_match_str(item):
"""Produce the string to an XML parameter without a value."""
return (
r'(.*\<spirit:configurableElementValue spirit:referenceId=".*\.'
+ item
+ r'")/\>'
)
def retarget_subcore(path, file, output_dir, target_tok):
"""Update target parameter for the specified sub-core."""
# Read XCI File
with open(os.path.join(path, file)) as in_file:
xci_lines = in_file.readlines()
replace_dict = {
"ARCHITECTURE": target_tok[0],
"DEVICE": target_tok[1],
"PACKAGE": target_tok[2],
"SPEEDGRADE": target_tok[3],
"C_XDEVICEFAMILY": target_tok[0],
"C_FAMILY": target_tok[0],
"C_XDEVICE": target_tok[1],
}
if len(target_tok) > 4:
replace_dict["TEMPERATURE_GRADE"] = target_tok[4]
if len(target_tok) > 5:
replace_dict["SILICON_REVISION"] = target_tok[5]
out_xci_filename = os.path.join(os.path.abspath(output_dir), os.path.basename(file))
# Write files with modified parameters
with open(out_xci_filename, "w") as out_file:
for r_line in xci_lines:
w_line = r_line
m = re.search(
get_match_str("(" + "|".join(list(replace_dict.keys())) + ")"), r_line
)
if m is not None:
w_line = m.group(1) + replace_dict[m.group(2)] + m.group(4) + "\n"
else:
m = re.search(
get_empty_match_str(
"(" + "|".join(list(replace_dict.keys())) + ")"
),
r_line,
)
if m is not None:
w_line = (
m.group(1)
+ ">"
+ replace_dict[m.group(2)]
+ "</spirit:configurableElementValue>\n"
)
out_file.write(w_line)
def main():
"""Perform directory traversal to detect and update sub-cores."""
args = get_options()
# Validate arguments
if not os.path.isdir(args.output_dir):
print(
"ERROR: IP Build directory "
+ args.output_dir
+ " could not be accessed or is not a directory."
)
sys.exit(1)
if not args.target:
print("ERROR: No target specified.")
sys.exit(1)
target_tok = args.target.split("/")
if len(target_tok) < 4:
print(
"ERROR: Invalid target format. Must be <arch>/<device>/<package>/<speedgrade>/<tempgrade>/<silicon revision>"
)
sys.exit(1)
sub_cores = []
# Detect sub-cores
ip_dir, ip_name = os.path.split(args.xci_filepath)
for path, _, files in os.walk(ip_dir):
for name in files:
if name.endswith("xci"):
sub_cores.append(os.path.join(path, name))
# Get the relative path for each IP core detected
relative_paths = [os.path.relpath(path, ip_dir) for path in sub_cores]
# Remove main core
relative_paths.remove(ip_name)
for rp in relative_paths:
retarget_subcore(
os.path.join(ip_dir, os.path.split(rp)[0]),
os.path.split(rp)[1],
os.path.join(args.output_dir, os.path.split(rp)[0]),
target_tok,
)
if __name__ == "__main__":
main()
|
