STM32L4R9I-Discovery BSP User Manual: Exported Functions

STM32L4R9I-Discovery BSP

previous page next page
STM32L4R9I-Discovery BSP User Manual
Functions
Exported Functions
STM32L4R9I_DISCOVERY Common

Functions

__weak void BSP_ErrorHandler (void)
 Error Handler.
uint32_t BSP_GetVersion (void)
 This method returns the STM32L4R9I DISCOVERY BSP Driver revision.
void BSP_LED_Init (Led_TypeDef Led)
 Configures LED GPIOs.
void BSP_LED_DeInit (Led_TypeDef Led)
 Unconfigures LED GPIOs.
void BSP_LED_On (Led_TypeDef Led)
 Turns selected LED On.
void BSP_LED_Off (Led_TypeDef Led)
 Turns selected LED Off.
void BSP_LED_Toggle (Led_TypeDef Led)
 Toggles the selected LED.
uint8_t BSP_JOY_Init (JOYMode_TypeDef Joy_Mode)
 Configures all buttons of the joystick in GPIO or EXTI modes.
void BSP_JOY_DeInit (void)
 Unonfigures all GPIOs used as buttons of the joystick.
JOYState_TypeDef BSP_JOY_GetState (void)
 Returns the current joystick status.
void BSP_COM_Init (COM_TypeDef COM, UART_HandleTypeDef *huart)
 Configures COM port.
void BSP_COM_DeInit (COM_TypeDef COM, UART_HandleTypeDef *huart)
 DeInit COM port.

Function Documentation

void BSP_COM_DeInit ( COM_TypeDef  COM,
UART_HandleTypeDef *  huart 
)

DeInit COM port.

Parameters:
COM,:COM port to be configured. This parameter can be one of the following values:
  • COM1
huart,:Pointer to a UART_HandleTypeDef structure that contains the configuration information for the specified USART peripheral.

Definition at line 494 of file stm32l4r9i_discovery.c.

References COM_RX_PIN, COM_RX_PORT, COM_TX_PIN, COM_TX_PORT, COM_USART, and DISCOVERY_COMx_CLK_DISABLE.

void BSP_COM_Init ( COM_TypeDef  COM,
UART_HandleTypeDef *  huart 
)

Configures COM port.

Parameters:
COM,:COM port to be configured. This parameter can be one of the following values:
  • COM1
huart,:Pointer to a UART_HandleTypeDef structure that contains the configuration information for the specified USART peripheral.

Definition at line 456 of file stm32l4r9i_discovery.c.

References COM_RX_AF, COM_RX_PIN, COM_RX_PORT, COM_TX_AF, COM_TX_PIN, COM_TX_PORT, COM_USART, DISCOVERY_COMx_CLK_ENABLE, DISCOVERY_COMx_RX_GPIO_CLK_ENABLE, and DISCOVERY_COMx_TX_GPIO_CLK_ENABLE.

void BSP_ErrorHandler ( void  )

Error Handler.

Note:
Defined as a weak function to be overwritten by the application.
Return values:
None

Definition at line 200 of file stm32l4r9i_discovery.c.

Referenced by BSP_LED_Init(), HAL_DFSDM_FilterRegConvCpltCallback(), HAL_DFSDM_FilterRegConvHalfCpltCallback(), I2C1_Error(), and MFX_IO_Init().

uint32_t BSP_GetVersion ( void  )

This method returns the STM32L4R9I DISCOVERY BSP Driver revision.

Return values:
version: 0xXYZR (8bits for each decimal, R for RC)

Definition at line 209 of file stm32l4r9i_discovery.c.

References __STM32L4R9I_DISCOVERY_BSP_VERSION.

void BSP_JOY_DeInit ( void  )

Unonfigures all GPIOs used as buttons of the joystick.

Return values:
None.

Definition at line 394 of file stm32l4r9i_discovery.c.

References BSP_IO_ConfigPin(), DOWN_JOY_PIN, LEFT_JOY_PIN, RIGHT_JOY_PIN, SEL_JOY_GPIO_CLK_ENABLE, SEL_JOY_GPIO_PORT, SEL_JOY_PIN, and UP_JOY_PIN.

