STM32746G-Discovery BSP User Manual: STM32746G_DISCOVERY_LOW_LEVELSTM32746G_DISCOVERY_LOW_LEVEL Exported Functions

STM32746G-Discovery BSP Drivers

STM32746G-Discovery BSP User Manual
STM32746G_DISCOVERY_LOW_LEVELSTM32746G_DISCOVERY_LOW_LEVEL Exported Functions

Functions

uint32_t BSP_GetVersion (void)
 This method returns the STM32746G DISCOVERY BSP Driver revision.
void BSP_LED_Init (Led_TypeDef Led)
 Configures LED on GPIO.
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 I2Cx_MspInit (I2C_HandleTypeDef *i2c_handler)
 Initializes I2C MSP.
static void I2Cx_Init (I2C_HandleTypeDef *i2c_handler)
 Initializes I2C HAL.
static HAL_StatusTypeDef I2Cx_ReadMultiple (I2C_HandleTypeDef *i2c_handler, uint8_t Addr, uint16_t Reg, uint16_t MemAddress, uint8_t *Buffer, uint16_t Length)
 Reads multiple data.
static HAL_StatusTypeDef I2Cx_WriteMultiple (I2C_HandleTypeDef *i2c_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 HAL_StatusTypeDef I2Cx_IsDeviceReady (I2C_HandleTypeDef *i2c_handler, uint16_t DevAddress, uint32_t Trials)
 Checks if target device is ready for communication.
static void I2Cx_Error (I2C_HandleTypeDef *i2c_handler, uint8_t Addr)
 Manages error callback by re-initializing I2C.
void AUDIO_IO_Init (void)
 Initializes Audio low level.
void AUDIO_IO_DeInit (void)
 Deinitializes Audio low level.
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.
void AUDIO_IO_Delay (uint32_t Delay)
 AUDIO Codec delay.
void CAMERA_IO_Init (void)
 Initializes Camera low level.
void CAMERA_IO_Write (uint8_t Addr, uint8_t Reg, uint8_t Value)
 Camera writes single data.
uint8_t CAMERA_IO_Read (uint8_t Addr, uint8_t Reg)
 Camera reads single data.
void CAMERA_Delay (uint32_t Delay)
 Camera delay.
void EEPROM_IO_Init (void)
 Initializes peripherals used by the I2C EEPROM driver.
HAL_StatusTypeDef EEPROM_IO_WriteData (uint16_t DevAddress, uint16_t MemAddress, uint8_t *pBuffer, uint32_t BufferSize)
 Write data to I2C EEPROM driver in using DMA channel.
HAL_StatusTypeDef EEPROM_IO_ReadData (uint16_t DevAddress, uint16_t MemAddress, uint8_t *pBuffer, uint32_t BufferSize)
 Read data from I2C EEPROM driver in using DMA channel.
HAL_StatusTypeDef EEPROM_IO_IsDeviceReady (uint16_t DevAddress, uint32_t Trials)
 Checks if target device is ready for communication.
void TS_IO_Init (void)
 Initializes Touchscreen low level.
void TS_IO_Write (uint8_t Addr, uint8_t Reg, uint8_t Value)
 Writes a single data.
uint8_t TS_IO_Read (uint8_t Addr, uint8_t Reg)
 Reads a single data.
void TS_IO_Delay (uint32_t Delay)
 TS delay.

Function Documentation

void AUDIO_IO_DeInit ( void  )

Deinitializes Audio low level.

Return values:
None

Definition at line 683 of file stm32746g_discovery.c.

void AUDIO_IO_Delay ( uint32_t  Delay)

AUDIO Codec delay.

Parameters:
Delay,:Delay in ms
Return values:
None

Definition at line 731 of file stm32746g_discovery.c.

void AUDIO_IO_Init ( void  )

Initializes Audio low level.

Return values:
None

Definition at line 674 of file stm32746g_discovery.c.

References hI2cAudioHandler, and I2Cx_Init().

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 711 of file stm32746g_discovery.c.

References hI2cAudioHandler, and I2Cx_ReadMultiple().

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

Definition at line 694 of file stm32746g_discovery.c.

References hI2cAudioHandler, and I2Cx_WriteMultiple().

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
  • COM2
huart,:Pointer to a UART_HandleTypeDef structure that contains the configuration information for the specified USART peripheral.
Return values:
None

Definition at line 435 of file stm32746g_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
  • COM2
huart,:Pointer to a UART_HandleTypeDef structure that contains the configuration information for the specified USART peripheral.
Return values:
None

Definition at line 395 of file stm32746g_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 STM32746G DISCOVERY BSP Driver revision.

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

Definition at line 173 of file stm32746g_discovery.c.

References __STM32746G_DISCO_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:
  • LED1
Note:
Led DeInit does not disable the GPIO clock
Return values:
None

Definition at line 217 of file stm32746g_discovery.c.

References GPIO_PIN, LED1, and LED1_GPIO_PORT.

void BSP_LED_Init ( Led_TypeDef  Led)

Configures LED on GPIO.

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

Definition at line 185 of file stm32746g_discovery.c.

References GPIO_PIN, LED1, LED1_GPIO_CLK_ENABLE, and LED1_GPIO_PORT.

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

Definition at line 258 of file stm32746g_discovery.c.

References GPIO_PIN, LED1, and LED1_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:
  • LED1
Return values:
None

Definition at line 240 of file stm32746g_discovery.c.

References GPIO_PIN, LED1, and LED1_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:
  • LED1
Return values:
None

Definition at line 276 of file stm32746g_discovery.c.

References GPIO_PIN, LED1, and LED1_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
  • BUTTON_TAMPER: Tamper Push Button
  • BUTTON_KEY: Key Push Button
Note:
On STM32746G-Discovery board, the three buttons (Wakeup, Tamper and key buttons) are mapped on the same push button named "User" on the board serigraphy.
PB DeInit does not disable the GPIO clock
Return values:
None

Definition at line 358 of file stm32746g_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
  • BUTTON_TAMPER: Tamper Push Button
  • BUTTON_KEY: Key Push Button
Note:
On STM32746G-Discovery board, the three buttons (Wakeup, Tamper and key buttons) are mapped on the same push button named "User" on the board serigraphy.
Return values:
TheButton GPIO pin value

Definition at line 380 of file stm32746g_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
  • BUTTON_TAMPER: Tamper Push Button
  • BUTTON_KEY: Key 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
Note:
On STM32746G-Discovery board, the three buttons (Wakeup, Tamper and key buttons) are mapped on the same push button named "User" on the board serigraphy.
Return values:
None

Definition at line 304 of file stm32746g_discovery.c.

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

void CAMERA_Delay ( uint32_t  Delay)

Camera delay.

Parameters:
Delay,:Delay in ms
Return values:
None

Definition at line 779 of file stm32746g_discovery.c.

void CAMERA_IO_Init ( void  )

Initializes Camera low level.

Return values:
None

Definition at line 742 of file stm32746g_discovery.c.

References hI2cExtHandler, and I2Cx_Init().

uint8_t CAMERA_IO_Read ( uint8_t  Addr,
uint8_t  Reg 
)

Camera reads single data.

Parameters:
Addr,:I2C address
Reg,:Register address
Return values:
Readdata

Definition at line 765 of file stm32746g_discovery.c.

References hI2cExtHandler, and I2Cx_ReadMultiple().

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

Camera writes single data.

Parameters:
Addr,:I2C address
Reg,:Register address
Value,:Data to be written
Return values:
None

Definition at line 754 of file stm32746g_discovery.c.

References hI2cExtHandler, and I2Cx_WriteMultiple().

void EEPROM_IO_Init ( void  )

Initializes peripherals used by the I2C EEPROM driver.

Return values:
None

Definition at line 790 of file stm32746g_discovery.c.

References hI2cExtHandler, and I2Cx_Init().

Referenced by BSP_EEPROM_Init().

HAL_StatusTypeDef EEPROM_IO_IsDeviceReady ( uint16_t  DevAddress,
uint32_t  Trials 
)

Checks if target device is ready for communication.

Note:
This function is used with Memory devices
Parameters:
DevAddress,:Target device address
Trials,:Number of trials
Return values:
HALstatus

Definition at line 828 of file stm32746g_discovery.c.

References hI2cExtHandler, and I2Cx_IsDeviceReady().

Referenced by BSP_EEPROM_Init(), and BSP_EEPROM_WaitEepromStandbyState().

HAL_StatusTypeDef EEPROM_IO_ReadData ( uint16_t  DevAddress,
uint16_t  MemAddress,
uint8_t *  pBuffer,
uint32_t  BufferSize 
)

Read data from I2C EEPROM driver in using DMA channel.

Parameters:
DevAddress,:Target device address
MemAddress,:Internal memory address
pBuffer,:Pointer to data buffer
BufferSize,:Amount of data to be read
Return values:
HALstatus

Definition at line 816 of file stm32746g_discovery.c.

References hI2cExtHandler, and I2Cx_ReadMultiple().

Referenced by BSP_EEPROM_ReadBuffer().

HAL_StatusTypeDef EEPROM_IO_WriteData ( uint16_t  DevAddress,
uint16_t  MemAddress,
uint8_t *  pBuffer,
uint32_t  BufferSize 
)

Write data to I2C EEPROM driver in using DMA channel.

Parameters:
DevAddress,:Target device address
MemAddress,:Internal memory address
pBuffer,:Pointer to data buffer
BufferSize,:Amount of data to be sent
Return values:
HALstatus

Definition at line 803 of file stm32746g_discovery.c.

References hI2cExtHandler, and I2Cx_WriteMultiple().

Referenced by BSP_EEPROM_WritePage().

static void I2Cx_Error ( I2C_HandleTypeDef *  i2c_handler,
uint8_t  Addr 
) [static]

Manages error callback by re-initializing I2C.

Parameters:
i2c_handler: I2C handler
Addr,:I2C Address
Return values:
None

Definition at line 655 of file stm32746g_discovery.c.

References I2Cx_Init().

Referenced by I2Cx_ReadMultiple(), and I2Cx_WriteMultiple().

static void I2Cx_Init ( I2C_HandleTypeDef *  i2c_handler) [static]

Initializes I2C HAL.

Parameters:
i2c_handler: I2C handler
Return values:
None

Definition at line 548 of file stm32746g_discovery.c.

References DISCOVERY_AUDIO_I2Cx, DISCOVERY_EXT_I2Cx, hI2cAudioHandler, and I2Cx_MspInit().

Referenced by AUDIO_IO_Init(), CAMERA_IO_Init(), EEPROM_IO_Init(), I2Cx_Error(), and TS_IO_Init().

static HAL_StatusTypeDef I2Cx_IsDeviceReady ( I2C_HandleTypeDef *  i2c_handler,
uint16_t  DevAddress,
uint32_t  Trials 
) [static]

Checks if target device is ready for communication.

Note:
This function is used with Memory devices
Parameters:
i2c_handler: I2C handler
DevAddress,:Target device address
Trials,:Number of trials
Return values:
HALstatus

Definition at line 644 of file stm32746g_discovery.c.

Referenced by EEPROM_IO_IsDeviceReady().

static HAL_StatusTypeDef I2Cx_ReadMultiple ( I2C_HandleTypeDef *  i2c_handler,
uint8_t  Addr,
uint16_t  Reg,
uint16_t  MemAddress,
uint8_t *  Buffer,
uint16_t  Length 
) [static]

Reads multiple data.

Parameters:
i2c_handler: I2C 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 586 of file stm32746g_discovery.c.

References I2Cx_Error().

Referenced by AUDIO_IO_Read(), CAMERA_IO_Read(), EEPROM_IO_ReadData(), and TS_IO_Read().

static HAL_StatusTypeDef I2Cx_WriteMultiple ( I2C_HandleTypeDef *  i2c_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:
i2c_handler: I2C 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 616 of file stm32746g_discovery.c.

References I2Cx_Error().

Referenced by AUDIO_IO_Write(), CAMERA_IO_Write(), EEPROM_IO_WriteData(), and TS_IO_Write().

void TS_IO_Delay ( uint32_t  Delay)

TS delay.

Parameters:
Delay,:Delay in ms
Return values:
None

Definition at line 876 of file stm32746g_discovery.c.

void TS_IO_Init ( void  )

Initializes Touchscreen low level.

Return values:
None

Definition at line 839 of file stm32746g_discovery.c.

References hI2cAudioHandler, and I2Cx_Init().

uint8_t TS_IO_Read ( uint8_t  Addr,
uint8_t  Reg 
)

Reads a single data.

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

Definition at line 862 of file stm32746g_discovery.c.

References hI2cAudioHandler, and I2Cx_ReadMultiple().

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

Definition at line 851 of file stm32746g_discovery.c.

References hI2cAudioHandler, and I2Cx_WriteMultiple().

Generated on Fri Dec 30 2016 16:31:33 for STM32746G-Discovery BSP User Manual by   doxygen 1.7.6.1