Data transfers functions. More...

Modules
	Blocking mode Polling
	Non-Blocking mode Interrupt
	IRQ Handler and Callbacks
	Peripheral State, Mode and Error functions
	Peripheral State and Errors functions.
Functions
HAL_StatusTypeDef	HAL_SMBUS_Master_Transmit_IT (SMBUS_HandleTypeDef hsmbus, uint16_t DevAddress, uint8_t pData, uint16_t Size, uint32_t XferOptions)
	Transmits in master mode an amount of data in blocking mode.
HAL_StatusTypeDef	HAL_SMBUS_Master_Receive_IT (SMBUS_HandleTypeDef hsmbus, uint16_t DevAddress, uint8_t pData, uint16_t Size, uint32_t XferOptions)
	Receive in master/host SMBUS mode an amount of data in non blocking mode with Interrupt.
HAL_StatusTypeDef	HAL_SMBUS_Master_Abort_IT (SMBUS_HandleTypeDef *hsmbus, uint16_t DevAddress)
	Abort a master/host SMBUS process communication with Interrupt.
HAL_StatusTypeDef	HAL_SMBUS_Slave_Transmit_IT (SMBUS_HandleTypeDef hsmbus, uint8_t pData, uint16_t Size, uint32_t XferOptions)
	Transmit in slave/device SMBUS mode an amount of data in non blocking mode with Interrupt.
HAL_StatusTypeDef	HAL_SMBUS_Slave_Receive_IT (SMBUS_HandleTypeDef hsmbus, uint8_t pData, uint16_t Size, uint32_t XferOptions)
	Enable the Address listen mode with Interrupt.
HAL_StatusTypeDef	HAL_SMBUS_EnableListen_IT (SMBUS_HandleTypeDef *hsmbus)
	Enable the Address listen mode with Interrupt.
HAL_StatusTypeDef	HAL_SMBUS_DisableListen_IT (SMBUS_HandleTypeDef *hsmbus)
	Disable the Address listen mode with Interrupt.
HAL_StatusTypeDef	HAL_SMBUS_EnableAlert_IT (SMBUS_HandleTypeDef *hsmbus)
	Enable the SMBUS alert mode with Interrupt.
HAL_StatusTypeDef	HAL_SMBUS_DisableAlert_IT (SMBUS_HandleTypeDef *hsmbus)
	Disable the SMBUS alert mode with Interrupt.
HAL_StatusTypeDef	HAL_SMBUS_IsDeviceReady (SMBUS_HandleTypeDef *hsmbus, uint16_t DevAddress, uint32_t Trials, uint32_t Timeout)
	Check if target device is ready for communication.
void	HAL_SMBUS_EV_IRQHandler (SMBUS_HandleTypeDef *hsmbus)
	This function handles SMBUS event interrupt request.
void	HAL_SMBUS_ER_IRQHandler (SMBUS_HandleTypeDef *hsmbus)
	This function handles SMBUS error interrupt request.
__weak void	HAL_SMBUS_MasterTxCpltCallback (SMBUS_HandleTypeDef *hsmbus)
	Master Tx Transfer completed callback.
__weak void	HAL_SMBUS_MasterRxCpltCallback (SMBUS_HandleTypeDef *hsmbus)
	Master Rx Transfer completed callback.
__weak void	HAL_SMBUS_SlaveTxCpltCallback (SMBUS_HandleTypeDef *hsmbus)
	Slave Tx Transfer completed callback.
__weak void	HAL_SMBUS_SlaveRxCpltCallback (SMBUS_HandleTypeDef *hsmbus)
	Slave Rx Transfer completed callback.
__weak void	HAL_SMBUS_AddrCallback (SMBUS_HandleTypeDef *hsmbus, uint8_t TransferDirection, uint16_t AddrMatchCode)
	Slave Address Match callback.
__weak void	HAL_SMBUS_ListenCpltCallback (SMBUS_HandleTypeDef *hsmbus)
	Listen Complete callback.
__weak void	HAL_SMBUS_ErrorCallback (SMBUS_HandleTypeDef *hsmbus)
	SMBUS error callback.
__weak void	HAL_SMBUS_AbortCpltCallback (SMBUS_HandleTypeDef *hsmbus)
	SMBUS abort callback.

Detailed Description

