| /** |
| ****************************************************************************** |
| * @file stm32l4xx_hal_smbus.h |
| * @author MCD Application Team |
| * @brief Header file of SMBUS HAL module. |
| ****************************************************************************** |
| * @attention |
| * |
| * Copyright (c) 2017 STMicroelectronics. |
| * All rights reserved. |
| * |
| * This software is licensed under terms that can be found in the LICENSE file |
| * in the root directory of this software component. |
| * If no LICENSE file comes with this software, it is provided AS-IS. |
| * |
| ****************************************************************************** |
| */ |
| |
| /* Define to prevent recursive inclusion -------------------------------------*/ |
| #ifndef STM32L4xx_HAL_SMBUS_H |
| #define STM32L4xx_HAL_SMBUS_H |
| |
| #ifdef __cplusplus |
| extern "C" { |
| #endif |
| |
| /* Includes ------------------------------------------------------------------*/ |
| #include "stm32l4xx_hal_def.h" |
| |
| /** @addtogroup STM32L4xx_HAL_Driver |
| * @{ |
| */ |
| |
| /** @addtogroup SMBUS |
| * @{ |
| */ |
| |
| /* Exported types ------------------------------------------------------------*/ |
| /** @defgroup SMBUS_Exported_Types SMBUS Exported Types |
| * @{ |
| */ |
| |
| /** @defgroup SMBUS_Configuration_Structure_definition SMBUS Configuration Structure definition |
| * @brief SMBUS Configuration Structure definition |
| * @{ |
| */ |
| typedef struct |
| { |
| uint32_t Timing; /*!< Specifies the SMBUS_TIMINGR_register value. |
| This parameter calculated by referring to SMBUS initialization section |
| in Reference manual */ |
| uint32_t AnalogFilter; /*!< Specifies if Analog Filter is enable or not. |
| This parameter can be a value of @ref SMBUS_Analog_Filter */ |
| |
| uint32_t OwnAddress1; /*!< Specifies the first device own address. |
| This parameter can be a 7-bit or 10-bit address. */ |
| |
| uint32_t AddressingMode; /*!< Specifies if 7-bit or 10-bit addressing mode for master is selected. |
| This parameter can be a value of @ref SMBUS_addressing_mode */ |
| |
| uint32_t DualAddressMode; /*!< Specifies if dual addressing mode is selected. |
| This parameter can be a value of @ref SMBUS_dual_addressing_mode */ |
| |
| uint32_t OwnAddress2; /*!< Specifies the second device own address if dual addressing mode is selected |
| This parameter can be a 7-bit address. */ |
| |
| uint32_t OwnAddress2Masks; /*!< Specifies the acknowledge mask address second device own address |
| if dual addressing mode is selected |
| This parameter can be a value of @ref SMBUS_own_address2_masks. */ |
| |
| uint32_t GeneralCallMode; /*!< Specifies if general call mode is selected. |
| This parameter can be a value of @ref SMBUS_general_call_addressing_mode. */ |
| |
| uint32_t NoStretchMode; /*!< Specifies if nostretch mode is selected. |
| This parameter can be a value of @ref SMBUS_nostretch_mode */ |
| |
| uint32_t PacketErrorCheckMode; /*!< Specifies if Packet Error Check mode is selected. |
| This parameter can be a value of @ref SMBUS_packet_error_check_mode */ |
| |
| uint32_t PeripheralMode; /*!< Specifies which mode of Periphal is selected. |
| This parameter can be a value of @ref SMBUS_peripheral_mode */ |
| |
| uint32_t SMBusTimeout; /*!< Specifies the content of the 32 Bits SMBUS_TIMEOUT_register value. |
| (Enable bits and different timeout values) |
| This parameter calculated by referring to SMBUS initialization section |
| in Reference manual */ |
| } SMBUS_InitTypeDef; |
| /** |
| * @} |
| */ |
| |
| /** @defgroup HAL_state_definition HAL state definition |
| * @brief HAL State definition |
| * @{ |
| */ |
| #define HAL_SMBUS_STATE_RESET (0x00000000U) /*!< SMBUS not yet initialized or disabled */ |
| #define HAL_SMBUS_STATE_READY (0x00000001U) /*!< SMBUS initialized and ready for use */ |
| #define HAL_SMBUS_STATE_BUSY (0x00000002U) /*!< SMBUS internal process is ongoing */ |
| #define HAL_SMBUS_STATE_MASTER_BUSY_TX (0x00000012U) /*!< Master Data Transmission process is ongoing */ |
| #define HAL_SMBUS_STATE_MASTER_BUSY_RX (0x00000022U) /*!< Master Data Reception process is ongoing */ |
| #define HAL_SMBUS_STATE_SLAVE_BUSY_TX (0x00000032U) /*!< Slave Data Transmission process is ongoing */ |
| #define HAL_SMBUS_STATE_SLAVE_BUSY_RX (0x00000042U) /*!< Slave Data Reception process is ongoing */ |
| #define HAL_SMBUS_STATE_TIMEOUT (0x00000003U) /*!< Timeout state */ |
| #define HAL_SMBUS_STATE_ERROR (0x00000004U) /*!< Reception process is ongoing */ |
| #define HAL_SMBUS_STATE_LISTEN (0x00000008U) /*!< Address Listen Mode is ongoing */ |
| /** |
| * @} |
| */ |
| |
| /** @defgroup SMBUS_Error_Code_definition SMBUS Error Code definition |
| * @brief SMBUS Error Code definition |
| * @{ |
| */ |
| #define HAL_SMBUS_ERROR_NONE (0x00000000U) /*!< No error */ |
| #define HAL_SMBUS_ERROR_BERR (0x00000001U) /*!< BERR error */ |
| #define HAL_SMBUS_ERROR_ARLO (0x00000002U) /*!< ARLO error */ |
| #define HAL_SMBUS_ERROR_ACKF (0x00000004U) /*!< ACKF error */ |
| #define HAL_SMBUS_ERROR_OVR (0x00000008U) /*!< OVR error */ |
| #define HAL_SMBUS_ERROR_HALTIMEOUT (0x00000010U) /*!< Timeout error */ |
| #define HAL_SMBUS_ERROR_BUSTIMEOUT (0x00000020U) /*!< Bus Timeout error */ |
| #define HAL_SMBUS_ERROR_ALERT (0x00000040U) /*!< Alert error */ |
| #define HAL_SMBUS_ERROR_PECERR (0x00000080U) /*!< PEC error */ |
| #if (USE_HAL_SMBUS_REGISTER_CALLBACKS == 1) |
| #define HAL_SMBUS_ERROR_INVALID_CALLBACK (0x00000100U) /*!< Invalid Callback error */ |
| #endif /* USE_HAL_SMBUS_REGISTER_CALLBACKS */ |
| #define HAL_SMBUS_ERROR_INVALID_PARAM (0x00000200U) /*!< Invalid Parameters error */ |
| /** |
| * @} |
| */ |
| |
| /** @defgroup SMBUS_handle_Structure_definition SMBUS handle Structure definition |
| * @brief SMBUS handle Structure definition |
| * @{ |
| */ |
| #if (USE_HAL_SMBUS_REGISTER_CALLBACKS == 1) |
| typedef struct __SMBUS_HandleTypeDef |
| #else |
| typedef struct |
| #endif /* USE_HAL_SMBUS_REGISTER_CALLBACKS */ |
| { |
| I2C_TypeDef *Instance; /*!< SMBUS registers base address */ |
| |
| SMBUS_InitTypeDef Init; /*!< SMBUS communication parameters */ |
| |
| uint8_t *pBuffPtr; /*!< Pointer to SMBUS transfer buffer */ |
| |
| uint16_t XferSize; /*!< SMBUS transfer size */ |
| |
| __IO uint16_t XferCount; /*!< SMBUS transfer counter */ |
| |
| __IO uint32_t XferOptions; /*!< SMBUS transfer options */ |
| |
| __IO uint32_t PreviousState; /*!< SMBUS communication Previous state */ |
| |
| HAL_LockTypeDef Lock; /*!< SMBUS locking object */ |
| |
| __IO uint32_t State; /*!< SMBUS communication state */ |
| |
| __IO uint32_t ErrorCode; /*!< SMBUS Error code */ |
| |
| #if (USE_HAL_SMBUS_REGISTER_CALLBACKS == 1) |
| void (* MasterTxCpltCallback)(struct __SMBUS_HandleTypeDef *hsmbus); |
| /*!< SMBUS Master Tx Transfer completed callback */ |
| void (* MasterRxCpltCallback)(struct __SMBUS_HandleTypeDef *hsmbus); |
| /*!< SMBUS Master Rx Transfer completed callback */ |
| void (* SlaveTxCpltCallback)(struct __SMBUS_HandleTypeDef *hsmbus); |
| /*!< SMBUS Slave Tx Transfer completed callback */ |
| void (* SlaveRxCpltCallback)(struct __SMBUS_HandleTypeDef *hsmbus); |
| /*!< SMBUS Slave Rx Transfer completed callback */ |
| void (* ListenCpltCallback)(struct __SMBUS_HandleTypeDef *hsmbus); |
| /*!< SMBUS Listen Complete callback */ |
| void (* ErrorCallback)(struct __SMBUS_HandleTypeDef *hsmbus); |
| /*!< SMBUS Error callback */ |
| |
| void (* AddrCallback)(struct __SMBUS_HandleTypeDef *hsmbus, uint8_t TransferDirection, uint16_t AddrMatchCode); |
| /*!< SMBUS Slave Address Match callback */ |
| |
| void (* MspInitCallback)(struct __SMBUS_HandleTypeDef *hsmbus); |
| /*!< SMBUS Msp Init callback */ |
| void (* MspDeInitCallback)(struct __SMBUS_HandleTypeDef *hsmbus); |
| /*!< SMBUS Msp DeInit callback */ |
| |
| #endif /* USE_HAL_SMBUS_REGISTER_CALLBACKS */ |
| } SMBUS_HandleTypeDef; |
| |
| #if (USE_HAL_SMBUS_REGISTER_CALLBACKS == 1) |
| /** |
| * @brief HAL SMBUS Callback ID enumeration definition |
| */ |
| typedef enum |
| { |
| HAL_SMBUS_MASTER_TX_COMPLETE_CB_ID = 0x00U, /*!< SMBUS Master Tx Transfer completed callback ID */ |
| HAL_SMBUS_MASTER_RX_COMPLETE_CB_ID = 0x01U, /*!< SMBUS Master Rx Transfer completed callback ID */ |
| HAL_SMBUS_SLAVE_TX_COMPLETE_CB_ID = 0x02U, /*!< SMBUS Slave Tx Transfer completed callback ID */ |
| HAL_SMBUS_SLAVE_RX_COMPLETE_CB_ID = 0x03U, /*!< SMBUS Slave Rx Transfer completed callback ID */ |
| HAL_SMBUS_LISTEN_COMPLETE_CB_ID = 0x04U, /*!< SMBUS Listen Complete callback ID */ |
| HAL_SMBUS_ERROR_CB_ID = 0x05U, /*!< SMBUS Error callback ID */ |
| |
| HAL_SMBUS_MSPINIT_CB_ID = 0x06U, /*!< SMBUS Msp Init callback ID */ |
| HAL_SMBUS_MSPDEINIT_CB_ID = 0x07U /*!< SMBUS Msp DeInit callback ID */ |
| |
| } HAL_SMBUS_CallbackIDTypeDef; |
| |
| /** |
| * @brief HAL SMBUS Callback pointer definition |
| */ |
| typedef void (*pSMBUS_CallbackTypeDef)(SMBUS_HandleTypeDef *hsmbus); |
| /*!< pointer to an SMBUS callback function */ |
| typedef void (*pSMBUS_AddrCallbackTypeDef)(SMBUS_HandleTypeDef *hsmbus, uint8_t TransferDirection, |
| uint16_t AddrMatchCode); |
| /*!< pointer to an SMBUS Address Match callback function */ |
| |
| #endif /* USE_HAL_SMBUS_REGISTER_CALLBACKS */ |
| /** |
| * @} |
| */ |
| |
| /** |
| * @} |
| */ |
| /* Exported constants --------------------------------------------------------*/ |
| |
| /** @defgroup SMBUS_Exported_Constants SMBUS Exported Constants |
| * @{ |
| */ |
| |
| /** @defgroup SMBUS_Analog_Filter SMBUS Analog Filter |
| * @{ |
| */ |
| #define SMBUS_ANALOGFILTER_ENABLE (0x00000000U) |
| #define SMBUS_ANALOGFILTER_DISABLE I2C_CR1_ANFOFF |
| /** |
| * @} |
| */ |
| |
| /** @defgroup SMBUS_addressing_mode SMBUS addressing mode |
| * @{ |
| */ |
| #define SMBUS_ADDRESSINGMODE_7BIT (0x00000001U) |
| #define SMBUS_ADDRESSINGMODE_10BIT (0x00000002U) |
| /** |
| * @} |
| */ |
| |
| /** @defgroup SMBUS_dual_addressing_mode SMBUS dual addressing mode |
| * @{ |
| */ |
| |
| #define SMBUS_DUALADDRESS_DISABLE (0x00000000U) |
| #define SMBUS_DUALADDRESS_ENABLE I2C_OAR2_OA2EN |
| /** |
| * @} |
| */ |
| |
| /** @defgroup SMBUS_own_address2_masks SMBUS ownaddress2 masks |
| * @{ |
| */ |
| |
| #define SMBUS_OA2_NOMASK ((uint8_t)0x00U) |
| #define SMBUS_OA2_MASK01 ((uint8_t)0x01U) |
| #define SMBUS_OA2_MASK02 ((uint8_t)0x02U) |
| #define SMBUS_OA2_MASK03 ((uint8_t)0x03U) |
| #define SMBUS_OA2_MASK04 ((uint8_t)0x04U) |
| #define SMBUS_OA2_MASK05 ((uint8_t)0x05U) |
| #define SMBUS_OA2_MASK06 ((uint8_t)0x06U) |
| #define SMBUS_OA2_MASK07 ((uint8_t)0x07U) |
| /** |
| * @} |
| */ |
| |
| |
| /** @defgroup SMBUS_general_call_addressing_mode SMBUS general call addressing mode |
| * @{ |
| */ |
| #define SMBUS_GENERALCALL_DISABLE (0x00000000U) |
| #define SMBUS_GENERALCALL_ENABLE I2C_CR1_GCEN |
| /** |
| * @} |
| */ |
| |
| /** @defgroup SMBUS_nostretch_mode SMBUS nostretch mode |
| * @{ |
| */ |
| #define SMBUS_NOSTRETCH_DISABLE (0x00000000U) |
| #define SMBUS_NOSTRETCH_ENABLE I2C_CR1_NOSTRETCH |
| /** |
| * @} |
| */ |
| |
| /** @defgroup SMBUS_packet_error_check_mode SMBUS packet error check mode |
| * @{ |
| */ |
| #define SMBUS_PEC_DISABLE (0x00000000U) |
| #define SMBUS_PEC_ENABLE I2C_CR1_PECEN |
| /** |
| * @} |
| */ |
| |
| /** @defgroup SMBUS_peripheral_mode SMBUS peripheral mode |
| * @{ |
| */ |
| #define SMBUS_PERIPHERAL_MODE_SMBUS_HOST I2C_CR1_SMBHEN |
| #define SMBUS_PERIPHERAL_MODE_SMBUS_SLAVE (0x00000000U) |
| #define SMBUS_PERIPHERAL_MODE_SMBUS_SLAVE_ARP I2C_CR1_SMBDEN |
| /** |
| * @} |
| */ |
| |
| /** @defgroup SMBUS_ReloadEndMode_definition SMBUS ReloadEndMode definition |
| * @{ |
| */ |
| |
| #define SMBUS_SOFTEND_MODE (0x00000000U) |
| #define SMBUS_RELOAD_MODE I2C_CR2_RELOAD |
| #define SMBUS_AUTOEND_MODE I2C_CR2_AUTOEND |
| #define SMBUS_SENDPEC_MODE I2C_CR2_PECBYTE |
| /** |
| * @} |
| */ |
| |
| /** @defgroup SMBUS_StartStopMode_definition SMBUS StartStopMode definition |
| * @{ |
| */ |
| |
| #define SMBUS_NO_STARTSTOP (0x00000000U) |
| #define SMBUS_GENERATE_STOP (uint32_t)(0x80000000U | I2C_CR2_STOP) |
| #define SMBUS_GENERATE_START_READ (uint32_t)(0x80000000U | I2C_CR2_START | I2C_CR2_RD_WRN) |
| #define SMBUS_GENERATE_START_WRITE (uint32_t)(0x80000000U | I2C_CR2_START) |
| /** |
| * @} |
| */ |
| |
| /** @defgroup SMBUS_XferOptions_definition SMBUS XferOptions definition |
| * @{ |
| */ |
| |
| /* List of XferOptions in usage of : |
| * 1- Restart condition when direction change |
| * 2- No Restart condition in other use cases |
| */ |
| #define SMBUS_FIRST_FRAME SMBUS_SOFTEND_MODE |
| #define SMBUS_NEXT_FRAME ((uint32_t)(SMBUS_RELOAD_MODE | SMBUS_SOFTEND_MODE)) |
| #define SMBUS_FIRST_AND_LAST_FRAME_NO_PEC SMBUS_AUTOEND_MODE |
| #define SMBUS_LAST_FRAME_NO_PEC SMBUS_AUTOEND_MODE |
| #define SMBUS_FIRST_FRAME_WITH_PEC ((uint32_t)(SMBUS_SOFTEND_MODE | SMBUS_SENDPEC_MODE)) |
| #define SMBUS_FIRST_AND_LAST_FRAME_WITH_PEC ((uint32_t)(SMBUS_AUTOEND_MODE | SMBUS_SENDPEC_MODE)) |
| #define SMBUS_LAST_FRAME_WITH_PEC ((uint32_t)(SMBUS_AUTOEND_MODE | SMBUS_SENDPEC_MODE)) |
| |
| /* List of XferOptions in usage of : |
| * 1- Restart condition in all use cases (direction change or not) |
| */ |
| #define SMBUS_OTHER_FRAME_NO_PEC (0x000000AAU) |
| #define SMBUS_OTHER_FRAME_WITH_PEC (0x0000AA00U) |
| #define SMBUS_OTHER_AND_LAST_FRAME_NO_PEC (0x00AA0000U) |
| #define SMBUS_OTHER_AND_LAST_FRAME_WITH_PEC (0xAA000000U) |
| /** |
| * @} |
| */ |
| |
| /** @defgroup SMBUS_Interrupt_configuration_definition SMBUS Interrupt configuration definition |
| * @brief SMBUS Interrupt definition |
| * Elements values convention: 0xXXXXXXXX |
| * - XXXXXXXX : Interrupt control mask |
| * @{ |
| */ |
| #define SMBUS_IT_ERRI I2C_CR1_ERRIE |
| #define SMBUS_IT_TCI I2C_CR1_TCIE |
| #define SMBUS_IT_STOPI I2C_CR1_STOPIE |
| #define SMBUS_IT_NACKI I2C_CR1_NACKIE |
| #define SMBUS_IT_ADDRI I2C_CR1_ADDRIE |
| #define SMBUS_IT_RXI I2C_CR1_RXIE |
| #define SMBUS_IT_TXI I2C_CR1_TXIE |
| #define SMBUS_IT_TX (SMBUS_IT_ERRI | SMBUS_IT_TCI | SMBUS_IT_STOPI | \ |
| SMBUS_IT_NACKI | SMBUS_IT_TXI) |
| #define SMBUS_IT_RX (SMBUS_IT_ERRI | SMBUS_IT_TCI | SMBUS_IT_NACKI | \ |
| SMBUS_IT_RXI) |
| #define SMBUS_IT_ALERT (SMBUS_IT_ERRI) |
| #define SMBUS_IT_ADDR (SMBUS_IT_ADDRI | SMBUS_IT_STOPI | SMBUS_IT_NACKI) |
| /** |
| * @} |
| */ |
| |
| /** @defgroup SMBUS_Flag_definition SMBUS Flag definition |
| * @brief Flag definition |
| * Elements values convention: 0xXXXXYYYY |
| * - XXXXXXXX : Flag mask |
| * @{ |
| */ |
| |
| #define SMBUS_FLAG_TXE I2C_ISR_TXE |
| #define SMBUS_FLAG_TXIS I2C_ISR_TXIS |
| #define SMBUS_FLAG_RXNE I2C_ISR_RXNE |
| #define SMBUS_FLAG_ADDR I2C_ISR_ADDR |
| #define SMBUS_FLAG_AF I2C_ISR_NACKF |
| #define SMBUS_FLAG_STOPF I2C_ISR_STOPF |
| #define SMBUS_FLAG_TC I2C_ISR_TC |
| #define SMBUS_FLAG_TCR I2C_ISR_TCR |
| #define SMBUS_FLAG_BERR I2C_ISR_BERR |
| #define SMBUS_FLAG_ARLO I2C_ISR_ARLO |
| #define SMBUS_FLAG_OVR I2C_ISR_OVR |
| #define SMBUS_FLAG_PECERR I2C_ISR_PECERR |
| #define SMBUS_FLAG_TIMEOUT I2C_ISR_TIMEOUT |
| #define SMBUS_FLAG_ALERT I2C_ISR_ALERT |
| #define SMBUS_FLAG_BUSY I2C_ISR_BUSY |
| #define SMBUS_FLAG_DIR I2C_ISR_DIR |
| /** |
| * @} |
| */ |
| |
| /** |
| * @} |
| */ |
| |
| /* Exported macros ------------------------------------------------------------*/ |
| /** @defgroup SMBUS_Exported_Macros SMBUS Exported Macros |
| * @{ |
| */ |
| |
| /** @brief Reset SMBUS handle state. |
| * @param __HANDLE__ specifies the SMBUS Handle. |
| * @retval None |
| */ |
| #if (USE_HAL_SMBUS_REGISTER_CALLBACKS == 1) |
| #define __HAL_SMBUS_RESET_HANDLE_STATE(__HANDLE__) do{ \ |
| (__HANDLE__)->State = HAL_SMBUS_STATE_RESET; \ |
| (__HANDLE__)->MspInitCallback = NULL; \ |
| (__HANDLE__)->MspDeInitCallback = NULL; \ |
| } while(0) |
| #else |
| #define __HAL_SMBUS_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_SMBUS_STATE_RESET) |
| #endif /* USE_HAL_SMBUS_REGISTER_CALLBACKS */ |
| |
| /** @brief Enable the specified SMBUS interrupts. |
| * @param __HANDLE__ specifies the SMBUS Handle. |
| * @param __INTERRUPT__ specifies the interrupt source to enable. |
| * This parameter can be one of the following values: |
| * @arg @ref SMBUS_IT_ERRI Errors interrupt enable |
| * @arg @ref SMBUS_IT_TCI Transfer complete interrupt enable |
| * @arg @ref SMBUS_IT_STOPI STOP detection interrupt enable |
| * @arg @ref SMBUS_IT_NACKI NACK received interrupt enable |
| * @arg @ref SMBUS_IT_ADDRI Address match interrupt enable |
| * @arg @ref SMBUS_IT_RXI RX interrupt enable |
| * @arg @ref SMBUS_IT_TXI TX interrupt enable |
| * |
| * @retval None |
| */ |
| #define __HAL_SMBUS_ENABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->CR1 |= (__INTERRUPT__)) |
| |
| /** @brief Disable the specified SMBUS interrupts. |
| * @param __HANDLE__ specifies the SMBUS Handle. |
| * @param __INTERRUPT__ specifies the interrupt source to disable. |
| * This parameter can be one of the following values: |
| * @arg @ref SMBUS_IT_ERRI Errors interrupt enable |
| * @arg @ref SMBUS_IT_TCI Transfer complete interrupt enable |
| * @arg @ref SMBUS_IT_STOPI STOP detection interrupt enable |
| * @arg @ref SMBUS_IT_NACKI NACK received interrupt enable |
| * @arg @ref SMBUS_IT_ADDRI Address match interrupt enable |
| * @arg @ref SMBUS_IT_RXI RX interrupt enable |
| * @arg @ref SMBUS_IT_TXI TX interrupt enable |
| * |
| * @retval None |
| */ |
| #define __HAL_SMBUS_DISABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->CR1 &= (~(__INTERRUPT__))) |
| |
| /** @brief Check whether the specified SMBUS interrupt source is enabled or not. |
| * @param __HANDLE__ specifies the SMBUS Handle. |
| * @param __INTERRUPT__ specifies the SMBUS interrupt source to check. |
| * This parameter can be one of the following values: |
| * @arg @ref SMBUS_IT_ERRI Errors interrupt enable |
| * @arg @ref SMBUS_IT_TCI Transfer complete interrupt enable |
| * @arg @ref SMBUS_IT_STOPI STOP detection interrupt enable |
| * @arg @ref SMBUS_IT_NACKI NACK received interrupt enable |
| * @arg @ref SMBUS_IT_ADDRI Address match interrupt enable |
| * @arg @ref SMBUS_IT_RXI RX interrupt enable |
| * @arg @ref SMBUS_IT_TXI TX interrupt enable |
| * |
| * @retval The new state of __IT__ (SET or RESET). |
| */ |
| #define __HAL_SMBUS_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) \ |
| ((((__HANDLE__)->Instance->CR1 & (__INTERRUPT__)) == (__INTERRUPT__)) ? SET : RESET) |
| |
| /** @brief Check whether the specified SMBUS flag is set or not. |
| * @param __HANDLE__ specifies the SMBUS Handle. |
| * @param __FLAG__ specifies the flag to check. |
| * This parameter can be one of the following values: |
| * @arg @ref SMBUS_FLAG_TXE Transmit data register empty |
| * @arg @ref SMBUS_FLAG_TXIS Transmit interrupt status |
| * @arg @ref SMBUS_FLAG_RXNE Receive data register not empty |
| * @arg @ref SMBUS_FLAG_ADDR Address matched (slave mode) |
| * @arg @ref SMBUS_FLAG_AF NACK received flag |
| * @arg @ref SMBUS_FLAG_STOPF STOP detection flag |
| * @arg @ref SMBUS_FLAG_TC Transfer complete (master mode) |
| * @arg @ref SMBUS_FLAG_TCR Transfer complete reload |
| * @arg @ref SMBUS_FLAG_BERR Bus error |
| * @arg @ref SMBUS_FLAG_ARLO Arbitration lost |
| * @arg @ref SMBUS_FLAG_OVR Overrun/Underrun |
| * @arg @ref SMBUS_FLAG_PECERR PEC error in reception |
| * @arg @ref SMBUS_FLAG_TIMEOUT Timeout or Tlow detection flag |
| * @arg @ref SMBUS_FLAG_ALERT SMBus alert |
| * @arg @ref SMBUS_FLAG_BUSY Bus busy |
| * @arg @ref SMBUS_FLAG_DIR Transfer direction (slave mode) |
| * |
| * @retval The new state of __FLAG__ (SET or RESET). |
| */ |
| #define SMBUS_FLAG_MASK (0x0001FFFFU) |
| #define __HAL_SMBUS_GET_FLAG(__HANDLE__, __FLAG__) \ |
| (((((__HANDLE__)->Instance->ISR) & ((__FLAG__) & SMBUS_FLAG_MASK)) == \ |
| ((__FLAG__) & SMBUS_FLAG_MASK)) ? SET : RESET) |
| |
| /** @brief Clear the SMBUS pending flags which are cleared by writing 1 in a specific bit. |
| * @param __HANDLE__ specifies the SMBUS Handle. |
| * @param __FLAG__ specifies the flag to clear. |
| * This parameter can be any combination of the following values: |
| * @arg @ref SMBUS_FLAG_TXE Transmit data register empty |
| * @arg @ref SMBUS_FLAG_ADDR Address matched (slave mode) |
| * @arg @ref SMBUS_FLAG_AF NACK received flag |
| * @arg @ref SMBUS_FLAG_STOPF STOP detection flag |
| * @arg @ref SMBUS_FLAG_BERR Bus error |
| * @arg @ref SMBUS_FLAG_ARLO Arbitration lost |
| * @arg @ref SMBUS_FLAG_OVR Overrun/Underrun |
| * @arg @ref SMBUS_FLAG_PECERR PEC error in reception |
| * @arg @ref SMBUS_FLAG_TIMEOUT Timeout or Tlow detection flag |
| * @arg @ref SMBUS_FLAG_ALERT SMBus alert |
| * |
| * @retval None |
| */ |
| #define __HAL_SMBUS_CLEAR_FLAG(__HANDLE__, __FLAG__) (((__FLAG__) == SMBUS_FLAG_TXE) ? \ |
| ((__HANDLE__)->Instance->ISR |= (__FLAG__)) : \ |
| ((__HANDLE__)->Instance->ICR = (__FLAG__))) |
| |
| /** @brief Enable the specified SMBUS peripheral. |
| * @param __HANDLE__ specifies the SMBUS Handle. |
| * @retval None |
| */ |
| #define __HAL_SMBUS_ENABLE(__HANDLE__) (SET_BIT((__HANDLE__)->Instance->CR1, I2C_CR1_PE)) |
| |
| /** @brief Disable the specified SMBUS peripheral. |
| * @param __HANDLE__ specifies the SMBUS Handle. |
| * @retval None |
| */ |
| #define __HAL_SMBUS_DISABLE(__HANDLE__) (CLEAR_BIT((__HANDLE__)->Instance->CR1, I2C_CR1_PE)) |
| |
| /** @brief Generate a Non-Acknowledge SMBUS peripheral in Slave mode. |
| * @param __HANDLE__ specifies the SMBUS Handle. |
| * @retval None |
| */ |
| #define __HAL_SMBUS_GENERATE_NACK(__HANDLE__) (SET_BIT((__HANDLE__)->Instance->CR2, I2C_CR2_NACK)) |
| |
| /** |
| * @} |
| */ |
| |
| |
| /* Private constants ---------------------------------------------------------*/ |
| |
| /* Private macros ------------------------------------------------------------*/ |
| /** @defgroup SMBUS_Private_Macro SMBUS Private Macros |
| * @{ |
| */ |
| |
| #define IS_SMBUS_ANALOG_FILTER(FILTER) (((FILTER) == SMBUS_ANALOGFILTER_ENABLE) || \ |
| ((FILTER) == SMBUS_ANALOGFILTER_DISABLE)) |
| |
| #define IS_SMBUS_DIGITAL_FILTER(FILTER) ((FILTER) <= 0x0000000FU) |
| |
| #define IS_SMBUS_ADDRESSING_MODE(MODE) (((MODE) == SMBUS_ADDRESSINGMODE_7BIT) || \ |
| ((MODE) == SMBUS_ADDRESSINGMODE_10BIT)) |
| |
| #define IS_SMBUS_DUAL_ADDRESS(ADDRESS) (((ADDRESS) == SMBUS_DUALADDRESS_DISABLE) || \ |
| ((ADDRESS) == SMBUS_DUALADDRESS_ENABLE)) |
| |
| #define IS_SMBUS_OWN_ADDRESS2_MASK(MASK) (((MASK) == SMBUS_OA2_NOMASK) || \ |
| ((MASK) == SMBUS_OA2_MASK01) || \ |
| ((MASK) == SMBUS_OA2_MASK02) || \ |
| ((MASK) == SMBUS_OA2_MASK03) || \ |
| ((MASK) == SMBUS_OA2_MASK04) || \ |
| ((MASK) == SMBUS_OA2_MASK05) || \ |
| ((MASK) == SMBUS_OA2_MASK06) || \ |
| ((MASK) == SMBUS_OA2_MASK07)) |
| |
| #define IS_SMBUS_GENERAL_CALL(CALL) (((CALL) == SMBUS_GENERALCALL_DISABLE) || \ |
| ((CALL) == SMBUS_GENERALCALL_ENABLE)) |
| |
| #define IS_SMBUS_NO_STRETCH(STRETCH) (((STRETCH) == SMBUS_NOSTRETCH_DISABLE) || \ |
| ((STRETCH) == SMBUS_NOSTRETCH_ENABLE)) |
| |
| #define IS_SMBUS_PEC(PEC) (((PEC) == SMBUS_PEC_DISABLE) || \ |
| ((PEC) == SMBUS_PEC_ENABLE)) |
| |
| #define IS_SMBUS_PERIPHERAL_MODE(MODE) (((MODE) == SMBUS_PERIPHERAL_MODE_SMBUS_HOST) || \ |
| ((MODE) == SMBUS_PERIPHERAL_MODE_SMBUS_SLAVE) || \ |
| ((MODE) == SMBUS_PERIPHERAL_MODE_SMBUS_SLAVE_ARP)) |
| |
| #define IS_SMBUS_TRANSFER_MODE(MODE) (((MODE) == SMBUS_RELOAD_MODE) || \ |
| ((MODE) == SMBUS_AUTOEND_MODE) || \ |
| ((MODE) == SMBUS_SOFTEND_MODE) || \ |
| ((MODE) == SMBUS_SENDPEC_MODE) || \ |
| ((MODE) == (SMBUS_RELOAD_MODE | SMBUS_SENDPEC_MODE)) || \ |
| ((MODE) == (SMBUS_AUTOEND_MODE | SMBUS_SENDPEC_MODE)) || \ |
| ((MODE) == (SMBUS_AUTOEND_MODE | SMBUS_RELOAD_MODE)) || \ |
| ((MODE) == (SMBUS_AUTOEND_MODE | SMBUS_SENDPEC_MODE | \ |
| SMBUS_RELOAD_MODE ))) |
| |
| |
| #define IS_SMBUS_TRANSFER_REQUEST(REQUEST) (((REQUEST) == SMBUS_GENERATE_STOP) || \ |
| ((REQUEST) == SMBUS_GENERATE_START_READ) || \ |
| ((REQUEST) == SMBUS_GENERATE_START_WRITE) || \ |
| ((REQUEST) == SMBUS_NO_STARTSTOP)) |
| |
| |
| #define IS_SMBUS_TRANSFER_OPTIONS_REQUEST(REQUEST) (IS_SMBUS_TRANSFER_OTHER_OPTIONS_REQUEST(REQUEST) || \ |
| ((REQUEST) == SMBUS_FIRST_FRAME) || \ |
| ((REQUEST) == SMBUS_NEXT_FRAME) || \ |
| ((REQUEST) == SMBUS_FIRST_AND_LAST_FRAME_NO_PEC) || \ |
| ((REQUEST) == SMBUS_LAST_FRAME_NO_PEC) || \ |
| ((REQUEST) == SMBUS_FIRST_FRAME_WITH_PEC) || \ |
| ((REQUEST) == SMBUS_FIRST_AND_LAST_FRAME_WITH_PEC) || \ |
| ((REQUEST) == SMBUS_LAST_FRAME_WITH_PEC)) |
| |
| #define IS_SMBUS_TRANSFER_OTHER_OPTIONS_REQUEST(REQUEST) (((REQUEST) == SMBUS_OTHER_FRAME_NO_PEC) || \ |
| ((REQUEST) == SMBUS_OTHER_AND_LAST_FRAME_NO_PEC) || \ |
| ((REQUEST) == SMBUS_OTHER_FRAME_WITH_PEC) || \ |
| ((REQUEST) == SMBUS_OTHER_AND_LAST_FRAME_WITH_PEC)) |
| |
| #define SMBUS_RESET_CR1(__HANDLE__) ((__HANDLE__)->Instance->CR1 &= \ |
| (uint32_t)~((uint32_t)(I2C_CR1_SMBHEN | I2C_CR1_SMBDEN | \ |
| I2C_CR1_PECEN))) |
| #define SMBUS_RESET_CR2(__HANDLE__) ((__HANDLE__)->Instance->CR2 &= \ |
| (uint32_t)~((uint32_t)(I2C_CR2_SADD | I2C_CR2_HEAD10R | \ |
| I2C_CR2_NBYTES | I2C_CR2_RELOAD | \ |
| I2C_CR2_RD_WRN))) |
| |
| #define SMBUS_GENERATE_START(__ADDMODE__,__ADDRESS__) (((__ADDMODE__) == SMBUS_ADDRESSINGMODE_7BIT) ? \ |
| (uint32_t)((((uint32_t)(__ADDRESS__) & (I2C_CR2_SADD)) | \ |
| (I2C_CR2_START) | (I2C_CR2_AUTOEND)) & \ |
| (~I2C_CR2_RD_WRN)) : \ |
| (uint32_t)((((uint32_t)(__ADDRESS__) & \ |
| (I2C_CR2_SADD)) | (I2C_CR2_ADD10) | \ |
| (I2C_CR2_START)) & (~I2C_CR2_RD_WRN))) |
| |
| #define SMBUS_GET_ADDR_MATCH(__HANDLE__) (((__HANDLE__)->Instance->ISR & I2C_ISR_ADDCODE) >> 17U) |
| #define SMBUS_GET_DIR(__HANDLE__) (((__HANDLE__)->Instance->ISR & I2C_ISR_DIR) >> 16U) |
| #define SMBUS_GET_STOP_MODE(__HANDLE__) ((__HANDLE__)->Instance->CR2 & I2C_CR2_AUTOEND) |
| #define SMBUS_GET_PEC_MODE(__HANDLE__) ((__HANDLE__)->Instance->CR2 & I2C_CR2_PECBYTE) |
| #define SMBUS_GET_ALERT_ENABLED(__HANDLE__) ((__HANDLE__)->Instance->CR1 & I2C_CR1_ALERTEN) |
| |
| #define SMBUS_CHECK_FLAG(__ISR__, __FLAG__) ((((__ISR__) & ((__FLAG__) & SMBUS_FLAG_MASK)) == \ |
| ((__FLAG__) & SMBUS_FLAG_MASK)) ? SET : RESET) |
| #define SMBUS_CHECK_IT_SOURCE(__CR1__, __IT__) ((((__CR1__) & (__IT__)) == (__IT__)) ? SET : RESET) |
| |
| #define IS_SMBUS_OWN_ADDRESS1(ADDRESS1) ((ADDRESS1) <= 0x000003FFU) |
| #define IS_SMBUS_OWN_ADDRESS2(ADDRESS2) ((ADDRESS2) <= (uint16_t)0x00FFU) |
| |
| /** |
| * @} |
| */ |
| |
| /* Include SMBUS HAL Extended module */ |
| #include "stm32l4xx_hal_smbus_ex.h" |
| |
| /* Exported functions --------------------------------------------------------*/ |
| /** @addtogroup SMBUS_Exported_Functions SMBUS Exported Functions |
| * @{ |
| */ |
| |
| /** @addtogroup SMBUS_Exported_Functions_Group1 Initialization and de-initialization functions |
| * @{ |
| */ |
| |
| /* Initialization and de-initialization functions ****************************/ |
| HAL_StatusTypeDef HAL_SMBUS_Init(SMBUS_HandleTypeDef *hsmbus); |
| HAL_StatusTypeDef HAL_SMBUS_DeInit(SMBUS_HandleTypeDef *hsmbus); |
| void HAL_SMBUS_MspInit(SMBUS_HandleTypeDef *hsmbus); |
| void HAL_SMBUS_MspDeInit(SMBUS_HandleTypeDef *hsmbus); |
| HAL_StatusTypeDef HAL_SMBUS_ConfigAnalogFilter(SMBUS_HandleTypeDef *hsmbus, uint32_t AnalogFilter); |
| HAL_StatusTypeDef HAL_SMBUS_ConfigDigitalFilter(SMBUS_HandleTypeDef *hsmbus, uint32_t DigitalFilter); |
| |
| /* Callbacks Register/UnRegister functions ***********************************/ |
| #if (USE_HAL_SMBUS_REGISTER_CALLBACKS == 1) |
| HAL_StatusTypeDef HAL_SMBUS_RegisterCallback(SMBUS_HandleTypeDef *hsmbus, |
| HAL_SMBUS_CallbackIDTypeDef CallbackID, |
| pSMBUS_CallbackTypeDef pCallback); |
| HAL_StatusTypeDef HAL_SMBUS_UnRegisterCallback(SMBUS_HandleTypeDef *hsmbus, |
| HAL_SMBUS_CallbackIDTypeDef CallbackID); |
| |
| HAL_StatusTypeDef HAL_SMBUS_RegisterAddrCallback(SMBUS_HandleTypeDef *hsmbus, |
| pSMBUS_AddrCallbackTypeDef pCallback); |
| HAL_StatusTypeDef HAL_SMBUS_UnRegisterAddrCallback(SMBUS_HandleTypeDef *hsmbus); |
| #endif /* USE_HAL_SMBUS_REGISTER_CALLBACKS */ |
| /** |
| * @} |
| */ |
| |
| /** @addtogroup SMBUS_Exported_Functions_Group2 Input and Output operation functions |
| * @{ |
| */ |
| |
| /* IO operation functions *****************************************************/ |
| /** @addtogroup Blocking_mode_Polling Blocking mode Polling |
| * @{ |
| */ |
| /******* Blocking mode: Polling */ |
| HAL_StatusTypeDef HAL_SMBUS_IsDeviceReady(SMBUS_HandleTypeDef *hsmbus, uint16_t DevAddress, uint32_t Trials, |
| uint32_t Timeout); |
| /** |
| * @} |
| */ |
| |
| /** @addtogroup Non-Blocking_mode_Interrupt Non-Blocking mode Interrupt |
| * @{ |
| */ |
| /******* Non-Blocking mode: Interrupt */ |
| HAL_StatusTypeDef HAL_SMBUS_Master_Transmit_IT(SMBUS_HandleTypeDef *hsmbus, uint16_t DevAddress, |
| uint8_t *pData, uint16_t Size, uint32_t XferOptions); |
| HAL_StatusTypeDef HAL_SMBUS_Master_Receive_IT(SMBUS_HandleTypeDef *hsmbus, uint16_t DevAddress, |
| uint8_t *pData, uint16_t Size, uint32_t XferOptions); |
| HAL_StatusTypeDef HAL_SMBUS_Master_Abort_IT(SMBUS_HandleTypeDef *hsmbus, uint16_t DevAddress); |
| HAL_StatusTypeDef HAL_SMBUS_Slave_Transmit_IT(SMBUS_HandleTypeDef *hsmbus, uint8_t *pData, uint16_t Size, |
| uint32_t XferOptions); |
| HAL_StatusTypeDef HAL_SMBUS_Slave_Receive_IT(SMBUS_HandleTypeDef *hsmbus, uint8_t *pData, uint16_t Size, |
| uint32_t XferOptions); |
| |
| HAL_StatusTypeDef HAL_SMBUS_EnableAlert_IT(SMBUS_HandleTypeDef *hsmbus); |
| HAL_StatusTypeDef HAL_SMBUS_DisableAlert_IT(SMBUS_HandleTypeDef *hsmbus); |
| HAL_StatusTypeDef HAL_SMBUS_EnableListen_IT(SMBUS_HandleTypeDef *hsmbus); |
| HAL_StatusTypeDef HAL_SMBUS_DisableListen_IT(SMBUS_HandleTypeDef *hsmbus); |
| /** |
| * @} |
| */ |
| |
| /** @addtogroup SMBUS_IRQ_Handler_and_Callbacks IRQ Handler and Callbacks |
| * @{ |
| */ |
| /******* SMBUS IRQHandler and Callbacks used in non blocking modes (Interrupt) */ |
| void HAL_SMBUS_EV_IRQHandler(SMBUS_HandleTypeDef *hsmbus); |
| void HAL_SMBUS_ER_IRQHandler(SMBUS_HandleTypeDef *hsmbus); |
| void HAL_SMBUS_MasterTxCpltCallback(SMBUS_HandleTypeDef *hsmbus); |
| void HAL_SMBUS_MasterRxCpltCallback(SMBUS_HandleTypeDef *hsmbus); |
| void HAL_SMBUS_SlaveTxCpltCallback(SMBUS_HandleTypeDef *hsmbus); |
| void HAL_SMBUS_SlaveRxCpltCallback(SMBUS_HandleTypeDef *hsmbus); |
| void HAL_SMBUS_AddrCallback(SMBUS_HandleTypeDef *hsmbus, uint8_t TransferDirection, uint16_t AddrMatchCode); |
| void HAL_SMBUS_ListenCpltCallback(SMBUS_HandleTypeDef *hsmbus); |
| void HAL_SMBUS_ErrorCallback(SMBUS_HandleTypeDef *hsmbus); |
| |
| /** |
| * @} |
| */ |
| |
| /** @addtogroup SMBUS_Exported_Functions_Group3 Peripheral State and Errors functions |
| * @{ |
| */ |
| |
| /* Peripheral State and Errors functions **************************************************/ |
| uint32_t HAL_SMBUS_GetState(SMBUS_HandleTypeDef *hsmbus); |
| uint32_t HAL_SMBUS_GetError(SMBUS_HandleTypeDef *hsmbus); |
| |
| /** |
| * @} |
| */ |
| |
| /** |
| * @} |
| */ |
| |
| /* Private Functions ---------------------------------------------------------*/ |
| /** @defgroup SMBUS_Private_Functions SMBUS Private Functions |
| * @{ |
| */ |
| /* Private functions are defined in stm32l4xx_hal_smbus.c file */ |
| /** |
| * @} |
| */ |
| |
| /** |
| * @} |
| */ |
| |
| /** |
| * @} |
| */ |
| |
| /** |
| * @} |
| */ |
| |
| #ifdef __cplusplus |
| } |
| #endif |
| |
| |
| #endif /* STM32L4xx_HAL_SMBUS_H */ |
