RIOT-OS/RIOT
RIOT-OS/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00
Code Releases Activity

Merge #19105

Browse Source 
19105: Documentation: Document PWM and other Peripherals for Weact STM32F4x1Cx boards r=maribu a=jhaand

### Contribution description
The  Weact boards with STM32F4x1Cx MCU's have their PWM outputs enabled. But these currently do not show in the the documentation. This PR updates the documentation for these 3 boards.  

### Testing procedure
I rebuild the documentation with `make doc` and checked the resulting 3 html files. 

### Issues/PRs references
Fixes this issue: https://github.com/jhaand/RIOT/issues/1
Also referred to in this issue: https://github.com/RIOT-OS/RIOT/issues/19103

### Context
Discussed `@maribu` and `@benpicco` on matrix [link](https://matrix.to/#/!pqHdpanAvkJvlCwUDE:matrix.org/$lEMfOAG5rGGrkEjfJcsg0nC1Ebj4vlitvH9zm8uP-NM?via=matrix.org&via=rubdos.be&via=schleiser.de)


Co-authored-by: Jelle Haandrikman <jhaand@freedom.nl>
This commit is contained in:
bors[bot] 2023-01-07 10:28:49 +00:00 committed by GitHub
commit d193988db2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 40 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
boards/weact-f401cc/doc.txt
View File

@ -33,6 +33,19 @@ It is available on sites like AliExpress for less than 3€.
| Datasheet | [Datasheet](https://www.st.com/resource/en/datasheet/stm32f401cc.pdf) |
| Reference Manual | [Reference Manual](https://www.st.com/content/ccc/resource/technical/document/reference_manual/9b/53/39/1c/f7/01/4a/79/DM00119316.pdf/files/DM00119316.pdf/jcr:content/translations/en.DM00119316.pdf) |
## Implementation Status
| Device | ID | Supported | Comments |
|:----------------- |:------------- |:------------------------- |:--------------------------------------------------------- |
| MCU | STM32F401CC | partly | Energy saving modes not fully utilized |
| Low-level driver | GPIO | yes | |
| | PWM | yes (4 pins available)) | |
| | UART | 2 UARTs | USART2 via PA3(RX)/PA2(TX), USART1 on PA10(RX)/PA9(TX) |
| | I2C | 1 I2C | |
| | SPI | 1 SPI | |
| | USB | yes | |
| | Timer | 1 32 bit timer (TIM5) | |
## Flashing the device
The device comes with a bootloader that allows flashing via `dfu-util`.

13
boards/weact-f401ce/doc.txt
View File

@ -33,6 +33,19 @@ It is available on sites like AliExpress for less than 3€.
| Datasheet | [Datasheet](https://www.st.com/resource/en/datasheet/stm32f401ce.pdf) |
| Reference Manual | [Reference Manual](https://www.st.com/content/ccc/resource/technical/document/reference_manual/9b/53/39/1c/f7/01/4a/79/DM00119316.pdf/files/DM00119316.pdf/jcr:content/translations/en.DM00119316.pdf) |
## Implementation Status
| Device | ID | Supported | Comments |
|:----------------- |:------------- |:------------------------- |:--------------------------------------------------------- |
| MCU | STM32F401CE | partly | Energy saving modes not fully utilized |
| Low-level driver | GPIO | yes | |
| | PWM | yes (4 pins available)) | |
| | UART | 2 UARTs | USART2 via PA3(RX)/PA2(TX), USART1 on PA10(RX)/PA9(TX) |
| | I2C | 1 I2C | |
| | SPI | 1 SPI | |
| | USB | yes | |
| | Timer | 1 32 bit timer (TIM5) | |
## Flashing the device
The device comes with a bootloader that allows flashing via `dfu-util`.

15
boards/weact-f411ce/doc.txt
View File

@ -15,7 +15,7 @@ It is available on sites like AliExpress for less than 4€.
![WeAct-F411CE](https://user-images.githubusercontent.com/1301112/69389644-eb5fb080-0ccc-11ea-8002-67d3db851250.png)
### MCU
| MCU | STM32F411CE |
| MCU | STM32F411CEU6 |
|:---------------- |:--------------------- |
| Family | ARM Cortex-M4F |
| Vendor | ST Microelectronics |
@ -33,6 +33,19 @@ It is available on sites like AliExpress for less than 4€.
| Datasheet | [Datasheet](https://www.st.com/resource/en/datasheet/stm32f411ce.pdf) |
| Reference Manual | [Reference Manual](https://www.st.com/content/ccc/resource/technical/document/reference_manual/9b/53/39/1c/f7/01/4a/79/DM00119316.pdf/files/DM00119316.pdf/jcr:content/translations/en.DM00119316.pdf) |
## Implementation Status
| Device | ID | Supported | Comments |
|:----------------- |:------------- |:------------------------- |:--------------------------------------------------------- |
| MCU | STM32F411CE | partly | Energy saving modes not fully utilized |
| Low-level driver | GPIO | yes | |
| | PWM | yes (4 pins available)) | |
| | UART | 2 UARTs | USART2 via PA3(RX)/PA2(TX), USART1 on PA10(RX)/PA9(TX) |
| | I2C | 1 I2C | |
| | SPI | 1 SPI | |
| | USB | yes | |
| | Timer | 1 32 bit timer (TIM5) | |
## Flashing the device
The device comes with a bootloader that allows flashing via `dfu-util`.