You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

45 lines
1.5 KiB

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