STM32F413H-Discovery BSP User Manual: STM32F413H Discovery Low Level Private Functions

STM32F413H-Discovery BSP Drivers

STM32F413H-Discovery BSP User Manual
STM32F413H Discovery Low Level Private Functions

Functions

uint32_t BSP_GetVersion (void)
 This method returns the STM32F413H DISCOVERY BSP Driver revision.
void BSP_LED_Init (Led_TypeDef Led)
 Configures LEDs.
void BSP_LED_DeInit (Led_TypeDef Led)
 DeInit LEDs.
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 ButtonMode)
 Configures button GPIO and EXTI Line.
void BSP_PB_DeInit (Button_TypeDef Button)
 Push Button DeInit.
uint32_t BSP_PB_GetState (Button_TypeDef Button)
 Returns the selected button state.
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.
static void FMPI2Cx_MspInit (FMPI2C_HandleTypeDef *fmpi2c_handler)
 Initializes FMPI2C MSP.
static void FMPI2Cx_Init (FMPI2C_HandleTypeDef *fmpi2c_handler)
 Initializes FMPI2C HAL.
static HAL_StatusTypeDef FMPI2Cx_ReadMultiple (FMPI2C_HandleTypeDef *fmpi2c_handler, uint8_t Addr, uint16_t Reg, uint16_t MemAddress, uint8_t *Buffer, uint16_t Length)
 Reads multiple data.
static HAL_StatusTypeDef FMPI2Cx_WriteMultiple (FMPI2C_HandleTypeDef *fmpi2c_handler, uint8_t Addr, uint16_t Reg, uint16_t MemAddress, uint8_t *Buffer, uint16_t Length)
 Writes a value in a register of the device through BUS in using DMA mode.
static void FMPI2Cx_Error (FMPI2C_HandleTypeDef *fmpi2c_handler, uint8_t Addr)
 Manages error callback by re-initializing I2C.
static void FMPI2Cx_DeInit (FMPI2C_HandleTypeDef *fmpi2c_handler)
 Deinitializes FMPI2C interface.
static void FMC_BANK3_WriteData (uint16_t Data)
 Writes register value.
static void FMC_BANK3_WriteReg (uint8_t Reg)
 Writes register address.
static uint16_t FMC_BANK3_ReadData (void)
 Reads register value.
void LCD_IO_WriteData (uint16_t RegValue)
 Writes data on LCD data register.
void LCD_IO_WriteMultipleData (uint16_t *pData, uint32_t Size)
 Writes several data on LCD data register.
void LCD_IO_WriteReg (uint8_t Reg)
 Writes register on LCD register.
uint16_t LCD_IO_ReadData (void)
 Reads data from LCD data register.
void LCD_IO_Delay (uint32_t Delay)
 LCD delay.
void AUDIO_IO_Write (uint8_t Addr, uint16_t Reg, uint16_t Value)
 Writes a single data.
uint16_t AUDIO_IO_Read (uint8_t Addr, uint16_t Reg)
 Reads a single data.
uint16_t TS_IO_ReadMultiple (uint8_t Addr, uint8_t Reg, uint8_t *Buffer, uint16_t Length)
 Reads multiple data with I2C communication channel from TouchScreen.
void TS_IO_WriteMultiple (uint8_t Addr, uint8_t Reg, uint8_t *Buffer, uint16_t Length)
 Writes multiple data with I2C communication channel from MCU to TouchScreen.
void AUDIO_IO_Delay (uint32_t Delay)
 AUDIO Codec delay.
uint8_t TS_IO_Read (uint8_t Addr, uint8_t Reg)
 Reads a single data.
void TS_IO_Write (uint8_t Addr, uint8_t Reg, uint8_t Value)
 Writes a single data.
void TS_IO_Delay (uint32_t Delay)
 Delay function used in TouchScreen low level driver.

Function Documentation

void AUDIO_IO_Delay ( uint32_t  Delay)

AUDIO Codec delay.

Parameters:
Delay,:Delay in ms

Definition at line 838 of file stm32f413h_discovery.c.

uint16_t AUDIO_IO_Read ( uint8_t  Addr,
uint16_t  Reg 
)

Reads a single data.

Parameters:
Addr,:I2C address
Reg,:Reg address
Return values:
Datato be read

Definition at line 792 of file stm32f413h_discovery.c.

References FMPI2Cx_ReadMultiple(), and hI2cAudioHandler.

void AUDIO_IO_Write ( uint8_t  Addr,
uint16_t  Reg,
uint16_t  Value 
)

Writes a single data.

Parameters:
Addr,:I2C address
Reg,:Reg address
Value,:Data to be written

Definition at line 775 of file stm32f413h_discovery.c.

References FMPI2Cx_WriteMultiple(), and hI2cAudioHandler.

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 382 of file stm32f413h_discovery.c.

References 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 344 of file stm32f413h_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.

uint32_t BSP_GetVersion ( void  )

This method returns the STM32F413H DISCOVERY BSP Driver revision.

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

Definition at line 181 of file stm32f413h_discovery.c.

References __STM32F413H_DISCOVERY_BSP_VERSION.

void BSP_LED_DeInit ( Led_TypeDef  Led)

DeInit LEDs.

Parameters:
Led,:LED to be configured. This parameter can be one of the following values:
  • LED3
  • LED4

Definition at line 214 of file stm32f413h_discovery.c.

References GPIO_PIN, and GPIO_PORT.

void BSP_LED_Init ( Led_TypeDef  Led)

Configures LEDs.

Parameters:
Led,:LED to be configured. This parameter can be one of the following values:
  • LED3
  • LED4

Definition at line 193 of file stm32f413h_discovery.c.

References GPIO_PIN, GPIO_PORT, and LEDx_GPIO_CLK_ENABLE.

void BSP_LED_Off ( Led_TypeDef  Led)

Turns selected LED Off.

Parameters:
Led,:LED to be set off This parameter can be one of the following values:
  • LED3
  • LED4

Definition at line 245 of file stm32f413h_discovery.c.

References GPIO_PIN, and GPIO_PORT.

void BSP_LED_On ( Led_TypeDef  Led)

Turns selected LED On.

Parameters:
Led,:LED to be set on This parameter can be one of the following values:
  • LED3
  • LED4

Definition at line 233 of file stm32f413h_discovery.c.

References GPIO_PIN, and GPIO_PORT.

void BSP_LED_Toggle ( Led_TypeDef  Led)

Toggles the selected LED.

Parameters:
Led,:LED to be toggled This parameter can be one of the following values:
  • LED3
  • LED4

Definition at line 257 of file stm32f413h_discovery.c.

References GPIO_PIN, and GPIO_PORT.

void BSP_PB_DeInit ( Button_TypeDef  Button)

Push Button DeInit.

Parameters:
Button,:Button to be configured This parameter can be one of the following values:
  • BUTTON_WAKEUP: Wakeup Push Button
Note:
PB DeInit does not disable the GPIO clock

Definition at line 314 of file stm32f413h_discovery.c.

References BUTTON_IRQn, BUTTON_PIN, and BUTTON_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_WAKEUP: Wakeup Push Button
Return values:
TheButton GPIO pin value (GPIO_PIN_RESET = button pressed)

Definition at line 331 of file stm32f413h_discovery.c.

References BUTTON_PIN, and BUTTON_PORT.

void BSP_PB_Init ( Button_TypeDef  Button,
ButtonMode_TypeDef  ButtonMode 
)

Configures button GPIO and EXTI Line.

Parameters:
Button,:Button to be configured This parameter can be one of the following values:
  • BUTTON_WAKEUP: Wakeup Push Button
ButtonMode,:Button mode This parameter can be one of the following values:
  • BUTTON_MODE_GPIO: Button will be used as simple IO
  • BUTTON_MODE_EXTI: Button will be connected to EXTI line with interrupt generation capability

Definition at line 273 of file stm32f413h_discovery.c.

References BUTTON_IRQn, BUTTON_MODE_EXTI, BUTTON_MODE_GPIO, BUTTON_PIN, BUTTON_PORT, and WAKEUP_BUTTON_GPIO_CLK_ENABLE.

static uint16_t FMC_BANK3_ReadData ( void  ) [static]

Reads register value.

Return values:
Readvalue

Definition at line 680 of file stm32f413h_discovery.c.

References FMC_BANK3.

Referenced by LCD_IO_ReadData().

static void FMC_BANK3_WriteData ( uint16_t  Data) [static]

Writes register value.

Parameters:
Data,:Data to be written

Definition at line 658 of file stm32f413h_discovery.c.

References FMC_BANK3.

Referenced by LCD_IO_WriteData(), and LCD_IO_WriteMultipleData().

static void FMC_BANK3_WriteReg ( uint8_t  Reg) [static]

Writes register address.

Parameters:
Reg,:Register to be written

Definition at line 669 of file stm32f413h_discovery.c.

References FMC_BANK3.

Referenced by LCD_IO_WriteReg().

static void FMPI2Cx_DeInit ( FMPI2C_HandleTypeDef *  fmpi2c_handler) [static]

Deinitializes FMPI2C interface.

Parameters:
fmpi2c_handler: FMPI2C handler

Definition at line 553 of file stm32f413h_discovery.c.

References DISCOVERY_AUDIO_I2Cx.

Referenced by AUDIO_IO_DeInit(), and TS_IO_DeInit().

static void FMPI2Cx_Error ( FMPI2C_HandleTypeDef *  fmpi2c_handler,
uint8_t  Addr 
) [static]

Manages error callback by re-initializing I2C.

Parameters:
fmpi2c_handler: FMPI2C handler
Addr,:I2C Address
Return values:
None

Definition at line 540 of file stm32f413h_discovery.c.

References FMPI2Cx_Init().

Referenced by FMPI2Cx_ReadMultiple(), and FMPI2Cx_WriteMultiple().

static void FMPI2Cx_Init ( FMPI2C_HandleTypeDef *  fmpi2c_handler) [static]

Initializes FMPI2C HAL.

Parameters:
fmpi2c_handler: FMPI2C handler

Definition at line 454 of file stm32f413h_discovery.c.

References DISCOVERY_AUDIO_I2Cx, and FMPI2Cx_MspInit().

Referenced by AUDIO_IO_Init(), FMPI2Cx_Error(), and TS_IO_Init().

static HAL_StatusTypeDef FMPI2Cx_ReadMultiple ( FMPI2C_HandleTypeDef *  fmpi2c_handler,
uint8_t  Addr,
uint16_t  Reg,
uint16_t  MemAddress,
uint8_t *  Buffer,
uint16_t  Length 
) [static]

Reads multiple data.

Parameters:
fmpi2c_handler: FMPI2C handler
Addr,:I2C address
Reg,:Reg address
MemAddress,:Memory address
Buffer,:Pointer to data buffer
Length,:Length of the data
Return values:
Numberof read data

Definition at line 484 of file stm32f413h_discovery.c.

References FMPI2Cx_Error().

Referenced by AUDIO_IO_Read(), TS_IO_Read(), and TS_IO_ReadMultiple().

static HAL_StatusTypeDef FMPI2Cx_WriteMultiple ( FMPI2C_HandleTypeDef *  fmpi2c_handler,
uint8_t  Addr,
uint16_t  Reg,
uint16_t  MemAddress,
uint8_t *  Buffer,
uint16_t  Length 
) [static]

Writes a value in a register of the device through BUS in using DMA mode.

Parameters:
fmpi2c_handler: FMPI2C handler
Addr,:Device address on BUS Bus.
Reg,:The target register address to write
MemAddress,:Memory address
Buffer,:The target register value to be written
Length,:buffer size to be written
Return values:
HALstatus

Definition at line 514 of file stm32f413h_discovery.c.

References FMPI2Cx_Error().

Referenced by AUDIO_IO_Write(), TS_IO_Write(), and TS_IO_WriteMultiple().

void LCD_IO_Delay ( uint32_t  Delay)

LCD delay.

Parameters:
Delay,:Delay in ms

Definition at line 746 of file stm32f413h_discovery.c.

uint16_t LCD_IO_ReadData ( void  )

Reads data from LCD data register.

Return values:
Readdata.

Definition at line 737 of file stm32f413h_discovery.c.

References FMC_BANK3_ReadData().

void LCD_IO_WriteData ( uint16_t  RegValue)

Writes data on LCD data register.

Parameters:
RegValue,:Data to be written

Definition at line 702 of file stm32f413h_discovery.c.

References FMC_BANK3_WriteData().

void LCD_IO_WriteMultipleData ( uint16_t *  pData,
uint32_t  Size 
)

Writes several data on LCD data register.

Parameters:
pData,:pointer on data to be written
Size,:data amount in 16bits short unit

Definition at line 713 of file stm32f413h_discovery.c.

References FMC_BANK3_WriteData().

void LCD_IO_WriteReg ( uint8_t  Reg)

Writes register on LCD register.

Parameters:
Reg,:Register to be written

Definition at line 727 of file stm32f413h_discovery.c.

References FMC_BANK3_WriteReg().

void TS_IO_Delay ( uint32_t  Delay)

Delay function used in TouchScreen low level driver.

Parameters:
Delay,:Delay in ms

Definition at line 902 of file stm32f413h_discovery.c.

uint8_t TS_IO_Read ( uint8_t  Addr,
uint8_t  Reg 
)

Reads a single data.

Parameters:
Addr,:I2C address
Reg,:Register address
Return values:
Datato be read

Definition at line 878 of file stm32f413h_discovery.c.

References FMPI2Cx_ReadMultiple(), and hI2cAudioHandler.

uint16_t TS_IO_ReadMultiple ( uint8_t  Addr,
uint8_t  Reg,
uint8_t *  Buffer,
uint16_t  Length 
)

Reads multiple data with I2C communication channel from TouchScreen.

Parameters:
Addr,:I2C address
Reg,:Register address
Buffer,:Pointer to data buffer
Length,:Length of the data
Return values:
Numberof read data

Definition at line 816 of file stm32f413h_discovery.c.

References FMPI2Cx_ReadMultiple(), and hI2cAudioHandler.

void TS_IO_Write ( uint8_t  Addr,
uint8_t  Reg,
uint8_t  Value 
)

Writes a single data.

Parameters:
Addr,:I2C address
Reg,:Reg address
Value,:Data to be written

Definition at line 893 of file stm32f413h_discovery.c.

References FMPI2Cx_WriteMultiple(), and hI2cAudioHandler.

void TS_IO_WriteMultiple ( uint8_t  Addr,
uint8_t  Reg,
uint8_t *  Buffer,
uint16_t  Length 
)

Writes multiple data with I2C communication channel from MCU to TouchScreen.

Parameters:
Addr,:I2C address
Reg,:Register address
Buffer,:Pointer to data buffer
Length,:Length of the data

Definition at line 829 of file stm32f413h_discovery.c.

References FMPI2Cx_WriteMultiple(), and hI2cAudioHandler.

Generated on Thu Jan 26 2017 16:30:37 for STM32F413H-Discovery BSP User Manual by   doxygen 1.7.6.1