v2.4.0

Pull Requests Since v2.3.0

Enhancement

1. #174 - Support central scripts for release notes and release generation

Unlabeled

1. #177 - Release Candidate v2.4.0
2. #176 - Adding a system_vcs.mk script
3. #175 - Adding VCS Q-2020.03 and removing buggy P-2019.06

Pull Request Details

Support central scripts for release notes and release generation

Author:	Ryan Herbst [email protected]
Date:	Tue Mar 31 10:18:57 2020 -0700
Pull:	#174 (264 additions, 222 deletions, 7 files changed)
Branch:	slaclab/new_release
Labels:	enhancement

Notes:

This moves two scripts to the scripts directory in ruckus. These scripts can be used to generate a release in response to a created tag. I have tested this with rogue.

https://github.com/slaclab/rogue/blob/8d3f48570395071fc61e4183ee8acfd87217f0c6/.travis.yml#L126-L132

---

Adding VCS Q-2020.03 and removing buggy P-2019.06

Author:	Larry Ruckman [email protected]
Date:	Fri Apr 3 09:11:02 2020 -0700
Pull:	#175 (1 additions, 2 deletions, 1 files changed)
Branch:	slaclab/vcs-2020

Notes:

---

Adding a system_vcs.mk script

Author:	Larry Ruckman [email protected]
Date:	Mon Apr 13 11:56:18 2020 -0700
Pull:	#176 (132 additions, 0 deletions, 1 files changed)
Branch:	slaclab/system_vcs

Notes:

---

Release Candidate v2.4.0

Author:	Larry Ruckman [email protected]
Date:	Mon Apr 13 13:33:40 2020 -0700
Pull:	#177 (397 additions, 224 deletions, 9 files changed)
Branch:	slaclab/pre-release
Issues:	#174, #175, #176

Notes:

Description

• Support central scripts for release notes and release generation #174
• Adding VCS Q-2020.03 and removing buggy P-2019.06 #175
• Adding a system_vcs.mk script #176

---

Minor Release

Pull Requests

1. #171 - Allow user to store github token in their environment
2. #172 - Add Pull Request Labels Release Notes

Pull Request Details

Allow user to store github token in their environment

Author:	Larry Ruckman [email protected]
Date:	Mon Mar 9 13:25:58 2020 -0700
Pull:	#171 (24 additions, 6 deletions, 2 files changed)
Branch:	slaclab/gh_token

Notes:

---

Add Pull Request Labels Release Notes

Author:	Larry Ruckman [email protected]
Date:	Tue Mar 17 07:57:12 2020 -0700
Pull:	#172 (8 additions, 1 deletions, 1 files changed)
Branch:	slaclab/labels

Notes:

This PR will add pull request labels to the release notes headers. The labels will allow the release notes to indicate if the PR was a new feature or bug request.

---

Patch Release

Pull Requests

1. #168 - removing whitespaces in source code
2. #167 - moving the vivado/project.tcl into vivado/sources.tcl
3. #165 - releaseGen.py Updates
4. #166 - Release script tweaks
5. #170 - Bug fix work around for Vivado thinking impl_1 not up-to-date

Pull Request Details

removing whitespaces in source code

Author:	Larry Ruckman [email protected]
Date:	Thu Feb 27 08:33:08 2020 -0800
Pull:	#168 (703 additions, 703 deletions, 42 files changed)
Branch:	slaclab/whitespace

Notes:

Description

• removing whitespaces in source code

---

moving the vivado/project.tcl into vivado/sources.tcl

Author:	Larry Ruckman [email protected]
Date:	Wed Feb 26 11:49:10 2020 -0800
Pull:	#167 (27 additions, 37 deletions, 3 files changed)
Branch:	slaclab/sdk-dev

Notes:

Description

• moving the vivado/project.tcl into vivado/sources.tcl

---

releaseGen.py Updates

Author:	Larry Ruckman [email protected]
Date:	Thu Feb 20 19:29:43 2020 -0800
Pull:	#165 (19 additions, 6 deletions, 2 files changed)
Branch:	slaclab/release-gz

Notes:

Description

• enabling GZIP build images by default
• check if .gz image file exists
  • If exists, then use it instead for the rogue_XXX.zip
