Skip to content

Commit 3fcdaba

Browse files
authored
docs: Add documentation of the ports directory
1 parent 60f3c13 commit 3fcdaba

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

ports/index.rst

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,23 @@
22
Ports
33
===========================================
44

5+
A "port" is the board‑/hardware‑specific implementation layer that adapts the generic plumCore framework
6+
to run on a particular microcontroller board or hardware platform.
7+
8+
It contains, among others:
9+
10+
- clock initialization happening in the early stage of the boot process
11+
- configuration of GPIO ports
12+
- instantiation of services which are run on the target hardware and injecting the required dependencies
13+
- advertising interfaces of the instantiated services
14+
- interrupt to service glue for interrupts
15+
- hardware revision detecting logic for cases when a single firmware runs on hardware of
16+
multiple (semi-)compatible revisions
17+
- linker script for the target MCU
18+
- FreeRTOS configuration specific for the target MCU
19+
- SConscript to build the port code
20+
- documentation of the port in the doxygen form (for the code) and reST (well, for the rest and high-level documents)
21+
522
.. toctree::
623

724
nwdaq-br28-fdc/index.rst

0 commit comments

Comments
 (0)