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