Documentation: move boards/nrf52 readmes to Documentation

This commit is contained in:
raiden00pl 2023-05-30 14:01:06 +02:00 committed by Brennan Ashton
parent da4c7703db
commit 4650c9f756
12 changed files with 479 additions and 228 deletions

View file

@ -0,0 +1,74 @@
======================
Adafruit NRF52 Feather
======================
The `Adafruit NRF52 Feather <https://www.adafruit.com/product/3406>`_
is a development board for the nRF52832 SoC from Nordic.
Serial Console
==============
The Feather nRF52 default console is the UART0.
The Feather nRF52 have USB serial bridge chip on board and UART0 is
connected to micro USB connector through the bridge chip.
LEDs and Buttons
================
LEDs
----
The Feather has 2 user-controllable LEDs:
==== =======
LED MCU
==== =======
LED1 PIN0-17
LED2 PIN0-19
==== =======
A high output illuminates the LED.
CONFIG_ARCH_LEDS
----------------
If CONFIG_ARCH_LEDS is not defined, then the LEDs are completely under
control of the application. The following interfaces are then available
for application control of the LEDs::
uint32_t board_userled_initialize(void);
void board_userled(int led, bool ledon);
void board_userled_all(uint32_t ledset);
Pushbuttons
-----------
The Feather nRF52 does not have user-controllable buttons. The reset button
on the board is connected to nRF52832 reset pin directly.
Configurations
==============
Each configuration is maintained in a sub-directory and can be selected as
follow::
tools/configure.sh nrf52-feather:<subdir>
Where <subdir> is one of the following:
nsh
---
This configuration is the NuttShell (NSH) example at examples/nsh/.
NOTES:
1. This configuration uses the mconf-based configuration tool. To
change this configurations using that tool, you should:
a. Build and install the kconfig-mconf tool. See nuttx/README.txt
see additional README.txt files in the NuttX tools repository.
b. Execute 'make menuconfig' in nuttx/ in order to start the
reconfiguration process.

View file

@ -0,0 +1,106 @@
===========
nRF52832-DK
===========
The `NRF52832-DK (PCA10040) <https://www.nordicsemi.com/Products/Development-hardware/nrf52-dk>`_
is a development board for the nRF52832 SoC from Nordic.
Serial Console
==============
The PCA10040 default console is the UART0.
The PCA10040 does not have RS-232 drivers or serial connectors on board.
UART0 is connected to the virtual COM port:
======== =====
Signal PIN
======== =====
UART0-RX P0.08
UART0-TX P0.06
======== =====
LEDs and Buttons
================
LEDs
----
The PCA10040 has 4 user-controllable LEDs:
==== =======
LED MCU
==== =======
LED1 P0.17
LED2 P0.18
LED3 P0.19
LED4 P0.20
==== =======
A low output illuminates the LED.
CONFIG_ARCH_LEDS
----------------
If CONFIG_ARCH_LEDS is not defined, then the LEDs are completely under
control of the application. The following interfaces are then available
for application control of the LEDs::
uint32_t board_userled_initialize(void);
void board_userled(int led, bool ledon);
void board_userled_all(uint32_t ledset);
Pushbuttons
-----------
======= =======
BUTTON MCU
======= =======
BUTTON1 P0.13
BUTTON2 P0.14
BUTTON3 P0.15
BUTTON4 P0.16
======= =======
Configurations
==============
Each configuration is maintained in a sub-directory and can be selected as
follow::
tools/configure.sh nrf52832-dk:<subdir>
Where <subdir> is one of the following:
buttons
-------
This configuration shows the use of the buttons subsystem.
nsh
----
Basic NuttShell configuration (console enabled in UART0, exposed via J-Link VCOM connection,
at 115200 bps).
ostest_tickless
---------------
This is a NSH configuration that includes ``apps/testing/ostest`` as a builtin and
enable support for the tick-less OS.
sdc
----
Enables Nordic's SoftDevice controller and uses NuttX BLE stack for the host-layer.
The ``btsak`` application is included as a builtin.
sdc_nimble
----------
Enables Nordic's SoftDevice controller and uses nimBLE for the host-layer.
The ``nimble`` test application can be used to enable a simple GATT server.
wdog
----
This configuration is a simple NSH-based test of the nRF52 watchdog
timer driver using the test at ``apps/examples/watchdog``.

