SMBUS HAL module driver. This file provides firmware functions to manage the following functionalities of the System Management Bus (SMBus) peripheral, based on I2C principles of operation : More...

Functions
static HAL_StatusTypeDef	SMBUS_WaitOnFlagUntilTimeout (struct __SMBUS_HandleTypeDef *hsmbus, uint32_t Flag, FlagStatus Status, uint32_t Timeout)
	Handle SMBUS Communication Timeout. More...

static void	SMBUS_Enable_IRQ (struct __SMBUS_HandleTypeDef *hsmbus, uint32_t InterruptRequest)
	Manage the enabling of Interrupts. More...

static void	SMBUS_Disable_IRQ (struct __SMBUS_HandleTypeDef *hsmbus, uint32_t InterruptRequest)
	Manage the disabling of Interrupts. More...

static HAL_StatusTypeDef	SMBUS_Master_ISR (struct __SMBUS_HandleTypeDef *hsmbus, uint32_t StatusFlags)
	Interrupt Sub-Routine which handle the Interrupt Flags Master Mode. More...

static HAL_StatusTypeDef	SMBUS_Slave_ISR (struct __SMBUS_HandleTypeDef *hsmbus, uint32_t StatusFlags)
	Interrupt Sub-Routine which handle the Interrupt Flags Slave Mode. More...

static void	SMBUS_ConvertOtherXferOptions (struct __SMBUS_HandleTypeDef *hsmbus)
	Convert SMBUSx OTHER_xxx XferOptions to functionnal XferOptions. More...

static void	SMBUS_ITErrorHandler (struct __SMBUS_HandleTypeDef *hsmbus)
	SMBUS interrupts error handler. More...

static void	SMBUS_TransferConfig (struct __SMBUS_HandleTypeDef *hsmbus, uint16_t DevAddress, uint8_t Size, uint32_t Mode, uint32_t Request)
	Handle SMBUSx communication when starting transfer or during transfer (TC or TCR flag are set). More...

HAL_StatusTypeDef	HAL_SMBUS_Init (SMBUS_HandleTypeDef *hsmbus)
	Initialize the SMBUS according to the specified parameters in the SMBUS_InitTypeDef and initialize the associated handle. More...

HAL_StatusTypeDef	HAL_SMBUS_DeInit (SMBUS_HandleTypeDef *hsmbus)
	DeInitialize the SMBUS peripheral. More...

void	HAL_SMBUS_MspInit (SMBUS_HandleTypeDef *hsmbus)
	Initialize the SMBUS MSP. More...

void	HAL_SMBUS_MspDeInit (SMBUS_HandleTypeDef *hsmbus)
	DeInitialize the SMBUS MSP. More...

HAL_StatusTypeDef	HAL_SMBUS_ConfigAnalogFilter (SMBUS_HandleTypeDef *hsmbus, uint32_t AnalogFilter)
	Configure Analog noise filter. More...

HAL_StatusTypeDef	HAL_SMBUS_ConfigDigitalFilter (SMBUS_HandleTypeDef *hsmbus, uint32_t DigitalFilter)
	Configure Digital noise filter. More...

HAL_StatusTypeDef	HAL_SMBUS_RegisterCallback (SMBUS_HandleTypeDef *hsmbus, HAL_SMBUS_CallbackIDTypeDef CallbackID, pSMBUS_CallbackTypeDef pCallback)
	Register a User SMBUS Callback To be used instead of the weak predefined callback. More...

HAL_StatusTypeDef	HAL_SMBUS_UnRegisterCallback (SMBUS_HandleTypeDef *hsmbus, HAL_SMBUS_CallbackIDTypeDef CallbackID)
	Unregister an SMBUS Callback SMBUS callback is redirected to the weak predefined callback. More...

HAL_StatusTypeDef	HAL_SMBUS_RegisterAddrCallback (SMBUS_HandleTypeDef *hsmbus, pSMBUS_AddrCallbackTypeDef pCallback)
	Register the Slave Address Match SMBUS Callback To be used instead of the weak HAL_SMBUS_AddrCallback() predefined callback. More...

HAL_StatusTypeDef	HAL_SMBUS_UnRegisterAddrCallback (SMBUS_HandleTypeDef *hsmbus)
	UnRegister the Slave Address Match SMBUS Callback Info Ready SMBUS Callback is redirected to the weak HAL_SMBUS_AddrCallback() predefined callback. More...