JOYState_TypeDef BSP_JOY_GetState ( void  )

Returns the current joystick status.

Return values:
Codeof the joystick key pressed This code can be one of the following values:
  • JOY_NONE
  • JOY_SEL
  • JOY_DOWN
  • JOY_LEFT
  • JOY_RIGHT
  • JOY_UP

Definition at line 414 of file stm32l4r9i_discovery.c.

References BSP_IO_ReadPin(), DOWN_JOY_PIN, JOY_DOWN, JOY_LEFT, JOY_NONE, JOY_RIGHT, JOY_SEL, JOY_UP, LEFT_JOY_PIN, RIGHT_JOY_PIN, SEL_JOY_GPIO_PORT, SEL_JOY_PIN, and UP_JOY_PIN.

uint8_t BSP_JOY_Init ( JOYMode_TypeDef  Joy_Mode)

Configures all buttons of the joystick in GPIO or EXTI modes.

Parameters:
Joy_Mode,:Joystick mode. This parameter can be one of the following values:
  • JOY_MODE_GPIO: Joystick pins will be used as simple IOs
  • JOY_MODE_EXTI: Joystick pins will be connected to EXTI line with interrupt generation capability
Return values:
HAL_OK,:if all initializations are OK. Other value if error.

Definition at line 347 of file stm32l4r9i_discovery.c.

References BSP_IO_ConfigPin(), BSP_IO_Init(), DOWN_JOY_PIN, JOY_MODE_EXTI, JOY_MODE_GPIO, LEFT_JOY_PIN, MFX_IO_ITConfig(), RIGHT_JOY_PIN, SEL_JOY_EXTI_IRQn, SEL_JOY_GPIO_CLK_ENABLE, SEL_JOY_GPIO_PORT, SEL_JOY_PIN, and UP_JOY_PIN.

void BSP_LED_DeInit ( Led_TypeDef  Led)

Unconfigures LED GPIOs.

Parameters:
Led,:Specifies the Led to be unconfigured. This parameter can be one of following parameters:
  • LED1
  • LED2
Return values:
None

Definition at line 266 of file stm32l4r9i_discovery.c.

References LED2, LED2_GPIO_CLK_ENABLE, LED2_GPIO_PORT, and LED_PIN.

void BSP_LED_Init ( Led_TypeDef  Led)

Configures LED GPIOs.

Parameters:
Led,:Specifies the Led to be configured. This parameter can be one of following parameters:
  • LED1
  • LED2
Return values:
None

Definition at line 222 of file stm32l4r9i_discovery.c.

References BSP_ErrorHandler(), BSP_IO_ConfigPin(), BSP_IO_Init(), BSP_IO_WritePin(), IO_ERROR, LED2, LED2_GPIO_CLK_ENABLE, LED2_GPIO_PORT, and LED_PIN.

void BSP_LED_Off ( Led_TypeDef  Led)

Turns selected LED Off.

Parameters:
Led,:Specifies the Led to be set off. This parameter can be one of following parameters:
  • LED1
  • LED2
Return values:
None

Definition at line 306 of file stm32l4r9i_discovery.c.

References BSP_IO_WritePin(), LED2, LED2_GPIO_PORT, and LED_PIN.

void BSP_LED_On ( Led_TypeDef  Led)

Turns selected LED On.

Parameters:
Led,:Specifies the Led to be set on. This parameter can be one of following parameters:
  • LED1
  • LED2
Return values:
None

Definition at line 286 of file stm32l4r9i_discovery.c.

References BSP_IO_WritePin(), LED2, LED2_GPIO_PORT, and LED_PIN.

void BSP_LED_Toggle ( Led_TypeDef  Led)

Toggles the selected LED.

Parameters:
Led,:Specifies the Led to be toggled. This parameter can be one of following parameters:
  • LED1
  • LED2
Return values:
None

Definition at line 326 of file stm32l4r9i_discovery.c.

References BSP_IO_TogglePin(), LED2, LED2_GPIO_PORT, and LED_PIN.

Generated on Fri Oct 13 2017 02:37:42 for STM32L4R9I-Discovery BSP User Manual by   doxygen 1.7.6.1
previous page start next page