View file

@ -28,8 +28,8 @@ Pin Mapping
===== =========== ==========
Pin Signal Notes
===== =========== ==========
P0.6 User Button Active LOW
P0.7 User LED Active LOW
P0.06 User Button Active LOW
P0.07 User LED Active LOW
P0.26 UART TXO
P0.27 UART RXI
===== =========== ==========

View file

@ -0,0 +1,140 @@
===========
nRF52840-DK
===========
The `NRF52840-DK (PCA10056) <https://www.nordicsemi.com/Products/Development-hardware/nRF52840-DK>`_
is a development board for the nRF52840 SoC from Nordic.
Serial Console
==============
The PCA10056 default console is the UART0.
The PCA10056 does not have RS-232 drivers or serial connectors on board.
UART0 is connected to the virtual COM port:
======== =====
Signal PIN
======== =====
UART0-RX P0.08
UART0-TX P0.06
======== =====
LEDs and Buttons
================
LEDs
----
The PCA10056 has 4 user-controllable LEDs:
==== =======
LED MCU
==== =======
LED1 P0.13
LED2 P0.14
LED3 P0.15
LED4 P0.26
==== =======
A low output illuminates the LED.
Pushbuttons
-----------
======= =======
BUTTON MCU
======= =======
BUTTON1 P0.11
BUTTON2 P0.12
BUTTON3 P0.24
BUTTON4 P0.25
======= =======
Configurations
==============
Each configuration is maintained in a sub-directory and can be selected as
follow::
tools/configure.sh nrf52840-dk:<subdir>
Where <subdir> is one of the following:
adc
----
This configuration shows the use of the ADC peripheral.
buttons
-------
This configuration shows the use of the buttons subsystem.
cdcacm
-------
NuttShell configuration with support for CDC/ACM USB device driver.
composite
---------
NuttShell configuration with support for CDC/ACM with RNDIS composite driver.
highpri
-------
This application demonstrates high priorty interrupt feature of the NuttX.
nsh
----
Basic NuttShell configuration (console enabled in UART0, exposed via J-Link VCOM connection,
at 115200 bps).
ostest_tickless
---------------
This is a NSH configuration that includes ``apps/testing/ostest`` as a builtin
and enable support for the tick-less OS.
pwm
---
This configuration shows the use of the PWM peripheral.
qspi
----
NuttShell configuration with enabled support for on-board MX25R QSPI memory.
rndis
-----
NuttShell configuration with support for RNDIS USB device driver.
sdc
---
Enables Nordic's SoftDevice controller and uses NuttX BLE stack for the host-layer.
The ``btsak`` application is included as a builtin.
sdc_nimble
----------
Enables Nordic's SoftDevice controller and uses nimBLE for the host-layer.
The ``nimble`` test application can be used to enable a simple GATT server.
sx127x
------
NuttShell configuration with support for sx127x chip.
timer
------
This configuration shows the use of the TIMER peripheral.
usbnsh
------
Basic NuttShell configuration (CDCACM console enabled in USB Port, at 115200 bps).

View file

@ -0,0 +1,63 @@
===============
nRF52840-dongle
===============
The `nRF52840-dongle (PCA10059) <https://www.nordicsemi.com/Products/Development-hardware/nrf52840-dongle>`_
is a a small, low-cost USB dongle based on nRF52840 fron Nordic.
Serial Console
==============
===== ========== =====================
Pin Signal Notes
===== ========== =====================
P0.15 UART TX edge soldering points
P0.13 UART RX edge soldering points
===== ========== =====================
LEDs and Buttons
================
LEDs
----
==== =======
LED MCU
==== =======
LED1 P0.06
==== =======
Pushbuttons
-----------
======= =======
BUTTON MCU
======= =======
BUTTON1 P1.06
======= =======
Configurations
==============
Each configuration is maintained in a sub-directory and can be selected as
follow::
tools/configure.sh nrf52840-dongle:<subdir>
Where <subdir> is one of the following:
nsh
----
Basic NuttShell configuration (console enabled in UART0, exposed via soldering points, at 115200 bps).
usbnsh
------
Basic NuttShell configuration (CDCACM console enabled in USB Port, at 115200 bps).
Flash & Debug
=============
Both flashing and debuing is possible only with an external debug proble.

