nrfx: Use actual nrfx instead of manually modified files

Warning. This commit breaks backwards compatibility with
Zephyr <= 2.4.0.

With nrfx 2.3.0 it is possible to include the MDK files on
non-ARM platforms. As the MDK has a depenency to cmsis core
files, a simple mocked core_cm4.h has been provided.

By defining NRF_DECLARE_ONLY and NRF_STATIC_INLINE to nothing,
no functions are inlined. This ensures that it is possible to
mock the peripherals.

For a non-zephyr build, the application must provide the
environment varianble NRFX_BASE.

The user of the nRF MDK or nrfx must ensure that the peripheral
pointers are redefined before they are used. This is done in
nrfx_bsim_redef.h. Include this header after including nrf.h
or similar. When using nrfx, this inclusion can be placed in
nrfx_glue.h

For non-zephyr builds, a nrfx_config and nrfx_glue is provided.
Other builds should include nrfx_config_bsim.h and nrfx_glue_bsim.h
in their config and glue files.

The original implementation of the HAL APIs from the real nrfx
is included in `nrf_hal_originals.c`.
All these functions are labelled as weak,
so they can be replaced as needed with new definition in `src/nrfx/hal/`
This removes the need for duplicating code.

Signed-off-by: Rubin Gerritsen <[email protected]>

Author: rugeGerritsen

CMakeLists.txt

@@ -22,14 +22,12 @@ if(CONFIG_BOARD_NRF52_BSIM)
   # module, so that the local modified versions of nrfx files are used instead
   # of those from the original nrfx.
   target_include_directories(zephyr_interface BEFORE INTERFACE
-    ${CMAKE_CURRENT_SOURCE_DIR}/src/
-    ${CMAKE_CURRENT_SOURCE_DIR}/src/nrfx/
-    ${CMAKE_CURRENT_SOURCE_DIR}/src/nrfx/hal/
-    ${CMAKE_CURRENT_SOURCE_DIR}/src/nrfx/mdk/
+    ${CMAKE_CURRENT_SOURCE_DIR}/src/nrfx/mdk_replacements
   )
 
   zephyr_include_directories(
     src/HW_models/
+    src/nrfx/nrfx_replacements
   )
 
   zephyr_library()
@@ -44,7 +42,6 @@ if(CONFIG_BOARD_NRF52_BSIM)
     $ENV{BSIM_COMPONENTS_PATH}/ext_2G4_libPhyComv1/src/
     $ENV{BSIM_COMPONENTS_PATH}/libRandv2/src/
     src/HW_models/
-    src/nrfx/
   )
 
 endif()

Makefile

@@ -8,12 +8,21 @@ include ${BSIM_BASE_PATH}/common/pre.make.inc
 
 SRCS:=$(shell find src/ -name "*.c")
 
+ifndef NRFX_BASE
+$(error NRFX_BASE must be set to the nrfx checkout folder)
+endif
+
 INCLUDES:=-I${libUtilv1_COMP_PATH}/src/ \
           -I${libPhyComv1_COMP_PATH}/src/ \
           -I${2G4_libPhyComv1_COMP_PATH}/src \
           -I${libRandv2_COMP_PATH}/src/ \
+          -Isrc/nrfx/mdk_replacements \
           -Isrc/HW_models/ \
-          -Isrc/nrfx/
+          -Isrc/nrfx_config \
+          -Isrc/nrfx/nrfx_replacements \
+          -I${NRFX_BASE} \
+          -I${NRFX_BASE}/mdk
+
 
 LIB_NAME:=libNRF52_hw_models.32
 A_LIBS:=
@@ -25,7 +34,8 @@ ARCH:=-m32
 WARNINGS:=-Wall -pedantic
 COVERAGE:=
 CFLAGS:=${ARCH} ${DEBUG} ${OPT} ${WARNINGS} -MMD -MP -std=c11 \
