Extended features functions

Extended features functions. More...

Modules
	I2C Extended Private Constants
	I2C Extended Private Macros
	I2C Extended Private Functions

Functions
HAL_StatusTypeDef	HAL_I2CEx_ConfigAnalogFilter (I2C_HandleTypeDef *hi2c, uint32_t AnalogFilter)
	Configure I2C Analog noise filter. More...
HAL_StatusTypeDef	HAL_I2CEx_ConfigDigitalFilter (I2C_HandleTypeDef *hi2c, uint32_t DigitalFilter)
	Configure I2C Digital noise filter. More...
HAL_StatusTypeDef	HAL_I2CEx_EnableWakeUp (I2C_HandleTypeDef *hi2c)
	Enable I2C wakeup from Stop mode(s). More...
HAL_StatusTypeDef	HAL_I2CEx_DisableWakeUp (I2C_HandleTypeDef *hi2c)
	Disable I2C wakeup from Stop mode(s). More...
void	HAL_I2CEx_EnableFastModePlus (uint32_t ConfigFastModePlus)
	Enable the I2C fast mode plus driving capability. More...
void	HAL_I2CEx_DisableFastModePlus (uint32_t ConfigFastModePlus)
	Disable the I2C fast mode plus driving capability. More...

Detailed Description

Extended features functions.

 ===============================================================================
                      ##### Extended features functions #####
 ===============================================================================
    [..] This section provides functions allowing to:
      (+) Configure Noise Filters
      (+) Configure Wake Up Feature
      (+) Configure Fast Mode Plus

Function Documentation

HAL_I2CEx_ConfigAnalogFilter()

HAL_StatusTypeDef HAL_I2CEx_ConfigAnalogFilter	(	I2C_HandleTypeDef *	hi2c,
		uint32_t	AnalogFilter
	)

Configure I2C Analog noise filter.

Parameters

hi2c	Pointer to a I2C_HandleTypeDef structure that contains the configuration information for the specified I2Cx peripheral.
AnalogFilter	New state of the Analog filter.

Return values

HAL

status

Definition at line 97 of file stm32l4xx_hal_i2c_ex.c.

{
  /* Check the parameters */
  assert_param(IS_I2C_ALL_INSTANCE(hi2c->Instance));
  assert_param(IS_I2C_ANALOG_FILTER(AnalogFilter));

  if (hi2c->State == HAL_I2C_STATE_READY)
  {
    /* Process Locked */
    __HAL_LOCK(hi2c);

    hi2c->State = HAL_I2C_STATE_BUSY;

    /* Disable the selected I2C peripheral */
    __HAL_I2C_DISABLE(hi2c);

    /* Reset I2Cx ANOFF bit */
    hi2c->Instance->CR1 &= ~(I2C_CR1_ANFOFF);

    /* Set analog filter bit*/
    hi2c->Instance->CR1 |= AnalogFilter;

    __HAL_I2C_ENABLE(hi2c);

    hi2c->State = HAL_I2C_STATE_READY;

    /* Process Unlocked */
    __HAL_UNLOCK(hi2c);

    return HAL_OK;
  }
  else
  {
    return HAL_BUSY;
  }
}

HAL_I2CEx_ConfigDigitalFilter()

HAL_StatusTypeDef HAL_I2CEx_ConfigDigitalFilter	(	I2C_HandleTypeDef *	hi2c,
		uint32_t	DigitalFilter
	)

Configure I2C Digital noise filter.

Parameters

hi2c	Pointer to a I2C_HandleTypeDef structure that contains the configuration information for the specified I2Cx peripheral.
DigitalFilter	Coefficient of digital noise filter between Min_Data=0x00 and Max_Data=0x0F.

Return values

HAL

status

Definition at line 141 of file stm32l4xx_hal_i2c_ex.c.

{
  uint32_t tmpreg;

  /* Check the parameters */
  assert_param(IS_I2C_ALL_INSTANCE(hi2c->Instance));
  assert_param(IS_I2C_DIGITAL_FILTER(DigitalFilter));

  if (hi2c->State == HAL_I2C_STATE_READY)
  {
    /* Process Locked */
    __HAL_LOCK(hi2c);

    hi2c->State = HAL_I2C_STATE_BUSY;

    /* Disable the selected I2C peripheral */
    __HAL_I2C_DISABLE(hi2c);

    /* Get the old register value */
    tmpreg = hi2c->Instance->CR1;

    /* Reset I2Cx DNF bits [11:8] */
    tmpreg &= ~(I2C_CR1_DNF);

    /* Set I2Cx DNF coefficient */
    tmpreg |= DigitalFilter << 8U;

    /* Store the new register value */
    hi2c->Instance->CR1 = tmpreg;

    __HAL_I2C_ENABLE(hi2c);

    hi2c->State = HAL_I2C_STATE_READY;

    /* Process Unlocked */
    __HAL_UNLOCK(hi2c);

    return HAL_OK;
  }
  else
  {
    return HAL_BUSY;
  }
}

HAL_I2CEx_DisableFastModePlus()

void HAL_I2CEx_DisableFastModePlus

(

uint32_t

ConfigFastModePlus

)

Disable the I2C fast mode plus driving capability.

Parameters

ConfigFastModePlus

Selects the pin. This parameter can be one of the I2C Extended Fast Mode Plus values

Note

