Commit bf7f02eb authored by Christian Eichler's avatar Christian Eichler
Browse files

Improve/update README.md

parent 4257ef51
GenE Benchmarking System for Infineon XMC4500 Relax (Lite)
===================
# GenE Benchmarking System for Infineon XMC4500 Relax (Lite)
Template for Infineon's XMC4500 Relax (Lite) Kit for UNIX-based operating systems
......@@ -14,7 +13,7 @@ Requirements:
* GNU Make
Preperations
------------------------
------------
You need to rename a file inside the CMSIS directory, because else gcc is not
able find the System_XMD4500.c file. This seems to be a UNIX-only problem since
windows-gcc is case-insensitive regarding filenames.
......@@ -22,41 +21,61 @@ windows-gcc is case-insensitive regarding filenames.
cd CMSIS/Infineon/XMC4500_series/Source
mv system_XMC4500.c System_XMC4500.c
Usage
-------------------------
1. Edit the Makefile and adapt the CMSIS Path.
2. Type _make_
3. Connect your evaluation board to usb, start the gdb-server with:
# The XMC4500
JLinkGDBServer -Device XMC4500-1024 -if SWD
The XMC4500 has two USB connectors:
One for the debugger, the other one for the "application processor".
4. Type _make install_
As soon as the operating system contained in this repo is flashed to the XCM4500,
the application USB connects as serial USB port (usually as /dev/ttyACM<number>).
Usage: xmccomm
------------------------
xmccomm <tty> <command> ...
## Usage: Flash the System
* `tty`: Path to /dev/ttyACMn
* `command`: One out of:
* `inf`: Display device information
* `dic`: Disable instruction cache
* `eic`: Enable instruction cache
* `bch <input value>`: Run benchmark with supplied input value
The OS is flashed by calling `make flash/<systype>_<deviceid>`
* `systype` is one of:
* ids: **ID**entification **S**ystem
* bch: **B**en**CH**mark System
* `deviceid` the serial ID of the debugger
### The **ID**entification **S**ystem
The **ids** is a tiny system, that is solely used to identify the devices,
especially to map the debugger to the corresponding ttyACM.
The **ids** supports the following requests:
* `inf`: print device information **INCLUDING the serial ID of the debugger**
Any other requests (including `bch`) will cause an error!
### The **B**en**CH**mark System
Multiple `command`s can be specified at once:
The **bch** supports the following requests:
xmccomm /dev/ttyACM0 dic inf "bch 1337"
* `inf`: print device information **WITHOUT the serial ID of the debugger**
* `dic`: disable instruction cache
* `eic`: enable instruction cache
* `bch`: run benchmark
Usage: Communicate with the System
----------------------------------
xmccomm <tty>
* `tty`: Path to /dev/ttyACMn
The actual commands sent to the XMC4500 are read from stdin;
One command per line:
* `inf`: Display device information
* `dic`: Disable instruction cache
* `eic`: Enable instruction cache
* `bch <input value>`: Run benchmark with supplied input value
To allow opening of /dev/ttyACMn, the current user needs to be in
system group `dialout`.
Getting J-Link Tools
-------------------------
You need to provide your serial number to download the J-Link Tools.
To get them, you can connect your board to a windows pc and install
the DAVE supplied J-Link package. After opening J-Link Commander you
will see the serial number in the command window.
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment