i2c.h

Go to the documentation of this file.

/* USER CODE BEGIN Header */
/**
  ******************************************************************************
  * @file    i2c.h
  * @brief   This file contains all the function prototypes for
  *          the i2c.c file
  ******************************************************************************
  * @attention
  *
  * Copyright (c) 2025 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.
  *
  ******************************************************************************
  */
/* USER CODE END Header */
/* Define to prevent recursive inclusion -------------------------------------*/
#ifndef __I2C_H__
#define __I2C_H__
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* Includes ------------------------------------------------------------------*/
#include "main.h"
 
/* USER CODE BEGIN Includes */
 
/* USER CODE END Includes */
 
extern I2C_HandleTypeDef hi2c2;
 
/* USER CODE BEGIN Private defines */
 
/* USER CODE END Private defines */
 
void MX_I2C2_Init(void);
 
/* USER CODE BEGIN Prototypes */
 
/**
 * @brief Deinitialise the I2C2 peripheral to reduce current consumption in low-power mode.
 *        Call before entering STOP or OFF mode; call MX_I2C2_Init() again after wakeup.
 */
void MX_I2C2_DeInit(void);
 
/**
 * @brief Wrapper around HAL_I2C_IsDeviceReady() that recovers from a busy bus.
 *        If the HAL I2C bus is in a BUSY error state, the function resets the
 *        peripheral (DeInit / Init cycle) before retrying the device poll.
 * @param hi2c       Pointer to the I2C handle.
 * @param DevAddress 7-bit or 10-bit device address (left-shifted by 1 for HAL).
 * @param Trials     Number of consecutive ACK attempts before giving up.
 * @param Timeout    Timeout in milliseconds for each trial.
 * @retval HAL_OK    – device acknowledged within the given number of trials.
 * @retval HAL_ERROR – device not present or bus error after recovery attempt.
 * @retval HAL_TIMEOUT – device did not acknowledge within the timeout.
 */
HAL_StatusTypeDef I2C_IsDeviceReadyMT(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint32_t Trials, uint32_t Timeout);
 
 
/* USER CODE END Prototypes */
 
#ifdef __cplusplus
}
#endif
 
#endif /* __I2C_H__ */