IO operation functions

GPIO Read, Write, Toggle, Lock and EXTI management functions. More...

Functions
GPIO_PinState	HAL_GPIO_ReadPin (GPIO_TypeDef *GPIOx, uint16_t GPIO_Pin)
	Read the specified input port pin. More...
void	HAL_GPIO_WritePin (GPIO_TypeDef *GPIOx, uint16_t GPIO_Pin, GPIO_PinState PinState)
	Set or clear the selected data port bit. More...
void	HAL_GPIO_TogglePin (GPIO_TypeDef *GPIOx, uint16_t GPIO_Pin)
	Toggle the specified GPIO pin. More...
HAL_StatusTypeDef	HAL_GPIO_LockPin (GPIO_TypeDef *GPIOx, uint16_t GPIO_Pin)
	Lock GPIO Pins configuration registers. More...
void	HAL_GPIO_EXTI_IRQHandler (uint16_t GPIO_Pin)
	Handle EXTI interrupt request. More...
void	HAL_GPIO_EXTI_Callback (uint16_t GPIO_Pin)
	EXTI line detection callback. More...

Detailed Description

GPIO Read, Write, Toggle, Lock and EXTI management functions.

 ===============================================================================
                       ##### IO operation functions #####
 ===============================================================================

Function Documentation

HAL_GPIO_EXTI_Callback()

__weak void HAL_GPIO_EXTI_Callback

(

uint16_t

GPIO_Pin

)

EXTI line detection callback.

Parameters

GPIO_Pin

Specifies the port pin connected to corresponding EXTI line.

Return values

None

Definition at line 529 of file stm32l4xx_hal_gpio.c.

{
  /* Prevent unused argument(s) compilation warning */
  UNUSED(GPIO_Pin);

  /* NOTE: This function should not be modified, when the callback is needed,
           the HAL_GPIO_EXTI_Callback could be implemented in the user file
   */
}

HAL_GPIO_EXTI_IRQHandler()

void HAL_GPIO_EXTI_IRQHandler

(

uint16_t

GPIO_Pin

)

Handle EXTI interrupt request.

Parameters

GPIO_Pin

Specifies the port pin connected to corresponding EXTI line.

Return values

None

Definition at line 514 of file stm32l4xx_hal_gpio.c.

{
  /* EXTI line interrupt detected */
  if(__HAL_GPIO_EXTI_GET_IT(GPIO_Pin) != 0x00u)
  {
    __HAL_GPIO_EXTI_CLEAR_IT(GPIO_Pin);
    HAL_GPIO_EXTI_Callback(GPIO_Pin);
  }
}

HAL_GPIO_LockPin()

HAL_StatusTypeDef HAL_GPIO_LockPin	(	GPIO_TypeDef *	GPIOx,
		uint16_t	GPIO_Pin
	)

Lock GPIO Pins configuration registers.

Note

The locked registers are GPIOx_MODER, GPIOx_OTYPER, GPIOx_OSPEEDR, GPIOx_PUPDR, GPIOx_AFRL and GPIOx_AFRH.

The configuration of the locked GPIO pins can no longer be modified until the next reset.

Parameters

GPIOx	where x can be (A..H) to select the GPIO peripheral for STM32L4 family
GPIO_Pin	specifies the port bits to be locked. This parameter can be any combination of GPIO_Pin_x where x can be (0..15).

Return values

None

Definition at line 479 of file stm32l4xx_hal_gpio.c.

{
  __IO uint32_t tmp = GPIO_LCKR_LCKK;

  /* Check the parameters */
  assert_param(IS_GPIO_LOCK_INSTANCE(GPIOx));
  assert_param(IS_GPIO_PIN(GPIO_Pin));

  /* Apply lock key write sequence */
  tmp |= GPIO_Pin;
  /* Set LCKx bit(s): LCKK='1' + LCK[15-0] */
  GPIOx->LCKR = tmp;
  /* Reset LCKx bit(s): LCKK='0' + LCK[15-0] */
  GPIOx->LCKR = GPIO_Pin;
  /* Set LCKx bit(s): LCKK='1' + LCK[15-0] */
  GPIOx->LCKR = tmp;
  /* Read LCKK register. This read is mandatory to complete key lock sequence */
  tmp = GPIOx->LCKR;

  /* Read again in order to confirm lock is active */
  if ((GPIOx->LCKR & GPIO_LCKR_LCKK) != 0x00u)
  {
    return HAL_OK;
  }
  else
  {
    return HAL_ERROR;
  }
}

HAL_GPIO_ReadPin()

GPIO_PinState HAL_GPIO_ReadPin	(	GPIO_TypeDef *	GPIOx,
		uint16_t	GPIO_Pin
	)

Read the specified input port pin.

Parameters

GPIOx	where x can be (A..H) to select the GPIO peripheral for STM32L4 family
GPIO_Pin	specifies the port bit to read. This parameter can be any combination of GPIO_Pin_x where x can be (0..15).

Return values

The	input port pin value.

Definition at line 397 of file stm32l4xx_hal_gpio.c.

{
  GPIO_PinState bitstatus;

  /* Check the parameters */
  assert_param(IS_GPIO_PIN(GPIO_Pin));

  if ((GPIOx->IDR & GPIO_Pin) != 0x00u)
  {
    bitstatus = GPIO_PIN_SET;
  }
  else
  {
    bitstatus = GPIO_PIN_RESET;
  }
  return bitstatus;
}

HAL_GPIO_TogglePin()

void HAL_GPIO_TogglePin	(	GPIO_TypeDef *	GPIOx,
		uint16_t	GPIO_Pin
	)

Toggle the specified GPIO pin.

Parameters

GPIOx	where x can be (A..H) to select the GPIO peripheral for STM32L4 family
GPIO_Pin	specifies the pin to be toggled.

Return values

None

Definition at line 453 of file stm32l4xx_hal_gpio.c.

{
  /* Check the parameters */
  assert_param(IS_GPIO_PIN(GPIO_Pin));

  if ((GPIOx->ODR & GPIO_Pin) != 0x00u)
  {
    GPIOx->BRR = (uint32_t)GPIO_Pin;
  }
  else
  {
    GPIOx->BSRR = (uint32_t)GPIO_Pin;
  }
}

HAL_GPIO_WritePin()

void HAL_GPIO_WritePin	(	GPIO_TypeDef *	GPIOx,
		uint16_t	GPIO_Pin,
		GPIO_PinState	PinState
	)

Set or clear the selected data port bit.

Note

This function uses GPIOx_BSRR and GPIOx_BRR registers to allow atomic read/modify accesses. In this way, there is no risk of an IRQ occurring between the read and the modify access.

Parameters

GPIOx	where x can be (A..H) to select the GPIO peripheral for STM32L4 family
GPIO_Pin	specifies the port bit to be written. This parameter can be any combination of GPIO_Pin_x where x can be (0..15).
PinState	specifies the value to be written to the selected bit. This parameter can be one of the GPIO_PinState enum values: GPIO_PIN_RESET: to clear the port pin GPIO_PIN_SET: to set the port pin

Return values

None

Definition at line 431 of file stm32l4xx_hal_gpio.c.

{
  /* Check the parameters */
  assert_param(IS_GPIO_PIN(GPIO_Pin));
  assert_param(IS_GPIO_PIN_ACTION(PinState));

  if(PinState != GPIO_PIN_RESET)
  {
    GPIOx->BSRR = (uint32_t)GPIO_Pin;
  }
  else
  {
    GPIOx->BRR = (uint32_t)GPIO_Pin;
  }
}