23 set tcl_path [
file normalize "[
file dirname [
info script]]/.."]
24 source $tcl_path/hog.tcl
28 if {[
info exists env(HOG_TCLLIB_PATH)]} {
29 lappend auto_path $env(HOG_TCLLIB_PATH)
31 puts "ERROR: To run Hog with Microsemi Libero SoC, you need to define the HOG_TCLLIB_PATH variable."
36 if {[
catch {
package require struct::matrix} ERROR]} {
37 puts "$ERROR\n If you are running this script on tclsh, you can fix this by installing 'tcllib'"
44 set project [
file tail $project_name]
45 set old_path [
file normalize "../../Projects/${project_name}/$project.runs/synth_1"]
51 if {[
info exists env(HOG_EXTERNAL_PATH)]} {
52 set ext_path $env(HOG_EXTERNAL_PATH)
53 Msg Info "Found environment variable HOG_EXTERNAL_PATH, setting path for external files to $ext_path..."
61 set proj_file "[get_property DIRECTORY [current_project]]/$project.prr"
63 set proj_file [get_property parent.project_path [current_project]]
65 set proj_dir [
file normalize [
file dirname $proj_file]]
66 set proj_name [
file rootname [
file tail $proj_file]]
69 set proj_name [
lindex $quartus(args) 1]
72 set proj_file [
file normalize "$proj_dir/$proj_name.qpf"]
74 set hogQsysFileName [
file normalize "$proj_dir/.hog/.hogQsys.md5"]
75 if {[
file exists $hogQsysFileName] != 0} {
76 set hogQsysFile [open $hogQsysFileName r]
77 set hogQsysFileLines [
split [read $hogQsysFile] "\n"]
78 foreach line $hogQsysFileLines {
79 set fileEntry [
split $line "\t"]
80 set fileEntryName [
lindex $fileEntry 0]
81 if {$fileEntryName != ""} {
82 if {[
file exists $fileEntryName]} {
83 set newMd5Sum [
Md5Sum $fileEntryName]
84 set oldMd5Sum [
lindex $fileEntry 1]
85 if {$newMd5Sum != $oldMd5Sum} {
86 Msg Warning "The checksum for file $fileEntryName is not equal to the one saved in $hogQsysFileName.\n\
87 New checksum $newMd5Sum, old checksum $oldMd5Sum. \
88 Please check the any changes in the file are correctly propagated to git!"
91 Msg Warning "File $fileEntryName not found... Will not check Md5Sum!"
97 set proj_dir [
file normalize [
file dirname "[project_data -dir]/../.."]]
98 set proj_name [
file tail $proj_dir]
99 set project $proj_name
101 set proj_dir [
file normalize "[
pwd]/.."]
102 set proj_name [
file tail $proj_dir]
103 set project $proj_name
106 set proj_file $old_path/[
file tail $old_path].xpr
107 set proj_dir [
file normalize [
file dirname $proj_file]]
108 set proj_name [
file rootname [
file tail $proj_file]]
109 Msg CriticalWarning "You seem to be running locally on tclsh, so this is a debug message. \
110 The project file will be set to $proj_file and was derived from the path you launched this script from: $old_path. \
111 If you want this script to work properly in debug mode, please launch it from the top folder of one project, \
112 for example Repo/Projects/fpga1/ or Repo/Top/fpga1/"
116 set repo_path [
file normalize "$tcl_path/../.."]
122 set flavour [
string map {. ""} [
file extension $proj_name]]
123 if {$flavour != ""} {
124 if {[
string is integer $flavour]} {
125 Msg Info "Project $proj_name has flavour = $flavour, the generic variable FLAVOUR will be set to $flavour"
127 Msg Warning "Project name has a unexpected non numeric extension, flavour will be set to -1"
138 lassign [
GetRepoVersions [
file normalize $repo_path/Top/$group/$proj_name] $repo_path $ext_path] \
139 commit version hog_hash hog_ver \
142 cons_ver cons_hash ext_names ext_hashes \
143 xml_hash xml_ver user_ip_repos user_ip_hashes user_ip_vers
147 set dst_dir [
file normalize "bin/$group/$proj_name\-$describe"]
148 Msg Info "Creating $dst_dir..."
149 file mkdir $dst_dir/reports
153 set confDict [dict create]
154 set allow_fail_on_conf 0
155 set allow_fail_on_list 0
156 set allow_fail_on_git 0
158 if {[
file exists "$tcl_path/../../Top/$group/$proj_name/hog.conf"]} {
159 set confDict [
ReadConf "$tcl_path/../../Top/$group/$proj_name/hog.conf"]
160 set allow_fail_on_check [
DictGet [
DictGet $confDict "hog"] "ALLOW_FAIL_ON_CHECK" 0]
161 set allow_fail_on_git [
DictGet [
DictGet $confDict "hog"] "ALLOW_FAIL_ON_GIT" 0]
162 set full_diff_log [
DictGet [
DictGet $confDict "hog"] "FULL_DIFF_LOG" 0]
169 Msg Info "Running list file checker..."
171 if {![
string equal ext_path ""]} {
172 set argv [list "-ext_path" "$ext_path" "-project" "$group/$proj_name" "-outDir" "$dst_dir" "-log" "[
expr {!$allow_fail_on_check}]"]
174 set argv [list "-project" "$group/$proj_name" "-outDir" "$dst_dir" "-log" "[
expr {!$allow_fail_on_check}]"]
176 source $tcl_path/utils/check_list_files.tcl
177 if {[
file exists "$dst_dir/diff_list_and_conf.txt"]} {
178 Msg CriticalWarning "Project list or hog.conf mismatch, will use current SHA ($this_commit) and version will be set to 0."
189 Msg Info "Evaluating non committed changes..."
190 set found_uncommitted 0
192 set diff_stat [
Git "diff --stat"]
194 set found_uncommitted 1
195 Msg Warning "Found non committed changes:..."
196 if {$full_diff_log} {
199 Msg Status "$diff_stat"
201 set fp [open "$dst_dir/diff_presynthesis.txt" w+]
204 Msg CriticalWarning "Repository is not clean, will use current SHA ($this_commit) and create a dirty bitfile..."
207 lassign [
GetHogFiles -ext_path "$ext_path" "$tcl_path/../../Top/$group/$proj_name/list/" "$tcl_path/../../"] listLibraries listProperties
209 if {!$allow_fail_on_git} {
210 foreach library [dict keys $listLibraries] {
211 set fileNames [dict get $listLibraries $library]
212 foreach fileName $fileNames {
214 set fp [open "$dst_dir/diff_presynthesis.txt" a+]
215 set found_uncommitted 1
216 puts $fp "\n[
Relative $tcl_path/../../ $fileName] is not in the git repository"
217 Msg CriticalWarning "[
Relative $tcl_path/../../ $fileName] is not in the git repository. \
218 Will use current SHA ($this_commit) and version will be set to 0."
224 if {$found_uncommitted == 0} {
225 Msg Info "No uncommitted changes found."
233 lassign [
GitRet "tag -l v0.0.1"] status result
235 Msg CriticalWarning "Repository does not have an initial v0.0.1 tag yet. Please create it with \"git tag v0.0.1\" "
239 Msg Info "Git describe for $commit is: $describe"
242 set commit $this_commit
244 Msg Info "Found last SHA for $proj_name: $commit"
245 if {$commit != $this_commit} {
246 set count [
Git "rev-list --count $commit..$this_commit"]
247 Msg Info "The commit in which project $proj_name was last modified is $commit, that is $count commits older than current commit $this_commit."
251 if {$xml_hash != ""} {
252 set xml_dst [
file normalize $old_path/../xml]
253 Msg Info "Creating XML directory $xml_dst..."
255 Msg Info "Copying xml files to $xml_dst and replacing placeholders with xml version $xml_ver..."
264 set maxThreads [
GetMaxThreads [
file normalize ./Top/$group/$proj_name/]]
266 if {$maxThreads != 1} {
267 Msg CriticalWarning "Multithreading enabled. Bitfile will not be deterministic. Number of threads: $maxThreads"
269 Msg Info "Disabling multithreading to assure deterministic bitfile"
274 set_param general.maxThreads $maxThreads
277 if {[
catch {
package require ::quartus::project} ERROR]} {
278 Msg Error "$ERROR\n Can not find package ::quartus::project"
284 project_open $proj_name -current_revision
286 set_global_assignment -name NUM_PARALLEL_PROCESSORS $maxThreads
289 set_option -max_parallel_jobs $maxThreads
292 set clock_seconds [
clock seconds]
293 set tt [
clock format $clock_seconds -format {%d/%m/%Y at %H:%M:%S}]
296 set date [
Git "log -1 --format=%cd --date=format:%d%m%Y $commit"]
297 set timee [
Git "log -1 --format=%cd --date=format:00%H%M%S $commit"]
299 Msg Warning "Found Git version older than 2.9.3. Using current date and time instead of commit time."
300 set date [
clock format $clock_seconds -format {%d%m%Y}]
301 set timee [
clock format $clock_seconds -format {00%H%M%S}]
307 set proj_group_and_name "$group/$proj_name"
310 prj_project open $proj_dir/$proj_name.ldf
312 WriteGenerics "synth" $repo_path $proj_group_and_name $date $timee $commit $version \
313 $top_hash $top_ver $hog_hash $hog_ver \
314 $cons_ver $cons_hash $libs $vers \
315 $hashes $ext_names $ext_hashes \
316 $user_ip_repos $user_ip_vers $user_ip_hashes \
317 $flavour $xml_ver $xml_hash
323 set status_file [
file normalize "$old_path/../versions.txt"]
326 if {[
catch {
package require ::quartus::project} ERROR]} {
327 Msg Error "$ERROR\n Can not find package ::quartus::project"
333 project_open $proj_name -current_revision
336 set zero_ttb 00000000
338 binary scan [
binary format H* [
string map {{'} {}} $date]] B32 bits
339 set_parameter -name GLOBAL_DATE $bits
340 binary scan [
binary format H* [
string map {{'} {}} $timee]] B32 bits
341 set_parameter -name GLOBAL_TIME $bits
342 binary scan [
binary format H* [
string map {{'} {}} $version]] B32 bits
343 set_parameter -name GLOBAL_VER $bits
344 binary scan [
binary format H* [
string map {{'} {}} $commit]] B32 bits
345 set_parameter -name GLOBAL_SHA $bits
346 binary scan [
binary format H* [
string map {{'} {}} $top_hash]] B32 bits
347 set_parameter -name TOP_SHA $bits
348 binary scan [
binary format H* [
string map {{'} {}} $top_ver]] B32 bits
349 set_parameter -name TOP_VER $bits
350 binary scan [
binary format H* [
string map {{'} {}} $hog_hash]] B32 bits
351 set_parameter -name HOG_SHA $bits
352 binary scan [
binary format H* [
string map {{'} {}} $hog_ver]] B32 bits
353 set_parameter -name HOG_VER $bits
354 binary scan [
binary format H* [
string map {{'} {}} $cons_ver]] B32 bits
355 set_parameter -name CON_VER $bits
356 binary scan [
binary format H* [
string map {{'} {}} $cons_hash]] B32 bits
357 set_parameter -name CON_SHA $bits
359 if {$use_ipbus == 1} {
360 binary scan [
binary format H* [
string map {{'} {}} $xml_ver]] B32 bits
361 set_parameter -name XML_VER $bits
362 binary scan [
binary format H* [
string map {{'} {}} $xml_hash]] B32 bits
363 set_parameter -name XML_SHA $bits
367 foreach l $libs v $vers h $hashes {
368 binary scan [
binary format H* [
string map {{'} {}} $v]] B32 bits
369 set_parameter -name "[
string toupper $l]_VER" $bits
370 binary scan [
binary format H* [
string map {{'} {}} $h]] B32 bits
371 set_parameter -name "[
string toupper $l]_SHA" $bits
374 foreach e $ext_names h $ext_hashes {
375 binary scan [
binary format H* [
string map {{'} {}} $h]] B32 bits
376 set_parameter -name "[
string toupper $e]_SHA" $bits
379 if {$flavour != -1} {
380 set_parameter -name FLAVOUR $flavour
383 if {![
file exists "$old_path/output_files"]} {
384 file mkdir "$old_path/output_files"
387 set status_file "$old_path/output_files/versions.txt"
391 puts "Hog:DEBUG GLOBAL_DATE=$date GLOBAL_TIME=$timee"
392 puts "Hog:DEBUG GLOBAL_SHA=$commit TOP_SHA=$top_hash"
393 puts "Hog:DEBUG CON_VER=$cons_ver CON_SHA=$cons_hash"
394 puts "Hog:DEBUG XML_SHA=$xml_hash GLOBAL_VER=$version TOP_VER=$top_ver"
395 puts "Hog:DEBUG XML_VER=$xml_ver HOG_SHA=$hog_hash HOG_VER=$hog_ver"
396 puts "Hog:DEBUG LIBS: $libs $vers $hashes"
397 puts "Hog:DEBUG EXT: $ext_names $ext_hashes"
398 puts "Hog:DEBUG FLAVOUR: $flavour"
399 set status_file "$old_path/versions.txt"
401 Msg Info "Opening version file $status_file..."
402 set status_file [open $status_file "w+"]
404 Msg Status " ------------------------- PRE SYNTHESIS -------------------------"
406 Msg Status " Firmware date and time: $date, $timee"
407 if {$flavour != -1} {
408 Msg Status " Project flavour: $flavour"
413 puts $status_file "## $group/$proj_name Version Table\n"
415 puts $status_file "## $proj_name Version Table\n"
421 m add row "| \"**File set**\" | \"**Commit SHA**\" | **Version** |"
422 m add row "| --- | --- | --- |"
423 Msg Status " Global SHA: $commit, VER: $version"
424 m add row "| Global | $commit | $version |"
427 Msg Status " Constraints SHA: $cons_hash, VER: $cons_ver"
428 m add row "| Constraints | $cons_hash | $cons_ver |"
430 if {$use_ipbus == 1} {
432 Msg Status " IPbus XML SHA: $xml_hash, VER: $xml_ver"
433 m add row "| \"IPbus XML\" | $xml_hash | $xml_ver |"
436 Msg Status " Top SHA: $top_hash, VER: $top_ver"
437 m add row "| \"Top Directory\" | $top_hash | $top_ver |"
440 Msg Status " Hog SHA: $hog_hash, VER: $hog_ver"
441 m add row "| Hog | $hog_hash | $hog_ver |"
443 Msg Status " --- Libraries ---"
444 foreach l $libs v $vers h $hashes {
446 Msg Status " $l SHA: $h, VER: $v"
447 m add row "| \"**Lib:** $l\" | $h | $v |"
450 if {[
llength $user_ip_repos] > 0} {
451 Msg Status " --- User IP Repositories ---"
452 foreach r $user_ip_repos v $user_ip_vers h $user_ip_hashes {
454 set repo_name [
file tail $r]
455 Msg Status " $repo_name SHA: $h, VER: $v"
456 m add row "| \"**Repo:** $repo_name\" | $h | $v |"
460 if {[
llength $ext_names] > 0} {
461 Msg Status " --- External Libraries ---"
462 foreach e $ext_names eh $ext_hashes {
463 Msg Status " $e SHA: $eh"
464 m add row "| \"**Ext:** $e\" | $eh | \" \" |"
468 Msg Status " -----------------------------------------------------------------"
470 puts $status_file [m format 2string]
471 puts $status_file "\n\n"
478 set user_pre_synthesis_file "./Top/$group/$proj_name/pre-synthesis.tcl"
479 if {[
file exists $user_pre_synthesis_file]} {
480 Msg Info "Sourcing user pre-synthesis file $user_pre_synthesis_file"
481 source $user_pre_synthesis_file