nrfx 2.3.0 release

NordicSemiconductor · Aug 20, 2020 · 6c31cb7 · 6c31cb7
1 parent 233c963
commit 6c31cb7
Show file tree

Hide file tree

Showing 146 changed files with 10,766 additions and 6,963 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,30 @@
 # Changelog
 All notable changes to this project are documented in this file.
 
+## [2.3.0] - 2020-08-19
+### Added
+- Added support for nRF52805.
+- Implemented workaround for nRF52 Series anomaly 197 in the POWER HAL.
+- Implemented workaround for nRF52 Series anomalies 211 and 223 in the USBD driver.
+- Added support for the nRF53 Series in the QSPI HAL.
+- Added function in the GPIO HAL that returns port index.
+- Introduced a QSPI HAL symbol that indicates the availability of the QSPI mode 1.
+- Introduced shortcut functionality in the CCM HAL.
+- Added function in the TIMER HAL for setting the specified shortcuts.
+- Added optional two-stage start procedure of the LFXO in the CLOCK driver.
+
+### Changed
+- Updated MDK to 8.35.0.
+- Divided network and application core-specific functionalities for nRF5340 in the RESET HAL and the reset reason helper.
+
+### Fixed
+- Corrected assertions in the NVMC driver.
+- Corrected return types in the CCM HAL.
+- Fixed setting of program memory access mode for secure code in the NVMC driver.
+- Removed usage of the NRF_UICR symbol on non-secure targets in address validity checks in the NVMC driver.
+- Fixed an error message in the SPIM driver that prevented successful compilation with logging enabled.
+- Fixed unused parameters in the PPI HAL.
+
 ## [2.2.0] - 2020-04-28
 ### Added
 - Added support for nRF52820.

diff --git a/README.md b/README.md
@@ -13,6 +13,7 @@ SoCs, as well as startup and initialization files for them.
 ## Supported SoCs
 
 * nRF51 Series
+* nRF52805
 * nRF52810
 * nRF52811
 * nRF52820