• force the extension to be exact
  • Previously only declaring .mcs would grab both .mcs and the .mcs.gz
  • $ indicates "end of the string"
• prevent file duplication writes in the zipFile
  • Example: declaring both .mcs and mcs.gz in the releases.yaml

---

Release script tweaks

Author:	Larry Ruckman [email protected]
Date:	Thu Feb 20 19:30:12 2020 -0800
Pull:	#166 (17 additions, 7 deletions, 2 files changed)
Branch:	slaclab/release-tweaks

Notes:

In releaseGen.py, the tag message is now like this:

Major Release vX.0.0
Minor Release vX.Y.0
Patch Release vX.Y.Z

The releaseNotes.py script has also been tweaked to omit any "Release Candidate" PRs from the generated release notes, as these are unnecessary to include.

---

Bug fix work around for Vivado thinking impl_1 not up-to-date

Author:	Larry Ruckman [email protected]
Date:	Thu Feb 27 14:03:00 2020 -0800
Pull:	#170 (9 additions, 0 deletions, 1 files changed)
Branch:	slaclab/ruckman-dev

Notes:

Description

• Related to changing of the bitstream post script when opening the GUI

---

Minor Release

Pull Requests

1. #162 - v2.2.0 release candidate
2. #159 - Add support for script install and conda dependencies
3. #160 - Release Script Updates
4. #164 - Support primary releases
5. #158 - resolve bug where syth_1/impl_1 design reset after batch build
6. #156 - Release Gen Updates
7. #155 - adding user post-build script call
8. #161 - zipimport does not support compression
9. #157 - setting multi-drive pin to ERROR
10. #163 - removing image commit message

Pull Request Details

v2.2.0 release candidate

Author:	Larry Ruckman [email protected]
Date:	Tue Feb 18 10:45:47 2020 -0800
Pull:	#162 (167 additions, 103 deletions, 7 files changed)
Branch:	slaclab/pre-release

Notes:

Description

• Release Gen Updates #156
• adding user post-build script call #155
• setting multi-drive pin to ERROR #157
• resolve bug where syth_1/impl_1 design reset after batch build #158
• Add support for script install and conda dependencies #159
• Release Script Updates #160
• zipimport does not support compression #161
• removing image commit message #163
• Support primary releases #164

---

Add support for script install and conda dependencies

Author:	Larry Ruckman [email protected]
Date:	Wed Feb 12 08:26:48 2020 -0800
Pull:	#159 (111 additions, 66 deletions, 1 files changed)
Branch:	slaclab/add_scripts

Notes:

This PR updates the releaseGen script with the following changes:

1. Allow scripts to be installed
2. Allow user to define conda dependencies
3. Suggest user can enter no value for compare version

This includes some changes in the script structure to cleanup the code.

---

Release Script Updates

Author:	Larry Ruckman [email protected]
Date:	Wed Feb 12 11:05:04 2020 -0800
Pull:	#160 (34 additions, 17 deletions, 2 files changed)
Branch:	slaclab/release-script-llr-dev

Notes:

Description

• adding RELEASE_DIR variable
• make PROJECT variable agnostic to string structure
  • Example: Supports export PROJECT=ClinkFebPgp3_1ch target name
• adding support for repo level release

---

Support primary releases

Author:	Larry Ruckman [email protected]
Date:	Thu Feb 13 09:40:23 2020 -0800
Pull:	#164 (19 additions, 11 deletions, 1 files changed)
Branch:	slaclab/prim_release

Notes:

This allows the release to have a Primary flag which will not pre-pend the release tag with the release name. This is useful for single release repositories.

Releases:
axi_pcie_devel:
Primary: True
Targets:
- InterCardTest
- RateTestKcu1500
Types:
- Rogue

This PR also adds an error check to ensure the release name does not contain dashes.

---

resolve bug where syth_1/impl_1 design reset after batch build

Author:	Larry Ruckman [email protected]
Date:	Tue Feb 11 14:22:32 2020 -0800
Pull:	#158 (1 additions, 12 deletions, 3 files changed)
Branch:	slaclab/ESCORE-534
Jira:	https://jira.slac.stanford.edu/issues/ESCORE-534

Notes:

Description

