Commit ac10bcbb authored by Martin Horauer's avatar Martin Horauer
Browse files

added README.adoc files

parent 83d02f42
# AnalogOut Example
= AnalogOut Example
This example illustrates how to use an analog output (DAC) with the XMC4500
Relax Kit. In particular, port P14_8 is used as analog output pin where a sinus
wave is output.
![alt-text](meas.png)
image::meas.png[]
## Makefile Usage
== Makefile Usage
```
[source%nowrap, bash]
----
make # build the application
make flash # flash the application
make debug # debug the application
make erase # erase the program memory
make doc # invoke doxygen
make clean # clean the project
```
----
# Manuell
= Manual
## Building
== Building
```
[source%nowrap, bash]
----
mbed compile -c -m XMC_4500_RELAX_KIT -t GCC_ARM -N main
```
----
This creates several files in the BUILD directory where you can find the
executables (bin, elf, hex ...).
## Flashing
== Flashing
```
[source%nowrap, bash]
----
$ JLinkExe -Device XMC4500-1024 -if SWD -speed 4000
J-LINK> h
J-Link> loadfile BUILD/XMC_4500_RELAX_KIT/GCC_ARM/main.hex
J-Link> r
J-Link> g
```
----
## Debugging
== Debugging
(1) Start the `JLinkGDEBServer`, e.g.:
(1) Build the application with debug symbols enabled by adding `--profile mbed-os/tools/profiles/debug.json`.
```
[source%nowrap, bash]
----
mbed compile -c -m XMC_4500_RELAX_KIT -t GCC_ARM -N main --profile mbed-os/tools/profiles/debug.json
----
(2) Start the `JLinkGDEBServer`, e.g.:
[source%nowrap, bash]
----
JLinkGDBServer -Device XMC4500-1024 -if SWD
```
(2) In order to log messages printed to `stdout` we connect to port 2333 via
----
(3) In order to log messages printed to `stdout` we connect to port 2333 via
telnet.
```
[source%nowrap, bash]
----
telnet 127.0.0.1 2333
```
----
(3) We launch the debugger and control the debug session:
(4) We launch the debugger and control the debug session:
```
[source%nowrap, bash]
----
arm-none-eabi-gdb -q BUILD/XMC_4500_RELAX_KIT/GCC_ARM/main.elf
(gdb) target remote :2331
(gdb) monitor reset
......@@ -63,5 +78,5 @@ arm-none-eabi-gdb -q BUILD/XMC_4500_RELAX_KIT/GCC_ARM/main.elf
(gdb) b main
(gdb) c
[...]
```
----
# Blinky Example
= Blinky Example
A siomple blinky example that flashes the LED1 on the XMC Relax-Kit eval board.
## Makefile Usage
== Makefile Usage
```
[source%nowrap, bash]
----
make # build the application
make flash # flash the application
make debug # debug the application
make erase # erase the program memory
make doc # invoke doxygen
make clean # clean the project
```
----
# Manuell
= Manual
## Building
== Building
```
[source%nowrap, bash]
----
mbed compile -c -m XMC_4500_RELAX_KIT -t GCC_ARM -N main
```
----
This creates several files in the BUILD directory where you can find the executables (bin, elf, hex ...).
## Flashing
== Flashing
```
[source%nowrap, bash]
----
$ JLinkExe -Device XMC4500-1024 -if SWD -speed 4000
J-LINK> h
J-Link> loadfile BUILD/XMC_4500_RELAX_KIT/GCC_ARM/main.hex
J-Link> r
J-Link> g
```
----
## Debugging
== Debugging
(1) Start the `JLinkGDEBServer`, e.g.:
(1) Build the application with debug symbols enabled by adding `--profile mbed-os/tools/profiles/debug.json`.
```
[source%nowrap, bash]
----
mbed compile -c -m XMC_4500_RELAX_KIT -t GCC_ARM -N main --profile mbed-os/tools/profiles/debug.json
----
(2) Start the `JLinkGDEBServer`, e.g.:
[source%nowrap, bash]
----
JLinkGDBServer -Device XMC4500-1024 -if SWD
```
(2) In order to log messages printed to `stdout` we connect to port 2333 via
----
(3) In order to log messages printed to `stdout` we connect to port 2333 via
telnet.
```
[source%nowrap, bash]
----
telnet 127.0.0.1 2333
```
----
(3) We launch the debugger and control the debug session:
(4) We launch the debugger and control the debug session:
```
[source%nowrap, bash]
----
arm-none-eabi-gdb -q BUILD/XMC_4500_RELAX_KIT/GCC_ARM/main.elf
(gdb) target remote :2331
(gdb) monitor reset
......@@ -58,5 +71,5 @@ arm-none-eabi-gdb -q BUILD/XMC_4500_RELAX_KIT/GCC_ARM/main.elf
(gdb) b main
(gdb) c
[...]
```
----
# InterruptIn Example
= InterruptIn Example
This example illustrates how to facilitate an interrupt using an IO asd input
with the XMC4500 Relax Kit. In particular, port P1_15 connected to BUTTON2 is
......@@ -7,60 +7,74 @@ switched on, otherwise, when a falling edge is detected LED2 will be switched
off. In other words, when you press BUTTON2 LED2 will be on when you release the
button, LED2 will be off.
![alt-text](seriallog.png)
image::seriallog.png[]
This example also uses MBED-OS queue functionality as well as UART1 on the XMC
Relax-Kit.
## Makefile Usage
== Makefile Usage
```
[source%nowrap, bash]
----
make # build the application
make flash # flash the application
make debug # debug the application
make erase # erase the program memory
make doc # invoke doxygen
make clean # clean the project
```
----
# Manuell
= Manual
## Building
== Building
```
[source%nowrap, bash]
----
mbed compile -c -m XMC_4500_RELAX_KIT -t GCC_ARM -N main
```
----
This creates several files in the BUILD directory where you can find the
executables (bin, elf, hex ...).
## Flashing
== Flashing
```
[source%nowrap, bash]
----
$ JLinkExe -Device XMC4500-1024 -if SWD -speed 4000
J-LINK> h
J-Link> loadfile BUILD/XMC_4500_RELAX_KIT/GCC_ARM/main.hex
J-Link> r
J-Link> g
```
----
## Debugging
== Debugging
(1) Start the `JLinkGDEBServer`, e.g.:
(1) Build the application with debug symbols enabled by adding `--profile mbed-os/tools/profiles/debug.json`.
```
[source%nowrap, bash]
----
mbed compile -c -m XMC_4500_RELAX_KIT -t GCC_ARM -N main --profile mbed-os/tools/profiles/debug.json
----
(2) Start the `JLinkGDEBServer`, e.g.:
[source%nowrap, bash]
----
JLinkGDBServer -Device XMC4500-1024 -if SWD
```
(2) In order to log messages printed to `stdout` we connect to port 2333 via
----
(3) In order to log messages printed to `stdout` we connect to port 2333 via
telnet.
```
[source%nowrap, bash]
----
telnet 127.0.0.1 2333
```
----
(3) We launch the debugger and control the debug session:
(4) We launch the debugger and control the debug session:
```
[source%nowrap, bash]
----
arm-none-eabi-gdb -q BUILD/XMC_4500_RELAX_KIT/GCC_ARM/main.elf
(gdb) target remote :2331
(gdb) monitor reset
......@@ -69,5 +83,5 @@ arm-none-eabi-gdb -q BUILD/XMC_4500_RELAX_KIT/GCC_ARM/main.elf
(gdb) b main
(gdb) c
[...]
```
----
Markdown is supported
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