B-L475E-IOT01 BSP User Manual: QSPI Exported Functions

B-L475E-IOT01 BSP Driver

B-L475E-IOT01 BSP User Manual
QSPI Exported Functions

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.
uint8_t BSP_QSPI_EnterDeepPowerDown (void)
 This function enter the QSPI memory in deep power down mode.
uint8_t BSP_QSPI_LeaveDeepPowerDown (void)
 This function leave the QSPI memory from deep power down mode.
__weak void BSP_QSPI_MspInit (void)
 Initializes the QSPI MSP.
__weak void BSP_QSPI_MspDeInit (void)
 De-Initializes the QSPI MSP.

Function Documentation

uint8_t BSP_QSPI_DeInit ( void  )

De-Initializes the QSPI interface.

Return values:
QSPImemory status

Definition at line 200 of file stm32l475e_iot01_qspi.c.

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

uint8_t BSP_QSPI_EnableMemoryMappedMode ( void  )

Configure the QSPI in memory-mapped mode.

Return values:
QSPImemory status

Definition at line 554 of file stm32l475e_iot01_qspi.c.

References QSPI_ERROR, QSPI_OK, and QSPIHandle.

uint8_t BSP_QSPI_EnterDeepPowerDown ( void  )

This function enter the QSPI memory in deep power down mode.

Return values:
QSPImemory status

Definition at line 674 of file stm32l475e_iot01_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 339 of file stm32l475e_iot01_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 428 of file stm32l475e_iot01_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 387 of file stm32l475e_iot01_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 538 of file stm32l475e_iot01_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 468 of file stm32l475e_iot01_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 141 of file stm32l475e_iot01_qspi.c.

References BSP_QSPI_MspInit(), QSPI_ERROR, QSPI_HIGH_PERF_ENABLE, QSPI_HighPerfMode(), QSPI_NOT_SUPPORTED, QSPI_OK, QSPI_QUAD_ENABLE, QSPI_QuadMode(), QSPI_ResetMemory(), and QSPIHandle.

uint8_t BSP_QSPI_LeaveDeepPowerDown ( void  )

This function leave the QSPI memory from deep power down mode.

Return values:
QSPImemory status

Definition at line 705 of file stm32l475e_iot01_qspi.c.

References QSPI_ERROR, QSPI_OK, and QSPIHandle.

void BSP_QSPI_MspDeInit ( void  )

De-Initializes the QSPI MSP.

Return values:
None

Definition at line 764 of file stm32l475e_iot01_qspi.c.

Referenced by BSP_QSPI_DeInit().

void BSP_QSPI_MspInit ( void  )

Initializes the QSPI MSP.

Return values:
None

Definition at line 736 of file stm32l475e_iot01_qspi.c.

Referenced by BSP_QSPI_Init().

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 223 of file stm32l475e_iot01_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 629 of file stm32l475e_iot01_qspi.c.

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

uint8_t BSP_QSPI_SuspendErase ( void  )

This function suspends an ongoing erase command.

Return values:
QSPImemory status

Definition at line 588 of file stm32l475e_iot01_qspi.c.

References BSP_QSPI_GetStatus(), QSPI_BUSY, QSPI_ERROR, QSPI_OK, QSPI_SUSPENDED, 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 265 of file stm32l475e_iot01_qspi.c.

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

Generated on Thu Mar 16 2017 10:38:33 for B-L475E-IOT01 BSP User Manual by   doxygen 1.7.6.1