• Resolves bug when you do "make bit" then "make gui" and the results of synth_1/impl_1 are lost when the GUI pops up

---

Release Gen Updates

Author:	Larry Ruckman [email protected]
Date:	Tue Feb 11 09:40:25 2020 -0800
Pull:	#156 (3 additions, 3 deletions, 2 files changed)
Branch:	slaclab/ESCORE-538
Jira:	https://jira.slac.stanford.edu/issues/ESCORE-538

Notes:

Description

• adding BZIP2 compression to the release ZIP file
• releaseGen.py depends on the ~/firmware/build/VivadoProject dir

Compression Example

• v1.0.0 is with original code (no compression)
• v2.0.0 is with BZIP2 compression

$ ls -lath /u1/ruckman/build/SmurfKcu1500RssiOffload10GbE/rogue*
-rw-r--r-- 1 ruckman re 103M Feb 11 09:33 /u1/ruckman/build/SmurfKcu1500RssiOffload10GbE/rogue_SmurfKcu1500RssiOffload10GbE_v1.0.0.zip
-rw-r--r-- 1 ruckman re  31M Feb 11 09:33 /u1/ruckman/build/SmurfKcu1500RssiOffload10GbE/rogue_SmurfKcu1500RssiOffload10GbE_v2.0.0.zip

---

adding user post-build script call

Author:	Larry Ruckman [email protected]
Date:	Mon Feb 10 13:35:31 2020 -0800
Pull:	#155 (5 additions, 0 deletions, 1 files changed)
Branch:	slaclab/post-build-script

Notes:

Description

• adding user post-build script call

---

zipimport does not support compression

Author:	Larry Ruckman [email protected]
Date:	Wed Feb 12 14:04:24 2020 -0800
Pull:	#161 (2 additions, 1 deletions, 1 files changed)
Branch:	slaclab/revert_zip_change

Notes:

Description

https://bugs.python.org/issue21751

---

setting multi-drive pin to ERROR

Author:	Larry Ruckman [email protected]
Date:	Tue Feb 11 13:32:33 2020 -0800
Pull:	#157 (2 additions, 1 deletions, 1 files changed)
Branch:	slaclab/messages-patch

Notes:

Description

• setting multi-drive pin to ERROR

---

removing image commit message

Author:	Larry Ruckman [email protected]
Date:	Thu Feb 13 08:59:21 2020 -0800
Pull:	#163 (0 additions, 2 deletions, 1 files changed)
Branch:	slaclab/remove-image-commit-msg

Notes:

Description

• Images should be attached to release tags and not committed directly now

---

Patch Release

Pull Requests

1. #154 - v2.1.2 release candidate
2. #153 - Replace username/password with git token

Pull Request Details

v2.1.2 release candidate

Author:	Larry Ruckman [email protected]
Date:	Thu Feb 6 15:13:47 2020 -0800
Pull:	#154 (11 additions, 20 deletions, 1 files changed)
Branch:	slaclab/pre-release

Notes:

Description

• Replace username/password with git token #153

---

Replace username/password with git token

Author:	Larry Ruckman [email protected]
Date:	Thu Jan 30 13:03:47 2020 -0800
Pull:	#153 (11 additions, 20 deletions, 1 files changed)
Branch:	slaclab/git_tokens

Notes:

This replaces the username/password prompt with a prompt for your git token in the releaseGen.py script.

---

Patch Release

Pull Requests

1. #152 - v2.1.1 release candidate
2. #149 - only set VHDL lib property to VHDL files in loadSource()
3. #150 - releaseGen.py needs to be called with python3
4. #151 - Clarify the path of the generated zipfile

Pull Request Details

v2.1.1 release candidate

Author:	Larry Ruckman [email protected]
Date:	Wed Jan 29 15:32:20 2020 -0800
Pull:	#152 (14 additions, 5 deletions, 3 files changed)
Branch:	slaclab/pre-release

Notes:

Description

• only set VHDL lib property to VHDL files in loadSource() #149
• releaseGen.py needs to be called with python3 #150
• Clarify the path of the generated zipfile #151

---

only set VHDL lib property to VHDL files in loadSource()