HAL_StatusTypeDef	HAL_SMBUS_Master_Transmit_IT (SMBUS_HandleTypeDef hsmbus, uint16_t DevAddress, uint8_t pData, uint16_t Size, uint32_t XferOptions)
	Transmit in master/host SMBUS mode an amount of data in non-blocking mode with Interrupt. More...

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. More...

HAL_StatusTypeDef	HAL_SMBUS_Master_Abort_IT (SMBUS_HandleTypeDef *hsmbus, uint16_t DevAddress)
	Abort a master/host SMBUS process communication with Interrupt. More...

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. More...

HAL_StatusTypeDef	HAL_SMBUS_Slave_Receive_IT (SMBUS_HandleTypeDef hsmbus, uint8_t pData, uint16_t Size, uint32_t XferOptions)
	Receive in slave/device SMBUS mode an amount of data in non-blocking mode with Interrupt. More...

HAL_StatusTypeDef	HAL_SMBUS_EnableListen_IT (SMBUS_HandleTypeDef *hsmbus)
	Enable the Address listen mode with Interrupt. More...

HAL_StatusTypeDef	HAL_SMBUS_DisableListen_IT (SMBUS_HandleTypeDef *hsmbus)
	Disable the Address listen mode with Interrupt. More...

HAL_StatusTypeDef	HAL_SMBUS_EnableAlert_IT (SMBUS_HandleTypeDef *hsmbus)
	Enable the SMBUS alert mode with Interrupt. More...

HAL_StatusTypeDef	HAL_SMBUS_DisableAlert_IT (SMBUS_HandleTypeDef *hsmbus)
	Disable the SMBUS alert mode with Interrupt. More...

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. More...

void	HAL_SMBUS_EV_IRQHandler (SMBUS_HandleTypeDef *hsmbus)
	Handle SMBUS event interrupt request. More...

void	HAL_SMBUS_ER_IRQHandler (SMBUS_HandleTypeDef *hsmbus)
	Handle SMBUS error interrupt request. More...

void	HAL_SMBUS_MasterTxCpltCallback (SMBUS_HandleTypeDef *hsmbus)
	Master Tx Transfer completed callback. More...

void	HAL_SMBUS_MasterRxCpltCallback (SMBUS_HandleTypeDef *hsmbus)
	Master Rx Transfer completed callback. More...

void	HAL_SMBUS_SlaveTxCpltCallback (SMBUS_HandleTypeDef *hsmbus)
	Slave Tx Transfer completed callback. More...

void	HAL_SMBUS_SlaveRxCpltCallback (SMBUS_HandleTypeDef *hsmbus)
	Slave Rx Transfer completed callback. More...

void	HAL_SMBUS_AddrCallback (SMBUS_HandleTypeDef *hsmbus, uint8_t TransferDirection, uint16_t AddrMatchCode)
	Slave Address Match callback. More...

void	HAL_SMBUS_ListenCpltCallback (SMBUS_HandleTypeDef *hsmbus)
	Listen Complete callback. More...

void	HAL_SMBUS_ErrorCallback (SMBUS_HandleTypeDef *hsmbus)
	SMBUS error callback. More...

uint32_t	HAL_SMBUS_GetState (SMBUS_HandleTypeDef *hsmbus)
	Return the SMBUS handle state. More...

uint32_t	HAL_SMBUS_GetError (SMBUS_HandleTypeDef *hsmbus)
	Return the SMBUS error code. More...

Detailed Description

SMBUS HAL module driver. This file provides firmware functions to manage the following functionalities of the System Management Bus (SMBus) peripheral, based on I2C principles of operation :

Author

MCD Application Team

Initialization and de-initialization functions
IO operation functions
Peripheral State and Errors functions

==============================================================================
                      ##### How to use this driver #####
