1# Changelog 2All notable changes to this project are documented in this file. 3 4## [3.3.0] - 2023-12-21 5### Added 6- Added support for nRF54H20 Eng A and nRF54L15 Eng A. 7- Added HALs for BELLBOARD, CRACEN, CTRLAP, EXMIF, GLITCHDET, GRTC, HSFLL, IPCT, LRCCONF, MEMCONF, MPC, MVDMA, PPIB, RAMC, RESETINFO, RRAMC, STM, TAMPC, TBM, UICR and, VPR. 8- Added HALYs for BELLBOARD, GRTC, MVDMA, RRAMC, TBM, and VPR. 9- Added drivers for BELLBOARD, GRTC, RRAMC, TBM, and VEVIF. 10- Added the nrfx_ids helper layer to facilitate developing generic code that performs inter-domain signalling. 11- Added possibility to use TX link feature without (D)PPI connection in the UARTE driver. 12- Added possibility to get callback called on each byte received in the UARTE driver. 13 14### Changed 15- Updated MDK to version 8.60.3. 16- Changed the default nrfx API version to 3.1.0. 17- Changed how the buffers are provided to the I2S driver. Now, the buffer size must be passed alongside pointers to the next buffers. 18- Improved peripheral power management in the PWM driver. Now, the peripheral is enabled only during playback. 19 20### Fixed 21- Fixed the workaround for nRF52840 anomaly 215 and nRF5340 anomaly 215 in the QSPI driver. Now, the custom instruction functions do not risk triggering anomalies. 22- Fixed a missing CTRLAP reset reason for nRF91 in the POWER HAL. 23- Fixed incorrect assertion in the TWIS driver. Now, the driver status can be checked when the driver is idle. 24- Restored workaround for nRF52 anomaly 55 in the I2S driver. 25 26## [3.2.0] - 2023-10-02 27### Added 28- Added multi-instance support for the GPIOTE driver. 29- Added the nrfx_ram_ctrl helper layer to facilitate developing generic code that controls the power and retention settings of RAM blocks. 30- Introduced the NRFX_TIMER_BASE_FREQUENCY_GET() and NRFX_SPIM_BASE_FREQUENCY_GET() macros for getting base frequencies in Hz for the specified TIMER and SPIM instances. 31- Added a function for checking whether the specified voltage regulator is enabled in the REGULATORS HAL. 32- Added a function for checking whether an inductor is connected to the DCC pin in the REGULATORS HAL. 33- Added a function for checking if the detected voltage is below or above the threshold of VPOF (POF Comparator's threshold voltage) in the REGULATORS HAL. 34- Added a function for powering on all RAM blocks in the VMC HAL. 35- Added missing entries in enumerators for RAM sections in the VMC HAL. 36- Added the new nrfx_wdt_stop() function to the WDT driver that stops the watchdog. 37- Added the new nrfx_wdt_uninit() function to the WDT driver that uninitializes the watchdog. 38- Added the new nrfy_wdt_task_stop_enable_set() function to the WDT HALY that enables or disables stopping the watchdog. 39- Added functions for retrieving pointers to the receive and transmit buffers in the TWIS HAL. 40- Added functions for checking whether given instance is initialized to all of the drivers. 41- Added individual functions for setting reference selection, external reference, detection type and enabling hysteresis in the LPCOMP HAL. Now they are supposed to be used instead of nrf_lpcomp_configure() function. 42- Added a blocking mode to the CLOCK driver. The mode is initialized when a user handler is set to NULL. 43- Added a new member to the configuration structure of the QSPI driver. The new configuration member determines time in milliseconds when a timeout of the QSPI operation occurs. 44- Added the new nrfx_qspi_timeout_signal() function to the QSPI driver that signals premature QSPI operation timeout. 45 46### Changed 47- Updated MDK to version 8.58.0. 48- Overhauled the UARTE driver. Extended the UARTE driver with various modes of operations including: mixing of blocking and non-blocking transfers, linking transfers, continuous reception, low power operation. 49- Changed all functions' parameters in the GPIOTE driver. A pointer to nrfx_gpiote_t structure was added as the first parameter in all functions. Now functions without the pointer to nrfx_gpiote_t structure as the first argument are deprecated. 50- Changed functions for setting and reading the GPREGRET registers in the POWER HAL. Now there are only two functions, nrf_power_gpregret_set() for setting and nrf_power_gpregret_get() for reading. A new `reg_num` argument was added to both of them. 51- Replaced nrf_regulators_dcdcen_set() and nrf_regulators_dcdcen_vddh_set() functions with nrf_regulators_vreg_enable_set(). 52- Replaced nrf_regulators_pofcon_set() and nrf_regulators_pofcon_vddh_set() functions with nrf_regulators_config_set(). 53- Replaced nrf_regulators_pofcon_get() function with nrf_regulators_pof_config_get(). 54- Renamed nrf_regulators_mainregstatus_get() function to nrf_regulators_main_status_get(). 55- Renamed NRF_REGULATORS_POTHR_V{XY} macros to NRF_REGULATORS_POF_THR_{X}V{Y}. 56- Renamed NRF_REGULATORS_PORTHRVDDH_V{XY} macros to NRF_REGULATORS_POF_THR_VDDH_{X}V{Y}. 57- Renamed nrf_regulators_pof_thrvddh_t structure to nrf_regulators_pof_thr_vddh_t. 58- Renamed macros indicating features presence in the REGULATORS HAL. 59- Changed a default value of the source reference structure member from 1.8V to 1.2V in the COMP driver configuration structure. 60- Changed a prototype of an event handler in the WDT driver. The new prototype accepts an event type, requests and a pointer to the context. A previous version is deprecated. 61- Changed a prototype of the nrfx_wdt_init() function in the WDT driver. The new prototype accepts a pointer to the instance, a pointer to the configuration, an event handler and a pointer to the context. A previous version is deprecated. 62- Replaced the nrf_wdt_task_stop_enable() function with nrf_wdt_task_stop_enable_set(). Now it takes a boolean parameter. 63- Replaced the deprecated NRFX_ERROR_ALREADY_INITIALIZED error code with the new NRFX_ERROR_ALREADY one. 64- Changed the organization of configuration structure members in the LPCOMP driver. 65- Changed the definition of nrf_saadc_value_t type in the SAADC HAL. Now pointer to the buffer holding conversion results is a void* instead of int16_t*. 66- Changed the return value in all drivers in case initialization functions have already been executed. Now the NRFX_ERROR_ALREADY error code will be returned instead of NRFX_ERROR_INVALID_STATE. 67- Changed the way that the QSPI peripheral is activated. Now the driver activates the peripheral instance before the first transfer or when the nrfx_qspi_activate() function is called. 68 69### Fixed 70- Fixed the device failing to reconnect to the host after USB cable being reconnected in the USBD driver. 71- Fixed configuration of the external reference in nrfx_comp_init() and nrfx_comp_reconfigure() functions. Now the differential mode can be enabled in the COMP driver. 72- Fixed support for P0.18, P0.20, and P0.28-P0.30 pins in the GPIOTE driver for nRF52820 SoC. 73- Fixed events being forwarded to the user callback despite having their interrupts disabled in the QDEC driver. 74 75## [3.1.0] - 2023-06-28 76### Added 77- Added the HALY layer for the NFCT. HALY is an extension of the HAL layer that aggregates basic hardware use cases within single functions. Now it is used instead of HAL in the NFCT drivers. 78- Added the NRFX_IN_RANGE() macro for checking if a given value is in a given range. 79- Added functions for writing a word to the flash and reading a buffer, word, halfword, and byte in the NVMC HAL. 80 81### Changed 82- Updated MDK to version 8.55.0. 83- Modified the power management in the SPIM driver. Now the nrfx_spim_abort() function must be called once all expected transactions using the NRFX_SPIM_FLAG_NO_XFER_EVT_HANDLER, NRFX_SPIM_FLAG_HOLD_XFER, or NRFX_SPIM_FLAG_REPEATED_XFER option flags are finalized. 84 85### Fixed 86- Fixed a workaround for the anomaly 109 on the nRF52 family in the SPIM and SPIS drivers. 87- Fixed the NRFX_TIMER_FREQUENCY_STATIC_CHECK() and NRFX_SPIM_FREQUENCY_STATIC_CHECK() macros. 88- Fixed the nrfx_wdt_reconfigure() function that was returning the NRFX_ERROR_INVALID_STATE error code when the driver instance has been initialized. 89- Fixed the nrfx_pwm_stopped_check() function when used without user's handler function. 90 91## [3.0.0] - 2023-04-25 92### Added 93- Added the HALY layer for the following peripherals: COMP, DPPI, GPIO, GPIOTE, I2S, LPCOMP, PDM, PWM, QDEC, RTC, SAADC, SPIM, TEMP, TIMER, TWIM, UARTE, WDT. HALY is an extension of the HAL layer that aggregates basic hardware use cases within single functions. Now it is used instead of HAL in the corresponding drivers. 94- Added functions for reconfiguring a peripheral outside of the initialization process in the following drivers: COMP, PDM, PWM, QDEC, QSPI, SPI, SPIM, SPIS, TIMER, TWI, TWIM, TWIS, UART, UARTE, WDT. 95- Added multi-instance support for the I2S and QDEC drivers. Now a pointer to the driver instance needs to be specified in all relevant functions. 96- Added the reportper_inten member to the configuration structure for the QDEC driver. It allows to explicitly enable interrupts associated with the REPORTRDY peripheral event. 97- Added the NRFX_ERROR_FORBIDDEN error being returned from the nrfx_spim_init() function when a user attempts to configure a hardware-controlled and software-controlled chip select simultaneously. 98- Added the NRFX_TIMER_FREQUENCY_STATIC_CHECK() macro to statically check if the given frequency is achievable for the specified TIMER instance. 99- Added the NRFX_TWIM_XFER_DESC() macro to support creation of any type of TWIM transaction for the TWIM driver. 100- Added auxiliary macros NRFX_KHZ_TO_HZ() and NRFX_MHZ_TO_HZ() for converting specified frequency value to Hertz. 101- Added auxiliary macros for sophisticated handling of the preprocessor symbols to `nrfx_utils.h`. 102- Added functions for getting the number of available channels and groups for a given peripheral instance in the DPPIC HAL. 103- Added functions for getting the SEQSTART tasks and SEQEND events associated with a specified sequence index in the PWM HAL. 104- Added the nrf_rtc_capture_task_get() function for getting the CAPTURE task associated with the specified CC channel in the RTC HAL. 105- Added functions for managing the non-maskable watchdog interrupts in the WDT HAL. 106- Added functions for getting the address of peripheral tasks and events in the EGU HAL. 107- Added a function for enabling the watchdog STOP task in the WDT HAL. 108- Added a function for getting the bitmask of all watchdog requests' statuses in the WDT HAL. 109- Added a function for clearing the event and task endpoints for a given channel in the GPPI helper. 110 111### Changed 112- Renamed a macro from NRFX_VOLTAGE_THRESHOLD_TO_INT() to NRFX_COMP_VOLTAGE_THRESHOLD_TO_INT() in the COMP HAL. 113- Renamed functions for getting the task of event address in the following drivers: CLOCK, GPIOTE, PPI, SPIM, TWIM. Now they follow a common scheme. 114- Renamed configuration structure members `hal` and `hal_config`, containing low-level peripheral settings, to `config` in the LPCOMP and UARTE drivers. 115- Renamed a function from nrfx_pwm_is_stopped() to nrfx_pwm_stopped_check() in the PWM driver. 116- Renamed a symbol from NRF_QDEC_LED_NOT_CONNECTED to NRF_QDEC_PIN_NOT_CONNECTED in the QDEC HAL. Now it is consistent with other, similar symbols. 117- Changed the way the API version to be used is specified. Now the following dedicated symbols shall be defined to form the API version as a numerical value: NRFX_CONFIG_API_VER_MAJOR, NRFX_CONFIG_API_VER_MINOR, NRFX_CONFIG_API_VER_MICRO. 118- Changed prototypes of several functions in the UARTE driver. Now all functions have a return value, and some of them accept additional parameters. 119- Changed a type of configuration structure members that hold a pin number from `uint8_t` to `uint32_t` in the following drivers: I2S, PWM, SPIM. 120- Changed the prototypes of the nrf_i2s_pins_set() and nrf_i2s_configure() functions in the I2S HAL. Now they accept a pointer to the configuration structure instead of several individual parameters. 121- Changed a default value of the `gain` structure member from `1/6` to `1` in the SAADC driver configuration structure. 122- Changed a type of the configuration structure member specifying the clock frequency from an enumeration to an unsigned integer in the TIMER driver. Now the timer clock frequency must be specified in Hertz. Use the NRFX_TIMER_FREQUENCY_STATIC_CHECK() macro to check if the requested frequency is achievable for a given TIMER instance. 123- Changed a type of the configuration structure member specifying the clock frequency from an enumeration to an unsigned integer in the SPIM driver. Now the clock signal frequency must be specified in Hertz. Use the NRFX_SPIM_FREQUENCY_STATIC_CHECK() macro to check if the requested frequency is achievable for a given SPIM instance. 124- Changed the prototype of the NRFX_TIMER_DEFAULT_CONFIG() macro in the TIMER driver. Now the desired timer clock frequency in Hertz needs to be specified as a parameter. 125- Changed a prototype of the WDT driver callback. Now a bitmask specifying which reload request caused the timeout is provided. 126- Changed the prototype of the initialization and callback functions of the QDEC driver. Now the user context can be provided and accessed during the interrupt handler execution. 127- Removed the deprecated nrf_gpio_pin_mcu_select() function and the corresponding nrf_gpio_pin_mcusel_t enumerator. Use the nrf_gpio_pin_control_select() function and the nrf_gpio_pin_sel_t enumerator instead. 128- Removed the deprecated and spurious NRF_QDEC_REPORTPER_DISABLED symbol from the QDEC HAL. 129- Removed the deprecated nrf_qdec_pio_assign() function from the QDEC HAL. Use the nrf_qdec_pins_set() function instead. 130- Removed the deprecated nrf_timer_frequency_set() and nrf_timer_frequency_get() functions in the TIMER HAL. Use nrf_timer_prescaler_set() and nrf_timer_prescaler_get() instead. 131- Removed symbols that mark a pin as unused in the following drivers: I2S, PWM, SPIM, SPIS. Now the HAL variant should be used instead. 132- Removed deprecated functions from the GPIOTE driver. Use new functions instead. 133- Removed the deprecated callback prototype in the IPC driver. Use a new variant instead. 134- Removed the following redundant functions from the PWM driver: nrfx_pwm_sequence_values_update(), nrfx_pwm_sequence_length_update(), nrfx_pwm_sequence_repeats_update(), nrfx_pwm_sequence_end_delay_update(). Use the nrfx_pwm_sequence_update() function instead. 135- Moved static inline functions from the header file to the source file in the GPPI helper. 136- Refactored the method of configuring pins that should use inverted polarity in the PWM driver. Now an array inside driver configuration structure needs to be used instead of masking the pin number value. As a consequence, the NRFX_PWM_PIN_INVERTED symbol was removed. 137- Renamed configuration structure members used for setting peripheral pins in the following drivers: PDM, TWIM, TWIS, UARTE. Now they use a common scheme. 138- Renamed the nrf_wdt_started() and nrf_wdt_request_status() functions in the WDT HAL. Now they are named as nrf_wdt_started_check() and nrf_wdt_request_status_check() respectively. 139 140### Fixed 141- Fixed a misleading description for the nrf_rtc_event_disable() function in the RTC HAL. It accepts a bitmask of events instead of a single event. 142 143## [2.11.0] - 2023-04-07 144### Added 145- Added support for the nRF9161 and nRF9131 SiPs. Use `NRF9120_XXAA` as the compilation symbol. 146- Implemented a workaround for the anomaly 161 on the nRF5340 SoC in the RESET HAL. 147 148### Changed 149- Updated MDK to version 8.53.1. 150 151### Fixed 152- Removed a spurious function call causing aborting of endpoints in the SUSPEND event for the USBD driver. 153 154## [2.10.0] - 2022-10-25 155### Added 156- Added NRFX_CONFIG_API_VER_2_9 and NRFX_CONFIG_API_VER_2_10 symbols that guard API-breaking changes. Deprecated API is used by default. 157- Added new signature for the event handler in the IPC driver that accepts event index instead of event bitmask. The previous signature is deprecated. 158- Added nrfx_ipc_gpmem_get() function that is used to get data from the GPMEM register in IPC. It should be now used instead of nrfx_ipc_mem_get(), which is deprecated. 159- Added samples for the following drivers: EGU, PWM, RNG, SAADC, SPIM, SPIS, TEMP, TIMER, TWIM, TWIS, UARTE. They are a part of `zephyrproject-rtos/hal_nordic/nrfx` repository. 160- Introduced the NRFX_{PERIPH}_INST_HANDLER_GET() macro for getting interrupt handler associated with the specified driver instance. 161- Introduced the NRFX_{PERIPH}_INST_GET() macro for getting pointer to the structure of the registers of the specified peripheral. 162- Introduced the NRF_TIMER_PRESCALER_CALCULATE() macro for computing prescaler value for given TIMER base frequency and desired frequency. 163- Introduced the NRF_TIMER_BASE_FREQUENCY_GET() macro for getting base frequency in Hz for the specified TIMER instance. 164- Added missing NRFX_RESET_REASON_CTRLAP_MASK in nrfx_reset_reason_mask_t for nRF9160. 165- Added missing NRFX_RESET_REASON_SREQ_MASK in nrfx_reset_reason_mask_t. 166 167### Changed 168- Updated MDK to version 8.51.0. 169- Refactored the TIMER driver to allow user handler to be NULL. 170- Removed magic numbers from nrf_twim_event_t type in TWIM HAL. 171 172### Fixed 173- Fixed the NRFX_ROUNDED_DIV() macro for negative numbers. 174- Disabled array bounds warning for nrf_clock_is_running() function that was false positive in GCC 12 and above. 175 176## [2.9.0] - 2022-07-19 177### Added 178- Added configuration parameter NRFX_NFCT_PARAM_ID_FDT_MIN that allows settting the value of the FRAMEDELAYMIN register. 179- Added nrf_gpio_pin_sel_t enumerator. It should be now used instead of nrf_gpio_pin_mcusel_t, which is deprecated. 180- Added nrf_gpio_pin_control_select() function. It should be now used instead of nrf_gpio_pin_mcu_select(), which is deprecated. 181- Added NRF_TIMER_CC_COUNT_MAX symbol that specifies maximum number of available compare channels. 182- Added NRF_TIMER_ALL_CHANNELS_INT_MASK symbol that is used for creating the interrupt bitmask for all compare channels. 183- Added nrf_timer_prescaler_set() and nrf_timer_prescaler_get() functions that are used for setting and retrieving the prescaler factor. They should be now used instead of nrf_timer_frequency_set() and nrf_timer_frequency_get(), which are deprecated. 184- Added NRFX_MAX(), NRFX_MIN() and NRFX_ABS() macros. 185 186### Changed 187- Updated MDK to version 8.47.0. 188 189### Fixed 190- Fixed logging level in nrfx_uart_init() and nrfx_uarte_init() functions. It was reduced from warning to info. 191- Fixed IO3 level used in nrfx_qspi_mem_busy_check(). The line is now kept high to prevent memory status from being read incorrectly. 192 193## [2.8.0] - 2022-04-05 194### Added 195- Added function for getting the currently configured channels in the SAADC driver. 196- Added callback for the RXFRAMESTART event in the NFCT driver. 197- Added function for transmitting the NFC frame with specified number of bits in the NFCT driver. 198- Added functions for getting and setting SEL_RES auto response configuration in the NFCT HAL. 199 200### Changed 201- Refactored calibration procedure in the SAADC driver, so it retains previously configured mode. 202- Improved management of low frequency clock source during initialization in the CLOCK driver. Compatible source that already runs or is starting during initialization is now used without reconfiguration. 203- Improved software-managed triggering of the START task on an END event in the SAADC driver. 204 205### Fixed 206- Fixed event processing order in the SAADC driver. Previously, incorrect buffer might have been filled when double-buffered sampling was used with END event and START task being connected through (D)PPI. 207- Fixed the limits feature that could be spuriously triggered during calibration procedure in the SAADC driver. 208 209## [2.7.0] - 2021-12-16 210### Added 211- Added new fields in the driver configuration structures to allow skipping GPIO and/or PSEL register configuration. Affected drivers: I2S, PDM, PWM, QDEC, QSPI, SPI, SPIM, SPIS, TWI, TWIM, TWIS, UART, UARTE. 212 213### Changed 214- Updated MDK to version 8.44.2. 215 216### Fixed 217- Fixed the inability to start subsequent simple mode conversion from the user callback context in the SAADC driver. 218 219## [2.6.0] - 2021-11-22 220### Added 221- Added new functions for the GPIOTE peripheral management in the GPIOTE driver. Legacy API is now deprecated. 222- Added support for the TIMER CC channels 6 and 7. 223- Added the nrfx_flag32_allocator helper layer to unify resource allocation mechanism across several drivers. 224- Added functions for getting shortcut bitmask associated with specified channel in the TIMER HAL. 225- Added functions for channel allocation and deallocation in the nrfx_gppi helper layer. 226- Added the nrf_gpio_reconfigure() function for selective reconfiguration of the specified pin. 227- Introduced the NRFX_CLOCK_CONFIG_CT_ENABLED symbol for enabling the calibration timer support in the CLOCK driver. The symbol is enabled by default on supported SoCs. 228- Introduced the NRFX_CTZ and NRFX_CLZ macros to allow providing custom implementation for these functionalities. By default `__RBIT()` and `__CLZ()` CMSIS macros are used. 229- Introduced the NRFX_ATOMIC_CAS macro to allow providing custom implementation for atomic compare-and-swap functionality. 230- Implemented workaround for the nRF9160 anomaly 7 in the NVMC driver. 231 232### Changed 233- Updated MDK to version 8.44.1. 234 235### Fixed 236- Fixed missing disabling of interrupts in the nrfx_qspi_lfm_start() and nrfx_qspi_lfm_xfer() functions. 237- Fixed manual sample fetching when REPORTPER is disabled in the QDEC driver. 238- Fixed a race condition in the NFCT driver when starting the transfer. 239 240## [2.5.0] - 2021-05-05 241### Added 242- Added support for double-buffered transfers in the QSPI driver. 243- Added support for one-by-one channel configuration in the SAADC driver. 244- Added critical sections for channel allocation and deallocation in the DPPI driver. 245- Added support for generating documentation in the RST format using Sphinx tool. 246- Added high-drive pin configuration in the QSPI, TWIM, and SPIM drivers. 247- Added report period setting of 1 sample in the QDEC HAL. 248- Implemented workaround for nRF53 Series anomaly 121 in the QSPI driver. 249 250### Changed 251- Updated MDK to version 8.40.2. 252- Removed implicit channel deallocation during initialization in the GPIOTE driver. 253- Restricted pins that are supported for specific configuration on nRF5340 in the QSPI, TWIM, and SPIM drivers. 254- Aligned IRQ handler symbols to new naming scheme for nRF53 Series. 255 256### Fixed 257- Fixed register access sequence in the COMP driver. 258- Fixed memory corruption when uninitialized channel was freed in the GPIOTE driver. 259- Fixed spurious access of DCX pin for every instance of the peripheral when extended features were enabled in the SPIM driver. 260- Fixed overwrite of MCUSEL configuration in the nrf_gpio_cfg() function. 261- Fixed driver behavior for zero-length transfer in the TWIM driver. 262- Fixed internal state handling when transfer is aborted before finishing in the TWI and TWIM drivers. 263- Corrected assertions for MPS requirements in the USBD driver. 264- Corrected symbol describing maximum data payload for a full-speed isochronous endpoint in the USBD driver. 265 266## [2.4.0] - 2020-11-13 267### Added 268- Added the channel allocator feature in the GPIOTE driver. 269- Added support for registers associated with the Direction Finding feature in the RADIO HAL. 270- Added support for the SUBSCRIBE and PUBLISH registers in the following HALs: AAR, CCM, ECB, RADIO, and RNG. 271- Added support for the LATENCY register present on nRF5340 in the GPIOTE driver and the GPIOTE HAL. 272- Implemented workaround for nRF53 Series anomaly 53 in the POWER driver. 273 274### Changed 275- Updated MDK to 8.37.0. 276 277### Fixed 278- Fixed unused parameters in the PPI, CLOCK, SPIM and POWER drivers to resolve compilation warnings, such as 'flags' in the SPIM driver. 279- Fixed a race condition in the COMP driver when interrupt occured before update of the driver internal state. 280- Fixed minor C++ compilation warnings in the drivers. 281- Fixed implementation of workaround for nRF52 Series anomaly 197 in the POWER HAL, which was applied in incorrect configuration. 282- Fixed implementation of workaround for nRF53 Series anomaly 4 in the CLOCK driver, which was applied in incorrect configuration. 283- Fixed the incorrect signature of the nrf_clock_alwaysrun_set() function. 284 285## [2.3.0] - 2020-08-19 286### Added 287- Added support for nRF52805. 288- Implemented workaround for nRF52 Series anomaly 197 in the POWER HAL. 289- Implemented workaround for nRF52 Series anomalies 211 and 223 in the USBD driver. 290- Added support for the nRF53 Series in the QSPI HAL. 291- Added function in the GPIO HAL that returns port index. 292- Introduced a QSPI HAL symbol that indicates the availability of the QSPI mode 1. 293- Introduced shortcut functionality in the CCM HAL. 294- Added function in the TIMER HAL for setting the specified shortcuts. 295- Added optional two-stage start procedure of the LFXO in the CLOCK driver. 296 297### Changed 298- Updated MDK to 8.35.0. 299- Divided network and application core-specific functionalities for nRF5340 in the RESET HAL and the reset reason helper. 300 301### Fixed 302- Corrected assertions in the NVMC driver. 303- Corrected return types in the CCM HAL. 304- Fixed setting of program memory access mode for secure code in the NVMC driver. 305- Removed usage of the NRF_UICR symbol on non-secure targets in address validity checks in the NVMC driver. 306- Fixed an error message in the SPIM driver that prevented successful compilation with logging enabled. 307- Fixed unused parameters in the PPI HAL. 308 309## [2.2.0] - 2020-04-28 310### Added 311- Added support for nRF52820. 312- Added possibility to use the nRF52833 DK in development for nRF52820. LEDs and buttons in this DK use GPIOs that are not present in the actual nRF52820 device, so accesses to these need special handling in the GPIO HAL. 313- Added the nrfx_reset_reason helper layer, to facilitate developing generic code that uses the RESETREAS register. 314- Implemented workarounds for nRF52 Series anomalies 170 and 196 in the I2S driver. 315- Added implicit casting of uint32_t to unsigned long in log messages, to prevent compiler warnings. 316- Added missing secure and non-secure peripheral symbol translations for nRF5340 and nRF9160. 317- Added functions in the NVMC driver for reading and writing halfword data from the OTP region of the UICR. 318 319### Changed 320- Updated MDK to 8.32.1. 321- Improved documentation regarding double-buffered reception in the UARTE driver. 322- Unified policy of pin cleanup procedure during uninitialization of the drivers. Now every driver restores utilized pins to default setting. 323- Removed support for revision Engineering A of nRF52840 in the USBD driver. 324- Changed selected while() loops to NRFX_WAIT_FOR() macro in the SPIM, UARTE and CLOCK drivers to improve robustness. 325 326### Fixed 327- Fixed assertions that check write addresses in the NVMC driver. Now the UICR memory region is handled properly. 328- Fixed a race condition in the CLOCK driver when requested clock was stopped during ramp-up from high priority interrupt. 329- Fixed assertions that check pin numbers in the GPIO HAL and GPIOTE driver. Now noncontiguous groups of available pin numbers are handled properly. 330- Fixed assertion that checks correctness of limit setting in the SAADC driver. 331- Fixed spurious callback invocation when the SPIM driver was reinitialized to blocking mode from non-blocking mode. 332- Fixed missing workaround for I2S STOP anomaly for nRF52833. 333- Fixed handling of NRFX_SPIM_FLAG_HOLD_XFER setting in the blocking mode of the SPIM driver. 334- Fixed void pointer cast in the CLOCK HAL, which could cause memory corruption with specific compiler settings. 335- Fixed definition of the NRF_CLOCK_LFCLK_Synth value, to make it available also in builds for nRF5340. 336 337## [2.1.0] - 2020-01-24 338### Added 339- Added HALs for DCNF, OSCILLATORS, USBREG, and VREQCTRL. 340- Added support for 1-MHz clock frequency in TWIM. 341- Introduced the NRFX_I2S_STATUS_TRANSFER_STOPPED flag in the I2S driver. 342- Introduced the nrfx_power_compat layer that allows use of the nrfx_power API with new SoC. 343- Added encryption support in the QSPI driver. 344- Added support for USBD in nRF5340. 345- Expanded HALs to cover new functions in nRF5340: GPIO, I2S, PDM, POWER, QSPI, and REGULATORS. 346- Introduced new clock management system in the CLOCK driver. 347- Introduced new audio clock configuration settings in the I2S and PDM drivers for nRF5340. 348- Implemented workaround for nRF5340 anomaly 4 in the CLOCK driver. 349- Implemented workaround for nRF5340 anomaly 10 in the CCM HAL. 350- Implemented workaround for nRF9160 anomaly 21 and nRF5340 anomaly 6 in the NVMC HAL. 351- Implemented workaround for nRF9160 anomaly 23 and nRF5340 anomaly 44 in the UARTE driver. 352- Introduced the NRFX_TWIM_NO_SPURIOUS_STOP_CHECK flag in the TWIM driver. 353- Added functions for getting shortcut configuration in the TWIM HAL. 354 355### Changed 356- Updated MDK to 8.30.2. 357- Reorganized templates of nrfx_config header files for different SoCs. Now they are included through one common file according to the selected SoC. 358- Improved the UARTE driver to consume less current after the driver uninitialization. Now all clocks are disabled properly after uninitialization. 359- Improved the GPIOTE driver robustness by setting the LATCH functionality to be used by default. 360- Changed names of the frequency divider symbols in the QSPI HAL to reflect the new frequencies in nRF5340. Old API names were preserved and are still supported. 361- Improved spurious STOP condition handling in the TWIM driver. 362- Improved sampling procedure in the advanced blocking mode in the SAADC driver. 363- Improved calibration procedure in the SAADC driver for nRF5340 and nRF9160. 364 365### Fixed 366- Fixed address assertions in NVMC driver for the nRF5340 network core. 367- Fixed an issue in the TWI driver that would make the driver stuck when a premature STOP condition was generated by a slave device. The driver now handles this situation properly and signals that a bus error occurred. 368- Fixed the stopping procedure in the PWM driver. Previously in very specific circumstances the PWM output might be not stopped at all or might be immediately restarted. 369 370## [2.0.0] - 2019-11-06 371### Added 372- Added support for nRF5340. 373- Added HALs for: CACHE, FPU, MUTEX, and RESET. 374- Added driver and HAL for IPC. 375- Added possibility to configure in UART and UARTE the number of stop bits and the type of parity, when a given SoC allows it. 376- Added function in the GPIO HAL for selecting the MCU to control the specified pin. 377- Added support for ONESHOT register in the TIMER HAL. 378- Added support for LIST feature in HALs for SPIS and TWIS. 379- Added possibility to choose TIMER instance used for workarounds in the NFCT driver. 380 381### Changed 382- Updated MDK to 8.29.0. 383- Enhanced PWM driver API: added the "p_context" parameter to the event handler. 384- Updated address and task getters in all HALs to return values as uint32_t type. 385- Updated all HAL functions to take the pointer to the structure of registers of the peripheral as their first argument. 386- Changed __STATIC_INLINE symbol to NRF_STATIC_INLINE for HALs and NRFX_STATIC_INLINE for drivers. 387- Refactored the SAADC driver and HAL. 388- Refactored the WDT driver and HAL to support multiple instances. 389- Changed nrfx_gpiote_init() function to take the interrupt priority as its parameter. Previously this priority was an nrfx_config option. 390- Changed nrf_usbd_ep_all_disable() function to disable really all endpoints. Use nrf_usbd_ep_default_config() to restore the default endpoint configuration. 391- Updated nrfx_gpiote_out_init() and nrfx_gpiote_in_init() return codes. Now NRFX_ERROR_INVALID_STATE is changed to NRFX_ERROR_BUSY. 392- Replaced the SWI/EGU driver with one for EGU only. 393- Aligned symbol names for default IRQ priority in nrfx_config. These symbols are now adhering to the following standard: NRFX_xxx_DEFAULT_CONFIG_IRQ_PRIORITY. 394- Changed the way of configuring the MISO pin pull setting in SPI and SPIM drivers. Now it can be set separately for each instance. 395 396### Removed 397- Removed deprecated functions from drivers: TWI and TWIM. See migration guide for details. 398- Removed deprecated functions from HALs: ECB, NVMC, and TEMP. See migration guide for details. 399- Removed redundant bariers in the nrfx_usbd driver. 400- Removed the default configuration values for drivers from the nrfx_config header files. 401 402## [1.8.1] - 2019-10-21 403### Added 404- Added functions in the GPIOTE driver for getting task or event for the specified GPIO pin. 405 406### Changed 407- Updated MDK to version 8.27.1. 408- Moved the nrfx_gppi helper from helpers/nrfx_gppi/ to helpers/. 409- Changed the interrupt initialization in the GPIOTE driver, so that mapping of the GPIOTEx_IRQn enumeration values is no longer needed for nRF9160. 410 411## [1.8.0] - 2019-08-27 412### Added 413- Added support for nRF52833. 414- Added bus recovery feature in the TWI and TWIM drivers. 415- Added the nrfx_gppi helper layer to facilitate developing generic code that can utilize PPI or DPPI, depending on which interface is available in a given SoC. 416 417### Changed 418- Updated MDK to version 8.27.0. 419 420### Fixed 421- Fixed an issue in the TWIM driver that would make the driver stuck when a premature STOP condition was generated by a slave device. The driver now handles this situation properly and signals that a bus error occurred. 422- Fixed a frame timing bug in the NFCT driver. Previously, the timing of the SENS_RES response could be violated after the NFCT peripheral was put to the Sleep state with the SLP_REQ command. 423 424## [1.7.2] - 2019-07-25 425### Added 426- Added functions in the DPPI, GPIOTE, PPI, RTC, and TIMER HALs for getting tasks and events specified by index. 427- Added the possibility of suspending transfers in the TWI driver. This allows combining several transfers into one continuous TWI transaction. 428- Added termination of transfers at deinitialization of the UARTE driver. 429- Added buffer alignment checks in the QSPI driver. 430- Introduced the NRFX_OFFSETOF macro that duplicates the functionality of the built-in offsetof() mechanism, but can be used without issues also with non-constant expressions. 431- Added an alternative way of ending the DMA transfer loop in the USBD driver. 432- Added the CTSTARTED and CTSTOPPED events to the CLOCK HAL. 433 434### Changed 435- Removed an assertion that prevented setting the data payload size of isochronous endpoints to zero, to fulfill requirements of the USB 2.0 specification, paragraph 5.6.3. 436- Declared the tx_buffer_length field in the UART driver's control block as volatile to prevent issues in case of compilation with high optimization level. 437 438### Fixed 439- Fixed an incorrect conversion of frequency values in the RADIO HAL. 440- Fixed an incorrectly enabled interrupt in the QSPI driver. 441- Corrected the LFCLK source selection values in the template configuration file for nRF9160. 442- Fixed support for external LFCLK sources for nRF52811. 443 444## [1.7.1] - 2019-04-08 445### Added 446- Added functions in the NVMC driver for getting the flash page size, the count of pages and the total flash size. 447 448### Fixed 449- Fixed handling of short unaligned write requests (1 or 2 bytes in length) in the nrfx_nvmc_bytes_write() function. 450 451## [1.7.0] - 2019-03-29 452### Added 453- Added drivers for NVMC and TEMP. 454- Added HALs: AAR and FICR. 455- Added support for the custom instruction long frame mode in the QSPI driver. 456 457### Changed 458- Reworked HAL for NVMC. Now it can be used for all SoCs supported by nrfx. 459- Reworked HAL for TEMP. 460- Improved documentation. Now it is more precise and can be generated without warnings with newer versions of doxygen. 461- Improved the UARTE driver to consume less current after the TX operation. Now at the end of the transmission the transmitter is turned off by the STOPTX task. 462- Improved C++ support in drivers. Now fields in structures are filled up in the correct order. 463- Changed to size_t the type used for holding the amount of data in the TWIS driver. 464 465### Fixed 466- Fixed a race condition in the USBD driver. It could occur when an IN transfer was interrupted by an OUT transaction, which in turn was interrupted by a process with a higher priority. 467 468## [1.6.2] - 2019-02-12 469### Added 470- Added the possibility to use the macro NRFX_COREDEP_DELAY_US_LOOP_CYCLES to specify the number of cycles consumed by one iteration of the internal loop in the function nrfx_coredep_delay_us(). 471 472### Changed 473- Updated MDK to version 8.24.1. 474 475## [1.6.1] - 2019-01-29 476### Fixed 477- Fixed an issue in the NFCT driver that caused a performance loss on nRF52832. The interrupt configuration is now properly restored after the NRFX_NFCT_EVT_FIELD_LOST event. 478 479## [1.6.0] - 2019-01-18 480### Added 481- Added support for nRF52811. 482- Added support for the legacy peripherals SPI, TWI, and UART in nRF52810. 483- Added support for SAMPLERATE in nrf_saadc.h. 484- Added clearing of the STOPPED event in the nrfx_saadc_init() function to prevent driver deadlock in some cases. 485- Added HALs: BPROT, MPU, MWU. 486- Added function for reading the pin input buffer configuration in the GPIO HAL. 487- Implemented workaround for nRF9160 anomaly 1 in the I2S driver. 488 489### Changed 490- Improved handling of hardware anomalies in the USBD driver. 491- Updated MDK to version 8.23.1. 492 493### Fixed 494- Fixed the condition in NRFX_WAIT_FOR in the nrfx_saadc_abort() function. The macro now correctly waits for a stop of the driver. 495- Fixed the pending interrupt clearing in NVIC in the nrfx_usbd_stop() function. The driver now correctly handles power management. 496- Fixed the case when nrfx_uarte_tx_in_progress() function would return an incorrect value. The driver now correctly updates the tx_buffer_length variable internally. 497 498## [1.5.0] - 2018-12-12 499### Added 500- Added support for nRF9160. 501- Added allocator for DPPI. 502- Added HALs: DPPI, KMU, REGULATORS, SPU, VMC. 503- Added support for DPPI subscription and publishing in HALs related to nRF9160. 504- Added support for instances 2 and 3 in SPIS, TWIM, TWIS, and UARTE drivers. 505 506### Changed 507- Updated MDK to version 8.21.1. 508 509### Fixed 510- Corrected NRFX_I2S_CONFIG_RATIO value in nrfx_config.h. It now correctly uses supported value. 511 512## [1.4.0] - 2018-11-30 513### Added 514- Added the nrfx_is_word_aligned() function for checking whether an address is word-aligned. 515- Added HAL for ACL. 516- Added functions for disabling and re-enabling interrupts in the SWI driver. 517- Added possibility to completely remove interrupt handling from the WDT driver. 518 519### Changed 520- Updated the documentation for the nrfx_uarte_rx() function. It now correctly reflects the actual behavior of the function. 521 522### Fixed 523- Corrected the type of the nrfx_uarte_xfer_evt_t structure field that holds the amount of transferred bytes. 524- Corrected the way of disabling interrupts in the NFCT driver when moving the peripheral to the disabled state. 525- Fixed a typo in the name of the bmRequest field in the nrfx_usbd_setup_t structure. The new correct name is bRequest. 526- Fixed the nrfx_ppi_channel_fork_assign() function. It now accepts also pre-programmed channels. 527- Fixed handling of long custom instruction responses in the QSPI driver. 528- Fixed a bug affecting the conversion of time to ticks in the TIMER HAL. 529 530## [1.3.1] - 2018-09-28 531### Fixed 532- Corrected the type of nrfx_usbd_ep_status_get() return value. 533- Corrected calls to undefined macros in NFCT and USBD drivers. 534 535## [1.3.0] - 2018-09-21 536### Added 537- Added HAL and driver for NFCT. 538- Added driver for USBD. 539- Added function for setting the burst mode in the SAADC HAL. 540- Added the NRFX_ARRAY_SIZE macro. 541 542### Changed 543- Moved the implementation of nrfx_power_clock_irq_handler() to nrfx_power.c, removed nrfx_power_clock.c. 544 545### Fixed 546- Replaced ARRAY_SIZE macro calls with NRFX_ARRAY_SIZE ones. 547 548## [1.2.0] - 2018-09-06 549### Added 550- Added function for checking if a specific channel is enabled in the GPIOTE HAL. 551- Added support for using the QDEC driver without LED. 552- Added functions for modifying only the event endpoint or only the task endpoint in the PPI HAL. 553- Added function for reading the pin pull configuration in the GPIO HAL. 554 555### Changed 556- Corrected ISOSPLIT enumerator names in the USBD HAL. 557 558### Fixed 559- Fixed a double buffering bug that occurred in the UARTE driver after the RX abort. 560- Fixed the TXRX transfers in the TWIM driver. They can now be started after transfers that are not ended with the stop condition. 561 562## [1.1.0] - 2018-06-15 563### Added 564- Implemented workaround for nRF52832 and nRF52840 anomaly 194 in the I2S driver. 565- Implemented workaround for nRF52840 anomaly 195 in the SPIM driver. 566- Added HALs for CCM, ECB, and RADIO. 567- Extended HALs for GPIO, PPI, SAADC, and USBD. 568- Added support for external LFCLK sources. 569 570### Changed 571- Corrected handling of transfer lengths in the TWI driver. 572- Updated MDK to version 8.17.0. 573 574### Fixed 575- Fixed logging in the PPI driver. 576- Fixed SPIM interrupt definition for nRF52810. 577- Fixed Slave Select configuration in the SPIM driver. 578- Corrected default settings for NRF_SPIM3. 579- Fixed a typo in the UARTE TXDRDY event definition. 580- Corrected the TIMEOUT event clearing in the WDT interrupt handler. 581 582## [1.0.0] - 2018-03-21 583### Added 584- Added the NRFX_WAIT_FOR macro to improve the time-out functionality in QSPI and SAADC drivers. 585- Added glue layer macros for checking and modifying the pending status of interrupts. 586- Added new enumeration values for interrupts and events in the UARTE HAL. 587- Implemented workarounds for nRF52 anomalies 192 and 201 in the CLOCK driver. 588- Implemented workaround for nRF52840 anomaly 122 in the QSPI driver. 589- Implemented workaround for nRF52840 anomaly 198 in the SPIM driver. 590 591### Changed 592- Updated MDK to 8.16.0. 593- Extended input pin configuration in the GPIOTE driver. 594- Unified the way of checking if a required event handler was provided. Now, all drivers do it with assertions. 595- Changed the RNG bias correction configuration option to be enabled by default. 596- Refactored the ADC driver and HAL. 597- Corrected assertions in the TIMER driver to make it usable in debug version with PPI. 598- Improved buffer handling in the I2S driver. The API of the driver has been slightly modified. 599- Enhanced SPIS driver API: added the "p_context" parameter, allowed NULL pointers for zero-length buffers. 600 601### Fixed 602- Fixed result value casting in the TEMP HAL. 603- Fixed types of conversion result and buffer size in the ADC HAL and driver. 604- Fixed time-out in the SAADC driver in abort function. 605 606## [0.8.0] - 2017-12-20 607### Added 608- Added XIP support in the QSPI driver. 609- Implemented Errata 132 in the CLOCK driver. 610- Added function for checking if a TIMER instance is enabled. 611- Added extended SPIM support. 612 613### Changed 614- Updated MDK to 8.15.0. Introduced Segger Embedded Studio startup files. 615- Updated drivers: COMP, PWM, QDEC, SAADC, SPIS, TIMER, TWI, TWIS. 616- Changed the type used for transfer lengths to 'size_t' in drivers: SPI, SPIM, SPIS, TWI, TWIM, TWIS, UART, UARTE. Introduced checking of EasyDMA transfers limits. 617- Updated HALs: COMP, NVMC, UART, UARTE, USBD. 618- Updated template files and documentation of configuration options. 619 620### Fixed 621- Fixed TWI and TWIM drivers so that they now support GPIOs from all ports. 622- Fixed definitions related to compare channels in the TIMER HAL. 623 624### Removed 625- Removed the possibility of passing NULL instead of configuration to get default settings during drivers initialization. 626- Removed support for UART1 and PRS box #5. 627 628## [0.7.0] - 2017-10-20 629### Added 630- This CHANGELOG.md file. 631- README.md file with simple description and explanations. 632- HAL for: ADC, CLOCK, COMP, ECB, EGU, GPIO, GPIOTE, I2S, LPCOMP, NVMC, PDM, POWER, PPI, PWM, QDEC, QSPI, RNG, RTC, SAADC, SPI, SPIM, SPIS, ARM(R) SysTick, TEMP, TIMER, TWI, TWIM, TWIS, UART, UARTE, USBD, WDT. 633- Drivers for: ADC, CLOCK, COMP, GPIOTE, I2S, LPCOMP, PDM, POWER, PWM, QDEC, QSPI, RNG, RTC, SAADC, SPI, SPIM, SPIS, ARM(R) SysTick, TIMER, TWI, TWIM, TWIS, UART, UARTE, WDT. 634- Allocators for: PPI, SWI/EGU. 635- MDK in version 8.14.0. 636- Offline documentation for every added driver and simple integration description. 637- Template integration files. 638