Author:	Larry Ruckman [email protected]
Date:	Mon Jan 27 08:36:06 2020 -0800
Pull:	#149 (11 additions, 2 deletions, 1 files changed)
Branch:	slaclab/ESCORE-524
Jira:	https://jira.slac.stanford.edu/issues/ESCORE-524

Notes:

Description

• This will remove these types of warnings ...

WARNING: [filemgmt 56-99] Vivado Synthesis ignores library specification for Verilog or SystemVerilog files.

---

releaseGen.py needs to be called with python3

Author:	Ryan Herbst [email protected]
Date:	Wed Jan 29 13:07:15 2020 -0800
Pull:	#150 (2 additions, 2 deletions, 1 files changed)
Branch:	slaclab/ESLCOMMON-264
Jira:	https://jira.slac.stanford.edu/issues/ESLCOMMON-264

Notes:

https://jira.slac.stanford.edu/browse/ESLCOMMON-264

---

Clarify the path of the generated zipfile

Author:	Ryan Herbst [email protected]
Date:	Wed Jan 29 14:12:37 2020 -0800
Pull:	#151 (1 additions, 1 deletions, 1 files changed)
Branch:	slaclab/full_path

Notes:

---

Patch Release

Pull Requests

1. #148 - v2.1.0 release candidate
2. #142 - Update releaseGen & releaseNotes
3. #144 - Add conda build files as well as LICENSE.txt to zipfile.
4. #147 - MicroblazeBasicCore Development Updates
5. #138 - bug fix for MicroblazeBasicCore/sdk & MicroblazeBasicCore/vitis
6. #140 - sub-type filename update
7. #146 - vivado/messages.tcl updates
8. #145 - bug fix when vitis not in $PATH
9. #141 - Updating the Rogue zip
10. #139 - Pyrogue Update

Pull Request Details

v2.1.0 release candidate

Author:	Larry Ruckman [email protected]
Date:	Fri Jan 24 15:46:53 2020 -0800
Pull:	#148 (209 additions, 94 deletions, 14 files changed)
Branch:	slaclab/pre-release

Notes:

Description

• bug fix for MicroblazeBasicCore/sdk & MicroblazeBasicCore/vitis #138
• Pyrogue Update #139
• sub-type filename update #140
• Updating the Rogue zip #141
• Update releaseGen & releaseNotes #142
• bug fix when vitis not in $PATH #145
• vivado/messages.tcl updates #146
• Add conda build files as well as LICENSE.txt to zipfile. #144
• MicroblazeBasicCore Development Updates #147

---

Update releaseGen & releaseNotes

Author:	Larry Ruckman [email protected]
Date:	Wed Jan 22 08:25:45 2020 -0800
Pull:	#142 (92 additions, 57 deletions, 4 files changed)
Branch:	slaclab/update_release

Notes:

Updates releaseGen script to format zip files correctly as well as dealing with the proper names for images.

---

Add conda build files as well as LICENSE.txt to zipfile.

Author:	Larry Ruckman [email protected]
Date:	Fri Jan 24 10:58:47 2020 -0800
Pull:	#144 (65 additions, 3 deletions, 1 files changed)
Branch:	slaclab/update_release

Notes:

---

MicroblazeBasicCore Development Updates

Author:	Larry Ruckman [email protected]
Date:	Fri Jan 24 15:45:15 2020 -0800
Pull:	#147 (23 additions, 6 deletions, 5 files changed)
Branch:	slaclab/MicroblazeBasicCore-update

Notes:

Description

• EMBED_PROC helps with the situation when both MicroblazeBasicCore.vhd and a Ultrascale MIG core is used and vivado rename the MicroblazeBasicCore.vhd's proc from microblaze_0 to U_CORE_U_CPU_U_Microblaze_microblaze_0
  • Elimate the requirement for a custom user script build and simply defined EMBED_PROC in Makefile instead

---

bug fix for MicroblazeBasicCore/sdk & MicroblazeBasicCore/vitis

Author:	Larry Ruckman [email protected]
Date:	Mon Jan 13 12:46:10 2020 -0800
Pull:	#138 (8 additions, 8 deletions, 6 files changed)
Branch:	slaclab/MicroblazeBasicCore

Notes:

---

sub-type filename update

