Documentation: migrate STM32WB

This commit is contained in:
raiden00pl 2023-08-23 10:18:20 +02:00 committed by Xiang Xiao
parent 77716ee264
commit 8a03b886dd
5 changed files with 149 additions and 139 deletions

View file

@ -0,0 +1,53 @@
============
Flipper Zero
============
This README file discusses the port of NuttX to the Flipper Zero multi-tool
device. See https://flipperzero.one/ for device details.
Device features
===============
- Multi-protocol wireless STM32WB55RGV6 MCU with 1MiB of Flash and 256KiB of SRAM.
- USB Type-C connector for communication and charging
- LiPo battery with charger BQ25896 and fuel gauge BQ27220
- 5-button joystick and a Back button
- ST7565 128x64 LCD
- RGB LED with LP5562 I2C driver
- Buzzer
- Vibration motor
- Micro SD slot connected over SPI
- CC1101 RF transceiver
- ST25R3916 high-performance NFC Universal Device and EMVCo reader
- 125 kHz RFID analog circuit
- IR led
- TSOP75538 IR receiver
- iButton connector
- GPIO connector with power out and SWD pins
Status
======
Oct 2022: initial nsh configuration. LCD seems working.
Programming
===========
The device can be normally flashing and debugging over SWD interface or flashing via
USB interface when the device is in DFU mode using STMicro's STM32CubeProgrammer. The
DFU mode will be activated after pressing two round button for 30s. Original firmware
can be flashed back and stay working until the secure flash area is not changed.
Serial Console
==============
The MCU's USART1 PB6/PB7 pins are available as external GPIO pins 13/14.
Configurations
==============
nsh:
----
Configures the NuttShell (nsh) located at examples/nsh. This
configuration is focused on low level, command-line driver testing.

View file

@ -0,0 +1,74 @@
================
ST NUCLEO-WB55RG
================
This README file discusses the port of NuttX to the STMicroelectronics
NUCLEO-WB55RG board. That board features the multi-protocol wireless and
ultra-low-power STM32WB55RGV6 MCU with 1MiB of Flash and 256KiB of SRAM.
A dedicated M0+ coprocessor is responsible for performing the real-time
low layer operations via one of the available wireless stacks distributed
as binaries in STM32CubeWB package.
Status
======
April 2022: The nucleo-wb55rg board minimal setup compiles successfully.
June 2022: All STM32WB chip family is defined, many of peripherals are
supported - GPIO, EXTI, DMA, timers, flash, PWR, RTC, USART/LPUART, SPI,
IPCC. SRAM2 heap allocation works. Builtin apps work and ostest passed.
July 2022: Added BLE support with mailbox IPC driver.
LEDs
====
The board has 3 user leds::
LED1 (Blue) PB5
LED2 (Green) PB0
LED3 (Red) PB1
These LEDs are not used by the board port unless CONFIG_ARCH_LEDS is
defined. In that case, the usage by the board port is defined in
include/board.h and src/stm32_autoleds.c.
Buttons
=======
The board has 3 user buttons::
SW1 PC4 (needs SB47 close)
SW2 PD0
SW3 PD1
Serial Consoles
===============
The MCU's USART1 is connected to the on-board ST-LINK/V2-1 and exposed as
a Virtual COM Port over the same Micro-USB Type B connection used for
programming/debugging.
Configurations
==============
nsh:
----
Configures the NuttShell (nsh) located at examples/nsh. This
configuration is focused on low level, command-line driver testing.
ble:
----
Besides the NuttShell this configuration also enables BLE support.
It includes btsak application for testing BLE applications.
nimble:
-------
Besides the NuttShell it includes nimble example application which
uses NimBLE host stack.::
nsh> ifup bnep0
nsh> nimble

View file

@ -0,0 +1,22 @@
==========
ST STM32WB
==========
Supported MCUs
==============
TODO
Peripheral Support
==================
TODO
Supported Boards
================
.. toctree::
:glob:
:maxdepth: 1
boards/*/*

View file

@ -1,62 +0,0 @@
README.txt
==========
This README file discusses the port of NuttX to the Flipper Zero multi-tool
device. See https://flipperzero.one/ for device details.
Contents
========
- Device features
- Status
- Programming
- Serial Console
- Configurations
Device features
===============
- Multi-protocol wireless STM32WB55RGV6 MCU with 1MiB of Flash and 256KiB of SRAM.
- USB Type-C connector for communication and charging
- LiPo battery with charger BQ25896 and fuel gauge BQ27220
- 5-button joystick and a Back button
- ST7565 128x64 LCD
- RGB LED with LP5562 I2C driver
- Buzzer
- Vibration motor
- Micro SD slot connected over SPI
- CC1101 RF transceiver
- ST25R3916 high-performance NFC Universal Device and EMVCo reader
- 125 kHz RFID analog circuit
- IR led
- TSOP75538 IR receiver
- iButton connector
- GPIO connector with power out and SWD pins
Status
======
Oct 2022: initial nsh configuration. LCD seems working.
Programming
===========
The device can be normally flashing and debugging over SWD interface or flashing via
USB interface when the device is in DFU mode using STMicro's STM32CubeProgrammer. The
DFU mode will be activated after pressing two round button for 30s. Original firmware
can be flashed back and stay working until the secure flash area is not changed.
Serial Console
==============
The MCU's USART1 PB6/PB7 pins are available as external GPIO pins 13/14.
Configurations
==============
nsh:
Configures the NuttShell (nsh) located at examples/nsh. This
configuration is focused on low level, command-line driver testing.
nsh> nxhello

View file

@ -1,77 +0,0 @@
NUCLEO-WB55RG README
======================
This README file discusses the port of NuttX to the STMicroelectronics
NUCLEO-WB55RG board. That board features the multi-protocol wireless and
ultra-low-power STM32WB55RGV6 MCU with 1MiB of Flash and 256KiB of SRAM.
A dedicated M0+ coprocessor is responsible for performing the real-time
low layer operations via one of the available wireless stacks distributed
as binaries in STM32CubeWB package.
Contents
========
- Status
- LEDs
- Buttons
- Serial Console
- Configurations
Status
======
April 2022: The nucleo-wb55rg board minimal setup compiles successfully.
June 2022: All STM32WB chip family is defined, many of peripherals are
supported - GPIO, EXTI, DMA, timers, flash, PWR, RTC, USART/LPUART, SPI,
IPCC. SRAM2 heap allocation works. Builtin apps work and ostest passed.
July 2022: Added BLE support with mailbox IPC driver.
LEDs
====
The board has 3 user leds:
LED1 (Blue) PB5
LED2 (Green) PB0
LED3 (Red) PB1
These LEDs are not used by the board port unless CONFIG_ARCH_LEDS is
defined. In that case, the usage by the board port is defined in
include/board.h and src/stm32_autoleds.c.
Buttons
=======
The board has 3 user buttons:
SW1 PC4 (needs SB47 close)
SW2 PD0
SW3 PD1
Serial Consoles
===============
The MCU's USART1 is connected to the on-board ST-LINK/V2-1 and exposed as
a Virtual COM Port over the same Micro-USB Type B connection used for
programming/debugging.
Configurations
==============
nsh:
Configures the NuttShell (nsh) located at examples/nsh. This
configuration is focused on low level, command-line driver testing.
ble:
Besides the NuttShell this configuration also enables BLE support.
It includes btsak application for testing BLE applications.
nimble:
Besides the NuttShell it includes nimble example application which
uses NimBLE host stack.
nsh> ifup bnep0
nsh> nimble