View file

@ -0,0 +1,57 @@
=================
Nordic Thingy:52
=================
The `Thingy:52 (PCA20020) <https://www.nordicsemi.com/Products/Development-hardware/Nordic-Thingy-52>`_
is a prototyping platform build around the nRF52832 from Nordic.
Peripheral Support
==================
================================== ======= =============
Peripheral Support NOTES
================================== ======= =============
UART Yes
Buttons No
LEDs No
NFC No
IMU (MPU-9250) No
Low power accelerometer (LIS2DH12) No
Pressure and temperature (LPS22HB) No
Humidity and temperature (HTS221) No
Color sensor (BH1745NUC) No
Gas sensor (CCS811) No
Microphone (MP34DB02) No
Speaker No
Battery monitoring No
================================== ======= =============
Serial Console
==============
===== ========== ==========
Pin Signal Notes
===== ========== ==========
P0.02 UART TX P4 header
P0.03 UART RX P4 header
===== ========== ==========
Configurations
==============
Each configuration is maintained in a sub-directory and can be selected as
follow::
tools/configure.sh thingy52:<subdir>
Where <subdir> is one of the following:
nsh
----
Basic NuttShell configuration (console enabled in UART0, exposed via P4 header, at 115200 bps).
Flash & Debug
=============
Both flashing and debuing is possible only with an external debug proble.

View file

@ -5,6 +5,30 @@ Nordic nRF52
The nRF52 series of chips from Nordic Semiconductor are based around an ARM Cortex-M4 core running
at 64 MHz and feature Bluetooth Low Energy (BLE) support.
Memory Map
==========
nRF52832
--------
============ ============= ======
Block Name Start Address Length
============ ============= ======
FLASH 0x00000000 512K
RAM 0x20000000 64K
============ ============= ======
nRF52840
--------
============ ============= ======
Block Name Start Address Length
============ ============= ======
FLASH 0x00000000 1024K
RAM 0x20000000 256K
============ ============= ======
Clock Configuration
===================
@ -39,7 +63,7 @@ PDM No
PPI Yes
PWM Yes
QDEC No
QSPI No
QSPI Yes
RADIO Yes Basic
RNG Yes
RTC Yes
@ -52,7 +76,7 @@ TWIM Yes
TWIS No
UART Yes
UARTE No
USBD No
USBD Yes
WDT Yes
========== ======= =====
@ -134,6 +158,12 @@ PWM
PWM is supported via standard driver. This means that more advanced features such as
complex sequences or waveform modes are not yet supported.
QSPI
----
QSPI is supported both in interrupt-based (via EasyDMA) mode and is exposed
via standard QSPI interface.
RNG
---
@ -151,6 +181,11 @@ RTC
The RTC peripheral is exposed as a standard timer, since it is really a low-power
timer, without any date handling capabilities.
USBD
----
The USBD peripheral is exposed via standard USBDEV interface.
WDT
---

View file

