STM32F479xx HAL User Manual
Data Structures | Typedefs | Enumerations
SMBUS Exported Types
SMBUS

Data Structures

struct  SMBUS_InitTypeDef
 SMBUS Configuration Structure definition. More...
struct  __SMBUS_HandleTypeDef
 SMBUS handle Structure definition. More...

Typedefs

typedef struct
__SMBUS_HandleTypeDef 
SMBUS_HandleTypeDef
 SMBUS handle Structure definition.
typedef void(* pSMBUS_CallbackTypeDef )(SMBUS_HandleTypeDef *hsmbus)
 HAL SMBUS Callback pointer definition.
typedef void(* pSMBUS_AddrCallbackTypeDef )(SMBUS_HandleTypeDef *hsmbus, uint8_t TransferDirection, uint16_t AddrMatchCode)

Enumerations

enum  HAL_SMBUS_StateTypeDef {
  HAL_SMBUS_STATE_RESET = 0x00U, HAL_SMBUS_STATE_READY = 0x20U, HAL_SMBUS_STATE_BUSY = 0x24U, HAL_SMBUS_STATE_BUSY_TX = 0x21U,
  HAL_SMBUS_STATE_BUSY_RX = 0x22U, HAL_SMBUS_STATE_LISTEN = 0x28U, HAL_SMBUS_STATE_BUSY_TX_LISTEN = 0x29U, HAL_SMBUS_STATE_BUSY_RX_LISTEN = 0x2AU,
  HAL_SMBUS_STATE_ABORT = 0x60U, HAL_SMBUS_STATE_TIMEOUT = 0xA0U, HAL_SMBUS_STATE_ERROR = 0xE0U
}
 HAL State structure definition. More...
enum  HAL_SMBUS_ModeTypeDef { HAL_SMBUS_MODE_NONE = 0x00U, HAL_SMBUS_MODE_MASTER = 0x10U, HAL_SMBUS_MODE_SLAVE = 0x20U }
 HAL Mode structure definition. More...
enum  HAL_SMBUS_CallbackIDTypeDef {
  HAL_SMBUS_MASTER_TX_COMPLETE_CB_ID = 0x00U, HAL_SMBUS_MASTER_RX_COMPLETE_CB_ID = 0x01U, HAL_SMBUS_SLAVE_TX_COMPLETE_CB_ID = 0x02U, HAL_SMBUS_SLAVE_RX_COMPLETE_CB_ID = 0x03U,
  HAL_SMBUS_LISTEN_COMPLETE_CB_ID = 0x04U, HAL_SMBUS_ERROR_CB_ID = 0x07U, HAL_SMBUS_ABORT_CB_ID = 0x08U, HAL_SMBUS_MSPINIT_CB_ID = 0x09U,
  HAL_SMBUS_MSPDEINIT_CB_ID = 0x0AU
}
 HAL SMBUS Callback ID enumeration definition. More...

Typedef Documentation

typedef void(* pSMBUS_AddrCallbackTypeDef)(SMBUS_HandleTypeDef *hsmbus, uint8_t TransferDirection, uint16_t AddrMatchCode)

pointer to an I2C Address Match callback function

Definition at line 223 of file stm32f4xx_hal_smbus.h.

typedef void(* pSMBUS_CallbackTypeDef)(SMBUS_HandleTypeDef *hsmbus)

HAL SMBUS Callback pointer definition.

pointer to an I2C callback function

Definition at line 222 of file stm32f4xx_hal_smbus.h.

SMBUS handle Structure definition.


Enumeration Type Documentation

HAL SMBUS Callback ID enumeration definition.

Enumerator:
HAL_SMBUS_MASTER_TX_COMPLETE_CB_ID 

SMBUS Master Tx Transfer completed callback ID

HAL_SMBUS_MASTER_RX_COMPLETE_CB_ID 

SMBUS Master Rx Transfer completed callback ID

HAL_SMBUS_SLAVE_TX_COMPLETE_CB_ID 

SMBUS Slave Tx Transfer completed callback ID

HAL_SMBUS_SLAVE_RX_COMPLETE_CB_ID 

SMBUS Slave Rx Transfer completed callback ID

HAL_SMBUS_LISTEN_COMPLETE_CB_ID 

SMBUS Listen Complete callback ID

HAL_SMBUS_ERROR_CB_ID 

SMBUS Error callback ID

HAL_SMBUS_ABORT_CB_ID 

SMBUS Abort callback ID

HAL_SMBUS_MSPINIT_CB_ID 

SMBUS Msp Init callback ID

HAL_SMBUS_MSPDEINIT_CB_ID 

SMBUS Msp DeInit callback ID

Definition at line 205 of file stm32f4xx_hal_smbus.h.

HAL Mode structure definition.

Note:
HAL SMBUS Mode value coding follow below described bitmap : b7 (not used) x : Should be set to 0 b6 (not used) x : Should be set to 0 b5 0 : None 1 : Slave (HAL SMBUS communication is in Slave/Device Mode) b4 0 : None 1 : Master (HAL SMBUS communication is in Master/Host Mode) b3-b2-b1-b0 (not used) xxxx : Should be set to 0000
Enumerator:
HAL_SMBUS_MODE_NONE 

No SMBUS communication on going

HAL_SMBUS_MODE_MASTER 

SMBUS communication is in Master Mode

HAL_SMBUS_MODE_SLAVE 

SMBUS communication is in Slave Mode

Definition at line 141 of file stm32f4xx_hal_smbus.h.

HAL State structure definition.

Note:
HAL SMBUS State value coding follow below described bitmap : b7-b6 Error information 00 : No Error 01 : Abort (Abort user request on going) 10 : Timeout 11 : Error b5 IP initialisation status 0 : Reset (IP not initialized) 1 : Init done (IP initialized and ready to use. HAL SMBUS Init function called) b4 (not used) x : Should be set to 0 b3 0 : Ready or Busy (No Listen mode ongoing) 1 : Listen (IP in Address Listen Mode) b2 Intrinsic process state 0 : Ready 1 : Busy (IP busy with some configuration or internal operations) b1 Rx state 0 : Ready (no Rx operation ongoing) 1 : Busy (Rx operation ongoing) b0 Tx state 0 : Ready (no Tx operation ongoing) 1 : Busy (Tx operation ongoing)
Enumerator:
HAL_SMBUS_STATE_RESET 

Peripheral is not yet Initialized

HAL_SMBUS_STATE_READY 

Peripheral Initialized and ready for use

HAL_SMBUS_STATE_BUSY 

An internal process is ongoing

HAL_SMBUS_STATE_BUSY_TX 

Data Transmission process is ongoing

HAL_SMBUS_STATE_BUSY_RX 

Data Reception process is ongoing

HAL_SMBUS_STATE_LISTEN 

Address Listen Mode is ongoing

HAL_SMBUS_STATE_BUSY_TX_LISTEN 

Address Listen Mode and Data Transmission process is ongoing

HAL_SMBUS_STATE_BUSY_RX_LISTEN 

Address Listen Mode and Data Reception process is ongoing

HAL_SMBUS_STATE_ABORT 

Abort user request ongoing

HAL_SMBUS_STATE_TIMEOUT 

Timeout state

HAL_SMBUS_STATE_ERROR 

Error

Definition at line 107 of file stm32f4xx_hal_smbus.h.