STM3210E_EVAL BSP User Manual: Exported Functions

STM3210E EVAL BSP Drivers

STM3210E_EVAL BSP User Manual
Exported Functions

Functions

uint32_t BSP_GetVersion (void)
 This method returns the STM3210E EVAL BSP Driver revision.
void BSP_LED_Init (Led_TypeDef Led)
 Configures LED GPIO.
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.
void BSP_PB_Init (Button_TypeDef Button, ButtonMode_TypeDef Button_Mode)
 Configures push button GPIO and EXTI Line.
uint32_t BSP_PB_GetState (Button_TypeDef Button)
 Returns the selected button state.
uint8_t BSP_JOY_Init (JOYMode_TypeDef Joy_Mode)
 Configures all button of the joystick in GPIO or EXTI modes.
JOYState_TypeDef BSP_JOY_GetState (void)
 Returns the current joystick status.
void BSP_COM_Init (COM_TypeDef COM, UART_HandleTypeDef *huart)
 Configures COM port.

Function Documentation

void BSP_COM_Init ( COM_TypeDef  COM,
UART_HandleTypeDef *  huart 
)

Configures COM port.

Parameters:
COM,:Specifies the COM port to be configured. This parameter can be one of following parameters:
  • COM1
huart,:pointer to a UART_HandleTypeDef structure that contains the configuration information for the specified UART peripheral.
Return values:
None

Definition at line 505 of file stm3210e_eval.c.

References COM_RX_PIN, COM_RX_PORT, COM_TX_PIN, COM_TX_PORT, COM_USART, COMx_CLK_ENABLE, COMx_RX_GPIO_CLK_ENABLE, and COMx_TX_GPIO_CLK_ENABLE.

uint32_t BSP_GetVersion ( void  )

This method returns the STM3210E EVAL BSP Driver revision.

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

Definition at line 260 of file stm3210e_eval.c.

References __STM3210E_EVAL_BSP_VERSION.

Returns the current joystick status.

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

Definition at line 478 of file stm3210e_eval.c.

References JOY_NONE, JOY_PIN, JOY_PORT, JOY_SEL, and JOYn.

uint8_t BSP_JOY_Init ( JOYMode_TypeDef  Joy_Mode)

Configures all button 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 430 of file stm3210e_eval.c.

References JOY_IRQn, JOY_MODE_EXTI, JOY_MODE_GPIO, JOY_NONE, JOY_PIN, JOY_PORT, JOY_SEL, JOYn, and JOYx_GPIO_CLK_ENABLE.

void BSP_LED_Init ( Led_TypeDef  Led)

Configures LED GPIO.

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

Definition at line 275 of file stm3210e_eval.c.

References LED_PIN, LED_PORT, and LEDx_GPIO_CLK_ENABLE.

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
  • LED3
  • LED4
Return values:
None

Definition at line 318 of file stm3210e_eval.c.

References LED_PIN, and LED_PORT.

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
  • LED3
  • LED4
Return values:
None

Definition at line 303 of file stm3210e_eval.c.

References LED_PIN, and LED_PORT.

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
  • LED3
  • LED4
Return values:
None

Definition at line 333 of file stm3210e_eval.c.

References LED_PIN, and LED_PORT.

uint32_t BSP_PB_GetState ( Button_TypeDef  Button)

Returns the selected button state.

Parameters:
Button,:Button to be checked. This parameter can be one of the following values:
  • BUTTON_TAMPER: Key/Tamper Push Button
Return values:
Buttonstate

Definition at line 416 of file stm3210e_eval.c.

References BUTTON_PIN, and BUTTON_PORT.

void BSP_PB_Init ( Button_TypeDef  Button,
ButtonMode_TypeDef  Button_Mode 
)

Configures push button GPIO and EXTI Line.

Parameters:
Button,:Button to be configured. This parameter can be one of the following values:
  • BUTTON_TAMPER: Key/Tamper Push Button
  • BUTTON_SEL : Sel Push Button on Joystick
  • BUTTON_LEFT : Left Push Button on Joystick
  • BUTTON_RIGHT : Right Push Button on Joystick
  • BUTTON_DOWN : Down Push Button on Joystick
  • BUTTON_UP : Up Push Button on Joystick
Button_Mode,:Button mode requested. This parameter can be one of the following values:
  • BUTTON_MODE_GPIO: Button will be used as simple IO
  • BUTTON_MODE_EVT : Button will be connected to EXTI line with event generation capability
  • BUTTON_MODE_EXTI: Button will be connected to EXTI line with interrupt generation capability
Return values:
None

Definition at line 357 of file stm3210e_eval.c.

References BUTTON_IRQn, BUTTON_MODE_EVT, BUTTON_MODE_EXTI, BUTTON_MODE_GPIO, BUTTON_PIN, BUTTON_PORT, BUTTON_WAKEUP, and BUTTONx_GPIO_CLK_ENABLE.

Generated on Thu Dec 10 2015 17:39:43 for STM3210E_EVAL BSP User Manual by   doxygen 1.7.6.1