Author:	Larry Ruckman [email protected]
Date:	Thu Jan 16 14:07:47 2020 -0800
Pull:	#140 (7 additions, 7 deletions, 2 files changed)
Branch:	slaclab/sub-type-patch

Notes:

Description

• updating naming convention to always use _ before a sub-type

---

vivado/messages.tcl updates

Author:	Larry Ruckman [email protected]
Date:	Fri Jan 24 10:33:02 2020 -0800
Pull:	#146 (6 additions, 5 deletions, 1 files changed)
Branch:	slaclab/Duplicate-files

Notes:

Description

• Changed filemgmt 20-1318 (Duplicate files) from critical warning (original warning) to error
• Changed Synth 8-5835 (BRAM overutilized) from warning to error

---

bug fix when vitis not in $PATH

Author:	Larry Ruckman [email protected]
Date:	Fri Jan 24 08:34:15 2020 -0800
Pull:	#145 (4 additions, 6 deletions, 1 files changed)
Branch:	slaclab/vitis-patch

Notes:

Description

bug fix when vitis not in $PATH

---

Updating the Rogue zip

Author:	Larry Ruckman [email protected]
Date:	Mon Jan 20 11:28:20 2020 -0800
Pull:	#141 (4 additions, 2 deletions, 1 files changed)
Branch:	slaclab/rogue-zip

Notes:

Description

• no longer ${PyRogueDirName} directory after uncompression

---

Pyrogue Update

Author:	Larry Ruckman [email protected]
Date:	Wed Jan 15 13:33:09 2020 -0800
Pull:	#139 (1 additions, 1 deletions, 1 files changed)
Branch:	slaclab/pyrogue

Notes:

Description

• For auto-build generation, instead of checking if ${PROJ_DIR}/python exists use if ::env(GEN_PYROGUE_ZIP) exist
• Requires defining GEN_PYROGUE_ZIP in Makefile

---

Patch Release

Pull Requests

1. #137 - v2.0.4 release candidate
2. #135 - Reorg vivado
3. #133 - Adding Vitis support to MicroblazeBasicCore
4. #136 - restoring vivado/pyrogue.tcl
5. #134 - Reorg vivado hls

Pull Request Details

v2.0.4 release candidate

Author:	Larry Ruckman [email protected]
Date:	Fri Jan 10 12:54:09 2020 -0800
Pull:	#137 (2258 additions, 1869 deletions, 43 files changed)
Branch:	slaclab/pre-release

Notes:

Description

• Adding Vitis support to MicroblazeBasicCore #133
• Reorg vivado hls #134
• Reorg vivado #135
• restoring vivado/pyrogue.tcl #136
• Update LICENSE.txt

---

Reorg vivado

Author:	Larry Ruckman [email protected]
Date:	Thu Dec 12 10:54:08 2019 -0800
Pull:	#135 (1766 additions, 1765 deletions, 25 files changed)
Branch:	slaclab/reorg-vivado

Notes:

Description

• Reorganzied the vivado_*.tcl files to a vivado/ directory

---

Adding Vitis support to MicroblazeBasicCore

Author:	Larry Ruckman [email protected]
Date:	Thu Dec 12 09:53:01 2019 -0800
Pull:	#133 (332 additions, 74 deletions, 12 files changed)
Branch:	slaclab/microblaze-vitis

Notes:

Description

• Backwards compatible with existing legacy SDK code and env variables
• Minor reorg of tcl files

---

restoring vivado/pyrogue.tcl

Author:	Larry Ruckman [email protected]
Date:	Fri Jan 10 12:51:58 2020 -0800
Pull:	#136 (130 additions, 0 deletions, 4 files changed)
Branch:	slaclab/ESCRYODET-538
Jira:	https://jira.slac.stanford.edu/issues/ESCRYODET-538

Notes:

Description

• restoring vivado/pyrogue.tcl as stop gap measure until releaseGen.py development is completed (including example + minimal documentation)

---

Reorg vivado hls

Author:	Larry Ruckman [email protected]
Date:	Thu Dec 12 10:11:04 2019 -0800
Pull:	#134 (31 additions, 31 deletions, 9 files changed)
Branch:	slaclab/reorg-vivado-hls

Notes:

Description

