1**Models of some of the HW present in a NRF52xxx.**<br>
2Where relevant differences exist, these models try to align with a NRF52382.
3
4This repo contains both models of the NRF52 HW as well as some replacement nrfx
5HAL functions. When used in combination with the real nrfx, these should enable code
6meant for the nrfx to run without needing further changes.
7This includes Zephyr SW.
8
9When compiling this component using the provided Makefile (not with Zephyr's build system),
10the environment variable `NRFX_BASE` must be set to the path where a nrfx has been cloned.
11The nrfx must be at least version 2.3.0.
12So for example, if the nrfx has been cloned as:
13
14```
15cd /some_path/nrfx/
16git clone git@github.com:NordicSemiconductor/nrfx.git .
17```
18`NRFX_BASE` must be set as:
19
20```
21export NRFX_BASE=/some_path/nrfx/
22```
23
24See the [nrfx/hal/README.md](../src/nrfx/hal/README.md) for more details.
25
26This models can be used directly with
27[Zephyr's nrf52_bsim target](https://docs.zephyrproject.org/latest/boards/posix/nrf52_bsim/doc/index.html).
28
29The NRF_RADIO peripheral model uses [BabbleSim](http://babblesim.github.io)
30for the radio environment simulation.
31
32For more information about the HW models, or how to use them without the
33nrf52_bsim please refer to [README_HW_models.md](./README_HW_models.md)
34
35## Faithfullness of these models
36
37These models are accurate enough to allow the current Zephyr to run, and
38its BLE stack to function. For more details please see the notes on the source
39files for each peripheral model.
40
41These models are based solely on
42[the public SOC specifications](https://infocenter.nordicsemi.com/topic/struct_nrf52/struct/nrf52832.html?cp=3_1)
43
44They have been developed without any other knowledge and probably contain
45inacuracies, and defects.
46
47Several of the peripherals which are not necessary for typical BLE applications
48are not modelled. Moreover, in the modelled peripherals, functionality which is
49not used in the Zephyr drivers is normally not modelled either.
50The [TODO](../TODO.txt) file list some mayor omissions.
51It is certainly possible to expand these models to include the rest.
52