PicoBlaze-Library by Paebbels
The PicoBlaze-Library
The PicoBlaze-Library offers several PicoBlaze devices and code routines to extend a common PicoBlaze environment to a little System on a Chip (SoC or SoFPGA).
Table of Content:
- Overview
- Download
- Requirements
- Integrating the Library into Projects
- Using PicoBlaze-Library
- Configuring a System-on-FPGA with PicoBlaze-Library
- Updating PicoBlaze-Library
1 Overview
TODO TODO TODO
Related repositories: PicoBlaze-Examples
2 Download
The PicoBlaze-Library can be downloaded as a zip-file (latest 'master'
branch) or cloned with git clone
from GitHub. GitHub offers HTTPS and SSH as transfer
protocols. See the Download wiki page for more details.
For SSH protocol use the URL ssh://git@github.com:Paebbels/PicoBlaze-Library.git
or command
line instruction:
cd <GitRoot>
git clone --recursive ssh://git@github.com:Paebbels/PicoBlaze-Library.git L_PicoBlaze
For HTTPS protocol use the URL https://github.com/Paebbels/PicoBlaze-Library.git
or command
line instruction:
cd <GitRoot>
git clone --recursive https://github.com/Paebbels/PicoBlaze-Library.git L_PicoBlaze
Note: The option --recursive
performs a recursive clone operation for all
linked git submodules. An additional git submodule init
and
git submodule update
call is not needed anymore.
3 Dependencies:
The PicoBlaze-Library depends on:
- The PoC-Library, a platform independent HDL library, and
- Open PicoBlaze Assembler, a free and freature rich assembler for the PicoBlaze processor.
Both dependencies are available as GitHub repositories and can be downloaded
via git clone
. See section the Dependencies and/or
Integration wiki pages for more details.
4 Requirements
The PicoBlaze-Library comes with some scripts to ease most of the common tasks. We choose to use Python as a platform independent scripting environment. All Python scripts are wrapped in PowerShell or Bash scripts, to hide some platform specifics of Windows or Linux. See the Requirements wiki page for more details and download sources.
Common Requirements:
- Programming languages and runtimes:
- Synthesis tool chains:
- Xilinx ISE 14.7 or
- Xilinx Vivado ≥ 2014.1 or
- Altera Quartus-II ≥ 13.0
- Simulation tool chains:
- Assembler tool chains:
- KCPSM6.exe
- Open PicoBlaze Assembler (opbasm)
Additional requirements on Linux:
- m4 macro pre-processor
- Debian specific:
- bash is configured as
/bin/sh
(read more)
dpkg-reconfigure dash
- bash is configured as
Additional requirements on Windows:
- m4 macro pre-processor
- PowerShell 4.0 (Windows Management Framework 4.0)
- Allow local script execution (read more)
Set-ExecutionPolicy RemoteSigned
- PowerShell Community Extensions 3.2 (pscx.codeplex.com)
- Allow local script execution (read more)
4 Integrating PicoBlaze-Library into Projects
The PicoBalze-Library is meant to be integrated into HDL projects. Therefore it's recommended to create a library folder and add the PicoBlaze-Library as a git submodule. After the repository linking is done, some short configuration steps are required to setup paths and tool chains. The following command line instructions show a short example on how to integrate the PicoBlaze-Library. A detailed list of steps can be found on the Integration wiki page.
4.1 Adding PicoBlaze-Library and it's Dependencies as git submodules
All Windows command line instructions are intended for Windows PowerShell, if not marked otherwise. So executing the following instructions in Windows Command Prompt (
cmd.exe
) won't function or result in errors! See the Requirements wiki page on where to download or update PowerShell.
The following command line instructions will create a library folder lib\
and clone all
depenencies as git submodules into subfolders.
cd <ProjectRoot>
mkdir lib\PoC\
git submodule add ssh://git@github.com:VLSI-EDA/PoC.git lib\PoC
git add .gitmodules lib\PoC
git commit -m "Added new git submodule PoC in 'lib\PoC' (PoC-Library)."
mkdir lib\L_PicoBlaze\
git submodule add ssh://git@github.com:Paebbels/PicoBlaze-Library.git lib\L_PicoBlaze
git add .gitmodules lib\L_PicoBlaze
git commit -m "Added new git submodule L_PicoBlaze in 'lib\L_PicoBlaze' (PicoBalze-Library)."
mkdir lib\opbasm\
git submodule add ssh://git@github.com:Paebbels/opbasm.git lib\opbasm
git add .gitmodules lib\opbasm
git commit -m "Added new git submodule opbasm in 'lib\opbasm' (Open PicoBlaze Assembler)."
4.2 Configuring PoC on a Local System
The previous step cloned the PoC-Library into the folder lib\PoC\
. This library needs to be
configured to provide its full potential.
cd <ProjectRoot>
cd lib\PoC\
.\poc.ps1 --configure
4.3 Creating PoC's my_config and my_project Files
The PoC-Library needs two VHDL files for it's configuration. These files are used to determine the most suitable implementation depending on the provided platform information. Copy these two template files into your project's source folder. Rename these files to *.vhdl and configure the VHDL constants in these files.
cd <ProjectRoot>
cp lib\PoC\src\common\my_config.vhdl.template src\common\my_config.vhdl
cp lib\PoC\src\common\my_project.vhdl.template src\common\my_project.vhdl
my_config.vhdl
defines two global constants, which need to be adjusted:
constant MY_BOARD : string := "CHANGE THIS"; -- e.g. Custom, ML505, KC705, Atlys
constant MY_DEVICE : string := "CHANGE THIS"; -- e.g. None, XC5VLX50T-1FF1136, EP2SGX90FF1508C3
my_project.vhdl
also defines two global constants, which need to be adjusted:
constant MY_PROJECT_DIR : string := "CHANGE THIS"; -- e.g. d:/vhdl/myproject/, /home/me/projects/myproject/"
constant MY_OPERATING_SYSTEM : string := "CHANGE THIS"; -- e.g. WINDOWS, LINUX
4.4 Compiling shipped Xilinx IPCores (*.xco files) to netlists
The PicoBlaze-Library and the PoC-Library are shipped with some pre-configured IP cores
from Xilinx. These IPCores are shipped as *.xco files and need to be compiled to netlists
(*.ngc files) and there auxillary files (*.ncf files; *.vhdl files; ...). This can be done
by invoking PoC's Netlist.py
through one of the provided wrapper scripts: netlist.[sh|ps1].
Compiling needed IP cores from PoC for a KC705 board:
cd <ProjectRoot>
cd lib\PoC\netlist
foreach ($i in 1..15) {
.\netlist.ps1 --coregen PoC.xil.ChipScopeICON_$i --board KC705
}
Compiling needed IP cores from L_PicoBlaze for a KC705 board:
cd ....
cd lib\L_PicoBlaze\netlist\<DeviceString>\
# TODO: write a script to regenerate all IP Cores
5 Using PicoBlaze-Library
6.1 Standalone
6.1 In Xilinx ISE (XST and iSim)
6.2 In Xilinx Vivado (Synth and xSim)
6 Configuring a System-on-FPGA with PicoBlaze-Library
7 Updating PicoBlaze-Library
Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
https://github.com/Paebbels/PicoBlaze-Library
Apache License 2.0
Issue Tracker
Last activity 6 years ago
Primary language: VHDL
1 fork
3 watchers
9 stars
62 commits by 1 contributor
activity over the last year
LibreCores data updated 1 year ago