diff --git a/doc/drv_supp_matrix.dox b/doc/drv_supp_matrix.dox
diff --git a/doc/main_page.dox b/doc/main_page.dox
@@ -1,7 +1,7 @@
 /**
-@mainpage Introduction
+@mainpage Introduction and configuration
 
-@em nrfx is a standalone set of drivers for peripherals present in Nordic
+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.
@@ -14,7 +14,7 @@ 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
+The purpose of 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
@@ -30,7 +30,7 @@ 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):
+([nrfx] stands for the nrfx root folder location):
 @code
 [nrfx]/
 [nrfx]/drivers/include
@@ -80,7 +80,7 @@ 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
+start developing with nrfx, you must add the CMSIS header files to include
 paths during the compilation process. Download these files from the following
 website:
 

diff --git a/doc/nrf51_series.dox b/doc/nrf51_series.dox
@@ -1,5 +1,9 @@
 /**
-@page nrf51_series_drivers nRF51 Series Drivers
+@page nrf51_series_drivers nRF51 Series drivers
+
+This page lists nrfx driver components supported by the nRF51 Series SoCs.
+For a complete overview, see @ref nrfx_drv_supp_matrix.
+
 @{
 
 @ref nrf_aar

diff --git a/doc/nrf52805.dox b/doc/nrf52805.dox
@@ -0,0 +1,68 @@
+/**
+@page nrf52805_drivers nRF52805 drivers
+
+This page lists nrfx driver components supported by the nRF52805 SoCs.
+For a complete overview, see @ref nrfx_drv_supp_matrix.
+
+@{
+
+@ref nrf_aar
+
+@ref nrf_bprot
+
+@ref nrf_ccm
+
+@ref nrf_clock
+
+@ref nrf_systick
+
+@ref nrf_ecb
+
+@ref nrf_egu
+
+@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_saadc
+
+@ref nrf_spi
+
+@ref nrf_spim
+
+@ref nrf_spis
+
+@ref nrf_temp
+
+@ref nrf_timer
+
+@ref nrf_twi
+
+@ref nrf_twim
+
+@ref nrf_twis
+
+@ref nrf_uart
+
+@ref nrf_uarte
+
+@ref nrf_wdt
+
+@}
+*/
diff --git a/doc/nrf52810.dox b/doc/nrf52810.dox
@@ -1,5 +1,9 @@
 /**
-@page nrf52810_drivers nRF52810/nRF52811 Drivers
+@page nrf52810_drivers nRF52810/nRF52811 drivers
+
+This page lists nrfx driver components supported by the nRF52810/nRF52811 SoC.
+For a complete overview, see @ref nrfx_drv_supp_matrix.
+
 @{
 
 @ref nrf_aar

diff --git a/doc/nrf52820.dox b/doc/nrf52820.dox
@@ -1,5 +1,9 @@
 /**
-@page nrf52820_drivers nRF52820 Drivers
+@page nrf52820_drivers nRF52820 drivers
+
+This page lists nrfx driver components supported by the nRF52820 SoC.
+For a complete overview, see @ref nrfx_drv_supp_matrix.
+
 @{
 
 @ref nrf_aar

diff --git a/doc/nrf52832.dox b/doc/nrf52832.dox
@@ -1,5 +1,9 @@
 /**
-@page nrf52832_drivers nRF52832 Drivers
+@page nrf52832_drivers nRF52832 drivers
+
+This page lists nrfx driver components supported by the nRF52832 SoC.
+For a complete overview, see @ref nrfx_drv_supp_matrix.
+
 @{
 
 @ref nrf_aar

diff --git a/doc/nrf52833.dox b/doc/nrf52833.dox
@@ -1,5 +1,9 @@
 /**
-@page nrf52833_drivers nRF52833 Drivers
+@page nrf52833_drivers nRF52833 drivers
+
+This page lists nrfx driver components supported by the nRF52833 SoC.
+For a complete overview, see @ref nrfx_drv_supp_matrix.
+
 @{
 
 @ref nrf_aar

diff --git a/doc/nrf52840.dox b/doc/nrf52840.dox
@@ -1,5 +1,9 @@
 /**
-@page nrf52840_drivers nRF52840 Drivers
+@page nrf52840_drivers nRF52840 drivers
+
+This page lists nrfx driver components supported by the nRF52840 SoC.
+For a complete overview, see @ref nrfx_drv_supp_matrix.
+
 @{
 
 @ref nrf_aar

diff --git a/doc/nrf5340.dox b/doc/nrf5340.dox
@@ -1,5 +1,9 @@
 /**
 @page nrf5340_drivers nRF5340 drivers
+
+This page lists nrfx driver components supported by the nRF5340 SoC.
+For a complete overview, see @ref nrfx_drv_supp_matrix.
+
 @{
 
 @ref nrf_aar

diff --git a/doc/nrf9160.dox b/doc/nrf9160.dox
@@ -1,5 +1,9 @@
 /**
 @page nrf9160_drivers nRF9160 drivers
+
+This page lists nrfx driver components supported by the nRF9160 SoC.
+For a complete overview, see @ref nrfx_drv_supp_matrix.
+
 @{
 
 @ref nrf_clock

diff --git a/doc/nrfx.doxyfile b/doc/nrfx.doxyfile
@@ -40,7 +40,7 @@ PROJECT_NAME           = "nrfx"
 
 ### EDIT THIS ###
 
-PROJECT_NUMBER         = "2.2"
+PROJECT_NUMBER         = "2.3"
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a
@@ -235,8 +235,8 @@ TAB_SIZE               = 4
 # newlines (in the resulting output). You can put ^^ in the value part of an
 # alias to insert a newline as if a physical newline was in the original file.
 
-ALIASES                = "tagGreenTick=@htmlonly<CENTER><font color= green>✔</font></CENTER>@endhtmlonly" \
-                         "tagRedCross=@htmlonly<CENTER><font color= red>✖</font></CENTER>@endhtmlonly"
+ALIASES                = tagGreenTick="@htmlonly<CENTER><font color=\"green\">✔</font></CENTER>@endhtmlonly" \
+                         tagRedCross="@htmlonly<CENTER><font color=\"red\">✖</font></CENTER>@endhtmlonly"
 
 # This tag can be used to specify a number of word-keyword mappings (TCL only).
 # A mapping has the form "name=value". For example adding "class=itcl::class"
@@ -795,6 +795,7 @@ INPUT                  = ../helpers \
                          ../hal \
                          ../soc \
                          ../templates \
+                         ../CHANGELOG.md \
                          config_dox \
                          .
 

diff --git a/drivers/include/nrfx_clock.h b/drivers/include/nrfx_clock.h
@@ -106,15 +106,16 @@ void nrfx_clock_stop(nrf_clock_domain_t domain);
  *
  * XTAL source is assumed for domains with multiple sources.
  *
- * @param[in]  domain  Clock domain.
- * @param[out] clk_src Clock source that is running. Set to NULL if not needed.
- *                     Ignored for HFCLKAUDIO domain. Typecast it to @ref nrf_clock_lfclk_t for
- *                     LFCLK and @ref nrf_clock_hfclk_t for HFCLK and HFCLK192M.
+ * @param[in]  domain    Clock domain.
+ * @param[out] p_clk_src Pointer to a clock source that is running. Set to NULL if not needed.
+ *                       Ignored for HFCLKAUDIO domain. Variable pointed by @p p_clk_src
+ *                       must be of either @ref nrf_clock_lfclk_t type for LFCLK
+ *                       or @ref nrf_clock_hfclk_t type for HFCLK and HFCLK192M.
  *
  * @retval true  The clock domain is running.
  * @retval false The clock domain is not running.
  */
-NRFX_STATIC_INLINE bool nrfx_clock_is_running(nrf_clock_domain_t domain, void * clk_src);
+NRFX_STATIC_INLINE bool nrfx_clock_is_running(nrf_clock_domain_t domain, void * p_clk_src);
 
 #if NRF_CLOCK_HAS_HFCLK_DIV || NRF_CLOCK_HAS_HFCLK_192M
 /**
@@ -318,9 +319,9 @@ NRFX_STATIC_INLINE uint32_t nrfx_clock_ppi_event_addr(nrf_clock_event_t event)
     return nrf_clock_event_address_get(NRF_CLOCK, event);
 }
 
-NRFX_STATIC_INLINE bool nrfx_clock_is_running(nrf_clock_domain_t domain, void * clk_src)
+NRFX_STATIC_INLINE bool nrfx_clock_is_running(nrf_clock_domain_t domain, void * p_clk_src)
 {
-    return nrf_clock_is_running(NRF_CLOCK, domain, clk_src);
+    return nrf_clock_is_running(NRF_CLOCK, domain, p_clk_src);
 }
 
 NRFX_STATIC_INLINE bool nrfx_clock_hfclk_is_running(void)