STM32L476G-Discovery BSP User Manual: Exported Functions

STM32L476G-Discovery BSP

STM32L476G-Discovery BSP User Manual

Functions

uint8_t BSP_QSPI_Init (void)
 Initializes the QSPI interface.
uint8_t BSP_QSPI_DeInit (void)
 De-Initializes the QSPI interface.
uint8_t BSP_QSPI_Read (uint8_t *pData, uint32_t ReadAddr, uint32_t Size)
 Reads an amount of data from the QSPI memory.
uint8_t BSP_QSPI_Write (uint8_t *pData, uint32_t WriteAddr, uint32_t Size)
 Writes an amount of data to the QSPI memory.
uint8_t BSP_QSPI_Erase_Block (uint32_t BlockAddress)
 Erases the specified block of the QSPI memory.
uint8_t BSP_QSPI_Erase_Sector (uint32_t Sector)
 Erases the specified sector of the QSPI memory.
uint8_t BSP_QSPI_Erase_Chip (void)
 Erases the entire QSPI memory.
uint8_t BSP_QSPI_GetStatus (void)
 Reads current status of the QSPI memory.
uint8_t BSP_QSPI_GetInfo (QSPI_Info *pInfo)
 Return the configuration of the QSPI memory.
uint8_t BSP_QSPI_EnableMemoryMappedMode (void)
 Configure the QSPI in memory-mapped mode.
uint8_t BSP_QSPI_SuspendErase (void)
 This function suspends an ongoing erase command.
uint8_t BSP_QSPI_ResumeErase (void)
 This function resumes a paused erase command.

Function Documentation

uint8_t BSP_QSPI_DeInit ( void  )

De-Initializes the QSPI interface.

Return values:
QSPImemory status

Definition at line 165 of file stm32l476g_discovery_qspi.c.

References QSPI_ERROR, QSPI_MspDeInit(), QSPI_OK, and QSPIHandle.

uint8_t BSP_QSPI_EnableMemoryMappedMode ( void  )

Configure the QSPI in memory-mapped mode.

Return values:
QSPImemory status

Definition at line 506 of file stm32l476g_discovery_qspi.c.

References QSPI_ERROR, QSPI_OK, and QSPIHandle.

uint8_t BSP_QSPI_Erase_Block ( uint32_t  BlockAddress)

Erases the specified block of the QSPI memory.

Parameters:
BlockAddress,:Block address to erase
Return values:
QSPImemory status

Definition at line 308 of file stm32l476g_discovery_qspi.c.

References QSPI_AutoPollingMemReady(), QSPI_ERROR, QSPI_OK, QSPI_WriteEnable(), and QSPIHandle.

uint8_t BSP_QSPI_Erase_Chip ( void  )

Erases the entire QSPI memory.

Return values:
QSPImemory status

Definition at line 397 of file stm32l476g_discovery_qspi.c.

References QSPI_AutoPollingMemReady(), QSPI_ERROR, QSPI_OK, QSPI_WriteEnable(), and QSPIHandle.

uint8_t BSP_QSPI_Erase_Sector ( uint32_t  Sector)

Erases the specified sector of the QSPI memory.

Parameters:
Sector,:Sector address to erase (0 to 255)
Return values:
QSPImemory status
Note:
This function is non blocking meaning that sector erase operation is started but not completed when the function returns. Application has to call BSP_QSPI_GetStatus() to know when the device is available again (i.e. erase operation completed).

Definition at line 356 of file stm32l476g_discovery_qspi.c.

References QSPI_ERROR, QSPI_OK, QSPI_WriteEnable(), and QSPIHandle.

uint8_t BSP_QSPI_GetInfo ( QSPI_Info pInfo)

Return the configuration of the QSPI memory.

Parameters:
pInfo,:pointer on the configuration structure
Return values:
QSPImemory status

Definition at line 490 of file stm32l476g_discovery_qspi.c.

References QSPI_Info::EraseSectorSize, QSPI_Info::EraseSectorsNumber, QSPI_Info::FlashSize, QSPI_Info::ProgPageSize, QSPI_Info::ProgPagesNumber, and QSPI_OK.

uint8_t BSP_QSPI_GetStatus ( void  )

Reads current status of the QSPI memory.

Return values:
QSPImemory status

Definition at line 437 of file stm32l476g_discovery_qspi.c.

References QSPI_BUSY, QSPI_ERROR, QSPI_OK, QSPI_SUSPENDED, and QSPIHandle.

Referenced by BSP_QSPI_ResumeErase(), and BSP_QSPI_SuspendErase().

uint8_t BSP_QSPI_Init ( void  )

Initializes the QSPI interface.

Return values:
QSPImemory status

Definition at line 120 of file stm32l476g_discovery_qspi.c.

References QSPI_DummyCyclesCfg(), QSPI_ERROR, QSPI_MspInit(), QSPI_NOT_SUPPORTED, QSPI_OK, QSPI_ResetMemory(), and QSPIHandle.

uint8_t BSP_QSPI_Read ( uint8_t *  pData,
uint32_t  ReadAddr,
uint32_t  Size 
)

Reads an amount of data from the QSPI memory.

Parameters:
pData,:Pointer to data to be read
ReadAddr,:Read start address
Size,:Size of data to read
Return values:
QSPImemory status

Definition at line 188 of file stm32l476g_discovery_qspi.c.

References QSPI_ERROR, QSPI_OK, and QSPIHandle.

uint8_t BSP_QSPI_ResumeErase ( void  )

This function resumes a paused erase command.

Return values:
QSPImemory status

Definition at line 586 of file stm32l476g_discovery_qspi.c.

References BSP_QSPI_GetStatus(), QSPI_BUSY, QSPI_ERROR, QSPI_OK, QSPI_SUSPENDED, QSPI_WriteEnable(), and QSPIHandle.

uint8_t BSP_QSPI_SuspendErase ( void  )

This function suspends an ongoing erase command.

Return values:
QSPImemory status

Definition at line 539 of file stm32l476g_discovery_qspi.c.

References BSP_QSPI_GetStatus(), QSPI_BUSY, QSPI_ERROR, QSPI_OK, QSPI_SUSPENDED, QSPI_WriteEnable(), and QSPIHandle.

uint8_t BSP_QSPI_Write ( uint8_t *  pData,
uint32_t  WriteAddr,
uint32_t  Size 
)

Writes an amount of data to the QSPI memory.

Parameters:
pData,:Pointer to data to be written
WriteAddr,:Write start address
Size,:Size of data to write
Return values:
QSPImemory status

Definition at line 228 of file stm32l476g_discovery_qspi.c.

References QSPI_AutoPollingMemReady(), QSPI_ERROR, QSPI_OK, QSPI_WriteEnable(), and QSPIHandle.

Generated on Tue Jun 23 2015 17:15:46 for STM32L476G-Discovery BSP User Manual by   doxygen 1.7.6.1