==============================================================================
  [..]
  The SMBUS HAL driver can be used as follows:

  (#) Declare a SMBUS_HandleTypeDef handle structure, for example:
      SMBUS_HandleTypeDef  hsmbus;

  (#)Initialize the SMBUS low level resources by implementing the @ref HAL_SMBUS_MspInit() API:
      (##) Enable the SMBUSx interface clock
      (##) SMBUS pins configuration
          (+++) Enable the clock for the SMBUS GPIOs
          (+++) Configure SMBUS pins as alternate function open-drain
      (##) NVIC configuration if you need to use interrupt process
          (+++) Configure the SMBUSx interrupt priority
          (+++) Enable the NVIC SMBUS IRQ Channel

  (#) Configure the Communication Clock Timing, Bus Timeout, Own Address1, Master Addressing mode,
      Dual Addressing mode, Own Address2, Own Address2 Mask, General call, Nostretch mode,
      Peripheral mode and Packet Error Check mode in the hsmbus Init structure.

  (#) Initialize the SMBUS registers by calling the @ref HAL_SMBUS_Init() API:
      (++) These API's configures also the low level Hardware GPIO, CLOCK, CORTEX...etc)
           by calling the customized @ref HAL_SMBUS_MspInit(&hsmbus) API.

  (#) To check if target device is ready for communication, use the function @ref HAL_SMBUS_IsDeviceReady()

  (#) For SMBUS IO operations, only one mode of operations is available within this driver

  *** Interrupt mode IO operation ***
  ===================================
  [..]
    (+) Transmit in master/host SMBUS mode an amount of data in non-blocking mode using @ref HAL_SMBUS_Master_Transmit_IT()
    (++) At transmission end of transfer @ref HAL_SMBUS_MasterTxCpltCallback() is executed and user can
         add his own code by customization of function pointer @ref HAL_SMBUS_MasterTxCpltCallback()
    (+) Receive in master/host SMBUS mode an amount of data in non-blocking mode using @ref HAL_SMBUS_Master_Receive_IT()
    (++) At reception end of transfer @ref HAL_SMBUS_MasterRxCpltCallback() is executed and user can
         add his own code by customization of function pointer @ref HAL_SMBUS_MasterRxCpltCallback()
    (+) Abort a master/host SMBUS process communication with Interrupt using @ref HAL_SMBUS_Master_Abort_IT()
    (++) The associated previous transfer callback is called at the end of abort process
    (++) mean @ref HAL_SMBUS_MasterTxCpltCallback() in case of previous state was master transmit
    (++) mean @ref HAL_SMBUS_MasterRxCpltCallback() in case of previous state was master receive
    (+) Enable/disable the Address listen mode in slave/device or host/slave SMBUS mode
         using @ref HAL_SMBUS_EnableListen_IT() @ref HAL_SMBUS_DisableListen_IT()
    (++) When address slave/device SMBUS match, @ref HAL_SMBUS_AddrCallback() is executed and user can
         add his own code to check the Address Match Code and the transmission direction request by master/host (Write/Read).
    (++) At Listen mode end @ref HAL_SMBUS_ListenCpltCallback() is executed and user can
         add his own code by customization of function pointer @ref HAL_SMBUS_ListenCpltCallback()
    (+) Transmit in slave/device SMBUS mode an amount of data in non-blocking mode using @ref HAL_SMBUS_Slave_Transmit_IT()
    (++) At transmission end of transfer @ref HAL_SMBUS_SlaveTxCpltCallback() is executed and user can
         add his own code by customization of function pointer @ref HAL_SMBUS_SlaveTxCpltCallback()
    (+) Receive in slave/device SMBUS mode an amount of data in non-blocking mode using @ref HAL_SMBUS_Slave_Receive_IT()
    (++) At reception end of transfer @ref HAL_SMBUS_SlaveRxCpltCallback() is executed and user can
         add his own code by customization of function pointer @ref HAL_SMBUS_SlaveRxCpltCallback()
    (+) Enable/Disable the SMBUS alert mode using @ref HAL_SMBUS_EnableAlert_IT() @ref HAL_SMBUS_DisableAlert_IT()
    (++) When SMBUS Alert is generated @ref HAL_SMBUS_ErrorCallback() is executed and user can
         add his own code by customization of function pointer @ref HAL_SMBUS_ErrorCallback()
         to check the Alert Error Code using function @ref HAL_SMBUS_GetError()
    (+) Get HAL state machine or error values using @ref HAL_SMBUS_GetState() or @ref HAL_SMBUS_GetError()
    (+) In case of transfer Error, @ref HAL_SMBUS_ErrorCallback() function is executed and user can
         add his own code by customization of function pointer @ref HAL_SMBUS_ErrorCallback()
         to check the Error Code using function @ref HAL_SMBUS_GetError()

   *** SMBUS HAL driver macros list ***
   ==================================
   [..]
     Below the list of most used macros in SMBUS HAL driver.

    (+) @ref __HAL_SMBUS_ENABLE:      Enable the SMBUS peripheral
    (+) @ref __HAL_SMBUS_DISABLE:     Disable the SMBUS peripheral
    (+) @ref __HAL_SMBUS_GET_FLAG:    Check whether the specified SMBUS flag is set or not
    (+) @ref __HAL_SMBUS_CLEAR_FLAG:  Clear the specified SMBUS pending flag
    (+) @ref __HAL_SMBUS_ENABLE_IT:   Enable the specified SMBUS interrupt
    (+) @ref __HAL_SMBUS_DISABLE_IT:  Disable the specified SMBUS interrupt

   *** Callback registration ***
   =============================================
  [..]
   The compilation flag USE_HAL_SMBUS_REGISTER_CALLBACKS when set to 1
   allows the user to configure dynamically the driver callbacks.
   Use Functions @ref HAL_SMBUS_RegisterCallback() or @ref HAL_SMBUS_RegisterAddrCallback()
   to register an interrupt callback.
  [..]
   Function @ref HAL_SMBUS_RegisterCallback() allows to register following callbacks:
     (+) MasterTxCpltCallback : callback for Master transmission end of transfer.
     (+) MasterRxCpltCallback : callback for Master reception end of transfer.
     (+) SlaveTxCpltCallback  : callback for Slave transmission end of transfer.
     (+) SlaveRxCpltCallback  : callback for Slave reception end of transfer.
     (+) ListenCpltCallback   : callback for end of listen mode.
     (+) ErrorCallback        : callback for error detection.
     (+) MspInitCallback      : callback for Msp Init.
     (+) MspDeInitCallback    : callback for Msp DeInit.
   This function takes as parameters the HAL peripheral handle, the Callback ID
   and a pointer to the user callback function.
  [..]
   For specific callback AddrCallback use dedicated register callbacks : @ref HAL_SMBUS_RegisterAddrCallback.
  [..]
   Use function @ref HAL_SMBUS_UnRegisterCallback to reset a callback to the default
   weak function.
   @ref HAL_SMBUS_UnRegisterCallback takes as parameters the HAL peripheral handle,
   and the Callback ID.
   This function allows to reset following callbacks:
     (+) MasterTxCpltCallback : callback for Master transmission end of transfer.
     (+) MasterRxCpltCallback : callback for Master reception end of transfer.
     (+) SlaveTxCpltCallback  : callback for Slave transmission end of transfer.
     (+) SlaveRxCpltCallback  : callback for Slave reception end of transfer.
     (+) ListenCpltCallback   : callback for end of listen mode.
     (+) ErrorCallback        : callback for error detection.
     (+) MspInitCallback      : callback for Msp Init.
     (+) MspDeInitCallback    : callback for Msp DeInit.
  [..]
   For callback AddrCallback use dedicated register callbacks : @ref HAL_SMBUS_UnRegisterAddrCallback.
  [..]
   By default, after the @ref HAL_SMBUS_Init() and when the state is @ref HAL_I2C_STATE_RESET
   all callbacks are set to the corresponding weak functions:
   examples @ref HAL_SMBUS_MasterTxCpltCallback(), @ref HAL_SMBUS_MasterRxCpltCallback().
   Exception done for MspInit and MspDeInit functions that are
   reset to the legacy weak functions in the @ref HAL_SMBUS_Init()/ @ref HAL_SMBUS_DeInit() only when
   these callbacks are null (not registered beforehand).
   If MspInit or MspDeInit are not null, the @ref HAL_SMBUS_Init()/ @ref HAL_SMBUS_DeInit()
   keep and use the user MspInit/MspDeInit callbacks (registered beforehand) whatever the state.
  [..]
   Callbacks can be registered/unregistered in @ref HAL_I2C_STATE_READY state only.
   Exception done MspInit/MspDeInit functions that can be registered/unregistered
   in @ref HAL_I2C_STATE_READY or @ref HAL_I2C_STATE_RESET state,
   thus registered (user) MspInit/DeInit callbacks can be used during the Init/DeInit.
   Then, the user first registers the MspInit/MspDeInit user callbacks
   using @ref HAL_SMBUS_RegisterCallback() before calling @ref HAL_SMBUS_DeInit()
   or @ref HAL_SMBUS_Init() function.
  [..]
   When the compilation flag USE_HAL_SMBUS_REGISTER_CALLBACKS is set to 0 or
   not defined, the callback registration feature is not available and all callbacks
   are set to the corresponding weak functions.

   [..]
     (@) You can refer to the SMBUS HAL driver header file for more useful macros

Attention

This software component is licensed by ST under BSD 3-Clause license, the "License"; You may not use this file except in compliance with the License. You may obtain a copy of the License at: opensource.org/licenses/BSD-3-Clause

Definition in file stm32l4xx_hal_smbus.c.

Functions

Detailed Description

© Copyright (c) 2017 STMicroelectronics. All rights reserved.