For I2C1, fast mode plus driving capability can be disabled on all selected I2C1 pins using I2C_FASTMODEPLUS_I2C1 parameter or independently on each one of the following pins PB6, PB7, PB8 and PB9.

For remaining I2C1 pins (PA14, PA15...) fast mode plus driving capability can be disabled only by using I2C_FASTMODEPLUS_I2C1 parameter.

For all I2C2 pins fast mode plus driving capability can be disabled only by using I2C_FASTMODEPLUS_I2C2 parameter.

For all I2C3 pins fast mode plus driving capability can be disabled only by using I2C_FASTMODEPLUS_I2C3 parameter.

For all I2C4 pins fast mode plus driving capability can be disabled only by using I2C_FASTMODEPLUS_I2C4 parameter.

Return values

None

Definition at line 310 of file stm32l4xx_hal_i2c_ex.c.

{
  /* Check the parameter */
  assert_param(IS_I2C_FASTMODEPLUS(ConfigFastModePlus));

  /* Enable SYSCFG clock */
  __HAL_RCC_SYSCFG_CLK_ENABLE();

  /* Disable fast mode plus driving capability for selected pin */
  CLEAR_BIT(SYSCFG->CFGR1, (uint32_t)ConfigFastModePlus);
}

HAL_I2CEx_DisableWakeUp()

HAL_StatusTypeDef HAL_I2CEx_DisableWakeUp

(

I2C_HandleTypeDef *

hi2c

)

Disable I2C wakeup from Stop mode(s).

Parameters

hi2c	Pointer to a I2C_HandleTypeDef structure that contains the configuration information for the specified I2Cx peripheral.

Return values

HAL

status

Definition at line 231 of file stm32l4xx_hal_i2c_ex.c.

{
  /* Check the parameters */
  assert_param(IS_I2C_WAKEUP_FROMSTOP_INSTANCE(hi2c->Instance));

  if (hi2c->State == HAL_I2C_STATE_READY)
  {
    /* Process Locked */
    __HAL_LOCK(hi2c);

    hi2c->State = HAL_I2C_STATE_BUSY;

    /* Disable the selected I2C peripheral */
    __HAL_I2C_DISABLE(hi2c);

    /* Enable wakeup from stop mode */
    hi2c->Instance->CR1 &= ~(I2C_CR1_WUPEN);

    __HAL_I2C_ENABLE(hi2c);

    hi2c->State = HAL_I2C_STATE_READY;

    /* Process Unlocked */
    __HAL_UNLOCK(hi2c);

    return HAL_OK;
  }
  else
  {
    return HAL_BUSY;
  }
}

HAL_I2CEx_EnableFastModePlus()

void HAL_I2CEx_EnableFastModePlus

(

uint32_t

ConfigFastModePlus

)

Enable the I2C fast mode plus driving capability.

Parameters

ConfigFastModePlus

Selects the pin. This parameter can be one of the I2C Extended Fast Mode Plus values

Note

For I2C1, fast mode plus driving capability can be enabled on all selected I2C1 pins using I2C_FASTMODEPLUS_I2C1 parameter or independently on each one of the following pins PB6, PB7, PB8 and PB9.

For remaining I2C1 pins (PA14, PA15...) fast mode plus driving capability can be enabled only by using I2C_FASTMODEPLUS_I2C1 parameter.

For all I2C2 pins fast mode plus driving capability can be enabled only by using I2C_FASTMODEPLUS_I2C2 parameter.

For all I2C3 pins fast mode plus driving capability can be enabled only by using I2C_FASTMODEPLUS_I2C3 parameter.

For all I2C4 pins fast mode plus driving capability can be enabled only by using I2C_FASTMODEPLUS_I2C4 parameter.

Return values

None

Definition at line 281 of file stm32l4xx_hal_i2c_ex.c.

{
  /* Check the parameter */
  assert_param(IS_I2C_FASTMODEPLUS(ConfigFastModePlus));

  /* Enable SYSCFG clock */
  __HAL_RCC_SYSCFG_CLK_ENABLE();

  /* Enable fast mode plus driving capability for selected pin */
  SET_BIT(SYSCFG->CFGR1, (uint32_t)ConfigFastModePlus);
}

HAL_I2CEx_EnableWakeUp()

HAL_StatusTypeDef HAL_I2CEx_EnableWakeUp

(

I2C_HandleTypeDef *

hi2c

)

Enable I2C wakeup from Stop mode(s).

Parameters

hi2c	Pointer to a I2C_HandleTypeDef structure that contains the configuration information for the specified I2Cx peripheral.

Return values

HAL

status

Definition at line 192 of file stm32l4xx_hal_i2c_ex.c.

{
  /* Check the parameters */
  assert_param(IS_I2C_WAKEUP_FROMSTOP_INSTANCE(hi2c->Instance));

  if (hi2c->State == HAL_I2C_STATE_READY)
  {
    /* Process Locked */
    __HAL_LOCK(hi2c);

    hi2c->State = HAL_I2C_STATE_BUSY;

    /* Disable the selected I2C peripheral */
    __HAL_I2C_DISABLE(hi2c);

    /* Enable wakeup from stop mode */
    hi2c->Instance->CR1 |= I2C_CR1_WUPEN;

    __HAL_I2C_ENABLE(hi2c);

    hi2c->State = HAL_I2C_STATE_READY;

    /* Process Unlocked */
    __HAL_UNLOCK(hi2c);

    return HAL_OK;
  }
  else
  {
    return HAL_BUSY;
  }
}