1# Changelog 2All notable changes to this project are documented in this file. 3 4## [2.5.0] - 2021-05-05 5### Added 6- Added support for double-buffered transfers in the QSPI driver. 7- Added support for one-by-one channel configuration in the SAADC driver. 8- Added critical sections for channel allocation and deallocation in the DPPI driver. 9- Added support for generating documentation in the RST format using Sphinx tool. 10- Added high-drive pin configuration in the QSPI, TWIM, and SPIM drivers. 11- Added report period setting of 1 sample in the QDEC HAL. 12- Implemented workaround for nRF53 Series anomaly 121 in the QSPI driver. 13 14### Changed 15- Updated MDK to version 8.40.2. 16- Removed implicit channel deallocation during initialization in the GPIOTE driver. 17- Restricted pins that are supported for specific configuration on nRF5340 in the QSPI, TWIM, and SPIM drivers. 18- Aligned IRQ handler symbols to new naming scheme for nRF53 Series. 19 20### Fixed 21- Fixed register access sequence in the COMP driver. 22- Fixed memory corruption when uninitialized channel was freed in the GPIOTE driver. 23- Fixed spurious access of DCX pin for every instance of the peripheral when extended features were enabled in the SPIM driver. 24- Fixed overwrite of MCUSEL configuration in the nrf_gpio_cfg() function. 25- Fixed driver behavior for zero-length transfer in the TWIM driver. 26- Fixed internal state handling when transfer is aborted before finishing in the TWI and TWIM drivers. 27- Corrected assertions for MPS requirements in the USBD driver. 28- Corrected symbol describing maximum data payload for a full-speed isochronous endpoint in the USBD driver. 29 30## [2.4.0] - 2020-11-13 31### Added 32- Added the channel allocator feature in the GPIOTE driver. 33- Added support for registers associated with the Direction Finding feature in the RADIO HAL. 34- Added support for the SUBSCRIBE and PUBLISH registers in the following HALs: AAR, CCM, ECB, RADIO, and RNG. 35- Added support for the LATENCY register present on nRF5340 in the GPIOTE driver and the GPIOTE HAL. 36- Implemented workaround for nRF53 Series anomaly 53 in the POWER driver. 37 38### Changed 39- Updated MDK to 8.37.0. 40 41### Fixed 42- Fixed unused parameters in the PPI, CLOCK, SPIM and POWER drivers to resolve compilation warnings, such as 'flags' in the SPIM driver. 43- Fixed a race condition in the COMP driver when interrupt occured before update of the driver internal state. 44- Fixed minor C++ compilation warnings in the drivers. 45- Fixed implementation of workaround for nRF52 Series anomaly 197 in the POWER HAL, which was applied in incorrect configuration. 46- Fixed implementation of workaround for nRF53 Series anomaly 4 in the CLOCK driver, which was applied in incorrect configuration. 47- Fixed the incorrect signature of the nrf_clock_alwaysrun_set() function. 48 49## [2.3.0] - 2020-08-19 50### Added 51- Added support for nRF52805. 52- Implemented workaround for nRF52 Series anomaly 197 in the POWER HAL. 53- Implemented workaround for nRF52 Series anomalies 211 and 223 in the USBD driver. 54- Added support for the nRF53 Series in the QSPI HAL. 55- Added function in the GPIO HAL that returns port index. 56- Introduced a QSPI HAL symbol that indicates the availability of the QSPI mode 1. 57- Introduced shortcut functionality in the CCM HAL. 58- Added function in the TIMER HAL for setting the specified shortcuts. 59- Added optional two-stage start procedure of the LFXO in the CLOCK driver. 60 61### Changed 62- Updated MDK to 8.35.0. 63- Divided network and application core-specific functionalities for nRF5340 in the RESET HAL and the reset reason helper. 64 65### Fixed 66- Corrected assertions in the NVMC driver. 67- Corrected return types in the CCM HAL. 68- Fixed setting of program memory access mode for secure code in the NVMC driver. 69- Removed usage of the NRF_UICR symbol on non-secure targets in address validity checks in the NVMC driver. 70- Fixed an error message in the SPIM driver that prevented successful compilation with logging enabled. 71- Fixed unused parameters in the PPI HAL. 72 73## [2.2.0] - 2020-04-28 74### Added 75- Added support for nRF52820. 76- 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. 77- Added the nrfx_reset_reason helper layer, to facilitate developing generic code that uses the RESETREAS register. 78- Implemented workarounds for nRF52 Series anomalies 170 and 196 in the I2S driver. 79- Added implicit casting of uint32_t to unsigned long in log messages, to prevent compiler warnings. 80- Added missing secure and non-secure peripheral symbol translations for nRF5340 and nRF9160. 81- Added functions in the NVMC driver for reading and writing halfword data from the OTP region of the UICR. 82 83### Changed 84- Updated MDK to 8.32.1. 85- Improved documentation regarding double-buffered reception in the UARTE driver. 86- Unified policy of pin cleanup procedure during uninitialization of the drivers. Now every driver restores utilized pins to default setting. 87- Removed support for revision Engineering A of nRF52840 in the USBD driver. 88- Changed selected while() loops to NRFX_WAIT_FOR() macro in the SPIM, UARTE and CLOCK drivers to improve robustness. 89 90### Fixed 91- Fixed assertions that check write addresses in the NVMC driver. Now the UICR memory region is handled properly. 92- Fixed a race condition in the CLOCK driver when requested clock was stopped during ramp-up from high priority interrupt. 93- Fixed assertions that check pin numbers in the GPIO HAL and GPIOTE driver. Now noncontiguous groups of available pin numbers are handled properly. 94- Fixed assertion that checks correctness of limit setting in the SAADC driver. 95- Fixed spurious callback invocation when the SPIM driver was reinitialized to blocking mode from non-blocking mode. 96- Fixed missing workaround for I2S STOP anomaly for nRF52833. 97- Fixed handling of NRFX_SPIM_FLAG_HOLD_XFER setting in the blocking mode of the SPIM driver. 98- Fixed void pointer cast in the CLOCK HAL, which could cause memory corruption with specific compiler settings. 99- Fixed definition of the NRF_CLOCK_LFCLK_Synth value, to make it available also in builds for nRF5340. 100 101## [2.1.0] - 2020-01-24 102### Added 103- Added HALs for DCNF, OSCILLATORS, USBREG, and VREQCTRL. 104- Added support for 1-MHz clock frequency in TWIM. 105- Introduced the NRFX_I2S_STATUS_TRANSFER_STOPPED flag in the I2S driver. 106- Introduced the nrfx_power_compat layer that allows use of the nrfx_power API with new SoC. 107- Added encryption support in the QSPI driver. 108- Added support for USBD in nRF5340. 109- Expanded HALs to cover new functions in nRF5340: GPIO, I2S, PDM, POWER, QSPI, and REGULATORS. 110- Introduced new clock management system in the CLOCK driver. 111- Introduced new audio clock configuration settings in the I2S and PDM drivers for nRF5340. 112- Implemented workaround for nRF5340 anomaly 4 in the CLOCK driver. 113- Implemented workaround for nRF5340 anomaly 10 in the CCM HAL. 114- Implemented workaround for nRF9160 anomaly 21 and nRF5340 anomaly 6 in the NVMC HAL. 115- Implemented workaround for nRF9160 anomaly 23 and nRF5340 anomaly 44 in the UARTE driver. 116- Introduced the NRFX_TWIM_NO_SPURIOUS_STOP_CHECK flag in the TWIM driver. 117- Added functions for getting shortcut configuration in the TWIM HAL. 118 119### Changed 120- Updated MDK to 8.30.2. 121- Reorganized templates of nrfx_config header files for different SoCs. Now they are included through one common file according to the selected SoC. 122- Improved the UARTE driver to consume less current after the driver uninitialization. Now all clocks are disabled properly after uninitialization. 123- Improved the GPIOTE driver robustness by setting the LATCH functionality to be used by default. 124- 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. 125- Improved spurious STOP condition handling in the TWIM driver. 126- Improved sampling procedure in the advanced blocking mode in the SAADC driver. 127- Improved calibration procedure in the SAADC driver for nRF5340 and nRF9160. 128 129### Fixed 130- Fixed address assertions in NVMC driver for the nRF5340 network core. 131- 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. 132- 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. 133 134## [2.0.0] - 2019-11-06 135### Added 136- Added support for nRF5340. 137- Added HALs for: CACHE, FPU, MUTEX, and RESET. 138- Added driver and HAL for IPC. 139- Added possibility to configure in UART and UARTE the number of stop bits and the type of parity, when a given SoC allows it. 140- Added function in the GPIO HAL for selecting the MCU to control the specified pin. 141- Added support for ONESHOT register in the TIMER HAL. 142- Added support for LIST feature in HALs for SPIS and TWIS. 143- Added possibility to choose TIMER instance used for workarounds in the NFCT driver. 144 145### Changed 146- Updated MDK to 8.29.0. 147- Enhanced PWM driver API: added the "p_context" parameter to the event handler. 148- Updated address and task getters in all HALs to return values as uint32_t type. 149- Updated all HAL functions to take the pointer to the structure of registers of the peripheral as their first argument. 150- Changed __STATIC_INLINE symbol to NRF_STATIC_INLINE for HALs and NRFX_STATIC_INLINE for drivers. 151- Refactored the SAADC driver and HAL. 152- Refactored the WDT driver and HAL to support multiple instances. 153- Changed nrfx_gpiote_init() function to take the interrupt priority as its parameter. Previously this priority was an nrfx_config option. 154- Changed nrf_usbd_ep_all_disable() function to disable really all endpoints. Use nrf_usbd_ep_default_config() to restore the default endpoint configuration. 155- Updated nrfx_gpiote_out_init() and nrfx_gpiote_in_init() return codes. Now NRFX_ERROR_INVALID_STATE is changed to NRFX_ERROR_BUSY. 156- Replaced the SWI/EGU driver with one for EGU only. 157- 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. 158- Changed the way of configuring the MISO pin pull setting in SPI and SPIM drivers. Now it can be set separately for each instance. 159 160### Removed 161- Removed deprecated functions from drivers: TWI and TWIM. See migration guide for details. 162- Removed deprecated functions from HALs: ECB, NVMC, and TEMP. See migration guide for details. 163- Removed redundant bariers in the nrfx_usbd driver. 164- Removed the default configuration values for drivers from the nrfx_config header files. 165 166## [1.8.1] - 2019-10-21 167### Added 168- Added functions in the GPIOTE driver for getting task or event for the specified GPIO pin. 169 170### Changed 171- Updated MDK to version 8.27.1. 172- Moved the nrfx_gppi helper from helpers/nrfx_gppi/ to helpers/. 173- Changed the interrupt initialization in the GPIOTE driver, so that mapping of the GPIOTEx_IRQn enumeration values is no longer needed for nRF9160. 174 175## [1.8.0] - 2019-08-27 176### Added 177- Added support for nRF52833. 178- Added bus recovery feature in the TWI and TWIM drivers. 179- 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. 180 181### Changed 182- Updated MDK to version 8.27.0. 183 184### Fixed 185- 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. 186- 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. 187 188## [1.7.2] - 2019-07-25 189### Added 190- Added functions in the DPPI, GPIOTE, PPI, RTC, and TIMER HALs for getting tasks and events specified by index. 191- Added the possibility of suspending transfers in the TWI driver. This allows combining several transfers into one continuous TWI transaction. 192- Added termination of transfers at deinitialization of the UARTE driver. 193- Added buffer alignment checks in the QSPI driver. 194- 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. 195- Added an alternative way of ending the DMA transfer loop in the USBD driver. 196- Added the CTSTARTED and CTSTOPPED events to the CLOCK HAL. 197 198### Changed 199- 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. 200- 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. 201 202### Fixed 203- Fixed an incorrect conversion of frequency values in the RADIO HAL. 204- Fixed an incorrectly enabled interrupt in the QSPI driver. 205- Corrected the LFCLK source selection values in the template configuration file for nRF9160. 206- Fixed support for external LFCLK sources for nRF52811. 207 208## [1.7.1] - 2019-04-08 209### Added 210- Added functions in the NVMC driver for getting the flash page size, the count of pages and the total flash size. 211 212### Fixed 213- Fixed handling of short unaligned write requests (1 or 2 bytes in length) in the nrfx_nvmc_bytes_write() function. 214 215## [1.7.0] - 2019-03-29 216### Added 217- Added drivers for NVMC and TEMP. 218- Added HALs: AAR and FICR. 219- Added support for the custom instruction long frame mode in the QSPI driver. 220 221### Changed 222- Reworked HAL for NVMC. Now it can be used for all SoCs supported by nrfx. 223- Reworked HAL for TEMP. 224- Improved documentation. Now it is more precise and can be generated without warnings with newer versions of doxygen. 225- 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. 226- Improved C++ support in drivers. Now fields in structures are filled up in the correct order. 227- Changed to size_t the type used for holding the amount of data in the TWIS driver. 228 229### Fixed 230- 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. 231 232## [1.6.2] - 2019-02-12 233### Added 234- 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(). 235 236### Changed 237- Updated MDK to version 8.24.1. 238 239## [1.6.1] - 2019-01-29 240### Fixed 241- 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. 242 243## [1.6.0] - 2019-01-18 244### Added 245- Added support for nRF52811. 246- Added support for the legacy peripherals SPI, TWI, and UART in nRF52810. 247- Added support for SAMPLERATE in nrf_saadc.h. 248- Added clearing of the STOPPED event in the nrfx_saadc_init() function to prevent driver deadlock in some cases. 249- Added HALs: BPROT, MPU, MWU. 250- Added function for reading the pin input buffer configuration in the GPIO HAL. 251- Implemented workaround for nRF9160 anomaly 1 in the I2S driver. 252 253### Changed 254- Improved handling of hardware anomalies in the USBD driver. 255- Updated MDK to version 8.23.1. 256 257### Fixed 258- Fixed the condition in NRFX_WAIT_FOR in the nrfx_saadc_abort() function. The macro now correctly waits for a stop of the driver. 259- Fixed the pending interrupt clearing in NVIC in the nrfx_usbd_stop() function. The driver now correctly handles power management. 260- 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. 261 262## [1.5.0] - 2018-12-12 263### Added 264- Added support for nRF9160. 265- Added allocator for DPPI. 266- Added HALs: DPPI, KMU, REGULATORS, SPU, VMC. 267- Added support for DPPI subscription and publishing in HALs related to nRF9160. 268- Added support for instances 2 and 3 in SPIS, TWIM, TWIS, and UARTE drivers. 269 270### Changed 271- Updated MDK to version 8.21.1. 272 273### Fixed 274- Corrected NRFX_I2S_CONFIG_RATIO value in nrfx_config.h. It now correctly uses supported value. 275 276## [1.4.0] - 2018-11-30 277### Added 278- Added the nrfx_is_word_aligned() function for checking whether an address is word-aligned. 279- Added HAL for ACL. 280- Added functions for disabling and re-enabling interrupts in the SWI driver. 281- Added possibility to completely remove interrupt handling from the WDT driver. 282 283### Changed 284- Updated the documentation for the nrfx_uarte_rx() function. It now correctly reflects the actual behavior of the function. 285 286### Fixed 287- Corrected the type of the nrfx_uarte_xfer_evt_t structure field that holds the amount of transferred bytes. 288- Corrected the way of disabling interrupts in the NFCT driver when moving the peripheral to the disabled state. 289- Fixed a typo in the name of the bmRequest field in the nrfx_usbd_setup_t structure. The new correct name is bRequest. 290- Fixed the nrfx_ppi_channel_fork_assign() function. It now accepts also pre-programmed channels. 291- Fixed handling of long custom instruction responses in the QSPI driver. 292- Fixed a bug affecting the conversion of time to ticks in the TIMER HAL. 293 294## [1.3.1] - 2018-09-28 295### Fixed 296- Corrected the type of nrfx_usbd_ep_status_get() return value. 297- Corrected calls to undefined macros in NFCT and USBD drivers. 298 299## [1.3.0] - 2018-09-21 300### Added 301- Added HAL and driver for NFCT. 302- Added driver for USBD. 303- Added function for setting the burst mode in the SAADC HAL. 304- Added the NRFX_ARRAY_SIZE macro. 305 306### Changed 307- Moved the implementation of nrfx_power_clock_irq_handler() to nrfx_power.c, removed nrfx_power_clock.c. 308 309### Fixed 310- Replaced ARRAY_SIZE macro calls with NRFX_ARRAY_SIZE ones. 311 312## [1.2.0] - 2018-09-06 313### Added 314- Added function for checking if a specific channel is enabled in the GPIOTE HAL. 315- Added support for using the QDEC driver without LED. 316- Added functions for modifying only the event endpoint or only the task endpoint in the PPI HAL. 317- Added function for reading the pin pull configuration in the GPIO HAL. 318 319### Changed 320- Corrected ISOSPLIT enumerator names in the USBD HAL. 321 322### Fixed 323- Fixed a double buffering bug that occurred in the UARTE driver after the RX abort. 324- Fixed the TXRX transfers in the TWIM driver. They can now be started after transfers that are not ended with the stop condition. 325 326## [1.1.0] - 2018-06-15 327### Added 328- Implemented workaround for nRF52832 and nRF52840 anomaly 194 in the I2S driver. 329- Implemented workaround for nRF52840 anomaly 195 in the SPIM driver. 330- Added HALs for CCM, ECB, and RADIO. 331- Extended HALs for GPIO, PPI, SAADC, and USBD. 332- Added support for external LFCLK sources. 333 334### Changed 335- Corrected handling of transfer lengths in the TWI driver. 336- Updated MDK to version 8.17.0. 337 338### Fixed 339- Fixed logging in the PPI driver. 340- Fixed SPIM interrupt definition for nRF52810. 341- Fixed Slave Select configuration in the SPIM driver. 342- Corrected default settings for NRF_SPIM3. 343- Fixed a typo in the UARTE TXDRDY event definition. 344- Corrected the TIMEOUT event clearing in the WDT interrupt handler. 345 346## [1.0.0] - 2018-03-21 347### Added 348- Added the NRFX_WAIT_FOR macro to improve the time-out functionality in QSPI and SAADC drivers. 349- Added glue layer macros for checking and modifying the pending status of interrupts. 350- Added new enumeration values for interrupts and events in the UARTE HAL. 351- Implemented workarounds for nRF52 anomalies 192 and 201 in the CLOCK driver. 352- Implemented workaround for nRF52840 anomaly 122 in the QSPI driver. 353- Implemented workaround for nRF52840 anomaly 198 in the SPIM driver. 354 355### Changed 356- Updated MDK to 8.16.0. 357- Extended input pin configuration in the GPIOTE driver. 358- Unified the way of checking if a required event handler was provided. Now, all drivers do it with assertions. 359- Changed the RNG bias correction configuration option to be enabled by default. 360- Refactored the ADC driver and HAL. 361- Corrected assertions in the TIMER driver to make it usable in debug version with PPI. 362- Improved buffer handling in the I2S driver. The API of the driver has been slightly modified. 363- Enhanced SPIS driver API: added the "p_context" parameter, allowed NULL pointers for zero-length buffers. 364 365### Fixed 366- Fixed result value casting in the TEMP HAL. 367- Fixed types of conversion result and buffer size in the ADC HAL and driver. 368- Fixed time-out in the SAADC driver in abort function. 369 370## [0.8.0] - 2017-12-20 371### Added 372- Added XIP support in the QSPI driver. 373- Implemented Errata 132 in the CLOCK driver. 374- Added function for checking if a TIMER instance is enabled. 375- Added extended SPIM support. 376 377### Changed 378- Updated MDK to 8.15.0. Introduced Segger Embedded Studio startup files. 379- Updated drivers: COMP, PWM, QDEC, SAADC, SPIS, TIMER, TWI, TWIS. 380- 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. 381- Updated HALs: COMP, NVMC, UART, UARTE, USBD. 382- Updated template files and documentation of configuration options. 383 384### Fixed 385- Fixed TWI and TWIM drivers so that they now support GPIOs from all ports. 386- Fixed definitions related to compare channels in the TIMER HAL. 387 388### Removed 389- Removed the possibility of passing NULL instead of configuration to get default settings during drivers initialization. 390- Removed support for UART1 and PRS box #5. 391 392## [0.7.0] - 2017-10-20 393### Added 394- This CHANGELOG.md file. 395- README.md file with simple description and explanations. 396- 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. 397- 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. 398- Allocators for: PPI, SWI/EGU. 399- MDK in version 8.14.0. 400- Offline documentation for every added driver and simple integration description. 401- Template integration files. 402
