added readme and user manual

This commit is contained in:
Robin Müller 2020-12-30 10:10:15 +01:00 committed by Robin Mueller
parent 9a2662d77e
commit 192f864e4c
2 changed files with 28 additions and 1 deletions

View File

@ -35,6 +35,10 @@ The CMake build system can be used to generate build systems as well (see helper
### Installing Vivado the the Xilinx development tools ### Installing Vivado the the Xilinx development tools
It's also possible to perform debugging with a normal Eclipse installation by installing
the TCF plugin. Still, it is necessary to install Vivado to get the toolchain for generating
C++ applications.
* Install Vivado 2018.2 and Xilinx SDK from https://www.xilinx.com/support/download/index.html/content/xilinx/en/downloadNav/vivado-design-tools/archive.html. * Install Vivado 2018.2 and Xilinx SDK from https://www.xilinx.com/support/download/index.html/content/xilinx/en/downloadNav/vivado-design-tools/archive.html.
Install the Vivado Design Suite - HLx Editions - 2018.2 Full Product Installation instead of the updates. It is recommended to use the installer. Install the Vivado Design Suite - HLx Editions - 2018.2 Full Product Installation instead of the updates. It is recommended to use the installer.
@ -48,7 +52,7 @@ The CMake build system can be used to generate build systems as well (see helper
* For supported OS refer to https://www.xilinx.com/support/documentation/sw_manuals/xilinx2018_2/ug973-vivado-release-notes-install-license.pdf * For supported OS refer to https://www.xilinx.com/support/documentation/sw_manuals/xilinx2018_2/ug973-vivado-release-notes-install-license.pdf
* Add path of linux cross-compiler to permanent environment variables (`.profile` file in Linux): * Add path of linux cross-compiler to permanent environment variables (`.profile` file in Linux):
`<XilinxInstallation>SDK\2018.2\gnu\aarch32\nt\gcc-arm-linux-gnueabi\bin` `<XilinxInstallation>\SDK\2018.2\gnu\aarch32\nt\gcc-arm-linux-gnueabi\bin`
or set up path each time before debugging. or set up path each time before debugging.
### Installing CMake and MSYS2 on Windows ### Installing CMake and MSYS2 on Windows
@ -89,6 +93,7 @@ The CMake build system can be used to generate build systems as well (see helper
When using Windows, run theses steps in MSYS2. When using Windows, run theses steps in MSYS2.
1. Clone the repository with 1. Clone the repository with
```sh ```sh
git clone https://egit.irs.uni-stuttgart.de/eive/eive_obsw.git git clone https://egit.irs.uni-stuttgart.de/eive/eive_obsw.git
``` ```
@ -124,6 +129,28 @@ When using Windows, run theses steps in MSYS2.
cmake --build . -j cmake --build . -j
``` ```
## Setting up default Eclipse for Q7S projects - TCF agent
The [TCF agent](https://wiki.eclipse.org/TCF) can be used to perform remote debugging on the Q7S.
1. Install the TCF agent plugin in Eclipse from the [releases](https://www.eclipse.org/tcf/downloads.php). Go to Help &rarr; Install New Software and use the download page, for example https://download.eclipse.org/tools/tcf/releases/1.6/1.6.2/ to search for the plugin and install it.
2. Go to Window &rarr; Perspective &rarr; Open Perspective and open the **Target Explorer Perspective**. Here, the Raspberry Pi should show up if the TCF agent has been set up on the Raspberry Pi as specified [here](https://wiki.eclipse.org/TCF/Raspberry_Pi) or in the respective [README](README-rpi.md#top). Connect to it.
3. A launch configuration was provided, but it might be necessary to adapt it for your own needs. Alternatively:
- Create a new **TCF Remote Application** by pressing the cogs button at the top or going to Run &rarr; Debug Configurations &rarr; Remote Application and creating a new one there.
- Set up the correct image in the main tab (it might be necessary to send it the the Raspberry Pi manually once) and file transfer properties
- It is also recommended to link the correct Eclipse project.
After that, comfortable remote debugging should be possible with the Debug button.
A build configuration and a shell helper script has been provided to set up the path variables and build the Q7S binary
on Windows, but a launch configuration needs to be newly created because the IP address and path settings differ
from machine to machine.
## Building in Xilinx SDK 2018.2 ## Building in Xilinx SDK 2018.2
1. Open Xilinx SDK 2018.2 1. Open Xilinx SDK 2018.2

BIN
doc/Q7S-user-manual.pdf Normal file

Binary file not shown.