Release Notes for STM32WBxx HAL Drivers
Copyright © 2019 STMicroelectronics
License
This software component is licensed by ST under BSD 3-Clause license, the “License”; You may not use this component except in compliance with the License. You may obtain a copy of the License at:
https://opensource.org/licenses/BSD-3-Clause
Purpose
The STM32Cube HAL and LL, an STM32 abstraction layer embedded software, ensure maximized portability across STM32 portfolio.
The Portable APIs layer provides a generic, multi instanced and simple set of APIs to interact with the upper layer (application, libraries and stacks). It is composed of native and extended APIs set. It is directly built around a generic architecture and allows the build-upon layers, like the middleware layer, to implement its functions without knowing in-depth the used STM32 device. This improves the library code reusability and guarantees an easy portability on other devices and STM32 families.
The Low Layer (LL) drivers are part of the STM32Cube firmware HAL that provide basic set of optimized and one shot services. The Low layer drivers, contrary to the HAL ones are not Fully Portable across the STM32 families; the availability of some functions depend on the physical availability of the relative features on the product. The Low Layer (LL) drivers are designed to offer the following features:
- New set of inline function for direct and atomic register access
- One-shot operations that can be used by the HAL drivers or from application level.
- Fully Independant from HAL and can be used in standalone usage (without HAL drivers)
- Full features coverage of the all the supported peripherals.
Update History
Main Changes
Add support for STM32WB15xx and STM32WB10xx
| Peripheral | Headline |
|---|---|
| generic | Prevent redefinition of UNUSED macro |
| generic | Add support of Keil V6 |
| USB | Fix device ISO IN double buffer mode |
| USB | Remove duplication of PCD_GET_EP_RX_CNT define |
| USB | Fix PMA rx count descriptor update |
| USB | Fix HAL_PCD_EP_Open indentation |
| USB | Rework device start and stop |
| USB | Remove register keyword as no more supported by c++ compiler |
| USB | Fix double buffer mode |
| USB | Fix Enabling ULPI interface |
| UART | Arrays are now declared as static const |
| UART | Add a HAL UART service to enable RTO interrupt |
| UART | Implement HAL UART enhanced reception services (ReceptionToIdle) |
| UART | Fix typos introduced in UART State definition description |
| UART | Fix invalid CR1 init in UART_SetConfig() and SMARTCARD_SetConfig() |
| TIMER | Correct timeout vulnerability |
| TIMER | Correct counter value latch delay at high frequency |
| TIMER | Correct error: “LL_TIM_TS_ITR11” is undefined |
| TIMER | Correct LL_TIM_E_TestLL_TIM_SetRemap |
| TIMER | Correct HAL_TIM_OnePulse_Start ignoring OutputChannel parameter leading to unexpected behavior |
| TIMER | Correct ONEPULSEMODE defines. Descriptions were inverted |
| TIMER | Fix MISRA errors |
| TIMER | Correct the return value of LL_TIM_GetCounterMode |
| LPTIM | Correct MISRAC2012-Rule-8.3_b: Declaration/definition of HAL_LPTIM_RegisterCallback is inconsistent with previous declaration |
| LPTIM | Fix external clock configuration (was incomplete for some ClockSource/CounterSource combinations) |
| ADC | Correct timeout vulnerability |
| ADC | Increase internal regulator stabilization time from 10us to 20us |
| COMP | Correct timeout vulnerability |
| CRYP | Correct official NIST CCM test pattern enciphering failing when header length is null |
| CRYP | Correct HAL_CRYP_SetConfig not storing the content of KeyIVConfigSkip |
| CRYP | Correct the GCM decryption in interrupt mode |
Backward Compatibility
This release is compatible with the previous versions.
Main Changes
Maitenance release
All peripheral
| Peripheral | Headline |
|---|---|
| CRYP | Add precision on data types |
| CRYP | AES GCM: handling of AUD with size not multiple of 4 bytes not properly handle in CRYP_AESGCM_Process_IT |
| CRYP | Fix CRYP HAL driver to manage GCM header lengths not multiple of 4 bytes in 8-bit, 16-bit and 32-bit data types. |
| CRYP | Update to be able to manage GCM/GMAC/CCM header feed in DMA mode |
| CRYP | Fix the enciphering issue and pass all the official NIST CCM test patterns. |
| EXTI | Replace reserved word __LINE__ by __EXTI_LINE__ |
| EXTI | Add missing line 46 to LL_EXTI_LINE_ALL_32_63 |
| I2C | Refactor documentation |
| PWR | Remove ‘register’ storage class specifier |
| RCC | HSE bypass related API must be removed from RCC LL/HAL drivers |
| RCC | LSI is no longer a source for RF WUP |
| RCC | SystemCoreClockUpdate shall not be called by the HAL |
| TIM | Add HAL_TIM_DMABurst_MultiWriteStart and HAL_TIM_DMABurst_MultiReadStart to support multiple DMA bursts. |
| TIM | Minor correction to fix warnings |
| WWDG | Correct driver description |
Backward Compatibility
This release is compatible with the previous versions.
Main Changes
Maitenance release
All peripheral
| Peripheral | Headline |
|---|---|
| All | Remove ‘register’ storage class specifier |
| CRYP | AES GCM: Add support data encrypt/decrypt with length not multiple of 16 bytes |
| DMA | LOCK UNLOCK process to modify, as LOCK is done at Start and UNLOCK is done at Completion processus |
| DMA | Correct the computation for DMAMUX overrun IT mask |
| GPIO | Correct bug on HAL_GPIO_TogglePin and LL_GPIO_TogglePin to allow to toggle multiple pin |
| I2C | Sequential transfer MAX_NBYTE_SIZE correspond to no reload |
| SPI | problematic timeout management inside SPI DMA xfer complete handler (interrupt context) |
| SPI | Issue in 3wires communication (Need Disable / Enable SPI) |
| IWDG | Correct the IWDG start-up timeout (insufficiently low) |
| USB | Improve OUT EP re-enable with double buffering |
| USB | Add workaround for unexpected USB wakeup during stop mode |
| USB | Clear unexpected wakeup during suspend IT |
| USB | Adjust IO address access to be volatile |
| USB | Manage IN isoc IN transfer complete interrupt |
| RTC | Issue on macro when clearing or getting flag TAMP, TIMESTAMP in EXTI |
| SAI | Issue with ‘register’ storage class specifier, should be removed |
| SMARTCARD | No repetition after NACK is received in smartcard T=0 |
| SMARTCARD | Improve doxygen visual result |
| UART | Rework BRR register value computation in HAL_UART_Init() for ROM size gain |
| Utils | Align package information to RM0434 |
| Utils | Turn UTILS_SetFlashLatency() into LL_SetFlashLatency() public function |
| TIM | Order of disabling in HAL_TIM_IC_Stop_DMA function |
| TIM | COUNTERMODE defines are inverted for TIM_CR1_CMS in ll_tim.h |
Backward Compatibility
This release is compatible with the previous versions.
Main Changes
Introduction of STM32WB5M, STM32WB35xx and STM32WB30xx product
This release introduce the support of STM32WB5Mxx, STM32WB35xx product and its value line STM32WB30xx.
Added features:
- Introduction of STM32WB35xx.
| Peripheral | Headline |
|---|---|
| HAL/LL | VREFBUF trimming calibration must be written by software |
| HAL | HAL_SetTickFreq() should update frequency on Systick_LOAD register and uwTickFreq correctly |
| GPIO | LL_GPIO_Init() generate undesired pulse |
| I2C | HardFault in I2C_DMAXferCplt |
| I2C | Incorrectly enable interrupts in I2C_Enable_IRQ routine when InterruptRequest = I2C_XFER_CPLT_IT |
| RCC | Cannot enable PLL if PLL OFF with identical PLL config |
| RCC | Clock reconfiguration issues once PLLSAI used |
Backward Compatibility
This release is compatible with the previous versions.
Main Changes
Maitenance release
| Peripheral | Headline |
|---|---|
| CRYP | Correct suspend and resume operation with a different parameter size. |
| I2C | Correct MISRA error. The value assigned to variable tmpITFlags was never used. |
| I2C | Correct I2C slave interrupt handling issue. |
| IPCC | Add LL_IPCC_GetChannelNumber API which return the number of channel supported by the device. |
| LPTIM | Correct doxygen group names. |
| PKA | Use a macro __PKA_RAM_PARAM_END to clear the last word of any input parameters. |
| TSC | Correct MISRA error related to tag __TSC_HandleTypeDef which is unused. |
| ADC | Add two functions to ease configuration of internal channels. |
Backward Compatibility
This release is compatible with the previous versions.
Dependencies
This software release is compatible with:
STM32CubeMX V6.0.0
Main Changes
Maitenance release
| Peripheral | Headline |
|---|---|
| CRYP | Document a restriction regarding size field on HAL_CRYP_Encrypt_DMA, HAL_CRYP_Decrypt_DMA API. |
| CRYP | Correct several MISRA C:2012 and Code Sonar compliancy improvements. |
| FLASH | Move FLASH_SIZE define from hal flash. h to cmsis device file |
| FLASH | Correct ECC management in HAL FLASH driver |
| FLASH | Correct #define in stm32wbxx_hal_flash.h - FLASH_PAGE_NB |
| RCC | Correct PLL characteristics |
| TIMER | Add assertion check inside HAL_TIMEx_MasterConfigSynchronization |
| TIMER | Make LL_TIM_SetETRSource in line with RM0434 |
| WWDG | Correct typical frequency computation description inside the header file |
| IRDA | Improve the description of the APIs |
| SMARTCARD | Fix GCC compilation warning |
| UART | Correct possible overflow with wordlength = 9bits and NO parity in HAL_UART_Transmit() and HAL_IRDA_Transmit() |
| UART | Fix GCC compilation warning |
| USART | Correct possible overflow with wordlength = 9bits and NO parity in HAL_UART_Transmit() and HAL_IRDA_Transmit() |
| USART | Fix GCC compilation warning |
Backward Compatibility
This release is compatible with the previous versions.
Dependencies
This software release is compatible with:
STM32CubeMX V5.4.0
Main Changes
STM32WB50xx introduction and maintenance release
First release for STM32WBxx HAL drivers introducing stm32wb50xx devices.
| Peripheral | Headline |
|---|---|
| RCC | Add capabilty to configure RNG clock in one step. |
| Before two steps were required: USB clock then RNG clock. | |
| Two step method is still supported and compatible. | |
| IRDA | Avoid using macros with function calls as argument |
| LPTIM | Add polling mechanims to check xxOK flags |
| Add new EXTI macros to manage LPTIM wakeup EXTI interrupts | |
| USB | Improve ep OUT interrupt handler |
| Ensure 16 bit access to USB PMA | |
| Enable BCD | |
| RNG | Add new error definitions |
| SAI | Correct SAI frequency calculation in case of SPDIF output |
| SMARTCARD | Avoid using macros with function calls as argument |
| UART | Avoid using macros with function calls as argument |
| USART | Avoid using macros with function calls as argument |
Backward Compatibility
This release is compatible with the previous versions.
Dependencies
This software release is compatible with:
STM32CubeMX V5.3.0
Main Changes
Maintenance release
Maintenance release of HAL and Low layers drivers supporting STM32WB55xx devices.
| Peripheral | Headline |
|---|---|
| COMP | Only cosmetic changes |
| CRYP | Only changes related to documentation |
| EXTI | Only changes related to documentation |
| FLASH | Improve code efficiency |
| GPIO | Improve HAL_GPIO_TogglePin efficiency |
| IWDG | Only changes related to documentation |
| RCC | Only changes related to documentation |
| RTC | LL_RTC_BAK_GetRegister generates warning on GCC 6.3.1 20170620 |
| TIM | Only changes related to documentation |
| TSC | Correct __HAL_TSC_GET_GROUP_STATUS which was checking only TSC_GROUP1_IDX |
Backward Compatibility
This release is compatible with the previous versions.
Dependencies
This software release is compatible with:
STM32CubeMX V5.2.0
Main Changes
First release
First official release of HAL (Hardware Abstraction Layer) and LL (Low layers) drivers to support STM32WB55xx.