Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update nordic board documentation [was: Rename nrf52dk_base to nrf52_base] #1784

Merged
merged 1 commit into from
May 12, 2020
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
39 changes: 39 additions & 0 deletions boards/nordic/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
Nordic Family of Boards
=======================

There are several closely related boards from Nordic supported, or previously
supported, by Tock. Unfortunately, the Nordic naming scheme is a bit confusing,
so two notions get conflated:

- The `nrf52xxx` family of chips, specifically for Tock the nrf52832 and nrf52840, is often referred to as the "nrf52" family of chips.
- The development kit for the nrf52840 is called the nrf52840dk; the development kit for the nrf52832 is called nrf52dk.

The result is:

- "nrf52" => nrf52832 chip or nrf52840 chip, which are on the nrf52dk and nrf52840dk respectively
- "nrf52dk" => development board with the nrf52832 chip
- "nrf52840dk" => development board with the nrf52840 chip
- "nrf52840_dongle" => minimalist board with the nrf52840 chip

This naming matches the products released by Nordic, but users should be careful.

Additionally, the acd52832 board is a platform developed by Aconno that
features a nrf52832 chip.


Tock Hierarchy
--------------

As much is shared across these platforms, Tock uses an "nrf52dk_base" crate.
This is a library crate that contains code shared by boards that include any
chips from the nrf52 family.


Legacy Boards
-------------

Tock 1.3 was the last release with support for the nrf51, a old chip in this
family that has a Cortex M0 with no MPU.

Code for the nrf51dk platform is available in the
[tock archive](https://github.com/tock/tock-archive/tree/master/nrf51dk).