• Reorganzied the vivado_hls_*.tcl files to a vivado/hls/ directory
• Moved moving write_vhd_synth_stub_parser.py to vivado dir

---

Patch Release

Pull Requests

1. #132 - v2.0.3 release candidate
2. #130 - TCL support for loadBlockDesign & CopyBdCores
3. #131 - Batch mode

Pull Request Details

v2.0.3 release candidate

Author:	Larry Ruckman [email protected]
Date:	Tue Dec 10 10:55:25 2019 -0800
Pull:	#132 (118 additions, 99 deletions, 6 files changed)
Branch:	slaclab/pre-release

Notes:

Description

• TCL support for loadBlockDesign & CopyBdCores #130
• Batch mode #131

---

TCL support for loadBlockDesign & CopyBdCores

Author:	Larry Ruckman [email protected]
Date:	Fri Dec 6 08:14:49 2019 -0800
Pull:	#130 (76 additions, 92 deletions, 1 files changed)
Branch:	slaclab/ESCORE-500
Jira:	https://jira.slac.stanford.edu/issues/ESCORE-500

Notes:

Description

• adding .TCL file support to loadBlockDesign()
  • Example: loadBlockDesign -path "$::DIR_PATH/bd/2018.3/MicroblazeBasicCore.tcl"
• adding createTcl support to CopyBdCores
• combining CopyBdCores and CopyBdCoresDebug together
• combining CopyIpCores and CopyIpCoresDebug together

Why TCL support for loadBlockDesign()

• .bd is a bit annoying - it contains the graphical placement info, etc. that's not so useful.
• Hard to edit in a text editor
• TCL is easy to modify. (Example: change data bus 32->128bits) without opening Vivado GUI

JIRA

ESCORE-500

---

Batch mode

Author:	Larry Ruckman [email protected]
Date:	Tue Dec 10 10:52:06 2019 -0800
Pull:	#131 (42 additions, 7 deletions, 5 files changed)
Branch:	slaclab/batch-mode

Notes:

Description

• adding 'batch' Makefile target
• some code header clean up

---

Patch Release

Pull Requests

1. #129 - v2.0.2 release candidate
2. #128 - Vivado HLS build System Updates
3. #125 - Fix version dependent Vivado multi-threading count for general.maxThreads
4. #126 - formating CreateDcpVhoFiles to component declaration template

Pull Request Details

v2.0.2 release candidate

Author:	Larry Ruckman [email protected]
Date:	Wed Dec 4 12:28:35 2019 -0800
Pull:	#129 (91 additions, 19 deletions, 8 files changed)
Branch:	slaclab/pre-release

Notes:

Description

• Fix version dependent Vivado multi-threading count for general.maxThreads #125
• formating CreateDcpVhoFiles to component declaration template #126
• updating Vivado version check to 2019.2.0
  • Legacy SDK + Microblaze currently not working with 2019.2 because SDK removed and replaced by Vitis
• Vivado HLS build System Updates #128

---

Vivado HLS build System Updates

Author:	Larry Ruckman [email protected]
Date:	Wed Dec 4 11:11:23 2019 -0800
Pull:	#128 (58 additions, 10 deletions, 5 files changed)
Branch:	slaclab/hls-dev

Notes:

Description

• updating default HLS_SIM_TOOL from vcs to xsim
• catching errors in the csim_design, csynth_design and cosim_design

---

Fix version dependent Vivado multi-threading count for general.maxThreads

Author:	Larry Ruckman [email protected]
Date:	Tue Dec 3 08:33:25 2019 -0800
Pull:	#125 (15 additions, 2 deletions, 1 files changed)
Branch:	asvetek/master

Notes:

Description

• Up to Vivado 2018.2, general.maxThreads was limited to 8 and from 2018.3 onwards the limit increased to 32.
• Default and max thread count values can be collected with "report_param" TCL command

---

formating CreateDcpVhoFiles to component declaration template

Author:	Larry Ruckman [email protected]
Date:	Tue Dec 3 14:47:25 2019 -0800
Pull:	#126 (12 additions, 1 deletions, 1 files changed)
Branch:	slaclab/CreateDcpVhoFiles-update

Notes:

Description

• formatting CreateDcpVhoFiles to component declaration template

---