STM32F4xx HAL Documentation
Hardware Abstraction Layer for STM32F4 familiy
Loading...
Searching...
No Matches
Initialization and de-initialization functions

Initialization and Configuration functions. More...

Collaboration diagram for Initialization and de-initialization functions:

Functions

HAL_StatusTypeDef HAL_FMPSMBUS_Init (FMPSMBUS_HandleTypeDef *hfmpsmbus)
 Initialize the FMPSMBUS according to the specified parameters in the FMPSMBUS_InitTypeDef and initialize the associated handle.
 
HAL_StatusTypeDef HAL_FMPSMBUS_DeInit (FMPSMBUS_HandleTypeDef *hfmpsmbus)
 DeInitialize the FMPSMBUS peripheral.
 
void HAL_FMPSMBUS_MspInit (FMPSMBUS_HandleTypeDef *hfmpsmbus)
 Initialize the FMPSMBUS MSP.
 
void HAL_FMPSMBUS_MspDeInit (FMPSMBUS_HandleTypeDef *hfmpsmbus)
 DeInitialize the FMPSMBUS MSP.
 
HAL_StatusTypeDef HAL_FMPSMBUS_ConfigAnalogFilter (FMPSMBUS_HandleTypeDef *hfmpsmbus, uint32_t AnalogFilter)
 Configure Analog noise filter.
 
HAL_StatusTypeDef HAL_FMPSMBUS_ConfigDigitalFilter (FMPSMBUS_HandleTypeDef *hfmpsmbus, uint32_t DigitalFilter)
 Configure Digital noise filter.
 

Detailed Description

Initialization and Configuration functions.

 ===============================================================================
              ##### Initialization and de-initialization functions #####
 ===============================================================================
    [..]  This subsection provides a set of functions allowing to initialize and
          deinitialize the FMPSMBUSx peripheral:

      (+) User must Implement HAL_FMPSMBUS_MspInit() function in which he configures
          all related peripherals resources (CLOCK, GPIO, IT and NVIC ).

      (+) Call the function HAL_FMPSMBUS_Init() to configure the selected device with
          the selected configuration:
        (++) Clock Timing
        (++) Bus Timeout
        (++) Analog Filer mode
        (++) Own Address 1
        (++) Addressing mode (Master, Slave)
        (++) Dual Addressing mode
        (++) Own Address 2
        (++) Own Address 2 Mask
        (++) General call mode
        (++) Nostretch mode
        (++) Packet Error Check mode
        (++) Peripheral mode


      (+) Call the function HAL_FMPSMBUS_DeInit() to restore the default configuration
          of the selected FMPSMBUSx peripheral.

      (+) Enable/Disable Analog/Digital filters with HAL_FMPSMBUS_ConfigAnalogFilter() and
          HAL_FMPSMBUS_ConfigDigitalFilter().

Function Documentation

◆ HAL_FMPSMBUS_Init()

HAL_StatusTypeDef HAL_FMPSMBUS_Init ( FMPSMBUS_HandleTypeDef * hfmpsmbus)

#include <stm32f4xx_hal_fmpsmbus.h>

Initialize the FMPSMBUS according to the specified parameters in the FMPSMBUS_InitTypeDef and initialize the associated handle.

Parameters
hfmpsmbusPointer to a FMPSMBUS_HandleTypeDef structure that contains the configuration information for the specified FMPSMBUS.
Return values
HALstatus

Definition at line 290 of file stm32f4xx_hal_fmpsmbus.c.

References __HAL_FMPSMBUS_DISABLE, __HAL_FMPSMBUS_ENABLE, FMPSMBUS_InitTypeDef::AddressingMode, FMPSMBUS_InitTypeDef::AnalogFilter, assert_param, FMPSMBUS_InitTypeDef::DualAddressMode, FMPSMBUS_HandleTypeDef::ErrorCode, FMPSMBUS_ADDRESSINGMODE_10BIT, FMPSMBUS_ADDRESSINGMODE_7BIT, FMPSMBUS_PEC_ENABLE, FMPSMBUS_PERIPHERAL_MODE_FMPSMBUS_SLAVE, FMPSMBUS_PERIPHERAL_MODE_FMPSMBUS_SLAVE_ARP, FMPSMBUS_InitTypeDef::GeneralCallMode, HAL_ERROR, HAL_FMPSMBUS_AddrCallback(), HAL_FMPSMBUS_ERROR_NONE, HAL_FMPSMBUS_ErrorCallback(), HAL_FMPSMBUS_ListenCpltCallback(), HAL_FMPSMBUS_MasterRxCpltCallback(), HAL_FMPSMBUS_MasterTxCpltCallback(), HAL_FMPSMBUS_MspInit(), HAL_FMPSMBUS_SlaveRxCpltCallback(), HAL_FMPSMBUS_SlaveTxCpltCallback(), HAL_FMPSMBUS_STATE_BUSY, HAL_FMPSMBUS_STATE_READY, HAL_FMPSMBUS_STATE_RESET, HAL_OK, HAL_UNLOCKED, FMPSMBUS_HandleTypeDef::Init, FMPSMBUS_HandleTypeDef::Instance, IS_FMPSMBUS_ADDRESSING_MODE, IS_FMPSMBUS_ANALOG_FILTER, IS_FMPSMBUS_DUAL_ADDRESS, IS_FMPSMBUS_GENERAL_CALL, IS_FMPSMBUS_NO_STRETCH, IS_FMPSMBUS_OWN_ADDRESS1, IS_FMPSMBUS_OWN_ADDRESS2, IS_FMPSMBUS_OWN_ADDRESS2_MASK, IS_FMPSMBUS_PEC, IS_FMPSMBUS_PERIPHERAL_MODE, FMPSMBUS_HandleTypeDef::Lock, FMPSMBUS_InitTypeDef::NoStretchMode, FMPSMBUS_InitTypeDef::OwnAddress1, FMPSMBUS_InitTypeDef::OwnAddress2, FMPSMBUS_InitTypeDef::OwnAddress2Masks, FMPSMBUS_InitTypeDef::PacketErrorCheckMode, FMPSMBUS_InitTypeDef::PeripheralMode, FMPSMBUS_HandleTypeDef::PreviousState, FMPSMBUS_InitTypeDef::SMBusTimeout, FMPSMBUS_HandleTypeDef::State, FMPSMBUS_InitTypeDef::Timing, and TIMING_CLEAR_MASK.

