初始版本

This commit is contained in:
xiaozhengsheng
2025-08-19 09:49:41 +08:00
parent 10f1ddf1c1
commit 6df0f7d96e
2974 changed files with 1712873 additions and 54 deletions

View File

@@ -0,0 +1,506 @@
.appliesto {background-color:#3D578C;color:#fff}
div.header
{
background-image:none;
background-color: #FFF;
border-bottom: 0px;
}
body, table, div, p, dl {
font-size: 16px;
font-family: Open Sans, Calibri, Arial, Sans-Serif;
color: #474747;
line-height: 20px;
}
a.code {
color: #1c99c7;
}
a.el {
font-weight: normal;
}
.contents a:visited, a:visited.code {
color: #16779a;
}
.title {
font-size: 1.34em
}
h1 {
font-size: 1.25em
}
h2 {
font-size: 1.15em
}
h3 {
font-size: 1.05em
}
h4 {
font-size: 1em
}
table.memberdecls, table.directory, table.memname {
margin:0px;
border:0px;
-moz-box-shadow: 0 0px 0px #d1d1d1;
-webkit-box-shadow: 0 0px 0px #d1d1d1;
box-shadow: 0 0px 0px #d1d1d1;
}
table.memberdecls tr {
padding-left:0px;
}
table.memberdecls tr:hover td, table.memname tr:hover td {
background: inherit;
}
table.directory tr.even, table.directory tr.odd {
background: inherit;
}
table.memberdecls td, table.directory td, table.directory td.desc {
border:0px;
padding: 2px 0px 0px;
}
table.memberdecls td.memSeparator {
background-color:#inherit;
padding:2px;
border-bottom: 1px dotted #DEE4F0;
}
.mdescLeft, .mdescRight,
.memItemLeft, .memItemRight,
.memTemplItemLeft, .memTemplItemRight, .memTemplParams {
background-color: inherit;
}
div.levels {
display:none;
}
table.retval {
border:#ccc 1px solid;
}
table.memname td, table.params td, table.retval td {
padding:5px;
border:0px;
}
div.fragment div.line {
font-size: 14px;
line-height:18px;
}
table.fieldtable, table.params, table.retval {
-moz-box-shadow: none;
-webkit-box-shadow: none;
box-shadow: none;
}
table.fieldtable th {
border:none;
border-bottom:1px solid #A8B8D9;
}
table.blank, table.blank tr th, table.blank tr td {
border:none;
-moz-box-shadow: none;
-webkit-box-shadow: none;
box-shadow: none;
}
table.blank tr:hover td {
background: #ffffff;
}
#projectlogo
{
text-align: left;
vertical-align: middle;
border-collapse: separate;
}
#projectname
{
font-size: 40px;
font-family: Open Sans, Calibri, Arial, Sans-Serif;
margin: 0px;
padding: 2px 0px;
}
#projectbrief
{
font-size: 30px;
margin: 0px;
padding: 0px;
}
#titlearea
{
border-bottom: 1px solid #e0e0e0;
}
.label a, .item a
{
border-bottom: none;
}
#nav-tree {
background-image: none;
background-color: #FAFAFA;
}
div.contents {
margin-left: 30px;
margin-right: 30px;
}
div.header {
margin-left: 20px;
}
table td.doclinks a {
font-size: 12px;
font-style: italic;
color: #e97c25;
border: 1px solid #e97c25;
padding: 2px 5px;
text-decoration: none;
}
table td.docselected a {
background: #e97c25;
color: #fff;
}
table td.doclinkintro {
font-size: 12px;
font-style: italic;
}
/* nordic.css */
.p {
margin-top: .3em;
}
/* fix for table spacing */
td p.p {
margin: 0em;
padding: 0px;
}
dt.line_sep {
border-top: solid #c9c9c9 1px;
padding-top: 5px;
}
a
{
color: #1c99c7;
text-decoration: none;
border-bottom: 1px #e5e5e5 solid;
}
a:visited
{
color: #16779a;
}
a:hover
{
color: #none;
text-decoration: underline;
border: none;
}
a:active
{
}
ul.ul {
margin-top: 4px;
margin-bottom: 10px;
}
a[href*='.pdf'] {
background:transparent url(./pdf.png) center left no-repeat;
padding-left:22px;
line-height:18px;
}
a[href*='.zip'] {
background:transparent url(./zip_s.png) center left no-repeat;
padding-left:22px;
line-height:18px;
}
a[href*='.exe'] {
background:transparent url(./execute_s.png) center left no-repeat;
padding-left:22px;
line-height:18px;
}
a[href*='.msi'] {
background:transparent url(./msi_s.png) center left no-repeat;
padding-left:22px;
line-height:18px;
}
table a:link {
color: #1c99c7;
text-decoration: none;
border-bottom: 1px #e5e5e5 solid;
}
table a:visited {
color: #16779a;
}
table a:active,
table a:hover {
color: #none;
text-decoration: underline;
border: none;
}
table {
font-family:Calibri, Arial, Sans-Serif;
color:#474747;
font-size:16px;
margin-left: auto;
margin-right: auto;
border:#ccc 1px solid;
-moz-box-shadow: 0 1px 2px #d1d1d1;
-webkit-box-shadow: 0 1px 2px #d1d1d1;
box-shadow: 0 1px 2px #d1d1d1;
}
table th {
color: #000;
font-size: 18px;
font-weight: bold;
text-align: left;
padding:10px 15px 10px 10px;
border-top:1px solid #7eceed;
border-bottom:1px solid #7eceed;
border-right:1px solid #7eceed;
border-left:1px solid #7eceed;
background: #7eceed;
background: -webkit-gradient(linear, left top, left bottom, from(#7eceed), to(#7eceed));
background: -moz-linear-gradient(top, #7eceed, #7eceed);
}
table th.center {
text-align: center;
}
table tr {
text-align: left;
}
table td {
padding:5px 5px 5px 10px;
border-top: 1px solid #ffffff;
border-bottom:1px solid #e0e0e0;
border-left: 1px solid #e0e0e0;
border-right: 1px solid #e0e0e0;
}
table tr:hover td {
background: #ebebeb;
background: -webkit-gradient(linear, left top, left bottom, from(#f2f2f2), to(#f0f0f0));
background: -moz-linear-gradient(top, #f2f2f2, #f0f0f0);
}
img {
border: 0;
margin-left: auto;
margin-right: auto;
max-width:100%;
}
/* make svg files scale in IE. compatible with Dita OT v2.0
img:not(.png) {
width: 100%;
margin-left: auto;
margin-right: auto;
}
*/
/* make svg files scale in IE */
embed.image:not(.png):not(.gif):not(.jpg) {
width: 100%;
margin-left: auto;
margin-right: auto;
margin-bottom: 15px;
}
svg {
position: absolute;
top: 0;
left: 0;
}
caption {
caption-side: bottom;
text-align: center;
font-size: 100%;
font-weight: bold;
margin-top: 15px;
margin-bottom: 35px;
}
figdesc {
caption-side: bottom;
text-align: center;
font-size: 100%;
font-weight: bold;
margin-top: 15px;
margin-bottom: 20px;
}
/* to get figure captions to appear below the image and center */
div.fig {
display: table;
width: 100%;
margin-top: 10px;
margin-bottom: 55px;
}
div.fig span.figcap {
display:table-footer-group;
text-align:center;
font-size: 100%;
font-weight: bold;
margin-top: 10px;
margin-bottom: 20px;
font-style: normal;
}
div.fig div.imagecenter {
display:table-row-group;
}
/* fix to hide borders in image maps (Chrome only) */
img.map, map area{
outline: none;
}
/* fix placement of <sup>&reg;</sup> */
sup {
line-height: 1em;
}
.sdkversion span {
font-size: 12px;
font-style: italic;
color: #e97c25;
border: 1px solid #e97c25;
padding: 2px 5px;
}
.sdkversion {
text-align: right;
}
.whichSDs span,.whichnRF span {
font-size: 12px;
font-style: italic;
color: #e97c25;
border: 1px solid #e97c25;
padding: 2px 5px;
}
.whichSDs.nRF52 span,.whichnRF.nRF52 span {
color: #e97c25;
border-color: #e97c25;
}
.whichSDs.nRF52840 span,.whichnRF.nRF52840 span {
color: #0081B7;
border-color: #0081B7;
}
.whichSDs.nRF51 span,.whichnRF.nRF51 span {
color: #7f7f7f;
border-color: #7f7f7f;
}
div.whichnRF {
padding-bottom: 5px;
}
span.whichnRF{
font-size: 12px;
font-style: italic;
color: #e97c25;
border: 1px solid #e97c25;
padding: 2px 5px;
}
span.whichnRF.nRF52 {
color: #e97c25;
border-color: #e97c25;
}
span.whichnRF.nRF52840 {
color: #0081B7;
border-color: #0081B7;
}
span.whichnRF.nRF51 {
color: #7f7f7f;
border-color: #7f7f7f;
}
.orange {
color: #e97c25;
}
hr {
margin-top:20px;
border-top:1px solid #8EA7B0;
}
.directory td.entry {
white-space: normal;
width:50%;
}
/* overrides */
.topicfooter {
text-align: right;
// margin-top: 1px;
padding-right: 10px;
box-shadow: inset 0px 1px 0px 0px #e0e0e0;
font-size: 13px;
}

Binary file not shown.

After

Width:  |  Height:  |  Size: 26 KiB

View File

@@ -0,0 +1,187 @@
<doxygenlayout version="1.0">
<!-- Navigation index tabs for HTML output -->
<navindex>
<tab type="mainpage" visible="yes" title="Home"/>
<tab type="pages" visible="yes" title="" intro=""/>
<tab type="modules" visible="yes" title="API Reference" intro=""/>
<tab type="namespaces" visible="no" title="">
<tab type="namespacelist" visible="yes" title="" intro=""/>
<tab type="namespacemembers" visible="yes" title="" intro=""/>
</tab>
<tab type="usergroup" visible="yes" title="Data Structures">
<tab type="classlist" visible="yes" title="" intro=""/>
<tab type="classindex" visible="$ALPHABETICAL_INDEX" title=""/>
<tab type="hierarchy" visible="no" title="" intro=""/>
<tab type="classmembers" visible="yes" title="" intro=""/>
</tab>
<tab type="files" visible="no" title="">
<tab type="filelist" visible="yes" title="" intro=""/>
<tab type="globals" visible="yes" title="" intro=""/>
</tab>
<tab type="examples" visible="yes" title="Source" intro=""/>
</navindex>
<!-- Layout definition for a class page -->
<class>
<briefdescription visible="yes"/>
<includes visible="$SHOW_INCLUDE_FILES"/>
<inheritancegraph visible="$CLASS_GRAPH"/>
<collaborationgraph visible="$COLLABORATION_GRAPH"/>
<memberdecl>
<nestedclasses visible="yes" title=""/>
<publictypes title=""/>
<publicslots title=""/>
<signals title=""/>
<publicmethods title=""/>
<publicstaticmethods title=""/>
<publicattributes title=""/>
<publicstaticattributes title=""/>
<protectedtypes title=""/>
<protectedslots title=""/>
<protectedmethods title=""/>
<protectedstaticmethods title=""/>
<protectedattributes title=""/>
<protectedstaticattributes title=""/>
<packagetypes title=""/>
<packagemethods title=""/>
<packagestaticmethods title=""/>
<packageattributes title=""/>
<packagestaticattributes title=""/>
<properties title=""/>
<events title=""/>
<privatetypes title=""/>
<privateslots title=""/>
<privatemethods title=""/>
<privatestaticmethods title=""/>
<privateattributes title=""/>
<privatestaticattributes title=""/>
<friends title=""/>
<related title="" subtitle=""/>
<membergroups visible="yes"/>
</memberdecl>
<detaileddescription title=""/>
<memberdef>
<inlineclasses title=""/>
<typedefs title=""/>
<enums title=""/>
<constructors title=""/>
<functions title=""/>
<related title=""/>
<variables title=""/>
<properties title=""/>
<events title=""/>
</memberdef>
<allmemberslink visible="yes"/>
<usedfiles visible="$SHOW_USED_FILES"/>
<authorsection visible="yes"/>
</class>
<!-- Layout definition for a namespace page -->
<namespace>
<briefdescription visible="yes"/>
<memberdecl>
<nestednamespaces visible="yes" title=""/>
<classes visible="yes" title=""/>
<typedefs title=""/>
<enums title=""/>
<functions title=""/>
<variables title=""/>
<membergroups visible="yes"/>
</memberdecl>
<detaileddescription title=""/>
<memberdef>
<inlineclasses title=""/>
<typedefs title=""/>
<enums title=""/>
<functions title=""/>
<variables title=""/>
</memberdef>
<authorsection visible="yes"/>
</namespace>
<!-- Layout definition for a file page -->
<file>
<briefdescription visible="yes"/>
<includes visible="$SHOW_INCLUDE_FILES"/>
<includegraph visible="$INCLUDE_GRAPH"/>
<includedbygraph visible="$INCLUDED_BY_GRAPH"/>
<sourcelink visible="yes"/>
<memberdecl>
<classes visible="yes" title=""/>
<namespaces visible="yes" title=""/>
<defines title=""/>
<typedefs title=""/>
<enums title=""/>
<functions title=""/>
<variables title=""/>
<membergroups visible="yes"/>
</memberdecl>
<detaileddescription title=""/>
<memberdef>
<inlineclasses title=""/>
<defines title=""/>
<typedefs title=""/>
<enums title=""/>
<functions title=""/>
<variables title=""/>
</memberdef>
<authorsection/>
</file>
<!-- Layout definition for a group page -->
<group>
<briefdescription visible="yes"/>
<groupgraph visible="$GROUP_GRAPHS"/>
<memberdecl>
<nestedgroups visible="yes" title=""/>
<dirs visible="yes" title=""/>
<files visible="yes" title=""/>
<namespaces visible="yes" title=""/>
<classes visible="yes" title=""/>
<defines title=""/>
<typedefs title=""/>
<enums title=""/>
<enumvalues title=""/>
<functions title=""/>
<variables title=""/>
<signals title=""/>
<publicslots title=""/>
<protectedslots title=""/>
<privateslots title=""/>
<events title=""/>
<properties title=""/>
<friends title=""/>
<membergroups visible="yes"/>
</memberdecl>
<detaileddescription title=""/>
<memberdef>
<pagedocs/>
<inlineclasses title=""/>
<defines title=""/>
<typedefs title=""/>
<enums title=""/>
<enumvalues title=""/>
<functions title=""/>
<variables title=""/>
<signals title=""/>
<publicslots title=""/>
<protectedslots title=""/>
<privateslots title=""/>
<events title=""/>
<properties title=""/>
<friends title=""/>
</memberdef>
<authorsection visible="yes"/>
</group>
<!-- Layout definition for a directory page -->
<directory>
<briefdescription visible="yes"/>
<directorygraph visible="yes"/>
<memberdecl>
<dirs visible="yes"/>
<files visible="yes"/>
</memberdecl>
<detaileddescription title=""/>
</directory>
</doxygenlayout>

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.2 KiB

View File

@@ -0,0 +1,55 @@
/**
@page nrfx_drv_supp_matrix Driver support matrix
The following matrix shows which drivers are supported by specific Nordic SoCs.
@{
Driver | nRF51 Series | nRF52810/nRF52811 | nRF52820 | nRF52832 | nRF52833 | nRF52840 | nRF9160 |
-----------------|--------------|-------------------| -------------| -------------| -------------| -------------| -------------|
@ref nrf_aar |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagRedCross |
@ref nrf_adc |@tagGreenTick |@tagRedCross |@tagRedCross |@tagRedCross |@tagRedCross |@tagRedCross |@tagRedCross |
@ref nrf_acl |@tagRedCross |@tagRedCross |@tagGreenTick |@tagRedCross |@tagGreenTick |@tagGreenTick |@tagRedCross |
@ref nrf_bprot |@tagRedCross |@tagGreenTick |@tagRedCross |@tagGreenTick |@tagRedCross |@tagRedCross |@tagRedCross |
@ref nrf_ccm |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagRedCross |
@ref nrf_clock |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |
@ref nrf_comp |@tagRedCross |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagRedCross |
@ref nrf_dppi |@tagRedCross |@tagRedCross |@tagRedCross |@tagRedCross |@tagRedCross |@tagRedCross |@tagGreenTick |
@ref nrf_ecb |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagRedCross |
@ref nrf_ficr |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |
@ref nrf_gpio |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |
@ref nrf_gpiote |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |
@ref nrf_i2s |@tagRedCross |@tagRedCross |@tagRedCross |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |
@ref nrf_kmu |@tagRedCross |@tagRedCross |@tagRedCross |@tagRedCross |@tagRedCross |@tagRedCross |@tagGreenTick |
@ref nrf_lpcomp |@tagGreenTick |@tagRedCross |@tagRedCross |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagRedCross |
@ref nrf_mpu |@tagGreenTick |@tagRedCross |@tagRedCross |@tagRedCross |@tagRedCross |@tagRedCross |@tagRedCross |
@ref nrf_mwu |@tagRedCross |@tagRedCross |@tagRedCross |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagRedCross |
@ref nrf_nfct |@tagRedCross |@tagRedCross |@tagRedCross |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagRedCross |
@ref nrf_nvmc |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagRedCross |
@ref nrf_pdm |@tagRedCross |@tagGreenTick |@tagRedCross |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |
@ref nrf_power |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |
@ref nrf_ppi |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagRedCross |
@ref nrf_pwm |@tagRedCross |@tagGreenTick |@tagRedCross |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |
@ref nrf_qdec |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagRedCross |
@ref nrf_qspi |@tagRedCross |@tagRedCross |@tagRedCross |@tagRedCross |@tagRedCross |@tagGreenTick |@tagRedCross |
@ref nrf_radio |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagRedCross |
@ref nrf_rng |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagRedCross |
@ref nrf_rtc |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |
@ref nrf_saadc |@tagRedCross |@tagGreenTick |@tagRedCross |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |
@ref nrf_spi |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagRedCross |
@ref nrf_spim |@tagRedCross |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |
@ref nrf_spis |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |
@ref nrf_spu |@tagRedCross |@tagRedCross |@tagRedCross |@tagRedCross |@tagRedCross |@tagRedCross |@tagGreenTick |
@ref nrf_systick |@tagRedCross |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |
@ref nrf_swi_egu |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |
@ref nrf_temp |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagRedCross |
@ref nrf_timer |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |
@ref nrf_twi |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagRedCross |
@ref nrf_twim |@tagRedCross |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |
@ref nrf_twis |@tagRedCross |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |
@ref nrf_uart |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagRedCross |
@ref nrf_uarte |@tagRedCross |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |
@ref nrf_usbd |@tagRedCross |@tagRedCross |@tagGreenTick |@tagRedCross |@tagGreenTick |@tagGreenTick |@tagRedCross |
@ref nrf_vmc |@tagRedCross |@tagRedCross |@tagRedCross |@tagRedCross |@tagRedCross |@tagRedCross |@tagGreenTick |
@ref nrf_wdt |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |@tagGreenTick |
@}
*/

View File

@@ -0,0 +1,2 @@
del html\*.* /Q
doxygen nrfx.doxyfile

View File

@@ -0,0 +1,2 @@
rm -rf html
doxygen nrfx.doxyfile

View File

@@ -0,0 +1,89 @@
/**
@mainpage Introduction
@em nrfx is a standalone set of drivers for peripherals present in Nordic
Semiconductor's SoCs. It originated as an extract from the nRF5 SDK.
The intention was to provide drivers that can be used in various environments
without the necessity to integrate other parts of the SDK into them.
For the user's convenience, the drivers come with the MDK package. This package
contains definitions of register structures and bitfields for all supported
SoCs, as well as startup and initialization files for them.
Refer to the @ref nrfx_drv_supp_matrix to check which drivers are suitable
for a given SoC.
@section nrfx_integration Integration
The purpose of @em nrfx is to make it possible to use the same set of peripheral
drivers in various environments, from RTOSes to bare metal applications.
Hence, for a given host environment, a light integration layer must be provided
that implements certain specific routines, like interrupt management, critical
sections, assertions, or logging. This is done by filling a predefined set of
macros with proper implementations (or keeping some empty if desired) in files
named:
- @ref nrfx_glue
- @ref nrfx_log
Templates of these files are provided
in the <a href="../../templates/">templates</a> subfolder. Their customized
versions can be placed in any location within the host environment that the
used compiler can access via include paths.
In addition, the following locations should be specified as include paths
([nrfx] stands for the @em nrfx root folder location):
@code
[nrfx]/
[nrfx]/drivers/include
[nrfx]/mdk
@endcode
@section nrfx_irq_handlers IRQ handlers
The IRQ handlers in all drivers are implemented as ordinary API functions
named "nrfx_*_irq_handler". They can be bound to some structures or called in
a specific way according to the requirements of the host environment.
To install the handlers in the standard MDK way, you must only add the following
line to the @ref nrfx_glue file:
@code
#include <soc/nrfx_irqs.h>
@endcode
This will cause the preprocessor to properly rename all the IRQ handler
functions so that the linker could install them in the vector table.
@section nrfx_configuration Configuration
The drivers use both dynamic (run time) and static (compile time) configuration.
Dynamic configuration is done by specifying desired options in configuration
structures passed to the drivers during their initialization.
Refer to the API reference for a given driver to see the members of its
configuration structure.
Static configuration allows enabling and disabling (excluding their code from
compilation) particular drivers or in some cases their specific features,
defining default parameters for dynamic configuration, parametrization of
logging in particular drivers. It is done by specifying desired values of macros
in a file named:
- nrfx_config.h
This file, similarly to the integration files mentioned above, can be placed
in any suitable location within the host environment.
The <a href="../../templates/">templates</a> subfolder contains templates of
configuration files for all currently supported Nordic SoCs placed in respective
subfolders.
Refer to the "driver configuration" section in the API reference for a given
driver for more information regarding configuration options available for it.
@section nrfx_additional_reqs Additional requirements
Nordic SoCs are based on ARM® Cortex™-M series processors. Before you can
start developing with @em nrfx, you must add the CMSIS header files to include
paths during the compilation process. Download these files from the following
website:
- <a href="https://github.com/ARM-software/CMSIS"> ARM® CMSIS repository</a>
(CMSIS/Include directory)
*/

View File

@@ -0,0 +1,56 @@
/**
@page nrf51_series_drivers nRF51 Series Drivers
@{
@ref nrf_aar
@ref nrf_adc
@ref nrf_ccm
@ref nrf_clock
@ref nrf_ecb
@ref nrf_ficr
@ref nrf_gpio
@ref nrf_gpiote
@ref nrf_lpcomp
@ref nrf_mpu
@ref nrf_nvmc
@ref nrf_power
@ref nrf_ppi
@ref nrf_qdec
@ref nrf_radio
@ref nrf_rng
@ref nrf_rtc
@ref nrf_spi
@ref nrf_spis
@ref nrf_swi_egu
@ref nrf_temp
@ref nrf_timer
@ref nrf_twi
@ref nrf_uart
@ref nrf_wdt
@}
*/

View File

@@ -0,0 +1,70 @@
/**
@page nrf52810_drivers nRF52810/nRF52811 Drivers
@{
@ref nrf_aar
@ref nrf_bprot
@ref nrf_ccm
@ref nrf_clock
@ref nrf_comp
@ref nrf_ecb
@ref nrf_ficr
@ref nrf_gpio
@ref nrf_gpiote
@ref nrf_nvmc
@ref nrf_pdm
@ref nrf_power
@ref nrf_ppi
@ref nrf_pwm
@ref nrf_qdec
@ref nrf_radio
@ref nrf_rng
@ref nrf_rtc
@ref nrf_saadc
@ref nrf_spi
@ref nrf_spim
@ref nrf_spis
@ref nrf_systick
@ref nrf_swi_egu
@ref nrf_temp
@ref nrf_timer
@ref nrf_twi
@ref nrf_twim
@ref nrf_twis
@ref nrf_uart
@ref nrf_uarte
@ref nrf_wdt
@}
*/

View File

@@ -0,0 +1,66 @@
/**
@page nrf52820_drivers nRF52820 Drivers
@{
@ref nrf_aar
@ref nrf_acl
@ref nrf_ccm
@ref nrf_clock
@ref nrf_comp
@ref nrf_ecb
@ref nrf_ficr
@ref nrf_gpio
@ref nrf_gpiote
@ref nrf_nvmc
@ref nrf_power
@ref nrf_ppi
@ref nrf_qdec
@ref nrf_radio
@ref nrf_rng
@ref nrf_rtc
@ref nrf_spi
@ref nrf_spim
@ref nrf_spis
@ref nrf_systick
@ref nrf_swi_egu
@ref nrf_temp
@ref nrf_timer
@ref nrf_twi
@ref nrf_twim
@ref nrf_twis
@ref nrf_uart
@ref nrf_uarte
@ref nrf_usbd
@ref nrf_wdt
@}
*/

View File

@@ -0,0 +1,78 @@
/**
@page nrf52832_drivers nRF52832 Drivers
@{
@ref nrf_aar
@ref nrf_bprot
@ref nrf_ccm
@ref nrf_clock
@ref nrf_comp
@ref nrf_ecb
@ref nrf_ficr
@ref nrf_gpio
@ref nrf_gpiote
@ref nrf_i2s
@ref nrf_lpcomp
@ref nrf_mwu
@ref nrf_nfct
@ref nrf_nvmc
@ref nrf_pdm
@ref nrf_power
@ref nrf_ppi
@ref nrf_pwm
@ref nrf_qdec
@ref nrf_radio
@ref nrf_rng
@ref nrf_rtc
@ref nrf_saadc
@ref nrf_spi
@ref nrf_spim
@ref nrf_spis
@ref nrf_systick
@ref nrf_swi_egu
@ref nrf_temp
@ref nrf_timer
@ref nrf_twi
@ref nrf_twim
@ref nrf_twis
@ref nrf_uart
@ref nrf_uarte
@ref nrf_wdt
@}
*/

View File

@@ -0,0 +1,80 @@
/**
@page nrf52833_drivers nRF52833 Drivers
@{
@ref nrf_aar
@ref nrf_acl
@ref nrf_ccm
@ref nrf_clock
@ref nrf_comp
@ref nrf_ecb
@ref nrf_ficr
@ref nrf_gpio
@ref nrf_gpiote
@ref nrf_i2s
@ref nrf_lpcomp
@ref nrf_mwu
@ref nrf_nfct
@ref nrf_nvmc
@ref nrf_pdm
@ref nrf_power
@ref nrf_ppi
@ref nrf_pwm
@ref nrf_qdec
@ref nrf_radio
@ref nrf_rng
@ref nrf_rtc
@ref nrf_saadc
@ref nrf_spi
@ref nrf_spim
@ref nrf_spis
@ref nrf_systick
@ref nrf_swi_egu
@ref nrf_temp
@ref nrf_timer
@ref nrf_twi
@ref nrf_twim
@ref nrf_twis
@ref nrf_uart
@ref nrf_uarte
@ref nrf_usbd
@ref nrf_wdt
@}
*/

View File

@@ -0,0 +1,82 @@
/**
@page nrf52840_drivers nRF52840 Drivers
@{
@ref nrf_aar
@ref nrf_acl
@ref nrf_ccm
@ref nrf_clock
@ref nrf_comp
@ref nrf_ecb
@ref nrf_ficr
@ref nrf_gpio
@ref nrf_gpiote
@ref nrf_i2s
@ref nrf_lpcomp
@ref nrf_mwu
@ref nrf_nfct
@ref nrf_nvmc
@ref nrf_pdm
@ref nrf_power
@ref nrf_ppi
@ref nrf_pwm
@ref nrf_qdec
@ref nrf_qspi
@ref nrf_radio
@ref nrf_rng
@ref nrf_rtc
@ref nrf_saadc
@ref nrf_spi
@ref nrf_spim
@ref nrf_spis
@ref nrf_systick
@ref nrf_swi_egu
@ref nrf_temp
@ref nrf_timer
@ref nrf_twi
@ref nrf_twim
@ref nrf_twis
@ref nrf_uart
@ref nrf_uarte
@ref nrf_usbd
@ref nrf_wdt
@}
*/

View File

@@ -0,0 +1,54 @@
/**
@page nrf9160_drivers nRF9160 drivers
@{
@ref nrf_clock
@ref nrf_systick
@ref nrf_dppi
@ref nrf_ficr
@ref nrf_gpio
@ref nrf_gpiote
@ref nrf_i2s
@ref nrf_kmu
@ref nrf_nvmc
@ref nrf_pdm
@ref nrf_power
@ref nrf_pwm
@ref nrf_rtc
@ref nrf_saadc
@ref nrf_spim
@ref nrf_spis
@ref nrf_spu
@ref nrf_swi_egu
@ref nrf_timer
@ref nrf_twim
@ref nrf_twis
@ref nrf_uarte
@ref nrf_vmc
@ref nrf_wdt
@}
*/

File diff suppressed because it is too large Load Diff

View File

@@ -0,0 +1,98 @@
/**
@defgroup nrfx_drivers Drivers
@{
@brief List of all drivers available in nrfx.
@defgroup nrf_aar AAR
@defgroup nrf_adc ADC
@defgroup nrf_acl ACL
@defgroup nrf_bprot BPROT
@defgroup nrf_ccm CCM
@defgroup nrf_clock CLOCK
@defgroup nrf_comp COMP
@defgroup nrf_dppi DPPI
@defgroup nrf_ecb ECB
@defgroup nrf_ficr FICR
@defgroup nrf_gpio GPIO
@defgroup nrf_gpiote GPIOTE
@defgroup nrf_i2s I2S
@defgroup nrf_kmu KMU
@defgroup nrf_lpcomp LPCOMP
@defgroup nrf_mpu MPU
@defgroup nrf_mwu MWU
@defgroup nrf_nfct NFCT
@defgroup nrf_nvmc NVMC
@defgroup nrf_pdm PDM
@defgroup nrf_power POWER
@defgroup nrf_ppi PPI
@defgroup nrf_pwm PWM
@defgroup nrf_qdec QDEC
@defgroup nrf_qspi QSPI
@defgroup nrf_radio RADIO
@defgroup nrf_rng RNG
@defgroup nrf_rtc RTC
@defgroup nrf_saadc SAADC
@defgroup nrf_spi SPI
@defgroup nrf_spim SPIM
@defgroup nrf_spis SPIS
@defgroup nrf_spu SPU
@defgroup nrf_systick Cortex-M Systick
@defgroup nrf_swi_egu SWI/EGU
@defgroup nrf_temp TEMP
@defgroup nrf_timer TIMER
@defgroup nrf_twi TWI
@defgroup nrf_twim TWIM
@defgroup nrf_twis TWIS
@defgroup nrf_uart UART
@defgroup nrf_uarte UARTE
@defgroup nrf_usbd USBD
@defgroup nrf_vmc VMC
@defgroup nrf_wdt WDT
@}
@defgroup nrfx nrfx API
*/