- •1 Acronyms and definitions
- •2 Overview of HAL drivers
- •2.1.1 HAL driver files
- •2.2 HAL data structures
- •2.2.1 Peripheral handle structures
- •2.2.2 Initialization and configuration structure
- •2.2.3 Specific process structures
- •2.3 API classification
- •2.4 Devices supported by HAL drivers
- •2.5 HAL drivers rules
- •2.5.1 HAL API naming rules
- •2.5.2 HAL general naming rules
- •2.5.3 HAL interrupt handler and callback functions
- •2.6 HAL generic APIs
- •2.7 HAL extension APIs
- •2.7.1 HAL extension model overview
- •2.7.2 HAL extension model cases
- •2.8 File inclusion model
- •2.9 HAL common resources
- •2.10 HAL configuration
- •2.11 HAL system peripheral handling
- •2.11.1 Clock
- •2.11.2 GPIOs
- •2.11.3 Cortex NVIC and SysTick timer
- •2.11.5 EXTI
- •2.12 How to use HAL drivers
- •2.12.1 HAL usage models
- •2.12.2 HAL initialization
- •2.12.2.1 HAL global initialization
- •2.12.2.2 System clock initialization
- •2.12.2.3 HAL MSP initialization process
- •2.12.3 HAL IO operation process
- •2.12.3.1 Polling mode
- •2.12.3.2 Interrupt mode
- •2.12.3.3 DMA mode
- •2.12.4 Timeout and error management
- •2.12.4.1 Timeout management
- •2.12.4.2 Error management
- •3 HAL System Driver
- •3.1 HAL Firmware driver API description
- •3.1.1 How to use this driver
- •3.1.3 HAL Control functions
- •3.1.4 HAL_Init
- •3.1.5 HAL_DeInit
- •3.1.6 HAL_MspInit
- •3.1.7 HAL_MspDeInit
- •3.1.8 HAL_InitTick
- •3.1.9 HAL_IncTick
- •3.1.10 HAL_GetTick
- •3.1.11 HAL_Delay
- •3.1.12 HAL_SuspendTick
- •3.1.13 HAL_ResumeTick
- •3.1.14 HAL_GetHalVersion
- •3.1.15 HAL_GetREVID
- •3.1.16 HAL_GetDEVID
- •3.1.17 HAL_DBGMCU_EnableDBGSleepMode
- •3.1.18 HAL_DBGMCU_DisableDBGSleepMode
- •3.1.19 HAL_DBGMCU_EnableDBGStopMode
- •3.1.20 HAL_DBGMCU_DisableDBGStopMode
- •3.1.21 HAL_DBGMCU_EnableDBGStandbyMode
- •3.1.22 HAL_DBGMCU_DisableDBGStandbyMode
- •3.1.23 HAL_EnableCompensationCell
- •3.1.24 HAL_DisableCompensationCell
- •3.2 HAL Firmware driver defines
- •4 HAL ADC Generic Driver
- •4.1 ADC Firmware driver registers structures
- •4.1.1 ADC_InitTypeDef
- •4.1.2 ADC_HandleTypeDef
- •4.1.3 ADC_ChannelConfTypeDef
- •4.1.4 ADC_AnalogWDGConfTypeDef
- •4.2 ADC Firmware driver API description
- •4.2.1 ADC Peripheral features
- •4.2.2 How to use this driver
- •4.2.4 IO operation functions
- •4.2.5 Peripheral Control functions
- •4.2.6 Peripheral State and errors functions
- •4.2.7 HAL_ADC_Init
- •4.2.8 HAL_ADC_DeInit
- •4.2.9 HAL_ADC_MspInit
- •4.2.10 HAL_ADC_MspDeInit
- •4.2.11 HAL_ADC_Start
- •4.2.12 HAL_ADC_Stop
- •4.2.13 HAL_ADC_PollForConversion
- •4.2.14 HAL_ADC_PollForEvent
- •4.2.15 HAL_ADC_Start_IT
- •4.2.16 HAL_ADC_Stop_IT
- •4.2.17 HAL_ADC_IRQHandler
- •4.2.18 HAL_ADC_Start_DMA
- •4.2.19 HAL_ADC_Stop_DMA
- •4.2.20 HAL_ADC_GetValue
- •4.2.21 HAL_ADC_ConvCpltCallback
- •4.2.22 HAL_ADC_ConvHalfCpltCallback
- •4.2.23 HAL_ADC_LevelOutOfWindowCallback
- •4.2.24 HAL_ADC_ErrorCallback
- •4.2.25 HAL_ADC_ConfigChannel
- •4.2.26 HAL_ADC_AnalogWDGConfig
- •4.2.27 HAL_ADC_GetState
- •4.2.28 HAL_ADC_GetError
- •4.3 ADC Firmware driver defines
- •5 HAL ADC Extension Driver
- •5.1 ADCEx Firmware driver registers structures
- •5.1.1 ADC_InjectionConfTypeDef
- •5.1.2 ADC_MultiModeTypeDef
- •5.2 ADCEx Firmware driver API description
- •5.2.1 How to use this driver
- •5.2.2 Extended features functions
- •5.2.3 HAL_ADCEx_InjectedStart
- •5.2.4 HAL_ADCEx_InjectedStart_IT
- •5.2.5 HAL_ADCEx_InjectedStop
- •5.2.6 HAL_ADCEx_InjectedPollForConversion
- •5.2.7 HAL_ADCEx_InjectedStop_IT
- •5.2.8 HAL_ADCEx_InjectedGetValue
- •5.2.9 HAL_ADCEx_MultiModeStart_DMA
- •5.2.10 HAL_ADCEx_MultiModeStop_DMA
- •5.2.11 HAL_ADCEx_MultiModeGetValue
- •5.2.12 HAL_ADCEx_InjectedConvCpltCallback
- •5.2.13 HAL_ADCEx_InjectedConfigChannel
- •5.2.14 HAL_ADCEx_MultiModeConfigChannel
- •5.3 ADCEx Firmware driver defines
- •5.3.1 ADCEx
- •6 HAL CAN Generic Driver
- •6.1 CAN Firmware driver registers structures
- •6.1.1 CAN_InitTypeDef
- •6.1.2 CAN_FilterConfTypeDef
- •6.1.3 CanTxMsgTypeDef
- •6.1.4 CanRxMsgTypeDef
- •6.1.5 CAN_HandleTypeDef
- •6.2 CAN Firmware driver API description
- •6.2.1 How to use this driver
- •6.2.3 IO operation functions
- •6.2.4 Peripheral State and Error functions
- •6.2.5 HAL_CAN_Init
- •6.2.6 HAL_CAN_ConfigFilter
- •6.2.7 HAL_CAN_DeInit
- •6.2.8 HAL_CAN_MspInit
- •6.2.9 HAL_CAN_MspDeInit
- •6.2.10 HAL_CAN_Transmit
- •6.2.11 HAL_CAN_Transmit_IT
- •6.2.12 HAL_CAN_Receive
- •6.2.13 HAL_CAN_Receive_IT
- •6.2.14 HAL_CAN_Sleep
- •6.2.15 HAL_CAN_WakeUp
- •6.2.16 HAL_CAN_IRQHandler
- •6.2.17 HAL_CAN_TxCpltCallback
- •6.2.18 HAL_CAN_RxCpltCallback
- •6.2.19 HAL_CAN_ErrorCallback
- •6.2.20 HAL_CAN_GetState
- •6.2.21 HAL_CAN_GetError
- •6.3 CAN Firmware driver defines
- •7 HAL CEC Generic Driver
- •7.1 CEC Firmware driver registers structures
- •7.1.1 CEC_InitTypeDef
- •7.1.2 CEC_HandleTypeDef
- •7.2 CEC Firmware driver API description
- •7.2.1 Initialization and Configuration functions
- •7.2.2 IO operation functions
- •7.2.3 Peripheral Control function
- •7.2.4 HAL_CEC_Init
- •7.2.5 HAL_CEC_DeInit
- •7.2.6 HAL_CEC_MspInit
- •7.2.7 HAL_CEC_MspDeInit
- •7.2.8 HAL_CEC_Transmit
- •7.2.9 HAL_CEC_Receive
- •7.2.10 HAL_CEC_Transmit_IT
- •7.2.11 HAL_CEC_Receive_IT
- •7.2.12 HAL_CEC_GetReceivedFrameSize
- •7.2.13 HAL_CEC_IRQHandler
- •7.2.14 HAL_CEC_TxCpltCallback
- •7.2.15 HAL_CEC_RxCpltCallback
- •7.2.16 HAL_CEC_ErrorCallback
- •7.2.17 HAL_CEC_GetState
- •7.2.18 HAL_CEC_GetError
- •7.3 CEC Firmware driver defines
- •8 HAL CORTEX Generic Driver
- •8.1 CORTEX Firmware driver API description
- •8.1.1 How to use this driver
- •8.1.3 Peripheral Control functions
- •8.1.4 HAL_NVIC_SetPriorityGrouping
- •8.1.5 HAL_NVIC_SetPriority
- •8.1.6 HAL_NVIC_EnableIRQ
- •8.1.7 HAL_NVIC_DisableIRQ
- •8.1.8 HAL_NVIC_SystemReset
- •8.1.9 HAL_SYSTICK_Config
- •8.1.10 HAL_NVIC_GetPriorityGrouping
- •8.1.11 HAL_NVIC_GetPriority
- •8.1.12 HAL_NVIC_SetPendingIRQ
- •8.1.13 HAL_NVIC_GetPendingIRQ
- •8.1.14 HAL_NVIC_ClearPendingIRQ
- •8.1.15 HAL_NVIC_GetActive
- •8.1.16 HAL_SYSTICK_CLKSourceConfig
- •8.1.17 HAL_SYSTICK_IRQHandler
- •8.1.18 HAL_SYSTICK_Callback
- •8.2 CORTEX Firmware driver defines
- •8.2.1 CORTEX
- •9 HAL CRC Generic Driver
- •9.1 CRC Firmware driver registers structures
- •9.1.1 CRC_HandleTypeDef
- •9.2 CRC Firmware driver API description
- •9.2.1 How to use this driver
- •9.2.3 Peripheral Control functions
- •9.2.4 Peripheral State functions
- •9.2.5 HAL_CRC_Init
- •9.2.6 HAL_CRC_DeInit
- •9.2.7 HAL_CRC_MspInit
- •9.2.8 HAL_CRC_MspDeInit
- •9.2.9 HAL_CRC_Accumulate
- •9.2.10 HAL_CRC_Calculate
- •9.2.11 HAL_CRC_GetState
- •9.3 CRC Firmware driver defines
- •10 HAL CRYP Generic Driver
- •10.1 CRYP Firmware driver registers structures
- •10.1.1 CRYP_InitTypeDef
- •10.1.2 CRYP_HandleTypeDef
- •10.2 CRYP Firmware driver API description
- •10.2.1 How to use this driver
- •10.2.3 AES processing functions
- •10.2.4 DES processing functions
- •10.2.5 TDES processing functions
- •10.2.6 DMA callback functions
- •10.2.7 CRYP IRQ handler management
- •10.2.8 Peripheral State functions
- •10.2.9 HAL_CRYP_Init
- •10.2.10 HAL_CRYP_DeInit
- •10.2.11 HAL_CRYP_MspInit
- •10.2.12 HAL_CRYP_MspDeInit
- •10.2.13 HAL_CRYP_AESECB_Encrypt
- •10.2.14 HAL_CRYP_AESCBC_Encrypt
- •10.2.15 HAL_CRYP_AESCTR_Encrypt
- •10.2.16 HAL_CRYP_AESECB_Decrypt
- •10.2.17 HAL_CRYP_AESCBC_Decrypt
- •10.2.18 HAL_CRYP_AESCTR_Decrypt
- •10.2.19 HAL_CRYP_AESECB_Encrypt_IT
- •10.2.20 HAL_CRYP_AESCBC_Encrypt_IT
- •10.2.21 HAL_CRYP_AESCTR_Encrypt_IT
- •10.2.22 HAL_CRYP_AESECB_Decrypt_IT
- •10.2.23 HAL_CRYP_AESCBC_Decrypt_IT
- •10.2.24 HAL_CRYP_AESCTR_Decrypt_IT
- •10.2.25 HAL_CRYP_AESECB_Encrypt_DMA
- •10.2.26 HAL_CRYP_AESCBC_Encrypt_DMA
- •10.2.27 HAL_CRYP_AESCTR_Encrypt_DMA
- •10.2.28 HAL_CRYP_AESECB_Decrypt_DMA
- •10.2.29 HAL_CRYP_AESCBC_Decrypt_DMA
- •10.2.30 HAL_CRYP_AESCTR_Decrypt_DMA
- •10.2.31 HAL_CRYP_DESECB_Encrypt
- •10.2.32 HAL_CRYP_DESECB_Decrypt
- •10.2.33 HAL_CRYP_DESCBC_Encrypt
- •10.2.34 HAL_CRYP_DESCBC_Decrypt
- •10.2.35 HAL_CRYP_DESECB_Encrypt_IT
- •10.2.36 HAL_CRYP_DESCBC_Encrypt_IT
- •10.2.37 HAL_CRYP_DESECB_Decrypt_IT
- •10.2.38 HAL_CRYP_DESCBC_Decrypt_IT
- •10.2.39 HAL_CRYP_DESECB_Encrypt_DMA
- •10.2.40 HAL_CRYP_DESCBC_Encrypt_DMA
- •10.2.41 HAL_CRYP_DESECB_Decrypt_DMA
- •10.2.42 HAL_CRYP_DESCBC_Decrypt_DMA
- •10.2.43 HAL_CRYP_TDESECB_Encrypt
- •10.2.44 HAL_CRYP_TDESECB_Decrypt
- •10.2.45 HAL_CRYP_TDESCBC_Encrypt
- •10.2.46 HAL_CRYP_TDESCBC_Decrypt
- •10.2.47 HAL_CRYP_TDESECB_Encrypt_IT
- •10.2.48 HAL_CRYP_TDESCBC_Encrypt_IT
- •10.2.49 HAL_CRYP_TDESECB_Decrypt_IT
- •10.2.50 HAL_CRYP_TDESCBC_Decrypt_IT
- •10.2.51 HAL_CRYP_TDESECB_Encrypt_DMA
- •10.2.52 HAL_CRYP_TDESCBC_Encrypt_DMA
- •10.2.53 HAL_CRYP_TDESECB_Decrypt_DMA
- •10.2.54 HAL_CRYP_TDESCBC_Decrypt_DMA
- •10.2.55 HAL_CRYP_InCpltCallback
- •10.2.56 HAL_CRYP_OutCpltCallback
- •10.2.57 HAL_CRYP_ErrorCallback
- •10.2.58 HAL_CRYP_IRQHandler
- •10.2.59 HAL_CRYP_GetState
- •10.3 CRYP Firmware driver defines
- •10.3.1 CRYP
- •11 HAL CRYP Extension Driver
- •11.1 CRYPEx Firmware driver API description
- •11.1.1 How to use this driver
- •11.1.2 Extended AES processing functions
- •11.1.3 CRYPEx IRQ handler management
- •11.1.4 HAL_CRYPEx_AESCCM_Encrypt
- •11.1.5 HAL_CRYPEx_AESGCM_Encrypt
- •11.1.6 HAL_CRYPEx_AESGCM_Decrypt
- •11.1.7 HAL_CRYPEx_AESGCM_Finish
- •11.1.8 HAL_CRYPEx_AESCCM_Finish
- •11.1.9 HAL_CRYPEx_AESCCM_Decrypt
- •11.1.10 HAL_CRYPEx_AESGCM_Encrypt_IT
- •11.1.11 HAL_CRYPEx_AESCCM_Encrypt_IT
- •11.1.12 HAL_CRYPEx_AESGCM_Decrypt_IT
- •11.1.13 HAL_CRYPEx_AESCCM_Decrypt_IT
- •11.1.14 HAL_CRYPEx_AESGCM_Encrypt_DMA
- •11.1.15 HAL_CRYPEx_AESCCM_Encrypt_DMA
- •11.1.16 HAL_CRYPEx_AESGCM_Decrypt_DMA
- •11.1.17 HAL_CRYPEx_AESCCM_Decrypt_DMA
- •11.1.18 HAL_CRYPEx_GCMCCM_IRQHandler
- •11.2 CRYPEx Firmware driver defines
- •11.2.1 CRYPEx
- •12 HAL DAC Generic Driver
- •12.1 DAC Firmware driver registers structures
- •12.1.1 DAC_HandleTypeDef
- •12.1.2 DAC_ChannelConfTypeDef
- •12.2 DAC Firmware driver API description
- •12.2.1 DAC Peripheral features
- •12.2.2 How to use this driver
- •12.2.4 IO operation functions
- •12.2.5 Peripheral Control functions
- •12.2.6 Peripheral State and Errors functions
- •12.2.7 HAL_DAC_Init
- •12.2.8 HAL_DAC_DeInit
- •12.2.9 HAL_DAC_MspInit
- •12.2.10 HAL_DAC_MspDeInit
- •12.2.11 HAL_DAC_Start
- •12.2.12 HAL_DAC_Stop
- •12.2.13 HAL_DAC_Start_DMA
- •12.2.14 HAL_DAC_Stop_DMA
- •12.2.15 HAL_DAC_GetValue
- •12.2.16 HAL_DAC_IRQHandler
- •12.2.17 HAL_DAC_ConvCpltCallbackCh1
- •12.2.18 HAL_DAC_ConvHalfCpltCallbackCh1
- •12.2.19 HAL_DAC_ErrorCallbackCh1
- •12.2.20 HAL_DAC_DMAUnderrunCallbackCh1
- •12.2.21 HAL_DAC_ConfigChannel
- •12.2.22 HAL_DAC_SetValue
- •12.2.23 HAL_DAC_GetState
- •12.2.24 HAL_DAC_GetError
- •12.2.25 HAL_DAC_IRQHandler
- •12.2.26 HAL_DAC_ConvCpltCallbackCh1
- •12.2.27 HAL_DAC_ConvHalfCpltCallbackCh1
- •12.2.28 HAL_DAC_ErrorCallbackCh1
- •12.2.29 HAL_DAC_DMAUnderrunCallbackCh1
- •12.3 DAC Firmware driver defines
- •13 HAL DAC Extension Driver
- •13.1 DACEx Firmware driver API description
- •13.1.1 How to use this driver
- •13.1.2 Extended features functions
- •13.1.3 HAL_DACEx_DualGetValue
- •13.1.4 HAL_DACEx_TriangleWaveGenerate
- •13.1.5 HAL_DACEx_NoiseWaveGenerate
- •13.1.6 HAL_DACEx_DualSetValue
- •13.1.7 HAL_DACEx_ConvCpltCallbackCh2
- •13.1.8 HAL_DACEx_ConvHalfCpltCallbackCh2
- •13.1.9 HAL_DACEx_ErrorCallbackCh2
- •13.1.10 HAL_DACEx_DMAUnderrunCallbackCh2
- •13.2 DACEx Firmware driver defines
- •13.2.1 DACEx
- •14 HAL DCMI Generic Driver
- •14.1 DCMI Firmware driver registers structures
- •14.1.1 DCMI_HandleTypeDef
- •14.2 DCMI Firmware driver API description
- •14.2.1 How to use this driver
- •14.2.2 Initialization and Configuration functions
- •14.2.3 IO operation functions
- •14.2.4 Peripheral Control functions
- •14.2.5 Peripheral State and Errors functions
- •14.2.6 HAL_DCMI_Init
- •14.2.7 HAL_DCMI_DeInit
- •14.2.8 HAL_DCMI_MspInit
- •14.2.9 HAL_DCMI_MspDeInit
- •14.2.10 HAL_DCMI_Start_DMA
- •14.2.11 HAL_DCMI_Stop
- •14.2.12 HAL_DCMI_IRQHandler
- •14.2.13 HAL_DCMI_ErrorCallback
- •14.2.14 HAL_DCMI_LineEventCallback
- •14.2.15 HAL_DCMI_VsyncEventCallback
- •14.2.16 HAL_DCMI_FrameEventCallback
- •14.2.17 HAL_DCMI_ConfigCROP
- •14.2.18 HAL_DCMI_DisableCROP
- •14.2.19 HAL_DCMI_EnableCROP
- •14.2.20 HAL_DCMI_GetState
- •14.2.21 HAL_DCMI_GetError
- •14.3 DCMI Firmware driver defines
- •14.3.1 DCMI
- •15 HAL DCMI Extension Driver
- •15.1 DCMIEx Firmware driver registers structures
- •15.1.1 DCMI_CodesInitTypeDef
- •15.1.2 DCMI_InitTypeDef
- •15.2 DCMIEx Firmware driver API description
- •15.2.1 DCMI peripheral extension features
- •15.2.2 How to use this driver
- •15.2.3 Initialization and Configuration functions
- •15.2.4 HAL_DCMI_Init
- •15.3 DCMIEx Firmware driver defines
- •15.3.1 DCMIEx
- •16 HAL DMA Generic Driver
- •16.1 DMA Firmware driver registers structures
- •16.1.1 DMA_InitTypeDef
- •16.1.2 __DMA_HandleTypeDef
- •16.2 DMA Firmware driver API description
- •16.2.1 How to use this driver
- •16.2.3 IO operation functions
- •16.2.4 State and Errors functions
- •16.2.5 HAL_DMA_Init
- •16.2.6 HAL_DMA_DeInit
- •16.2.7 HAL_DMA_Start
- •16.2.8 HAL_DMA_Start_IT
- •16.2.9 HAL_DMA_Abort
- •16.2.10 HAL_DMA_PollForTransfer
- •16.2.11 HAL_DMA_IRQHandler
- •16.2.12 HAL_DMA_GetState
- •16.2.13 HAL_DMA_GetError
- •16.3 DMA Firmware driver defines
- •17 HAL DMA Extension Driver
- •17.1 DMAEx Firmware driver API description
- •17.1.1 How to use this driver
- •17.1.2 Extended features functions
- •17.1.3 HAL_DMAEx_MultiBufferStart
- •17.1.4 HAL_DMAEx_MultiBufferStart_IT
- •17.1.5 HAL_DMAEx_ChangeMemory
- •17.2 DMAEx Firmware driver defines
- •17.2.1 DMAEx
- •18 HAL DMA2D Generic Driver
- •18.1 DMA2D Firmware driver registers structures
- •18.1.1 DMA2D_ColorTypeDef
- •18.1.2 DMA2D_CLUTCfgTypeDef
- •18.1.3 DMA2D_InitTypeDef
- •18.1.4 DMA2D_LayerCfgTypeDef
- •18.1.5 __DMA2D_HandleTypeDef
- •18.2 DMA2D Firmware driver API description
- •18.2.1 How to use this driver
- •18.2.2 Initialization and Configuration functions
- •18.2.3 IO operation functions
- •18.2.4 Peripheral Control functions
- •18.2.5 Peripheral State and Errors functions
- •18.2.6 HAL_DMA2D_Init
- •18.2.7 HAL_DMA2D_DeInit
- •18.2.8 HAL_DMA2D_MspInit
- •18.2.9 HAL_DMA2D_MspDeInit
- •18.2.10 HAL_DMA2D_Start
- •18.2.11 HAL_DMA2D_Start_IT
- •18.2.12 HAL_DMA2D_BlendingStart
- •18.2.13 HAL_DMA2D_BlendingStart_IT
- •18.2.14 HAL_DMA2D_Abort
- •18.2.15 HAL_DMA2D_Suspend
- •18.2.16 HAL_DMA2D_Resume
- •18.2.17 HAL_DMA2D_PollForTransfer
- •18.2.18 HAL_DMA2D_IRQHandler
- •18.2.19 HAL_DMA2D_ConfigLayer
- •18.2.20 HAL_DMA2D_ConfigCLUT
- •18.2.21 HAL_DMA2D_EnableCLUT
- •18.2.22 HAL_DMA2D_DisableCLUT
- •18.2.23 HAL_DMA2D_ProgramLineEvent
- •18.2.24 HAL_DMA2D_GetState
- •18.2.25 HAL_DMA2D_GetError
- •18.3 DMA2D Firmware driver defines
- •19 HAL ETH Generic Driver
- •19.1 ETH Firmware driver registers structures
- •19.1.1 ETH_InitTypeDef
- •19.1.2 ETH_MACInitTypeDef
- •19.1.3 ETH_DMAInitTypeDef
- •19.1.4 ETH_DMADescTypeDef
- •19.1.5 ETH_DMARxFrameInfos
- •19.1.6 ETH_HandleTypeDef
- •19.2 ETH Firmware driver API description
- •19.2.1 How to use this driver
- •19.2.3 IO operation functions
- •19.2.4 Peripheral Control functions
- •19.2.5 Peripheral State functions
- •19.2.6 HAL_ETH_Init
- •19.2.7 HAL_ETH_DeInit
- •19.2.8 HAL_ETH_DMATxDescListInit
- •19.2.9 HAL_ETH_DMARxDescListInit
- •19.2.10 HAL_ETH_MspInit
- •19.2.11 HAL_ETH_MspDeInit
- •19.2.12 HAL_ETH_TransmitFrame
- •19.2.13 HAL_ETH_GetReceivedFrame
- •19.2.14 HAL_ETH_GetReceivedFrame_IT
- •19.2.15 HAL_ETH_IRQHandler
- •19.2.16 HAL_ETH_TxCpltCallback
- •19.2.17 HAL_ETH_RxCpltCallback
- •19.2.18 HAL_ETH_ErrorCallback
- •19.2.19 HAL_ETH_ReadPHYRegister
- •19.2.20 HAL_ETH_WritePHYRegister
- •19.2.21 HAL_ETH_Start
- •19.2.22 HAL_ETH_Stop
- •19.2.23 HAL_ETH_ConfigMAC
- •19.2.24 HAL_ETH_ConfigDMA
- •19.2.25 HAL_ETH_GetState
- •19.3 ETH Firmware driver defines
- •20 HAL FLASH Generic Driver
- •20.1 FLASH Firmware driver registers structures
- •20.1.1 FLASH_ProcessTypeDef
- •20.2 FLASH Firmware driver API description
- •20.2.1 FLASH peripheral features
- •20.2.2 How to use this driver
- •20.2.3 Programming operation functions
- •20.2.4 Peripheral Control functions
- •20.2.5 Peripheral Errors functions
- •20.2.6 HAL_FLASH_Program
- •20.2.7 HAL_FLASH_Program_IT
- •20.2.8 HAL_FLASH_IRQHandler
- •20.2.9 HAL_FLASH_EndOfOperationCallback
- •20.2.10 HAL_FLASH_OperationErrorCallback
- •20.2.11 HAL_FLASH_Unlock
- •20.2.12 HAL_FLASH_Lock
- •20.2.13 HAL_FLASH_OB_Unlock
- •20.2.14 HAL_FLASH_OB_Lock
- •20.2.15 HAL_FLASH_OB_Launch
- •20.2.16 HAL_FLASH_GetError
- •20.2.17 FLASH_WaitForLastOperation
- •20.3 FLASH Firmware driver defines
- •20.3.1 FLASH
- •21 HAL FLASH Extension Driver
- •21.1 FLASHEx Firmware driver registers structures
- •21.1.1 FLASH_EraseInitTypeDef
- •21.1.2 FLASH_OBProgramInitTypeDef
- •21.1.3 FLASH_AdvOBProgramInitTypeDef
- •21.2 FLASHEx Firmware driver API description
- •21.2.1 Flash Extension features
- •21.2.2 How to use this driver
- •21.2.3 Extended programming operation functions
- •21.2.4 HAL_FLASHEx_Erase
- •21.2.5 HAL_FLASHEx_Erase_IT
- •21.2.6 HAL_FLASHEx_OBProgram
- •21.2.7 HAL_FLASHEx_OBGetConfig
- •21.2.8 HAL_FLASHEx_AdvOBProgram
- •21.2.9 HAL_FLASHEx_AdvOBGetConfig
- •21.2.10 HAL_FLASHEx_OB_SelectPCROP
- •21.2.11 HAL_FLASHEx_OB_DeSelectPCROP
- •21.3 FLASHEx Firmware driver defines
- •21.3.1 FLASHEx
- •22 HAL FLASH__RAMFUNC Generic Driver
- •22.1 FLASH__RAMFUNC Firmware driver API description
- •22.1.1 APIs executed from Internal RAM
- •22.1.2 ramfunc functions
- •22.1.3 HAL_FLASHEx_StopFlashInterfaceClk
- •22.1.4 HAL_FLASHEx_StartFlashInterfaceClk
- •22.1.5 HAL_FLASHEx_EnableFlashSleepMode
- •22.1.6 HAL_FLASHEx_DisableFlashSleepMode
- •22.2 FLASH__RAMFUNC Firmware driver defines
- •22.2.1 FLASH__RAMFUNC
- •23 HAL FMPI2C Generic Driver
- •23.1 FMPI2C Firmware driver registers structures
- •23.1.1 FMPI2C_InitTypeDef
- •23.1.2 FMPI2C_HandleTypeDef
- •23.2 FMPI2C Firmware driver API description
- •23.2.2 IO operation functions
- •23.2.3 Peripheral State and Errors functions
- •23.2.4 HAL_FMPI2C_Init
- •23.2.5 HAL_FMPI2C_DeInit
- •23.2.6 HAL_FMPI2C_MspInit
- •23.2.7 HAL_FMPI2C_MspDeInit
- •23.2.8 HAL_FMPI2C_Master_Transmit
- •23.2.9 HAL_FMPI2C_Master_Receive
- •23.2.10 HAL_FMPI2C_Slave_Transmit
- •23.2.11 HAL_FMPI2C_Slave_Receive
- •23.2.12 HAL_FMPI2C_Master_Transmit_IT
- •23.2.13 HAL_FMPI2C_Master_Receive_IT
- •23.2.14 HAL_FMPI2C_Slave_Transmit_IT
- •23.2.15 HAL_FMPI2C_Slave_Receive_IT
- •23.2.16 HAL_FMPI2C_Master_Transmit_DMA
- •23.2.17 HAL_FMPI2C_Master_Receive_DMA
- •23.2.18 HAL_FMPI2C_Slave_Transmit_DMA
- •23.2.19 HAL_FMPI2C_Slave_Receive_DMA
- •23.2.20 HAL_FMPI2C_Mem_Write
- •23.2.21 HAL_FMPI2C_Mem_Read
- •23.2.22 HAL_FMPI2C_Mem_Write_IT
- •23.2.23 HAL_FMPI2C_Mem_Read_IT
- •23.2.24 HAL_FMPI2C_Mem_Write_DMA
- •23.2.25 HAL_FMPI2C_Mem_Read_DMA
- •23.2.26 HAL_FMPI2C_IsDeviceReady
- •23.2.27 HAL_FMPI2C_EV_IRQHandler
- •23.2.28 HAL_FMPI2C_ER_IRQHandler
- •23.2.29 HAL_FMPI2C_MasterTxCpltCallback
- •23.2.30 HAL_FMPI2C_MasterRxCpltCallback
- •23.2.31 HAL_FMPI2C_SlaveTxCpltCallback
- •23.2.32 HAL_FMPI2C_SlaveRxCpltCallback
- •23.2.33 HAL_FMPI2C_MemTxCpltCallback
- •23.2.34 HAL_FMPI2C_MemRxCpltCallback
- •23.2.35 HAL_FMPI2C_ErrorCallback
- •23.2.36 HAL_FMPI2C_GetState
- •23.2.37 HAL_FMPI2C_GetError
- •23.3 FMPI2C Firmware driver defines
- •23.3.1 FMPI2C
- •24 HAL FMPI2C Extension Driver
- •24.1 FMPI2CEx Firmware driver API description
- •24.1.1 Extension features functions
- •24.1.2 HAL_FMPI2CEx_AnalogFilter_Config
- •24.1.3 HAL_FMPI2CEx_DigitalFilter_Config
- •24.1.4 HAL_FMPI2CEx_EnableWakeUp
- •24.1.5 HAL_FMPI2CEx_DisableWakeUp
- •24.1.6 HAL_FMPI2CEx_EnableFastModePlus
- •24.1.7 HAL_FMPI2CEx_DisableFastModePlus
- •24.2 FMPI2CEx Firmware driver defines
- •24.2.1 FMPI2CEx
- •25 HAL GPIO Generic Driver
- •25.1 GPIO Firmware driver registers structures
- •25.1.1 GPIO_InitTypeDef
- •25.2 GPIO Firmware driver API description
- •25.2.1 GPIO Peripheral features
- •25.2.2 How to use this driver
- •25.2.4 IO operation functions
- •25.2.5 HAL_GPIO_Init
- •25.2.6 HAL_GPIO_DeInit
- •25.2.7 HAL_GPIO_ReadPin
- •25.2.8 HAL_GPIO_WritePin
- •25.2.9 HAL_GPIO_TogglePin
- •25.2.10 HAL_GPIO_LockPin
- •25.2.11 HAL_GPIO_EXTI_IRQHandler
- •25.2.12 HAL_GPIO_EXTI_Callback
- •25.3 GPIO Firmware driver defines
- •25.3.1 GPIO
- •26 HAL GPIO Extension Driver
- •26.1 GPIOEx Firmware driver defines
- •26.1.1 GPIOEx
- •27 HAL HASH Generic Driver
- •27.1 HASH Firmware driver registers structures
- •27.1.1 HASH_InitTypeDef
- •27.1.2 HASH_HandleTypeDef
- •27.2 HASH Firmware driver API description
- •27.2.1 How to use this driver
- •27.2.2 HASH processing using polling mode functions
- •27.2.3 HASH processing using interrupt mode functions
- •27.2.4 HASH processing using DMA mode functions
- •27.2.5 HMAC processing using polling mode functions
- •27.2.6 HMAC processing using DMA mode functions
- •27.2.7 Peripheral State functions
- •27.2.9 HAL_HASH_MD5_Start
- •27.2.10 HAL_HASH_MD5_Accumulate
- •27.2.11 HAL_HASH_SHA1_Start
- •27.2.12 HAL_HASH_SHA1_Accumulate
- •27.2.13 HAL_HASH_MD5_Start_IT
- •27.2.14 HAL_HASH_SHA1_Start_IT
- •27.2.15 HAL_HASH_IRQHandler
- •27.2.16 HAL_HMAC_SHA1_Start
- •27.2.17 HAL_HMAC_MD5_Start
- •27.2.18 HAL_HASH_MD5_Start_DMA
- •27.2.19 HAL_HASH_MD5_Finish
- •27.2.20 HAL_HASH_SHA1_Start_DMA
- •27.2.21 HAL_HASH_SHA1_Finish
- •27.2.22 HAL_HASH_SHA1_Start_IT
- •27.2.23 HAL_HASH_MD5_Start_IT
- •27.2.24 HAL_HMAC_MD5_Start
- •27.2.25 HAL_HMAC_SHA1_Start
- •27.2.26 HAL_HASH_SHA1_Start_DMA
- •27.2.27 HAL_HASH_SHA1_Finish
- •27.2.28 HAL_HASH_MD5_Start_DMA
- •27.2.29 HAL_HASH_MD5_Finish
- •27.2.30 HAL_HMAC_MD5_Start_DMA
- •27.2.31 HAL_HMAC_SHA1_Start_DMA
- •27.2.32 HAL_HASH_GetState
- •27.2.33 HAL_HASH_IRQHandler
- •27.2.34 HAL_HASH_Init
- •27.2.35 HAL_HASH_DeInit
- •27.2.36 HAL_HASH_MspInit
- •27.2.37 HAL_HASH_MspDeInit
- •27.2.38 HAL_HASH_InCpltCallback
- •27.2.39 HAL_HASH_ErrorCallback
- •27.2.40 HAL_HASH_DgstCpltCallback
- •27.2.41 HAL_HASH_GetState
- •27.2.42 HAL_HASH_MspInit
- •27.2.43 HAL_HASH_MspDeInit
- •27.2.44 HAL_HASH_InCpltCallback
- •27.2.45 HAL_HASH_DgstCpltCallback
- •27.2.46 HAL_HASH_ErrorCallback
- •27.3 HASH Firmware driver defines
- •27.3.1 HASH
- •28 HAL HASH Extension Driver
- •28.1 HASHEx Firmware driver API description
- •28.1.1 How to use this driver
- •28.1.2 HASH processing using polling mode functions
- •28.1.3 HMAC processing using polling mode functions
- •28.1.4 HASH processing using interrupt functions
- •28.1.5 HASH processing using DMA functions
- •28.1.6 HMAC processing using DMA functions
- •28.1.7 HAL_HASHEx_SHA224_Start
- •28.1.8 HAL_HASHEx_SHA256_Start
- •28.1.9 HAL_HASHEx_SHA224_Accumulate
- •28.1.10 HAL_HASHEx_SHA256_Accumulate
- •28.1.11 HAL_HMACEx_SHA224_Start
- •28.1.12 HAL_HMACEx_SHA256_Start
- •28.1.13 HAL_HASHEx_SHA224_Start_IT
- •28.1.14 HAL_HASHEx_SHA256_Start_IT
- •28.1.15 HAL_HASHEx_IRQHandler
- •28.1.16 HAL_HASHEx_SHA224_Start_DMA
- •28.1.17 HAL_HASHEx_SHA224_Finish
- •28.1.18 HAL_HASHEx_SHA256_Start_DMA
- •28.1.19 HAL_HASHEx_SHA256_Finish
- •28.1.20 HAL_HMACEx_SHA224_Start_DMA
- •28.1.21 HAL_HMACEx_SHA256_Start_DMA
- •28.1.22 HAL_HASHEx_SHA224_Start
- •28.1.23 HAL_HASHEx_SHA256_Start
- •28.1.24 HAL_HASHEx_SHA224_Accumulate
- •28.1.25 HAL_HASHEx_SHA256_Accumulate
- •28.1.26 HAL_HMACEx_SHA224_Start
- •28.1.27 HAL_HMACEx_SHA256_Start
- •28.1.28 HAL_HASHEx_SHA224_Start_IT
- •28.1.29 HAL_HASHEx_SHA256_Start_IT
- •28.1.30 HAL_HASHEx_SHA224_Start_DMA
- •28.1.31 HAL_HASHEx_SHA224_Finish
- •28.1.32 HAL_HASHEx_SHA256_Start_DMA
- •28.1.33 HAL_HASHEx_SHA256_Finish
- •28.1.34 HAL_HMACEx_SHA224_Start_DMA
- •28.1.35 HAL_HMACEx_SHA256_Start_DMA
- •28.1.36 HAL_HASHEx_IRQHandler
- •28.2 HASHEx Firmware driver defines
- •28.2.1 HASHEx
- •29 HAL HCD Generic Driver
- •29.1 HCD Firmware driver registers structures
- •29.1.1 HCD_HandleTypeDef
- •29.2 HCD Firmware driver API description
- •29.2.1 How to use this driver
- •29.2.3 IO operation functions
- •29.2.4 Peripheral Control functions
- •29.2.5 Peripheral State functions
- •29.2.6 HAL_HCD_Init
- •29.2.7 HAL_HCD_HC_Init
- •29.2.8 HAL_HCD_HC_Halt
- •29.2.9 HAL_HCD_DeInit
- •29.2.10 HAL_HCD_MspInit
- •29.2.11 HAL_HCD_MspDeInit
- •29.2.12 HAL_HCD_HC_SubmitRequest
- •29.2.13 HAL_HCD_IRQHandler
- •29.2.14 HAL_HCD_SOF_Callback
- •29.2.15 HAL_HCD_Connect_Callback
- •29.2.16 HAL_HCD_Disconnect_Callback
- •29.2.17 HAL_HCD_HC_NotifyURBChange_Callback
- •29.2.18 HAL_HCD_Start
- •29.2.19 HAL_HCD_Stop
- •29.2.20 HAL_HCD_ResetPort
- •29.2.21 HAL_HCD_GetState
- •29.2.22 HAL_HCD_HC_GetURBState
- •29.2.23 HAL_HCD_HC_GetXferCount
- •29.2.24 HAL_HCD_HC_GetState
- •29.2.25 HAL_HCD_GetCurrentFrame
- •29.2.26 HAL_HCD_GetCurrentSpeed
- •29.3 HCD Firmware driver defines
- •30 HAL I2C Generic Driver
- •30.1 I2C Firmware driver registers structures
- •30.1.1 I2C_InitTypeDef
- •30.1.2 I2C_HandleTypeDef
- •30.2 I2C Firmware driver API description
- •30.2.1 How to use this driver
- •30.2.3 IO operation functions
- •30.2.4 Peripheral State and Errors functions
- •30.2.5 HAL_I2C_Init
- •30.2.6 HAL_I2C_DeInit
- •30.2.7 HAL_I2C_MspInit
- •30.2.8 HAL_I2C_MspDeInit
- •30.2.9 HAL_I2C_Master_Transmit
- •30.2.10 HAL_I2C_Master_Receive
- •30.2.11 HAL_I2C_Slave_Transmit
- •30.2.12 HAL_I2C_Slave_Receive
- •30.2.13 HAL_I2C_Master_Transmit_IT
- •30.2.14 HAL_I2C_Master_Receive_IT
- •30.2.15 HAL_I2C_Slave_Transmit_IT
- •30.2.16 HAL_I2C_Slave_Receive_IT
- •30.2.17 HAL_I2C_Master_Transmit_DMA
- •30.2.18 HAL_I2C_Master_Receive_DMA
- •30.2.19 HAL_I2C_Slave_Transmit_DMA
- •30.2.20 HAL_I2C_Slave_Receive_DMA
- •30.2.21 HAL_I2C_Mem_Write
- •30.2.22 HAL_I2C_Mem_Read
- •30.2.23 HAL_I2C_Mem_Write_IT
- •30.2.24 HAL_I2C_Mem_Read_IT
- •30.2.25 HAL_I2C_Mem_Write_DMA
- •30.2.26 HAL_I2C_Mem_Read_DMA
- •30.2.27 HAL_I2C_IsDeviceReady
- •30.2.28 HAL_I2C_EV_IRQHandler
- •30.2.29 HAL_I2C_ER_IRQHandler
- •30.2.30 HAL_I2C_MasterTxCpltCallback
- •30.2.31 HAL_I2C_MasterRxCpltCallback
- •30.2.32 HAL_I2C_SlaveTxCpltCallback
- •30.2.33 HAL_I2C_SlaveRxCpltCallback
- •30.2.34 HAL_I2C_MemTxCpltCallback
- •30.2.35 HAL_I2C_MemRxCpltCallback
- •30.2.36 HAL_I2C_ErrorCallback
- •30.2.37 HAL_I2C_GetState
- •30.2.38 HAL_I2C_GetError
- •30.3 I2C Firmware driver defines
- •31 HAL I2C Extension Driver
- •31.1 I2CEx Firmware driver API description
- •31.1.1 I2C peripheral extension features
- •31.1.2 How to use this driver
- •31.1.3 Extension features functions
- •31.1.4 HAL_I2CEx_ConfigAnalogFilter
- •31.1.5 HAL_I2CEx_ConfigDigitalFilter
- •31.2 I2CEx Firmware driver defines
- •32 HAL I2S Generic Driver
- •32.1 I2S Firmware driver registers structures
- •32.1.1 I2S_InitTypeDef
- •32.1.2 I2S_HandleTypeDef
- •32.2 I2S Firmware driver API description
- •32.2.1 How to use this driver
- •32.2.3 IO operation functions
- •32.2.4 Peripheral State and Errors functions
- •32.2.5 HAL_I2S_Init
- •32.2.6 HAL_I2S_DeInit
- •32.2.7 HAL_I2S_MspInit
- •32.2.8 HAL_I2S_MspDeInit
- •32.2.9 HAL_I2S_Transmit
- •32.2.10 HAL_I2S_Receive
- •32.2.11 HAL_I2S_Transmit_IT
- •32.2.12 HAL_I2S_Receive_IT
- •32.2.13 HAL_I2S_Transmit_DMA
- •32.2.14 HAL_I2S_Receive_DMA
- •32.2.15 HAL_I2S_DMAPause
- •32.2.16 HAL_I2S_DMAResume
- •32.2.17 HAL_I2S_DMAStop
- •32.2.18 HAL_I2S_IRQHandler
- •32.2.19 HAL_I2S_TxHalfCpltCallback
- •32.2.20 HAL_I2S_TxCpltCallback
- •32.2.21 HAL_I2S_RxHalfCpltCallback
- •32.2.22 HAL_I2S_RxCpltCallback
- •32.2.23 HAL_I2S_ErrorCallback
- •32.2.24 HAL_I2S_GetState
- •32.2.25 HAL_I2S_GetError
- •32.2.26 HAL_I2S_GetState
- •32.2.27 HAL_I2S_GetError
- •32.3 I2S Firmware driver defines
- •33 HAL I2S Extension Driver
- •33.1 I2SEx Firmware driver API description
- •33.1.1 I2S Extension features
- •33.1.2 How to use this driver
- •33.1.3 HAL_I2SEx_TransmitReceive
- •33.1.4 HAL_I2SEx_TransmitReceive_IT
- •33.1.5 HAL_I2SEx_TransmitReceive_DMA
- •33.2 I2SEx Firmware driver defines
- •34 HAL IRDA Generic Driver
- •34.1 IRDA Firmware driver registers structures
- •34.1.1 IRDA_InitTypeDef
- •34.1.2 IRDA_HandleTypeDef
- •34.2 IRDA Firmware driver API description
- •34.2.1 How to use this driver
- •34.2.2 Initialization and Configuration functions
- •34.2.3 IO operation functions
- •34.2.4 Peripheral State and Errors functions
- •34.2.5 HAL_IRDA_Init
- •34.2.6 HAL_IRDA_DeInit
- •34.2.7 HAL_IRDA_MspInit
- •34.2.8 HAL_IRDA_MspDeInit
- •34.2.9 HAL_IRDA_Transmit
- •34.2.10 HAL_IRDA_Receive
- •34.2.11 HAL_IRDA_Transmit_IT
- •34.2.12 HAL_IRDA_Receive_IT
- •34.2.13 HAL_IRDA_Transmit_DMA
- •34.2.14 HAL_IRDA_Receive_DMA
- •34.2.15 HAL_IRDA_DMAPause
- •34.2.16 HAL_IRDA_DMAResume
- •34.2.17 HAL_IRDA_DMAStop
- •34.2.18 HAL_IRDA_IRQHandler
- •34.2.19 HAL_IRDA_TxCpltCallback
- •34.2.20 HAL_IRDA_TxHalfCpltCallback
- •34.2.21 HAL_IRDA_RxCpltCallback
- •34.2.22 HAL_IRDA_RxHalfCpltCallback
- •34.2.23 HAL_IRDA_ErrorCallback
- •34.2.24 HAL_IRDA_GetState
- •34.2.25 HAL_IRDA_GetError
- •34.3 IRDA Firmware driver defines
- •34.3.1 IRDA
- •35 HAL IWDG Generic Driver
- •35.1 IWDG Firmware driver registers structures
- •35.1.1 IWDG_InitTypeDef
- •35.1.2 IWDG_HandleTypeDef
- •35.2 IWDG Firmware driver API description
- •35.2.1 IWDG Specific features
- •35.2.2 How to use this driver
- •35.2.4 IO operation functions
- •35.2.5 Peripheral State functions
- •35.2.6 HAL_IWDG_Init
- •35.2.7 HAL_IWDG_MspInit
- •35.2.8 HAL_IWDG_Start
- •35.2.9 HAL_IWDG_Refresh
- •35.2.10 HAL_IWDG_GetState
- •35.3 IWDG Firmware driver defines
- •35.3.1 IWDG
- •36 HAL LTDC Generic Driver
- •36.1 LTDC Firmware driver registers structures
- •36.1.1 LTDC_ColorTypeDef
- •36.1.2 LTDC_InitTypeDef
- •36.1.3 LTDC_LayerCfgTypeDef
- •36.1.4 LTDC_HandleTypeDef
- •36.2 LTDC Firmware driver API description
- •36.2.1 How to use this driver
- •36.2.2 Initialization and Configuration functions
- •36.2.3 IO operation functions
- •36.2.4 Peripheral Control functions
- •36.2.5 Peripheral State and Errors functions
- •36.2.6 HAL_LTDC_Init
- •36.2.7 HAL_LTDC_DeInit
- •36.2.8 HAL_LTDC_MspInit
- •36.2.9 HAL_LTDC_MspDeInit
- •36.2.10 HAL_LTDC_ErrorCallback
- •36.2.11 HAL_LTDC_LineEvenCallback
- •36.2.12 HAL_LTDC_IRQHandler
- •36.2.13 HAL_LTDC_ErrorCallback
- •36.2.14 HAL_LTDC_LineEvenCallback
- •36.2.15 HAL_LTDC_ConfigLayer
- •36.2.16 HAL_LTDC_ConfigColorKeying
- •36.2.17 HAL_LTDC_ConfigCLUT
- •36.2.18 HAL_LTDC_EnableColorKeying
- •36.2.19 HAL_LTDC_DisableColorKeying
- •36.2.20 HAL_LTDC_EnableCLUT
- •36.2.21 HAL_LTDC_DisableCLUT
- •36.2.22 HAL_LTDC_EnableDither
- •36.2.23 HAL_LTDC_DisableDither
- •36.2.24 HAL_LTDC_SetWindowSize
- •36.2.25 HAL_LTDC_SetWindowPosition
- •36.2.26 HAL_LTDC_SetPixelFormat
- •36.2.27 HAL_LTDC_SetAlpha
- •36.2.28 HAL_LTDC_SetAddress
- •36.2.29 HAL_LTDC_ProgramLineEvent
- •36.2.30 HAL_LTDC_GetState
- •36.2.31 HAL_LTDC_GetError
- •36.3 LTDC Firmware driver defines
- •36.3.1 LTDC
- •37 HAL NAND Generic Driver
- •37.1 NAND Firmware driver registers structures
- •37.1.1 NAND_IDTypeDef
- •37.1.2 NAND_AddressTypeDef
- •37.1.3 NAND_InfoTypeDef
- •37.1.4 NAND_HandleTypeDef
- •37.2 NAND Firmware driver API description
- •37.2.1 How to use this driver
- •37.2.3 NAND Input and Output functions
- •37.2.4 NAND Control functions
- •37.2.5 NAND State functions
- •37.2.6 HAL_NAND_Init
- •37.2.7 HAL_NAND_DeInit
- •37.2.8 HAL_NAND_MspInit
- •37.2.9 HAL_NAND_MspDeInit
- •37.2.10 HAL_NAND_IRQHandler
- •37.2.11 HAL_NAND_ITCallback
- •37.2.12 HAL_NAND_Read_ID
- •37.2.13 HAL_NAND_Reset
- •37.2.14 HAL_NAND_Read_Page
- •37.2.15 HAL_NAND_Write_Page
- •37.2.16 HAL_NAND_Read_SpareArea
- •37.2.17 HAL_NAND_Write_SpareArea
- •37.2.18 HAL_NAND_Erase_Block
- •37.2.19 HAL_NAND_Read_Status
- •37.2.20 HAL_NAND_Address_Inc
- •37.2.21 HAL_NAND_ECC_Enable
- •37.2.22 HAL_NAND_ECC_Disable
- •37.2.23 HAL_NAND_GetECC
- •37.2.24 HAL_NAND_GetState
- •37.2.25 HAL_NAND_Read_Status
- •37.3 NAND Firmware driver defines
- •37.3.1 NAND
- •38 HAL NOR Generic Driver
- •38.1 NOR Firmware driver registers structures
- •38.1.1 NOR_IDTypeDef
- •38.1.2 NOR_CFITypeDef
- •38.1.3 NOR_HandleTypeDef
- •38.2 NOR Firmware driver API description
- •38.2.1 How to use this driver
- •38.2.2 NOR Initialization and de_initialization functions
- •38.2.3 NOR Input and Output functions
- •38.2.4 NOR Control functions
- •38.2.5 NOR State functions
- •38.2.6 HAL_NOR_Init
- •38.2.7 HAL_NOR_DeInit
- •38.2.8 HAL_NOR_MspInit
- •38.2.9 HAL_NOR_MspDeInit
- •38.2.10 HAL_NOR_MspWait
- •38.2.11 HAL_NOR_Read_ID
- •38.2.12 HAL_NOR_ReturnToReadMode
- •38.2.13 HAL_NOR_Read
- •38.2.14 HAL_NOR_Program
- •38.2.15 HAL_NOR_ReadBuffer
- •38.2.16 HAL_NOR_ProgramBuffer
- •38.2.17 HAL_NOR_Erase_Block
- •38.2.18 HAL_NOR_Erase_Chip
- •38.2.19 HAL_NOR_Read_CFI
- •38.2.20 HAL_NOR_WriteOperation_Enable
- •38.2.21 HAL_NOR_WriteOperation_Disable
- •38.2.22 HAL_NOR_GetState
- •38.2.23 HAL_NOR_GetStatus
- •38.3 NOR Firmware driver defines
- •39 HAL PCCARD Generic Driver
- •39.1 PCCARD Firmware driver registers structures
- •39.1.1 PCCARD_HandleTypeDef
- •39.2 PCCARD Firmware driver API description
- •39.2.1 How to use this driver
- •39.2.3 PCCARD Input and Output functions
- •39.2.4 PCCARD State functions
- •39.2.5 HAL_PCCARD_Init
- •39.2.6 HAL_PCCARD_DeInit
- •39.2.7 HAL_PCCARD_MspInit
- •39.2.8 HAL_PCCARD_MspDeInit
- •39.2.9 HAL_PCCARD_Read_ID
- •39.2.10 HAL_PCCARD_Read_Sector
- •39.2.11 HAL_PCCARD_Write_Sector
- •39.2.12 HAL_PCCARD_Erase_Sector
- •39.2.13 HAL_PCCARD_Reset
- •39.2.14 HAL_PCCARD_IRQHandler
- •39.2.15 HAL_PCCARD_ITCallback
- •39.2.16 HAL_PCCARD_GetState
- •39.2.17 HAL_PCCARD_GetStatus
- •39.2.18 HAL_PCCARD_ReadStatus
- •39.3 PCCARD Firmware driver defines
- •39.3.1 PCCARD
- •40 HAL PCD Generic Driver
- •40.1 PCD Firmware driver registers structures
- •40.1.1 PCD_HandleTypeDef
- •40.2 PCD Firmware driver API description
- •40.2.1 How to use this driver
- •40.2.3 IO operation functions
- •40.2.4 Peripheral Control functions
- •40.2.5 Peripheral State functions
- •40.2.6 HAL_PCD_Init
- •40.2.7 HAL_PCD_DeInit
- •40.2.8 HAL_PCD_MspInit
- •40.2.9 HAL_PCD_MspDeInit
- •40.2.10 HAL_PCD_Start
- •40.2.11 HAL_PCD_Stop
- •40.2.12 HAL_PCD_IRQHandler
- •40.2.13 HAL_PCD_DataOutStageCallback
- •40.2.14 HAL_PCD_DataInStageCallback
- •40.2.15 HAL_PCD_SetupStageCallback
- •40.2.16 HAL_PCD_SOFCallback
- •40.2.17 HAL_PCD_ResetCallback
- •40.2.18 HAL_PCD_SuspendCallback
- •40.2.19 HAL_PCD_ResumeCallback
- •40.2.20 HAL_PCD_ISOOUTIncompleteCallback
- •40.2.21 HAL_PCD_ISOINIncompleteCallback
- •40.2.22 HAL_PCD_ConnectCallback
- •40.2.23 HAL_PCD_DisconnectCallback
- •40.2.24 HAL_PCD_DevConnect
- •40.2.25 HAL_PCD_DevDisconnect
- •40.2.26 HAL_PCD_SetAddress
- •40.2.27 HAL_PCD_EP_Open
- •40.2.28 HAL_PCD_EP_Close
- •40.2.29 HAL_PCD_EP_Receive
- •40.2.30 HAL_PCD_EP_GetRxCount
- •40.2.31 HAL_PCD_EP_Transmit
- •40.2.32 HAL_PCD_EP_SetStall
- •40.2.33 HAL_PCD_EP_ClrStall
- •40.2.34 HAL_PCD_EP_Flush
- •40.2.35 HAL_PCD_ActivateRemoteWakeup
- •40.2.36 HAL_PCD_DeActivateRemoteWakeup
- •40.2.37 HAL_PCD_GetState
- •40.3 PCD Firmware driver defines
- •41 HAL PCD Extension Driver
- •41.1 PCDEx Firmware driver API description
- •41.1.1 Extended features functions
- •41.1.2 HAL_PCDEx_SetTxFiFo
- •41.1.3 HAL_PCDEx_SetRxFiFo
- •41.1.4 HAL_PCDEx_ActivateLPM
- •41.1.5 HAL_PCDEx_DeActivateLPM
- •41.1.6 HAL_PCDEx_LPM_Callback
- •41.2 PCDEx Firmware driver defines
- •41.2.1 PCDEx
- •42 HAL PWR Generic Driver
- •42.1 PWR Firmware driver registers structures
- •42.1.1 PWR_PVDTypeDef
- •42.2 PWR Firmware driver API description
- •42.2.2 Peripheral Control functions
- •42.2.3 HAL_PWR_DeInit
- •42.2.4 HAL_PWR_EnableBkUpAccess
- •42.2.5 HAL_PWR_DisableBkUpAccess
- •42.2.6 HAL_PWR_ConfigPVD
- •42.2.7 HAL_PWR_EnablePVD
- •42.2.8 HAL_PWR_DisablePVD
- •42.2.9 HAL_PWR_EnableWakeUpPin
- •42.2.10 HAL_PWR_DisableWakeUpPin
- •42.2.11 HAL_PWR_EnterSLEEPMode
- •42.2.12 HAL_PWR_EnterSTOPMode
- •42.2.13 HAL_PWR_EnterSTANDBYMode
- •42.2.14 HAL_PWR_PVD_IRQHandler
- •42.2.15 HAL_PWR_PVDCallback
- •42.2.16 HAL_PWR_EnableSleepOnExit
- •42.2.17 HAL_PWR_DisableSleepOnExit
- •42.2.18 HAL_PWR_EnableSEVOnPend
- •42.2.19 HAL_PWR_DisableSEVOnPend
- •42.3 PWR Firmware driver defines
- •43 HAL PWR Extension Driver
- •43.1 PWREx Firmware driver API description
- •43.1.1 Peripheral extended features functions
- •43.1.2 HAL_PWREx_EnableBkUpReg
- •43.1.3 HAL_PWREx_DisableBkUpReg
- •43.1.4 HAL_PWREx_EnableFlashPowerDown
- •43.1.5 HAL_PWREx_DisableFlashPowerDown
- •43.1.6 HAL_PWREx_GetVoltageRange
- •43.1.7 HAL_PWREx_ControlVoltageScaling
- •43.1.8 HAL_PWREx_EnableOverDrive
- •43.1.9 HAL_PWREx_DisableOverDrive
- •43.1.10 HAL_PWREx_EnterUnderDriveSTOPMode
- •43.2 PWREx Firmware driver defines
- •43.2.1 PWREx
- •44 HAL QSPI Generic Driver
- •44.1 QSPI Firmware driver registers structures
- •44.1.1 QSPI_InitTypeDef
- •44.1.2 QSPI_HandleTypeDef
- •44.1.3 QSPI_CommandTypeDef
- •44.1.4 QSPI_AutoPollingTypeDef
- •44.1.5 QSPI_MemoryMappedTypeDef
- •44.2 QSPI Firmware driver API description
- •44.2.1 Initialization and Configuration functions
- •44.2.2 IO operation functions
- •44.2.3 Peripheral Control and State functions
- •44.2.4 HAL_QSPI_Init
- •44.2.5 HAL_QSPI_DeInit
- •44.2.6 HAL_QSPI_MspInit
- •44.2.7 HAL_QSPI_MspDeInit
- •44.2.8 HAL_QSPI_IRQHandler
- •44.2.9 HAL_QSPI_Command
- •44.2.10 HAL_QSPI_Command_IT
- •44.2.11 HAL_QSPI_Transmit
- •44.2.12 HAL_QSPI_Receive
- •44.2.13 HAL_QSPI_Transmit_IT
- •44.2.14 HAL_QSPI_Receive_IT
- •44.2.15 HAL_QSPI_Transmit_DMA
- •44.2.16 HAL_QSPI_Receive_DMA
- •44.2.17 HAL_QSPI_AutoPolling
- •44.2.18 HAL_QSPI_AutoPolling_IT
- •44.2.19 HAL_QSPI_MemoryMapped
- •44.2.20 HAL_QSPI_ErrorCallback
- •44.2.21 HAL_QSPI_CmdCpltCallback
- •44.2.22 HAL_QSPI_RxCpltCallback
- •44.2.23 HAL_QSPI_TxCpltCallback
- •44.2.24 HAL_QSPI_RxHalfCpltCallback
- •44.2.25 HAL_QSPI_TxHalfCpltCallback
- •44.2.26 HAL_QSPI_FifoThresholdCallback
- •44.2.27 HAL_QSPI_StatusMatchCallback
- •44.2.28 HAL_QSPI_TimeOutCallback
- •44.2.29 HAL_QSPI_GetState
- •44.2.30 HAL_QSPI_GetError
- •44.2.31 HAL_QSPI_Abort
- •44.2.32 HAL_QSPI_SetTimeout
- •44.2.33 HAL_QSPI_ErrorCallback
- •44.2.34 HAL_QSPI_FifoThresholdCallback
- •44.2.35 HAL_QSPI_CmdCpltCallback
- •44.2.36 HAL_QSPI_RxCpltCallback
- •44.2.37 HAL_QSPI_TxCpltCallback
- •44.2.38 HAL_QSPI_RxHalfCpltCallback
- •44.2.39 HAL_QSPI_TxHalfCpltCallback
- •44.2.40 HAL_QSPI_StatusMatchCallback
- •44.2.41 HAL_QSPI_TimeOutCallback
- •44.2.42 HAL_QSPI_GetState
- •44.2.43 HAL_QSPI_GetError
- •44.2.44 HAL_QSPI_Abort
- •44.2.45 HAL_QSPI_SetTimeout
- •44.3 QSPI Firmware driver defines
- •44.3.1 QSPI
- •45 HAL RCC Generic Driver
- •45.1 RCC Firmware driver registers structures
- •45.1.1 RCC_OscInitTypeDef
- •45.1.2 RCC_ClkInitTypeDef
- •45.2 RCC Firmware driver API description
- •45.2.1 RCC specific features
- •45.2.2 RCC Limitations
- •45.2.4 Peripheral Control functions
- •45.2.5 HAL_RCC_DeInit
- •45.2.6 HAL_RCC_OscConfig
- •45.2.7 HAL_RCC_ClockConfig
- •45.2.8 HAL_RCC_MCOConfig
- •45.2.9 HAL_RCC_EnableCSS
- •45.2.10 HAL_RCC_DisableCSS
- •45.2.11 HAL_RCC_GetSysClockFreq
- •45.2.12 HAL_RCC_GetHCLKFreq
- •45.2.13 HAL_RCC_GetPCLK1Freq
- •45.2.14 HAL_RCC_GetPCLK2Freq
- •45.2.15 HAL_RCC_GetOscConfig
- •45.2.16 HAL_RCC_GetClockConfig
- •45.2.17 HAL_RCC_NMI_IRQHandler
- •45.2.18 HAL_RCC_CSSCallback
- •45.3 RCC Firmware driver defines
- •46 HAL RCC Extension Driver
- •46.1 RCCEx Firmware driver registers structures
- •46.1.1 RCC_PLLInitTypeDef
- •46.1.2 RCC_PLLI2SInitTypeDef
- •46.1.3 RCC_PLLSAIInitTypeDef
- •46.1.4 RCC_PeriphCLKInitTypeDef
- •46.2 RCCEx Firmware driver API description
- •46.2.1 Extended Peripheral Control functions
- •46.2.2 HAL_RCCEx_PeriphCLKConfig
- •46.2.3 HAL_RCCEx_GetPeriphCLKConfig
- •46.2.4 HAL_RCCEx_GetPeriphCLKFreq
- •46.2.5 HAL_RCCEx_SelectLSEMode
- •46.2.6 HAL_RCC_OscConfig
- •46.2.7 HAL_RCC_GetOscConfig
- •46.2.8 HAL_RCC_GetSysClockFreq
- •46.3 RCCEx Firmware driver defines
- •46.3.1 RCCEx
- •47 HAL RNG Generic Driver
- •47.1 RNG Firmware driver registers structures
- •47.1.1 RNG_HandleTypeDef
- •47.2 RNG Firmware driver API description
- •47.2.1 How to use this driver
- •47.2.3 Peripheral Control functions
- •47.2.4 Peripheral State functions
- •47.2.5 HAL_RNG_Init
- •47.2.6 HAL_RNG_DeInit
- •47.2.7 HAL_RNG_MspInit
- •47.2.8 HAL_RNG_MspDeInit
- •47.2.9 HAL_RNG_GenerateRandomNumber
- •47.2.10 HAL_RNG_GenerateRandomNumber_IT
- •47.2.11 HAL_RNG_IRQHandler
- •47.2.12 HAL_RNG_GetRandomNumber
- •47.2.13 HAL_RNG_GetRandomNumber_IT
- •47.2.14 HAL_RNG_ReadLastRandomNumber
- •47.2.15 HAL_RNG_ReadyDataCallback
- •47.2.16 HAL_RNG_ErrorCallback
- •47.2.17 HAL_RNG_GetState
- •47.3 RNG Firmware driver defines
- •48 HAL RTC Generic Driver
- •48.1 RTC Firmware driver registers structures
- •48.1.1 RTC_InitTypeDef
- •48.1.2 RTC_TimeTypeDef
- •48.1.3 RTC_DateTypeDef
- •48.1.4 RTC_AlarmTypeDef
- •48.1.5 RTC_HandleTypeDef
- •48.2 RTC Firmware driver API description
- •48.2.1 Backup Domain Operating Condition
- •48.2.2 Backup Domain Reset
- •48.2.3 Backup Domain Access
- •48.2.4 How to use this driver
- •48.2.5 RTC and low power modes
- •48.2.7 RTC Time and Date functions
- •48.2.8 RTC Alarm functions
- •48.2.9 Peripheral Control functions
- •48.2.10 Peripheral State functions
- •48.2.11 HAL_RTC_Init
- •48.2.12 HAL_RTC_DeInit
- •48.2.13 HAL_RTC_MspInit
- •48.2.14 HAL_RTC_MspDeInit
- •48.2.15 HAL_RTC_SetTime
- •48.2.16 HAL_RTC_GetTime
- •48.2.17 HAL_RTC_SetDate
- •48.2.18 HAL_RTC_GetDate
- •48.2.19 HAL_RTC_SetAlarm
- •48.2.20 HAL_RTC_SetAlarm_IT
- •48.2.21 HAL_RTC_DeactivateAlarm
- •48.2.22 HAL_RTC_GetAlarm
- •48.2.23 HAL_RTC_AlarmIRQHandler
- •48.2.24 HAL_RTC_AlarmAEventCallback
- •48.2.25 HAL_RTC_PollForAlarmAEvent
- •48.2.26 HAL_RTC_WaitForSynchro
- •48.2.27 HAL_RTC_GetState
- •48.3 RTC Firmware driver defines
- •49 HAL RTC Extension Driver
- •49.1 RTCEx Firmware driver registers structures
- •49.1.1 RTC_TamperTypeDef
- •49.2 RTCEx Firmware driver API description
- •49.2.1 How to use this driver
- •49.2.2 RTC TimeStamp and Tamper functions
- •49.2.4 Extension Peripheral Control functions
- •49.2.5 Extended features functions
- •49.2.6 HAL_RTCEx_SetTimeStamp
- •49.2.7 HAL_RTCEx_SetTimeStamp_IT
- •49.2.8 HAL_RTCEx_DeactivateTimeStamp
- •49.2.9 HAL_RTCEx_GetTimeStamp
- •49.2.10 HAL_RTCEx_SetTamper
- •49.2.11 HAL_RTCEx_SetTamper_IT
- •49.2.12 HAL_RTCEx_DeactivateTamper
- •49.2.13 HAL_RTCEx_TamperTimeStampIRQHandler
- •49.2.14 HAL_RTCEx_TimeStampEventCallback
- •49.2.15 HAL_RTCEx_Tamper1EventCallback
- •49.2.16 HAL_RTCEx_Tamper2EventCallback
- •49.2.17 HAL_RTCEx_PollForTimeStampEvent
- •49.2.18 HAL_RTCEx_PollForTamper1Event
- •49.2.19 HAL_RTCEx_PollForTamper2Event
- •49.2.20 HAL_RTCEx_SetWakeUpTimer
- •49.2.21 HAL_RTCEx_SetWakeUpTimer_IT
- •49.2.22 HAL_RTCEx_DeactivateWakeUpTimer
- •49.2.23 HAL_RTCEx_GetWakeUpTimer
- •49.2.24 HAL_RTCEx_WakeUpTimerIRQHandler
- •49.2.25 HAL_RTCEx_WakeUpTimerEventCallback
- •49.2.26 HAL_RTCEx_PollForWakeUpTimerEvent
- •49.2.27 HAL_RTCEx_BKUPWrite
- •49.2.28 HAL_RTCEx_BKUPRead
- •49.2.29 HAL_RTCEx_SetCoarseCalib
- •49.2.30 HAL_RTCEx_DeactivateCoarseCalib
- •49.2.31 HAL_RTCEx_SetSmoothCalib
- •49.2.32 HAL_RTCEx_SetSynchroShift
- •49.2.33 HAL_RTCEx_SetCalibrationOutPut
- •49.2.34 HAL_RTCEx_DeactivateCalibrationOutPut
- •49.2.35 HAL_RTCEx_SetRefClock
- •49.2.36 HAL_RTCEx_DeactivateRefClock
- •49.2.37 HAL_RTCEx_EnableBypassShadow
- •49.2.38 HAL_RTCEx_DisableBypassShadow
- •49.2.39 HAL_RTCEx_AlarmBEventCallback
- •49.2.40 HAL_RTCEx_PollForAlarmBEvent
- •49.3 RTCEx Firmware driver defines
- •49.3.1 RTCEx
- •50 HAL SAI Generic Driver
- •50.1 SAI Firmware driver registers structures
- •50.1.1 SAI_InitTypeDef
- •50.1.2 SAI_FrameInitTypeDef
- •50.1.3 SAI_SlotInitTypeDef
- •50.1.4 __SAI_HandleTypeDef
- •50.2 SAI Firmware driver API description
- •50.2.1 How to use this driver
- •50.2.3 IO operation functions
- •50.2.4 Peripheral State and Errors functions
- •50.2.5 HAL_SAI_InitProtocol
- •50.2.6 HAL_SAI_Init
- •50.2.7 HAL_SAI_DeInit
- •50.2.8 HAL_SAI_MspInit
- •50.2.9 HAL_SAI_MspDeInit
- •50.2.10 HAL_SAI_Transmit
- •50.2.11 HAL_SAI_Receive
- •50.2.12 HAL_SAI_Transmit_IT
- •50.2.13 HAL_SAI_Receive_IT
- •50.2.14 HAL_SAI_DMAPause
- •50.2.15 HAL_SAI_DMAResume
- •50.2.16 HAL_SAI_DMAStop
- •50.2.17 HAL_SAI_Abort
- •50.2.18 HAL_SAI_Transmit_DMA
- •50.2.19 HAL_SAI_Receive_DMA
- •50.2.20 HAL_SAI_EnableTxMuteMode
- •50.2.21 HAL_SAI_DisableTxMuteMode
- •50.2.22 HAL_SAI_EnableRxMuteMode
- •50.2.23 HAL_SAI_DisableRxMuteMode
- •50.2.24 HAL_SAI_IRQHandler
- •50.2.25 HAL_SAI_TxCpltCallback
- •50.2.26 HAL_SAI_TxHalfCpltCallback
- •50.2.27 HAL_SAI_RxCpltCallback
- •50.2.28 HAL_SAI_RxHalfCpltCallback
- •50.2.29 HAL_SAI_ErrorCallback
- •50.2.30 HAL_SAI_GetState
- •50.2.31 HAL_SAI_GetError
- •50.3 SAI Firmware driver defines
- •51 HAL SAI Extension Driver
- •51.1 SAIEx Firmware driver API description
- •51.1.1 SAI peripheral extension features
- •51.1.2 How to use this driver
- •51.1.3 Extension features Functions
- •51.1.4 SAI_BlockSynchroConfig
- •51.1.5 SAI_GetInputClock
- •51.2 SAIEx Firmware driver defines
- •51.2.1 SAIEx
- •52 HAL SDRAM Generic Driver
- •52.1 SDRAM Firmware driver registers structures
- •52.1.1 SDRAM_HandleTypeDef
- •52.2 SDRAM Firmware driver API description
- •52.2.1 How to use this driver
- •52.2.2 SDRAM Initialization and de_initialization functions
- •52.2.3 SDRAM Input and Output functions
- •52.2.4 SDRAM Control functions
- •52.2.5 SDRAM State functions
- •52.2.6 HAL_SDRAM_Init
- •52.2.7 HAL_SDRAM_DeInit
- •52.2.8 HAL_SDRAM_MspInit
- •52.2.9 HAL_SDRAM_MspDeInit
- •52.2.10 HAL_SDRAM_IRQHandler
- •52.2.11 HAL_SDRAM_RefreshErrorCallback
- •52.2.12 HAL_SDRAM_DMA_XferCpltCallback
- •52.2.13 HAL_SDRAM_DMA_XferErrorCallback
- •52.2.14 HAL_SDRAM_Read_8b
- •52.2.15 HAL_SDRAM_Write_8b
- •52.2.16 HAL_SDRAM_Read_16b
- •52.2.17 HAL_SDRAM_Write_16b
- •52.2.18 HAL_SDRAM_Read_32b
- •52.2.19 HAL_SDRAM_Write_32b
- •52.2.20 HAL_SDRAM_Read_DMA
- •52.2.21 HAL_SDRAM_Write_DMA
- •52.2.22 HAL_SDRAM_WriteProtection_Enable
- •52.2.23 HAL_SDRAM_WriteProtection_Disable
- •52.2.24 HAL_SDRAM_SendCommand
- •52.2.25 HAL_SDRAM_ProgramRefreshRate
- •52.2.26 HAL_SDRAM_SetAutoRefreshNumber
- •52.2.27 HAL_SDRAM_GetModeStatus
- •52.2.28 HAL_SDRAM_GetState
- •52.3 SDRAM Firmware driver defines
- •52.3.1 SDRAM
- •53 HAL SD Generic Driver
- •53.1 SD Firmware driver registers structures
- •53.1.1 SD_HandleTypeDef
- •53.1.2 HAL_SD_CSDTypedef
- •53.1.3 HAL_SD_CIDTypedef
- •53.1.4 HAL_SD_CardStatusTypedef
- •53.1.5 HAL_SD_CardInfoTypedef
- •53.2 SD Firmware driver API description
- •53.2.1 How to use this driver
- •53.2.3 IO operation functions
- •53.2.4 Peripheral Control functions
- •53.2.5 Peripheral State functions
- •53.2.6 HAL_SD_Init
- •53.2.7 HAL_SD_DeInit
- •53.2.8 HAL_SD_MspInit
- •53.2.9 HAL_SD_MspDeInit
- •53.2.10 HAL_SD_ReadBlocks
- •53.2.11 HAL_SD_WriteBlocks
- •53.2.12 HAL_SD_ReadBlocks_DMA
- •53.2.13 HAL_SD_WriteBlocks_DMA
- •53.2.14 HAL_SD_CheckReadOperation
- •53.2.15 HAL_SD_CheckWriteOperation
- •53.2.16 HAL_SD_Erase
- •53.2.17 HAL_SD_IRQHandler
- •53.2.18 HAL_SD_XferCpltCallback
- •53.2.19 HAL_SD_XferErrorCallback
- •53.2.20 HAL_SD_DMA_RxCpltCallback
- •53.2.21 HAL_SD_DMA_RxErrorCallback
- •53.2.22 HAL_SD_DMA_TxCpltCallback
- •53.2.23 HAL_SD_DMA_TxErrorCallback
- •53.2.24 HAL_SD_Get_CardInfo
- •53.2.25 HAL_SD_WideBusOperation_Config
- •53.2.26 HAL_SD_StopTransfer
- •53.2.27 HAL_SD_HighSpeed
- •53.2.28 HAL_SD_SendSDStatus
- •53.2.29 HAL_SD_GetStatus
- •53.2.30 HAL_SD_GetCardStatus
- •53.3 SD Firmware driver defines
- •54 HAL SMARTCARD Generic Driver
- •54.1 SMARTCARD Firmware driver registers structures
- •54.1.1 SMARTCARD_InitTypeDef
- •54.1.2 SMARTCARD_HandleTypeDef
- •54.2 SMARTCARD Firmware driver API description
- •54.2.1 How to use this driver
- •54.2.2 Initialization and Configuration functions
- •54.2.3 IO operation functions
- •54.2.4 Peripheral State and Errors functions
- •54.2.5 HAL_SMARTCARD_Init
- •54.2.6 HAL_SMARTCARD_DeInit
- •54.2.7 HAL_SMARTCARD_MspInit
- •54.2.8 HAL_SMARTCARD_MspDeInit
- •54.2.9 HAL_SMARTCARD_ReInit
- •54.2.10 HAL_SMARTCARD_Transmit
- •54.2.11 HAL_SMARTCARD_Receive
- •54.2.12 HAL_SMARTCARD_Transmit_IT
- •54.2.13 HAL_SMARTCARD_Receive_IT
- •54.2.14 HAL_SMARTCARD_Transmit_DMA
- •54.2.15 HAL_SMARTCARD_Receive_DMA
- •54.2.16 HAL_SMARTCARD_IRQHandler
- •54.2.17 HAL_SMARTCARD_TxCpltCallback
- •54.2.18 HAL_SMARTCARD_RxCpltCallback
- •54.2.19 HAL_SMARTCARD_ErrorCallback
- •54.2.20 HAL_SMARTCARD_GetState
- •54.2.21 HAL_SMARTCARD_GetError
- •54.3 SMARTCARD Firmware driver defines
- •54.3.1 SMARTCARD
- •55 HAL SPDIFRX Generic Driver
- •55.1 SPDIFRX Firmware driver registers structures
- •55.1.1 SPDIFRX_InitTypeDef
- •55.1.2 SPDIFRX_SetDataFormatTypeDef
- •55.1.3 SPDIFRX_HandleTypeDef
- •55.2 SPDIFRX Firmware driver API description
- •55.2.1 How to use this driver
- •55.2.3 IO operation functions
- •55.2.4 Peripheral State and Errors functions
- •55.2.5 HAL_SPDIFRX_Init
- •55.2.6 HAL_SPDIFRX_DeInit
- •55.2.7 HAL_SPDIFRX_MspInit
- •55.2.8 HAL_SPDIFRX_MspDeInit
- •55.2.9 HAL_SPDIFRX_SetDataFormat
- •55.2.10 HAL_SPDIFRX_ReceiveDataFlow
- •55.2.11 HAL_SPDIFRX_ReceiveControlFlow
- •55.2.12 HAL_SPDIFRX_ReceiveDataFlow_IT
- •55.2.13 HAL_SPDIFRX_ReceiveControlFlow_IT
- •55.2.14 HAL_SPDIFRX_ReceiveDataFlow_DMA
- •55.2.15 HAL_SPDIFRX_ReceiveControlFlow_DMA
- •55.2.16 HAL_SPDIFRX_DMAStop
- •55.2.17 HAL_SPDIFRX_IRQHandler
- •55.2.18 HAL_SPDIFRX_RxHalfCpltCallback
- •55.2.19 HAL_SPDIFRX_RxCpltCallback
- •55.2.20 HAL_SPDIFRX_CxHalfCpltCallback
- •55.2.21 HAL_SPDIFRX_CxCpltCallback
- •55.2.22 HAL_SPDIFRX_ErrorCallback
- •55.2.23 HAL_SPDIFRX_GetState
- •55.2.24 HAL_SPDIFRX_GetError
- •55.3 SPDIFRX Firmware driver defines
- •55.3.1 SPDIFRX
- •56 HAL SPI Generic Driver
- •56.1 SPI Firmware driver registers structures
- •56.1.1 SPI_InitTypeDef
- •56.1.2 __SPI_HandleTypeDef
- •56.2 SPI Firmware driver API description
- •56.2.1 How to use this driver
- •56.2.3 IO operation functions
- •56.2.4 Peripheral State and Errors functions
- •56.2.5 HAL_SPI_Init
- •56.2.6 HAL_SPI_DeInit
- •56.2.7 HAL_SPI_MspInit
- •56.2.8 HAL_SPI_MspDeInit
- •56.2.9 HAL_SPI_Transmit
- •56.2.10 HAL_SPI_Receive
- •56.2.11 HAL_SPI_TransmitReceive
- •56.2.12 HAL_SPI_Transmit_IT
- •56.2.13 HAL_SPI_Receive_IT
- •56.2.14 HAL_SPI_TransmitReceive_IT
- •56.2.15 HAL_SPI_Transmit_DMA
- •56.2.16 HAL_SPI_Receive_DMA
- •56.2.17 HAL_SPI_TransmitReceive_DMA
- •56.2.18 HAL_SPI_DMAPause
- •56.2.19 HAL_SPI_DMAResume
- •56.2.20 HAL_SPI_DMAStop
- •56.2.21 HAL_SPI_IRQHandler
- •56.2.22 HAL_SPI_TxCpltCallback
- •56.2.23 HAL_SPI_RxCpltCallback
- •56.2.24 HAL_SPI_TxRxCpltCallback
- •56.2.25 HAL_SPI_TxHalfCpltCallback
- •56.2.26 HAL_SPI_RxHalfCpltCallback
- •56.2.27 HAL_SPI_TxRxHalfCpltCallback
- •56.2.28 HAL_SPI_ErrorCallback
- •56.2.29 HAL_SPI_GetState
- •56.2.30 HAL_SPI_GetError
- •56.3 SPI Firmware driver defines
- •57 HAL SRAM Generic Driver
- •57.1 SRAM Firmware driver registers structures
- •57.1.1 SRAM_HandleTypeDef
- •57.2 SRAM Firmware driver API description
- •57.2.1 How to use this driver
- •57.2.2 SRAM Initialization and de_initialization functions
- •57.2.3 SRAM Input and Output functions
- •57.2.4 SRAM Control functions
- •57.2.5 SRAM State functions
- •57.2.6 HAL_SRAM_Init
- •57.2.7 HAL_SRAM_DeInit
- •57.2.8 HAL_SRAM_MspInit
- •57.2.9 HAL_SRAM_MspDeInit
- •57.2.10 HAL_SRAM_DMA_XferCpltCallback
- •57.2.11 HAL_SRAM_DMA_XferErrorCallback
- •57.2.12 HAL_SRAM_Read_8b
- •57.2.13 HAL_SRAM_Write_8b
- •57.2.14 HAL_SRAM_Read_16b
- •57.2.15 HAL_SRAM_Write_16b
- •57.2.16 HAL_SRAM_Read_32b
- •57.2.17 HAL_SRAM_Write_32b
- •57.2.18 HAL_SRAM_Read_DMA
- •57.2.19 HAL_SRAM_Write_DMA
- •57.2.20 HAL_SRAM_WriteOperation_Enable
- •57.2.21 HAL_SRAM_WriteOperation_Disable
- •57.2.22 HAL_SRAM_GetState
- •57.3 SRAM Firmware driver defines
- •57.3.1 SRAM
- •58 HAL TIM Generic Driver
- •58.1 TIM Firmware driver registers structures
- •58.1.1 TIM_Base_InitTypeDef
- •58.1.2 TIM_OC_InitTypeDef
- •58.1.3 TIM_OnePulse_InitTypeDef
- •58.1.4 TIM_IC_InitTypeDef
- •58.1.5 TIM_Encoder_InitTypeDef
- •58.1.6 TIM_ClockConfigTypeDef
- •58.1.7 TIM_ClearInputConfigTypeDef
- •58.1.8 TIM_SlaveConfigTypeDef
- •58.1.9 TIM_HandleTypeDef
- •58.2 TIM Firmware driver API description
- •58.2.1 TIMER Generic features
- •58.2.2 How to use this driver
- •58.2.3 Time Base functions
- •58.2.4 Time Output Compare functions
- •58.2.5 Time PWM functions
- •58.2.6 Time Input Capture functions
- •58.2.7 Time One Pulse functions
- •58.2.8 Time Encoder functions
- •58.2.9 IRQ handler management
- •58.2.10 Peripheral Control functions
- •58.2.11 TIM Callbacks functions
- •58.2.12 Peripheral State functions
- •58.2.13 HAL_TIM_Base_Init
- •58.2.14 HAL_TIM_Base_DeInit
- •58.2.15 HAL_TIM_Base_MspInit
- •58.2.16 HAL_TIM_Base_MspDeInit
- •58.2.17 HAL_TIM_Base_Start
- •58.2.18 HAL_TIM_Base_Stop
- •58.2.19 HAL_TIM_Base_Start_IT
- •58.2.20 HAL_TIM_Base_Stop_IT
- •58.2.21 HAL_TIM_Base_Start_DMA
- •58.2.22 HAL_TIM_Base_Stop_DMA
- •58.2.23 HAL_TIM_OC_Init
- •58.2.24 HAL_TIM_OC_DeInit
- •58.2.25 HAL_TIM_OC_MspInit
- •58.2.26 HAL_TIM_OC_MspDeInit
- •58.2.27 HAL_TIM_OC_Start
- •58.2.28 HAL_TIM_OC_Stop
- •58.2.29 HAL_TIM_OC_Start_IT
- •58.2.30 HAL_TIM_OC_Stop_IT
- •58.2.31 HAL_TIM_OC_Start_DMA
- •58.2.32 HAL_TIM_OC_Stop_DMA
- •58.2.33 HAL_TIM_PWM_Init
- •58.2.34 HAL_TIM_PWM_DeInit
- •58.2.35 HAL_TIM_PWM_MspInit
- •58.2.36 HAL_TIM_PWM_MspDeInit
- •58.2.37 HAL_TIM_PWM_Start
- •58.2.38 HAL_TIM_PWM_Stop
- •58.2.39 HAL_TIM_PWM_Start_IT
- •58.2.40 HAL_TIM_PWM_Stop_IT
- •58.2.41 HAL_TIM_PWM_Start_DMA
- •58.2.42 HAL_TIM_PWM_Stop_DMA
- •58.2.43 HAL_TIM_IC_Init
- •58.2.44 HAL_TIM_IC_DeInit
- •58.2.45 HAL_TIM_IC_MspInit
- •58.2.46 HAL_TIM_IC_MspDeInit
- •58.2.47 HAL_TIM_IC_Start
- •58.2.48 HAL_TIM_IC_Stop
- •58.2.49 HAL_TIM_IC_Start_IT
- •58.2.50 HAL_TIM_IC_Stop_IT
- •58.2.51 HAL_TIM_IC_Start_DMA
- •58.2.52 HAL_TIM_IC_Stop_DMA
- •58.2.53 HAL_TIM_OnePulse_Init
- •58.2.54 HAL_TIM_OnePulse_DeInit
- •58.2.55 HAL_TIM_OnePulse_MspInit
- •58.2.56 HAL_TIM_OnePulse_MspDeInit
- •58.2.57 HAL_TIM_OnePulse_Start
- •58.2.58 HAL_TIM_OnePulse_Stop
- •58.2.59 HAL_TIM_OnePulse_Start_IT
- •58.2.60 HAL_TIM_OnePulse_Stop_IT
- •58.2.61 HAL_TIM_Encoder_Init
- •58.2.62 HAL_TIM_Encoder_DeInit
- •58.2.63 HAL_TIM_Encoder_MspInit
- •58.2.64 HAL_TIM_Encoder_MspDeInit
- •58.2.65 HAL_TIM_Encoder_Start
- •58.2.66 HAL_TIM_Encoder_Stop
- •58.2.67 HAL_TIM_Encoder_Start_IT
- •58.2.68 HAL_TIM_Encoder_Stop_IT
- •58.2.69 HAL_TIM_Encoder_Start_DMA
- •58.2.70 HAL_TIM_Encoder_Stop_DMA
- •58.2.71 HAL_TIM_IRQHandler
- •58.2.72 HAL_TIM_OC_ConfigChannel
- •58.2.73 HAL_TIM_IC_ConfigChannel
- •58.2.74 HAL_TIM_PWM_ConfigChannel
- •58.2.75 HAL_TIM_OnePulse_ConfigChannel
- •58.2.76 HAL_TIM_DMABurst_WriteStart
- •58.2.77 HAL_TIM_DMABurst_WriteStop
- •58.2.78 HAL_TIM_DMABurst_ReadStart
- •58.2.79 HAL_TIM_DMABurst_ReadStop
- •58.2.80 HAL_TIM_GenerateEvent
- •58.2.81 HAL_TIM_ConfigOCrefClear
- •58.2.82 HAL_TIM_ConfigClockSource
- •58.2.83 HAL_TIM_ConfigTI1Input
- •58.2.84 HAL_TIM_SlaveConfigSynchronization
- •58.2.85 HAL_TIM_SlaveConfigSynchronization_IT
- •58.2.86 HAL_TIM_ReadCapturedValue
- •58.2.87 HAL_TIM_PeriodElapsedCallback
- •58.2.88 HAL_TIM_OC_DelayElapsedCallback
- •58.2.89 HAL_TIM_IC_CaptureCallback
- •58.2.90 HAL_TIM_PWM_PulseFinishedCallback
- •58.2.91 HAL_TIM_TriggerCallback
- •58.2.92 HAL_TIM_ErrorCallback
- •58.2.93 HAL_TIM_Base_GetState
- •58.2.94 HAL_TIM_OC_GetState
- •58.2.95 HAL_TIM_PWM_GetState
- •58.2.96 HAL_TIM_IC_GetState
- •58.2.97 HAL_TIM_OnePulse_GetState
- •58.2.98 HAL_TIM_Encoder_GetState
- •58.3 TIM Firmware driver defines
- •59 HAL TIM Extension Driver
- •59.1 TIMEx Firmware driver registers structures
- •59.1.1 TIM_HallSensor_InitTypeDef
- •59.1.2 TIM_MasterConfigTypeDef
- •59.1.3 TIM_BreakDeadTimeConfigTypeDef
- •59.2 TIMEx Firmware driver API description
- •59.2.1 TIMER Extended features
- •59.2.2 How to use this driver
- •59.2.3 Timer Hall Sensor functions
- •59.2.4 Timer Complementary Output Compare functions
- •59.2.5 Timer Complementary PWM functions
- •59.2.6 Timer Complementary One Pulse functions
- •59.2.7 Peripheral Control functions
- •59.2.8 Extension Callbacks functions
- •59.2.9 Extension Peripheral State functions
- •59.2.10 HAL_TIMEx_HallSensor_Init
- •59.2.11 HAL_TIMEx_HallSensor_DeInit
- •59.2.12 HAL_TIMEx_HallSensor_MspInit
- •59.2.13 HAL_TIMEx_HallSensor_MspDeInit
- •59.2.14 HAL_TIMEx_HallSensor_Start
- •59.2.15 HAL_TIMEx_HallSensor_Stop
- •59.2.16 HAL_TIMEx_HallSensor_Start_IT
- •59.2.17 HAL_TIMEx_HallSensor_Stop_IT
- •59.2.18 HAL_TIMEx_HallSensor_Start_DMA
- •59.2.19 HAL_TIMEx_HallSensor_Stop_DMA
- •59.2.20 HAL_TIMEx_OCN_Start
- •59.2.21 HAL_TIMEx_OCN_Stop
- •59.2.22 HAL_TIMEx_OCN_Start_IT
- •59.2.23 HAL_TIMEx_OCN_Stop_IT
- •59.2.24 HAL_TIMEx_OCN_Start_DMA
- •59.2.25 HAL_TIMEx_OCN_Stop_DMA
- •59.2.26 HAL_TIMEx_PWMN_Start
- •59.2.27 HAL_TIMEx_PWMN_Stop
- •59.2.28 HAL_TIMEx_PWMN_Start_IT
- •59.2.29 HAL_TIMEx_PWMN_Stop_IT
- •59.2.30 HAL_TIMEx_PWMN_Start_DMA
- •59.2.31 HAL_TIMEx_PWMN_Stop_DMA
- •59.2.32 HAL_TIMEx_OnePulseN_Start
- •59.2.33 HAL_TIMEx_OnePulseN_Stop
- •59.2.34 HAL_TIMEx_OnePulseN_Start_IT
- •59.2.35 HAL_TIMEx_OnePulseN_Stop_IT
- •59.2.36 HAL_TIMEx_ConfigCommutationEvent
- •59.2.37 HAL_TIMEx_ConfigCommutationEvent_IT
- •59.2.38 HAL_TIMEx_ConfigCommutationEvent_DMA
- •59.2.39 HAL_TIMEx_MasterConfigSynchronization
- •59.2.40 HAL_TIMEx_ConfigBreakDeadTime
- •59.2.41 HAL_TIMEx_RemapConfig
- •59.2.42 HAL_TIMEx_CommutationCallback
- •59.2.43 HAL_TIMEx_BreakCallback
- •59.2.44 TIMEx_DMACommutationCplt
- •59.2.45 HAL_TIMEx_HallSensor_GetState
- •59.3 TIMEx Firmware driver defines
- •59.3.1 TIMEx
- •60 HAL UART Generic Driver
- •60.1 UART Firmware driver registers structures
- •60.1.1 UART_InitTypeDef
- •60.1.2 UART_HandleTypeDef
- •60.2 UART Firmware driver API description
- •60.2.1 How to use this driver
- •60.2.2 Initialization and Configuration functions
- •60.2.3 IO operation functions
- •60.2.4 Peripheral Control functions
- •60.2.5 Peripheral State and Errors functions
- •60.2.6 HAL_UART_Init
- •60.2.7 HAL_HalfDuplex_Init
- •60.2.8 HAL_LIN_Init
- •60.2.9 HAL_MultiProcessor_Init
- •60.2.10 HAL_UART_DeInit
- •60.2.11 HAL_UART_MspInit
- •60.2.12 HAL_UART_MspDeInit
- •60.2.13 HAL_UART_Transmit
- •60.2.14 HAL_UART_Receive
- •60.2.15 HAL_UART_Transmit_IT
- •60.2.16 HAL_UART_Receive_IT
- •60.2.17 HAL_UART_Transmit_DMA
- •60.2.18 HAL_UART_Receive_DMA
- •60.2.19 HAL_UART_DMAPause
- •60.2.20 HAL_UART_DMAResume
- •60.2.21 HAL_UART_DMAStop
- •60.2.22 HAL_UART_IRQHandler
- •60.2.23 HAL_UART_TxCpltCallback
- •60.2.24 HAL_UART_TxHalfCpltCallback
- •60.2.25 HAL_UART_RxCpltCallback
- •60.2.26 HAL_UART_RxHalfCpltCallback
- •60.2.27 HAL_UART_ErrorCallback
- •60.2.28 HAL_LIN_SendBreak
- •60.2.29 HAL_MultiProcessor_EnterMuteMode
- •60.2.30 HAL_MultiProcessor_ExitMuteMode
- •60.2.31 HAL_HalfDuplex_EnableTransmitter
- •60.2.32 HAL_HalfDuplex_EnableReceiver
- •60.2.33 HAL_UART_GetState
- •60.2.34 HAL_UART_GetError
- •60.3 UART Firmware driver defines
- •60.3.1 UART
- •61 HAL USART Generic Driver
- •61.1 USART Firmware driver registers structures
- •61.1.1 USART_InitTypeDef
- •61.1.2 USART_HandleTypeDef
- •61.2 USART Firmware driver API description
- •61.2.1 How to use this driver
- •61.2.2 Initialization and Configuration functions
- •61.2.3 IO operation functions
- •61.2.4 Peripheral State and Errors functions
- •61.2.5 HAL_USART_Init
- •61.2.6 HAL_USART_DeInit
- •61.2.7 HAL_USART_MspInit
- •61.2.8 HAL_USART_MspDeInit
- •61.2.9 HAL_USART_Transmit
- •61.2.10 HAL_USART_Receive
- •61.2.11 HAL_USART_TransmitReceive
- •61.2.12 HAL_USART_Transmit_IT
- •61.2.13 HAL_USART_Receive_IT
- •61.2.14 HAL_USART_TransmitReceive_IT
- •61.2.15 HAL_USART_Transmit_DMA
- •61.2.16 HAL_USART_Receive_DMA
- •61.2.17 HAL_USART_TransmitReceive_DMA
- •61.2.18 HAL_USART_DMAPause
- •61.2.19 HAL_USART_DMAResume
- •61.2.20 HAL_USART_DMAStop
- •61.2.21 HAL_USART_IRQHandler
- •61.2.22 HAL_USART_TxCpltCallback
- •61.2.23 HAL_USART_TxHalfCpltCallback
- •61.2.24 HAL_USART_RxCpltCallback
- •61.2.25 HAL_USART_RxHalfCpltCallback
- •61.2.26 HAL_USART_TxRxCpltCallback
- •61.2.27 HAL_USART_ErrorCallback
- •61.2.28 HAL_USART_GetState
- •61.2.29 HAL_USART_GetError
- •61.3 USART Firmware driver defines
- •61.3.1 USART
- •62 HAL WWDG Generic Driver
- •62.1 WWDG Firmware driver registers structures
- •62.1.1 WWDG_InitTypeDef
- •62.1.2 WWDG_HandleTypeDef
- •62.2 WWDG Firmware driver API description
- •62.2.1 WWDG specific features
- •62.2.2 How to use this driver
- •62.2.4 IO operation functions
- •62.2.5 Peripheral State functions
- •62.2.6 HAL_WWDG_Init
- •62.2.7 HAL_WWDG_DeInit
- •62.2.8 HAL_WWDG_MspInit
- •62.2.9 HAL_WWDG_MspDeInit
- •62.2.10 HAL_WWDG_WakeupCallback
- •62.2.11 HAL_WWDG_Start
- •62.2.12 HAL_WWDG_Start_IT
- •62.2.13 HAL_WWDG_Refresh
- •62.2.14 HAL_WWDG_IRQHandler
- •62.2.15 HAL_WWDG_WakeupCallback
- •62.2.16 HAL_WWDG_GetState
- •62.3 WWDG Firmware driver defines
- •62.3.1 WWDG
- •63 FAQs
- •64 Revision history
UM1725
User Manual
Description of STM32F4xx HAL drivers
Introduction
STM32CubeTM is an STMicroelectronics original initiative to ease developers life by reducing development efforts, time and cost. STM32CubeTM covers STM32 portfolio.
STM32CubeTM Version 1.x includes:
The STM32CubeMX, a graphical software configuration tool that allows generating C initialization code using graphical wizards.
A comprehensive embedded software platform, delivered per series (such as STM32CubeF4 for STM32F4 series)
The STM32Cube HAL, an STM32 abstraction layer embedded software, ensuring maximized portability across STM32 portfolio
A consistent set of middleware components such as RTOS, USB, TCP/IP, Graphics
All embedded software utilities coming with a full set of examples.
The HAL drivers layer provides a generic multi instance simple set of APIs (application programming interfaces) to interact with the upper layer (application, libraries and stacks). It is composed of generic and extension APIs. It is directly built around a generic architecture and allows the built-upon layers, such as the middleware layer, to implement their functions without knowing in-depth how to use the MCU. This structure improves the library code reusability and guarantees an easy portability on other devices.
The HAL drivers include a complete set of ready-to-use APIs which simplify the user application implementation. As an example, the communication peripherals contain APIs to initialize and configure the peripheral, to manage data transfers based on polling, to handle interrupts or DMA, and to manage communication errors.
The HAL drivers APIs are split into two categories: generic APIs which provide common and generic functions for all the STM32 series and extension APIs which include specific and customized functions for a given family or part number.
The HAL drivers are feature-oriented instead of IP-oriented. As an example, the timer APIs are split into several categories following the functions offered by the IP: basic timer, capture, pulse width modulation (PWM), etc..
The drivers source code is developed in Strict ANSI-C which makes it independent from the development tools. It is checked with CodeSonarTM static analysis tool. It is fully documented and is MISRA-C 2004 compliant.
The HAL drivers layer implements run-time failure detection by checking the input values of all functions. Such dynamic checking contributes to enhance the firmware robustness. Run-time detection is also suitable for user application development and debugging.
This user manual is structured as follows:
Overview of the HAL drivers
Detailed description of each peripheral driver: configuration structures, functions, and how to use the given API to build your application.
April 2015 |
DOCID025834 Rev 2 |
1/900 |
www.st.com
Contents |
UM1725 |
Contents
1 |
Acronyms and definitions............................................................. |
53 |
||
2 |
Overview of HAL drivers ............................................................... |
55 |
||
|
2.1 |
HAL and user-application files......................................................... |
55 |
|
|
|
2.1.1 |
HAL driver files ................................................................................. |
55 |
|
|
2.1.2 |
User-application files ........................................................................ |
57 |
|
2.2 |
HAL data structures ........................................................................ |
59 |
|
|
|
2.2.1 |
Peripheral handle structures ............................................................ |
59 |
|
|
2.2.2 |
Initialization and configuration structure ........................................... |
60 |
|
|
2.2.3 |
Specific process structures .............................................................. |
60 |
|
2.3 |
API classification ............................................................................. |
61 |
|
|
2.4 |
Devices supported by HAL drivers .................................................. |
62 |
|
|
2.5 |
HAL drivers rules............................................................................. |
66 |
|
|
|
2.5.1 |
HAL API naming rules ...................................................................... |
66 |
|
|
2.5.2 |
HAL general naming rules ................................................................ |
67 |
|
|
2.5.3 |
HAL interrupt handler and callback functions................................... |
68 |
|
2.6 |
HAL generic APIs............................................................................ |
69 |
|
|
2.7 |
HAL extension APIs ........................................................................ |
70 |
|
|
|
2.7.1 |
HAL extension model overview ........................................................ |
70 |
|
|
2.7.2 |
HAL extension model cases ............................................................. |
71 |
|
2.8 |
File inclusion model......................................................................... |
73 |
|
|
2.9 |
HAL common resources.................................................................. |
73 |
|
|
2.10 |
HAL configuration............................................................................ |
74 |
|
|
2.11 HAL system peripheral handling ..................................................... |
76 |
||
|
|
2.11.1 |
Clock................................................................................................. |
76 |
|
|
2.11.2 |
GPIOs ............................................................................................... |
76 |
|
|
2.11.3 |
Cortex NVIC and SysTick timer........................................................ |
78 |
|
|
2.11.4 |
PWR ................................................................................................. |
79 |
|
|
2.11.5 |
EXTI.................................................................................................. |
79 |
|
|
2.11.6 |
DMA.................................................................................................. |
80 |
|
2.12 How to use HAL drivers .................................................................. |
81 |
||
|
|
2.12.1 |
HAL usage models ........................................................................... |
81 |
|
|
2.12.2 |
HAL initialization ............................................................................... |
82 |
|
|
2.12.3 |
HAL IO operation process ................................................................ |
84 |
|
|
2.12.4 |
Timeout and error management....................................................... |
87 |
3 |
HAL System Driver ........................................................................ |
92 |
||
2/900 |
|
|
DOCID025834 Rev 2 |
|
UM1725 |
Contents |
|
3.1 |
HAL Firmware driver API description .............................................. |
92 |
|
|
|
3.1.1 |
How to use this driver ....................................................................... |
92 |
|
|
3.1.2 |
Initialization and de-initialization functions ....................................... |
92 |
|
|
3.1.3 |
HAL Control functions....................................................................... |
92 |
|
|
3.1.4 |
HAL_Init ............................................................................................ |
93 |
|
|
3.1.5 |
HAL_DeInit ....................................................................................... |
93 |
|
|
3.1.6 |
HAL_MspInit ..................................................................................... |
93 |
|
|
3.1.7 |
HAL_MspDeInit ................................................................................ |
93 |
|
|
3.1.8 |
HAL_InitTick ..................................................................................... |
94 |
|
|
3.1.9 |
HAL_IncTick ..................................................................................... |
94 |
|
|
3.1.10 |
HAL_GetTick .................................................................................... |
94 |
|
|
3.1.11 |
HAL_Delay ....................................................................................... |
94 |
|
|
3.1.12 |
HAL_SuspendTick............................................................................ |
95 |
|
|
3.1.13 |
HAL_ResumeTick............................................................................. |
95 |
|
|
3.1.14 |
HAL_GetHalVersion ......................................................................... |
95 |
|
|
3.1.15 |
HAL_GetREVID ................................................................................ |
95 |
|
|
3.1.16 |
HAL_GetDEVID ................................................................................ |
95 |
|
|
3.1.17 |
HAL_DBGMCU_EnableDBGSleepMode ......................................... |
96 |
|
|
3.1.18 |
HAL_DBGMCU_DisableDBGSleepMode ........................................ |
96 |
|
|
3.1.19 |
HAL_DBGMCU_EnableDBGStopMode ........................................... |
96 |
|
|
3.1.20 |
HAL_DBGMCU_DisableDBGStopMode .......................................... |
96 |
|
|
3.1.21 |
HAL_DBGMCU_EnableDBGStandbyMode ..................................... |
96 |
|
|
3.1.22 |
HAL_DBGMCU_DisableDBGStandbyMode .................................... |
96 |
|
|
3.1.23 |
HAL_EnableCompensationCell ........................................................ |
96 |
|
|
3.1.24 |
HAL_DisableCompensationCell ....................................................... |
97 |
|
3.2 |
HAL Firmware driver defines........................................................... |
97 |
|
|
|
3.2.1 |
HAL................................................................................................... |
97 |
4 |
HAL ADC Generic Driver............................................................. |
100 |
||
|
4.1 |
ADC Firmware driver registers structures ..................................... |
100 |
|
|
|
4.1.1 |
ADC_InitTypeDef............................................................................ |
100 |
|
|
4.1.2 |
ADC_HandleTypeDef ..................................................................... |
101 |
|
|
4.1.3 |
ADC_ChannelConfTypeDef ........................................................... |
101 |
|
|
4.1.4 |
ADC_AnalogWDGConfTypeDef..................................................... |
102 |
|
4.2 |
ADC Firmware driver API description............................................ |
103 |
|
|
|
4.2.1 |
ADC Peripheral features................................................................. |
103 |
|
|
4.2.2 |
How to use this driver ..................................................................... |
103 |
|
|
4.2.3 |
Initialization and de-initialization functions ..................................... |
105 |
|
|
4.2.4 |
IO operation functions .................................................................... |
105 |
|
|
|
DOCID025834 Rev 2 |
3/900 |
Contents |
|
|
UM1725 |
|
|
|
4.2.5 |
Peripheral Control functions ........................................................... |
106 |
|
|
4.2.6 |
Peripheral State and errors functions............................................. |
106 |
|
|
4.2.7 |
HAL_ADC_Init ................................................................................ |
106 |
|
|
4.2.8 |
HAL_ADC_DeInit............................................................................ |
107 |
|
|
4.2.9 |
HAL_ADC_MspInit ......................................................................... |
107 |
|
|
4.2.10 |
HAL_ADC_MspDeInit..................................................................... |
107 |
|
|
4.2.11 |
HAL_ADC_Start ............................................................................. |
107 |
|
|
4.2.12 |
HAL_ADC_Stop.............................................................................. |
107 |
|
|
4.2.13 |
HAL_ADC_PollForConversion ....................................................... |
108 |
|
|
4.2.14 |
HAL_ADC_PollForEvent ................................................................ |
108 |
|
|
4.2.15 |
HAL_ADC_Start_IT ........................................................................ |
108 |
|
|
4.2.16 |
HAL_ADC_Stop_IT ........................................................................ |
109 |
|
|
4.2.17 |
HAL_ADC_IRQHandler .................................................................. |
109 |
|
|
4.2.18 |
HAL_ADC_Start_DMA ................................................................... |
109 |
|
|
4.2.19 |
HAL_ADC_Stop_DMA.................................................................... |
109 |
|
|
4.2.20 |
HAL_ADC_GetValue ...................................................................... |
110 |
|
|
4.2.21 |
HAL_ADC_ConvCpltCallback ........................................................ |
110 |
|
|
4.2.22 |
HAL_ADC_ConvHalfCpltCallback .................................................. |
110 |
|
|
4.2.23 |
HAL_ADC_LevelOutOfWindowCallback ........................................ |
110 |
|
|
4.2.24 |
HAL_ADC_ErrorCallback ............................................................... |
110 |
|
|
4.2.25 |
HAL_ADC_ConfigChannel ............................................................. |
110 |
|
|
4.2.26 |
HAL_ADC_AnalogWDGConfig ...................................................... |
111 |
|
|
4.2.27 |
HAL_ADC_GetState....................................................................... |
111 |
|
|
4.2.28 |
HAL_ADC_GetError ....................................................................... |
111 |
|
4.3 |
ADC Firmware driver defines ........................................................ |
111 |
|
|
|
4.3.1 |
ADC ................................................................................................ |
111 |
5 |
HAL ADC Extension Driver ......................................................... |
120 |
||
|
5.1 |
ADCEx Firmware driver registers structures ................................. |
120 |
|
|
|
5.1.1 |
ADC_InjectionConfTypeDef ........................................................... |
120 |
|
|
5.1.2 |
ADC_MultiModeTypeDef................................................................ |
121 |
|
5.2 |
ADCEx Firmware driver API description ....................................... |
121 |
|
|
|
5.2.1 |
How to use this driver ..................................................................... |
121 |
|
|
5.2.2 |
Extended features functions ........................................................... |
122 |
|
|
5.2.3 |
HAL_ADCEx_InjectedStart ............................................................ |
123 |
|
|
5.2.4 |
HAL_ADCEx_InjectedStart_IT ....................................................... |
123 |
|
|
5.2.5 |
HAL_ADCEx_InjectedStop............................................................. |
123 |
|
|
5.2.6 |
HAL_ADCEx_InjectedPollForConversion ...................................... |
124 |
|
|
5.2.7 |
HAL_ADCEx_InjectedStop_IT ....................................................... |
124 |
4/900 |
|
|
DOCID025834 Rev 2 |
|
UM1725 |
Contents |
|
|
5.2.8 |
HAL_ADCEx_InjectedGetValue ..................................................... |
124 |
|
|
5.2.9 |
HAL_ADCEx_MultiModeStart_DMA .............................................. |
124 |
|
|
5.2.10 |
HAL_ADCEx_MultiModeStop_DMA............................................... |
125 |
|
|
5.2.11 |
HAL_ADCEx_MultiModeGetValue ................................................. |
125 |
|
|
5.2.12 |
HAL_ADCEx_InjectedConvCpltCallback ....................................... |
125 |
|
|
5.2.13 |
HAL_ADCEx_InjectedConfigChannel ............................................ |
125 |
|
|
5.2.14 |
HAL_ADCEx_MultiModeConfigChannel ........................................ |
126 |
|
5.3 |
ADCEx Firmware driver defines .................................................... |
126 |
|
|
|
5.3.1 |
ADCEx ............................................................................................ |
126 |
6 |
HAL CAN Generic Driver............................................................. |
129 |
||
|
6.1 |
CAN Firmware driver registers structures ..................................... |
129 |
|
|
|
6.1.1 |
CAN_InitTypeDef............................................................................ |
129 |
|
|
6.1.2 |
CAN_FilterConfTypeDef................................................................. |
130 |
|
|
6.1.3 |
CanTxMsgTypeDef......................................................................... |
131 |
|
|
6.1.4 |
CanRxMsgTypeDef ........................................................................ |
131 |
|
|
6.1.5 |
CAN_HandleTypeDef ..................................................................... |
132 |
|
6.2 |
CAN Firmware driver API description............................................ |
133 |
|
|
|
6.2.1 |
How to use this driver ..................................................................... |
133 |
|
|
6.2.2 |
Initialization and de-initialization functions ..................................... |
134 |
|
|
6.2.3 |
IO operation functions .................................................................... |
134 |
|
|
6.2.4 |
Peripheral State and Error functions .............................................. |
134 |
|
|
6.2.5 |
HAL_CAN_Init ................................................................................ |
135 |
|
|
6.2.6 |
HAL_CAN_ConfigFilter................................................................... |
135 |
|
|
6.2.7 |
HAL_CAN_DeInit............................................................................ |
135 |
|
|
6.2.8 |
HAL_CAN_MspInit ......................................................................... |
135 |
|
|
6.2.9 |
HAL_CAN_MspDeInit..................................................................... |
135 |
|
|
6.2.10 |
HAL_CAN_Transmit ....................................................................... |
136 |
|
|
6.2.11 |
HAL_CAN_Transmit_IT.................................................................. |
136 |
|
|
6.2.12 |
HAL_CAN_Receive ........................................................................ |
136 |
|
|
6.2.13 |
HAL_CAN_Receive_IT................................................................... |
136 |
|
|
6.2.14 |
HAL_CAN_Sleep............................................................................ |
136 |
|
|
6.2.15 |
HAL_CAN_WakeUp ....................................................................... |
137 |
|
|
6.2.16 |
HAL_CAN_IRQHandler .................................................................. |
137 |
|
|
6.2.17 |
HAL_CAN_TxCpltCallback............................................................. |
137 |
|
|
6.2.18 |
HAL_CAN_RxCpltCallback ............................................................ |
137 |
|
|
6.2.19 |
HAL_CAN_ErrorCallback ............................................................... |
137 |
|
|
6.2.20 |
HAL_CAN_GetState....................................................................... |
138 |
|
|
6.2.21 |
HAL_CAN_GetError ....................................................................... |
138 |
|
|
|
DOCID025834 Rev 2 |
5/900 |
Contents |
|
|
UM1725 |
|
|
6.3 |
CAN Firmware driver defines ........................................................ |
138 |
|
|
|
6.3.1 |
CAN ................................................................................................ |
138 |
7 |
HAL CEC Generic Driver ............................................................. |
146 |
||
|
7.1 |
CEC Firmware driver registers structures ..................................... |
146 |
|
|
|
7.1.1 |
CEC_InitTypeDef............................................................................ |
146 |
|
|
7.1.2 |
CEC_HandleTypeDef ..................................................................... |
147 |
|
7.2 |
CEC Firmware driver API description............................................ |
148 |
|
|
|
7.2.1 |
Initialization and Configuration functions........................................ |
148 |
|
|
7.2.2 |
IO operation functions .................................................................... |
148 |
|
|
7.2.3 |
Peripheral Control function ............................................................. |
148 |
|
|
7.2.4 |
HAL_CEC_Init ................................................................................ |
148 |
|
|
7.2.5 |
HAL_CEC_DeInit............................................................................ |
149 |
|
|
7.2.6 |
HAL_CEC_MspInit ......................................................................... |
149 |
|
|
7.2.7 |
HAL_CEC_MspDeInit..................................................................... |
149 |
|
|
7.2.8 |
HAL_CEC_Transmit ....................................................................... |
149 |
|
|
7.2.9 |
HAL_CEC_Receive ........................................................................ |
149 |
|
|
7.2.10 |
HAL_CEC_Transmit_IT.................................................................. |
150 |
|
|
7.2.11 |
HAL_CEC_Receive_IT................................................................... |
150 |
|
|
7.2.12 |
HAL_CEC_GetReceivedFrameSize............................................... |
150 |
|
|
7.2.13 |
HAL_CEC_IRQHandler .................................................................. |
150 |
|
|
7.2.14 |
HAL_CEC_TxCpltCallback............................................................. |
151 |
|
|
7.2.15 |
HAL_CEC_RxCpltCallback ............................................................ |
151 |
|
|
7.2.16 |
HAL_CEC_ErrorCallback ............................................................... |
151 |
|
|
7.2.17 |
HAL_CEC_GetState....................................................................... |
151 |
|
|
7.2.18 |
HAL_CEC_GetError ....................................................................... |
151 |
|
7.3 |
CEC Firmware driver defines ........................................................ |
152 |
|
|
|
7.3.1 |
CEC ................................................................................................ |
152 |
8 |
HAL CORTEX Generic Driver...................................................... |
162 |
||
|
8.1 |
CORTEX Firmware driver API description .................................... |
162 |
|
|
|
8.1.1 |
How to use this driver ..................................................................... |
162 |
|
|
8.1.2 |
Initialization and de-initialization functions ..................................... |
163 |
|
|
8.1.3 |
Peripheral Control functions ........................................................... |
163 |
|
|
8.1.4 |
HAL_NVIC_SetPriorityGrouping .................................................... |
163 |
|
|
8.1.5 |
HAL_NVIC_SetPriority ................................................................... |
163 |
|
|
8.1.6 |
HAL_NVIC_EnableIRQ .................................................................. |
164 |
|
|
8.1.7 |
HAL_NVIC_DisableIRQ.................................................................. |
164 |
|
|
8.1.8 |
HAL_NVIC_SystemReset............................................................... |
164 |
|
|
8.1.9 |
HAL_SYSTICK_Config................................................................... |
164 |
6/900 |
|
|
DOCID025834 Rev 2 |
|
UM1725 |
Contents |
|
|
8.1.10 |
HAL_NVIC_GetPriorityGrouping .................................................... |
165 |
|
|
8.1.11 |
HAL_NVIC_GetPriority ................................................................... |
165 |
|
|
8.1.12 |
HAL_NVIC_SetPendingIRQ ........................................................... |
165 |
|
|
8.1.13 |
HAL_NVIC_GetPendingIRQ .......................................................... |
165 |
|
|
8.1.14 |
HAL_NVIC_ClearPendingIRQ........................................................ |
166 |
|
|
8.1.15 |
HAL_NVIC_GetActive .................................................................... |
166 |
|
|
8.1.16 |
HAL_SYSTICK_CLKSourceConfig ................................................ |
166 |
|
|
8.1.17 |
HAL_SYSTICK_IRQHandler .......................................................... |
166 |
|
|
8.1.18 |
HAL_SYSTICK_Callback ............................................................... |
167 |
|
8.2 |
CORTEX Firmware driver defines................................................. |
167 |
|
|
|
8.2.1 |
CORTEX......................................................................................... |
167 |
9 |
HAL CRC Generic Driver............................................................. |
168 |
||
|
9.1 |
CRC Firmware driver registers structures ..................................... |
168 |
|
|
|
9.1.1 |
CRC_HandleTypeDef..................................................................... |
168 |
|
9.2 |
CRC Firmware driver API description ........................................... |
168 |
|
|
|
9.2.1 |
How to use this driver ..................................................................... |
168 |
|
|
9.2.2 |
Initialization and de-initialization functions ..................................... |
168 |
|
|
9.2.3 |
Peripheral Control functions ........................................................... |
169 |
|
|
9.2.4 |
Peripheral State functions .............................................................. |
169 |
|
|
9.2.5 |
HAL_CRC_Init ................................................................................ |
169 |
|
|
9.2.6 |
HAL_CRC_DeInit ........................................................................... |
169 |
|
|
9.2.7 |
HAL_CRC_MspInit ......................................................................... |
169 |
|
|
9.2.8 |
HAL_CRC_MspDeInit..................................................................... |
169 |
|
|
9.2.9 |
HAL_CRC_Accumulate .................................................................. |
170 |
|
|
9.2.10 |
HAL_CRC_Calculate...................................................................... |
170 |
|
|
9.2.11 |
HAL_CRC_GetState....................................................................... |
170 |
|
9.3 |
CRC Firmware driver defines ........................................................ |
170 |
|
|
|
9.3.1 |
CRC ................................................................................................ |
170 |
10 HAL CRYP Generic Driver........................................................... |
172 |
|||
|
10.1 CRYP Firmware driver registers structures ................................... |
172 |
||
|
|
10.1.1 |
CRYP_InitTypeDef ......................................................................... |
172 |
|
|
10.1.2 |
CRYP_HandleTypeDef................................................................... |
172 |
|
10.2 CRYP Firmware driver API description ......................................... |
173 |
||
|
|
10.2.1 |
How to use this driver ..................................................................... |
173 |
|
|
10.2.2 |
Initialization and de-initialization functions ..................................... |
174 |
|
|
10.2.3 |
AES processing functions .............................................................. |
174 |
|
|
10.2.4 |
DES processing functions .............................................................. |
175 |
|
|
|
DOCID025834 Rev 2 |
7/900 |
Contents |
|
UM1725 |
10.2.5 |
TDES processing functions ............................................................ |
175 |
10.2.6 |
DMA callback functions .................................................................. |
176 |
10.2.7 |
CRYP IRQ handler management ................................................... |
176 |
10.2.8 |
Peripheral State functions .............................................................. |
176 |
10.2.9 |
HAL_CRYP_Init.............................................................................. |
176 |
10.2.10 |
HAL_CRYP_DeInit ......................................................................... |
177 |
10.2.11 |
HAL_CRYP_MspInit ....................................................................... |
177 |
10.2.12 |
HAL_CRYP_MspDeInit .................................................................. |
177 |
10.2.13 |
HAL_CRYP_AESECB_Encrypt...................................................... |
177 |
10.2.14 |
HAL_CRYP_AESCBC_Encrypt ..................................................... |
177 |
10.2.15 |
HAL_CRYP_AESCTR_Encrypt...................................................... |
178 |
10.2.16 |
HAL_CRYP_AESECB_Decrypt ..................................................... |
178 |
10.2.17 |
HAL_CRYP_AESCBC_Decrypt ..................................................... |
178 |
10.2.18 |
HAL_CRYP_AESCTR_Decrypt ..................................................... |
179 |
10.2.19 |
HAL_CRYP_AESECB_Encrypt_IT ................................................ |
179 |
10.2.20 |
HAL_CRYP_AESCBC_Encrypt_IT ................................................ |
179 |
10.2.21 |
HAL_CRYP_AESCTR_Encrypt_IT ................................................ |
180 |
10.2.22 |
HAL_CRYP_AESECB_Decrypt_IT ................................................ |
180 |
10.2.23 |
HAL_CRYP_AESCBC_Decrypt_IT ................................................ |
180 |
10.2.24 |
HAL_CRYP_AESCTR_Decrypt_IT ................................................ |
181 |
10.2.25 |
HAL_CRYP_AESECB_Encrypt_DMA............................................ |
181 |
10.2.26 |
HAL_CRYP_AESCBC_Encrypt_DMA ........................................... |
181 |
10.2.27 |
HAL_CRYP_AESCTR_Encrypt_DMA............................................ |
181 |
10.2.28 |
HAL_CRYP_AESECB_Decrypt_DMA ........................................... |
182 |
10.2.29 |
HAL_CRYP_AESCBC_Decrypt_DMA ........................................... |
182 |
10.2.30 |
HAL_CRYP_AESCTR_Decrypt_DMA ........................................... |
182 |
10.2.31 |
HAL_CRYP_DESECB_Encrypt ..................................................... |
183 |
10.2.32 |
HAL_CRYP_DESECB_Decrypt ..................................................... |
183 |
10.2.33 |
HAL_CRYP_DESCBC_Encrypt ..................................................... |
183 |
10.2.34 |
HAL_CRYP_DESCBC_Decrypt ..................................................... |
183 |
10.2.35 |
HAL_CRYP_DESECB_Encrypt_IT ................................................ |
184 |
10.2.36 |
HAL_CRYP_DESCBC_Encrypt_IT ................................................ |
184 |
10.2.37 |
HAL_CRYP_DESECB_Decrypt_IT ................................................ |
184 |
10.2.38 |
HAL_CRYP_DESCBC_Decrypt_IT ................................................ |
185 |
10.2.39 |
HAL_CRYP_DESECB_Encrypt_DMA ........................................... |
185 |
10.2.40 |
HAL_CRYP_DESCBC_Encrypt_DMA ........................................... |
185 |
10.2.41 |
HAL_CRYP_DESECB_Decrypt_DMA ........................................... |
185 |
10.2.42 |
HAL_CRYP_DESCBC_Decrypt_DMA ........................................... |
186 |
10.2.43 |
HAL_CRYP_TDESECB_Encrypt ................................................... |
186 |
8/900 |
DOCID025834 Rev 2 |
|
UM1725 |
Contents |
10.2.44 |
HAL_CRYP_TDESECB_Decrypt ................................................... |
186 |
10.2.45 |
HAL_CRYP_TDESCBC_Encrypt ................................................... |
187 |
10.2.46 |
HAL_CRYP_TDESCBC_Decrypt ................................................... |
187 |
10.2.47 |
HAL_CRYP_TDESECB_Encrypt_IT .............................................. |
187 |
10.2.48 |
HAL_CRYP_TDESCBC_Encrypt_IT.............................................. |
188 |
10.2.49 |
HAL_CRYP_TDESECB_Decrypt_IT.............................................. |
188 |
10.2.50 |
HAL_CRYP_TDESCBC_Decrypt_IT.............................................. |
188 |
10.2.51 |
HAL_CRYP_TDESECB_Encrypt_DMA ......................................... |
188 |
10.2.52 |
HAL_CRYP_TDESCBC_Encrypt_DMA ......................................... |
189 |
10.2.53 |
HAL_CRYP_TDESECB_Decrypt_DMA ......................................... |
189 |
10.2.54 |
HAL_CRYP_TDESCBC_Decrypt_DMA......................................... |
189 |
10.2.55 |
HAL_CRYP_InCpltCallback ........................................................... |
190 |
10.2.56 |
HAL_CRYP_OutCpltCallback ........................................................ |
190 |
10.2.57 |
HAL_CRYP_ErrorCallback............................................................. |
190 |
10.2.58 |
HAL_CRYP_IRQHandler................................................................ |
190 |
10.2.59 |
HAL_CRYP_GetState .................................................................... |
190 |
10.3 CRYP Firmware driver defines...................................................... |
191 |
|
10.3.1 |
CRYP.............................................................................................. |
191 |
11 HAL CRYP Extension Driver....................................................... |
195 |
|
11.1 CRYPEx Firmware driver API description ..................................... |
195 |
|
11.1.1 |
How to use this driver ..................................................................... |
195 |
11.1.2 |
Extended AES processing functions .............................................. |
197 |
11.1.3 |
CRYPEx IRQ handler management............................................... |
197 |
11.1.4 |
HAL_CRYPEx_AESCCM_Encrypt................................................. |
197 |
11.1.5 |
HAL_CRYPEx_AESGCM_Encrypt ................................................ |
197 |
11.1.6 |
HAL_CRYPEx_AESGCM_Decrypt ................................................ |
198 |
11.1.7 |
HAL_CRYPEx_AESGCM_Finish ................................................... |
198 |
11.1.8 |
HAL_CRYPEx_AESCCM_Finish ................................................... |
198 |
11.1.9 |
HAL_CRYPEx_AESCCM_Decrypt ................................................ |
199 |
11.1.10 |
HAL_CRYPEx_AESGCM_Encrypt_IT ........................................... |
199 |
11.1.11 |
HAL_CRYPEx_AESCCM_Encrypt_IT ........................................... |
199 |
11.1.12 |
HAL_CRYPEx_AESGCM_Decrypt_IT ........................................... |
200 |
11.1.13 |
HAL_CRYPEx_AESCCM_Decrypt_IT ........................................... |
200 |
11.1.14 |
HAL_CRYPEx_AESGCM_Encrypt_DMA ...................................... |
200 |
11.1.15 |
HAL_CRYPEx_AESCCM_Encrypt_DMA....................................... |
200 |
11.1.16 |
HAL_CRYPEx_AESGCM_Decrypt_DMA ...................................... |
201 |
11.1.17 |
HAL_CRYPEx_AESCCM_Decrypt_DMA ...................................... |
201 |
11.1.18 |
HAL_CRYPEx_GCMCCM_IRQHandler......................................... |
201 |
|
DOCID025834 Rev 2 |
9/900 |
Contents |
|
UM1725 |
11.2 CRYPEx Firmware driver defines.................................................. |
202 |
|
11.2.1 |
CRYPEx ......................................................................................... |
202 |
12 HAL DAC Generic Driver............................................................. |
203 |
|
12.1 DAC Firmware driver registers structures ..................................... |
203 |
|
12.1.1 |
DAC_HandleTypeDef ..................................................................... |
203 |
12.1.2 |
DAC_ChannelConfTypeDef ........................................................... |
203 |
12.2 DAC Firmware driver API description............................................ |
204 |
|
12.2.1 |
DAC Peripheral features................................................................. |
204 |
12.2.2 |
How to use this driver ..................................................................... |
205 |
12.2.3 |
Initialization and de-initialization functions ..................................... |
206 |
12.2.4 |
IO operation functions .................................................................... |
206 |
12.2.5 |
Peripheral Control functions ........................................................... |
206 |
12.2.6 |
Peripheral State and Errors functions ............................................ |
206 |
12.2.7 |
HAL_DAC_Init ................................................................................ |
207 |
12.2.8 |
HAL_DAC_DeInit............................................................................ |
207 |
12.2.9 |
HAL_DAC_MspInit ......................................................................... |
207 |
12.2.10 |
HAL_DAC_MspDeInit..................................................................... |
207 |
12.2.11 |
HAL_DAC_Start ............................................................................. |
207 |
12.2.12 |
HAL_DAC_Stop.............................................................................. |
208 |
12.2.13 |
HAL_DAC_Start_DMA ................................................................... |
208 |
12.2.14 |
HAL_DAC_Stop_DMA.................................................................... |
208 |
12.2.15 |
HAL_DAC_GetValue ...................................................................... |
209 |
12.2.16 |
HAL_DAC_IRQHandler .................................................................. |
209 |
12.2.17 |
HAL_DAC_ConvCpltCallbackCh1.................................................. |
209 |
12.2.18 |
HAL_DAC_ConvHalfCpltCallbackCh1 ........................................... |
209 |
12.2.19 |
HAL_DAC_ErrorCallbackCh1 ........................................................ |
210 |
12.2.20 |
HAL_DAC_DMAUnderrunCallbackCh1 ......................................... |
210 |
12.2.21 |
HAL_DAC_ConfigChannel ............................................................. |
210 |
12.2.22 |
HAL_DAC_SetValue ...................................................................... |
210 |
12.2.23 |
HAL_DAC_GetState....................................................................... |
211 |
12.2.24 |
HAL_DAC_GetError ....................................................................... |
211 |
12.2.25 |
HAL_DAC_IRQHandler .................................................................. |
211 |
12.2.26 |
HAL_DAC_ConvCpltCallbackCh1.................................................. |
211 |
12.2.27 |
HAL_DAC_ConvHalfCpltCallbackCh1 ........................................... |
211 |
12.2.28 |
HAL_DAC_ErrorCallbackCh1 ........................................................ |
212 |
12.2.29 |
HAL_DAC_DMAUnderrunCallbackCh1 ......................................... |
212 |
12.3 DAC Firmware driver defines ........................................................ |
212 |
|
12.3.1 |
DAC ................................................................................................ |
212 |
10/900 |
DOCID025834 Rev 2 |
|
UM1725 |
Contents |
13 HAL DAC Extension Driver ......................................................... |
217 |
||
13.1 |
DACEx Firmware driver API description ....................................... |
217 |
|
|
13.1.1 |
How to use this driver ..................................................................... |
217 |
|
13.1.2 |
Extended features functions ........................................................... |
217 |
|
13.1.3 |
HAL_DACEx_DualGetValue .......................................................... |
217 |
|
13.1.4 |
HAL_DACEx_TriangleWaveGenerate ........................................... |
217 |
|
13.1.5 |
HAL_DACEx_NoiseWaveGenerate ............................................... |
218 |
|
13.1.6 |
HAL_DACEx_DualSetValue........................................................... |
219 |
|
13.1.7 |
HAL_DACEx_ConvCpltCallbackCh2 ............................................. |
219 |
|
13.1.8 |
HAL_DACEx_ConvHalfCpltCallbackCh2 ....................................... |
219 |
|
13.1.9 |
HAL_DACEx_ErrorCallbackCh2 .................................................... |
220 |
|
13.1.10 |
HAL_DACEx_DMAUnderrunCallbackCh2 ..................................... |
220 |
13.2 |
DACEx Firmware driver defines .................................................... |
220 |
|
|
13.2.1 |
DACEx ............................................................................................ |
220 |
14 HAL DCMI Generic Driver ........................................................... |
222 |
||
14.1 |
DCMI Firmware driver registers structures.................................... |
222 |
|
|
14.1.1 |
DCMI_HandleTypeDef ................................................................... |
222 |
14.2 |
DCMI Firmware driver API description .......................................... |
222 |
|
|
14.2.1 |
How to use this driver ..................................................................... |
222 |
|
14.2.2 |
Initialization and Configuration functions........................................ |
223 |
|
14.2.3 |
IO operation functions .................................................................... |
223 |
|
14.2.4 |
Peripheral Control functions ........................................................... |
224 |
|
14.2.5 |
Peripheral State and Errors functions ............................................ |
224 |
|
14.2.6 |
HAL_DCMI_Init............................................................................... |
224 |
|
14.2.7 |
HAL_DCMI_DeInit .......................................................................... |
224 |
|
14.2.8 |
HAL_DCMI_MspInit........................................................................ |
224 |
|
14.2.9 |
HAL_DCMI_MspDeInit ................................................................... |
225 |
|
14.2.10 |
HAL_DCMI_Start_DMA.................................................................. |
225 |
|
14.2.11 |
HAL_DCMI_Stop ............................................................................ |
225 |
|
14.2.12 |
HAL_DCMI_IRQHandler ................................................................ |
225 |
|
14.2.13 |
HAL_DCMI_ErrorCallback ............................................................. |
226 |
|
14.2.14 |
HAL_DCMI_LineEventCallback ..................................................... |
226 |
|
14.2.15 |
HAL_DCMI_VsyncEventCallback .................................................. |
226 |
|
14.2.16 |
HAL_DCMI_FrameEventCallback .................................................. |
226 |
|
14.2.17 |
HAL_DCMI_ConfigCROP............................................................... |
226 |
|
14.2.18 |
HAL_DCMI_DisableCROP ............................................................. |
227 |
|
14.2.19 |
HAL_DCMI_EnableCROP.............................................................. |
227 |
|
|
DOCID025834 Rev 2 |
11/900 |
Contents |
|
|
UM1725 |
|
14.2.20 |
HAL_DCMI_GetState ..................................................................... |
227 |
|
14.2.21 |
HAL_DCMI_GetError...................................................................... |
227 |
14.3 |
DCMI Firmware driver defines....................................................... |
227 |
|
|
14.3.1 |
DCMI............................................................................................... |
227 |
15 HAL DCMI Extension Driver........................................................ |
233 |
||
15.1 |
DCMIEx Firmware driver registers structures................................ |
233 |
|
|
15.1.1 |
DCMI_CodesInitTypeDef................................................................ |
233 |
|
15.1.2 |
DCMI_InitTypeDef .......................................................................... |
233 |
15.2 |
DCMIEx Firmware driver API description ...................................... |
234 |
|
|
15.2.1 |
DCMI peripheral extension features............................................... |
234 |
|
15.2.2 |
How to use this driver ..................................................................... |
234 |
|
15.2.3 |
Initialization and Configuration functions........................................ |
234 |
|
15.2.4 |
HAL_DCMI_Init............................................................................... |
235 |
15.3 |
DCMIEx Firmware driver defines .................................................. |
235 |
|
|
15.3.1 |
DCMIEx .......................................................................................... |
235 |
16 HAL DMA Generic Driver ............................................................ |
236 |
||
16.1 |
DMA Firmware driver registers structures ..................................... |
236 |
|
|
16.1.1 |
DMA_InitTypeDef ........................................................................... |
236 |
|
16.1.2 |
__DMA_HandleTypeDef................................................................. |
237 |
16.2 |
DMA Firmware driver API description ........................................... |
238 |
|
|
16.2.1 |
How to use this driver ..................................................................... |
238 |
|
16.2.2 |
Initialization and de-initialization functions ..................................... |
239 |
|
16.2.3 |
IO operation functions .................................................................... |
239 |
|
16.2.4 |
State and Errors functions .............................................................. |
240 |
|
16.2.5 |
HAL_DMA_Init ................................................................................ |
240 |
|
16.2.6 |
HAL_DMA_DeInit ........................................................................... |
240 |
|
16.2.7 |
HAL_DMA_Start ............................................................................. |
240 |
|
16.2.8 |
HAL_DMA_Start_IT........................................................................ |
240 |
|
16.2.9 |
HAL_DMA_Abort ............................................................................ |
241 |
|
16.2.10 |
HAL_DMA_PollForTransfer............................................................ |
241 |
|
16.2.11 |
HAL_DMA_IRQHandler.................................................................. |
241 |
|
16.2.12 |
HAL_DMA_GetState ...................................................................... |
242 |
|
16.2.13 |
HAL_DMA_GetError....................................................................... |
242 |
16.3 |
DMA Firmware driver defines........................................................ |
242 |
|
|
16.3.1 |
DMA................................................................................................ |
242 |
17 HAL DMA Extension Driver......................................................... |
246 |
||
17.1 |
DMAEx Firmware driver API description ....................................... |
246 |
|
12/900 |
|
DOCID025834 Rev 2 |
|
UM1725 |
Contents |
17.1.1 |
How to use this driver ..................................................................... |
246 |
17.1.2 |
Extended features functions ........................................................... |
246 |
17.1.3 |
HAL_DMAEx_MultiBufferStart ....................................................... |
246 |
17.1.4 |
HAL_DMAEx_MultiBufferStart_IT .................................................. |
246 |
17.1.5 |
HAL_DMAEx_ChangeMemory....................................................... |
247 |
17.2 DMAEx Firmware driver defines.................................................... |
247 |
|
17.2.1 |
DMAEx............................................................................................ |
247 |
18 HAL DMA2D Generic Driver........................................................ |
248 |
|
18.1 DMA2D Firmware driver registers structures ................................ |
248 |
|
18.1.1 |
DMA2D_ColorTypeDef................................................................... |
248 |
18.1.2 |
DMA2D_CLUTCfgTypeDef ............................................................ |
248 |
18.1.3 |
DMA2D_InitTypeDef....................................................................... |
248 |
18.1.4 |
DMA2D_LayerCfgTypeDef............................................................. |
249 |
18.1.5 |
__DMA2D_HandleTypeDef ............................................................ |
249 |
18.2 DMA2D Firmware driver API description....................................... |
250 |
|
18.2.1 |
How to use this driver ..................................................................... |
250 |
18.2.2 |
Initialization and Configuration functions........................................ |
251 |
18.2.3 |
IO operation functions .................................................................... |
251 |
18.2.4 |
Peripheral Control functions ........................................................... |
252 |
18.2.5 |
Peripheral State and Errors functions ............................................ |
252 |
18.2.6 |
HAL_DMA2D_Init ........................................................................... |
252 |
18.2.7 |
HAL_DMA2D_DeInit....................................................................... |
253 |
18.2.8 |
HAL_DMA2D_MspInit .................................................................... |
253 |
18.2.9 |
HAL_DMA2D_MspDeInit................................................................ |
253 |
18.2.10 |
HAL_DMA2D_Start ........................................................................ |
253 |
18.2.11 |
HAL_DMA2D_Start_IT ................................................................... |
254 |
18.2.12 |
HAL_DMA2D_BlendingStart .......................................................... |
254 |
18.2.13 |
HAL_DMA2D_BlendingStart_IT ..................................................... |
254 |
18.2.14 |
HAL_DMA2D_Abort ....................................................................... |
255 |
18.2.15 |
HAL_DMA2D_Suspend.................................................................. |
255 |
18.2.16 |
HAL_DMA2D_Resume................................................................... |
255 |
18.2.17 |
HAL_DMA2D_PollForTransfer ....................................................... |
255 |
18.2.18 |
HAL_DMA2D_IRQHandler ............................................................. |
256 |
18.2.19 |
HAL_DMA2D_ConfigLayer ............................................................ |
256 |
18.2.20 |
HAL_DMA2D_ConfigCLUT ............................................................ |
256 |
18.2.21 |
HAL_DMA2D_EnableCLUT ........................................................... |
256 |
18.2.22 |
HAL_DMA2D_DisableCLUT .......................................................... |
257 |
18.2.23 |
HAL_DMA2D_ProgramLineEvent .................................................. |
257 |
|
DOCID025834 Rev 2 |
13/900 |
Contents |
|
UM1725 |
18.2.24 |
HAL_DMA2D_GetState.................................................................. |
257 |
18.2.25 |
HAL_DMA2D_GetError .................................................................. |
257 |
18.3 DMA2D Firmware driver defines ................................................... |
257 |
|
18.3.1 |
DMA2D ........................................................................................... |
257 |
19 HAL ETH Generic Driver ............................................................. |
264 |
|
19.1 ETH Firmware driver registers structures...................................... |
264 |
|
19.1.1 |
ETH_InitTypeDef ............................................................................ |
264 |
19.1.2 |
ETH_MACInitTypeDef .................................................................... |
264 |
19.1.3 |
ETH_DMAInitTypeDef .................................................................... |
267 |
19.1.4 |
ETH_DMADescTypeDef................................................................. |
268 |
19.1.5 |
ETH_DMARxFrameInfos................................................................ |
269 |
19.1.6 |
ETH_HandleTypeDef ..................................................................... |
270 |
19.2 ETH Firmware driver API description ............................................ |
270 |
|
19.2.1 |
How to use this driver ..................................................................... |
270 |
19.2.2 |
Initialization and de-initialization functions ..................................... |
271 |
19.2.3 |
IO operation functions .................................................................... |
271 |
19.2.4 |
Peripheral Control functions ........................................................... |
272 |
19.2.5 |
Peripheral State functions .............................................................. |
272 |
19.2.6 |
HAL_ETH_Init................................................................................. |
272 |
19.2.7 |
HAL_ETH_DeInit ............................................................................ |
272 |
19.2.8 |
HAL_ETH_DMATxDescListInit....................................................... |
272 |
19.2.9 |
HAL_ETH_DMARxDescListInit ...................................................... |
273 |
19.2.10 |
HAL_ETH_MspInit.......................................................................... |
273 |
19.2.11 |
HAL_ETH_MspDeInit ..................................................................... |
273 |
19.2.12 |
HAL_ETH_TransmitFrame ............................................................. |
273 |
19.2.13 |
HAL_ETH_GetReceivedFrame ...................................................... |
273 |
19.2.14 |
HAL_ETH_GetReceivedFrame_IT................................................. |
274 |
19.2.15 |
HAL_ETH_IRQHandler .................................................................. |
274 |
19.2.16 |
HAL_ETH_TxCpltCallback ............................................................. |
274 |
19.2.17 |
HAL_ETH_RxCpltCallback............................................................. |
274 |
19.2.18 |
HAL_ETH_ErrorCallback................................................................ |
274 |
19.2.19 |
HAL_ETH_ReadPHYRegister ........................................................ |
275 |
19.2.20 |
HAL_ETH_WritePHYRegister ........................................................ |
275 |
19.2.21 |
HAL_ETH_Start.............................................................................. |
275 |
19.2.22 |
HAL_ETH_Stop .............................................................................. |
275 |
19.2.23 |
HAL_ETH_ConfigMAC ................................................................... |
276 |
19.2.24 |
HAL_ETH_ConfigDMA ................................................................... |
276 |
19.2.25 |
HAL_ETH_GetState ....................................................................... |
276 |
14/900 |
DOCID025834 Rev 2 |
|
UM1725 |
Contents |
19.3 |
ETH Firmware driver defines......................................................... |
276 |
|
|
19.3.1 |
ETH................................................................................................. |
276 |
20 HAL FLASH Generic Driver......................................................... |
308 |
||
20.1 |
FLASH Firmware driver registers structures ................................. |
308 |
|
|
20.1.1 |
FLASH_ProcessTypeDef ............................................................... |
308 |
20.2 |
FLASH Firmware driver API description........................................ |
308 |
|
|
20.2.1 |
FLASH peripheral features ............................................................. |
308 |
|
20.2.2 |
How to use this driver ..................................................................... |
309 |
|
20.2.3 |
Programming operation functions .................................................. |
309 |
|
20.2.4 |
Peripheral Control functions ........................................................... |
309 |
|
20.2.5 |
Peripheral Errors functions ............................................................. |
309 |
|
20.2.6 |
HAL_FLASH_Program ................................................................... |
310 |
|
20.2.7 |
HAL_FLASH_Program_IT .............................................................. |
310 |
|
20.2.8 |
HAL_FLASH_IRQHandler .............................................................. |
310 |
|
20.2.9 |
HAL_FLASH_EndOfOperationCallback ......................................... |
310 |
|
20.2.10 |
HAL_FLASH_OperationErrorCallback ........................................... |
310 |
|
20.2.11 |
HAL_FLASH_Unlock ...................................................................... |
311 |
|
20.2.12 |
HAL_FLASH_Lock ......................................................................... |
311 |
|
20.2.13 |
HAL_FLASH_OB_Unlock............................................................... |
311 |
|
20.2.14 |
HAL_FLASH_OB_Lock .................................................................. |
311 |
|
20.2.15 |
HAL_FLASH_OB_Launch .............................................................. |
311 |
|
20.2.16 |
HAL_FLASH_GetError ................................................................... |
311 |
|
20.2.17 |
FLASH_WaitForLastOperation....................................................... |
312 |
20.3 |
FLASH Firmware driver defines .................................................... |
312 |
|
|
20.3.1 |
FLASH ............................................................................................ |
312 |
21 HAL FLASH Extension Driver..................................................... |
318 |
||
21.1 |
FLASHEx Firmware driver registers structures ............................. |
318 |
|
|
21.1.1 |
FLASH_EraseInitTypeDef .............................................................. |
318 |
|
21.1.2 |
FLASH_OBProgramInitTypeDef .................................................... |
318 |
|
21.1.3 |
FLASH_AdvOBProgramInitTypeDef .............................................. |
319 |
21.2 |
FLASHEx Firmware driver API description.................................... |
319 |
|
|
21.2.1 |
Flash Extension features ................................................................ |
319 |
|
21.2.2 |
How to use this driver ..................................................................... |
320 |
|
21.2.3 |
Extended programming operation functions .................................. |
320 |
|
21.2.4 |
HAL_FLASHEx_Erase ................................................................... |
320 |
|
21.2.5 |
HAL_FLASHEx_Erase_IT .............................................................. |
321 |
|
21.2.6 |
HAL_FLASHEx_OBProgram.......................................................... |
321 |
|
|
DOCID025834 Rev 2 |
15/900 |
Contents |
|
UM1725 |
21.2.7 |
HAL_FLASHEx_OBGetConfig ....................................................... |
321 |
21.2.8 |
HAL_FLASHEx_AdvOBProgram ................................................... |
321 |
21.2.9 |
HAL_FLASHEx_AdvOBGetConfig ................................................. |
321 |
21.2.10 |
HAL_FLASHEx_OB_SelectPCROP............................................... |
322 |
21.2.11 |
HAL_FLASHEx_OB_DeSelectPCROP .......................................... |
322 |
21.3 FLASHEx Firmware driver defines ................................................ |
322 |
|
21.3.1 |
FLASHEx ........................................................................................ |
322 |
22 HAL FLASH__RAMFUNC Generic Driver................................... |
326 |
|
22.1 FLASH__RAMFUNC Firmware driver API description .................. |
326 |
|
22.1.1 |
APIs executed from Internal RAM .................................................. |
326 |
22.1.2 |
ramfunc functions ........................................................................... |
326 |
22.1.3 |
HAL_FLASHEx_StopFlashInterfaceClk ......................................... |
326 |
22.1.4 |
HAL_FLASHEx_StartFlashInterfaceClk ......................................... |
326 |
22.1.5 |
HAL_FLASHEx_EnableFlashSleepMode ...................................... |
327 |
22.1.6 |
HAL_FLASHEx_DisableFlashSleepMode...................................... |
327 |
22.2 FLASH__RAMFUNC Firmware driver defines .............................. |
327 |
|
22.2.1 |
FLASH__RAMFUNC ...................................................................... |
327 |
23 HAL FMPI2C Generic Driver ....................................................... |
328 |
|
23.1 FMPI2C Firmware driver registers structures................................ |
328 |
|
23.1.1 |
FMPI2C_InitTypeDef ...................................................................... |
328 |
23.1.2 |
FMPI2C_HandleTypeDef ............................................................... |
328 |
23.2 FMPI2C Firmware driver API description ...................................... |
329 |
|
23.2.1 |
Initialization and de-initialization functions ..................................... |
329 |
23.2.2 |
IO operation functions .................................................................... |
330 |
23.2.3 |
Peripheral State and Errors functions ............................................ |
331 |
23.2.4 |
HAL_FMPI2C_Init........................................................................... |
331 |
23.2.5 |
HAL_FMPI2C_DeInit ...................................................................... |
331 |
23.2.6 |
HAL_FMPI2C_MspInit.................................................................... |
332 |
23.2.7 |
HAL_FMPI2C_MspDeInit ............................................................... |
332 |
23.2.8 |
HAL_FMPI2C_Master_Transmit .................................................... |
332 |
23.2.9 |
HAL_FMPI2C_Master_Receive ..................................................... |
332 |
23.2.10 |
HAL_FMPI2C_Slave_Transmit ...................................................... |
333 |
23.2.11 |
HAL_FMPI2C_Slave_Receive ....................................................... |
333 |
23.2.12 |
HAL_FMPI2C_Master_Transmit_IT ............................................... |
333 |
23.2.13 |
HAL_FMPI2C_Master_Receive_IT ................................................ |
334 |
23.2.14 |
HAL_FMPI2C_Slave_Transmit_IT ................................................. |
334 |
23.2.15 |
HAL_FMPI2C_Slave_Receive_IT .................................................. |
334 |
23.2.16 |
HAL_FMPI2C_Master_Transmit_DMA .......................................... |
334 |
16/900 |
DOCID025834 Rev 2 |
|
UM1725 |
Contents |
|
23.2.17 |
HAL_FMPI2C_Master_Receive_DMA ........................................... |
335 |
|
23.2.18 |
HAL_FMPI2C_Slave_Transmit_DMA ............................................ |
335 |
|
23.2.19 |
HAL_FMPI2C_Slave_Receive_DMA ............................................. |
335 |
|
23.2.20 |
HAL_FMPI2C_Mem_Write ............................................................. |
336 |
|
23.2.21 |
HAL_FMPI2C_Mem_Read............................................................. |
336 |
|
23.2.22 |
HAL_FMPI2C_Mem_Write_IT........................................................ |
336 |
|
23.2.23 |
HAL_FMPI2C_Mem_Read_IT ....................................................... |
337 |
|
23.2.24 |
HAL_FMPI2C_Mem_Write_DMA................................................... |
337 |
|
23.2.25 |
HAL_FMPI2C_Mem_Read_DMA................................................... |
337 |
|
23.2.26 |
HAL_FMPI2C_IsDeviceReady ....................................................... |
338 |
|
23.2.27 |
HAL_FMPI2C_EV_IRQHandler ..................................................... |
338 |
|
23.2.28 |
HAL_FMPI2C_ER_IRQHandler ..................................................... |
338 |
|
23.2.29 |
HAL_FMPI2C_MasterTxCpltCallback ............................................ |
339 |
|
23.2.30 |
HAL_FMPI2C_MasterRxCpltCallback............................................ |
339 |
|
23.2.31 |
HAL_FMPI2C_SlaveTxCpltCallback .............................................. |
339 |
|
23.2.32 |
HAL_FMPI2C_SlaveRxCpltCallback.............................................. |
339 |
|
23.2.33 |
HAL_FMPI2C_MemTxCpltCallback ............................................... |
339 |
|
23.2.34 |
HAL_FMPI2C_MemRxCpltCallback............................................... |
340 |
|
23.2.35 |
HAL_FMPI2C_ErrorCallback ......................................................... |
340 |
|
23.2.36 |
HAL_FMPI2C_GetState ................................................................. |
340 |
|
23.2.37 |
HAL_FMPI2C_GetError.................................................................. |
340 |
23.3 |
FMPI2C Firmware driver defines................................................... |
341 |
|
|
23.3.1 |
FMPI2C .......................................................................................... |
341 |
24 HAL FMPI2C Extension Driver.................................................... |
347 |
||
24.1 |
FMPI2CEx Firmware driver API description .................................. |
347 |
|
|
24.1.1 |
Extension features functions .......................................................... |
347 |
|
24.1.2 |
HAL_FMPI2CEx_AnalogFilter_Config ........................................... |
347 |
|
24.1.3 |
HAL_FMPI2CEx_DigitalFilter_Config............................................. |
347 |
|
24.1.4 |
HAL_FMPI2CEx_EnableWakeUp .................................................. |
347 |
|
24.1.5 |
HAL_FMPI2CEx_DisableWakeUp ................................................. |
348 |
|
24.1.6 |
HAL_FMPI2CEx_EnableFastModePlus......................................... |
348 |
|
24.1.7 |
HAL_FMPI2CEx_DisableFastModePlus ........................................ |
348 |
24.2 |
FMPI2CEx Firmware driver defines .............................................. |
348 |
|
|
24.2.1 |
FMPI2CEx ...................................................................................... |
348 |
25 HAL GPIO Generic Driver............................................................ |
349 |
||
25.1 |
GPIO Firmware driver registers structures .................................... |
349 |
|
|
25.1.1 |
GPIO_InitTypeDef .......................................................................... |
349 |
|
|
DOCID025834 Rev 2 |
17/900 |
Contents |
|
UM1725 |
25.2 GPIO Firmware driver API description .......................................... |
349 |
|
25.2.1 |
GPIO Peripheral features ............................................................... |
349 |
25.2.2 |
How to use this driver ..................................................................... |
350 |
25.2.3 |
Initialization and de-initialization functions ..................................... |
350 |
25.2.4 |
IO operation functions .................................................................... |
351 |
25.2.5 |
HAL_GPIO_Init ............................................................................... |
351 |
25.2.6 |
HAL_GPIO_DeInit .......................................................................... |
351 |
25.2.7 |
HAL_GPIO_ReadPin...................................................................... |
351 |
25.2.8 |
HAL_GPIO_WritePin ...................................................................... |
352 |
25.2.9 |
HAL_GPIO_TogglePin ................................................................... |
352 |
25.2.10 |
HAL_GPIO_LockPin....................................................................... |
352 |
25.2.11 |
HAL_GPIO_EXTI_IRQHandler ...................................................... |
352 |
25.2.12 |
HAL_GPIO_EXTI_Callback............................................................ |
353 |
25.3 GPIO Firmware driver defines....................................................... |
353 |
|
25.3.1 |
GPIO............................................................................................... |
353 |
26 HAL GPIO Extension Driver........................................................ |
358 |
|
26.1 GPIOEx Firmware driver defines................................................... |
358 |
|
26.1.1 |
GPIOEx .......................................................................................... |
358 |
27 HAL HASH Generic Driver .......................................................... |
359 |
|
27.1 HASH Firmware driver registers structures ................................... |
359 |
|
27.1.1 |
HASH_InitTypeDef ......................................................................... |
359 |
27.1.2 |
HASH_HandleTypeDef................................................................... |
359 |
27.2 HASH Firmware driver API description ......................................... |
360 |
|
27.2.1 |
How to use this driver ..................................................................... |
360 |
27.2.2 |
HASH processing using polling mode functions ............................ |
361 |
27.2.3 |
HASH processing using interrupt mode functions.......................... |
361 |
27.2.4 |
HASH processing using DMA mode functions ............................... |
361 |
27.2.5 |
HMAC processing using polling mode functions ............................ |
362 |
27.2.6 |
HMAC processing using DMA mode functions .............................. |
362 |
27.2.7 |
Peripheral State functions .............................................................. |
362 |
27.2.8 |
Initialization and de-initialization functions ..................................... |
362 |
27.2.9 |
HAL_HASH_MD5_Start ................................................................. |
363 |
27.2.10 |
HAL_HASH_MD5_Accumulate ...................................................... |
363 |
27.2.11 |
HAL_HASH_SHA1_Start................................................................ |
363 |
27.2.12 |
HAL_HASH_SHA1_Accumulate .................................................... |
364 |
27.2.13 |
HAL_HASH_MD5_Start_IT ............................................................ |
364 |
27.2.14 |
HAL_HASH_SHA1_Start_IT .......................................................... |
364 |
27.2.15 |
HAL_HASH_IRQHandler................................................................ |
365 |
18/900 |
DOCID025834 Rev 2 |
|
UM1725 |
Contents |
27.2.16 |
HAL_HMAC_SHA1_Start ............................................................... |
365 |
27.2.17 |
HAL_HMAC_MD5_Start................................................................. |
365 |
27.2.18 |
HAL_HASH_MD5_Start_DMA ....................................................... |
365 |
27.2.19 |
HAL_HASH_MD5_Finish ............................................................... |
366 |
27.2.20 |
HAL_HASH_SHA1_Start_DMA ..................................................... |
366 |
27.2.21 |
HAL_HASH_SHA1_Finish ............................................................. |
366 |
27.2.22 |
HAL_HASH_SHA1_Start_IT .......................................................... |
366 |
27.2.23 |
HAL_HASH_MD5_Start_IT ............................................................ |
367 |
27.2.24 |
HAL_HMAC_MD5_Start................................................................. |
367 |
27.2.25 |
HAL_HMAC_SHA1_Start ............................................................... |
367 |
27.2.26 |
HAL_HASH_SHA1_Start_DMA ..................................................... |
368 |
27.2.27 |
HAL_HASH_SHA1_Finish ............................................................. |
368 |
27.2.28 |
HAL_HASH_MD5_Start_DMA ....................................................... |
368 |
27.2.29 |
HAL_HASH_MD5_Finish ............................................................... |
369 |
27.2.30 |
HAL_HMAC_MD5_Start_DMA....................................................... |
369 |
27.2.31 |
HAL_HMAC_SHA1_Start_DMA ..................................................... |
369 |
27.2.32 |
HAL_HASH_GetState .................................................................... |
370 |
27.2.33 |
HAL_HASH_IRQHandler................................................................ |
370 |
27.2.34 |
HAL_HASH_Init.............................................................................. |
370 |
27.2.35 |
HAL_HASH_DeInit ......................................................................... |
370 |
27.2.36 |
HAL_HASH_MspInit ....................................................................... |
370 |
27.2.37 |
HAL_HASH_MspDeInit .................................................................. |
370 |
27.2.38 |
HAL_HASH_InCpltCallback ........................................................... |
371 |
27.2.39 |
HAL_HASH_ErrorCallback............................................................. |
371 |
27.2.40 |
HAL_HASH_DgstCpltCallback ....................................................... |
371 |
27.2.41 |
HAL_HASH_GetState .................................................................... |
371 |
27.2.42 |
HAL_HASH_MspInit ....................................................................... |
371 |
27.2.43 |
HAL_HASH_MspDeInit .................................................................. |
372 |
27.2.44 |
HAL_HASH_InCpltCallback ........................................................... |
372 |
27.2.45 |
HAL_HASH_DgstCpltCallback ....................................................... |
372 |
27.2.46 |
HAL_HASH_ErrorCallback............................................................. |
372 |
27.3 HASH Firmware driver defines...................................................... |
373 |
|
27.3.1 |
HASH.............................................................................................. |
373 |
28 HAL HASH Extension Driver....................................................... |
376 |
|
28.1 HASHEx Firmware driver API description ..................................... |
376 |
|
28.1.1 |
How to use this driver ..................................................................... |
376 |
28.1.2 |
HASH processing using polling mode functions ............................ |
377 |
28.1.3 |
HMAC processing using polling mode functions ............................ |
377 |
|
DOCID025834 Rev 2 |
19/900 |
Contents |
|
|
UM1725 |
|
28.1.4 |
HASH processing using interrupt functions |
.................................... 377 |
|
28.1.5 |
HASH processing using DMA functions ......................................... |
377 |
|
28.1.6 |
HMAC processing using DMA functions ........................................ |
378 |
|
28.1.7 |
HAL_HASHEx_SHA224_Start ....................................................... |
378 |
|
28.1.8 |
HAL_HASHEx_SHA256_Start ....................................................... |
378 |
|
28.1.9 |
HAL_HASHEx_SHA224_Accumulate ............................................ |
378 |
|
28.1.10 |
HAL_HASHEx_SHA256_Accumulate ............................................ |
379 |
|
28.1.11 |
HAL_HMACEx_SHA224_Start....................................................... |
379 |
|
28.1.12 |
HAL_HMACEx_SHA256_Start....................................................... |
379 |
|
28.1.13 |
HAL_HASHEx_SHA224_Start_IT .................................................. |
380 |
|
28.1.14 |
HAL_HASHEx_SHA256_Start_IT .................................................. |
380 |
|
28.1.15 |
HAL_HASHEx_IRQHandler ........................................................... |
380 |
|
28.1.16 |
HAL_HASHEx_SHA224_Start_DMA ............................................. |
381 |
|
28.1.17 |
HAL_HASHEx_SHA224_Finish ..................................................... |
381 |
|
28.1.18 |
HAL_HASHEx_SHA256_Start_DMA ............................................. |
381 |
|
28.1.19 |
HAL_HASHEx_SHA256_Finish ..................................................... |
381 |
|
28.1.20 |
HAL_HMACEx_SHA224_Start_DMA............................................. |
382 |
|
28.1.21 |
HAL_HMACEx_SHA256_Start_DMA............................................. |
382 |
|
28.1.22 |
HAL_HASHEx_SHA224_Start ....................................................... |
382 |
|
28.1.23 |
HAL_HASHEx_SHA256_Start ....................................................... |
383 |
|
28.1.24 |
HAL_HASHEx_SHA224_Accumulate ............................................ |
383 |
|
28.1.25 |
HAL_HASHEx_SHA256_Accumulate ............................................ |
383 |
|
28.1.26 |
HAL_HMACEx_SHA224_Start....................................................... |
383 |
|
28.1.27 |
HAL_HMACEx_SHA256_Start....................................................... |
384 |
|
28.1.28 |
HAL_HASHEx_SHA224_Start_IT .................................................. |
384 |
|
28.1.29 |
HAL_HASHEx_SHA256_Start_IT .................................................. |
384 |
|
28.1.30 |
HAL_HASHEx_SHA224_Start_DMA ............................................. |
385 |
|
28.1.31 |
HAL_HASHEx_SHA224_Finish ..................................................... |
385 |
|
28.1.32 |
HAL_HASHEx_SHA256_Start_DMA ............................................. |
385 |
|
28.1.33 |
HAL_HASHEx_SHA256_Finish ..................................................... |
386 |
|
28.1.34 |
HAL_HMACEx_SHA224_Start_DMA............................................. |
386 |
|
28.1.35 |
HAL_HMACEx_SHA256_Start_DMA............................................. |
386 |
|
28.1.36 |
HAL_HASHEx_IRQHandler ........................................................... |
387 |
28.2 |
HASHEx Firmware driver defines.................................................. |
387 |
|
|
28.2.1 |
HASHEx ......................................................................................... |
387 |
29 HAL HCD Generic Driver............................................................. |
388 |
||
29.1 |
HCD Firmware driver registers structures ..................................... |
388 |
|
|
29.1.1 |
HCD_HandleTypeDef..................................................................... |
388 |
20/900 |
|
DOCID025834 Rev 2 |
|
UM1725 |
Contents |
29.2 HCD Firmware driver API description ........................................... |
388 |
|
29.2.1 |
How to use this driver ..................................................................... |
388 |
29.2.2 |
Initialization and de-initialization functions ..................................... |
389 |
29.2.3 |
IO operation functions .................................................................... |
389 |
29.2.4 |
Peripheral Control functions ........................................................... |
389 |
29.2.5 |
Peripheral State functions .............................................................. |
389 |
29.2.6 |
HAL_HCD_Init ................................................................................ |
389 |
29.2.7 |
HAL_HCD_HC_Init......................................................................... |
390 |
29.2.8 |
HAL_HCD_HC_Halt ....................................................................... |
390 |
29.2.9 |
HAL_HCD_DeInit ........................................................................... |
390 |
29.2.10 |
HAL_HCD_MspInit ......................................................................... |
390 |
29.2.11 |
HAL_HCD_MspDeInit..................................................................... |
391 |
29.2.12 |
HAL_HCD_HC_SubmitRequest ..................................................... |
391 |
29.2.13 |
HAL_HCD_IRQHandler.................................................................. |
391 |
29.2.14 |
HAL_HCD_SOF_Callback ............................................................. |
391 |
29.2.15 |
HAL_HCD_Connect_Callback ....................................................... |
392 |
29.2.16 |
HAL_HCD_Disconnect_Callback ................................................... |
392 |
29.2.17 |
HAL_HCD_HC_NotifyURBChange_Callback ................................ |
392 |
29.2.18 |
HAL_HCD_Start ............................................................................. |
392 |
29.2.19 |
HAL_HCD_Stop ............................................................................. |
392 |
29.2.20 |
HAL_HCD_ResetPort..................................................................... |
393 |
29.2.21 |
HAL_HCD_GetState....................................................................... |
393 |
29.2.22 |
HAL_HCD_HC_GetURBState........................................................ |
393 |
29.2.23 |
HAL_HCD_HC_GetXferCount ....................................................... |
393 |
29.2.24 |
HAL_HCD_HC_GetState ............................................................... |
393 |
29.2.25 |
HAL_HCD_GetCurrentFrame ........................................................ |
394 |
29.2.26 |
HAL_HCD_GetCurrentSpeed ........................................................ |
394 |
29.3 HCD Firmware driver defines ........................................................ |
394 |
|
29.3.1 |
HCD ................................................................................................ |
394 |
30 HAL I2C Generic Driver ............................................................... |
396 |
|
30.1 I2C Firmware driver registers structures ....................................... |
396 |
|
30.1.1 |
I2C_InitTypeDef.............................................................................. |
396 |
30.1.2 |
I2C_HandleTypeDef ....................................................................... |
396 |
30.2 I2C Firmware driver API description.............................................. |
397 |
|
30.2.1 |
How to use this driver ..................................................................... |
397 |
30.2.2 |
Initialization and de-initialization functions ..................................... |
400 |
30.2.3 |
IO operation functions .................................................................... |
400 |
30.2.4 |
Peripheral State and Errors functions ............................................ |
402 |
|
DOCID025834 Rev 2 |
21/900 |
Contents |
|
|
UM1725 |
|
30.2.5 |
HAL_I2C_Init .................................................................................. |
402 |
|
30.2.6 |
HAL_I2C_DeInit.............................................................................. |
402 |
|
30.2.7 |
HAL_I2C_MspInit ........................................................................... |
402 |
|
30.2.8 |
HAL_I2C_MspDeInit....................................................................... |
402 |
|
30.2.9 |
HAL_I2C_Master_Transmit............................................................ |
403 |
|
30.2.10 |
HAL_I2C_Master_Receive ............................................................. |
403 |
|
30.2.11 |
HAL_I2C_Slave_Transmit .............................................................. |
403 |
|
30.2.12 |
HAL_I2C_Slave_Receive ............................................................... |
404 |
|
30.2.13 |
HAL_I2C_Master_Transmit_IT....................................................... |
404 |
|
30.2.14 |
HAL_I2C_Master_Receive_IT........................................................ |
404 |
|
30.2.15 |
HAL_I2C_Slave_Transmit_IT......................................................... |
404 |
|
30.2.16 |
HAL_I2C_Slave_Receive_IT.......................................................... |
405 |
|
30.2.17 |
HAL_I2C_Master_Transmit_DMA.................................................. |
405 |
|
30.2.18 |
HAL_I2C_Master_Receive_DMA................................................... |
405 |
|
30.2.19 |
HAL_I2C_Slave_Transmit_DMA .................................................... |
405 |
|
30.2.20 |
HAL_I2C_Slave_Receive_DMA ..................................................... |
406 |
|
30.2.21 |
HAL_I2C_Mem_Write..................................................................... |
406 |
|
30.2.22 |
HAL_I2C_Mem_Read .................................................................... |
406 |
|
30.2.23 |
HAL_I2C_Mem_Write_IT ............................................................... |
407 |
|
30.2.24 |
HAL_I2C_Mem_Read_IT ............................................................... |
407 |
|
30.2.25 |
HAL_I2C_Mem_Write_DMA .......................................................... |
407 |
|
30.2.26 |
HAL_I2C_Mem_Read_DMA .......................................................... |
408 |
|
30.2.27 |
HAL_I2C_IsDeviceReady............................................................... |
408 |
|
30.2.28 |
HAL_I2C_EV_IRQHandler ............................................................. |
408 |
|
30.2.29 |
HAL_I2C_ER_IRQHandler ............................................................. |
409 |
|
30.2.30 |
HAL_I2C_MasterTxCpltCallback.................................................... |
409 |
|
30.2.31 |
HAL_I2C_MasterRxCpltCallback ................................................... |
409 |
|
30.2.32 |
HAL_I2C_SlaveTxCpltCallback...................................................... |
409 |
|
30.2.33 |
HAL_I2C_SlaveRxCpltCallback ..................................................... |
409 |
|
30.2.34 |
HAL_I2C_MemTxCpltCallback....................................................... |
409 |
|
30.2.35 |
HAL_I2C_MemRxCpltCallback ...................................................... |
410 |
|
30.2.36 |
HAL_I2C_ErrorCallback ................................................................. |
410 |
|
30.2.37 |
HAL_I2C_GetState......................................................................... |
410 |
|
30.2.38 |
HAL_I2C_GetError ......................................................................... |
410 |
30.3 |
I2C Firmware driver defines .......................................................... |
410 |
|
|
30.3.1 |
I2C .................................................................................................. |
410 |
31 HAL I2C Extension Driver ........................................................... |
417 |
||
31.1 |
I2CEx Firmware driver API description ......................................... |
417 |
|
22/900 |
|
DOCID025834 Rev 2 |
|
UM1725 |
Contents |
|
31.1.1 |
I2C peripheral extension features .................................................. |
417 |
|
31.1.2 |
How to use this driver ..................................................................... |
417 |
|
31.1.3 |
Extension features functions .......................................................... |
417 |
|
31.1.4 |
HAL_I2CEx_ConfigAnalogFilter ..................................................... |
417 |
|
31.1.5 |
HAL_I2CEx_ConfigDigitalFilter ...................................................... |
417 |
31.2 |
I2CEx Firmware driver defines ...................................................... |
418 |
|
|
31.2.1 |
I2CEx .............................................................................................. |
418 |
32 HAL I2S Generic Driver ............................................................... |
419 |
||
32.1 |
I2S Firmware driver registers structures ....................................... |
419 |
|
|
32.1.1 |
I2S_InitTypeDef .............................................................................. |
419 |
|
32.1.2 |
I2S_HandleTypeDef ....................................................................... |
419 |
32.2 |
I2S Firmware driver API description.............................................. |
420 |
|
|
32.2.1 |
How to use this driver ..................................................................... |
420 |
|
32.2.2 |
Initialization and de-initialization functions ..................................... |
422 |
|
32.2.3 |
IO operation functions .................................................................... |
422 |
|
32.2.4 |
Peripheral State and Errors functions ............................................ |
423 |
|
32.2.5 |
HAL_I2S_Init .................................................................................. |
423 |
|
32.2.6 |
HAL_I2S_DeInit.............................................................................. |
423 |
|
32.2.7 |
HAL_I2S_MspInit............................................................................ |
424 |
|
32.2.8 |
HAL_I2S_MspDeInit ....................................................................... |
424 |
|
32.2.9 |
HAL_I2S_Transmit ......................................................................... |
424 |
|
32.2.10 |
HAL_I2S_Receive .......................................................................... |
424 |
|
32.2.11 |
HAL_I2S_Transmit_IT .................................................................... |
425 |
|
32.2.12 |
HAL_I2S_Receive_IT ..................................................................... |
425 |
|
32.2.13 |
HAL_I2S_Transmit_DMA ............................................................... |
426 |
|
32.2.14 |
HAL_I2S_Receive_DMA ................................................................ |
426 |
|
32.2.15 |
HAL_I2S_DMAPause ..................................................................... |
427 |
|
32.2.16 |
HAL_I2S_DMAResume.................................................................. |
427 |
|
32.2.17 |
HAL_I2S_DMAStop........................................................................ |
427 |
|
32.2.18 |
HAL_I2S_IRQHandler .................................................................... |
427 |
|
32.2.19 |
HAL_I2S_TxHalfCpltCallback ........................................................ |
427 |
|
32.2.20 |
HAL_I2S_TxCpltCallback ............................................................... |
428 |
|
32.2.21 |
HAL_I2S_RxHalfCpltCallback ........................................................ |
428 |
|
32.2.22 |
HAL_I2S_RxCpltCallback .............................................................. |
428 |
|
32.2.23 |
HAL_I2S_ErrorCallback ................................................................. |
428 |
|
32.2.24 |
HAL_I2S_GetState ......................................................................... |
428 |
|
32.2.25 |
HAL_I2S_GetError ......................................................................... |
428 |
|
32.2.26 |
HAL_I2S_GetState ......................................................................... |
429 |
|
|
DOCID025834 Rev 2 |
23/900 |
Contents |
|
|
UM1725 |
|
32.2.27 |
HAL_I2S_GetError ......................................................................... |
429 |
32.3 |
I2S Firmware driver defines .......................................................... |
429 |
|
|
32.3.1 |
I2S .................................................................................................. |
429 |
33 HAL I2S Extension Driver ........................................................... |
434 |
||
33.1 |
I2SEx Firmware driver API description.......................................... |
434 |
|
|
33.1.1 |
I2S Extension features ................................................................... |
434 |
|
33.1.2 |
How to use this driver ..................................................................... |
434 |
|
33.1.3 |
HAL_I2SEx_TransmitReceive ........................................................ |
435 |
|
33.1.4 |
HAL_I2SEx_TransmitReceive_IT................................................... |
435 |
|
33.1.5 |
HAL_I2SEx_TransmitReceive_DMA.............................................. |
435 |
33.2 |
I2SEx Firmware driver defines ...................................................... |
435 |
|
|
33.2.1 |
I2SEx .............................................................................................. |
435 |
34 HAL IRDA Generic Driver............................................................ |
436 |
||
34.1 |
IRDA Firmware driver registers structures .................................... |
436 |
|
|
34.1.1 |
IRDA_InitTypeDef........................................................................... |
436 |
|
34.1.2 |
IRDA_HandleTypeDef .................................................................... |
436 |
34.2 |
IRDA Firmware driver API description........................................... |
437 |
|
|
34.2.1 |
How to use this driver ..................................................................... |
437 |
|
34.2.2 |
Initialization and Configuration functions........................................ |
438 |
|
34.2.3 |
IO operation functions .................................................................... |
439 |
|
34.2.4 |
Peripheral State and Errors functions ............................................ |
440 |
|
34.2.5 |
HAL_IRDA_Init ............................................................................... |
440 |
|
34.2.6 |
HAL_IRDA_DeInit........................................................................... |
440 |
|
34.2.7 |
HAL_IRDA_MspInit ........................................................................ |
440 |
|
34.2.8 |
HAL_IRDA_MspDeInit.................................................................... |
441 |
|
34.2.9 |
HAL_IRDA_Transmit ...................................................................... |
441 |
|
34.2.10 |
HAL_IRDA_Receive ....................................................................... |
441 |
|
34.2.11 |
HAL_IRDA_Transmit_IT................................................................. |
441 |
|
34.2.12 |
HAL_IRDA_Receive_IT.................................................................. |
442 |
|
34.2.13 |
HAL_IRDA_Transmit_DMA ............................................................ |
442 |
|
34.2.14 |
HAL_IRDA_Receive_DMA ............................................................. |
442 |
|
34.2.15 |
HAL_IRDA_DMAPause.................................................................. |
443 |
|
34.2.16 |
HAL_IRDA_DMAResume............................................................... |
443 |
|
34.2.17 |
HAL_IRDA_DMAStop..................................................................... |
443 |
|
34.2.18 |
HAL_IRDA_IRQHandler ................................................................. |
443 |
|
34.2.19 |
HAL_IRDA_TxCpltCallback............................................................ |
443 |
|
34.2.20 |
HAL_IRDA_TxHalfCpltCallback ..................................................... |
444 |
|
34.2.21 |
HAL_IRDA_RxCpltCallback ........................................................... |
444 |
24/900 |
|
DOCID025834 Rev 2 |
|
UM1725 |
Contents |
34.2.22 |
HAL_IRDA_RxHalfCpltCallback ..................................................... |
444 |
34.2.23 |
HAL_IRDA_ErrorCallback .............................................................. |
444 |
34.2.24 |
HAL_IRDA_GetState...................................................................... |
444 |
34.2.25 |
HAL_IRDA_GetError ...................................................................... |
445 |
34.3 IRDA Firmware driver defines ....................................................... |
445 |
|
34.3.1 |
IRDA ............................................................................................... |
445 |
35 HAL IWDG Generic Driver........................................................... |
452 |
|
35.1 IWDG Firmware driver registers structures ................................... |
452 |
|
35.1.1 |
IWDG_InitTypeDef ......................................................................... |
452 |
35.1.2 |
IWDG_HandleTypeDef................................................................... |
452 |
35.2 IWDG Firmware driver API description ......................................... |
452 |
|
35.2.1 |
IWDG Specific features .................................................................. |
452 |
35.2.2 |
How to use this driver ..................................................................... |
453 |
35.2.3 |
Initialization and de-initialization functions ..................................... |
453 |
35.2.4 |
IO operation functions .................................................................... |
454 |
35.2.5 |
Peripheral State functions .............................................................. |
454 |
35.2.6 |
HAL_IWDG_Init .............................................................................. |
454 |
35.2.7 |
HAL_IWDG_MspInit ....................................................................... |
454 |
35.2.8 |
HAL_IWDG_Start ........................................................................... |
454 |
35.2.9 |
HAL_IWDG_Refresh ...................................................................... |
455 |
35.2.10 |
HAL_IWDG_GetState..................................................................... |
455 |
35.3 IWDG Firmware driver defines ...................................................... |
455 |
|
35.3.1 |
IWDG .............................................................................................. |
455 |
36 HAL LTDC Generic Driver ........................................................... |
458 |
|
36.1 LTDC Firmware driver registers structures.................................... |
458 |
|
36.1.1 |
LTDC_ColorTypeDef ...................................................................... |
458 |
36.1.2 |
LTDC_InitTypeDef.......................................................................... |
458 |
36.1.3 |
LTDC_LayerCfgTypeDef ................................................................ |
459 |
36.1.4 |
LTDC_HandleTypeDef ................................................................... |
460 |
36.2 LTDC Firmware driver API description .......................................... |
461 |
|
36.2.1 |
How to use this driver ..................................................................... |
461 |
36.2.2 |
Initialization and Configuration functions........................................ |
462 |
36.2.3 |
IO operation functions .................................................................... |
462 |
36.2.4 |
Peripheral Control functions ........................................................... |
462 |
36.2.5 |
Peripheral State and Errors functions ............................................ |
463 |
36.2.6 |
HAL_LTDC_Init .............................................................................. |
463 |
36.2.7 |
HAL_LTDC_DeInit.......................................................................... |
463 |
|
DOCID025834 Rev 2 |
25/900 |
Contents |
|
|
UM1725 |
|
36.2.8 |
HAL_LTDC_MspInit........................................................................ |
463 |
|
36.2.9 |
HAL_LTDC_MspDeInit ................................................................... |
464 |
|
36.2.10 |
HAL_LTDC_ErrorCallback ............................................................. |
464 |
|
36.2.11 |
HAL_LTDC_LineEvenCallback ...................................................... |
464 |
|
36.2.12 |
HAL_LTDC_IRQHandler ................................................................ |
464 |
|
36.2.13 |
HAL_LTDC_ErrorCallback ............................................................. |
464 |
|
36.2.14 |
HAL_LTDC_LineEvenCallback ...................................................... |
464 |
|
36.2.15 |
HAL_LTDC_ConfigLayer................................................................ |
465 |
|
36.2.16 |
HAL_LTDC_ConfigColorKeying ..................................................... |
465 |
|
36.2.17 |
HAL_LTDC_ConfigCLUT ............................................................... |
465 |
|
36.2.18 |
HAL_LTDC_EnableColorKeying .................................................... |
466 |
|
36.2.19 |
HAL_LTDC_DisableColorKeying ................................................... |
466 |
|
36.2.20 |
HAL_LTDC_EnableCLUT .............................................................. |
466 |
|
36.2.21 |
HAL_LTDC_DisableCLUT.............................................................. |
466 |
|
36.2.22 |
HAL_LTDC_EnableDither .............................................................. |
466 |
|
36.2.23 |
HAL_LTDC_DisableDither ............................................................. |
467 |
|
36.2.24 |
HAL_LTDC_SetWindowSize .......................................................... |
467 |
|
36.2.25 |
HAL_LTDC_SetWindowPosition .................................................... |
467 |
|
36.2.26 |
HAL_LTDC_SetPixelFormat .......................................................... |
467 |
|
36.2.27 |
HAL_LTDC_SetAlpha..................................................................... |
468 |
|
36.2.28 |
HAL_LTDC_SetAddress................................................................. |
468 |
|
36.2.29 |
HAL_LTDC_ProgramLineEvent ..................................................... |
468 |
|
36.2.30 |
HAL_LTDC_GetState ..................................................................... |
468 |
|
36.2.31 |
HAL_LTDC_GetError ..................................................................... |
469 |
36.3 |
LTDC Firmware driver defines ...................................................... |
469 |
|
|
36.3.1 |
LTDC .............................................................................................. |
469 |
37 HAL NAND Generic Driver .......................................................... |
475 |
||
37.1 |
NAND Firmware driver registers structures................................... |
475 |
|
|
37.1.1 |
NAND_IDTypeDef .......................................................................... |
475 |
|
37.1.2 |
NAND_AddressTypeDef................................................................. |
475 |
|
37.1.3 |
NAND_InfoTypeDef........................................................................ |
475 |
|
37.1.4 |
NAND_HandleTypeDef .................................................................. |
476 |
37.2 |
NAND Firmware driver API description ......................................... |
476 |
|
|
37.2.1 |
How to use this driver ..................................................................... |
476 |
|
37.2.2 |
NAND Initialization and de-initialization functions .......................... |
477 |
|
37.2.3 |
NAND Input and Output functions .................................................. |
477 |
|
37.2.4 |
NAND Control functions ................................................................. |
478 |
|
37.2.5 |
NAND State functions..................................................................... |
478 |
26/900 |
|
DOCID025834 Rev 2 |
|
UM1725 |
Contents |
37.2.6 |
HAL_NAND_Init.............................................................................. |
478 |
37.2.7 |
HAL_NAND_DeInit ......................................................................... |
478 |
37.2.8 |
HAL_NAND_MspInit....................................................................... |
478 |
37.2.9 |
HAL_NAND_MspDeInit .................................................................. |
479 |
37.2.10 |
HAL_NAND_IRQHandler ............................................................... |
479 |
37.2.11 |
HAL_NAND_ITCallback ................................................................. |
479 |
37.2.12 |
HAL_NAND_Read_ID .................................................................... |
479 |
37.2.13 |
HAL_NAND_Reset ......................................................................... |
479 |
37.2.14 |
HAL_NAND_Read_Page ............................................................... |
479 |
37.2.15 |
HAL_NAND_Write_Page................................................................ |
480 |
37.2.16 |
HAL_NAND_Read_SpareArea ...................................................... |
480 |
37.2.17 |
HAL_NAND_Write_SpareArea....................................................... |
480 |
37.2.18 |
HAL_NAND_Erase_Block .............................................................. |
481 |
37.2.19 |
HAL_NAND_Read_Status ............................................................. |
481 |
37.2.20 |
HAL_NAND_Address_Inc .............................................................. |
481 |
37.2.21 |
HAL_NAND_ECC_Enable ............................................................. |
481 |
37.2.22 |
HAL_NAND_ECC_Disable............................................................. |
481 |
37.2.23 |
HAL_NAND_GetECC ..................................................................... |
482 |
37.2.24 |
HAL_NAND_GetState .................................................................... |
482 |
37.2.25 |
HAL_NAND_Read_Status ............................................................. |
482 |
37.3 NAND Firmware driver defines...................................................... |
482 |
|
37.3.1 |
NAND.............................................................................................. |
482 |
38 HAL NOR Generic Driver............................................................. |
485 |
|
38.1 NOR Firmware driver registers structures..................................... |
485 |
|
38.1.1 |
NOR_IDTypeDef ............................................................................ |
485 |
38.1.2 |
NOR_CFITypeDef .......................................................................... |
485 |
38.1.3 |
NOR_HandleTypeDef..................................................................... |
485 |
38.2 NOR Firmware driver API description ........................................... |
486 |
|
38.2.1 |
How to use this driver ..................................................................... |
486 |
38.2.2 |
NOR Initialization and de_initialization functions ........................... |
487 |
38.2.3 |
NOR Input and Output functions .................................................... |
487 |
38.2.4 |
NOR Control functions.................................................................... |
487 |
38.2.5 |
NOR State functions....................................................................... |
487 |
38.2.6 |
HAL_NOR_Init ................................................................................ |
487 |
38.2.7 |
HAL_NOR_DeInit ........................................................................... |
488 |
38.2.8 |
HAL_NOR_MspInit ......................................................................... |
488 |
38.2.9 |
HAL_NOR_MspDeInit .................................................................... |
488 |
38.2.10 |
HAL_NOR_MspWait....................................................................... |
488 |
|
DOCID025834 Rev 2 |
27/900 |
Contents |
|
UM1725 |
38.2.11 |
HAL_NOR_Read_ID ...................................................................... |
488 |
38.2.12 |
HAL_NOR_ReturnToReadMode .................................................... |
489 |
38.2.13 |
HAL_NOR_Read ............................................................................ |
489 |
38.2.14 |
HAL_NOR_Program....................................................................... |
489 |
38.2.15 |
HAL_NOR_ReadBuffer .................................................................. |
489 |
38.2.16 |
HAL_NOR_ProgramBuffer ............................................................. |
489 |
38.2.17 |
HAL_NOR_Erase_Block ................................................................ |
490 |
38.2.18 |
HAL_NOR_Erase_Chip.................................................................. |
490 |
38.2.19 |
HAL_NOR_Read_CFI .................................................................... |
490 |
38.2.20 |
HAL_NOR_WriteOperation_Enable ............................................... |
490 |
38.2.21 |
HAL_NOR_WriteOperation_Disable .............................................. |
491 |
38.2.22 |
HAL_NOR_GetState ...................................................................... |
491 |
38.2.23 |
HAL_NOR_GetStatus..................................................................... |
491 |
38.3 NOR Firmware driver defines........................................................ |
491 |
|
38.3.1 |
NOR................................................................................................ |
491 |
39 HAL PCCARD Generic Driver ..................................................... |
494 |
|
39.1 PCCARD Firmware driver registers structures.............................. |
494 |
|
39.1.1 |
PCCARD_HandleTypeDef ............................................................. |
494 |
39.2 PCCARD Firmware driver API description .................................... |
494 |
|
39.2.1 |
How to use this driver ..................................................................... |
494 |
39.2.2 |
PCCARD Initialization and de-initialization functions ..................... |
495 |
39.2.3 |
PCCARD Input and Output functions ............................................. |
495 |
39.2.4 |
PCCARD State functions................................................................ |
495 |
39.2.5 |
HAL_PCCARD_Init......................................................................... |
495 |
39.2.6 |
HAL_PCCARD_DeInit .................................................................... |
496 |
39.2.7 |
HAL_PCCARD_MspInit.................................................................. |
496 |
39.2.8 |
HAL_PCCARD_MspDeInit ............................................................. |
496 |
39.2.9 |
HAL_PCCARD_Read_ID ............................................................... |
496 |
39.2.10 |
HAL_PCCARD_Read_Sector ........................................................ |
496 |
39.2.11 |
HAL_PCCARD_Write_Sector ........................................................ |
497 |
39.2.12 |
HAL_PCCARD_Erase_Sector ....................................................... |
497 |
39.2.13 |
HAL_PCCARD_Reset .................................................................... |
497 |
39.2.14 |
HAL_PCCARD_IRQHandler .......................................................... |
497 |
39.2.15 |
HAL_PCCARD_ITCallback ............................................................ |
498 |
39.2.16 |
HAL_PCCARD_GetState ............................................................... |
498 |
39.2.17 |
HAL_PCCARD_GetStatus ............................................................. |
498 |
39.2.18 |
HAL_PCCARD_ReadStatus .......................................................... |
498 |
39.3 PCCARD Firmware driver defines................................................. |
499 |
|
28/900 |
DOCID025834 Rev 2 |
|
UM1725 |
Contents |
39.3.1 |
PCCARD ........................................................................................ |
499 |
40 HAL PCD Generic Driver ............................................................. |
501 |
|
40.1 PCD Firmware driver registers structures ..................................... |
501 |
|
40.1.1 |
PCD_HandleTypeDef ..................................................................... |
501 |
40.2 PCD Firmware driver API description............................................ |
501 |
|
40.2.1 |
How to use this driver ..................................................................... |
501 |
40.2.2 |
Initialization and de-initialization functions ..................................... |
502 |
40.2.3 |
IO operation functions .................................................................... |
502 |
40.2.4 |
Peripheral Control functions ........................................................... |
502 |
40.2.5 |
Peripheral State functions .............................................................. |
503 |
40.2.6 |
HAL_PCD_Init ................................................................................ |
503 |
40.2.7 |
HAL_PCD_DeInit............................................................................ |
503 |
40.2.8 |
HAL_PCD_MspInit ......................................................................... |
503 |
40.2.9 |
HAL_PCD_MspDeInit..................................................................... |
503 |
40.2.10 |
HAL_PCD_Start ............................................................................. |
503 |
40.2.11 |
HAL_PCD_Stop.............................................................................. |
504 |
40.2.12 |
HAL_PCD_IRQHandler .................................................................. |
504 |
40.2.13 |
HAL_PCD_DataOutStageCallback ................................................ |
504 |
40.2.14 |
HAL_PCD_DataInStageCallback ................................................... |
504 |
40.2.15 |
HAL_PCD_SetupStageCallback .................................................... |
504 |
40.2.16 |
HAL_PCD_SOFCallback................................................................ |
504 |
40.2.17 |
HAL_PCD_ResetCallback.............................................................. |
505 |
40.2.18 |
HAL_PCD_SuspendCallback ......................................................... |
505 |
40.2.19 |
HAL_PCD_ResumeCallback.......................................................... |
505 |
40.2.20 |
HAL_PCD_ISOOUTIncompleteCallback........................................ |
505 |
40.2.21 |
HAL_PCD_ISOINIncompleteCallback............................................ |
505 |
40.2.22 |
HAL_PCD_ConnectCallback.......................................................... |
506 |
40.2.23 |
HAL_PCD_DisconnectCallback ..................................................... |
506 |
40.2.24 |
HAL_PCD_DevConnect ................................................................. |
506 |
40.2.25 |
HAL_PCD_DevDisconnect............................................................. |
506 |
40.2.26 |
HAL_PCD_SetAddress .................................................................. |
506 |
40.2.27 |
HAL_PCD_EP_Open ..................................................................... |
506 |
40.2.28 |
HAL_PCD_EP_Close ..................................................................... |
507 |
40.2.29 |
HAL_PCD_EP_Receive ................................................................. |
507 |
40.2.30 |
HAL_PCD_EP_GetRxCount .......................................................... |
507 |
40.2.31 |
HAL_PCD_EP_Transmit ................................................................ |
507 |
40.2.32 |
HAL_PCD_EP_SetStall.................................................................. |
508 |
40.2.33 |
HAL_PCD_EP_ClrStall................................................................... |
508 |
|
DOCID025834 Rev 2 |
29/900 |
Contents |
|
UM1725 |
40.2.34 |
HAL_PCD_EP_Flush ..................................................................... |
508 |
40.2.35 |
HAL_PCD_ActivateRemoteWakeup .............................................. |
508 |
40.2.36 |
HAL_PCD_DeActivateRemoteWakeup.......................................... |
508 |
40.2.37 |
HAL_PCD_GetState....................................................................... |
509 |
40.3 PCD Firmware driver defines ........................................................ |
509 |
|
40.3.1 |
PCD ................................................................................................ |
509 |
41 HAL PCD Extension Driver ......................................................... |
511 |
|
41.1 PCDEx Firmware driver API description ....................................... |
511 |
|
41.1.1 |
Extended features functions ........................................................... |
511 |
41.1.2 |
HAL_PCDEx_SetTxFiFo ................................................................ |
511 |
41.1.3 |
HAL_PCDEx_SetRxFiFo................................................................ |
511 |
41.1.4 |
HAL_PCDEx_ActivateLPM ............................................................ |
511 |
41.1.5 |
HAL_PCDEx_DeActivateLPM ........................................................ |
511 |
41.1.6 |
HAL_PCDEx_LPM_Callback ......................................................... |
512 |
41.2 PCDEx Firmware driver defines .................................................... |
512 |
|
41.2.1 |
PCDEx ............................................................................................ |
512 |
42 HAL PWR Generic Driver ............................................................ |
513 |
|
42.1 PWR Firmware driver registers structures .................................... |
513 |
|
42.1.1 |
PWR_PVDTypeDef ........................................................................ |
513 |
42.2 PWR Firmware driver API description........................................... |
513 |
|
42.2.1 |
Initialization and de-initialization functions ..................................... |
513 |
42.2.2 |
Peripheral Control functions ........................................................... |
513 |
42.2.3 |
HAL_PWR_DeInit........................................................................... |
515 |
42.2.4 |
HAL_PWR_EnableBkUpAccess .................................................... |
515 |
42.2.5 |
HAL_PWR_DisableBkUpAccess.................................................... |
516 |
42.2.6 |
HAL_PWR_ConfigPVD .................................................................. |
516 |
42.2.7 |
HAL_PWR_EnablePVD.................................................................. |
516 |
42.2.8 |
HAL_PWR_DisablePVD................................................................. |
516 |
42.2.9 |
HAL_PWR_EnableWakeUpPin...................................................... |
516 |
42.2.10 |
HAL_PWR_DisableWakeUpPin ..................................................... |
516 |
42.2.11 |
HAL_PWR_EnterSLEEPMode ....................................................... |
517 |
42.2.12 |
HAL_PWR_EnterSTOPMode......................................................... |
517 |
42.2.13 |
HAL_PWR_EnterSTANDBYMode ................................................. |
518 |
42.2.14 |
HAL_PWR_PVD_IRQHandler........................................................ |
518 |
42.2.15 |
HAL_PWR_PVDCallback ............................................................... |
518 |
42.2.16 |
HAL_PWR_EnableSleepOnExit ..................................................... |
518 |
42.2.17 |
HAL_PWR_DisableSleepOnExit .................................................... |
518 |
42.2.18 |
HAL_PWR_EnableSEVOnPend .................................................... |
519 |
30/900 |
DOCID025834 Rev 2 |
|
UM1725 |
Contents |
42.2.19 |
HAL_PWR_DisableSEVOnPend.................................................... |
519 |
42.3 PWR Firmware driver defines ....................................................... |
519 |
|
42.3.1 |
PWR ............................................................................................... |
519 |
43 HAL PWR Extension Driver ........................................................ |
525 |
|
43.1 PWREx Firmware driver API description....................................... |
525 |
|
43.1.1 |
Peripheral extended features functions.......................................... |
525 |
43.1.2 |
HAL_PWREx_EnableBkUpReg ..................................................... |
526 |
43.1.3 |
HAL_PWREx_DisableBkUpReg .................................................... |
526 |
43.1.4 |
HAL_PWREx_EnableFlashPowerDown ........................................ |
526 |
43.1.5 |
HAL_PWREx_DisableFlashPowerDown........................................ |
526 |
43.1.6 |
HAL_PWREx_GetVoltageRange ................................................... |
526 |
43.1.7 |
HAL_PWREx_ControlVoltageScaling ............................................ |
527 |
43.1.8 |
HAL_PWREx_EnableOverDrive .................................................... |
527 |
43.1.9 |
HAL_PWREx_DisableOverDrive.................................................... |
528 |
43.1.10 |
HAL_PWREx_EnterUnderDriveSTOPMode .................................. |
528 |
43.2 PWREx Firmware driver defines ................................................... |
529 |
|
43.2.1 |
PWREx ........................................................................................... |
529 |
44 HAL QSPI Generic Driver ............................................................ |
532 |
|
44.1 QSPI Firmware driver registers structures .................................... |
532 |
|
44.1.1 |
QSPI_InitTypeDef........................................................................... |
532 |
44.1.2 |
QSPI_HandleTypeDef .................................................................... |
532 |
44.1.3 |
QSPI_CommandTypeDef............................................................... |
533 |
44.1.4 |
QSPI_AutoPollingTypeDef ............................................................. |
534 |
44.1.5 |
QSPI_MemoryMappedTypeDef ..................................................... |
534 |
44.2 QSPI Firmware driver API description........................................... |
534 |
|
44.2.1 |
Initialization and Configuration functions........................................ |
534 |
44.2.2 |
IO operation functions .................................................................... |
535 |
44.2.3 |
Peripheral Control and State functions........................................... |
535 |
44.2.4 |
HAL_QSPI_Init ............................................................................... |
536 |
44.2.5 |
HAL_QSPI_DeInit........................................................................... |
536 |
44.2.6 |
HAL_QSPI_MspInit ........................................................................ |
536 |
44.2.7 |
HAL_QSPI_MspDeInit.................................................................... |
536 |
44.2.8 |
HAL_QSPI_IRQHandler ................................................................. |
536 |
44.2.9 |
HAL_QSPI_Command ................................................................... |
536 |
44.2.10 |
HAL_QSPI_Command_IT .............................................................. |
537 |
44.2.11 |
HAL_QSPI_Transmit ...................................................................... |
537 |
44.2.12 |
HAL_QSPI_Receive ....................................................................... |
537 |
|
DOCID025834 Rev 2 |
31/900 |
Contents |
|
|
UM1725 |
|
44.2.13 |
HAL_QSPI_Transmit_IT................................................................. |
537 |
|
44.2.14 |
HAL_QSPI_Receive_IT.................................................................. |
538 |
|
44.2.15 |
HAL_QSPI_Transmit_DMA ............................................................ |
538 |
|
44.2.16 |
HAL_QSPI_Receive_DMA ............................................................. |
538 |
|
44.2.17 |
HAL_QSPI_AutoPolling.................................................................. |
538 |
|
44.2.18 |
HAL_QSPI_AutoPolling_IT ............................................................ |
539 |
|
44.2.19 |
HAL_QSPI_MemoryMapped .......................................................... |
539 |
|
44.2.20 |
HAL_QSPI_ErrorCallback .............................................................. |
539 |
|
44.2.21 |
HAL_QSPI_CmdCpltCallback ........................................................ |
539 |
|
44.2.22 |
HAL_QSPI_RxCpltCallback ........................................................... |
540 |
|
44.2.23 |
HAL_QSPI_TxCpltCallback............................................................ |
540 |
|
44.2.24 |
HAL_QSPI_RxHalfCpltCallback ..................................................... |
540 |
|
44.2.25 |
HAL_QSPI_TxHalfCpltCallback ..................................................... |
540 |
|
44.2.26 |
HAL_QSPI_FifoThresholdCallback ................................................ |
540 |
|
44.2.27 |
HAL_QSPI_StatusMatchCallback .................................................. |
540 |
|
44.2.28 |
HAL_QSPI_TimeOutCallback ........................................................ |
541 |
|
44.2.29 |
HAL_QSPI_GetState...................................................................... |
541 |
|
44.2.30 |
HAL_QSPI_GetError ...................................................................... |
541 |
|
44.2.31 |
HAL_QSPI_Abort ........................................................................... |
541 |
|
44.2.32 |
HAL_QSPI_SetTimeout.................................................................. |
541 |
|
44.2.33 |
HAL_QSPI_ErrorCallback .............................................................. |
542 |
|
44.2.34 |
HAL_QSPI_FifoThresholdCallback ................................................ |
542 |
|
44.2.35 |
HAL_QSPI_CmdCpltCallback ........................................................ |
542 |
|
44.2.36 |
HAL_QSPI_RxCpltCallback ........................................................... |
542 |
|
44.2.37 |
HAL_QSPI_TxCpltCallback............................................................ |
542 |
|
44.2.38 |
HAL_QSPI_RxHalfCpltCallback ..................................................... |
542 |
|
44.2.39 |
HAL_QSPI_TxHalfCpltCallback ..................................................... |
543 |
|
44.2.40 |
HAL_QSPI_StatusMatchCallback .................................................. |
543 |
|
44.2.41 |
HAL_QSPI_TimeOutCallback ........................................................ |
543 |
|
44.2.42 |
HAL_QSPI_GetState...................................................................... |
543 |
|
44.2.43 |
HAL_QSPI_GetError ...................................................................... |
543 |
|
44.2.44 |
HAL_QSPI_Abort ........................................................................... |
543 |
|
44.2.45 |
HAL_QSPI_SetTimeout.................................................................. |
544 |
44.3 |
QSPI Firmware driver defines ....................................................... |
544 |
|
|
44.3.1 |
QSPI ............................................................................................... |
544 |
45 HAL RCC Generic Driver............................................................. |
551 |
||
45.1 |
RCC Firmware driver registers structures ..................................... |
551 |
|
|
45.1.1 |
RCC_OscInitTypeDef ..................................................................... |
551 |
32/900 |
|
DOCID025834 Rev 2 |
|
UM1725 |
Contents |
45.1.2 |
RCC_ClkInitTypeDef ...................................................................... |
551 |
45.2 RCC Firmware driver API description ........................................... |
552 |
|
45.2.1 |
RCC specific features..................................................................... |
552 |
45.2.2 |
RCC Limitations.............................................................................. |
552 |
45.2.3 |
Initialization and de-initialization functions ..................................... |
553 |
45.2.4 |
Peripheral Control functions ........................................................... |
554 |
45.2.5 |
HAL_RCC_DeInit ........................................................................... |
554 |
45.2.6 |
HAL_RCC_OscConfig .................................................................... |
554 |
45.2.7 |
HAL_RCC_ClockConfig ................................................................. |
555 |
45.2.8 |
HAL_RCC_MCOConfig .................................................................. |
555 |
45.2.9 |
HAL_RCC_EnableCSS .................................................................. |
556 |
45.2.10 |
HAL_RCC_DisableCSS ................................................................. |
556 |
45.2.11 |
HAL_RCC_GetSysClockFreq ........................................................ |
556 |
45.2.12 |
HAL_RCC_GetHCLKFreq .............................................................. |
557 |
45.2.13 |
HAL_RCC_GetPCLK1Freq ............................................................ |
557 |
45.2.14 |
HAL_RCC_GetPCLK2Freq ............................................................ |
557 |
45.2.15 |
HAL_RCC_GetOscConfig .............................................................. |
557 |
45.2.16 |
HAL_RCC_GetClockConfig ........................................................... |
558 |
45.2.17 |
HAL_RCC_NMI_IRQHandler ......................................................... |
558 |
45.2.18 |
HAL_RCC_CSSCallback................................................................ |
558 |
45.3 RCC Firmware driver defines ........................................................ |
558 |
|
45.3.1 |
RCC ................................................................................................ |
558 |
46 HAL RCC Extension Driver ......................................................... |
579 |
|
46.1 RCCEx Firmware driver registers structures ................................. |
579 |
|
46.1.1 |
RCC_PLLInitTypeDef ..................................................................... |
579 |
46.1.2 |
RCC_PLLI2SInitTypeDef................................................................ |
579 |
46.1.3 |
RCC_PLLSAIInitTypeDef ............................................................... |
580 |
46.1.4 |
RCC_PeriphCLKInitTypeDef .......................................................... |
580 |
46.2 RCCEx Firmware driver API description ....................................... |
582 |
|
46.2.1 |
Extended Peripheral Control functions........................................... |
582 |
46.2.2 |
HAL_RCCEx_PeriphCLKConfig..................................................... |
582 |
46.2.3 |
HAL_RCCEx_GetPeriphCLKConfig ............................................... |
583 |
46.2.4 |
HAL_RCCEx_GetPeriphCLKFreq .................................................. |
583 |
46.2.5 |
HAL_RCCEx_SelectLSEMode....................................................... |
583 |
46.2.6 |
HAL_RCC_OscConfig .................................................................... |
583 |
46.2.7 |
HAL_RCC_GetOscConfig .............................................................. |
584 |
46.2.8 |
HAL_RCC_GetSysClockFreq ........................................................ |
584 |
|
DOCID025834 Rev 2 |
33/900 |
Contents |
|
UM1725 |
46.3 RCCEx Firmware driver defines.................................................... |
585 |
|
46.3.1 |
RCCEx............................................................................................ |
585 |
47 HAL RNG Generic Driver............................................................. |
606 |
|
47.1 RNG Firmware driver registers structures ..................................... |
606 |
|
47.1.1 |
RNG_HandleTypeDef..................................................................... |
606 |
47.2 RNG Firmware driver API description ........................................... |
606 |
|
47.2.1 |
How to use this driver ..................................................................... |
606 |
47.2.2 |
Initialization and de-initialization functions ..................................... |
606 |
47.2.3 |
Peripheral Control functions ........................................................... |
607 |
47.2.4 |
Peripheral State functions .............................................................. |
607 |
47.2.5 |
HAL_RNG_Init ................................................................................ |
607 |
47.2.6 |
HAL_RNG_DeInit ........................................................................... |
607 |
47.2.7 |
HAL_RNG_MspInit ......................................................................... |
607 |
47.2.8 |
HAL_RNG_MspDeInit .................................................................... |
608 |
47.2.9 |
HAL_RNG_GenerateRandomNumber ........................................... |
608 |
47.2.10 |
HAL_RNG_GenerateRandomNumber_IT...................................... |
608 |
47.2.11 |
HAL_RNG_IRQHandler.................................................................. |
608 |
47.2.12 |
HAL_RNG_GetRandomNumber .................................................... |
609 |
47.2.13 |
HAL_RNG_GetRandomNumber_IT ............................................... |
609 |
47.2.14 |
HAL_RNG_ReadLastRandomNumber........................................... |
609 |
47.2.15 |
HAL_RNG_ReadyDataCallback..................................................... |
609 |
47.2.16 |
HAL_RNG_ErrorCallback............................................................... |
610 |
47.2.17 |
HAL_RNG_GetState ...................................................................... |
610 |
47.3 RNG Firmware driver defines........................................................ |
610 |
|
47.3.1 |
RNG................................................................................................ |
610 |
48 HAL RTC Generic Driver ............................................................. |
613 |
|
48.1 RTC Firmware driver registers structures ..................................... |
613 |
|
48.1.1 |
RTC_InitTypeDef............................................................................ |
613 |
48.1.2 |
RTC_TimeTypeDef......................................................................... |
613 |
48.1.3 |
RTC_DateTypeDef ......................................................................... |
614 |
48.1.4 |
RTC_AlarmTypeDef ....................................................................... |
615 |
48.1.5 |
RTC_HandleTypeDef ..................................................................... |
615 |
48.2 RTC Firmware driver API description............................................ |
616 |
|
48.2.1 |
Backup Domain Operating Condition ............................................. |
616 |
48.2.2 |
Backup Domain Reset.................................................................... |
616 |
48.2.3 |
Backup Domain Access.................................................................. |
616 |
48.2.4 |
How to use this driver ..................................................................... |
617 |
34/900 |
DOCID025834 Rev 2 |
|
UM1725 |
Contents |
48.2.5 |
RTC and low power modes ............................................................ |
617 |
48.2.6 |
Initialization and de-initialization functions ..................................... |
617 |
48.2.7 |
RTC Time and Date functions ........................................................ |
618 |
48.2.8 |
RTC Alarm functions ...................................................................... |
618 |
48.2.9 |
Peripheral Control functions ........................................................... |
618 |
48.2.10 |
Peripheral State functions .............................................................. |
618 |
48.2.11 |
HAL_RTC_Init ................................................................................ |
618 |
48.2.12 |
HAL_RTC_DeInit............................................................................ |
619 |
48.2.13 |
HAL_RTC_MspInit.......................................................................... |
619 |
48.2.14 |
HAL_RTC_MspDeInit ..................................................................... |
619 |
48.2.15 |
HAL_RTC_SetTime........................................................................ |
619 |
48.2.16 |
HAL_RTC_GetTime ....................................................................... |
620 |
48.2.17 |
HAL_RTC_SetDate ........................................................................ |
620 |
48.2.18 |
HAL_RTC_GetDate........................................................................ |
620 |
48.2.19 |
HAL_RTC_SetAlarm ...................................................................... |
621 |
48.2.20 |
HAL_RTC_SetAlarm_IT ................................................................. |
621 |
48.2.21 |
HAL_RTC_DeactivateAlarm........................................................... |
621 |
48.2.22 |
HAL_RTC_GetAlarm ...................................................................... |
621 |
48.2.23 |
HAL_RTC_AlarmIRQHandler......................................................... |
622 |
48.2.24 |
HAL_RTC_AlarmAEventCallback .................................................. |
622 |
48.2.25 |
HAL_RTC_PollForAlarmAEvent..................................................... |
622 |
48.2.26 |
HAL_RTC_WaitForSynchro ........................................................... |
622 |
48.2.27 |
HAL_RTC_GetState ....................................................................... |
623 |
48.3 RTC Firmware driver defines ........................................................ |
623 |
|
48.3.1 |
RTC ................................................................................................ |
623 |
49 HAL RTC Extension Driver ......................................................... |
634 |
|
49.1 RTCEx Firmware driver registers structures ................................. |
634 |
|
49.1.1 |
RTC_TamperTypeDef .................................................................... |
634 |
49.2 RTCEx Firmware driver API description........................................ |
634 |
|
49.2.1 |
How to use this driver ..................................................................... |
634 |
49.2.2 |
RTC TimeStamp and Tamper functions......................................... |
635 |
49.2.3 |
RTC Wake-up functions ................................................................. |
636 |
49.2.4 |
Extension Peripheral Control functions .......................................... |
636 |
49.2.5 |
Extended features functions ........................................................... |
637 |
49.2.6 |
HAL_RTCEx_SetTimeStamp ......................................................... |
637 |
49.2.7 |
HAL_RTCEx_SetTimeStamp_IT .................................................... |
637 |
49.2.8 |
HAL_RTCEx_DeactivateTimeStamp ............................................. |
638 |
49.2.9 |
HAL_RTCEx_GetTimeStamp......................................................... |
638 |
|
DOCID025834 Rev 2 |
35/900 |
Contents |
|
|
UM1725 |
|
49.2.10 |
HAL_RTCEx_SetTamper ............................................................... |
638 |
|
49.2.11 |
HAL_RTCEx_SetTamper_IT .......................................................... |
639 |
|
49.2.12 |
HAL_RTCEx_DeactivateTamper ................................................... |
639 |
|
49.2.13 |
HAL_RTCEx_TamperTimeStampIRQHandler ............................... |
639 |
|
49.2.14 |
HAL_RTCEx_TimeStampEventCallback ....................................... |
639 |
|
49.2.15 |
HAL_RTCEx_Tamper1EventCallback ........................................... |
639 |
|
49.2.16 |
HAL_RTCEx_Tamper2EventCallback ........................................... |
640 |
|
49.2.17 |
HAL_RTCEx_PollForTimeStampEvent.......................................... |
640 |
|
49.2.18 |
HAL_RTCEx_PollForTamper1Event.............................................. |
640 |
|
49.2.19 |
HAL_RTCEx_PollForTamper2Event.............................................. |
640 |
|
49.2.20 |
HAL_RTCEx_SetWakeUpTimer .................................................... |
640 |
|
49.2.21 |
HAL_RTCEx_SetWakeUpTimer_IT ............................................... |
641 |
|
49.2.22 |
HAL_RTCEx_DeactivateWakeUpTimer......................................... |
641 |
|
49.2.23 |
HAL_RTCEx_GetWakeUpTimer .................................................... |
641 |
|
49.2.24 |
HAL_RTCEx_WakeUpTimerIRQHandler....................................... |
641 |
|
49.2.25 |
HAL_RTCEx_WakeUpTimerEventCallback................................... |
642 |
|
49.2.26 |
HAL_RTCEx_PollForWakeUpTimerEvent ..................................... |
642 |
|
49.2.27 |
HAL_RTCEx_BKUPWrite............................................................... |
642 |
|
49.2.28 |
HAL_RTCEx_BKUPRead .............................................................. |
642 |
|
49.2.29 |
HAL_RTCEx_SetCoarseCalib........................................................ |
642 |
|
49.2.30 |
HAL_RTCEx_DeactivateCoarseCalib ............................................ |
643 |
|
49.2.31 |
HAL_RTCEx_SetSmoothCalib ....................................................... |
643 |
|
49.2.32 |
HAL_RTCEx_SetSynchroShift ....................................................... |
644 |
|
49.2.33 |
HAL_RTCEx_SetCalibrationOutPut ............................................... |
644 |
|
49.2.34 |
HAL_RTCEx_DeactivateCalibrationOutPut ................................... |
644 |
|
49.2.35 |
HAL_RTCEx_SetRefClock ............................................................. |
645 |
|
49.2.36 |
HAL_RTCEx_DeactivateRefClock ................................................. |
645 |
|
49.2.37 |
HAL_RTCEx_EnableBypassShadow............................................. |
645 |
|
49.2.38 |
HAL_RTCEx_DisableBypassShadow ............................................ |
645 |
|
49.2.39 |
HAL_RTCEx_AlarmBEventCallback .............................................. |
646 |
|
49.2.40 |
HAL_RTCEx_PollForAlarmBEvent ................................................ |
646 |
49.3 |
RTCEx Firmware driver defines .................................................... |
646 |
|
|
49.3.1 |
RTCEx ............................................................................................ |
646 |
50 HAL SAI Generic Driver .............................................................. |
666 |
||
50.1 |
SAI Firmware driver registers structures ....................................... |
666 |
|
|
50.1.1 |
SAI_InitTypeDef ............................................................................. |
666 |
|
50.1.2 |
SAI_FrameInitTypeDef ................................................................... |
667 |
|
50.1.3 |
SAI_SlotInitTypeDef ....................................................................... |
668 |
36/900 |
|
DOCID025834 Rev 2 |
|
UM1725 |
Contents |
|
50.1.4 |
__SAI_HandleTypeDef................................................................... |
668 |
50.2 |
SAI Firmware driver API description ............................................. |
669 |
|
|
50.2.1 |
How to use this driver ..................................................................... |
669 |
|
50.2.2 |
Initialization and de-initialization functions ..................................... |
671 |
|
50.2.3 |
IO operation functions .................................................................... |
672 |
|
50.2.4 |
Peripheral State and Errors functions ............................................ |
673 |
|
50.2.5 |
HAL_SAI_InitProtocol..................................................................... |
673 |
|
50.2.6 |
HAL_SAI_Init .................................................................................. |
673 |
|
50.2.7 |
HAL_SAI_DeInit ............................................................................. |
674 |
|
50.2.8 |
HAL_SAI_MspInit ........................................................................... |
674 |
|
50.2.9 |
HAL_SAI_MspDeInit....................................................................... |
674 |
|
50.2.10 |
HAL_SAI_Transmit......................................................................... |
674 |
|
50.2.11 |
HAL_SAI_Receive.......................................................................... |
674 |
|
50.2.12 |
HAL_SAI_Transmit_IT.................................................................... |
675 |
|
50.2.13 |
HAL_SAI_Receive_IT..................................................................... |
675 |
|
50.2.14 |
HAL_SAI_DMAPause..................................................................... |
675 |
|
50.2.15 |
HAL_SAI_DMAResume ................................................................. |
675 |
|
50.2.16 |
HAL_SAI_DMAStop ....................................................................... |
675 |
|
50.2.17 |
HAL_SAI_Abort .............................................................................. |
676 |
|
50.2.18 |
HAL_SAI_Transmit_DMA............................................................... |
676 |
|
50.2.19 |
HAL_SAI_Receive_DMA................................................................ |
676 |
|
50.2.20 |
HAL_SAI_EnableTxMuteMode ...................................................... |
676 |
|
50.2.21 |
HAL_SAI_DisableTxMuteMode...................................................... |
677 |
|
50.2.22 |
HAL_SAI_EnableRxMuteMode ...................................................... |
677 |
|
50.2.23 |
HAL_SAI_DisableRxMuteMode ..................................................... |
677 |
|
50.2.24 |
HAL_SAI_IRQHandler.................................................................... |
677 |
|
50.2.25 |
HAL_SAI_TxCpltCallback .............................................................. |
677 |
|
50.2.26 |
HAL_SAI_TxHalfCpltCallback ........................................................ |
678 |
|
50.2.27 |
HAL_SAI_RxCpltCallback .............................................................. |
678 |
|
50.2.28 |
HAL_SAI_RxHalfCpltCallback........................................................ |
678 |
|
50.2.29 |
HAL_SAI_ErrorCallback ................................................................. |
678 |
|
50.2.30 |
HAL_SAI_GetState......................................................................... |
678 |
|
50.2.31 |
HAL_SAI_GetError ......................................................................... |
678 |
50.3 |
SAI Firmware driver defines .......................................................... |
679 |
|
|
50.3.1 |
SAI .................................................................................................. |
679 |
51 HAL SAI Extension Driver........................................................... |
687 |
||
51.1 |
SAIEx Firmware driver API description ......................................... |
687 |
|
|
51.1.1 |
SAI peripheral extension features .................................................. |
687 |
|
|
DOCID025834 Rev 2 |
37/900 |
Contents |
|
UM1725 |
51.1.2 |
How to use this driver ..................................................................... |
687 |
51.1.3 |
Extension features Functions ......................................................... |
687 |
51.1.4 |
SAI_BlockSynchroConfig ............................................................... |
687 |
51.1.5 |
SAI_GetInputClock ......................................................................... |
687 |
51.2 SAIEx Firmware driver defines...................................................... |
687 |
|
51.2.1 |
SAIEx.............................................................................................. |
687 |
52 HAL SDRAM Generic Driver ....................................................... |
688 |
|
52.1 SDRAM Firmware driver registers structures ................................ |
688 |
|
52.1.1 |
SDRAM_HandleTypeDef................................................................ |
688 |
52.2 SDRAM Firmware driver API description ...................................... |
688 |
|
52.2.1 |
How to use this driver ..................................................................... |
688 |
52.2.2 |
SDRAM Initialization and de_initialization functions ...................... |
689 |
52.2.3 |
SDRAM Input and Output functions ............................................... |
689 |
52.2.4 |
SDRAM Control functions............................................................... |
689 |
52.2.5 |
SDRAM State functions.................................................................. |
690 |
52.2.6 |
HAL_SDRAM_Init........................................................................... |
690 |
52.2.7 |
HAL_SDRAM_DeInit ...................................................................... |
690 |
52.2.8 |
HAL_SDRAM_MspInit .................................................................... |
690 |
52.2.9 |
HAL_SDRAM_MspDeInit ............................................................... |
690 |
52.2.10 |
HAL_SDRAM_IRQHandler ............................................................ |
691 |
52.2.11 |
HAL_SDRAM_RefreshErrorCallback ............................................. |
691 |
52.2.12 |
HAL_SDRAM_DMA_XferCpltCallback........................................... |
691 |
52.2.13 |
HAL_SDRAM_DMA_XferErrorCallback ......................................... |
691 |
52.2.14 |
HAL_SDRAM_Read_8b ................................................................. |
691 |
52.2.15 |
HAL_SDRAM_Write_8b ................................................................. |
692 |
52.2.16 |
HAL_SDRAM_Read_16b ............................................................... |
692 |
52.2.17 |
HAL_SDRAM_Write_16b ............................................................... |
692 |
52.2.18 |
HAL_SDRAM_Read_32b ............................................................... |
692 |
52.2.19 |
HAL_SDRAM_Write_32b ............................................................... |
693 |
52.2.20 |
HAL_SDRAM_Read_DMA ............................................................. |
693 |
52.2.21 |
HAL_SDRAM_Write_DMA ............................................................. |
693 |
52.2.22 |
HAL_SDRAM_WriteProtection_Enable.......................................... |
694 |
52.2.23 |
HAL_SDRAM_WriteProtection_Disable......................................... |
694 |
52.2.24 |
HAL_SDRAM_SendCommand ...................................................... |
694 |
52.2.25 |
HAL_SDRAM_ProgramRefreshRate ............................................. |
694 |
52.2.26 |
HAL_SDRAM_SetAutoRefreshNumber ......................................... |
694 |
52.2.27 |
HAL_SDRAM_GetModeStatus ...................................................... |
695 |
52.2.28 |
HAL_SDRAM_GetState ................................................................. |
695 |
38/900 |
DOCID025834 Rev 2 |
|
UM1725 |
Contents |
52.3 SDRAM Firmware driver defines................................................... |
695 |
|
52.3.1 |
SDRAM........................................................................................... |
695 |
53 HAL SD Generic Driver ............................................................... |
696 |
|
53.1 SD Firmware driver registers structures ........................................ |
696 |
|
53.1.1 |
SD_HandleTypeDef........................................................................ |
696 |
53.1.2 |
HAL_SD_CSDTypedef ................................................................... |
697 |
53.1.3 |
HAL_SD_CIDTypedef .................................................................... |
699 |
53.1.4 |
HAL_SD_CardStatusTypedef ........................................................ |
700 |
53.1.5 |
HAL_SD_CardInfoTypedef............................................................. |
700 |
53.2 SD Firmware driver API description .............................................. |
701 |
|
53.2.1 |
How to use this driver ..................................................................... |
701 |
53.2.2 |
Initialization and de-initialization functions ..................................... |
703 |
53.2.3 |
IO operation functions .................................................................... |
703 |
53.2.4 |
Peripheral Control functions ........................................................... |
703 |
53.2.5 |
Peripheral State functions .............................................................. |
704 |
53.2.6 |
HAL_SD_Init................................................................................... |
704 |
53.2.7 |
HAL_SD_DeInit .............................................................................. |
704 |
53.2.8 |
HAL_SD_MspInit ............................................................................ |
704 |
53.2.9 |
HAL_SD_MspDeInit ....................................................................... |
704 |
53.2.10 |
HAL_SD_ReadBlocks .................................................................... |
705 |
53.2.11 |
HAL_SD_WriteBlocks..................................................................... |
705 |
53.2.12 |
HAL_SD_ReadBlocks_DMA .......................................................... |
705 |
53.2.13 |
HAL_SD_WriteBlocks_DMA .......................................................... |
706 |
53.2.14 |
HAL_SD_CheckReadOperation ..................................................... |
706 |
53.2.15 |
HAL_SD_CheckWriteOperation ..................................................... |
706 |
53.2.16 |
HAL_SD_Erase .............................................................................. |
706 |
53.2.17 |
HAL_SD_IRQHandler..................................................................... |
706 |
53.2.18 |
HAL_SD_XferCpltCallback............................................................. |
707 |
53.2.19 |
HAL_SD_XferErrorCallback ........................................................... |
707 |
53.2.20 |
HAL_SD_DMA_RxCpltCallback ..................................................... |
707 |
53.2.21 |
HAL_SD_DMA_RxErrorCallback ................................................... |
707 |
53.2.22 |
HAL_SD_DMA_TxCpltCallback ..................................................... |
707 |
53.2.23 |
HAL_SD_DMA_TxErrorCallback.................................................... |
708 |
53.2.24 |
HAL_SD_Get_CardInfo .................................................................. |
708 |
53.2.25 |
HAL_SD_WideBusOperation_Config............................................. |
708 |
53.2.26 |
HAL_SD_StopTransfer................................................................... |
708 |
53.2.27 |
HAL_SD_HighSpeed...................................................................... |
709 |
53.2.28 |
HAL_SD_SendSDStatus ................................................................ |
709 |
|
DOCID025834 Rev 2 |
39/900 |
Contents |
|
UM1725 |
53.2.29 |
HAL_SD_GetStatus........................................................................ |
709 |
53.2.30 |
HAL_SD_GetCardStatus................................................................ |
709 |
53.3 SD Firmware driver defines........................................................... |
709 |
|
53.3.1 |
SD................................................................................................... |
709 |
54 HAL SMARTCARD Generic Driver.............................................. |
722 |
|
54.1 SMARTCARD Firmware driver registers structures ...................... |
722 |
|
54.1.1 |
SMARTCARD_InitTypeDef ............................................................ |
722 |
54.1.2 |
SMARTCARD_HandleTypeDef...................................................... |
723 |
54.2 SMARTCARD Firmware driver API description............................. |
724 |
|
54.2.1 |
How to use this driver ..................................................................... |
724 |
54.2.2 |
Initialization and Configuration functions........................................ |
725 |
54.2.3 |
IO operation functions .................................................................... |
726 |
54.2.4 |
Peripheral State and Errors functions ............................................ |
728 |
54.2.5 |
HAL_SMARTCARD_Init ................................................................. |
728 |
54.2.6 |
HAL_SMARTCARD_DeInit ............................................................ |
728 |
54.2.7 |
HAL_SMARTCARD_MspInit .......................................................... |
728 |
54.2.8 |
HAL_SMARTCARD_MspDeInit ..................................................... |
729 |
54.2.9 |
HAL_SMARTCARD_ReInit ............................................................ |
729 |
54.2.10 |
HAL_SMARTCARD_Transmit........................................................ |
729 |
54.2.11 |
HAL_SMARTCARD_Receive......................................................... |
729 |
54.2.12 |
HAL_SMARTCARD_Transmit_IT .................................................. |
730 |
54.2.13 |
HAL_SMARTCARD_Receive_IT ................................................... |
730 |
54.2.14 |
HAL_SMARTCARD_Transmit_DMA.............................................. |
730 |
54.2.15 |
HAL_SMARTCARD_Receive_DMA............................................... |
730 |
54.2.16 |
HAL_SMARTCARD_IRQHandler................................................... |
731 |
54.2.17 |
HAL_SMARTCARD_TxCpltCallback ............................................. |
731 |
54.2.18 |
HAL_SMARTCARD_RxCpltCallback ............................................. |
731 |
54.2.19 |
HAL_SMARTCARD_ErrorCallback ................................................ |
731 |
54.2.20 |
HAL_SMARTCARD_GetState ....................................................... |
731 |
54.2.21 |
HAL_SMARTCARD_GetError ........................................................ |
732 |
54.3 SMARTCARD Firmware driver defines ......................................... |
732 |
|
54.3.1 |
SMARTCARD ................................................................................. |
732 |
55 HAL SPDIFRX Generic Driver ..................................................... |
741 |
|
55.1 SPDIFRX Firmware driver registers structures ............................. |
741 |
|
55.1.1 |
SPDIFRX_InitTypeDef.................................................................... |
741 |
55.1.2 |
SPDIFRX_SetDataFormatTypeDef................................................ |
742 |
55.1.3 |
SPDIFRX_HandleTypeDef ............................................................. |
742 |
40/900 |
DOCID025834 Rev 2 |
|
UM1725 |
Contents |
55.2 |
SPDIFRX Firmware driver API description.................................... |
743 |
|
|
55.2.1 |
How to use this driver ..................................................................... |
743 |
|
55.2.2 |
Initialization and de-initialization functions ..................................... |
745 |
|
55.2.3 |
IO operation functions .................................................................... |
745 |
|
55.2.4 |
Peripheral State and Errors functions ............................................ |
746 |
|
55.2.5 |
HAL_SPDIFRX_Init ........................................................................ |
746 |
|
55.2.6 |
HAL_SPDIFRX_DeInit.................................................................... |
746 |
|
55.2.7 |
HAL_SPDIFRX_MspInit ................................................................. |
747 |
|
55.2.8 |
HAL_SPDIFRX_MspDeInit............................................................. |
747 |
|
55.2.9 |
HAL_SPDIFRX_SetDataFormat .................................................... |
747 |
|
55.2.10 |
HAL_SPDIFRX_ReceiveDataFlow................................................. |
747 |
|
55.2.11 |
HAL_SPDIFRX_ReceiveControlFlow............................................. |
747 |
|
55.2.12 |
HAL_SPDIFRX_ReceiveDataFlow_IT ........................................... |
748 |
|
55.2.13 |
HAL_SPDIFRX_ReceiveControlFlow_IT ....................................... |
748 |
|
55.2.14 |
HAL_SPDIFRX_ReceiveDataFlow_DMA....................................... |
748 |
|
55.2.15 |
HAL_SPDIFRX_ReceiveControlFlow_DMA................................... |
748 |
|
55.2.16 |
HAL_SPDIFRX_DMAStop ............................................................. |
749 |
|
55.2.17 |
HAL_SPDIFRX_IRQHandler .......................................................... |
749 |
|
55.2.18 |
HAL_SPDIFRX_RxHalfCpltCallback .............................................. |
749 |
|
55.2.19 |
HAL_SPDIFRX_RxCpltCallback .................................................... |
749 |
|
55.2.20 |
HAL_SPDIFRX_CxHalfCpltCallback .............................................. |
749 |
|
55.2.21 |
HAL_SPDIFRX_CxCpltCallback .................................................... |
750 |
|
55.2.22 |
HAL_SPDIFRX_ErrorCallback ....................................................... |
750 |
|
55.2.23 |
HAL_SPDIFRX_GetState............................................................... |
750 |
|
55.2.24 |
HAL_SPDIFRX_GetError ............................................................... |
750 |
55.3 |
SPDIFRX Firmware driver defines ................................................ |
750 |
|
|
55.3.1 |
SPDIFRX ........................................................................................ |
750 |
56 HAL SPI Generic Driver............................................................... |
756 |
||
56.1 |
SPI Firmware driver registers structures ....................................... |
756 |
|
|
56.1.1 |
SPI_InitTypeDef ............................................................................. |
756 |
|
56.1.2 |
__SPI_HandleTypeDef................................................................... |
757 |
56.2 |
SPI Firmware driver API description ............................................. |
758 |
|
|
56.2.1 |
How to use this driver ..................................................................... |
758 |
|
56.2.2 |
Initialization and de-initialization functions ..................................... |
758 |
|
56.2.3 |
IO operation functions .................................................................... |
759 |
|
56.2.4 |
Peripheral State and Errors functions ............................................ |
759 |
|
56.2.5 |
HAL_SPI_Init .................................................................................. |
760 |
|
56.2.6 |
HAL_SPI_DeInit ............................................................................. |
760 |
|
|
DOCID025834 Rev 2 |
41/900 |
Contents |
|
|
UM1725 |
|
56.2.7 |
HAL_SPI_MspInit ........................................................................... |
760 |
|
56.2.8 |
HAL_SPI_MspDeInit....................................................................... |
760 |
|
56.2.9 |
HAL_SPI_Transmit......................................................................... |
760 |
|
56.2.10 |
HAL_SPI_Receive.......................................................................... |
761 |
|
56.2.11 |
HAL_SPI_TransmitReceive............................................................ |
761 |
|
56.2.12 |
HAL_SPI_Transmit_IT.................................................................... |
761 |
|
56.2.13 |
HAL_SPI_Receive_IT..................................................................... |
761 |
|
56.2.14 |
HAL_SPI_TransmitReceive_IT ...................................................... |
762 |
|
56.2.15 |
HAL_SPI_Transmit_DMA............................................................... |
762 |
|
56.2.16 |
HAL_SPI_Receive_DMA................................................................ |
762 |
|
56.2.17 |
HAL_SPI_TransmitReceive_DMA.................................................. |
762 |
|
56.2.18 |
HAL_SPI_DMAPause..................................................................... |
763 |
|
56.2.19 |
HAL_SPI_DMAResume ................................................................. |
763 |
|
56.2.20 |
HAL_SPI_DMAStop ....................................................................... |
763 |
|
56.2.21 |
HAL_SPI_IRQHandler.................................................................... |
763 |
|
56.2.22 |
HAL_SPI_TxCpltCallback .............................................................. |
764 |
|
56.2.23 |
HAL_SPI_RxCpltCallback .............................................................. |
764 |
|
56.2.24 |
HAL_SPI_TxRxCpltCallback .......................................................... |
764 |
|
56.2.25 |
HAL_SPI_TxHalfCpltCallback ........................................................ |
764 |
|
56.2.26 |
HAL_SPI_RxHalfCpltCallback........................................................ |
764 |
|
56.2.27 |
HAL_SPI_TxRxHalfCpltCallback.................................................... |
764 |
|
56.2.28 |
HAL_SPI_ErrorCallback ................................................................. |
765 |
|
56.2.29 |
HAL_SPI_GetState......................................................................... |
765 |
|
56.2.30 |
HAL_SPI_GetError ......................................................................... |
765 |
56.3 |
SPI Firmware driver defines .......................................................... |
765 |
|
|
56.3.1 |
SPI .................................................................................................. |
765 |
57 HAL SRAM Generic Driver .......................................................... |
771 |
||
57.1 |
SRAM Firmware driver registers structures................................... |
771 |
|
|
57.1.1 |
SRAM_HandleTypeDef .................................................................. |
771 |
57.2 |
SRAM Firmware driver API description ......................................... |
771 |
|
|
57.2.1 |
How to use this driver ..................................................................... |
771 |
|
57.2.2 |
SRAM Initialization and de_initialization functions ......................... |
772 |
|
57.2.3 |
SRAM Input and Output functions .................................................. |
772 |
|
57.2.4 |
SRAM Control functions ................................................................. |
772 |
|
57.2.5 |
SRAM State functions .................................................................... |
773 |
|
57.2.6 |
HAL_SRAM_Init ............................................................................. |
773 |
|
57.2.7 |
HAL_SRAM_DeInit......................................................................... |
773 |
|
57.2.8 |
HAL_SRAM_MspInit....................................................................... |
773 |
42/900 |
|
DOCID025834 Rev 2 |
|
UM1725 |
Contents |
57.2.9 |
HAL_SRAM_MspDeInit .................................................................. |
773 |
57.2.10 |
HAL_SRAM_DMA_XferCpltCallback ............................................. |
774 |
57.2.11 |
HAL_SRAM_DMA_XferErrorCallback............................................ |
774 |
57.2.12 |
HAL_SRAM_Read_8b.................................................................... |
774 |
57.2.13 |
HAL_SRAM_Write_8b.................................................................... |
774 |
57.2.14 |
HAL_SRAM_Read_16b.................................................................. |
774 |
57.2.15 |
HAL_SRAM_Write_16b.................................................................. |
775 |
57.2.16 |
HAL_SRAM_Read_32b.................................................................. |
775 |
57.2.17 |
HAL_SRAM_Write_32b.................................................................. |
775 |
57.2.18 |
HAL_SRAM_Read_DMA................................................................ |
776 |
57.2.19 |
HAL_SRAM_Write_DMA................................................................ |
776 |
57.2.20 |
HAL_SRAM_WriteOperation_Enable............................................. |
776 |
57.2.21 |
HAL_SRAM_WriteOperation_Disable............................................ |
776 |
57.2.22 |
HAL_SRAM_GetState .................................................................... |
776 |
57.3 SRAM Firmware driver defines ..................................................... |
777 |
|
57.3.1 |
SRAM ............................................................................................. |
777 |
58 HAL TIM Generic Driver .............................................................. |
778 |
|
58.1 TIM Firmware driver registers structures....................................... |
778 |
|
58.1.1 |
TIM_Base_InitTypeDef................................................................... |
778 |
58.1.2 |
TIM_OC_InitTypeDef...................................................................... |
778 |
58.1.3 |
TIM_OnePulse_InitTypeDef ........................................................... |
779 |
58.1.4 |
TIM_IC_InitTypeDef ....................................................................... |
780 |
58.1.5 |
TIM_Encoder_InitTypeDef ............................................................. |
780 |
58.1.6 |
TIM_ClockConfigTypeDef .............................................................. |
781 |
58.1.7 |
TIM_ClearInputConfigTypeDef....................................................... |
782 |
58.1.8 |
TIM_SlaveConfigTypeDef .............................................................. |
782 |
58.1.9 |
TIM_HandleTypeDef ...................................................................... |
783 |
58.2 TIM Firmware driver API description ............................................. |
783 |
|
58.2.1 |
TIMER Generic features................................................................. |
783 |
58.2.2 |
How to use this driver ..................................................................... |
784 |
58.2.3 |
Time Base functions ....................................................................... |
784 |
58.2.4 |
Time Output Compare functions .................................................... |
785 |
58.2.5 |
Time PWM functions ...................................................................... |
785 |
58.2.6 |
Time Input Capture functions ......................................................... |
786 |
58.2.7 |
Time One Pulse functions .............................................................. |
786 |
58.2.8 |
Time Encoder functions.................................................................. |
787 |
58.2.9 |
IRQ handler management .............................................................. |
787 |
58.2.10 |
Peripheral Control functions ........................................................... |
787 |
|
DOCID025834 Rev 2 |
43/900 |
Contents |
|
UM1725 |
58.2.11 |
TIM Callbacks functions ................................................................. |
788 |
58.2.12 |
Peripheral State functions .............................................................. |
788 |
58.2.13 |
HAL_TIM_Base_Init ....................................................................... |
788 |
58.2.14 |
HAL_TIM_Base_DeInit................................................................... |
789 |
58.2.15 |
HAL_TIM_Base_MspInit................................................................. |
789 |
58.2.16 |
HAL_TIM_Base_MspDeInit ............................................................ |
789 |
58.2.17 |
HAL_TIM_Base_Start..................................................................... |
789 |
58.2.18 |
HAL_TIM_Base_Stop..................................................................... |
789 |
58.2.19 |
HAL_TIM_Base_Start_IT ............................................................... |
789 |
58.2.20 |
HAL_TIM_Base_Stop_IT................................................................ |
790 |
58.2.21 |
HAL_TIM_Base_Start_DMA .......................................................... |
790 |
58.2.22 |
HAL_TIM_Base_Stop_DMA........................................................... |
790 |
58.2.23 |
HAL_TIM_OC_Init .......................................................................... |
790 |
58.2.24 |
HAL_TIM_OC_DeInit...................................................................... |
791 |
58.2.25 |
HAL_TIM_OC_MspInit ................................................................... |
791 |
58.2.26 |
HAL_TIM_OC_MspDeInit............................................................... |
791 |
58.2.27 |
HAL_TIM_OC_Start ....................................................................... |
791 |
58.2.28 |
HAL_TIM_OC_Stop........................................................................ |
791 |
58.2.29 |
HAL_TIM_OC_Start_IT .................................................................. |
792 |
58.2.30 |
HAL_TIM_OC_Stop_IT .................................................................. |
792 |
58.2.31 |
HAL_TIM_OC_Start_DMA ............................................................. |
792 |
58.2.32 |
HAL_TIM_OC_Stop_DMA ............................................................. |
793 |
58.2.33 |
HAL_TIM_PWM_Init....................................................................... |
793 |
58.2.34 |
HAL_TIM_PWM_DeInit .................................................................. |
793 |
58.2.35 |
HAL_TIM_PWM_MspInit ................................................................ |
793 |
58.2.36 |
HAL_TIM_PWM_MspDeInit ........................................................... |
793 |
58.2.37 |
HAL_TIM_PWM_Start .................................................................... |
794 |
58.2.38 |
HAL_TIM_PWM_Stop .................................................................... |
794 |
58.2.39 |
HAL_TIM_PWM_Start_IT............................................................... |
794 |
58.2.40 |
HAL_TIM_PWM_Stop_IT ............................................................... |
795 |
58.2.41 |
HAL_TIM_PWM_Start_DMA .......................................................... |
795 |
58.2.42 |
HAL_TIM_PWM_Stop_DMA .......................................................... |
795 |
58.2.43 |
HAL_TIM_IC_Init ............................................................................ |
795 |
58.2.44 |
HAL_TIM_IC_DeInit ....................................................................... |
796 |
58.2.45 |
HAL_TIM_IC_MspInit ..................................................................... |
796 |
58.2.46 |
HAL_TIM_IC_MspDeInit................................................................. |
796 |
58.2.47 |
HAL_TIM_IC_Start ......................................................................... |
796 |
58.2.48 |
HAL_TIM_IC_Stop ......................................................................... |
796 |
58.2.49 |
HAL_TIM_IC_Start_IT .................................................................... |
797 |
44/900 |
DOCID025834 Rev 2 |
|
UM1725 |
Contents |
58.2.50 HAL_TIM_IC_Stop_IT .................................................................... |
797 |
58.2.51 HAL_TIM_IC_Start_DMA ............................................................... |
797 |
58.2.52 HAL_TIM_IC_Stop_DMA ............................................................... |
798 |
58.2.53 HAL_TIM_OnePulse_Init................................................................ |
798 |
58.2.54 HAL_TIM_OnePulse_DeInit ........................................................... |
798 |
58.2.55 HAL_TIM_OnePulse_MspInit ......................................................... |
798 |
58.2.56 HAL_TIM_OnePulse_MspDeInit .................................................... |
799 |
58.2.57 HAL_TIM_OnePulse_Start ............................................................. |
799 |
58.2.58 HAL_TIM_OnePulse_Stop ............................................................. |
799 |
58.2.59 HAL_TIM_OnePulse_Start_IT........................................................ |
799 |
58.2.60 HAL_TIM_OnePulse_Stop_IT ........................................................ |
800 |
58.2.61 HAL_TIM_Encoder_Init .................................................................. |
800 |
58.2.62 HAL_TIM_Encoder_DeInit ............................................................. |
800 |
58.2.63 HAL_TIM_Encoder_MspInit ........................................................... |
800 |
58.2.64 HAL_TIM_Encoder_MspDeInit....................................................... |
801 |
58.2.65 HAL_TIM_Encoder_Start ............................................................... |
801 |
58.2.66 HAL_TIM_Encoder_Stop ............................................................... |
801 |
58.2.67 HAL_TIM_Encoder_Start_IT .......................................................... |
801 |
58.2.68 HAL_TIM_Encoder_Stop_IT .......................................................... |
802 |
58.2.69 HAL_TIM_Encoder_Start_DMA ..................................................... |
802 |
58.2.70 HAL_TIM_Encoder_Stop_DMA ..................................................... |
802 |
58.2.71 HAL_TIM_IRQHandler ................................................................... |
803 |
58.2.72 HAL_TIM_OC_ConfigChannel ....................................................... |
803 |
58.2.73 HAL_TIM_IC_ConfigChannel ......................................................... |
803 |
58.2.74 HAL_TIM_PWM_ConfigChannel.................................................... |
803 |
58.2.75 HAL_TIM_OnePulse_ConfigChannel............................................. |
804 |
58.2.76 HAL_TIM_DMABurst_WriteStart .................................................... |
804 |
58.2.77 HAL_TIM_DMABurst_WriteStop .................................................... |
805 |
58.2.78 HAL_TIM_DMABurst_ReadStart.................................................... |
805 |
58.2.79 HAL_TIM_DMABurst_ReadStop .................................................... |
806 |
58.2.80 HAL_TIM_GenerateEvent .............................................................. |
806 |
58.2.81 HAL_TIM_ConfigOCrefClear.......................................................... |
807 |
58.2.82 HAL_TIM_ConfigClockSource ....................................................... |
807 |
58.2.83 HAL_TIM_ConfigTI1Input............................................................... |
808 |
58.2.84 HAL_TIM_SlaveConfigSynchronization ......................................... |
808 |
58.2.85 HAL_TIM_SlaveConfigSynchronization_IT .................................... |
808 |
58.2.86 HAL_TIM_ReadCapturedValue...................................................... |
808 |
58.2.87 HAL_TIM_PeriodElapsedCallback ................................................. |
809 |
DOCID025834 Rev 2 |
45/900 |
Contents |
|
|
UM1725 |
|
58.2.88 |
HAL_TIM_OC_DelayElapsedCallback........................................... |
809 |
|
58.2.89 |
HAL_TIM_IC_CaptureCallback ...................................................... |
809 |
|
58.2.90 |
HAL_TIM_PWM_PulseFinishedCallback ....................................... |
809 |
|
58.2.91 |
HAL_TIM_TriggerCallback ............................................................. |
810 |
|
58.2.92 |
HAL_TIM_ErrorCallback................................................................. |
810 |
|
58.2.93 |
HAL_TIM_Base_GetState .............................................................. |
810 |
|
58.2.94 |
HAL_TIM_OC_GetState................................................................. |
810 |
|
58.2.95 |
HAL_TIM_PWM_GetState ............................................................. |
810 |
|
58.2.96 |
HAL_TIM_IC_GetState................................................................... |
810 |
|
58.2.97 |
HAL_TIM_OnePulse_GetState ...................................................... |
811 |
|
58.2.98 |
HAL_TIM_Encoder_GetState......................................................... |
811 |
58.3 |
TIM Firmware driver defines.......................................................... |
811 |
|
|
58.3.1 |
TIM.................................................................................................. |
811 |
59 HAL TIM Extension Driver........................................................... |
826 |
||
59.1 |
TIMEx Firmware driver registers structures................................... |
826 |
|
|
59.1.1 |
TIM_HallSensor_InitTypeDef ......................................................... |
826 |
|
59.1.2 |
TIM_MasterConfigTypeDef ............................................................ |
826 |
|
59.1.3 |
TIM_BreakDeadTimeConfigTypeDef ............................................. |
826 |
59.2 |
TIMEx Firmware driver API description ......................................... |
827 |
|
|
59.2.1 |
TIMER Extended features .............................................................. |
827 |
|
59.2.2 |
How to use this driver ..................................................................... |
827 |
|
59.2.3 |
Timer Hall Sensor functions ........................................................... |
828 |
|
59.2.4 |
Timer Complementary Output Compare functions......................... |
829 |
|
59.2.5 |
Timer Complementary PWM functions........................................... |
829 |
|
59.2.6 |
Timer Complementary One Pulse functions................................... |
829 |
|
59.2.7 |
Peripheral Control functions ........................................................... |
830 |
|
59.2.8 |
Extension Callbacks functions........................................................ |
830 |
|
59.2.9 |
Extension Peripheral State functions ............................................. |
830 |
|
59.2.10 |
HAL_TIMEx_HallSensor_Init.......................................................... |
830 |
|
59.2.11 |
HAL_TIMEx_HallSensor_DeInit ..................................................... |
831 |
|
59.2.12 |
HAL_TIMEx_HallSensor_MspInit ................................................... |
831 |
|
59.2.13 |
HAL_TIMEx_HallSensor_MspDeInit .............................................. |
831 |
|
59.2.14 |
HAL_TIMEx_HallSensor_Start ....................................................... |
831 |
|
59.2.15 |
HAL_TIMEx_HallSensor_Stop ....................................................... |
831 |
|
59.2.16 |
HAL_TIMEx_HallSensor_Start_IT.................................................. |
832 |
|
59.2.17 |
HAL_TIMEx_HallSensor_Stop_IT .................................................. |
832 |
|
59.2.18 |
HAL_TIMEx_HallSensor_Start_DMA............................................. |
832 |
|
59.2.19 |
HAL_TIMEx_HallSensor_Stop_DMA ............................................. |
832 |
46/900 |
|
DOCID025834 Rev 2 |
|
UM1725 |
Contents |
|
59.2.20 |
HAL_TIMEx_OCN_Start................................................................. |
832 |
|
59.2.21 |
HAL_TIMEx_OCN_Stop................................................................. |
833 |
|
59.2.22 |
HAL_TIMEx_OCN_Start_IT ........................................................... |
833 |
|
59.2.23 |
HAL_TIMEx_OCN_Stop_IT ........................................................... |
833 |
|
59.2.24 |
HAL_TIMEx_OCN_Start_DMA ...................................................... |
834 |
|
59.2.25 |
HAL_TIMEx_OCN_Stop_DMA....................................................... |
834 |
|
59.2.26 |
HAL_TIMEx_PWMN_Start ............................................................. |
834 |
|
59.2.27 |
HAL_TIMEx_PWMN_Stop ............................................................. |
835 |
|
59.2.28 |
HAL_TIMEx_PWMN_Start_IT ........................................................ |
835 |
|
59.2.29 |
HAL_TIMEx_PWMN_Stop_IT ........................................................ |
835 |
|
59.2.30 |
HAL_TIMEx_PWMN_Start_DMA ................................................... |
836 |
|
59.2.31 |
HAL_TIMEx_PWMN_Stop_DMA ................................................... |
836 |
|
59.2.32 |
HAL_TIMEx_OnePulseN_Start ...................................................... |
836 |
|
59.2.33 |
HAL_TIMEx_OnePulseN_Stop ...................................................... |
836 |
|
59.2.34 |
HAL_TIMEx_OnePulseN_Start_IT ................................................. |
837 |
|
59.2.35 |
HAL_TIMEx_OnePulseN_Stop_IT ................................................. |
837 |
|
59.2.36 |
HAL_TIMEx_ConfigCommutationEvent ......................................... |
837 |
|
59.2.37 |
HAL_TIMEx_ConfigCommutationEvent_IT.................................... |
838 |
|
59.2.38 |
HAL_TIMEx_ConfigCommutationEvent_DMA ............................... |
839 |
|
59.2.39 |
HAL_TIMEx_MasterConfigSynchronization ................................... |
839 |
|
59.2.40 |
HAL_TIMEx_ConfigBreakDeadTime.............................................. |
839 |
|
59.2.41 |
HAL_TIMEx_RemapConfig ............................................................ |
840 |
|
59.2.42 |
HAL_TIMEx_CommutationCallback ............................................... |
840 |
|
59.2.43 |
HAL_TIMEx_BreakCallback ........................................................... |
840 |
|
59.2.44 |
TIMEx_DMACommutationCplt ....................................................... |
841 |
|
59.2.45 |
HAL_TIMEx_HallSensor_GetState ................................................ |
841 |
59.3 |
TIMEx Firmware driver defines ..................................................... |
841 |
|
|
59.3.1 |
TIMEx ............................................................................................. |
841 |
60 HAL UART Generic Driver........................................................... |
843 |
||
60.1 |
UART Firmware driver registers structures ................................... |
843 |
|
|
60.1.1 |
UART_InitTypeDef ......................................................................... |
843 |
|
60.1.2 |
UART_HandleTypeDef................................................................... |
843 |
60.2 |
UART Firmware driver API description ......................................... |
844 |
|
|
60.2.1 |
How to use this driver ..................................................................... |
844 |
|
60.2.2 |
Initialization and Configuration functions........................................ |
846 |
|
60.2.3 |
IO operation functions .................................................................... |
847 |
|
60.2.4 |
Peripheral Control functions ........................................................... |
848 |
|
60.2.5 |
Peripheral State and Errors functions ............................................ |
848 |
|
|
DOCID025834 Rev 2 |
47/900 |
Contents |
|
UM1725 |
60.2.6 |
HAL_UART_Init .............................................................................. |
848 |
60.2.7 |
HAL_HalfDuplex_Init ...................................................................... |
849 |
60.2.8 |
HAL_LIN_Init .................................................................................. |
849 |
60.2.9 |
HAL_MultiProcessor_Init ................................................................ |
849 |
60.2.10 |
HAL_UART_DeInit ......................................................................... |
850 |
60.2.11 |
HAL_UART_MspInit ....................................................................... |
850 |
60.2.12 |
HAL_UART_MspDeInit................................................................... |
850 |
60.2.13 |
HAL_UART_Transmit..................................................................... |
850 |
60.2.14 |
HAL_UART_Receive...................................................................... |
851 |
60.2.15 |
HAL_UART_Transmit_IT................................................................ |
851 |
60.2.16 |
HAL_UART_Receive_IT................................................................. |
851 |
60.2.17 |
HAL_UART_Transmit_DMA........................................................... |
851 |
60.2.18 |
HAL_UART_Receive_DMA............................................................ |
852 |
60.2.19 |
HAL_UART_DMAPause................................................................. |
852 |
60.2.20 |
HAL_UART_DMAResume ............................................................. |
852 |
60.2.21 |
HAL_UART_DMAStop ................................................................... |
852 |
60.2.22 |
HAL_UART_IRQHandler................................................................ |
853 |
60.2.23 |
HAL_UART_TxCpltCallback .......................................................... |
853 |
60.2.24 |
HAL_UART_TxHalfCpltCallback .................................................... |
853 |
60.2.25 |
HAL_UART_RxCpltCallback .......................................................... |
853 |
60.2.26 |
HAL_UART_RxHalfCpltCallback.................................................... |
853 |
60.2.27 |
HAL_UART_ErrorCallback ............................................................. |
854 |
60.2.28 |
HAL_LIN_SendBreak ..................................................................... |
854 |
60.2.29 |
HAL_MultiProcessor_EnterMuteMode ........................................... |
854 |
60.2.30 |
HAL_MultiProcessor_ExitMuteMode.............................................. |
854 |
60.2.31 |
HAL_HalfDuplex_EnableTransmitter ............................................. |
854 |
60.2.32 |
HAL_HalfDuplex_EnableReceiver ................................................. |
855 |
60.2.33 |
HAL_UART_GetState..................................................................... |
855 |
60.2.34 |
HAL_UART_GetError ..................................................................... |
855 |
60.3 UART Firmware driver defines ...................................................... |
855 |
|
60.3.1 |
UART .............................................................................................. |
855 |
61 HAL USART Generic Driver ........................................................ |
867 |
|
61.1 USART Firmware driver registers structures................................. |
867 |
|
61.1.1 |
USART_InitTypeDef ....................................................................... |
867 |
61.1.2 |
USART_HandleTypeDef ................................................................ |
868 |
61.2 USART Firmware driver API description ....................................... |
868 |
|
61.2.1 |
How to use this driver ..................................................................... |
868 |
61.2.2 |
Initialization and Configuration functions........................................ |
870 |
48/900 |
DOCID025834 Rev 2 |
|
UM1725 |
Contents |
61.2.3 |
IO operation functions .................................................................... |
871 |
61.2.4 |
Peripheral State and Errors functions ............................................ |
872 |
61.2.5 |
HAL_USART_Init............................................................................ |
872 |
61.2.6 |
HAL_USART_DeInit ....................................................................... |
872 |
61.2.7 |
HAL_USART_MspInit..................................................................... |
872 |
61.2.8 |
HAL_USART_MspDeInit ................................................................ |
873 |
61.2.9 |
HAL_USART_Transmit .................................................................. |
873 |
61.2.10 |
HAL_USART_Receive ................................................................... |
873 |
61.2.11 |
HAL_USART_TransmitReceive ..................................................... |
873 |
61.2.12 |
HAL_USART_Transmit_IT ............................................................. |
874 |
61.2.13 |
HAL_USART_Receive_IT .............................................................. |
874 |
61.2.14 |
HAL_USART_TransmitReceive_IT ................................................ |
874 |
61.2.15 |
HAL_USART_Transmit_DMA ........................................................ |
875 |
61.2.16 |
HAL_USART_Receive_DMA ......................................................... |
875 |
61.2.17 |
HAL_USART_TransmitReceive_DMA ........................................... |
875 |
61.2.18 |
HAL_USART_DMAPause .............................................................. |
876 |
61.2.19 |
HAL_USART_DMAResume ........................................................... |
876 |
61.2.20 |
HAL_USART_DMAStop ................................................................. |
876 |
61.2.21 |
HAL_USART_IRQHandler ............................................................. |
876 |
61.2.22 |
HAL_USART_TxCpltCallback ........................................................ |
876 |
61.2.23 |
HAL_USART_TxHalfCpltCallback.................................................. |
877 |
61.2.24 |
HAL_USART_RxCpltCallback........................................................ |
877 |
61.2.25 |
HAL_USART_RxHalfCpltCallback ................................................. |
877 |
61.2.26 |
HAL_USART_TxRxCpltCallback.................................................... |
877 |
61.2.27 |
HAL_USART_ErrorCallback .......................................................... |
877 |
61.2.28 |
HAL_USART_GetState .................................................................. |
878 |
61.2.29 |
HAL_USART_GetError................................................................... |
878 |
61.3 USART Firmware driver defines.................................................... |
878 |
|
61.3.1 |
USART............................................................................................ |
878 |
62 HAL WWDG Generic Driver ........................................................ |
886 |
|
62.1 WWDG Firmware driver registers structures................................. |
886 |
|
62.1.1 |
WWDG_InitTypeDef ....................................................................... |
886 |
62.1.2 |
WWDG_HandleTypeDef ................................................................ |
886 |
62.2 WWDG Firmware driver API description ....................................... |
887 |
|
62.2.1 |
WWDG specific features ................................................................ |
887 |
62.2.2 |
How to use this driver ..................................................................... |
887 |
62.2.3 |
Initialization and de-initialization functions ..................................... |
887 |
62.2.4 |
IO operation functions .................................................................... |
888 |
|
DOCID025834 Rev 2 |
49/900 |
Contents |
|
UM1725 |
|
|
62.2.5 |
Peripheral State functions .............................................................. |
888 |
|
62.2.6 |
HAL_WWDG_Init............................................................................ |
888 |
|
62.2.7 |
HAL_WWDG_DeInit ....................................................................... |
888 |
|
62.2.8 |
HAL_WWDG_MspInit..................................................................... |
889 |
|
62.2.9 |
HAL_WWDG_MspDeInit ................................................................ |
889 |
|
62.2.10 |
HAL_WWDG_WakeupCallback ..................................................... |
889 |
|
62.2.11 |
HAL_WWDG_Start......................................................................... |
889 |
|
62.2.12 |
HAL_WWDG_Start_IT.................................................................... |
889 |
|
62.2.13 |
HAL_WWDG_Refresh.................................................................... |
890 |
|
62.2.14 |
HAL_WWDG_IRQHandler ............................................................. |
890 |
|
62.2.15 |
HAL_WWDG_WakeupCallback ..................................................... |
890 |
|
62.2.16 |
HAL_WWDG_GetState .................................................................. |
890 |
|
62.3 WWDG Firmware driver defines.................................................... |
891 |
|
|
62.3.1 |
WWDG............................................................................................ |
891 |
63 |
FAQs............................................................................................. |
|
895 |
64 |
Revision history .......................................................................... |
|
899 |
50/900 |
DOCID025834 Rev 2 |
UM1725 |
List of tables |
List of tables |
|
Table 1: Acronyms and definitions............................................................................................................ |
53 |
Table 2: HAL drivers files.......................................................................................................................... |
55 |
Table 3: User-application files .................................................................................................................. |
57 |
Table 4: APis classification ....................................................................................................................... |
61 |
Table 5: List of devices supported by HAL drivers ................................................................................... |
63 |
Table 6: HAL API naming rules ................................................................................................................ |
66 |
Table 7: Macros handling interrupts and specific clock configurations .................................................... |
67 |
Table 8: Callback functions....................................................................................................................... |
68 |
Table 9: HAL generic APIs ....................................................................................................................... |
69 |
Table 10: HAL extension APIs .................................................................................................................. |
70 |
Table 11: Define statements used for HAL configuration ......................................................................... |
74 |
Table 12: Description of GPIO_InitTypeDef structure .............................................................................. |
77 |
Table 13: Description of EXTI configuration macros ................................................................................ |
79 |
Table 14: MSP functions........................................................................................................................... |
84 |
Table 15: Timeout values ......................................................................................................................... |
88 |
Table 16: Document revision history ...................................................................................................... |
899 |
DOCID025834 Rev 2 |
51/900 |
List of figures |
UM1725 |
List of figures |
|
Figure 1: Example of project template ...................................................................................................... |
58 |
Figure 2: Adding device-specific functions ............................................................................................... |
71 |
Figure 3: Adding family-specific functions ................................................................................................ |
71 |
Figure 4: Adding new peripherals ............................................................................................................. |
72 |
Figure 5: Updating existing APIs .............................................................................................................. |
72 |
Figure 6: File inclusion model ................................................................................................................... |
73 |
Figure 7: HAL driver model ....................................................................................................................... |
82 |
52/900 |
DOCID025834 Rev 2 |
UM1725 Acronyms and definitions
1 |
Acronyms and definitions |
|
|
|
|
Table 1: Acronyms and definitions |
|
|
|
|
|
|
Acronym |
Definition |
|
|
|
|
|
|
ADC |
Analog-to-digital converter |
|
|
|
|
|
|
ANSI |
American National Standards Institute |
|
|
|
|
|
|
API |
Application Programming Interface |
|
|
|
|
|
|
BSP |
Board Support Package |
|
|
|
|
|
|
CAN |
Controller area network |
|
|
|
|
|
|
CEC |
Consumer Electronics Control |
|
|
|
|
|
|
CMSIS |
Cortex Microcontroller Software Interface Standard |
|
|
|
|
|
|
CPU |
Central Processing Unit |
|
|
|
|
|
|
CRYP |
Cryptographic processor unit |
|
|
|
|
|
|
CRC |
CRC calculation unit |
|
|
|
|
|
|
DAC |
Digital to analog converter |
|
|
|
|
|
|
DCMI |
Digital Camera Module Interface |
|
|
|
|
|
|
DMA |
Direct Memory Access |
|
|
|
|
|
|
DMA2D |
Chrom-Art Accelerator™ controller |
|
|
|
|
|
|
ETH |
Ethernet controller |
|
|
|
|
|
|
EXTI |
External interrupt/event controller |
|
|
|
|
|
|
FLASH |
Flash memory |
|
|
|
|
|
|
FSMC |
Flexible Static Memory controller |
|
|
|
|
|
|
FMC |
Flexible Memory controller |
|
|
|
|
|
|
FMPI2C |
Fast-mode Plus inter-integrated circuit |
|
|
|
|
|
|
GPIO |
General purpose I/Os |
|
|
|
|
|
|
HAL |
Hardware abstraction layer |
|
|
|
|
|
|
HASH |
Hash processor |
|
|
|
|
|
|
HCD |
USB Host Controller Driver |
|
|
|
|
|
|
I2C |
Inter-integrated circuit |
|
|
|
|
|
|
I2S |
Inter-integrated sound |
|
|
|
|
|
|
IRDA |
InfraRed Data Association |
|
|
|
|
|
|
IWDG |
Independent watchdog |
|
|
|
|
|
|
LTDC |
LCD TFT Display Controller |
|
|
|
|
|
|
MSP |
MCU Specific Package |
|
|
|
|
|
|
NAND |
NAND external Flash memory |
|
|
|
|
|
|
NOR |
NOR external Flash memory |
|
|
|
|
|
|
NVIC |
Nested Vectored Interrupt Controller |
|
|
|
|
|
|
PCCARD |
PCCARD external memory |
|
|
|
|
|
|
|
DOCID025834 Rev 2 |
53/900 |
Acronyms and definitions |
UM1725 |
|
|
|
|
|
Acronym |
Definition |
|
|
|
|
PCD |
USB Peripheral Controller Driver |
|
|
|
|
PWR |
Power controller |
|
|
|
|
QSPI |
QuadSPI Flash memory Interface |
|
|
|
|
RCC |
Reset and clock controller |
|
|
|
|
RNG |
Random Number Generator |
|
|
|
|
RTC |
Real-time clock |
|
|
|
|
SAI |
Serial Audio Interface |
|
|
|
|
SD |
Secure Digital |
|
|
|
|
SDRAM |
SDRAM external memory |
|
|
|
|
SRAM |
SRAM external memory |
|
|
|
|
SMARTCARD |
Smartcard IC |
|
|
|
|
SPDIFRX |
SPDIF-RX Receiver Interface |
|
|
|
|
SPI |
Serial Peripheral interface |
|
|
|
|
SysTick |
System tick timer |
|
|
|
|
TIM |
Advanced-control, general-purpose or basic timer |
|
|
|
|
UART |
Universal asynchronous receiver/transmitter |
|
|
|
|
USART |
Universal synchronous receiver/transmitter |
|
|
|
|
WWDG |
Window watchdog |
|
|
|
|
USB |
Universal Serial Bus |
|
|
|
|
PPP |
STM32 peripheral or block |
|
|
|
54/900 |
DOCID025834 Rev 2 |