HAL SBS How to Use

group SBS_How_To_Use

How to use the SBS HAL module driver

The SBS HAL driver can be used as follows:

After startup, SBS peripheral is not active by default. Use HAL_RCC_SBS_EnableClock() function to enable SBS APB3 clock.

This module provides different sets of APIs that allow to :

1. Analog IO switch supply : Several APIs are available to manage the analog IO switch supply

   • Configure the I/O analog switches supply:

     • This functionality is ensured by HAL_SBS_SetAnalogIOSwitchSupply() function.

   • Get the I/O analog switches supply configuration:

     • This functionality is ensured by HAL_SBS_GetAnalogIOSwitchSupply() function.

2. Manage floating point unit interrupts : Several APIs are available to manage the floating point unit interrupts

   • Enable and disable the floating point unit interrupts:

     • These functionalities are ensured respectively by HAL_SBS_EnableFPUIT() and HAL_SBS_DisableFPUIT().

   • Get the floating point unit interrupts state:

     • This functionality is ensured by HAL_SBS_IsEnabledFPUIT() function.

3. Manage TIM break inputs : This feature is used to control the system break interconnect to TIM1/8/15/16/17 break inputs

   • Enable the TIM break inputs:

     • This functionality is ensured by HAL_SBS_EnableTIMBreakInputs() function.

   • Check the TIM break inputs activation:

     • This functionality is ensured by HAL_SBS_IsEnabledTIMBreakInputs() function.

   • Note: The TIM break inputs disabling can only be done by a hardware reset.

4. Control the compensation cell : The SBS can be configured to manage the compensation cell

   • Set the compensation cell code source :

     • This functionality is ensured by HAL_SBS_SetCompensationCellCodeSrc() function.

   • Get the compensation cell code source :

     • This functionality is ensured by HAL_SBS_GetCompensationCellCodeSrc() function.

   • Enable and disable the compensation cell activation :

     • These functionalities are ensured respectively by HAL_SBS_EnableCompensationCell() and HAL_SBS_DisableCompensationCell().

   • Get the compensation cell state:

     • This functionality is ensured by HAL_SBS_IsEnabledCompensationCell() function.

5. Manage the compensation code : Several APIs are available to manage the compensation code

   • Get the compensation value of PMOS transistor :

     • This functionality is ensured by HAL_SBS_GetPMOSCompensationCellValue() function.

   • Get the compensation value of NMOS transistor :

     • This functionality is ensured by HAL_SBS_GetNMOSCompensationCellValue() function.

   • Set the compensation cell code:

     • This functionality is ensured by HAL_SBS_SetConfigxMOSCompensationCellCode() function.

   • Get the compensation cell code :

     • This functionality is ensured by HAL_SBS_GetConfigxMOSCompensationCellCode() function.

6. HDP levels management functions : Several APIs are available to manage HDPL

   • Set the HDPL value :

     • This functionality is ensured by HAL_SBS_SetHDPLevelValue() function.

   • Get the HDPL value :

     • This functionality is ensured by HAL_SBS_GetHDPLevelValue() function.

7. Debug control functions Several APIs are available to manage the debug control

   • Unlock and lock the APB, AHB access ports :

     • This functionality is ensured by HAL_SBS_UnlockAPBAHBAccessPorts() and HAL_SBS_LockAPBAHBAccessPorts() functions.

   • Check if the APB, AHB access ports are locked :

     • This functionality is ensured by HAL_SBS_IsLockedAPBAHBAccessPorts() function.

   • Unlock and lock the debug interface :

     • This functionality is ensured by HAL_SBS_UnlockCoreDebugInterface() and HAL_SBS_LockCoreDebugInterface() functions.

   • Check if the debug interface is locked :

     • This functionality is ensured by HAL_SBS_IsLockedCoreDebugInterface() function.

   • Set the HDP level at which the authenticated debug opens :

     • This functionality is ensured by HAL_SBS_SetAuthenticatedDebugHDPLevel() function.

   • Get the HDP level at which the authenticated debug opens :

     • This functionality is ensured by HAL_SBS_GetAuthenticatedDebugHDPLevel() function.

   • Lock the debug configuration :

     • This functionality is ensured by HAL_SBS_LockDebugConfig() function.

   • Check if the debug configuration is locked :

     • This functionality is ensured by HAL_SBS_IsLockedDebugConfig() function.

8. Flag management functions : Several APIs are available on the header file as “static_inline” functions to manage the memories erase status

   • Check if the memories erase status flags is active or not :

     • This functionality is ensured by HAL_SBS_GetMemoryEraseStatus() function.

9. RSS Command selection functions : Several APIs are available to manage the RSS command

   • Set a command to the RSS to be executed at next reset :

     • This functionality is ensured by HAL_SBS_SetRSSCommand() function.

   • Get the command sent to the RSS :

     • This functionality is ensured by HAL_SBS_GetRSSCommand() function.

10. Boot address functions :

    • Get the boot address :

      • This functionality is ensured by HAL_SBS_GetBootAddress() function.

11. I/O speed optimization functions : Several APIs are available to manage the I/O speed optimization features

    • Enable and disable the I/O speed optimization:

      • This functionality is ensured respectively by HAL_SBS_EnableIOSpeedOptimization() function and HAL_SBS_DisableIOSpeedOptimization() function.

    • Check the I/O speed optimization status:

      • This functionality is ensured by HAL_SBS_IsEnabledIOSpeedOptimization() function.