-        ${INCLUDES} -fdata-sections -ffunction-sections
+        ${INCLUDES} -fdata-sections -ffunction-sections \
+        -DNRF52832_XXAA
 LDFLAGS:=${ARCH} ${COVERAGE}
 CPPFLAGS:=
 

docs/README.md

@@ -1,11 +1,26 @@
 **Models of some of the HW present in a NRF52xxx.**<br>
 Where relevant differences exist, these models try to align with a NRF52382.
 
-This repo contains both models of the NRF52 HW as well as a replacement nRFx
-HAL.<br>
-This replacement HAL is a modified version of the real nRFx to be used with
-these models.
-With it, the Zephyr SW should work without needing further changes.
+This repo contains both models of the NRF52 HW as well as some replacement nrfx
+HAL functions. When used in combination with the real nrfx, these should enable code
+meant for the nrfx to run without needing further changes.
+This includes Zephyr SW.
+
+When compiling this component using the provided Makefile (not with Zephyr's build system),
+the environment variable `NRFX_BASE` must be set to the path where a nrfx has been cloned. 
+The nrfx must be at least version 2.3.0.
+So for example, if the nrfx has been cloned as:
+
+```
+cd /some_path/nrfx/
+git clone [email protected]:NordicSemiconductor/nrfx.git .
+```
+`NRFX_BASE` must be set as:
+
+```
+export NRFX_BASE=/some_path/nrfx/
+```
+
 See the [nrfx/hal/README.md](../src/nrfx/hal/README.md) for more details.
 
 This models can be used directly with

docs/README_HW_models.md

@@ -86,7 +86,7 @@ thread into the HW models thread.
 
 ### The SW registers IF
 
-Each perihperal model which has HW registers accessible by SW, presents
+Each peripheral model which has HW registers accessible by SW, presents
 a structure which matches those registers' layout.
 This structure will be allocated somewhere in the process memory, but certainly
 not in the same address as in the real HW.

src/HW_models/NRF_AAR.h

@@ -6,7 +6,7 @@
 #ifndef _NRF_HW_MODEL_AAR_H
 #define _NRF_HW_MODEL_AAR_H
 
-#include "NRF_regs.h"
+#include "nrfx.h"
 
 #ifdef __cplusplus
 extern "C"{

src/HW_models/NRF_AES_CCM.h

@@ -6,7 +6,7 @@
 #ifndef _NRF_HW_MODEL_AES_CCM_H
 #define _NRF_HW_MODEL_AES_CCM_H
 
-#include "NRF_regs.h"
+#include "nrfx.h"
 #include <stdbool.h>
 
 #ifdef __cplusplus

src/HW_models/NRF_AES_ECB.h

@@ -6,7 +6,7 @@
 #ifndef _NRF_HW_MODEL_AES_ECB_H
 #define _NRF_HW_MODEL_AES_ECB_H
 
-#include "NRF_regs.h"
+#include "nrfx.h"
 
 #ifdef __cplusplus
 extern "C"{

src/HW_models/NRF_CLOCK.h

@@ -6,7 +6,7 @@
 #ifndef _NRF_HW_MODEL_CLOCK_H
 #define _NRF_HW_MODEL_CLOCK_H
 
-#include "NRF_regs.h"
+#include "nrfx.h"
 
 #ifdef __cplusplus
 extern "C"{

src/HW_models/NRF_FICR.h

@@ -6,7 +6,7 @@
 #ifndef _NRF_HW_MODEL_FICR_H
 #define _NRF_HW_MODEL_FICR_H
 
-#include "NRF_regs.h"
+#include "nrfx.h"
 
 #ifdef __cplusplus
 extern "C"{

src/HW_models/NRF_GPIO.h

@@ -6,7 +6,7 @@
 #ifndef _NRF_HW_MODEL_GPIO_H
 #define _NRF_HW_MODEL_GPIO_H
 
-#include "NRF_regs.h"
+#include "nrfx.h"
 
 #ifdef __cplusplus
 extern "C"{