xref: /nrf52832-nimble/nordic/nrfx/README.md (revision 150812a83cab50279bd772ef6db1bfaf255f2c5b)
1# nrfx
2
3## Overview
4
5nrfx is a standalone set of drivers for peripherals present in Nordic
6Semiconductor's SoCs. It originated as an extract from the nRF5 SDK.
7The intention was to provide drivers that can be used in various environments
8without the necessity to integrate other parts of the SDK into them.
9For the user's convenience, the drivers come with the MDK package. This package
10contains definitions of register structures and bitfields for all supported
11SoCs, as well as startup and initialization files for them.
12
13## Supported SoCs
14
15* nRF51 Series
16* nRF52810
17* nRF52832
18* nRF52840
19* nRF9160
20
21## Directories
22
23```
24 .
25 ├── doc             # Project documentation files
26 ├── drivers         # nrfx drivers files
27 │   └── include     # nrfx drivers headers
28 │   └── src         # nrfx drivers sources
29 ├── hal             # Hardware Access Layer files
30 ├── mdk             # Nordic MDK files
31 ├── soc             # Nordic SoC related files
32 └── templates       # Templates of nrfx integration files
33```
34
35## Generating documentation
36
37nrfx documentation is available in the `doc\html` folder of the release package.
38
39You can also generate documentation yourself from the source code. To do it, install doxygen
40and run one of the scripts: `generate_html_doc.bat` or `generate_html_doc.sh`. Generated
41documentation will be stored in the `doc\html` directory. Use `index.html` to open it.
42