@ -1,96 +0,0 @@
README
======
README for NuttX port to Adafruit NRF52 Feather boards.
Contents
========
- Status
- Feather nRF52 board
- Configurations
Status
======
This is the current status of the NRF52 port:
- The basic OS test configuration and the basic NSH configurations
are present and fully verified. This includes: SYSTICK system time,
pin and GPIO configuration, and serial console support.
Feather nRF52 board
===================
https://www.adafruit.com/product/3406
Console
-------
The Feather nRF52 default console is the UART0.
The Feather nRF52 have USB serial bridge chip on board and UART0 is
connected to micro USB connector through the bridge chip.
LEDs
----
The Feather has 2 user-controllable LEDs
LED MCU
LED1 PIN0-17
LED2 PIN0-19
A high output illuminates the LED.
Pushbuttons
-----------
The Feather nRF52 does not have user-controllable buttons. The reset button
on the board is connected to nRF52832 reset pin directly.
Memory Map
==========
Block Start Length
Name Address
--------------------- ---------- ------
FLASH 0x00000000 512K
RAM 0x20000000 64K
Configurations
==============
Each configuration is maintained in a sub-directory and can be selected as
follow:
tools/configure.sh nrf52-feather:<subdir>
Where <subdir> is one of the following:
<board>-nsh:
-----------
This configuration is the NuttShell (NSH) example at examples/nsh/.
NOTES:
1. This configuration uses the mconf-based configuration tool. To
change this configurations using that tool, you should:
a. Build and install the kconfig-mconf tool. See nuttx/README.txt
see additional README.txt files in the NuttX tools repository.
b. Execute 'make menuconfig' in nuttx/ in order to start the
reconfiguration process.
CONFIG_ARCH_LEDS
----------------
If CONFIG_ARCH_LEDS is defined, the LED will be controlled as follows
for NuttX debug functionality (where NC means "No Change").
TBD!
If CONFIG_ARCH_LEDS is not defined, then the LEDs are completely under
control of the application. The following interfaces are then available
for application control of the LEDs:
uint32_t board_userled_initialize(void);
void board_userled(int led, bool ledon);
void board_userled_all(uint32_t ledset);

View file

@ -1,107 +0,0 @@
README
======
README for NuttX port to NRF52832-DK (PCA10040) boards.
Contents
========
- Status
- NRF52832 development kit (PCA10040)
- Configurations
Status
======
This is the current status of the NRF52 port:
- The basic OS test configuration and the basic NSH configurations
are present and fully verified. This includes: SYSTICK system time,
pin and GPIO configuration, and serial console support.
NRF52832 development kit (PCA10040)
===================================
Console
-------
The PCA10040 default console is the UART0.
The PCA10040 does not have RS-232 drivers or serial connectors on board.
UART0 is connected to the virtual COM port:
-------- -----
Signal PIN
-------- -----
UART0-TX P0.06
UART0-RX P0.08
LEDs
----
The PCA10040 has 4 user-controllable LEDs
LED MCU
LED1 PIN0-17
LED2 PIN0-18
LED3 PIN0-19
LED4 PIN0-20
A low output illuminates the LED.
Pushbuttons
-----------
To be provided
Memory Map
==========
Block Start Length
Name Address
--------------------- ---------- ------
FLASH 0x00000000 512K
RAM 0x20000000 64K
Configurations
==============
Each configuration is maintained in a sub-directory and can be selected as
follow:
tools/configure.sh nrf52832-dk:<subdir>
Where <subdir> is one of the following:
nsh:
-----------
This configuration is the NuttShell (NSH) example at examples/nsh/.
NOTES:
1. This configuration uses the mconf-based configuration tool. To
change this configurations using that tool, you should:
a. Build and install the kconfig-mconf tool. See nuttx/README.txt
see additional README.txt files in the NuttX tools repository.
b. Execute 'make menuconfig' in nuttx/ in order to start the
reconfiguration process.
wdog:
------------
This configuration is a simple NSH-based test of the nRF52 watchdog
timer driver using the test at apps/examples/watchdog.
CONFIG_ARCH_LEDS
----------------
If CONFIG_ARCH_LEDS is defined, the LED will be controlled as follows
for NuttX debug functionality (where NC means "No Change").
TBD!
If CONFIG_ARCH_LEDS is not defined, then the LEDs are completely under
control of the application. The following interfaces are then available
for application control of the LEDs:
uint32_t board_userled_initialize(void);
void board_userled(int led, bool ledon);
void board_userled_all(uint32_t ledset);

View file

@ -1,5 +0,0 @@
README
======
README for NuttX port to Sparkfun NRF52832 breakout board.

View file

@ -1,8 +0,0 @@
nRF52840-DK
===========
README for NuttX port to NRF52840-DK (PCA10056) boards.
Status
======
Only the basic NSH configuration is supported for now.

View file

@ -1,8 +0,0 @@
nRF52840-DONGLE
===============
README for NuttX port to NRF52840-DONGLE (PCA10059) boards.
Status
======
Only the basic NSH configuration is supported for now.