Initialization and Configuration functions.
More...
Initialization and Configuration functions.
===============================================================================
##### Initialization and de-initialization functions #####
===============================================================================
[..] This subsection provides a set of functions allowing to initialize and
deinitialize the FMPI2Cx peripheral:
(+) User must Implement HAL_FMPI2C_MspInit() function in which he configures
all related peripherals resources (CLOCK, GPIO, DMA, IT and NVIC ).
(+) Call the function HAL_FMPI2C_Init() to configure the selected device with
the selected configuration:
(++) Clock Timing
(++) Own Address 1
(++) Addressing mode (Master, Slave)
(++) Dual Addressing mode
(++) Own Address 2
(++) Own Address 2 Mask
(++) General call mode
(++) Nostretch mode
(+) Call the function HAL_FMPI2C_DeInit() to restore the default configuration
of the selected FMPI2Cx peripheral.
◆ HAL_FMPI2C_DeInit()
DeInitialize the FMPI2C peripheral.
- Parameters
-
hfmpi2c | Pointer to a FMPI2C_HandleTypeDef structure that contains the configuration information for the specified FMPI2C. |
- Return values
-
Definition at line 659 of file stm32f4xx_hal_fmpi2c.c.
◆ HAL_FMPI2C_Init()
Initializes the FMPI2C according to the specified parameters in the FMPI2C_InitTypeDef and initialize the associated handle.
- Parameters
-
hfmpi2c | Pointer to a FMPI2C_HandleTypeDef structure that contains the configuration information for the specified FMPI2C. |
- Return values
-
Definition at line 544 of file stm32f4xx_hal_fmpi2c.c.
◆ HAL_FMPI2C_MspDeInit()
DeInitialize the FMPI2C MSP.
- Parameters
-
hfmpi2c | Pointer to a FMPI2C_HandleTypeDef structure that contains the configuration information for the specified FMPI2C. |
- Return values
-
Definition at line 721 of file stm32f4xx_hal_fmpi2c.c.
◆ HAL_FMPI2C_MspInit()
Initialize the FMPI2C MSP.
- Parameters
-
hfmpi2c | Pointer to a FMPI2C_HandleTypeDef structure that contains the configuration information for the specified FMPI2C. |
- Return values
-
Definition at line 705 of file stm32f4xx_hal_fmpi2c.c.
◆ HAL_FMPI2C_RegisterAddrCallback()
Register the Slave Address Match FMPI2C Callback To be used instead of the weak HAL_FMPI2C_AddrCallback() predefined callback.
- Parameters
-
hfmpi2c | Pointer to a FMPI2C_HandleTypeDef structure that contains the configuration information for the specified FMPI2C. |
pCallback | pointer to the Address Match Callback function |
- Return values
-
Definition at line 983 of file stm32f4xx_hal_fmpi2c.c.
◆ HAL_FMPI2C_RegisterCallback()
Register a User FMPI2C Callback To be used instead of the weak predefined callback.
- Note
- The HAL_FMPI2C_RegisterCallback() may be called before HAL_FMPI2C_Init() in HAL_FMPI2C_STATE_RESET to register callbacks for HAL_FMPI2C_MSPINIT_CB_ID and HAL_FMPI2C_MSPDEINIT_CB_ID.
- Parameters
-
hfmpi2c | Pointer to a FMPI2C_HandleTypeDef structure that contains the configuration information for the specified FMPI2C. |
CallbackID | ID of the callback to be registered This parameter can be one of the following values:
|
pCallback | pointer to the Callback function |
- Return values
-
Definition at line 755 of file stm32f4xx_hal_fmpi2c.c.
◆ HAL_FMPI2C_UnRegisterAddrCallback()
UnRegister the Slave Address Match FMPI2C Callback Info Ready FMPI2C Callback is redirected to the weak HAL_FMPI2C_AddrCallback() predefined callback.
- Parameters
-
hfmpi2c | Pointer to a FMPI2C_HandleTypeDef structure that contains the configuration information for the specified FMPI2C. |
- Return values
-
Definition at line 1018 of file stm32f4xx_hal_fmpi2c.c.
◆ HAL_FMPI2C_UnRegisterCallback()
Unregister an FMPI2C Callback FMPI2C callback is redirected to the weak predefined callback.
- Note
- The HAL_FMPI2C_UnRegisterCallback() may be called before HAL_FMPI2C_Init() in HAL_FMPI2C_STATE_RESET to un-register callbacks for HAL_FMPI2C_MSPINIT_CB_ID and HAL_FMPI2C_MSPDEINIT_CB_ID.
- Parameters
-
hfmpi2c | Pointer to a FMPI2C_HandleTypeDef structure that contains the configuration information for the specified FMPI2C. |
CallbackID | ID of the callback to be unregistered This parameter can be one of the following values: This parameter can be one of the following values:
|
- Return values
-
Definition at line 881 of file stm32f4xx_hal_fmpi2c.c.