mirror of
https://github.com/RIOT-OS/RIOT.git
synced 2024-12-29 04:50:03 +01:00
boards/openlabs-kw41z-mini: fix doc rendering
There were some errors in the formatting. This fixes the `make doc` output.
This commit is contained in:
Benjamin Valentin
parent
d4e05edac0
commit
880c2f129e
@ -3,12 +3,13 @@
|
||||
@ingroup boards
|
||||
@brief Support for openlabs-kw41z-mini
|
||||
|
||||
### General information
|
||||
### General information
|
||||
|
||||
This is an open-source development board shipped by openlabs.co with
|
||||
source files located at https://openlabs.co/OSHW/kw41z-mini
|
||||
|
||||
A driver for the radio transceiver is available in #12277 (802.15.4 only).
|
||||
A driver for the radio transceiver is available in [#12277](https://github.com/RIOT-OS/RIOT/pull/12277)
|
||||
(802.15.4 only).
|
||||
|
||||
|
||||
### Programming Pinout
|
||||
@ -16,83 +17,89 @@ A driver for the radio transceiver is available in #12277 (802.15.4 only).
|
||||
Programming and debugging can be done with a Raspberry Pi (or equivalent)
|
||||
running OpenOCD.
|
||||
|
||||
|
||||
Pi GPIO Pins kw41z-mini
|
||||
====================================
|
||||
||
|
||||
GPIO_19 ------||------- RST
|
||||
||
|
||||
GPIO_20 ------||------- SWDCLK
|
||||
||
|
||||
GPIO_21 ------||------- SWDIO
|
||||
||
|
||||
3.3V -------||------- 3.3V
|
||||
||
|
||||
GND -------||------- GND
|
||||
||
|
||||
|
||||
Pi GPIO Pins kw41z-mini
|
||||
====================================
|
||||
||
|
||||
GPIO_19 ------||------- RST
|
||||
||
|
||||
GPIO_20 ------||------- SWDCLK
|
||||
||
|
||||
GPIO_21 ------||------- SWDIO
|
||||
||
|
||||
3.3V -------||------- 3.3V
|
||||
||
|
||||
GND -------||------- GND
|
||||
||
|
||||
|
||||
### Compiling and Flashing
|
||||
|
||||
# install build deps for openocd
|
||||
apt install git build-essential libtool automake
|
||||
|
||||
apt install git build-essential libtool automake
|
||||
|
||||
# fetch and build openocd with support for JTAG via RPi or generic GPIO
|
||||
git clone https://github.com/beduino-project/openocd.git
|
||||
cd openocd
|
||||
./bootstrap
|
||||
./configure --enable-bcm2835gpio --enable-sysfsgpio
|
||||
make -j4 && sudo make install
|
||||
|
||||
git clone https://github.com/beduino-project/openocd.git
|
||||
cd openocd
|
||||
./bootstrap
|
||||
./configure --enable-bcm2835gpio --enable-sysfsgpio
|
||||
make -j4 && sudo make install
|
||||
|
||||
# install arm toolchain
|
||||
apt install git gcc-arm-none-eabi gdb-arm-none-eabi
|
||||
# fetch Riot
|
||||
git clone https://github.com/RIOT-OS/RIOT.git
|
||||
# build and flash the gnrc_networking example
|
||||
cd RIOT/examples/gnrc_networking
|
||||
BOARD=openlabs-kw41z-mini CFLAGS+="-DKW41ZRF_ENABLE_LEDS=1" make -j4 flash
|
||||
|
||||
apt install git gcc-arm-none-eabi gdb-arm-none-eabi
|
||||
|
||||
# fetch Riot
|
||||
|
||||
git clone https://github.com/RIOT-OS/RIOT.git
|
||||
|
||||
# build and flash the gnrc_networking example
|
||||
|
||||
cd RIOT/examples/gnrc_networking
|
||||
BOARD=openlabs-kw41z-mini CFLAGS+="-DKW41ZRF_ENABLE_LEDS=1" make -j4 flash
|
||||
|
||||
### Debug Uart Pinout
|
||||
|
||||
It is also possible to use the Pi for connecting to the debug uart.
|
||||
|
||||
|
||||
Pi GPIO Pins kw41z-mini
|
||||
==================================
|
||||
||
|
||||
UART TX ----||------ RXI
|
||||
||
|
||||
UART RX ----||------ TXO
|
||||
||
|
||||
GND ------||------ GND
|
||||
||
|
||||
|
||||
Pi GPIO Pins kw41z-mini
|
||||
==================================
|
||||
||
|
||||
UART TX ----||------ RXI
|
||||
||
|
||||
UART RX ----||------ TXO
|
||||
||
|
||||
GND ------||------ GND
|
||||
||
|
||||
|
||||
# enable the uart on the Pi
|
||||
echo "enable_uart=1" >> /boot/config.txt
|
||||
reboot
|
||||
# install serial terminal
|
||||
apt install picocom
|
||||
# run serial terminal to access debug uart
|
||||
picocom -b115200 /dev/serial0
|
||||
|
||||
echo "enable_uart=1" >> /boot/config.txt
|
||||
reboot
|
||||
|
||||
# install serial terminal
|
||||
|
||||
apt install picocom
|
||||
|
||||
# run serial terminal to access debug uart
|
||||
|
||||
picocom -b115200 /dev/serial0
|
||||
|
||||
It is recommended (if possible) to switch the Pi to the better-clocked
|
||||
uart for higher baud rates:
|
||||
|
||||
echo "dtoverlay=disable-bt" >> /boot/config.txt
|
||||
reboot
|
||||
|
||||
echo "dtoverlay=disable-bt" >> /boot/config.txt
|
||||
reboot
|
||||
|
||||
### Notes
|
||||
|
||||
To get a working radio, add #12277 and uncomment the lines in
|
||||
boards/openlabs-kw41z-mini/Makefile.dep
|
||||
`boards/openlabs-kw41z-mini/Makefile.dep`
|
||||
|
||||
The DAC output is on pin PTB18.
|
||||
The DAC output is on pin `PTB18`.
|
||||
|
||||
ADC input A3 needs a hack applied to cpu/kinetis/periph/adc.c to remove
|
||||
ADC_CFG2_MUXSEL_MASK from CFG2 to switch to the correct mux setting.
|
||||
ADC input A3 needs a hack applied to `cpu/kinetis/periph/adc.c` to remove
|
||||
`ADC_CFG2_MUXSEL_MASK` from `CFG2` to switch to the correct mux setting.
|
||||
|
||||
The PWM peripheral on this board isn't supported in the Kinetis PWM driver yet.
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user