Debian Codegraph @

ports/stm32/boards/WEACT_F411_BLACKPILL/README.md

raw
1 WeAct F411 'blackpill'
2 ======================
3
4 The WeAct F411 blackpill board comes in a number of versions and variants.
5 All have a footprint for a SPI flash chip on the back, though the board is
6 often sold without any flash chip loaded.
7
8 At the time of writing (Sep 2024) v3.1 is the current version.
9 This version is sold with both 25Mhz HSE crystal (same as previous versions) and also
10 with a 8Mhz crystal. The end user should be careful to confirm which variant is
11 purchased and/or read the markings on the crystal to know which variant build to load.
12
13 The previous v2.0 boards had changed the MCU pinout for the spi flash chip so requires
14 soft-spi support enabled in the variant settings, unlike v3.1 or v1.3 which is
15 compatible with the hardware spi peripheral.
16
17 The original v1.3 boards did not include a user switch on the top, it only has
18 "BOOT0" and "NRST" switches to load bootloader and reset the board respectively.
19
20 For more information see: https://github.com/WeActStudio/WeActStudio.MiniSTM32F4x1
21
22 Note: The pins used by features like spiflash and USB are also broken out to the
23 gpio headers on the sides of the board.
24 If these peripherals / features are enabled then these external pins must be avoided to ensure
25 there are no conflicts. [pins.csv](pins.csv) should be consulted to check all pins assigned
26 to alternate functions on the board.
27
28 Customising the build
29 ---------------------
30
31 After purchasing a board without any spiflash chip loaded the user can solder on
32 their own of any desired size. Most brands of spiflash in SO8 pinout are compatible
33 however some do have a slightly different protocol so may not work out of the box
34 with micropython. Brand compatibility is outide the scope of this doc.
35
36 Once a custom spiflash chip has been loaded onto the board micropython should
37 be built with the flash size specified. After doing so the spiflash chip will
38 be used for the FAT/LFS main filesystem.
39
40 Examples:
41
42 For a v3.1 / 25Mhz (default version) board with 16MiB flash chip loaded:
43 ``` bash
44 make -C ports/stm32 BOARD=WEACT_F411_BLACKPILL SPI_FLASH_SIZE_MB=16
45 ```
46
47 For a v3.1 / 8Mhz board with 4MiB flash chip loaded:
48 ``` bash
49 make -C ports/stm32 BOARD=WEACT_F411_BLACKPILL BOARD_VARIANT=V31_XTAL_8M SPI_FLASH_SIZE_MB=4
50 ```
51
52 For a v1.3 board with 2MiB flash chip loaded and XTAL manually replaced with 8Mhz:
53 ``` bash
54 make -C ports/stm32 BOARD=WEACT_F411_BLACKPILL BOARD_VARIANT=V13 SPI_FLASH_SIZE_MB=2 XTAL_FREQ_MHZ=8
55 ```