noisymime
/
STM32GENERIC
mirror of https://github.com/noisymime/STM32GENERIC.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

documentation: update documentation for adding boards

This commit is contained in:
Daniel Fekete 2017-06-12 18:39:35 +02:00
parent 4402dddbe0
commit dac90592aa
1 changed files with 12 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
tools/documentation/mkdocs/add_board.md
View File

@ -1,8 +1,8 @@
# Add your board:
## 1. Create a copy of the STM32/variants/TEMPLATE folder with a name of your choice.
## 1. Create a copy of the STM32/variants/xxx folder with a name of your choice.
TODO create TEMPLATE, for now just use an existing one
Use one that is the most similar to your board
## 2. Edit the ldscript.ld file
@ -10,32 +10,26 @@ TODO create TEMPLATE, for now just use an existing one
2. FLASH LENGTH to be the size of RAM of the microcontroller
3. RAM LENGTH to be the size of RAM of the microcontroller
TODO CCRAM? SDRAM?
TODO CCRAM, SDRAM.
## 3. Edit the variant.h file
1. Copy the `enum {`... from `system/STM32XX/stm32_chip/stm32_STM32XXXXXX.h` file.
2. If the board has pin name - pin number assigments (for example arduino headers), rearrange the enum accordingly.
3. Change LED_BUILTIN, MOSI, MISO... macros to point to the primary LED, primary SPI, primary I2C pins.
4. Add board specific macros if the board has extra leds, buttons, SPI CS select lines etc...
1. Change LED_BUILTIN, MOSI, MISO... macros to point to the primary LED, primary SPI, primary I2C pins.
2. Add board specific macros if the board has extra leds, buttons, SPI CS select lines etc...
3. If the board has pin name - pin number assigments (for example arduino headers), Copy the VARIANT_PIN_LIST_DEFAULT from `system/STM32XX/stm32_chip/stm32_STM32XXXXXX.h` file, rename to VARIANT_PIN_LIST, and rearrange accordingly.
## 4. Edit the variant.cpp file
1. Copy the `const stm32_port_pin_type variant_pin_list[] = {` from `system/STM32XX/stm32_chip/stm32_STM32XXXXXX.h` file.
2. Rearrange to be the same as `enum {` in `variant.h`
## 5. Edit the systemclock_config.c file
## 4. Edit the variant.c file
1. Run STM32CubeMX, select the chip for your board
2. If the board has external crystal, set RCC HSE to crystal. In clock configuration, set PLL Source to HSE, set HSE to the frequency of the board crystal.
3. Set some peripherals (SPI, I2C, SDIO, USB, ...), so that the clock configuration will generate extra code needed for those peripherals, and bounds check the frequencies.
4. Go to clock configuration, set everything to maximum :), let CubeMX figure out the rest.
5. Click generate. Set toolchain/IDE to SW4STM32. Clik OK
6. From the generated src/main.c, copy `void SystemClock_Config(void) {` into your `variant/.../systemclock_config.c`
6. From the generated src/main.c, copy `void SystemClock_Config(void) {` into your `variant/.../variant.c`
## 6. Edit the boards.txt file
## 5. Edit the boards.txt file
TODO create template. For now, copy an existing board
Copy one that is the most similar to your board
1. Rename the board
2. Change `build.mcu=` to your cortex-mX version
@ -45,10 +39,10 @@ TODO create template. For now, copy an existing board
6. If the external crystal is not the board default in `system/STM32XX/HAL_SRC/system_stm32XXxx.c`, add `-DHSE_VALUE=8000000` to `xxx.build.extra_flags`
7. TODO explain upload / usb / serial menu options
## 7. Restart
## 6. Restart
Restart Arduino IDE
## 8. Run the blink example on your new board
## 7. Run the blink example on your new board
Run examples / basic / blink