1
0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00
RIOT/boards/stm32f4discovery/doc.txt
2023-02-10 10:12:18 +01:00

195 lines
6.4 KiB
Plaintext

/**
@defgroup boards_stm32f4discovery STM32F4Discovery
@ingroup boards
@brief Support for the STM32F4Discovery board
## Overview
See [this page](https://github.com/RIOT-OS/RIOT/wiki/Getting-started-with-STM32F%5B0%7C3%7C4%5Ddiscovery-boards)
for a quick getting started guide.
## Hardware
![Stm32f4discovery with RIOT pin names](https://raw.githubusercontent.com/wiki/RIOT-OS/RIOT/images/stm32f4discovery_pinout_RIOT.png)
### MCU
| MCU | STM32F407VGT6 |
|:------------- |:--------------------- |
| Family | ARM Cortex-M4 |
| Vendor | ST Microelectronics |
| Package | LQFP100 |
| RAM | 192Kb (128Kb RAM + 64Kb CCMRAM) |
| Flash | 1024Kb |
| Frequency | up to 168MHz |
| FPU | yes |
| Timers | 14 (12x 16bit, 2x 32bit [TIM2 + TIM5]) |
| ADCs | 3x 16 channel 6 to 12-bit |
| UARTs | 6 |
| SPIs | 3 |
| I2Cs | 3 |
| Vcc | 2.0V - 3.6V |
| Datasheet | [Datasheet](https://www.st.com/resource/en/datasheet/stm32f407vg.pdf) |
| Reference Manual | [Reference Manual](https://www.st.com/resource/en/reference_manual/dm00031020.pdf) |
| Programming Manual | [Programming Manual](https://www.st.com/resource/en/programming_manual/dm00046982.pdf) |
| Board Manual | [Board Manual](https://www.st.com/resource/en/user_manual/dm00039084.pdf)|
### RIOT pin mapping
Please refer to [this document](https://docs.google.com/spreadsheets/d/11iqdux3K1-7FPZChufNgpChwENkgCiLrnKJPoCcJxdg/edit?usp=sharing)
for the RIOTs pin
mapping for the stm32f4discovery board. The pin mapping is chosen completely
arbitrary and can be altered by editing the
`boards/stm32f4discovery/include/periph_conf.h` header file.
### User Interface
2 Buttons:
| NAME | USER | RESET |
|:----- |:----- |:--------- |
| Pin | PA0 (IN) | NRST |
6 User controllable LEDs:
| NAME | LD3 | LD4 | LD5 | LD6 | LD7 | LD8 |
| ----- | ----- | ----- | ----- | ----- | ----- | ------ |
| Color | orange| green | red | blue | green | red |
| Pin | PD13 | PD12 | PD14 | PD15 | PA9 | PD5 |
LEDs LD7 and LD8 are used by the USB connector for over-current (LD8) and
data (LD7) indication.
### USB Device Interface
The board has a micro USB port that can be used for USB device mode.
As the ST-Link on the board does not provide a USB-UART interface, the STDIO is
mapped to the micro USB port by default (via CDC ACM).
### Accelerometer
The STM32F4discovery board contains a 3-axis MEMS accelerometer that can
sample with up to 1.6kHz.
| Sensor | LIS3DSH |
|:------------- |:--------------------- |
| Type | Accelerometer |
| Vendor | ST Microelectronics |
| Datasheet | [Datasheet](http://www.st.com/st-web-ui/static/active/en/resource/technical/document/datasheet/DM00040962.pdf)|
| Connected to | SPI_0 |
| Pin Config: | |
| Device | SPI1 |
| SCK | PA5 (OUT, SPI1_SCK) |
| MISO | PA6 (IN, SPI1_MISO) |
| MOSI | PA7 (OUT, SPI1_MOSI) |
| INT1 | PE0 (IN) |
| INT2 | PE1 (IN) |
| CS | PE3 (OUT) |
### Digital Microphone
The STM32F4discovery board contains a on-board MEMS audio sensor.
| Sensor | MP45DT02 |
|:------------- |:--------------------- |
| Type | Audio sensor |
| Vendor | ST Microelectronics |
| Datasheet | [Datasheet](http://www.mouser.com/pdfdocs/STM_MP45DT02_Datasheet.PDF)|
| Connected to | n/a |
| Pin Config: | |
| Device | I2S2 |
| CLK | PB10 |
| DOUT | PC3 |
### Audio DAC with integrated class D speaker driver
The board contains an digital analog converter (DAC) with integrated class D
speaker driver.
| Device | CS43L22 |
|:------------- |:--------------------- |
| Type | DAC |
| Vendor | Cirrus Logic |
| Datasheet | [Datasheet](http://www.cirrus.com/en/pubs/proDatasheet/CS43L22_F2.pdf) |
| Connected to | DAC + I2C + I2S |
| Pin Config: | |
| Device | DAC1 + I2C1 + I2S3 |
| AIN1 | PA4 (DAC1_OUT) |
| SCL | PB6 (I2C1_SCL) |
| SDA | PB9 (I2C1_SDA) |
| MCLK | PC7 (I2S3_MCK) |
| SCLK | PC10 (I2S3_CK) |
| SDIN | PC12 (I2S3_SD) |
| RESET | PD4 (OUT) |
## Supported Toolchains
For using the STM32F4discovery board we strongly recommend the usage of the
[GNU Tools for ARM Embedded Processors](https://launchpad.net/gcc-arm-embedded)
toolchain.
# Alternative way to flash
## Using openocd to flash the RIOT binary to the board
1. Compile your code to have a .hex file
2. Connect the board with the mini usb cable, on the debugger side to your PC
3. run openocd with `$ sudo /usr/local/bin/openocd -f interface/stlink-v2.cfg
-f target/stm32f4x_stlink.cfg`
4. in a new terminal connect: `telnet 127.0.0.1 4444`
5. run:
```
> flash banks
#0 : stm32f4x.flash (stm32f2x) at 0x08000000, size 0x00100000, buswidth 0,
chipwidth 0
> halt
target state: halted
target halted due to debug-request, current mode: Thread
xPSR: 0x21000000 pc: 0x0800251a msp: 0x20000c4c
> flash write_image erase unlock /home/c/git/RIOT-
OS/RIOT/examples/ipc_pingpong/bin/stm32f4discovery/ipc_pingpong.hex 0
auto erase enabled
auto unlock enabled
target state: halted
target halted due to breakpoint, current mode: Thread
xPSR: 0x61000000 pc: 0x20000042 msp: 0x20000c4c
wrote 16384 bytes from file /home/c/git/RIOT-
OS/RIOT/examples/ipc_pingpong/bin/stm32f4discovery/ipc_pingpong.hex in 1.200528s
(13.327 KiB/s)
> reset
```
The board is now flashed with your RIOT binary
## Using UART
1. connect your usb tty to: RX=PA3 TX=PA2 and GND=GND
- **PA3** is connected with **TX** on the UART converter
- **PA2** is connected with **RX** on the UART converter
2. done
# Emulator
To emulate this board you need an updated version of
[renode](https://github.com/renode/renode) installed, at least version 1.11.
```
EMULATE=1 BOARD=stm32f4discovery make all term
```
## Known Issues / Problems
### I2C
When connecting an I2C device and a logic analyzer to an I2C port at the same
time, the internal pull-up resistors are not sufficient for stable bus
operation. You probably have to connect external pull-ups to both bus lines. 10K
is a good value to start with.
### macOS & make term
If you want the terminal to work using `make term` command and get a message
about missing tty device install the driver from
https://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers .
*/