2024.2 release -

Add US+ GTY IBERT example design and notebook Enhanced logging to handle additional logging domains Move example designs and jupyter notebooks out of pypi wheel to reduce file size Switch device program log to use hw_server service Add slr_index option to get_plm_log Add --force-reset option to device program Fix problems found in device program done and progress callbacks Add optional delay prior to create_session device scan to help initialization on slower systems Fix comparison case mismatch when jtag arch_name is missing from jtag node properties Upgrade required antlr dependency to 4.13.1 from 4.10 Add missing YK Scan documentation Miscellaneous FAQ and documentation updates Host examples on github not pypi
Xilinx · Nov 21, 2024 · 9b0ef5b · 9b0ef5b
1 parent 1ba3270
commit 9b0ef5b
Show file tree

Hide file tree

Showing 175 changed files with 37,051 additions and 23,148 deletions.
diff --git a/FAQ.md b/FAQ.md
@@ -139,3 +139,9 @@ Option 2: Install Microsoft Build Tools as described in the error message. This
 http://visualstudio.microsoft.com/visual-cpp-build-tools/
 
 ---
+
+**Q:** On Windows, how do I fix the path length error  `OSError: [WinError 206] The filename or extension is too long`?
+
+**A:**
+See section `4.1.2. Removing the MAX_PATH Limitation` of the [Python documentation](https://docs.python.org/3/using/windows.html#removing-the-max-path-limitation). It describes how to
+fix the path length issue by changing a registry setting.
diff --git a/LICENSE b/LICENSE
@@ -1,4 +1,5 @@
-Copyright 2021 Xilinx, Inc.
+Copyright (C) 2021-2022, Xilinx, Inc.
+Copyright (C) 2022-2024, Advanced Micro Devices, Inc.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

diff --git a/README.md b/README.md
@@ -4,43 +4,57 @@
 
 ![](https://raw.githubusercontent.com/Xilinx/chipscopy/master/docs/images/chipscopy_logo_head_right_transparent_background.png)
 
-ChipScoPy is an open-source project from Xilinx® that enables high-level control of Versal debug IP running in hardware.
+ChipScoPy is an open-source project from AMD that enables high-level control of Versal debug IP running in hardware.
 Using a simple Python API, developers can control and communicate with ChipScope® debug IP such as the Integrated Logic
 Analyzer (ILA), Virtual IO (VIO), device memory access, and more.
 
 ChipScoPy communicates with Versal devices. It does not work with older devices such as Ultrascale+ and 7-Series devices.
 
 **We recommend using Python 3.8, 3.9, 3.10, or 3.11 with ChipScoPy.**
 
--------------------------------------------------------------------------------
 
 ![](https://raw.githubusercontent.com/Xilinx/chipscopy/master/docs/images/chipscopy_overview.png)
 
--------------------------------------------------------------------------------
+## Quick Links
 
-[ChipScoPy Overview](https://xilinx.github.io/chipscopy/2024.1/overview.html)
+[ChipScoPy Overview](https://xilinx.github.io/chipscopy/2024.2/overview.html)
 
--------------------------------------------------------------------------------
+[System Requirements](https://xilinx.github.io/chipscopy/2024.2/system_requirements.html)
 
-[System Requirements](https://xilinx.github.io/chipscopy/2024.1/system_requirements.html)
+[ChipScoPy Installation](https://xilinx.github.io/chipscopy/2024.2/chipscopy_installation.html)
 
--------------------------------------------------------------------------------
+[ChipScoPy Examples](https://github.com/Xilinx/chipscopy/tree/master/chipscopy/examples)
 
-[ChipScoPy Installation](https://xilinx.github.io/chipscopy/2024.1/chipscopy_installation.html)
+[FAQ](https://github.com/Xilinx/chipscopy/blob/master/FAQ.md)
 
--------------------------------------------------------------------------------
+[API Documentation](https://xilinx.github.io/chipscopy/)
 
-[ChipScoPy Examples](https://github.com/Xilinx/chipscopy/tree/master/chipscopy/examples)
 
--------------------------------------------------------------------------------
+## **ChipScoPy Installation PyPI Package Dependencies**
 
-[FAQ](https://github.com/Xilinx/chipscopy/blob/master/FAQ.md)
+During ChipScoPy installation, the following packages (and any dependencies) are installed from the Python Package Index (PyPI) using pip.
 
--------------------------------------------------------------------------------
+| Package                                                                     |  License   |
+| :----------------------------------------------                             |  :------:  |
+| [Requests](https://pypi.org/project/requests/)                              | Apache-2.0 |
+| [more-itertools](https://pypi.org/project/more-itertools/)                  |    MIT     |
+| [typing_extensions](https://pypi.org/project/typing-extensions/)            |    PSF     |
+| [loguru](https://pypi.org/project/loguru/)                                  |    MIT     |
+| [importlib_metadata](https://pypi.org/project/importlib-metadata/)          | Apache-2.0 |
+| [rich](https://pypi.org/project/rich/)                                      |    MIT     |
+| [Click](https://pypi.org/project/click/)                                    |    BSD     |
+| [antlr4-python3-runtime](https://pypi.org/project/antlr4-python3-runtime/)  |    BSD     |
+| [kaleido](https://pypi.org/project/kaleido/)                                |    MIT     |
+| [plotly](https://pypi.org/project/plotly/)                                  |    MIT     |
+| [notebook](https://pypi.org/project/notebook/)                              |    BSD     |
+| [ipywidgets](https://pypi.org/project/ipywidgets/)                          |    BSD     |
+| [pandas](https://pypi.org/project/pandas/)                                  |    BSD     |
+| [matplotlib](https://pypi.org/project/matplotlib/)                          |    PSF     |
+| [PyQt5](https://pypi.org/project/PyQt5/)                                    |    GPL     |
+| [ipympl](https://pypi.org/project/ipympl/)                                  |    BSD     |
 
-[API Documentation](https://xilinx.github.io/chipscopy/)
 
--------------------------------------------------------------------------------
+#
 
 Copyright (C) 2021-2022, Xilinx, Inc.
 

diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md
@@ -1,5 +1,23 @@
 # ChipScoPy Release Notes
 
+## 2024.2 - Release November 22, 2024
+      
+- 2024.2.1732227392   
+- Add US+ GTY IBERT example design and notebook
+- Enhanced logging to handle additional logging domains
+- Move example designs and jupyter notebooks out of pypi wheel to reduce file size
+- Switch device program log to use hw_server service
+- Add slr_index option to get_plm_log
+- Add --force-reset option to device program
+- Fix problems found in device program done and progress callbacks
+- Add optional delay prior to create_session device scan to help initialization on slower systems
+- Fix comparison case mismatch when jtag arch_name is missing from jtag node properties
+- Upgrade required antlr dependency to 4.13.1 from 4.10
+- Add missing YK Scan documentation
+- Miscellaneous FAQ and documentation updates
+- Host examples on github not pypi
+
+
 ## 2024.1 - June 12, 2024
 
 - 2024.1.1717799899