Data transfers functions.

 ===============================================================================
                      ##### IO operation functions #####
 ===============================================================================
    [..]
    This subsection provides a set of functions allowing to manage the SMBUS data
    transfers.

    (#) Blocking mode function to check if device is ready for usage is :
        (++) HAL_SMBUS_IsDeviceReady()

    (#) There is only one mode of transfer:
       (++) Non Blocking mode : The communication is performed using Interrupts.
            These functions return the status of the transfer startup.
            The end of the data processing will be indicated through the
            dedicated SMBUS IRQ when using Interrupt mode.

    (#) Non Blocking mode functions with Interrupt are :
        (++) HAL_SMBUS_Master_Transmit_IT()
        (++) HAL_SMBUS_Master_Receive_IT()
        (++) HAL_SMBUS_Master_Abort_IT()
        (++) HAL_SMBUS_Slave_Transmit_IT()
        (++) HAL_SMBUS_Slave_Receive_IT()
        (++) HAL_SMBUS_EnableAlert_IT()
        (++) HAL_SMBUS_DisableAlert_IT()

    (#) A set of Transfer Complete Callbacks are provided in No_Blocking mode:
        (++) HAL_SMBUS_MasterTxCpltCallback()
        (++) HAL_SMBUS_MasterRxCpltCallback()
        (++) HAL_SMBUS_SlaveTxCpltCallback()
        (++) HAL_SMBUS_SlaveRxCpltCallback()
        (++) HAL_SMBUS_AddrCallback()
        (++) HAL_SMBUS_ListenCpltCallback()
        (++) HAL_SMBUS_ErrorCallback()
        (++) HAL_SMBUS_AbortCpltCallback()

Function Documentation

__weak void HAL_SMBUS_AbortCpltCallback ( SMBUS_HandleTypeDef * hsmbus )

SMBUS abort callback.

Parameters:

hsmbus Pointer to a SMBUS_HandleTypeDef structure that contains the configuration information for the specified SMBUS.

Return values:

None

Definition at line 1843 of file stm32f4xx_hal_smbus.c.

Referenced by HAL_SMBUS_Init(), HAL_SMBUS_UnRegisterCallback(), and SMBUS_ITError().

__weak void HAL_SMBUS_AddrCallback	(	SMBUS_HandleTypeDef *	hsmbus,
		uint8_t	TransferDirection,
		uint16_t	AddrMatchCode
	)

Slave Address Match callback.

Parameters:

hsmbus	Pointer to a SMBUS_HandleTypeDef structure that contains the configuration information for the specified SMBUS.
TransferDirection	Master request Transfer Direction (Write/Read), value of SMBUS XferOptions definition
AddrMatchCode	Address Match Code

Return values:

None

Definition at line 1793 of file stm32f4xx_hal_smbus.c.

Referenced by HAL_SMBUS_Init(), HAL_SMBUS_UnRegisterAddrCallback(), and SMBUS_Slave_ADDR().

HAL_StatusTypeDef HAL_SMBUS_DisableAlert_IT ( SMBUS_HandleTypeDef * hsmbus )

Disable the SMBUS alert mode with Interrupt.

Parameters:

hsmbus Pointer to a SMBUS_HandleTypeDef structure that contains the configuration information for the specified SMBUSx peripheral.

Return values:

HAL status

Definition at line 1371 of file stm32f4xx_hal_smbus.c.

References __HAL_SMBUS_DISABLE_IT, __SMBUS_HandleTypeDef::Instance, and SMBUS_IT_ERR.

HAL_StatusTypeDef HAL_SMBUS_DisableListen_IT ( SMBUS_HandleTypeDef * hsmbus )

Disable the Address listen mode with Interrupt.

Parameters:

hsmbus Pointer to a SMBUS_HandleTypeDef structure that contains the configuration information for the specified SMBUS.

Return values:

HAL status

Definition at line 1319 of file stm32f4xx_hal_smbus.c.

References __HAL_SMBUS_DISABLE_IT, HAL_SMBUS_MODE_NONE, HAL_SMBUS_STATE_LISTEN, HAL_SMBUS_STATE_READY, __SMBUS_HandleTypeDef::Instance, __SMBUS_HandleTypeDef::Mode, __SMBUS_HandleTypeDef::PreviousState, SMBUS_IT_ERR, SMBUS_IT_EVT, SMBUS_STATE_MSK, and __SMBUS_HandleTypeDef::State.

HAL_StatusTypeDef HAL_SMBUS_EnableAlert_IT ( SMBUS_HandleTypeDef * hsmbus )

Enable the SMBUS alert mode with Interrupt.

Parameters:

hsmbus Pointer to a SMBUS_HandleTypeDef structure that contains the configuration information for the specified SMBUSx peripheral.

Return values:

HAL status

Definition at line 1352 of file stm32f4xx_hal_smbus.c.

References __HAL_SMBUS_CLEAR_FLAG, __HAL_SMBUS_ENABLE_IT, __SMBUS_HandleTypeDef::Instance, SMBUS_FLAG_SMBALERT, and SMBUS_IT_ERR.

HAL_StatusTypeDef HAL_SMBUS_EnableListen_IT ( SMBUS_HandleTypeDef * hsmbus )

Enable the Address listen mode with Interrupt.

Parameters:

hsmbus Pointer to a SMBUS_HandleTypeDef structure that contains the configuration information for the specified SMBUS.

Return values:

HAL status

Definition at line 1286 of file stm32f4xx_hal_smbus.c.

References __HAL_SMBUS_ENABLE, __HAL_SMBUS_ENABLE_IT, HAL_SMBUS_STATE_LISTEN, HAL_SMBUS_STATE_READY, __SMBUS_HandleTypeDef::Instance, SMBUS_IT_ERR, SMBUS_IT_EVT, and __SMBUS_HandleTypeDef::State.

void HAL_SMBUS_ER_IRQHandler ( SMBUS_HandleTypeDef * hsmbus )

This function handles SMBUS error interrupt request.

Parameters:

hsmbus Pointer to a SMBUS_HandleTypeDef structure that contains the configuration information for the specified SMBUS.

Return values:

None

Definition at line 1622 of file stm32f4xx_hal_smbus.c.

References __HAL_SMBUS_CLEAR_FLAG, __SMBUS_HandleTypeDef::ErrorCode, HAL_SMBUS_ERROR_AF, HAL_SMBUS_ERROR_ALERT, HAL_SMBUS_ERROR_ARLO, HAL_SMBUS_ERROR_BERR, HAL_SMBUS_ERROR_NONE, HAL_SMBUS_ERROR_OVR, HAL_SMBUS_ERROR_PECERR, HAL_SMBUS_ERROR_TIMEOUT, HAL_SMBUS_MODE_MASTER, HAL_SMBUS_MODE_SLAVE, HAL_SMBUS_STATE_BUSY_TX, HAL_SMBUS_STATE_BUSY_TX_LISTEN, HAL_SMBUS_STATE_LISTEN, __SMBUS_HandleTypeDef::Instance, __SMBUS_HandleTypeDef::Mode, __SMBUS_HandleTypeDef::PreviousState, SMBUS_FLAG_AF, SMBUS_FLAG_ARLO, SMBUS_FLAG_BERR, SMBUS_FLAG_OVR, SMBUS_FLAG_PECERR, SMBUS_FLAG_SMBALERT, SMBUS_FLAG_TIMEOUT, SMBUS_IT_ERR, SMBUS_ITError(), SMBUS_Slave_AF(), SMBUS_STATE_SLAVE_BUSY_TX, __SMBUS_HandleTypeDef::State, and __SMBUS_HandleTypeDef::XferCount.

__weak void HAL_SMBUS_ErrorCallback ( SMBUS_HandleTypeDef * hsmbus )

SMBUS error callback.

Parameters:

hsmbus Pointer to a SMBUS_HandleTypeDef structure that contains the configuration information for the specified SMBUS.

Return values:

None

Definition at line 1827 of file stm32f4xx_hal_smbus.c.

Referenced by HAL_SMBUS_Init(), HAL_SMBUS_UnRegisterCallback(), and SMBUS_ITError().

void HAL_SMBUS_EV_IRQHandler ( SMBUS_HandleTypeDef * hsmbus )

This function handles SMBUS event interrupt request.

Parameters:

hsmbus Pointer to a SMBUS_HandleTypeDef structure that contains the configuration information for the specified SMBUS.

Return values:

None

Definition at line 1517 of file stm32f4xx_hal_smbus.c.

References HAL_SMBUS_MODE_MASTER, __SMBUS_HandleTypeDef::Instance, __SMBUS_HandleTypeDef::Mode, SMBUS_FLAG_ADD10, SMBUS_FLAG_ADDR, SMBUS_FLAG_BTF, SMBUS_FLAG_RXNE, SMBUS_FLAG_SB, SMBUS_FLAG_STOPF, SMBUS_FLAG_TRA, SMBUS_FLAG_TXE, SMBUS_IT_BUF, SMBUS_IT_EVT, SMBUS_Master_ADD10(), SMBUS_Master_ADDR(), SMBUS_Master_SB(), SMBUS_MasterReceive_BTF(), SMBUS_MasterReceive_RXNE(), SMBUS_MasterTransmit_BTF(), SMBUS_MasterTransmit_TXE(), SMBUS_Slave_ADDR(), SMBUS_Slave_STOPF(), SMBUS_SlaveReceive_BTF(), SMBUS_SlaveReceive_RXNE(), SMBUS_SlaveTransmit_BTF(), and SMBUS_SlaveTransmit_TXE().

HAL_StatusTypeDef HAL_SMBUS_IsDeviceReady	(	SMBUS_HandleTypeDef *	hsmbus,
		uint16_t	DevAddress,
		uint32_t	Trials,
		uint32_t	Timeout
	)

Check if target device is ready for communication.

Parameters:

hsmbus	Pointer to a SMBUS_HandleTypeDef structure that contains the configuration information for the specified SMBUS.
DevAddress	Target device address The device 7 bits address value in datasheet must be shifted to the left before calling the interface
Trials	Number of trials
Timeout	Timeout duration

Return values:

HAL status

Definition at line 1393 of file stm32f4xx_hal_smbus.c.

References __HAL_SMBUS_CLEAR_ADDRFLAG, __HAL_SMBUS_CLEAR_FLAG, __HAL_SMBUS_ENABLE, __HAL_SMBUS_GET_FLAG, __SMBUS_HandleTypeDef::ErrorCode, HAL_GetTick(), HAL_SMBUS_ERROR_NONE, HAL_SMBUS_STATE_BUSY, HAL_SMBUS_STATE_READY, HAL_SMBUS_STATE_TIMEOUT, __SMBUS_HandleTypeDef::Instance, SMBUS_7BIT_ADD_WRITE, SMBUS_FLAG_ADDR, SMBUS_FLAG_AF, SMBUS_FLAG_BUSY, SMBUS_FLAG_SB, SMBUS_NO_OPTION_FRAME, SMBUS_TIMEOUT_BUSY_FLAG, SMBUS_WaitOnFlagUntilTimeout(), __SMBUS_HandleTypeDef::State, and __SMBUS_HandleTypeDef::XferOptions.

__weak void HAL_SMBUS_ListenCpltCallback ( SMBUS_HandleTypeDef * hsmbus )

Listen Complete callback.

Parameters:

hsmbus Pointer to a SMBUS_HandleTypeDef structure that contains the configuration information for the specified SMBUS.

Return values:

None

Definition at line 1811 of file stm32f4xx_hal_smbus.c.

Referenced by HAL_SMBUS_Init(), HAL_SMBUS_UnRegisterCallback(), SMBUS_ITError(), SMBUS_Slave_AF(), and SMBUS_Slave_STOPF().

HAL_StatusTypeDef HAL_SMBUS_Master_Abort_IT	(	SMBUS_HandleTypeDef *	hsmbus,
		uint16_t	DevAddress
	)

Abort a master/host SMBUS process communication with Interrupt.

Note:: This abort can be called only if state is ready

Parameters:

hsmbus	Pointer to a SMBUS_HandleTypeDef structure that contains the configuration information for the specified SMBUS.
DevAddress	Target device address The device 7 bits address value in datasheet must be shifted to the left before calling the interface

Return values:

HAL status

Definition at line 1106 of file stm32f4xx_hal_smbus.c.

References __HAL_SMBUS_DISABLE_IT, __SMBUS_HandleTypeDef::ErrorCode, HAL_SMBUS_ERROR_NONE, HAL_SMBUS_STATE_ABORT, __SMBUS_HandleTypeDef::Init, __SMBUS_HandleTypeDef::Instance, SMBUS_InitTypeDef::PeripheralMode, __SMBUS_HandleTypeDef::PreviousState, SMBUS_IT_BUF, SMBUS_IT_ERR, SMBUS_IT_EVT, SMBUS_ITError(), SMBUS_PERIPHERAL_MODE_SMBUS_HOST, SMBUS_STATE_NONE, __SMBUS_HandleTypeDef::State, and __SMBUS_HandleTypeDef::XferCount.

HAL_StatusTypeDef HAL_SMBUS_Master_Receive_IT	(	SMBUS_HandleTypeDef *	hsmbus,
		uint16_t	DevAddress,
		uint8_t *	pData,
		uint16_t	Size,
		uint32_t	XferOptions
	)

Receive in master/host SMBUS mode an amount of data in non blocking mode with Interrupt.

Parameters:

hsmbus	Pointer to a SMBUS_HandleTypeDef structure that contains the configuration information for the specified SMBUS.
DevAddress	Target device address The device 7 bits address value in datasheet must be shifted to the left before calling the interface
pData	Pointer to data buffer
Size	Amount of data to be sent
XferOptions	Options of Transfer, value of SMBUS XferOptions definition

Return values:

HAL status

Definition at line 992 of file stm32f4xx_hal_smbus.c.

HAL_StatusTypeDef HAL_SMBUS_Master_Transmit_IT	(	SMBUS_HandleTypeDef *	hsmbus,
		uint16_t	DevAddress,
		uint8_t *	pData,
		uint16_t	Size,
		uint32_t	XferOptions
	)

Transmits in master mode an amount of data in blocking mode.

Parameters:

hsmbus	Pointer to a SMBUS_HandleTypeDef structure that contains the configuration information for the specified SMBUS.
DevAddress	Target device address The device 7 bits address value in datasheet must be shifted to the left before calling the interface
pData	Pointer to data buffer
Size	Amount of data to be sent
XferOptions	Options of Transfer

Return values:

HAL status

Definition at line 907 of file stm32f4xx_hal_smbus.c.

__weak void HAL_SMBUS_MasterRxCpltCallback ( SMBUS_HandleTypeDef * hsmbus )

Master Rx Transfer completed callback.

Parameters:

hsmbus Pointer to a SMBUS_HandleTypeDef structure that contains the configuration information for the specified SMBUS.

Return values:

None

Definition at line 1744 of file stm32f4xx_hal_smbus.c.

Referenced by HAL_SMBUS_Init(), HAL_SMBUS_UnRegisterCallback(), SMBUS_MasterReceive_BTF(), and SMBUS_MasterReceive_RXNE().

__weak void HAL_SMBUS_MasterTxCpltCallback ( SMBUS_HandleTypeDef * hsmbus )

Master Tx Transfer completed callback.

Parameters:

hsmbus Pointer to a SMBUS_HandleTypeDef structure that contains the configuration information for the specified SMBUS.

Return values:

None

Definition at line 1728 of file stm32f4xx_hal_smbus.c.

Referenced by HAL_SMBUS_Init(), HAL_SMBUS_UnRegisterCallback(), SMBUS_MasterTransmit_BTF(), and SMBUS_MasterTransmit_TXE().

HAL_StatusTypeDef HAL_SMBUS_Slave_Receive_IT	(	SMBUS_HandleTypeDef *	hsmbus,
		uint8_t *	pData,
		uint16_t	Size,
		uint32_t	XferOptions
	)

Enable the Address listen mode with Interrupt.

Parameters:

hsmbus	Pointer to a SMBUS_HandleTypeDef structure that contains the configuration information for the specified SMBUS.
pData	Pointer to data buffer
Size	Amount of data to be sent
XferOptions	Options of Transfer, value of SMBUS XferOptions definition

Return values:

HAL status

Definition at line 1222 of file stm32f4xx_hal_smbus.c.

HAL_StatusTypeDef HAL_SMBUS_Slave_Transmit_IT	(	SMBUS_HandleTypeDef *	hsmbus,
		uint8_t *	pData,
		uint16_t	Size,
		uint32_t	XferOptions
	)

Transmit in slave/device SMBUS mode an amount of data in non blocking mode with Interrupt.

Parameters:

hsmbus	Pointer to a SMBUS_HandleTypeDef structure that contains the configuration information for the specified SMBUS.
pData	Pointer to data buffer
Size	Amount of data to be sent
XferOptions	Options of Transfer, value of SMBUS XferOptions definition

Return values:

HAL status

Definition at line 1156 of file stm32f4xx_hal_smbus.c.

__weak void HAL_SMBUS_SlaveRxCpltCallback ( SMBUS_HandleTypeDef * hsmbus )

Slave Rx Transfer completed callback.

Parameters:

hsmbus Pointer to a SMBUS_HandleTypeDef structure that contains the configuration information for the specified SMBUS.

Return values:

None

Definition at line 1775 of file stm32f4xx_hal_smbus.c.

Referenced by HAL_SMBUS_Init(), HAL_SMBUS_UnRegisterCallback(), and SMBUS_SlaveReceive_RXNE().

__weak void HAL_SMBUS_SlaveTxCpltCallback ( SMBUS_HandleTypeDef * hsmbus )

Slave Tx Transfer completed callback.

Parameters:

hsmbus Pointer to a SMBUS_HandleTypeDef structure that contains the configuration information for the specified SMBUS.

Return values:

None

Definition at line 1759 of file stm32f4xx_hal_smbus.c.

Referenced by HAL_SMBUS_Init(), HAL_SMBUS_UnRegisterCallback(), and SMBUS_SlaveTransmit_TXE().

Modules

Functions

Detailed Description

Function Documentation