[libbsd 07/22] libbsd.txt: Move BSP related content

Sebastian Huber sebastian.huber at embedded-brains.de
Mon May 23 14:33:30 UTC 2022


---
 CONTRIBUTING.rst | 22 ++++++++++++++++++++++
 libbsd.txt       | 19 -------------------
 2 files changed, 22 insertions(+), 19 deletions(-)

diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
index 1bcdca31..1d45f0ef 100644
--- a/CONTRIBUTING.rst
+++ b/CONTRIBUTING.rst
@@ -394,3 +394,25 @@ build process.  The ``Makefile.todo`` file performs this manually.  The should b
 included in ``freebsd-to-rtems.py`` script some time in the future.  For details,
 see also
 `KOBJ(9) <http://www.freebsd.org/cgi/man.cgi?query=kobj&sektion=9&apropos=0>`_.
+
+Reference Board Support Package
+===============================
+
+The reference BSP for LibBSD development is ``arm/xilinx_zynq_a9_qemu``.  All
+patches shall be tested for this BSP.  The BSP runs on the Qemu simulator which
+has some benefits for development and test of the LibBSD
+
+* ``NULL`` pointer read and write protection,
+* Qemu is a fast simulator,
+* Qemu provides support for GDB watchpoints,
+* Qemu provides support for virtual Ethernet networks, e.g. TUN and bridge
+  devices (you can run multiple test instances on one virtual network).
+
+Board Support Package Requirements
+==================================
+
+In FreeBSD, interrupt handler may use mutexes.  In RTEMS, using mutexes from
+within interrupt context is not allowed, so the Board Support Package (BSP)
+should support the
+`Interrupt Manager <https://docs.rtems.org/branches/master/c-user/interrupt/directives.html#rtems-interrupt-server-handler-install>`_
+in general.
diff --git a/libbsd.txt b/libbsd.txt
index 2cb7fb07..c86ffc99 100644
--- a/libbsd.txt
+++ b/libbsd.txt
@@ -7,7 +7,6 @@ RTEMS BSD Library Guide
 
 == Getting Started
 
-=== Tool Chain ===
 
 You need a tool chain for RTEMS based on the latest RTEMS Source Builder (RSB).
 
@@ -33,14 +32,6 @@ status' says `rtems_waf` need updating run the submodule update command:
  $ git submodule sync
  $ git submodule rtems_waf update
 
-=== Board Support Package Requirements ===
-
-You need the latest RTEMS version to build the libbsd master.  The Board
-Support Package (BSP) must support the
-http://www.rtems.org/onlinedocs/doxygen/cpukit/html/group\__rtems\__interrupt__extension.html[Interrupt Manager Extension]
-// The first underscores have to be masked to stop asciidoc interpreting them
-to make use of generic FreeBSD based drivers.
-
 === Board Support Package Configuration and Build ===
 
 You need to configure RTEMS for the desired BSP and install it.  The BSP must
@@ -66,16 +57,6 @@ ${HOME}/git-rtems/configure \
         make && \
         make install
 -------------------------------------------------------------------------------
-
-The `arm/xilinx_zynq_a9_qemu` BSP running on the Qemu simulator has some
-benefits for development and test of the BSD library
-
-* it offers a NULL pointer read and write protection,
-* Qemu is a fast simulator,
-* Qemu provides support for GDB watchpoints,
-* Qemu provides support for virtual Ethernet networks, e.g. TUN and bridge
-devices (you can run multiple test instances on one virtual network).
-
 === BSD Library Configuration and Build ===
 
 The build system based on the Waf build system. To build with Waf please refer
-- 
2.35.3



More information about the devel mailing list