◆ HAL_FMPSMBUS_DeInit()

HAL_StatusTypeDef HAL_FMPSMBUS_DeInit ( FMPSMBUS_HandleTypeDef * hfmpsmbus)

#include <stm32f4xx_hal_fmpsmbus.h>

DeInitialize the FMPSMBUS peripheral.

Parameters
hfmpsmbusPointer to a FMPSMBUS_HandleTypeDef structure that contains the configuration information for the specified FMPSMBUS.
Return values
HALstatus

Definition at line 415 of file stm32f4xx_hal_fmpsmbus.c.

References __HAL_FMPSMBUS_DISABLE, __HAL_UNLOCK, assert_param, FMPSMBUS_HandleTypeDef::ErrorCode, HAL_ERROR, HAL_FMPSMBUS_ERROR_NONE, HAL_FMPSMBUS_MspDeInit(), HAL_FMPSMBUS_STATE_BUSY, HAL_FMPSMBUS_STATE_RESET, HAL_OK, FMPSMBUS_HandleTypeDef::Instance, FMPSMBUS_HandleTypeDef::PreviousState, and FMPSMBUS_HandleTypeDef::State.

◆ HAL_FMPSMBUS_MspInit()

__weak void HAL_FMPSMBUS_MspInit ( FMPSMBUS_HandleTypeDef * hfmpsmbus)

#include <stm32f4xx_hal_fmpsmbus.h>

Initialize the FMPSMBUS MSP.

Parameters
hfmpsmbusPointer to a FMPSMBUS_HandleTypeDef structure that contains the configuration information for the specified FMPSMBUS.
Return values
None

Definition at line 460 of file stm32f4xx_hal_fmpsmbus.c.

References UNUSED.

Referenced by HAL_FMPSMBUS_Init().

◆ HAL_FMPSMBUS_MspDeInit()

__weak void HAL_FMPSMBUS_MspDeInit ( FMPSMBUS_HandleTypeDef * hfmpsmbus)

#include <stm32f4xx_hal_fmpsmbus.h>

DeInitialize the FMPSMBUS MSP.

Parameters
hfmpsmbusPointer to a FMPSMBUS_HandleTypeDef structure that contains the configuration information for the specified FMPSMBUS.
Return values
None

Definition at line 476 of file stm32f4xx_hal_fmpsmbus.c.

References UNUSED.

Referenced by HAL_FMPSMBUS_DeInit().

◆ HAL_FMPSMBUS_ConfigAnalogFilter()

HAL_StatusTypeDef HAL_FMPSMBUS_ConfigAnalogFilter ( FMPSMBUS_HandleTypeDef * hfmpsmbus,
uint32_t AnalogFilter )

#include <stm32f4xx_hal_fmpsmbus.h>

Configure Analog noise filter.

Parameters
hfmpsmbusPointer to a FMPSMBUS_HandleTypeDef structure that contains the configuration information for the specified FMPSMBUS.
AnalogFilterThis parameter can be one of the following values:
Return values
HALstatus

Definition at line 495 of file stm32f4xx_hal_fmpsmbus.c.

References __HAL_FMPSMBUS_DISABLE, __HAL_FMPSMBUS_ENABLE, __HAL_LOCK, __HAL_UNLOCK, assert_param, HAL_BUSY, HAL_FMPSMBUS_STATE_BUSY, HAL_FMPSMBUS_STATE_READY, HAL_OK, FMPSMBUS_HandleTypeDef::Instance, IS_FMPSMBUS_ANALOG_FILTER, and FMPSMBUS_HandleTypeDef::State.

◆ HAL_FMPSMBUS_ConfigDigitalFilter()

HAL_StatusTypeDef HAL_FMPSMBUS_ConfigDigitalFilter ( FMPSMBUS_HandleTypeDef * hfmpsmbus,
uint32_t DigitalFilter )

#include <stm32f4xx_hal_fmpsmbus.h>

Configure Digital noise filter.

Parameters
hfmpsmbusPointer to a FMPSMBUS_HandleTypeDef structure that contains the configuration information for the specified FMPSMBUS.
DigitalFilterCoefficient of digital noise filter between Min_Data=0x00 and Max_Data=0x0F.
Return values
HALstatus

Definition at line 539 of file stm32f4xx_hal_fmpsmbus.c.

References __HAL_FMPSMBUS_DISABLE, __HAL_FMPSMBUS_ENABLE, __HAL_LOCK, __HAL_UNLOCK, assert_param, HAL_BUSY, HAL_FMPSMBUS_STATE_BUSY, HAL_FMPSMBUS_STATE_READY, HAL_OK, FMPSMBUS_HandleTypeDef::Instance, IS_FMPSMBUS_DIGITAL_FILTER, and FMPSMBUS_HandleTypeDef::State.